Worker Activity Milestone Item Upload

This integration uploads multiple Activity/Offboarding Activity (Onboarding/Offboarding, i.e. OOB) and/or milestone items for workers.

Connector Overview

Component	Detail
Company Type	Buyer
Version Type	API-V1.0
Format	CSV
Prerequisites	Company plug-ins must be turned on for Integration – Worker Activity/Milestone Item Upload. User role permission must be turned on for Upload Data and Download Data.
Predecessors	Activity (Onboarding) or Offboarding Activity Items Workers
Related Connectors	Supplier Onboarding Upload Standard Checklist Item Completion Upload

File Formatting

Header

Component	Required?	Definition/Use	Notes	Value
Type	Yes	Upload File Type	If you have a custom connector name for a standard connector, you may use the exact same custom name for the Type header; otherwise, you must use the standard name shown in the Value field.	Worker Activity Milestone Item Upload
Transaction	No	Only applicable for the API-V1.0 version. Transaction Type	Transaction Type. The valid type names are: True: If any record errors, the entire upload fails. False: Only records in error fail. Remaining records are committed successfully. If this field is not included in the header, the default value will be True.
Comments	No	Upload comments	This is a comment field containing notes about the upload file.

Component

Required?

Definition/Use

Notes

Value

Type

Yes

Upload File Type

If you have a custom connector name for a standard connector, you may use the exact same custom name for the Type header; otherwise, you must use the standard name shown in the Value field.

Worker Activity Milestone Item Upload

Transaction

Only applicable for the API-V1.0 version.

Transaction Type

Transaction Type.

The valid type names are:

True: If any record errors, the entire upload fails.
False: Only records in error fail. Remaining records are committed successfully.

If this field is not included in the header, the default value will be True.

Comments

Upload comments

This is a comment field containing notes about the upload file.

Immediately following the Header section of the upload is one blank line.

Detail

Field Header Name	Data Type	Length	Required?	Value(s)/Format	Description/Use/Field Rules
Modification Type	Char	1	Yes	Valid values are: A	'A' will add an Onboarding OffBoarding Activity/Milestone item to the worker. 'U' and 'D' are not supported by this upload. To delete activity items, use the Activity Item Delete Upload.
Worker ID	Text	16	Yes	Valid SAP Fieldglass Worker ID. Example: ABCDWK000012 ABCDPW000022	Worker ID to which the item is being associated.
Type	Text	100	Yes	Valid values are: Activity Offboarding Activity Milestone	This determines if the item to be associated is a milestone, an onboarding item, or an offboarding item. An onboarding item and an offboarding item may have the same code.
Code	Text	100	Yes	Valid SAP Fieldglass Activity/Offboarding Activity Code or New Milestone Code	The code for the Onboarding or OffBoarding Activity Item to be associated with the worker. The code must match the code specified in SAP Fieldglass. For Milestone Upload, this is the code of the new milestone to be created.
Action	Text	100	Yes for Milestone. No for Onboarding /Offboarding Activity Item.		Action to be taken for Onboarding/Offboarding Activity or Milestone.
Description	Text	1000	No		Item description
Completion Type	Text	100	Yes for Milestone. No for Onboarding /Offboarding Activity Item.	Valid values are: View Website Task Worker Evaluation Worker Edit Work Order Revision Supplier Evaluation Form - Attachment. Complete Custom Fields	Valid SAP Fieldglass Completion Type
Web Address	Text	100	Yes if Completion Type is 'Website – URL'.		Web address
Usage	Text	100	Yes for Milestone. No for Onboarding/Offboarding Activity Item.	Valid values are: Optional Mandatory	Usage
Actor	Text	100	Yes for Milestone. No for Onboarding/Offboarding Activity Item.	Valid SAP Fieldglass role	Role of the person who will perform the Onboarding/Offboarding Activity or Milestone action
Emails	Text	50	No		Email addresses, separated by commas or semicolons
Due Days	Number		Yes if Due Type is Prior To Worker Start or After Worker Start. Otherwise, not necessary.	Example: 0 - 999	Due Days
Due Type	Text	100	Yes if Due on Date is not entered for Milestone. No for Onboarding/Offboarding Activity Item.	Valid values are: Prior To Worker Start On Worker Start After Worker Start After Work Order Create Prior to worker end date On worker end date After worker end date After WO Accept After WOR Accept On Work Order Draft On Work Order / Work Order Revision Accept On WO Accept On WOR Accept On Worker Close On Profile Worker Close On SOW Close On SOW Create On SOW Accept On SOW Response Approval On SOW Revision Accept On SOW / SOW Revision Accept On SOW / SOW Revision Response Approval	Due Type
Due On Date	Date		Yes if Due Type is not entered for Milestone. No for Onboarding/Offboarding Activity Item.		Due On Date
Send work Items before due date (days)	Number		Yes for Milestone. No for Onboarding/Offboarding Activity Item.	Example: 0 - 999	Send Work Items Days before Due Date
Escalate after due date (days)	Number		Yes for Milestone. No for Onboarding/Offboarding Activity Item.	Example: 0 - 999	Escalate Days after Due Date
[c] `<custom field>` or Custom Field Names	Dependent on custom field configuration		Yes if Completion Type = Complete Custom Fields. Otherwise, leave blank.	Valid SAP Fieldglass Custom Field	Name of the custom fields. Multiple custom fields can be added using a tilde (~) separator. When uploading data in JSON format, Custom Field information must be provided in array format. If no custom fields need to be added, provide data in the below array format or do not include this element in the upload file. "Custom Fields":[{"name":"", "value":""}]
Custom Fields Default Values	Dependent on custom field configuration		Conditional, only if prior field is labeled Custom Field Names.		Default value for the custom fields specified above. This upload uses the default value defined at admin. level if not specified. Multiple values can be added using a tilde (~) separator.

Unique Identifier

Worker ID field

Assumptions/Tips

To delete activity items, use Activity Item Delete Upload.

For onboarding/offboarding records in upload, only required fields are:

Modification Type
Worker ID
Type
Code

All other fields will be picked up from predefined onboarding/offboarding items in the Admin > Workflow > OOB Items list

If enter another SAP Fieldglass ID other than worker id, that transaction will be ignored.
A milestone can be loaded to a worker that does not have to correspond to an OOB item in the Admin menu.
Activity Offboarding Upload will mirror the Worker Manage tab Activity/Offboarding Activity Items in the UI.
Milestone upload will mirror the Worker Manage tab New Milestone Items in the UI.
These are buyer-side uploads.
Profile Workers are handled like this:
- In the application, the Manage Tab for Profile Worker is available only on the original Profile Worker, and not the revisions. Therefore, when adding items via upload for any Profile Worker, they are automatically added to the original Profile Worker record.
- Onboarding and Milestone can only be added when a Profile Worker's status is not closed.
- Completion Type for Profile Workers includes - Complete Custom Fields, Website URL, Worker Edit, Task, and Form-Attachment only.
Completion Type ‘Manage Contingent Work end date’ is not valid for this connector.
If an Activity Item's Due Type is one of the Due Types that have action-based triggers, the upload will ignore the 'Send work items before due date (days)' column value.
When a user uses the upload to assign an activity item to a worker (and if that activity item is assigned a Rule Engine rule) the activity item's condition is evaluated. If the condition is met, the integration assigns the activity item. If the condition is not met, the integration does not assign the activity item, and an error is thrown.
The actors will be populated instantly on the Activity Item once it is attached to an SOW worker. You don't have to wait 5 minutes for this upload to complete. This change will be a generic change and will apply to all clients.