Copado DX Solution Configuration Steps

Updated 1 week ago by Copado Solutions

Overview

Not all classic Copado functionalities are yet available in this product, please review the Copado DX Supported Functionalities and Limitations article for more information.

To get the DX extension for Multi-Cloud up and running in your organization, there are several steps you need to follow. 

You may already be working with Copado for Salesforce DevOps, in which case you don’t need to follow the process of installing Copado and getting the necessary licenses. If this is not the case, review the article Copado Base Setup and Implementation before proceeding with the installation.

Copado recommends testing the beta package on a dedicated Copado instance so that you don’t impact your productive org or your stable sandbox for Copado developments. Feel free to use Copado Playgrounds as an enabler to create a beta instance.

Prerequisites

  1. Source Tracking needs to be enabled in your sandboxes. If you don’t have Source Tracking enabled sandboxes, please enable Source Tracking in your Dev Hub and then create your Mock Sandboxes for the beta.
  2. Ask Copado Support or your CSM to enable Copado Functions for the Copado instance where you want to set up the beta package.
  3. The extension requires version 18.28.3 of Copado. 
  4. Ensure you have a Copado API Key generated in the Account Summary. 
  5. Make sure My Domain is enabled in the org where you are installing the extension.

Setup & Configuration

Installing the Extension 

First of all, you need to install the Multi-Cloud SFDX extension package. 

If you don’t have the Copado Deployer package installed yet, do so before installing this extension. Please refer to the Prerequisites section for more information.

To do this follow the steps below:

  1. Contact your customer success manager to get the DX extension installation URL.
  2. Install the extension in your beta Copado org (select the option Install for Admin Users Only). Once the installation is complete, click on Done.
  3. Next, go to the App Launcher and navigate to the Copado Extensions tab.
  4. Select SFDXExtensionBundle in the Select Extension picklist.
  5. Then, click on Generate Extension Records. Copado will create all the promotion and deployment step records in your org.
    1. In the future, when you upgrade the extension package to the latest version, remember to repeat the Generate Extension Records action to update the extension scripts.
Extension Setup

Once this process is complete, you need to perform some manual steps and create the environment and pipeline records in Copado. Go ahead and see how you can do this.

Platform Picklist Value
  1. Add the SFDX value to the Platform picklist field in both Environment and Pipeline objects (see Salesforce’s article Add or Edit Picklist Values for more information about how to do this) to ensure these records are referencing the correct platform.
Page Layouts

Package

Add the Create Package Version and Distribute Package buttons to the Mobile & Lightning Actions section in the Package Layout

Package Version

Add the Data JSON field to the Artifact Version Layout.

Lightning Record Pages

Pipeline 

If you are using a cloned version of the Pipeline Record Page (Pipeline_Record_Page_Multicloud), you need to manually remove and add the following fields (if you are using this page as the default, it will be automatically upgraded):

  1. In Setup, navigate to the Pipeline object. 
  2. In the Lightning Record Pages section, search the one which is set to default and open it.  
  3. In the Automations section remove Promotion Automation and Deployment Automation fields and add Commit Job Template, Promotion Job Template and Deployment Job Template fields:
Automations
If you're working with Multi-Cloud, you need to have activated and set as default the Pipeline Record Page (Pipeline_Record_Page_Multicloud).

Promotion

  1. In Setup, navigate to the Promotion object. 
  2. In the Lightning Record Pages section, review if the Promotion Record Page is activated as Org Default. If not, you need to activate it by cloning the existing one and assign it as Org Default for Desktop form factor. 
Permission Sets

Ensure to assign the following permission sets apart from the Copado User permission set:

  • Copado Functions Permission Set
  • Copado Job Engine Permission Set
  • CMC SFDX Admin Permission Set
Git Repository Record
  1. Activate the DX value in the Source Format picklist field. To do so, navigate to Setup > Object Manager > Git Repository > In Fields & Relationships, click on Source Format > In the Values section set DX as the Default value.
    DX Default Value
  2. Create the Git Repository record to connect your new DX Git repository with Copado. You can find the step-by-step process in the Git Repository Overview article.
  3. Create the Git Snapshot record. For more information, review the Git Snapshot Overview article.

While you can connect an existing repository to the Copado DX beta package, we recommend starting with an empty repository first and afterward try to use a fork of your productive repository to simulate implementation scenarios.

Environment Records

You need to modify the environment records that will be part of your pipeline, like dev, staging and production, by setting the Platform field to SFDX, the picklist value you enabled in a previous step.

For new credentials: 

After the authentication, change the Platform field to SFDX on the environment of the new credential:

New Org Credential

For existing credentials: 

  1. Remove the environments from any active pipeline by deleting the Pipeline Connection records, where those environments are referenced.
  2. Change the Platform field to SFDX on the environment you want to add to the source format pipeline. 
  3. When you create the new DX pipeline in the next step, associate your Environments with this new pipeline. 
Pipeline & Pipeline Connections

You can re-use an existing pipeline or create a new one for this beta setup.

For existing pipelines:

  1. Remove all pipeline connections from the pipeline if that has not been done yet. 
  2. Change the Platform field on the Pipeline record to SFDX.
  3. Set the remaining Pipeline values if needed.
  4. Save your changes. 
  5. Change the Platform field on the environments you want to link to the pipeline to SFDX.
  6. In the Automations section of the Pipeline, you need to associate the following Job Templates:
    1. Commit Job Template: SFDX Commit
    2. Promotion Job Template: SFDX Promote
    3. Deployment Job Template: SFDX Deploy
    These Job Templates come as part of the DX Extension package that you install.

For new pipelines:

  1. Create the new pipeline
  2. Set the Platform field to SFDX.
  3. Ensure the environments you want to connect to the pipeline have also the Platform value populated with SFDX.
  4. In the Automations section of the Pipeline, you need to associate the following Job Templates:
    1. Commit Job Template: SFDX Commit
    2. Promotion Job Template: SFDX Promote
    3. Deployment Job Template: SFDX Deploy
    These Job Templates come as part of the DX Extension package that you install.
  5. Navigate to the Pipeline Connections related list on the Pipeline record and create the connections between the different environments. Review the section Creating a Pipeline Connection from the Pipeline Connections Related List to go through the step-by-step process. 

Alright, you have configured the DX extension. Now, let’s do a simple test run to check if the setup was correct.

Test Your Setup
  1. Create a Project record and link your DX pipeline to it. Review the Project Overview and Setup article for more information about how to do this.
Pipeline Connections

  1. Create a User Story.
  2. In your dev org create metadata, for example, a Visualforce page and a field on the Account object.
  3. Go back to the created user story and click on Commit Changes. You might see a different screen, but don’t worry, it’s ok.

There is a section, which allows you to select the date and time. For these fields, you need to select today, yesterday, or any time prior to you creating the metadata for this test. When done, click on Pull Changes. The grid will load the metadata list.

Commit Changes
  1. Select the metadata you want to commit and click on Commit Changes. This will redirect you to the Snapshot Commit detail page.
    Snapshot Commit detail page
  2. To review the status of the job execution, navigate to the Copado Job Execution tab and open the latest one which is in progress.
Copado Job Execution

  1. On the Job Execution detail page you will see the steps performed as part of the commit and their status: 
Job Execution detail page

Each step has a result record that is displayed at the right of the Job Steps table.

result record for Job execution

If you click on the R00011 Result link you’ll be redirected to the Result record detail page where you’re able to access the logs of this step:

Result Record Logs


How did we do?