UIP Maestro フローの初期化

「uip maestro flow init」の構文とオプション。最小限のマニフェストとスターターの「.flow」ファイルを使用して新しいフロー プロジェクトを構成します。

uip maestro flow init は、最小限のマニフェストと、単一の手動トリガーノードを含むスターター .flow ファイルを含む新しいFlowプロジェクトディレクトリをスキャフォールディングします。

概要

uip maestro flow init <name> [--force] [--skip-solution-registration] [--automate] [--sdk-source [file]]

グローバルオプションを優先します。終了コードは 標準コントラクトに従います。

引数

• <name> (required) — project folder name. Allowed characters: letters, numbers, underscores (_), and hyphens (-).

オプション

• --force — ターゲットディレクトリが存在し、空でない場合でも初期化します。既存のファイルはクリア されず 、ファイルは並行して書き込まれます。これは、事前に作成されたフォルダー内で再初期化する場合に便利です。
• --skip-solution-registration — このプロジェクトを周囲のソリューションに自動登録しないでください (以下の「動作」を参照)。
• --automate — create a Maestro Automate project. The project and the commands that operate on it are the same as for a standard Flow project; only the runtime profile written into operate.json differs.
• --sdk-source [file] — also write the builder-SDK source for the new project: decompile the starter .flow file into <project>/.flow-sdk/<name>.flow.ts, or into [file] (relative to the current directory), creating its folder. The result is the same as running uip maestro flow decompile <name>.flow -o <file> --no-pipeline after init. Requires @uipath/maestro-builder-sdk 6.11.1 or later, installed in the project or globally. If [file] already exists, the command fails unless you pass --force.

動作

The command writes these files into <name>/:

• project.uiproj — { "Name": "<name>", "ProjectType": "Flow" }
• operate.json — the project's runtime settings, including the runtime profile that --automate selects
• <name>.flow — 以下を含むシードフロー JSON
  • 生成されたentryPointIdに配線された 1 つのcore.trigger.manual開始ノード
  • definitions[] の一致するノードの定義
  • 空の edges、 bindings、 variables
  • キャンバス layout.nodes.start 位置

ソリューションの自動登録。--skip-solution-registrationが合格しない限り:

• 現在のディレクトリが既にソリューション内にある場合は、 <name>/ がそこに作成され、そのソリューションの .uipx マニフェストにプロジェクトとして登録されます。
• 現在のディレクトリがソリューション内にない場合、<name>Solution という名前の親ソリューションが自動的にスキャフォールディングされます — フロー プロジェクトは、概要を文字どおりに読むと示唆されるように、現在のディレクトリの <name>/ ではなく、最終的に <name>Solution/<name>/にネストされます。

<name>既に存在し、空ではなく、--forceが設定されていない場合、コマンドは失敗し、ユーザーに--forceを渡すよう求めるエラーが表示されます。

With --sdk-source, the command checks for @uipath/maestro-builder-sdk before it creates anything. If the project is created but writing the SDK source fails, the error names the uip maestro flow decompile command that writes the source for the existing project.

例

# 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

# Create a Maestro Automate project
uip maestro flow init my-automate --automate

# Create a project inside an existing solution and write its builder-SDK source
cd MySolution && uip maestro flow init my-flow --sdk-source

データシェイプ(--output 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 is present only when a parent solution was scaffolded automatically (i.e. the command wasn't run inside an existing solution). SolutionRegistration is always present; with --skip-solution-registration, its Status is OptedOut. SdkSource (the path of the written builder-SDK source) is present only with --sdk-source.

失敗した場合、 Code は存在せず、応答は Result: "Failure"、 Messageおよび Instructionsを運びます。

参照

• uip maestro flow pack — スキャフォールディングされたプロジェクトを梱包する
• uip maestro flow node — スターター.flowファイルにノードを追加します
• uip maestro flow registry — 追加するノードタイプを検出します
• フローの概要