Installation

To install and run SSIS Integration Toolkit for Oracle Marketing Cloud, your system must have the following components installed. 

  • A supported SSIS design-time or run-time, which can be one of the following:
    • SSIS 2017
    • SSIS 2016
    • SSIS 2014
    • SSIS 2012
    • SSIS 2008 R2
    • SSIS 2008
    • SSIS 2005

    For SSIS runtime, the installation should be done by using the corresponding SQL Server installation media (most likely in CD/DVD format), and you must select the "Integration Services" component during the installation (as shown below).

    Integration Services Runtime Selection

    Note that when using SQL Server 2014, a cumulative update is required (a recent service pack, such as one of the following, is more preferred) in order to run our software during runtime.

    For SSIS design-time, you should be installing the version of SSDT (SQL Server Data Tools) or BIDS (Business Intelligence Development Studio) that aligns with the SQL Server version that you plan to use for your final deployment (the runtime).

    • When targeting SSIS 2017 or 2016, you would use SSDT for Visual Studio 2015 available for download at https://msdn.microsoft.com/mt186501.aspx
      • Note that this SSDT installation can be used to target SSIS 2014 or 2012 as well.
    • When targeting SSIS 2014, you can use either one of the following:
    • When targeting SSIS 2012, you can use any one of the following:
    • When targeting SSIS 2008 R2 or earlier, you would have to install the Business Intelligence Development Studio that is shipped with the installation media of the corresponding SQL Server version. 
  • .NET Framework 3.5
    • For any version before v1.2, .NET Framework 3.5 is required. For v1.2 or later, .NET Framework 3.5 is only required when you use SSIS 2005.
      • If you are using Windows Server 2003, Windows Server 2008, Windows Vista, Windows XP operating systems, you would install .NET framework by downloading it from Microsoft website.
      • If you are using Windows Server 2008 R2 or 2012 family of operating systems, .NET framework 3.5 should be installed using Server Manager program by adding .NET Framework 3.5.1 features.
      • If you are using Windows 8, go to Control Panel -> Programs and Features -> Turn Windows features on or off, then select .NET Framework (includes .NET 2.0 and 3.0).
  • Windows Installer 4.5
    • If you are using Windows Server 2008, Windows Server 2012 family of operating systems or later (including Windows Vista, Windows 7, Windows 8, Windows Server 2012 R2, Windows Server 2016), you do not need to do anything since the latest Windows Installer has been installed by the operating system.
    • If you are using Windows Server 2003 family of operating systems (including Windows XP), you should install Windows Installer 4.5 by downloading it from Microsoft website.

When you have confirmed that your system satisfies the above prerequisites, you can navigate to the KingswaySoft website at http://www.kingswaysoft.com to download the installation package. In the download page you will find two download links. One for x86 systems and one for x64 systems. Make sure to choose and download the correct package for your system. 

download options

After you have downloaded the package, you can install the software by following the installation wizard. 

Assigning Permissions

The Oracle Eloqua Connection Manager retrieves tokens from the Oracle Eloqua app, once you give authorization. These tokens are then stored in Registry so that once they have expired, our component will automatically request new tokens from Oracle Eloqua to minimize user effort, and replace the existing tokens with these new ones in Registry. In order to achieve this, there must be proper permissions given to the KingswaySoft folder in Registry.

Start by opening the Registry Editor, and navigate into the following folders:

  • HKEY_LOCAL_MACHINE > SOFTWARE > KingswaySoft > SSIS Integration Toolkit for Oracle Eloqua

eloqua registry

  • Right-click on the SSIS Integration Toolkit for Oracle Eloqua folder in the KingswaySoft folder and select the Permissions option. Enable the following permissions to give yourself the permissions to modify this folder.

Give Permissions

Using the Oracle Eloqua Connection Manager

The Oracle Eloqua Connection Manager is an SSIS connection manager component that can be used to establish connections with Oracle Eloqua.

To add an Oracle Eloqua connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "Oracle Eloqua" item to add the new Oracle Eloqua connection manager.

new connection

add SSIS Eloqua connection

The Oracle Eloqua Connection Manager contains the following three pages which configures how you want to connect to Oracle Eloqua.

  • General
  • Advanced Settings
  • More Info 

General page

The General page on the Connection Manager allows you to specify general settings for the connection.

SSIS Oracle Eloqua connection

Server URL:

The URL of the Oracle Eloqua server that you want to connect to.  This property is optional and when not set the component will retrieve the default URL for your account when authenticating at https://login.eloqua.com.

Authentication Type:

