Ajouter et configurer une étape Update Job Properties (Mettre à jour les propriétés de tâche)

L’étape Update Job Properties (Mettre à jour les propriétés de tâche) permet à la personne qui exécute une tâche de mettre à jour les propriétés étendues et les propriétés de tâche suivantes :

• job_name
• start_date
• due_date
• priority_rank
• description
• owned_by
• job_status
• notes
• parent_job

Lorsque l’étape est exécutée, les propriétés configurée dans l’étape apparaissent dans la vignette de la tâche. Si un texte d’aide est configuré pour l’étape, il apparaît en bas de la vignette de la tâche. Les valeurs par défaut ou en cours apparaissent dans la zone de texte située sous chaque propriété pouvant être mise à jour.

Si une propriété contient une valeur non valide ou si une propriété obligatoire ne contient pas de valeur, la propriété est mise en surbrillance en rouge et le bouton Proceed (Poursuivre) n’est pas disponible.

Remarque :

Si une propriété est automatiquement mise à jour et rencontre une erreur, l’étape échoue et une erreur apparaît dans la vignette de la tâche. L’erreur est également consignée dans les journaux ArcGIS Server.

When the step is run, the following actions can be performed:

• The step can be cancelled by clicking Cancel.
• The step can be finished by clicking Proceed.

Configurer l’étape

To configure the step, do the following:

1. Create or edit a workflow diagram to access the Step Library panel.
2. Faites glisser Update Job Properties (Mettre à jour les propriétés de tâche) depuis le volet Step Library (Bibliothèque d’étapes) vers une flèche de connexion d’une étape de la zone d’affichage du workflow.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. Optionally, add the message you want to appear when the step is run in the User Prompt text box.

   You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

   'This job is currently assigned to ' + jobOwner($job) + '.'

5. Dans la section Arguments, saisissez le nom de la table et le nom du champ de la propriété à mettre à jour dans la zone de texte Job Property (Propriété de tâche) avec la syntaxe suivante :

   tablename.fieldname

   Remarque :

   Le nom de table des propriétés de tâche est jobs. Les noms des tables de propriétés étendues se trouvent sur l’onglet Extended Properties (Propriétés étendues) du modèle de tâche.

6. Vous pouvez cliquer sur le bouton Show default value (Afficher la valeur par défaut) pour définir la valeur par défaut et les paramètres de visibilité de la propriété lorsque l’étape est exécutée.
   1. Sélectionnez l’une des options suivantes :
      • Value (Valeur) : indiquez une valeur statique.
      • Arcade Expression (Expression Arcade) : indiquez une valeur dynamique à l’aide d’une expression Arcade.
   2. Indiquez une valeur par défaut pour la propriété dans la zone de texte Value (Valeur) ou Arcade Expression (Expression Arcade).
   3. Cochez la case Visible pour autoriser la modification de la valeur lorsque l’étape est exécutée.

   Attention :

   Si aucune valeur par défaut n’est indiquée et que la case Visible n’est pas cochée, la valeur en cours de la propriété de tâche est supprimée lorsque l’étape est exécutée.

7. Au besoin, cliquez sur Add New Job Property (Ajouter une nouvelle propriété de tâche) et répétez les étapes 5 et 6 pour ajouter plus de propriétés.

   Remarque :

   Pour supprimer une propriété de tâche, positionnez le pointeur sur cette dernière et cliquez sur le bouton Delete Property (Supprimer la propriété) .

8. Optionally, hover over a property, click the Reorder Property button , and drag it to the desired location to reorder the properties.
9. Click the Options tab.
10. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Remarque :

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

11. Optionally, check the Enabled check box in the Step Commenting section to allow a user to add a comment when the step is run.
12. Optionally, if you enabled step commenting, check the Required check box in the Step Commenting section to require a comment.
13. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

14. Optionally, click the Style tab to change the shape and color of the step.
15. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Remarque :

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.