Worker Security Single Line Download

This integration downloads worker and associated assignment database on an effective key of Security ID (SID). This version of the download provides one record per worker, regardless of the cost center, task code and/or rate association. Only the worker's primary cost center is provided; no information on associated task codes or rates is included against the record.

Connector Overview

Component

Detail

Company Type

Buyer

Supplier

MSP Partner

Version Type

1.0 - Original version. Pulls the latest Work Order revision including pending revisions and last Profile Worker revision including pending revisions.

1.1 - Pulls the last confirmed Work Order revision and last Approved Profile Worker revision. It will not pull "pending" revisions.

2.0 - Optimizes version 1.0.

3.0 - Supports resource workers.

Format

CSV

Prerequisites

Company Details Setting must be turned on for Integration – Worker Security Single Line Download.

User role permission must be turned on for Upload Data and Download Data.

Security ID functionality must be enabled for the buyer.

Predecessors

Worker(s)

Related Connectors

  • Active Worker Single Line Download

  • Active Worker Delta Single Line Download

  • Worker from Work Order Download

  • Worker from Work Order XML Download

  • Worker from Work Order HRXML Download

  • Supplier Worker Download

  • Worker Security Download

Inclusion Criteria

Workers and work orders in the following statuses are included if there have been any updates made to either the worker or work order record since the last run of the download.

Work Order Status

Worker Registered

Worker Record Included in Download

Status in Download

Person ID

Pending Approval

No

Yes

Pending

Blank

Rejected

No

Yes

Closed

Blank

Created

No

Yes

Pending

Blank

Accepted

No

Yes

Pending

Blank

Activated

No

Yes

Activated

Blank

Confirmed

Yes

Yes

Active

Populated

Pending Approval

Yes

Yes

Active

Populated

Created

Yes

Yes

Active

Populated

Confirmed

Yes

Yes

Active

Populated

Rejected

Yes

Yes

Closed

Populated

Declined

Yes

Yes

Closed

Populated

Confirmed

Yes

Yes

Active

Populated

Approval paused/ Pending Approval/ Created

n/a

Yes

Pending

 

Blank

 

Rejected

n/a

Yes

Closed

 

Blank

 

Closed

No

Yes

Closed

Populated

Declined

No

Yes

Closed

Populated

Confirmed (Worker Closed) (End date after the download date)

Yes

Yes

Active

Populated

Confirmed (Worker Closed) (End date on or before the download date)

Yes

Yes

Closed

Populated

File Formatting

Detail

Column Header Name

Data Type

Length

Enabled by Default?

Value(s)/Format

Description/Use/Field Rules

Security ID Text 100 Yes   Unique identifier for a candidate when the supplier submits the candidate against a work order (WO).
Job Seeker ID Text 16 Yes

Example:

XXXXJS00000001

SAP Fieldglass Job Seeker ID

Tied to the work order. (A worker can have many Job Seeker IDs.)

Not available for resource worker.

Worker ID Text 16 Yes

Example:

XXXXWK00000001

or

ABCDRE00001234

SAP Fieldglass Worker ID or resource worker ID.

Populated when the worker registers.

Tied to the work order. (A worker can have many worker IDs.)

Person ID Text 24 Yes  

Unique identifier for the worker as a person or resource worker person ID.

Populated when the worker registers.

Status Text 50 Yes  

Status of the worker:

Active or Closed

First Name Text 200 Yes

Example:

John

First name of the worker as defined in SAP Fieldglass.
Last Name Text 200 Yes

Example:

Smith

Last name of the worker as defined in SAP Fieldglass.
Worker Email Text 100 Yes

Example:

JSmith@abcd.com

Worker’s e-mail address.
Job Posting Title Text 100 Yes   Job posting title, SOW name for SOW workers, or job code for resource worker.
Work Order ID Text 16 Yes

Example:

XXXXWO00000001

Work Order ID.
Work Order/Work Order Revision Owner Text 100 Yes  

Work order owner’s name.

Not available for resource worker.

Work Order/Work Order Revision Owner Employee ID Text 100 No Valid Work Order Employee ID Work order owner’s employee ID.
Business Unit Code Text 100 Yes Valid Business Unit Code Business unit code.
Business Unit Name Text 100 Yes Valid Business Unit Name Business Unit Name.
Vendor Number Text 6 Yes Valid Supplier Code SAP Fieldglass Supplier Code for buyer.
Vendor Name Text 200 Yes Valid Supplier name Supplier name.
Buyer Code Text 6 Yes Valid Buyer Company Code Buyer company code.

Supervisor Username

Text

100

No

Valid SAP Fieldglass username.

Supervisor Username.

Auto register

Text

3

No

Valid options are:

Yes

No

Indicates if the resource is auto registered.

Time Template

Text

600

No

Time template associated to the Resource worker.

Work Schedule

Text

600

No

Work Schedule associated to the resource.

Work Schedule Effective Date

Date

No

Date on which the work schedule for the resource is effective.

Remit To Address Code Text 100 No Code as assigned to the RTA by the supplier.

Code as assigned to the RTA by supplier.

Not available for resource worker.

