You can create "Proposed nodes" in your Salesforce Org Models to design and document any metadata will have to be created in the Org as a result of a change request.
Article outline
Prerequisites
Creating proposed nodes
Documenting proposed nodes
Tracking proposed nodes
Updating & deleting proposed nodes
You might be also interested in
Prerequisites
Editor access to an Org model
Sync'd Salesforce Org
TIP After you create the new metadata and sync your Org Model, the previously created documentation will be automatically linked to the new item in the tree.
Creating proposed nodes
Users with editor access to the Org Model can create proposed nodes in the Org Models. This can be done from the tree structure by right-clicking on a metadata type grouping (i.e. "Application" rather than a specific Application Class) and choosing the option "Create proposed [type]"
In the modal window, you need to provide the Label & API name for the proposed node. The API name must be unique within an Org Model (no need to add '__c' - Elements will do that for you!). Y
ou can also provide a Description for your suggested metadata, and for Field Proposed nodes, a Field type you plan to implement.
Creating proposed nodes from Changes and Diagrams apps
For both Changes and Diagram apps Proposed nodes can be created after selecting an item, for Changes - a Story and for Diagrams - an Activity box.
For both scenarios, to add a Proposed node, please navigate to right-hand side panel, and access the Insights tab. There you need to select 'Add Proposed node'
Changes app
Diagrams app
To add proposed node from a Story or Activity level please follow these steps:
In the 'Org models' dropdown, please select the org model you want to create the proposed node for.
In the 'Types' dropdown, please select the metadata type you want to create the porposed noe of.
It is importnat to point out: when selecting metadata dictionary top level
metadata (Apex Classes and Triggers, Flows, Lightning pages, Objects etc.),
the modal present the set of fields to fill out to provide new Proposed ndoe specification.Caveat: for any object-nested metadata types (Fields, Record types, Buttons, Links and Actions, Page layouts) please first select the metadata type from the dropwdown, and then in the top right box, please start typing the name of the object you want to create the nested metadata components' Proposed node for.
After selecitng the new Proposed node metadata type (and the object for nested proposed nodes), please fill out the specification for the new Proposed node.
Adding a new FIeld proposed node for an Account object in Changes app
Adding a new FIeld proposed node for an Account object in Diagrams app
TIP To add Data Cloud proposed nodes, please follow the same step as for other objects. All different Data Cloud object types are available for selection in the 'Types' dropdown. To create Fields for Data Cloud objects, please folow the same process as for other object-nested metadata.
Creating Data Cloud object
Documenting Proposed nodes
Because "Proposed nodes" are only placeholders in your Org Model, you will not be able to see any information about usage, dependencies or access. But you will be able to add documentation, including diagram links, rich text notes, end-user help, user stories and business requirements.
Tracking proposed nodes
After every sync, the owner of the Org Model receives an email with a list of changes since the last sync. This list includes any new, updated, not synced (deleted) and suggested metadata.
You can also generate a node list report. You can then filter all the reported metadata in your Org Model by "Proposed" status to see all the proposed changes.
Updating & deleting proposed nodes
If you create metadata with the same API name as the proposed nodes, then after the next Sync, the status of the proposed node will change to "New". Depending on the metadata type, we will then also be able to show information about its dependencies, usage, or access.
If you decide that the proposed node is not required, or you have made a mistake creating it, you can just delete it by hovering over the node and click the on "X".
You might be also interested in
See how certain field places in dependency - use this feature to visualize your metadata dependencies in a simple, yet powerful easy to view form
Complete list of supported metadata types - this article will shed more light on what metadata type is supported in Org Model
Connecting and syncing Salesforce Orgs - follow this step-by-step short instruction how to connect your Org to Elements platform