Skip to main content

Create and schedule multi-export tasks

Scheduler task guide

Package multiple exports into one scheduled delivery process.

Create a multi-export taskDirect link to Create a multi-export task

Configure the output locationDirect link to Configure the output location

Create a multi-export task and set the Local directory where NIM will write the generated files. Configure the field delimiter and other file-format options. Use a dedicated directory if the task will create an archive for SFTP delivery.

Step 1 of 3

Select filters or audit queriesDirect link to Select filters or audit queries

Despite the Filters section name, a multi-export row can use either a filter or an auditing query. Use filters for current data selected from connected systems and auditing queries for recorded change history. For each row, choose its Resource type, Resource name, and File name. Give each output a distinct filename so the resulting files are easy to identify.

Set local output optionsDirect link to Set local output options

OptionWhat it controls
Local directoryDirectory on the NIM server where export files are written. The adjacent Append control can help build the directory value.
Include headersWrites column names as the first row of each file.
Dates as UTCOutputs date values in UTC rather than local time.
Carriage Return and Line FeedSelect the line-ending characters. Enable both when the recipient expects CRLF line endings.
Field delimiterCharacter used to separate fields, such as a comma or pipe. Match the receiving system's expected format.

Protect output with PGPDirect link to Protect output with PGP

Enable PGP file encryption and select the recipient's public PGP encryption key or keys from the list. If the recipient also needs to verify that NIM produced the files, enable PGP file signing and select the appropriate NIM signing key. The keys must first be available in Configuration > Settings > Certificates.

Choose Armored (text) for .asc output or Binary for .gpg output according to the recipient's requirements. Agree on the file format and test decryption before scheduling delivery. See PGP encryption and signing for key setup and ownership.

Deliver files by SFTPDirect link to Deliver files by SFTP

Enable Upload results to remote SFTP host when the files should be transferred after creation. Configure Remote directory, Host name, Port, Username, and Password for the receiving SFTP server. Confirm the account can write to the remote directory before relying on the schedule.

SFTP optionsDirect link to SFTP options

OptionWhen to use it
Compress files to single archivePackage files from the local directory into one archive for upload. Enter the Remote archive file name when this is enabled.
Use custom ciphersSelect ciphers when the SFTP host requires a specific supported set.
Use custom KEX algorithmsSelect key-exchange algorithms when the SFTP host requires a specific supported set.
Debug SFTP connectionEnable temporarily while diagnosing a failed connection, then review the NIM logs.
Check the archive contents

The archive can include unrelated files already present in the local directory. Files that were not generated by this task may not have PGP protection. Keep the export directory dedicated to this task and inspect a test archive before enabling a schedule.

Use a custom date formatDirect link to Use a custom date format

Use {date_format:...} in a multi-export directory or filename, for example doc_dept_employees_{date_format:MM_DD_YYYY_HH_mm}.csv. The format supports Day.js display-format tokens.