4me Help
Export Fields

Export Fields

The table below lists the fields of the Export form and provides utilization guidelines for each field.

Field Label Utilization Guideline
Name

The Name field is used to enter a short description of the export.

Disabled

The Disabled box is checked to temporarily stop the recurrence of the export.

State

The State field is automatically set.

The options are:

  • Scheduled – The export run has been scheduled in accordance with the recurrence schedule.
  • Queued – The export run has been added to the queue and will start as soon as the jobs that are ahead of it in the queue have been processed.
  • Processing – The export file(s) are currently being generated.
  • Done – The export run has been completed.
Completed at

The Completed at field indicates when the export run was performed.

Download

The Download field provides the link with which the export file can be downloaded.

Download expiry date

The Download expiry date field indicates when the export file will no longer be available for download.

System log

The System log field provides the link to the system log entry that was generated for the export run.

Next run

The Next run field is automatically set to the date and time at which the next export will run based on the schedule defined in the Recurrence section.

Run as

The Run as field is used to select the account administrator in whose name the export should run.

The email notification that gets sent out when an export run has been completed is sent to the primary email address of the person selected in this field.

Strategy

The Strategy field is used to specify whether all records of the selected types need to be exported (i.e. a Full export), or if only the records that were created or updated since a specific moment need to be exported (i.e. a Partial export). When a recurrence schedule is used, it is also possible to specify that only the records that were created or updated since the last run need to be exported (i.e. an Incremental export).

Note that full exports cannot be performed more frequent than once every 23 hours for record types of which more than 10,000 records exist in the account.

Changes since

The Changes since field is available when the “Partial” option has been selected in the Strategy field. It is used to specify the date and time since when a record needs to have been created or updated to be included in the export.

Time zone

The Time zone field is used to specify the time zone that is applied to the Changes since field.

Types

The Types field is used to select the record types that need to be included in the export. Check the “Select all” box to select all record types.

Line encoding

The Line encoding options are set to “Unix” by default. This ensures that only the line feed (LF or 0×0A) control character is placed at the end of each line of the CSV file(s) that the export generates. When the “Windows” option is selected instead, each line of the CSV file(s) will end with both a carriage return and a line feed (CR and LF or 0×0D and 0×0A) control character, as is typical for Microsoft Windows.

Recurrence
Repeats

The Repeats field is used to select the frequency with which the export is to run.

Every

The Every field is used to specify whether any days, weeks, months or years (depending on the option selected in the Repeats field) should be skipped following a run of the export before the next run is started.

For example, if the Repeats field is set to “Daily” and the Every field is set to 1, then the export will run every day. If the Every field is set to 2 instead, then the export will run every other day.

On

The On field is used to select the days of the week on which the export should run.

Each

The Each field is used to select the days of the month on which the export should run.

In

The In field is used to select the months in which the export should run. If the On the field is not selected, then the export will run in the selected month(s) on the day of the month specified in the Start date field.

On the

The On the field is used to specify on which day of the month the export should run.

Weekday

The Weekday field is used to select the weekday on which the export should run.

At

The At field is used to specify the time at which the export should run.

Time zone

The Time zone field is used to specify the time zone that is applied to the At, Start date and End date fields.

Start date

The Start date field is used to specify the date on which the recurrence schedule of the export becomes effective.

End date

The End date field is used to specify the date after which the recurrence schedule of the export stops being effective.

Last Runs
Last runs

The Last runs table field lists the last 10 export runs that were processed in accordance with the recurrence schedule.