Démarrer

CLI WorkflowGen
Documentation Forum Support
Rechercher…
1.2.0
Démarrer
Connectez-vous à votre serveur WorkflowGen
Avant d'utiliser la CLI WorkflowGen pour interagir avec votre serveur WorkflowGen, vous devez vous y connecter. Consultez la section login pour plus d'informations.
1
wfg login http://localhost/wfgen -u wfgen_admin -p myPassword -c DEV
Copied!
Gestion de projet
Un projet est composé de processus, de sous-processus, d'applications de workflow personnalisées, de listes globales et de ressources de formulaires Web.
Un projet est basé sur une définition de fichier manifeste (voir la section Manifeste de projet).
La gestion d'un projet avec la CLI vous permet d'exporter ou d'importer le contenu facilement.
Créez un projet simple
Dans la plupart des cas, un projet WorkflowGen est composé de processus et de sous-processus. Le manifeste suivant définit un projet avec un processus et deux sous-processus, avec une liste globale :
1
{
2
  "version": "1.0",
3
  "tag": "1.2.0",
4
	"processes":[
5
    {
6
      "name":"EMPLOYEE_ONBOARDING",
7
      "version":1,
8
      "folder":"HR"
9
    }
10
  ],
11
  "subProcesses":[
12
    {
13
      "name":"CREATE_AD_ACCOUNT",
14
      "version":1,
15
      "folder":"IT"
16
    },
17
    {
18
      "name":"CREATE_ERP_ACCESS",
19
      "version":1,
20
      "folder":"IT"
21
    }
22
  ],
23
  "globalLists": [
24
    "Country"
25
  ]
26
}
Copied!
Vous pouvez utiliser la commande project init pour créer le manifeste avec l'interface de ligne de commande ou écrire la définition directement dans un fichier manifest.json.
Si vous ajoutez des ressources de formulaire Web à votre manifeste, assurez-vous que vous avez correctement défini le chemin d'accès au dossier du formulaire Web sur le serveur WorkflowGen.
Le chemin du formulaire Web est également requis si vous souhaitez exporter le code de processus (contenu dans le fichier Default.aspx).
Exportez votre projet
Une fois votre fichier manifest.json correctement défini, vous pouvez utiliser la commande project export pour télécharger les liens de toutes les sources vers votre projet.
1
wfg project export -p pathToTheFolderWithTheManifest
Copied!
Pour la définition du manifeste, vous devez avoir une structure de dossiers comme celle-ci :
1
| manifest.json
2
| definitions/
3
|    globallists/
4
|        Country.Xml
5
|    subprocesses/
6
|        CREATE_AD_ACCOUNTv1.xml
7
|        CREATE_ERP_ACCESSv1.xml
8
|    processes/
9
|        EMPLOYEE_ONBOARDINGv1.xml
10
| src/
11
|    processes/
12
|        CREATE_AD_ACCOUNT/
13
|                V1/
14
|                    Default.aspx
15
|                    Default.aspx.cs
16
|        CREATE_ERP_ACCESS/
17
|                V1/
18
|                    Default.aspx
19
|                    Default.aspx.cs
20
|        EMPLOYEE_ONBOARDING/
21
|                V1/
22
|                    Default.aspx
23
|                    Default.aspx.cs
Copied!
Importez votre projet
Avec la commande project import, vous pouvez importer votre projet dans un autre serveur WorkflowGen (tel que le serveur de production).
1
wfg project import --source pathToMyProjectFolder
Copied!
La CLI importera toutes les définitions dans votre application WorkflowGen, créera des processus, des sous-processus, des applications et des listes globales, et déplacera les ressources du formulaire Web vers le dossier du formulaire Web.
Exemple vidéo
Utilisation d'une configuration à plusieurs serveurs
La CLI utilise des contextes pour identifier le serveur et l'utilisateur à utiliser pour se connecter à WorkflowGen. Vous pouvez définir plusieurs configurations, une pour chacun de vos serveurs WorkflowGen.
La commande login contient l'option --context pour donner un nom à votre contexte.
La commande config get-contexts vous permet d'afficher tous les contextes définis.
1
wfg config get-contexts
Copied!
Résultat :
1
 ----------------------------------------------------- 
2
 | Current | Context name | Server name | User name  |
3
 ----------------------------------------------------- 
4
 |         | PROD         | CG9FDCK57K  | ZQPWB00VS3 |
