アクション

Interact Web APIサービスには多数のアクションがあり、Blue Prismオブジェクト（ユーティリティ - Interact API）の使用から呼び出されます。以下のセクションでは、各アクションを順番に確認しながら、自動化の中でこれらのアクションを使用する方法を説明します。

すべてのWeb APIサービスアクションは、Webサービスから直接呼び出すのではなく、Blue Prismのユーティリティ - Interact API VBOから呼び出す必要があります。

送信を取得

［送信を取得］アクションは、キューから情報を取得する際に、［次のアイテムを取得］アクションと非常によく似たアクションを実行します。

アクションを利用するには、アクションをプロセスと選択したビジネスオブジェクトに追加し、アクションを［送信を取得］に設定します。入力パラメーターは、以下に示す送信IDのみです。

出力パラメーターは、送信IDをコレクションに使用してInteractフォームの内容を取得します。

標準の［次のアイテムを取得］アクションではなく、この方法を使用して送信を取得する場合の違いの1つは、日付要素の形式です。［次のアイテムを取得］手法を使用すると、日付はテキスト形式で返されますが、［送信を取得］では次のようにDateTime形式で返されます。

シナリオの全リストについては、「Interact Web APIサービスのオブジェクト制限」を参照してください。

送信IDがわかっている場合を除き、［送信を取得］アクションは使用できません。これは送信ごとに一意であるため、自動化にハードコードすることはできません。これは、［次のアイテムを取得］アクションを使用して取得する必要があります。

フォームスキーマを取得

［フォームスキーマを取得］アクションは、コレクション内のInteractフォームの構造を取得し、処理後［送信を作成］アクションを使用して、ユーザーが入力して送信できるようInteractフォームを空または部分的に作成します。

次の図に示すように、入力パラメーターは1つのみで、それは構造を取得するInteract内のフォームの名前です。

出力パラメーターは、リクエストステータスが、フィールドを含むコレクションとともに返される［送信を取得］アクションと似ています。

取得したコレクションは、フォームの構造を含む空白のコレクションです。

表示されるフィールドの構造は、［次のアイテムを取得］形式と同じ形式であるため、日付要素ではテキストデータ型の送信が要求されます。テキストタイプが使用されるのは、Interact内の複数の形式の日付要素タイプをサポートするためです。日付は、英国形式、米国形式、または国際形式で指定できます。

送信を作成

［送信を作成］アクション内では4つのパラメーターを定義する必要があります。

4つのパラメーターは以下のとおりです。

• ユーザー名 – 送信を作成するInteractユーザーのユーザー名。
• パスワード – このInteractユーザーのパスワード。
• フォーム名 – Interact内で作成されるフォーム。
• フィールド – 作成された送信内で設定される値。

新しい送信の作成を補助するために、［フォームスキーマを取得］を使用してフォームの基本構造を取得できます。これには新しいデータアイテムが入力され、ユーザーの新しい送信として作成されます。

送信を作成するには、フィールドとフォームスキーマがInteract内のフォームのフィールドとフォームスキーマに一致している必要があります。フィールドがないか構造が間違っていると、破損した送信が作成されます。

いったん開始されると、作成された送信は、指定されたユーザーの送信履歴に送信済みフォームとして表示され、フォーム構造に詳細が示された、指定されたBlue Prismキューに追加されます。

認証情報を使用して新しい送信を作成するユーザーには、フォームへのアクセスを許可する必要があります。そのため、フォームを含むInteract役割には、ユーザーリストで指定されたユーザーが必要です。

［送信を作成］アクションには出力パラメーターがありません。

送信を生成する

送信フィールド値を編集

［送信フィールド値を編集］アクションは、他のすべてのアクションと同様に、オブジェクトから呼び出されます。オブジェクト内には、特定のフィールド要素を更新できるアクションがいくつかあります。これらのアクションは、Interactフォームで使用される要素タイプに直接リンクしています。

以下のセクションのフィールド名は、フォームデザイナー内で作成されたオートメーションIDです。

さまざまな要素タイプの詳細については、以降のセクションで説明します。

チェックボックス要素（単一）

チェックボックス編集値は、単一チェックボックスと複数チェックボックスの両方の使用をサポートする2つの異なるアクションです。単一チェックボックスの値を更新するには、単純なテキスト文字列が送信されます。

チェックボックス要素（複数）

チェックボックス編集値（複数）については、やはり単純なテキスト文字列が送信されますが、異なる値にはカンマ区切りの文字列を使用します。

日付要素

日付要素は、テキスト形式を使用してInteractフォーム内の値を編集します。これは、Interactフォーム内の3つの異なる形式をサポートするためのものです。このフォームでは、以下の形式を日付に使用できます。

• DD/MM/YYYY – 英国形式。
• MM/DD/YYYY – 米国形式。
• YYYY/MM/DD – 国際形式。

Interactフォームで日付を国際形式として承認するように設定し、英国または米国の形式で日付を差し戻すと、Interactフォームには無効なデータメッセージが表示されます。

ドロップダウン要素（単一）

ドロップダウン要素は、チェックボックス要素と同様に、単一のエントリと複数のエントリに対して2つのアクションをサポートします。単一ドロップダウンの値を更新するには、単純なテキスト文字列が送信されます。

ドロップダウン要素（複数）

ドロップダウン編集値（複数）については、やはり単純なテキスト文字列が送信されますが、異なる値にはカンマ区切りの文字列を使用します。

数値要素

数値要素は、渡される数値またはテキストを受け入れます。フィールドタイプはテキストタイプですが、カンマや小数点など、使用できる区切り記号のみを使用して数値を指定する必要があります。テキストが返されると、Interactフォームに無効なデータに関するメッセージが表示されます。

ラジオグループ要素

ラジオグループ要素は、単一のチェックボックスまたはドロップダウン要素に似ています。編集された値は、必要な更新値を含む単一のテキストフィールドです。

表要素

表要素は、値を更新するためにコレクションを使用します。コレクションには、ターゲットフォーム内のフォームフィールドと同じ数の列が含まれている必要があります。コレクションのフィールド名には、オートメーションIDを使用する必要があります。更新対象のデータに合わせて行数を増減できます。

［表を編集］アクションは、既存の表に行を追加するのとは対照的に、表全体を上書きします。

テキスト要素

テキスト要素には、その要素に渡す単純なテキストフィールドが必要です。

時間要素

時間要素は、テキスト形式を使用してInteractフォームの値を編集します。時間は、次の2つの形式のいずれかで指定できます。

• 03:00:00 PM、または
• 15:00:00。

どちらもInteractでは午後3時を返します。