Introduction
This integration guide details the processes required to integrate Apteco software with the Instiller email service provider (ESP).
Integration options
FastStats
For a one-off broadcast, you can use a combination of the Email Broadcasting and Email Responses wizards to upload your list, schedule a broadcast campaign, and finally receive responses from your customers back into your FastStats system for further analysis.
PeopleStage
Automate data uploads for unattended and scheduled marketing broadcasts. PeopleStage allows you to define and implement marketing process flow diagrams that react to the responses you receive from the ESP.
Export and Upload a File
Access generic FTP support to allow data export and upload to third-party digital broadcast providers.
Note: Apteco approves this integration with Instiller. Use of Apteco software in combination with Instiller software through this integration will not affect the intellectual property rights indemnity provided in the Apteco software “End User Licence Agreement”.
Instiller integrates with your FastStats system by utilising a RESTful transport over HTTP/S, in conjunction with SFTP.
Before you begin
Caution: This guide assumes you have the relevant Apteco software system administration experience to perform this task, particularly with the FastStats Administrator, SQL Server and the areas of the Apteco software that relate to creating selections and campaign creation. If you do not, contact your Apteco partner or the Apteco support team. You need to have the appropriate system and SQL Server administrator permissions to install the relevant components successfully. Additionally, you will need to have Access to the broadcaster web-based control panel and obtain all the relevant information from Instiller. You will also need to understand how to construct your message in Instiller.
This guide details the steps required to integrate FastStats and PeopleStage with a Broadcaster using an API; the document is in two parts:
-
The configuration of Apteco software
-
Appendices which include:
-
A summary of configuration in Instiller
-
API Parameters
-
Useful to have before you start:
-
Database Connection String made up of the database server Instance name and FastStats system name, for example:
<SQLServerInstanceName>;Initial Catalog=RS_<SystemName>;User Id=faststats_service;Password=fa5t5tat5;
-
The Digital Integration.zip available from:
-
Decide where your FERG folders are to be created
Used to store the .xml and .bat files used when scheduling FERG
Bulk insert folder must be accessible from SQL Server to use BULK INSERT
-
Decide where you want the FastStats Email Response Gatherer to be installed
This will typically be on the same server as the FERG folders but can be on any PC
-
Virtual Variables in FastStats to map to broadcast fields
-
The Instiller UI URL Username, Password and PIN
-
The Instiller List Name and Message Name (available from the Instiller UI)
-
The Instiller API Username and Password
-
The Instiller API Key
-
The Instiller API ID
Process summary
Architecture
The following diagrams describe a typical process from FastStats to Instiller, to the customer and back to FastStats.
-
A broadcast is initialised through the FastStats Web Service using the Email Broadcasting Wizard, which inserts a job into the Web Service Control database (WS_DB).
-
The FastStats Service picks this job up, uploads the list to the Instiller SFTP site and then uses RESTful communication to monitor the upload.
-
Instiller then imports the contents of this list to its subscribers and associates them with a list name ready for use in any email campaigns.
-
A campaign can then be scheduled using the Instiller web interface.
-
Instiller sends Messages to all recipients on the list.
-
Instiller records any undelivered messages.
-
Instiller records a response for each interaction with a message (for example opens and clicks).
-
A scheduled job on the FastStats server initiates the FastStats Email Response Gatherer (FERG) which checks the SFTP site for response files.
-
These responses are then imported into the Response database (RS_DB) ready for analysis by your FastStats system.
The key difference in this process is messages are sent from Instiller automatically, allowing full control of the campaign scheduling from within Apteco software.
Note: For the message to send automatically, you need to create a Message in Instiller.