Applies to: Kyvos Reporting

The Query Object Editor is the design interface for creating, editing, and managing Query Objects. It guides you through configurable steps—such as Data Source, Join, Union, Filter, and Format—to shape your dataset and preview results as you work.

This page shows how to open the Query Object Editor and walks through its main UI areas and options menu actions. It also covers the basics for working in the editor and creating a new Query Object.

To access the Query Object Editor, go to the Reporting home, and select Navigate > Design > Query Object. The Query Object Editor screen is displayed.

Open

The Query Object Editor includes the following sections:

• Steps Selector: The left pane where you can drag and drop required steps, such as Join, Union, and Format, to design the Query Object in the editor pane.

• Editor or Transformation Area: The central pane that represents the design of the current Query Object. By default, the Data Source and Format steps are displayed in this area when you begin designing.

• Properties Tab: Located at the bottom left, this tab allows you to edit properties of the selected item in the editor, such as Data Type, Length, and Locale.

• Result Tab: Located at the bottom right, this tab shows the data result set processed up to the currently selected step.

• Options Menu: The top menu provides action buttons for CRUD operations and other actions.

Options Menu Actions

• Save: Save changes made to the Query Object.

• Help: Access help documentation for query objects.

• Actions menu (More Options):

  • Add: Create a new Query Object.

  • Save As: Save the current Query Object under a different name.

  • Open: Open an existing Query Object using a selector dialog. Expand the folder, then double-click or select the Query Object name and click Open.

  • List View: View Query Objects in a list format.

  • Detailed View: View Query Objects with detailed information.

  • Refresh List: Refresh the list of Query Objects fetched from the repository.

  • Advanced: Access advanced steps (refer to the Advanced Steps section).

  • Delete: Delete the currently opened Query Object from the repository after confirming. This action is irreversible.

Working with the Query Object Editor

The Editor section provides a canvas for designing Query Objects.

• Naming the Query Object: Double-click the Untitled Query Object text at the top of the screen to rename the query object.

• Default Steps: When you create a new Query Object, two steps—Data Source and Format—are automatically added to the editor. An edge line with an arrow depicts the flow of data between them.

• Adding Steps: Drag a step from the Steps Selector onto the editor. Join the new step to another step by drawing a line in the direction of the data flow. You can also double-click a step to add it directly to the editor.

• Inserting Steps: Drop a new step onto an existing edge line to insert it between two connected steps. For example, to insert a Filter step between Data Source and Format, drop the Filter step on the connecting line.

• Multiple Data Sources: You can include multiple Data Source steps in a Query Object. Steps like Join can take two inputs, and steps like Union can take more than two inputs.

• Viewing Results: At each step, use the Result tab to view the processed data set up to the selected step.

Adding a New Query Object

1. On the Query Object Editor, click the Add icon.

2. Select Query Object.

3. The Query Object Designer screen appears, where you can design the new Query Object.