PDAutomationProvider : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 9 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’une des options suivantes :
    • 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 classées par voies. Une activité facultative est prédéfinie lors de la conception du processus. Les activités ne sont pas planifiées pour se dérouler à une heure précise. Une activité peut être affectée à une voie et disponible pour être exécutée pendant l’exécution de voie. Une activité peut être affectée à un processus et 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__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é par rapport à une autre activité. Le processus doit être en cours d’exécution pour insérer une activité facultative.

    Voir aussi :

    PDAutomationProvider – activateProcess(String processDefinitionSysId)

    Active un playbook.

    Tableau 1. Paramètres
    Nom Type Description
    processDefinitionSysId Chaîne Le sys_id d’un playbook situé dans la table Définitions de processus [sys__process_definition].
    Tableau 2. Renvoie
    Propriété Description
    Objet Objet contenant les détails de l’activation de la définition de processus.
    {
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}
    erreurs Liste d’erreurs. Vide en cas de réussite.

    Type de données : tableau de chaîne(s)
    process_definition Playbook activé et ses propriétés.

    Type de données : objet

    "process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}
    process_definition.active Marqueur indiquant si la définition du processus pour le playbook désactivé est active. Recherchez les définitions de processus dans la liste Définitions de processus [sys__process_definition].
    Valeurs valides :
    • true : la définition du processus pour le playbook désactivé est active.
    • false : la définition du processus pour le playbook désactivé est inactive.

    Type de données : booléennes
    process_definition.snapshot Contient des détails sur la définition du processus au moment de l’activation.

    Type de données : objet

    {
  "snapshot":
    {
      "created": "String",
      "processDefinitionSysId": "String"
    }
}
    process_definition. instantané. créé Date à laquelle le playbook a été créé.

    Type de données : chaîne
    process_definition. instantané. processDefinitionSysId La sys_id du playbook activé.

    Type de données : chaîne
    process_definition.État Indique l’état de publication du playbook.
    Valeurs possibles :
    • draft : le playbook est à l’état de draft.
    • publié : le playbook est à l’état publié.

    Type de données : chaîne
    État Indique si votre demande d’activation a abouti ou non.
    Valeurs possibles :
    • RÉUSSITE : le playbook a été activé avec succès.
    • ÉCHEC : L’ID du playbook est introuvable.

    Type de données : objet

    L’exemple suivant montre comment activer un playbook.

    var myPlaybook = sn_pad.PDAutomationProvider.activateProcess('cdd1b85e43000210d96e29c28ab8f275');
