List of Commands
login
login
The login
command lets you add your WorkflowGen credentials to authorize the CLI. The CLI supports basic and Open ID Connect authentication.
Basic or Integrated Windows authentication
Basic and Integrated Windows authentication are available since WorkflowGen version 7.0.0.
Auth0 authentication
Auth0 authentication is available since WorkflowGen version 7.11.0.
MSIDV2 (Microsoft Identity Platform v2) authentication
MSIDV2 authentication is available since WorkflowGen version 7.16.0.
For MSIDV2 mode, you must first have registered a new dedicated application (server-side application
) in your Azure Active Directory and on your WorkflowGen server by following the instructions in the Azure AD Configuration for Server-Side Scripts chapter in the WorkflowGen for Azure guide.
All of the operations invoked from the WorkflowGen CLI will therefore use the user account specific in the Impersonate username
field of the Non-interactive client
application associated to the WorkflowGen CLI in WorkflowGen.
Okta authentication
Okta authentication is available since WorkflowGen version 7.13.0.
AD FS authentication
AD FS authentication is available since WorkflowGen 7.11.0.
Argument
Name
Type
Description
Behavior
url
String
WorkflowGen URL
Required
Options
Alias
Type
Description
Default value
Behavior
--username
or -u
String
WorkflowGen username
None
Required
--password
or -p
String
WorkflowGen password
None
Optional
--webforms
or -w
String
Webforms path
C:\inetpub\wwwroot\wfgen\wfapps\webforms
Optional
--context
or -c
String
Context name
DEFAULT
Optional
--authentication-mode
String
Authentication mode (BASIC
, AUTH0
, MSIDV2
, ADFS
, OKTA
)
BASIC
Facultatif
--client-id
String
Client's public identifier
None
Facultatif
--domain
String
ADFS
or AUTH0
domain
Aucune
Facultatif
--tenant-id
String
MSIDV2
tenant ID
None
Facultatif
--metadata-url
String
OKTA
metadata URL
Aucune
Facultatif
--client-secret
String
Data known only to the application and the authorization server
Aucune
Facultatif
--client-secret-file
String
File containing the client secret known only to the application and the authorization server
None
Facultatif
--port
String
WorkflowGen port
None
📌 Basic authentication login examples
📌 Auth0 login examples
📌 MSIDV2 login examples
📌 Okta login examples
📌 AD FS login examples
config
config
The config
command lets you configure the CLI.
Available since WorkflowGen version 7.0.0.
current-context
current-context
Displays the current context.
Usage
delete-context
delete-context
Deletes the specified context from the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name
Type
Description
Behavior
name
String
Name of the context to delete
Required
📌 Example
delete-server
delete-server
Deletes the specified server from the configuration.
Usage
Argument
Name
Type
Description
Behavior
name
String
Name of the server to delete
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the server deletion and delete associated contexts
false
Optional
📌 Example
delete-user
delete-user
Deletes the specified user from the configuration.
Usage
Argument
Name
Type
Description
Behavior
name
String
Name of the user to delete
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Forces the user deletion and deletes associated contexts
false
Optional
📌 Example
get-contexts
get-contexts
Describes one or several contexts.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name
Type
Description
Behavior
names
String
Name(s) of context(s) to get
Optional
📌 Example
get-servers
get-servers
Displays servers defined in the configuration.
Usage
get-users
get-users
Displays users defined in the configuration.
Usage
rename-context
rename-context
Renames a context in the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Arguments
Name
Type
Description
Behavior
old-name
String
Context name to rename
Required
new-name
String
New context name
Required
📌 Example
rename-server
rename-server
Renames a server in the configuration.
Usage
Arguments
Name
Type
Description
Behavior
old-name
String
Server name to rename
Required
new-name
String
New server name
Required
📌 Example
rename-user
rename-user
Renames a user in the configuration.
Usage
Arguments
Name
Type
Description
Behavior
USER_OLD_NAME
String
Username to rename
Required
USER_NEW_NAME
String
New username
Required
📌 Example
set-context
set-context
Sets a context entry in the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name
Type
Description
Behavior
name
String
Context name
Required
Options
Alias
Type
Description
Default value
Behavior
--server
or -s
String
Server name
None
Required
--user
or -u
String
Username
None
Required
📌 Example
set-server
set-server
Sets a server entry in the configuration.
Usage
Argument
Name
Type
Description
Behavior
name
String
Server name
Required
Options
Alias
Type
Description
Default value
Behavior
--url
or -u
String
WorkflowGen URL
None
Optional
--webforms
or -w
String
WorkflowGen webforms path
None
Optional
--version
or -v
String
WorkflowGen version
None
Optional
📌 Example
set-user
set-user
Sets a user entry in the configuration.
Usage
Argument
Name
Type
Description
Behavior
name
String
Username
Required
Options
Alias
Type
Description
Default value
Behavior
--username
or -u
String
WorkflowGen username
None
Required
--password
or -w
String
WorkflowGen password
None
Required
📌 Example
use-context
use-context
Sets the current context in the configuration.
Usage
Argument
Name
Type
Description
Behavior
name
String
Context name
Required
📌 Example
[CONTEXT_NAME]
represent the name given to the CLI context that contains your server and user information.
project
project
The project
command lets you either export or import an entire WorkflowGen project from a manifest.
Available since WorkflowGen version 7.17.0.
init
init
The init
command allow you to generate a manifest.json
file interactively.
Usage
Options
Alias
Type
Description
Default value
Behavior
--path
or -p
String
Directory path where the project will be initialized
Current directory
Optional
--bare
Boolean
Generates a manifest.json
file with the bare minimum content
false
Optional
--force
or -f
Boolean
Forces the manifest.json
generation
false
Optional
📌 Examples
export
export
Exports a project from your WorkflowGen server to a local repository.
Usage
Option
Alias
Type
Description
Default value
Behavior
--path
or -p
String
Path to folder where the project's manifest and files are located.
Current directory
Optional
📌 Example
import
import
Imports a project from a local repository to your WorkflowGen server.
Usage
Options
Alias
Type
Description
Default value
Behavior
--source
or -s
String
Project path
Current directory
Optional
--force
or -f
Boolean
Updates the project's existing global lists and applications
false
Optional
📌 Example
show
show
Displays the content of a manifest link to a project.
Usage
Option
Alias
Type
Description
Default value
Behavior
--path
or -p
String
Project path
Current directory
Optional
📌 Example
process
process
The process
command lets you export
, import
, get
, update
, or delete
a process.
Available since WorkflowGen version 7.17.0.
export
export
Exports a specific process from your WorkflowGen server to a local repository.
Usage
Arguments
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
Option
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
📌 Example
import
import
Imports a specific process from a local repository to your WorkflowGen server.
Usage
Argument
Name
Type
Description
Behavior
file-path
String
Path of the process XML file
Required
Options
Alias
Type
Description
Default value
Behavior
--use-version-number
Boolean
Use the process version from the XML file
false
Optional
--state
or -s
String
Specify with which status the process will be imported
TEST
Optional
--folder
String
Destination name of the process folder into which to import the process; the folder should exist
DEFAULT
Optional
UseVersionNumber
UseVersionNumber
<use-version-number = true>
will try to add the process with the version number inside the XML file, if it doesn't already exist.<use-version-number = false>
will add the process with the latest version number plus one (e.g. if the latest current version is3
, setting this tofalse
will import the process as version4
).
state
state
The state can be one of the following:
TEST
(default)ACTIVE
DEV
ARCHIVE
📌 Example
get
get
Displays one or several processes.
Usage
Arguments
Name
Type
Description
Behavior
name
String
Process name
Optional
version
Int
Process version
Optional (except if a name is specified)
Option
Alias
Type
Description
Default Value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
update
update
Updates information for a single process.
Usage
Arguments
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
Options
Alias
Type
Description
Default value
Behavior
--description
or -d
String
Specifies the description with which the process will be updated
None
Optional
--state
or -s
String
Specify with which status the process will be updated
None
Optional
📌 Example
delete
delete
Deletes a single process by name and version.
Usage
Arguments
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
📌 Example
test
test
Runs test cases of your processes.
Usage
Arguments
Name
Type
Description
Behavior
test-files
String
Path(s) to the test file(s)
Required
Option
Name
Type
Description
Behavior
--verbosity
or -v
String
Establishes the level of verbosity
Possible values: q[uiet]
,n[ormal]
(default) ,d[etailed]
Optional
--doctor
String
Check if test cases are compliant. Only available as of WorkflowGen version 8.0.3.
Optional
📌 Example
📌 Example of a test file
global-list
global-list
The global-list
command lets you export
, import
, get
, or delete
a global list.
Available since WorkflowGen version 7.17.0.
export
export
Exports a specific global list from your WorkflowGen server to a local repository.
Usage
Argument
Name
Type
Description
Behavior
name
String
Global list name
Required
Option
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
📌 Example
import
import
Imports a specific global list from your local repository to your WorkflowGen server.
Known issue (#3373): See the WorkflowGen 7.22.2 release notes.
Usage
Argument
Name
Type
Description
Behavior
file-path
String
The path to the global list's XML file
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Updates specified global list
false
Optional
📌 Example
get
get
Displays one or several global lists.
Usage
Argument
Name
Type
Description
Behavior
names
String
Global list name(s)
Optional
Option
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
delete
delete
Deletes a single global list by name.
Usage
Argument
Name
Type
Description
Behavior
name
String
Global list name
Required
📌 Example
application
application
The application
command lets you export
, import
, get
, get-parameters
, or delete
an application.
Available since WorkflowGen version 7.14.0.
export
export
Exports a specific application from your WorkflowGen server to a local repository.
Usage
Argument
Name
Type
Description
Behavior
name
String
Application name
Required
Option
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
📌 Example
import
import
Imports a specific application from your local repository to your WorkflowGen server.
Usage
Argument
Name
Type
Description
Behavior
file-path
String
The full path containing the application's JSON file
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Updates the specified application
false
Optional
📌 Example
get
get
Displays one or several applications.
Usage
Argument
Name
Type
Description
Behavior
names
String
Application name(s)
Optional
Option
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
get-parameters
get-parameters
Displays an application's parameters.
Usage
Argument
Name
Type
Description
Behavior
name
String
Application name
Required
Option
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
delete
delete
Deletes a single application by name.
Usage
Argument
Name
Type
Description
Behavior
name
String
Application name
Required
📌 Example
action
action
Available since WorkflowGen version 7.17.0.
get
get
Lets you display the action information of a request or process.
Usage
Argument
Name
Type
Description
Behavior
requestNumber
Int
ID number of the request that you want to get
Optional
Option
Alias
Type
Description
Default value
Behavior
--processName
or -p
String
Name of the process whose actions you want to retrieve
(none)
Optional
--processVersion
or -v
Int
Version of the process whose actions you want to retrieve
(none)
Optional
--status
or -s
String
Retrieve the requests with a specified status (OPEN
or CLOSED)
(none)
Optional
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
complete
complete
Lets you complete an action for a process.
Usage
Argument
Name
Type
Description
Behavior
activityNumber
Int
Action number of the action that you want to complete
Required
requestNumber
Int
ID number of the request whose action you want to complete
Required
Option
Alias
Type
Description
Behavior
--parameter
or -p
String
Your complete action parameter contains a string in the following format: ValueType:ParameterName=Value
. ValueType
can be text
,numeric
, or date
Optional
📌 Example
cancel
cancel
Lets you cancel an ongoing action.
Usage
Argument
Name
Type
Description
Behavior
activityNumber
Int
Action number of the action that you want to cancel
Required
requestNumber
Int
ID number of the request whose action you want to cancel
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the cancellation
false
Optional
📌 Example
request
request
Available since WorkflowGen version 7.17.0.
get
get
Lets you manage a WorkflowGen request.
Usage
Argument
Name
Type
Description
Behavior
requestNumber
String
ID number(s) of the request(s) that you want to get
Optional
Option
Alias
Type
Description
Default value
Behavior
--processName
or -p
String
Name of the process whose requests you want to retrieve
(none)
Optional
--processVersion
or -v
Int
Version of the process whose requests you want to retrieve
(none)
Optional
--status
or -s
String
Retrieve the requests with the specified status (OPEN
or CLOSED)
(none)
Optional
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
📌 Example
create
create
Lets you create a new request from a process.
Usage
Argument
Name
Type
Description
Behavior
processName
String
Name of the process of which you want to create a request
Required
processVersion
Int
Version of the process of which you want to create a request
Required
Option
Alias
Type
Description
Behavior
--parameter
or -p
String
Your complete action parameter contains a string in the following format: ValueType:ParameterName=Value
. ValueType
can be text
,numeric
, or date
.
Optional
📌 Example
cancel
cancel
Lets you cancel an ongoing request.
Usage
Argument
Name
Type
Description
Behavior
requestNumber
Int
The request number that you want to cancel
Required
Option
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the cancellation
false
Optional
📌 Example
graphql
graphql
The graphql
command lets you run a custom GraphQL query.
Available since WorkflowGen version 7.0.0.
Usage
Arguments
Name
Type
Description
Behavior
--variable
or -v
String
Inputs a variable that will be read as a raw string.
See below
--variableCast
or -V
String
Inputs a variable that the CLI will attempt to cast in a valid JSON type.
See below
--variableJson
JSON
Input a JSON object containing the variables' names as keys and variables' values as the values of those keys.
📌 Example: { "key": "value" }
See below
If the graphql
query uses variables, you have to specify either --variable
and --variableCast
or --variableJson
. You can't use --variableJson
with the other two arguments and vice-versa.
📌 Examples
Due to a known PowerShell bug at time of writing (https://github.com/PowerShell/PowerShell/issues/1995), any double quotes ("
) will be stripped from the string when sending it to a native executable. The solution is to add a backslash (\
) before each double quote, or use three double quotes ("""
).
Last updated