Oracle Eloqua supports two types of authentication: Basic and OAuth2.  Basic authentication is faster to set up but is considered less secure than OAuth2.

Basic Authentication:

Basic authentication has the following three properties:

  • Company Name - The company name associated with the Oracle Eloqua account
  • User Name - The user name of your Oracle Eloqua account
  • Password - The password of your Oracle Eloqua account
OAuth2 Authentication:

OAuth2 has the following 4 properties and buttons:

  • Token Location - Oracle Eloqua retrieves tokens from the Oracle Eloqua app, once you give authorization. The tokens are stored in Registry so that once they expire, our component will automatically request new tokens from Oracle Eloqua to minimize user effort, and replace the existing tokens with the new ones in Registry. You have two options to choose where in registry you would like to store these tokens: 
    1. Local Machine - HKEY_LOCAL_MACHINE
    2. Current User - HKEY_CURRENT_USER
  • User Name - The User Name specifies the user name used to authenticate to Oracle Eloqua. Our component lists all existing tokens in Registry according to the specified token location.  The tokens are what give the components access to your Oracle Eloqua instance through the Oracle Eloqua API. They are generated by a form of authentication called OAuth. To perform the authentication either click the Add User ID (In App) or Add User ID (In Browser) button.
  • Add User ID (In App)  - The Add User ID (In App) button completes the entire OAuth authentication process inside of the toolkit. All you need to do is login to Oracle Eloqua and authorize our app to generate your OAuth tokens.
  • Add User ID (In Browser) - The Add User ID (In Browser) button completes the OAuth authentication using your default browser. After you click this button simply follow the steps in the dialog to generate your OAuth tokens, then enter them into the browser authentication dialog in the connection manager.
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

Test Connection

After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.

Advanced Settings

The Advanced Settings page on the Eloqua Connection Manager allows you to specify some advanced and optional settings for the connection.

SSIS Oracle Eloqua connection - Advanced

Proxy Mode

Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option, you can provide a proxy server to connect to Oracle Eloqua .

Port 

The Port option allows you to specify port number of the proxy server for the connection.

Username 

The Username option allows you to specify the proxy user account.

Password

Using Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

NOTE: The Proxy Password is not included in the Oracle Eloqua connection manager's ConnectionString property by default. This is done by design for security reasons. However you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Retry on Intermittent Errors

This is an option designed to help recover from possible intermittent outages or disruption of service so the integration does not have to be stopped because of such temporary issues. Enabling this option will allow service calls to be retried upon certain types of failure. A service call may be retried up to 3 times before an exception is fired. Retries occur after 0 seconds, 15 seconds, and 60 seconds. Warning: Although we have carefully designed this feature so that such retries should only happen when it is deemed to be safe to do so. However, in some extreme occasions, such retried service calls could result in the creation of duplicate data.

More Info page

The More Info page shows some basic information about the toolkit. In this page, you can find the version information of the toolkit.

Adding SSIS Components to Business Intelligence Development Studio's Toolbox

SSIS Integration Toolkit for Oracle Eloqua includes two data flow components for use with Oracle Eloqua. They need to be added to the SSIS toolbox before you can use them in a SSIS data flow task.

NOTE: If you are using SQL Server 2012 or later development environment, you should not need to do this, as SQL Server 2012 or later automatically lists all available pipeline components by scanning the system. 

To add the data flow components, create a new data flow task if you do not have one yet and switch to the SSIS data flow page. Right-click on the toolbox area to bring up the context menu, where you can select the "Choose Items..." option as shown below.

Choose items

You will be presented with a window called "Choose Toolbox Items". Switch to "SSIS Data Flow Items" tab, and select Oracle Eloqua Destination and Oracle Eloqua Source components from the list. 

Add Oracle Eloqua SSIS Items

Both data flow components should now appear in your SSIS Toolbox, where you can drag and drop any of them to the design surface of your SSIS data flow task. 

Using the Oracle Eloqua Source Component

The Oracle Eloqua Source Component is an SSIS data flow pipeline component that can be used to read / retrieve data from Oracle Eloqua.

The component includes the following two pages to configure how you want to read data from Oracle Eloqua.

  • General
  • Columns

General page

The General page of the Oracle Eloqua Source Component allows you to specify the general settings of the component. 

SSIS Oracle Eloqua Source

Connection Manager

The Oracle Eloqua Source Component requires an Oracle Eloqua connection in order to connect with Oracle Eloqua. The Connection Manager drop-down will show a list of all Oracle Eloqua  connection managers that are available to current SSIS package.

Source Object

