オートメーション プロジェクトのパブリッシュについて

オートメーション プロジェクトのパブリッシュとは、プロジェクト フォルダーをロボットに送信して実行できるようアーカイブすることです。

テスト ケースの場合を除き、既定では、プロジェクト フォルダー内のすべてのファイルがパブリッシュされます。パブリッシュされるパッケージに特定のファイルを含めないようにするには、[プロジェクト] パネル内でそのファイルを右クリックし、[パブリッシュから除外] を選択します (ライブラリ プロジェクトのワークフロー ファイルでは使用できません)。ライブラリの場合は、パブリッシュされたライブラリをプロジェクトにインストールするときに、ワークフロー ファイルが再利用可能コンポーネントとして [アクティビティ] パネルに表示されないように、[プロジェクト] パネル内でそのファイルを右クリックして、[非公開にする] を選択します。

オートメーション プロジェクトは Orchestrator、カスタム NuGet フィード、またはローカルにパブリッシュできます。Orchestrator にパブリッシュすると、アーカイブされたプロジェクトが [パッケージ] ページに表示され、ロボットに配布されるプロセスを作成できます。オートメーション プロセスを Orchestrator の個人用ワークスペースにパブリッシュするか、テスト ケースをパブリッシュすると、プロセスが存在しない場合は自動的に作成され、既存のプロセスが最新のパブリッシュ バージョンに自動更新されます。

さらに、オートメーション プロジェクトは、カスタム NuGet フィードにパブリッシュできます。フィードで認証が必要な場合には、API キーを追加するオプションも提供されます。

プロジェクトをローカルにパブリッシュするには、ローカル マシン上のパスを指定する必要があります。このパスは、プロセスパッケージがパブリッシュされた場所とは別の場所へのパスです。ここから、後でロボットにパッケージを手動で送信してロボットで実行することができます。既定では、ローカルなパブリッシュの場所は %ProgramData%\UiPath\Packages です。

プロジェクトをパブリッシュする際、プロジェクト フォルダー内の project.json ファイルと design.json ファイルは読み取り専用ではない場所に格納されている必要があります。たとえば、プロジェクトがソース管理下にある場合は、編集のためにファイルをチェックアウトする必要があります。

You can publish projects from Studio or from the command line. To update dependencies for multiple projects and publish them all at once, use the Project Dependencies Mass Update Tool.

プロジェクトを Studio からパブリッシュする

プロジェクトをパブリッシュするには、Studio の [デザイン] タブのリボンで [パブリッシュ] を選択します。

オートメーション プロジェクトをパブリッシュするには、次の操作を行います。

1. Studio で、新しいプロジェクトを作成します。

2. [デザイン] リボン タブの [パブリッシュ] をクリックします。[パブリッシュ] ウィンドウが表示されます。コンテキストに応じてウィンドウのタイトル バーが変化することを確認してください。

   • [プロセスをパブリッシュ] - プロセスをパブリッシュする場合
   • [ライブラリをパブリッシュ] - ライブラリ プロジェクトをパブリッシュする場合
   • [UI ライブラリをパブリッシュ] - UI ライブラリ プロジェクトをパブリッシュする場合
   • [テスト ケースをパブリッシュ] - テスト ケースをパブリッシュする場合
   • [テンプレートをパブリッシュ] - テンプレートをパブリッシュする場合

