Install and Configure the Recipe

On your Oracle Integration instance, install the recipe to deploy and configure the integration and associated resources.

Install the recipe on your Oracle Integration instance. See Install a Recipe or Accelerator.

After you've installed the recipe, configure the following resources:

Configure the Oracle Unity Connection

  1. In the Connections section, click the connection name.
  2. In the Oracle Unity URL field, enter the URL for connecting to Oracle Unity. For example, https://XXXXXX.cxunity.ocs.oraclecloud.com.

    The URL is provided when you subscribe to Oracle Unity.

  3. In the Security section, enter the following details:
    Field Information to Enter
    Security Policy Select Resource Owner Password Credentials.
    Access Token URI

    Enter the authorization server that generates the access token:

    https://IDCS_URL/oauth2/v1/token
    Client ID Enter the unique random string that matches the API console project. See Configure Oracle Unity.
    Client Secret Enter the unique random string that matches the API console project.
    Username Enter the Oracle Identity Cloud Service username of the OAuth token request.
    Password Enter the Oracle Identity Cloud Service password of the OAuth token request.
    Scope Enter the list of authorization permissions for the target application. For example, read write.
  4. Click OK.
  5. Click Save. If prompted, click Save again.
  6. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  7. To return to the project workspace, click Go back Back icon.

Configure the FTP Connection

  1. In the Connections section, click the connection name.
  2. In the Properties section, enter the following details:
    Field Information to Enter
    FTP Server Host Address Enter the host address of your sFTP server.
    FTP Server Port Enter 22.
    SFTP Connection Select Yes from the list.
  3. In the Security section, enter the following details:
    Field Information to Enter
    Security Policy Select FTP Server Access Policy.
    User Name Enter the user name to connect to your sFTP server.
    Password Enter the password to connect to your sFTP server.
  4. Click Save. If prompted, click Save again.
  5. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  6. To return to the project workspace, click Go back Back icon.

Configure the REST Salesforce Marketing Cloud Connection

  1. In the Connections section, click the connection name.
  2. In the Properties section, enter the following details:
    Field Information to Enter
    Connection Type Select REST API Base URL.
    Connection URL Paste the URL without trailing (/) copied from Salesforce Marketing Cloud. See Configure Salesforce Marketing Cloud.
  3. In the Security section, enter the following details:
    Field Information to Enter
    Security Policy Select OAuth Custom Two-Legged Flow.
    Access Token Request

    Enter the client id, client secret, account id and auth url copied from Salesforce Marketing Cloud in the below format. Append v2/token in the auth url. To generate client id and secret, see Configure Salesforce Marketing Cloud.

    -X POST -H 'Content-Type:application/json' -d '{ "grant_type": "client_credentials", "client_id": "<client id>", "client_secret": "<client secret>", "account_id": "<account id>" }' 'https://mc4nwk3rs1n1tm8lm4qgd1g448hm.auth.marketingcloudapis.com/v2/token'
  4. Click Save. If prompted, click Save again.
  5. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  6. To return to the project workspace, click Go back Back icon.

Configure the SOAP Salesforce Marketing Cloud Connection

  1. In the Connections section, click the connection name.
  2. In the Properties section, enter the SOAP WSDL URL in the WSDL URL field. See Configure Salesforce Marketing Cloud.
  3. In the Security section, enter the following details:
    Field Information to Enter
    Security Policy Select Username Password Token.
    Username

    Enter the username. See Configure Salesforce Marketing Cloud.

    Password Enter the password.
  4. Click Save. If prompted, click Save again.
  5. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  6. To return to the project workspace, click Go back Back icon.

Configure the REST OIC Invoke Connection

  1. In the Connections section, click the connection name.
  2. In the Properties section, enter the following details:
    Field Information to Enter
    Connection Type Select REST API Base URL.
    Connection URL Paste the URL of the Oracle Integration instance in the below format.
  3. In the Security section, enter the following details:
    Field Information to Enter
    Security Policy Select Basic Authentication.
    Username Enter the username of the Oracle Integration instance.
    Password Enter the password of the Oracle Integration instance.
  4. Click Save. If prompted, click Save again.
  5. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  6. To return to the project workspace, click Go back Back icon.

