Snapshot Data Dictionary Report

Introduction

The Snapshot Data Dictionary Report is a feature in the Snapshot desktop application that enables organizations to document the contents of their Salesforce organization (org). This documentation can be crucial for compliance purposes or to keep track of changes over time.

Accessing the Data Dictionary Report

To access the Data Dictionary Report:

1. Launch the Snapshot desktop application.
2. Ensure that your Salesforce orgs are connected in a deployment pipeline.
3. Right-click on any item within an org.
4. Select the Data Dictionary Report from the context menu.

Report Content

The Data Dictionary Report provides detailed information about all the properties of objects in the selected Salesforce org. The report comprises:

1. Objects List: Displays a list of objects in the org on the left side of the interface.
2. Summary Statistics: Shows a count of different assets and asset names in the org.
3. Organization Limits: Lists the different limits that are applicable to each object in the org.
4. Object Properties: Lists metadata properties that define an object.
5. Field Properties: Displays the properties of the fields of an object.
6. Object and Field Relationships: Shows relationships related to the object or to an individual field.

Previewing Properties

You can preview properties for a specific object:

1. Select an object from the Objects List.
2. Check the desired properties (such as Field Properties).
3. Click the “Preview” button to view the selected properties for the chosen object.

Generating a Report

To generate a comprehensive Data Dictionary Report:

1. Select the desired objects and properties by checking the respective checkboxes.
2. Navigate to the “Display Report” tab to see a comprehensive report including the selected objects and their respective properties.
3. The report includes Object and Field Properties, Organization Limits, and other selected information.

Report Scheduling and Distribution

With Snapshot, you can schedule the Data Dictionary Report to be generated whenever there is a new snapshot. You can configure the report to be sent via email, or posted in Salesforce Chatter, or saved to Salesforce content. To schedule and distribute the report:

1. Choose the “Schedule” option in the report section.
2. Select the snapshot frequency.
3. Choose the distribution method (Email, Chatter, or Salesforce content).
4. If you choose Email, select the group to which the report should be sent.

Report Formats

The Data Dictionary Report can be exported in various formats, including spreadsheet or PDF. This allows for easy sharing with colleagues, or saving for compliance documentation.

Conclusion

The Snapshot Data Dictionary Report is a powerful tool for Salesforce org documentation. It enables organizations to comprehensively document object and field properties, organization limits, and other crucial data, which can be essential for compliance and monitoring changes over time.