Liste de commandes
login
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
L'authentification de base ou intégrée est disponible depuis la version 7.0.0 de WorkflowGen.
Authentification Auth0
L'authentification Auth0 est disponible depuis la version 7.11.0 de WorkflowGen.
Authentification MSIDV2 (Microsoft Identity Platform v2)
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
L'authentification Okta est disponible depuis la version 7.13.0 de WorkflowGen.
Authentification AD FS
L'authentification AD FS est disponible depuis la version 7.11.0 de WorkflowGen.
Arguments
Nom | Type | Description | Comportement |
| Chaîne | URL WorkflowGen | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Nom d'utilisateur WorkflowGen | Aucune | Requis |
| Chaîne | Mot de passe WorkflowGen | Aucune | Facultatif |
| Chaîne | Chemin du fichier contenant le mot de passe WorkflowGen | Aucune | Facultatif |
| Chaîne | Chemin des formulaires Web |
| Facultatif |
| Chaîne | Nom du contexte |
| Facultatif |
| Chaîne | Mode d'authentification ( |
| Facultatif |
| Chaîne | L'identifiant public du client | Aucune | Facultatif |
| Chaîne | Le domaine pour | Aucune | Facultatif |
| Chaîne | L'ID de locataire pour | Aucune | Facultatif |
| Chaîne | L'URL de métadonnées pour | Aucune | Facultatif |
| Chaîne | Donnée seulement connue de l’application et du serveur d’autorisation | Aucune | Facultatif |
| Chaîne | Fichier contenant le secret client seulement connu de l’application et du serveur d’autorisation | Aucune | Facultatif |
| 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
config
La commande config
vous permet de configurer la CLI.
Disponible depuis la version 7.0.0 de WorkflowGen.
current-context
current-context
Affiche le contexte actuel.
Utilisation
delete-context
delete-context
Supprime le contexte spécifié de la configuration.
Utilisation
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du contexte à supprimer | Requis |
📌 Exemple
delete-server
delete-server
Supprime le serveur spécifié de la configuration.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du serveur à supprimer | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Force la suppression du serveur et supprime les contextes associés |
| Facultatif |
📌 Exemple
delete-user
delete-user
Supprime l'utilisateur spécifié de la configuration.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom de l'utilisateur à supprimer | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Force la suppression de l'utilisateur et supprime les contextes associés |
| Facultatif |
📌 Exemple
get-contexts
get-contexts
Décrit un ou plusieurs contextes.
Utilisation
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom(s) du ou des contexte(s) à obtenir | Facultatif |
📌 Exemple
get-servers
get-servers
Affiche les serveurs définis dans la configuration.
Utilisation
get-users
get-users
Affiche les utilisateurs définis dans la configuration.
Utilisation
rename-context
rename-context
Renomme un contexte dans la configuration.
Utilisation
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du contexte à renommer | Requis |
| Chaîne | Nouveau nom du contexte | Requis |
📌 Exemple
rename-server
rename-server
Renomme un serveur dans la configuration.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du serveur à renommer | Requis |
| Chaîne | Nouveau nom du serveur | Requis |
📌 Exemple
rename-user
rename-user
Renomme un utilisateur dans la configuration.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom d'utilisateur à renommer | Requis |
| Chaîne | Nouveau nom d'utilisateur | Requis |
📌 Exemple
set-context
set-context
Définit une entrée de contexte dans la configuration.
Utilisation
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du contexte | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Nom du serveur | Aucune | Requis |
| Chaîne | Nom d'utilisateur | Aucune | Requis |
📌 Exemple
set-server
set-server
Définit une entrée de serveur dans la configuration.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du serveur | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | URL WorkflowGen | Aucune | Facultatif |
| Chaîne | Chemin des formulaires Web WorkflowGen | Aucune | Facultatif |
| Chaîne | Version de WorkflowGen | Aucune | Facultatif |
📌 Exemple
set-user
set-user
Définit une entrée utilisateur dans la configuration.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom d'utilisateur | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Nom d'utilisateur WorkflowGen | Aucune | Requis |
| Chaîne | Mot de passe WorkflowGen | Aucune | Requis |
📌 Exemple
use-context
use-context
Définit le contexte actuel dans la configuration.
Utilisation
[CONTEXT_NAME]
représente le nom donné au contexte CLI qui contient vos informations de serveur et d'utilisateur.
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du contexte | Requis |
📌 Exemple
project
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
init
La 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 |
| Chaîne | Chemin du répertoire où le projet sera initialisé | Répertoire actuel | Facultatif |
| Booléen | Générer un fichier |
| Facultatif |
| Booléen | Forcer la génération du |
| Facultatif |
📌 Exemples
export
export
Exporte un projet de votre serveur WorkflowGen vers un référentiel local.
Utilisation
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| 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
import
Importe un projet d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Chemin du projet | Répertoire actuel | Facultatif |
| Booléen | Met à jour les listes globales et applications existantes du projet |
| Facultatif |
📌 Exemple
show
show
Affiche le contenu d'un lien de manifeste vers un projet.
Utilisation
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Chemin du projet | Répertoire actuel | Facultatif |
📌 Exemple
process
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
export
Exporte un processus spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du processus | Requis |
| Int | Version du processus | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Chemin d'exportation | Répertoire actuel | Facultatif |
📌 Exemple
import
import
Importe un processus spécifique d'un référentiel local vers votre serveur WorkflowGen.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Chemin du fichier XML de processus | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Utiliser la version de processus du fichier XML |
| Facultatif |
| Chaîne | Spécifie avec quel statut le processus sera importé |
| Facultatif |
| String | Nom de destination du dossier de processus dans lequel importer le processus; le dossier doit exister |
| 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 surfalse
importera le processus en tant que version4
).
state
state
L'état (state
) peut être l'un des suivants :
TEST
(par défaut)ACTIVE
DEV
ARCHIVE
📌 Exemple
get
get
Affiche un ou plusieurs processus.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du processus | Facultatif |
| Int | Version du processus | Facultatif (sauf si un nom est spécifié) |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Définit la valeur de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
update
update
Met à jour les informations pour un seul processus.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du processus | Requis |
| Int | Version du processus | Requis |
Options
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Spécifie la description avec laquelle le processus sera mis à jour | Aucune | Facultatif |
| Chaîne | Spécifie avec quel statut le processus sera mis à jour | Aucune | Facultatif |
📌 Exemple
delete
delete
Supprime un seul processus par nom et version.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom du processus | Requis |
| Int | Version du processus | Requis |
📌 Exemple
test
test
Exécute des cas de test de vos processus
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Chemin(s) vers le(s) fichier(s) de test | Requis |
Option
Nom | Type | Description | Comportement |
| Chaîne | Établit le niveau de verbosité. Valeurs possibles : | Facultatif |
| 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-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
export
Exporte une liste globale spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom de la liste globale | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Chemin d'exportation | Répertoire actuel | Facultatif |
📌 Exemple
import
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
Argument
Nom | Type | Description | Comportement |
| Chaîne | Le chemin vers le fichier XML de la liste globale | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Met à jour la liste globale spécifiée |
| Facultatif |
📌 Exemple
get
get
Affiche une ou plusieurs listes globales.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom(s) de la ou des liste(s) globale(s) | Facultatif |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Définit la valeur de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
delete
delete
Supprime une seule liste globale par nom.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom de la liste globale | Requis |
📌 Exemple
application
application
La 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.
Disponible depuis la version 7.14.0 de WorkflowGen.
export
export
Exporte une application spécifique de votre serveur WorkflowGen vers un référentiel local.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom de l'application | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Chemin d'exportation | Répertoire actuel | Facultatif |
📌 Exemple
import
import
Importe une application spécifique de votre référentiel local vers votre serveur WorkflowGen.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Le chemin complet contenant le fichier JSON de l'application | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Met à jour l'application spécifiée |
| Facultatif |
📌 Exemple
get
get
Affiche une ou plusieurs applications.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom(s) de la ou des application(s) | Facultatif |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Définit le format de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
get-parameters
get-parameters
Affiche les paramètres d'une application.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom de l'application | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Définit le format de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
delete
delete
Supprime une seule application par son nom.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Nom de l'application | Requis |
📌 Exemple
action
action
Disponible depuis la version 7.17.0 de WorkflowGen.
get
get
Affiche les informations d'action d'une demande ou d'un processus.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Int | Numéro d'identification de la demande que vous souhaitez obtenir | Facultatif |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Chaîne | Nom du processus dont vous souhaitez récupérer les actions | (aucune) | Facultatif |
| Int | Version du processus dont vous souhaitez récupérer les actions | (aucune) | Facultatif |
| Chaîne | Récupérer les demandes avec un statut spécifié ( | (aucune) | Facultatif |
| Chaîne | Définit le format de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
complete
complete
Effectuer une action pour un processus.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Int | Numéro d'action de l'action que vous souhaitez effectuer | Requis |
| Int | Numéro d'identification de la demande dont vous souhaitez effectuer l'action | Requis |
Option
Alias | Type | Description | Comportement |
| Chaîne | Votre paramètre d'action complet contient une chaîne au format suivant : | Facultatif |
📌 Exemple
cancel
cancel
Annule une action en cours.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Int | Numéro d'action de l'action que vous souhaitez annuler | Requis |
| Int | Numéro d'identification de la demande dont vous souhaitez annuler l'action | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Force l'annulation |
| Facultatif |
📌 Example
request
request
Disponible depuis la version 7.17.0 de WorkflowGen.
get
get
Gère un demande WorkflowGen.
Utilisation
Argument
Nom | Type | Description | Comportement |
| 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 |
| Chaîne | Nom du processus dont vous souhaitez récupérer les demandes | (aucune) | Facultatif |
| Int | Version du processus dont vous souhaitez récupérer les demandes | (aucune) | Facultatif |
| Chaîne | Récupérer les demandes avec le statut spécifié ( | (aucune) | Facultatif |
| Chaîne | Définit le format de sortie. Valeurs valides : |
| Facultatif |
📌 Exemple
create
create
Crée une nouvelle demande à partir d'un processus.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Chaîne | Nom du processus dont vous souhaitez créer une demande | Requis |
| Int | Version du processus dont vous souhaitez créer une demande | Requis |
Option
Alias | Type | Description | Comportement |
|
| Votre paramètre d'action complet contient une chaîne au format suivant : | Facultatif |
📌 Exemple
cancel
cancel
Annule une demande en cours.
Utilisation
Argument
Nom | Type | Description | Comportement |
| Int | Le numéro de demande que vous souhaitez annuler | Requis |
Option
Alias | Type | Description | Valeur par défaut | Comportement |
| Booléen | Force l'annulation |
| Facultatif |
📌 Exemple
graphql
graphql
La commande graphql
vous permet d'exécuter une requête GraphQL personnalisée.
Disponible depuis la version 7.0.0 de WorkflowGen.
Utilisation
Arguments
Nom | Type | Description | Comportement |
| Chaîne | Entre une variable qui sera lue sous forme de chaîne brute | Voir ci-dessous |
| Chaîne | Entre une variable que la CLI tentera de caster dans un type JSON valide | Voir ci-dessous |
| 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 : | 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 ("""
).
Dernière mise à jour