List of Commands
Last updated
Last updated
login
The login
command lets you add your WorkflowGen credentials to authorize the CLI. The CLI supports basic and Open ID Connect authentication.
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 chapter in the 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.
Name
Type
Description
Behavior
url
String
WorkflowGen URL
Required
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
config
The config
command lets you configure the CLI.
current-context
Displays the current context.
delete-context
Deletes the specified context from the configuration.
Name
Type
Description
Behavior
name
String
Name of the context to delete
Required
delete-server
Deletes the specified server from the configuration.
Name
Type
Description
Behavior
name
String
Name of the server to delete
Required
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the server deletion and delete associated contexts
false
Optional
delete-user
Deletes the specified user from the configuration.
Name
Type
Description
Behavior
name
String
Name of the user to delete
Required
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Forces the user deletion and deletes associated contexts
false
Optional
get-contexts
Describes one or several contexts.
Name
Type
Description
Behavior
names
String
Name(s) of context(s) to get
Optional
get-servers
Displays servers defined in the configuration.
get-users
Displays users defined in the configuration.
rename-context
Renames a context in the configuration.
Name
Type
Description
Behavior
old-name
String
Context name to rename
Required
new-name
String
New context name
Required
rename-server
Renames a server in the configuration.
Name
Type
Description
Behavior
old-name
String
Server name to rename
Required
new-name
String
New server name
Required
rename-user
Renames a user in the configuration.
Name
Type
Description
Behavior
USER_OLD_NAME
String
Username to rename
Required
USER_NEW_NAME
String
New username
Required
set-context
Sets a context entry in the configuration.
Name
Type
Description
Behavior
name
String
Context name
Required
Alias
Type
Description
Default value
Behavior
--server
or -s
String
Server name
None
Required
--user
or -u
String
Username
None
Required
set-server
Sets a server entry in the configuration.
Name
Type
Description
Behavior
name
String
Server name
Required
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
set-user
Sets a user entry in the configuration.
Name
Type
Description
Behavior
name
String
Username
Required
Alias
Type
Description
Default value
Behavior
--username
or -u
String
WorkflowGen username
None
Required
--password
or -w
String
WorkflowGen password
None
Required
use-context
Sets the current context in the configuration.
Name
Type
Description
Behavior
name
String
Context name
Required
project
The project
command lets you either export or import an entire WorkflowGen project from a manifest.
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
export
Exports a project from your WorkflowGen server to a local repository.
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
import
Imports a project from a local repository to your WorkflowGen server.
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
show
Displays the content of a manifest link to a project.
Usage
Alias
Type
Description
Default value
Behavior
--path
or -p
String
Project path
Current directory
Optional
process
The process
command lets you export
, import
, get
, update
, or delete
a process.
export
Exports a specific process from your WorkflowGen server to a local repository.
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
import
Imports a specific process from a local repository to your WorkflowGen server.
Name
Type
Description
Behavior
file-path
String
Path of the process XML file
Required
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
<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 is 3
, setting this to false
will import the process as version 4
).
state
The state can be one of the following:
TEST
(default)
ACTIVE
DEV
ARCHIVE
get
Displays one or several processes.
Name
Type
Description
Behavior
name
String
Process name
Optional
version
Int
Process version
Optional (except if a name is specified)
Alias
Type
Description
Default Value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
update
Updates information for a single process.
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
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
delete
Deletes a single process by name and version.
Name
Type
Description
Behavior
name
String
Process name
Required
version
Int
Process version
Required
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
The global-list
command lets you export
, import
, get
, or delete
a global list.
export
Exports a specific global list from your WorkflowGen server to a local repository.
Name
Type
Description
Behavior
name
String
Global list name
Required
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
import
Imports a specific global list from your local repository to your WorkflowGen server.
Name
Type
Description
Behavior
file-path
String
The path to the global list's XML file
Required
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Updates specified global list
false
Optional
get
Displays one or several global lists.
Name
Type
Description
Behavior
names
String
Global list name(s)
Optional
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
delete
Deletes a single global list by name.
Name
Type
Description
Behavior
name
String
Global list name
Required
application
The application
command lets you export
, import
, get
, get-parameters
, or delete
an application.
export
Exports a specific application from your WorkflowGen server to a local repository.
Name
Type
Description
Behavior
name
String
Application name
Required
Alias
Type
Description
Default value
Behavior
--destination
or -d
String
Export path
Current directory
Optional
import
Imports a specific application from your local repository to your WorkflowGen server.
Name
Type
Description
Behavior
file-path
String
The full path containing the application's JSON file
Required
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Updates the specified application
false
Optional
get
Displays one or several applications.
Name
Type
Description
Behavior
names
String
Application name(s)
Optional
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
get-parameters
Displays an application's parameters.
Name
Type
Description
Behavior
name
String
Application name
Required
Alias
Type
Description
Default value
Behavior
--output
or -o
String
Define the output format. Valid values: json
, table
.
table
Optional
delete
Deletes a single application by name.
Name
Type
Description
Behavior
name
String
Application name
Required
action
get
Lets you display the action information of a request or process.
Name
Type
Description
Behavior
requestNumber
Int
ID number of the request that you want to get
Optional
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
complete
Lets you complete an action for a process.
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
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
cancel
Lets you cancel an ongoing action.
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
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the cancellation
false
Optional
request
get
Lets you manage a WorkflowGen request.
Name
Type
Description
Behavior
requestNumber
String
ID number(s) of the request(s) that you want to get
Optional
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
create
Lets you create a new request from a process.
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
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
cancel
Lets you cancel an ongoing request.
Name
Type
Description
Behavior
requestNumber
Int
The request number that you want to cancel
Required
Alias
Type
Description
Default value
Behavior
--force
or -f
Boolean
Force the cancellation
false
Optional
graphql
The graphql
command lets you run a custom GraphQL query.
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.
Known issue (#3373): See the .
Due to a known PowerShell bug at time of writing (), 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 ("""
).