Job Class—ArcGIS Pro

Job Class

In This Topic

Represents a Workflow Manager job

Object Model

Syntax

C#
Visual Basic (Declaration)

public sealed class Job

Public NotInheritable Class Job

Remarks

A Job is a single unit of work that is carried out within an organization. It may have one or many people working on it. It can would with a single dataset, multiple dataset or no data at all. A Job is created based off of a template known as a Job Type, which is configured with the desired properties and components (such as the Workflow and Maps) that will be used in the job. For more information on Workflow Concepts please refer to the help topic below.

Example

JobsManager manager = WorkflowModule.GetManager<JobsManager>(connectionPath);
Job jobInfo = await manager.GetJob(123);
jobInfo.Name = "test";
await jobInfo.Save();

How to get a job

// GetJob returns an existing job
// it is passed a valid job ID as an integer
var wfCon = await WorkflowModule.ConnectAsync();
var jobManager = wfCon.GetManager<JobsManager>();
var job = jobManager.GetJob(jobID);

How to get a job associated with a map

// Get a job associated with the map
var wfCon = await WorkflowModule.ConnectAsync();
var jobManager = wfCon.GetManager<JobsManager>();
var job = jobManager.GetJob(map);
if (job != null)
{
  // Job found, do something with the job
  var jobId = job.ID;
}

Inheritance Hierarchy

System.Object
ArcGIS.Desktop.Workflow.Models.JobModels.Job

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

Job Members
ArcGIS.Desktop.Workflow.Models.JobModels Namespace

Send feedback