Cost Center Name Text 200 No Valid SAP Fieldglass Cost Center Name

Primary Cost Center Name in SAP Fieldglass.

Not available for resource worker.

Cost Center Code Text 200 Yes Valid SAP Fieldglass Cost Center Code

Primary Cost Center Code in SAP Fieldglass.

Not available for resource worker.

Billable Per Diem Decimal No

Example:

75.00

Per diem amount that is billable (if applicable).

Not available for resource worker.

Start Date Date 10 Yes

Valid format is:

yyyy-mm-dd

Work order start date.
End Date Date 10 Yes

Valid format is:

yyyy-mm-dd

Work order end date.
Currency Text 100 Yes

Valid ISO Currency Code.

Example: USD

Currency designation.
Site Code Text 100 Yes Valid SAP Fieldglass Site Code Site code.
Site Name Text 100 Yes   Site name.

Vendor ID

Text

50

No

Native field for the buyer company’s external ID.

Worker Country of Origin

Text

3

Conditional

Valid SAP Fieldglass country code.

Examples:

GER

USA

Indicates worker's country of origin.

Company configurations 'Security ID format by worker country of origin' and 'Security Information' must be enabled.

Time Zone

Text

100

No

Examples:

GMT-06:00 Central Time (U.S. & Canada)

or

GMT-05:00 Eastern Time (U.S. & Canada)

or

GMT Greenwich Mean Time.

Time zone of worker.

If not entered, it is defaulted to the default setting of buyer's time zone.

Work Location Name

Text

100

Conditional

The location name.

Enable at least one sub-configuration for the company configuration Use multiple locations. If the download’s parameters pull a document with multiple locations, the row is repeated with the exact same information in all columns except the location columns. There will be as many duplicated rows as there are number of locations on the time sheet.

If a work order is associated with multiple locations, all associated work location names along with the name of the primary location appear in a single cell separated by tildes (~).

Location Code

Text

100

Conditional

Valid SAP Fieldglass location code

The location code.

Enable at least one sub-configuration for the company configuration Use multiple locations. If the download’s parameters pull a document with multiple locations, the row is repeated with the exact same information in all columns except the location columns. There will be as many duplicated rows as there are number of locations on the time sheet.

If a work order is associated with multiple locations, all associated location codes along with the primary location code appear in a single cell separated by tildes (~).

Primary Location

Text

100

No

Indicates primary location name when at least one sub-configuration for the company configuration Use multiple locations is enabled.

Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.

Not available for resource worker.

Primary Location Code

Text

100

No

Valid SAP Fieldglass location code

Indicates primary location code when at least one sub-configuration for the company configuration Use multiple locations is enabled.

Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.

Not available for resource worker.

Original Revision Start Date

Date

No

This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

Not available for resource worker.

[c] Work Order Custom Fields Text 500 Depends on custom field configuration.  

Custom fields found on the Work Order/Work Order Revision.

If there are many custom fields, there will be many columns. Column header format will be:

"[c] modulename_custom field name" (that is [c] followed by module custom text lowercase with no spaces, followed by underscore, followed by the custom field name text as defined by users in the SAP Fieldglass application.)

Not available for resource worker.

[c] Worker Custom Fields Text 1000 Depends on custom field configuration.  

Custom fields found on the worker.

If there are many custom fields, there will be many columns. Column header format will be:

"[c] modulename_custom field name" (that is [c] followed by module custom text lowercase with no spaces, followed by underscore, followed by the custom field name text as defined by users in the SAP Fieldglass® application.)

Custom fields from the following Modules may be included in the download:

SOW Worker

Worker

Profile Worker

Resource

[c] Worker User Person Custom Fields

 

 

Text 1000 Depends on custom field configuration  

Custom fields found on the worker user person.

If there are many custom fields, there will be many columns. The column header format will be:

"[c] modulename_custom field name" (that is [c] followed by module custom text lowercase with no spaces, followed by underscore, followed by the custom field name text as defined by users in the SAP Fieldglass application.)

[c] Buyer or Supplier custom fields Text 1000 Depends on custom field configuration  

Custom fields found on the supplier. For supplier side download, only those fields required by the buyer for supplier to be entered and viewed are downloaded.

If there are many custom fields, there will be many columns. The column header format will be:

“[c] modulename_custom field name” (that isthat is [c] followed by module custom text lowercase with no spaces, followed by underscore, followed by the custom field name text as defined by users in the SAP Fieldglass application.)

Unique Identifier

  • Security ID field

Custom Fields

  • The download file includes custom fields from various modules in SAP Fieldglass. The specific modules are explained in the preceding file format.

  • The client can specify the custom fields they wish to include in the file and the order they wish to see in the file.

  • At the time the connector is activated for the client, the client is required to supply a list of the custom fields and their order. This list is stored in SAP Fieldglass against the setup of the connector. If no custom fields are supplied, the download does not include any custom field values.

  • Custom fields that are included always appear at the end of the column layout after all of the native, either default, or optional SAP Fieldglass fields have been outputted.

  • For Worker User Person Custom fields:

    • If 'Store Encrypted Data' is set to 'Yes', buyer users with and without the 'View and Report on Sensitive Data' flag enabled in their user profile are able to see the unencrypted value.

    • If 'Visible to Supplier' is checked and 'Store Encrypted Data' is set to 'Yes', supplier users with and without the 'View and Report on Sensitive Data' flag enabled in their user profile are able to see the unencrypted value. If 'Visible to Supplier' is not enabled, suppliers do not see the field; the field is suppressed for suppliers in this case.

