Deploying Using Connected App Authentication

From Release 8.2:

Deployment helps to migrate objects (processes, forms, actions) with their dependencies (e.g., subprocesses, versions) between organizations.

This method of deployment uses a Salesforce Connected App authentication mechanism. Connected App authentication is a secure connection and authentication mechanism between Salesforce and external applications. In this case, it will be used to connect one Salesforce org with another. Using a Connected App doesn’t require you to store target Salesforce org passwords in a Salesforce Source Org, which improves security.

Here is how it works:

  1. The Work-Relay Deployment tool provides a way to configure a list of target organizations via Connected Apps configurations. You can add a configuration for a Connected App in the first screen of the deployment wizard tool.
  2. When users configure a list of target organizations, the following info must be provided: Organization Name, Domain URL, Client Key, and Client Secret.
  3. Client Key and Client Secret should be obtained once from the target organization via Work-Relay Connect application (ask the target Salesforce org admin for assistance).
  4. Once added, the desired organization may be selected from the appropriate picklist as the target for deployment.

Deployment Procedure:

  • Select the desired Processes, Forms, Actions, or Action Groups from their respective pages (1) and click "Deploy" button (2).
  • The Deployment Wizard will open in a new browser tab. Select the Target Organization (3) and click "Next" button (4). (Note: The Target Organization configuration must already have been configured according to the instructions provided later in this article.)
  • Check the items to be deployed (5). Select the desired necessary Action (6) and click the "Deploy" button (7).
  • Confirm deployment (8) by clicking the OK button.
  • The progress of the deployment will be displayed.
  • After the deployment procedure has completed, a confirmation message will be displayed.
  • Deployment is now complete. Target organization will now contain all of the deployed objects according to their folder structure.

Deployment Actions

Object Does Not Exist in Target Organization

If the object (process, process version, form, form version, action, action group) does not exist in the target organization, only the "Create" action will be available.

When deploying a Process for the first time, it is possible to only choose the  desired "Process." This is enough for successful deployment, as the Process will be deployed along with the Process Version, by default).

After deployment is complete, the new object is added to the target organization along with its corresponding versions and other referenced objects.

Process versions are deployed in an Inactive state and must be Activated manually.

Object Exists in Target Organization

If an object already exists in the target organization, the Deployment Wizard will allow the user to choose between the "Create" and "Overwrite" actions (9). Overwrite is suggested by default:

Create Action:

When the Create action is selected, different behavior will occur, depending upon the Object Type:

  • Process - A new process gets deployed to the target organization, along with the process version.
  • Process Version - A new process version gets deployed to the target organization as an inactive version of existing process.
  • Form - A new form gets deployed to the target organization, along with the form versions.
  • Action or Action Group - A new action/action group gets deployed to the target organization.

Overwrite Action:

When the Overwrite action is selected, different behavior will occur, depending upon the Object Type:

  • Process - The existing process gets overwritten during deployment. If a corresponding process primary version exists in the target organization, it gets overwritten as well. If the process primary version in the target organization differs from the primary version in the source organization, the overwritten process version becomes the primary version.
  • Process Version - The existing process version is overwritten by the new version. If that process version was set as primary in the target organization, it will remain primary. If another version is set as primary at the time of deployment, that version will remain primary.
  • Form - The existing form is overwritten by the new form, as are the form versions.
  • Action or Action Group - The existing action/action group is overwritten by the new version.

Note: The Overwrite action is available for Processes only if the process has no started instances in the target organization.

If a Process Version is active in the target organization and it has related Process Instances, only the Create action will be available in the Deployment Wizard for both the Process and Version.

How to add a Target Organization config

In order to perform a deployment, a configuration for Target Organization must first be added to the Target Organizations list. To do this:

  • Click the "Add" button (10) next to the Target Organizations list on the Deployment Wizard page.
  • Enter an Organization Name (11) - This will be displayed in the picklist when deploying to a Target Organization.
  • Enter the Domain URL of your target organization (12).
  • Enter the Client Key (13) and Client Secret (14).
  • Click the "Next" button (15).

Client Key and Client Secret are special credentials that are generated by the "Work-Relay Connect" Connected Application within the Target Organization. Ask your Target Organization admin for assistance.

If the data entered is valid, a new Target Organization will be added to the list and will be available to select for deployment (16).

When a Target Organization is selected, a "Delete" button (17) becomes available. Click it to delete the selected Target  Organization from the list.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.