Using plugins within Server-side Business Objects
We recommend using Plugins only within Server-side Business Objects (Read more). This helps you to increase data security and does not force you to expose data to the clients you do not want to be manipulable.
Using plugins within Applications/Modules
To access Plugins within Applications, you have two options
- Access the Plugin via a Server-side Business Object as recommended (see above) and add the Business Object Function to your Process using our BO Shape. For some Plugins there are ready-to-use Server-side Business Objects in our Standard Content!
- Script the Plugin call (Not recommended)
Scripting the Plugin call
this.callPlugin(pluginName, slot, payload, callback, showBusyIndicator, failonError, failCallback)
pluginName | the name of the plugin |
slot | slot (function, interface) within the plugin |
payload | a JSON object with the required parameters for the plugin |
callback | function, which is called after the successful execution of the plugin |
showBusyIndicator | boolean value that indicates whether the screen has to be blocked by a loading bar (true) or not (false) |
failonError | boolean value that indicates whether the plugin should be called in case of an error of the function passed via “failCallback” (false) or not (true) |
failCallback | function, which is called in case of an error in the plugin, is false for “failOnError” is passed |
Using Plugins within Workflows
To access Plugins within Workflows, you have to set up a REST Connector accessing a Server-side Business Object using the Plugin via our Client-API with a local user’s authentication. We do not recommend to directly use Plugins via a REST-Connector in Workflows