Lightning - Salesforce Integration

Step by step guide on how to integrate ContractSafe with Salesforce Lighting Experience (LEX)

Here is how:

Step 1: Enable ContractSafe Salesforce integration through Settings - Security and Integration - and enable the Salesforce integration. Click the Generate Salesforce Endpoint URL and copy it for future use.

Enter your Salesforce Account user, Password, and Account Security Token.

IMPORTANT: If your password ever changes, you will need to reset your Account Security Token and re-enter both into ContractSafe.

NOTE: If you are working in a Salesforce Sandbox environment, make sure to check the Use Sandbox checkbox.


 Step 2:

In your Salesforce account, add as a new Remote Site.

To get there, click the Settings gear in the top right, followed by Setup. In the Quick Find search bar, enter "Remote Site",


Step 3: Modify the Apex Class

- In the top right, click the settings gear icon and navigate to Developer Console.
IMPORTANT NOTE: To minimize confusion, we recommend that you stick with the naming conventions and suggestions in this guide.

 Click File > Open > Classes > {the file for the old Apex class}.  Alternatively, create a new Apex class and keep the old one if you would like. Call it "ContractSafeWsLightning"

- Insert the following code. Note that the bold part of the code will need to be your specific ContractSafe endpoint that we have generated and copied from the previous step:

global class ContractSafeWsLightning {
webservice static void sendToCS(String contractId) {
User u = [select email from user where id=:userinfo.getuserid()];
String useremail = u.Email;
HttpRequest req = new HttpRequest();
HttpResponse res = new HttpResponse();
Http http = new Http();
//req.setBody('sfobjectID='+EncodingUtil.urlEncode(contractId, 'UTF-8'));
req.setBody('{"sfobjectID":"'+ contractId +'","user":"' + useremail + '"}');
//req.setCompressed(true); // otherwise we hit a limit of 32000
try {
res = http.send(req);
} catch(System.CalloutException e) {
System.debug('Callout error: '+ e);

Optionally: If you're working in a Salesforce Sandbox Environment, you will need to create Test classes with sufficient code coverage in order to finally deploy to Production.

Click File > New > Apex Class and enter the name ContractSafeWsLightningMock. Then paste in the following code.

global class ContractSafeWsLightningMock implements HttpCalloutMock {
    global HTTPResponse respond(HTTPRequest request) {
        HttpResponse response = new HttpResponse();
        response.setHeader('Content-Type', 'application/json');
        response.setBody('{"response": "ContractSafe response"}');
        return response;

Click File > New > Apex Class and enter the name ContractSafeWsLightningTest. then paste in the following code.

public class ContractSafeWsLightningTest {
    static testMethod void runTest(){
        Test.setMock(HttpCalloutMock.class, new ContractSafeWsLightningMock());

You can run the test by returning to the ContractSafeWsLightning Apex Class. Click Test > New Run and select your newly created ContractSafeWsLightningTest.

Step 4: Lightning Component
1. From the developer console, click File > New > Lightning Component - We recommend you name it ExportToCsLightning.
2. This will land you in a .cmp file under the name you've chosen. Add the following code:
<aura:component controller="ContractSafeWsLightning" implements="force:appHostable,flexipage:availableForAllPageTypes,flexipage:availableForRecordHome,force:hasRecordId,forceCommunity:availableForAllPageTypes" access="global">    
<div class="slds-m-around--medium">
<lightning:button variant="brand" label="Export To CS" onclick="{! c.sendContract }" />


3. In the sidebar on the right, click CONTROLLER to define the component's controller: 
    sendContract : function(component, event, helper) {


4. On the right again, click HELPER. The following goes in there:
    getResponse: function(component) {
        // create a server side action.      
        var action = component.get("c.sendToCS");
            "contractId": component.get("v.recordId")
        action.setCallback(this, function(response) {
            var state = response.getState();
            if (component.isValid() && state === "SUCCESS") {

                alert("Contract sent successfully");
            } else {


Step 5: Test

1. Now we're ready to test. Click File > New > Lighting Application and instantiate your component inside it, like so: We recommend you name your application "ExportToCsLightningApp"

<aura:application >

2. On the right, click "Preview" and it should load up the component. If all is good, you should see a simple button. It won't do much if you click it since it's not on the contract page and has nothing to reference.

3. Now for the real test. Navigate to your Contracts page and choose a contract. 
4. Click the settings icon in the top right, followed by Edit Page
5. If everything is configured correctly, you should be able to see your custom component towards the bottom of the panel to the left. Go ahead and click and drag it anywhere you'd like on the page.
6. Save up and activate the page.
7. You should now see a button that reads "Export To CS"
8. Click the button and you're good to go.

If Salesforce SSO is enabled on ContractSafe, you will not be able to send documents to ContractSafe from Salesforce.