Skip to main content

Get help for ARIS

JSON

Extracts data from a JSON file.

Maximum size of a JSON source file

A JSON source file is limited to: 80 MB

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 176.

    Example

    https://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 177.

    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 dynamic value (CTRL + Space)

Inserts a dynamic value into the URL using an ARIS parameter. Place the cursor in the URL, press CTRL + Space and select a parameter from the list.

You can specify the parameters, for example the default value. Click ARIS parameters in the editor header > Configure.

Settings

Displays additional options.

  • Shared caching

Enables the use of a shared cache when multiple users access the same document. This option is available if you specified a document as a data source that is deployed in ARIS Document Storage (ADS). The option is enabled by default. If you disable the option, you must specify HTTP basic authentication instead.

  • HTTP basic authentication

Specifies an HTTP basic access authentication.

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

The option is available, if you disable Shared caching.

  • Refresh rate

Specifies the time until the data source is read in again. Default value is 12 h.

  • HTTP headers

Adds HTTP headers to the URL.

Click + Add header and specify HTTP headers.

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.

More 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

List of data source columns. Click Edit Column configuration to configure 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.

Click Detect to automatically read the columns of the data source. The requested columns lists are displayed, based on the specified repeating object.

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.