Class ProgramExecutionTask
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class ProgramExecutionTask : Task
- Inheritance
-
objectProgramExecutionTask
Properties
BatchScript
Gets or sets the stored batch file to execute.
public Script BatchScript { get; set; }
Property Value
Remarks
The script must have a language of "Batch". It will be written to a temporary file and executed as a batch file.
If BatchScript is specified, the ExecutionTarget is ignored.
BatchScriptAutoCheckpoint
Determines whether adTempus will insert checkpoints in batch files when running a BatchScript.
public bool BatchScriptAutoCheckpoint { get; set; }
Property Value
- bool
Remarks
If this option is True, adTempus will insert a checkpoint call immediately after each line of the batch file that is a label (a line that starts with ":"). The label name will be used as the checkpoint name.
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
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
public string CommandLineParameters { get; set; }
Property Value
- string
CommandLineScript
public Script CommandLineScript { get; set; }
Property Value
ConsoleCaptureOptions
public ConsoleCaptureOptions ConsoleCaptureOptions { get; set; }
Property Value
CustomData
public string CustomData { get; set; }
Property Value
- string
CustomUIClass
public string CustomUIClass { get; set; }
Property Value
- string
ExecutionTarget
public string ExecutionTarget { 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
Priority
public ProcessPriority Priority { get; set; }
Property Value
SkipIfAlreadyRunning
public bool SkipIfAlreadyRunning { get; set; }
Property Value
- bool
StartupDirectory
public string StartupDirectory { 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
SuccessRuleScript
public Script SuccessRuleScript { get; set; }
Property Value
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>
WaitLimit
public int WaitLimit { get; set; }
Property Value
- int
WaitOptions
public WaitOptions WaitOptions { get; set; }
Property Value
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)