Initialisation du flux uip maestro

Syntaxe et options pour `uip maestro flow init`, qui élaborationt un nouveau projet Flow avec un manifeste et un fichier de démarrage `.flow` minimaux.

uip maestro flow init élabore un nouveau répertoire de projet Flow avec un manifeste minimal et un fichier .flow de démarrage contenant un seul nœud de déclencheur manuel.

Synthèse

uip maestro flow init <name> [--force] [--skip-solution-registration]

Les options globales sont respectées. Les codes de sortie suivent le contrat standard.

Arguments

• <name> (obligatoire) : nom du dossier du projet. Validé par rapport à VALID_PROJECT_NAME_REGEX: lettres, chiffres, traits de soulignement (_) et traits d’union (-) uniquement.

Options

• --force — initialise même si le répertoire cible existe et n'est pas vide. Les fichiers existants ne sont pas effacés - les fichiers sont écrits avec; Cela est utile pour la réinitialisation dans un dossier pré-créé.
• --skip-solution-registration — n'enregistrez pas automatiquement ce projet dans la solution voisine (voir Comportement ci-dessous).

Comportement

La commande écrit deux fichiers dans <name>/:

• project.uiproj — { "Name": "<name>", "ProjectType": "Flow" }
• <name>.flow — référencer le flux JSON contenant:
  • Un core.trigger.manual nœud de démarrage connecté à un entryPointIdgénéré
  • La définition du nœud correspondant dans definitions[]
  • Vide edges, bindings, variables
  • Position layout.nodes.start de la zone de dessin

Enregistrement automatique de la solution. Hormis si --skip-solution-registration est défini:

• Si le répertoire actuel se trouve déjà à l'intérieur d'une solution, le fichier <name>/ y est créé et enregistré en tant que projet dans le manifeste .uipx de cette solution.
• Si le répertoire actuel ne se trouve pas à l'intérieur d'une solution, une solution parente nommée <name>Solution est exécutée automatiquement — le projet Flow se retrouve imbriqué à <name>Solution/<name>/, et non à <name>/ dans le répertoire actuel, comme une lecture littérale de la synthèse pourrait suggérer .

Si <name> existe déjà et n’est pas vide et que --force n’est pas défini, la commande échoue en présentant une erreur invitant l’utilisateur à transmettre --force

Exemples

# Create a new project in ./invoice-flow
uip maestro flow init invoice-flow

# Reinitialize into an existing non-empty folder (e.g. a Git repo)
uip maestro flow init invoice-flow --force

Format des données (--sortie json)

{
  "Code": "FlowInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-flow-projectSolution/my-flow-project",
    "SolutionRegistration": {
      "Status": "Registered",
      "Message": "Project registered in parent solution.",
      "Solution": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx",
      "Project": "my-flow-project/project.uiproj",
      "ProjectId": "00000000-0000-0000-0000-000000000000",
      "Instructions": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
    },
    "AutoCreatedSolution": {
      "Name": "my-flow-projectSolution",
      "Path": "/workspace/my-flow-projectSolution",
      "SolutionFile": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx"
    },
    "ProjectArtifacts": { "Created": true },
    "NextSteps": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
  }
}

AutoCreatedSolution est présent uniquement lorsqu'une solution parente a été exécutée automatiquement (c'est-à-dire que la commande n'a pas été exécutée dans une solution existante). SolutionRegistration est entièrement absent lorsque --skip-solution-registration est transmis.

En cas d'échec, Code est absent et la réponse comporte Result: "Failure", Message et Instructions.

Voir également

• uip maestro flow pack — compresser le projet structuré
• uip maestro flow node — ajoutez des nœuds au fichier .flow de démarrage
• uip maestro flow registry — découvrir les types de nœuds à ajouter
• Vue d’ensemble du flux