Oracle Commerce Cloud Connection¶

Introduction¶

An Oracle Commerce Cloud connection, created using the Oracle Commerce Cloud connector, establishes access to Oracle Commerce Cloud. Once a connection is configured, you can create instances of Oracle Commerce Cloud activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Note

This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Endpoint in this connection requires users to re-enter the API Token for the connection.

Create or Edit an Oracle Commerce Cloud Connection¶

A new Oracle Commerce Cloud connection is created using the Oracle Commerce Cloud connector from one of these locations:

The design component palette's Connections tab (see Design Component Palette).
The Global Connections page (see Create a Global Connection in Global Connections).

An existing Oracle Commerce Cloud connection can be edited from these locations:

The design component palette's Connections tab (see Design Component Palette).
The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
The Global Connections page (see Edit a Global Connection in Global Connections).

Configure an Oracle Commerce Cloud Connection¶

Each user interface element of the Oracle Commerce Cloud connection configuration screen is described below.

Oracle Commerce Cloud connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Connection Name: Enter a name to use to identify the connection. The name must be unique for each Oracle Commerce Cloud connection and must not contain forward slashes / or colons :. This name is also used to identify the Oracle Commerce Cloud endpoint, which refers to both a specific connection and its activities.
API Token: Enter the API token generated in the Oracle Commerce Cloud dashboard.
Endpoint: Enter the base URL for the API endpoint. The base URL is located in the Oracle Commerce Cloud environment and has this URL structure:

<subdomain>.<domain>.com:<port>/<resource-path>
Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
Save Changes: Click to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After an Oracle Commerce Cloud connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

Search: Queries object data in Oracle Commerce Cloud and is intended to be used as a source in an operation.
Read: Retrieves object data from Oracle Commerce Cloud and is intended to be used as a source in an operation.
Create: Creates object data in Oracle Commerce Cloud and is intended to be used as a target in an operation.
Update: Updates existing object data in Oracle Commerce Cloud and is intended to be used as a target in an operation.
Delete: Deletes object data from Oracle Commerce Cloud and is intended to be used as a target in an operation.