Exemple de documentation Salesforce avec sa source
Une règle de validation suivie de sa formule à son explication, puis à ses cas de vérification. Exemple construit pour la démonstration, sans inscription.
Un exemple construit pour la démonstration
Cet exemple illustre la méthode. Il ne vient pas d’une org client et aucun test n’a été exécuté. L’objet est Opportunity. La règle s’appelle Closed_Won_Requires_Amount.
Ce que dit la formule
La règle bloque l’enregistrement quand l’étape vaut Closed Won et que le montant est vide, nul ou négatif. Elle lit deux champs : StageName et Amount.
La raison métier n’est pas dans la formule. Elle reste à confirmer avec le responsable du processus.
Ce qu’il reste à documenter
- La version déployée et la date d’observation.
- Les automatisations qui renseignent StageName ou Amount.
- Les autres règles et exemptions qui s’appliquent.
- Les résultats des tests exécutés dans un environnement autorisé.
- Le responsable métier et la raison confirmée de la règle.
La source et les cas à vérifier
Formule de la règle de validation :
AND(
ISPICKVAL(StageName, "Closed Won"),
OR(ISBLANK(Amount), Amount <= 0)
)| StageName | Amount | Erreur attendue |
|---|---|---|
| Closed Won | 100 | Non |
| Closed Won | 0 | Oui |
| Closed Won | -1 | Oui |
| Closed Won | vide | Oui |
| Prospecting | 0 | Non |
Ces cas ignorent les autres règles et automatisations de l’org. Ils servent à préparer vos tests.
Références
Exemple pédagogique rédigé par aprity. La documentation Salesforce ci-dessous décrit le composant ValidationRule.
- Salesforce — Documentation strategies (en anglais)
- Salesforce Metadata API — ValidationRule (en anglais)
Trois ressources pour documenter votre org
Une méthode, un modèle réutilisable et un exemple commenté. Sans inscription.
Comment documenter une org Salesforce
Une méthode pratique pour documenter une org Salesforce : objets, automatisations, dépendances, sources, et mise à jour après chaque livraison.
Modèle de documentation Salesforce à télécharger
Un modèle Markdown gratuit, sans inscription : périmètre, objets, règles, sources, tests et questions ouvertes.
Exemple de documentation Salesforce avec sa source
Une règle de validation suivie de sa formule à son explication, puis à ses cas de vérification. Exemple construit pour la démonstration, sans inscription.
Appliquez la méthode à votre org
Testez aprity sur un périmètre que votre équipe connaît bien.