Plugin types and configuration
Once a plugin is registered correctly in the Plugins section of WEBCON BPS Designer Studio, it can be used in regular configuration areas that correspond to its type.
So for example, a Custom control (aka. Form field) type plugin can be used instead of a regular form field configuration – Create a new form field in any process, select Custom control (SDK) as the form field type, then select your registered plugin from the Customization of form field controls (SDK) dropdown in the bottom right corner.
Here is a list of plugin types available in WEBCON BPS, their purpose, and where they are configured.
Custom action
Custom actions allow you to execute extra code created by a programmer in any place you would be able to use a regular action.
Use examples:
· Validating form fields based on information from external systems, e.g. checking if the vendor exists in the external ERP system
· Saving information in the external system after completing tasks in the workflow (moving an instance to the next step)
· Filling in the value of a field based on other field values and external conditions
· Generating custom signatures
· Assigning tasks based on the external system data
Use places:
Custom actions can be used in any place where actions can normally be defined:
· On step actions (regular actions)
· Global actions
· Action templates
Simply create a new action definition in any of these places and select Run an SDK action as its type, then select your registered plugin from the Plugin (SDK) dropdown menu.
Custom control
Custom control allows you to create an ASP.NET user control (form field) and place it on a SharePoint form.
Custom controls can display any information, and they can save the stored value in any location.
Use examples:
· Displaying custom charts, diagrams, reports from external systems, analyses, and other useful things on the form
· Saving specific business data to an external system
Use places:
The configuration is very similar to any other form field, simply create a new form field definition in your chosen process, select Custom control (SDK) as the field type, then select your registered plugin from the Customization of form field controls (SDK) dropdown in the bottom right corner (Settings section).
Field customizations
Modifies the appearance and function of a standard WEBCON BPS form field.
This type of add-on is very similar to Custom control, but instead of defining a new form field, it alters the function of a standard WEBCON BPS form field. The plugin works by saving data to the database field corresponding to the desired form field.
The main advantage of Field customizations is that it is closely bound to the standard field it modifies. Thanks to this, many form field mechanisms are automated, such as: saving values to the database, loading values, setting default values, specifying field styles, and standard JavaScript functions.
Use examples:
· Custom display of a standard form field
· Various views of a field depending on (for example) its visibility
Use places:
Create a new form field definition in your chosen process, select any standard form field type, then select your registered plugin from the Customization of form field controls (SDK) dropdown in the bottom right corner (Settings section).
Items list control
An items list control allows you to create your own Items list implementation from scratch.
It enables you to completely change the standard item list appearance, while supporting data management actions such as data saving or data loading via the standard engine. It is worth noting that this plugin was the precursor of the Item list form field, and was used in its creation.
Use examples:
- You can create an item list having advanced analytical mechanisms that exceed the standard form field (e.g. totals, grouping, calculation).
Use places:
Create a new form field definition in your chosen process, select Item list as the type, then select your registered plugin from the Customization of form field controls (SDK) dropdown in the bottom right corner (Settings section).
Items list customization
Items list customization allows you to change the functioning of a standard Items list form field.
You can run your own code during certain events on the items list, and also change the item list’s behavior during these events.
Use examples:
· Executing additional actions before you start an action as you move to the next step
· Blocking the action of ending a task when certain criteria are not met
· Blocking the move to the next step when certain criteria are not met
· Additional task assignment
· Changing item list cell appearance
· Executing additional actions before saving the workflow instance
· Changing the visibility and functionality of Remove and Clone buttons on item list rows
· Blocking the action of saving the workflow instance when certain criteria are not met
· Items list validation
· Changing item list column order
· Blocking the possibility of adding, removing, and cloning when certain criteria are not met
· Adding and supporting new buttons on the items list
· Advanced approval scenarios based on analytical breakdown
Use places:
Create a new form field definition in your chosen process, select Item list as the type, then select your registered plugin from the Customization of form field controls (SDK) dropdown in the bottom right corner (Settings section). Next in the Advanced settings of the item list form field, in the General tab, find the Customization configuration section in the bottom right.
Label printout template
Label printout template allows you to create a non-standard appearance of a barcode label, and replace the standard barcode printout template.
You can use parameters from the current workflow instance. It is also possible to delegate label printout support to an external system.
Use examples:
· Non-standard barcode printout template
· Label printout handled by an external system
Use places:
Create a new action definition in any of these places and select Printout a barcode label as its type, then select your registered plugin from the Plugin (SDK) dropdown menu.
Custom data source
This plugin allows you to make custom data available as a data source (loaded by using logic specified in the plugin code).
This data source can then be used anywhere in the BPS system where it is possible to select a standard data source.
Use examples:
- Connecting to non-standard databases
- Combining data from two existing data sources e.g.: Fixed values list and Oracle database
Use places:
Register a new data source definition in the Data sources segment, under the Custom node. Then select your registered plugin from the Plugin dropdown in the top right corner.
Flow control
Defines the logic of path selection in a Flow control step.
The path that will be taken by a workflow instance entering a flow control step will be determined based on the plugin code.
Use examples:
- Defining complex business logic for the flow control step that cannot otherwise be handled by regular business rules.
Use places:
In the edit window of a Flow control type step, go to its namesake Flow control tab and select the Plugin flow control option at the bottom. Then select your registered plugin from the Plugin dropdown.
Business rule
Create powerful custom Business rules that can be placed in various places in Designer Studio.
Use examples:
- Carrying out complex logic operations impossible to support for the standard system.
- Integrating with external systems that cannot be integrated with in the standard system (non-standard provider).
Use places:
Create a new Business rule definition (either global or process-specific). Edit the rule definition, and into the workspace add an SDK EXECUTION function (Functions -> Integration -> SDK EXECUTION).
Then click on the edit button next to the function, this will open a separate window for editing the SDK EXECUTION function. Select your registered plugin from the Plugin dropdown.
Plugin configuration
You may have noticed that when using plugins in Designer Studio, they are associated with their own Configure, Configuration, or Advanced Configuration buttons similarly to standard non-SDK elements of the same type in Designer Studio. When accessing this configuration window, all available configuration parameters are always dependent on the code of the plugin – they can be as customizable or as simple as the plugin designer wishes.
Below is an example of a Custom action SDK used in an Action template. As in most configuration areas of Designer Studio, you are free to use Variables or static values.
