The Scheduler

Name

Set a name for the scheduled export and a name for the file (which will be automatically appended with the timestamp of the export).

File Type

The File Type drop-down lists all of the available file types you can export the data as. Each type exists as a "file generator" end point in the Data Exporter's goss.DataExporter.fileGenerators namespace. The standard types are CSV and JSON.

Data Source

The data you export is found in the platform's History service. You can choose whether you want to export directly from history, export from digested histories (see History Digests for more information), or use custom end points to perform the export.

History

The history data source exports histories that have been created or updated within a certain time period. Pick "History" as the data source to see a drop-down list of every history "labela" value. Pick the type of history you would like to export.

If you don't enter a labelc value (in the advanced section below), the exporter will assume a labelc: null. It's not possible to export all labelc type histories for a given labela record.

When you are setting up a schedule for the export:

• The start date of the schedule determines the maximum age of the histories that will be exported
• The export range is calculated from when the schedule runs, back to your chosen start date OR the date the schedule last ran
• Histories that have been updated or created between these two dates are exported

For example, if your schedule runs daily, each export will include any histories that have been updated/created in the past day.

Volumes of Data
The exporter is designed to run regularly, perhaps on a daily or weekly basis, exporting new data written since the last export. Exporting large volumes of data will have an impact on performance.

Advanced - Label C

Enter the labelc value of the specific histories you would like to export. Leaving this blank assumes a labelc of null, excluding any histories with a labelc value (ie blank doesn't mean "all").

Advanced - Date Filter

Choose whether history records created or updated in the export time period will be exported.

Advanced - Flatten history

The "flatten" history option will only display the most recent value for an event field, rather than every value. For example, if you have a value in an event which gets updated multiple times, only the final value will appear.

Advanced - Refine history

This option is designed to remove "duplicate" events from your histories by excluding any history events that don't have a historyDescription property (see History Data Conventions).

The workflow related form fields have the option to write "summary" events, and these events contain a copy of all of the form data submitted so far during the workflow. They also always include a historyDescription. If you are only interested in these events, tick this box.

If you are exporting data written by the History - Write Event form field (ie it doesn't relate to a workflow process), you can either choose not to "refine" the history, or you can add a historyDescription in the field settings.

History Digest

Pick a history digest from the list to export all of the digested history data. The exporter looks for a column called lastupdated in your digest, so make sure you include one when you use registerDigest().

End Point

All of the end points in the goss.DataExporter.dataSources namespace are listed here. You'll find any product specific end points we have written listed here.

Export Types

Choose whether the export should be stored in the platform to be downloaded using the Data Exports Template, emailed, or posted somewhere via SFTP. These options are configured later in the form.

Take care using email. You should not email anything that contains personal data. Email attachments are also subject to file size limits (around 30MB).

Configure a Schedule

This option lets you create a repeating schedule, or run a one-off export.

Schedule

Tick this box to set up a schedule later in the form (see the The Scheduler - Scheduling page later).

One Time

Clear the box if you are creating a one-off export to run now. This lets you enter a start and end date to define the range of your export:

On-demand exports set to run now cannot be used with the file store option (because they are not stored) - they can only be emailed or posted via SFTP.