Skyline.DataMiner.Core.Scheduler.Automation 1.0.1-Alpha

Skyline.DataMiner.Core.Scheduler.Automation

The Scheduler is a NuGet package that provides useful functionalities to interact between Automation Scripts and the DataMiner Scheduler module, allowing the creation, update and deletion of Scheduler Tasks.

Installation

You can install the Scheduler package via NuGet Package Manager:

PM>  Install-Package Skyline.DataMiner.Core.Scheduler.Automation 

Usage

To use library, first initialize the Scheduler class by passing a filter of which Scheduler Tasks you want to see retrieved upon initialization of the class:

var scheduler = new Scheduler(task => task != null);

In the case presented below, all the tasks available in your DMS will be retrieved.

Now you can call methods to Get and Delete Scheduler Tasks according to a given filter:

IEnumerable<Skyline.DataMiner.Net.Messages.SchedulerTask> tasksToGet = scheduler.GetSchedulerTasksByFilter(task => task.TaskName == "Task Name");

scheduler.DeleteSchedulerTasksByFilter(taskToDelete => taskToDelete.TaskName == "Task Name");

In order to create a Scheduler Task it is necessary to first define the intended recurrence for such task.

For a task that is intended to be executed only once, the following constructor should be used:

var scheduleOnce = new ScheduleOnce(createSchedulerEvent: true);

Note that if the createScheduleEvent flag is set to true, a scheduling event will be created as documented in docs.dataminer.services.

For a task that is intended to be executed on a daily basis the following constructor should be used:

var now = DateTime.Now;
var repeats = 20;
var repetitionIntervalInMinutes = 30;
var startDate = now.AddDays(1);
var endDate = now.AddDays(2);
var scheduleDaily = new ScheduleDaily(startDate, repeats, repetitionIntervalInMinutes, endDate);

This daily task will run from tomorrow until the day after tomorrow, being repeated every 30 minutes until a maximum of 20 executions before the task is ended.

For a task that is intended to be executed weekly, the following constructor should be used:

var now = DateTime.Now;
var repeats = 20;
var repetitionIntervalInMinutes = 30;
var endDate = now.AddDays(10);
var weekDaysToRepeat = new List<WeekDays> { WeekDays.Saturday, WeekDays.Friday };
var scheduleWeekly = new ScheduleWeekly(now, weekDaysToRepeat, repeats, repetitionIntervalInMinutes, endDate);

This weekly task will run every 30 minutes, on Saturdays and Fridays for the next 10 days until a maximum of 20 executions before the task is ended.

For a task that is intended to be executed monthly, the following constructor should be used:

var now = DateTime.Now;
var repeats = 400;
var repetitionIntervalInMinutes = 100;
var endDate = now.AddYears(1);
var monthsToRepeat = new List<Months> { Months.February, Months.August };
var daysInMonthToRepeat = new List<int> { 1, 2, 15, 16 };
var scheduleMonthly = new ScheduleMonthly(now, monthsToRepeat, daysInMonthToRepeat, repeats, repetitionIntervalInMinutes, endDate);

This monthly task will run every 100 minutes for the next year, on February and August, in the 1st, 2nd, 15th and 16th days of the referred months, until a maximum of 400 executions before the task is ended.

Once the schedule repetition is defined, it's time to create the Scheduler task:

var startRunTime = DateTime.Now;
var endRunTime = startRunTime.AddHours(2);

var schedulerTask = new SchedulerTask("Name", "Description", startRunTime, endRunTime, scheduleRepetition);

Assuming that's 1PM, the task will be scheduled to run from 1PM to 3PM, being repeated according to the selected schedule repetition.

With the task already defined, it's time configure the schedule action. Currently, this library only supports Automation Script actions, which can be defined as follows:

var inputScriptParams = new List<AutomationScriptInputParameter>
{
	new AutomationScriptInputParameter("InputScriptParam1", "InputValue1"),
	new AutomationScriptInputParameter("InputScriptParam2", "InputValue2"),
};

var automationScriptAction = new AutomationScriptAction("Script Name", inputScriptParams, checkSets: true, runAsync: false);

schedulerTask.ISchedulerAction = automationScriptAction;
schedulerTask.ISchedulerFinalAction = automationScriptAction;

This action will execute an automation script asynchronously (runAsync flag), named Script Name that will receive the InputScriptParam1 and InputScriptParam2 arguments, by verifying through the optional checkSets flag whether a read parameter will be checked for a new value after a set command. Note that it's possible to define a final action that will be executed when the Scheduler task is removed. In the presented case the same Automation Script action will be executed.

Finally, when the task is fully ready, it can be created or updated at DataMiner Scheduler module level using the following method:

scheduler.CreateOrUpdateSchedulerTask(schedulerTask);

To create or update multiple tasks at the same time, where it's possible to define an optional flag to indicate whether to send changes in bulk:

var schedulerTasks = new List<SchedulerTask>
{
	schedulerTask1,
	schedulerTask2,
	schedulerTask3,
};

scheduler.CreateOrUpdateSchedulerTasks(schedulerTasks, sendInBulk: true);

API Reference

Scheduler Class

Initializes a new instance of the Scheduler class by retrieving the Scheduler tasks according to the given selector.

public Scheduler(Func<Net.Messages.SchedulerTask, bool> selector = null)` 

Parameters

• selector - Selector that will be applied to the retrieved Scheduler tasks. If null, no Scheduler Tasks are retrieved.

Properties

• SchedulerTasks - Gets the current tasks in the DataMiner Scheduler.

Methods

public void CreateOrUpdateSchedulerTask(SchedulerTask task) 

Creates or updates a single Scheduler task.

Parameters

• task - The SchedulerTask object to create/update.

Exceptions

• ArgumentNullException - Thrown when task is null.

• SaveSchedulerTasks - Saves the Scheduler tasks after creating/updating.

public void CreateOrUpdateSchedulerTasks(IEnumerable<SchedulerTask> schedulerTasks, bool sendInBulk = false) 

Creates or updates a collection of Scheduler tasks.

Parameters

• schedulerTasks - The collection of SchedulerTask objects to create/update.

• sendInBulk - A flag indicating whether to send changes in bulk. Optional, defaults to false.

Exceptions

• ArgumentNullException - Thrown when schedulerTasks is null.

• GetSchedulerTasksByFilter - Retrieves a collection of SchedulerTask objects based on a filter specified by the selector Func parameter.

public IEnumerable<Net.Messages.SchedulerTask> GetSchedulerTasksByFilter(Func<Net.Messages.SchedulerTask, bool> selector)

Parameters

• selector - The function used to filter the SchedulerTask objects to return.

Returns

• A collection of SchedulerTask objects that match the given filter.

Exceptions

• InvalidOperationException - Thrown when the GetSchedulerTasksResponseMessage is null.

• DeleteSchedulerTasksByFilter - Deletes scheduler tasks based on the provided filter.

public void DeleteSchedulerTasksByFilter(Func<Net.Messages.SchedulerTask, bool> selector) 

Parameters

• selector - Filter function used to select tasks for deletion.

Exceptions

• ArgumentNullException - Thrown when the selector parameter is null.