Créer un modèle de configuration
Créez un modèle qui définit les entrées requises pour configurer un spoke. Définissez des paires clé-valeur statiques pour créer des enregistrements et définir les valeurs qui s’appliquent à chaque intégration. Définissez des paires clé-valeur dynamiques pour recueillir les entrées de l’utilisateur et définissez des valeurs de champ qui peuvent varier. À l’aide de ce modèle, les administrateurs et les concepteurs de flux peuvent configurer le spoke à partir d’un formulaire unique.
Avant de commencer
Procédure
- Accédez à la Tous > Centre d'intégration > Connexions et informations d'identification > Modèles de configuration.
- Cliquez sur Nouveau.
-
Sélectionnez le type de modèle de configuration que vous souhaitez créer.
La sélection d’un type fournit des données de démarrage pour vous aider à configurer le modèle.
Type de configuration Description Connexion HTTP avec type d'attribution du code d'autorisation OAuth Crée un modèle pour enregistrer le système tiers en tant que fournisseur OAuth à l’aide d’un code d’autorisation. Connexion HTTP avec type d'attribution titulaire OAuth JWT Crée un modèle pour enregistrer le système tiers en tant que fournisseur OAuth à l’aide d’un jeton Web JSON. Connexion HTTP avec informations d'identification de base Crée un modèle à intégrer au système tiers à l’aide de l’authentification de base. Connexion HTTP avec informations d'identification de clé API Crée un modèle à intégrer au système tiers à l’aide d’une clé API. Autre configuration Crée un modèle vide, vous permettant de configurer un modèle pour une authentification personnalisée. - Dans le champ Nom , ajoutez un nom pour identifier le modèle.
-
Dans le champ Modèle de données par défaut , apportez les modifications nécessaires.
Ce champ définit les informations statiques qui s’appliquent à chaque intégration. Par exemple, vous pouvez définir l'API et l'URL du jeton si la valeur s'applique à chaque intégration.
Ces objets dans le modèle de données par défaut sont requis :
Informations d’identification: crée un enregistrement d’informations d’identification avec les champs requis.connexion: crée un enregistrement de connexion avec les champs requis. Accédez aux attributs de connexion à l’aide de l’objet enfantextended_attributes. Par exemple :"connection": { "extended_attributes": { "api_version": "v1" }, "connection_url": "https://<provider-domain-name>.com", "name": "Spoke Connection", "table": "http_connection" }
Vous pouvez utiliser l’objet
supplémentairepour configurer les données d’une table personnalisée et utiliser le script de post-traitement pour insérer les données dans la table.Remarque :Dans le modèle de données par défaut pour le type d’attribution de code d’autorisation OAuth, les valeurs des clésde oauth_entity_profile_scopeet deoauth_entity_scopedoivent correspondre. Dans l’exemple suivant, les deux clés ont la valeurLire l’e-mail de l’utilisateur."oauth_entity_profile": [ { "grant_type": "authorization_code", "name": "<provider-name> Profile", "default": true, "oauth_entity_profile_scope": [ "Read user's email" ] } ], "code_challenge_method": "S256", "type": "consumer", "oauth_entity_scope": [ { "oauth_entity_scope": "Read user's email", "name": "email" } ], -
Dans le champ Schéma de données dynamiques , apportez les modifications requises.
Ce champ Définit les informations que l'utilisateur doit renseigner pour configurer l'intégration. Par exemple, vous pouvez ajouter des paires de valeurs clés de nom d'utilisateur et de mot de passe pour collecter des valeurs définies par l'utilisateur.
Les champs du schéma de données dynamiques incluent les propriétés suivantes :
name: champ auquel l’entrée de l’utilisateur est mappée. Par exemple, pour mapper l’entrée utilisateur au champ URL de connexion dans l’enregistrement de connexion, saisissezconnection.connection_url.étiquette: l’étiquette de champ que l’utilisateur voit lorsqu’il remplit le modèle.type: type de champ. Assurez-vous que ce type de données correspond au type de données du champ auquel vous mappez la valeur.defaultValue: facultatif. Valeur par défaut du champ. Si aucune valeur par défaut n’est fournie, l’astuce s’affiche.Astuce: Facultatif. Texte de conseil à afficher en l’absence de valeur par défaut.
Remarque :Si vous configurez un modèle pour l’authentification de type d’attribution titulaire OAuth JWT, vous souhaiterez peut-être saisir une entrée utilisateur pour une paire clé-valeur unique dans le tableaujwt_claim_validation. Vous pouvez faire référence à une paire clé-valeur unique dans le schéma de données dynamiques en vous référant à son index dans le tableau. Par exemple, votre modèle de données par défaut peut inclure cet extrait."jwt_claim_validation" : [ { "name" : "iss", "is_standard" : true, "data_type" : "string", "value":"<docusign-iss-claim>" }, { "name" : "sub", "is_standard" : true, "data_type" : "string", "value":"<docusign-sub-claim>" }, { "name" : "aud", "is_standard" : true, "data_type" : "string", "value":"<docusign-aud-claim>" }, { "name" : "scope", "is_standard" : false, "data_type" : "string", "value" : "signature impersonation" } ],Reportez-vous à la paire clé-valeur
issà l’aide de l’index de base zéro de l’élément :credential.jwt_provider.jwt_claim_validation[0].value. - Facultatif :
Dans le champ Script de post-traitement , ajoutez un script qui c Crée les enregistrements supplémentaires requis par l'intégration. Par exemple, si votre spoke inclut des tables personnalisées, vous pouvez créer des enregistrements dans ces tables en fonction de l'entrée de l'utilisateur dans le modèle de configuration. Ce script s'exécute une fois que les enregistrements de connexion et d'informations d'identification sont créés.
Le script de post-traitement a accès à ces objets globaux.
Objet global Description aliasId Sys_id de l’enregistrement d’alias de la table Alias de connexion et d’informations d’identification [sys_alias]. connectionSysId (ID de connexion) Sys_id de l’enregistrement de connexion créé par le modèle. jsonDefaultData Contenu JSON du champ Modèle de données par défaut au format Chaîne. jsonDynamicData Contenu JSON issu du champ Modèle de données dynamiques au format Chaîne. -
Dans le champ Script de pré-édition , ajoutez un script pour pré-remplir les champs supplémentaires lorsque vous modifiez une connexion.
Ce script renvoie un tableau d’objets. Chaque objet dispose d’une paire nom-valeur pour remplir les champs supplémentaires. Par exemple, si la connexion nécessite des champs qui se trouvent dans une table personnalisée, vous pouvez mapper ces champs à la table personnalisée.
Le script de pré-édition a accès aux objets globaux suivants :
Objet global Description aliasId Sys_id de l’enregistrement d’alias de la table Alias de connexion et d’informations d’identification [sys_alias]. connectionSysId (ID de connexion) Sys_id de l’enregistrement de connexion créé par le modèle. jsonDefaultData Contenu JSON du champ Modèle de données par défaut au format Chaîne. jsonDynamicData Contenu JSON issu du champ Modèle de données dynamiques au format Chaîne. Chaque objet du script possède les propriétés suivantes :name: nom du champ personnalisé pour spécifier la valeur dans la connexion.Valeur: valeur que vous souhaitez mapper afin de remplir le champ personnalisé. Vous pouvez mapper le champ à l’aide d’une fonction ou d’une variable, ou en le codant en dur.
Les types de données suivants sont pris en charge pour les champs :
Tableau 1. Types de données pris en charge pour les champs Type Description Texte Valeur de chaîne. Booléen Zone de sélection. La sélection indique une valeur Vrai et la désélection indique une valeur Faux. Numéro Valeur numérique. Date Valeur de date au format aaaa-mm-jj. Vous pouvez également utiliser l’objet GlideDate. Choix Liste des choix valides définis dans le champ Schéma de données dynamiques. Référence GlideRecord valide. Groupe de cases d'option Groupes contenant un ensemble de champs différent. Ces groupes sont disponibles en tant que choix dans une liste déroulante lorsque vous modifiez une connexion. Les champs de chaque groupe s’affichent lorsque vous sélectionnez le groupe requis dans la liste déroulante. Par exemple, considérons la structure suivante du groupe de cases d’option définie dans le champ Schéma de données dynamiques :{ "name": "radio_groups", "label": "Radio Groups", "type": "radio", "groups": [{ "name": "radio_group1", "label": "Radio Group 1", "fields": [{ "name": "radio_field1", "label": "Radio Field 1", "type": "text", "defaultValue": "efgh", "mandatory": true }] }, { "name": "radio_group2", "label": "Radio Group 2", "fields": [{ "name": "radio_field2", "label": "Radio Field 2", "type": "text", "defaultValue": "abcd", "mandatory": true }], "default_group": true }Pour cet exemple, vous pouvez utiliser l’extrait de code suivant pour comprendre comment les groupes de cases d’option sont utilisés dans le script à l’aide de la remontée pas à pas :
{ name: "radio_field.first_radio_group.radio_field1", value: "radio field 1" }, { name: "radio_field.second_radio_group.radio_field2", value: "radio field 2" }, { name: “radio_groups”, value: gr.getValue(‘radio_groups’) }Pour plus d’informations sur l’utilisation de la remontée pas à pas, reportez-vous à la rubrique Remontée pas à pas.
Conseil :Si les valeurs pré-remplies n’apparaissent pas dans les champs lors de la modification d’une connexion, accédez à Diagnostics du système > Débogage de session > Journal des débogages pour diagnostiquer le problème. -
Ajoutez le modèle à un alias de connexion et d’informations d’identification.
- Accédez à la Centre d'intégration > Connexions et informations d'identification > Alias de connexion et d'informations d'identification.
- Ouvrez l’enregistrement d’alias pour le spoke.
- Dans le champ Modèle de configuration , cliquez sur l’icône de recherche.
- Sélectionnez le modèle que vous avez créé dans la liste.
- Cliquez sur Mettre à jour.