Prerequisites for Creating a Connection

You must satisfy the following prerequisites to create a connection with the Salesforce Adapter.

Prerequisites for Oracle Integration Release 20.2.2.0.0 (200524.0200.35760) or Later

When you create or edit your Salesforce Adapter connection on release 20.2.2.0.0 (200524.0200.35760) or later of Oracle Integration, you must specify the following details on the Connections page. Therefore, you must obtain the following details before creating or editing a connection.

Topics:

Identify the Instance Type of Your Salesforce Organization

Follow these methods to identify your instance type:

Obtain the Custom Domain Name

When you create your Salesforce Adapter connection on the Connections page, you must specify your custom domain name.

Note:

The steps provided here apply to the Salesforce Classic UI. If you are using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.

To obtain the custom domain name:

  1. Log in to the Salesforce sandbox or production instance.
  2. After logging in, view the URL in the browser. Your domain name appears between https:// and my.salesforce.com.
    You need this domain name when establishing a connection. See Configure Connection Properties.

Find Your Current Salesforce API Version

You can find your current Salesforce API version in the enterprise WSDL.

Note:

The steps provided here apply to the Salesforce Classic UI. If you're using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.

To find your current Salesforce API version.

  1. Log in to the Salesforce sandbox or production instance.
  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for API in the Quick Find box, then select API under Develop.
  4. Click Generate Enterprise WSDL.
  5. On the Generate Enterprise WSDL page, click Generate.
    The WSDL opens in a new browser tab and your current API version appears in the Commented-out section. For example:
    Salesforce.com Enterprise Web Services API Version 35.0

Prerequisite for Oracle Integration Releases Earlier Than 20.2.2.0.0

Perform the following prerequisite for Oracle Integration releases earlier Than 20.2.2.0.0.

Generate the Salesforce Enterprise WSDL

If you edit an existing connection created prior to release 20.2.2.0.0 (200524.0200.35760) of Oracle Integration, you must upload an enterprise WSDL to use in an integration.

You must generate the Salesforce enterprise WSDL, then upload this WSDL on the Connections page when creating a Salesforce Adapter connection.

Note:

The steps provided here apply to the Salesforce Classic UI. If you're using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.

To generate the Salesforce Adapter enterprise WSDL:

  1. Log in to your Enterprise, Unlimited, or Developer Edition Salesforce.com account.

  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for API in the Quick Find box, then select API under Develop.

  4. If the organization has managed packages installed in the organization, click Generate Enterprise WSDL. Salesforce prompts you to select the version of each installed package to include in the generated WSDL or right-click Generate Enterprise WSDL and save it to a local directory.

    In the right-click menu, Microsoft Edge/Google Chrome users can select Save link as, while Mozilla Firefox users can select Save Link As to save it to the local directory.

    The Save dialog is displayed.

  5. Provide a name for the WSDL file and a location to save the file on your file system, and click Save. For information about uploading this WSDL when creating a connection, see Configure Connection Properties.

Prerequisites to Use the Salesforce Username Password Policy (Deprecated)

To use the Salesforce Username Password policy (Deprecated), you must create a user account in Salesforce.com.

  1. Create an API-enabled profile. You assign this profile to the user account you subsequently create for Oracle Integration. See Create a Secure Salesforce API User.
  2. Create a user account in Salesforce for Oracle Integration. See Add a Single User.
    Once the user account is created, a verification email is sent to the email address you provided for the account.
  3. Log in to the corresponding email account and click Verify Account in the email message from Salesforce.

    You are redirected to the Salesforce instance to set a password for the new user account.

    Note:

    You use the credentials of this user account when configuring the Salesforce connection in Oracle Integration.
  4. Set a password and copy this value.

    You're subsequently signed in to the Salesforce instance with the new account.

    You'll need to enter these values on the Connections page when you configure the Salesforce Username Password security policy for your Salesforce Adapter connection in Oracle Integration. See Configure Connection Security.

  5. Generate a security token.

    Generate a security token for the new user account. You'll need this security token along with the password to access Salesforce using Oracle Integration.

    Stay signed in as the new user, and click the user name at the top of the page to open a menu.

    Note:

    The steps provided here apply to the Salesforce Classic UI. If you're using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.
    1. Click My Settings in the menu or click the user name, then select My Settings.
    2. On the My Settings page, in the Quick Links section, click Edit my personal information.
    3. On the resulting page, click Reset My Security Token in the left navigation pane.
    4. Click Reset Security Token.
      A new security token is sent to the email address associated with the account.
    5. Copy the security token.

Prerequisites to Use the Resource Owner Password Credentials Security Policy

To use the Resource Owner Password Credentials security policy, you must create a connected application in Salesforce.com.

Note:

  1. Log in to your Enterprise, Unlimited, or Developer Edition Salesforce.com account.
  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Apps in the Quick Find box, then select Apps under Create.
  4. Go to the API section, and browse for your existing connected app.
  5. Under Enable Oauth Settings, click Manager Consumer Details.
  6. In the Verify your Identity window that appears, enter the verification code sent to your registered email ID or phone number.
  7. Copy the values for consumer key (client ID) and consumer secret (client secret).

