No Results

A JSON Feed will parse target JSON data and bring in a tabular dataset. The feed will be designated as a JSON feed in the data pipeline as seen in the following screenshot.

Configuring JSON Feed

Step 1: Create a Connection

Perform the following steps to connect to a data directory on the local server:

  1. Click .
    The Connections page is displayed.
  2. Click + in the lower-left corner to create a new connection.
    A pop-up for choosing a connection type is displayed.
  3. In the pop-up, select File / Server Filesystem connection type.
  4. Click Use Selected.
    A new page is displayed.
  5. In Connection Name, enter a name for the connection.
  6. Make sure the Enable Connection toggle is on.
  7. In Server Path, provide a relative path from the installation folder of edgeCore.
  8. Click Next.
    You are taken to the Test Connection tab where the confirmation message Connection test was successful is displayed.
  9. Click Save and Close.
    The newly created connection is displayed in the list of Connections.


Step 2: Create a JSON Feed

Now that you have established a connection to a directory of files, you can create a Feed from a specific JSON file.

Perform the following steps to create a JSON Feed:

  1. Click .
    The connection you created is displayed in the Pipeline.
  2. Click the gear icon button in the connection box and select + .
    A pop-up for choosing a Feed Type is displayed.
  3. In the pop-up, select JSON.
    A new page is displayed.
  4. On the Base Configuration tab, do the following:
    a) In Feed Name, enter a name for the feed.
    b) (Optional) Provide a description.
    c) In File Name, select the .json file. In order for the .json file to appear in this dropdown, it needs to be located in the data folder of the edgeCore build.
    d) In File Encoding, select the encoding of the file.
    e) Enable or disable the Preserve Data Types toggle switch. If enabled, data types defined in the data source will be preserved. If disabled, all values will be interpreted as strings.
    f) Enable or disable the Convert Null Values to Empty Strings toggle switch. If enabled, null values will be converted to empty strings.
    g) In Attribute Depth Limit, specify how many levels of nesting the server will go when parsing the data. Higher values can lead to longer processing times if the data contains deeply nested objects.
    h) In Record Sample Limit, specify the number of records evaluated by the server during attribute discovery and data preview. Lowering this value may improve processing times when dealing with exceptionally large data sets. To disable the limit, set the value to -1.
    i) (Optional) Enable the Advanced Update Scheduling toggle switch if you want to define an advanced schedule for updates.
    j) In Poll Interval, specify how often you can access the data for a feed and also how often the data changes (in seconds). If a server subscription is active (another user is using that node or a server job is making it active), the current data retrieved will be returned. It will not refresh until all server-side subscriptions are closed and a new one is open. If you set the poll interval to 0, that means the data is very static, and you do not expect it to change.
    k) (Optional) Turn on the Enable Server Subscription toggle switch in order for data for this feed to be continually fetched, updated, and cached based on the Poll Interval. If enabled, the server will subscribe to the feed, just as a client widget would. This means that the data and any resources that would otherwise be allocated “on-demand” for the first user to view a Visualization that leverages the data produced by this feed are allocated when the server is started and maintained as long as this feed is configured.
    l) (Optional) Enable the Persist toggle switch to use persistent table store.
    m) (Optional) Enable the Publish Dataset via REST API toggle switch to allow other edgeCore servers or third-party software to connect to this server’s pipeline.
    n) Click Next. You are taken to the JSON Parser tab.
  5. The JSON Parser tab consists of the following:
    a) JSON Path: here you define how to parse the target JSON data; Use Goessner’s JSON Path to select portions of the JSON you want to include in the resulting dataset.
    b) Raw Data: shows the raw JSON data from the source file. Use this tab as a reference when writing the JSON Path syntax.

    c) JSON Path Results: shows the resulting JSON data after parsing it with the supplied JSON Path syntax. To update, click the Test button in the JSON Path field, then toggle back and forth between Raw Data and Results to validate your JSON Path syntax.

    d) Exposed Values: shows a list of all discovered attributes from the JSON Path Results. Any attributes in this list will be used in converting the data to a tabular format.
    e) Download Raw: enables you to save a copy of the raw data as a JSON file. The file will be downloaded directly to the local machine, similar to any other file that one would download from the browser.
    f) Click Next. You are taken to Tabular Data Preview where you can observe the data preview of your JSON Feed.
  6. Click Save and Close.
    The newly created feed is displayed in the Pipeline.


Uploading JSON Files through the User Interface

edgeCore version: 4.3.7

To upload JSON files to feeds without having to access the server, click + next to File Name.
Make sure the file extension matches the feed type (in this case, the extension needs to be .json).
Once uploaded, the JSON file will be available in the File Name dropdown.

Terms | Privacy