SOW Worker Revision Upload

These integrations upload SOW worker revisions to an existing SOW.

Only the data being changed is required in the upload file.

Connector Overview

Component

Detail

Company Type

Buyer

Supplier

Version Type

API-V1.0 (for SOW Worker Revision Upload)

API-A-V1.0

BULK-DELTA-V1.0 (for SOW Worker Revision Delta Upload)

Format

CSV

Prerequisites

Company plug-ins must be turned on for Integration – SOW Worker Revision Upload or SOW Worker Revision Delta Upload.

User role permission is turned on for Upload Data and Download Data.

Predecessors

Statement of Work

User

SOW Worker

Sites

Locations

Related Connectors

SOW Worker Upload

SOW Shell Upload

File Formatting

Header

For SOW Worker Revision Upload

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.

SOW Worker Revision Upload

Transaction

Yes

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. Optional field containing any specific reference value required by the supplier.

  • False: Only records in error fail. Remaining records are committed successfully.

Language

No

Determines the language to be used for values in the file, such as drop-down lists and radio buttons. Column headers always default to the upload user's preferred language.

The valid language values are:

Arabic (Standard Arabic)
Chinese (Simplified)
Chinese (Traditional)
Dutch (Netherlands)
English (United Kingdom)
English (United States)
French (Canada)
French (France)
German (Germany)
Hebrew (Israel)
Hungarian (Hungary)
Italian (Italy)
Japanese (Japan)
Korean (Korea)
Mongolian (Mongolia)
Polish (Poland)
Portuguese (Brazil)
Portuguese (European)
Russian (Russia)
Spanish (Mexico)
Swedish (Sweden)

Number Format

No

Determines the number format to be used in the file.

The valid values are:

  • “#,##9.99" (Example: "1,234,567.99”)

  • “#.##9,99" (Example: "1.234.567,99”)

  • “#'##9.99" (Example: "1'234'567.99”)

  • “# ##9,99" (Example: "1 234 567,99”)

The quotes are required even if the value does not have a comma in it. If this field is not included in the header, the default value is “#,##9.99” (Example: ”1,234,567.99”)

Date Format

No

Determines the date format to be used in the file.

The valid values are:

  • MM/DD/YYYY

  • DD/MM/YYYY

  • YYYY-MM-DD

Optional field containing any specific reference value. If this field is not included in the header, the default value is MM/DD/YYYY.

Approval Required

Yes 

Determines if Approval Group is to be used.

Valid values are:

  • True: The SOW Worker is routed through the approval process if approvals are set up.

  • False: The SOW Worker bypasses the approval process, if there exist any.

Buyer

Yes, if supplier upload

Buyer Code

Buyer Code of Buyer for which the SOW Worker Revisions are being uploaded.

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

Purchase Order Number

Field Header Name

Data Type

Length

Required?

Value(s)/Format

Description/Use/Field Rules

sap-technical-name 

Text

100

No

Optional field containing any specific reference value required by the supplier.

Job Seeker ID

Test

16

Yes, if Work Order ID field is not entered.

Valid SAP Fieldglass Job Seeker ID

Example:

  • ABCDJS00000001

Job Seeker ID of the Job Seeker to be Revised.

Work Order ID

Text

16

Yes, if Job Seeker ID field is not entered.

Valid SAP Fieldglass Work Order ID

Example:

  • ABCDWO00000012

Work Order ID of the Work Order to be Revised.

External SOW ID

Text

100

No

An external SOW identifier used by the client for tracking purposes

Workforce ID

Text

16

No

Valid SAP Fieldglass Workforce ID

Example:

  • KELYWF00000013

Workforce ID of the SOW worker.

First Name

Text

200

No

Example:

  • John

First Name of SOW worker

Last Name

Text

200

No

Example:

  • Smith

Last Name of SOW worker

SOW Worker Role

Text

100

Conditional

When Use Rate Grid is turned off for the SOW: The code entered here should match an existing SOW Worker Role defined by the buyer.