gs.info(JSON.stringify(myPlaybook));
    Sortie : 
    {
  "process_definition": {
    "active": true,
    "snapshot": {
      "processDefinitionId": "cdd1b85e43000210d96e29c28ab8f275",
      "created": "2024-02-19 22:58:12"
    },
    "status": "published"
  },
  "state": "SUCCESS",
  "errors": []
}

    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 les voies et les activités de Process Automation Designer.

    Tableau 3. Paramètres
    Nom Type Description
    ID contexte Chaîne Sys_id de l’exécution de l’activité dans laquelle ajouter l’activité facultative. Pour y accéder, cliquez sur le processus répertorié dans la table Exécutions du processus [sys__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 le tableau Activités [sys__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__activity].
    où Chaîne Indique où placer l’activité dans le processus.
    Valeurs valides :
    • APRÈS : exécute 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 lequel ou avec lequel l’activité facultative s’exécutera. Répertorié dans la table Contexte de l’activité [sys__activity_context].
    Tableau 4. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’exécution de l’activité a été planifiée.
    Valeurs valides :
    • vrai : l’exécution de l’activité a été planifiée. Le résultat est une chaîne indiquant la réussite.
    • faux : l’exécution de l’activité n’a pas été planifiée. La sortie est un tableau d’un ou plusieurs messages d’erreur.

    En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant le tableau de 0 ou plusieurs éléments dans le cas contraire.
    Tableau En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant le tableau de 0 ou plusieurs éléments dans le cas contraire.
    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 non valide : le sys_id de Concepteur de processus () fourni 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 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é relatif.

    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 les voies et les activités de Process Automation Designer.

    Tableau 5. Paramètres
    Nom Type Description
    ID contexte Chaîne Sys_id de l’exécution de l’activité dans laquelle ajouter l’activité facultative. Pour y accéder, cliquez sur le processus répertorié dans la table Exécutions du processus [sys__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 le tableau Activités [sys__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__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.
    • NEXT – Exécuter 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__lane_context].
    Tableau 6. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’exécution de l’activité a été planifiée.
    Valeurs valides :
    • vrai : l’exécution de l’activité a été planifiée. Le résultat est une chaîne indiquant la réussite.
    • faux : l’exécution de l’activité n’a pas été planifiée. La sortie est un tableau d’un ou plusieurs messages d’erreur.
    Tableau En cas d’erreur, liste d’un ou de plusieurs messages d’erreur. Message indiquant le tableau de 0 ou plusieurs éléments dans le cas contraire.
    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 non valide : le sys_id de Concepteur de processus () fourni 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 non valide : la sys_id fournie pour le paramètre n’est relativeToId pas valide.
    • Impossible d’ajouter une activité facultative à la voie : l’activité facultative fournie dans le activityId paramètre ne peut pas être ajoutée par rapport à la voie indiquée 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 en tant qu’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

    PDAutomationProvider – deactivateProcess(String processDefinitionSysId)

    Désactive un playbook.

    Tableau 7. Paramètres
    Nom Type Description
    processDefinitionSysId Chaîne Le sys_id d’un playbook situé dans la table Définitions de processus [sys__process_definition].
    Tableau 8. Renvoie
    Propriété Description
    Objet Objet contenant les détails de désactivation de la définition de processus.
    {
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}
    erreurs Liste d’erreurs. Vide en cas de réussite.

    Type de données : tableau de chaîne(s)
    process_definition Playbook désactivé et ses propriétés.

    Type de données : objet

    "process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}
    process_definition.active Indique si la définition du processus pour le playbook désactivé est active. Recherchez les définitions de processus dans la liste Définitions de processus [sys__process_definition].
    Valeurs possibles :
    • true : la définition du processus pour le playbook désactivé est active.
    • false : la définition du processus pour le playbook désactivé est inactive.

    Type de données : booléennes
    process_definition.description Détails sur votre playbook désactivé.

    Type de données : chaîne
    process_definition.label Le nom du playbook désactivé que les utilisateurs voient dans l’interface.

    Type de données : chaîne
    process_definition.name Nom du playbook désactivé dans le code. Uniquement utilisé comme paramètre de demande dans le scripting.

    Type de données : chaîne
    process_definition.champ d’application sys_id du périmètre de l’application pour lequel votre playbook est désactivé.

    Type de données : chaîne
    process_definition.État Si le playbook est publié, il redevient un brouillon.

    Type de données : chaîne
    État Indique si la désactivation a réussi.
    Valeurs possibles :
    • RÉUSSITE : le playbook a été désactivé avec succès.
    • ÉCHEC : L’ID du playbook est introuvable.

    Type de données : chaîne

    Désactivez le playbook.

    sn_pad.PDAutomationProvider.deactivateProcess('cdd1b85e43000210d96e29c28ab8f275')

    Sorties :

    {"process_definition":{"scope":"global","name":"test","active":true,"description":"","label":"test","status":"draft"},"state":"SUCCESS"}

    PDAutomationProvider : duplicateProcess(String processDefinitionSysId, étiquette de chaîne, description de la chaîne, String scopeId, String triggerTypeId)

    Dupliquez un playbook.

    Tableau 9. Paramètres
    Nom Type Description
    processDefinitionSysId Chaîne Le sys_id d’un playbook situé dans la table Définitions de processus [sys__process_definition].
    étiquette Chaîne Nom du playbook dupliqué.
    description Chaîne Facultatif. Ajoutez des détails sur votre playbook.
    scopeId Chaîne La sys_id du périmètre de l’application dans lequel vous souhaitez que votre playbook s’exécute. Le nom inclus dans le champ d’application provient de la table de définition de processus [sys__process_definition] au format scope.name. La saisie des sys_id pour le périmètre global permet à votre playbook de s’exécuter dans n’importe quel périmètre de l’application.
    triggerTypeId (en anglais seulement) Chaîne La sys_id du déclencheur à partir duquel lancer les exécutions du playbook. Recherchez le type de déclencheur dans la table Type de déclencheur [sys__trigger_type] et copiez son sys_id.
    Tableau 10. Renvoie
    Propriété Description
    Objet Objet contenant les détails de la duplication de la définition du processus.
    {
  "errors": [Array]
  "processDefinitionSysId": "String",
  "state": "String"
}
    erreurs Liste d’erreurs. Vide en cas de réussite.

    Type de données : tableau de chaîne(s)

    Messages d’erreur possibles :
    • Périmètre introuvable pour scopeId : xyz
    • Définition du processus introuvable pour l’ID : xyz
    • Type de déclencheur introuvable pour triggerTypeId : xyz
    processDefinitionSysId La sys_id du nouveau playbook dans la table Définitions de processus [sys__process_definition].

    Type de données : chaîne
    État Indique si la duplication du playbook a réussi.
    Valeurs possibles :
    • RÉUSSITE : le playbook a été dupliqué avec succès.
    • ÉCHEC : l’ID du playbook, du périmètre de l’application ou du déclencheur est introuvable.

    Type de données : objet

    Cet exemple montre comment dupliquer un playbook avec le sys_id f8ca6192ec210210f8772cbd595eab20. Le nouveau playbook est nommé Playbook 2.0, son périmètre d’application est Global et il est déclenché lorsqu’un enregistrement est créé. Le type de déclencheur Créer un enregistrement a la sys_id ab6951170f1200108c87f4f0ff767e4f.

    sn_pad.PDAutomationProvider.duplicateProcess('f8ca6192ec210210f8772cbd595eab20', 'Playbook 2.0', '', 'global', 'ab6951170f1200108c87f4f0ff767e4f');

    Sortie :

    {"processDefinitionSysId":"6e4f0b8fece9c210f8772cbd595eabda","state":"SUCCESS"}