ApexDevForce.com

Salesforce SFDX CI/CD - Bitbucket Pipelines Example

Wed, 01 Jul 2020 00:00:00 +0000

Salesforce SFDX CI/CD - Bitbucket Pipelines Example

1. Prerequisites - environment and tools

Command Line on an OS MacOS / Linux / Windows
Web Browser
OpenSSL - OOTB in MacOS and Linux. Windows: https://www.openssl.org/
Salesforce Deployment Traget Org with Admin User Access
SFDX CLI - https://developer.salesforce.com/tools/sfdxcli
Bitbucket Pipeline - bitbucket user account with repo admin permission
Git - https://git-scm.com/

2. OpenSSL - crete a private key and self-sighned digital certificate

Run the following Commands in a folder, e.g. a folder named “my_ssh_keys” on Desktop

cd ~/Desktop/my_ssh_keys
openssl genrsa -des3 -passout pass:x -out server.pass.key 2048
openssl rsa -passin pass:x -in server.pass.key -out server.key
openssl req -new -key server.key -out server.csr
openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt

Reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_key_and_cert.htm

3. Salesforce Org - create a Connect App on deployment target org

Classic UI: Setup -> Build -> Create -> Apps -> New Connected Apps -> New
Lightning: Setup -> PLATFORM TOOLS -> Apps -> App Manager -> New Connected App
Connect App Name: e.g. My CICD
Contact Email: your@email.address
Enable OAuth Settings
- Callback URL: http://localhost:1717/OauthRedirect
- Tick “Use digital signatures” -> upload the server.crt that was generated by OpenSSL in step 2.
- OAuth scope:
  - Access and manage your data (api)
  - Perform requests on your behalf at any time (refresh_token, offline_access)
  - Provide access to your data via the Web (web)
Reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_connected_app.htm

4. Salesforce Org - OAuth from browser to the deployment target org

Allow from 2-10 minutes for your changes to take effect on the server before using the connected app.
Open browser, past the following address to login to the Salesforce deployment target org
- https://org-custom-domain.my.salesforce.com/services/oauth2/authorize?client_id=consumer_key&redirect_uri=http://localhost:1717/OauthRedirect&response_type=code
Replace org-custom-domain with the deployment target custom domain
Replace consumer_key with the connect app’s consumer key
Login and Authorize (here the login user will be used as the pipeline Salesforce login user)
- After login and authroize, the browser will be redirected to http://localhost:1717/OauthRedirect, just ignore and close the browser tab.

5. Bitbucket Pipeline - enable pipline

Click Pipeline on repo sidebar menu
Select the default Starter pipeline
Replace the bitbucket-pipelines.yml content with the following example.

image:
  name: salesforce/salesforcedx:7.75.1-slim

pipelines:
  default:
    - step:
        script:
          - echo "Commited changes to a branch that does not match the listed branches in bitbucket-pipelines.yml."
          - echo "You can skip running pipline by adding [skip ci] or [ci skip] (with []) to the git commit message."
          - sfdx --version
          - sfdx plugins --core
  branches:
    qa:
     - step:
         script:
           - sfdx --version
           - sfdx force:auth:jwt:grant -f server.key -i $SFDC_CONSUMER_KEY -u $SFDC_USER -d -s -r $SFDC_URL
           - sfdx force:source:deploy -x $MANIFEST_PACKAGE_PATH -l RunSpecifiedTests -r $TEST_CLASSES_1

The example will work when changes committed to the git repo branch named qa i.e. the CI/CD will automatically run when someone pull-request and merge changes to the qa branch.
You can change the branch name to suit your project settings.
You can add more branches to deploy different branches to different deployment target orgs, in this case you will need to set up Connect Apps in each deployment target orgs.

6. Bitbucket Pipeline - repository variables

The example in step 5 need following variables to be set up in the repository.
Repository sidebar -> Repository settings -> PIPELINES > Repository Variables: Add new Name and Value pairs
- SFDC_CONSUMER_KEY : the consumer key from the newly created Salesforce Connect App
- SFDC_USER : Salesforce Org user name of the CI/CD runner, the user that used in the OAuth slide
- SFDC_URL : https://test.salesforce.com for sandboxes, replace “test” with “login” for production.
- TEST_CLASSES_1 : list of comma separated unit test class names, e.g. MyClassTest,YourClassTest
- MANIFEST_PACKAGE_PATH : manifest/release_package.xml

