Finding global configurations by using queries

Build queries to find global configurations that meet the attribute conditions that you specify. With queries, you can work more efficiently by selecting multiple configurations at a time to complete tasks such as editing attributes or tagging configurations. Only global configurations from the same project area as the query are returned.

Before you begin

  • You must be logged in to a global configuration management project area.
  • To share your queries with other project area members, you must have the Configuration Lead role or higher, or the Create shared queries privilege.
  • To modify and delete the queries written by other project area members, you must be assigned that privilege.

About this task

You can build conditions for both built-in attributes and custom attributes. Attributes might be used differently by teams, even within the same project area: different teams might use different sets of attributes. So even after an administrator defines a custom attribute for configurations, it might not be added to all configurations yet. For example, if your configuration lead defines a custom attribute named Approver to indicate that a configuration has been reviewed and approved, this attribute is likely added to, and set, only on configurations that are reviewed and approved.

Global Configuration Management (GCM) queries are not published to Report Builder. To create across artifacts, project areas, or servers, build queries in Report Builder.

Procedure

  1. On the banner, click Queries and click the query type to create.
    • Personal query, which only you can edit and run
    • Shared query, which all project area members can run (you must have permission to create shared queries)
    Tip: You can also click Browse and create queries on the Welcome page.
  2. In the text field at the top of the page, enter a name for your query. Only query names are searched; use a descriptive name to help team members find your query easily. To add the query to your Favorites list, click the star beside the query name.
  3. On the Conditions tab, build your query. When you build your query:
    • From the top menu in the query editor, choose whether all or only some conditions must be met.
    • Click Add Condition and then build the condition by using the menus. To add a group of conditions, click Add Group.
    • Move conditions by dragging them.
    • You can specify a condition for any attribute in a global configuration or component, except for attributes that use the String (Large) data type.
      Note:
      • You can't query custom attributes that are large strings. If you need to query that information, replace those attributes with new ones whose data type is a small or medium string, or an enumerated data type. See the related topic about replacing large strings.
      • If you want to create a condition but no existing attribute reflects what you need, ask your configuration lead to consider adding a custom attribute to the configuration or component artifact type.
    • You can also specify conditions based on attributes of these related items: components, parent configurations, and configurations derived from those that meet the conditions you specify.
    • Search for only archived configurations by clicking Show archived configurations Icon showing books and binoculars.
  4. Optional: On the Details tab, provide a description of the query so it's easy to identify in a list. Query descriptions are not searched.
  5. On the Columns tab, in the Result Columns section, choose which attributes to show. The order the columns are shown in this section matches the order they are shown in the results. To sort the query results, select the attribute to sort on, and then specify the sort order. You cannot sort on String (Large) types.
  6. Click Save. By default, the query is saved on the My Queries tab, where only you can see it.
  7. Click Run.

Example

Your company builds vehicles including sports cars and pickup trucks, each with their own project area that contains many global components. Configurations in this project area have an attribute named Engine, which has multiple values: hybrid, high-performance, and electric.
Example 1. In the SportsCar project area, you want a list of baselines whose Engine attribute is hybrid. Add these conditions:
  • Condition 1: Choose Configuration Type, is any of, and Baseline. Then, click Add Condition.
  • Condition 2: Choose Engine, is any of, and hybrid. Then, click Run.
Example 2. Return the list of streams and baselines that are derived from any stream whose engine is hybrid. Add these conditions:
  • Condition 1: Choose Configuration Type, is any of, and then select Stream and Baseline. Then, click Add Condition.
  • Condition 2: Choose Created From Configuration > Engine, is any of, and then select hybrid.

Example 3. Return the configurations that are assigned to the team areas that you belong to. Choose Team Area and I'm a member of.

What to do next

To complete tasks (such as tagging or editing attributes) for multiple configurations at a time, select the configurations from the list of results; then, click the Actions menu beside one of them and select the task to complete.

View or work with a specific configuration tree by clicking a configuration name.

Add tags or edit attributes of multiple configurations at time by selecting configurations in the results list; then, click the Actions menu beside one of them and select the task.

Edit a configuration by clicking its name, and then click Edit in the configuration editor.

View the list of other queries by clicking Browse Queries.

Sharing queries with project area members

Create queries that any project area member can run.

Before you begin

You must have the Create shared queries privilege.

About this task

After you share a query, you can't make it private again. Instead, you can save a copy of it to the My Queries tab and then delete the original query from the Shared Queries tab.

Procedure

  • Create shared queries from these locations:
    • On the banner, click Queries, and in the Create Query section, click Shared Query.
    • From the Shared Queries tab on the Queries page, click Create Query > Shared Query near the upper right.
  • Share existing personal queries from the My Queries tab: click a query name, and then on the results page, click Share near the upper right.

Running queries

Query results show only global configurations from the same project area as the query.

Procedure

Complete one of these steps:
  • On the Welcome page, click Browse and create queries, and explore the queries on the tabs.
  • On the banner, click Queries and click a query.
  • In the Add Configurations dialog box, select the Global Configuration Management application and a project area; then, click the menu beside the search field, choose a query type (private or shared) and choose a query.

What to do next

Edit attributes and tag configurations: Select the check mark beside a configuration name and click Actions > task.

Add or remove attribute columns: To make a temporary change to the results shown, or if you don’t own the query, click the icon (Table columns) at the right of the query results table, or right-click the column headings. You lose your choices when you leave the results page. To save your column choices, edit the query or ask the query owner to edit it.


video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki