Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Working with Projects, Packages, and Processes : Documentation

Documentation
See "Documentation" in TIBCO Business Studio Concepts.
Creating Documentation from within TIBCO Business Studio
You can create documentation from within TIBCO Business Studio.
1.
2.
If you selected a 'special' folder, select Export > Export > Documentation.
3.
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.
The default location for generation is <ProjectPath> > Documentation > * Model Documentation.
The default for the Index page is <ProjectPath > > Documentation.
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).
Creating Documentation from the Command Line
You can create documentation from the command line.
1.
2.
   C:\Program Files\TIBCO\BusinessStudio
3.
4.
This will generate documentation for the selected file(s) and also an index page.
An example of command line invocation would be:
TIBCOBusinessStudio.exe -application com.tibco.xpd.resources.ui.documentation -data <workspace> -projectName <project name> -outputPath <output path>
If you do not want to see the TIBCO Business Studio splash screen then provide an extra argument (-noSplash) with the above command as:
TIBCOBusinessStudio.exe -application com.tibco.xpd.resources.ui.documentation -data <workspace> -projectName <project name> -outputPath <output path> -noSplash
Generating Documentation On Demand
You can generate documentation on demand from your local filesystem, without requiring a workspace or TIBCO Business Studio project.
To do this, you require a supported file type (.maa) on the local filesystem. An .maa file is a way of compressing a TIBCO Business Studio project.
To create an .maa file, in the Project Explorer in TIBCO Business Studio, go to your project, and select the Documentation folder. Then right click to select Export > Archive File. When naming the file, give it the suffix .maa.
To generate documentation on demand do one of the following when opening an .maa file:
The command line generates documentation in the same path as the .maa file for the selected file(s) and also an index page.
If an output path is provided in the <Business Studio Home>/studio-doc.ini the documentation is generated in the path provided. To add an output path, add the following to the beginning of the studio-doc.ini file:
-outputPath
<OutputPath>
Viewing Documentation
You can view documentation you have created from TIBCO Business Studio.
1.
2.
If you created the documentation from the command line:
3.
See "Deploying BPM Applications" in the TIBCO Business Studio BPM Implementation guide for more information.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved