Last modified: 2023-02-03

Customizing OneSpan Sign for Salesforce

This section discusses the following topics, which are relevant to customizing your installation of OneSpan Sign for Salesforce:

Connecting Salesforce to your OneSpan Sign Instance

To connect Salesforce to your OneSpan Sign instance:

  1. From Salesforce, search for the OneSpan Sign app. This opens the OneSpan Sign for Salesforce app.
  2. On the OneSpan Sign for Salesforce menu, click the Admin tab. The Admin page appears.
  3. If you are already connected to a OneSpan Sign environment, the Website URL on the Configuration tab displays the OneSpan Sign URL to which the application points. If you want to change this environment:
    1. Click Disconnect and click Continue.
    2. Select the appropriate Environment from the drop-down list:
    • US Production: apps.esignlive.com
    • US Classic Interface Production: apps.e-signlive.com
    • US Governmentsigner-gov.esignlive.com
    • Canada Production: apps.e-signlive.ca
    • AU Productionapps.esignlive.com.au
    • EU Productionapps.esignlive.eu
    • US Sandbox: sandbox.esignlive.com
    • US Classic Interface Sandbox: sandbox.e-signlive.com
    • US Governmentsigner-sandbox-gov.esignlive.com
    • Canada Sandbox: sandbox.e-signlive.ca
    • Configurable: The user must configure a custom Website URL.
  • If you select Configurable, you must also click the Click Here link in the Remote Site Settings to add the endpoint's domain in Salesforce's Remote Site Settings. Clicking the link opens the New Remote Site page.

  • Provide your OneSpan Sign password or API key, and click Connect. This will validate the API key with: (1) the server defined in the Website URL; (2) the email address of the current user. Salesforce should now be connected to your OneSpan Sign instance.
  • Managing Custom Settings

    To manage various Custom Settings in Salesforce :

    • Log in to OneSpan Sign for Salesforce and click the Admin tab.

    Selecting Display Languages

    While OneSpan Sign for Salesforce supports a variety of languages (listed below) you may wish to only make a few of these languages available to your users wherever users can make a language selection (for example, when creating a transaction). To customize the list of languages to be displayed, use the following procedure.

    To select the languages to be displayed wherever users can make a language selection:

    1. On the OneSpan Sign for Salesforce menu, click the Admin tab. The Admin page appears.
    2. In the Languages section use the Add and Remove buttons to change the languages that will be made available to your users.
    3. Use the Up and Down arrows to set the order in which languages will be displayed to a user.
    4. To set a default language, move that language to the top of the Displayed Languages list.

    The following languages are currently supported in OneSpan Sign for Salesforce:

    LanguageValue in the Code
    English[en]
    Français (French)[fr]
    Dansk (Danish)[da]
    Deutsch (German)[de]
    Español (Spanish)[es]
    Ελληνικά (Greek)[el]
    Italiano (Italian)[it]
    Nederlands (Dutch)[nl]
    Português (Portuguese)[pt]
    Pусский (Russian)[ru]
    中文简体 (Chinese - Simplified)[zh-cn]
    中文繁體 (Chinese - Traditional)[zh-tw]
    日本語 (Japanese)[ja]
    한국어 (Korean)[ko]

    اللغة العربية (Arabic)

    Available only in the Signer Experience

    [ar]

    Integrating with Chatter

    Chatter is a social-networking tool in Salesforce that lets users work together, talk to each other, and share information — all in real time. Integrating Chatter with OneSpan Sign for Salesforce enables connector users to access this built-in Notification Center. Users can choose to be notified when a transaction/template state changes, and they can select which notifications they will receive.

    This section describes:

    Enabling Chatter Feed Tracking for Transaction/Template Objects

    To enable this feature, your organization must have enabled Chatter. If you have installed OneSpan Sign for Salesforce for the first time, this feature is already enabled. However, if you are upgrading from a previous version of OneSpan Sign for Salesforce, you may need to enable this feature manually. If so, perform the following procedure.

    To enable Chatter Feed Tracking for OneSpan Sign transaction and template objects in Lightning Experience:

    1. Go to Setup > Customize > Chatter > Feed Tracking. The Feed Tracking page appears.

    2. In the Object column, click the OneSpan Sign Transaction/Template Object.
    3. Ensure that the Enable Feed Tracking option box is checked.
    4. Click Save.

    To enable Chatter Feed Tracking for OneSpan Sign transaction and template objects in Classic:

    1. Click the Gear icon, and then click Setup.
    2. Go to Feature Settings > Chatter > Feed Tracking.The Feed Tracking page appears.

    3. In the Object column, click the OneSpan Sign Transaction/Template Object.
    4. Ensure that the Enable Feed Tracking option box is checked.
    5. Click Save.

    Managing Chatter Settings

    The following procedure enables an OneSpan Sign for Salesforce Admin to manage certain of their organization's Chatter settings.

    To manage your organization's Chatter settings, select one of the following options from the OneSpan Sign Admin page:

    • Disabled — If this option is selected: (1) Chatter settings are hidden on the OneSpan Sign Admin Configuration page; (2) the Enable Chatter Updates field is hidden and unchecked on all new transactions and templates; (3) nonetheless, the Enable Chatter Updates field remains visible on sent or completed transactions if those transactions had the option enabled before they were sent or completed.
    • Enabled and On by Default — If this option is selected: (1) the Chatter settings are visible on the Admin Configuration page; (2) the Enable Chatter Updates field is visible and checked on new transactions and templates.
    • Enabled and Off by Default — If this option is selected: (1) the Chatter settings are visible on the Admin Configuration page; (2) the Enable Chatter Updates field is visible and unchecked on new transactions and templates.

    Changing Preferences for Chatter Notifications

    Chatter posts appear on the transaction and template detail page feed. Anyone following a transaction and template record will see Chatter updates on their Chatter feed.

    To change the preferences for your organization's Chatter notifications:

    1. Click Admin on the Salesforce menu. The OneSpan Sign Admin page appears.
    2. Select the boxes of the events for which you want notifications, and clear the boxes of the events for which you do not want notifications. Then click Save.
    • Display Chatter Updates on related records: All enabled Chatter updates will be posted in the Chatter feed of the Transaction Detail page and on the Related Object Record.
    • Transaction is sent: Users will receive a Chatter notification when a transaction is sent.
    • Transaction is completed: Users will receive a Chatter notification when a transaction is completed.
    • Include links to signed document: Chatter feed updates will include links to signed documents.
    • Transaction is declined: Users will receive a Chatter notification when a transaction is declined.
    • Transaction is opted-out: Users will receive a Chatter notification when a transaction is opted-out.
    • Transaction is expired: Users will receive a Chatter notification when a transaction has expired.
    • Recipient has completed signing: Users will receive a Chatter notification when a recipient has completed signing.
    • Recipient is locked: Users will receive a Chatter notification when a recipient is locked out from signing a transaction.
    • Recipient has delegated their signing role: Users will receive a Chatter notification when a recipient has delegated their signing role.
    • User is required to sign a Transaction: Chatter updates will appear not only on the Transaction feed (and Related Record if the option is enabled), but also on the Recipients feed.

    Adding a Transaction's Related List to an Object's Page Layout

    The following sections describe how to add a transaction's Related List to an object's Page Layout in the OneSpan Sign for Salesforce Lightning Experience and the Classic UI.

    Salesforce Lightning Experience

    In the Lightning Experience, the procedure is the same whether you are adding a transaction's Related List to a Custom or a Standard Object's Page Layout.

    To add a transaction's Related List to an Object's Page Layout in the Salesforce Lightning Experience:

    1. On the top-right menu bar, click the Gear icon > Setup.

    2. On the menu bar, click Object Manager. The Object Manager screen displays a list of both Standard and Custom Objects.

    3. Click the relevant Object name (i.e. Account).

    4. Click Page Layouts and click the relevant page layout name.

    5. Drag and drop the appropriate Related List to the desired position.
    6. Click Save. A message warns that you have added a Related List to this Page Layout.
    7. Click Yes to confirm your changes.

    Salesforce Classic

    This section describes how to add a transaction's Related List to an object's Page Layout in Salesforce Classic.

    Procedure for Standard Objects

    To add a transaction's Related List to a Standard Object's Page Layout:

    1. From the top menu, click Setup.
    2. Click the relevant Standard Object (e.g., Accounts).
    3. Click Edit Layout.
    4. In the Page Layout Editor, click Related Lists.
    5. Drag and drop the new Related List to the desired position.
    6. Click Save. A message warns that you have added a Related List to this Page Layout.
    7. Click Yes to confirm your changes.

    Procedure for Custom Objects

    To add a transaction's Related List to a Custom Object's Page Layout:

    1. From the top menu, click Setup.
    2. In the Salesforce Administrator menu, under Build, click Create > Objects.
    3. Click the relevant Custom Object. The Custom Object page opens.
    4. Scroll to Page Layouts, and click Edit next to the relevant Page Layout.
    5. In the Page Layout Editor, click Related Lists.
    6. Drag and drop the new Related List to the desired position.
    7. Click Save. A message warns that you have added a Related List to this Page Layout.
    8. Click Yes to confirm your changes.

    Automating Transaction Creation in Salesforce Classic

    This section describes how automate transaction creation if you're using Salesforce Classic. The following procedures provide detailed instructions:

    Creating a Custom Link, Button, or List Button

    If you are using Classic Salesforce, you can automate transaction creation by creating a custom Link, custom Button, or custom List Button. You can do so in one of two ways:

    Creating a Custom Link, Button, or List Button to Create a Transaction via a URL

    This section describes how to create a custom Link, Button, or List Button for transaction creation via a URL in the following contexts:

    To create a Link, Button, or Action for a Standard Object, with a view to creating a transaction via a URL:

    1. From the top menu, click Setup.
    2. Click the Standard Object to which you want to add the Custom Link, Button, or List Button (e.g., Accounts).
    3. Under the Standard Object, click Edit Layout link.
    4. Click Buttons, Links, and Actions. The Buttons, Links, and Actions page appears.
    5. Click New Button or Link. The New Button or Link page appears.
    6. From the New Button or Link page, give the link, button, or list a Label and a Name.
    7. Choose one of the following Display Types for the object you want to create:
      • Detail Page Link — Creates a link that you can add to the links section of any detail page. Links can display other pages or websites.
      • Detail Page Button — Creates a button that you can add to the heading of any detail page. Detail page buttons act on the record which the user is viewing.
      • List Button — Creates a button that you can add to the heading of any list view or Related List. List buttons allow users to select multiple items in the list, and to act on all of them at once.
        • To add list buttons to list views, edit the list view layout in search layouts.
        • To add list buttons to Related Lists, edit the Related List properties on the page layout where the Related List appears.
        • To add a list button to an object's Related List, you must create the list button in that object.
    8. Select the appropriate Behaviour.
    9. In the Content Source list, choose URL.
    10. Create a suitable URL code snippet with various parameters. For example, a button that uses multiple parameters may look like this:
    11. /apex/esl__package?ParentId={!Account.Id}&
      	TemplateId=a0Ag0000007r4nS&
      	Name={!Account.Name}%20Agreement&
      	Documents=015g0000000Cm1f&
      	Signer1={!Account.MainContact__c}&
      	Signer1Label=a0Tg0000001uMIf&
      	ConventionId=a0Rg00000033spu&
      enableReminders=true

      For a complete list of URL code snippets, see Parameters for URL Code Snippets.

    12. Click Save. A message warns that the new object will not be displayed until it is added to the Page Layout (see Adding a Link, Button, or List Button to a Page Layout).
    13. Click OK.

    To create a Link, Button, or List for a Custom Object, with a view to creating a transaction via a URL:

    1. From the top menu, click Setup.
    2. In the Salesforce Setup menu, under App Setup, click Create > Objects.
    3. Click the Custom Object to which you want to add the Custom Link, Button, or List Button. The Custom Object page appears.
    4. Scroll to the Related List Buttons, Links, and Actions, and click New Button or Link. The New Button or Link page appears.
    5. From the New Button or Link page, give the link, button, or list a Label and a Name.
    6. Choose one of the following Display Types for the object you want to create:
      • Detail Page Link — Creates a link that you can add to the links section of any detail page. Links can display other pages or websites.
      • Detail Page Button — Creates a button that you can add to the heading of any detail page. Detail page buttons act on the record which the user is viewing.
      • List Button — Creates a button that you can add to the heading of any list view or Related List. List buttons allow users to select multiple items in the list, and to act on all of them at once.
        • To add list buttons to list views, edit the list view layout in search layouts.
        • To add list buttons to Related Lists, edit the Related List properties on the page layout where the Related List appears.
        • To add a list button to an object's Related List, you must create the list button in that object.
    7. Select Behaviour and Content Source URL.
    8. Create a suitable URL code snippet with various parameters. For example, a button that uses multiple parameters may look like this:
    9. /apex/esl__transaction?ParentId={!Account.Id}&
      	TemplateId=a0Ag0000007r4nS&
      	Name={!Account.Name}%20Agreement&
      	Documents=015g0000000Cm1f&
      	Signer1={!Account.MainContact__c}&
      	Signer1Label=a0Tg0000001uMIf&
      	ConventionId=a0Rg00000033spu&
      enableReminders=true

      For a complete list of URL code snippets, see Parameters for URL Code Snippets.

    10. Click Save. A message warns that the new object will not be displayed until it is added to the Page Layout (see Adding a Link, Button, or List Button to a Page Layout).
    11. Click OK.

    Creating a Custom Link, Button, or List Button to Create a Transaction via Conga

    Conga is a third-party application that can create documents with information from Salesforce. If you are using Classic Salesforce, OneSpan Sign for Salesforce can retrieve such documents from Conga, and distribute them for signing.

    To create a Link, Button, or List Button, with a view to creating a transaction via Conga:

    1. From the New Button or Link page, give the link, button, or list a Label and a Name.
    2. Choose one of the following Display Types for the object you want to create:
      • Detail Page Link: Creates a link that you can add to the links section of any detail page. Links can display other pages or websites.
      • Detail Page Button: Creates a button that you can add to the heading of any detail page. Detail page buttons act on the record that the user is viewing.
      • List Button: Creates a button that you can add to the heading of any list view or Related List. List buttons allow users to select multiple items in the list, and to act on all of them at once.
        • To add list buttons to list views, edit the list view layout in search layouts.
        • To add list buttons to Related Lists, edit the Related List properties on the page layout where the Related List appears.
        • To add a List Button to an object's Related List, you must create the List Button in that object.
    3. Select Behaviour: Execute JavaScript and Content Source: OnClick JavaScript.
    4. Create the JavaScript. The following sample code is for a button created in a Contact object. To make it work, you must replace its SalesforceId parameters.
    5. {!REQUIRESCRIPT("/soap/ajax/30.0/connection.js")}
      	var ParentObjectId = '{!Contact.Id}';
      	var TransactionName = '{!Contact.Name} CongaPOC';
      	var RecipientId = '{!Contact.Id}';
      	var Send = true;
      	var congaParameters = "SessionId={!API.Session_ID}&ServerUrl={!API.Partner_Server_URL_210}&Id={!Contact.Id}&TemplateId=00P11000002ImxI&ds7=5&defaultPDF=1&OCNR=1";
      	//Change popup visual here
      	var popup = window.open("https://composer.congamerge.com?"+ congaParameters,'Conga','menu=no, scrollbars=no, top=100, left=100, width=300, height=200');
      	//Do not modify below this line
      	var timer = setInterval(function() {
      	if(popup.closed) {
      	clearInterval(timer);
      	var attach = sforce.connection.query("select id from attachment where ParentId ='"+ ParentObjectId+"' order by createddate desc limit 1");
      	if(attach.records != null)
      	{
      	var transactionParameters= 'ParentId='+ParentObjectId+'&Name='+TransactionName+'&Documents=' + attach.records.Id + '&Signer1=' + RecipientId + '&Signer2=' + '0031100000eKoFW' + '&ConventionId=a0711000003AGvj' + '&Signer1Label=a0L110000035S7k' + '&retURL={!URLENCODE(Contact.Id)}';
      	if(Send)
      	{
      	transactionParameters += '&Send=1';
      	}
      	window.location = '/apex/esl__package?' + transactionParameters;
      			}
      			else
      			{
      			window.reload();
      			}
      			}
      		}, 500)

    Adding a Link, Button, or List Button to a Page Layout

    For Standard Objects:

    1. From the top menu, click Setup.
    2. In the Salesforce Setup menu, under App Setup, click Customize.
    3. Click the Standard Object to which you want to add the custom link, button, or list (e.g., Accounts).
    4. Under the Standard Object, click Page Layouts.
    5. Click Edit.
    6. Click New Button or Link. The New Button or Link page appears.
    7. Perform the procedure Modifying a Page Layout to Add a Link, Button, or List Button.

    For Custom Objects:

    1. From the top menu, click Setup.
    2. In the Salesforce Setup menu, under App Setup, click Create > Objects.
    3. Click the Custom Object to which you want to add the Link, Button, or List Button. The Custom Object page opens.
    4. Scroll to the related list Page Layouts, and click Edit next to the relevant Page Layout.
    5. Perform the procedure Modifying a Page Layout to Add a Link, Button, or List Button.

    Modifying a Page Layout to Add a Link, Button, or List Button

    To modify a Page Layout to add a Link or a Button:

    1. In the Page Layout Editor at the top, click Links or Buttons.
    2. Drag and drop the new Link/Button to the desired position.
    3. Click Save.

    To modify a Page Layout to add a List Button:

    1. Go to the Related List of the object to which you want to add the List Button, and click the wrench icon (Properties).
    2. Expand the Buttons section, and move the new List Button from the Available Buttons to Selected Buttons.
    3. Click OK.

    Automating Transaction Creation in Salesforce Lightning Experience

    The procedures needed to automate transaction creation differ, depending on if you're using Classic Salesforce or you're using the version of Salesforce that has the Lightning Experience enabled.

    This section describes how to do so if you're using the version of Salesforce that has the Lightning Experience enabled. The following procedures provide detailed instructions:

    If you are using the version of Salesforce that has the Lightning Experience enabled, you must automate transaction creation via a Custom Action. A Custom Action cannot directly call a URL, but it can call a Visualforce page. Thus all four of the above procedures are needed to automate transaction creation.

    Creating a Field to Store the Automation URL

    To create a field that will store an Automation URL:.

    1. On the top-right menu bar, click the Gear icon > Setup. The Setup Home page opens.
    2. Under Platform Tools, click Objects and Fields > Object Manager. The Object Manager page opens.
    3. Click the object that will store the Automation URL (e.g., Account, Contact, Opportunity).
    4. Under Fields & Relationships, click New.
    5. Select the Formula data type, then click Next.
    6. Enter a Field Label, Field Name, and Formula Return Type, and click Next.
    7. Enter the URL as a formula (for help, see the Parameters for URL Code Snippets).
    8. Click Check Syntax. If your formula contains no errors, click Next.
    9. For Security for Profile, select Field-Level.
    10. Click Next
    11. Select the Page Layouts to which the field will be added.
    12. Click Save.

    Creating a Visualforce Page to Trigger the Automation

    The following procedure creates the Visualforce page that will trigger the Automation URL from the previous section.

    To create a Visualforce page to trigger the automation:

    1. Click the Gear icon, then click Setup > Setup. The Setup Home page opens.
    2. Under Platform Tools, click Custom Code > Visualforce Pages. Then click New.
    3. Type a label, a name, and a description.
    4. Create the Visualforce Markup by doing the following:
      1. Specify the name of the object that will use the Visualforce page (e.g., Account, Contact, Opportunity), and the name of the field where the URL is stored (see Automating Transaction Creation in Salesforce Lightning Experience).
      2. Always use the PackageAutomation component.
      3. Specify the name of the field of the object where the Automation URL is stored. For example:
      4. <apex:page standardController="Account">
            <esl:PackageAutomation fieldName="Account_Automation_URL__c"/>
        </apex:page>
        
    5. Select Available for Salesforce mobile apps and Lightning Pages.
    6. Click Save.

    Creating the Custom Action

    The following procedure creates the Custom Action that will call the Visualforce page created in the previous section.

    To create the relevant Custom Action:

    1. Click the Gear icon > Setup > Setup Home. The Setup Home page opens.
    2. Under Platform Tools, click Objects and Fields > Object Manager. The Object Manager page opens.
    3. Click the object, and scroll down to Buttons, Links, and Actions.
    4. Click New Action. The Setup Object Manager page opens.
    5. Select the Action TypeCustom Visualforce, and select the Visualforce Page you created in the previous section.
    6. Type a label and a name, then click Save.

    Adding the Custom Action to the Page Layout

    The following procedure adds to the Page Layout the Custom Action created in the previous section.

    To add the Custom Action to the Page Layout:

    1. In the Setup Object Manager, click the object you want to edit (e.g., Account, Contact, Opportunity).
    2. Click Edit beside desired Page Layout.
    3. Click Mobile & Lightning Actions, then drag and drop the Custom Action into the section Salesforce Mobile and Lightning Experience Actions.
    4. Click Save.

    In-App Instructions

    From the OneSpan Sign for Salesforce Admin page, you can click the Instructions tab for information about:

    • Related Lists: How to add OneSpan Sign transactions to a Salesforce layout for a Standard or Custom Salesforce Object
    • Custom Buttons: How to create a Custom Button, and add it to a Salesforce object
    • Custom Actions: How to create a Custom Action, and add it to a Salesforce object
    Was this information helpful?
    X