This information is for planning purposes only. The information herein is subject to change or removal without notice before the products described may become available.
The CE/CLM products were renamed in version 7.0. As the help is updated to reflect the changes, the topics might contain inconsistencies. For details on the name change, see Renaming the IBM Continuous Engineering Portfolio.


Finding global configurations by using queries

Build queries to find global configurations that meet the attribute conditions 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.

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 that are 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 is 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 queries 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 box field at the top of the page, enter a name for your query.
    Use a descriptive name so that team members can find your query easily.
  3. On the Conditions tab, build your query.
    When you build your query:
    • The current project area is selected by default. However, you can choose to build your query across multiple project areas. For more information, see Creating queries across project areas.
    • 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 that are derived from the configurations that meet the conditions you specify.
    • Search for only archived configurations by clicking Show archived configurations Icon showing books and binoculars. A new Archived query condition is added that supplants the Show archived configurations toggle for query results. The advantage of adding this condition is that it can be saved with the query. It has three values: true (for archived configurations), false (for active configurations), and either archived or active (for both). If your query doesn't include the archived condition, the results would show only active configurations, preserving the behavior of prior releases.
    • Operator for non-existence of query.
    • Operator for existence and non-existence of tags attribute.
  4. Optional: On the Details tab, provide a description of the query so that it can be easily identified 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 in which the columns are shown on the Columns tab, matches the order that 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 that include 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.

To add the query to your Favorites list, click the star icon beside the query name.

View the list of other queries by clicking Browse Queries.

Creating queries across project areas

Create queries that run across multiple project areas in the same repository.

About this task

A new query runs against the current project area by default. However, you can choose a set of project areas for querying. When multiple project areas are selected, the query results show all matching configurations from these chosen project areas. The attributes that are available to use for the conditions and result columns are a combination of attributes from the selected project areas.

The query editor collapses the equivalent attributes (having the same URI and data type) from different project areas. But it flags the following conflicts in the attribute names:

  • Equivalent attributes with different names.
  • Non-equivalent attributes with the same name.

Procedure

  1. On the banner, click the Queries menu.
    You can create a new query or browse to an existing one, and edit it.
  2. Click the value of the Project Areas field.
    A window opens with the list of all project areas that you are a member of.
  3. From the list, add a set of project areas of your choice, and click OK.

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.

Finding global configurations that have external or local contributions

Add conditions to your query to discover global configurations that have external or local contributions.

About this task

You can add query conditions to find global configurations that have external or local contributions. You can also learn about how to enable GCM servers to contribute configurations to other GCM servers.

Suppose you are a Configuration Lead who is managing the reuse of components across multiple GCM servers and want to review the existing usage of external contributions in a particular GCM instance. Using these query conditions, you can find global streams that have external contributions in their hierarchy. You can also look for global baselines that don't have a local configuration as a direct child.

Note:
  • An external contribution is a global configuration from another GCM server.
  • A local contribution is a configuration from an IBM Engineering Lifecycle Management application.

Procedure

  1. On the banner, click the Queries menu.
    You can create a new query or browse to an existing one, and edit it.
  2. On the Conditions tab, click Add Condition.
  3. Choose External Contributions or Local Contributions from the first drop-down and select an operator of your choice from the second drop-down.
    Note: The External Contributions option is only available if the collaborating GCM servers are enabled. For more information, see Enabling GCM servers to contribute configurations to other GCM servers.
  4. Choose in the hierarchy or direct children from the next drop-down as required.
    If needed, you can add more conditions to this query.
  5. Click Run to view the query results.

Using subquery as a condition

About this task

Procedure


Running queries

Query results show all global configurations from the set of project areas that are selected at the time of query creation.

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, click the icon (Table columns) at the right of the query results table, or right-click the column headings. You can also apply these temporary changes to the results of the query that you don’t own. 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. Select the Project Area result column from the list to identify the source of the matching configurations.

Add to Favorites: To add the query to your Favorites list, click the star icon beside the query name.


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