内容

ソリューション アクセラレータの構造

ソリューション アクセラレータは、すべてのソリューション アクセラレータで一貫したエクスペリエンスを維持するために、次のフォルダー構造に準拠する必要があります。 次の 4 つのフォルダーを含めることができます。

1. デプロイ ( テスト データの管理など、ユーザー エクスペリエンスが有人である場合、これが含まれない可能性があります)
2. ドキュメント
3. ライブラリ (プロセスにライブラリが含まれていない場合、このライブラリが含まれていない可能性があります)
4. プロセス

特定の要素 (フォルダー構造など) は各ソリューション アクセラレータで一貫していますが、ソリューション アクセラレータは、ソリューション アクセラレータ内で使用される特定のユース ケースや UiPath 製品の影響を受ける可能性があります。 以下の表に、各ソリューション アクセラレータ内の一貫性のある項目を示します。

デプロイ	ドキュメント	ライブラリ	プロセス
資産の詳細 キューの詳細 ソリューション管理パッケージ 任意のライブラリ NUPKG ファイル その他のカスタム アクティビティ	ソリューション アクセラレータ – アクセラレータの概要 ソリューション アクセラレータ – 導入ガイド ソリューション アクセラレータ – テクニカル ドキュメント 高レベルのソリューション設計(.pdfおよび.vsdxなどの元の編集ファイル) 詳細なソリューション設計(.pdfおよび.vsdxなどのオリジナル編集ファイル)	各ライブラリの個別のサブフォルダ	各プロセスの個別のサブフォルダー

2. 展開フォルダー

a. 資産の詳細

アセットは、ソリューション アクセラレータ上のさまざまなオートメーション プロジェクトで使用できる共有変数または資格情報を表します。[アセットの詳細] は、Orchestrator Manager に対応した Microsoft Excel のブック ファイル (.xlsx) です。 Orchestrator Manager は、Orchestrator の API を利用してエンティティを操作するツールです。このブックを使用すると、ソリューション アクセラレータ全体で使用されるアセットを簡単に確認および追加できます。

以下の例に示すように、このブックには、Text、Bool、および Integer アセットを作成するための [Create ] と、資格情報アセットを作成するための [資格情報を作成] の 2 つのシートが必要です。各シートに必要なヘッダーとヘッダーの順序、および各行内の情報は、以下の表で定義されています。

N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
フォルダー名1	アセット名1	説明1	スコープ1	ロボット名またはユーザーのユーザー名1	タイプ1	値1	アセット ID2	結果2
発注書の処理	Dispatcher_PurchaseOrdersEmailsSourceAccount	処理する必要のある PurchaseOrders ドキュメント メールが格納されているメールボックスです。	グローバル	N/A	テキスト	特定の値に置き換えるには	N/A	N/A

¹0 列は、作成するアセットの名前、タイプ、値などの入力を操作から受け取ります。

¹1 Orchestrator から取得したデータ (作成されたアセットの ID など) を書き込むために Orchestrator Manager が使用する列です。この値は、次回の 資格情報の作成/作成 操作時に上書きされます。

作成

