Obtenir le statut de l'analyse du document

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)

Mode de fonctionnement

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. Terminez les étapes de Configuration .
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. Entrez les valeurs pour les propriétés Input .
6. Create and enter a String variable for your Output property.
7. Exécutez l’activité.

   • Your input properties are sent to the GetDocumentAnalysis API.

   • L'API renvoie la valeur String à votre variable de propriété de sortie.

     

Propriétés

Les valeurs des propriétés suivantes sont spécifiées lors de l'ajout de cette activité à votre projet dans UiPath Studio.

Commun

DisplayName

Le nom complet de l’activité.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Oui (Yes)
Valeur par défaut	Get Document Analysis Status
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	S/O

Entrée

JobId

L'identifiant affecté au processus d'analyse de document que vous souhaitez récupérer.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Non (recommandé si vous prévoyez d'utiliser les données de sortie dans des activités ultérieures)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String
Remarques	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)

Divers

Private

Si elles sont sélectionnées, les valeurs des variables et des arguments ne sont plus enregistrées au niveau détaillé.

Attributs	Détails (Details)
Saisie de texte	Case à cocher
Requis	Non (No)
Valeur par défaut	non sélectionné
Valeurs autorisées	Sélectionné ou Non sélectionné
Remarques	S/O

Sortie

JobStatus

The status of the specified JobId.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Non (recommandé si vous prévoyez d'utiliser les données de sortie dans des activités ultérieures)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String
Remarques	Il y a 4 valeurs de statut possibles : IN_PROGRESS réussie Échec PARTIAL_SUCCESS

Exemple

L'image suivante montre un exemple de la relation de dépendance d'activité et des valeurs de propriété d'entrée/sortie.

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