Adding Metadata Descriptions in Elements

Salesforce metadata descriptions, Org documentation, metadata, ElementsGPT recommendations, character limit, sync

Ksawery Lisinski avatar
Written by Ksawery Lisinski
Updated over a week ago

Unlock the power of enhanced Salesforce Org documentation with Elements metadata descriptions. This article will help you discover how to add and edit descriptions, understand syncing behaviour of descriptions from Salesforce to Elements, and harness the benefits of longer, more informative metadata descriptions. Let's explore how metadata descriptions can revolutionize your documentation process and empower you to make changes intelligently.

Prerequisites

  • Registered and verified Elements account

  • Sync'd Salesforce Org Model, with editor permissions

  • Pro or Enterprise license

Syncing Metadata Descriptions from Salesforce

During the initial sync between Elements and Salesforce, metadata descriptions are automatically synced from Salesforce to Elements. However, subsequent updates to the descriptions are not synced between the two systems. This is because Elements has extended the character limit for descriptions beyond that of Salesforce (1000 characters in Elements).

How to Add Metadata Descriptions

To add metadata descriptions in Elements, follow these steps:

1. Login to your Elements account and navigate to the Salesforce Org Model.

2. Locate the specific metadata item for which you want to add a description.

3. Check if the metadata item belongs to the supported types (see below):

Apex class, Apex trigger, Object (custom and standard), Field (custom and standard), Validation rule, Flow, Record type, Profile, Permission set, and Permission set group.

4. View the metadata item by clicking on it, and you will find the "Description" field in the right panel.

5. Click on the "Description" field to edit and enter your desired description.

6. Changes will save automatically.

Editing Metadata Descriptions in Elements

To edit metadata descriptions in Elements, simply locate the specific metadata item, click on it to open the details, and select the "Description" field to edit as needed. Changes will be saved automatically once you click off the text field.

Benefits of Longer and Enhanced Descriptions

By adding longer and enhanced descriptions to your metadata items in Elements, you can enjoy the following benefits:

Limitations and Exceptions

Please note the following limitations and exceptions regarding metadata descriptions in Elements:

  • The "Description" field is not editable for nodes belonging to managed packages.

  • Initially, the description field is not synced for Apex classes, Apex triggers, standard objects, and standard fields. This is because descriptions are not available in Salesforce for these metadata types.

If you have any questions or concerns, please contact us at success@elements.cloud and we will be happy to help.

Remember, by leveraging metadata descriptions in Elements, you can enhance your Org documentation, gain valuable insights, and fully leverage Elements as a Change Intelligence platform for your Salesforce Org.

Did this answer your question?