Déclencher manuellement un Playbook

Utilisez un script serveur pour déclencher manuellement un playbook.

Fonction Playbook de déclenchement

Déclenchez manuellement un Playbook à l’aide d’une fonction de script serveur avec le code suivant :

sn_playbook.PlaybookExperience.triggerPlaybook('<scoped name>',parentRecord);

Remplacez <nom défini dans le champ d’application> par le nom défini dans le champ d’application de votre playbook. Pour trouver le nom inclus dans le périmètre, recherchez la définition du processus dans la table sys_pd_process_definition et copiez les champs nom et périmètre de l’application. Remplacez parentRecord par l’entrée/l’enregistrement parent sur lequel vous souhaitez exécuter le processus.

Le script de serveur lève une exception en cas d’échec. Vous pouvez ajouter un message d’information en cas de réussite et un message d’erreur en cas d’échec.

Fonctions d’aide

Utilisez la fonction scriptable suivante pour déterminer si un Playbook est déjà en cours d’exécution sur un enregistrement avant d’afficher une action d’interface utilisateur ou une action déclarative pour le déclencher.

sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(parentRecord, '<scoped name>')

Pour afficher tous les playbooks en cours d’exécution sur un enregistrement parent donné, utilisez le code suivant :

sn_playbook.PlaybookExperience.getPlaybooksForParentRecord(parentRecord)

Ces informations peuvent être utilisées pour contrôler quand afficher une action de playbook de déclencheur telle qu’une action d’interface utilisateur.

La section suivante est un exemple d’utilisation de la fonction de déclencheur du playbook pour créer un bouton Ajouter un playbook.

Créer une action d’interface utilisateur Ajouter un Playbook

Créez une action d’interface utilisateur Ajouter un Playbook dans l’espace de travail.

Avant de commencer

Rôle requis : workspace_admin

Procédure

1. Accédez à la Tous > Définitions du système > Actions d'interface utilisateur.
2. Cliquez sur Nouveau.
3. Renseignez les champs du formulaire.
   Remarque :

   D’autres champs que ceux de la table suivante apparaissent dans le formulaire, mais ils ne fonctionnent pas dans les espaces de travail. Pour en savoir plus sur chaque champ du formulaire Actions d’interface utilisateur, reportez-vous à Configurer des actions d’interface utilisateur personnalisées dans legacy workspace.

   Tableau 1. Formulaire Action d’interface utilisateur

   Champ	Description
   Nom	Nom de l’action d’interface utilisateur. Cela apparaît dans l’interface utilisateur de l’espace de travail, par exemple, Ajouter un playbook d’embauche.
   Table	Table à laquelle l’action d’interface utilisateur s’applique. Chaque fois qu’un agent affiche un enregistrement à partir de cette table, cette action d’interface utilisateur s’affiche.
   Ordre	Placement dans la liste horizontale des actions d’interface utilisateur. De gauche à droite, les numéros de commande vont du plus petit au plus grand.
   Nom de l'action	Équivalent du nom qui apparaît dans les journaux et les colonnes de table, par exemple, interaction_add_onboarding
   Actif	Basculez pour faire apparaître l’action d’interface utilisateur.
   Afficher la mise à jour	Activez/désactivez cette option pour afficher la mise à jour dans la table.
   Condition	Conditions qui doivent être remplies pour que l’action d’interface utilisateur apparaisse, par exemple, current.canWrite() && !sn_playbook. PlaybookExperience.parentRecordContainsPlaybook(current, « sn_pad_demo.playbook_onboarding_demo »).
   Script	Script côté serveur qui implémente l’action d’interface utilisateur.
   Application	Application à laquelle ce composant s’applique. Global signifie que le composant s’applique à toutes les applications.

4. Pour créer un script côté serveur qui implémente l’action d’ajout de playbook, saisissez le script dans le champ Script .

   try{
   	current.update();
   	sn_playbook.PlaybookExperience.triggerPlaybook('sn_pad_demo.playbook_onboarding_demo',current);
   	gs.addInfoMessage(gs.getMessage("Onboarding Playbook added to Interaction."));
   } catch(e){
   		gs.addErrorMessage(e.getMessage());
   }

   Le système ignore tous les scripts clients inclus dans ce champ. Vous ne pouvez utiliser le champ de script client de l’espace de travail que pour les scripts clients. Remplacez sn_pad_demo.playbook_onboarding_demo par le nom inclus dans le champ d’application de votre playbook. Pour trouver le nom inclus dans le périmètre, recherchez la définition du processus dans la table sys_pd_process_definition et copiez les champs nom et périmètre de l’application.

5. Dans l’onglet Espace de travail , sélectionnez : Bouton de formulaire d’espace de travail pour faire apparaître le bouton Ajouter un playbook sur la ligne des actions d’interface utilisateur ou Menu de formulaire d’espace de travail pour le faire apparaître sous forme de liste dans la liste de menus.
6. Dans le champ Script client de l’espace de travail , créez un script client spécifique à l’espace de travail.
   Workspace présente des limitations de scripting client similaires à celles de Portail de services. Par exemple, pour ouvrir un formulaire en cliquant dessus, vous pouvez ajouter le script client suivant :

   function onClick(g_form) {
   
   }