Refer to the following information when you are specifying parameters
in the custom script for publishing UML models, com.ibm.xtools.publish.CLModelPublish:
Note: - If an attribute is optional, you can specify it or not. If you do not
specify the attribute, the default value is assumed. A required attribute
must have a valid value for the task to work.
- Write all paths as fully qualified paths, as in these examples: /root/myoutput/myModelProject1 (Linux®)
or c:\output\myModelProject1 (Windows®).
The script includes the following attributes:
- modelPath
- Required. Specify the fully qualified path of the model to publish.
- To find the fully qualified path, right-click the model in the Project
Explorer view; then click Properties.
- You can specify more than one model. Use a semicolon (;) to separate entries.
- outputFolder
- Required. Specify the fully qualified path of the location to send the
published model. The folder must be accessible before you run the script.
- outputFilename
- Required. Type index.html for the name of the root of
the published model.
- overwriteExisting
- Optional. Specify whether the contents of the output directory should
be deleted before a report is generated to this directory. The values are true (the
default) and false.
- preview
- Optional. Specify whether to display the published model automatically
after the publishing process completes. The values are true and false
(the default).
- showIcons
- Optional. Specify whether to display the standard icons for the elements
of the published model. The values are true (the default)
and false.
- genDate
- Optional. Specify whether to display the date of publication. The values
are true and false (the default).
- diagramImageFormat
- Optional. Specify the format to use for the published model diagrams.
The values are gif (the default), bmp, jpg, svg,
and vnp.
- detailLevel
- Optional. Specify whether to display all the material in the model or
only the documentation. The values are full (the default)
and min.
- errorHandling
- Optional. Specify how to handle errors. The values are ignore (the
default), which ignores any errors that might occur and continues processing,
and abort, which stops processing immediately and exits the
task.