uip solution upload

「uip solution upload」の構文とオプション - ローカルのソリューションをバンドルし、それを Studio Web に送信してブラウザーで編集します。

uip solution upload ブラウザーで編集するために、ローカル ソリューションを UiPath Studio Web にアップロードします。ソリューションは内部の .uis アーカイブにバンドルされ、Studio Web に送信され、(成功すると) デザイナーで直接開くことができる URL が出力されます。

Orchestrator 用のデプロイ可能な.zipを生成する uip solution pack + uip solution publishとは異なり、upload は対話型の Studio Web 作成画面をターゲットにします。引き続きブラウザーでソリューションを共同で編集する場合に使用します。

Overwrite or import

Before uploading, the command checks whether Studio Web holds a solution with the SolutionId from the .uipx (or from the .uis archive):

• The solution exists. It is overwritten in place. The replaced contents are first recorded as a restorable version, unless you pass --no-snapshot. Data.Action is Overwritten.
• The solution does not exist. The upload is imported as a new solution, and the ID that Studio Web assigns is written back into the local .uipx so the next upload overwrites the same solution. Data.Action is Imported.

--force skips the existence check and overwrites directly. If Studio Web has no solution with that SolutionId, the command fails with not_found and uploads nothing; re-run without --force to import as new.

概要

uip solution upload <solutionPath> [--force] [--no-snapshot] [--login-validity <minutes>]

このコマンドは 、グローバルオプション を尊重し、 標準の終了コードを返します。

引数

• <solutionPath> (必須) — 次のいずれか:
  • .uipxマニフェストを含むソリューション ディレクトリ (最も一般的)。
  • .uipx ファイル (コマンドは、それを含むディレクトリを解決します)。
  • .uisファイル (事前にバンドルされたソリューション アーカイブ。後方互換性のためにそのままアップロードされます)。

オプション

• --force — Skip the existence check and overwrite the Studio Web solution named by the bundled SolutionId directly. An upload overwrites an existing cloud solution without it. Fails if that solution does not exist. No effect when no SolutionId is bundled (a .uis archive without one): the upload imports as new.
• --no-snapshot — クラウド ソリューションの復元可能な上書き前のバージョンは、その内容を置換する前に記録しないでください。前回のアップロード以降に Studio Web で行った変更は失われます。ローカル ファイルは影響を受けません。アップロードによって新しいソリューションがインポートされても、効果はありません。
• --login-validity <minutes> — 更新をトリガーするトークンの有効期限の最小分前。既定値は [ 10です。

例

最小限

uip solution upload ./my-solution

特定の .uipx をアップロードします。

uip solution upload ./workspace/my-solution/my-solution.uipx

復元可能なスナップショットなしで上書きする

uip solution upload ./my-solution --no-snapshot

スクリプティング — 返されたデザイナーの URL を開きます

URL=$(uip solution upload ./my-solution --output-filter "DesignerUrl" --output plain)
open "$URL"   # macOS

データシェイプ(--output json)

Studio Web にはバンドルされた SolutionIdのソリューションがないため、新規としてインポートされ、ローカル .uipx が割り当てられた ID で更新されます。

{
  "Code": "SolutionUpload",
  "Data": {
    "Status": "Uploaded successfully",
    "Action": "Imported",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "DesignerUrl": "https://cloud.uipath.com/myorg/mytenant/studio_/designer/p1?solutionId=a1b2c3d4-0000-0000-0000-000000000001",
    "LocalSolutionIdUpdated": {
      "Path": "/workspace/my-solution/my-solution.uipx",
      "From": "00000000-0000-0000-0000-0000000000ff",
      "To": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    "Response": { }
  }
}

ソリューションはすでに Studio Web に存在しているため、その場で上書きされ、置き換えられたコンテンツは最初に復元可能なバージョンとして記録されます。

{
  "Code": "SolutionUpload",
  "Data": {
    "Status": "Uploaded successfully",
    "Action": "Overwritten",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "DesignerUrl": "https://cloud.uipath.com/myorg/mytenant/studio_/designer/p1?solutionId=a1b2c3d4-0000-0000-0000-000000000001",
    "SnapshotCreated": true,
    "Response": { }
  }
}

• Action — そのSolutionIdを持つソリューションが Studio Web にすでに存在していた場合"Overwritten"、初回アップロード時に"Imported"されます。
• SolutionId — Studio Web で割り当てられた Identity (初回アップロード時) または一致済み (上書き時) です。また、ローカル .uipx に書き戻されるため、次の upload で同じソリューションが更新されます。
• DesignerUrl — ソリューション内の最初のプロジェクトのすぐに開ける URL です。ソリューションに事前にスコープが設定されています。nullStudio Web がプロジェクト ID を返さない場合は /absent
• LocalSolutionIdUpdated — 新しい SolutionId がローカル .uipx に書き戻されたときにのみ存在します (Path、 From、 To)。上書きが行われている場合、またはアップロード ソースに書き換える事前 ID がない場合には表示されません。
• SnapshotCreated — present and true only on an overwrite that recorded a restorable pre-overwrite version (that is, without --no-snapshot). Absent on a fresh import and with --no-snapshot.
• Response — Studio Web の生の応答ペイロード。デバッグに役立ちます。安定した契約の一部ではありません。

副作用

• Resource preparation. For a solution directory or .uipx file, upload prepares the solution's resources the same way as uip solution pack: it syncs each project's bindings_v2.json into the solution's resource declarations, as uip solution resources refresh does, and writes what each project contributes onto its resources. An error that a project's tool reports fails the upload. A .uis file is uploaded as-is, without this step.
• SolutionId write-back. On an import, the returned solution ID replaces (or populates) the SolutionId field in the local .uipx.

Files left out of the bundle

When bundling a solution directory, upload always leaves out .venv, node_modules, __pycache__, .git, .local, and .flow-sdk folders, and dotenv files (.env, .env.local, .env.production, and similar).

To leave out more files, add a .uipignore file at the solution root, in a project folder, or both. The syntax is gitignore: one pattern per line, # for comments, globs such as *.log, anchored paths such as /dist, a trailing / for directories only, and ! to re-include. Patterns in a project's .uipignore match relative to that project folder and apply only to it. An unreadable .uipignore is skipped with a warning.

A pattern that would leave out the manifest of a project listed in the .uipx (for example *.uiproj, or the project's folder name) is refused: the command fails with invalid_argument and names the project. Remove or narrow the pattern, or remove the project from the solution with uip solution projects remove, then upload again.

故障モード

• A project uses a project.json manifest that Studio Web does not accept. Refused with invalid_argument. Convert the listed project to a project.uiproj manifest before uploading. uip solution pack and uip solution publish accept project.json.
• A .uipignore pattern drops a listed project. Refused with invalid_argument, as described in Files left out of the bundle.
• --force with a SolutionId that Studio Web does not hold. Refused with not_found; nothing is uploaded.

関連コマンド

• uip solution pack + uip solution publish — uploadに代わるデプロイパイプライン。
• uip solution delete — Studio Web ソリューションをSolutionIdで削除します。
• uip solution init — アップロードする前にソリューションを素早く作成します。

参照

• 認証 — upload にはアクティブなセッションが必要です。
• uip solutionの概要。