Configure the REST OIC Trigger Connection

  1. In the Connections section, click the connection name.
  2. In the Security section, select the Security Policy as OAuth 2.0 Or Basic Authentication.
  3. Click Save. If prompted, click Save again.
  4. Click Test to ensure that your connection is successfully configured. In the resulting dialog, click Test again.

    A message confirms if your test is successful.

  5. To return to the project workspace, click Go back Back icon.

Configure the Lookup Tables

The recipe contains the following four lookup tables. Edit the lookup tables to enter appropriate values for the lookup keys.

  • ORACLE-BRT-UNITY_SFMC_PROPERTIES: Used to configure the FTP file details in which the customer segments are stored.

    Key Description Example
    FileDirectory Stores the location of the FTP file directory that has the customer segments. /home/users/org-name /customers/inbound
    RetryCount Stores the number of retries when a transient error occurs. 3
    ArchiveEnabled Stores the flag to identify if the file must be archived after being processed successfully. Y
    ArchiveDirectory Stores the location of the FTP directory that stores the archived files with customer segments. /home/users/org-name /customers/archive
    CustomerDataExtensionKey Stores the ID of customer data extension in Salesforce Marketing Cloud. It is a unique value that identifies the data extension and is used to identify the data extension with an API call. 5C2EF345-4A12-405C-BDCE-BE358139DC44
    SFMCPageSize Stores the ideal pagination value for the Oracle FTP SFMC DataExtension Import integration. 250
    EmailFrom_Success Stores the email address from which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is successful. no-reply@company.com
    EmailTo_Success Stores the email address to which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is successful. xyz@company.com
    EmailSubject_Success Stores the subject of the email that is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is successful. Unity to SFMC Customer Import Successful
    EmailFrom_Failure Stores the email address from which a message is sent whenever the customer import from Oracle Unity toSalesforce Marketing Cloud is unsuccessful. no-reply@company.com
    EmailTo_Failure Stores the email address to which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is unsuccessful. xyz@company.com
    EmailSubject_Failure Stores the subject of the email that is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is unsuccessful. Unity to SFMC Customer Import Failure
    MaxFileCount Stores the maximum number of files that can be processed in one instance. Ensure that the processing time doesn’t exceed six hours limit for a scheduled instance. The maximum possible value is 100. 100
    MaxInstanceCount

    Stores the maximum number of instances that a run can span across in case the processing is not completed in one instance.

    Note:

    Ensure that processing is complete before next scheduled run.
    		10
    ClearBeforeImport Stores the flag to identify if recipe clears the old data before importing the new data in the customer import data extension. Y
    CustomerSegmentName Stores the Customer Segment Name. Unity_SFMC_MasterCustomer
    UnityTenantId Stores the Unity Tenant Id. 100046

  • ORACLE-BRT-SFMC_UNITY_PROPERTIES: Used to configure the data extension that stores the campaign results in Salesforce Marketing Cloud.

    Key Description Example
    ResultsDataExtensionKey Stores the external key of the results data extension in Salesforce Marketing Cloud. This value is passed in the Automation Setup integration. ResultsDataExtensionName
    ResultsDataExtensionName Stores the name of the results data extension in Salesforce Marketing Cloud. This value is passed in the Automation Setup integration. Unity_CampaignResults_DE
    MarketingMedium Stores the medium of the marketing campaign. Email
    MarkeingSource Stores the source application of the marketing campaign. Salesforce Marketing Cloud
    EmailFrom_Success Stores the email address from which a message is sent whenever the campaign results import from Salesforce Marketing CloudCloud to Oracle Unity is successful. no-reply@company.com
    EmailTo_Success Stores the email address to which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is successful. xyz@company.com
    EmailSubject_Success Stores the subject of the email that is sent whenever the customer import from Oracle Unity toSalesforce Marketing Cloud is successful. Unity to SFMC Customer Import Successful
    EmailFrom_Failure Stores the email address from which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is unsuccessful. no-reply@company.com
    EmailTo_Failure Stores the email address to which a message is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is unsuccessful. xyz@company.com
    EmailSubject_Failure Stores the subject of the email that is sent whenever the customer import from Oracle Unity to Salesforce Marketing Cloud is unsuccessful. Unity to SFMC Customer Import Failure
    UnityPageSize Stores the maximum number of records that can be passed to Oracle Unity in an invoke request. 500
    UnityRetryCount

    Stores the maximum number of retries in case Oracle Unity invoke request fails.

    		3
    MaxIterationCount Stores the maximum number of Salesforce Marketing Clouditerations with an iteration size of 2500 records. Ensure that the processing time doesn’t exceed six hours limit for a scheduled instance. 100
    MaxInstanceCount

    Stores the maximum number of instances that a run can span across in case the processing is incomplete in one instance.

    Note:

    Ensure that the processing gets completed before next scheduled run.
    		20

  • ORACLE-BRT-SFMC_UNITY_EVENT_TYPE: Represents the mapping between event types in the instances. For instance, SentEvent is mapped with Sent.

    Event Type in Salesforce Marketing Cloud Event Type in Oracle Unity
    SentEvent Sent
    OpenEvent Opened
    ClickEvent Clicked
    BounceEvent Bounced

  • ORACLE-BRT-SFMC_UNITY_MONTH_OF_YEAR: Used to map the calendar months between the instances.

  1. In the Lookups section, click the lookup name.
  2. Edit the lookup table as necessary.
  3. Click Save. If prompted, click Save again.
  4. To return to the project workspace, click Go back Back icon.

