Create user plugins for RPA Desktop Design Studio

Create user plugins by using Microsoft Visual Studio to enable RPA developers to use complex .NET components or libraries in RPA Desktop Design Studio in a seamless way.

Before you begin

Use either Microsoft Visual Studio Pro, Community, or Enterprise version to perform this task.

Role required: none

About this task

The following procedure describes how to create a user plugin using C#.NET.

Procedure

1. Open Microsoft Visual Studio and click Create a new project.

2. In the Create a new project dialog box, select the Class Library (.NET Framework) template.

1. Click Next.

2. In the Configure your new project dialog box, fill in the following fields:

1. Click Create.

   The Class1.cs file opens.

2. In the Solution Explorer pane, right-click References and select Add Reference.

3. In the Reference Manager dialog box, navigate to Assemblies > Framework.

4. Select the System.AddIn assembly to add an annotation of this addin.

1. Click OK.

2. In the Class1.cs file, add the System.AddIn.AddIn("MyFirstPlugin", Description = "Learning to create custom components", Version = "1.0") code snippet above the class.

3. In the Class1.cs file, create one or more public static methods to your code.

   In this example, two methods are added to the code:

   • SayHello method: The name is taken as the input and returns "Hello" with a name and followed by an exclamation mark. For example, if the input is User, it returns "Hello User!".
   • Sum method: Two numbers are taken as the input and returns the sum of these two numbers. For example, if the inputs are 5 and 12, it returns "17".

1. Click Save.

2. In the Solution Explorer pane, right-click your project and select Build.

3. After the build is successful, do the following actions to copy and paste the .dll files:

   1. In the Solution Explorer pane, right-click your project and select Open Folder in File Explorer.

   2. Navigate to bin > Debug and copy the .dll files.

   3. Go to your RPA Desktop Design Studio automation project folder and create a new folder as UserPlugins.

      Important: Ensure that the spelling of this folder is entered correctly.

   4. In the UserPlugins folder, create a folder and enter a name for the folder.

      For example, My First Plugin.

   5. Paste the .dll files in this folder.

4. In the RPA Desktop Design Studio, do the following actions to add the plugin to your automation project:

   1. In the Project Explorer pane, right-click User Plugins and select Add User Plugin.

   2. In the Available User Plugins dialog box, select the plugin.

   3. Click OK.

   In the Toolbox pane, the user plugin you created appears.

5. Do the following actions to use the user plugin:

   1. In the Toolbox pane, navigate to the user plugin component category to select a method.

2.  Drag a method to the Design surface.

3.  To provide the input parameter value manually, double-click the input parameter field under the method, and enter the value.

4.  To provide the input parameter value from another method or component, connect the Data In port of the method to the Data Out port of another method or component.

5.  Connect the control ports of the method to the corresponding ports of another method or component.

6.  On the Design surface, right-click the title bar of the component from where you want to start the execution and select **Run From Here**.

Parent Topic:Building automations