| title | Copy data from Oracle Service Cloud (Preview) | ||
|---|---|---|---|
| description | Learn how to copy data from Oracle Service Cloud to supported sink data stores using a copy activity in an Azure Data Factory or Synapse Analytics pipeline. | ||
| titleSuffix | Azure Data Factory & Azure Synapse | ||
| ms.author | jianleishen | ||
| author | jianleishen | ||
| ms.subservice | data-movement | ||
| ms.topic | how-to | ||
| ms.date | 01/26/2025 | ||
| ms.custom |
|
[!INCLUDEappliesto-adf-asa-md]
Important
This connector is at End of Support stage. You are recommended to migrate to ODBC connector by installing a driver.
This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Oracle Service Cloud. It builds on the copy activity overview article that presents a general overview of copy activity.
This Oracle Service Cloud connector is supported for the following capabilities:
| Supported capabilities | IR |
|---|---|
| Copy activity (source/-) | ① ② |
| Lookup activity | ① ② |
① Azure integration runtime ② Self-hosted integration runtime
For a list of data stores that are supported as sources/sinks, see the Supported data stores table.
The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.
[!INCLUDE data-factory-v2-connector-get-started]
Use the following steps to create a linked service to Oracle Service Cloud in the Azure portal UI.
-
Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:
:::image type="content" source="media/doc-common-process/new-linked-service.png" alt-text="Create a new linked service with Azure Data Factory UI.":::
:::image type="content" source="media/doc-common-process/new-linked-service-synapse.png" alt-text="Create a new linked service with Azure Synapse UI.":::
-
Search for Oracle and select the Oracle Service Cloud connector.
:::image type="content" source="media/connector-oracle-service-cloud/oracle-service-cloud-connector.png" alt-text="Select the Oracle Service Cloud connector.":::
-
Configure the service details, test the connection, and create the new linked service.
:::image type="content" source="media/connector-oracle-service-cloud/configure-oracle-service-cloud-linked-service.png" alt-text="Configure a linked service to Oracle Service Cloud.":::
The following sections provide details about properties that are used to define Data Factory entities specific to Oracle Service Cloud connector.
The following properties are supported for Oracle Service Cloud linked service:
| Property | Description | Required |
|---|---|---|
| type | The type property must be set to: OracleServiceCloud | Yes |
| host | The URL of the Oracle Service Cloud instance. | Yes |
| username | The user name that you use to access Oracle Service Cloud server. | Yes |
| password | The password corresponding to the user name that you provided in the username key. You can choose to mark this field as a SecureString to store it securely in the service, or store password in Azure Key Vault and let the service copy activity pull from there when performing data copy - learn more from Store credentials in Key Vault. | Yes |
| useEncryptedEndpoints | Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. | No |
| useHostVerification | Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over TLS. The default value is true. | No |
| usePeerVerification | Specifies whether to verify the identity of the server when connecting over TLS. The default value is true. | No |
Example:
{
"name": "OracleServiceCloudLinkedService",
"properties": {
"type": "OracleServiceCloud",
"typeProperties": {
"host" : "<host>",
"username" : "<username>",
"password": {
"type": "SecureString",
"value": "<password>"
},
"useEncryptedEndpoints" : true,
"useHostVerification" : true,
"usePeerVerification" : true,
}
}
}
For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by Oracle Service Cloud dataset.
To copy data from Oracle Service Cloud, set the type property of the dataset to OracleServiceCloudObject. The following properties are supported:
| Property | Description | Required |
|---|---|---|
| type | The type property of the dataset must be set to: OracleServiceCloudObject | Yes |
| tableName | Name of the table. | No (if "query" in activity source is specified) |
Example
{
"name": "OracleServiceCloudDataset",
"properties": {
"type": "OracleServiceCloudObject",
"typeProperties": {},
"schema": [],
"linkedServiceName": {
"referenceName": "<OracleServiceCloud linked service name>",
"type": "LinkedServiceReference"
}
}
}
For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by Oracle Service Cloud source.
To copy data from Oracle Service Cloud, set the source type in the copy activity to OracleServiceCloudSource. The following properties are supported in the copy activity source section:
| Property | Description | Required |
|---|---|---|
| type | The type property of the copy activity source must be set to: OracleServiceCloudSource | Yes |
| query | Use the custom SQL query to read data. For example: "SELECT * FROM MyTable". |
No (if "tableName" in dataset is specified) |
Example:
"activities":[
{
"name": "CopyFromOracleServiceCloud",
"type": "Copy",
"inputs": [
{
"referenceName": "<OracleServiceCloud input dataset name>",
"type": "DatasetReference"
}
],
"outputs": [
{
"referenceName": "<output dataset name>",
"type": "DatasetReference"
}
],
"typeProperties": {
"source": {
"type": "OracleServiceCloudSource",
"query": "SELECT * FROM MyTable"
},
"sink": {
"type": "<sink type>"
}
}
}
]To learn details about the properties, check Lookup activity.
For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.