Installing, Upgrading, and Uninstalling IBM webMethods Adapter for Salesforce

Overview

This chapter explains how to install, upgrade, and uninstall IBM webMethods Adapter for Salesforce 8.2. The instructions use the IBM webMethods Installer and the IBM webMethods Uninstaller wizards. For complete information about the wizards or other installation methods, or to install other webMethods products, see the Installing IBM webMethods Products On Premises for your release.

Requirements

For a list of the operating systems and webMethods products supported by the adapter, see the IBM webMethods Adapters System Requirements, available in the documentation site.

Adapter for Salesforce 8.2 has no hardware requirements beyond those of its host Integration Server.

The following table lists the Salesforce.com components that are required by Adapter for Salesforce.

Component Comment

Salesforce.com Partner WSDL 25

Component	Comment
Salesforce.com Partner WSDL 25	When defining an adapter connection, be sure to specify the endpoint URL to point to version 25.0. The default endpoint used by Adapter for Salesforce is: `https://login.salesforce.com/services/Soap/u/25.0` When using an alternate endpoint, like Salesforce.com Sandbox or test environment, be sure to use version 25.0. Specifying a different version might give unexpected results.
Salesforce.com API-enabled user account	When defining an adapter connection, you must specify the credentials of a Salesforce.com user account that the adapter uses when interacting with Salesforce.com using the Partner WSDL API. Adapter for Salesforce requires that the API feature must be enabled by the user organization. This feature is enabled by default for Unlimited, Enterprise, and Developer Editions. Some Professional Edition organizations might also have the API enabled. If the API Enabled feature is not available, contact Salesforce.com and ensure that it is enabled before using this adapter.
Apache Axis 1.4	When running the adapter on Integration Server 8.2 and later, the adapter uses the common Integration Server libraries.

When defining an adapter connection, be sure to specify the endpoint URL to point to version 25.0.

The default endpoint used by Adapter for Salesforce is:

https://login.salesforce.com/services/Soap/u/25.0

When using an alternate endpoint, like Salesforce.com Sandbox or test environment, be sure to use version 25.0. Specifying a different version might give unexpected results.

Salesforce.com API-enabled user account

When defining an adapter connection, you must specify the credentials of a Salesforce.com user account that the adapter uses when interacting with Salesforce.com using the Partner WSDL API.

Adapter for Salesforce requires that the API feature must be enabled by the user organization. This feature is enabled by default for Unlimited, Enterprise, and Developer Editions. Some Professional Edition organizations might also have the API enabled. If the API Enabled feature is not available, contact Salesforce.com and ensure that it is enabled before using this adapter.

Apache Axis 1.4 When running the adapter on Integration Server 8.2 and later, the adapter uses the common Integration Server libraries.

Installing IBM webMethods Adapter 8.2 for Salesforce

About this task

To install Adapter for Salesforce:

Procedure

Download Installer.
If you are installing the adapter on an existing Integration Server, shut down the Integration Server.
Start the Installer wizard.
Choose the webMethods release that includes the Integration Server on which to install the adapter. For example, if you want to install the adapter on Integration Server 8.2, choose the 8.2 release.
Specify the installation directory as follows:
- If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server.
- If you are installing both the host Integration Server and the adapter, specify the installation directory to use.
  The Installer will install the adapter in the Integration Server_directory\packages directory.
In the product selection list, select Adapters > webMethods Adapter 8.2 for Salesforce.
After the installation completes, close the Installer.
Start the host Integration Server.
Make sure the WmTomcat package is enabled. For instructions, see the IBM webMethods Integration Server Administrator’s Guide for your release.

Upgrading to IBM webMethods Adapter 8.2 for Salesforce

About this task

To upgrade to IBM webMethods Adapter 8.2 for Salesforce:

Procedure

Uninstall the older version of Adapter for Salesforce. For information about how to uninstall Adapter for Salesforce, see the installation guide for the older Adapter for Salesforce version.
Delete the WmSalesforceAdapter package from the Integration Server_directory\packages directory.

You should not delete any other packages, such as packages that contain connections, services, and notifications, even when the packages have a dependency on the WmSalesforceAdapter package.
Install Adapter for Salesforce as described in Installing IBM webMethods Adapter 8.2 for Salesforce.
Restart Integration Server.

