Upgrade Modes for Query Builder Report Templates Authored Before Windchill 11.0
The QML (query markup language) structure has been modified for Windchill 11.0. The updated QML (query markup language) format provides more seamless integration with the Report Builder user interface when users run reports and lays the groundwork for future enhancements.
If a report was originally created in a release before Windchill 11.0, it was written using the old QML format. The first time the report is run in Report Builder or edited in Query Builder in 11.0, it is automatically upgraded to the current QML format in standard mode. No additional action is required from users.
If you have a report from a release before Windchill 11.0, and want it to appear to users in the same manner that it appeared before Report Builder was introduced, you can choose to upgrade the report using one or both of the other upgrade modes: legacy mode or single date mode.
Standard Mode
Upgrading a report in standard mode results in the following changes to the report template:
|
As specified on the Criteria tab of the pre-11.0 Query Builder
|
Result after upgrade to current QML
|
|
Parameters whose column in the criteria matches a column in the select clause.
Exceptions:
• The parameter is used in a function or a sub-select query
• The parameter is used multiple times in the criteria clause
|
These parameters are combined with the matching column in the select clause, including any specified default or constant values, and take the display name of the select clause column. That is, the parameter now appears as a Column item on the Select or Constrain tab of the report template, with the Display Name of the item as specified on the Select or Constrain tab. Any constant or default value specified in the old QML is populated to the Value property (as a Constant value or Default value) for the column in the Edit Column window.
The parameter reference in the criteria clause is replaced with a Report Attribute Reference item on the Criteria tab, referring to the item on the Select or Constrain tab.
|
|
Any two date parameters against the same date column (one with a < or <= operator, and one with a > or >= operator).
Exceptions:
• The parameters are used multiple times in the where clause
• The parameters are used in a function or in a sub-select query
• The parameters appear under a Not or Or boolean condition in the criteria clause
|
The two date parameters are combined into one date column in the select clause, using the column for the parameters that was specified in the criteria clause.
That is, the date parameters are a single Column reportable item on the Select or Constrain tab of the report template. Any constant or default specified in the old QML is populated to the Start Date or End Date properties (as a Constant value or Default value) for the column in the Edit Column window.
Dates display in the Report Builder criteria pane as a single entry with input fields for both start date and end date.
|
|
Any other parameters:
• Parameters that do not match items in the select clause
• Parameters that are used in a function or sub-select query
• Parameters that are used multiple times in the criteria clause
• Parameters that appear under a Not or Or boolean condition in the criteria clause
|
These parameters are moved to the select clause. That is, each parameter is now a Parameter Value item on the Select or Constrain tab of the report template.
These new items are placed at the top of the Select or Constrain tab, and appear at the top of the Report Builder criteria pane. This makes them easy to locate within the report template, to move or edit as needed.
The parameter reference in the criteria clause is replaced with a Report Attribute Reference item on the Criteria tab, referring to the item on the Select or Constrain tab.
|
The Report Builder Options for each item now on the Select or Constrain tab are set as follows:
• Allow user to specify criteria is selected (An input box for the user to enter criteria is displayed on the criteria pane of the Report Builder)
• Allow user to decide is selected (a checkbox appears next to the item on the criteria pane of the Report Builder, allowing the user to select whether that item is included in the report results)
As a result, all items now on the Select or Constrain tab for the report template appear in the criteria pane of the Report Builder when viewing the report, and can be selected or specified by the user.
Reports are automatically upgraded in standard mode the first time they are run in the Report Builder or opened for editing in the Query Builder.
Legacy Mode
Upgrading a report in legacy mode sets the Report Builder Options for each item on the Select or Constrain tab of the Query Builder so that the criteria pane of the Report Builder appears the same way as it did before Report Builder was introduced.
For those items which were parameters on the Criteria tab in the old Query Builder with a corresponding column in the select clause, the Report Builder Options are set as follows:
• Allow user to specify criteria is selected (An input box for the user to enter criteria is displayed on the criteria pane of the Report Builder)
• Always include is selected
(The item always appears in the report results)
For those items which were parameters on the Criteria tab in the old Query Builder but do not have a corresponding column in the select clause, the following is true on the criteria pane of the Report Builder:
• An input box is always displayed for the user to enter criteria.
• No checkbox is displayed for the user to select the field in the report results. Parameter values are never included in the report results.
• No operator displays for the parameter value. The operator specified Criteria tab is used in the query.
For all other items on the Select or Constrain tab of the report template, the Report Builder Options are set as follows:
• Allow user to specify criteria is not selected
• Always include is selected
All other changes described for standard mode apply for legacy mode.
Single Date Mode
Upgrading a report in single date mode means that the from and to dates for a date parameter date range are not combined into a single parameter value on the Select or Constrain tab, but are kept as individual parameter values. On the criteria pane of the Report Builder, they appear as individual criteria fields, rather than as a single row with active left and right values for the date range.
All other changes described for standard mode apply for single date mode.
Legacy Mode and Single Date Mode
If both Legacy Mode and Single Date Mode are selected, both upgrade modes are applied. Date parameters displayed in Report Builder as a result of the Legacy Mode settings are kept as individual parameter values, as described for Single Date Mode.