Plug-ins
On this page, Global Admins can manage plug-ins, taking any of the actions below. For a complete list of plug-ins, see the Plug-ins Guide.
Add a plug-in
To add a plug-in:
- Go to the Admin App.
- Open the Settings page and go to the Workflow tab.
- Click the Plug-ins page, displaying all plug-ins within a table.
- Select the plug-in and click the Add button at the top of the table.
- Enter the plug-in name and XML and click Add.
- You will receive a message confirming that the plug-in has been added .
The Plug-ins Guide covers all plug-ins supported in Evolve 20.2. Please consult with Winshuttle Customer Support if you would like to introduce changes to an existing plug-in or add a new custom plug-in.
View a plug-in
To view a plug-in:
- Go to the Admin App.
- Open the Settings page and go to the Workflow tab.
- Click the plug-ins page, displaying all plug-ins within a table.
- Plug-in names and definitions are available on this page.
Edit a plug-in
To edit a plug-in:
- Go to the Admin App.
- Open the Settings page and go to the Workflow tab.
- Click the plug-ins page, displaying all plug-ins within a table.
- Select the plug-in and click the Edit button at the top of the table.
- Select either the XML or the Designer option.
- Make the changes you require and click Save.
- You will receive a message confirming that the plug-in has been updated.
Delete a plug-in
To delete a plug-in:
- Go to the Admin App.
- Open the Settings page and go to the Workflow tab.
- Click the plug-ins page, displaying all plug-ins within a table.
- Select the plug-in and click the Delete button at the top of the table.
- Enter the plug-in name and XML and click Delete.
- You will receive a message confirming that the plug-in has been deleted.
Add a custom plug-in
References required (all of these assemblies are available in the bin folder of the Evolve installed location):
- 1. Microsoft.Extensions.Logging.dll
- 2. Microsoft.Extensions.Logging.Abstractions.dll
- 3. Newtonsoft.Json.dll
- 4. Winshuttle.Finx.DAL.dll
- 5. Winshuttle.Finx.Plugins.dll
- 6. Winshuttle.Finx.SharedInfa.dll
- 7. Winshuttle.Finx.Workflow.dll
- 8. Winshuttle.Finx.Workflow.Shared.dll
To run a background plug-in (with executor), add the following reference:
- 9. Winshuttle.Finx.Workflow.WF.dll
Write an interactive plug-in
This code will execute once the plugin action is reached in the workflow.
- Write a plug-in class that inherits PluginCommon and implement IWFPluginAction.
- All plug-in logic is written in the “OnWorkFlowEvent()” method.
Write a background plug-in
For background plug-in, an additional executor is necessary.