3. [パッケージのプロパティ] タブで以下の操作を実行します。

   • パッケージの名前を入力します。ドロップダウン リストには、最近パブリッシュしたパッケージの名前が最大 5 つ表示されます。

   • In the Version section, review the Current Version of your project, and type a New Version if needed. Check the Is Prerelease box to mark the version as alpha. Please note that this automatically changes the project’s version schema to semantic. When publishing a new version of the file locally, make sure that the custom location does not already include a file with the same proposed version number. For more details about project versioning, check the About Automation Projects page.

   • 必要に応じて、プロジェクトのアイコン オプションを使用してプロジェクトのカスタム アイコンを定義します。ファイルを参照して選択するか、最大 1MB の jpeg、jpg、または png ファイルへのパスまたはパブリック URL を入力します。

     プロジェクトがパブリッシュされると、アイコンは次のように表示されます。

     • プロセスの場合、プロセス リストで特定しやすいように、Assistant でプロセス名の横に表示されます。

     • テンプレートの場合、[ホーム] (Studio の Backstage ビュー) > [テンプレート] でテンプレートの横に表示されます。

     • ライブラリの場合、Studio の [パッケージを管理] ウィンドウでパッケージの横に表示されます。

       注:

       Orchestrator または埋め込みアイコンがサポートされていないフィードにパブリッシュするライブラリのアイコンとしてローカル ファイルを使用すると、アイコンは [パッケージを管理] に表示されません。この場合は、URL を使用してアイコンを指定します。

   • [プロジェクト タグ] ボックスでは、新しいタグを作成するか、Orchestrator で既に定義されているタグを再利用して、1 つ以上のタグをプロジェクトに追加できます。タグにはラベルとプロパティ (キーと値のペア) の 2 種類があります。タグはパブリッシュされるパッケージに含まれており、プロジェクトの説明と分類に役立ちます。たとえば、自動化されたアプリケーション (Excel のラベル) や部署 (部署:会計というキーと値のプロパティ) を表すタグを追加できます。

     入力を開始すると、既に定義されたタグから一致候補が提案されます。一致候補のリストからタグを選択して再利用できます。プロパティの一致候補の場合、キーと : (コロン) 文字が最初に表示され、キーを選択すると関連付けられた値が表示されます。新しいタグを追加するには、名前を入力した後、名前の横にプラス記号が表示されているエントリをクリックします。文字列を : (コロン) 文字で分けるとプロパティを追加でき、: を含めないとラベルを追加できます。

     ラベルおよびキーと値のプロパティに使用できる文字数は、最大 256 文字です。タグ名に使用できない文字は、 <、 >、 %、 &、 \、 ?、 /、 : です。

     プロジェクト タグは Orchestrator のプロセスに自動的に適用できます。タグの使用について詳しくは、『UiPath Orchestrator ガイド』の「タグを使用してリソースを整理する」をご覧ください。

   • [リリース ノート] テキスト ボックスには、バージョンなどの関連情報の詳細を入力します。パブリッシュしたプロジェクトのリリース ノートは、Orchestrator の [パッケージ] セクションに表示されます。[リリース ノート] フィールドには、最大 10,000 文字まで入力できます。

     

4. [次へ] をクリックします。

   テンプレートをパブリッシュしている場合は、次の手順 (手順 5) で [テンプレート情報] タブが開きます。それ以外の場合には、手順 6 に進みます。

5. (テンプレートの場合のみ) [テンプレート情報] タブで以下の情報を入力し、[次へ] をクリックします。

   • 名前 - テンプレートの名前です。

   • 説明 - [テンプレート] タブのテンプレートの説明です。

   • 既定のプロジェクト名 - このテンプレートを使用する新しいプロジェクトを作成する際の既定のプロジェクト名です。

     注:

     句読点、区切り文字、およびファイル名に使用できない文字の使用は避けてください。これらの文字は、テンプレートを使用するときに既定の名前から削除される場合があります。

   • 既定のプロジェクトの説明 - このテンプレートを使用する新しいプロジェクトを作成する際の既定のプロジェクトの説明です。

     