フォルダー名 1	アセット名 1	説明 1	スコープ 1	ロボット名 1 またはユーザーのユーザー名 1	タイプ 1	値 1	アセット ID 2	結果 2
モダン フォルダーのサブフォルダーの名前を指定する場合、親フォルダーとその祖先フォルダーの完全な名前をスラッシュ (/) で区切って入力する必要があります。 例:「WorkGroup1」というモダン フォルダーが「部門 A」というモダン フォルダーのサブフォルダーである場合、「ワークグループ 1」の完全な名前は「部門 A/ワークグループ 1」になります。	アセットの名前。 名前は最大 256 文字にする必要があります。	アセットの説明。 説明は最大 250 文字にする必要があります。	[スコープ] フィールドには、Orchestrator で利用可能なアセット スコープに応じて、設定可能な数の固定数の値があります。 グローバル Robot (クラシック フォルダーでのみ使用可能) ユーザー (モダン フォルダーでのみ使用可能)	ロボットごとにアセットを作成する場合は、[ロボット名] または [ユーザーのユーザー名] フィールドを使用して、定義するアセットの値へのアクセス権が必要なロボットの名前を指定します。 ロボットは、作成したロボットごとのアセットと同じフォルダーに存在する必要があります。 複数のロボットの値は、同じフォルダー名、アセット名、スコープ、種類の別々の行に指定する必要があります。	[型] フィールドには、Orchestrator で利用可能なアセットの種類に応じて、指定可能な数の値が固定されています。 テキスト Bool Integer	アセットの値。 ユーザーがアセット値を定義する必要がある場合は、「特定の値で置き換える」と記述する必要があります。 このフィールドには、次のものが必要です。 Text 型の場合は最大 1,000,000 文字 Integer 型の場合は 2147483648 から 2147483648 の値 Bool 型の場合は TRUE または FALSE の値。	アセットが正常に作成された場合は、作成されたアセットの ID です。	アセットの作成結果 (成功または失敗)。

¹2 列は、作成するアセットの名前、タイプ、値などの入力を操作から受け取ります。

¹3 Orchestrator から取得したデータ (作成されたアセットの ID など) を書き込むために Orchestrator Manager が使用する列です。この値は、次回の 資格情報の作成/作成 操作時に上書きされます。

資格情報を作成

フォルダー名 1	アセット名 1	説明 1	スコープ 1	ロボット名またはユーザーのユーザー名 1	ユーザー名 1	パスワード 1	アセット ID 2	結果 2
モダン フォルダーのサブフォルダーの名前を指定する場合、親フォルダーとその祖先フォルダーの完全な名前をスラッシュ (/) で区切って入力する必要があります。 例:「WorkGroup1」というモダン フォルダーが「DepartmentA」というモダン フォルダーのサブフォルダーである場合、「WorkGroup1」の完全な名前は「DepartmentA/WorkGroup1」となります。	アセットの名前。 名前は最大 256 文字にする必要があります。	アセットの説明。 説明は最大 250 文字にする必要があります。	[スコープ] フィールドには、Orchestrator で利用可能なアセット スコープに応じて、設定可能な数の固定数の値があります。 グローバル Robot (クラシック フォルダーでのみ使用可能) ユーザー (モダン フォルダーでのみ使用可能)	ロボットごとにアセットを作成する場合は、[ロボット名] または [ユーザーのユーザー名] フィールドを使用して、定義するアセットの値へのアクセス権が必要なロボットの名前を指定します。 ロボットは、作成したロボットごとのアセットと同じフォルダーに存在する必要があります。 複数のロボットの値は、同じフォルダー名、アセット名、スコープ、種類の別々の行に指定する必要があります。	ユーザー名フィールド。 これはエンド ユーザーによって提供されるため、このフィールドの各行には常に "TO REPLACE WITH SPECIFIC VALUE" を含める必要があります。	パスワード フィールド。 これはエンド ユーザーによって提供されるため、このフィールドの各行には常に "TO REPLACE WITH SPECIFIC VALUE" を含める必要があります。	アセットが正常に作成された場合は、作成されたアセットの ID です。	アセットの作成結果 (成功または失敗)。

¹4 列は、作成するアセットの名前、タイプ、値など、操作から入力を受け取ります。

¹5 Orchestrator から取得したデータ (作成されたアセットの ID など) を書き込むために Orchestrator Manager が使用する列です。この値は、次回の 資格情報の作成/作成 操作時に上書きされます。

b. キューの詳細

キューとは、無制限の数のアイテムを保持できるコンテナーです。キュー アイテムには、請求書情報や顧客情報など、複数の種類のデータを格納できます。キューを使用すると、ソリューション アクセラレータのような、複雑なロジックで下線が引かれた大規模なオートメーション プロジェクトを作成できます。

