Template Parameters
The template has 21 parameters. These are summarized in the following table and shown in the following figure.
Must be assigned the value of the name of the top-level Activity Chart to document (the name should be entered in caps just as it appears in the Workarea). Must be assigned the value of the text to appear in the top left of the generated document header. Note that this value is case sensitive. Must be set to the name of the output device to use in generating the plots for the output document (the device name must be in caps). Use a device of format Word for RTF plots. Must be set to TRUE to output the Long Description in the properties tables included in the document – a value of FALSE outputs the Description (also known as the Short Description) in the properties tables. Can be set to a filename to use as the cover page of the document. Leaving this parameter blank causes the following four parameters to be used in creation of the cover page: Can be set to the name of a file that will be imported into the Applicable Documents section. Can be set to a the name of a file that will be imported into the System Overview section. Must be set toTRUE
to order the document following the hierarchical structure of the model – a value ofFALSE
alphabetically documents the Activity Charts followed by the Statecharts. An external file can be inserted to the document or can be linked using an “hyperlink”. When this parameter is set to TRUE the files will be inserted, otherwise linked using an “hyperlink” When this parameter is set toTRUE
, the Transitions Table for Statecharts will be generated into the document Plot the Track Change description for all charts in the workarea. if this parameter is set toTRUE
, the change log is for all the charts in the Workarea, if set toFALSE
, the change log is only for the charts in the Document scope.