Overview

This feature allows the user to create a customize workflow dynamically. I.e. the user will be capable of adding/removing/ordering any module/plugin in the workflow. After alteration in the workflow, the user will be allowed to deploy these changes made to the workflow only after it has validated the workflow by fulfilling the dependencies of individual plugin.

Usability

Configure Modules

To configure the modules of a particular batch class, the user needs to follow the following the steps:

  • Choose the batch class for which the user wants to change the workflow from “Batch Class Management” screen and traverse to the Modules Node.

  • Under the “Modules” node in the tree view of that batch class, there is a dual list on detail view. Here user can add/delete/re-order any module.
  • In this view, the user can see the following:
    • ‘Associated Modules’: the list of associated modules for the workflow.
    • ‘Available Modules’: the list of available modules.
    • ‘Add New Module’ button: to add a new module to the available modules list. On click of this button below pop-up appears on the screen. In name field user has to enter the name of the new module, which user wants to give to that module and in description field some description regarding the new module needed to be entered. On “OK” button click, new module will be saved in the available modules list.

E:\Rajan\module\module 1.png

    • ‘Remove Selected’ button: to remove any of selected modules from the associated modules list.
    • ‘Add Selected’ button: to add any selected module(s) from available modules list to associated modules list. By default the added module will be placed at the bottom of associated modules list.
    • ‘Move Selected Up’ button: to move up in order any selected module in associated modules list. The user can select multiple modules at once and each module will be moved one place up each time the button is clicked.
    • ‘Move Selected Down’ button: to move down in order any selected module in selected modules list. The user can select multiple modules at once and each module will be moved one place down each time the button is clicked.
  • Any newly added module would initially be empty.
  • Multi select and Drag and Drop functionality has been added to add or remove selected Modules.

Configure plugins

Likewise the module configure functionality, there is a plugin configure functionality. This functionality allows the user to add/delete/re-order the plugins in a particular module of a batch class.E:\Rajan\module\module 2.png

  • To configure plugins for a particular module of a batch class, the user needs select any particular module of a batch class from navigation tree.
  • User can edit the plugin details, by selecting the plugin from navigation tree. On selection of plugin, an editable view of plugin will be open on the screen and then user can edit the plugin detail. Below pop-up shows the editable view of “RECOSTAR_HOCR” plugin.

\\lipsye33\writable\plugin edit view.png

  • The functionality of above view is similar to the “Configure Modules” view. With “Add”, “Remove”, “Up”, “Down” buttons having the common functionalities from “Configure Modules” view.
  • Apart from the common functionality, below is the additional functionalities for the “Configure Plugins” view are:
    • Dependency highlight
      • Whenever a plug-in is selected in the available list (currently CMIS EXPORT), all its dependencies will be highlighted (currently CREATE MULTIPAGE FILES) in the same list.

\\lipsye33\writable\module 3.png

    • Warning on plugin addition
      • While adding the plug-in to the selected plugins list using the add button, if all the dependencies of the plugin are NOT already present in selected plugins list, following pop up will be displayed.

E:\Rajan\module\Module 4.png

      • In the above pop-up:
        • Yes: pressing this button will add all the dependencies of the plugin along with it to the selected plugins list.
        • No: pressing this button will just add the selected plugin to the selected plugins list ignoring the dependencies.
        • Cancel: pressing this button will cancel the operation.
  • Similar to Module Configuration multi select and Drag and Drop functionality has been added to add or remove selected Plugins.

Deploy workflow

This button is present in menu bar of the batch class edit view. Pressing this button will check all the rules to be applied on the selected plug-ins.

E:\Rajan\module\module4.png

If there is any violation of dependencies among plugins, the first violation will be reported in the pop up.

E:\Rajan\module\module5.png

On successful deployment of batch class, below pop-up is shown.

E:\scdocumnet\module\sucess.png

Notes

  • The user needs to deploy the batch class each time it makes any change in the workflow by configuring modules or plugins.
  • User can only deploy a validated batch class.
  • Saving a batch class using “Apply” button will not deploy the batch class. But deploying a batch class using “Deploy Workflow” button will 1st perform the save batch class function and will then deploy the batch class.

<Back4.0.0.0 Release Documentation

Was this article helpful to you?

Engineering

Comments are closed.