TQL Query Editor

This feature enables you to build and edit TQL queries.

To access

To open a new TQL query in the TQL Query Editor, go to the Modeling Studio, click the New button and select Query.

To open an existing TQL query in the TQL Query Editor, go to the Resources tab of the left pane in the Modeling Studio and select Queries as the Resource type. Right-click a TQL query in the tree and select Open Query or double click a TQL query or drag a TQL query onto the empty canvas. The TQL query opens in a new tab.

Important information To save your TQL query, use the Save button on the Modeling Studio main toolbar.
Relevant tasks How to Define a TQL Query
See also

User interface elements are described below (unlabeled elements are shown in angle brackets):

UI Element (A-Z) Description

Show View Results in IT Universe. Goes directly to the selected view in IT Universe Manager.

Note This button only appears for views, templates, or perspectives.

Create Relationship. Enables you to draw a relationship from one query node to another.
Calculate Query Result Count. Calculates the number of instances found for each TQL query node or relationship.
Preview. Displays a preview of the TQL query results as they would appear in IT Universe Manager.
Delete. Deletes the selected query node or relationship from the query.

Query/View Definition Properties.

For queries, opens the Query Definition Properties dialog box which enables you to edit the type, scope, and priority of the TQL query.

For views, opens the View Definition Properties dialog box.

Report Properties. Opens the Report Properties dialog box, which enables you to set the title, subtitle, and format for the view's topology report. For details, see Report Properties Dialog Box.

Note This button only appears for views, templates, or perspectives.

Assign Tenants. Opens the Assign Tenants dialog box which enables you to assign tenants to the resource.

Note This button is only available when multi-tenancy is enabled.

Manage Security. Enables you to assign the selected resource to specific roles or resource groups.

Show Parameters. Opens the Template Parameter Values dialog box which enables you to edit the parameters of a query node in a template-based view.

Note This button only appears for template-based views.

<Legend>

Indicates the icons displayed next to CIs with any of the following special designations:

  • It is defined as a contact query node in a perspective

  • It is a federated CI

  • It has attributes defined

  • It has selected identities defined

  • It is hidden in the query results

  • It is defined as the output query node of a pattern-based model

  • It has a subgraph defined

<Main menu> For details, see Main Menu.
<Shortcut menu options> For details, see Shortcut Menu Options.
<Topology Map Sidebar> For details, see Topology Map Sidebar.

Advanced Pane

This area displays the properties, conditions, and cardinality for the selected query node and relationship.

Important information

The Advanced pane appears in the lower part of the window in the following managers and user interfaces: Modeling Studio, Impact Analysis Manager, Enrichment Manager, the Input Query Editor and Trigger Query Editor in DFM.

A small green indicator appears next to the tabs that contain data.

Relevant tasks

User interface elements are described below:

UI Elements (A-Z) Description
If the window is not wide enough to display all the tabs, use the left and right arrows to move to the required tab.
Click Show List to display a list of the available tabs for the current module. You can select a tab from the list.
Attributes Displays the attribute conditions defined for the query node or the relationship. For details, see Attributes Tab.
Cardinality Cardinality defines how many query nodes you expect to have at the other end of a relationship. For example, in a relationship between a node and an IP Address, if the cardinality is 1:3, the TQL query retrieves only those nodes that are connected to between one and three IP Addresses. For details, see Cardinality Tab.
Data Sources

Displays the data sources set for the selected query node.

Note This tab appears only in the Modeling Studio.

Details

Displays the following information:

  • CI Type/Element Type. The CIT of the selected query node/relationship.

  • Element Name. The name of the query node or relationship. This appears only in the Modeling Studio.

  • Show in query results. A green check indicates that the selected query node/relationship is visible in the topology map. A red mark indicates that it is not visible. In the Modeling Studio, this is indicated by the word Yes or No.

  • Include subtypes. A green check indicates that both the selected CI and its children are displayed in the topology map. A red mark indicates that only the selected CI appears. This item does not appear in the Modeling Studio.

Edit Click Edit to open the relevant dialog box for the selected tab.
Element Layout

Displays the attributes selection for the selected query node or relationship. It lists the attributes selected to be included in the query results (when Specific Attributes is selected as the attributes condition). It also lists the excluded attributes and any selected qualifiers for attributes. For details, see Element Layout Tab.

Note This tab appears only in the Modeling Studio.

Element Type

Displays the subtype conditions defined for the query node or relationship. For details, see Element Type Tab.

Note This tab appears only in the Modeling Studio.

Enrichment Rules

Displays the Enrichment rule defined for the selected query node or relationship. If the Enrichment rule is used to update the attributes of a CI, click Edit to open the Query Node/Relationship Definition dialog box and edit the rule if required. For details, see Query Node/Relationship Definition Dialog Box.

Note This tab appears only in Enrichment Manager.

Impacted Query Nodes

Indicates which query node is impacted by the changes that occur in the selected trigger query node. If required, you can click Edit to open and modify the Impacted Query Nodes dialog box. For details, see Impacted Query Nodes Dialog Box.

Note This tab appears only in Impact Analysis Manager.

Qualifiers

Displays the qualifier conditions defined for the query node or the relationship. For details, see Qualifier Tab.

Note This tab appears only in Enrichment Manager and Impact Analysis Manager.

Selected Identities Displays the element instances that are used to define what should be included in the TQL query results. For details, see Identity Tab.