Migrating Adapter Services Created with IBM webMethods Adapter 7.1 SP1 for Salesforce

About this task

The input signatures of the create, update, and upsert adapter services have changed in IBM webMethods Adapter 8.2 for Salesforce. For this reason, existing create, update, and upsert services will not work with version 8.2 of the adapter, unless they are updated.

You use the wm.adapter.wmsalesforce.migration.Service:migrate_711_To_82 migration utility service to migrate create, update, and upsert adapter services created with IBM webMethods Adapter 7.1 SP1 for Salesforce. The migration service updates the signatures of the existing create, update, and upsert adapter services.

The migration service automatically corrects the input pipeline mapping of any dependent flow services that contain create, update, or upsert adapter services.

The migration service also updates the connections defined in the custom package containing the create, update, and upsert adapter services, as well as any external connections referred to in the custom package, by changing the Endpoint URL for the connections to https://login.salesforce.com/services/Soap/u/25.0. The migration service changes the connection state to enabled for the connections associated with a create, update, or upsert service.

Note: If the connection associated with a create, update, or upsert adapter service no longer exists, the service will not be migrated.

watt.adapter.salesforce.migration.updateEndPointURL. Use this property to change the Endpoint URL for adapter connection using the migration utility.

When the watt property watt.adapter.salesforce.migration.updateEndPointURL is set to true, the migration utility service changes the default Endpoint URL for adapter connections to the Partner WSDL version. When the property is set to false, the migration utility service does not change the Endpoint URL for adapter connections. The default is false.

When the value of the watt property is changed, you must restart Integration Server.

The following table shows the input parameters of the migration service:

Input Parameter	Description
`packageName`	The name of the package that contains the create, update, or upsert services created using IBM webMethods Adapter 7.1 SP1 for Salesforce.

The following table shows the output parameters of the migration service:

Output Parameter	Description
`status`	The `status` is either `success` or `failure`, depending on the outcome of the migration service.

Before Migrating Adapter Services

About this task

To prepare to migrate adapter services created with IBM webMethods Adapter 7.1 SP1 for Salesforce.

Procedure

Back up the package containing the create, update, and upsert adapter services that you want to migrate.
Make sure that none of the create, update, or upsert services is running, either directly or in a flow service.
Make sure that IS_8.2_SP2_Core_Fix5 or later is installed on the host Integration Server.

Important: If IS_8.2_SP2_Core_Fix5 or later is not installed on the host Integration Server, the migration service will not work.

Migrating earlier versions of Adapter Services to the latest

About this task

To migrate create, update, and upsert adapter services created with IBM webMethods Adapter 7.1 SP1 for Salesforce.

Procedure

Upgrade to IBM webMethods Adapter 8.2 for Salesforce. For information about the upgrade steps, see Upgrading to IBM webMethods Adapter 8.2 for Salesforce.
In Designer, run the wm.adapter.wmsalesforce.migration.Service:migrate_711_To_82 service. For information about the service parameters, see Migrating Adapter Services Created with IBM webMethods Adapter 7.1 SP1 for Salesforce.

Results

At the end of the migration, the migration service reloads the custom package containing the create, update, and upsert adapter services, as well as any packages containing flow services that were modified during the migration.

If after running the migration service, you still have old adapter connections, you can migrate them by modifying the Endpoint URL for the connections in Integration Server Administrator to https://login.salesforce.com/services/Soap/u/25.0.

Uninstalling the adapter

About this task

To uninstall the adapter:

Procedure

Shut down the host Integration Server. You do not need to shut down any other webMethods products or applications that are running on your machine.
Start IBM webMethods Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > webMethods Adapter 8.2 for Salesforce. You can also choose to uninstall documentation.
After Uninstaller completes, restart the host Integration Server.
Uninstaller removes all Adapter for Salesforce related files that were installed. However, it does not delete files created after you installed the adapter (for example, user-created or configuration files), nor does it delete the adapter directory structure. You can go to the Integration Server_directory\packages directory and delete the WmSalesforceAdapter directory.