キューの詳細 は Microsoft Excel のブック ファイル (.xlsx) です。 Orchestrator Manager は Orchestrator の API を利用してエンティティを操作するツールです。このブックを使用すると、ソリューション アクセラレータ全体で使用されるキューを簡単に確認および追加できます

以下の例では、このブックには 1 つのシートが必要です。 すべてのキューを作成するには、 Create 。シートに必要なヘッダーとヘッダーの順序、および各行内の情報は、以下の表で定義されています。オレンジ色のヘッダー列は、名前、説明、作成するキューの最大リトライ回数など、操作からの入力を受け取ります。灰色のヘッダー列は、Orchestrator Manager で Orchestrator から取得したデータ (作成されたキューの ID など) を書き込むために使用されます。この値は、次の作成操作で上書きされます。

N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
フォルダー名	キュー名	説明	一意の参照	自動リトライ	最大リトライ回数	アセット ID	結果
モダンフォルダーのサブフォルダーの名前を指定する場合は、親フォルダーの親フォルダーの完全な名前をスラッシュ(/)で区切って入力する必要があります。例: "WorkGroup1" という名前のモダン フォルダーが "DepartmentA" という名前のモダン フォルダーのサブフォルダーである場合、WorkGroup1 の完全な名前は "DepartmentA/WorkGroup1" になります。	キューの名前です。名前には空白は使用できません。名前は最大で 50 文字にする必要があります。	キューの説明です。説明は最大 250 文字にする必要があります。	トランザクションに一意の参照を強制します。[はい] または [いいえ] のいずれかである必要があります。	システム例外で失敗したキュー内のトランザクション アイテムを自動的にリトライできるようにします。[はい] または [いいえ] のいずれかである必要があります。	キュー内のトランザクション アイテムの最大リトライ回数です。[自動リトライ] が [はい] の場合は、1 以上である必要があります。1 から 50 までの整数を指定できます。	キューが正常に作成された場合に、作成されたキューの ID です。	キューの作成結果 (成功か失敗か)。

c. ソリューション管理パッケージ

ソリューション アクセラレータとは、UiPath Platform 上で開発された複数の コンポーネント (プロセス、アセット、キューなど) のバンドルであり、これらが連携してビジネス ユース ケースを自動化します。UiPath ソリューション管理 は、構築済みのソリューション アクセラレータ コンポーネントのライフサイクルを管理するための、すぐに使えるツールです。この一連の機能は、ソリューション アクセラレータの開発が完了し、ソリューション アクセラレータのコンポーネントを新しい環境に簡単に昇格するときに役立ちます。

ソリューション管理では、ソリューション アクセラレータの開発対象の Orchestrator 環境内で、これらのコンポーネントを 1 つのファイルに簡単にパッケージ化できます。ソリューション管理パッケージの作成方法については、「 ソリューション プロジェクトを作成する」をご覧ください。

ソリューション アクセラレータのソリューション管理パッケージを作成する際のいくつかの要件と考慮事項:

• 資格情報であるアセットには、エンドユーザーによって提供される「特定の値で置き換える」の値を持つユーザー名とパスワードのフィールドが含まれている必要があります。
• 宛先メールアドレスや環境 URL など、エンドユーザー固有のアセットにも「特定の値で置き換える」の値が必要です。
• ソリューション管理 Zip の名前付け規則は、"ソリューション アクセラレータ名 1.0.0" である必要があります。 ここで、ソリューション アクセラレータ名はソリューション アクセラレータの名前で、1.0.0 はソリューション管理 zip のソリューション プロジェクトのバージョンです。
• すべてのストレージ バケットとトリガーは、ソリューション管理の zip ファイルに含まれます。 ストレージ バケットとトリガーは手動デプロイに含めることはできません。デプロイ ガイドのドキュメント内に手動で作成できるように明記しておく必要があります。
• プロセスは [ソリューション管理] の zip に含める べきではありません 。プロセスは、ソリューション アクセラレータの環境および手順固有の拡張機能を変更しない限り、すぐには動作しないことが期待されます。
• カスタム ライブラリが何らかの理由で変更されることが予想される場合は、変更しないとすぐには機能しないため、ソリューション管理パッケージに含めないでください。

