Difference between revisions of "Plug-in assemblies"

From Resco's Wiki
Jump to: navigation, search
(Examples)
(Getting started)
(One intermediate revision by the same user not shown)
Line 8: Line 8:
 
* communication with some third party system
 
* communication with some third party system
 
* etc.
 
* etc.
 +
 +
In [[Resco Cloud]], you can manage plugins using the [[Admin Console]].
  
 
== Creating a plug-in assembly ==
 
== Creating a plug-in assembly ==
Line 85: Line 87:
 
[[File:Plugin successfully loaded.png|600px]]
 
[[File:Plugin successfully loaded.png|600px]]
  
== Implementation of Plug-in Assembly ==
+
== Implementation of plug-in assembly ==
navigate to the Processes
+
 
navigateprocesses.png
+
# In the Admin Console, go to '''Processes Center > Processes'''.
Add new
+
# Click '''New''' to create a new process.
Select Workflow/Job
+
# As '''Category''', select Workflow or Job.
if your plugin has return value, it is necessary to add variable of this type to the editor, then you are able to select plugin
+
# 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.
callplugin.png
 
5. Logs
 
-when Process was executed, its logs are saved and visible on the Resco Cloud -> Logs
 
logsconsole.png
 
logexample.png
 
  
 +
[[File:Process using the demo plugin.png|600px]]
  
 +
== Logs ==
  
 +
Whenever a process is executed, the run generates a log file entry. To access the logs, go to '''Processes Center > Logs'''.
  
 +
[[File:Process log.png|600px]]
  
  
 
[[Category:Resco Cloud]]
 
[[Category:Resco Cloud]]

Revision as of 12:10, 13 April 2021

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.

In Resco Cloud, you can manage plugins using the Admin Console.

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.
    Add reference to dll.png
    Add reference to dll 2.png
  4. Implement the PluginBase interface.
    PluginBase interface.png

Return value of plugin

You can define the return value of your plugin.

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

IPluginReturnValue.png

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

Allowed return type.png

Input values of plugin

You can define the input values of your plugin.

Input values.png

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

MyPluginInput.png

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

Example-fetch.png

Create

Example-create.png

Update

Example-update.png

Delete

Example-delete.png

Adding Plug-in Assembly to the Resco Cloud

In the development tool:

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

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).

Plugin successfully loaded.png

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.

Process using the demo plugin.png

Logs

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

Process log.png