When Use Rate Grid is turned on for the SOW: The value entered here should match the SOW Worker Role defined in the Roles, Sites and Unit of Measure combination for the Statement of Work.

Entering a value here changes the current Role on the SOW Worker.

Entry is only valid if SOW response is in Approved status.

If changing role, Site and UOM fields must also be entered.

If the SOW worker role is changed when revising the worker, the associated job code to the new worker role is updated on the worker record.

If the SOW is revised and the SOW worker role is changed for a confirmed worker, the associated job code to that worker role is updated on the worker record.

Site Code

Text

100

No

Valid SAP Fieldglass Site Code

Site Code of SOW Worker

Purchase Unit

Text

100

Conditional

Valid Purchase Unit Code

Purchase Unit of the SOW Worker

Mail Code

Text

100

No

Mail Code of SOW worker

Unit of Measure

Text

100

Conditional

When Use Rate Grid is turned off for the SOW: The code entered here should match an existing UOM defined by the buyer.

When Use Rate Grid is turned on for the SOW: The value entered here should match the Unit Of Measure defined in the 'Roles, Sites and Unit of Measure' combination for the Statement of Work.

Entry is only valid if SOW response is in Approved status and Track Time Sheets = Yes.

If UOM entered, Role and Site fields need to be entered also.

If the SOW has enabled Rate Schedules, the system ignores the contents of this column.

Rate Schedule Code

Text

100

No

Valid SAP Fieldglass Rate Schedule Code

Indicates rate schedule.

Company configuration Enable Rate Schedules must be set and SOW Worker Role uses Rate Schedules.

If SOW Work Order's current Rate Schedule is a unit-based Rate Schedule (Unit Pay Rate and Coefficient or Unit Bill Rate), then only a unit-based Rate Schedule can be specified. If SOW Work Order's current Rate Schedule is a non-unit-based Rate Schedule (Pay Rate and Coefficient Rate Schedule, Rate Rate Schedule, or Markup Rate Schedue), then only a non-unit-based Rate Schedule can be specified.

When 'Rates 2.0' is enabled:

The system ignores the 'Use Admin Structure' flag on the Rate Schedule to align with behavior in the UI.

If new Role combo uses a different Rate Schedule, the Start Date of the Revision must be coincide with the start of a Time Sheet period. Otherwise, the system displays an error.

This upload does not prevent changing the Rate Schedule from an All Units Rate Schedule to a Mixed Rates and Units Rate Schedule, or vice versa.

If Rate schedule changes (to any other Rate Schedule), the Revision must start on a Time Sheet Start Date, so this prevents a mid-Time Sheet/Rate Schedule switch.

Validations are in place to ensure that if the Rate Schedule type is 'Units only' and does not track time, the Time Sheet type cannot be 'TITO'.

Default Shift Code

Text

100

No

Shift Code that is valid for the Base Section of the Rate Schedule in the Rate Schedule Code

Indicates default shift code.

Company configuration 'Enable Rate Schedules' must be set and SOW Worker Role uses Rate Schedules.

Billable per Diem

Number

No

The amount of per diem for each day that the worker charges hours.

If left blank, it is taken as zero.

Entry is only valid if SOW response is in Draft status.

Hours per Day

Number

No

Example:

  • 8

The standard number of hours worked per day.

Entry is only valid if SOW response is in Draft status.

If the Rate Schedule Code has a Base Rate that is not Hourly, the system ignores the contents of this field.

Hours per Week

Number

Conditional

Example:

  • 40

The standard number of hours worked per week.

This field is required if the 'Track Time Sheet' flag is set to True on the work order.

Entry is only valid if SOW response is in Draft status.

If the Rate Schedule Code has a Base Rate that is not Hourly, the system ignores the contents of this field.

Purchase Order Number

Text

100

No

Any purchase order number assigned to the Statement of Work for which SOW worker is being submitted.

Entry is only valid if SOW response is in Draft status.

Additional Discount

Decimal

No

Valid values are 0-100, up to 3 decimal places

