Toggle menu

Data Exporter Configuration

The Data Exporter has a single configuration end point, primarily used to hold SFTP details. These details are picked from the scheduling form so that configuration can be held in a single place, and passwords don't need to be entered into the form.

Namespace

The Configuration End Points article explains the principles of holding product configuration in End Points.

You should create configuration for each of your environments at config.<environment>.DataExporter.getConfig

Properties

NameTypeDescription
dataSourcesVersionStringBy default the exporter always runs as the latest version and this property should be null.
sftpDetailsArray <objects>An array of sftp details. See below for an example
upgradeProcessInstanceBooleanUsed with the upgradeSchedulesToLatestProcess end point to enable a support fix

Example

There's an example configuration end point at config.example.DataExporter.getConfig which you can copy into your other environment namespaces.

Details

function(params, credentials) {
    return {
        sftpDetails: [{
                "key": "first_sftp",
                "display": "First SFTP",
                "path": "transfer/myFolder/",
                "password": "password2",
                "port": 22,
                "host": "127.0.0.1",
                "createFolder": "",
                "user": "test"
            },
            {
                "key": "second_sftp",
                "display": "Second SFTP",
                "path": "transfer/myFolder/",
                "password": "password2",
                "port": 22,
                "host": "127.0.0.1",
                "createFolder": "",
                "user": "test"
            }
        ]
    };
}

Each object in this array provides an option in the scheduling form drop-down:

SFTP Details

They are:

PropertyDescription
keyA unique identifier for this configuration
displayThe display text for the drop-down field
pathThe path you enter should already exist on the SFTP host. Depending on your server it may need to end in a forward slash. Use "/" for the root
passwordThe SFTP password
portThe port
hostThe host
createFolderIf you enter a name here a new directory will be created with that name
userThe SFTP username
Last modified on 22 July 2025