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. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for My Domain in the Quick Find box, then select My Domain.
  4. Under My Domain Settings, your custom domain name appears in the Your domain name is field.

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 Security Policy

To use the Salesforce Username Password security policy, 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 username, 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 Salesforce OAuth Three-Legged (Authorization Code Credentials) or Resource Owner Password Credentials Security Policy

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

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 Apps in the Quick Find box, then select Apps under Create.
  4. In the Connected Apps section, click New. The New Connected App page appears.
  5. In the Basic Information section, enter your basic information details, and select the Enable OAuth Settings checkbox in the API section.
  6. In the Callback URL field, enter the fully qualified domain name of your server using the HTTPS protocol, and add the following text to the URL: agent/oauth/callback.
    For example:
    https://www.your_server.com/agent/oauth/callback
  7. From the Available OAuth Scopes list, add the following scopes toSelected OAuth Scopes:
    • Access and manage your data (api)
    • Access your basic information (id)
    • Perform requests on your behalf at any time (refresh_token)

    Note:

    These are the minimum scopes required to configure the Salesforce OAuth Three-Legged security policy for your Salesforce Adapter connection. For the Resource Owner Password Credentials security policy, api and id are the minimum scopes required.
  8. Click Save, and then click Continue. Once the application is saved, Salesforce populates the API section with the following IDs:
    • Consumer key (Client ID)
    • Consumer secret (Client secret)

    Note:

Prerequisites to Use Platform Events

Perform the following prerequisites to use platform events.

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.

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:

New workflow rules are blocked in the Salesforce application as of the Winter 2023 release. New workflow rules cannot be created in Salesforce. However, you can activate, deactivate, and edit existing workflow rules.

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.

Use Outbound Messaging with a Workflow

Perform the following prerequisite to use outbound messaging.

Generate the Salesforce Adapter Outbound Messaging WSDL

You can generate an outbound messaging WSDL for the Salesforce Adapter to receive outbound message notifications from the Salesforce application. You then select this WSDL when configuring the Salesforce Adapter as a trigger on the Outbound Messaging page of the Adapter Endpoint Configuration Wizard.

This process consists of several steps. You must first create a workflow rule and generate an outbound messaging WSDL. The outbound message consists of a workflow, approval, or milestone action that sends your specified information to your specified endpoint. You configure outbound messaging in the Salesforce setup menu. Afterward, you configure the endpoint.

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 create a workflow rule:

  1. Log in to your Salesforce account.

  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search Workflow in the Quick Find box.
  4. Click Workflow Rules under Workflow & Approvals in the Build section.

  5. Click New Rule.

  6. Select an object and click Next.

  7. Enter a rule name, select an evaluation and rule criteria, and click Save & Next.

  8. Click Add Workflow Action and select New Outbound Message or Select Existing Action (if you already have the outbound message).

  9. Provide the required information in the wizards and click Save.
    1. Enter a name, description for this outbound message, and endpoint URL, and select the fields you want included in the outbound message.

      Note:

      You can enter a dummy URL in the Endpoint URL field. For example:
      https://test.com
    2. Click Add.
Outbound messaging WSDLs associated with approval processes or entitlement processes are also supported and consumed by the Salesforce Adapter.
  1. Generate the Salesforce outbound messaging WSDL at www.salesforce.com. You then select this WSDL to receive outbound message notifications from the Salesforce application on the Outbound Messaging page in the Adapter Endpoint Configuration Wizard. See Trigger Outbound Messaging Page.

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 generate the Salesforce outbound messaging WSDL:

  1. Log in to your Salesforce account.
  2. Click Setup in the header or click your username, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search Outbound Messages in the Quick Find box.
  4. Click Outbound Messages under Workflow & Approvals in the Build section.
  5. Select the required outbound message.
  6. Click Click for WSDL to download the outbound messaging WSDL.
  7. Drag the Salesforce Adapter to the trigger (inbound) section of the integration canvas. This invokes the Adapter Endpoint Configuration Wizard.
  8. Browse for the generated WSDL on the Outbound Messaging page.
  9. Activate the integration and copy the endpoint URL from the integration information icon.
  10. Select the required outbound message.
  11. Click Edit.
  12. Replace the dummy URL with the activated integration endpoint URL in the Endpoint URL field. You entered the dummy URL when configuring your outbound message.

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.