UIP ソリューション プロジェクト

「uip ソリューション プロジェクト」の構文とオプション。「.uipx」ソリューション マニフェストに一覧表示されているプロジェクトと、クラウド プロジェクトのパブリッシュと同期を管理します。

uip solution projects は、.uipx ソリューション マニフェストにリストされているプロジェクト (RPA プロセス、テスト、エージェント、Maestro フロー、ケース プロジェクトと BPMN プロジェクト、コード化されたアプリ、関数、API ワークフロー、その他の構築可能なプロジェクトの種類) を管理します。ライブラリはプロジェクトではありません。単独でライブラリをパブリッシュしてから、 に添付uip solution resources add --source remote --kind Library。

注:

このグループは、以前は project (単数形) として文書化されていました。単数形は今でも機能します - それは後方互換性のための非推奨の隠されたエイリアスとして登録されたままです - しかし、 projects 今後は正規です。

サブコマンド	目的
add	ソリューション ディレクトリに既に存在するプロジェクト フォルダーを登録します。
import	外部プロジェクト フォルダーをソリューション ディレクトリにコピーして登録します。
remove	.uipxからプロジェクトの登録を解除します (ディスク上のファイルは削除されません)。
list	ローカル .uipxに登録されているプロジェクトのリストを表示します。
publish	クラウド ソリューション プロジェクトをソリューション パッケージとしてパブリッシュします。
resync	クラウド ソリューション プロジェクトを同期またはリセットする。

add、 import、 remove、および list はローカル ファイルに対してのみ動作し、認証は不要です。publish と resync はクラウド ソリューション プロジェクト上で動作し、アクティブなセッションが必要です。

概要

uip solution projects add <project-path> [solutionFile]
uip solution projects import <source> [--solutionFile <path>]
uip solution projects remove <project-path> [solutionFile]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>] [--description <text>] [--release-notes <text>] [-t <tenant-name>]
uip solution projects resync [project-name] [--project-name <name>] [--sync-option <Sync|Reset>] [-t <tenant-name>]

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

一般的な動作 (追加/インポート/削除)

• 対象のプロジェクト フォルダーに、project.uiproj、レガシ project.json、またはuipath.json記述子が含まれている必要があります。コマンドはどれを自動検出するかを自動検出します。
• [solutionFile]を省略すると、コマンドはプロジェクト パス (importの場合は現在のディレクトリ) から最も近い.uipxを検索します。何も見つからない場合、または同じフォルダーに複数の .uipx ファイルが存在する場合、コマンドは失敗し、 1で終了します。
• マニフェストに追加されたプロジェクトエントリごとに一意の Id (UUID)が生成されます。

---

追加

ソリューション ディレクトリ に既に存在する プロジェクト フォルダーを登録します。プロジェクト フォルダーの相対パスが .uipxに記録され、一致するエントリがソリューションの内部リソース ビルダーにプロビジョニングされます。

引数

• <project-path> (必須) — プロジェクト フォルダーへのパスです。project.uiproj、project.json、または uipath.jsonを含める必要があります。
• [solutionFile] (任意) — .uipx ソリューションのマニフェストへのパスです。省略した場合、最も近い .uipx は <project-path>から歩いて位置します。

例

uip solution projects add ./my-solution/my-project ./my-solution/my-solution.uipx

# Auto-detect the .uipx
uip solution projects add ./my-solution/my-project

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

