Plug-in assemblies

This document is a brief summary of plug-in assemblies in Resco Cloud and their implementation to the processes (workflows).

Getting started

Plug-in assemblies allow you to run custom C# code on the Resco Cloud as part of the Processes. Plugins can run periodically as jobs or be triggered as workflows. It should solve the limitations of the no-coding editor of processes. There are the typical use cases:

• complex logic of process
• communication with some third party system
• etc.

Creating a plug-in assembly

1. Download Resco SDK.
   Sample projects are part of the RescoCRM.Plugin.SDK.zip file.
2. Create a new project as a Class Library (.NET Framework 4.6.2).
3. Add a reference to the downloaded XRMServer.Core.dll.
   
   
4. Implement the PluginBase interface.
   

Return value of plugin

You can define the return value of your plugin.

Implement the IPluginReturnValue interface to the code (e.g. string):

These are the allowed return types: It should be possible to create a variable of this type in Processes editor.

Input values of plugin

You can define the input values of your plugin.

The name of the PluginInputParameter (MyPluginInput in the example), will be visible in the Processes editor.

Logs

context.AppendLogLine("Contacts with specified account id '{0}' cannot be found!", accountId);

Logs are saved and visible in the Admin Console under Processes Center > Logs.

Cancel the workflow execution

context.AppendLogLine("Contacts with specified account id '{0}' cannot be found!", accountId);
return PluginResult.Failed;

Examples

Fetch

Create

Update

Delete

Adding Plug-in Assembly to the Resco Cloud

In the development tool:

1. Build the solution.
   
2. Create the zip file with the dll file.
   

In the Admin Console:

1. Go to Processes Center > Plug-in Assemblies.
2. Click New, then click Browse and upload the zip file.

The plugin is loaded and the return type and input parameters listed below (if implemented).

Implementation of plug-in assembly

1. In the Admin Console, go to Processes Center > Processes.
2. Click New to create a new process.
3. As Category, select Workflow or Job.
4. If your plugin has return value, it is necessary to add the variable of this type to the editor, then you are able to select the plugin.

Logs

Whenever a process is executed, the run generates a log file entry. To access the logs, go to Processes Center > Logs.