Bonnes pratiques : noms et descriptions des cartes d'action

Suivez ces bonnes pratiques recommandées pour l'affectation de noms et de descriptions aux cartes d'action.

Nom d'une carte d'action

Le nom d'une carte d'action provient de la chaîne que vous saisissez dans la boîte de dialogue Nommer votre flux lorsque vous enregistrez un nouveau flux pour la première fois. Vous pouvez inviter la boîte de dialogue Nommer votre flux de l'une des deux manières suivantes :

• Cliquez sur l'icône du crayon Sans nom dans la bannière supérieure du canevas du concepteur Workflows.
• Cliquez sur le bouton Enregistrer.

Les noms des cartes d'action doivent utiliser la casse du titre où la première lettre de chaque mot est en majuscule. Dans la mesure du possible, évitez d'inclure des articles (définis ou indéfinis) ou d'autres mots tels que des prépositions.

Par exemple, les noms propres des cartes d'action sont les suivants :

• Create User
• Delete File
• Custom API Action

Les versions suivantes des noms de cartes d'action précédents ne sont pas recommandées :

• Create a User
• Delete a File
• custom api action

Si des articles ou des prépositions sont nécessaires en vue d'une dénomination intuitive, incluez-les en caractères minuscules :

• Add User to Group
• List Users with Filter

Dans ces exemples, les formes en majuscules de To ou With sont incorrectes.

Description d'une carte d'action

Lorsque vous soumettez la fiche d'action d'un connecteur en vue d'être vérifiée et publiée dans le catalogue public, vous devez inclure une description. Vous pouvez ajouter une description dans la boîte de dialogue Nommer votre flux.

• La description d'une carte devrait utiliser la casse de la phrase seulement lorsque seul le premier mot doit commencer par une majuscule, sauf si la description comprend des noms propres.
• Une description ne doit comporter qu'une ou deux phrases et se terminer par un point. Si nécessaire, une description peut contenir deux phrases maximum.
• Pour améliorer les résultats de la recherche, une description doit inclure le nom du service en cours d'intégration, par exemple Okta, Salesforce, ou Zoom.
• Une description doit être rédigée au présent.

Par exemple, les descriptions suivantes sont valides :

• Update group details in Google Workspace.
• Unassign a license from an Azure Active Directory user.

Les descriptions suivantes utilisent le temps, des majuscules et une ponctuation incorrects :

• Updated group & details
• Unassigns a License from a Azure Active Directory User