Email responses

Installing the Email Response Gatherer

To install the Email Response Gatherer:

  1. Download the FastStats Email Response Gatherer installer.

    You can find the installer in the DigitalIntegration.zip, available here: apteco.com/portal/software-releases.

    Extract the zip file to your designated server where you want the email response web gatherer to run.

    Note: The FastStats Email Response Gatherer application can run on any PC in your system.

  2. Open the EmailResponseGatherer64Setup.msi from the DigitalIntegration\EmailResponseGatherer folder.

  3. Click Next.

  4. Select the check box to accept the terms, then click Next.

  5. Click Change if you wish to install the Email Response Gatherer application in a different location, then click Next.

    Note: The default directory for this is C:\Program Files\Apteco\FastStats Email Response Gatherer x64 but may be different, we recommended that you install this in your FastStats application files directory on the FastStats Application Server.

  6. Click Install .

  7. Once the installation has completed, click Finish.

Creating the Response Gatherer folders

You need to create folders to store the files to use with the Response Gatherer; these include the following types of files.

Files Associated with the Response Gatherer.

Type of file Description
Batch (.bat) Contains the information for applications like Task Scheduler or command-line programs to run the Response Gatherer on a schedule
XML (.xml) Contains the connection and communication parameters used to connect to the broadcaster
Text files (.txt) The Response Gatherer generate two log files each time it runs, an Event log with the times each event occurred, and a Details log with a step by step log of the digital response batch process with the broadcaster

You can create the directories in any user-defined location and use your own choice of name; you must refer to the directories in the batch file.

Important: The bulk insert directory must be accessible from the SQL server and the user running the SQL Server Service must have read permissions to it.

Creating the Configuration File

You need to create an XML file containing the configuration settings to use with the Email Response Gatherer; the XML file is specified in an argument when you run the EmailResponseGatherer.exe.

Note: You can use the Response Gatherer with multiple integrations by using an XML and matching batch file for each integration.

  1. Browse to the directory where you installed the Email Response Gatherer and open the EmailResponseConfig.exe, enter your Connection String and click Test.

  2. Select Instiller from the Broadcaster drop-down list.

  3. Enter the Username and Password to use with the Instiller API.

  4. Use Add to add all the required parameters for the Broadcaster.

  5. Use the File menu to save the XML file to the batch and XML file folder.

Note: Instiller is a Predefined Broadcaster, the only required parameter is the FTPURL, you can use the other fields if you need to customize the collection.

Email Response Database Configuration Parameters

Dialogue Item Settings to use
Connection String The connection string to the response database for your system
Timeout (secs) The timeout (in seconds) for the connection and query steps, the default is 1200 seconds
Bulk insert folder The location to store the results to optimize the processing of campaigns that generate large volumes of data, SQL Server can BULK COLLECT from this location
PeopleStage Connection String Used for certain broadcasters, to retrieve metadata from the PeopleStage database Not applicable with Instiller

See Email Response Gatherer Parameters for a full list of available parameters to use with the Email Response Gatherer.

Scheduling the Response Gatherer

You need to set FERG to run on a scheduled basis, provide it with the broadcaster’s communication details (in a .xml configuration file) and the location to output the Log files; this example uses Windows Task Scheduler however you can use any similar application or create Command Line (.cmd) files manually.

Creating the Batch Files

The batch files provide the Response Gatherer with the Log file directory and the name of the XML file to use.

Create or modify the batch file using Notepad++ or similar text editor, save the file to the batch and xml file directory.

Using Task Scheduler

Using the Windows Task Scheduler, you can create multiple Tasks to run the Response Gatherer on a timed basis.

To setup the Task Scheduler:

  1. Open Windows Task Scheduler.

    Tip: Search for Task in the Start Menu.

  2. Select Create Basic Task.

    Tip: You can create folders to organise your tasks.

  3. Give your task a Name and Description, then click Next.

  4. Select the Trigger interval.

  5. Enter the Start Date and Time or relevant sub-step details, then click Next.

  6. Select Start a program, then click Next.

  7. Click Browse then navigate to the folder containing your batch files. Select the file to use and click Open.

    Optional: Provide the name of the XML configuration file in the Add arguments box, then click Next.

    Note: The XML file is typically included in the batch file.

  8. Check the Summary, then click Finish.

Email Responses Wizard

When your emails have been sent out you can start analysing the responses from your target audience.

To get started:

  1. Open the Email Responses wizard.

  2. Enter the name of the message that you used in the Email Broadcasting wizard, then click Next.

  3. As the Email Response Gatherer starts collecting information from Instiller, you will see how customers are interacting with your broadcast.

    If you want to analyse this information further, check the box for Create a virtual variable from this information, then click Next.

  4. Drag the Email variable that you used in the Email Broadcasting wizard onto the drop box, then click Next.

  5. Locate the folder where you wish to store the virtual variable, then click Next.

  6. Enter any notes that will be stored along with the virtual variable, then click Next.

  7. Enter a Description for the virtual variable or drag an existing virtual variable onto the drop box if you wish to overwrite it. Modify the Security Attributes if applicable, then click Next.

  8. Click OK, then click Finish.