Note:

Configure the OAuth – External Client App in Salesforce

Follow these steps to configure the OAuth - external client app.

  1. Log in to your Salesforce account (Enterprise, Unlimited, or Developer Edition) and switch to Lightning Experience.
  2. Click Setup (gear icon in the header).
  3. In the Quick Find field, search for External Client App.
  4. Select External Client App Manager.
  5. Click New External Client App.
  6. On the New External Client App page, enter the required details under Basic Information, and enable OAuth Settings.
  7. Configure the OAuth settings.
    1. Obtain the client ID and client secret from Consumer Key and Secret.
    2. Enter the callback URL: 
      https://your_server/icsapis/agent/oauth/callback
    3. Select the following OAuth scopes:
      • Access and manage your data (api)
      • Access your basic information (id)
      • Perform requests on your behalf at any time (refresh_token)
      These scopes (api, id, and refresh_token) are the minimum required to configure a connection in Oracle Integration using the OAuth 2.0 Authorization Code Credentials security policy.
  8. Enable Authorization Code and Credentials Flow.
  9. Configure the security settings as follows:
    1. Enable Require secret for Web Server Flow.
    2. Enable Require secret for Refresh Token Flow.
    3. Ensure PKCE is disabled (unchecked).
  10. Click Save and Continue to save the configuration.

Obtain the Client ID and Client Secret

Follow these steps to retrieve the client ID (consumer key) and client secret from Salesforce.

  1. Log in to your Salesforce account (Enterprise, Unlimited, or Developer Edition) and switch to Lightning Experience.
  2. Click Setup (gear icon in the header).
  3. In the Quick Find field, search for External Client App.

    Note:

    If you do not have an external client app, you can create one. See Configuring OAuth – External Client App in Salesforce.
  4. Select External Client App Manager.
  5. From the list, select your external client app.
  6. Go to the Settings tab.
  7. Under App Settings, click Consumer Key and Secret.
  8. Copy the client ID (consumer key) and client secret.

Create an External Client App from a Connected App

Use the automated process to create external client apps that replace your existing locally connected apps. After migration, the old, connected app remains as a read-only version in App Manager.

  1. From Setup, in the Quick Find box, enter App Manager.
  2. Select App Manager.
  3. Open the connected app by clicking the name. If the connected app is eligible for migration, the Migrate to External Client App button is available.
  4. Click Migrate to External Client App.
  5. Confirm that the app is local and that it doesn’t use the user name-password flow.
  6. Click Migrate.
    A window opens with a link to the new external client app.

Prerequisites to Use Platform Events

Perform the following prerequisites to use platform events.

Topics:

Define Your Platform Event

To receive notifications using platform events, you must define the platform event. The list of platform events you defined in Salesforce.com is displayed for use on the Streaming API page of the Adapter Endpoint Configuration Wizard when configuring the Salesforce Adapter as a trigger connection.

Note:

The steps provided here apply to the Salesforce Classic UI. If you are using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.
  1. Log in to your Enterprise, Unlimited, or Developer Edition Salesforce.com account.
  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Platform Events in the Quick Find box, then select Platform Events.
  4. Click New Platform Event.
  5. Enter the required details, and click Save.
  6. To add a field, click New in the Custom Fields & Relationships section.
  7. Select the field type, and click Next.
  8. Enter the required details, and click Save. A new custom field is added.
    Additional information about platform events is provided. See Define and Manage Platform Events.

Publish Platform Events

After a platform event is defined, you must publish event messages from a Salesforce application.

Note:

See Publishing Platform Events.

Prerequisite to Use Change Data Capture (CDC) Events

Perform the following prerequisite to use change data capture (CDC) events.

Select an Entity (Business Object)

To receive notifications using change data capture (CDC) events, you must select the entity/entities. Once selected, these objects are displayed for use on the Operations page of the Adapter Endpoint Configuration Wizard when configuring the Salesforce Adapter as a trigger connection.

Note:

The steps provided here apply to the Salesforce Classic UI. If you are using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.
  1. Log in to your Enterprise, Unlimited, or Developer Edition Salesforce.com account.
  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Change Data Capture in the Quick Find box, then select Change Data Capture.
  4. Select the required entities (business objects) for which you want to receive change event notifications.
  5. Click Save.

Prerequisite to Use Outbound Messaging

To use outbound messaging, perform the following prerequisites.

Note:

Salesforce is retiring workflow rules beginning December 31, 2025. Therefore, you cannot create, edit, activate, or deactivate workflows in Salesforce. You are advised to create a new flow or migrate from workflow rules to flows. See Salesforce Workflow Rules & Process Builder End of Support.

Use Outbound Messaging with a Flow

To use outbound messaging with a flow, follow these instructions.

Note:

