Job object

[This documentation is preliminary and is subject to change.]

The Job Object accesses a job and aligns with the hierarchy of the AXE Job Manifest.

  • Collections
  • Methods
  • Properties

Collections

The Job object has the following collections.

Collection Description
AssessmentCollection

This property provides direct read-only access to the collection of assessments in the job manifest. This property is only available in the Job object. It provides an enumerable collection the solution can use rather than having to rely on the AssessmentCount property and GetAssessment method.

AssessmentRuns

A collection of AssessmentRun Objects containing information used to manage the assessments that are run by the job, such as parameter values and metric thresholds. Received from a job manifest or solution. AssessmentRuns is a collection of AssessmentRun elements. There can be one or more runs of a specific assessment in a job.

Assessments

Read-only collection of Assessment Objects that represents each of the individual assessments in a job. When an AssessmentRun Object is added to a job, the AXE checks to see if it has seen that particular assessment before. If not, then it adds that assessment to the Assessments collection.

 

Methods

The Job object has the following methods.

Method Description
DeployToFolder

Copy the job manifest into a directory and copy the assessment manifests needed by the job into subdirectories.

GetAssessment

Retrieve a specific assessment from the job.

 

Properties

The Job object has the following properties.

Property Access type Description

AssessmentCount

Read-only

Strong identity of the job received from a solution or job manifest.

CurrentAssessmentIndex

Read-only

Retrieve the assessment index of the assessment that is currently running.

Description

Read/write

Descriptive information for the job received from a solution or job manifest.

The values of the following sub-elements of the Description element provide the information describing the job:

Name provides the localized human-readable name. ProgrammaticName provides the non-localized programmatic name that can be used by applications. ToolTip provides the localized human-readable short description. Tags provides a collection of Tag elements. This field may be empty. Categories provides a collection of Category elements. This collection may be empty. Details provides a rich documentation as a RTF stream. This stream may have zero length (be empty.)

EarliestStartTime

Read/write

Earliest start time and date for the job in Coordinated Universal Time (UTC.) Received from a job manifest or solution. The default value is a DateTime type containing all zeros and means there is no specified delay before starting the job. Solutions may save the value of this property in the job manifest as the value of an EarliestStartTime element.

FileName

Read-only

The file path to the file that backs the job data. Received from a job manifest or solution. Received from the value of the FilePath element in the assessment manifest.

IsDirty

Read/write

If true, the job is not read-only and has been changed. This means it needs to be saved.

IsNew

Read-only

If true, the job manifest is new and has never been saved to a file.

KeepTempFiles

Read/write

If true, AXE will not delete temporary files or report files. Received from a job manifest or solution. The default value is false and means temporary files can be deleted. Solutions may save the value of this property in the job manifest as the value of an KeepTempFiles element.

LastSaveDateTime

Read-only

Last time and date in UTC that the job manifest was saved to a file. The default value for a new job is all zeros and means 12:00:00 midnight, January 1, 0001 A.D. (Common Era.) The value is saved in a LastSavedTimeAndDate element.

LastSaveId

Read-only

A GUID value saved the last time AXE saved a job manifest. The value for a new job manifest is "{00000000-0000-0000-0000-000000000000}". The value is saved in a LastSavedId element.

OfflineImage

Read/write

Path to the off-line image of a file. Received from a job manifest or solution. The default value is an empty string. Solutions may save the value of this property in the job manifest as the value of an Image element.

PostExecutionAction

Read/write

An action with command line AXE should perform upon completing the job. Set by a solution.

ResultsPublishPath

Read/write

A UNC path to the location of a file containing job results. Received from a job manifest or solution. The default value is an empty string and means AXE will leave results in place and not delete them. Solutions may save the value of this property in the job manifest as the value of an ResultsPublishPath element.

SolutionData

Read/write

Provides SolutionData Object of the XmlDocument class defined by the solution. The document may be empty or the property may be set to a null value. The default is that the value of the property is null and no solution data is saved with the job data.

Status

Read-only

Retrieve the current state of execution for the job. A job can be in one of three states: NotYetRun, Running, and Completed.

UserNameString

Read/write

Name for the job provided by the job author. A solution may use this name, the value is ignored by AXE. The default value is an empty string. Solutions may save the value of this property in the job manifest as the value of an UserString element.

VersionedId

Read-only

Strong identity of the job received from a solution or job manifest. The VersionedId value contains the Guid and Version values that uniquely identifies the version of a job. The Guid of the job is unique and never changes. A solution may update a job's Version value.

 

See also

Job

 

 

Build date: 9/6/2011