Article outline
Generate CSV file template for import
You might be also interested in
Prerequisites
Enterprise license (or have an active trial)
Synced Org Model (import is not supported on Reference models)
What kind of documentation can I import?
Currently we allow you to import tags and URL links to your Org model.
Note: our initial release only supports the addition of new tags and URLs, but not the ability to overwrite/update existing documentation.
With this import you can also specify if you would like the URL to be available as Salesforce In-app help, and if so, if it is visible as help in Lightning, Classic, or both.
TIP We recommend using a "Node list" report from the reporting functionality to generate a list of metadata items in your org model and from the Report viewer download an Excel-type file to work on.
Import documentation CSV file
In the list of Org Models, click on the import icon in the upper right corner of the screen. Then click "Import data from CSV".
This will open a window where you can select the target implementation and the type of data you want to import. Tags and URL links must be imported separately as the required CSV formats are different.
Importing Tags
The CSV file for tags import uses the following format:
Column 1: Metadata Type (e.g. Apex Class, Object, Validation rule etc.)
Column 2: Managed Package API name (only required if the metadata you want to add stakeholder for belongs to a managed package)
Column 3: Object API name (only required if the metadata you want to add stakeholder for belongs to an object, e.g. field, validation rule etc.)
Column 4: API name (the API name of the target component)
Column 5: Tags (Cannot have spaces or any special characters like ! £ # $ % < > etc.). To add more than one tag you can separate each tag by comma, without leaving any space between each new tag. e.g:
Using this import method you can only add new tags, but you cannot update or remove existing tags. To remove an existing tag you will need to navigate to the node in the Org model and remove it from the right panel.
Importing URL links
The CSV file for URL links import uses this format:
Column 1: Metadata type (e.g. Apex Class, Object, Validation rule etc.)
Column 2: Managed package API name (only required if the metadata you want to add stakeholder for belongs to a managed package)
Column 3: Object API name (only required if the metadata you want to add stakeholder for belongs to an object, e.g. field, validation rule etc.)
Column 4: API name (the API name of the target component)
Column 5: URL (The link you want to attach)
Column 6: Visible to (You can specify the Elements user groups you want to be able to view this URL attachment. Either name the group, put All if you want all users to see it, or leave the field empty if you would like no users except for Editors to see this).
Column 7: Help in lightning (Specify yes/no if you want this URL to be visible as in-app help in SF Lightning mode)
Column 8: Help in classic (Specify yes/no if you want this URL to be visible as in-app help in SF Classic mode)
Column 9: Open in new tab (Specify yes or no if you want the link to open in a new tab when clicked)
Using this import method you can add new URLs, but you cannot update or remove existing ones. To remove an existing URL you will need to navigate to the node in the Org model and remove it from the right panel.
Adding URL links from a CSV does not add them to the URL library.
Generate CSV file template for import
To make the import experience easier for you we can generate import templates for your Org model automatically.
Select the "Generate CSV template for import tab" in the window, then the name of your implementation and import type either "Tags" or "URL Links". You can then select which types of metadata you want to include in your template file.
Once you have selected one or more metadata types, click "Generate". The system will generate a template file with the list of metadata matching selected types and with the right columns. Simply download the CSV file from the notification icon in the top right corner of the screen. From here you can fill in the CSV file with the required information and re-upload it from the "Import from CSV" tab.
If something goes wrong we'll generate a report with an additional column at the end showing you which data imports failed and why. This can also be found in the same notification icon in the top right corner.
You might also be interested in
Can't find what you need? Reach us at success@elements.cloud and let's talk! We are always happy to hear your feedback, and will do our best to answer any questions or concerns you may have.