Discounts can be defined on the SOW rule must be set to Yes for the SOW ID, else this field is ignored.

Revision Start Date

Date

No

The date on which the SOW worker’s new assignment begins.

When a statement of work revision is in draft, and the SOW worker is being revised, this field cannot be empty or missing.

When Use Rates Based on Effective Date is set to Yes, if the start date of the work order revision does not match the start of the time sheet, the upload fails with an error message.

End Date

Date

No

The date on which the SOW worker’s new assignment ends.

When a statement of work revision is in draft, and the SOW worker is being revised, this field cannot be empty or missing.

Start Date for SAP Fieldglass Time Reporting

Date

No

Start Date of SOW worker’s first time sheet period.

Entry is only valid if SOW response is in Draft status.

Allow Worker to submit SOW Line Items

Text

3

No

Valid values are:

  • Yes

  • No

Indicates if SOW worker is allowed to submit SOW line items, such as events, fees, and schedules.

Security ID

Text

100

No

Security ID of SOW worker.  

Entry is only valid if company config Security Information is enabled.

If the Worker Country of Origin value has a configured Auto-generate Security ID format (which is available for configuration when the Auto-generate Security ID company configuration is enabled), the Security ID will be auto-generated and any value entered here will be ignored.

Username

Text

100

No

Username of SOW worker

Auto invoice all SOW items

Text

3

No

Valid values are:

  • Yes

  • No

Indicates if SOW characteristics should be auto-invoiced. Only entered if Auto Invoice company configuration is enabled.

The value is applied to the line item if the SOW template flag Auto invoice characteristics, timesheets and expense sheets is set to Yes and the Auto Invoicing for Services flag for Supplier Admin is not locked. Also applied if the current value of Auto invoice characteristics, timesheets and expense sheets flag on SOW is No, but the current value of Auto invoice characteristics, timesheets and expense sheets flag on the underlying SOW Template is Yes. Otherwise, the value in the column is ignored.

SOW Worker Primary Contact

or

SOW Worker Primary Contact Username

Text

100

No

Valid SAP Fieldglass Username.

SAP Fieldglass Username of SOW Worker primary contact.

SOW rule Allow changes to Site and Location on the SOW Work Order/Worker by Buyer must be enabled.

When a statement of work revision is in draft, and the SOW worker is being revised, this field cannot be empty or missing.

Work Site

Text

100

Conditional

Valid SAP Fieldglass Site

Work Site of SOW Worker.

If Site entered, Role and UOM fields need to be entered also.

SOW rule Allow changes to Site and Location on the SOW Work Order/Worker by Buyer must be enabled.

Default would be SOW Site.

If the Enhanced Legal Entity Validation configuration is enabled for the company and Allow changes to Site, Location on the SOW Work Order/Worker by Buyer or Supplier is enabled, the system validates that the site code entered has visibility to the worker's legal entity (from SOW) and the worker primary contact (Owner).

Location

Text

100

Conditional

Valid SAP Fieldglass Location(s).

Example:

  • loc1~loc2~loc3

Location of SOW Worker.

SOW rule Allow changes to Site and Location on the SOW Work Order/Worker by Buyer must be enabled.

Multiple locations are separated by a tilde (~), this field becomes mandatory and company configuration Allow Multiple Locations must be enabled.

Location

Text

100

Conditional

Valid SAP Fieldglass Location Code(s).

Example:

  • loc1~loc2~loc3

Location of SOW Worker.

SOW rule Allow changes to Site and Location on the SOW Work Order/Worker by Buyer must be enabled.

Location codes must be defined in the SAP Fieldglass application.

Multiple codes are separated by a tilde (~) when at least one sub-configuration for company configuration Use multiple locations is enabled.

Primary Location Code

Text

10

Conditional

Valid SAP Fieldglass location code

Indicates primary location code.

Enable at least one sub-configuration for the company configuration Use multiple locations.

If the selected primary location isn't listed in the 'Location Code' column, the application displays an error message.

