Work Order Worker Custom Field Update Upload

This integration uploads custom field edits. This upload differs from the Custom Field Update Upload in that it can update all work order revisions at the same time. You can also use Work Order ID, Worker ID, Consolidated Worker ID, Resource ID, and/or Profile Worker ID in the same upload file.

Connector Overview

Component	Detail
Company Type	Buyer Supplier MSP Partner
Version Type	API-A-V1.0
Format	CSV
Prerequisites	Company plug-ins must be turned on for Integration – Work Order Worker Custom Field Update Upload . User role permission must be turned on for Upload Data and Download Data.
Predecessors	Work Orders Workers Profile Workers Statement of Work
Related Connectors	N/A

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.	Work Order Worker Custom Field Update Upload
Buyer	Yes if supplier upload	Buyer Code	Buyer Code of the buyer for which the custom fields are being updated
Comments	No	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
Object ID or Security ID	Text	16	Yes	Valid SAP Fieldglass Work Order, Worker, Consolidated Worker, Profile Worker ID, or Resource ID. Examples: XXXXWO00000001 XXXXWK00000001 XXXXMW0000001 XXXXPW00000001 XXXXRE00000001	Unique ID for record. If a Work Order, Worker, Consolidated Worker, Profile Worker, or Resource ID is used, the column header should remain as Object ID. If Consolidated Worker is used in the Object ID, it's applied to all associated Work Orders/Worker records/Resource records tied to the associated Consolidated Worker ID. If a Security ID is used to update all records that contain that ID, the column head needs to be changed to Security ID.
Revision Number	Number		No	Valid revision number for Work Order ID or Profile Worker ID.	Indicates the revision number of the work order being updated. Applicable only if the field 'Revise All Work Order?' is 'No' or blank, otherwise an error is thrown.
Revise All Work Order?	Text	3	No	Valid values are: Yes No If no value is provided, it will revise the current revision.	Update all revisions or just the current revision. If a Consolidated Worker Object ID is used, this field isn't used, and updates are applied to all revisions of any associated work orders.
Buyer Reference	Text	100	No		Buyer Ref on the Work Order, Worker, Profile Worker, or Resource.
[c] Work Order Custom Field 1	Dependent on Custom Field Type		Conditional	Dependent on the custom field.	Custom fields as defined in the configuration. When Custom Field Type = Segmented Pick List and the Autopopulate Segment rule on the Pick List = Yes, if a segment value is left blank on the upload, the value is auto populated on the document if there is only one possible value based on the previous segment values. If there is more than one possible value, an error message displays.
[c] Worker Custom Field 1	Dependent on Custom Field Type		Yes, if the custom field is mandatory without a default value and is not a linked custom field.	Dependent on the custom field.	Custom fields as defined in the configuration. When Custom Field Type = Segmented Pick List and the Autopopulate Segment rule on the Pick List = Yes, if a segment value is left blank on the upload, the value is auto-populated on the document if there is only one possible value based on the previous segment values. If there is more than one possible value, an error message displays. If a worker belongs to a statement of work that uses a Contract, the value defaults from the statement of work when the field is blank. If a custom field already has a value, that value will default.
[c] Resource Custom Field 1	Dependent on Custom Field Type		Conditional	Dependent on the custom field.	Custom fields as defined in the configuration. When Custom Field Type = Segmented Pick List and the Auto Populate Segment rule on the Pick List = Yes, if a segment value is left blank on the upload, the value is auto populated on the document if there is only one possible value based on the previous segment values. If there is more than one possible value, an error message displays.
Object Buyer Ref ID	Text	100	Yes, if Object ID/Securty ID is not entered.		Buyer Ref used as a unique ID for the record.
Module Name	Text	100	No	Valid values are: Profile Worker Resource Worker Work Order	Module name of custom field when Object Buyer Ref ID is used as unique ID.

Unique Identifier

Object ID or Security ID.

Assumptions/Tips

Due to a requirement for tracking of the changes to values for Personally Identifiable Information (PII), SAP creates an audit trail for the following worker/user fields: Usernames, Names, Addresses, Phone Numbers, Email Addresses, Employee ID, Unique ID, Security ID, Attachments, and any custom fields configured as PII.
Both buyer and supplier entered custom fields display and can be updated by both parties regardless of who created the custom field first.
When the 'Revise All Work Order?' field is specified as Yes, the custom field(s) should be present on all the work order revisions.
If the Upload Column Transform setting (which is present in Connector Configurations) has the column 'Revise All Work Order?' default value as 'Yes', whenever the CSV file is uploaded, irrespective of providing a 'Revise All Work Order?' value or not, it picks up the value as 'Yes' and therefore all the revisions of the Work Order will be updated.
When updating a linked Worker custom field that has the same name from Contingent and SOW modules, the upload updates based on the type of worker record.
For any record, an error occurs if values for the Object Buyer Ref ID and Buyer Ref columns are given. (A column cannot be updated when it is being used as a primary key.)
When a worker custom field is edited:
- If custom fields that are being edited are not tenure lookup keys, tenure recalculation is not triggered. Therefore, any prior violations are not triggered or monitored.
- If the custom fields that are being edited are tenure lookup keys, tenure is recalculated. This could cause a previous violation to trigger again. However, a custom field that is tenure-relevant and has been altered must adhere to compliance measures, and therefore, the update requires a work order revision instead of a worker update.
If Consolidated Worker is used in the Object ID field, it is applied to all associated Work Orders / Worker records tied to the associated Consolidated Worker ID.
For a worker/work order, if a custom field already has a value and the upload is sent with a blank, the already populated custom field value is blanked out.
Regarding closed resource workers:
- If the Object Buyer Ref ID/Object ID is for a closed resource, the upload will fail with a valid error message.
- If the Consolidated Worker Object ID/Security ID includes a closed resource and other workers/work orders, the upload will be successful, ignoring the closed resource and updating the custom fields of other workers/work orders.
- If the Consolidated Worker Object ID/Security ID includes only one closed resource, the upload will fail with a valid error message.
Regarding leading and dependent custom fields:
- When leading and dependent custom fields have been set up, and a buyer downloads a blank upload template for this connector from the user interface, leading and dependent custom fields are automatically added as individual columns.
- The system reads the value of the leading custom field and validates the first dependent custom field. This process continues for all dependent custom fields in the defined sequence until it is completed.
For work orders for SOW Workers, the revision time is only updated if the Buyer Reference is provided.