1. Introduction
2. Example Options File
   1. Property Details
3. Template Script
   1. IPayload Interface
   2. IPayloadValue Interface

Introduction

This filter provides users with the flexibility to code a C# script, enabling them to read or modify the raw source data. Users can add, modify, and remove payload values according to their requirements. The script comprises one or more C# code files (.cs), with one of these files containing a class that implements the IoTnxt.Raptor.Generic.Filter.IPayloadExecutor interface.

During compilation, the C# compiler loads all script files associated with the script project and compiles them collectively. The C# compilation process is customisable, allowing users to set specific options via the C-Sharp Script Options.

Example Options File

{
  "Devices": {
    "Device1": {
      "DeviceType": "Generic",
      ...
      "Filters": [
         {
            "FilterType": "CSharpScript",
            "Order": 1,
            "ProjectId": "Project1",
            "PropertyMaps": {
              "PropertyKey": {
                "DataType": "String"
            },
         }
      ]
    }
  }  
}

Property Details

Here is an overview of the parameters for configuring the C-SharpScript filter:

Template Script

using System;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Newtonsoft.Json;
using Microsoft.Extensions.Logging;

namespace IoTnxt.Raptor.Generic.Filter;

public class PayloadExecutor: IPayloadExecutor
{
    private readonly ILogger _logger;

    public PayloadExecutor(ILogger<PayloadExecutor> logger)
    {
        _logger = logger;
    }

    /// <summary>
    /// Executes the filter to process the payload.
    /// </summary>
    /// <param name="payload">The payload to process</param>
    /// <param name="cancellationToken">Cancellation token</param>
    /// <returns>A Task</returns>
    public Task ExecuteAsync(IPayload payload, CancellationToken cancellationToken)
    {
        // TODO: Process the payload here.
        return Task.CompletedTask;
    }
}

IPayload Interface

This is a description of the properties associated with the payload in the C-SharpScript filter:

IPayloadValue Interface

The read-only properties form part of the payload key. If there is a need to change these properties, the user is advised to create a new value and remove the old one. This ensures proper handling of changes to the payload properties while maintaining the integrity of the payload key.

Here is an explanation of the properties associated with the payload values: