Liste de commandes

CLI WorkflowGen
Documentation Forum Support
Rechercher…
1.2.0
Liste de commandes
login
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.
Authentification de base ou intégrée
1
wfg login [WORKFLOWGEN_URL] -u [WORKFLOWGEN_USERNAME] -p [WORKFLOWGEN_PASSWORD] --password-file [PASSWORD_PATH] -c [CONTEXT_NAME]
Copied!
L'authentification de base ou intégrée est disponible depuis la version 7.0.0 de WorkflowGen.
Authentification Auth0
1
wfg login [WORKFLOWGEN_URL] --authentication-mode AUTH0 --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Copied!
L'authentification Auth0 est disponible depuis la version 7.11.0 de WorkflowGen.
Authentification MSIDV2 (Microsoft Identity Platform v2)
1
wfg login [WORKFLOWGEN_URL] --authentication-mode MSIDV2 --tenant-id [TENANT_ID] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Copied!
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
1
wfg login [WORKFLOWGEN_URL] --authentication-mode OKTA --metadata-url [METADATA_URL] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Copied!
L'authentification Okta est disponible depuis la version 7.13.0 de WorkflowGen.
Authentification AD FS
1
wfg login [WORKFLOWGEN_URL] --authentication-mode ADFS --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]
Copied!
L'authentification AD FS est disponible depuis la version 7.11.0 de WorkflowGen.
Arguments
Nom
Type
Description
Comportement
url
Chaîne
URL WorkflowGen
Requis
Options
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
📌 Exemples de login de base
1
wfg login http://localhost/wfgen -u wfgen_admin -p myPassword
Copied!
1
wfg login http://localhost/wfgen -u wfgen_admin --password-file ./path/to/password.txt
Copied!
📌 Exemples de login Auth0
1
wfg login http://localhost/wfgen --authentication-mode AUTH0 --domain myDomain.auth0.com --client-id myClientId
Copied!
1
wfg login http://localhost/wfgen --authentication-mode AUTH0 --domain myDomain.auth0.com --client-id myClientId --client-secret myClientSecret
Copied!
📌 Exemples de login MSIDV2
1
wfg login http://localhost/wfgen --authentication-mode MSIDV2 --tenant-id myTenantId --client-id myClientId
Copied!
1
wfg login http://localhost/wfgen --authentication-mode MSIDV2 --tenant-id myTenantId --client-id myClientId --client-secret myClientSecret
Copied!
📌 Exemples de login Okta
1
wfg login http://localhost/wfgen --authentication-mode OKTA --metadata-url https://MyOktaDomain/.well-known/openid-configuration --client-id myClientId
Copied!
1
wfg login http://localhost/wfgen --authentication-mode OKTA --metadata-url https://MyOktaDomain/.well-known/openid-configuration --client-id myClientId --client-secret myClientSecret
Copied!
📌 Exemples de login AD FS
1
wfg login http://localhost/wfgen --authentication-mode ADFS --domain myAdfsDomain --client-id myClientId
Copied!
1
wfg login http://localhost/wfgen --authentication-mode ADFS --domain myAdfsDomain --client-id myClientId --client-secret myClientSecret
Copied!
config
La commande config vous permet de configurer la CLI.
Disponible depuis la version 7.0.0 de WorkflowGen.
current-context
Affiche le contexte actuel.
Utilisation
1
wfg config current-context
Copied!
delete-context
Supprime le contexte spécifié de la configuration.
Utilisation
1
wfg config delete-context [CONTEXT_NAME]
Copied!
[CONTEXT_NAME] représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du contexte à supprimer
Requis
📌 Exemple
1
wfg config delete-context WFGEN_PROD
Copied!
delete-server
Supprime le serveur spécifié de la configuration.
Utilisation
1
wfg config delete-server [SERVER_NAME] --force
Copied!
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du serveur à supprimer
Requis
Option
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
📌 Exemple
1
wfg config delete-server WFGEN_PROD_SERVER --force
Copied!
delete-user
Supprime l'utilisateur spécifié de la configuration.
Utilisation
1
wfg config delete-user [NAME] --force
Copied!
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom de l'utilisateur à supprimer
Requis
Option
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
📌 Exemple
1
wfg config delete-user ADMIN_PROD_ACCOUNT --force
Copied!
get-contexts
Décrit un ou plusieurs contextes.
Utilisation
1
wfg config get-contexts [CONTEXT_NAME1] [CONTEXT_NAME2] [CONTEXT_NAME3]
Copied!
[CONTEXT_NAME] représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom
Type
Description
Comportement
names
Chaîne
Nom(s) du ou des contexte(s) à obtenir
Facultatif
📌 Exemple
1
wfg config get-contexts WFGEN_PROD
Copied!
get-servers
Affiche les serveurs définis dans la configuration.
Utilisation
1
wfg config get-servers
Copied!
get-users
Affiche les utilisateurs définis dans la configuration.
Utilisation
1
wfg config get-users
Copied!
rename-context
Renomme un contexte dans la configuration.
Utilisation
1
wfg config rename-context [CONTEXT_OLD_NAME] [CONTEXT_NEW_NAME]
Copied!
[CONTEXT_NAME] représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Arguments
Nom
Type
Description
Comportement
old-name
Chaîne
Nom du contexte à renommer
Requis
new-name
Chaîne
Nouveau nom du contexte
Requis
📌 Exemple
1
wfg config rename-context WFGEN_PROD WFGEN_DEV
Copied!
rename-server
Renomme un serveur dans la configuration.
Utilisation
1
wfg config rename-server [SERVER_OLD_NAME] [SERVER_NEW_NAME]
Copied!
Arguments
Nom
Type
Description
Comportement
old-name
Chaîne
Nom du serveur à renommer
Requis
new-name
Chaîne
Nouveau nom du serveur
Requis
📌 Exemple
1
wfg config rename-server WFGEN_PROD_SERVER WFGEN_DEV_SERVER
Copied!
rename-user
Renomme un utilisateur dans la configuration.
Utilisation
1
wfg config rename-user [USER_OLD_NAME] [USER_NEW_NAME]
Copied!
Arguments
Nom
Type
Description
Comportement
USER_OLD_NAME
Chaîne
Nom d'utilisateur à renommer
Requis
USER_NEW_NAME
Chaîne
Nouveau nom d'utilisateur
Requis
📌 Exemple
1
wfg config rename-user ADMIN_PROD_ACCOUNT ADMIN_DEV_ACCOUNT
Copied!
set-context
Définit une entrée de contexte dans la configuration.
Utilisation
1
wfg config set-context [CONTEXT_NAME] --server [SERVER_NAME] --user [USER_NAME]
Copied!
[CONTEXT_NAME] représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du contexte
Requis
Options
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
📌 Exemple
1
wfg config set-context WFGEN_PROD --server WFGEN_PROD_SERVER --user ADMIN_PROD_ACCOUNT
Copied!
set-server
Définit une entrée de serveur dans la configuration.
Utilisation
1
wfg config set-server [SERVER_NAME] --url [URL] --version [SERVER_VERSION]
Copied!
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du serveur
Requis
Options
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
📌 Exemple
1
wfg config set-server WFGEN_PROD_SERVER --url http://localhost/wfgen/admin --version 7.22.0
Copied!
set-user
Définit une entrée utilisateur dans la configuration.
Utilisation
1
wfg config set-user [USER_NAME] --username [USER_USERNAME] --password [USER_PASSWORD]
Copied!
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom d'utilisateur
Requis
Options
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
📌 Exemple
1
wfg config set-user ADMIN_PROD_ACCOUNT --username wfgen_admin --password QWRtaW4xMjMh
Copied!
use-context
Définit le contexte actuel dans la configuration.
Utilisation
1
wfg config use-context [CONTEXT_NAME]
Copied!
[CONTEXT_NAME] représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du contexte
Requis
📌 Exemple
1
wfg config use-context WFGEN_PROD
Copied!
project
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.
init
La commande init vous permet de générer un fichier manifest.json de manière interactive.
Utilisation
1
wfg project init --path projectPath
Copied!
Options
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
📌 Exemples
1
wfg project init --path ./MyProject
Copied!
1
wfg project init --path ./MyProject --bare --force
Copied!
export
Exporte un projet de votre serveur WorkflowGen vers un référentiel local.
Utilisation
1
wfg project export --path [PROJECT_PATH]
Copied!
Option
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
📌 Exemple
1
wfg project export --path ./MyProject
Copied!
import
Importe un projet d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
1
wfg project import --source [PATH] --force
Copied!
Options
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
📌 Exemple
1
wfg project import --source c:\repository
Copied!
show
Affiche le contenu d'un lien de manifeste vers un projet.
Utilisation
1
wfg project show --path [PROJECT_PATH]
Copied!
Option
Alias
Type
Description
Valeur par défaut
Comportement
--path ou -p
Chaîne
Chemin du projet
Répertoire actuel
Facultatif
📌 Exemple
1
wfg project show --path c:\repository
Copied!
process
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.
export
Exporte un processus spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
1
wfg process export [PROCESS_NAME] [PROCESS_VERSION] --destination [PATH]
Copied!
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom du processus
Requis
version
Int
Version du processus
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--destination ou -d
Chaîne
Chemin d'exportation
Répertoire actuel
Facultatif
📌 Exemple
1
wfg process export SIMPLE_APPROVAL 1
Copied!
import
Importe un processus spécifique d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
1
wfg process import [PROCESS_PATH] --useVersionNumber --state [STATE]
Copied!
Argument
Nom
Type
Description
Comportement
file-path
Chaîne
Chemin du fichier XML de processus
Requis
Options
Alias
Type
Description
Valeur par défaut
Comportement
--use-version-number
Booléen
Utiliser la version de processus du fichier XML
false
Facultatif
--state ou -s
Chaîne
Spécifie avec quel statut le processus sera importé
TEST
Facultatif
--folder
String
Nom de destination du dossier de processus dans lequel importer le processus; le dossier doit exister
DEFAULT
Facultatif
UseVersionNumber
<use-version-number = true> tentera d'ajouter le processus avec le numéro de version dans le fichier XML, s'il n'existe pas déjà.

