Salesforce Organization Sync Task Documentation

Owned by Christina
Last updated: Nov 19, 2021
4 min read

In Opsera, there are 2 ways to run a Salesforce pipeline. Either get the components from the org to the git branch using the sync-sfdc-repo Task or you can move your components from a git branch or an org to another salesforce org in Salesforce pipeline. The following documentation covers sync-sfdc-repo Task setup.

Salesforce Organization Sync workflow requires task creation, followed by a task run. Once the task has been created, you must select Run Task and follow the steps to complete the wizard. The prerequisite to Salesforce Organization Sync is having successfully configured Jenkins, SFDC Configurator, and SCM tools to select in the drop downs. The configured SCM tool must be added to Accounts within the Jenkins and SFDC Configurator tools.

Salesforce Organization Sync Task Setup Instructions:

  1. Select Salesforce Organization Sync from the Type drop down. Once this has been selected, the following values will be fetched for selection:

  • Jenkins Tool - Displays Jenkins Tools from Tool Registry.

  • Salesforce Account - Displays all Salesforce Accounts from Tool Registry.

  • Account - Displays Accounts added in Jenkins tool from Tool Registry.

  • Repository - Select a Repository from Account.

  • Branch - Select a Branch where the changes will be merged.

2. Select Create

3. After the task is created, select Run Task to successfully merge the task.

Include or exclude XML Package Instructions:

User has the option to exclude or include an XML package. To include the XML package in the merge, use the following steps:

  1. Click on the gear icon to edit the task:

2. Scroll down and toggle on “Include Package XML”:

3. In Package XML Reference Path field, you can either specify the name of the file where the Package XML will be merged or have the Package XML updated in current directory.

  • To specify the file where the Package XML will be merged: Include the file path name.

  • To have the Package XML updated in the current directory: Give the path as “.” (dot).

4. Save and proceed to follow the next steps. Once the task has successfully been completed, the Package XML will be viewable in the reference path provided above.

For example, if you include the following Package XML Reference Path:

The package XML will be merged into the given Repository, Branch & current directory:

Run Merge Task Instructions:

  1. In the Opsera Task table, select individual task to view Task Details→ and then select Run Task.

  2. In the Opsera Task Confirmation, select a branch:

    1. Select an existing branch: If user wishes to use an existing branch, they can select one from the Branch drop down list.

    2. Create a new branch: If user wishes to change the branch where files are getting synched they can do so by toggling on Create a new branch. Once this has been toggled on, user will be prompted to provide a branch name and select an Upstream Branch from which the feature branch will be created.

3. Select Run Task

Proceed to follow the steps in the Salesforce Git Task Configuration wizard, selecting components to be included in the run.