Skip to main content
  1. Ironclad
  2. Integrations
  3. Salesforce
  4. Basics

Upgrade Your Ironclad Salesforce Integration

This article will walk you through how to upgrade your Salesforce integration.
 
Ironclad periodically releases new versions of the Salesforce Managed Package via the AppExchange. You can see the most recent version number on the AppExchange listing.
 
There are three different ways to upgrade your Salesforce Managed Package depending on your use case, select the section that is relevant to you:
To determine which version you are using, refer to Verify Your Salesforce Managed Package Version. To upgrade, a Salesforce Admin must navigate to Ironclad’s AppExchange listing and install the latest package version.
 
NOTE
If you want to learn more about the Salesforce Integration features that were released with each version, refer to the Salesforce Integration Version Log for a detailed log of each Salesforce Integration release from version 2.30 and on.
 
 

Upgrade Your Salesforce Integration (Versions 2.30, 2.32, 2.18, 2.16, and 2.23)

Prerequisites
Before you upgrade your Salesforce integration, you must:

  • Contact your Ironclad support representative to request that your account is enabled for access to the new Salesforce integration features.
  • If you have previously used this article to set up a related list using Process Builder, remove the process that you created.
  • In Salesforce, navigate to Setup > Process Builder. Delete the process that you previously created. To do this, in Salesforce, navigate to Setup > Process Builder. You do not have to remove the lookup relationship you created, only the process.
image (70).png
  1. In the Salesforce AppExchange, locate the Ironclad Managed Package. Verify that the version number is higher than 2.13. Install the package. We highly recommend that you Install for All Users to make sure that there are no permissions issues.
  2. If you are not already logged into the org you want to install the package to, Salesforce prompts you to log in. For more information on installing packages, refer to Salesforce’s documentation.
 
 

Upgrade from a Legacy Package (Versions 2.0, 2.1, and 2.3)

What should I know before I upgrade my Salesforce integration to version 3.0+?

  • The updated package is fully backwards compatible with existing features. Your in-flight contracts and current workflow configurations should not be impacted by updating your package.
  • Some aspects of your integration’s data model will be updated. If you have any fields/processes that are dependent on the following fields, make sure you have migrated that data or planned an alternative before beginning the upgrade process:
    • The Workflow Step field will no longer available. It is replaced with a new field called Workflow Status. As part of the migration process, you will have the option to populate the new Workflow Status field with Workflow Step data for existing workflows.
    • All new workflows created after upgrading will automatically use the Workflow Status field.
    • The old Workflow Step field will no longer be visible.
  • The default lookup relationship direction between Ironclad workflows and Salesforce objects will be changed to many-to-one (from workflows to Salesforce objects) to better support multiple contract situations.
    • If you followed this article to set up a related list using Process Builder, you already have this lookup relationship. The updated integration will start overwriting this field. You should remove the process to avoid any conflicts with the managed package.
    • We recommend NOT starting the upgrade process until you have verified that overwriting these fields or removing the process will not cause negative impacts in other areas of your Salesforce instance.
    • Contact Ironclad Support for additional guidance.

 

Prerequisites
Before you upgrade your Salesforce integration, you must:

  • Contact your Ironclad support representative to request that your account is enabled for access to the new Salesforce integration features.
  • If you have previously used this article to set up a related list using Process Builder, remove the process that you created.
  • In Salesforce, navigate to Setup > Process Builder. Delete the process that you previously created. To do this, in Salesforce, navigate to Setup > Process Builder. You do not have to remove the lookup relationship you created, only the process.
 
Follow the steps in each dropdown below to upgrade from a legacy package to the most recent managed package:
 

Install the Ironclad Package Update

  1. In the Salesforce AppExchange, locate the Ironclad Managed Package. Verify that the version number is higher than 2.13. Install the package. We highly recommend that you Install for All Users to make sure that there are no permissions issues.image (70).png
  2. If you are not already logged into the org you want to install the package to, Salesforce prompts you to log in. For more information on installing packages, refer to Salesforce’s documentation.

Update Your Salesforce Permissions

To update your permission sets in Salesforce, refer to Manage Salesforce Permissions (Legacy Packages 2.4 and Below).
 

Migrate Existing Workflows

Required Permissions: Ironclad Admin OR Integrations Permissions
In package versions 2.1 and below, the state of in-flight workflows were saved in the Workflow Step Salesforce field. To support expanded functionality, in package versions 2.13+, the Workflow Step field was replaced by the new Workflow Status field.