The Source Object  drop-down lists all of the currently supported objects which you can read from.

Child Objects

The Child Objects drop-down lists all of the child objects supported for the selected source object.  Each child object that is selected will create a new output where its data will be directed.

Bulk API

The Batch Size specifies whether you want to use Eloqu Bulk API to read data from your Eloqua system.

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

Batch Size

The Batch Size lets you specify how many records to retrieve per service call to Oracle Eloqua.  The batch size can be between 1 and 1000.

Output Timezone

The Output Timezone option lets you specify how all datetime fields should be retrieved. The default value is Local System Timezone. There is also the option to convert to UTC. There is no performance difference between the two options, it simply makes integration easier. 

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. 

General Parameters

Each source objects will have different parameters that you can be set to determine which records are returned and in what order.

Detailed information about common parameters and the syntax of the parameter values can be found here: https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAC/APIRequests_URLParameters.html

Common parameters include:

depth: The level of depth of the response.  The default is Complete which will return all source object and child object data.  Partial  and Minimal  depth will return less data but will be faster.

search: A search filter used to determine which records are returned.  The syntax is {field name} {operator} {value} and the supported operators are:

  • = (Equal To)
  • != (Not equal to)
  • > (Greater than)
  • < (Less than)
  • >= (Greater than or Equal to)
  • <= (Less than or Equal to)

See the above linked documentation for more details about search parameter syntax.

sort: Specifies the name of the property used to sort the returned entities.

dir: The sort direction of results, either asc or desc.

orderBy: Specifies the field by which list results are ordered.

lastUpdatedAt: Returns records last updated after the specified date.  Date can be entered either as a text date (Jan 1, 2017) or as a unix time integer.

Refresh Component Button

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

Columns page

The Columns page of the Oracle Eloqua Source Component shows you all available attributes from the object that you specified on the General page. 

SSIS Oracle Eloqua Source - Columns

The columns page contains a dropdown that lists the source object from the general page and any available children.  Output columns can be toggled on.

Using the Oracle Eloqua Destination Component

The Oracle Eloqua Destination Component is an SSIS data flow pipeline component that can be used to write data to Oracle Eloqua. You can create, update, 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 Eloqua Destination Component. The Columns page allows you to map the columns from upstream components to Oracle Eloqua 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.

SSIS Oracle Eloqua Destination

Connection Manager

The Oracle Eloqua Destination Component requires an Oracle Eloqua connection. The Connection Manager option will show all Oracle Eloqua 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 are 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 Account, Contact and Custom objects.

Action

The Action option allows you to specify how data should be written to Oracle Eloqua. 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 Eloqua server.

Batch Size 

The Batch Size lets you specify how many records to send per service call to Eloqua when Bulk API 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 Update Multiple Matched Records option to specify whether or not imported data will be mapped to multiple existing records when Bulk API 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 Eloqua 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.

Columns page

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

SSIS Oracle Eloqua Destination - Columns

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.

In 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 Eloqua 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.
Error Handling page

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

SSIS Oracle Eloqua Destination - Error Handling

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 Eloqua will be redirected to the 'Error Output' output of the Destination Component. As indicated in the screenshot below, the green output connection represent 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 Eloqua or the component itself.

SSIS Oracle Eloqua Destination - Error Output

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 no 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.

SSIS Oracle Marketing Cloud Token Manager

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 Eloqua 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 which helps you manage and activate the product license key to be used for the toolkit.

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

KingswaySoft License Manager

The only limitation with 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 License Manager program, then click "Change License Key" button, where you can request a free trial license after filling out the necessary Licensee Information.

KingswaySoft License Manager

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

To request a free trial license or activate a product license key that you have received, you can use Web Service option to complete the process by sending the request to our license server directly. An Internet connection is required when 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 from through email, you can save it to a local file, which you can then install by clicking "Install License File..." button in License Manager.

If you have acquired a perpetual license from us, once the software has been activated, your license manager will be shown as something like below.

KingswaySoft License Manager

You can see your Support Expiry Date or Maintenance Expiry Date in the License Manager program if you are using a perpetual license. By default, your perpetual license comes with a one-year maintenance and upgrade, which entitles you to use any version of the software released before your Support Expiry Date or Maintenance Expiry Date. You can extend it by entering a new maintenance license key that you have acquired from us.

KingswaySoft License Manager

If your commercial license is a subscription license, you will not see the Support Expiry Date or Maintenance Expiry Date option in the License Manager program, since your subscription license comes with maintenance and upgrade for the entire subscription period.

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

Contact Us

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