Oracle Marketing Cloud SSIS Components

Using the Oracle Marketing Cloud Destination Component

The Oracle Marketing Cloud Destination Component is an SSIS data flow pipeline component that can be used to write data to Oracle Marketing Cloud. You can Create, Update, Upsert, or Delete objects with this component. There are three pages of configuration:

• General
• Columns
• Error Handling

The General page is used to specify general settings for the Oracle Marketing Cloud Destination Component. The Columns page allows you to map the columns from upstream components to Oracle Marketing Cloud fields in the destination object. The Error Handling page allows you to specify how errors should be handled when they occur.

General page

The General page allows you to specify general settings for the component.

Connection Manager

The Oracle Marketing Cloud Destination Component requires an Oracle Marketing Cloud connection. The Connection Manager option will show all Oracle Marketing Cloud connection managers that have been created in the current SSIS package or project.

Destination Object

The Destination Object option allows you to specify which object to write data to. A drop-down with the available objects is listed here.

Bulk API

Use Bulk API option dictates whether you want to use Eloqua Bulk API to write to your Eloqua system. By default, this option is not selected.

Note: This option will only be available to Upsert action to Account, Contact, and Custom objects.

Action

The Action option allows you to specify how data should be written to Oracle Marketing Cloud. There are currently three (3) supported action types available but not every object supports every action. Available actions include:

• Create: Create new record(s).
• Update: Update existing record(s). The primary field is required.
• Upsert: Update any existing record(s) in Eloqua if matching can be found, otherwise create a new record with the information from the upstream pipeline components.
• Delete: Deletes record(s). The primary field is required.

Input Timezone

The Input Timezone option specifies the timezone of all incoming datetime fields. This will indicate whether the datetime fields should be converted from the Local Time or kept in UTC format when writing to the Oracle Marketing Cloud server.

Batch Size

The Batch Size lets you specify how many records to send per service call to Marketing Cloud when Bulk API is enabled.

Polling Throttle Rate (minutes)

The Polling Throttle Rate determines the frequency rate to poll the status of the job to determine if it has been completed.

Note: This option will only be available when the Bulk API option is enabled.

Update Multiple Matched Records

Use the Update Multiple Matched Records option to specify whether or not imported data will be mapped to multiple existing records when Bulk API is enabled.

Child Object Settings

The Child Object Settings grid lists all available secondary inputs and allows them to be mapped to child objects of the destination object.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each attribute to its most recent metadata.

Map Unmapped Fields Button

By clicking this button, the component will try to map any unmapped Oracle Marketing Cloud attributes by matching their names with the input columns from upstream components. This is useful when your source component has recently added more columns, in which case you can use this button to automatically establish the association between input columns and unmapped destination attributes.

Clear All Mappings Button

By clicking this button, the component will reset all your mappings in the destination component.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamics update of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Columns Page

The Columns page of the Oracle Marketing Cloud Destination Component allows you to map the columns from upstream components to destination attributes.

Select Input: The select input dropdown allows you to select which input will be displayed in the mapping grid, either the primary input or one of the secondary inputs. Primary input will have a field called _LinkId which is matched a field called _ParentLinkId in each secondary child input.

On the Columns page, you would see a grid that contains four columns as shown below.

• Input Column: You can select an input column from an upstream component here.
• Oracle Eloqua Field: The Oracle Marketing Cloud field that you are writing data.
• Data Type: This column indicates the type of value for the current field.
• Unmap: This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.

Advanced Page

The Advanced page allows you to specify additional settings for Bulk Writing action in destination.

Bulk Date Field Time Zone

The Bulk Date Field Time Zone option specifies the timezone of all incoming datetime fields.

Additional Bulk Settings

The Additional Bulk Settings grid allows you to specify the details of the bulk import definition.

Sync Action(since v21.2)

The Sync Action grid allows you to specify operations to perform during the sync with a maximum of 10 actions. Available options are:

• Add contacts to contact list
• Remove contacts from contact list
• Subscribe contacts to email group
• Unsubscribe contacts from email group
• Contacts global subscribe
• Contacts global unsubscribe

Note: The Sync Action support will only be available to Contact object.

Error Handling Page

The Error Handling page allows you to specify how errors should be handled when they happen.

There are three options available.

1. Fail on error
2. Redirect rows to error output
3. Ignore error

When the Redirect rows to error output option is selected, rows that failed to write to Oracle Marketing Cloud will be redirected to the 'Error Output' output of the Destination Component. As indicated in the screenshot below, the green output connection represents rows that were successfully written, and the red 'Error Output' connection represents rows that were erroneous. The 'ErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by Oracle Marketing Cloud or the component itself.

Note: Use extra caution when selecting Ignore error option, since the component will remain silent for any errors that have occurred.

