Using Catalyst you can build a data inventory of your technology - either automatically for Salesforce (what we call an Org Model) or manually for any other technology (what we call a Reference model). Whether you create a Salesforce Org Model or a Ref mode, you can use our product to document any part of your technology configuration, link it to business processes that the technology supports, and link it to planned changes.
- Documenting an entire Salesforce implementation across Orgs
- Standard attachments on org and ref models
- Linking process diagrams to org and ref models
- Linking requirements and stories to org and ref models
- Reporting on documentation
Documenting an entire Salesforce implementation across Orgs
When you have synced Orgs belonging to the same implementation (i.e. the production org and associated sandboxes) any documentation and any comment added in one Org model is automatically visible in the other Org models.
This feature allows Salesforce admins, consultants and developers to stay aware of each other's work and collaborate across multiple environments. Read this article on collaborating using the feedback tab.
Standard attachments on org and ref models
There are a number of different attachments that can be linked to an Org and Ref model item and used as documentation. In order to add an attachment or a link open the Documentation tab in the right panel for the selected item and then click on Add documentation. You can also right-click on a node and add documentation from the context menu.
The standard attachments are:
- Rich text notes
Linking process diagrams to org models
Ref/ Org Model nodes can be linked to individual activities in process diagrams to provide contextual information on both ends (i.e. which part of the process this bit of technology supports). You can also use these links as Salesforce end-user help.
In order to create a link between a process activity and a model node click Copy Node Link on a node (right-click menu or under the DOCUMENTATION tab).
Then find the diagram activity you want to link to, right-click on the activity while in edit mode, and select "Org Model Node" option under "Add links" option.
You can view the Salesforce metadata links on a process while in expanded view mode. You will see blue cloud icons on activities.
Clicking on those cloud icons will show you a context menu of available Salesforce metadata links.
When you link the Salesforce Org Model node with a process activity you are not just linking this particular node, you are linking the same node from Production & all associated Sandbox Org Models. Clicking on the available metadata from the blue icon will pop up a modal window with the list of all metadata connections across existing environments. You will be able to either navigate to the org models or to Salesforce setup for the selected item, in the selected environment.
In the Ref/Org Model you can roll over the process activity link to see an image of the process + information about the name of the activity, process diagram & map to contextualise the link. You can click on the name of the activity at the top of the rollover to open the diagram in a new tab.
Linking requirements and stories to org and ref models
The easiest way to link requirements & stories to a model node is to click on “Add documentation” in the right panel or using the right-click in the tree. You will see a dialog what allows you to add multiple stories and requirements or create a new one.
You can also click Copy requirement link on requirement / or Copy story link on a story in the Change app and go to the Org / Ref Model node and then select an option to Paste requirement link or Paste story link. You can do that either from the Documentation tab or from the context menu on a node
Reporting on documentation
In order to evaluate the level of documentation of your data model you can run a report "Documentation" to see the list of all requirements, stories, process links, rich text notes and URLs attached across your Org.
For Salesforce Org Models you can additionally launch Salesforce Org Analytics to see the aggregate data and visualisations on documentation for your Org.