Skip to main content

Voyado Engage

File based integration

When using file-based integrations, one or more files should be transferred periodically via FTPS to Voyado. The periodicity is usually set to once every hour by default but can be adjusted per instance and method according to the specific needs in the project. If the Voyado FTP server is unresponsive, it’s up you, the sender, to re-attempt the transfer until it’s been successfully received.

The process

Importing data to Voyado:

file-based-integration-1.png

Exporting data from Voyado:

file-based-integration-2.png

When the import batch job is triggered, Voyado will begin processing files and import the transactions. Once a file is processed you will be able to see the status of the import on the Integration log (see image below). The processed file will then be deleted from the FTP folder.

file-based-integration-3.png

Constraints

We recommend a maximum of 20 000 contacts/transactions per file in order to guarantee correct consumption of the files without the risk of timeout. This is not a hard limit but should definitely be seen as a strong recommendation.

Caution

Keep the number of contacts/transactions per file under 20 000.

Encoding and XML syntax

The encoding of the files must be UTF-8.

All XML-files should follow the scheme specified per import type (Contacts import, Receipts import). It is also strongly recommended (but not mandatory) to follow the XML-syntax provided per object. When these field names are followed, no client specific XSLT transformation needs to be done on the Voyado side of the integrations.

FTP access - staging

URL: ftps://ftp.voyado.com/[objectSpecificFolder]

Port: 22

Your username and password are assigned by your Voyado team.

FTP access - production

URL: ftps://ftp.voyado.com/[objectSpecificFolder]

Port: 22

Your username and password are assigned by your Voyado team.