6. [パブリッシュのオプション] タブで、プロジェクトをパブリッシュする場所を選択します。利用可能なオプションは、パブリッシュするプロジェクトの種類によって異なります。

   • プロセス の場合 (StudioX プロジェクトを含む):

     • Orchestrator Tenant Processes Feed, Orchestrator Personal Workspace Feed and, if a first-level folder with a separate package feed or one if its subfolders is selected from the folders menu in the Studio status bar, the feed for that folder hierarchy. These options are available if Studio is connected to Orchestrator. The Orchestrator Personal Workspace Feed is available only if your user has the Personal Workspace feature enabled in Orchestrator.

       Studio で個人用ワークスペースまたは別のパッケージ フィードを持つ階層のフォルダーが選択されている場合、そのフォルダーのフィードが既定のオプションになります。それ以外の場合は、テナント フィードが既定のオプションです。現在のセッションで既にプロジェクトをパブリッシュした場合は、Studio を閉じるか、Studio のステータス バーから Orchestrator フォルダーを変更するまで、最後にパブリッシュに使用した場所が既定で選択されます。

     • Assistant (Robot の既定) - Robot と Assistant の既定のパッケージの場所です (C:\ProgramData\UiPath\Packages)。ここにパブリッシュされたプロジェクトは自動的に Assistant に表示されます。Studio が Orchestrator に接続されている場合、このオプションは使用できません。

     • カスタム - カスタム NuGet フィードの URL またはローカル フォルダー。任意で API キーを追加できます。

   • テスト ケースの場合:
     • Orchestrator 個人用ワークスペース フィードを除いて、プロセスの場合と同じオプションを利用可能です。
   • ライブラリおよび UI ライブラリの場合:
     • Orchestrator テナント ライブラリ フィードまたは Orchestrator 共有ライブラリ フィード - Studio が Orchestrator に接続している場合に利用できます。利用可能なオプションは、Orchestrator でテナント ライブラリ フィードが有効化されているかどうかによって異なります。
     • カスタム - カスタム NuGet フィードの URL またはローカル フォルダー。任意で API キーを追加できます。
   • テンプレートの場合:
     • Orchestrator テナント ライブラリ フィードまたは Orchestrator 共有ライブラリ フィード - Studio が Orchestrator に接続している場合に利用できます。利用可能なオプションは、Orchestrator でテナント ライブラリ フィードが有効化されているかどうかによって異なります。
     • ローカル - テンプレートをローカルにパブリッシュする場所。既定では C:\Users\User\Documents\UiPath\.templates です。
     • カスタム - カスタム NuGet フィードの URL またはローカル フォルダー。任意で API キーを追加できます。

   ライブラリ、またはテンプレート以外の Windows またはクロスプラットフォームに対応したプロジェクトをパブリッシュする場合は、[コンパイル設定] の [パブリッシュのオプション] タブで追加の設定を行えます。

   • *(For libraries only)*Activities Root Category - enter a name for the category under which the reusable component will be listed in the Activities panel.

   • ソースを含める - このオプションを選択すると、これまで非公開になっていたワークフローを含むすべての .xaml ソースが、パブリッシュされるパッケージ内にパッケージ化されます。Windows - レガシ ライブラリの場合、ファイルは生成されるアセンブリ ファイル内、および lib\net45 フォルダーの .nupkg ファイル内に保存されます。Windows、およびクロスプラットフォームのライブラリとプロセスの場合、ファイルは content フォルダーの .nupkg ファイル内に保存されます。

   • *(For Windows-legacy libraries only)*Compile activities expressions - select this option to compile and package all activities expressions. This results in an improved execution time.

   • (Windows レガシ ライブラリの場合のみ) すぐに実行可能にする - このオプションをオンにすると、実行時の JIT コンパイルを高速化するために、生成されるアセンブリを最適化します。

     注:

     To find out what might prevent a library from being published successfully, read about the limitations when publishing libraries.

     

7. [次へ] をクリックして [証明書の署名] タブに進むか、[パブリッシュ] に進んでプロジェクトをパブリッシュします。

8. (Optional) In the Certificate Signing tab, add a local Certificate Path next to the Certificate box. Furthermore, add the Certificate Password and an optional certificate Timestamper if needed. For more details, check out the Signing Packages page.

   

   注:

   現在、プロジェクトの署名では、証明書の拡張子として .pfx および .p12 が認められています。

9. [パブリッシュ] をクリックします。.nupkg ファイルが作成され、Orchestrator とカスタム NuGet フィードにアップロードされるか、ローカル ディレクトリに保存されます。プロジェクトに応じて、パッケージには以下が含まれます。

   • Windows - レガシ対応のテンプレート プロジェクトとプロセスの場合、プロジェクト ソース ファイル。
   • Windows またはクロスプラットフォームに対応したライブラリおよびプロジェクトの場合、コンパイルされた DLL ファイル。

10. プロジェクトが正常にパブリッシュされると、[情報] ダイアログ ボックスが表示され、NuGetServerUrl パラメーター (UiPath.settings ファイル内) に設定された NuGet の場所にプロジェクトがコピーされます。

[情報] ダイアログ ボックスには次の情報が表示されます。

• パブリッシュしたパッケージの名前。

• パブリッシュされたパッケージのバージョン番号

• プロジェクトがローカルまたは Robot の既定にパブリッシュされた場合、その場所。パブリッシュした場所が Orchestrator でないかぎり、パスをクリックするとパッケージに移動します。

