website logo
🔭Overview
💼Platform Actions
💜Integrations
🧰Custom Actions
🛠️Developer's Guide
Navigate through spaces
⌘K
📒What is a Custom Action?
📒Prerequisites and Environment setup
📒Your first Custom action
📒Custom action decorators
📒Frontend decorator
📒Frontend Select decorator guide
📒Class decorator
📒Backend decorator
📒Lists and Display rules inside custom actions
📒Full guide on custom actions
❗Custom action rules and limitations
Docs powered by
Archbee

Your first Custom action

9min

In the following article we will learn how to create a simple Custom action and how to add it to our flow.

1. Open Visual Studio.

2. Create a New project of type Class Library (.Net 6).

3. In this example we will call the action FullName.

4. Add the nuget to your project:

  • go to Tools → Nuget Package Manager → Manage NuGet Packages for Solution
  • from Package Source select your Github connection
  • from Browse select the Ringhel.Procesio.Action.Core package
  • check the name of your project and click Install
Document image


5. In the Solution explorer right click on your project and select Edit project file and replace the text with.

XML
|
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
    <TargetsForTfmSpecificBuildOutput>
      $(TargetsForTfmSpecificBuildOutput);IncludeDepsInPackage
    </TargetsForTfmSpecificBuildOutput>
    <AllowedOutputExtensionsInPackageBuildOutputFolder>
      $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb;.json
    </AllowedOutputExtensionsInPackageBuildOutputFolder>
    <Version>1.0.0.1</Version>
  </PropertyGroup>


  <ItemGroup>
    <PackageReference Include="Ringhel.Procesio.Action.Core" Version="1.19.2" />
  </ItemGroup>

  <Target Name="IncludeDepsInPackage">
    <ItemGroup>
      <BuildOutputInPackage Include="$(OutDir)*" />
    </ItemGroup>
  </Target>
</Project>


If you choose to use the following optional tags, you will need to update them manually when you create a new build in the same way as you update the Version tag or the changes will not appear in the new build.

XML
|
<AssemblyVersion>1.0.0.1</AssemblyVersion>
<FileVersion>1.0.0.1</FileVersion>




6. Create your custom action in a new class.

7. Include the following namespaces in your Custom Action class definition.

C#
|
using System;
using System.Threading.Tasks;
using Ringhel.Procesio.Action.Core.Models;
using Ringhel.Procesio.Action.Core;
using Ringhel.Procesio.Action.Core.ActionDecorators;
using Ringhel.Procesio.Action.Core.Utils;


8. We will provide you the full code for a custom action that will concatenate two strings that will be provided as inputs.

C#
|
namespace ConcatenateAction
{
    [ClassDecorator(Name = "Name of Action", Shape = ActionShape.Square, Description = "Description of the custom action", Classification = Classification.cat1, Tooltip = "Tooltip of the action", IsTestable = false)]
    [FEDecorator(Label = "Configure formatting", Type = FeComponentType.Side_pannel, Tab = "Presentation",Parent = "Side_Panel_Parent", RowId = 1)]
    [Permissions(CanDelete = true, CanDuplicate = true, CanAddFromToolbar = true)]
    public class Concatenate : IAction
    {
        [FEDecorator(Label = "First name", Type = FeComponentType.Text, Parent = "Side_Panel_Parent", RowId = 1)]
        [BEDecorator(IOProperty = Direction.Input)]
        [Validator(IsRequired = true)]
        public string FirstName { get; set; }
        [FEDecorator(Label = "Last name", Type = FeComponentType.Text, Parent = "Side_Panel_Parent", RowId = 2)]
        [BEDecorator(IOProperty = Direction.Input)]
        [Validator(IsRequired = true)]
        public string LastName { get; set; }
        [FEDecorator(Label = "String after format", Type = FeComponentType.Text, Parent = "Side_Panel_Parent", RowId = 3)]
        [BEDecorator(IOProperty = Direction.Output)]
        [Validator(IsRequired = true)]
        public string FullName { get; set; }
        public async Task Execute()
        {
            FullName = string.Concat(FirstName, " ", LastName);
        }
    }
}


You have the following class attributes that if set as true will give your action extra functionality, we advise that you set them to true. If the CanAddFromToolbar is set as false in your code the action will not appear in the platform.

9. The above code can be altered to create your own specific custom action or left as is.

10. To generate your own nuget you will need to right click your project in the Solution explorer and select Properties and in the Package section you will need to:

  • check Generate Nuget package on build
  • before each build you will need to come here and change the Package version, for example from 1.0.0.0 to 1.0.0.1
Document image


11. From the Visual Studio main menu select Build Solution from the Build dropdown.

Document image


13. To add the Custom action to your project switch to the Custom actions section.

Document image


14. Click the Create custom action button on the bottom left corner.

Document image


15. Give the action a name and upload or drag and drop the file and click Save.

Document image


16. The newly created Custom action will appear in the Custom actions list and you can drag it on the canvas like any other action.

We provided the code used to create the custom actions present on the platform on Github.



Updated 05 Apr 2023
Did this page help you?
PREVIOUS
Prerequisites and Environment setup
NEXT
Custom action decorators
Docs powered by
Archbee
Docs powered by
Archbee