{
  "Code": "ProjectAdd",
  "Data": {
    "Status": "Added successfully",
    "Project": "my-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

故障モード

• プロジェクトがソリューション フォルダーの外部にあるこのコマンドは、外部プロジェクトをコピーする projects importへのポインタを使用して追加を拒否します。
• プロジェクトはすでに登録されています。1と、既存のプロジェクト パスの名前を示すメッセージが表示されて終了します。

---

import

外部プロジェクト フォルダーをソリューション ディレクトリにコピーし (フォルダー名は保持)、.uipxに登録します。含めるプロジェクトがまだソリューションのルート下にない場合に使用します。

引数

• <source> (必須) — インポートする外部プロジェクト フォルダーへのパスです。、project.json、または uipath.jsonを含むディレクトリproject.uiproj必要があります。これは位置の引数であり、フラグではありません — このページの以前のドキュメントでは、 --source <path>として表示されていましたが、これは間違っています。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solutionFile	パス	現在のディレクトリより上 .uipx 最も近い	.uipx ソリューション マニフェストへのパス。

例

uip solution projects import ./external-project \
  --solutionFile ./my-solution/my-solution.uipx

# From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution projects import ../shared-library

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

{
  "Code": "ProjectImport",
  "Data": {
    "Status": "Imported successfully",
    "Project": "external-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

失敗モードとロールバック

• 保存先フォルダーは既に存在します。このコマンドは上書きを拒否します。移動元のフォルダーの名前を変更するか、先に既存の保存先を削除します。
• プロジェクトが既に .uipx マニフェストに含まれています。ファイルがコピーされるまで拒否されます。
• コピー、書き込み、またはビルダーのステップが失敗します。コマンドがロールバックされ、コピーされたディレクトリが削除され、 .uipx が元の内容に復元されます。

---

削除

.uipx ソリューション マニフェストからプロジェクトの登録を解除し、そのエントリを内部リソース ビルダーから削除します。ディスク上のファイルは削除されません。ソリューション内の 最後の プロジェクトの削除を拒否する (空の Projects[] は init直後にのみ有効です) — 1 つの例外は、サポートされていない種類のプロジェクトです。このプロジェクトはいつでも削除してブロックを解除できます packです。

引数

• <project-path> (必須) — 削除するプロジェクト フォルダーのパスです。現在 .uipxに登録されている必要があります。
• [solutionFile] (任意) — .uipx ソリューションのマニフェストへのパスです。既定値は、<project-path>から歩いて上って見つけた最も近い.uipxです。

例

uip solution projects remove ./my-solution/my-project ./my-solution/my-solution.uipx

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

{
  "Code": "ProjectRemove",
  "Data": {
    "Status": "Removed successfully",
    "Project": "my-project",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

故障モード

• プロジェクトがソリューション フォルダーの外部にある相対パスの先頭に ..を含めることはできません。
• プロジェクトがマニフェストにありません。1と検索に使用する相対パスで終了します。
• ソリューションに残っているのはプロジェクトだけです。サポートされていない種類のプロジェクトでない限り拒否されます。

---

リスト (List)

ローカル .uipx ソリューション マニフェストに登録されているプロジェクトを一覧表示します。ディスク上のメタデータのみを読み取り、バックエンド呼び出しは読み取りません。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。

例

uip solution projects list

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

{
  "Code": "SolutionProjectsList",
  "Data": [
    {
      "Name": "MyProject",
      "Type": "Process",
      "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "ProjectRelativePath": "MyProject/project.uiproj",
      "ProjectFilePath": "/workspace/my-solution/MyProject/project.uiproj"
    }
  ]
}

---

パブリッシュ

クラウド ソリューション プロジェクト (ローカルの .uipx プロジェクトではなく、すでに Automation Cloud に存在するプロジェクト) をソリューション パッケージとしてパブリッシュし、パブリッシュ操作が完了するまで待ちます。

オプション

長押し	値 (Value)	既定 (Default)	説明
--project-name	text	—	必須。パブリッシュするクラウド ソリューション プロジェクトの名前です。
--package-name	text	—	必須。作成するソリューション パッケージの名前です。
--package-version	text	—	必須。作成するソリューション パッケージのバージョンです。
--folder-name	text	—	ソリューション パッケージに保存するルート フォルダー名です。
--description	text	—	ソリューション パッケージの説明。
--release-notes	text	—	ソリューション パッケージのリリース ノート
-t, --tenant	name	セッションの既定値	tenant.
--timeout	秒	360	パブリッシュ ポーリング タイムアウト。
--poll-interval	ミリ秒	5000	パブリッシュのステータスのポーリングの間隔 (ミリ秒)。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution

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

{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}

---

再同期

クラウド ソリューション プロジェクトを同期またはリセットし、操作が完了するまで待ちます。Sync プロジェクトとそのソースを調整します。 Reset 、ローカル クラウドの変更は破棄されます。

引数

• [project-name] (任意) — 同期するクラウド ソリューション プロジェクト名です。--project-nameを付けることもできます。両方に異なる値を指定するとエラーになります。

オプション

長押し	値 (Value)	既定 (Default)	説明
--project-name	text	—	同期するクラウド ソリューション プロジェクト名 (positional 引数の代替手段)。
--sync-option	Sync | Reset	Sync	実行する同期操作。
-t, --tenant	name	セッションの既定値	tenant.
--timeout	秒	360	同期ポーリングのタイムアウト。
--poll-interval	ミリ秒	5000	同期ステータスのポーリングの間隔 (ミリ秒)。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

uip solution projects resync --project-name MyProject --sync-option Sync

# Positional form, reset instead of sync
uip solution projects resync MyProject --sync-option Reset

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

{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}

失敗すると、各同期エラーがサービス名および影響を受けるリソース キー別に一覧表示されます Instructions 。

---

関連コマンド

• uip solution init — プロジェクトを追加する前にソリューションを素早く作成します。
• uip solution resources refresh — プロジェクトのバインドを編集した後、リソースを再同期します。
• uip solution pack — プロジェクト リストが完成したら、ソリューションをパッケージ化します。

参照

• 最初のパイプライン — エンドツーエンドの例。
• uip solutionの概要。