Oracle Sales Cloud

The Oracle Sales Cloud connector lets you perform insert, delete, update, and read operations on Oracle Sales Cloud data.

Supported versions

The following is the minimum supported version for this connector: Oracle Sales Cloud 24D (11.13.24.10.0)

Before you begin

In your Google Cloud project, do the following tasks:

Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
Grant the roles/connectors.admin IAM role to the user configuring the connector.
Grant the roles/secretmanager.viewer and roles/secretmanager.secretAccessor IAM roles to the service account that you want to use for the connector.
Enable the following services:
- secretmanager.googleapis.com (Secret Manager API)
- connectors.googleapis.com (Connectors API)
To understand how to enable services, see Enabling services. If these services or permissions have not been enabled for your project previously, you are prompted to enable them when you configure the connector.

Configure the connector

A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:

In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
Go to the Connections page
Click + CREATE NEW to open the Create Connection page.
In the Location section, choose the location for the connection.
1. Region: Select a location from the drop-down list.
  For the list of all the supported regions, see Locations.
2. Click NEXT.
In the Connection Details section, complete the following:
1. Connector: Select Oracle Sales Cloud from the drop down list of available Connectors.
2. Connector version: Select the Connector version from the drop down list of available versions.
3. In the Connection Name field, enter a name for the Connection instance.
  Connection names must meet the following criteria:
  - Connection names can use letters, numbers, or hyphens.
  - Letters must be lower-case.
  - Connection names must begin with a letter and end with a letter or number.
  - Connection names cannot exceed 63 characters.
4. Optionally, enter a Description for the connection instance.
5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
6. Service Account: Select a service account that has the required roles.
7. Optionally, configure the Connection node settings:
  - Minimum number of nodes: Enter the minimum number of connection nodes.
  - Maximum number of nodes: Enter the maximum number of connection nodes.
  A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
8. Expand Fields: The field parameter filters the resource attributes. When running SELECT * queries, if this field is set to true, only the specified attributes are returned.
9. Include Custom Objects: Specifies whether custom objects are dynamically retrieved. If this property is set to false, custom tables will not be displayed.
10. Connection Timeout: Specifies the connection timeout in seconds.
11. Generate Schema Files: Specifies when to generate and save the schemas. You can choose one of the following options:
  - Never: Never generates schema files.
  - OnUse: Generates the schema file when a table is referenced for the first time and the schema file doesn't exist.
  - OnStart: Generates the schema file for tables that don't have a schema file when the connection is created.
  - OnCreate: Generates the schema file when a CREATE TABLE SQL query is run.
12. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
13. Click NEXT.
In the Destinations section, enter details of the remote host (backend system) you want to connect to.
1. Destination Type: Select a Destination Type.
  - Select Host address from the list to specify the hostname or IP address of the destination.
  - If you want to establish a private connection to your backend systems, select Endpoint attachment from the list, and then select the required endpoint attachment from the Endpoint Attachment list.
    Note: To understand how to create an endpoint attachment, see PSC service attachment and endpoint attachment. After you have created the endpoint attachment, it will be visible in the Endpoint Attachment list.
  If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.
  
  To enter additional destinations, click +ADD DESTINATION.
2. Click NEXT.
In the Authentication section, enter the authentication details.
1. Select an Authentication type and enter the relevant details.
  The following authentication types are supported by the Oracle Sales Cloud connection:
  - Username and password
2. Click NEXT.
Review: Review your connection and authentication details.
Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

Username and password
- Username: Username for connector
- Password: Secret Manager Secret containing the password associated with the connector.
- Secret version: Secret version for the secret selected above.

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

Field name	Details
Location	europe-west1
Connector	Oracle Sales Cloud
Connector version	1
Connection Name	oracle-sales-new
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Minimum number of nodes	2
Maximum number of nodes	50
Destination Type	Host address
host1	https://iaaptz.fa.ocs.oraclecloud.com//td>
Username	OracleSalesCloudUser
Password	PASSWORD
Secret Version	1

System limitations

The Oracle Sales Cloud connector can process a maximum of 10 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Use the Oracle Sales Cloud connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Entity operation examples

This section provides examples of how to perform the entity operations in this connector.

Example - List all opportunities

In the Configure connector task dialog, click Entities.
Select Opportunities from the Entity list.
Select the List operation, and then click Done.

You must use the List operation with filter clause in entities where more than one key is required to retrieve a single record.

Example - Get contacts

In the Configure connector task dialog, click Entities.
Select Contacts from the Entity list.
Select the Get operation, and then click Done.
Set the entity ID to Contacts. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter 3046 in the Input Value field and choose the EntityId as Local variable.

