PDAutomationProvider : champ d’application, global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 5 minutes de lecture

    • L’API PDAutomationProvider permet d’insérer une activité facultative dans un processus pendant son exécution.

    Cette API fait partie du module d’extension Playbooks (com.glide.pad.core) et s’exécute dans l’espace de noms sn_pad .

    L’appel de scripts avec cette API nécessite au moins l’un des éléments suivants :
    • L’appelant doit se trouver dans le même champ d’application que celui dans lequel le déclencheur d’activité facultative a été créé.
    • Privilèges d’administrateur.

    Un processus est une série d’activités organisées par voies. Une activité facultative est prédéfinie lors de la conception du processus. Les activités ne sont pas programmées pour se dérouler à une heure précise. Une activité peut être affectée à une voie et rendue disponible pour être exécutée pendant l’exécution de la voie. Une activité peut être affectée à un processus et être rendue disponible pour être exécutée pendant l’exécution de voie.

    Pour créer une activité facultative, la règle de démarrage doit être définie sur Manuel dans la table Activités [sys_pd_activity]. Playbooks ne prend actuellement pas en charge la création d’activités manuelles.

    Un agent ajoute l’activité facultative à une voie ou à une activité relative à une autre activité. Le processus doit être en cours d’exécution pour insérer une activité facultative.

    Voir aussi :

    PDAutomationProvider – addOptionalActivityRelativeToActivityContext(String contextID, String activityId, String where, String relativeToId)

    Ajoute une activité facultative spécifiée à un processus à exécuter par rapport à une autre activité pendant l’exécution du processus.

    Un contexte d’activité est créé pour chaque activité lorsqu’un processus s’exécute. Le contexte gère également la façon dont l’activité gère l’exécution. Pour plus d’informations, consultez Voies et activités Process Automation Designer.

    Tableau 1. Paramètres
    Nom Type Description
    ID contexte Chaîne Sys_id de l’exécution de l’activité à laquelle ajouter l’activité facultative. Pour y accéder, cliquez sur le processus répertorié dans la table Exécutions du processus [sys_pd_context]. L’exécution sélectionnée doit être à l’état En cours.
    activityId Chaîne Sys_id de l’activité facultative répertoriée dans la table Activités [sys_pd_activity].
    Remarque :
    Pour créer une activité facultative, la règle de démarrage doit être définie sur Manuel dans la table Activités [sys_pd_activity].
    où Chaîne Indique où placer l’activité dans le processus.
    Valeurs valides :
    • AFTER – Exécutez cette activité après l’activité relative Contexte.
    • AVEC : exécute l’activité en même temps qu’une autre activité relative Contexte.
    relativeToId Chaîne ID du contexte d’activité relatif après ou avec lequel l’activité facultative s’exécutera. Répertorié dans la table Contexte de l’activité [sys_pd_activity_context].
    Tableau 2. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’activité a été planifiée avec succès.
    Valeurs valides :
    • true : l’activité a été planifiée pour s’exécuter. Le résultat est une chaîne indiquant la réussite.
    • false : l’activité n’est pas planifiée avec succès pour s’exécuter. La sortie est un tableau d’un ou de plusieurs messages d’erreur.

    En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant Tableau de 0 éléments ou plus sinon.
    Tableau En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant Tableau de 0 éléments ou plus sinon.
    Messages d’erreur possibles :
    • ID d’activité facultative non valide : la sys_id fournie pour le paramètre n’est activityId pas valide.
    • ID de contexte PD non valide : la sys_id Process Designer (PD) fournie dans le paramètre n’est contextID pas valide.
    • Type de poste non valide – Le type de poste fourni n’est pas valide. Consultez la description du paramètre pour connaître les where types valides.
    • ID de relative-to non valide : la sys_id fournie pour le paramètre n’est relativeToId pas valide.
    • Activité facultative introuvable : la sys_id fournie pour le activityId paramètre est introuvable.
    • Le processus doit toujours être actif : le processus contenant cette activité doit être actif pour exécuter l’activité facultative.
    • Contexte d’activité relative introuvable : la sys_id fournie pour le relativeToId paramètre est introuvable.

    L’exemple suivant montre comment exécuter une activité facultative simultanément avec le contexte d’activité relative.

    var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'WITH'; // options AFTER, WITH
var relativeToId = '<relative_activity_context_id>'; // relative activity context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));
    Sortie (réussite) :
    success: boolean = true
errors: Array of 0 elements

    PDAutomationProvider – addOptionalActivityRelativeToLaneContext(String contextID, String activityId, String where, String relativeToId)

    Affecte une activité facultative à une voie à exécuter pendant le contexte d’exécution de cette voie.

    Un contexte de voie est créé pour chaque voie lorsqu’un processus s’exécute. Le contexte gère également la façon dont la voie gère l’exécution. Pour plus d’informations, consultez Voies et activités Process Automation Designer.

    Tableau 3. Paramètres
    Nom Type Description
    ID contexte Chaîne Sys_id de l’exécution de l’activité à laquelle ajouter l’activité facultative. Pour y accéder, cliquez sur le processus répertorié dans la table Exécutions du processus [sys_pd_context]. L’exécution sélectionnée doit être à l’état En cours.
    activityId Chaîne Sys_id de l’activité facultative répertoriée dans la table Activités [sys_pd_activity].
    Remarque :
    Pour créer une activité facultative, la règle de démarrage doit être définie sur Manuel dans la table Activités [sys_pd_activity].
    où Chaîne Indique où placer l’activité dans le processus.
    Valeurs valides :
    • LAST – Exécuter en tant qu’activité finale dans une voie Contexte.
    • SUIVANT : exécute l’activité suivante dans une voie Contexte.
    relativeToId Chaîne ID du contexte de voie relative dans lequel l’activité facultative doit s’exécuter. Répertorié dans la table Contexte de la voie [sys_pd_lane_context].
    Tableau 4. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’activité a été planifiée avec succès.
    Valeurs valides :
    • true : l’activité a été planifiée pour s’exécuter. Le résultat est une chaîne indiquant la réussite.
    • false : l’activité n’est pas planifiée avec succès pour s’exécuter. La sortie est un tableau d’un ou de plusieurs messages d’erreur.
    Tableau En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant Tableau de 0 éléments ou plus sinon.
    Messages d’erreur possibles :
    • ID d’activité facultative non valide : la sys_id fournie pour le paramètre n’est activityId pas valide.
    • ID de contexte PD non valide : la sys_id Process Designer (PD) fournie dans le paramètre n’est contextID pas valide.
    • Type de poste non valide – Le type de poste fourni n’est pas valide. Consultez la description du paramètre pour connaître les where types valides.
    • ID de relative-to non valide : la sys_id fournie pour le paramètre n’est relativeToId pas valide.
    • Impossible d’ajouter l’activité facultative à la voie : l’activité facultative fournie dans le activityId paramètre ne peut pas être ajoutée par rapport à la voie fournie dans le relativeToId paramètre. Assurez-vous que l’exécution de l’activité sélectionnée est à l’état En cours .
    • Activité facultative introuvable : la sys_id fournie pour le activityId paramètre est introuvable.
    • Le processus doit toujours être actif : le processus contenant cette activité doit être actif pour exécuter l’activité facultative.
    • Contexte de voie relative introuvable : la sys_id fournie pour le relativeToId paramètre est introuvable.

    L’exemple suivant montre comment exécuter une activité facultative comme activité finale dans un contexte de voie.

    var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'LAST'; // options LAST, NEXT
var relativeToId = '<relative_lane_context_id>'; // relative lane context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));
    Sortie (réussite) :
    success: boolean = true
errors: Array of 0 elements