Message Sets: Generating documentation from message sets and message flows

You can generate documentation from your message sets, message flows, subflows, message definition files, message maps, Java™ files, ESQL files, and deployable WSDL files.

About this task

To generate documentation that describes your message sets, message flows, subflows, message definition files, message maps, Java files, ESQL files, and deployable WSDL files, complete the following steps.

Bidirectional text is not fully supported in generated documentation. For example, if you enter text in the IBM® Integration Toolkit that has a right-to-left orientation, the text is displayed in the generated documentation with a left-to-right orientation.

Procedure

  1. Switch to the Integration Development perspective.
  2. In the pop-up menu of the Application Development view, right-click a message set project, a message set, a message flow, a subflow, a message definition file, a Java file, an ESQL file, or a deployable WSDL file, and select the action Generate Documentation.
    The Documentation Generation wizard opens.
  3. Provide the information that is requested to describe the documentation report that you want, and click Next to move to the next panel of the wizard.
  4. Step through the wizard, clicking Next to move to a new panel, and clicking Finish when you have described all the information that you want your report to document.