Plugin
This activity allows you to use in the scenario a plugin (an additional software component that adds extra functionality to the scenario and expands its capabilities). Plugin should be locateded in a specific place for Wizlink to be able to use it. Plugin source opens a dropdown list to choose: local folder, direct file path, BCC.
Plugin files (all .wll and .dll files connected to one plugin) should be placed in independent, separate folders.
Plugin files are regularly located in C:\ProgramData\Wizlink2\Plugins\Local. Direct file path is mostly used during coding or testing. If your scenario will run under BCC control - you should place your plugin in BCC. When you click on the downward arrow in activity box - the bcc plugins selection window will appear.
Put the activity Plugin in the main scenario. Choose the plugin source (Local Folder). Click circular arrow to let robot check disc localisation in search for plugins, then choose the right one from the dropdown list. Then in the next dropdown box (Methods) choose the procedure/function to be performed (each plugin brings a list of procedures – so-called methods – that can be performed). Choosing a method causes opening additional boxes that await for data, so fill them with the correct data/variables.
Instance name is a custom internal name of a plugin. Giving a unique name to the plugin’s Instance allows to significantly shorten the operation time and reduce memory consumption. It is especially important when the same plugin is called multiple times and handles large-volume files.
NOTE: you can specify other locations for plugins, simply set path as environment variable values (WIZLINK_PLUGINS_PATH).
NOTE: see also Wizlink Plugins Manual.
| Parameter Name | Parameter Type | In/Out | Description |
|---|---|---|---|
| Alternative Scenario If Failed | Boolean | Input | checkbox; default is "on" |
| BCC Plugin Name | String | Input | plugin name from BCC |
| Display Name | Literal | Input | you can change the name of activity for greater clarity of the scenario |
| Exclude from Transaction Check | Boolean | Input | checkbox; default is "off" |
| Instance name | String | Input | custom internal name for that particular plugin in order to use in Wizlink (optional parameter) |
| Method | - | Input | a procedure to perform, choose it from dropdown list |
| Plugin File Path | String | Input | full path to plugin file |
| Plugin Name | String | Input | .wll or .dll file name |
| Plugin Source | Dropdown | Input | select the appropriate option from the dropdown list |
| Result | Boolean | Output | returns the Boolean value: it will return True if no error is in activity, otherwise it will return False |
| Result Code | Int32 | Output | Result Code will return 0 if there is no error in activity, otherwise in most cases it will return 1, the extended result code will show only in several chosen activities |