If the 'Primary Location Code' column is blank for records with multiple locations or even a single location, the application displays an error message.

Time Sheet Type

Text

16

Conditional

Valid values are:

  • Standard (or Hourly)

  • Time-In/Time-Out

  • No Time Sheets

Depends on the selection on the SOW.

If the time sheet type defined for SOW is other than No Time Sheets and is not enabled for the Work Order’s Site, then this field is required.

If SOW Worker's Rate Schedule has Capture Time Worked on Time Sheet = No, then Time Sheet Type cannot beTime In/Time Out.

Tax Service Type

Text

500

Conditional

Valid Tax Service Type Pick List values.

Used for Tax Adjustment if the Tax Guidance is enabled.

If Tax Guidance is On, and Tax Service Type is a Key, then this field is required.

If Rates 2.0 is enabled, this field does not appear.

Worker Spend

Decimal

No

Indicates worker spend.

Company configuration Enable Rate Schedules must be set.

Mandatory when Rate Schedule type is Unit Pay Rate and Coefficient or Unit Bill Rate.

Negative numbers are allowed as long as the SOW Worker's Cumulative Committed Spend is greater than 0.

[sc] Security Custom Field

Dependent on Custom Field Type

Conditional

Dependent on Custom Field Type

This is only applicable only when the Security Information Functionality is enabled.

[br] Rate Category/ UOM

Decimal

Conditional

Example:

[br] ST/Hr

135.89

The presented bill rate for the SOW Worker.

If supplier upload, supplier must provide rate category name and unit of measure.

When SOW uses Rate Schedules, the Rate Category/UOM in the header must be a valid rate for the Rate Schedule specified in the row.

When 'Rates 2.0' is disabled:

The rate is automatically set to zero If Allow invoicing from approved Time Sheets is not enabled for the SOW.

Value of the row must be valid for Rate Schedule/Rate Grid.

If the rate is a calculated rate (Accruable, Accruable - Calculated, Pay Rate - Calculated, Rate - Calculated, Unit Bill Rate - Calculated, or Unit Pay Rate - Calculated), the system ignores the contents of this column.

If Coefficient rate, value must be 1 to 10.

If Factor rate, value must be 1 to 1000.

If Pay Rate, when SOW rule 'Disallow Supplier edits to Pay Rate (for Rate Schedules with Coefficients)' is enabled and a value is entered in this column, the value is ignored.

When 'Rates 2.0' is enabled:

If Bill Rate is not editable, this column is ignored because the system calculates the Bill Rate using the Rate Component Group and/or Factor, when applicable.

If the Bill Rate is editable but the column is omitted or no value is entered, the system keeps the current rate. The value defaults from the current Work Order, or, if the rate is new to the Work Order Revision, from the Role-Site combination on the Statement of Work.

If Bill Rate is editable, and a value is entered, the system validates that entry.

The maximum value for this field is 99999999999.99; the number of decimal places allowed is determined by the currency setup.

If the rate uses a Factor, value can only be edited using the [factor] Rate Category/UOM column header.

If the rate uses Rate Components, such as a Markup or Coefficient, values can only be edited using the [rcomp] Rate Category/UOM~Rate Component Code column header.

If Use Rates Based on Effective Date is set to Yes, and you are only allowed to decrease the rate, but you increase it, the upload fails with an error message.

[pr] Rate Category/UOM

Decimal

No

Example:

[pr] ST/Hr

125.89

The presented Pay Rate for the SOW Worker.

If supplier upload, supplier must provide rate category name and unit of measure.

When SOW uses Rate Schedules, the Rate Category/UOM in the header must be a valid rate for the Rate Schedule specified in the row.

When 'Rates 2.0' is disabled:

In order for Pay Rate to be editable, the SOW Worker must use a Rate Schedule that contains Pay Rate or Unit Pay Rate.

If the rate is a calculated rate (Accruable, Accruable - Calculated, Pay Rate - Calculated, Rate - Calculated, Unit Bill Rate - Calculated, or Unit Pay Rate - Calculated), the system ignores the contents of this column.

