Committing OmniStudio Components to a Branch
Last updated
Was this helpful?
Last updated
Was this helpful?
This section deals with exporting of OmniStudio data packs from a Salesforce Org through a YAML manifest describing your project and committing the same to a Version Control System. The primary goal is to enable Continuous Integration for OmniStudio metadata through source control.
Go to the New EZ-Commit screen.
In the EZ-Commit screen, select your Salesforce Org.
Select the Salesforce Org Author.
Under Commit To section, select the Version Control Repository and the Branch where the commits need to be done.
Under Fetch Changes, select the components as OmniStudio Components.
1. Auto Draft
This will bring all the changes which the Author has done in the Salesforce Org which have not been committed yet to Version Control (AutoRABIT does the calculation by using the last modified date in the Salesforce org and comparing against the last commit date to Version Control branch).
2. Select Manually
This will export OmniStudio components from a Salesforce Org through a YAML manifest describing your project and committing the same to a Version Control System. The primary goal is to enable continuous integration for OmniStudio metadata through source control.
3. Max Depth
Max Depth decides the level of dependencies that will be executed while fetching and committing vlocity components. The value of Max Depth that was set while configuring OmniStudio will be used globally
However, the user can modify the value based on his requirement.
When Max Depth Values is set to -1 means it will execute all-level dependencies of the selected data pack record
When Max Depth Values is set to 0 means it will execute only selected data pack records and
When Max Depth Values is set to 1 means it will execute only first-level dependencies of the selected data pack record.
4. Custom YAML File
The user also has an option to upload a custom YAML file (Project path and manifest/queries fields are mandatory). In such a case, the already configured Data Packs Type will have no impact on the current commit label.
5. Compile on Build
When checked, it compiles the data you are attempting to deploy in your branch. However, AutoRABIT recommends that you keep this checkbox unselected. This is because the tool can throw a compilation error when you're trying to commit data that doesn't have dependent components keeping the 'Compile On Build' checkbox selected.
6. Auto Update Settings
This option ensures you have the latest DataPack settings before each export and deployment. This check is quick and you are advised to allow it.
7. Separate Matrix Versions
Add Ability to Export Matrix Versions separately.
Fill in the remaining fields as per your requirements, and proceed to the next screen. The OmniStudio components will get retrieved based on the difference between the Salesforce org and below-mentioned retrieval path. Select the components you would like to commit to the branch.
Scenario 1: If the metadata folder path is not available. For such a case, the OmniStudio components will fetch from the <repoURL>/<yaml project path> path by default.
Example:
Retrieval Path:"<repoURL>/<yaml project path>"Scenario 2: The metadata folder path is available. In such case, the OmniStudio components will get retrieved from repoURL>/<metadata folder path>/<yaml project path>.
Example:
Retrieval Path:"<repoURL>/<OmniStudio Component>/<yaml project path>"
Scenario 1: The metadata folder path is not available. For such a case, the OmniStudio components will fetch from <repoURL>/autorabit_alldefault_OmniStudio_build path by default.
Example:
Retrieval Path: "<repoURL>/<autorabit_alldefault_OmniStudio_build>"
Scenario 2: The metadata folder path is available. In such case, the OmniStudio components will get retrieved from <repoURL>/<metadata folder path>.
Example:
Retrieval Path:"<repoURL>/<metadata folder path>"
