Class ScriptExecutionTask
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class ScriptExecutionTask : Task
- Inheritance
-
objectScriptExecutionTask
Properties
AllowUserInterface
public bool AllowUserInterface { get; set; }
Property Value
- bool
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
CaptureOutput
Indicates whether the output from the script should be saved as a CapturedFile in the job history.
public bool CaptureOutput { get; set; }
Property Value
- bool
Remarks
Output can be captured only for PowerShell scripts. This option is ignored for other scripts.
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
CommandLineParameters
Specifies the command-line parameters (arguments) to pass to the script.
public string CommandLineParameters { get; set; }
Property Value
- string
ExitCodeCriterion
public ExitCodeTestType ExitCodeCriterion { get; set; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
MaxRunTime
public int MaxRunTime { get; set; }
Property Value
- int
RunIsolated
public bool RunIsolated { get; set; }
Property Value
- bool
Script
public Script Script { get; set; }
Property Value
ScriptFile
public string ScriptFile { get; set; }
Property Value
- string
ScriptFileLanguage
public string ScriptFileLanguage { get; set; }
Property Value
- string
SuccessCriterion
public SuccessCriterion SuccessCriterion { get; set; }
Property Value
SuccessMaxCode
public int SuccessMaxCode { get; set; }
Property Value
- int
SuccessMinCode
public int SuccessMinCode { get; set; }
Property Value
- int
SupportedResponseEvents
Gets a list of the events that are supported for Responses associated with this task.
public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
Methods
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- Task.UserInterfaceExtensionID
- Task.UserInterfaceExtensionData
- Task.DescriptionOverride
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)