Comment on page
List of Commands
The
login command lets you add your WorkflowGen credentials to authorize the CLI. The CLI supports basic and Open ID Connect authentication. wfg login [WORKFLOWGEN_URL] -u [WORKFLOWGEN_USERNAME] -p [WORKFLOWGEN_PASSWORD] --password-file [PASSWORD_PATH] -c [CONTEXT_NAME]
Basic and Integrated Windows authentication are available since WorkflowGen version 7.0.0.
wfg login [WORKFLOWGEN_URL] --authentication-mode AUTH0 --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Auth0 authentication is available since WorkflowGen version 7.11.0.
wfg login [WORKFLOWGEN_URL] --authentication-mode MSIDV2 --tenant-id [TENANT_ID] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
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.wfg login [WORKFLOWGEN_URL] --authentication-mode OKTA --metadata-url [METADATA_URL] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Okta authentication is available since WorkflowGen version 7.13.0.
wfg login [WORKFLOWGEN_URL] --authentication-mode ADFS --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
AD FS authentication is available since WorkflowGen 7.11.0.
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 | ​ |
wfg login http://localhost/wfgen -u wfgen_admin -p myPassword
wfg login http://localhost/wfgen -u wfgen_admin --password-file ./path/to/password.txt
wfg login http://localhost/wfgen --authentication-mode AUTH0 --domain myDomain.auth0.com --client-id myClientId
wfg login http://localhost/wfgen --authentication-mode AUTH0
wfg login http://localhost/wfgen --authentication-mode MSIDV2 --tenant-id myTenantId --client-id myClientId
wfg login http://localhost/wfgen --authentication-mode MSIDV2 --tenant-id myTenantId --client-id myClientId --client-secret myClientSecret
wfg login http://localhost/wfgen --authentication-mode OKTA --metadata-url https://MyOktaDomain/.well-known/openid-configuration --client-id myClientId
wfg login http://localhost/wfgen --authentication-mode OKTA --metadata-url https://MyOktaDomain/.well-known/openid-configuration --client-id myClientId --client-secret myClientSecret
wfg login http://localhost/wfgen --authentication-mode ADFS --domain myAdfsDomain --client-id myClientId
wfg login http://localhost/wfgen --authentication-mode ADFS --domain myAdfsDomain --client-id myClientId --client-secret myClientSecret
The
config command lets you configure the CLI. Available since WorkflowGen version 7.0.0.
Displays the current context.
wfg config current-context
Deletes the specified context from the configuration.
wfg config delete-context [CONTEXT_NAME]
[CONTEXT_NAME] represents the name given to the CLI context that contains your server and user information.Name | Type | Description | Behavior |
name | String | Name of the context to delete | Required |
wfg config delete-context WFGEN_PROD
Deletes the specified server from the configuration.
wfg config delete-server [SERVER_NAME] --force
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 |
wfg config delete-server WFGEN_PROD_SERVER --force
Deletes the specified user from the configuration.
wfg config delete-user [USER_NAME] --force
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 |
wfg config delete-user ADMIN_PROD_ACCOUNT --force
Describes one or several contexts.
wfg config get-contexts [CONTEXT_NAME1] [CONTEXT_NAME2] [CONTEXT_NAME3]
[CONTEXT_NAME] represents the name given to the CLI context that contains your server and user information.Name | Type | Description | Behavior |
names | String | Name(s) of context(s) to get | Optional |
wfg config get-contexts WFGEN_PROD
Displays servers defined in the configuration.
wfg config get-servers
Displays users defined in the configuration.
wfg config get-users
Renames a context in the configuration.
wfg config rename-context [CONTEXT_OLD_NAME] [CONTEXT_NEW_NAME]
[CONTEXT_NAME] represents the name given to the CLI context that contains your server and user information.Name | Type | Description | Behavior |
old-name | String | Context name to rename | Required |
new-name | String | New context name | Required |
wfg config rename-context WFGEN_PROD WFGEN_DEV
Renames a server in the configuration.
wfg config rename-server [SERVER_OLD_NAME] [SERVER_NEW_NAME]
Name | Type | Description | Behavior |
old-name | String | Server name to rename | Required |
new-name | String | New server name | Required |
wfg config rename-server WFGEN_PROD_SERVER WFGEN_DEV_SERVER
Renames a user in the configuration.
wfg config rename-user [USER_OLD_NAME] [USER_NEW_NAME]
Name | Type | Description | Behavior |
USER_OLD_NAME | String | Username to rename | Required |
USER_NEW_NAME | String | New username | Required |
wfg config rename-user ADMIN_PROD_ACCOUNT ADMIN_DEV_ACCOUNT
Sets a context entry in the configuration.
wfg config set-context [CONTEXT_NAME] --server [SERVER_NAME] --user [USER_NAME]
[CONTEXT_NAME] represents the name given to the CLI context that contains your server and user information.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 |
wfg config set-context WFGEN_PROD --server WFGEN_PROD_SERVER --user ADMIN_PROD_ACCOUNT
Sets a server entry in the configuration.
wfg config set-server [SERVER_NAME] --url [URL] --version [SERVER_VERSION]
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 |
wfg config set-server WFGEN_PROD_SERVER --url http://localhost/wfgen/admin --version 7.22.0
Sets a user entry in the configuration.
wfg config set-user [USER_NAME] --username [USER_USERNAME] --password [USER_PASSWORD]
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 |
wfg config set-user ADMIN_PROD_ACCOUNT --username wfgen_admin --password QWRtaW4xMjMh
Sets the current context in the configuration.
wfg config use-context [CONTEXT_NAME]
Name | Type | Description | Behavior |
name | String | Context name | Required |
wfg config use-context WFGEN_PROD
[CONTEXT_NAME] represent the name given to the CLI context that contains your server and user information.The
project command lets you either export or import an entire WorkflowGen project from a manifest. Available since WorkflowGen version 7.17.0.
The
init command allow you to generate a manifest.json file interactively.Usage
wfg project init --path projectPath
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 |
wfg project init --path ./MyProject
wfg project init --path ./MyProject --bare --force
Exports a project from your WorkflowGen server to a local repository.
wfg project export --path [PROJECT_PATH]
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 |
wfg project export --path ./MyProject
Imports a project from a local repository to your WorkflowGen server.
wfg project import --source [PATH] --force
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 |
wfg project import --source c:\repository
Displays the content of a manifest link to a project.
Usage
wfg project show --path [PROJECT_PATH]
Alias | Type | Description | Default value | Behavior |
--path or -p | String | Project path | Current directory | Optional |
wfg project show --path c:\repository
The
process command lets you export, import, get, update, or delete a process. Available since WorkflowGen version 7.17.0.
Exports a specific process from your WorkflowGen server to a local repository.
wfg process export [PROCESS_NAME] [PROCESS_VERSION] --destination [PATH]
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 |
wfg process export SIMPLE_APPROVAL 1
Imports a specific process from a local repository to your WorkflowGen server.
wfg process import [PROCESS_PATH] --useVersionNumber --state [STATE] --folder [PROCESS_FOLDER]
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 |