How to Create Automated Data Download

Automated Data Downloads allow you to generate data export files on a recurring schedule without manual intervention. Each automated job produces downloadable files (ZIP format) according to its defined schedule and can deliver them via SFTP.

You can access Automated Uploads under:

Account > Partitions > {PartitionName} > Data Management > Data Downloads > +New Data Download > Automated Download

Prerequisites

You need the following permission:

Partition Data Management – edit

When you create a new automated job, SFTP credentials are automatically created and emailed to the job’s creator. They also appear under the SFTP User Management tab (SFTP User Management).

Creating a New Automated Data Download

Automated Download consists of the four-step wizard:

1. General

Enter the basic information and choose the entity you want to export.

  • Name: Enter a meaningful name for the data download job.

  • Entity Type: Choose the Pricefx entity from which data will be exported (e.g., Customer, Product).

Once completed, click Continue.

2. Data Mapping

In this step, define what fields from the source entity should appear in the exported file and how they should be named.

The screen shows the list of available fields on the left, and for each field you can define:

  • Conversion: Apply necessary conversions where applicable (similar to manual downloads). See Advanced Field Editor.

  • Exported File Field: The name that will be used as the column header in the output file.

You may map as many fields as necessary.
When done, click Continue.

3. Filter (Optional)

Filters allow you to restrict which rows will be included in the exported file.

You can create:

  • Individual filter rules

  • Nested groups

  • Match-none groups

The file will contain only data records that match the filter conditions.

Click Continue when finished.

4. Additional Options

This step defines:

  • The automation schedule

  • Additional export behavior (batching, file naming, incremental export)

  • Notifications

This is the most important step for automated jobs.

Download Schedule

Here you define how often the job should run and when the first run will occur.

Timezone

Select the timezone in which the scheduled run time should be interpreted.
Execution is internally processed in UTC but displayed in local time.

Interval Type

Supported interval types include:

Interval Period

Defines the numerical interval (e.g., every 1 day, every 4 hours, every 2 months).

Starting At

Select the time of day when the job should execute.

First Run Preview

The UI shows a live calculation of the next upcoming execution time based defined schedule.

Advanced Options

Do not include header record in the output file: Enable if your integration does not require a header row.

Delimiter Character: Choose the delimiter for the exported CSV file.

Maximum Data Batch Size: Large exports are processed in chunks.
Default: 50 000 rows per batch.

File Size Options

Set maximum number of lines per file: If enabled and set, files are split after the specified number of lines.

The maximum number of files generated by a single Data Download execution is limited to 100 files.

Add file counter suffix when multiple files are exported: Appends a sequence number to file names.

If Maximum number of lines per file is set but Add file counter suffix when multiple files are exported is disabled, only one file is exported. Each new file overwrites the previous one, so only the last file remains.

File Naming Options

You may choose a custom naming pattern for generated files.

Define custom name pattern for the downloaded file: Enable this option to manually configure the file name format.

Downloaded File Name
Base name of the output file.
You may use the following tokens, which PlatformManager replaces automatically with real values:

  • {object-type} – the exported object type (for example, Product, Customer, Price Parameter)

  • {object-name} – the object/table name for extension objects

  • {timestamp} – the time of export, formatted according to the timestamp format selected below

Example: export_{object-type}_{timestamp}

If the field is left blank, the default file name is used.

Timestamp Format Used in File Name: Defines how timestamps are inserted when the {timestamp} token is used.
Default: yyyy-MM-dd'T'HHmmss

Incremental Export

If the Download only data modified after a certain date option is enabled, only data modified after a specific date will be included.

Data to Be Downloaded

This field controls how the system decides which records qualify as “modified.”

You can choose from two options:

1. Data modified since last download

Exports only the records that have changed after the most recent successful execution of this automated download job.

Warning:
If the previous run failed, the system still uses the timestamp of the last successful run. Internally, the comparison is strict:

record.timestamp > lastSuccessfulRunTimestamp

This means changes that occur between the start and end of an export run may not be included in that run.
This behavior is by design and matches other batch-export mechanisms.

It means that it is possible that some records are never exported when using incremental export. If a record is modified during the time window between the start and the end of an export run, and no further modification occurs afterward, that record will not be included in any export.

2. Data modified after date in custom timestamp column

Exports only the records whose value in a specific timestamp column is later than a chosen reference date.

Use this when:

  • Your data contains custom update timestamps, such as:
    lastModified, updatedAt, priceChangedAt, etc.

  • You want to control the timestamp manually.

  • You want the export to rely on a business-specific timestamp rather than system metadata.

After selecting this option a field appears where you choose the custom timestamp column name. The export compares values in that column against the reference date or the last stored timestamp.

Custom Timestamp Column Requirements

  • The column must contain parseable timestamps in an ISO-like format, for example:

yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd'T'HH:mm:ss.SSS

  • The T character between date and time is literal and must not be replaced.

  • Timezone offsets (e.g. +01:00) or Z for UTC are accepted.

  • If a timestamp cannot be parsed, the row is skipped.

For extension tables, use the column name (internal field name), not the label. Labels and label translations are UI-only and are not recognized by the export logic.

Notifications

You may configure notifications to alert you when:

  • The automated download completes

  • The download fails

Notifications can also be added later after creating the job.

To define the notification, follow these steps:

  1. Click New Notification.
    The Add Notification dialog appears.

  2. Enter a Name for the notification.

  3. In Trigger By (State), select one or more states that should trigger the notification.

    • Success

    • Error

  4. In Emails for notifications, enter one or more email addresses.
    PlatformManager sends a notification email to all listed recipients when the selected state occurs.

  5. Click Create.

The notification is added to the Automated Download configuration and will be applied to all future executions.

Saving the Automated Download

Click Save to finish creation.

The job will now appear in Data Management > Data Downloads (see Downloads) with:

  • Type: Automated

  • Frequency: Human-readable schedule (e.g., “Every 2 days at 14:00”)

  • Next Download: First predicted execution time

Execution Behavior

Each scheduled run generates a downloadable ZIP file.

The system logs:

  • Start and end of execution

  • Outcome (success or failure)

  • Error message if applicable

  • File identifiers

Failure does not stop future scheduled runs.

Editing an Existing Automated Data Download

You can modify an existing automated Data Download to adjust its configuration without recreating the job.

Open the automated download

  1. Go to Account > Partitions > {Partition} > Data Management > Data Downloads.

  2. In the Data Downloads table, locate the the job you want to updated (where Type = Automated).

  3. At the right end of the row, open the three-dot menu and select Edit.

This opens the Edit Automated Download dialog for the selected job.

What you can edit

When editing an existing automated Data Download, you can change the following:

  • Mapping

  • Filter

  • Additional options

    • Download Schedule

    • Advanced Options

After making your changes in the relevant tabs, click Save. The job keeps its history but will use the updated configuration for future runs.

See Also