• パブリッシュされたプロジェクト ファイルの名前を含むリストを展開する詳細オプション。

• [クリップボードにコピー] オプション

  

パブリッシュ先など、パブリッシュ時に追加された情報はウィンドウ内に保持されるため、続けて同じ種類のプロジェクトをパブリッシュする場合は使用できます。[パブリッシュ] をクリックするたびに、プロジェクトの新しいバージョンが作成されてパッケージ フィードに送信されます。セキュリティ保護されているフィードへのパブリッシュは、ロボット キー、Orchestrator の資格情報、Windows 認証、または API キーのいずれかで認証して実行できます。

重要:

プロジェクトをパブリッシュして作成したパッケージ ファイルは、解凍しないでください。変更を加える場合は、Studio で元の .xaml ファイルを開き、これを変更したうえで、再度プロジェクトをパブリッシュします。

プロジェクトをコマンド ラインからパブリッシュする

プロジェクトは、UiPath.Studio.CommandLine.exe のパブリッシュ コマンドを使用してパブリッシュできます。

UiPath.Studio.CommandLine.exe はインストール フォルダー内にあります。

• マシン単位のインストールの場合、既定のパスは C:\Program Files\UiPath\Studio です。
• ユーザー単位のインストールの場合、既定のパスは %localappdata%\Programs\UiPath\Studio です。

パブリッシュ コマンドでは次の引数を使用できます。

引数	説明
-p、--project-path	パブリッシュする project.json へのパスです。この引数は必須です。
-g、--target	プロジェクトをパブリッシュする場所: Custom - カスタム URL またはローカル フォルダーです。引数 -f、-feed を使用して場所を定義します。 Robot - ロボットが Orchestrator に接続されていない場合の、既定のパブリッシュ場所です。ライブラリまたはテンプレートのパブリッシュには利用できません。 OrchestratorTenant - Orchestrator テナント プロセス フィード (プロセスおよびテスト ケースの場合)、または Orchestrator ライブラリ フィード (ライブラリおよびテンプレートの場合) です。 OrchestratorPersonalFolder - Orchestrator 個人用ワークスペース フィードです。ライブラリ、テンプレート、またはテスト ケースのパブリッシュには使用できません。 OrchestratorFolderHierarchy - If a first-level folder with a separate package feed or one if its subfolders is selected from the folders menu in the Studio status bar, the feed for that folder hierarchy. Not available for publishing libraries or templates.
-f、--feed	The custom URL for publishing the project. This can also be a custom local directory, similar to the path in the Publish options tab in Studio.
-a、--api-key	プロジェクトをパブリッシュするための API キーです。この引数はカスタム ターゲットに使用できます。
-i、--icon	パッケージに使用するカスタム アイコンへのパスです。
-n、--notes	プロジェクトへの変更を含むリリース ノートです。
-v、--new-version	プロジェクトの新しいバージョンです。指定しない場合、バージョン番号は自動的に増分されます。
-t、--timeout	プロジェクトのパブリッシュのタイムアウト値を指定します。既定のタイムアウト値は 30 秒です。この設定は、Orchestrator へのパッケージ転送の間にのみ適用されます。
--cer-path	パッケージ署名の証明書へのローカル パスです。
--cer-password	証明書のパスワードです。
--timestamper-url	タイムスタンパーの URL です。
--incl-all-feeds	必須ではありません。
--help	各コマンドで使用可能な引数を表示します。
--version	UiPath.Studio.CommandLine.exe のバージョンを確認します。

例:

• 次のコマンドは、Sample というプロセスを Orchestrator テナント プロセス フィードにパブリッシュします。

  UiPath.Studio.CommandLine.exe publish --project-path "C:\Users\username\Documents\UiPath\Sample\project.json"--target OrchestratorTenant --notes "Fixed a couple of bugs."

• 次のコマンドは、同プロセスをローカル フォルダーにパブリッシュします。

  UiPath.Studio.CommandLine.exe publish --project-path "C:\Users\username\Documents\UiPath\Sample\project.json"--target Custom --feed "C:\Users\username\Desktop\myfeed" --notes "Fixed a couple of bugs."

For more information about the CommandLine.exe utility, see Mass Update Command Line Parameters.