If you provide a value for Report Category for Classified Objects on the custom method, then when that method is called, the software searches for template documents with the same value in the Report Category property and the Object Classification. If one or more templates are found with the above combination, the software considers the object condition specified on each of the template documents and finds the condition that matches the object that the method was called from. The template document with the matching category and condition is used to generate the OpenXML Word report.
If the object that the method was called from does not meet the conditions set on any of the template documents with matching report category and object classification values, the software navigates up the classification tree from the classification of the selected object and looks for a matching template document with that classification. This process continues until a template is found that matches both the report category and condition of the object or until it reaches the root classification.
This behavior is explained using the following example.
You create two template documents with the following properties:
|
Name |
Report category |
Object classification |
Object condition |
|---|---|---|---|
|
Template 1 |
DocumentRevisions |
3D Documents |
IsReserved |
|
Template 2 |
DocumentRevisions |
3D Documents |
IsIssued |
You also create the following objects:
-
A method that has DocumentRevisions as the value for the Report Category for Classified Objects
-
Documents with a subtype of Civil Details in both the Reserved and Issued states
When you generate an OpenXML Word report for any of these design documents, the software looks for the matching template document with the Object Classification of Civil Details and Report Category of DocumentRevisions. Because there is no template document with this combination, the software navigates up the classification tree to the parent classification of Civil Details that is Civil, and looks for a template document that has an Object Classification of Civil and a Report Category of DocumentRevisions.
If the software does not find a template document with this combination of values, it navigates up another level to the parent classification of Civil that is 3D Documents, and looks for a template with the Object Classification of 3D Documents and Report Category of DocumentRevisions.
The software finds two template documents with a matching combination of values, so it evaluates the conditions of each template document and uses the template with the condition that matches the object the method was called from.
The software ignores the filtering process (described above) if the custom method includes a value in the Template Document Name box, this template document is always used to generate an OpenXML Word report with
the custom method. Any value specified in the Report Category for Classified Objects box is ignored.