<use-version-number = false> ajoutera le processus avec le dernier numéro de version plus un (p.ex. si la dernière version actuelle est 3, définir ce paramètre sur false importera le processus en tant que version 4).
state
L'état (state) peut être l'un des suivants :
TEST (par défaut)
ACTIVE
DEV
ARCHIVE
📌 Exemple
1
wfg process import c:\repository\SIMPLE_APPROVALv1.xml
Copied!
get
Affiche un ou plusieurs processus.
Utilisation
1
wfg process get [PROCESS_NAME] [PROCESS_VERSION] --output
Copied!
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom du processus
Facultatif
version
Int
Version du processus
Facultatif (sauf si un nom est spécifié)
Option
Alias
Type
Description
Valeur par défaut
Comportement
--output ou -o
Chaîne
Définit la valeur de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
1
wfg process get SIMPLE_APPROVAL 1 -o json
Copied!
update
Met à jour les informations pour un seul processus.
Utilisation
1
wfg process update [PROCESS_NAME] [PROCESS_VERSION] -d [DESCRIPTION] -s [STATE]
Copied!
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom du processus
Requis
version
Int
Version du processus
Requis
Options
Alias
Type
Description
Valeur par défaut
Comportement
--description ou -d
Chaîne
Spécifie la description avec laquelle le processus sera mis à jour
Aucune
Facultatif
--state ou -s
Chaîne
Spécifie avec quel statut le processus sera mis à jour
Aucune
Facultatif
state
L'état (state) peut être l'un des suivants :
TEST
ACTIVE
DEV
ARCHIVE
📌 Exemple
1
wfg process update SIMPLE_APPROVAL 1 -s DEV
Copied!
delete
Supprime un seul processus par nom et version.
Utilisation
1
wfg process delete [PROCESS_NAME] [PROCESS_VERSION]
Copied!
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom du processus
Requis
version
Int
Version du processus
Requis
📌 Exemple
1
wfg process delete SIMPLE_APPROVAL 1
Copied!
test
Exécute des cas de test de vos processus
Utilisation
1
wfg process test [PATH_TEST_FILES] --verbosity [LEVEL] --doctor
Copied!
Arguments
Nom
Type
Description
Comportement
test-files
Chaîne
Chemin(s) vers le(s) fichier(s) de test
Requis
Option
Nom
Type
Description
Comportement
--verbosity ou -v
Chaîne
Établit le niveau de verbosité. 
Valeurs possibles : q[uiet],n[ormal] (par défaut),d[etailed]
Facultatif
--doctor
Chaîne
Vérifiez si les cas de test sont conformes. Uniquement disponible à partir de WorkflowGen version 8.0.3.
Facultatif
📌 Exemple
1
wfg process test c:\repository\SIMPLE_APPROVALv1_Test.json c:\repository\SIMPLE_REQUESTv1_Test.json --verbosity quiet
Copied!
📌 Exemple d'un fichier de test
1
{
2
    "processName": "SIMPLE_APPROVAL",
3
    "processVersion": 1,
4
    "tests": [
5
        {
6
            "describe": "First test",
7
            "requestParameters": [],
8
            "actions": [
9
                {
10
                    "name": "INITIATES",
11
                    "operation": "COMPLETE",
12
                    "parameters": [
13
                        {
14
                            "name": "REQUEST_SUBJECT",
15
                            "textValue": "OK"
16
                        }
17
                    ],
18
                    "assertions": {
19
                        "status": "CLOSED",
20
                        "subStatus": "COMPLETED"
21
                    }
22
                },
23
                {
24
                    "name": "VALIDATES",
25
                    "operation": "COMPLETE",
26
                    "parameters": [
27
                        {
28
                            "name": "APPROVAL_DECISION",
29
                            "textValue": "YES"
30
                        }
31
                    ],
32
                    "assertions": {
33
                        "status": "CLOSED",
34
                        "subStatus": "COMPLETED",
35
                        "data": [
36
                            {
37
                                "name": "APPROVAL_DECISION",
38
                                "textValue": "YES"
39
                            }
40
                        ]
41
                    }
42
                }
43
        },
44
        {
45
            "describe": "Second test",
46
            "requestParameters": [],
47
            "actions": [
48
                {
49
                    "name": "INITIATES",
50
                    "operation": "COMPLETE",
51
                    "parameters": [
52
                        {
53
                            "name": "REQUEST_SUBJECT",
54
                            "textValue": "OK"
55
                        }
56
                    ],
57
                    "assertions": {
58
                        "status": "CLOSED",
59
                        "subStatus": "COMPLETED"
60
                    }
61
                },
62
                {
63
                    "name": "VALIDATES",
64
                    "operation": "COMPLETE",
65
                    "parameters": [
66
                        {
67
                            "name": "APPROVAL_DECISION",
68
                            "textValue": "NO"
69
                        }
70
                    ],
71
                    "assertions": {
72
                        "status": "CLOSED",
73
                        "subStatus": "COMPLETED",
74
                        "data": [
75
                            {
76
                                "name": "APPROVAL_DECISION",
77
                                "textValue": "NO"
78
                            }
79
                        ]
80
                    }
81
                },
82
                {
83
                    "name": "UPDATES",
84
                    "operation": "COMPLETE",
85
                    "parameters": [
86
                        {
87
                            "name": "REQUEST_SUBJECT",
88
                            "textValue": "OK2"
89
                        }
90
                    ],
91
                    "assertions": {
92
                        "status": "CLOSED",
93
                        "subStatus": "COMPLETED"
94
                    }
95
                },
96
                {
97
                    "name": "VALIDATES",
98
                    "operation": "COMPLETE",
99
                    "parameters": [
100
                        {
101
                            "name": "APPROVAL_DECISION",
102
                            "textValue": "YES"
103
                        }
104
                    ],
105
                    "assertions": {
106
                        "status": "CLOSED",
107
                        "subStatus": "COMPLETED",
108
                        "data": [
109
                            {
110
                                "name": "APPROVAL_DECISION",
111
                                "textValue": "YES"
112
                            }
113
                        ]
114
                    }
115
                }
116
        }
117
    ],
118
    "deleteRequest": false
119
}
Copied!
global-list
La commande global-list vous permet d'exporter (export), d'importer (import), d'afficher (get) ou de supprimer (delete) une liste globale.
Disponible depuis la version 7.17.0 de WorkflowGen.
export
Exporte une liste globale spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
1
wfg global-list export [GLOBAL_LIST_NAME] --destination [PATH]
Copied!
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom de la liste globale
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--destination ou -d
Chaîne
Chemin d'exportation
Répertoire actuel
Facultatif
📌 Exemple
1
wfg global-list export Country
Copied!
import
Importe une liste globale spécifique de votre référentiel local vers votre serveur WorkflowGen.
Problème connu (#3373) : Voir les notes de version WorkflowGen 7.22.2.
Utilisation
1
wfg global-list import [GLOBAL_LIST_PATH] --force
Copied!
Argument
Nom
Type
Description
Comportement
file-path
Chaîne
Le chemin vers le fichier XML de la liste globale
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--force ou -f
Booléen
Met à jour la liste globale spécifiée
false
Facultatif
📌 Exemple
1
wfg global-list import c:\repository\Country
Copied!
get
Affiche une ou plusieurs listes globales.
Utilisation
1
wfg global-list get [GLOBAL_LIST_NAME] --output
Copied!
Arguments
Nom
Type
Description
Comportement