5
 ----------------------------------------------------- 
6
 | *       | DEV          | CB6YHR11DD  | ACJTLYG0AZ |
7
 ----------------------------------------------------- 
8
 
9
 Count: 2
Copied!
Vous pouvez passer à un autre contexte avec la commande config use-context.
1
wfg config use-context PROD
Copied!
Options globales
La CLI fournit des options globales pour vous donner d'autres informations.
help
L'option help vous permet d'obtenir des informations sur la façon d'utiliser une commande spécifique ou de voir quelles commandes sont disponibles.
1
wfg --help
Copied!
Résultat :
1
Usage:
2
  wfg [options] [command]
3
​
4
Options:
5
  --debug
6
  --verbose
7
  --version         Show version information
8
  -?, -h, --help    Show help and usage information
9
​
10
Commands:
11
  login <url>
12
  config
13
  process
14
  project
15
  global-list
16
  application
17
  graphql <query>
Copied!
debug
L'option debug vous permet d'afficher plus de logs dans votre terminal lors de l'exécution de la commande.
1
wfg process get --debug
Copied!
verbose
L'option verbose est comme l'option debug, mais la CLI affichera plus de logs que pour debug.
1
wfg process get --verbose
Copied!
version
L'option version renvoie la version actuelle de votre CLI WorkflowGen.
1
wfg --version
Copied!
Activation de la saisie semi-automatique via la touche Tab (tab completion)
PowerShell
Bash
1.Installez l'outil global dotnet-suggest :
1
dotnet tool install --global dotnet-suggest
Copied!
2.Ouvrez votre profil PowerShell et ajoutez-y le code suivant. Vous pouvez obtenir le chemin de votre chemin de profil avec echo $PROFILE.
1
# dotnet suggest shell start
2
$availableToComplete = (dotnet-suggest list) | Out-String
3
$availableToCompleteArray = $availableToComplete.Split([Environment]::NewLine, [System.StringSplitOptions]::RemoveEmptyEntries) 
4
​
5
Register-ArgumentCompleter -Native -CommandName $availableToCompleteArray -ScriptBlock {
6
    param($commandName, $wordToComplete, $cursorPosition)
7
    $fullpath = (Get-Command $wordToComplete.CommandElements[0]).Source
8
​
9
    $arguments = $wordToComplete.Extent.ToString().Replace('"', '\"')
10
    dotnet-suggest get -e $fullpath --position $cursorPosition -- "$arguments" | ForEach-Object {
11
        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
12
    }
13
}
14
​
15
$env:DOTNET_SUGGEST_SCRIPT_VERSION = "1.0.0"
16
# dotnet suggest script end
Copied!
1.Installez l'outil global dotnet-suggest :
1
dotnet tool install --global dotnet-suggest
Copied!
2.Ouvrez votre profil bash (~/.bash_profile) et ajoutez-y le code suivant :
1
# dotnet suggest shell complete script start
2
_dotnet_bash_complete()
3
{
4
    local fullpath=`type -p ${COMP_WORDS[0]}`
5
    local escaped_comp_line=$(echo "$COMP_LINE" | sed s/\"/'\\\"'/g)
6
    local completions=`dotnet-suggest get --executable "${fullpath}" --position ${COMP_POINT} -- "${escaped_comp_line}"`
7
​
8
    if [ "${#COMP_WORDS[@]}" != "2" ]; then
9
        return
10
    fi
11
​
12
    local IFS=#x27;\n'
13
    local suggestions=($(compgen -W "$completions"))
14
​
15
    if [ "${#suggestions[@]}" == "1" ]; then
16
        local number="${suggestions[0]/%\ */}"
17
        COMPREPLY=("$number")
18
    else
19
        for i in "${!suggestions[@]}"; do
20
            suggestions[$i]="$(printf '%*s' "-$COLUMNS"  "${suggestions[$i]}")"
21
        done
22
​
23
        COMPREPLY=("${suggestions[@]}")
24
    fi
25
}
26
​
27
_dotnet_bash_register_complete()
28
{
29
    local IFS=#x27;\n'
30
    complete -F _dotnet_bash_complete `dotnet-suggest list`
31
}
32
_dotnet_bash_register_complete
33
export DOTNET_SUGGEST_SCRIPT_VERSION="1.0.1"
34
# dotnet suggest shell complete script end
Copied!
Pour utiliser les outils dotnet-suggest, vous devez installer .NET Core 3.1.