Create the Salesforce Outbound Message

  1. Log in to your Salesforce account.
  2. Click Setup in the header or click your user name, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Outbound Messages in the Quick Find box.
  4. Click Outbound Messages under Workflow & Approvals in the Build section.
  5. Select an object.
  6. Enter the required details.
  7. Click Save.

Develop a Flow in Salesforce

  1. Log in to your Salesforce account.
  2. Click Setup in the header or click your user name, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Flows in the Quick Find box.
  4. Select Flows under Workflow & Approvals in the Build section.


    Flows appears in the Search field. Below is the Administer section, which includes Security Flows. Login Flows is entered in a field. Below is the Build section, with Create and then Workflow & Approvals section. Flows appears in a field below this. To the right is the Flows section. In the View field, All Flows is selected. Edit and Create New View links appear to the right. A table with fields for Flow Label, Description, and Last Modified appears below this.

  5. Click New Flow.
  6. Select Record-Triggered Flow.
  7. Click Create. The Configure Start page appears.
  8. Select an object.
  9. Set the trigger criteria.

    The Configure Start page shows the Select Object section, which includes the Object search field. Below this is the Configure Trigger section, which includes the label Trigger the Flow When and its options: A record is created, A record is updated, A record is created or updated, and A record is deleted. Below this is the Set Entry Conditions section.

  10. Select the condition requirement in the Condition Requirements field. You click add condition to add an element.


    The Configure Start page shows the Condition Requirements list at the top. All Conditions Are Met (And) is selected. To the right is the New label and Formulas for Conditions. Below is the Field search box, the Operator list, and the Value search box. Below is the Add Condition button. Below is the When to Run the Flow for Updated Records section, with two selections: 1) Every time a record is updated and meets the condition requirements and 2) Only when a record is updated to meet the condition requirements. Below this is the Optimize the Flows for section, with selections for Fast Field Updates and Actions and Related Records.

  11. Select Actions and Related Records.
  12. Click Done.
  13. Click the + icon.


    Start Record-Trigger Flow shows a message with values for Object, Trigger, Conditions, and Optimize for. Below are two selections: 1) Add Scheduled Paths (Optional) and 2) Open Flow Trigger Explorer for Account.

  14. Select Action from Add Element.


    Record-Trigger Flow shows a start button, Run Immediately label, and close icon. Below is the Add Element option, which includes sections for Shortcuts (with Update Triggering Record and Update fields on the triggering record), Interaction (with Action, Perform an action outside of the flow, Subflow, and Launch another flow that's available), and Logic.

  15. Click Outbound message.
  16. Select the outbound message that you created.


    The New Action page shows the Filter By list on the left. Category is selected. Below is a list of options, with Outbound Message (the second in the list) selected. On the right, Account is being entered in the Action list. Entries with the word Account are displayed below.

  17. Enter a label name of the outbound message.


    The New Action page shows the Filter By list on the left. Category is selected. Below is a list of options, with Outbound Message (the second in the list) selected. On the right, Account is entered in the Action list. Below are fields for Label, API Name, and Description.

  18. Click Done and click Save.
  19. Enter a flow name and click Save.
  20. Click Save and click Activate.

Migrate an Existing Workflow Rule to a Flow

Perform the following steps to migrate an existing workflow rule to a flow.

  1. Log in to your Salesforce account.

  2. Click Setup in the header or click your user name, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for Workflow & Approvals in the Quick Find box.
  4. In the Build section, click Migrate to Flow under Workflow & Approvals.


    In the left navigation pane, Workflow & Approvals is expanded and Migrate to Flow is selected. The Migrate to Flow page is shown. A table is shown with columns for Name, Type, Object, Status, and Resulting Flow.

  5. Select the outbound message to be migrated.
  6. Click Migrate to Flow.


    In the left navigation pane, Workflow & Approvals is expanded and Migrate to Flow is selected. The Migrate to Flow page is shown and the Migrate to Flow button is enabled. A table is shown with columns for Name, Type, Object, Status, and Resulting Flow.

  7. Once migrated, click Switch Activations to activate the migrated flow.


    The Migration details page shows Step 1: Test the Flow. Below this is the Test in Flow Builder. Next to this is the Autolaunched Flow text and a status button labeled Inactive. Below this is Step 2: Activate the Flow. The Switch Activations button is shown. The Close button is at the bottom.

    Workflow rules have now been migrated to a flow.


    The Migration details page shows Step 1: Test the Flow. Below this is the View in Flow Builder. Next to this is the Autolaunched Flow text and a status button labeled Active. The Close button is at the bottom.

Prerequisite to Use Apex Web Services

Perform the following prerequisite to use Apex web services.

Generate the Salesforce Adapter Custom WSDL

You can generate a custom WSDL that includes custom Apex classes written on force.com and exposed as SOAP web services. This enables external applications to access your code and application.

You select the custom WSDL for the Invoke Apex Web Services option when configuring the Salesforce Adapter in the invoke direction. See Invoke Apex Operations Page.

For more information about custom WSDLs, see Exposing Apex Methods as SOAP Web Services.