Connector Builder documentation des cartes d'action
Chaque carte d'un connecteur nécessite une rubrique d'aide pour décrire l'objectif et les champs de la carte.
Nom et description
Indiquez clairement le nom de la carte et fournissez une brève description de l'action effectuée par la carte. Ces informations peuvent correspondre au nom et à la description du flux d'action associé à la carte.
Définitions des champs
Incluez des informations pour chaque option et champ de saisie et de résultat d'une carte. Pour chaque champ, fournissez les éléments suivants :
-
Étiquette : le nom du champ.
-
Définition : décrivez l'objectif du champ, par exemple les données qui doivent être transmises à ce champ ou renvoyées par ce champ.
-
Type : indiquez le type de données autorisées pour ce champ. Par exemple, Nombre ou Liste de textes.
-
Obligatoire : indiquez si ce champ a besoin d'une valeur pour exécuter le flux.
Organisez l'ensemble des options, entrées et sorties dans des sections distinctes.
Pour les options, le nom du groupe porte l'étiquette Options et ne peut pas être modifié. Pour les champs d'options décrits dans la rubrique d'aide, répertoriez tous les choix disponibles.
Pour les entrées et les sorties, tous les champs se trouvent dans un ou plusieurs groupes, avec des étiquettes modifiables. Incluez toutes les étiquettes de groupe dans la rubrique d'aide.
Limitations et problèmes connus
Incluez des informations sur les limitations et les problèmes connus pour cette carte. Par exemple :
-
Une carte s'exécute lentement si elle doit traiter un grand nombre d'enregistrements.
-
La liste déroulante d'un champ d'options ne peut afficher qu'un sous-ensemble de tous les choix possibles.
Exemples
Pour référence, consultez les rubriques suivantes sur les cartes du connecteur :
-
Rechercher les problèmes associés au connecteur Jira
-
Envoyer un fichier à l'utilisateur du connecteur Slack
Étapes suivantes