Liste de commandes
login
loginLa 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
wfg login [WORKFLOWGEN_URL] -u [WORKFLOWGEN_USERNAME] -p [WORKFLOWGEN_PASSWORD] --password-file [PASSWORD_PATH] -c [CONTEXT_NAME]Authentification Auth0
wfg login [WORKFLOWGEN_URL] --authentication-mode AUTH0 --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]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]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 la section Configuration de Microsoft Entra ID pour les scripts côté serveur du guide WorkflowGen pour Azure.
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]Authentification AD FS
wfg login [WORKFLOWGEN_URL] --authentication-mode ADFS --domain [DOMAIN] --client-id [CLIENT_ID] --client-secret [CLIENT_SECRET] -c [CONTEXT_NAME]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
📌 Exemples de login Auth0
📌 Exemples de login MSIDV2
📌 Exemples de login Okta
📌 Exemples de login AD FS
config
configLa commande config vous permet de configurer la CLI.
current-context
current-contextAffiche le contexte actuel.
Utilisation
delete-context
delete-contextSupprime le contexte spécifié de la configuration.
Utilisation
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du contexte à supprimer
Requis
📌 Exemple
delete-server
delete-serverSupprime le serveur spécifié de la configuration.
Utilisation
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
delete-user
delete-userSupprime l'utilisateur spécifié de la configuration.
Utilisation
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
get-contexts
get-contextsDécrit un ou plusieurs contextes.
Utilisation
Argument
Nom
Type
Description
Comportement
names
Chaîne
Nom(s) du ou des contexte(s) à obtenir
Facultatif
📌 Exemple
get-servers
get-serversAffiche les serveurs définis dans la configuration.
Utilisation
get-users
get-usersAffiche les utilisateurs définis dans la configuration.
Utilisation
rename-context
rename-contextRenomme un contexte dans la configuration.
Utilisation
Arguments
Nom
Type
Description
Comportement
old-name
Chaîne
Nom du contexte à renommer
Requis
new-name
Chaîne
Nouveau nom du contexte
Requis
📌 Exemple
rename-server
rename-serverRenomme un serveur dans la configuration.
Utilisation
Arguments
Nom
Type
Description
Comportement
old-name
Chaîne
Nom du serveur à renommer
Requis
new-name
Chaîne
Nouveau nom du serveur
Requis
📌 Exemple
rename-user
rename-userRenomme un utilisateur dans la configuration.
Utilisation
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
set-context
set-contextDéfinit une entrée de contexte dans la configuration.
Utilisation
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
set-server
set-serverDéfinit une entrée de serveur dans la configuration.
Utilisation
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
set-user
set-userDéfinit une entrée utilisateur dans la configuration.
Utilisation
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
use-context
use-contextDéfinit le contexte actuel dans la configuration.
Utilisation
Argument
Nom
Type
Description
Comportement
name
Chaîne
Nom du contexte
Requis
📌 Exemple
project
projectLa commande project vous permet d'exporter ou d'importer un projet WorkflowGen entier à partir d'un manifeste.
init
initLa commande init vous permet de générer un fichier manifest.json de manière interactive.
Utilisation
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
export
exportExporte un projet de votre serveur WorkflowGen vers un référentiel local.
Utilisation
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
import
importImporte un projet d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
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
show
showAffiche le contenu d'un lien de manifeste vers un projet.
Utilisation
Option
Alias
Type
Description
Valeur par défaut
Comportement
--path ou -p
Chaîne
Chemin du projet
Répertoire actuel
Facultatif
📌 Exemple
process
processLa commande process vous permet d'exporter (export), d'importer (import), d'afficher (get), de mettre à jour (update) ou de supprimer (delete) un processus.
export
exportExporte un processus spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
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
import
importImporte un processus spécifique d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
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
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 est3, définir ce paramètre surfalseimportera le processus en tant que version4).
state
stateL'état (state) peut être l'un des suivants :
TEST(par défaut)ACTIVEDEVARCHIVE
📌 Exemple
get
getAffiche un ou plusieurs processus.
Utilisation
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
update
updateMet à jour les informations pour un seul processus.
Utilisation
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
📌 Exemple
delete
deleteSupprime un seul processus par nom et version.
Utilisation
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom du processus
Requis
version
Int
Version du processus
Requis
📌 Exemple
test
testExécute des cas de test de vos processus
Utilisation
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
📌 Exemple d'un fichier de test
global-list
global-listLa commande global-list vous permet d'exporter (export), d'importer (import), d'afficher (get) ou de supprimer (delete) une liste globale.
export
exportExporte une liste globale spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
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
import
importImporte 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
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
get
getAffiche une ou plusieurs listes globales.
Utilisation
Arguments
Nom
Type
Description
Comportement
names
Chaîne
Nom(s) de la ou des liste(s) globale(s)
Facultatif
Option
Alias
Type
Description
Valeur par défaut
Comportement
--output or -o
Chaîne
Définit la valeur de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
delete
deleteSupprime une seule liste globale par nom.
Utilisation
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom de la liste globale
Requis
📌 Exemple
application
applicationLa commande application vous permet d'exporter (export), d'importer, d'afficher (get), d'afficher les paramètres (get-parameters) ou de supprimer (delete) une application.
export
exportExporte une application spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom de l'application
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--destination ou -d
Chaîne
Chemin d'exportation
Répertoire actuel
Facultatif
📌 Exemple
import
importImporte une application spécifique de votre référentiel local vers votre serveur WorkflowGen.
Utilisation
Arguments
Nom
Type
Description
Comportement
file-path
Chaîne
Le chemin complet contenant le fichier JSON de l'application
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--force ou -f
Booléen
Met à jour l'application spécifiée
false
Facultatif
📌 Exemple
get
getAffiche une ou plusieurs applications.
Utilisation
Arguments
Nom
Type
Description
Comportement
names
Chaîne
Nom(s) de la ou des application(s)
Facultatif
Option
Alias
Type
Description
Valeur par défaut
Comportement
--output ou -o
Chaîne
Définit le format de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
get-parameters
get-parametersAffiche les paramètres d'une application.
Utilisation
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom de l'application
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--output ou -o
Chaîne
Définit le format de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
delete
deleteSupprime une seule application par son nom.
Utilisation
Arguments
Nom
Type
Description
Comportement
name
Chaîne
Nom de l'application
Requis
📌 Exemple
action
actionget
getAffiche les informations d'action d'une demande ou d'un processus.
Utilisation
Argument
Nom
Type
Description
Comportement
requestNumber
Int
Numéro d'identification de la demande que vous souhaitez obtenir
Facultatif
Option
Alias
Type
Description
Valeur par défaut
Comportement
--processName ou -p
Chaîne
Nom du processus dont vous souhaitez récupérer les actions
(aucune)
Facultatif
--processVersion ou -v
Int
Version du processus dont vous souhaitez récupérer les actions
(aucune)
Facultatif
--status ou -s
Chaîne
Récupérer les demandes avec un statut spécifié (OPEN ou CLOSED)
(aucune)
Facultatif
--output ou -o
Chaîne
Définit le format de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
complete
completeEffectuer une action pour un processus.
Utilisation
Argument
Nom
Type
Description
Comportement
activityNumber
Int
Numéro d'action de l'action que vous souhaitez effectuer
Requis
requestNumber
Int
Numéro d'identification de la demande dont vous souhaitez effectuer l'action
Requis
Option
Alias
Type
Description
Comportement
--parameter ou -p
Chaîne
Votre paramètre d'action complet contient une chaîne au format suivant :ValueType:ParameterName=Value. ValueType peut être text,numeric ou date
Facultatif
📌 Exemple
cancel
cancelAnnule une action en cours.
Utilisation
Argument
Nom
Type
Description
Comportement
activityNumber
Int
Numéro d'action de l'action que vous souhaitez annuler
Requis
requestNumber
Int
Numéro d'identification de la demande dont vous souhaitez annuler l'action
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--force ou -f
Booléen
Force l'annulation
false
Facultatif
📌 Example
request
requestget
getGère un demande WorkflowGen.
Utilisation
Argument
Nom
Type
Description
Comportement
requestNumber
Chaîne
Numéro(s) d'identification de la ou des demandes que vous souhaitez obtenir
Facultatif
Option
Alias
Type
Description
Valeur par défaut
Comportement
--processName ou -p
Chaîne
Nom du processus dont vous souhaitez récupérer les demandes
(aucune)
Facultatif
--processVersion ou -v
Int
Version du processus dont vous souhaitez récupérer les demandes
(aucune)
Facultatif
--status ou -s
Chaîne
Récupérer les demandes avec le statut spécifié (OPEN ou CLOSED)
(aucune)
Facultatif
--output ou -o
Chaîne
Définit le format de sortie. Valeurs valides : json, table.
table
Facultatif
📌 Exemple
create
createCrée une nouvelle demande à partir d'un processus.
Utilisation
Argument
Nom
Type
Description
Comportement
processName
Chaîne
Nom du processus dont vous souhaitez créer une demande
Requis
processVersion
Int
Version du processus dont vous souhaitez créer une demande
Requis
Option
Alias
Type
Description
Comportement
--parameter ou -p
Chaîne
Votre paramètre d'action complet contient une chaîne au format suivant : ValueType:ParameterName=Value. ValueType peut être text,numeric ou date.
Facultatif
📌 Exemple
cancel
cancelAnnule une demande en cours.
Utilisation
Argument
Nom
Type
Description
Comportement
requestNumber
Int
Le numéro de demande que vous souhaitez annuler
Requis
Option
Alias
Type
Description
Valeur par défaut
Comportement
--force ou -f
Booléen
Force l'annulation
false
Facultatif
📌 Exemple
graphql
graphqlLa commande graphql vous permet d'exécuter une requête GraphQL personnalisée.
Utilisation
Arguments
Nom
Type
Description
Comportement
--variable ou -v
Chaîne
Entre une variable qui sera lue sous forme de chaîne brute
Voir ci-dessous
--variableCast ou -V
Chaîne
Entre une variable que la CLI tentera de caster dans un type JSON valide
Voir ci-dessous
--variableJson
JSON
Entre un objet JSON contenant les noms des variables en tant que clés et les valeurs des variables en tant que valeurs de ces clés.
📌 Exemple : { "key": "value" }
Voir ci-dessous
Si la commande graphql utilise des variables, vous devez spécifier soit --variable et --variableCast, soit --variableJson. Vous ne pouvez pas utiliser --variableJson avec les deux autres arguments et vice-versa.
📌 Exemples
En raison d'un bogue PowerShell connu au moment de l'écriture (https://github.com/PowerShell/PowerShell/issues/1995), les guillemets (") seront supprimés de la chaîne lors de son envoi à un exécutable natif. La solution consiste à ajouter une barre oblique inverse (\) avant chaque guillemet ou à utiliser trois guillemets (""").
Mis à jour