DiagramProject.bj

Action

Generate a relationship flow diagram for the specified project. Use DiagramTS.bj to generate a relationship flow diagram for each workspace object of a specified type.

Syntax

DiagramProject LogFile Workspace Scope [Pattern] [Tag] [Layout] [Project] [OptionSet] [ReportType]

Required Parameters	Description
LogFile	Output log file generated when the batch script is executed.
Workspace	Workspace file (.rwp).
Scope	Diagram scope (including user-defined scopes).

Optional Parameters	Description
Pattern	Pattern for naming the generated diagram, consisting of the output folder, file name pattern, and extension. For example, D:.emf. The file name pattern may contain any valid symbols. An asterisk () is replaced with the name of the project. The format of the diagram depends on the extension: .bmp, .jpg, .vsd, .vdx, or .emf. Default is \`WorkspaceFolder`\Output\`ProjectName`.bmp.
Tag	Tag used to black-box objects in the diagram. If related objects are contained in different black boxes, generates a Blackbox Interface Report. The report is stored in the folder location specified in Pattern, with the name `DiagramName`-`ProjectName`-BlackBoxRpt.csv. Report types are described in ReportType below.
Layout	Diagram layout: Circular, Hierarchical, Orthogonal, Symmetric, or Tree.
Project	Project. Default is the default project.
OptionSet	Whether to use the current settings in the interactive Diagrammer tool for auto expand, project boundary entities, and potential incomplete composite relationships, or the default settings: interactive, to specify the current settings. default, to specify the default settings. Default is *default.
ReportType	Type of Blackbox Interface Report. A Blackbox Interface Report lists the relationships between objects in different black boxes. Specify: Full, to generate the report with a row for each relationship. A row contains: The black box tag structure for the left and right objects in the relationship. The entity types and names of the left and right objects in the relationship. The relationship name. Distinct, to generate the report with a row for each blackbox interface (effectively collapsing the rows for relationships with the same interface). A row contains: The black box tag structure for the left and right objects in the relationship. The relationship name. The number of distinct objects with the left black box tag structure. The number of distinct objects with the right black box tag structure. The number of occurrences of the relationship. Default is Full. Omitting the parameter is the same as specifying Full. Note: This parameter must be specified last in the list of parameters.