d. ライブラリ NUPKG ファイル

ライブラリとは、他のプロジェクトのアクティビティとして再利用できる 1 つ以上のワークフローを含むプロジェクトです。これにより、ソリューション アクセラレータは個々のプロセス全体で共通のコードを使用できます。ライブラリの作成については、ライブラリ ドキュメントの「 ライブラリを作成する」セクション をご覧ください。ソリューション アクセラレータのライブラリを作成するための開発標準については、「 ライブラリの開発」セクションをご覧ください。ライブラリはパブリッシュ時に NUPKG ファイルとして保存され、 パッケージ マネージャーから依存関係としてインストールできます。ライブラリをローカル フォルダーにパブリッシュするか、NuGet パッケージ フィードからパブリッシュしてダウンロードし、関連する NUPKG ファイルを取得することができます。

重要:

再利用可能なライブラリが、変更を必要とせずにすぐに動作するように設計されている場合は、それを Deployment フォルダー内に含めてください。

ライブラリがプロジェクト内で正しく動作するように変更されることが予想される場合は、そのライブラリが Deployment フォルダーに含まれていないことが予想され、そのライブラリを使用するすべてのプロジェクトでライブラリを変更、発行、および依存関係を更新する必要があることを Deployment Guide に明確にする必要があります。再利用可能なライブラリがフィード (UiPath ソリューション アクセラレータの Generic Reusables など) で個別にパブリッシュされる場合は、NUPKG ファイルを含める必要はありません。

e.その他のカスタム アクティビティ

UiPath Studio プロジェクトで使用できる 独自のカスタム アクティビティを作成できます 。作成した カスタム アクティビティを使用するには 、UiPath Studio からパッケージ マネージャーにアクセスして NUPKG をインストールし、そのアクティビティを含む NuGet パッケージをソリューション アクセラレータ プロジェクトにインストールする必要があります。カスタム アクティビティ の完了時に 、その NuGet パッケージを作成する必要があります。NUPKG は、ソリューション アクセラレータの Deployment フォルダーに含めることができます。

3. ドキュメント

ドキュメントの構成は、以下のガイドラインに従う必要があります。

• ソリューション アクセラレータ – アクセラレータの概要
• ソリューション アクセラレータ – 導入ガイド
• ソリューション アクセラレータ – テクニカル ドキュメント
• 高レベルのソリューション設計(.pdfおよび.vsdxなどの元の編集ファイル)
• 詳細なソリューション設計(.pdfおよび.vsdxなどのオリジナル編集ファイル)

4. ライブラリ

UiPath ライブラリとは、他のプロジェクトのアクティビティとして再利用できる 1 つ以上のワークフローを含むプロジェクトです。ライブラリはパブリッシュ時に NUPKG ファイルとして保存され、 パッケージ マネージャーから依存関係としてインストールできます。ライブラリは、ライブラリタイプのプロジェクトを使用してのみ開発できます。再利用可能な UI コンポーネントも 、オブジェクト リポジトリを使用してライブラリ内に実装する必要があります。Data Service のエンティティはすべて ライブラリ内にインポートし、 ライブラリをインポートすることによってソリューション アクセラレータ全体で同じ参照/名前空間を使用できるようにする必要があります。ライブラリ内に をインポートすることで、異なるプロセス間で名前空間が競合することはありません。

ライブラリには次の要件があります。

