This job imports and processes a Control XML job package from an FTP server or SCP service.

General Information

The Control XML file contains instructions for performing a range of operations in Mapp Engage. These operations include the creation of groups, the import or update of recipients, and the creation and sendout of messages. Mapp Engage is able to receive and process instructions that are contained in an XML job package. This process is offered as an alternative to the SOAP and REST interfaces for transferring larger quantities of data. This interface uses comprehensive XML data sets that are transferred to Mapp in various ways. Together with the XML, the transfer includes other mass data like recipient lists, attachments, or images.

Instructions for creating a Control XML job package can be found on the Mapp Engage API help pages.



​Time Zone​
Specify when the job will be carried out by the system.

Defines the character encoding of the source file. The character encoding ensures that the imported text is displayed correctly. The   symbol opens a pop-up window. In the window it is possible to select from a list of all available types of character encoding.

Source File

This input field defines the file name or pattern of the Control XML file. This input field can also be used to identify different files that are uploaded to the same location. In this case, a file pattern is specified using the asterisk as a wildcard character. For example, the file pattern ​*.xml​ uploads any XML file that is uploaded to the location specified in the ​Address​ field. Complex patterns can be specified with a regular expression. The following source file types are supported:

  • XML: Job packages that do not contain references to attachments are processed as a single XML file.

  • gzip: Job packages that contain references to attachments (an XML control file that is named ​main.xml​ and optional gzip-compressed external references) are processed as a single gzip archive. Only one level of compression is supported.

Automations that upload or import files from a server process the specified files at the scheduled time, even if the source file is incomplete. Use a different file name or extension when transferring files to the server and rename the file with a script when the transfer is complete.

Credential Store Record

This input field defines the location where the import file is stored. A connection can be established with the server over FTP (FTP, PFTP (passive FTP), AFTP (active FTP), SFTP, FTPS), SCP and HTTP (HTTP, HTTPS).

This address has the following format: ​protocol://user:password@host.port/url-path​.

Example: ​​

The server account credentials can be encrypted with ​Transfer Security​ records. The user name, password or complete user account are specified with placeholders for Transfer Security records. For more information, see Credential Store Options​.



File compression

  • No compression: this is the defult setting.
  • gzip: Lets you unzip zip and gzip files. If the file to be imported is in gzip format, you must select this option.

Source Backup

Saves a backup copy of the imported data in the data system or on a server

As a general rule, Engage deletes the imported file as soon as the import is complete. If the imported data cannot be reproduced from a CRM or shop system, it is a good idea to make a backup copy when the import is finished. When this parameter is used, a default number of five backup files are saved at the specified address.

Max number of backups

Defines the number of backups.

This option sets a limit to the number of backups saved. If the number of saved files exceeds the limit, Engage replaces the oldest file. No other files should be saved in the specified directory because all the files located there are managed by the backup process.

Credential Store RecordDefines where the backups are saved.

Related Topics