Changes in your various Salesforce application accounts, such as updated user information (consumer keys or secrets, for example) will require an update to your existing Connector Projects. Often, it is good practice to update your Connector Projects occasionally.
You can update these Projects by using the Cloud Connector Update option in the CIC Studio.
Before you update
Before actually taking the update steps, please note the following recommendations:
- Always back up the latest working integrations and Connector Projects before performing any updates. This helps mitigate potential business interruptions.
- Always perform the update using the latest version of the CIC Studio (at the time of update) to leverage the newest features and bug fixes.
Take these steps to update the Connector Projects in the CIC Studio.
- From the main menu, select Cloud Connector Update.
- Browse for and select the existing Salesforce Connector Project you plan to update. Alternatively, you can right-click on the Salesforce Connector Project in your main menu and then select Cloud Connector Update…
- Follow the wizard instructions and edit/provide the required Salesforce account information.
- Verify all details and then click on Finish to complete the update process.
When Salesforce deprecates API versions (and how to avoid problems)
When a Salesforce Connector is being created or updated, it uses the current API(s) version. This API version will be fixed; it does not automatically get updated unless the Connector is updated by the user in the Studio. If Connectors aren't being updated regularly, there is risk that a particular API version used by the Connector may be deprecated by Salesforce. Take the following steps to help avoid this scenario:
- Review the latest Salesforce release notes for deprecated API versions. Refer to this example of Salesforce Release Notes to see how deprecated API versions are communicated.
- Check the API version of your Connector. This can be done by opening Salesforce_Enterprise.wsdl, located in the Connector Project's wsdl package. From the Project Explorer, use a simple text editor to open the file, which lists the API version being used.
- The Salesforce Connector should be updated if the API version is deprecated or will be retired soon.
- Changes to APIs across Salesforce versions can affect existing integration flows. To mitigate this possibility, Cleo recommends that users perform a backup of working Connector Projects and related integration Projects before updating.
Frequently Asked Questions
Q. Will I see any differences once the upgraded connector is available?
Yes, some differences will be introduced in the upgraded connector. These include:
- Schema changes: In the new version of API, if any schema field that is utilized in an existing integration is removed, then the associated Business Processes will have to be updated to utilize alternative fields.
- API changes: Should any API being utilized in an existing BP be deprecated, then the respective BP will not be available in the upgraded Connector. An alternative BP will need to be used to enable the required integration flow(s).