Generate-Report
The Generate-Report webject executes a Windchill report and returns the results as an Info*Engine group.
 |
You cannot use the Generate-Report webject to execute a report template that has the following conditions:
• Soft types or attributes.
• The GENERATE_TYPE_INTANCES parameter is set to TRUE.
• The template includes the following QueryBuilder features:
◦ Multiple classes exist and one or more of the classes is not contained in an explicit join. This means one or more classes are not listed on the Join tab.
◦ Criteria subselect is used. This means Sub-Select is selected from the Type drop-down menu on the Criteria tab.
|
Syntax
<ie:webject name="Generate-Report" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GENERATE_TYPE_INSTANCES" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INPUT" data="name=value"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PURGE_DEFAULT" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="REPORT_REF" data="ufid"/>
<ie:param name="UNFORMATED" data="dataType"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GENERATE_TYPE_INSTANCES" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INPUT" data="name=value"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PURGE_DEFAULT" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="REPORT_REF" data="ufid"/>
<ie:param name="UNFORMATED" data="dataType"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|---|---|---|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
CONTAINER_REF
|
ATTRIBUTE
|
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
|
GROUP_FILTER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
|
PASSWD
|
FORMAT
|
|
|
REFERENCE_EXCEPTIONS
|
GENERATE_TYPE_INSTANCES
|
|
|
REPORT_REF
|
GROUP_IN
|
|
|
WHERE
|
GROUP_OUT
|
|
|
WHERE_CASE_SENSITIVITY
|
INPUT
|
|
|
PURGE_DEFAULT
|
||
|
REFERENCE_DELIMITER
|
||
|
REFERENCE_OUTPUT_DELIMITER
|
||
|
UNFORMATTED
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see the Common Webject Parameters section in Adapter Webjects Overview.
|
CONTAINER_REF
A Windchill context to apply the webject against. This parameter accepts the following types of input:
• The UFID of a Windchill context. Multiple UFIDs can be specified for this parameter.
• MEMBERSHIP—The query finds only those contexts of which the user is a member.
When this parameter is specified, the scope of queries executed against the TYPE and WHERE parameters are restricted to the associated context.
GENERATE_TYPE_INSTANCES
Specifies how data is added to the output group. If specified as TRUE, report result output is generated as TypeInstances. If specified as FALSE, the report result output is generated as tabular, relational data where each row is an element and each column is an attribute. The default for this parameter is TRUE. This parameter is optional.
GROUP_IN
The name of the input group containing one or more objects whose attributes are retained in the output group and whose reference attributes will be dereferenced.
The GROUP_IN parameter value can be obtained from Query-Objects webject specified within the same task file. This parameter can be specified instead of or in addition to TYPE, WHERE, or OBJECT_REF.
GROUP_OUT
The name of the output group produced by the webject. If not specified, the name assigned to the output group is “wt.query.report.” This parameter is optional.
INPUT
A name and value pair that serves as input to the specified report templates. It can be specified more than once to provide more than one name and value pair. If it is not specified, no input is provided to the report templates.
If the parameter is specified, then each value must be of the form name=value where “name” is the name of a report template parameter, and “value” is the associated value of the parameter. This parameter is optional.
PURGE_DEFAULT
Specifies whether to purge the suggested values from the return group. The default value for this parameter is FALSE.
If the parameter is set to TRUE, it purges the suggested values from the return group. This parameter is optional.
REPORT_REF
Specifies the Unique Federation Identifier (UFID) of a report template. It can be specified more than once, if you want to select more than one report template. If more than one value is specified, all of the referenced report templates are executed, and the output group contains their combined results. The class name for a report template is wt.query.template.ReportTemplate.
If this parameter is not specified, the WHERE parameter must be specified. If both this parameter and the WHERE parameter are specified, then all report templates referenced by REPORT_REF and queried by WHERE are executed, and the output group contains the combined results.
WHERE
Specifies a Windchill query specification that selects the report templates to be executed. If this parameter is not specified, the REPORT_REF parameter must be specified.
If both this parameter and the REPORT_REF parameter are specified, then all report templates referenced by REPORT_REF and queried by WHERE are executed, and the output group contains the combined results. For additional information see Specifying the TYPE and WHERE Parameters