7. Bitbucket Pipeline - running CI/CD

In the example bitbucket-pipelines.yml the configuration is based on a branch named: qa
Create a branch in the repository, name it as qa
Commit the bitbucket-pipelines.yml and the server.key (created by OpenSSL in the step 1) to the qa branch.
Create the release_package.xml and commit it along with the metadata files that listed in it to the qa branch, your pipeline should have started automatically.
Don’t forget to update the Test Classes in the Repository variables. In the example the variable name is TEST_CLASSES_1

8. Good luck! 8 is a lucky number in Chinese culture, which means get rich :)

Apex get outstanding scheduled jobs

Wed, 12 Dec 2018 00:00:00 +0000

Get outstanding scheduled Apex jobs

public static Integer getOutstandingJobs(String jobName){
  // Job Types:
  // Data Export (0)
  // Dashboard Refresh (3)
  // Analytic Snapshot (4)
  // Scheduled Apex (7)
  // Report Run (8)
  // Batch Job (9)

  // The current state of the job. The job state is managed by the system. Possible values are:
  // WAITING: The job is waiting for execution.
  // ACQUIRED: The job has been picked up by the system and is about to execute.
  // EXECUTING: The job is executing.
  // COMPLETE: The trigger has fired and is not scheduled to fire again.
  // ERROR: The trigger definition has an error.
  // DELETED: The job has been deleted.
  // PAUSED: A job can have this state during patch and major releases. After the release has finished, the job state is automatically set to WAITING or another state.
  // BLOCKED: Execution of a second instance of the job is attempted while one instance is running. This state lasts until the first job instance is completed.
  // PAUSED_BLOCKED: A job has this state due to a release occurring. When the release has finished and no other instance of the job is running, the job’s status is set to another state.
  
  // hardcoded to type=7, as it is the schedule job
  CronTrigger[] cts = [SELECT Id, CronExpression, StartTime, EndTime, PreviousFireTime, NextFireTime, 
             State, CronJobDetail.Id, CronJobDetail.Name, CronJobDetail.JobType 
             FROM CronTrigger 
             WHERE CronJobDetail.JobType = '7' 
             AND State = 'WAITING'
             AND CronJobDetail.Name like :jobName+'%' ];
  // this query check for any "waiting" job that match the jobname... doesn't really care when it is fired
  // this check make sure we don't schdule more than 1 job with the same name
  //for(CronTrigger c: cts){system.debug(c);}
  return cts.size();
}

com.sforce.ws.SoapFaultException Unable to find a deserializer for the type common.api.soap.wsdl.QueryResult Error Id

Sun, 07 Jan 2018 00:00:00 +0000

com.sforce.ws.SoapFaultException: Unable to find a deserializer for the type common.api.soap.wsdl.QueryResult Error Id: 883671539-69937 (-428048666)

Resolve:

Check the Query String

 QueryResult accountQueryResult = enterpriseConnection.query("SELECT Id, (SELECT Id FROM Contacts), Name, FROM Account WHERE Id = \'" + acctId + "\' LIMIT 1");

Notice the sub-query (SELECT Id FROM Contacts), the result of the above query has nested contact objects information.
Now start to use the account query result by casting it to Account acct = (Account)accountQueryResult.getRecords()[0];
Start using ‘acct’ as Account object, (remember it has nested contact object information), the ERROR may occurs if you use this ‘acct’ directly in other SOAP methods, as other methods may require a Account object without the nested Contact objects (Unable to find a deserializer for the type common.api.soap.wsdl.QueryResult). So process the ‘acct’ to remove the sub contact objects before using it in other methods.

Attach a Dynamic PDF Message to a Salesforce Email Template

Wed, 17 May 2017 00:00:00 +0000

Attach a Dynamic PDF Message to a Salesforce Email Template.The Email Template can be used in Email Alerts that will be triggered by Workflow Rule / Process / Flow … etc

We will create following items:

A Visualforce page that will be rendered as PDF. (e.g. Receipt)
A Apex Controller Class for the above VF page. (e.g. ReceiptController)
A VF Component that to be referenced by the Visualforce Email Template. (e.g. ReceiptAttachment)
A Apex Controller Class for the above VF Component. (e.g. ReceiptAttachmentController)An Visualforce Email Template.

