Liquid XML Studio
JSON Target
See Also Send Feedback
Data Mapping > Data Mapper Functions > By Category > JSON > JSON Target

Glossary Item Box

Function Name
JSON Data Target
Category
JSON
Icon
Description
Allows data to be written to a JSON file.
Inputs
Filename

If this connection point is connected then each value is used as the filename for the JSON document.
Filenames must be local or UNC paths.
Not visible in Simple View.
(If not connected then the default filename is used - see Properties Window)

Document

A container for all the types of data the JSON Document can contain.
Should not be connected to.
Not visible in Simple View.

Root (TYPE) The root node within the JSON document. Some JSON schemas allow the root node to be different type the root entry will exist for each allowable type. For each Document only one root should be provided with a value (as a document can not have more than one root node).
Properties
General Specify the name of the Source component
Structure Specify the JSON Schema.
Source Data Specify default filename to load if neither of the inputs are connected

Usage

Allows JSON documents to created within the Data Mapper.

Creating an JSON data target

To begin, drag the JSON Target component from the JSON section of the Component Palette onto a new Data Mapper file.

This will cause the wizard to launch

 

In order to write data to a JSON document, the Data Mapper needs to be aware of its structure.

JSON Schema (IEFT drat 4)

Loads the JSON Schema from the file specified.

Infer a JSON Schema from a sample JSON document.

If you don't have a JSON Schema then you can infer one from a sample JSON document, select this option and press next.

This wizard page allows you to infer a JSON Schema from a sample JSON document.

Sample JSON filename

A JSON file containing data that is representative of the data you intend to load. The better the sample data the better the results.

As far as possible ensure that the file contains all the possible combinations of data you expect to see, and try to show objects with and without optional fields.

If your data is very complex you may need to refine the results afterwards using the JSON Schema Editor.

JSON Schema filename

The generated JSON Schema fill be written here.

JSON Schema Encoding

The encoding used to write the JSON Schema.

Force Required

Makes objects definitions required/mandatory if it that has not been identified as optional. If this is not set then all objects are declared as optional.

Infer Enums

When checked the values within objects and arrays are generated as Enumerated values using the unique values in the sample document.

so if an array contained ["true", "false", "false", "false", "true" ] this would be inferred as an enumeration with the values "true", "false".

This option works well on large sample documents, but on small sample sets it can cause the creation of values as enumerations, when in fact they should contain free text.

Infer Enum Tolerance

A tolerance factor for determining if a set of values can be considered an enumeration or free text.

They will be considered an enumeration if (NoOfSamples/UniqueValues) > InferEnumTolorence.

Array Rules

Default Additional Items

Indicates if additional items are allowed within the schemas definitions produced. This is a 3 state field.

Default Additional Properties

Indicates if additional properties are allowed within the schemas definitions produced. This is a 3 state field.

Allows you to select the output location for the JSON data that this components represents.

No default JSON Data

No output filename has been provided so one must be provided within the transform using the 'Filename' input, the resulting JSON data will be written to the filename taken from the value of this input.

Write JSON data to this file

JSON Data is written to the filename provided (the filename can be an absolute path or can be a relative path which will be evaluated relative to the transform file)

 

When the wizard is complete pressing the Finish button will created the JSON Target on the transform.

To better understand the way in which the JSON schema is translated into the JSON Writer component, see How a JSON Schema is translated into a Data Mapper Component.

The quality of the source JSON schema has a significant effect on the resulting JSON Writer Component, if the schema is poorly typed, then you will see a lot of duplicate entries (differing only by type).

Simple View

By default some of the lesser used properties of the writer are hidden, these can be shown again by right clicking and selecting "Toggle Simple View".

See Also