Skip to main content
Version: Next

Option Formats

Some data fields that you export from an event or a collection give you a choice to pick a desired output format. The syntax for these fields is:

+++= data-field.option

DateTime Formats

When using a time-based field like archivedAt, createdAt, updatedAt, or deletedAt, you must specify a datetime option to output a specific datetime format.

The syntax follows +++= dateTimeField.dateTimeOption, where dateTimeOption can be any of the entries in the following table:

Date Time OptionOutput Example
dateTimeLocalOctober 15th, 2022 at 11:06 AM
dateTimeLocalTZOctober 15th, 2022 at 11:06 AM PDT
dateTimeUTCOctober 15th, 2022 at 6:06 PM UTC
dateLocalOctober 15th, 2022
dateLocalTZOctober 15th, 2022 PDT
dateUTCOctober 15th, 2022 UTC
shortLocal10/15/2022
shortLocalTZ10/15/2022 PDT
shortUTC10/15/2022 UTC
isoDate2022-10-15T18:06:55Z
shortLocalTZ10/15/2022 PDT
shortUTC10/15/2022 UTC
isoDate2022-10-15T18:06:55Z
timeLocal11:06 AM
timeLocalTZ11:06 AM PDT
timeUTC11:06 AM UTC
tip

For example, to export a collection's CreatedAt field in your local date time with a timezone, use +++= createdAt.dateTimeLocalTZ.

User Formats

Specific user information can be included using the following options:

User OptionOutput ExampleNotes
id70d3d3a6-8c52-4483-8610-e4da9192775cN/A
firstNameJohnN/A
lastNameDoeN/A
emailjdoe@cogility.comN/A
roleThreat AnalystN/A
fullNameJohn DoeN/A
fullNameAndEmailJohn Doe (jdoe@cogility.com)N/A
fullNameAndRoleJohn Doe (Threat Analyst)N/A
groupsGroup One, Group TwoN/A
createdAt.dateTimeOptionDateTimeSee Datetime Formats
deletedAt.dateTimeOptionDateTimeSee Datetime Formats
updatedAt.dateTimeOptionDateTimeSee Datetime Formats
lastLoginAt.dateTimeOptionDateTimeSee Datetime Formats
tip

To get the name of a collection's assigned user and their email in two separate lines, use the following:

+++= assignedToUser.fullName +++

+++= assignedToUser.email +++

To loop through all participants and output their full name and last login date in local time (at the time the export was performed):

+++FOR person IN participants +++

+++= $person.fullName +++

+++= $person.lastLoginAt.dateTimeLocal +++

+++END-FOR person+++