Configuration des fonctions

Comment puis-je...

• Configurer les fonctions
• Appel d'une fonction à l'aide des API REST
• Déploiement des fonctions dans les règles de workflow
• Consulter les codes d'erreur
  • Codes de statut HTTP
  • Erreurs personnalisées
• Exemples de certaines fonctions couramment utilisées
  ​[Sujets connexes]

Configurer les fonctions

Vous pouvez configurer les fonctions à 5 endroits :

• Créez une fonction autonome.
• Associez une fonction à une règle de workflow.
• Utilisez les fonctions plus tard en les incluant dans des programmes.
• Définissez la fonction à exécuter par un clic sur un bouton personnalisé.
• Associez une fonction à une liste liée.

Pour créer une fonction

1. Allez à Setup > Developer Space > Functions (Configuration > Espace développeur > Fonctions).
2. Sur la page Functions (Fonctions), cliquez sur + Create New Function (+ Créer une nouvelle fonction).
3. Choisissez l'endroit où ajouter la fonction.
   
4. Cliquez sur Next (Suivant).
5. Sur la page Create Function (Créer une fonction), procédez comme suit :
   • Indiquez un nom et une description (facultative) pour la fonction.
   • Cliquez sur Edit arguments (Modifier les arguments).
   • Définissez les arguments à utiliser dans le script, avec le nom de champ ou la valeur personnalisée dans le module CRM.
     

   • Définissez votre fonction dans l'éditeur Script Deluge.

     
   • Cliquez sur Save & Execute Script (Enregistrer et exécuter le script) pour valider votre code.
   • Cliquez sur Save (Enregistrer).
6. Cliquez sur Save (Enregistrer).
   La fonction sera répertorié sous List View (Affichage Liste) dans la page Functions (Fonctions).
   Veuillez noter que les fonctions spécifiées pour une utilisation à un endroit particulier ne peuvent pas être utilisées ailleurs. Par exemple : une fonction configurée pour les règles de workflow ne peut pas être utilisée dans les programmes.

Appel des fonctions à l'aide des API REST

Une fonction vous permet d'intégrer des fonctionnalités supplémentaires dans votre CRM, en plus des fonctionnalités conventionnelles. La fonction a besoin d'un déclencheur pour l'appel. Le déclencheur peut prendre la forme d'un workflow, d'un blueprint, d'une liste associée ou d'un simple clic sur un bouton.

Si la fonction doit être déclenchée sans utiliser ces méthodes ou à partir de sources externes, vous pouvez créer des fonctions autonomes et les mettre à disposition sous forme d'appels d'API. Le déclenchement des fonctions par le biais des API REST offre la flexibilité de déclencher depuis n'importe quel endroit de Zoho CRM ou n'importe quelle application tierce.

Exemple de fonction comme appel d'API :

Un formulaire qui génère automatiquement un prospect dans votre CRM, sur la base des informations fournies en entrée dans le formulaire.

Étape 1 :

Créez une fonction autonome avec le code suivant.

Étape 2 :

Pour rendre la fonction disponible en tant qu'API

1. Allez à Setup > Developer Space > Functions (Configuration > Espace développeur > Fonctions).
2. Cliquez sur l'icône Settings (Paramètres) pour la fonction correspondante qui doit devenir une API.
3. Cliquez surREST API.
   
4. Définissez le Nom d'API pour la fonction personnalisée.
5. Activez les curseurs OAuth2.0 et API key (Clé API).
6. Cliquez sur Save (Enregistrer).
   

Étape 3 :

L'exemple ci-dessous est présenté sous la forme d'un formulaire créé à l'aide de Zoho Creator. Créez le formulaire de sorte qu'il comporte les champs "FirstName", "LastName", "Company" et "Mobile". Vous pouvez programmer la fonction pour qu'elle soit exécutée par un clic sur le bouton Submit (Envoyer).

Résultat :

Un clic sur le bouton Submit (Envoyer) active l'exécution de la fonction et le prospect est créé dans votre CRM. Les détails fournis dans le formulaire sont attribués au prospect.

Fonctions dans POSTMAN :

Les fonctions fournies en tant qu'appels d'API peuvent être testées à l'aide de l'application POSTMAN. Cependant, vous devez garder certains points à l'esprit lorsque vous exécutez une fonction dans cette application.

• Les méthodes actuellement prises en charge pour utiliser une fonction en tant qu'API sont GET et POST.
• Dans une demande POST, dans la section « Body », sélectionnez « form-data ».
• Créez une clé nommée « arguments » et définissez la valeur sur l'objet JSON d'entrée.
• Les arguments peuvent également être indiqués dans l'URL sous la forme arguments={encoded_arguments}
• Demande POST - Limite des arguments
  • Dans l'URL de demande - 5 000 lignes
  • Dans le corps - 95 000 lignes (comme objet JSON)

Exemples d'arguments dans « Body » :

Déploiement de fonctions dans les règles de workflow

Pour associer une fonction à une règle de workflow

1. Allez à Setup > Automation > Workflow Automation > Rules (Configuration > Automatisation > Automatisation de workflow > Règles).
2. Sur la page Workflow Rules (Règles de workflow), cliquez sur Create RuleCréer une règle).
3. Dans l'onglet Create New Rule (Créer une règle), spécifiez les paramètres de la règle de workflow.
4. Sous Instant Actions (Actions instantanées), sélectionnez Function (Fonction).
   
5. Sur la page Configure Function (Configurer la fonction), sélectionnez une fonction sous Gallery (Galerie) ou Functions (Fonctions créées par les utilisateurs de votre organisation), ou choisissez Write your Own pour écrire votre propre fonction à l'aide d'un script Deluge.
6. Cliquez surFunctions  (Fonctions créées par les utilisateurs de votre organisation).
   
7. Sélectionnez la fonction à déclencher et cliquez sur Configure (Configurer).
   
8. Sur la page Configure Custom Function (Configurer une fonction personnalisée), procédez comme suit :
   • Sélectionnez le module à associer.
   • Sous la section Argument Mapping (Mappage des arguments), mappez l'argument sur le nom de champ dans le module CRM.
     
   • Cliquez sur Save and Associate (Enregistrer et associer).
     Vous pouvez maintenant associer la fonction personnalisée de galerie à la règle de workflow.
9. Cliquez sur Save (Enregistrer) dans la page Workflow rule (Règle de workflow).
   Votre fonction personnalisée est maintenant associée à la règle de workflow. Lorsque la règle de workflow est déclenchée, la fonction personnalisée est exécutée automatiquement.