Class JobVariable

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Represents a Job Variable

public sealed class JobVariable : ADTObject, IJobVariable

Inheritance

object

ObjectBase

ADTObject

JobVariable

Implements

IJobVariable

Properties

AddToEnvironment

Indicates whether the variable is added to the environment

public bool AddToEnvironment { get; set; }

Property Value

bool

BooleanValue

Gets or sets the Value as a boolean value.

public bool? BooleanValue { get; set; }

Property Value

bool?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Boolean. This property returns null if the variable has no value, or if the value cannot be converted to a boolean. adTempus stores boolean values as "1" (true) or "0" (false).

Caption

The caption to be used when prompting for a value for this variable

public string Caption { get; set; }

Property Value

string

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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.

DateTimeValue

Gets or sets the Value as a DateTime.

public DateTime? DateTimeValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.DateTime. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "yyyy-MM-dd HH:mm:ss.fff"

DateValue

Gets or sets the Value as a DateTime containing only a date.

public DateTime? DateValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Date. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "yyyy-MM-dd"

DecimalValue

Gets or sets the Value as a decimal.

public decimal? DecimalValue { get; set; }

Property Value

decimal?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Decimal. This property returns null if the variable has no value, or if the value cannot be converted to a decimal.

ExecutionOverrideRule

Determines whether the variable can be overridden when a job using this variable is submitted for execution by a Job Execution Task, Job Control Action, or manually (on-demand)

[RequiredVersion(5, 0, 0, 0)]
public JobVariableOverrideRule ExecutionOverrideRule { get; set; }

Property Value

JobVariableOverrideRule

HideValue

Specifies whether the value should be hidden from the user

public bool HideValue { get; set; }

Property Value

bool

Remarks

When HideValue is true the user interface hides the value of the variable. Users with Edit permission for the owning object are able to reveal the value of the variable but other users cannot. The Job Detail Log masks the values for hidden variables

IntegerValue

Gets or sets the Value as an integer.

public int? IntegerValue { get; set; }

Property Value

int?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Integer. This property returns null if the variable has no value, or if the value cannot be converted to an integer.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

Name

The name of the variable

public string Name { get; set; }

Property Value

string

OverriddenVariable

The variable that this variable overrides

[RequiredVersion(5, 0, 0, 0)]
public JobVariable OverriddenVariable { get; }

Property Value

JobVariable

Remarks

This property is only set when using one of the GetInheritedVariables methods. It is not saved with the variable.

OverrideRule

Determines whether the variable can be overridden at a lower level

[RequiredVersion(5, 0, 0, 0)]
public JobVariableOverrideRule OverrideRule { get; set; }

Property Value

JobVariableOverrideRule

PropagateInheritedValue

Determines whether the inherited value for this variable is sent to subsequent jobs in the chain.

[RequiredVersion(5, 0, 0, 0)]
public bool PropagateInheritedValue { get; set; }

Property Value

bool

Remarks

When PropagateInheritedValue is true the explicitly-defined Value at this level is ignored and the inherited value is used.

RedactedValue

Returns the Value, or the ArcanaDevelopment.adTempus.Resources.Literals.HiddenValueMask if HideValue is true

public string RedactedValue { get; }

Property Value

string

StringValue

Gets or sets the Value as a string

public string StringValue { get; set; }

Property Value

string

TimeValue

Gets or sets the Value as a DateTime value that stores only the time.

public DateTime? TimeValue { get; set; }

Property Value

DateTime?

Remarks

If the value is set using this property, the VariableType is changed to JobVariableType.Time. This property returns null if the variable has no value, or if the value cannot be converted to a DateTime. adTempus stores DateTime values in the format "HH:mm:ss.fff"

UserInterfaceExtensionID

Extension ID of the custom UI for this variable

public string UserInterfaceExtensionID { get; set; }

Property Value

string

Value

The value of the variable

public string Value { get; set; }

Property Value

string

Remarks

All variable values are stored as strings but can be specified as specific data types using the VariableType and get/set using one of the specified Value properties.

See Also

BooleanValue

DateTimeValue

DateValue

DecimalValue

IntegerValue

StringValue

TimeValue

ValueAsObject

Gets the Value as an object of the type specified by the VariableType.

public object ValueAsObject { get; }

Property Value

object

VariableType

The data type of the variable

public JobVariableType VariableType { get; set; }

Property Value

JobVariableType

Remarks

See remarks under Value

Methods

CopyFrom(JobVariable)

Copies all properties from the source variable

public void CopyFrom(JobVariable source)

Parameters

Name	Type	Description
source	JobVariable

Exceptions

ArgumentNullException

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

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.

HideFieldValueInTextOutput(string)

Suppress hidden values in Object Configuration Reports and Dataset Projections.

protected override bool HideFieldValueInTextOutput(string fieldName)

Parameters

Name	Type	Description
fieldName	string

Returns

bool

TrySet(JobVariableType, string)

Tries to set the variable to the specified type and value.

public bool TrySet(JobVariableType varType, string value)

Parameters

Name	Type	Description
varType	JobVariableType	The new VariableType
value	string

Returns

bool

Remarks

TrySet attempts to convert the provided string value to the type specified by varType. If this succeeds, the VariableType and Value are updated and the method returns True. Otherwise the variable is not updated and the method returns false.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

Name	Type	Description
reportBuilder	IADTObjectConfigurationReportWriter	The report builder to write the object to.

Inherited Members

• ADTObject.LastModified
• ADTObject.CreationTimestamp
• ADTObject.FromController
• ADTObject.CustomProperties
• ADTObject.Description
• ADTObject.DescriptionTextType
• ADTObject.OID
• 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.IsReadOnly
• ObjectBase.IsDirty
• ObjectBase.IsNew
• ObjectBase.IsStub
• ObjectBase.ClassName
• ObjectBase.GetDescriptionWithClassName()
• ObjectBase.GetDescription()
• ObjectBase.BeginEdit()
• ObjectBase.BeginEdit(UndoLevelAction)
• ObjectBase.CommitEdit(Guid)
• ObjectBase.CommitEdit()
• ObjectBase.UndoEdit()
• ObjectBase.UndoEdit(Guid)