Intégrer des contrôles personnalisés

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture
  • Implémentez et exploitez les contrôles personnalisés créés à l’aide du cadre de travail de contrôle personnalisé dans votre intégration.

    Avant de commencer

    Rôle requis : virtual_agent_admin ou admin

    Pourquoi et quand exécuter cette tâche

    Mappez les contrôles personnalisés à un canal de fournisseur.
    Implémenter des contrôles personnalisés créés dans Studio de workflow
    Utilisez l’exemple de script pour implémenter les contrôles personnalisés créés dans Studio de workflow.
    Exemple : Prise en charge des contrôles personnalisés
    {
        uiType: "CustomControl",
        group: "DefaultCustomControl",
        name: "The name of the Custom Control (sys_cs_custom_control.name)",
        required: true/false,
        uxComponentDefinitionSysId: "seismicComponentId" // or null if not
        isInput: true/false, // whether to wait for a response value or if just output
        serializedControlData: "User defined JSON from generateControlData function";    
    }
    Exemple : script de contrôles personnalisés
    (function execute(inputs, outputs) {
        var rich_controls = inputs.rich_control;
        //this is the data returned from the 'serialized control data function' defind in designer
        var serializedControlData = rich_control['serializedControlData'];
        // if this rich control will require a response to move forward in topic flow
        var isInput = rich_control['isInput'];
        // if the component is suggesting using a Seismic control (web) that handles this
        var uxComponentDefinitionId = rich_control['uxComponentDefinitionSysId'];
        // the name of the custom control
        var name - rich_control['name'];
    
        // 1) now perform some logic to transform this data into a custom ui (slack/facebook/sms ascii art/html/etc)
        // 2) attach to outputs, i.e. outputs.text_message='foo :)'; for sms twillio
    
        // basic flow is to take the serializedControlData/Name/compId(optional) and create a custom UI component here
        // that your client understands (i.e. a slack rich form payload)
    })(inputs, outputs);
    Implémenter une transformation spécifique au fournisseur d’un contrôle personnalisé
    Vous pouvez implémenter une transformation spécifique au fournisseur pour chaque contrôle personnalisé à l’aide du champ Sous-type de la table Configuration d’adaptateur personnalisé [sys_cs_custom_adapter_config]. Vous pouvez publier une version plus récente d’un contrôle personnalisé ou un contrôle personnalisé prédéfini ServiceNow , également appelé contrôle personnalisé par défaut, si nécessaire. Cela implique la publication des scripts d’action entrants et sortants Studio de workflow appropriés et la mise à jour de la configuration dans la table Configuration d’adaptateur personnalisé [sys_cs_custom_adapter_config].
    • Si vous publiez votre propre version d’un ServiceNow contrôle personnalisé, remplacez l’enregistrement du contrôle personnalisé dans la table Configuration d’adaptateur personnalisé avec vos propres noms de script d’action entrants et sortants.
    • Un seul enregistrement avec le même sous-type est autorisé. Si le même contrôle personnalisé est implémenté par deux parties différentes, une seule peut mettre à jour l’enregistrement existant avec de nouveaux transformateurs entrants et sortants.
    Remarque :
    Une fois que vous avez remplacé un enregistrement de contrôle personnalisé existant, le système utilise la nouvelle version du contrôle personnalisé. Par exemple, les scripts de transformation peuvent transformer plusieurs contrôles personnalisés, tels que le sélecteur d’heure et l’authentification. Si vous ajoutez un contrôle Sélecteur d’heure avec différentes transformations entrantes et sortantes, le nouveau contrôle Sélecteur d’heure est utilisé. Vous ne pouvez pas revenir à la version d’origine du contrôle personnalisé.

    Procédure

    1. Accédez à Tout, puis saisissez sys_cs_custom_adapter_config.list dans le filtre.
    2. Sélectionnez Nouveau.
    3. Renseignez les champs du formulaire.
      Tableau 1. Formulaire Configurations d’adaptateur personnalisé
      Champ Description
      Fournisseur Le nom de l’identificateur de canal pour votre intégration de messagerie instantanée personnalisée. Pour plus de détails, voir Créer un identificateur de canal pour votre intégration de messagerie instantanée personnalisée.
      Type de contrôle

      Sélectionnez le contrôle personnalisé que vous avez conçu. Pour les contrôles personnalisés, le type est toujours DefaultCustomControl.

      Pour en savoir plus sur les contrôles personnalisés, reportez-vous à la section Personnalisation avec des Agent virtuel contrôles personnalisés.

      Sous type Nom du contrôle personnalisé.
      Action du transformateur entrant Nom du script d’action du transformateur entrant pour ce contrôle enrichi, par exemple sn_va_sms_twilio.va_sms_twilio_adapter_input_text_inbound_transformer.
      Action de transformation sortante Nom du script d’action du transformateur sortant pour ce contrôle enrichi, par exemple sn_va_sms_twilio.va_sms_twilio_adapter_input_text_outbound_transformer.
    4. Sélectionnez Soumettre.