The old Workflow Step was a string field, and the new Workflow Status field is a picklist.image (71).png
Because all in-flight workflows do not yet have data for the Workflow Status field, we have created a migration tool to automatically populate those values.

Before discussing the steps for accessing and using the tool, it is important to know that this migration consumes a substantial number of Salesforce API calls. If you do not have sufficient calls left within your daily limit, the migration fails and you must re-attempt on another day. The migration tool shows an estimated number of calls needed prior to starting the migration. The call volume is tied to the number of workflows connected to Salesforce in your company.

To check your daily Salesforce API call limit, refer to Salesforce’s documentation. If you have questions related to the daily API call limit, contact your Salesforce representative.

Before starting the migration, keep in mind:
  • This process only needs to be done once and cannot be paused, undone, or reversed after it has been started.
  • The migration does not impact the progress of your workflows. You can continue working on these workflows and launching new ones without any interference while the migration runs in the background.
  • If you have built any automation or tooling that uses the Workflow Step field, such as Salesforce reports, you should update those processes to use the Workflow Status field before starting the migration. You should also confirm that the datatype change (from string to picklist) will not negatively impact your processes.
  • Depending on the number of active workflows and demand on the tool, the migration process can take anywhere from a few minutes to a few hours. You receive an email with the status of the migration and any required next steps upon completion.
  • This step can be completed independently of the other steps in this topic. You can work on other parts of the upgrade process and return to this step on a different day, such as when you have more API calls left within your daily limit.
image (72).png
  1. Log in to your account, and then visit the following link.
  2. View the estimated number of Salesforce API calls needed, and verify that your organization has enough calls left in your daily limit. Click Start Migration.
  3. Follow the prompts and begin the migration. At this point, you can navigate away from the page and continue setting up and using the Salesforce integration. The admin who started the migration will receive an email notifying them if the process was successfully completed, or if there are any errors that need to be resolved.image (73).png
  4. If you have any questions about the migration tool, reach out to the Ironclad Support team. If you have questions related to the daily API call limit, reach out to your Salesforce representative.

Add a New Path Component

You can now add a path component to the Ironclad Workflow object, which provides a visual representation for the workflow’s status. You must first enable this feature in Salesforce, then you must add the standard component to the lightning page of the Ironclad Workflow object.
  1. In the top right corner of Salesforce, click Setup indicated by a gear icon. Navigate to User Interface > Path Settings, and then click Enable.
  2. Verify the Status path for the Ironclad Workflow, which was added through the managed package, is set to Active.image (74).png
  3. Click the App Launcher icon indicated by a grid of stacked dots. Search for and click on Ironclad Workflows.
  4. Click New. This is a placeholder record you can delete later.
  5. Enter an Ironclad Workflow Name and Workflow ID. Click Save.image (75).png
  6. Click Setup indicated by a gear icon in the top right corner, and then click Edit Page.
  7. Drag the Path component to the header section of the page.image (76).png
  8. Select the Hide path update button checkbox and click Save.image (77).png
  9. If the activation modal does not immediately appear after you click Save, click Activation to activate the page based on your organization’s needs.
  10. Activate the page as Org Default or App Default depending on your organization’s needs. We recommend that you activate this Lightning page for both Sales and Sales Console apps. Click Close.image (78).png
  11. Verify that the path’s status bare displays on the test Ironclad Workflow object. Once the activation is complete, if you used a test record, delete the record by exiting the page layout editor, clicking the dropdown icon in the top right, and click Delete.image (79).png

Add New Lookup Field on Ironclad Workflow Object

This steps below walk you through how to add a new lookup relationship from the Ironclad Workflow object to your Salesforce source objects. This allows users to see all related workflows directly from the source object.  This instructions below use the Contact object to represent the source object, but you may follow these steps using any source object.
  1. Click Setup indicated by a gear icon in the top right corner, and then click Object Manager. Click the Ironclad Workflow object.
  2. In the left panel, click Fields & Relationships, and then click New.
  3. For the Data Type, select Lookup Relationship and click Next.
  4. In the Related To dropdown, select the object type you want relate to. In this example, we are using the Contact object, so we select Contact. Click Next.
  5. Enter a Field Label and Field Name.
  6. In the Child Relationship Name field, enter Ironclad_Workflows. Verify the Clear the value of this field checkbox is selected. Click Save.image (80).png
  7. Repeat the steps above for each Salesforce object you have a workflow configured for.

Delete Old Lookup Field on Salesforce Source Object

