Skyline.DataMiner.Utils.InteractiveAutomationScriptToolkit 5.0.0

Skyline.DataMiner.Utils.InteractiveAutomationScriptToolkit

About

Quickly develop interactive automation scripts for DataMiner. This package provides an API that more closely resembles other desktop graphical user interface libraries. It builds upon the features available in Skyline.DataMiner.Automation and makes them easier to use.

using System;

using Skyline.DataMiner.Automation;
using Skyline.DataMiner.Utils.InteractiveAutomationScript;

/// <summary>
///     DataMiner Script Class.
/// </summary>
public class Script
{
	/// <summary>
	///     The Script entry point.
	/// </summary>
	/// <param name="engine">Link with SLScripting process.</param>
	public void Run(Engine engine)
	{
		// DO NOT REMOVE THE COMMENTED OUT CODE BELOW OR THE SCRIPT WONT RUN!
		// Interactive scripts need to be launched differently.
		// This is determined by a simple string search looking for "engine.ShowUI" in the source code.
		// However, due to the NuGet package, this string can no longer be detected.
		// This comment is here as a temporary workaround until it has been fixed.
		//// engine.ShowUI(

		try
		{
			// Controls the event loop and switch between dialogs
			var controller = new InteractiveController(engine);

			// Create an instance of the dialog you wish to show.
			var helloWorldDialog = new HelloWorldDialog(engine);

			// Starts the event loop and shows the first dialog.
			controller.Run(helloWorldDialog);
		}
		catch (ScriptAbortException)
		{
			throw;
		}
		catch (ScriptForceAbortException)
		{
			throw;
		}
		catch (ScriptTimeoutException)
		{
			throw;
		}
		catch (InteractiveUserDetachedException)
		{
			throw;
		}
		catch (Exception e)
		{
			engine.ExitFail(e.ToString());
		}
	}
}

// You can define your dialogs by inheriting from the Dialog class
public class HelloWorldDialog : Dialog
{
	public HelloWorldDialog(IEngine engine) : base(engine)
	{
		// Create a label widget
		var label = new Label("Hello, World!") { Style = TextStyle.Title };

		// Add it to the dialog grid at position 0,0
		AddWidget(label, 0, 0);

		// Create a button widget
		var button = new Button("OK");

		// Add it to the dialog just below the label
		AddWidget(button, 1, 0);

		// Add an action to be performed whenever the button is clicked
		button.Pressed += (sender, args) => engine.ExitSuccess("Done");
	}
}

If you have questions, you can post them to our DataMiner community platform. Or have a look at the guides and video courses listed below.

Courses and guides

• All video courses related to DataMiner Automation
• Getting started with the toolkit
• Video course covering the toolkit basics (The first 2 minutes can be skipped as they cover how to acquire the toolkit without NuGet)
• Create applications using Model View Presenter

Known Issue

When you use this NuGet package, it is possible you get the following error when launching the script: DataMinerException: Show UI Failed: 0x800402F5 (Interactive UI can only be used in interactive mode. ) This is due to a DataMiner software issue causing the script to be launched in the wrong mode. The DataMiner software performs a simple string search to detect if the script should be launched in interactive mode. It is looking for the following string "engine.ShowUI" which is normally always present in the source code of the script. This method call is now handled by the NuGet package, so the string can no longer be found in the script source code, causing the issue. We are currently working on a fix which will be available in one of our upcoming DataMiner releases.

Workaround

Add the following comment to your script.

// engine.ShowUI(

Location of the comment does not matter as long as it is visible in the C# code block view of the DataMiner Automation Script UI.

About DataMiner

DataMiner is a transformational platform that provides vendor-independent control and monitoring of devices and services. Out of the box and by design, it addresses key challenges such as security, complexity, multi-cloud, and much more. It has a pronounced open architecture and powerful capabilities enabling users to evolve easily and continuously.

The foundation of DataMiner is its powerful and versatile data acquisition and control layer. With DataMiner, there are no restrictions to what data users can access. Data sources may reside on premises, in the cloud, or in a hybrid setup.

A unique catalog of 7000+ connectors already exist. In addition, you can leverage DataMiner Development Packages to build you own connectors (also known as "protocols" or "drivers").

Note See also: About DataMiner.

About Skyline Communications

At Skyline Communications, we deal in world-class solutions that are deployed by leading companies around the globe. Check out our proven track record and see how we make our customers' lives easier by empowering them to take their operations to the next level.