Deployment Manager: Sample Step Code
This provides an example step for the Deployment Manager.
You can download the code the for SampleSite project here
We will utilize SampleService as the service for our Sample Steps
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace SiteProvisioning.SampleSite.Services
{
public class SampleService
{
public SampleService()
{
}
public void DoSomething()
{
//Wait 3 seconds
System.Threading.Thread.Sleep(3000);
}
public string DoSomethingWithTitle(string title)
{
//Wait 2 seconds
System.Threading.Thread.Sleep(2000);
//Return Title
return title;
}
}
}A step that calls one method in SampleService and completes
using Akumina.SiteProvisioning.Common.Models;
using Akumina.SiteProvisioning.Core;
using Akumina.SiteProvisioning.Core.Interfaces;
using Akumina.SiteProvisioning.Core.Services;
using SiteProvisioning.SampleSite.Services;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace SiteProvisioning.SampleSite.Steps
{
public class SampleStep : SiteProvisionerStepBase, ISiteProvisionerStep
{
public override string StepName
{
get { return "Executing a Sample Step"; }
}
public override SiteProvisionerStepResponse Execute()
{
var response = new SiteProvisionerStepResponse();
SampleService sampleService = new SampleService();
sampleService.AssetDirectory = this.Properties.AssetDirectory;
try
{
sampleService.DoSomething();
response.Message = "We did something";
response.Success = true;
}
catch (Exception ex)
{
response.Message = ex.Message;
response.Success = false;
}
return response;
}
}
}Our site deployment will consist of one step, SampleStep.cs
using Akumina.SiteProvisioning.Core.Interfaces;
using SiteProvisioning.SampleSite.Steps;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace SiteProvisioning.SampleSite
{
public class Example : SiteProvisionerSiteBase
{
public override string AssetDirectory
{
get { return "Example"; }
}
public override string Javascript
{
get { return ""; }
}
public override string FriendlyName
{
get { return "Example Site"; }
}
public override List<ISiteProvisionerStep> Steps
{
get
{
var _steps = new List<ISiteProvisionerStep>();
_steps.Add(new SampleStep());
return _steps;
}
}
public override List<SiteProvisionerSettingsField> UserSettings
{
get
{
return new List<SiteProvisionerSettingsField>();
}
}
}
}Once you integrate your custom site definition with the Deployment Manager App you should be able to see it in the UI
For this example we will reuse the SampleService.cs class from the previous example.
Our new step will utilize a "Title" field for user input
using Akumina.SiteProvisioning.Common.Models;
using Akumina.SiteProvisioning.Core;
using Akumina.SiteProvisioning.Core.Interfaces;
using Akumina.SiteProvisioning.Core.Services;
using SiteProvisioning.SampleSite.Services;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace SiteProvisioning.SampleSite.Steps
{
public class SampleStepWithUserInputs : SiteProvisionerStepBase, ISiteProvisionerStep
{
public override string StepName
{
get { return "Executing a Sample Step with User Inputs"; }
}
public override SiteProvisionerStepResponse Execute()
{
var response = new SiteProvisionerStepResponse();
SampleService sampleService = new SampleService();
sampleService.AssetDirectory = this.Properties.AssetDirectory;
try
{
var siteTitle = GetProperty("Title");
if (string.IsNullOrEmpty(siteTitle))
{
throw new Exception("The Title value is required");
}
response.Message = sampleService.DoSomethingWithTitle(siteTitle);
response.Success = true;
}
catch (Exception ex)
{
response.Message = ex.Message;
response.Success = false;
}
return response;
}
}
}We will reuse Example.cs from the previous sample, but with a couple modifications. We will add our SampleStepWithUserInputs class to the step list and add an entry to the SiteProvisionerSettingsField list. Changes from the previous version are highlighted.
using Akumina.Logging;
using Akumina.SiteProvisioning.Common.Models;
using Akumina.SiteProvisioning.Core;
using Akumina.SiteProvisioning.Core.Interfaces;
using SiteProvisioning.SampleSite.Steps;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace SiteProvisioning.SampleSite
{
public class Example : SiteProvisionerSiteBase
{
public override string AssetDirectory
{
get { return "Example"; }
}
public override string Javascript
{
get { return "~/SiteDefinitions/Example/ProvisionerFiles/js/example.js"; }
}
public override string FriendlyName
{
get { return "Example Site"; }
}
public override string ClassName
{
get { return "SiteCreator.Example"; }
}
public override List<ISiteProvisionerStep> Steps
{
get
{
var _steps = new List<ISiteProvisionerStep>();
_steps.Add(new SampleStep());
_steps.Add(new SampleStepWithUserInputs());
return _steps;
}
}
public override List<SiteProvisionerSettingsField> UserSettings
{
get
{
var _userSettings = new List<SiteProvisionerSettingsField>();
_userSettings.Add(
new SiteProvisionerSettingsField()
{
Name = "Title",
Description = "This is a Sample Field",
DefaultValue = "",
Required = true
}
);
return _userSettings;
}
}
}
}Under the SiteDefinitions folder you will need to create the following folder structure.
And it will contain the example.js file
var SiteCreator = SiteCreator ? SiteCreator : {};
if ((typeof SiteCreator.Example) === 'undefined') {
SiteCreator.Example = function () {
var _cur = this;
this.Init = function (model) {
SiteCreator.Eventing.Subscribe('/SiteCreator/DeployButtonclick/', _cur.OnDeploymentClick);
SiteCreator.Eventing.Subscribe('/SiteCreator/SelectActionChange/', _cur.SelectActionChange);
SiteCreator.Eventing.Subscribe('/SiteCreator/SiteChange/', _cur.OnSiteChange);
SiteCreator.Eventing.Subscribe('/SiteCreator/GetFeatureName/', _cur.GetFeatureName);
_cur.className = model.className;
_cur.siteContainerId = model.siteContainerId;
};
this.OnDeploymentClick = function (model) {
BaseDeployment(model, _cur.siteContainerId);
};
this.SelectActionChange = function (model) {
if (model.siteContainerId == _cur.siteContainerId) {
//Detect Add mode
if ($('input[type=radio][name=select-an-action][value=CreateNewInstallation]').is(':checked')) {
}//Detect Update mode
else if ($('input[type=radio][name=select-an-action][value=UpdateConfigurationSettings]').is(':checked')) {
}
}
};
this.OnSiteChange = function (model) {
if (model.siteContainerId == _cur.siteContainerId) {
$("#selectActionDiv").show();
$("#updateConfigOption").hide();
}
};
this.GetFeatureName = function (model) {
BaseGetFeatureName(model, _cur.siteContainerId);
};
}
};After we integrate our project with the Deployment Manager App, we should see our steps and user input appear when we select the Example site within the app.
You can download the code the for SampleSite project here
To learn how to leverage the Deployment Manager SDK see the following articles: