Adding a New Basic Data Query

This section shows a very basic data query, made of a Search operator and a ResultSet operator.

This task shows you how to:

See Also
Adding ENOVIA Security to Your Data Query
Creating Input Parameters
Configuring Visualizations

Add a SEARCH Operator First

You begin the processing graph of your data query, by adding a Source operator, typically the SEARCH operator.

Before you begin: You have created a data perspective and switched to Edit mode.
  1. From the left panel, click Data.
  2. Click Add data query.
  3. Right-click the central panel, and select an operator from the panel.

    For example, Sources > Search.



    The central panel shows the selected operator. A red alert icon appears when the operator requires some configuration.

    A panel also opens on the right to let you specify the configuration.

    Important: To get information about the various operators, click their tooltip icons.

  4. Define the required parameters of the operator.

    For example, for the Search operator, you must define a Variable. To do so, you must select and Index unit and a class. You can only select the Index Units created on the same tenant, and shared with users having the Data Analyst role. By default, you see the 3DSpace Index Unit.

For most use cases, you then add Transformation operators to the processing graph to transform the stream of items.

Add a ResultSet Operator at the End

RESULT SET is the terminal operator to use at the end of your processing graph. It represents an output of the data query. It has many features to help you format your data and render it in a visualization.

A Result Set is made of one or several views. A View represents a projection of your data. Usually, you may need one View per graph or visualization displayed in your app.

Tip: The RawView is the simplest one. You can start with that view if you want to use the ResultSet operator quickly.

  1. In the central panel, add another operator linked to the first operator.
    1. Drag the point at the output the operator.



    2. Select an operator from the panel (see step 3).

      For example, select Terminal > RESULT SET.

    3. Configure the new operator.

      For example, for ResultSet, click Auto fill fields.

      Fields are added to the operator automatically.
  2. Verify the output of your data query by selecting a view.

    A view represents a projection of your data. The selected view allows you to format outgoing data and display it when you click Run.

    Tip: It is better to add one view per chart or any other visualization displayed in your data perspective.

    1. On the right of the Result Set panel, click .
      A list of possible views displays.

    2. Select a type of view. For example select, Add table view.

      There are three types of views. Each of them is suitable for different use cases.

      View Type Description
      Raw view

      This is the simplest view. It returns data in JSON, without any formatting, and it requires a few settings only.

      It is suitable to display:

      • Output data without any complex settings.
      • Polymorphic data, that is a stream of elements that do not support the same attributes.
      Table view

      This view displays data in a table.

      Specify the fields for which you want to have table columns.

      This view provides filtering and sort features that are based on the columns.

      It is suitable to display:

      • Data in a table visualization.
      • Data with a known structure.

      Cube view

      This view creates data partitions and processes aggregations on them.

      Define axes and aggregations.

      An Axis provides pagination and sort features.

      It is suitable to display data in charts, for example, line chart, pie chart, heatmap, etc.

    3. Click Run
      A panel opens, displaying a tab with the entire server response in JSON, and tabs corresponding to the view you selected. For example, you can have a table view, showing the fields you specified in columns.

  3. From the top bar, click Save and Apply.
    The operator displays in the central panel, linked to the first operator.
  4. You can now apply your data query to one or more visualizations.
    1. From the left panel, under Presentation, select a screen.
    2. Select a visualization.
    3. Select a Data Query.
      The right panel refreshes to display all the parameters of the selected visualization.