Sample Code List

Receipt.page

<apex:page controller="ReceiptController" applyHtmlTag="false" applyBodyTag="false" showHeader="false" sidebar="false">
<html>
<span>Dynamic PDF data:  <apex:outputText value="{!ContactName}" escape="false"/></span>
</html>
</apex:page>

ReceiptController.class

public class ReceiptController {

    public String ContactID {
        get{
            if(ContactID == null && 
            ApexPages.currentPage().getParameters().get('contactId') != null){
                ContactID = ApexPages.currentPage().getParameters().get('contactId');
            }
            return ContactID;
        }
        set;
    }

    public String ContactName {
        get{
            return [SELECT Name FROM Contact WHERE ID = :ContactID LIMIT 1].Name;
        }
        set;
    }
}

ReceiptAttachment.component

<apex:component controller="ReceiptAttachmentController" access="global">
    <apex:attribute name="contactId"

        description="Contact Id"

        assignTo="{!contactObjectId}"

        type="Id" />

    <apex:outputText value="{!PageContents}" escape="false" />
</apex:component>

ReceiptAttachmentController.class

global class ReceiptAttachmentController {

  global String PageContents{ get; set; }
  global String contactObjectId{ 
    get; 
    set {
        UpdateContents(value);
    } 
  }

  public void UpdateContents(String contactObjectID) {
    try {
        PageReference pageRef = Page.Receipt;
        pageRef.getParameters().put('contactId', contactObjectID);
        PageContents = pageRef.getContent().toString().replace('<html style="display:none !important;">', '<html>');
    } catch(exception ex) { 
        PageContents = 'An error has occurred while trying to generate this invoice.  Please contact customer service.' + 
                       '\n\nError Message:' + ex.getMessage();
    }
  }
}

Visualforce Email Template

<messaging:emailTemplate subject="Receipt Attached" recipientType="Contact" 
 relatedToType="Contact" replyTo="your@company.com">
    <messaging:attachment renderAs="PDF" filename="receipt.pdf">
        <c:ReceiptAttachment contactId="{!relatedTo.Id}"/>
    </messaging:attachment>
    <messaging:htmlEmailBody >
    <html>
        Please find your invoice attached.
    </html>
    </messaging:plainTextEmailBody>
</messaging:emailTemplate>

Now you will see “Visualforce Attachments” in the Email Template, File Name: receipt.pdf

Salesforce Formula field to generate Case ref number

Tue, 07 Mar 2017 00:00:00 +0000

TRIM(" [ ref:" + LEFT( $Organization.Id, 4) + RIGHT($Organization.Id, 4) +"."+ LEFT( Id, 4) + SUBSTITUTE(SUBSTITUTE(SUBSTITUTE(Id, RIGHT( Id, 4), ""), LEFT( Id, 4), ""), "0", "") + RIGHT( Id, 4) + ":ref ] ")

V2 Case ref number used in Email communication.

"ref:_"&LEFT( $Organization.Id,5)&SUBSTITUTE(RIGHT($Organization.Id,10),"0","")&"._"&LEFT(Id,5)&SUBSTITUTE(LEFT(RIGHT(Id,10),5),"0","")&RIGHT(Id,5)&":ref"

Salesforce Formula Calculate Years and Months Between 2 Dates

Sun, 22 May 2016 00:00:00 +0000

To calculate Years and Months in Salesforce formula field between 2 dates.Use case:Calculate how many years and months work experience from an employee start work date.Formula Field, return Text:

TEXT(YEAR(TODAY()) - YEAR(Start_Date__c)
- 
if((MONTH(TODAY()) < MONTH(Start_Date__c)) 
|| 
((MONTH(TODAY()) == MONTH(Start_Date__c)) && 
(DAY(TODAY()) < DAY(Start_Date__c)) 
) 
,1,0)) 

& " Years " & 

TEXT(MOD((MONTH(TODAY()) - MONTH(Start_Date__c) 
+ 12*(YEAR(TODAY())-YEAR(Start_Date__c)) 
- if(DAY(TODAY()) < DAY(Start_Date__c),1,0)) 
, 12)) 

& " Months"