This topic will walk you through how to upgrade your early access Salesforce package to the official release. This article will guide you through the upgrade process to update your Ironclad Salesforce package. It is intended for users who installed an early-access version of the package (Versions 2.4-2.12) who would like to upgrade to the official public release package (Versions 2.30+).
Note: This article is intended for users who previously installed an early-access package (version numbers 2.4-2.12) and are now switching to the official release package (2.30+).
- If you are setting up the Ironclad Salesforce integration for the first time, or are installing an updated version of the Ironclad Managed package, refer to the Salesforce New User Setup Guide.
- If you are looking to upgrade from a version below 2.4 to version 2.30+, refer to Upgrade the Ironclad Salesforce Integration.
- If you are looking to do a first-time install using package versions 2.30+, refer to Salesforce New Installation Setup Guide.
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 (Step 1 below).
- We also recommend completing Step 2 to backfill the Workflow Status field for older workflows; additional information is available below. Step 2 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 Salesforce Integration Version Log for instructions on enabling new features.
Install the Ironclad Package Update
- 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.
- 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 Ironclad Permissions: Admin
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.
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.
- Log in to your account, and then visit the following link.
- 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.
- 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.
- 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.
- In the top right corner, click the Setup icon indicated by a blue gear.
- Click the App Launcher icon indicated by a square grid in the top left corner. Search for and select User Interface.
- Click Path Settings.
- Locate the Status path and click Edit under the Action column.
- Review the Fields and Text section to view the individual status fields and their descriptions.
- For each of the status fields that is missing a descriptor, paste the corresponding description in the Guidance for Success field:
|Ironclad is automatically collecting additional information before launching. Users will receive information request emails.|
|The contract is being reviewed and approved in Ironclad.|
|This contract has been paused.|
|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.|
|The contract has been fully executed. The contract metadata is being reviewed for archive in Ironclad.|
|This workflow has been canceled.|
|The fully-executed contract has been successfully archived to the Ironclad repository.|