Get Document Analysis Status

The Get Document Analysis Status activity uses the Amazon Textract GetDocumentAnalysis API to asynchronously retrieve the status of an existing or previously executed document analysis job (JobId).

After retrieving the document analysis, the activity returns the job status as a String value that you can use as a condition to run other activities (for example, Get Document Analysis).

To avoid overloading the Amazon Textract service with requests, it's recommended that you implement a delay between each execution of this activity (for example, add the Get Document Analysis Status and a Delay activity inside a Do While activity - see example section below)

動作のしくみ

The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.

1. 「セットアップ」の手順を完了します。
2. Add the Amazon Scope activity to your project.
3. Add an activity or run an external process that outputs a JobId value (for example, Start Document Analysis).
4. Add the Get Document Analysis Status inside the Amazon Scope activity.
5. [入力] セクションのプロパティに値を入力します。
6. Create and enter a String variable for your Output property.
7. アクティビティを実行します。

   • Your input properties are sent to the GetDocumentAnalysis API.

   • API は、[出力] セクションのプロパティ変数に String の値を返します。

     

プロパティ

以下のプロパティの値は、このアクティビティを UiPath Studio でプロジェクトに追加するときに指定します。

共通

表示名

アクティビティの表示名です。

属性	詳細
入力	String
Required	はい
既定値	Get Document Analysis Status
許容値	String または String 型変数を入力します。
備考	N/A

入力

ジョブ ID

取得するドキュメント分析プロセスに割り当てられた識別子です。

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String または String 型変数を入力します。
備考	To get the JobId String value, use an external process or activity that includes the JobID value in its output (e.g., Start Document Analysis or external API call)

その他

プライベート (Private)

選択すると、変数と引数の値が Verbose レベルでログ記録されなくなります。

属性	詳細
入力	チェックボックス
Required	いいえ
既定値	非選択
許容値	選択または非選択
備考	N/A

出力

JobStatus

The status of the specified JobId.

属性	詳細
入力	String
Required	いいえ (後続のアクティビティで出力データを使用する予定がある場合に推奨)
既定値	空
許容値	String 型変数を入力します。
備考	以下の 4 つのステータス値が考られます。 IN_PROGRESS 成功 失敗 PARTIAL_SUCCESS

例

次の画像は、アクティビティの依存関係と入力/出力プロパティの値の例です。

For step-by-step instructions and examples, see the Quickstart guides.