You will also need to remove the old lookup relationship. Before doing this, verify that there are no other components in your Salesforce instance that depend on this field.
  1. Click Setup indicated by a gear icon in the top right corner, and then click Object Manager > Fields & Relationships.
  2. Locate the Ironclad Workflow field, and then click on the dropdown button located on the right. Click Delete.image (81).png
  3. Repeat the steps above for each Salesforce object you have a workflow configured for.

Update Ironclad Workflow Page Layout

  1. Click Setup indicated by a gear icon in the top right corner, and then click Object Manager. Click the Ironclad Workflow object.
  2. In the left panel, click Page Layouts, and then click Ironclad Workflow Layout.
  3. Drag the Account and Contact lookup fields into the page layout (and any other objects you want to configure). This may have been done automatically for you after creating the lookup relationship, in which case all you have to do is double-check that the correct fields appear.image (82).png
  4. Locate the Workflow Step field and click the Remove icon.image (83).png
  5. Drag the Workflow Status field to the page layout, and then click Save. This may have been done automatically for you after creating the lookup relationship, in which case all you have to do is double-check that the correct fields appear.image (84).png

Update Source Object Page Layout

You must add the Ironclad Workflows Related List to the Source Object Page Layout.  This allows users to see all related workflows directly from the source object.  The instructions below use the Contact object to represent the source object, but you may follow these steps using any source object.
  1. Click Setup indicated by a gear icon in the top right corner, and then click Object Manager. Click the Contact object.
  2. In the left panel, click Page Layouts, and then click Contact Layout.
  3. Click the Related Lists tab, and then drag the Ironclad Workflows related list onto the page layout. we recommend adding it to the top of the list for easy access. This may have been done automatically for you after creating the lookup relationship, in which case all you have to do is double-check that the correct list appears and reorder the lists as needed.image (85).png
  4. Click the wrench icon above the Ironclad Workflows related list.image (86).png
  5. From the Available Fields list, add Ironclad Workflow Name, Workflow ID, Workflow Link, and Workflow Status to the list of Selected Fields. Click OK.image (87).png
  6. Click Save.

[Optional] Add Workflow Configurations to Salesforce for Embedded Launch

Skip this section if your organization does not want to use embedded launch for your launch forms. Your custom buttons will continue to function normally. If you are launching from a Salesforce custom button and/or only using the Pull from Salesforce option in Ironclad, you do not need to complete this section. It is only required to be able to use embedded launch from the Ironclad Workflows component.

There are three ways to launch an Ironclad workflow that syncs with Salesforce data:
  1. Pull from Salesforce Button on Ironclad: When you click the Pull from Salesforce button, you can search objects in Salesforce and automatically fill in the workflow form with values from the Salesforce object you select based on the configuration you created.
  2. Custom Salesforce Button: Add a custom button to Salesforce pages to automatically launch an Ironclad workflow from a Salesforce page.
  3. Ironclad Workflows Component in Salesforce:  Launch a new workflow from within your Salesforce window. You can also see all available workflows from one component.
To set up embedded launch, refer to Launch Workflows from Salesforce.
 

Upgrade from the Early Access Salesforce Package to the Official Release

What should I know before I upgrade my Salesforce integration?

  • Upgrading the package will enable your team to be working on the most up-to-date version of the integration; only the most-recent package version is officially maintained by the Ironclad team.
  • The package changes will:
    • enable embedded workflow launch for Safari users
    • provide more detailed error messages for invalid workflow URLs
    • improve the consistency of tab redirection behavior after submitting an embedded workflow launch form
  • The updated package will provide access to new features, as detailed in the Salesforce Integration Version Log, including:
    • Ironclad Approvals Module
    • Salesforce Initiated Data Refresh and Sync
    • Expanded Permissions and User Guidance for Embedded Workflow Launch
  • For the vast majority of users, there will be no changes to the managed package’s functionality or user experience.
  • In flight workflows will not be impacted.
 

What does the upgrade process look like?

If you installed the early-access package as a fresh installation (did not upgrade from an earlier Ironclad Managed Package version):
  • You will only have to install the new package from the Salesforce AppExchange (Step 1 below).
  • No other action is required to maintain existing functionality. However, refer to Salesforce Integration Version Log for instructions on enabling new features.
If you installed the early-access package as an upgrade from a previous Ironclad Managed Package version:
  • Install the new package from the Salesforce AppExchange.
  • We also recommend migrating your existing workflows to backfill the Workflow Status field for older workflows; additional information is available below. Migrating your existing workflows is strongly encouraged for all customers who upgraded, but it is only required for those who have built additional automation/tooling on top of the Workflow Step/Workflow Status fields.