When the SOW rule Disallow Supplier edits to Pay Rate (for Rate Schedules with Coefficients) is enabled and a value is entered in this column, the value is ignored.

When 'Rates 2.0' is enabled:

If the rate does not support a Pay Rate, this column is ignored.

If Pay Rate is applicable to the rate but is not editable, this column is ignored and the system automatically applies a Pay Rate. The value is calculated according to the rate and lookup setup.

If Pay Rate is editable but no value is entered, the system automatically applies a Pay Rate. The value is calculated according to the rate and lookup setup.

If Pay Rate is editable and a value is entered, the system validates that entry.

The maximum value for this field is 99999999999.99; the number of decimal places allowed is determined by the currency setup.

When the SOW rule Disallow Supplier edits to Pay Rate is enabled, and a value is entered in this column, the value is ignored.

[factor] Rate Category/UOM

Decimal

6

No. This column must be manually added and customized as needed.

Minimum Value = 0.001

Maximum Value = 50.000

The value is capped at 3 decimal places.

This field is only applicable when Rates 2.0 is enabled.

The factor for the Rate for the SOW Worker.

If the rate does not use a Factor, anything entered in this column is ignored for that row.

If the rate uses a Factor, and this column is customized with a specific Rate Category/ Rate UOM, but the column name entered does not match a valid Factor-based Calculated Rate, an error is displayed.

A Factor rate uses the same Rate Component Group as its Base (if Base uses one) unless a different Rate Component Group was specified for the Factor.

If the Factor entered causes the Bill Rate to exceed the maximum allowed value, an error is generated.

[rcomp] Rate Category/UOM~Rate Component Code

Decimal

17

No. This column must be manually added and customized as needed.

Example:

[rcomp] ST/Hr~ABC

3.500000

This field is only applicable when Rates 2.0 is enabled.

The rate component for a rate that uses a Rate Component Group.

The 17-character value may include a decimal. A negative symbol is allowed for any component except Coefficient.

The system ignores this column when the rate does not use a Rate Component Group OR the Component is not one the Supplier is allowed to edit (COS, Fee, TAX).

If this column is customized with a specific Rate Category/ Rate UOM~Rate Component Code (e.g. [rcomp] ST/Hr~ABC), but the column name entered is invalid for the rate, an error is generated.

If the column is customized with a valid Rate Category/ Rate UOM~Rate Component Code, but the Rate Component is not editable, an error is generated.

[mrkp] Rate Category/UOM

Decimal

No

Example:

[mrkp] ST/Hr

10.50

The mark up for a rate.

If supplier upload, supplier must provide rate category name and unit of measure for the buyer that the supplier is uploading.

When SOW uses Rate Schedules, the Rate Category/Rate UOM in the header must be a valid rate for the Rate Schedule specified.

Value of the row must be valid for Rate Schedule/Rate Grid; If the rate is a calculated rate (Accruable, Accruable - Calculated, Pay Rate - Calculated, Rate - Calculated, Unit Bill Rate - Calculated, or Unit Pay Rate - Calculated), the system ignores the contents of this column. If Coefficient rate, value must be 0 to 10. If Factor rate, value must be 0 to 1000.

If Rates 2.0 is enabled, this field does not appear.

[M] rate code

Decimal

No

Example:

  • 2.5

Multiplier used with calculated rates. If added for a certain rate code, the multiplier value is used during calculation. Also applicable to SOW workers using rate schedules.

If Rates 2.0 is enabled, this field does not appear.

[usage] Rate Category/Rate UOM

Decimal

No

Example:

  • 50.50 , 65.25

Usage % of the rate.

The total of the usage % should equal 100.

Entry is only valid if company configuration Supplier must enter % on the rates for the SOW Worker is enabled.

If Rates 2.0 is enabled, this field does not appear.

[c] SOW 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 Custom Field type.

Any custom field associated with the SOW worker. The custom field name should be prefixed with '[c]'.

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 the SOW Worker is being added to an SOW that uses a Contract, value will default from SOW when the field is blank.