projectType	ライブラリプロジェクト
Process Size & Workflow Naming Convention	小規模で明確に定義された XAML 名前付け: パスカル ケースではなく、「各単語を大文字にする」という名前 (間にスペースを入れる) を使用します。 ワークフローにパスカル ケースが望ましい場合でも、「各単語を大文字にする」規則 (スペースをアクティビティ名に戻す) は、[アクティビティ レイアウト] の [表示名] フィールド (プロジェクト エクスプローラーのワークフロー メニュー オプションを右クリック) を使用して実行できます。
注釈	各ワークフロー ファイルに免責事項/説明としてピン留めされた注釈を追加する アクティビティに適切な説明で注釈を付ける
変数の命名規則	キャメルケースの小文字 (例: firstName、lastName、myOrganizationStructure )
引数の命名規則	引数には、 PascalCase 標準を使用して名前を付ける必要があります。 引数の名前にはプレフィックス in_/out_/io_ を使用しないでください。これらの引数はライブラリの作成時にプロパティとして表示されるためです。 注釈は、[ライブラリ] アクティビティの使用時に表示されるため、すべての引数に存在する必要があります
引数の結果	ライブラリワークフローは、ワークフロー名が記述されているようにする必要があります ワークフローは、API または GUI の結果を解析し、特定のデータの結果を返す必要があります
コメント	コメントを追加してライブラリプロジェクトの読みやすさを向上
Data Service エンティティ	Data Service のエンティティはライブラリ内にインポートできます。 名前空間はエンティティの名前である必要があります。 Data Service の操作をライブラリで実行することで、ソリューション アクセラレータ全体でのエンティティの再利用性を向上できます。
例外処理	ライブラリ内のエラーは、出力引数によって通知されるのではなく、例外としてスローされる必要があります。 目的のアクションが実行されたかどうかを確認して、ライブラリコンポーネントの結果を最後に確認し、発生していない場合は例外をスローします。

5. プロセス

プロセスとは、プロセス設計オプションを使用して開発された UiPath のプロジェクトであり、UiPath のロボットによって実行できます。新しいプロセス プロジェクトは、 クロスプラットフォーム プロジェクト または Windows プロジェクトのいずれかである必要があります。Windows – レガシでは古いバージョンの the.NET Framework が使用されており、近い将来、新しいプロジェクトのオプションでは利用できなくなります。Data Service のエンティティはプロセス内にはインポートしないでください。個々のプロセス内でインポートすると、ソリューション アクセラレータ全体で名前空間が競合する可能性があります。

プロセスには次の要件があります。

projectType	Windows プロジェクト クロスプラットフォームプロジェクト
プロセスサイズ	小規模で適切に区切られたプロセス
注釈	各ワークフロー ファイルに免責事項/説明としてピン留めされた注釈を追加します。 一般的な形式では、ワークフローの目的と、送受信する各引数の説明を説明します アクティビティに適切な説明で注釈を付ける
変数の命名規則	オートメーション プロセス全体で一貫した変数命名規則を維持することは、読みやすさと明瞭さのために重要です 標準的な UiPath 開発者が従うのは、キャメル ケースの小文字です (例: firstName、myFirstName、lastName、myOrganizationStructure)。
引数の命名規則	キャメルケースの小文字で、引数の型が入力、出力、または入力/出力のいずれかであることを示すプレフィックスを付けます ( 例: in_defaultTimeout、in_fileName、out_textResult、io_retryNumber )。 注釈は、ワークフローが呼び出されたときに表示されるすべての引数に存在する必要があります
コメント	顧客のシナリオに基づいてロジックを変更する必要がある設定の領域や強調表示するために、適切な場所にコメント アクティビティを追加します
Data Service エンティティ	Data Service のエンティティはプロセス内にインポートしないでください。 名前空間の競合を避けるため、Data Service のエンティティは共通のライブラリ内にインポートする必要があります。 Data Service の操作は、ライブラリからインポートした名前空間を持つプロセスで発生する可能性があります。
層	アプリケーション層(特定のアプリケーションにAPIまたはUI自動化を使用できますが、これは開発者の裁量に任されています) ビジネス ロジック層/実装層