Add or Edit the Attributes inSalesforce Marketing Cloud (Optional)

To add or edit attributes in Salesforce Marketing Cloud (other than what is pre-configured in this recipe), you must update the data extension you created previously and update the schema in REST endpoint configuration of the Oracle FTP SFMC DataExtension Import integration flow.

Update the Data Extension in Salesforce Marketing Cloud

  1. Log in to Salesforce Marketing Cloud.
  2. In Audience Builder, select Contact Builder.
  3. In the Contact Builder window, navigate to the Data Extensions tab.
  4. Select the data extension you created previously from the list, then click Open.
  5. To add a new attribute, click Create Attribute.
  6. To edit an attribute, click the Edit icon next to the attribute.

    Note:

    You cannot select the data type while editing the attribute.
  7. Click Save.

Update the Schema in REST Endpoint Configuration

  1. In the Integrations section, click the Oracle FTP SFMC DataExtension Import integration flow.
  2. On the integration canvas, expand FileScope, then expand PageScope.
  3. In PageScope, select the UpsertInSFMCDataExtension element, and then click Actions Actions icon and select Edit.
  4. On the Request page, update the JSON schema with the new fields.
  5. On the Summary page, click Done.
  6. In the resulting window, click Update.

    The updated attribute appears as a separate field on the mapping canvas.

Update the REST Endpoint’s Mapper

Map the new attribute to the relevant source attribute on the mapping canvas.

  1. On the integration canvas, in PageScope, select the Map to UpsertInSFMCDataExtension element, then click Actions Actions icon and select Edit to open the mapper.
  2. Map the new attribute to the relevant source attribute on the mapping canvas.

Add or Delete Attributes in Oracle Unity (Optional)

To add or delete attributes in Oracle Unity (other than what is pre-configured in this recipe), you must perform the following tasks:

  1. Add or delete the personalization attributes in Oracle Unity.
  2. In the Oracle FTP SFMC DataExtension Import integration flow of the recipe:
    1. Update the FTP adapter with the new file schema.
    2. Update the mapper element corresponding to the FTP adapter.
    3. Update the Stage File element with the new file schema.
    4. Update the mapper element corresponding to the Stage File element.
    5. Update the Stage File element in the fault handler with the new file schema.
    6. Update the mapper element corresponding to the Stage File element in the fault handler.

Add or Delete the Personalization Attributes in Oracle Unity

To add or delete the personalization attributes (other than what is pre-configured in this recipe) from the base object to the segment, see Managing Personalization Attributes in Oracle Unity documentation.

Update the FTP Adapter with the New Schema

Note:

You get the updated file schema when you run the Oracle Unity FTP Master Customer Export integration flow.

  1. In the Integrations section, click the Oracle FTP SFMC DataExtension Import integration flow.
  2. On the integration canvas, expand the FileScope element, select the ReadFileFromFTP element, and then click Actions Actions icon and select Edit.
  3. Upload the updated schema.
  4. On the Summary page, click Done.
  5. In the resulting window, click Update.

    The updated attribute appears as a separate field on the mapping canvas.

Update the FTP Adapter’s Mapper

  1. On the integration canvas, in FileScope, select the Map to ReadFileFromFTP element, and then click Actions Actions icon and select Edit to open the mapper.
  2. Map the new attribute to the relevant target attribute on the mapping canvas.
Update the Stage File Element with the New Schema
  1. On the integration canvas, in FileScope, select the InitializeStageErrorFile element, and then click Actions Actions icon and select Edit.
  2. Upload the updated schema.
  3. On the Summary page, click Done.
  4. In the resulting window, click Update.

    The updated attribute appears as a separate field on the mapping canvas.

    To know more about configuring stage file activity, see Configure a Stage File Action in Using Integrations in Oracle Integration 3.

Update the Stage File Element’s Mapper
  1. On the integration canvas, in FileScope, select the Map to InitializeStageErrorFile element, and then click Actions Actions icon and select Edit to open the mapper.
  2. Map the new attribute to the relevant target attribute on the mapping canvas.
Update the Fault Handler’s Stage File Element with the New Schema
  1. On the integration canvas, expand FileScope, and then expand PageScope.
  2. In PageScope, click the Fault Handler element, and select Default Handler.
  3. Select the AppendToStageErrorFile element, and then click Actions Actions icon and select Edit.
  4. On the Format Definition page, upload the updated schema.
  5. On the Summary page, click Done.
  6. In the resulting window, click Update.

    The updated attribute appears as a separate field on the mapping canvas.

    To know more about configuring stage file activity, see Configure a Stage File Action in Using Integrations in Oracle Integration 3.

Update the Stage File Element’s Mapper

  1. On the integration canvas, within DefaultHandler, select the Map to AppendToStageErrorFile element, and then click Actions Actions icon and select Edit to open the mapper.
  2. Map the new attribute to the relevant target attribute on the mapping canvas.

Add a New Email Campaign Event (Optional)

In this recipe, the following email campaign events are pre-configured:
  • Sent Event
  • Bounce Event
  • Click Event
  • Open Event
To add a new email campaign event other than what is pre-configured in the recipe, you must:
  1. Add a new event in the lookup table ORACLE-BRT-SFMC_UNITY_EVENT_TYPE. See Configure the Lookup Tables.
  2. In the Integration section, click the Oracle SFMC Automation Setup integration flow and perform the following tasks on the integration canvas.
    1. Assign global variables for the new event.
      1. On the integration canvas, select the AssignGlobalVariables element, and then click Actions Actions icon and select Edit.
      2. Add new variables for the event.
    2. Add a SOAP adapter endpoint and a mapper for the new event.
      1. In the Main Scope, expand DataExtensions Scope.
      2. Add a SOAP adapter endpoint along with a mapper element.
      3. Update the mapper with the details specific to the new event.
    3. Add a status check for the data extension created.
      1. In the DataExtensions Scope, select the switch case (IF DataExtensionsCreated) element, and then click Actions Actions icon and select Edit.
      2. Add a StatusCode for the new data extension created.
    4. Add query definitions for the event.
      1. In the Main Scope, expand QueryDefinitions Scope.
      2. Add a SOAP adapter endpoint and a mapper for a query definition to query events data from the Salesforce Marketing Cloud data view and import the same to the data extension created for the event.
      3. Update the query definition mapper with the details and query specific to the new event.
      4. Add another SOAP adapter endpoint and a mapper for a query definition to copy data from the event-specific data extension to the results data extension.
      5. Update the query definition mapper with the details and query specific to the new event.
      6. Add switch case conditions and assign variables for the data extensions created.
        1. In the QueryDefinitions Scope, select the switch case (IF QueryDefinitionsCreated) element, and then click Actions Actions icon and select Edit.
        2. Add a StatusCheck for the new data extension created.
        3. To assign variables, select the AssignQueryDefinition element, and then click Actions Actions icon and select Edit.
        4. Add a new variable in the similar format you added for other events.
    5. In the Automation Scope, update the mapper with the query definition created.
      1. In the Main Scope, expand AutomationScope.
      2. Select the Map to createAutomation element, and then click Actions Actions icon and select Edit.
      3. On the mapping canvas, add a new AutomationTask and map the new query definition created with the relevant target attribute.