コンポーネントのユーザー ガイド テンプレート

すべての種類のコンポーネントに関する一般情報

はじめに - コンポーネントの目的

• このセクションには、コンポーネントの概要と目的を簡単に記載します。
• コンポーネントの機能を示す、関連するビデオ、デモ、スクリーンショットがあれば追加します。
• UiPath Studio との相互運用性を指定します。

ユース ケース

このセクションでは、業務プロセスでのコンポーネントの用途とそのメリットを説明します。つまり、どのような問題を解決できるのかということです。

前提条件 (該当する場合)

設定前に他のソースからダウンロードする必要のある成果物やソフトウェアがある場合は、このセクションに記載します。例:

• サードパーティ ソフトウェアまたはプラットフォームをダウンロードするための URL
• API キーまたはライセンスを取得するための URL
• ソフトウェアのバージョン
• その他すべての依存関係、それらの入手先、インストールと設定の方法

設定 (該当する場合)

このセクションには、コンポーネントを使用する前に環境を準備するための手順を記載します。

新しいキーまたはライセンスを生成する必要がある場合は、その手順を示します。

例: Google Direction API を使用してキーを生成する手順は以下のとおりです。

• Google アカウントにログインします。
• https://console.developers.google.com にアクセスします。
• 無料トライアルをアクティブにします。
• 同意して続行します。
• 住所とクレジット カードの情報を入力します (無料トライアル終了後の自動課金はありません)。
• 「Google API」のロゴをクリックして、ホーム ページに移動します。
• [認証情報] > [認証情報を作成] をクリックします。
• [API キー] を選択します。
• API キーをメモします (これがオートメーションで使用するキーになります)。
• 「Direction API」を有効化するには、Google API のロゴをクリックしてホーム ページに移動します。
• [API とサービスを有効化] をクリックします。
• 「Direction API」を検索します。
• 「Direction API」を有効化します。

実行する必要がある PowerShell スクリプトがある場合は、スクリプトの実行を含む関連するスクリーンショットを含めます。

その他の必要な設定手順 (および、関連するスクリーンショット)

各種類のコンポーネントについての情報

カスタム アクティビティ

このセクションには、含まれる各アクティビティの簡単な説明を記載します。さらに、各アクティビティの各パラメーターについて詳しく説明します。

各種アクティビティの内容や設定方法を示すスクリーンショットも、ユーザーが情報を簡単に手に入れるために役立ちます。

プラットフォーム スコープ

• アクティビティの簡単な説明を記載します。
• このアクティビティは、このパッケージとプラットフォームに含まれる各アクティビティ間の接続を保証します。各アクティビティは、この親アクティビティ内に配置する必要があります。

入力

• URL (文字列) - プラットフォームの URL です。[アカウント プロフィール] > [API] > [URL] に移動することで確認できます。
• API トークン (文字列) - [アカウント プロフィール] > [API] > [資格情報] で確認できる API トークンです。

出力

• トークン (文字列) - 生成されるトークンです。各要求で使用できます。

例:

• このセクションには、UiPath Studio でオートメーションを使用するための手順を記載します。
• カスタム アクティビティの場合、プロパティに渡される入力形式の値の例
• 複数のアクティビティが含まれているカスタム アクティビティの場合、それらのアクティビティを特定の順序で使用する必要があるときには、アクティビティの使用法を示すサンプル ワークフローのスクリーンショットを添えます。例: 次のスクリーンショットの「スコープ」系アクティビティ、[Create Document]、[Create Recipient]、[Define Envelope]、[Send Envelope]、[Download Envelope] は、すべて同じカスタム アクティビティ パッケージに含まれます。

スニペット

このセクションには、以下を記載します。

• 各ワークフロー ファイルに関する簡単な説明
• 設定ファイルに関する簡単な説明 (必要に応じて)
• 各 XAML のすべてのパラメーターについての詳細な説明

ワークフロー テンプレート/ソリューション

このセクションには、テンプレートに関する簡単な説明を記載します。使用されているベスト プラクティス、各種ワークフローの数と目的のほか、

使用されている引数と変数、および設定に必要な手順についても簡単に記載しておきます。

例：

Robotic Enterprise Framework は、[ステート マシン] に基づくプロジェクト テンプレートです。このテンプレートは、ログ、例外処理、アプリケーションの初期化などに関するすべてのベスト プラクティスに適合するよう作成されているため、これを使えばすぐに複雑なビジネス シナリオに取り組むことができます。

このテンプレートには、アプリケーションの初期化、入力データの取得と処理、トランザクションの終了のために事前作成された複数の [ステート] コンテナーが含まれています。こうした [ステート] はすべて、複数の [遷移条件] を通じて接続され、標準的なオートメーション シナリオのほぼすべてのニーズに対応します。また、複数の呼び出されたワークフローもあり、それぞれがプロジェクトの特定の部分の処理を行います。