ExcelServicesJob Members

  • Article

Include Protected Members
Include Inherited Members

Defines methods, properties, and events for validating, dividing, scheduling, and executing divided work on a compute cluster.

The ExcelServicesJob type exposes the following members.

Constructors

  Name Description
Public method ExcelServicesJob() Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(String, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(ExcelServicesWork, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(String, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(ExcelServicesWork, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(Trigger, ExcelServicesWork, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(Trigger, String, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob([], ExcelServicesWork, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob([], String, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(Trigger, ExcelServicesWork, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob(Trigger, String, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob([], ExcelServicesWork, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.
Public method ExcelServicesJob([], String, Int32, JobPriority, String, String, SecureString, String, LocationType, String, String, Boolean) Initializes a new instance of the ExcelServicesJob class.

Top

Properties

  Name Description
Public property ApplicationName Gets or sets the application name used by the ScheduledTask property to execute the Windows Compute Cluster Server 2003 job.
Public property AsyncCheckTaskPeriod Gets or sets the period in milliseconds that is used to check whether a task has completed during the execution of the private RunNowAsync method.
Public property Capacity (Inherited from List<TaskTracker>.)
Public property CCSFilename Gets the Windows Compute Cluster Server 2003 XML file name used by the Schedule and ScheduledRunNow methods.
Public property Cluster Gets or sets the compute cluster for the current job instance.
Public property ClusterName Gets or sets the name of the compute cluster to connect to, to submit the Windows Compute Cluster Server 2003 job.
Public property ClusterNodes Gets the number of nodes associated with the compute cluster where the job is submitted.
Public property Coordinates Gets or sets the coordinate to output the results in the workbook template.
Public property Count (Inherited from List<TaskTracker>.)
Public property DataCulture Gets or sets the data culture used in opening the workbook template for the ProcessCompleteResult method.
Public property DataCultureName Gets or sets the data culture based on the name, used in opening the template workbook for the ProcessCompleteResult method.
Public property Divisor Gets or sets the divisor value for the fixed TypeOfDivision property.
Public property IncludeHeader Gets or sets whether the header is included in the output used by the results collection for the Schedule and ScheduledRunNow methods.
Public property InputWork Gets or sets the input for the ExcelServicesWork object used in dividing the work and distributing it to the cluster.
Public property Item[Int32] (Inherited from List<TaskTracker>.)
Public property Item[Task] Gets or sets the TaskTracker indexer.
Public property JobFilename Gets or sets the Windows Compute Cluster Server 2003 XML file name used by the Schedule and ScheduledRunNow methods.
Public property JobName Gets the Windows Compute Cluster Server 2003 job and task name for the jobs submitted by the Schedule, ScheduledRunNow, and private RunNowAsync methods.
Public property LocalPath Gets or sets the local file path based on the UNCPath property.
Public property MaximumProcessors Gets or sets the maximum number of processors to use for the Windows Compute Cluster Server 2003 jobs and tasks.
Public property MinimumProcessors Gets or sets the minimum number of processors to use for the Windows Compute Cluster Server 2003 jobs and tasks.
Public property OutputLocation Gets or sets the output location used by the results collection for the Schedule and ScheduledRunNow methods.
Public property Priority Gets or sets the priority of the Windows Compute Cluster Server 2003 job.
Public property ResultWork Gets the ExcelServicesWork result generated from the collection of results from the XML files.
Public property ScheduledJobId Gets or sets the Windows Compute Cluster Server 2003 job identifier for the job submitted by the private RunNowAsync method.
Public property ScheduledTask Gets or sets the scheduled task created by the Schedule and ScheduledRunNow methods.
Public property ScheduledTaskDate Gets the date of the scheduled task used by the Schedule and ScheduledRunNow methods.
Public property ScheduledTaskDirectory Gets the scheduled task directory value.
Public property ScheduledTaskName Gets the name of the scheduled task.
Public property SerializationFileName Gets or sets the Excel Calculation Services XML serialization file name.
Public property Status Gets the result status after the execution of the ProcessCompleteResult method.
Public property TaskList
Public property TaskTrigger Appends a task trigger to the existing set of triggers.
Public property TaskTriggers Gets or sets an array of task triggers created by the Schedule and ScheduledRunNow methods.
Public property Template Gets or sets the template used by the results collection for the Schedule and ScheduledRunNow methods.
Public property TypeOfDivision Gets or sets the type of division to perform in dividing the input work into Windows Compute Cluster Server 2003 tasks.
Public property TypeOfLocation Gets or sets the location type used by the results collection for the Schedule and ScheduledRunNow methods.
Public property UICulture Gets or sets user interface culture used in opening the workbook template for the ProcessCompleteResult method.
Public property UICultureName Gets or sets the name of the user interface culture, used in opening the template workbook for the ProcessCompleteResult method.
Public property UNCPath Gets or sets the head node UNC location where the Windows Compute Cluster Server 2003 and Excel Calculation Services XML job files are stored prior to execution.
Public property Workbook Gets the workbook result output from the ProcessCompleteResult method.

Top

Methods

  Name Description
Public method Add (Inherited from List<TaskTracker>.)
Public method AddRange (Inherited from List<TaskTracker>.)
Public method AsReadOnly (Inherited from List<TaskTracker>.)
Public method BinarySearch(T) (Inherited from List<TaskTracker>.)
Public method BinarySearch(T, IComparer<T>) (Inherited from List<TaskTracker>.)
Public method BinarySearch(Int32, Int32, T, IComparer<T>) (Inherited from List<TaskTracker>.)
Public method Clear (Inherited from List<TaskTracker>.)
Public method CompleteAsync Completes an asynchronous operation.
Public method Contains (Inherited from List<TaskTracker>.)
Public method ConvertAll<TOutput> (Inherited from List<TaskTracker>.)
Public method CopyTo([]) (Inherited from List<TaskTracker>.)
Public method CopyTo([], Int32) (Inherited from List<TaskTracker>.)
Public method CopyTo(Int32, [], Int32, Int32) (Inherited from List<TaskTracker>.)
Public methodStatic member DeserializeMe Deserializes the XML in an XML file into an object.
Public method Dispose() Closes the scheduled task if it is still open, and closes the impersonation and cluster objects.
Public method Dispose(Boolean)
Public method Divide Performs division on the object based on the TypeOfDivision and Divisor properties.
Public method Equals (Inherited from Object.)
Public method Exists (Inherited from List<TaskTracker>.)
Protected method Finalize (Inherited from Object.)
Public method Find (Inherited from List<TaskTracker>.)
Public method FindAll (Inherited from List<TaskTracker>.)
Public method FindIndex(Predicate<T>) (Inherited from List<TaskTracker>.)
Public method FindIndex(Int32, Predicate<T>) (Inherited from List<TaskTracker>.)
Public method FindIndex(Int32, Int32, Predicate<T>) (Inherited from List<TaskTracker>.)
Public method FindLast (Inherited from List<TaskTracker>.)
Public method FindLastIndex(Predicate<T>) (Inherited from List<TaskTracker>.)
Public method FindLastIndex(Int32, Predicate<T>) (Inherited from List<TaskTracker>.)
Public method FindLastIndex(Int32, Int32, Predicate<T>) (Inherited from List<TaskTracker>.)
Public method ForEach (Inherited from List<TaskTracker>.)
Public method GenerateXml() Creates an XML file.
Public method GenerateXml(Boolean) Creates the XML file used by the Microsoft.Office.Excel.Server.Addins.ComputeCluster executable file.
Public method GetEnumerator (Inherited from List<TaskTracker>.)
Public method GetHashCode (Inherited from Object.)
Public method GetRange (Inherited from List<TaskTracker>.)
Public method GetType (Inherited from Object.)
Public method IndexOf(T) (Inherited from List<TaskTracker>.)
Public method IndexOf(T, Int32) (Inherited from List<TaskTracker>.)
Public method IndexOf(T, Int32, Int32) (Inherited from List<TaskTracker>.)
Public method Insert (Inherited from List<TaskTracker>.)
Public method InsertRange (Inherited from List<TaskTracker>.)
Public method LastIndexOf(T) (Inherited from List<TaskTracker>.)
Public method LastIndexOf(T, Int32) (Inherited from List<TaskTracker>.)
Public method LastIndexOf(T, Int32, Int32) (Inherited from List<TaskTracker>.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OutputName Returns the output file name.
Public method ProcessCompleteResult() Processes the results of a completed job and stores the collected results in the ResultWork property.
Public method ProcessCompleteResult(Boolean, Int32, Int32, String, LocationType, String) Processes the results of a completed job and stores the collected results in the ResultWork property.
Public method Remove (Inherited from List<TaskTracker>.)
Public method RemoveAll (Inherited from List<TaskTracker>.)
Public method RemoveAt (Inherited from List<TaskTracker>.)
Public method RemoveRange (Inherited from List<TaskTracker>.)
Public methodStatic member ResetCreds Facilitates the resetting of credentials for a single task.
Public method Reverse() (Inherited from List<TaskTracker>.)
Public method Reverse(Int32, Int32) (Inherited from List<TaskTracker>.)
Public method RunNow Adds an event handler for the TaskCompleted event prior to executing the private RunNowAsync method.
Public method SaveWorkbook() Saves the workbook output from the ProcessCompleteResult method.
Public method SaveWorkbook(String, LocationType) Saves the workbook output from the ProcessCompleteResult method.
Public method Schedule Validates, divides, and then schedules the work to perform on the compute cluster on the head node using the ScheduledTask property.
Public method ScheduledRunNow Validates, divides, creates a schedule, and then runs the work to perform on the compute cluster immediately.
Public method ScheduledRunNowWait Validates, divides, creates a schedule, and then runs the work to perform on the compute cluster immediately. Waits for the work to be completed.
Public method SerializeMe Serializes the current instance of the object based on the FileName parameter.
Public method Sort() (Inherited from List<TaskTracker>.)
Public method Sort(IComparer<T>) (Inherited from List<TaskTracker>.)
Public method Sort(Comparison<T>) (Inherited from List<TaskTracker>.)
Public method Sort(Int32, Int32, IComparer<T>) (Inherited from List<TaskTracker>.)
Public method ToArray (Inherited from List<TaskTracker>.)
Public method ToString (Inherited from Object.)
Public method TrimExcess (Inherited from List<TaskTracker>.)
Public method TrueForAll (Inherited from List<TaskTracker>.)
Public method Validate Performs validation on the constructor parameters prior to the execution of the Divide method.

Top

Events

  Name Description
Public event JobCompleted
Public event JobCredentialsCached
Public event JobErrored
Public event JobInputDivided
Public event JobResourcesValidated Notifies and passes back the results of resource validation.
Public event JobTimeout Provides notification about a task timeout.
Public event JobUserImpersonated
Public event JobXmlGenerated
Public event TaskCompleted Provides notification about the completion of a task.
Public event TaskErrored

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IXmlSerializable.GetSchema
Explicit interface implemetationPrivate method IXmlSerializable.ReadXml
Explicit interface implemetationPrivate method IXmlSerializable.WriteXml
Explicit interface implemetationPrivate method IList.Add (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IList.Contains (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method ICollection.CopyTo (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IEnumerable<T>.GetEnumerator (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IList.IndexOf (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IList.Insert (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property IList.IsFixedSize (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property ICollection<T>.IsReadOnly (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property IList.IsReadOnly (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property IList.Item (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate method IList.Remove (Inherited from List<TaskTracker>.)
Explicit interface implemetationPrivate property ICollection.SyncRoot (Inherited from List<TaskTracker>.)

Top

See Also

Reference

ExcelServicesJob Class

Microsoft.Office.Excel.Server.Addins.ComputeCluster Namespace