Liste de commandes
La commande
login
vous permet d'ajouter vos informations d'identification WorkflowGen pour autoriser l'interface de ligne de commande (CLI). La CLI supporte l'authentification de base et l'authentification OpenID Connect.wfg login [WORKFLOWGEN_URL] -u [WORKFLOWGEN_USERNAME] -p [WORKFLOWGEN_PASSWORD] --password-file [PASSWORD_PATH] -c [CONTEXT_NAME]
L'authentification de base ou intégrée est disponible depuis la version 7.0.0 de WorkflowGen.
Authentification Auth0
wfg login [WORKFLOWGEN_URL] --authentication-mode AUTH0 --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
L'authentification Auth0 est disponible depuis la version 7.11.0 de WorkflowGen.
Authentification MSIDV2 (Microsoft Identity Platform v2)
wfg login [WORKFLOWGEN_URL] --authentication-mode MSIDV2 --tenant-id [TENANT_ID] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
L'authentification MSIDV2 est disponible depuis la version 7.16.0 de WorkflowGen.
Pour le mode MSIDV2, vous devez préalablement avoir enregistré une nouvelle application dédiée (
application côté serveur
) dans votre Azure Active Directory et sur votre serveur WorkflowGen en suivant les directives tel qu'indiquées dans le chapitre Configuration d'Azure Active Directory pour les scripts côté serveur.
Toutes les opérations invoquées à partir de la CLI WorkflowGen utiliseront donc le compte de l'utilisateur spécifié dans le champ Nom d’utilisateur d'impersonnification
de l'application Client Non Interactif
associée à la CLI WorkflowGen dans WorkflowGen. Authentification Okta
wfg login [WORKFLOWGEN_URL] --authentication-mode OKTA --metadata-url [METADATA_URL] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
L'authentification Okta est disponible depuis la version 7.13.0 de WorkflowGen.
Authentification AD FS
wfg login [WORKFLOWGEN_URL] --authentication-mode ADFS --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
L'authentification AD FS est disponible depuis la version 7.11.0 de WorkflowGen.
Nom | Type | Description | Comportement |
url | Chaîne | URL WorkflowGen | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--username ou -u | Chaîne | Nom d'utilisateur WorkflowGen | Aucune | Requis |
--password ou -p | Chaîne | Mot de passe WorkflowGen | Aucune | Facultatif |
-- password-file | Chaîne | Chemin du fichier contenant le mot de passe WorkflowGen | Aucune | Facultatif |
--webforms ou -w | Chaîne | Chemin des formulaires Web | C:\inetpub\wwwroot\wfgen\wfapps\webforms | Facultatif |
--context ou -c | Chaîne | Nom du contexte | DEFAULT | Facultatif |
--authentication-mode | Chaîne | Mode d'authentification ( BASIC , AUTH0 , MSIDV2 , ADFS , OKTA ) | BASIC | Facultatif |
--client-id | Chaîne | L'identifiant public du client | Aucune | Facultatif |
--domain | Chaîne | Le domaine pour ADFS ou AUTH0 | Aucune | Facultatif |
--tenant-id | Chaîne | L'ID de locataire pour MSIDV2 | Aucune | Facultatif |
--metadata-url | Chaîne | L'URL de métadonnées pour OKTA | Aucune | Facultatif |
--client-secret | Chaîne | Donnée seulement connue de l’application et du serveur d’autorisation | Aucune | Facultatif |
--client-secret-file | Chaîne | Fichier contenant le secret client seulement connu de l’application et du serveur d’autorisation | Aucune | Facultatif |
--port | Chaîne | Le port de WorkflowGen | Aucune | Facultatif |
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 --domain myDomain.auth0.com --client-id myClientId --client-secret myClientSecret
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
La commande
config
vous permet de configurer la CLI.Disponible depuis la version 7.0.0 de WorkflowGen.
Affiche le contexte actuel.
wfg config current-context
Supprime le contexte spécifié de la configuration.
wfg config delete-context [CONTEXT_NAME]
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.Nom | Type | Description | Comportement |
name | Chaîne | Nom du contexte à supprimer | Requis |
wfg config delete-context WFGEN_PROD
Supprime le serveur spécifié de la configuration.
wfg config delete-server [SERVER_NAME] --force
Nom | Type | Description | Comportement |
name | Chaîne | Nom du serveur à supprimer | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--force ou -f | Booléen | Force la suppression du serveur et supprime les contextes associés | false | Facultatif |
wfg config delete-server WFGEN_PROD_SERVER --force
Supprime l'utilisateur spécifié de la configuration.
wfg config delete-user [NAME] --force
Nom | Type | Description | Comportement |
name | Chaîne | Nom de l'utilisateur à supprimer | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--force ou -f | Booléen | Force la suppression de l'utilisateur et supprime les contextes associés | false | Facultatif |
wfg config delete-user ADMIN_PROD_ACCOUNT --force
Décrit un ou plusieurs contextes.
wfg config get-contexts [CONTEXT_NAME1] [CONTEXT_NAME2] [CONTEXT_NAME3]
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.Nom | Type | Description | Comportement |
names | Chaîne | Nom(s) du ou des contexte(s) à obtenir | Facultatif |
wfg config get-contexts WFGEN_PROD
Affiche les serveurs définis dans la configuration.
wfg config get-servers
Affiche les utilisateurs définis dans la configuration.
wfg config get-users
Renomme un contexte dans la configuration.
wfg config rename-context [CONTEXT_OLD_NAME] [CONTEXT_NEW_NAME]
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.Nom | Type | Description | Comportement |
old-name | Chaîne | Nom du contexte à renommer | Requis |
new-name | Chaîne | Nouveau nom du contexte | Requis |
wfg config rename-context WFGEN_PROD WFGEN_DEV
Renomme un serveur dans la configuration.
wfg config rename-server [SERVER_OLD_NAME] [SERVER_NEW_NAME]
Nom | Type | Description | Comportement |
old-name | Chaîne | Nom du serveur à renommer | Requis |
new-name | Chaîne | Nouveau nom du serveur | Requis |
wfg config rename-server WFGEN_PROD_SERVER WFGEN_DEV_SERVER
Renomme un utilisateur dans la configuration.
wfg config rename-user [USER_OLD_NAME] [USER_NEW_NAME]
Nom | Type | Description | Comportement |
USER_OLD_NAME | Chaîne | Nom d'utilisateur à renommer | Requis |
USER_NEW_NAME | Chaîne | Nouveau nom d'utilisateur | Requis |
wfg config rename-user ADMIN_PROD_ACCOUNT ADMIN_DEV_ACCOUNT
Définit une entrée de contexte dans la configuration.
wfg config set-context [CONTEXT_NAME] --server [SERVER_NAME] --user [USER_NAME]
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.Nom | Type | Description | Comportement |
name | Chaîne | Nom du contexte | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--server ou -s | Chaîne | Nom du serveur | Aucune | Requis |
--user ou -u | Chaîne | Nom d'utilisateur | Aucune | Requis |
wfg config set-context WFGEN_PROD --server WFGEN_PROD_SERVER --user ADMIN_PROD_ACCOUNT
Définit une entrée de serveur dans la configuration.
wfg config set-server [SERVER_NAME] --url [URL] --version [SERVER_VERSION]
Nom | Type | Description | Comportement |
name | Chaîne | Nom du serveur | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--url ou -u | Chaîne | URL WorkflowGen | Aucune | Facultatif |
--webforms ou -w | Chaîne | Chemin des formulaires Web WorkflowGen | Aucune | Facultatif |
--version ou -v | Chaîne | Version de WorkflowGen | Aucune | Facultatif |
wfg config set-server WFGEN_PROD_SERVER --url http://localhost/wfgen/admin --version 7.22.0
Définit une entrée utilisateur dans la configuration.
wfg config set-user [USER_NAME] --username [USER_USERNAME] --password [USER_PASSWORD]
Nom | Type | Description | Comportement |
name | Chaîne | Nom d'utilisateur | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--username ou -u | Chaîne | Nom d'utilisateur WorkflowGen | Aucune | Requis |
--password ou -w | Chaîne | Mot de passe WorkflowGen | Aucune | Requis |
wfg config set-user ADMIN_PROD_ACCOUNT --username wfgen_admin --password QWRtaW4xMjMh
Définit le contexte actuel dans la configuration.
wfg config use-context [CONTEXT_NAME]
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.Nom | Type | Description | Comportement |
name | Chaîne | Nom du contexte | Requis |
wfg config use-context WFGEN_PROD
La commande
project
vous permet d'exporter ou d'importer un projet WorkflowGen entier à partir d'un manifeste.Disponible depuis la version 7.17.0 de WorkflowGen.
La commande
init
vous permet de générer un fichier manifest.json
de manière interactive.wfg project init --path projectPath
Alias | Type | Description | Valeur par défaut | Comportement |
--path ou -p | Chaîne | Chemin du répertoire où le projet sera initialisé | Répertoire actuel | Facultatif |
--bare | Booléen | Générer un fichier manifest.json avec le contenu minimal | false | Facultatif |
--force ou -f | Booléen | Forcer la génération du manifest.json | false | Facultatif |
wfg project init --path ./MyProject
wfg project init --path ./MyProject --bare --force
Exporte un projet de votre serveur WorkflowGen vers un référentiel local.
wfg project export --path [PROJECT_PATH]
Alias | Type | Description | Valeur par défaut | Comportement |
--path ou -p | Chaîne | Chemin d'accès au dossier dans lequel se trouvent le manifeste et les fichiers du projet. | Répertoire actuel | Facultatif |
wfg project export --path ./MyProject
Importe un projet d'un référentiel local vers votre serveur WorkflowGen.
wfg project import --source [PATH] --force
Alias | Type | Description | Valeur par défaut | Comportement |
--source ou -s | Chaîne | Chemin du projet | Répertoire actuel | Facultatif |
--force ou -f | Booléen | Met à jour les listes globales et applications existantes du projet | false | Facultatif |
wfg project import --source c:\repository
Affiche le contenu d'un lien de manifeste vers un projet.
wfg project show --path [PROJECT_PATH]
Alias | Type | Description | Valeur par défaut | Comportement |
--path ou -p | Chaîne | Chemin du projet | Répertoire actuel | Facultatif |
wfg project show --path c:\repository
La commande
process
vous permet d'exporter (export
), d'importer (import
), d'afficher (get
), de mettre à jour (update
) ou de supprimer (delete
) un processus.Disponible depuis la version 7.17.0 de WorkflowGen.
Exporte un processus spécifique de votre serveur WorkflowGen vers un référentiel local.
wfg process export [PROCESS_NAME] [PROCESS_VERSION] --destination [PATH]
Nom | Type | Description | Comportement |
name | Chaîne | Nom du processus | Requis |
version | Int | Version du processus | Requis |
Alias | Type | Description | Valeur par défaut | Comportement |
--destination ou -d | Chaîne | Chemin d'exportation | Répertoire actuel | Facultatif |
wfg process export SIMPLE_APPROVAL 1
Importe un processus spécifique d'un référentiel local vers votre serveur WorkflowGen.
wfg process import [PROCESS_PATH] --useVersionNumber --state [STATE]
Nom | Type | Description | Comportement |
file-path | Chaîne | Chemin du fichier XML de processus | Requis |