5.1

Table Of Contents
Using the Workflow Documentation
Plug-In 10
You can use the Workflow Documentation plug-in to generate PDF documentation about a specific workflow
or workflow category.
This chapter includes the following topics:
n
“Workflow Documentation Plug-In Scripting API,” on page 73
n
“Workflow Library for the Workflow Documentation Plug-In,” on page 73
n
“Generate Workflow Documentation,” on page 74
Workflow Documentation Plug-In Scripting API
The Workflow Documentation scripting API contains one class, with its respective methods. You can use the
API to develop custom workflows.
WorkflowDocumentationService Class
The WorkflowDocumentationService class is the main Workflow Documentation class.
The WorkflowDocumentationService class defines the following methods.
Method Returns Description
getWorkflowCategoryDocumentatio
n
MimeAttachment
Gets documentation about a workflow
category.
getWorkflowDocumentation MimeAttachment
Gets documentation about a workflow.
Workflow Library for the Workflow Documentation Plug-In
With the Workflow Documentation plug-in workflows you can generate PDF documentation about specific
workflows or workflow categories.
You can access these workflows from Library > Workflow documentation in the Workflows view of the
Orchestrator client.
Get documentation for
workflow
Generates information about a workflow that you select.
Get documentation for
workflow category
Generates information about a workflow category that you select.
VMware, Inc. 73