Customizing JSON

If you need to customize the information contained in the files generated, you can use this topic as a reference to understand the purpose of each element.

Metadata

Holds information about global aspects of the files generated, including formatting of numbers and dates, files extensions and, data delimiters.

Element	Description	Type	Example
dates	Format options to apply to all date fields.	FormatStructure	yyyy-MM-dd
dateTimeFields	Format options to apply to all date time fields.	FormatStructure	yyyy-MM-dd'T'HH:mm:ss
dtdName	CSV/TXT files: name of the document type definition file of the XML file created. Note: DE Only	Text	gdpdu-01-09-2004.dtd
files	Options to define the file created, such as files extensions. Also includes column and record delimiters for CSV/TXT files.	FileStructure
measures	Format options to apply to all decimal fields.	MeasureStructure
recordsLimit	Maximum number of records to be processed in each asynchronous job. Default is 10,000.	Integer
isSequential	Defines the mode in which the audit file process is run, sequential or parallel. Default is sequential.	Boolean

FormatStructure

Holds information about defining format expressions for different types of fields.

Element	Description	Type	Example
format	Expression to format the value of different types of fields.	Text	yyyy-MM-dd #,##0.00

Element

Description

Type

Example

format

Expression to format the value of different types of fields.

Text

yyyy-MM-dd

#,##0.00

FileStructure

Holds information about customizing the way files are created.

Element	Description	Type	Example
columnDelimiter	Character to split columns in CSV/TXT files.	Text	;
extension	Extension of the files created.	Text	xml
recordDelimiter	Character to split records in CSV/TXT files.	Text	\r\n

MeasureStructure

Holds information about formatting of decimal numbers.

Element	Description	Type	Example
decimalSeparator	Character used as decimal point.	Text	.
thousandsSeparator	Character used as thousands separator. Note: By default no thousands separator is defined.	Text	,
decimalPlaces	Number of places after the decimal point.	Text	2

Root

Holds information about the starting element of XML files, including namespace attributes. It can also be used to define other properties such as global filters that apply to all generated files, including other file types such as CSV or TXT.

Review ElementStructure below for more information.

ElementStructure

Holds information about how an element of a file can be customized.

Element	Description	Type
name	Name of the XML tag or text file.	Text
description	Description of the content of the text file.	Text
filters	List of the filters of the element.	FilterStructure
conditions	List of the conditions of the element.	FilterStructure
fields	List of XML tags that the element contains. This is the list of columns defined for CSV/TXT files.	FieldStructure
attributes	List of attributes that the element contains.	FieldStructure
elements	List of nested elements.	ElementStructure

FilterStructure

Holds information about how the data can be filtered when files are created.

Element	Description	Type	Example
name	Name of the element field value that is used to evaluate the condition.	Text
field	Details of the field used to filter by.	ValueStructure
operator	Type of operator of the filter condition. Supported operators are defined in the SAQL reference.	Text	= >=
value	Unique value evaluated in the filter predicate.	Text
values	List of values evaluated in the filter predicate.	Text Array
isSelectionCriteria	The value of the filter is from the selection criteria fields available for the audit file: Company Name, Period From, or Period To.	Boolean

ValueStructure

Holds information about how to get data from different types of dataset fields.

Element	Description	Type	Example
field	Name of the dataset field or SAQL expression.	Text
type	Type of field.	Text	Text CustomText Numeric Integer Date Datetime
function	[Optional] SAQL function applied to the field or expression.	Text	sum unique first

Element

Description

Type

Example

field

Name of the dataset field or SAQL expression.

Text

type

Type of field.

Text

CustomText

Numeric

Integer

Date

Datetime

function

[Optional] SAQL function applied to the field or expression.

Text

sum

unique

first

FieldStructure

Holds information about how to generate tags in XML files and columns in CSV/TXT files.

Element	Description	Type	Example
name	XML files: name of the XML tag or attribute. CSV/TXT files: name of the column in the table.	Text
value	Details of the dataset field or expression generated.	ValueStructure
isRequired	The field is required for file creation.	Boolean
isKey	The field is a primary key that contains unique values.	Boolean
filters	List of filters for the field.	FilterStructure
conditions	List of conditions to render the field if conditions are successfully evaluated.	FilterStructure
hidden	XML Files: the field is not rendered if the property is enabled.	Boolean
foreignKey	CSV/TXT files: name of the table which the field is referencing as a primary key of another table.	Text
orderBy	If this property is specified on any field, data is sorted in the audit file . If orderBy is not specified, by default data is sorted based on all fields. Valid values are `asc` for ascending and `desc` for descending.	Text	orderBy: ‘asc'