Class JobScheduledTaskAddIn

Namespace

Dynamicweb.DataIntegration.Integration

Assembly

Dynamicweb.DataIntegration.dll

[AddInName("RunDataIntegrationJobAddIn")]
[AddInLabel("Run Data Integration Job AddIn")]
[AddInDescription("Run Data Integration Job AddIn")]
[AddInIgnore(true)]
public class JobScheduledTaskAddIn : BaseScheduledTaskAddIn, IParameterOptions, IParameterVisibility

Inheritance

object

ConfigurableAddIn

BaseScheduledTaskAddIn

JobScheduledTaskAddIn

Implements

IParameterOptions

IParameterVisibility

Inherited Members

BaseScheduledTaskAddIn.ScheduledTaskName

BaseScheduledTaskAddIn.Task

BaseScheduledTaskAddIn.CancellationToken

BaseScheduledTaskAddIn.IsCancellationTokenUsed

BaseScheduledTaskAddIn.HostUrl

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Activity

[AddInParameter("Activity")]
[AddInParameterEditor(typeof(GroupedDropDownParameterEditor), "required=true;ReloadOnChange=true;SortBy=,,default", InfoText = "Select the activity to run, or select an activity folder's \"(all activities)\" option to run every activity in that folder")]
public string? Activity { get; set; }

Property Value

string

StopOnFailedActivity

[AddInParameter("StopOnFailedActivity")]
[AddInLabel("Stop on failed activity")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool StopOnFailedActivity { get; set; }

Property Value

bool

Methods

GetHiddenParameterNames(string, object?)

public IEnumerable<string> GetHiddenParameterNames(string parameterName, object? parameterValue)

Parameters

parameterName string

parameterValue object

Returns

IEnumerable<string>

GetParameterOptions(string)

public IEnumerable<ParameterOption> GetParameterOptions(string parameterName)

Parameters

parameterName string

Returns

IEnumerable<ParameterOption>

Run()

Performs the work of the scheduled task. Called once per task run, after the framework has populated the context properties and loaded the saved parameter values.

public override bool Run()

Returns

bool

true when the work succeeded; otherwise false. The value is logged and stored as the task's last result. Exceptions that escape this method are caught by the framework, logged, and recorded as a failed run.