Studio Developer Manual / Version 2107
Table Of Contents
In order to make new workflows available for the Studio client,
you use the AddWorkflowPlugin in the context of a StudioPlugin's configuration
section.
The AddWorkflowPlugin has specific subclasses for translation and publication workflows which
will be covered later in this chapter together with concrete examples. The main functionality of the plugin is the
same for both workflow types.
The AddWorkflowPlugin offers the following configuration options. More details on each option
can be found in the code documentation of the plugin.
-
processDefinitionName The name of the process definition of your new workflow.
-
processCategory The process category, translation or publication.
-
startForm The start form to use for your new workflow inside the Studio's
StartWorkflowWindow. For both publication and translation workflows, default forms exist. They are described in later sections. While it is possible to define your own forms from scratch, it is not recommended and no support is given. Instead, it is recommended subclassing the default form components if needed and to use the additional workflow fields mechanism described below in Section Section 7.23.1.2, “Adding Workflow Fields”.-
inboxForm The form to show when your new workflow is shown in the Control Room inbox panel. Default forms exist, see the explanations for
startForm.-
pendingForm The form to show when your new workflow is shown in the Control Room pending panel. Default forms exist, see the explanations for
startForm.-
finishedForm The form to show when your new workflow is shown in the Control Room finished panel. Default forms exist, see the explanations for
startForm.-
listToolbarButtonsFunction A function that returns the buttons for the toolbars of the inbox, pending and finished panels of the Control Room.
