Workforce feature service

The Workforce feature service contains the following layers and tables:

• Workers layer
  • A point feature layer that contains a record for each mobile worker who is included in the project.
  • Includes information about the mobile worker, including their contact number and job title.
  • The mobile worker's ArcGIS organizational username is stored in the userid field.
  • The layer tracks who created and last updated each mobile worker.
  • There is a primary key-foreign key (PK-FK) relationship from GlobalID to Assignments.workerid. Using the GlobalID value from the Workers layer as the Assignments.workerid field value associates the mobile worker with all their assignments.
  • The layer has the following coded value domain associations:
    • The status field is associated with the Worker_Status coded value domain to track the mobile worker's status.
• Assignments layer
  • A point feature layer that contains a record for each assignment.
  • Includes information about the assignment, including its status, location, and description, among others.
  • The layer tracks who created and last updated each assignment.
  • Attachments are enabled on the feature layer.
  • The layer contains foreign keys for some fields, associating values from another layer with this layer:
    • Assignments.workerid to Workers.GlobalID.
    • Assignments.dispatcherid to Dispatchers.GlobalID.
    • Assignments.workorderid can be used as a foreign key to an external system, such as an asset or maintenance management system, by providing values from the other system.
    • There is a PK-FK relationship from GlobalID to Assignment.assignmenttype. Using the GlobalID value from the Assignments layer as the Assignments.assignmenttype field value associates the assignment with the assignment type.
  • The layer has the following coded value domain associations:
    • The status field is associated with the Assign_Status coded value domain to track the assignment status.
    • The priority field is associated with the Priority coded value domain to manage the priority of work assignments.

  Caution:

  If an assignment has a null value for its geometry, it will not appear in Workforce.

• Dispatchers table
  • A table that contains a record for each dispatcher in the project.
  • Includes information about the dispatcher, including their name and contact number.
  • The dispatcher's ArcGIS organizational username is stored in the userid field.
  • The layer tracks who created and last updated each dispatcher.
  • There is a PK-FK relationship from GlobalID to Assignments.dispatcherid. Using the GlobalID value from the Dispatchers table as the Assignments.dispatcherid field value associates the dispatcher with all the assignments they assigned.
• Assignment Types table
  • A table that contains a record for each assignment type in the project.
  • This table is empty when the project is created. It contains values once assignment types have been added during project configuration.
  • It includes the descriptions for the assignment types specified by the project owner when the assignment types were added.
  • There is a PK-FK relationship from GlobalID to Assignments.assignmenttype. Using the GlobalID field value from the Assignment Types table associates the assignment type with assignments.
• Assignment Integrations table
  • A table that contains a record for each assignment integration in the project.
  • This table contains a record for integration with ArcGIS Navigator when created.
  • The Assignment Integrations table contains the following user-defined attributes, in addition to the standard system-defined attributes:
    • app—An identifier for the integrated app that will help find the integration configurations needed to populate the configuration experience in the web app—for example, arcgis-collector or https://collector.arcgis.app.
    • assignmenttype—The GlobalID of an assignment type if the integration should only be shown for certain assignment types. A value of null indicates that the integration supports all assignment types in the project.
    • prompt—The prompt displayed in the mobile client—for example, Navigate to assignment.
    • urltemplate—The template URL that is used to invoke the integrated app.
  • To find the integrations that are applicable to a particular assignment, use one of the following where clauses: assignmenttype = null or assignmenttype = '<assignment-type-id>'. These find all project-level integrations and all type-level integrations for the current assignment's type.
  • To find the integrations applicable to a project, query by the app using a where clause, for example, appid = 'arcgis-collector'.

The three coded value domains are as follows:

• Assign_Status—Stores the seven valid values for the status of an assignment. The values from 0-20 are reserved for future use by Workforce. Customers who want to store their own values in this field should choose a value from outside that range.
• Priority—Stores the four valid values for the priority of an assignment.
• Worker_Status—Stores the three valid values for the status of the mobile worker.

  For the values of the coded value domains, see the Workforce schema diagram.

Web map item relationship

The item relationship between the Workforce feature service and the worker and dispatcher web maps has the following definition:

• Relationship type—WorkforceMap2FeatureService
• Origin type—Web Map
• Destination type—Feature Service
• Rules
  • mustOwnAllItems—The project owner establishes the relationship and they must own the related map.

When a web map has an item relationship with the Workforce feature service, the following information is added to its metadata:

• title—The title of the project.
• snippet—The short description of the project.
• thumbnail—The thumbnail for the project.
• typeKeywords—Workforce Worker is added to the Worker map and Workforce Dispatcher is added to the Dispatcher map.

Get started with the Workforce module

The Workforce module allows you to create Classic projects as well as projects that are enabled for offline use. Create projects with the Workforce module by completing the following steps:

1. Sign in to ArcGIS Online by running the following command in either a Python script or Python console:
   gis = arcgis.gis.GIS("https://arcgis.com", "<username>", "<password>")

2. Create either a Classic project or a project that is enabled for offline use by running one of the following commands:

   Create a Classic project

   version1_project = arcgis.apps.workforce.create_project("<project-title>", "<project-summary>", major_version=1)

   Create a project enabled for offline use

   version2_project = arcgis.apps.workforce.create_project("<project-title>", "<project-summary>", major_version=2)

For information on how to use the Workforce module to modify assignments, assignment types, workers, dispatchers, and app integrations, see the ArcGIS API for Python documentation for the Workforce module.

Create an assignment using ArcGIS REST API

Workforce works with the content of the Assignments feature layer, regardless of how the records were created. There is no requirement to create assignments through the Workforce web app. If a record is properly created in the Assignments feature layer using ArcGIS REST API, Workforce recognizes it as a valid assignment in both the web and mobile apps.

When creating assignments using ArcGIS REST API, use the Add Features command. Some fields require values, you can provide values for other fields if your assignment requires them, and some fields cannot contain values.

The fields described in the following table require values:

You can also include values for the following optional fields:

To assign the work as part of its creation, use a status of 1 (as mentioned above) and provide the following fields as well:

The other fields in the Assignments layer are managed by the ArcGIS platform, including the fields that are marked as part of the ArcGIS or Editor Tracking fields in the schema diagram. Do not provide or modify these values.

Assign assignments using ArcGIS REST API

In the previous section, you learned how to create an assigned assignment. Now, you'll learn how to assign an existing assignment. Use the ArcGIS REST API Update Features command, passing in the array of features to be updated. For each feature, you must provide these three fields to assign or reassign an assignment: