Campaign | partitions | partition[n] | Engage

These properties control authentication and data exchange between HCL® Campaign and HCL Engage if the products are integrated.

To access these properties, choose Settings > Configuration. If your Campaign installation has multiple partitions, set these properties for each partition that uses the integration.

Service URL

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Service URL indicates the URL where Campaign can access the HCL Engage application. The Engage Org Admin must provide this value.
Default value: <none>
Example: https://engageapi.abc01.com/

OAuth URL Suffix

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The OAuth URL Suffix specifies the authentication token for the Engage APIs.
Default value: oauth/token

API URL Suffix

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The API URL Suffix is set to XMLAPI to ensure that Campaign uses the Engage XML APIs. Best practice is to leave this set to the default value.
Default value: XMLAPI

Platform User with Data Sources for Engage Credentials

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Platform User with Data Sources for Engage Credentials indicates the name of the HCL Marketing Platform user account that is allowed to connect to the HCL Engage server. This user account contains the data sources that provide Engage credentials. Typically, asm_admin is used.
Default value: No default value defined.
Valid values: The HCL Marketing Platform user account that contains the data sources for Engage integration credentials.

Data Source for Client ID

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Data Source for Client ID value must exactly match the name of the Engage Client ID data source that was created for the user account that connects to the HCL Engage server (Platform User with Data Sources for Engage Credentials). In other words, the value must match what is set up as the datasource for the HCL Marketing Platform user. Best practice is to leave this set to the default value.
Default value: ENGAGE_CLIENT_ID_DS

Data Source for Client Secret

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Data Source for Client Secret value must exactly match the name of the Engage Client Secret data source that was created for the user account that connects to the HCL Engage server (Platform User with Data Sources for Engage Credentials). Best practice is to leave this set to the default value.
Default value: ENGAGE_CLIENT_SECRET_DS

Data Source for Client Refresh Token

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Data Source for Client Refresh Token value must exactly match the name of the Engage Client Refresh Token data source that was created for the user account that connects to the HCL Engage server (Platform User with Data Sources for Engage Credentials). Best practice is to leave this set to the default value.
Default value: ENGAGE_CLIENT_REF_TOK_DS

Data Source for File Transfer Credentials

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Data Source for File Transfer Credentials indicates the name of the data source that provides the credentials for FTP communication between Campaign and Engage. This value must exactly match the name of the Engage FTP data source that was created for the user account that connects to the HCL Engage server (Platform User with Data Sources for Engage Credentials). Best practice is to leave this set to the default value.
Default value: ENGAGE_FTP_DS

Host Name for File Transfer

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Host Name for File Transfer indicates the host name of the Engage FTP server where Campaign uploads the contact list in TSV format. This file gets deleted automatically after it is uploaded into a contact list.
Default value: <none>
Valid values: Any valid address in the list of HCL Marketing Cloud FTP addresses: http://www.ibm.com/support/knowledgecenter/SSTSRG/Setting_up_an_FTP_or_SFTP_account.html?lang=en. For example: transfer2.silverpop.com

Port Number for File Transfer

Configuration category: Campaign | partitions | partition[n] | Engage
Description: The Port Number for File Transfer indicates the port number for the FTP server that is specified in Host Name for File Transfer.
Default value: 22
Valid values: Any valid FTP port number

Use proxy for ServiceURL

Description: Determine if you use proxy for ServiceURL. If you select Yes, your connection uses the proxy server. Proxy server details can be configured under Campaign | proxy. If you select No, a proxy server is not used to connect to Engage.

Default value: No

Valid values: Yes, No

Use proxy for FTP

Description: Determine if you use proxy for FTP. If you select Yes, your connection to the Engage FTP server uses the proxy server. Proxy server details can be configured under Campaign | proxy. If you select No, a proxy server is not used to connect to the Engage FTP server.

Default value: No

Valid values: Yes, No

allowableFailurePercentage

Description

When a campaign contact list is processed in Engage, an error is returned to Campaign if a contact fails for any reason. Use the allowableFailurePercentage property to specify the percentage of failed records that are allowed before the campaign process fails. If the percentage of failed records is greater than the configured allowableFailurePercentage, the process fails.

If the percentage of failed records is less than or equal to the configured allowableFailurePercentage, the process does not fail. Duplicate records are considered as valid records and so they do not affect the allowableFailurePercentage for a process box. All valid records are imported into Engage.

The percentage of failed records is calculated as ([TOTAL_ROWS - TOTAL_VALID]/ TOTAL_ROWS) *100.

Any warnings and errors for the process are logged in the ImportErrors log file. You can delete this file at regular intervals. The ImportErrors log file is located in the <Campaign_home>/logs folder.

Default value: 0

Valid values: Integers between 0-100.