File and FTP

Note: To use this functionality, your organisation must have the Broadcaster bundle or above.

FTP and File channels can now be set up via Orbit Channel Editor. Once set up they are visible in PeopleStage and Orbit to use and modify.

Setting up an FTP channel in Orbit

In Application Settings, click Campaigning Channel Editor.

The types of channels that can be defined are listed under the Communications folder, including email, File, and FTP.

To set up an FTP channel:

  1. Navigate to the FTP folder and click Create New.

  2. On the Create New screen, select FTP Channel from the drop down menu.

  3. Give the channel a name and select which folder the channel should be created in.

    Note: If you have chosen Create New from the folder itself, then the folder location is updated to reflect this.

  4. Click Create.

Populating the Channel Details

Basic details such as the FTP URL need to be populated. An FTP also has an associated username and password associated that needs to be added here for Apteco to upload the file during the export process.

Note: Once the FTP password has been entered for the first time, it is hidden from the user. An Update Password option appears and a new password can be added and saved.

Additional output settings can be applied in the Output Settings tab, including the option to add a communication key (unique ID) and replace the file which is on the FTP as part of the upload process. More details regarding these settings can be found here.

File settings relate to the format of the output file. Settings such as file format, delimiters, zip file requirements and enclosers can all be specified here. These settings are applied to the file during the export process.

Additional Variables allow the user to add output fields to the export file exported every time the FTP channel is used. These output columns are created by adding variables from Apteco software.

To add a variable to the file output, click + Add Variable.

Search for the variable required. If the name of the variable needs to be changed for output purposes, then this can be added in the Variable Description Override.

Note: The variable name is used as the column header in the output file unless specified in the Variable Description Override.

The choice to show codes as the output or the description of the field can be changed in the Show Category Values.

Depending on the type of variable, the Formatting can be changed. Postcode in this example is a text field and the formatting can be changed to upper, lower or title case if required. The formatting options of other variables changes depending on how they have been defined in Apteco.

Add as many variables as required to be standard fields always output as part of using the File channel and click Apply.

Once added, you can choose to always append these fields at the end or the beginning of the file by placing a tick in Append additional variables directly.

After all settings have been added, click Save All Changes to update the channel.

Using the FTP channel in Orbit

To use the channel,

  1. Navigate to Export tab in Audiences:

  2. Select the FTP channel from the drop down menu and choose Export.

  3. Amend the file name if required.

  4. Set the Campaign schedule.

  5. Choose Export.

Setting up a File Channel in Orbit

To create a new File channel in Orbit

  1. Navigate to the Application Settings - Campaigning Channel Editor.

    Note: Here a new Item can be added or a new channel can be created by clicking on Create New on the applicable channel folder.

  2. In the Create New screen, select File from the drop down menu.

  3. Give the channel a name and save it in the required folder location.

  4. Click Create.

Populating the Channel Details

Start filling out the Basic Details by specifying a folder path for each file to be saved in during the Export process. The file is saved within the FastStats File Explorer in either the public or private folder.

In Output Settings, select whether adding a communication key to the output for reference is required. It is here that you can also specify whether you wish to replace any previous files exported or whether a new one is saved alongside the previous versions.

File Settings contains options regarding the file output format. Here you can specify options such as the type of file format, any delimiter, or encloser requirements and whether the file should be zipped on export.

Lastly, Additional Variables can be added to ensure that they are output every time the channel is used in the exporting/campaigning process.

To add a variable to the file output, click + Add Variable.

Search for the variable required. If the name of the variable needs to be changed for output purposes, then this can be added in the Variable Description Override.

Note: The variable name is used as the column header in the output file unless specified in the Variable Description Override.

The choice to show codes as the output or the description of the field can be changed in the Show Category Values As option.

Depending on the type of variable, the Formatting can be changed. Postcode in this example is a text field and the formatting can be changed to upper, lower, or title case if required. The formatting options of other variables changes depending on how they have been defined in Apteco.

Add as many variables as required to be standard fields always output as part of using the File channel and click Apply.

Once added, you can choose to always append these fields at the end or the beginning of the file by placing a tick in Append additional variables directly.

After all settings have been added, click Save All Changes to update the channel.

Using the File channel in Orbit

Note: To use this functionality, the organisation must have the Broadcaster bundle or above licensed.

To use the channel:

  1. Navigate to Export tab in Audiences.

  2. Select the File channel from the drop down menu and choose Export.

  3. Amend the file name if required.

  4. Change the Folder Path to change where the file is saved.

  5. Set the Campaign schedule.

  6. Choose Export.