If the SOW Worker is being revised, the existing value of custom field will default, or if field was picked up by the revision, then the SOW's value will default.

Unique Identifier

  • Job Seeker ID field or Work Order ID field

Assumptions/Tips

  • The user must manually add the headers for bill rates, e.g. [br] ST/Hr.

  • The user must manually add the headers for SOW worker custom fields, e.g. [c] SOW Worker Custom Field 1.

  • The user must manually add the headers for Usage % for the pay rates, e.g. [usage] ST/Hr.

  • A supplier can upload a SOW worker when the SOW Response is in an Approved status or the SOW Response is in Draft by the supplier.

  • The SOW Worker rate is automatically set to zero if Allow invoicing from approved Time Sheets is not enabled for the SOW.

  • To process SOW Worker revisions, Work Order should be in a Confirmed status.

  • Tax Guidance must be loaded prior to use of Tax Service Type.

  • Amounts are automatically rounded to a whole number but displayed to two decimal points if the currency is Yen. For some other user entered amounts, a validation has to happen on the upload to ensure that the value entered is a whole number where precision is supposed to be zero decimals.

  • 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.

  • If the supplier enters a Rate Schedule that is different than the SOW Work Order's existing Rate Schedule, the system validates that the Start Date of the Revision coincides with the start of a Time Sheet period.

  • The system checks the Use Admin Structure flag on each SOW Work Order's Rate Schedule. If No, the system does not pull in any changes from Rate Schedule admin. object. If Yes, the system refreshes the Rate Schedule and rates from the Rate Schedule admin object for: Name, Custom Fields, Shift Structure, Rates, Rate Rule/Custom Script for each Rate, and Frequency for each Rate.

  • This connector uses the Corporate Calendar for the spend calculation when the company configuration Spend calculation is based on corporate calendar is enabled.

  • If there are no approvals, the SOW Work Order Revision is confirmed and updates the Consolidated Worker.

  • A change to the SOW worker role with a different job code results in a change of job code on the SOW worker. When an SOW is revised and the SOW worker role is changed on workers in accepted, activated, or any unregistered status, the role change is immediately reflected on the SOW worker.

  • If this upload causes changes to SOW worker role, site, or location, the system re-evaluates the activity checklist when the SOW worker revision reaches final approval to determine if there are additional activity items affected.

  • If the Allow Selection of Multiple Locations on SOW Workers rule is enabled, multiple locations can be added to the same SOW worker. The list of available locations is based on the latest confirmed version of the statement of work. If an existing location on the SOW worker is removed from the SOW, then an error is displayed when editing or revising the SOW worker.

  • For Rates 2.0:

    • Rate and Rate Component values entered in the upload are validated against the Rate/Site combo selected for the Work Order Revision.

    • Calculated Rates that rely on Rate Rules do not need to be added in the file, since they do not accept rate values.

    • Rate Rules are processed for Calculated Rates if the rule is set up to process on SOW Work Orders.

    • If a column isn't listed in the file for a particular Rate Type, then it isn't supported for that Rate Type, and the system ignores entries in unsupported columns.

    • The user must manually add the headers for Factor and Rate Components, when applicable.

    • A revision changes only the rate values you include in the file. If you omit a rate column (for example, [br] ST/Hr) or leave it blank, the work order keeps its current rate. The system does not pull a new rate from the statement of work for a rate that already exists on the work order. To change an existing rate on the revision, include the rate column with the new value. The same applies to the pay rate, factor, and rate component columns.

  • 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.

Configuration Considerations

#

Item

Notes

1

External SOW ID

In case the clients are using external ref. or testing with external ref instead of SOW ID, go to SA admin page, edit the bulk upload batch job for company, select the specific batch job ID, and change the column key from SOW ref. to external ref.

Example: For 'SOW Characteristic Upload', it is ‘dbo.get_split_key(data, 1,''' +  ''','''')' by default. Change 1 to 2 (column 2 is external ref column).