You must use the Get operation with filter clause in entities where more than one key is required to retrieve a single record.

Example - Delete opportunities

In the Configure connector task dialog, click Entities.
Select Opportunities from the Entity list.
Select the Delete operation, and then click Done.
Set the entity ID to Delete Opportunities. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter 203002 in the Input Value field and choose the EntityId as Local variable.
You must use the Delete operation with filter clause in entities where more than one key is required to retrieve a single record.

Example - Create contacts

In the Configure connector task dialog, click Entities.
Select Contacts from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
 { "FirstName": "Googlecloud2", "LastName": "TestCreate3" }
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "PartyNumber": "807006" }
```

Example - Create contact addresses

In the Configure connector task dialog, click Entities.
Select ContactAddresses from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
{ "City": "CreatingAddGooglecloud", "State": "France", "Country": "FR", "Address1": "Googlecloud Contact Address 1", "PartyNumber": "3046" }
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "AddressNumber": "411001", "PartyNumber": "3046" }
```

Example - Create accounts

In the Configure connector task dialog, click Entities.
Select Accounts from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
{ "OrganizationName": "Test Account7Googlecloud", "AddressLine1": "E-City", "City": "Paris", "Country": "FR" }
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "PartyNumber": "804006" }
```

Example - Create opportunities

In the Configure connector task dialog, click Entities.
Select Opportunities from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
{ "Name": "OpportunityGooglecloud1" } 
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "OptyNumber": "203001" }
```

Example - Create activity assignee

In the Configure connector task dialog, click Entities.
Select ActivityAssignee from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
{ "ActivityId": 300000010836710, "AssigneeId": 300000001962681, "ActivityNumber": "212380" }
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "ActivityAssigneeId": 300000014424799 }
```

Example - Create activity contact

In the Configure connector task dialog, click Entities.
Select ActivityContact from the Entity list.
Select the Create operation, and then click Done.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
{ "ActivityNumber": "212544", "ContactId": 100000001886382 }
```
Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:
```
{ "ActivityContactId": 300000014968493 }
```

Example - Update opportunities

In the Configure connector task dialog, click Entities.
Select Opportunities from the Entity list.
Select the Update operation, and then click Done.
Set the EntityID to Opportunities. To set the EntityID, in the Data mapper section of the Tasks, click EntityID and then enter 5 in the given field.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
 { "Name": "Updated Googlecloud Opportunity again" }
```

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

{ "OptyNumber": "150364" }

Example - Update accounts

In the Configure connector task dialog, click Entities.
Select Accounts from the Entity list.
Select the Update operation, and then click Done.
Set the EntityID to Accounts. To set the EntityID, in the Data mapper section of the Tasks, click EntityID and then enter 804006 in the given field.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
 { "OrganizationName": "updated Test Account7Googlecloud" }
```

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

{ "PartyNumber": "804006" }

Example - Update activities

In the Configure connector task dialog, click Entities.
Select Activities from the Entity list.
Select the Update operation, and then click Done.
Set the EntityID to Activities. To set the EntityID, in the Data mapper section of the Tasks, click EntityID and then enter 201001 in the given field.

In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

{ "ActivityFunctionCode": "APPOINTMENT", "ActivityStartDate": "2025-05-27 07:10:23", "ActivityEndDate": "2025-05-27 08:10:23" }

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

{ "ActivityNumber": "201001" }

Example - Update contacts

In the Configure connector task dialog, click Entities.
Select Contacts from the Entity list.
Select the Update operation, and then click Done.
Set the EntityID to Contacts. To set the EntityID, in the Data mapper section of the Tasks, click EntityID and then enter 59 in the given field.
In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:
```
  { "FirstName": "GooglecloudUpdated2", "LastName": "Testlatency3" }
```

Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

 { "PartyNumber": "807004" }

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
expand_fields	BOOLEAN	False	Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.
include_custom_objects	BOOLEAN	False	Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.
generate_schema_files	ENUM	False	Indicates the user preference as to when schemas should be generated and saved. Supported values are: Never, OnUse, OnStart, OnCreate
proxy_enabled	BOOLEAN	False	Specifies whether to configure a proxy server for the connection.
proxy_auth_scheme	ENUM	False	The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user	STRING	False	A user name to be used to authenticate to the ProxyServer proxy.
proxy_password	SECRET	False	A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype	ENUM	False	The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

Understand how to suspend and resume a connection.
Understand how to monitor connector usage.
Understand how to view connector logs.