Model Documentation Editor
The Model Report of PowerDesigner is a model-based, project-oriented overview document, which provides a flexible and rich model document editing interface, and realizes the whole process of designing, modifying and outputting model documents.
The functions of the model document are as follows:
- Generate standard or custom documentation for individual models and output as RTF or HTML formatted files
- Utilize the document template editor to provide unified, customized templates for model documents, similar to Word's template functionality
- Internationalization of model documents by providing various languages for model documents using document language editors
- Either single-model documentation can be generated for each model, or multi-model documentation can be generated for several models
The document model editors include: document template editor, document editor, multi-model document editor and language document editor.
Document Template Editor
(1) Select the Report-Report Templates (or Tools-Resources-Report Templates) command to open the List of Report Templates window (these templates are installed in the <PowerDesigner 15 installation directory>\Resources Files\Report Templates directory)
(2) Double-click Available Items (valid option), the selected option will be automatically added to the Template items (options included in the template) column on the right, and you can edit it by right-clicking. After editing, select the File-Save command to save the modifications made to the system-provided template.
(3) You can also create a new document template yourself. Click the New icon in the interface shown in the above step (1) to open the Report Template Type window, you can define the template name, language and type, click ok to enter the template definition window, double-click the option in the Available Items column, select The options will be automatically added to the right column, and then edit it and save it.
document editor
The documentation editor is used to define the structure of the generated documentation for a single model. The documentation structure indicates the content of the generated documentation. Model documentation can also be output to a printer or to RTF and HTML formatted files. The following describes the process of CDM document generation.
(1) Open CDM in Workspace, select the Report-Reports command, and the dialog box shown in Figure 9-1 will pop up.
Figure 9-1
(2) Display all documents in the List of Reports dialog box. If not displayed, you can also click the New Report icon to open the dialog box shown in Figure 9-2.
Figure 9-2
(3) Enter the document name, select the document language and template, click OK, and enter the model document editing window according to the selected language and template, as shown in Figure 9-3.
Figure 9-3
(4) Click the Print Preview icon in the toolbar to open the preview window of the model document as shown in Figure 9-4.
Figure 9-4
(5) You can also click the Print icon in Figure 9-3 to output the model document to the printer, click the Generate RTF icon to generate an RTF file, and click the Generate HTML icon to generate an HTML file. The generated RTF file can be opened and edited with Microsoft Office Word, as shown in Figure 9-5.
Figure 9-5
Language Documentation Editor
The language document editor is used to provide language resource files for various documents for generating documents in languages other than English. The language resource file is a file in XML format with .XRL as the suffix.
Steps for usage:
(1) Select Tools-Resource-Report Languages, open the List of Report Languages window, select a language as the language of the document editor, click Properties in the toolbar, open the Report Language Properties window, and set the properties of each object and title in the document .
(2) Edit the language resource file defined by the application language document: select Report-Report Properties, open the window, select the required language form, click the Edit Report language button on the right side of the Language drop-down list box, and open the Report Language Properties window, as Document custom language resource files, and use the document editor to generate document print previews with Chinese information.
Mult-Model Report editor
The multi-model file editor is used to generate the same document for multiple models for easy global browsing and analysis of all models.
Manage model documents
Customize the contents of the document according to actual needs, such as: document items, nodes, projects, page settings, etc.
(General process of Powerdesiger design system: system requirements analysis and design-create CDM (establish entity, establish relationship, define domain, define business rules, check CDM for correctness, generate CDM model document, CDM into PDM)-refine physical data Model-PDM to OOM)