Creating Documentation From Within TIBCO Business Studio

You can create documentation from within TIBCO Business Studio.

  1. You can do one of the following:
    • Right click on a model resource (for example: an .xpdl, .bom or .om file).
    • Right click on a project.
    • Right click on a 'special' folder.
  2. You can do one of the following:
    • If you selected a model resource or the whole project, select Export > Documentation.
    • If you selected a 'special' folder, select Export > Export > Documentation.
  3. One of the following will happen:
    • If you selected a model resource in step 1, it is selected in the wizard (you can change the selection here if required).
    • If you selected the entire project or a 'special' folder in step 1 all possible resources are selected in the wizard.)
  4. You have the option to select the destination for the documentation files.
    • The default location for generation is <ProjectPath> > Documentation > * Model Documentation.
    • The default for the Index page is <ProjectPath > > Documentation.
      Note: You can specify a location outside the workspace. In this case, the location must exist or an error will appear in the wizard)
  5. Click Finish to generate documentation for the selected model file(s) and generate an index page containing overview information for the selected files(s).