› Overview › Workflow Management

Workflow Management

Workflow Management contains plugins and the corresponding dependencies required by any workflow, and the criteria by which the plugins are working.

Expand Workflow Management to view all the available plugins. By default, the first plugin on the list is selected. Select a plugin to view the plugin dependencies and the dependency type.

Upload new plugin

You can add a new plugin by either browsing to it, or by dragging it to another location.

Working

Working of this functionality depends on the following conditions:

This widget accepts a .zip file for uploading. Contents of the .zip file:

  • .jar file: The Jar for the plugin to be added.

  • .xml file: Contains the plugin information.

  • .zip file must only contain two file types: .jar and .xml.

  • .zip file and .jar file must have the same name.

  • .jar file content cannot be verified, so you must validate it.

In order for this plugin to take effect, you must restart the Tomcat server.

This .zip file after successful validation of its contents is stored in the configurable location specified in the <Ephesoft Transact installation path>ApplicationWEB-INFclassesMETA-INFapplication.properties file under the property named plugin_upload_folder_path.

The bpml file for the uploaded plugin is stored in the "plugins" folder in the configuration location specified in the <Ephesoft installation build>Application WEB-INFclassesMETA-INFdcma-workflowsdcma-workflows.properties file under the property named newWorkflows.basePath.

Validation on XML

  • All tags are compulsory and have any string value, except for is-scripting, is-mandatory, is-multivalue, and override-existing tags that have Boolean values (TRUE, FALSE).

  • The jar-name tag value must match the name of the .jar file present in the .zip file.

  • Only if is-scripting tag has a value TRUE, the values of back-up-file-name and script-name tag are taken into account.

  • The plugin-property and dependency tag can have multiple instances and have the values for plugin configs and dependencies respectively.

  • The override-existing tag decides whether to add the new plugin or update an existing one. If the value is true, then the existing plugin is updated. Otherwise, it is added as new.

  • Three operations can be done on the plugin properties and are defined by the operations tag inside plugin-property tag. The supported operations are:

    • Add: Adds a plugin property. An error is shown if it already exists.

    • Update: Updates a plugin property identified by its name and if it does not exist, creates a new one.

    • Delete: Deletes a plugin property identified by its name. An error is shown if no such property exists.

  • Default values for the plugin properties:

    Property data type Default value

    String

    Default

    Integer

    0

    Boolean

    Yes

    These properties are assigned for properties which are mandatory. Also, if a property is multivalued, the first value from the list is the default value.

Assumptions

  • The tags plugin-service-instance and method-name must be correct as they cannot be validated.

  • The application-context-path tag refers to the application context file name for the plugin.

  • For the dependencies tag:

    • ORDER_BEFORE : P2,P3/P4,P6/P7/P8

    • UNIQUE : TRUE

Options panel

  • Add: Add dependency to the selected plugin. An existing dependency cannot be added again.

    Click Add to configure the selected plugin.

  • Edit: Edit the selected dependency. Click to open a bottom view where you can configure the selected dependency according to your requirements.

  • Delete: Remove the selected dependency of a plugin. You can also delete multiple dependencies at a time.

  • Help: Click to open a dialog box containing the "how to" information for a new plugin to be uploaded.