JSON

Extracts data from a JSON file.

The following parameters are available.

Parameters

Description

Source

JSON file

  • URL: HTTP address of the source file

    If another operator supplies the URL dynamically, the URL cannot be edited here.

    Example

    http://myhost.company:1080/documents/rest/links/03388871-367d-4abe-a2c9-37bc9fa44580?tenantid=default&revision=1

  • URL alias: Loads the file from a resource directory. Files must be located in a defined resource directory on the server. The data source files are located in a folder or a sub-folder of the ARIS document storage accessible in the ARIS Repository.

    If you have updated ARIS 10.0 Service Release 1 to version 10.0 Service Release 2, you need to recreate the URL alias that WAS defined for ARIS 10.0 Service Release 1. Delete the URL alias at first and add a new URL alias with the same data.

    Path prefix (alias): Alias of the resource directory with the path to a directory on the server. Select an alias of the local resource directory, for example, Feed URL.

    Feed URL is the alias of the resource directory of the default data feeds provided in ARIS.

    In the input box, enter a path to the relevant data source file for the Path prefix (alias) selected.

    Example

    /documents/rest/links/03388871-367d-4abe-a2c9-37bc9fa44580?tenantid=default&revision=1

To configure a Path prefix (alias), see Configure Dashboard server for details.

To store data source files in a resource directory, see Upload file based data sources for details.

To copy the source file URL, see Upload file based data sources for details.

Insert parameter (Insert parameter)

Inserts user defined input parameters at the cursor position. The button is only clickable if at least one user input parameter, for example, Text user input, has been inserted in the feed definition.

Parameter options (Parameter options)

Enables you to set input parameter options

Refresh rate ()

Specifies the time span before the source file is read in again. The default value is 30 sec.

Authentication

Specifies the credentials for authenticating to access the source file.

Single Sign-On is preset for authentication if you select URL alias to access the source and Single Sign-On is enabled for the selected Path prefix (alias). Click Authentication if you want to change the settings.

Single Sign-On:

Enables you to access the source file using Single Sign-On (SSO). SSO only works within ARIS and not for files provided by external data sources, such as an external web page. For details on how to configure SSO, see Configure single sign-on.

HTTP basic authentication:

Specifies an HTTP basic access authentication.

User name and password are required for accessing the source file.

HTTP headers

Adds HTTP headers to the URL

Repeating object: Detect

Reads out the repeating object automatically. A repeating object already set by a user will not be considered. The detected columns are displayed in the Columns box depending on the repeating object.

JSON object that is repeated for each row;

You can edit the repeating object manually.

Specify a valid XQuery 3.1 lookup expression, for example,

?catalog?journal?articles?*

?data?rows?*

?catalog?books?*

A JSON document is loaded as a nested structure of maps and arrays. The above expressions use the (terse form of the) map/array lookup syntax as follows:

- The initial '?' is a unary lookup operator that selects a named member of the root map

- Further '?' are postfix lookup operators

- '?*' selects all members of an array, for example, '?5' selects the fifth element of an array.

For more information about the lookup syntax, see https://www.w3.org/TR/xquery-31/#id-lookup.

Advanced parsing options

Charset: Character set in which the source file is coded. This can be set manually if the extracted data refers to a different coding type.

By default, the HTTP response encoding is used if available, otherwise UTF-8 is used.

EMML parsing: Parses values in the same way as they are parsed in EMML. This affects parsing of numeric and date values. It affects whether a specific value is understood as a date or numeric value, because different sets of date patterns and locales are used. If this option is activated, dates without an explicit time zone are assigned to the server's default time zone. If this option is deactivated, they are assigned to GMT.

Columns: Detect

Reads out the columns of the data source automatically. The requested columns lists are displayed, based on the specified repeating object.

Configure columns

Configures the columns list. Deselect a column to exclude it from the result data. If you enter a New name for a column, it is used instead of the original column name in the result. If you click Reset columns, the column list is reloaded from the data source and all changes in the list are undone.

If you use an absolute URL, for example, http://myhost.company:1080/documents/rest/links/03388871-367d-4abe-a2c9-37bc9fa44580, an authentication has to be set. All requests to the uploaded file are made with the specified user/password combination.

If you use a relative URL, for example, /documents/rest/links/03388871-367d-4abe-a2c9-37bc9fa44580, an authentication is not required. All requests to the uploaded file are made with the current logged in user.