SDS2.TaskScheduler.Plugins 1.0.0

Purpose

This package allows you to extend the SDS2 Task Scheduler.

How to Use

In order to add a new plugin into the SDS2 Task Scheduler you will need to create a new .net 6 or .net standard 2.1 library. Once you have the library you can start adding classes. Each class that extends the SDS2Task type will be a plugin that the Task Scheduler can load.

Example

[TaskName("My Plugin")] //The display name in the Task Scheduler
//Task Parameters will define the UI
[TaskParameter(TaskParameterType.Sds2Job, Sds2Job, IsRequired = true)]
[TaskParameter(TaskParameterType.FileLocation, FileLocation, "", true, "*.txt")]
public class MyPlugin: SDS2Task
{
    public const string Sds2Job = "SDS2 Job";
    public const string FileLocation = "File Location";

    private ILogger _logger;

    // Your constructor needs to take in an ILogger<YourClassType>
    public MyPlugin(ILogger<MyPlugin> logger) : base(typeof(MyPlugin))
    {
        _logger = logger;
    }

    // this is where all your plugin logic goes
    // the parameters dictionary will contain all user entered info from the UI
    public override Task ExecuteTask(Dictionary<string, TaskParameter> parameters)
    {
        _logger.LogInformation("Started My Plugin");

        try
        {
            // Plugin Code

            _logger.LogInformation("Completed My Plugin");
        }
        catch(Exception ex)
        {
            Console.WriteLine(ex.Message);
            _logger.LogError(ex, "Error in My Plugin");
            throw new JobExecutionException("Job failed to execute", ex);
        }

        return Task.CompletedTask;
    }

}