Box スコープ

UiPath.Box.Activities.BoxScope

Box アクティビティでは、JWT 認証を使用して UiPath と Box カスタムアプリとの間の接続を確立します。この接続によってロボットが Box API を呼び出し、ユーザーに代わってリソースにアクセスできる権限が付与されます。

認証を有効化するには、JWT 認証を使用して Box カスタムアプリを作成します。アプリケーションを作成すると、Box は認証されたコネクションするために必要な情報を含む構成ファイルを生成します。また、OAuth 認証を使用して Box カスタムアプリを作成することもできます。詳しくは「セットアップ」をご覧ください。オートメーションプロジェクトをはじめて構築する前にもこちらのページをご覧ください。

カスタムアプリを作成したら、使用する認証の種類 ([認証の種類]) を選択し、構成ファイルの場所 ([構成ファイルパス]) またはファイルの内容 ([構成ファイルの内容]) を [Box スコープ] アクティビティに入力します (JWT 認証を使用する場合)。OAuth 認証を使用する場合は、[クライアント ID] と [クライアントシークレット] を入力します。

接続の確立後、親の [Box スコープ] アクティビティは接続のレコードを BoxClient オブジェクト ([Box 接続]) に出力します。このオブジェクトは、後続の子アクティビティで使用できます。

動作のしくみ

以下の手順とメッセージシーケンスダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

「セットアップ」の手順を完了します。
[Box スコープ] アクティビティをプロジェクトに追加します。
[入力] プロパティと [JWT 認証] プロパティ (JWT を使用する場合) の値を入力します。
[出力] セクションのプロパティのために BoxClient 型変数を作成し、入力します。
- この変数は、後続の [Box スコープ] アクティビティで使用できます。

プロパティ

共通

エラー発生時に実行を継続 - 例外がスローされた際にアクティビティの実行を継続するかどうかを指定します。このフィールドでは、Boolean 値のみがサポートされています。
表示名 - アクティビティの表示名です。このフィールドでは Strings 型または String 型変数のみがサポートされます。

既存の接続

Box 接続 - 親の [Box スコープ] アクティビティから取得する接続のレコードです。新しい接続を確立する代わりに使用できます。このフィールドでは BoxClient 変数のみがサポートされています。
- BoxClient 型変数は、以前に実行して、まだアクティブな接続を保っている [Box スコープ] アクティビティ (親) のものを使用する必要があります。
- このプロパティを使用して接続を確立できない場合は、親の [Box スコープ] アクティビティを再実行してみてください。

入力

認証の種類 - カスタムアプリへの接続に使用する認証の種類です。ドロップダウンリストから次の 3 つの項目のいずれかを選択します。
- JWT - JWT 認証を指定します。[Box スコープ] アクティビティの最初の実行 (親スコープの実行) に必要です。
- OAuth - OAuth 認証を指定します。[Box スコープ] アクティビティの最初の実行 (親スコープの実行) に必要です。
- Box 接続 - 親スコープを含む同一のオートメーションプロジェクト内の [Box スコープ] の実行に対しては任意です。

JWT 認証

構成ファイルの内容 - String オブジェクト形式の、JSON 構成ファイルの内容です。このフィールドでは、Strings または String 型の変数のみがサポートされています。構成ファイルについて詳しくは、Box の「セットアップ」をご覧ください。
構成ファイルパス - ダウンロードされる構成ファイルの場所です。このフィールドでは Strings または String 型の変数のみがサポートされています。構成ファイルについて詳しくは、Box の「セットアップ」をご覧ください。
ユーザー ID - 認証に使用するユーザーアカウントの ID です。このフィールドでは Strings 型または String 型変数のみがサポートされます。設定しない場合、認証はサービスアカウントに対して行われます。

その他

プライベート - このチェックボックスをオンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

OAuth 2.0 認証

クライアント ID - Box アプリケーションのクライアント ID です。このフィールドでは Strings または String 型の変数のみがサポートされています。構成ファイルについて詳しくは、Box の「セットアップ」をご覧ください。
クライアントシークレット - Box アプリケーションのクライアントシークレットです。SecureString または SecureString 型変数を入力します。構成ファイルについて詳しくは、Box の「セットアップ」をご覧ください。

出力

Box 接続 - このスコープアクティビティに含まれる他の [Box スコープ] アクティビティで使用できる、確立済みの接続のレコードです。このフィールドでは BoxClient 変数のみがサポートされています。

注:
この変数は、親スコープアクティビティ内から呼び出される、ワークフロー内のスコープアクティビティに渡すことができます。

たとえば、3 つのワークフローを使用するとします。最初のワークフローには、登録アプリケーションへの接続を確立する親スコープアクティビティ (つまり親ワークフロー) が含まれます。第 2 のワークフローは新しい連絡先レコードを作成し、第 3 のワークフローは新しいアカウントレコードを作成します。いずれも親スコープアクティビティに含まれています。

ワークフローを実行すると、親スコープアクティビティは、第 2、第 3 のワークフローの既存の接続 ([Box 接続] プロパティ) に、BoxClient 変数を渡します (下の図をご覧ください)。