Redpoint Interaction v6.x Documentation
Redpoint Interaction v6.x Documentation
Breadcrumbs

Instiller Email

Instiller is a third-party email execution engine used by RPI to deliver interaction emails.

The following channel-specific fields are shown for Instiller email channels:

  • Re-subscribe contacts: as per Salesforce Marketing Cloud email channel.

  • Recipient email: as per Salesforce Marketing Cloud email channel.

Service Credentials section:

  • API service URL: this text property is mandatory and can be a maximum of 100 characters in length. It represents the URL that will be used to connect to the Instiller API service. It defaults to the value ‘https://control.instiller.co.uk’.

  • Username: this text property is mandatory and can be a maximum of 100 characters in length. It represents the user name that will be used to connect to Instiller.

  • API identifier: this password-masked text property is mandatory and can be a maximum of 100 characters in length. It is used during authentication when connecting to the Instiller API service.

  • API key: this text property is mandatory and can be a maximum of 100 characters in length. It is also used when authenticating against to use the Instiller API service.

  • Field maps identifier: this text property is mandatory and can be a maximum of 100 characters in length. It is used to map the columns of the data file to the email data fields. Note that, to acquire a Field maps identifier, the ‘List > Field Maps > API Identifier’ property must be configured at the Instiller UI.

  • Click tracking domain: this text property is mandatory and can be a maximum of 100 characters in length. It is used when tracking link clicks. It defaults to ‘clicks.dnsentries.co.uk’.

  • Email profile name: this property represents the email profile name to be used by the sending email address.

  • Email profile API identifier: this property represents the email profile API identifier to be used by the sending email address.

Suppressions section:

  • Auto-suppress: as per Salesforce Marketing Cloud email channel.

  • Custom suppression table: as per Salesforce Marketing Cloud email channel.

  • Suppression table name: as per Salesforce Marketing Cloud email channel.

Synchronization section:

The properties in this section are used to limit the API calls/transactions made to the Instiller API during channel synchronization. Setting lower duration values limits the number of API calls made; setting higher frequency values further limits API calls.

  • Override sync frequency: this checkbox is unchecked by default. When checked, the other fields in the Synchronization section are enabled.

  • HardBounced sync duration: this numeric property is enabled when Override sync frequency is checked. It defaults to 5, accepts a minimum value of 1 and a maximum value of 30. It allows you to define the maximum number of days across which to synchronize HardBounced results.

  • SoftBounced sync duration: this numeric property is enabled when Override sync frequency is checked. It defaults to 5, accepts a minimum value of 1 and a maximum value of 30. It allows you to define the maximum number of days across which to synchronize SoftBounced results.

  • HardBounced sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the frequency, in hours, at which HardBounced results will be synchronized.

  • SoftBounced sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the frequency, in hours, at which SoftBounced results will be synchronized.

  • Complaints sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the frequency, in hours, at which Complaints results will be synchronized.

  • Global OptOut sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the frequency, in hours, at which Global OptOut results will be synchronized.

  • Campaign metrics sync sequence: the following properties provide control over the synchronization of high level campaign metrics.

  • Initial sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 20, accepts a minimum value of 5 and a maximum value of 60. It allows you to define the frequency, in minutes, of the initial synchronization of high level campaign metrics.

  • Initial sync duration: this numeric property is enabled when Override sync frequency is checked. It defaults to 4, accepts a minimum value of 1 and a maximum value of 24. It allows you to define the duration, in hours, of the initial synchronization of high level campaign metrics.

  • Post initial sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 1 accepts a minimum value of 1 and a maximum value of 24. It allows you to define the frequency, in hours, at which post initial campaign metrics will be synchronized.

  • Post initial sync duration: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the duration, in hours, of the post initial synchronization of high level campaign metrics.

  • Sync frequency: this numeric property is enabled when Override sync frequency is checked. It defaults to 24, accepts a minimum value of 1 and a maximum value of 720. It allows you to define the frequency, in hours, at which high level campaign metrics will be synchronized after the post initial sync.

Miscellaneous section:

  • Remove default text footer: as per Salesforce Marketing Cloud email channel.

  • Include view online link: this checkbox is unchecked by default. If checked, a View Online link is inserted into delivered email content. If unchecked, the link is not inserted.

  • Save event files: this checkbox is unchecked by default. When checked, Instiller event files will be moved to the 'C:\temp\RPI\Instiller\TENANT_ID\Processed' folder.

If this option is selected, there is the potential for the persistence of PII data on the RPI Server. Accordingly, a warning is shown when this option is checked:

att_1_for_5094801454.png

  • Retry count: this integer property allows you to specify the number of retry attempts to be made in the event of an error occurring when connecting to the Instiller service.

  • Content templates shared folder: as per CheetahMail email channel.

  • Send throttle rate: this integer property is set to 500,000 by default. It accepts a minimum value of 50,000. It represents the maximum number of email messages that can be sent per hour.

The following properties are exposed at the Advanced tab:

  • External folder: as per Acoustic email channel.

  • Import via file: as per Salesforce Marketing Cloud email channel.

  • Import table suffix: as per Salesforce Marketing Cloud email channel.

  • Import FTP location: as per Salesforce Marketing Cloud email channel.

  • Enable trace: as per SendGrid email channel.

  • Move hashtags to end of URL: as per Salesforce Marketing Cloud email channel.

Web Adapters are supported at the channel.

A Validate channels job is created and executed on saving a new Instiller email channel, or on saving following a change to an existing Instiller email channel's Recipient email field. Full details are as per the Salesforce Marketing Cloud email channel documentation.