How to find Query ID for use in Dashboard Templates
I am creating a new Dashboard Template with several viewlets of Work Items. In the web interface this is pretty easy - you click "Edit" and select the query. In the Dashboard Template definition section in Eclipse, you need to enter a query ID. How do I find the ID of the query I wish to add? There is nothing in the query definition listing an ID.
I tried using the ID seen in the browser when the query is run, for example:
com.ibm.team.workitem.runSavedQuery&id=_Vy1oYCKVEeCLuq6uR-B1GA
or just:
_Vy1oYCKVEeCLuq6uR-B1GA
But those did not work. "The work item query does not exist" is the result when I create a new dashboard from that template.
2.0.0.2 i5
I tried using the ID seen in the browser when the query is run, for example:
com.ibm.team.workitem.runSavedQuery&id=_Vy1oYCKVEeCLuq6uR-B1GA
or just:
_Vy1oYCKVEeCLuq6uR-B1GA
But those did not work. "The work item query does not exist" is the result when I create a new dashboard from that template.
2.0.0.2 i5
6 answers
Hi Mike,
Currently you can only point work items viewlets in Dashboard Templates at predefined queries that exist in the process for the project area and have an id associated with them in there. Here's an example of the configuration data for a predefined query in the Jazz Foundation project area:
When configuring a work items viewlet in your template to use this query, the id you would use is "com.ibm.team.workitem.queries.predefined.openCreated". So in order for you to achieve what you are after, you will have to define the queries you want in the process for your project area and give them a unique id.
Currently you can only point work items viewlets in Dashboard Templates at predefined queries that exist in the process for the project area and have an id associated with them in there. Here's an example of the configuration data for a predefined query in the Jazz Foundation project area:
<configuration-data xmlns="http://com.ibm.team.workitem/queries" id="com.ibm.team.workitem.configuration.queries">
<query name="Open created by me" description="Work items I have created which are open or in progress" id="com.ibm.team.workitem.queries.predefined.openCreated">
...
</query>
</configuration-data>
When configuring a work items viewlet in your template to use this query, the id you would use is "com.ibm.team.workitem.queries.predefined.openCreated". So in order for you to achieve what you are after, you will have to define the queries you want in the process for your project area and give them a unique id.
Hi Mike,
You can add your existing queries to the process for the project and assign them an id using the project editor where you create your dashboard templates. Open the Project Editor and switch to the Process Configuration tab. Then expand Project Configuration > Configuration Data > Work Items > Predefined Queries. From there you can add any of your existing queries to the list, select them and populate the Identifier attribute in the details panel.
This is the identifier you will need to use to reference them in your dashboard templates.
You can add your existing queries to the process for the project and assign them an id using the project editor where you create your dashboard templates. Open the Project Editor and switch to the Process Configuration tab. Then expand Project Configuration > Configuration Data > Work Items > Predefined Queries. From there you can add any of your existing queries to the list, select them and populate the Identifier attribute in the details panel.
This is the identifier you will need to use to reference them in your dashboard templates.