Enable Columns for Default Output. Some objects and actions do not use the default output columns provided, these columns will still be created but will contain no values. Both columns are unchecked by default to prevent unused columns in SSIS.

• OracleEloquaRecordId: Contains the newly created record's ID, which you can use to write to log or further process using additional data flow components

Using the Oracle Marketing Cloud Token Manager

The Oracle Marketing Cloud Token Manager is a utility external to SSIS that allows you to add, remove, import, and export your Oracle Marketing Cloud Tokens from machine to machine.

Once you have developed your integration package, and you are getting ready to deploy, this utility will assist you in getting your Oracle Marketing Cloud tokens from your development environment to your integration server:

1. Open the Oracle Marketing Cloud Token Manager on your development machine
2. Select the tokens you wish to export
3. Click the 'Export' button
4. Save the 'tokens.json' file
5. Move the file manually to your integration server
6. Open the Oracle Marketing Cloud Token Manager on your integration server
7. Click the 'Import' button
8. Select the 'tokens.json' file

This is the simplest way to get your tokens from your development environment to your integration server but in some cases, you may need to add tokens manually, in which case simply click the 'Add' button. Adding tokens in the Oracle Marking Cloud Token Manager is exactly like adding tokens in the Oracle Marketing Cloud Connection Manager.

You may also need to remove tokens from your machine. Simply select the tokens you wish to remove and click the 'Remove' button.

Overall the Oracle Marketing Cloud Token Manager is a simple and secure utility that helps make your integration easy and safe.

License Manager

SSIS Integration Toolkit comes with a license manager program that helps you manage and activate the product license key to be used for the toolkit. The below information is useful for development workstations and Single Server license management. For Azure-SSIS IR deployments, license management and activation will be handled through the PowerShell script, see Running SSIS Integration Toolkit on the Cloud for further details.

Without a commercial license, SSIS Integration Toolkit will operate under the Developer License which is free to use for development or evaluation purposes. Under the developer license, you can use the software within the development tool (SSDT-BI, BIDS, or Visual Studio).

The only limitation of the free developer license is the inability to run the software outside of the development tool (SSDT-BI, BIDS, or Visual Studio). If you would like to run the software outside the development tool, such as running SSIS packages on a scheduled basis or from a command line, you will need to acquire a license from us.

If you want to test out the functionality by scheduling your SSIS packages, a trial license can be requested. To do so, you can launch the License Manager program, then click the "Change/Update License Key..." button, where you can request a free trial license after filling out the necessary Licensee Information.

If you have received a product license key from us after placing an order through our online shopping cart system, you can also click the "Change/Update License Key..." button and enter the product license key in order to activate the software to use the fully-featured commercial license.

The Licensee field is where you will specify the company the software is licensed to, you can include your system's machine name for future reference. For example, the Licensee can be "ABC Inc." or "XYZ Corp (SQLSVR-001)." The Contact Email would be the person we reach out to for any license-related notices such as renewal reminders.

To request a free trial license or activate a product license key that you have received, you can use the Web Service option to complete the process by sending the request to our license server directly. An Internet connection is required when the Web Service option is used. This is the option that we recommend.

Alternatively, you can choose the Email option so that the license manager will generate an email for you which you can send to us. The Email option should only be used if your system has no Internet access. It requires manual processing so please expect to wait for 24 to 48 hours before receiving a license file from us. Once you have received the license file from us through email, you can save it to a local file, which you can then install by clicking the "Install License File..." button in License Manager.

If you have acquired a license from us, once the software has been activated, your license manager should look as shown below:

Connection Tier will display the number of distinct connections your license supports per connection type within a 24-hour period at runtime. Multiple connections to the same instance are typically treated as 1 distinct connection (exceptions may apply depending on the nature of the service). Selecting the magnify icon will launch the Runtime Connection Usage Summary window which will display counts on the number of connections made per connection type and when the 24-hour period will reset.

If you own a perpetual license from us, you should be able to see your Maintenance Expiry Date in the License Manager program. By default, your perpetual license should be instated with a one-year maintenance and upgrade included, which entitles you to use any version of the software released before your Maintenance Expiry Date. To extend your software license maintenance, log in to our portal and navigate to the license key using the License Keys menu. From there, you can renew the license or otherwise reach out to our Client Services team to request their assistance in renewing your license terms.

Note: Perpetual license is only applicable to clients who have previously acquired such a license before the deprecation of the license type. It is no longer offered for any new purchases.

If your commercial license is a subscription license, you will not see the Maintenance Expiry Date option in the License Manager program, since your subscription license comes with maintenance and upgrade for the entire subscription period. Instead, you will see your license expiry date and a progress bar with the number of days left on your subscription.

Note: You must run the License Manager program under a local administrative account due to the privileges required to write license files to the system.

Contact Us

If you need any further assistance with the toolkit, please don't hesitate to contact us.