User Defined Documents (UDDs)
User defined documents (UDDs) are custom reports that you define through IronPython scripts. Once placed in a Lib directory, you can access the scripts via the Create Document command. The scripts describe a Create User Defined Document dialog box that lets you specify trace and solution inputs. After you confirm your input selections, XML, HTML, and PDF documents are generated. A web browser window opens to display the generated HTML file. The created document appears in the Project Manager, under Results in the Documents folder.
The general UDD process flow is as follows:
The UDD Python scripts must be placed in the UserDefinedDocuments directory under either of syslib, userlib, or Personallib with any subdirectory structure needed. The Lib directory can contain Python scripts that have common code that other scripts can use.
Use
The UDD scripts that are in syslib/UserDefinedDocuments, userlib/UserDefinedDocuments, or
Personallib/UserDefinedDocuments are available through the
Create User Defined Document Dialog Inputs
User defined documents allow data from traces, solutions, and
report types as inputs. A UDD can specify the named inputs, which you
select or enter the values of in the Create User Defined Document
dialog box that displays when you run
Input Types can be of Boolean, number, text, trace, or solution type. The boolean, number, and text type can be given a default value that you can interactively override when the document is created or modified. For example, you can select a trace when you create or modify a UDD document. The trace data is available to the user and can be accessed from the Python script.
At the time of selection, you can choose from the Reporter dialog box the report type (Standard, Eye Diagram, User Defined), solution name, context, and the quantity for which you want the trace data.
Input Type can also be Solution. You can select an entire solution when the document is created or modified. The solution data in its entirety is now available to the user and can be accessed from the Python script.
At the time of selection, you can choose from the reporter dialog the report type (Standard, Eye Diagram, User Defined), solution name, and context. A specific quantity cannot be selected since data for all quantities in the solution are available.
The Category/Quantity/Function portion of the dialog is disabled for user input.
UDD Document Creation and Display
After all the input selections for a UDD are confirmed, based on the script, XML, HTML, and PDF documents are generated based on the inputs provided by the user. (The XML, HTML, and PDF generation is based on specific calls in the Python script, which are explain in a following section.) A web browser window also opens to display the generated HTMLfile.
The created document will be placed under a new folder named Documents under the Results folder. All documents that are created by the user for the design will be placed under this folder.
