Plug-ins Guide
Notes: 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.
When you deploy solutions that include plug-ins, App Name, Solution Name, and Library Name parameters are validated. If one or more of these parameters is not found, you will receive an error message within a dialog box.
When configuring many of the plug-ins, you can select fields for parameters using drop-down menus.
Related topic: Plug-in Action Node
Plug-ins are nodes within a workflow that are used to automate a variety of tasks within the workflow. Examples of such tasks include:
- Automatically send email notifications.
- Copy files to a local directory or shared network folder.
- Copy files attached to forms to a library or other file system.
In addition, you can perform more advanced operations such as:
- Execute Powershell scripts to perform specific operations.
- Launch a secondary child form from a parent form when the user clicks a button in the parent form.
- Update a SQL database with data. Data examples: the number of times a form was submitted, how many users have used a form, or the Start and End dates for a process.
Add a plug-in to a workflow
- On the Workflow tab, under Elements, double click Plug-in. This adds the Plug-in Action node to the workflow.
- Click the Plug-in Action node.
- In the Properties pane, click the Plug-in Name drop-down field, and select the desired plug-in from the list. See below for a list of plug-ins.
- Configure the plug-in parameters. See below for a list of plug-ins.
Plug-ins Table
Click a plug-in name for more information, settings, and usage examples.
Plug-in | Excel/ Form/ Both | Description |
---|---|---|
Add Attachment | Form | Attach a document automatically at a given point in a workflow. |
Copy Attachments | Form | Copies one or more attachments from an Attachment Form Element in a form and places the copied file(s) into a file system. |
Copy Document | Excel | Create a copy of a document or supporting document and place it in a file system directory. |
Copy Form | Form | Copy a specified Form View as a Read Only copy and place it in a File Library. |
Create Folder | Both | Create a folder in a File Library or File System. |
Data Connection Adapter | Form | Execute the field mapping created for data connections. And, execute updates for form data that is defined in the field mapping. |
Database Query | Both | Create, update, and/or delete database records in a database (using ODBC or OLEDB connection). |
Deferred Column Update | Both | Set values in a form field or a solution field within the current process. Values are placed in a queue for processing. |
Deferred Copy Document | Excel | Create a copy of a document or supporting document(s) and place it in a processing queue, from which it will be added - either to a File System or to a folder in a File Library. |
Deferred Set Form Data | Form | Set a value in a form field through an asynchronous processing queue. |
Deferred Update Due Date | Both | Updates the due dates of a running process or of assignments within the running process. |
Delete Attachments | Form | Delete an attachment from the Attachment Form Element in a form. |
Delete File | Both | Allows users to delete file(s) from the folder of a File Library. |
EnterWorks Rest API | Form | Execute APIs provided by the EnterWorks application. |
Excel Process Launch | Both |
Start an Excel solution process on a specific Excel document. |
Execute Command Line | Both | Run a command line within a workflow. |
Execute Powershell | Both | Run a Powershell command or script within a workflow. |
Export Form Data to Database | Form | Export form data to a database that supports ODBC and OLEDB connections. |
Export Process State | Both | Export the current status of a workflow to solution fields. |
Export Process History | Both | Export the process history to SAP as an attachment. |
Export Repeating Group | Form | Export the values in a repeating table or section to Solution Data Library. |
Export Repeating Group to File | Form | Export the values in a repeating table or section to a file. |
Form Monitor | Form | Automatically launch a new form with a designated process when a certain start date is reached. |
Form Process Launch | Form | Launch a separate form and corresponding process during the workflow. |
Manage Swim Lanes | Both | Update the swim lane participant of the current process. |
Manage Users | Both | Manage Evolve users from the workflow. |
Process Form Data | Form | Extract form data and write it to a file or insert part or all of the data into a file or database (using an ODBC or OLEDB connection). |
Both |
Search and replace text within files in text format (for example, .txt or .xml). Search is case sensitive. |
|
Send Email | Both | Send an email at a specified point within a workflow. |
Set Column | Both | Set values in one or more Solution Fields. |
Set Column with Process Inheritance | Both | Set values in a Solution Field of a particular Parent or Child process that is currently running. |
Set Form Data | Form | Set a value in a form field at a particular point in the process. |
Update Due Date | Both | Update the due dates of a running process or assignments within the process. |
Update Item Permission | Both | Add, overwrite, and/or remove view permissions on the document, for any users or groups. |
Update Solution Data Library | Both | Allows to insert, update, or delete items from a Solution Data Library. |
Wait | Both | Wait for a specified period of time from the current time. |
Wait for Child Processes | Both | Pauses a process until all or specified child processes are complete. |
Winshuttle AutoRun | Excel | Automatically post data through Solution Designer instead of posting through the built-in Evolve workflow. |
Winshuttle Update | Form | Add a Winshuttle Web service to a workflow to run SAP data operations within the workflow. |
XSL Transformation | Form | Run an Extensible Stylesheet Language (XSL) style sheet on XML and store the results in a file on the file system. |