Marketplace ユーザーガイド

最終更新日時 2024年9月5日

内容

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

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

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

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

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

2. 展開フォルダー

a. 資産の詳細

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

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

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

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

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

作成

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

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

資格情報を作成

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

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

b. キューの詳細

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

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

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

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

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

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

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

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

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

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

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

重要:

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

ライブラリがプロジェクト内で正しく動作するように変更されることが予想される場合は、配置フォルダーに含まれないことが予想され、配置ガイドでは、そのライブラリを使用するすべてのプロジェクトでライブラリを変更、発行、および依存関係を更新する必要があることを明確にする必要があります。

UiPath Solution Accelerators の汎用再利用可能なファイルのように、再利用可能なライブラリがフィード上で個別にパブリッシュされている場合は、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)
引数の命名規則	引数にはパスカルケース標準を使用して名前を付ける必要があります。引数の名前には、ライブラリの作成時にこれらの引数がプロパティとして表示されるため、 in_/out_/io_プレフィックスを含めないでください。注釈は、[ライブラリ] アクティビティの使用時に表示されるため、すべての引数に存在する必要があります
引数の結果	ライブラリワークフローは、ワークフロー名が記述されているようにする必要がありますワークフローは、API または GUI の結果を解析し、特定のデータの結果を返す必要があります
コメント	コメントを追加してライブラリプロジェクトの読みやすさを向上
Data Service エンティティ	Data Service のエンティティはライブラリ内にインポートできます。名前空間はエンティティの名前である必要があります。 Data Service の操作をライブラリで実行することで、ソリューションアクセラレータ全体でのエンティティの再利用性を向上できます。
例外処理	ライブラリ内のエラーは、出力引数によって通知されるのではなく、例外としてスローされる必要があります。目的のアクションが実行されたかどうかを確認して、ライブラリコンポーネントの結果を最後に確認し、発生していない場合は例外をスローします。

5. プロセス

プロセスとは、プロセス設計オプションを使用して開発された UiPath のプロジェクトで、UiPath のロボットで実行できます。新しいプロセスプロジェクトは、クロスプラットフォームプロジェクトまたは Windows プロジェクトである必要があります。 Windows – レガシでは古いバージョンの .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自動化を使用できますが、これは開発者の裁量に任されています) ビジネスロジック層/実装層