Download Selection Criteria

The following information outlines how the download selection logic works with regards to pulling information related to each unique worker based on Security ID. The terms 'worker' and 'assignment are used generically here, with the former referring to a given worker person, by Security ID, and the latter referring to the associated data that outlines the work period, cost allocation, etc. The actual data that is downloaded pulls from the worker/work order records (contingent/services) and profile worker records in the application. Profile workers do not have a separate assignment-related object. All information is contained within the profile worker record itself; however, the logic outlined below still applies, as if they are separate.

General Logic

  • A worker can be on many assignments, across the Contingent, Services, and Profile Worker modules in SAP Fieldglass. This download pulls data for only one of those assignments at a time, no matter how many or what types a worker is associated with.

  • The data pulled throughout the tenure of a given worker is designed to be a rolling indication of when that worker starts, on the first assignment, and when the worker ends, on the final assignment. If there are no more open assignments and the final (or only) assignment is closed, the worker record is downloaded as ‘Closed’ based on this final assignment.

  • To move from one assignment to the next, the download requires the currently referenced worker to be explicitly closed and to have an end date that has passed (that is, the assignment has expired). Both conditions must be met. If an assignment is expired but the worker is not yet explicitly closed, any update to that assignment sends data for the expired assignment. For more information, see the Assignment Selection Conditions section below.

Assignment Selection Conditions

  • Assignment data is pulled in the download as soon as a Security ID is available, meaning a record containing only the assignment data, with a status of ‘Pending’ and no associated worker record, is possible.

  • The download always seeks to pull an active assignment with the earliest start date.

  • If a second assignment is created with a start date prior to that of the first assignment, an update comes through on the subsequent run of the download with the data from that second assignment. However, if the start date is later than the start date from the first assignment, this does not pull through immediately. It may come through later, depending on the conditions at that time.

  • If the first assignment “expires” (i.e. the end date passes), but it is not closed, while the second assignment with a later start date exists, any updates to the worker continues passing the data for that expired assignment.

  • If the first assignment is closed and its end date passed but the second assignment is not closed, data comes from the second assignment, i.e. the next available non-closed assignment with the earliest start date. A status change to ‘Closed’ is not passed while there are active assignments.

  • If the second assignment closes while the first assignment with the earliest start date is expired but still not closed, the worker record does not pass any data and hence the status change to the second assignment is not passed.

  • When there are no more open assignments and/or the final (or only) assignment for the worker is closed, then the worker record is downloaded as ‘Closed’ based on the assignment with the latest start date.

    If both the first assignment with the earliest start date is closed and the second assignment with the later start date are closed between download executions, the most recently closed worker record with the latest closed time passes on the download and as ‘Closed’.

  • If a worker record is already downloaded as closed for an assignment and later a second assignment is created, then the download passes the worker record based off the second assignment. The client’s security system may decide, based on the elapsed time between the close of first assignment and start of second, whether to assign the worker a new identity/access ID or reuse the existing identity/access ID.

Assignment Revision Selection Conditions

  • When an assignment is under revision or revised, the worker record is downloaded with the assignment revision data included. If an assignment revision is then rejected or declined, the worker record comes through again and reflects data from the prior confirmed assignment.

  • For a worker on multiple assignments, the available revision data is used for assignment selection based on the same rules described above for the assignment selection conditions.

Assumptions/Tips

  • Deleted/erased/scrubbed fields are filtered out for this download.

  • If the buyer company has multiple MSPs, when the MSP supplier user downloads records, they see only records for their MSP.

  • Active worker type 'Direct Hire' is also downloaded, along with Temp and SOW workers.

  • The system includes any inactive cost centers associated with the document.

Configuration Considerations

#

Item

Notes

1

Row Count

If a row count of records is needed, go to SA admin page, edit the batch job for company, and select the Yes radio button under ROW COUNT option.

2

Include All Workers?

On the ‘Enabled Fields’ tab, add the field ‘Include All Workers?’. This field is not included in the output field. The download returns all workers instead of just workers that were edited since the last transaction.

3

Enable Delta Compare Configuration Option

If the ‘Enable Delta Compare’ field on the connector setup page is set to 'Yes', you can define the fields you want to monitor for changes. Two menu items become available under More Actions: ‘Define Delta Compare Fields’ and ‘Truncate Delta History’.

If you select ‘Define Delta Compare Fields’, it allows you to choose what fields you want to select for comparison. If no fields are chosen, all enabled fields are used for comparison. Any changes made between the downloads may impact the download results.

If you select ‘Truncate Delta History’, this truncates the back-end history table that is used to hold both the data string and key that is formed from the compare fields that were chosen. Any connector configuration changes made between the downloads may impact the download results, in particular changing the delimiter.