No other action is required to maintain existing functionality. However, refer to the Salesforce Integration Version Log for instructions on enabling new features.
 
Follow the steps in each dropdown below to upgrade from the early access Salesforce package to the official release:
 

Install the Ironclad Package Update

  1. In the Salesforce AppExchange, locate the Ironclad Managed Package. Verify that the version number is higher than 2.13. Install the package. We highly recommend that you Install for All Users to make sure that there are no permissions issues.image (70).png
  2. If you are not already logged into the org you want to install the package to, Salesforce prompts you to log in. For more information on installing packages, refer to Salesforce’s documentation.

Migrate Existing Workflows

Required Permissions: Ironclad Admin OR Integrations Permissions
In package versions 2.1 and below, the state of in-flight workflows were saved in the Workflow Step Salesforce field. To support expanded functionality, in package versions 2.13+, the Workflow Step field was replaced by the new Workflow Status field.

The old Workflow Step was a string field, and the new Workflow Status field is a picklist.image (88).png
Because all in-flight workflows do not yet have data for the Workflow Status field, we have created a migration tool to automatically populate those values.

Before discussing the steps for accessing and using the tool, it is important to know that this migration consumes a substantial number of Salesforce API calls. If you do not have sufficient calls left within your daily limit, the migration fails and you must re-attempt on another day. The migration tool shows an estimated number of calls needed prior to starting the migration. The call volume is tied to the number of workflows connected to Salesforce in your company.

To check your daily Salesforce API call limit, refer to Salesforce’s documentation. If you have questions related to the daily API call limit, contact your Salesforce representative.

Before starting the migration, keep in mind:
  • This process only needs to be done once and cannot be paused, undone, or reversed after it has been started.
  • The migration does not impact the progress of your workflows. You can continue working on these workflows and launching new ones without any interference while the migration runs in the background.
  • If you have built any automation or tooling that uses the Workflow Step field, such as Salesforce reports, you should update those processes to use the Workflow Status field before starting the migration. You should also confirm that the datatype change (from string to picklist) will not negatively impact your processes.
  • Depending on the number of active workflows and demand on the tool, the migration process can take anywhere from a few minutes to a few hours. You receive an email with the status of the migration and any required next steps upon completion.
  • This step can be completed independently of the other steps in this topic. You can work on other parts of the upgrade process and return to this step on a different day, such as when you have more API calls left within your daily limit.
image (89).png
  1. Log in to your account, and then visit the following link.
  2. View the estimated number of Salesforce API calls needed, and verify that your organization has enough calls left in your daily limit. Click Start Migration.
  3. Follow the prompts and begin the migration. At this point, you can navigate away from the page and continue setting up and using the Salesforce integration. The admin who started the migration will receive an email notifying them if the process was successfully completed, or if there are any errors that need to be resolved.image (90).png
  4. If you have any questions about the migration tool, reach out to the Ironclad Support team. If you have questions related to the daily API call limit, reach out to your Salesforce representative.

(Optional) Add Guidance for Success Descriptors

The Path component on the Ironclad Workflow Object helps sales users follow along with the contracting process and see the statuses of their workflows at a glance. We have provided default descriptions for the ‘Guidance for success’ path. You can add additional detail about your company’s individual contracting process to further customize this component.
  1. In the top right corner, click the Setup icon indicated by a blue gear.
  2. Click the App Launcher icon indicated by a square grid in the top left corner. Search for and select User Interface.
  3. Click Path Settings.
  4. Locate the Status path and click Edit under the Action column.
  5. Review the Fields and Text section to view the individual status fields and their descriptions.
  6. For each of the status fields that is missing a descriptor, paste the corresponding description in the Guidance for Success field:
Name Description
Create Ironclad is automatically collecting additional information before launching. Users will receive information request emails.
Review The contract is being reviewed and approved in Ironclad.
Paused This contract has been paused.
Sign The contract has been approved and signatures are being collected.
Sign: Not Out for Signature The contract has been approved and is being prepared for signature in Ironclad.
Sign: Out for Signature The contract is out for signature.
Archive The contract has been fully executed. The contract metadata is being reviewed for archive in Ironclad.
Canceled This workflow has been canceled.
Complete The fully-executed contract has been successfully archived to the Ironclad repository.
 
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Related Articles

Want to learn more about this feature and more? Review the Related Articles. Here, we provide a list of articles curated just for you.

Related articles