Working with Data Connectors: JSON Get

This generic data connector primarily operates using the GET method, enabling HTTP requests to access data hosted on a server (HTTP/HTTPS).

To initiate these requests, Viz Flowics requires a specific URL that encompasses the necessary access information, including the token, for seamless data retrieval.

Requests for data updates can be made manually from the remote control or automatically every n seconds. For more information on data updating, please review the acquisition style configuration of this data connector. 

Requirements

  • The App ID or authentication token must be added to the URL.

Warning

Authentication based on headers is NOT supported


Supported Sources

This data connector supports getting content from the following file formats:

  • JSON
  • CSV (header data is read by default, with comma delimiter)
  • TSV (tab delimiter, with the first row as header)

The charset must be correct and declared in the HTTP response headers. This is crucial for interpreting the text correctly, especially when dealing with data in different languages or encoding formats.

JSON, CSV, and TSV files all support data coercion, which allows users to get the correct data type for each property. For example, if the value of a property is "123," it may be returned as a string, number, array, or object. Viz Flowics automatically converts the property to a consistent data type, ensuring that all data is represented uniformly.

Info

All files must be hosted on an HTTP or HTTPS server.

Here is an example of a JSON and a CSV for you to examine the structure and even create test graphics with these samples:

Simply copy the URL and paste it into the URL field in the dataset settings of this data connector. Find more detailed instructions below in this article.


Allowed Ports

As mentioned earlier, it's essential to host all files on an HTTP or HTTPS server. This requirement means that the JSON Get Connector is specifically configured to connect to ports 443 and 80, corresponding to the HTTPS and HTTP protocols, respectively.


Adding the Data Connector to the Graphics Editor

  1. Add an External Connector to the Elements Tree
  2. Click on Connect

    3. From the External Source panel, select 'JSON Get'.

Setting up the JSON Get

You will be prompted to configure the dataset settings:

  • Acquisition Style: Choose how to control data updates. This allows you to decide whether to synchronize data from the remote control manually (Attended) or enable automatic data updates periodically (Unattended).

Be Aware

The minimum unattended data update time is 30 seconds. It is NOT possible to configure a data update time less than this.

  • JSON, TSV, or CSV URL: Insert the URL hosting the content.

  • Schema: After adding the URL and setting the acquisition style, the next step is to add the schema. You have two options:

    • Generate from Example: Viz Flowics will generate the schema for you. Simply click on 'Generate Schema from Example.'
    • Direct Input: In case you have created your own schema, simply paste it into the box.

    • In either case, click 'Create' at the end.

JSON Get example graphics

With the data now set up, you can start creating your tree with our building blocks, binding content, and formatting the Graphics. 

In the example, we created a "Scorebug" for a baseball game with the information of the previous JSON.

Was this article helpful?