API parameters
The following data is inserted into the FastStats Email Response Table as part of the predefined configuration. You can optionally override the settings by adding them in the FastStats Email Response Configurator.
Email Response Gatherer Parameters
| Response table field | Instiller extract file column | |
|---|---|---|
| APIKey | Your Instiller API Key. Found in Instiller under Settings > API | |
| APIId | Your Instiller API ID. Found in Instiller under Settings > API | |
| MESSAGEPERIOD | Time period since message sent for responses to be pulled back e.g. 1D or 2W | |
| COMMUNICATIONKEYCOLUMNNAME | CommunicationKey | FastStats Communication Key. Only be available if it has been previously uploaded from FastStats |
| ConstantFields | Pipe delimited field of key value constants, separated by # e.g. Key1#Value1|Key2#Value2 | |
| ADDITIONALFIELDS | Any additional fields | |
| CLICKDATECOLUMNNAME | ClickDate | Date the link was clicked |
| CLICKURLCOLUMNNAME | ClickUrl | The name of the URL that was clicked |
| DATEFORMAT | Date format used e.g. dd.MM.yyyy HH:mm | |
| DELIVERYDATECOLUMNNAME | DeliveryDate | Delivery date |
| EMAILCOLUMNNAME | Email address | |
| EXECUTIONBUFFER | Adds a buffer in minutes to the start of the response window. Use this to create an overlap to allow for delayed response notifications | |
| EXECUTIONTAG | When using Smart Execution, this can be used to identify separate accounts when using the same broadcaster | |
| EXPORTTYPES | Pipe delimited field of response types to collected. The default is delivered|hard|soft|returned|oprn|output|complaints|clicks_info | |
| LOCALTIMEZONE | Specify the time zone that you wish to store your dates in. This allows you to write responses in your current time zone. The default value is local, which is the time zone of this machine | |
| LOOKUPBROADCASTIDSONTHEFLY | False will force the Email Response Gatherer to download a full list of Broadcast Ids from all the previous broadcasts in the response database. This can then be used to quickly match responses to broadcasts. If set to true, the Broadcast Ids will be fetched and cached as and when required | |
| MESSAGEENDDATE | Message end date. Format is yyyy-mm-dd | |
| MESSAGESTARTDATE | Message start date. Format is yyyy-mm-dd | |
| ONLYPROCESSRECORDSWITHBROADCASTID | false | Setting this to true forces the Email Response Gatherer to only download responses to messages that have originated from FastStats. The default option is false; all responses are downloaded. |
| OPENDATECOLUMNNAME | Opened First | |
| OUTPUTDATECOLUMNNAME | Output Date Column Name | |
| RUNCOLUMNNAME | Reserved for future use | |
| SERVERTIMEZONE | Specify the time zone that your broadcaster uses when returning data. This allows you to write responses in your current time zone. The default value is local, which is the time zone of this machine | |
| TYPECOLUMNNAME | MessageType | Response type |
| URL | Instiller URL for the account. The default is https://control.instiller.co.uk/rest | |
| URNCOLUMNNAME | URN | FastStats Urn. Only be available if it has been previously uploaded from FastStats |
Note: These settings are specific to each Instiller account.
Email Broadcasting Parameters
| Parameter | Default | Description *Example, these are specific to your account |
|---|---|---|
| API Key | Your Instiller API Key. Found in Instiller under Settings > API | |
| API ID | Your Instiller API ID. Found in Instiller under Settings > API | |
| Admin From Email | The from email address that administrative emails are sent from | |
| DatedListFormat | yyyMMdd-HHmmss | The date format string for the date and time stamp if created |
| Field Map Name | Name of the Field Map in Instiller | |
| Email Field Name | Name of the Email Field in Instiller | |
| Encoding | UTF8 | Enter the encoding of the incoming file |
| File Mapping | A pipe delimited list of header values that will overwrite any defined in your output sequences | |
| UseDatedList | True | Setting this to false will remove the date and time stamp at the end of the file name |
| Urn Field Name | Name of Urn Field in Instiller | |
| Target Automations | Target automations rather than individual templates | |
| URL | Instiller URL for the account. The default is https://control.instiller.co.uk/rest | |
| Urn Field Name Alias | Urn Field Name Alias from Instiller |
Example batch file
Example batch file to use with FERG and scheduling.
Copy
REM - Instiller Response Integration
REM - Instiller Response Integration
@echo off
REM****************************************************************************
REM File Name: Instiller.bat
REM ToDo:
REM Define the drive and folders to output the log files
REM Set FERG to define the location of the EmailResponseGatherer64.exe
REM Set LOGFILE to the folder where the event logs are stored
REM Set LOGFILEDETAILS to the folder where detail logs are stored
REM Define the XML configuration file to use
REM ***************************************************************************
D:
cd D:\FastStats\FERG
cls
SET FERG="%ProgramFiles%\Apteco\FastStats Email Response Gatherer x64\EmailResponseGatherer64.exe"
SET LOGFILE="Logs\Instiller.txt"
SET LOGFILEDETAILS="Logs\Instiller_Details.txt"
echo. >> %LOGFILE%
echo. >> %LOGFILEDETAILS%
echo %date% %time% - Starting FastStats Instiller Response Download >> %LOGFILE%
echo %date% %time% - Starting FastStats Instiller Response Download >> %LOGFILEDETAILS%
echo. >> %LOGFILE%
echo. >> %LOGFILEDETAILS%
%FERG% Instiller.xml >> %LOGFILEDETAILS%
IF ERRORLEVEL 9003 goto FailedException
IF ERRORLEVEL 9002 goto FailedLogout
IF ERRORLEVEL 9001 goto FailedDownload
IF ERRORLEVEL 9000 goto FailedLogin
:OK
echo %date% %time% - FastStats Gathered Instiller Responses OK >> %LOGFILE%
goto Complete
:FailedLogin
echo %date% %time% - FastStats Gatherer Failed - Login Failed to Instiller >> %LOGFILE%
goto Complete
:FailedDownload
echo %date% %time% - FastStats Gatherer Failed - Downloading from Instiller >> %LOGFILE%
goto Complete
:FailedLogout
echo %date% %time% - FastStats Gatherer Failed - Logging out of Instiller >> %LOGFILE%
goto Complete
:FailedException
echo %date% %time% - FastStats Gatherer Failed - Instiller API Exception >> %LOGFILE%
goto Complete
:Complete
echo %date% %time% - Completed FastStats Instiller Response Download >> %LOGFILE%
To use the batch file see section Scheduling the Response Gatherer.
Troubleshooting
The following are some common problems that may occur, and procedures for resolving them.
Errors relating to configuring and using FERG
These errors can occur due to missing files.
Description: Error received when running FERG using a batch file.
Copy
Error: Could not read email response configuration file: Could not find file 'D:\FastStats\FERG\Instiller.xml'.Instiller.xml refers to the filename referenced in this section of the batch file:
%FERG% Instiller.xml >> %LOGFILEDETAILS%
In the location:
“cd D:\FastStats\FERG” in the batch file
Solution: Ensure the file exists or change the filename in the batch file to match.