Skip to Content

SAP Fieldglass Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started

SAP Fieldglass Version Support

The connector leverages the SAP Fieldglass REST API to enable bidirectional access to SAP Fieldglass data.

Establish a Connection

Obtain Your Credentials

Please contact your SAP Fieldglass representative to obtain an OAuthClientId, OAuthClientSecret, and EnvironmentURL.

Connect to SAP Fieldglass

To authenticate to production environments, specify the following:

  • APIKey: Your SAP Fieldglass API Key. To obtain this, log in to the SAP Fieldglass Integration Tools and click Create API Application Key.
  • OAuthClientId: The OAuth Client ID that you obtained from your SAP Fieldglass representative.
  • OAuthClientSecret: OAuth Client Secret that you obtained from your SAP Fieldglass representative.
  • EnvironmentURL: The SAP Fieldglass Environment URL that you obtained from your SAP Fieldglass representative.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the SAP Fieldglass connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to SAP Fieldglass and then processes the rest of the query in memory (client-side).

User Defined Views

The SAP Fieldglass connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM AuditTrails WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The SAP Fieldglass connector models SAP Fieldglass objects as relational tables and views. A SAP Fieldglass object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to SAP Fieldglass APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Connectors as Views

SAP Fieldglass Connectors are exposed as views and internally use the default connector names, such as Active Worker Download.

In order to query the connectors as views, they should first be enabled and configured in SAP Fieldglass using the Integration Tools.

Make sure to set the ConnectorDataFormat property based on the configured download data format.

In order to list Connectors that are not part of the exposed views or have custom names, set the ConnectorNames property to a comma-separated list of Connector names. Make sure to correctly write the Connector names including spaces.

Connector Custom Fields

By default, the IncludeCustomFields property is set to false. Set it to true to list custom fields or fields that are not part of the current schemas.

To include the custom fields, the connector needs to make an individualized request per Connector, which may cause poor performance when listing metadata.

Selecting From Reports in SAP Fieldglass

The connector offers the possibility to select reports as relational views.

Selecting data from your reports

To access the data from your reports, query a view with the reports name. All the possible views can be seen using the sys_views system table.

SELECT * FROM [Job Posting Report 1]

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Fieldglass Connector Views

Name Description
ActiveWorkers Retrieve all active workers using the Active Worker Download connector.
ActiveWorkersSingleLine Retrieve all active workers using the Active Worker Single Line Download connector.
ActiveWorkOrderProfileWorkers Retrieve all active work orders including profile workers using the Active Work Order Profile Worker Download connector.
ActiveWorkOrders Retrieve all active work orders using the Active Work Order Download connector.
Approvals Query this table for approvals in SAPFieldglass.
ApprovedExpenseSheets Retrieve approved expense sheets using the Approved Expense Sheet Download connector.
ApprovedTimeSheets Retrieve all approved time sheets using the Approved Time Sheet Download connector.
Assignments Retrieve all active assignments using the Assignment Download connector.
AuditTrails Query this table for audit trails in SAPFieldglass.
BusinessUnits Retrieve business units using the Business Unit Download connector.
CATSTimeSheets Retrieve all time sheets entered in SAP CATS (Cross-Application Time Sheet) that are now in Draft, Rejected, and/or Pending Approval status within a provided parameter using the CATS Time Sheet Download connector.
CostCenters Retrieve cost centers using the Cost Center Download connector.
DistributionLists Retrieve distribution lists using the Distribution List Download connector.
DraftRejectedTimeSheets Retrieve all time sheets in draft/rejected approval status using the Draft Rejected Time Sheet Download connector.
DraftTimeSheets Retrieve all time sheets in Draft status using the Draft Time Sheet Download connector.
Locations Retrieve locations using the Location Download connector.
RateCategories Retrieve rate categories using the Rate Category Download connector.
RateCodes Retrieve rate codes using the Rate Code Download connector.
RateComponentGroups Retrieve rate component groups using the Rate Component Group Download connector.
RateComponents Retrieve rate components using the Rate Component Download connector.
RateGrids Retrieve rate grid codes using the Rate Grid Download connector.
RateGroups Retrieve rate groups using the Rate Group Download connector.
RateSchedules Retrieve rate schedules using the Rate Schedule Download connector.
RejectReasons Query this table for reject reasons in SAPFieldglass.
RequisitionLineItems Retrieve all high-level requisition information using the Requisition Line Item Detail Download connector. This connector differs from the Requisition Detail Download in that it adds SOW characteristic details. Each payment characteristic is added as a separate line and its corresponding details is sourced from the SOW.
Requisitions Retrieve all high-level requisition information using the Requisition Detail Download connector.
Resources Retrieve resources using the Resource Download connector.
SecurityWorkers Retrieve all data on workers with Security IDs using the Worker Security Download connector.
SecurityWorkersSingleLine Retrieve all data on workers with Security IDs using the Worker Security Single Line Download connector.
SecurityWorkersWithTransactionType Retrieve worker records based on transaction type filtering logic using the Worker Security with Transaction Type Download connector.
SecurityWorkersWithTransactionTypeSingleLine Retrieve worker records based on transaction type filtering logic using the Worker Security with Transaction Type Single Line Download connector.
ServiceEntrySheets Retrieve service entry sheets using the Service Entry Sheet Download connector.
ServiceReceipts Retrieve service receipts that are in Pending Approval, Approval Paused, Rejected and/or Approved status using the Service Receipt Download connector.
Sites Retrieve site codes using the Site Download connector.
SOWBids Retrieve SOW and SOW bid information using the SOW with Bid Download connector.
SOWCharacteristics Retrieve SOW characteristic information using the Approved Characteristic Download connector.
SOWs Retrieve Statement of Work (SOW) information using the SOW Download connector.
SOWWorkerRoles Retrieve worker roles in all statuses using the SOW Worker Role Download connector.
Suppliers Retrieve supplier configuration information using the Supplier Download connector.
TimeJournals Retrieve time journals that are in Submitted, Consolidated, and/or Errored status depending on a provided parameter using the Time Journal Download connector.
TimeSheetBuyerDeductions Retrieve time sheet deductions for buyers using the Deduction Buyer Download connector.
TimeSheets Retrieve contingent worker time sheets that are in Draft (with time entries), Rejected, and/or Pending Approval status, depending on a provided parameter using the Time Sheet Download connector.
TimeSheetSupplierDeductions Retrieve time sheet deductions for suppliers using the Deduction Supplier Download connector.
TimeSheetsWithNoTimeEntry Retrieve time sheets with no time entries using the Time Sheet with No Time Entry Download connector.
TITOTimeSheets Retrieve worker time in/time out (TITO) details based off a parameter entered during run time using the TITO Time Sheet Status Parameter Download connector.
Users Retrieve all active users for the logged in user's company using the User Download connector.
WorkersFromWorkOrder Retrieve multiple workers using the Worker from Work Order Download connector.

ActiveWorkers

Retrieve all active workers using the Active Worker Download connector.

Columns
Name Type Description
Worker ID String SAP Fieldglass Worker ID.
Job Seeker ID String SAP Fieldglass Job Seeker ID.
Person ID String Unique identifier for the worker as a person.
Security ID String This column will only appear in the file if the security ID field functionality is activated in SAP Fieldglass for the buyer. If the functionality is not activated, this column will not be in the file.
Status String Status of the worker.
First Name String First name of the Worker as defined in SAP Fieldglass.
Last Name String Last name of the Worker as defined in SAP Fieldglass.
Worker Email String Worker's e-mail address.
Job Posting Title String Job Posting's Title or SOW Name for SOW Workers.
Work Order ID String Work Order ID.
Work Order/Work Order Revision Owner String Work Order Owner's name.
Work Order/Work Order Revision Owner Employee ID String Work Order Owner's Employee ID.
Business Unit Code String Business Unit Code.
Business Unit Name String Business Unit Name.
Vendor Number String SAP Fieldglass Supplier code for buyer.
Vendor Name String Supplier name.
Buyer Code String Buyer Company Code.
Remit To address Code String Code as assigned to the Remit To Address by supplier.
Cost Center Name String Cost Center Name in SAP Fieldglass.
Cost Center Code String Cost Center Code in SAP Fieldglass.
Billable Per Diem Decimal Billable Per Diem
Start Date Date Work order start date.
End Date Date Work order end date.
Currency String ISO currency designation (ex. USD).
Site Code String Site Code.
Site Name String Site Name.
Rate Category / UOM String Worker's Rate Category/Unit Of Measure for which the corresponding rate will be displayed. More than one Rate Category/UOM may exist for a single Worker. If this is the case a new line will appear for each associated Rate Category/UOM in this file.
Bill Rate Decimal Worker's Bill Rate that is associated to the Rate Category/UOM listed in the previous field.
Pay Rate Decimal Worker's Pay Rate that is associated to the Rate Category/UOM listed in the previous field. If Supplier did not enter a Pay Rate, 0.00 will be displayed.
Sequence Int Work Order Revision Number.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration is set. This field is mutually exclusive with GL Account fields. More than one string can appear for a cost center.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone for worker.If not entered, it is defaulted to the default setting of buyer's time zone.
Discount % Decimal Discount % from SOW Worker
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Location Code String The location code of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Work Location Name String The location name of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

ActiveWorkersSingleLine

Retrieve all active workers using the Active Worker Single Line Download connector.

Columns
Name Type Description
Worker ID [KEY] String SAP Fieldglass Worker ID.
Job Seeker ID String SAP Fieldglass Job Seeker ID.
Person ID String Unique identifier for the worker as a person.
Security ID String This column will only appear in the file if the security ID field functionality is activated in SAP Fieldglass for the buyer. If the functionality is not activated, this column will not be in the file.
Status String Status of the worker.
First Name String First name of the worker as defined in SAP Fieldglass (100 characters).
Last Name String Last name of the worker as defined in SAP Fieldglass.
Worker Email String Worker's e-mail address.
Job Posting Title String Job Posting's Title or SOW Name for SOW Workers.
Work Order ID String Work Order ID.
Work Order/Work Order Revision Owner String Work Order Owner's name.
Work Order/Work Order Revision Owner Employee ID String Work Order Employee ID.
Business Unit Code String Business Unit Code.
Business Unit Name String Business Unit Name.
Vendor Number String Fieldglass Supplier code.
Vendor Name String Supplier name.
Buyer Code String Buyer Company Code.
Remit To Address Code String Code as assigned to the RTA by Supplier.
Cost Center Name String Cost Center Name in SAP Fieldglass. Primary Cost Center only.
Cost Center Code String Cost Center Code in SAP Fieldglass. Primary Cost Center Only.
Billable Per Diem Decimal Amount that is billable.
Start Date Date Work Order Start date.
End Date Date Work Order End Date.
Currency String Currency designation (USD).
Site Code String Site Code.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone for worker.If not entered, it is defaulted to the default setting of buyer's time zone.
Discount % Decimal Discount % from SOW Worker
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.
Project-Based Worker String Indicates if project-based workers are allowed.If this field is left blank, it uses the value from the Contingent Type.

ActiveWorkOrderProfileWorkers

Retrieve all active work orders including profile workers using the Active Work Order Profile Worker Download connector.

Columns
Name Type Description
Work Order ID String Work Order ID Will be blank for Profile Workers.
Revision Number Int Revision Number of Work Order or Profile Worker.
Work Order Start Date Date Start Date of Work Order or Profile Worker.
Work Order End date Date End Date of Work Order or Profile Worker.
Work Order Status String Status of the Work Order or Profile Worker.
Work Order Last Modified Date Date Last modified Date of Work Order or Profile Worker.
Work Order Activation Date Date Date this work order was activated. Will be blank if status is Created or Pending Approval.
Worker First Name String Worker's First Name.
Worker Last Name String Worker's Last Name.
Worker ID String SAP Fieldglass Worker ID.
Job Seeker ID String SAP Fieldglass Job Seeker ID. Will be blank for Profile Workers.
Vendor Name String Supplier Name.
Vendor Code String SAP Fieldglass Supplier code.
Job Posting Title String Job Posting Title. Will be blank for Profile Workers.
Site Name String Site Name
Site Code String Site Code
Site Address 1 String Site Address 1
Site Address 2 String Site Address 2
Site City String Site City
Site State/Province String Site State or Province
Site Country String Site Country ISO Code
Site ZIP/Postal Code String Site Zip or Postal code
Business Unit Name String Business Unit Name
Business Unit Code String Business Unit Code
Hours per Day Decimal Indicates Hours per Day. Will be blank for Profile Worker.
Hours per Week Decimal Indicates Hours per Week. Will be blank for Profile Worker.
Estimated Additional Spend Percentage Decimal Indicates any Additional Estimated Spend Percentage. Will be blank for Profile Worker.
Total Estimated Hours Decimal Indicates total estimated hours for work order. Will be blank for Profile Worker.
Estimated Expenses Percentage Decimal Indicates any estimated expenses percentage. Will be blank for Profile Worker.
Adjustments applies to estimated spend Percentage Decimal Indicates any adjustments applied to spend percentage. Will be blank for Profile Worker.
Remit to Address Code String Code as assigned to the RTA by Supplier.
Bill Rate Category String Rate category for Bill Rate. Will be blank for Profile Worker.
Bill Rate Decimal Worker's Bill Rate which is associated to the Rate Unit listed in the next field. Will be blank for Profile Worker.
Rate Unit String Unit of measure for bill rate. Will be blank for Profile Worker.
Currency String Currency designation (Example: USD) Will be blank for Profile Worker.
Average rate used to calculate spend Decimal Calculated average rate for work order. Will be blank for Profile Worker.
Billable per diem Decimal Amount that is billable per day. Will be blank for Profile Worker.
Maximum Expense Decimal Maximum amount for expenses. Will be blank for Profile Worker.
Committed spend Decimal Amount of committed spend. Will be blank for Profile Worker.
Cost Center Name String Cost Center Name in SAP Fieldglass. Primary Cost Center only. Will be blank for Profile Worker.
Cost Center Code String Cost Center Code in SAP Fieldglass. Primary Cost Center only. Will be blank for Profile Worker.
Cost Allocation percentage Decimal Percentage to allocate to cost center. If Cost Allocation Amount entered, this field is mandatory. If company configuration 'Cost Allocation Percentage decimal precision' is enabled, the Cost Allocation Percentage field shows zeros beyond the precision value set digit. Will be blank for Profile Worker.
Cost Allocation amount Decimal Amount to be allocated to cost center. Will be blank for Profile Worker.
Task Name String Name of task code Will be blank for Profile Workers.
Task Code String Task code Will be blank for Profile Workers.
Cumulative Committed Spend Decimal Amount accumulated for committed spend for work order(s). Will be blank for Profile Worker.
Spend to Date Decimal Amount spent to date. Will be blank for Profile Worker.
Job Posting Owner String Name of JP owner Will be blank for Profile Worker.
Job Posting Owner Employee ID String Employee ID of JP owner Will be blank for Profile Worker.
Job Posting Creator String Job Posting creator Will be blank for Profile Worker.
Work Order Create Date Date Creation date of work order or Profile Worker.
Work Order Submit Date Date Submit date of work order Will be blank for Profile Workers.
External ID String An external Work Order identifier used by the client for tracking purposes.
Purchase Order Number String PO Number
Legal Entity Code String Indicates legal entity code associated to worker/profile worker. Required if company configuration 'Enable Legal Entity' is set. Default legal entity configuration on Profile Worker must be 'Apply the same Entity validation used for Contingent'.
Purchase Unit String Name of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Purchase Unit Code String Code of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone for worker. If not entered, it is defaulted to the default setting of buyer's time zone.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.For profile worker records in this download, this field will always be blank.
Commodity Code Description String Description of the commodity code.This field must be manually configured to be in the download file template.For profile worker records in this download, this field will always be blank.
Discount % Decimal Discount % from SOW Worker
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

ActiveWorkOrders

Retrieve all active work orders using the Active Work Order Download connector.

Columns
Name Type Description
Work Order ID String Work Order ID
Revision Number Int Work Order Revision Number
Start Date Date Start Date of Work Order
End Date Date End Date of Work Order
Status String Status of the Work Order
Last Modified Date Date Last Modified Date
Activation Date Date Date this Work Order was activated
Worker First Name String Worker's First Name
Worker Last Name String Worker's Last Name
Worker ID String SAP Fieldglass Worker ID
Vendor Name String Supplier Name
Vendor Code String SAP Fieldglass Supplier code
Job Posting Title String Job Posting Title
Site Name String Site Name
Site Code String Site Code
Site Address 1 String Site Address 1
Site Address 2 String Site Address 2
Site City String Site City
Site State/Province String Site State or Province
Site Country String Site Country ISO Code
Site Zip/Postal Code String Site ZIP Code or Postal code
Legal Entity String Legal Entity code associated to Work Order or SOW. Company configuration 'Enable Legal Entity' must be turned on for Contingent and/or Services: Work Orders and Workers.
Purchase Unit String Name of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Purchase Unit Code String Code of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
AP Code String Accounts Payable (AP) code associated to SOW. Company configuration 'AP Code Required' must be turned on for Services. Custom Lookup for AP Code Selection Type must exist.
Business Unit Name String Business Unit Name
Business Unit Code String Business Unit Code
Hours per Day Decimal Indicates Hours per Day
Hours per Week Decimal Indicates Hours per Week
Hours for Committed Spend Decimal Number of hours entered by the WO/WOR creator
Days for Committed Spend Decimal Number of days entered by the WO/WOR creator
Estimated Additional Spend Percentage Decimal Indicates any Additional Estimated Spend Percentage.
Total Estimated Hours Decimal Indicates total estimated hours for work order.
Estimated Expenses Percentage Decimal Indicates any estimated expenses percentage.
Adjustments applies to estimated spend Percentage Decimal Indicates any adjustments applied to spend percentage.
Remit to Address Code String Code as assigned to the RTA by Supplier.
Worker Pay Type Code String Indicates any worker pay types.Company configuration 'Use Worker Type' must be enabled.
Rate Category/UOM String Rate category for Bill Rate with unit of measure.
Bill Rate Decimal Worker's Bill Rate which is associated to the Rate Unit listed in the next field.
Currency String Currency designation
Average rate used to calculate spend Decimal Calculated average rate for work order
Billable per diem Decimal Amount that is billable per day
Maximum Expense Decimal Maximum amount for expenses
Committed spend Decimal Amount of committed spend
Cost Center Name String Cost Center Name in SAP Fieldglass. Primary Cost Center only.
Cost Center Code String Cost Center Code in SAP Fieldglass. Primary Cost Center only.
Cost Allocation percentage Decimal Percentage to allocate to cost center. If company configuration 'Cost Allocation Percentage decimal precision' is enabled, the Cost Allocation Percentage field shows zeros beyond the precision value set digit.
Cost Allocation amount Decimal Amount to be allocated to cost center.
Task Name String Name of task code
Task Code String Task code
Cumulative Committed Spend Decimal Amount accumulated for committed spend for work order(s).
Spend to Date Decimal Amount spent to date
Job Posting Owner String Name of JP owner
Job Posting Owner Employee ID String Employee ID of JP owner
Work Order Create Date Date Creation date of work order
Work Order Submit Date Date Submit date of work order
External ID String An external Work Order identifier used by the client for tracking purposes.
Purchase Order Number String PO Number
Auto Register String Indicates if auto register of workers is set.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Line Item Number Int Fetches Line Item Number of Cost Centers from Work Orders when Account Category Pick List is used.Not applicable for supplier downloads.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.
Commodity Code Description String Description of the commodity code.This field must be manually configured to be in the download file template.
Discount % Decimal Discount % of SOW Worker
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

Approvals

Query this table for approvals in SAPFieldglass.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • ModuleId supports the = operator.
  • WorkItemId supports the '=' operator. This must be used alongside ModuleId.

For example, the following queries are processed server-side:

SELECT * FROM Approvals WHERE ModuleId = '70'
SELECT * FROM Approvals WHERE ModuleId = '70' AND WorkItemId = '300'
Columns
Name Type Description
Id [KEY] String The ID of the approval.
ModuleId String The ID of the module this approval belongs to.
ModuleName String The name of the module this approval belongs to.
Ref String The reference of the approval.
Uom String The unit of measure of the approval.
Name String The name of the approval.
Amount Double The amount of the approval.
StartDate Date The start date of the approval.
EndDate Date The end date of the approval.
CreateDate Date The created date of the approval.
CreatorName String The name of the approval's creator.
UniqueName String The unique name of the approval's creator.
EmailId String The ID of the email of this approval.
RefVersion Integer The ref version of this approval.
ValidObject Boolean Indicates whether this approval is a valid object or not.
WorkerType String The type of the worker.
WorkerTypeLabel String The label of the worker type.
SourceLink String The source link of the approval.
Others String An aggregate of other properties for this approval.
Status String The status of this approval.
Details String The details of this approval.
ActivityID String The ID of the approval's activity.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
WorkItemId String The WorkItem ID you want to filter approvals with. This must be used in conjunction with ModuleId.

ApprovedExpenseSheets

Retrieve approved expense sheets using the Approved Expense Sheet Download connector.

Columns
Name Type Description
Buyer Name String Buyer Company Name
Buyer Code String Fieldglass Buyer Code
Supplier Name String Supplier Name
Supplier Code String Fieldglass Supplier Code
Account Name String Fieldglass Account Name
Account Code String Fieldglass Account Code
Remit To Address Code String Supplier's Remit To Address Code associated to the Worker.
Job Posting Owner String Display Name of the Job Posting Owner
Work Order ID String Fieldglass Work Order ID
Worker ID String Fieldglass Worker ID
Job Seeker ID String Fieldglass Job Seeker ID of the Worker.
Worker Last Name String Worker's Last Name
Worker First Name String Worker's First Name
Site Code String Fieldglass Site Code
Site Name String Fieldglass Site Name
Business Unit Code String Fieldglass Business Unit Code
Business Unit Name String Fieldglass Business Unit Name
Final Approver First Name String Fieldglass Final Approver First Name. Will be blank if no approvals were necessary.
Final Approver Last Name String Fieldglass Final Approver Last Name. Will be blank if no approvals were necessary.
Final Approver Employee ID String Fieldglass Final Approver Employee ID Will be blank if no approvals were necessary or if no Employee ID exists on the Approvers User Profile.
Final Approver Email String Fieldglass Approver Email Address. Will be blank if no approvals were necessary.
Expense Sheet ID String Fieldglass Expense Sheet ID
Expense Sheet Status String Expense Sheet Status
Expense Sheet Submit Date Date Date and time the expense sheet was submitted in SAP Fieldglass.
Expense Sheet Approved Date Date Date and time the expense sheet received final approval. If no approval was necessary, then date will equal the Submit date.
Expense Entry Date Date Date the expense item was incurred.
Cost Center Code String Fieldglass Cost Center Code
Cost Center Name String Fieldglass Cost Center Name
Expense Code String Fieldglass Expense Code representing the expense incurred.
Expense Name String Fieldglass Expense Code Name representing the expense incurred.
General Ledger Account Code String General Ledger Account Code associated to the Expense Code. This field is mutually exclusive with Segmented Object Detail.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|) and dash (-) Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields More than one string can appear for a cost center.
Merchant String Name of the merchant to whom the expense was paid.
Description String Description of the expense.
Units Int Units of the expense incurred. When the Expense Code is related to an Expense Type associated with Units, values will represent the unit of the Expense Type. If Expense Code is not unit based, 0 will be displayed.
Rate Decimal If an Expense Type is associated to the Expense Code, then the rate will represent the pre-configured Expense Type Rate, otherwise the value will be 0.
Billable Amount Decimal Billable amount of the expense.
Non-billable Amount Decimal The non-billable amount of the expense.
Currency String Three-character code for the currency associated with the expense.
Invoice ID String Invoice ID associated with the Expense Sheet. If auto invoicing is enabled for expense sheets, then Approved Expenses will always have a corresponding Invoice ID. If auto invoicing is not enabled, Invoice IDs will be populated only if the supplier and/or MSP have generated invoices from the approved expenses prior to the download occurring.
MSP % Int MSP's percentage for the expenses.
Revision String Expense Sheet Revision/ Sequence.Company configuration 'Allow Submission of Revised Expense Sheets' must be enabled.
Original Expense Sheet ID String Parent Expense Sheet ID.Company configuration 'Allow Submission of Revised Expense Sheets' must be enabled.
Adjustment Name String Expense Code Adjustment Name
Adjustment % Decimal Expense Code Adjustment percentage.
Expense Amount Decimal Adjustment value without taxes applied.
Expense Total Decimal Adjustment value with taxes applied.
Account Category String Identifies the type of Cost Center.

ApprovedTimeSheets

Retrieve all approved time sheets using the Approved Time Sheet Download connector.

Columns
Name Type Description
Time Sheet ID String Fieldglass Unique Identifier for the worker's time sheet.
Time Sheet Status String Status of the time sheet. For time sheets with status of 'Revoked', the 'Allow Revocation of Approved Time Sheets' company configuration must be enabled.
Time Sheet Start Date Date Start Date for the time sheet.
Time Sheet End Date Date End Date for the time sheet. May be one week after start, two weeks after start, or at month end.
Time Sheet Submit Date/Time Datetime Date and time stamp of the time sheet's most recent submission.
Time Sheet Approved Date Date Date and time stamp when the time sheet's final approval occurred. If no approvals occur, then this field will have the same value as the Time Sheet Submit Date/Time field.
Time Entry Date Date Calendar Day for which hours are being entered.
Buyer Name String Fieldglass Buyer Name to which the worker is related.
Buyer Code String Fieldglass Buyer Code to which the worker is related.
Supplier Name String Fieldglass Supplier Name that employs the worker.
Supplier Code String Fieldglass Supplier Code for the supplier that employs the worker.
Account Name String Fieldglass Account Name for large clients. If missing, identifies Supplier code that employs the worker.
Account Code String Fieldglass Account Code for large clients. If missing, identifies the supplier that employs the worker.
Remit To Address Code String Remit To Address Code chosen by supplier to be associated to the worker.
Job Posting Owner String Name of the SAP Fieldglass Job Posting Owner in 'First Last' format.
Work Order ID String Fieldglass Work Order ID related to the worker.
Worker ID String Fieldglass Worker ID that uniquely identifies the worker.
Job Seeker ID String Fieldglass Job Seeker ID which uniquely identified the worker as a Job Seeker prior to Work Order creation.
Worker Last Name String Worker's Last Name
Worker First Name String Worker's First Name
Site Code String Fieldglass Site Code associated to the worker.
Site Name String Name of the site which is associated to the worker.
Business Unit Code String Fieldglass Business Unit Code associated to the worker.
Business Unit Name String Name of business unit associated to the worker.
Final Approver First Name String First name of the last SAP Fieldglass user to approve the time sheet. Will be blank if no approvals were performed.
Final Approver Last Name String Last name of the last SAP Fieldglass user to approve the time sheet Will be blank if no approvals were performed.
Final Approver Employee ID String Employee ID from SAP Fieldglass User Profile of last user to approve the time sheet. Will be blank if approvals were not performed.
Final Approver Email String Email address from SAP Fieldglass User Profile of the last user to approve the time sheet. Will be blank if approvals were not performed.
Cost Center Code String SAP Fieldglass Cost Center Code the worker chose to allocate their hours against.
Cost Center Name String Name of the Cost Center the worker chose to allocate their hours against.
Task Code String SAP Fieldglass Task Code the worker chose to allocate their hours against.
Task Name String The Name of the Task the worker chose to allocate their time against.
General Ledger Account Code String The SAP Fieldglass General Ledger Account Code associated to the Task Code chosen. This field is mutually exclusive with Segmented Object Detail field.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|) and dash (-). Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. Note - more than one string can appear for a cost center.
Billable Per Diem Decimal Billable Per Diem amount as indicated on the worker's current confirmed work order.
Billable Hours Decimal Billable Hours the Worker entered on his or her time sheet for the Time Entry Date, Cost Center, and Task Provided. Populated if the Task Code chosen by the worker has the Billable Flag set to Yes. If left blank on time sheet, a '0' will be populated in this field.
Non-billable Hours Decimal Non-billable hours the worker entered on his or her time sheet for the Time Entry Date, Cost Center, and Task Provided. Populated if the Task Code chosen by the worker has the Billable Flag set to No. If left blank on time sheet, a '0' will be populated in this field.
Total Hours Decimal Sum of all Billable and Non-billable Hours entered for the current record.
time_entry_comments String Indicates comments for date, cost center, task code, and rate category code/unit of measure. See Configuration Considerations to enable.
Billable Amount Decimal Sum of billable charges based on the Billable Hours and Billable Per Diem entered for the current record.
Billable Amount after Discount Decimal Billable Amount of the time sheet date after applying the discount.
Currency String Currency code for the Billable Amount listed above.
Rate Category/UOM String Combination of the Rate Category chosen to allocate the hours booked by the worker and the Unit of Measure to which the Rate Category is associated.
Bill Rate Buyer Decimal The Bill Rate the buyer is to pay for the Rate Category per each UOM. The value is expressed in the currency provided in the Currency field explained above.
Bill Rate Supplier Decimal The Bill Rate the supplier is paid for the Rate Category per each UOM. The value is expressed in the currency provided in the Currency field explained above.
Pay Rate Decimal The amount the worker is paid for the Rate Category per each UOM. Value is expressed in the currency provided in the Currency field explained above. If the supplier does not enter a pay rate for the worker in SAP Fieldglass, then this field will be populated with a '0'.
SOW ID String Identifies the Statement Of Work for which the time sheet applies. Only applicable for SOW worker time sheets.
Account Category String Identifies the type of Cost Center.
Work Location Name String The location name of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.This field does not display unless this download is configured to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink.
Location Code String The location code of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.This field does not display unless this download is configured to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink.

Assignments

Retrieve all active assignments using the Assignment Download connector.

Columns
Name Type Description
Assignment ID String Unique identifier for the assignment.
External Ref String Unique external reference (identifier) for the assignment.
Type Name String The name of the assignment Type upon which this assignment is based.
Supplier Code String Supplier code.
Title String The title of the assignment.
Description String Description of assignment.
Currency String Valid three-character currency code associated with the Cost Center listed in the Cost Center Code field. Only one currency code can be given. Currency must be associated with the buyer prior to using in this upload.
Legal Entity String Legal Entity code associated to Assignment. Company configuration 'Enable Legal Entity' must be turned on for Contingent.
Business Unit Code String The business unit in which this Assignment belongs. Business unit codes must be defined in the SAP Fieldglass application, and the Assignment owner must have access to this business unit code.
Site Code String The code that identifies the site where the assignment is located. The Assignment owner must have access to this site in order to create the Assignment. Site codes must be defined in the SAP Fieldglass application.
Location Code String Code that identifies where the assignment is located. Location codes must be defined in the SAP Fieldglass application.
Start Date Date Date on which the Assignment begins.
End Date Date Date on which the Assignment ends.
Assignment Owner String Username of Assignment Owner.
Budget Decimal Budget for the assignment.
Spend to Date Decimal Spend to date = Assignment Budget - Budget approved in Service Receipt
Remaining Budget Decimal Remaining Budget = Assignment Budget - Spend to Date
Purchase Order Number String Purchase order number for the assignment.
Cost Center Code String Primary Cost Center Only For the 2020.11 release, since the new flag will not allow adding of Cost Center Codes on assignment, this field will be blank.
General Ledger Account Code String For the Primary Cost Center only Company configuration 'Require GLA Allocation on Job Postings and Statements of Work' must be enabled. For the 2020.11 release, since the new flag will not allow adding of CC Codes on assignment, this field will be blank. This field is mutually exclusive with the Segmented Object Detail field.
Segmented Object Detail String Segmented Object Detail. Segments will be separated by delimiter on the segmented object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if the 'Enable Segmented Object Detail' configuration is enabled. For the Primary Cost Center only. For the 2020.11 release, since the new flag will not allow adding of CC Codes on assignment, this will be blank. This field is mutually exclusive with the General Ledger Account Code field.
Job Code String Job code for assignment. Multiple rows will be downloaded for multiple Job Codes. For the 2020.11 release, since the new flag will not allow adding of Job Codes on assignment, this will be blank.
Rate Lookup Name String Associated Rate Lookup with a data set on the corresponding Assignment ID. The Data Set company configuration must be enabled to view this field.
PO Lines String Multiple rows will be downloaded for multiple PO Lines.This field must be manually added to the download file configuration.
[seg] User selected segment name String This field displays each of the user selectable segments (in separate columns) which are associated to the PO line. Each segment value associated to multiple cost centers per PO line appear in separate rows. The Data Set company configuration must be enabled to view this field. Valid values of the user selectable segments are picked up from the Assignment.
PO (Line n) Spend Decimal Spend associated with the PO line number of Spend Matrix.This field must be manually added to the download file configuration.
PO (Line n) Remaining Spend Decimal Remaining Spend = Line Item Spend - Spend to DateThis field must be manually added to the download file configuration.
PO (Line n) Spend to Date Decimal Spend to Date = PO line Spend - Line Spend approved in Service ReceiptThis field must be manually added to the download file configuration.
PO (Line n) Cost Center Code String Cost center associated with the PO line number .This field must be manually added to the download file configuration.
Allow Access to all Cost Centers String Indicates if assignment has access to all cost centers.
Allow Access to all Job Codes String Indicates if assignment has access to all job codes.
Allow any Resource to submit Spend against the Assignment String Indicates if any resource can submit spend against the assignment.

AuditTrails

Query this table for audit trails in SAPFieldglass.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following column and operator. The remaining filter criteria is executed client-side within the connector.

  • Status supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM AuditTrails WHERE Status = 'OK'
Columns
Name Type Description
Id [KEY] String The ID of the audit trail.
Category String The category of the audit trail.
Company String The company of the audit trail.
Details String The details of the audit trail.
Status String The status of the audit trail. The allowed values are OK, Error.
Type String The type of the audit trail.
User String The user of the audit trail.
StartTime Datetime The start time of the audit trail.
StopTime Datetime The stop time of the audit trail.
PassportActionType Integer The action type of the audit trail's passport.
PassportComponentType Integer The component type of the audit trail's passport.
PassportTransactionId String The transaction ID of the audit trail's passport.
Version String The version of the audit trail.
Activity String The activity of the audit trail.
CompanyAttribute String The company attribute of the audit trail.
DocumentStatus String The document status of the audit trail.
ClientMessage String The client message of the audit trail.
ClientReturnCode Integer The client return code of the audit trail.
CRC32Checksum String The CRC32 checksum of the audit trail.
DeliveryTime Integer The delivery time of the audit trail.
DeliveryStatus String The delivery status of the audit trail.
Duration Datetime The duration of the audit trail.
Message Boolean The message of the audit trail.
RecordsFailed String The number of the audit trail's failed records.
RecordsProcessed String The number of the audit trail's processed records.
ServerMessage String The server message of the audit trail.
ServerStatus String The server status of the audit trail.
UploadFile String The uploaded file of the audit trail.

BusinessUnits

Retrieve business units using the Business Unit Download connector.

Columns
Name Type Description
Code [KEY] String Code describing the Business Unit. Value must be unique.
Name String Name of the Business Unit.
Parent Business Unit String Code of the Business Unit directly above this Business Unit in the company Hierarchy.
General Ledger String General Ledger Code associated to the Business Unit.
Escalation Preference String Escalation Preference Name related to transactions that will be created for this Business Unit.
Resource Coordinator Required Flag String Determines whether a Resource Coordinator will be required for this Business Unit. If left blank, defaults to No.
Resource Coordinator Username String Required if the Resource Coordinator Required Flag = Yes. SAP Fieldglass Username of the Resource Coordinator to be assigned to this Business Unit. User will need the 'This User can act as Resource Coordinator/Distributor' flag set to Yes on his or her User Profile.
Distributor Required Flag String Determines whether a Distributor will be required for this Business Unit. If left blank, defaults to No.
Distributor Username String Required if the Distributor Required Flag = Yes. SAP Fieldglass Username of the Distributor to be assigned to this Business Unit. User will need the 'This User can act as Coordinator/Distributor' flag set to Yes on their User Profile.
Remit-To Address Required String If left blank, defaults to No.
Buyer Selects AP Code String Company configuration 'AP Code Required' must be enabled. The 'Remit-To-Address Required' field must be set to Yes in order to have this field's value be Yes. If left blank, this field defaults to No.
Legal Entity String Legal Entity Code for the site. Only applicable if company configuration is enabled for Legal Entity. If the Legal Entity Association is set to All, then in the download, this field will show ALL instead of actual Legal Entities.
Modification Type String A - Add

CATSTimeSheets

Retrieve all time sheets entered in SAP CATS (Cross-Application Time Sheet) that are now in Draft, Rejected, and/or Pending Approval status within a provided parameter using the CATS Time Sheet Download connector.

View Specific Information

The following pseudo-columns should be specified in the WHERE clause in order to query the view:

  • StartDate specifies the start date of time sheets.
  • EndDate specifies the end date of time sheets.

For example:

SELECT * FROM CATSTimeSheets WHERE StartDate = '2023/01/01' AND EndDate = '2023/04/01'
Columns
Name Type Description
Job_Seeker_ID String Unique identifier for the worker associated with the SAP CATS record.
TIMESHEET ID String The TIMESHEET ID associated to the SAP CATS record.
Worker_Id String The Worker_Id associated to the SAP CATS record.
Buyer_Ref String The Buyer_Ref associated to the SAP CATS record (if applicable).
Worker_Name String The Worker_Name associated to the SAP CATS record.
Entry_Date Date The Entry_Date value in the SAP CATS table.
Cost Center Code String Cost Center Code against which time is being recorded.
GL Account Code String General Ledger Account Code against which time is being recorded. Company configuration 'Require GLA Allocation on Job Postings and Statements of Work' must be enabled. Company configuration 'Enable Rate Schedule' must be enabled.
Task Code String Task Code against which time is being recorded.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. More than one string can appear for a cost center.
Shift Code String Shift Code against which time is being recorded. Company configuration 'Enable Rate Schedule' must be enabled.
Time_In String The Time_In value in the SAP CATS table.
Time_Out String The Time_Out value in the SAP CATS table.
Comments String The Comments value in the SAP CATS table.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
StartDate Date This parameter specifies the start date of time sheets in MM/DD/YYYY format.
EndDate Date This parameter specifies the end date of time sheets in MM/DD/YYYY format.

CostCenters

Retrieve cost centers using the Cost Center Download connector.

Columns
Name Type Description
Modification Type String A - Add If the cost center already exists, SAP Fieldglass will treat it as an Update.
Cost Center Code String Value that uniquely describes the cost center.
Cost Center Name String Value that uniquely describes the cost center in more recognizable terms than the Cost Center Code.
Cost Center Description String Description of the cost center.
Is this a Rebillable Cost Object? String Indicates whether suppliers will be able to see Cost Allocation information on the Job Posting or SOW Bid.
Is this a Project Cost Center String Indicates if cost center applies to a project. Company configuration 'Require Segmented Object Detail based allocation' must be disabled.
Project Cost Center Start Date Date Indicates project cost center start date. The 'Is this a Project Cost Center' field must be set to Yes on the Cost Center, else the field is ignored.
Project Cost Center End Date Date Indicates project cost center end date. The 'Is this a Project Cost Center' field must be set to Yes on the Cost Center, else the field is ignored.
Open to Associate String Indicates if workers can associate the project cost center to themselves without requiring the permission of the cost center owner. This flag is only relevant for Project Cost Centers. If the Buyer Company has the 'Require Segmented Object Detail based allocation' company config enabled, AND the Buyer code is configured in the SysEnv 'PROJECT_COST_CENTER_WITH_SOD', then this field will be suppressed.
Estimated Hours Usage Decimal Estimated Hours Usage for Project Cost Centers. The 'Is this a Project Cost Center' field must be set to Yes on the Cost Center, else the field is ignored.
Environment String Indicates to which system that cost center applies.
Owner String The SAP Fieldglass username of the cost center's owner. Field is required unless you set the header 'Suppress Owner Validation' to True.
Reason String Cost Center Closed Reason must be entered when deleting a cost center. If a user has his or her default language set to the default language of the company, the reason code can be in any language. If using the bulk download, a standard reason will be applied to all Deletes. Please contact your SAP Fieldglass representative to configure this reason.
Include All Task Flag String Determines whether all task codes will automatically be associated to the cost center. Yes: All task codes will be assigned to the cost center. No: No task codes will be assigned to the cost center when initially created by the connector. Blank: This field defaults to No.
Include All Expense Flag String Determines whether all expense codes will automatically be associated to the cost center. Yes: All expense codes will be assigned to the cost center. No: No expense codes will be assigned to the cost center when initially created by the connector. Blank: This field defaults to No.
Default Expense Codes String Valid expense code or codes.Multiple codes must be separated by a tilde (~).This field can only be used if 'Include All Expense Flag' field is set to Yes.
Legal Entity Association String Indicates if multiple legal entities apply to the cost center.
Legal Entity String Indicates a single legal entity.
Segmented Object Detail Code String For a Buyer company that wants to use Project Cost Center with SOD, the Buyer Company must have 'Require Segmented Object Detail based allocation' company config enabled AND the Buyer code must be configured in the SysEnv 'PROJECT_COST_CENTER_WITH_SOD'.Company configurations 'Apply to Cost Center for Contingent' or 'Apply to Cost Center for Services' are available to associate Segmented Object Detail Code to Cost Center.
Currency String Determines the currency for the cost center. Values may only consist of currencies already associated to the buyer. If multiple currencies are to be associated with the cost center, they may all be entered in this field, delimited by the tilde character (~). If left blank in Add mode, it will default to the default currency of the buyer. If left blank in Update mode, it retains the old value.
Default Task Codes String Task codes are expected. Multiple codes are separated by the tilde character (~). This field can only be used if 'Include All Task Flag' is set to Yes.
Legal Entities String Indicates multiple legal entities. Multiple legal entities are separated by the tilde character (~).

DistributionLists

Retrieve distribution lists using the Distribution List Download connector.

Columns
Name Type Description
Code String Distribution list code.
Name String Name of distribution list.
Supplier Code String Supplier code to be associated with the distribution list.
Associate all Business Units String If Yes, the new distribution list should be automatically associated with all active business units in the company. All new business units will be associated to the distribution list upon creation. If No is entered for a new distribution list, you must manually create business unit associations for the distribution list. If No was entered on a previously created distribution list, the current business units will remain associated with the distribution list. (You must manually remove the business units from association with the distribution list.)
Custom Lookup String Indicates custom lookup name selected for the distribution list. If no value is entered, then no change will be made.If [Blank] is entered, then the value will be blank.
Level Int Determine the number of levels that should be included in the distribution list. Job postings will be first sent to suppliers in Level 1, then to suppliers in Level 2, and so on. If all the suppliers in the distribution list should receive job postings at the same time, the distribution list will have only one level.
Usage String For each supplier you want to include in the distribution list, select the appropriate usage. Mandatory suppliers are automatically selected for distribution and cannot be removed from the list. Preferred suppliers are automatically selected for distribution, but can be manually deselected. Optional suppliers are not automatically selected for distribution, but can be manually selected. Disallowed suppliers cannot be added to this list. When a job posting is set to distribute automatically, at least one supplier must have a usage status of Mandatory or Preferred.

DraftRejectedTimeSheets

Retrieve all time sheets in draft/rejected approval status using the Draft Rejected Time Sheet Download connector.

View Specific Information

The following pseudo-columns should be specified in the WHERE clause in order to query the view:

  • StartDate specifies the start date of time sheets.
  • Company specifies the buyer company for which time sheets are retrieved.

For example:

SELECT * FROM DraftRejectedTimeSheets WHERE StartDate = '2023/01/01' AND Company = 'CDT'
Columns
Name Type Description
Job_Seeker_Id String Unique identifier for the worker.
Last_Name String Worker's last name.
First_Name String Worker's first name.
Date Date Time sheet week starting date.
Week_Start_Date Date This field is only necessary when using bi-weekly or 8 day time sheets. For 8 day time sheets, enter hours via the Date and Week Start Date columns similar to the existing bi-weekly requirements.
Cost_Center_Code String Cost Center Code for which time is to be adjusted.
Cost_Center_Name String Cost Center Name for which time is to be adjusted.
Task_Code String Task Code for which time is to be adjusted.
Task_Name String Task Name for which time is to be adjusted.
GL_Account_Code String Must be from the list of current active GL account codes and must have an association to the worker for which time is being booked. This column is applicable only if 'Require GLA Allocation on Job Postings and Statements of Work' plug-in is On. This field is mutually exclusive with Segmented Object Detail field.
GL_Account_Name String Name related to the GL Account Code entered above.
Segmented Object Detail String Segmented Object Detail. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' set. This field is mutually exclusive with GL Account fields.
Rate_Category_Code String Rate Category Code for which time is to be adjusted. Rate Category Code listed will determine which of the worker's rates to apply to the hours entered.
Rate_Category_Name String Rate Category Name for which the time is to be adjusted.
UOM String Unit of measure for this given Rate Category.
Sun_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Mon_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Tue_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Wed_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Thu_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Fri_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Sat_Hrs Decimal Difference, in hours, from original time sheet. The maximum negative value allowed will be equal to the original time sheet hours for that period. Enter 0 or null if no change.
Location Code String The location code of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.This field does not display unless this download is configured to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink.
Work Location Name String The location name of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.This field does not display unless this download is configured to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
StartDate Date This parameter specifies the start date of time sheets in MM/DD/YYYY format.
Company String This parameter specifies the buyer company for which time sheets are retrieved.

DraftTimeSheets

Retrieve all time sheets in Draft status using the Draft Time Sheet Download connector.

Columns
Name Type Description
Time Sheet ID String Fieldglass Time Sheet ID.
Worker Last Name String Worker's Last Name.
Worker First Name String Worker's First Name.
Supplier Name String Fieldglass Supplier Name associated with buyer.
Time Sheet Start Date Date Start Date of Time Sheet.
Time Sheet End Date Date End Date of Time Sheet.
Work Location Name String The location name of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.

Locations

Retrieve locations using the Location Download connector.

Columns
Name Type Description
Modification Type String Required for upload only.
Code String Code for the Work Location. Must be unique for each site.
Name String Name of work location.
Status String Status of location.
Site Code String Site code of the site associated with the work location.
Site Association Type String Indicates sites association to the location. Company config 'Allow Multiple Location' must be enabled.
Description String Optional text description of the work location.
Address 1 String Line 1 of the Location's address.
Address 2 String Line 2 of the Location's address.
City String City where the Location is located.
State/Province String State/Province where the Location is located.
Country/Region String Country/region Code for the country where the location is located.
Zip/Postal Code String Zip code/postal code of the site.

RateCategories

Retrieve rate categories using the Rate Category Download connector.

Columns
Name Type Description
Code String Code assigned to Rate Category. A bar 'I' should not be used in a rate category name as this may cause errors when using the code within a rate rule. It is suggested to use an underscore '_' if needed.
Name String Name given to Rate Category. The rate category name is displayed on the time sheets.
Description String Description of Rate Category.
Sequence Int Sequence of Rate Category. Sequence does not apply when rate is used on a rate schedule, as the sections of the schedule determine the order.
Rate Type String Valid Fieldglass Category Rate Type. *This can be different and specific to each buyer based on their configuration.

RateCodes

Retrieve rate codes using the Rate Code Download connector.

Columns
Name Type Description
RateCode String Unique SAP Fieldglass Rate Code.
Name String Name of Rate Code.
Description String Description of Rate Code.
RateCategory String Rate Category assigned to the Rate.
Currency String Currency assigned to the Rate.
Rate Unit String Unit of measure for the Rate.
Min Rate Decimal Minimum Rate.
Max Rate Decimal Maximum Rate.
Minimum Pay Rate Decimal Minimum pay Rate.
Maximum Pay Rate Decimal Maximum pay Rate.
Rate Type String Type of Rate.
Allow Supplier to edit Rate Factor String Applicable only for Rate Type of 'Factor'. If not Rate Type of 'Factor', this field will show blank.
Markup % Decimal Markup percentage for rates of type Markup. If another Rate type, value will be 0.
Factor Decimal Factor to apply to base rate for the Rate. If Rate is not a Factor, then value will be 0.
Base Rate Category String For Rates of type Factor, this is the Rate Code of the Rate to which the Factor will be applied to calculate this Rate. Example: In a common scenario where Over Time is paid at 1.5 times that of Straight Time; OT may have a Factor of 1.5, which is applied to its base Rate of ST.
Can be used as replacement rate String Indicates rate can be used as replacement for rate types Rate, Factor, and Rate - Calculated rate. Company configuration 'Allow Supplier To Specify Payment Currency' must be enabled. Required if Modification Type = A and rate type is Rate, Rate - Calculated or Factor. Rate Code is created only if Currency, Rate Category, UOM, Rate Type combination doesn't already exist.

RateComponentGroups

Retrieve rate component groups using the Rate Component Group Download connector.

Columns
Name Type Description
Code String Unique Code for the Rate Component Group.
Name String Name of the Rate Component Group.
Description String Optional Description of the Rate Component Group.
Use Admin Structure Flag String Rate Component Group structure is copied from admin when Work Order, Work Order Revision, Statement of Work, SOW Revision, or Add SOW Worker is created. This is independent of the flags on the rate components which affect the value of the components. Default is No.
Rate Component Code String Indicates Rate Component Codes associated with Rate Component Group.
Level Int Indicates sequence rate component code should be applied in group.
Non-Taxable String Indicate if rate component code is taxable or not. Default is No.
Component Limit Decimal Pay and bill rate should be calculated using rate component limit. Default is zero.
MSP Code String MSP Company code associated with rate component group.

RateComponents

Retrieve rate components using the Rate Component Download connector.

Columns
Name Type Description
Code String Code assigned to rate component.
Name String Name given to rate component.
Description String Description of rate component.
Type String Valid SAP Fieldglass Rate Component Type. Additional values can be added if 'Can Modify Flag' is set to 'Yes'.
Rate Component Unit String Valid SAP Fieldglass Component Unit Type.
Rate Component Unit Rate Decimal Value for Rate Component Unit.
Use Admin Value String Indicates if Rule to Use Admin Value is wanted. Default is No.
Can Modify Flag String Indicates if Rule to Edit Values is wanted. Default is No.
Supplier can Increase Margin String Indicates if supplier can increase margin for rate. Default is No.
Include in Level Subtotal String Indicates if rate component can be included in level subtotal. Default is Yes.
MSP Code String Indicates MSP code associated to buyer. Company configuration 'Does Buyer Have MSP?' must be enabled for this field to appear in file.

RateGrids

Retrieve rate grid codes using the Rate Grid Download connector.

Columns
Name Type Description
Rate Grid Code String Unique Code to be assigned to be the Rate Grid.
Name String Name of the Rate Grid.
Description String Optional description of the Rate Grid.
MSP Code String Indicates if specific MSP Supplier associated to rate grid.

RateGroups

Retrieve rate groups using the Rate Group Download connector.

Columns
Name Type Description
Rate Group Code String Unique Code for the Rate Group.
Name String Name of the Rate Group.
Description String Optional Description of the Rate Group.
Rate Type String This field reflects the appropriate Rate Group Type. Bill Rate and Pay Rate Based are only available as options if Rate Component functionality is enabled for the buyer within their company configuration. Enter 'Pay Rate' if you want Rate Type in the UI to be 'Pay Rate and Coefficient'.
MSP Code String Indicates MSP code associated with the rate group.Company configuration 'Does Buyer Have MSP?' must be enabled.

RateSchedules

Retrieve rate schedules using the Rate Schedule Download connector.

Columns
Name Type Description
Rate Schedule Code String Code identifying the rate schedule.
Rate Schedule Name String Name of rate schedule.
Service Type String Indicates service type for rate schedule.
Rate Section Name String Indicates the section of the rate schedule. The rate section name 'Base Section' must always be included. Other rate sections names can also be added by the buyer after 'Base Section'.
Include Rate on String The base rate must appear on the work order details; however, you can determine if any other rates need to appear (in additional sections).
Coefficient Code String Indicates overtime/coefficient code for rate schedule in case of coefficient type rate.
Coefficient Name String Indicates overtime/coefficient name for rate schedule in case of coefficient type rate.
Rate Code String Indicates Rate code for rate schedule.
Rate Name String Indicates rate name for rate schedule.
Associated Shift Schedules String Indicates shift schedules associated to rate code
Time Sheet Rule String Indicates rate rule or custom script associated to rate code.
Frequency String The Frequency determines when a time sheet entry can be made either by the worker or via the rate rule. If Daily is selected, the worker (or rate rule) will be able to make an entry on every day. If Weekly is selected, the worker (or rate rule) will be able to make an entry on the last day of the time sheet. If Monthly is selected, the worker (or rate rule) will be able to make an entry on the last day of the month.

RejectReasons

Query this table for reject reasons in SAPFieldglass.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following column and operator. The remaining filter criteria is executed client side within the connector.

  • ModuleId supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM RejectReasons WHERE ModuleId = '70'
Columns
Name Type Description
Id [KEY] String The ID of the reject reason.
ModuleId String The ID of the reject reason's module.
ModuleName String The name of the reject reason's module.
Description String The description of this reject reason.
RefVersion Integer The ref version of this reject reason.
ValidObject Boolean Indicates whether this approval is a valid object or not.
Status String The status of this reject reason.
Details String The details of this reject reason.

RequisitionLineItems

Retrieve all high-level requisition information using the Requisition Line Item Detail Download connector. This connector differs from the Requisition Detail Download in that it adds SOW characteristic details. Each payment characteristic is added as a separate line and its corresponding details is sourced from the SOW.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • Include supports the '=' operator. This parameter specifies if work order or SOW details will be retrieved. Available values are: Work Order, SOW, and Both. By default, both types are retrieved.

For example, the following queries are processed server-side:

SELECT * FROM RequisitionLineItems WHERE Include = 'Work Order'
SELECT * FROM RequisitionLineItems WHERE Include = 'SOW'
Columns
Name Type Description
Object ID String SAP Fieldglass Work Order or SOW object reference.
Revision Int Revision number corresponding to the object reference.
Description String Job Posting Title or SOW Name
Status String SAP Fieldglass SOW/Work Order Status
External ID String An external identifier used by the client for tracking purposes.
Buyer Ref String Buyer reference
Master SOW Ref String SAP Fieldglass Master SOW ID.
Master SOW External Ref String An external identifier for Master SOW used by the client for tracking purposes.
Master SOW String Indicates if Object ID refers to a Master SOW.
Master SOW PO Number String Optional purchase order number from the Master SOW.
Object Owner Username String Username of object owner, latest revision.
Object Owner Employee ID String Employee ID of Work Order/SOW owner, latest revision.
Object Creator Username String Username of object creator, latest revision
Object Creator Employee ID String Employee ID of Work Order/SOW creator, latest revision.
Object Create Date Date The date the SOW/Work Order was created.
Object Start Date Date Start date of the Work Order/SOW. Indicates the latest revision start date.
Object End Date Date End date of the Work Order/SOW. Indicates the latest revision end date.
Actual End Date Date When the SOW is closed this field indicates when the SOW needs to be closed
Closed Reason String Closed reason for SOW/Work Order
Supplier Code String Supplier Code for the SOW/Work Order
Vendor ID String The Vendor ID value associated to the Supplier
Remit to Address Code String Remit to address (if any) specified by the Supplier on the Work Order/SOW.
Site Code String SAP Fieldglass Site object for SOW/Work Order, latest revision.
Location Code String SAP Fieldglass Location object for SOW/Work Order, latest revision.
Business Unit Code String SAP Fieldglass Business Unit Code.
Primary Cost Center Code String Primary Cost Center Code identified on the SOW.
Primary Cost Center Name String Primary Cost Center Name identified on the SOW.
Account Category String Identifies the type of Cost Center: Internal Order, Cost Center, WBS Element.
Cost Center Allocation Amount Decimal Indicates amount to be allocated to cost center if not using allocation percentages.Applicable for SOW Work Orders only.
Allocation % Decimal Allocation % is the percent value for whichever object (Cost Center % or GLA % or SOD %) is driving the cost allocation. If company configuration 'Cost Allocation Percentage decimal precision' is enabled, this field shows zeros beyond the precision value set digit.Applicable for SOW Work Orders only.
Primary Cost Center Owner Employee ID String Employee ID of the primary cost center owner.
General Ledger Account String Pass the GL Account for Cost Center associated. This field only appears if company configuration 'Require GLA Allocation on Job Postings and Statements of Work' is enabled.
Segment Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration set. More than one string can appear for a cost center.
Legal Entity Code String Legal Entity Code related to the SOW or the Work Order, latest revision.Required if 'Enable Legal Entity' configuration set.
Legal Entity Name String Legal Entity Name related to the SOW or the Work Order, latest revision
PO Number String Populated with the value of the SAP Fieldglass PO Number field where populated.
Committed Spend Decimal Amount of committed spend/revised committed spend excluding tax or adjustment for Work Order or the Maximum Budget Amount (without Site Tax or any Adjustments) from the SOW.
Cumulative Committed Spend Decimal Value of Cumulative Committed Spend from the Work Order / Work Order Revision or the Presented Budget Amount (without Site Tax or any Adjustments) from the SOW.
Spend to Date Decimal Cumulative spend across all revisions for Work Order or Spend to Date from the SOW.
Currency String ISO Currency code from SOW/Work Order.
Job Seeker/Worker Name String SAP Fieldglass Job Seeker Name object for the Work Order latest revision and Worker Name object for SOW with SOW workers on latest SOW revision.
Job Seeker ID String Job Seeker ID
Line Item ID String SAP Fieldglass SOW Line item ID.
External Line Item ID String An external identifier used by the client for tracking purposes.
Line Item Description String Description of SOW line item
Line Item Name String Name of the SOW Line Item.
Line Item Type String Valid SOW Line Item Type. All Fee Definitions, Schedules in Created status and Management Events in Pending status.
Sequence Number Int The sequence number assigned automatically by the Fieldglass application.
Buyer Defined Sequence Number Int The sequence number assigned manually by the buyer.
Units Decimal The number of units being billed for schedules or fees.
Maximum Units Int Maximum units allowed for schedules or fee characteristics.
Unit of Measure String The unit of measure code for the Units listed.
Unit of Measure Name String The unit of measure name for the Units listed
Line Item Rate Decimal Line Item Rate
Requested Amount Decimal Requested Amount for work order/SOW
Charged Amount Decimal Amount for the individual charge detail of the SOW Line Item.
Total Line Item Amount Decimal Total Line Item Amount.
Due Date Date The due date noted for the SOW Line Item. This field is only applicable for Schedules.
Library Definition Code String The Code of the library definition used to create the Line Item. Only applicable to SOW Characteristics. For Fee Responses, the library is pulled from the Fee Definition.
Library Definition Name String The Name of the library definition used to create the Line Item Only applicable to SOW Characteristics. For Fee Responses, the library is pulled from the Fee Definition.
Line Item Cost Center Code String Cost center code for line item
Line Item Cost Center Name String Cost center name for line item
Line Item Cost Center Allocation Amount Decimal Amount allocated to line item cost center
Line Item General Ledger Account String The GL Account for associated Cost Center. This field only appears if company configuration 'Require GLA Allocation on Job Postings and Statements of Work' is enabled.
Line Item Segment Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration set. Note - more than one string can appear for a cost center.
Line Item Allocation % Decimal Allocation % is the percent value for whichever object (Cost Center % or GLA % or SOD %) is driving the cost allocation for the SOW Line Item.
Commodity Code String Description of the commodity code from the Contingent Work Order, Statement of Work, Event, Fee, or Schedule. This field must be manually configured to be in the download file template.
Commodity Description String Description of the commodity code from the Contingent Work Order, Statement of Work, Event, Fee, or Schedule. This field must be manually configured to be in the download file template.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Include String This parameter specifies if work order or SOW details will be retrieved. Available values are Work Order, SOW, and Both. Defaults to Both.

Requisitions

Retrieve all high-level requisition information using the Requisition Detail Download connector.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • Include supports the '=' operator. This parameter specifies if work order or SOW details will be retrieved. Available values are: Work Order, SOW, and Both. By default, both types are retrieved.

For example, the following queries are processed server-side:

SELECT * FROM Requisitions WHERE Include = 'Work Order'
SELECT * FROM Requisitions WHERE Include = 'SOW'
Columns
Name Type Description
Object ID [KEY] String SAP Fieldglass Work Order or SOW object reference.
Revision Int Revision number corresponding to the object reference.
Work Order Cost Center Code String Pass all Cost Centers on a new line, if multiples exist.
Primary Worker Cost Center String Pass the Primary Cost Center of the Worker.
Cost Allocation Amount Decimal Amount to be allocated to each cost center.
General Ledger Account String Pass the GL Account for Cost Center associated. This field only appears if company configuration 'Require GLA Allocation on Job Postings and Statements of Work' is enabled. This field is mutually exclusive with Segmented Object Detail field.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. Note - more than one string can appear for a cost center.
Allocation % Decimal Allocation % is the percent value for whichever object (Cost Center % or GLA %) is driving the cost allocation. If company configuration 'Cost Allocation Percentage decimal precision' is enabled, this field shows zeros beyond the precision value set digit.
Object Create Date Date The date the SOW/Work Order was created.
Object Start Date Date Start date of the Work Order/SOW. Indicates the latest revision start date.
Object End Date Date Work Order/SOW end date. Indicates the latest revision end date.
Object Owner Employee ID String Employee ID of Work Order/SOW owner, latest revision.
Object Owner Username String Username of object owner, latest revision.
Object Creator Employee ID String Employee ID of Work Order/SOW creator, latest revision.
Object Creator Username String Username of object creator, latest revision.
Description String Job Posting Title or SOW Name.
Job Seeker/Worker Name String SAP Fieldglass Job Seeker Name object for the Work Order latest revision and Worker Name object for SOW with SOW workers latest SOW revision.
Job Seeker ID String Fieldglass Job Seeker ID for the Work Order latest revision. Blank for SOW workers.
Legal Entity String Legal Entity code associated to work order. Company configuration Enable Legal Entity must be turned on for Contingent.
Purchase Unit String Name of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Purchase Unit Code String Code of Purchase Unit Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Site Code String SAP Fieldglass Site object for SOW/Work Order, latest revision.
Location Code String SAP Fieldglass Location object for SOW/Work Order, latest revision.
Business Unit Code String SAP Fieldglass Business Unit Code.
Remit to Address Code String Remit to address (if any) specified by the Supplier on the Work Order/SOW.
Currency String ISO Currency code from SOW/Work Order.
Committed spend Decimal Amount of committed spend/revised committed spend excluding tax or adjustment for Work Order or the Maximum Budget Amount (without Site Tax or any Adjustments) from the SOW.
Cumulative Committed Spend Decimal Called Cumulative Committed Spend. Value of Cumulative Committed Spend from the Work Order / Work Order Revision or the Presented Budget Amount (without Site Tax or any Adjustments) from the SOW.
Spend to Date Decimal Cumulative spend across all revisions for Work Order or Spend to Date from the SOW.
PO Number String Populated with the value of the SAP Fieldglass PO Number field where populated.
External ID String An external identifier used by the client for tracking purposes. External SOW ID
Unit Of Measure String Rate unit of measure.
Calculated Cumulative Amount Decimal Cumulative cost center amounts.
Primary Cost Center Owner Employee ID String Employee ID of the primary cost center owner.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.
Commodity Code Description String Description of the commodity code.This field must be manually configured to be in the download file template.
Account Category String Identifies the type of Cost Center.
Work Location Name String The location name.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Include String This parameter specifies if work order or SOW details will be retrieved. Available values are Work Order, SOW, and Both. Defaults to Both.

Resources

Retrieve resources using the Resource Download connector.

Columns
Name Type Description
Resource ID String 14-character alphanumeric SAP Fieldglass Resource ID.
Security ID String Security ID assigned to resource. This column will only appear in the file if the Security ID field functionality is activated in SAP Fieldglass for the buyer.
Status String Status of the resource.
First Name String First name of the Worker as defined in SAP Fieldglass.
Last Name String Last name of the Worker as defined in SAP Fieldglass.
Worker Email String Worker's e-mail address.
Buyer Code String Buyer company code.
Supplier Code String Supplier company code.
Buyer Reference Tag String Buyer-designated reference.Only for buyer downloads.
Engagement Manager String Engagement manager's username.
Available Start Date Date Available start date of the resource.
Available End Date Date Available end date of the resource.
Equipment String Indicates if the resource is equipment.
Auto register String Indicates if the resource is auto registered.
Associated Rate Lookup String The Associated Rate Lookup on the corresponding Resource ID. For Resources of Assignment Category, this field contains the rate lookup information. For Resources of Statement of Work Category, this field is blank.
[seg] User selected segment name String Each user selected segment displays as separate columns with a prefix of [seg] next to it and displays the values selected on the Resource ID. The Data Set company configuration must be enabled to view this field. Valid values of the user selectable segments are picked up from the corresponding Resource.
Time Template String Time template associated to the resource.For Resources of Assignment Category, this field contains the time template name.For Resources of Statement of Work Category, this field is blank.
Work Schedule String Work Schedule associated to the resource.For Resources of Assignment Category, this field contains the work schedule information.For Resources of Statement of Work Category, this field is blank.
Work Schedule Effective Date Date Date on which the work schedule for the resource is effective.For Resources of Assignment Category, this field contains the work schedule effective date.For Resources of Statement of Work Category, this field is blank.
Site String Site of the resource.Site codes are defined in the SAP Fieldglass application.
Job Codes String Job codes of the resource.One job code per row will be downloaded.Job codes are defined in the SAP Fieldglass application.
Legal Entity Code String Legal entity code of resource. Users must configure their output to include this field. For Resources of Assignment Category, this field contains the legal entity code. For Resources of Statement of Work Category, this field is blank.
Business Unit Code String Business unit code of resource. Users must configure their output to include this field. For Resources of Assignment Category, this field contains the business unit code. For Resources of Statement of Work Category, this field is blank.
Site Code String Site code of resource. Users must configure their output to include this field. For Resources of Assignment Category, this field contains the site code. For Resources of Statement of Work Category, this field is blank.
Location Code String Location code of resource. Users must configure their output to include this field. For Resources of Assignment Category, this field contains the location code. For Resources of Statement of Work Category, this field is blank.
Allow Rates on the Resource? String Indicates whether rates are allowed on the resouce. The Category field on the resource must be set to 'Assignment'.
Rate Category/UOM String Rate category code.The Category field on the resource must be set to 'Assignment'.
Pay Rate Decimal The rate value for the Rate Category.The Category field on the resource must be set to 'Assignment'.
Bill Rate Decimal The Rate value for the Rate Category.The Category field on the resource must be set to 'Assignment'.
Markup Percentage Decimal This field reflects the numerical value of the markup percentage for the rate. All values entered are in percentage. For example, 1.25% should be entered as 1.25, not .0125.

SecurityWorkers

Retrieve all data on workers with Security IDs using the Worker Security Download connector.

Columns
Name Type Description
Security ID String Unique identifier for a candidate when the supplier submits the candidate against a work order (WO).
Job Seeker ID String SAP Fieldglass Job Seeker ID Tied to the work order (A worker can have many Job Seeker IDs.).
Worker ID String SAP Fieldglass Worker ID. Populated when the worker registers. Tied to the work order (A worker can have many worker IDs.).
Person ID String Unique identifier for the worker as a person. Populated when the worker registers.
Status String Status of the worker: Active or Closed
First Name String First name of the worker as defined in SAP Fieldglass.
Last Name String Last name of the worker as defined in SAP Fieldglass.
Worker Email String Worker's e-mail address.
Job Posting Title String Job posting title or SOW name for SOW workers.
Work Order ID String Work Order ID.
Work Order/Work Order Revision Owner String Work order owner's name.
Work Order/Work Order Revision Owner Employee ID String Work order owner's employee ID.
Business Unit Code String Business unit code.
Business Unit Name String Business Unit Name.
Vendor Number String SAP Fieldglass Supplier Code for buyer.
Vendor Name String Supplier name.
Buyer Code String Buyer company code.
Remit To Address Code String Code as assigned to the RTA by supplier.
Cost Center Name String Cost Center Name in SAP Fieldglass.
Cost Center Code String Cost Center Code in SAP Fieldglass.
Task Name String Task Name in SAP Fieldglass.
Task Code String Task Code in SAP Fieldglass.
Billable Per Diem Decimal Per diem amount that is billable (if applicable).
Start Date Date Work order start date.
End Date Date Work order end date.
Currency String Currency designation.
Site Code String Site code.
Site Name String Site name.
Rate Category / UOM String Worker's Rate Category/UOM for which the corresponding rate will be displayed. More than one Rate Category/UOM may exist for a single worker. If this is the case, a new line will appear for each associated Rate Category/UOM in this file. Rates are pulled from current work order.
Bill Rate Decimal Worker's Bill Rate which is associated to the Rate Category/UOM listed in the previous field.
Pay Rate Decimal Worker's Pay Rate which is associated to the Rate Category/UOM listed in the previous field. If the supplier did not enter a Pay Rate, 0.00 will be displayed.
Vendor ID String Native field for the buyer company's external ID.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time Zone of worker.If not entered, it is defaulted to the default setting of buyer's time zone.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

SecurityWorkersSingleLine

Retrieve all data on workers with Security IDs using the Worker Security Single Line Download connector.

Columns
Name Type Description
Security ID String Unique identifier for a candidate when the supplier submits the candidate against a work order (WO).
Job Seeker ID String SAP Fieldglass Job Seeker ID Tied to the work order. (A worker can have many Job Seeker IDs.)
Worker ID String SAP Fieldglass Worker ID. Populated when the worker registers. Tied to the work order. (A worker can have many worker IDs.)
Person ID String Unique identifier for the worker as a person. Populated when the worker registers.
Status String Status of the worker: Active or Closed
First Name String First name of the worker as defined in SAP Fieldglass.
Last Name String Last name of the worker as defined in SAP Fieldglass.
Worker Email String Worker's e-mail address.
Job Posting Title String Job posting title or SOW name for SOW workers.
Work Order ID String Work Order ID.
Work Order/Work Order Revision Owner String Work order owner's name.
Work Order/Work Order Revision Owner Employee ID String Work order owner's employee ID.
Business Unit Code String Business unit code.
Business Unit Name String Business Unit Name.
Vendor Number String SAP Fieldglass Supplier Code for buyer.
Vendor Name String Supplier name.
Buyer Code String Buyer company code.
Remit To Address Code String Code as assigned to the RTA by supplier.
Cost Center Name String Primary Cost Center Name in SAP Fieldglass.
Cost Center Code String Primary Cost Center Code in SAP Fieldglass.
Billable Per Diem Decimal Per diem amount that is billable (if applicable).
Start Date Date Work order start date.
End Date Date Work order end date.
Currency String Currency designation.
Site Code String Site code.
Site Name String Site name.
Bill Rate Decimal Worker's Bill Rate which is associated to the Rate Category/UOM listed in the previous field.
Pay Rate Decimal Worker's Pay Rate which is associated to the Rate Category/UOM. If the supplier did not enter a Pay Rate, 0.00 will be displayed.
Vendor ID String Native field for the buyer company's external ID.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone of worker.If not entered, it is defaulted to the default setting of buyer's time zone.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

SecurityWorkersWithTransactionType

Retrieve worker records based on transaction type filtering logic using the Worker Security with Transaction Type Download connector.

Columns
Name Type Description
Security ID String Unique identifier for a candidate when the supplier submits the candidate against a WO.
Job Seeker ID String Internal SAP Fieldglass ID for Job Seeker. Tied to the work order. A worker can have many Job Seeker IDs.
Worker ID String Tied to the work order. A worker can have many Worker IDs. Will be blank if the record is downloaded from the work order Populated when the worker registers.
Person ID String Unique identifier for the worker as a person Will be blank if the record is downloaded from the work order Populated when the worker registers.
Status String The status is set based on the following: pending: wo created pending: wo accepted closed: wo rejected closed: wo declined activated: wo activated active: worker confirmed active: worker revised active: wo revised closed: wo closed closed: worker closed Rule: Filter out Pending and Activated statuses
First Name String First name
Last Name String Last name
Worker Email String Workers e-mail address
Job Posting Title String Job posting Title
Work Order ID String Work Order ID
Work Order/Work Order Revision Owner String Work Order owner name
Work Order/Work Order Revision Owner Employee ID String Work Order Employee ID
Business Unit Code String Business unit code
Business Unit Name String Business unit name
Vendor Number String Supplier code
Vendor Name String Supplier name
Buyer Code String Buyer Company Code
Remit To Address Code String Code as assigned to the RTA by supplier
Cost Center Name String Cost Center Name
Cost Center Code String Cost Center Code
Task_Name String Task Name
Task_Code String Task Code
Billable Per Diem Decimal Billable Per Diem
Start Date Date Work order start date. Valid format is: yyyy-mm-dd
End Date Date Work order end date. Valid format is: yyyy-mm-dd
Currency String Currency designation (ex. USD)
Site Code String Site code
Site Name String Site name
Rate Category/ UOM String Rate category and rate unit of measure
Bill Rate Decimal Bill rate for the Rate Category
Pay Rate Decimal Pay Rate for the Rate Category (Populated for buyer downloads when buyer has access to supplier pay rate data, otherwise this field will be defaulted to 0)
Worker Supervisor String Username of worker's supervisor
Closed Reason String Reason for closing worker
Buyer Reference String Native Buyer Reference on the Worker. Contains External Person ID.
Transaction Type String Send based on when the user took the action in SAP Fieldglass vs when it is effective. So, if a future close action is taken today we would send a TER trans type with the future end date. The following are possible values: HIR — Indicating brand new contingent worker. Rule: Status is Active and Buyer Reference is Blank UPD—Indicating a change to the existing contract of a contingent worker Rule: Status is Active and Buyer Reference is not Blank and is not a rehire. RHI – Indicating this is an existing worker on a new assignment Rule: Status is Active and Buyer Reference is not Blank and there is a previous Work Order in TRM status, and no other work orders are active during the same window. TER — Indicating a termination Rule: Send when the Action to Close is taken: User Closed in a future date Auto-Close after end date Please reference Transaction Type Process within this document for further details.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone of worker. If not entered, it is defaulted to the default setting of the buyer's time zone.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Original Revision Start Date Date Original Revision Start Date

SecurityWorkersWithTransactionTypeSingleLine

Retrieve worker records based on transaction type filtering logic using the Worker Security with Transaction Type Single Line Download connector.

Columns
Name Type Description
Security ID String Unique identifier for a candidate when the supplier submits the candidate against a WO.
Job Seeker ID String Internal SAP Fieldglass ID for Job Seeker. Tied to the work order. A worker can have many Job Seeker IDs.
Worker ID String Tied to the work order. A worker can have many Worker IDs. Will be blank if the record is downloaded from the work order Populated when the worker registers.
Person ID String Unique identifier for the worker as a person Will be blank if the record is downloaded from the work order Populated when the worker registers.
Status String The status is set based on the following: pending: wo created pending: wo accepted closed: wo rejected closed: wo declined activated: wo activated active: worker confirmed active: worker revised active: wo revised closed: wo closed closed: worker closed Rule: Filter out Pending and Activated statuses
First Name String First name
Last Name String Last name
Worker Email String Workers e-mail address
Job Posting Title String Job Posting title for worker
Work Order ID String Work Order ID
Work Order/Work Order Revision Owner String Work Order owner name
Work Order/Work Order Revision Owner Employee ID String Work Order Employee ID
Business Unit Code String Business unit code
Business Unit Name String Business unit name
Vendor Number String Supplier code
Vendor Name String Supplier name
Buyer Code String Buyer Company Code
Remit To Address Code String Code as assigned to the RTA by supplier
Primary Cost Center Name String Primary Cost Center Name
Primary Cost Center Code String Primary Cost Center Code
Billable Per Diem Decimal Billable Per Diem
Start Date Date Format: mm/dd/yyyy
End Date Date Format: mm/dd/yyyy
Currency String Currency designation (USD)
Site Code String Site code of worker
Site Name String Site name
Buyer Reference String Unique ID for buyer side
Transaction Type String Indicates if hire, rehire, update, or termination
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Time Zone String Time zone of worker.If not entered, it is defaulted to the default setting of buyer's time zone.
Work Location Name String Work Location Name
Location Code String Valid SAP Fieldglass location code
Primary Location String Primary Location
Primary Location Code String Valid SAP Fieldglass location code
Original Revision Start Date Date Original Revision Start Date

ServiceEntrySheets

Retrieve service entry sheets using the Service Entry Sheet Download connector.

Columns
Name Type Description
Company Code String Buyer Code.
Company Name String Buyer Name.
Line Item ID String Line Item ID, including Event ID, Schedule ID, Fee ID, Timesheet ID, or Expense Sheet ID.
External Line Item ID String External ID for the line item.
Line Item Name String Name of the SOW Line Item. Not applicable to Time Sheets or Expense Sheets. Pull blank value for Time sheet or expenses sheet.
Line Item Type String The type of document: ES = Expense Sheet PE = Event PS = Schedule TS = Timesheet TU = Fee
Revision? String Indicates whether the SOW Line Item is a revision to a different Line Item.
Original Line Item ID String SOW Line Items that are revised will show their Original SOW Line Item ID in this field, to indicate from which SOW Line Item the revision was created
Original External Line Item ID String SOW Line Items that are revised will show their previous Line Item's External ID.
Supplier Code String Supplier Code for Buyer.
Supplier Name String Supplier Name.
Vendor ID String The Vendor ID value associated to the Supplier.
Service Date Date The date most typically associated with completion of work for the Line Item. Varies by Line Item module.
Submit Date Date The date when the line item was submitted.
Project ID String SOW Statement of Work Reference or Contingent Work Order Reference.
PO Number String Optional purchase order number from the SOW or Work Order related to the invoice.
Master SOW ID String Statement of Work ID of the Master SOW.Defaults to blank for contingent work order.
Master SOW PO Number String Optional purchase order number from the Master SOW related to the invoice.Defaults to blank for contingent work order.
Legal Entity Code String Legal Entity Code related to the Line Item.
Legal Entity Name String Legal Entity Name related to the Line Item.
Site Code String Site Code related to the Line Item.
Site Name String Site Name related to the Line Item.
Capitalized? String Indicates if line item is to be capitalized. This value can be edited at the characteristic level.
Business Unit Code String Business Unit Code related to the Line Item.
Business Unit Name String Business Unit Name related to the Line Item.
Cost Center Code String Cost Center Code related to the Line Item.
Cost Center Name String Cost Center Name related to the Line Item.
Cost Center Allocation % Decimal Allocation percentage associated to the Line Item's cost center.If company configuration 'Cost Allocation Percentage decimal precision' is enabled, this field shows zeros beyond the precision value set digit.
Cost Center Allocation Amount Decimal Allocation amount associated to the Line Item's cost center.
Currency String Currency of the line item.
Charge Code String Charge code for line item. Only applicable to Time Sheets and Expense Sheets and for the Schedule, Event and Fee definition. Schedule Event and Fee definition pull blank value.
General Ledger Account Code String General Ledger Account Code related to the Line Item.Mutually exclusive with Segmented Object Detail.
Hours Decimal Line Item Hours, if applicable.
Rate Category Code String Line Item Rate Category Code. Only applicable to Time Sheets. For Expense sheet, Schedule, Event, Fee definition, pull blank value.
Rate Decimal Line item rate.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration is set. More than one string can appear for a cost center. This field is mutually exclusive with GL Account fields.
Units Decimal The number of units being billed. Not applicable to Events.
Unit of Measure Code String The unit of measure code for the Units listed. Not applicable to Expense Sheets or Events.
Unit of Measure Name String The unit of measure name for the Units listed. Not applicable to Expense Sheets or Events.
Sequence Number Int The sequence number assigned automatically by the Fieldglass application.
Buyer Defined Sequence Number Int The sequence number assigned manually by the buyer.
Library Definition Code String The Code of the library definition used to create the Line Item. Only applicable to SOW Characteristics. For Fee Responses, the library is pulled from the Fee Definition. Defaults to blank for timesheet and expense sheet.
Library Definition Name String The name of the SOW library definition used to create the Line Item. Only applicable to SOW Characteristics. For Fee Responses, the library is pulled from the Fee Definition. This field is blank when the characteristic is not copied from the definition library. Defaults to blank for timesheet and expense sheet.
Charged Amount Decimal Amount for the individual charge detail of the SOW Line Item.
Total Line Item Amount Decimal Total Line Item Amount.

ServiceReceipts

Retrieve service receipts that are in Pending Approval, Approval Paused, Rejected and/or Approved status using the Service Receipt Download connector.

Columns
Name Type Description
Service Receipt ID String Service receipt reference ID.
Create Date Date Date the time journal was created.
Buyer String Name of buyer associated to the time journal.
Buyer Code String Buyer code associated to the time journal.
Time Journal Amount Decimal Service receipt time journal amount.
Time Journal Cost Center String Service receipt time journal cost center code.
Time Journal Hours Decimal Service receipt time journal hours.
Service Receipt Amount Decimal Total service receipt amount inclusive of all time journals This value repeats for each line of the service receipt that appears in this download.
Supplier String Name of supplier associated to the time journal.
Supplier Code String Supplier code associated to the time journal.
Assignment ID String Reference ID for the associated assignment.
Assignment Type String Assignment type of the associated assignment.
Assignment String Name of the associated assignment.
Site String Site name.
Business Unit String Business unit associated with the assignment.
Status String Status of the time journal.
PO Number String Assignment purchase order number.
Line Item Number String Assignment line item number.
[s]Time Journal Segment Name String Any user selectable segment associated with Time Journal. The Segment Name should contain an [s] before the name. The Data Set company configuration must be enabled to view this field. Valid values of the user selectable segments are picked up from the Time Journal.
Job Code String Job code on the time journal
Currency String Currency associated with the time journal
External Reference ID String External reference ID.
Time Journal Date Date Date of the time journal.

Sites

Retrieve site codes using the Site Download connector.

Columns
Name Type Description
Code String Code for the site. The code must be unique for each site.
Name String Name of the site.
Currency String Currency code for currency related to the site. In the event that multiple currencies are to be associated to a site, they may all be entered here, delimited by a tilde '~'. To associate to all enabled SAP Fieldglass currencies, you may enter [ALL].
Parent Site String Site code of parent site.
Selectable Site? String Sets the 'Can Select' flag to true or false. Yes = True No = False
Corporate Calendar String Name of the corporate calendar used by the site.
Description String Optional text description of the site.
Address 1 String Line 1 of the site's address.
Address 2 String Line 2 of the site's address.
City String City where the site is located.
State/Province String State/Province where the site is located.
Allow Candidate Anonymity? String Yes - Candidate Anonymity Flag is set to True. No/Blank - Candidate Anonymity Flag is set to False.
Legal Entity Code String Legal entities allow buyers to establish relationships between various data entry elements (such as business units, cost centers, task codes, and users) in the SAP Fieldglass application. The Legal Entity field appears only when the Legal Entity has been enabled in the company configuration. If the Legal Entity Association is set to All, this field will show 'ALL' instead of actual Legal Entities in the download.
Country String ISO Country Code for the country where the site is located.
ZIP/Postal Code String Zip Code/Postal Code of the site. Required if Country=USA.
Market Type String The market type to which this site should be associated. This field is displayed only if the Rate Guidance company configuration option is enabled. When creating or editing a site, the market type is used to manually rank sites into groups with similar Cost of Living Indexes (COLI). If the market type is left blank, the system will use the site's ZIP code to determine the site's COLI by mapping the ZIP code to the COLI table. Sites with ZIP codes found in the COLI table are mapped to one of four market ranges: A, B, C, or D. Some ZIP codes within the U.S., and all areas outside the U.S., are not included in the COLI table. For these sites, the only way to establish COLI information is to manually rank the site using market type. When a site has been ranked, rate guidance information can be populated.
Hours per Day Decimal Standard hours worked per day at the Site.
Hours per Week Decimal Standard hours worked per week at the Site.
Invoice Tax Information Required? String Yes - Invoice Tax Information Required Flag is on site, but not mandatory. No/Blank - Flag does not appear on site.
Invoice Tax Information Code String Invoice Tax Information code created by buyer. This field is mandatory when the site has workers and the buyer selects ITI required 'Yes' while downloaded. This field is non-mandatory when the buyer is creating a new site or on a site that does not have any workers.
Original Code String Original code for this site in the ERP instance from which the site originates. Multiple sites may have the same Original Code. If a company does not use multiple ERP instances, this field should be left blank.
Modification Type String A - Add

SOWBids

Retrieve SOW and SOW bid information using the SOW with Bid Download connector.

Columns
Name Type Description
SOW ID String Unique identifier for SOW/Bid.
Revision Number Int SOW Revision number.
SOW Name String SOW name.
Start Date Date SOW start date.
End Date Date SOW end date.
Status String Current SOW Status.
Supplier Code String SOW Supplier company code. If SOW template rule 'Suppress Supplier Name' is enabled, output will display 'XXXX' for SOW Bid and for SOW Statuses of Draft/Pending Supplier Review/Pending Approval or Response Approval. Also, if rule is enabled, supplier names will NOT be visible even for users who have the 'View Supplier Bid Responses' User Role Permission enabled.
Supplier Name String SOW Supplier company name. If SOW template rule 'Suppress Supplier Name' is enabled, output will display 'Name Withheld' for SOW Bid and SOW Statuses of Draft/Pending Supplier Review/Pending Approval or Response Approval.
Billable? String Indicates if SOW is billable to client.
Master SOW? String Flag to determine if this is a Master SOW.
Legal Entity String Legal Entity code associated to SOW. Company configuration 'Enable Legal Entity' must be turned on for Services.
Purchase Unit String Name of Purchase Unit. Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Purchase Unit Code String Code of Purchase Unit. Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Business Unit String Business unit code associated to SOW.
Clauses String This field will determine if clauses are in use by the SOW.
Management Events String This field will determine if the Management Event characteristic is in use by the SOW.
Schedules String This field will determine if the Schedule characteristic is in use by the SOW.
Events String This field will determine if Event characteristic is in use by the SOW.
Units/Reimbursable String This field will determine if any fee is defined in the SOW.
SOW Agency Workers String This field will determine if the Workers are in use by the SOW.
Maximum Budget Decimal Maximum allowed amount to spend on the SOW.
Holdback % Decimal The holdback % that is set on the SOW. SOW template rule 'Enable Holdback' must be set.
Fee Response Holdback % Decimal The holdback % that is set on the SOW fee response. SOW template rule 'Enable Holdback' must be set.
Currency String Code of the currency used by the SOW.
Spend to Date Decimal Sum of the amount spend on the SOW.
Other Pending Spend Decimal The total amount of all schedules, events, units, and team-based amounts which are in pending status.
Remaining Budget Decimal Difference between Maximum Budget and Spend to Date values.
Cost Center Code String Cost Center code associated to the SOW.
Cost Center Name String Cost Center name associated to the SOW.
Create Date Date Create date of the SOW.
Submit Date Date Submit date of the SOW.
SOW Template Name String Name of the template from which SOW is Created, if applicable.
SOW Template Type String Type of the template from SOW is created. Default value is 'Classic'.
AP Code String The AP Code field appears only when the AP Code Required has been enabled in the company configuration for Contingent and/or Services: Work Orders and Workers. Custom Lookup: AP Code Selection must be created. The AP Code is associated to Work Order or SOW.
Created for SOW Bid String Indicates if SOW created for Bid.
SOW Bid Maximum Budget Decimal Indicates maximum budget for SOW Bid.
Associated MSOW Name String MSOW name associated with supplier.SOW Template rule 'Allow MSOW association to ~SOW Bid~ supplier' must be enabled.
Associated MSOW ID String MSOW ID associated with SupplierSOW Template rule 'Allow MSOW association to ~SOW Bid~ supplier' must be enabled.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.For SOW Bid records in this download, this field will always be blank.
Commodity Code Description String Description of the commodity code.This field must be manually configured to be in the download file template.For SOW Bid records in this download, this field will always be blank.
Additional Classifications String For MSOWs that have multiple classifications, this field displays the additional classifications added during creation or revision, separated by a (|) pipe delimiter. This field must be manually configured to appear in the download.
Work Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.

SOWCharacteristics

Retrieve SOW characteristic information using the Approved Characteristic Download connector.

Columns
Name Type Description
SOW Line Item ID String SAP Fieldglass SOW Line item ID.
SOW ID String SOW FG ID corresponding to the characteristic.
Revision Int Revision of the SOW corresponding to the characteristic.
Characteristic Type String Which type of characteristic it is.
Sequence Number Int Sequence number given in the SOW for each characteristic.
Buyer Defined Sequence Number String Buyer defined sequence number for SOW line item. Company configuration 'Allow Buyer Defined Sequence on SOW Line Items' must be enabled.
Name String Name given to the characteristic when it was entered in the SOW.
Description String Description of the characteristic.
Status String Status of the characteristic.
Supplier Code String Supplier code corresponding to the characteristic.
Submit Date Date Date when the characteristic was submitted. This field is found on event and fee characteristics.
Approved Date Date Date when the characteristic was approved.
Cost Center Code String Cost center corresponding to the characteristic.
Cost Center Allocation % Decimal Allocation % of for each of the cost center present in the characteristic. If company configuration 'Cost Allocation Percentage decimal precision' is enabled, this field shows zeros beyond the precision value set digit.
Cost Bearing String Indicates if cost center is cost bearing or for statistical purposes.Company configurations 'Enable Cost Bearing' and 'Statement of Work' must be enabled.
Requested Amount Decimal Requested amount of the characteristic.
Final Amount Decimal Final amount of the characteristic.
Amount Decimal Amount per line in the fee characteristic.
Maximum Budget Decimal Maximum budget amount of the corresponding SOW latest confirmed revision.
Spend to Date Decimal Amount spend to date on the corresponding SOW.
Expected Date Date Expected completion date of the event.
Unit of Measure String Unit of measure of schedules or fee characteristics.
Maximum Units Int Maximum units for schedules or fee characteristics. This shows the maximum amount of units allowed.
Units Int Field found on the schedules and fee characteristics. This field shows the amount unit used.
Rate Decimal Rate of the Fee characteristic.
Frequency String Field found on schedules and management events that are reoccurring.
Start Period Date Field found on schedules and management events that are reoccurring.
Date Range Start Date Field found on Schedules and Management Events that are reoccurring.
Date Range End Date Field found on Schedules and Management Events that are reoccurring.
Submitted By Username String User name of the user who submitted the characteristic to be approved. This field is found on Event and Fee characteristics.
Submitted By Name String Name of the user who submitted the characteristic to be approved.
Submitted By Id String Employee ID of the user who submitted the characteristic to be approved
Owner Username String User name of the characteristic owner.
Owner Name String Name of SOW Owner.
Owner ID String Employee ID of SOW Owner.
Task Code String 1 to 1 relationship to the characteristic.
Business Unit Code String Business Unit of the characteristic.
GL Account Code String GL Account code of characteristic Company configuration 'Require GLA Allocation on Job Postings and Statements of Work' must be enabled. This field is mutually exclusive with Segmented Object Detail field.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|) and dash (-). Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. Note – more than one string can appear for a cost center.
Defined By String Indicates if the characteristic was defined by the buyer or the supplier.
Site String Site of the characteristic.
Capitalized? String This value can be edited at the characteristic level.
PO Number String PO Number of the characteristic.
Reason Code String The reason code associated to the SOW Line Item revision. If revising Holdback item, the reason associated with the holdback. Company configuration 'Allow Supplier to submit revised SOW Events, Fees, and Schedules' must be enabled.
SOW Line Item Revision Type String Type of Event, Fee, or Schedule revision Company configuration 'Allow Supplier to submit revised SOW Events, Fees, and Schedules' must be enabled.
SOW Line Item Revision Number Int The revision number of the SOW Line Item If revising Holdback, the revision number of the holdback. Company configuration 'Allow Supplier to submit revised SOW Events, Fees, and Schedules' must be enabled.
Original SOW Line Item ID String The SAP Fieldglass ZID of the original SOW Line Item associated to the SOW Line Item revision. If revising holdback, this must be the SAP Fieldglass ZID of the original holdback item associated with the holdback revision. Company configuration 'Allow Supplier to submit revised SOW Events, Fees, and Schedules' must be enabled.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.
Commodity Code Description String Description of the commodity code. This field must be manually configured to be in the download file template.
Account Category String Identifies the type of Cost Center.
Discount Decimal Discount on the characteristic.
Final Amount after Discount Decimal Final Amount after Discount on the characteristic
Amount after Discount Decimal Amount after discount per line in the fee characteristic
Item Category String Defines whether the line item is of type Limit or Standard which are planned or unplanned work. Using the Item Category of 'Limit' creates a PO Line for a specified amount. Using the Item Category Type of 'Standard' creates a PO Line where the Qty, Unit, and Unit Rate can be specified.This field only appears in the download if the sysenv= SOW_CREATION_TYPE_ENABLED is enabled and Creation Type = Integration.Only applicable for hierarchial events.This field is visible only at the last level event.
Product Type String Defines whether the line item is of type 'Material' or 'Service'. A Purchase Order from S/4 can have a mixture of both Service and Material lines which need to be visible in both SAP Fieldglass (SOW) and SAP Ariba.'Material' lines are Read Only and cannot be completed. They are excluded from budget calculation and validations in SAP Fieldglass.'Service' lines are completed in SAP Fieldglass.This field only appears in the download if the sysenv= SOW_CREATION_TYPE_ENABLED is enabled and Creation Type = Integration.Only applicable for hierarchial events.This field is visible only at the last level event.
Unit Tolerance % Decimal The percentage tolerance allowed on units and amount of 'Standard' type line items.The percentage can be up to 3 decimal places.This field only appears in the download if the sysenv= SOW_CREATION_TYPE_ENABLED is enabled and Creation Type = Integration.Only applicable for hierarchial events.This field is visible only at the last level event.
Units with Tolerance Decimal Maximum tolerance units for 'Standard' type line items.This field only appears in the download if the sysenv= SOW_CREATION_TYPE_ENABLED is enabled and Creation Type = Integration.Only applicable for hierarchial events.This field is visible only at the last level event.
Amount with Tolerance Decimal Maximum tolerance amount for 'Limit' type line items.This field only appears in the download if the sysenv= SOW_CREATION_TYPE_ENABLED is enabled and Creation Type = Integration.Only applicable for hierarchial events.This field is visible only at the last level event.This field is not visible to supplier if event's Item Category = Standard.

SOWs

Retrieve Statement of Work (SOW) information using the SOW Download connector.

Columns
Name Type Description
SOW ID String Field glass SOW ID.
Revision Number Int SOW Revision number.
SOW Name String SOW name.
Start Date Date SOW start date.
End Date Date SOW end date.
Status String Name of the current SOW Status.
Supplier Code String SOW Supplier company code. If SOW template rule 'Suppress Supplier Name' is enabled, output will display 'XXXX' for SOW Bid and SOW Statuses of Draft/Pending Supplier Review/Pending Approval or Response Approval.
Supplier Name String SOW Supplier company name. If SOW template rule 'Suppress Supplier Name' is enabled, output will display 'Name Withheld' for SOW Bid and for SOW Statuses of Draft/Pending Supplier Review/Pending Approval or Response Approval. Also, if rule is enabled, Supplier Name will NOT be visible even for users who have the 'View Supplier Bid Responses' User Role Permission enabled.
Billable? String Indicates if SOW is billable to client.
Master SOW? String Flag to determine if this is a Mater SOW.
Legal Entity String Legal Entity code associated to SOW. Company configuration Enable Legal Entity must be turned on for Services.
Purchase Unit String Name of Purchase Unit. Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Purchase Unit Code String Code of Purchase Unit. Company configuration 'Enable Purchase Unit' must be enabled. The User Role Permission 'Purchase Unit - View' must be enabled to view this information.
Business Unit String Business unit code associated to SOW.
Clauses String This field will determine if clauses are in use by the SOW.
Management Events String This field will determine if the Management Event characteristic is in use by the SOW.
Schedules String This field will determine if the Schedule characteristic is in use by the SOW.
Events String This field will determine if Event characteristic is in use by the SOW.
Units/Reimbursable String This field will determine if any fee is defined in the SOW.
SOW Agency Workers String This field will determine if the Workers are in use by the SOW.
Automatically Extend SOW Worker End Dates to Match SOW EndDate String Indicates whether the SOW worker end dates are to be automatically extended to match the SOW end date.
Maximum Budget Decimal Maximum allowed amount to spend on the SOW.
Holdback % Decimal The holdback % that is set on the SOW. SOW template rule 'Enable Holdback' must be set.
Fee Response Holdback % Decimal The holdback % that is set on the SOW fee response. SOW template rule 'Enable Holdback' must be set.
Currency String Code of the currency used by the SOW.
Spend to Date Decimal Sum of the amount spend on the SOW.
Other Pending Spend Decimal The total amount of all schedules, events, units, and team-based amounts which are in pending status.
Remaining Budget Decimal Difference between Maximum Budget and Spend to Date values.
Cost Center Code String Cost Center code associated to the SOW.
Cost Center Name String Cost Center name associated to the SOW.
Create Date Date Create date of the SOW.
Submit Date Date Submit date of the SOW.
SOW Template Name String Name of the template from which SOW is Created.
SOW Template Type String Type of the template from SOW is created.
AP Code String The AP Code field appears only when the AP Code Required has been enabled in the company configuration for Contingent and/or Services: Work Orders and Workers. Custom Lookup: AP Code Selection must be created. The AP Code is associated to Work Order or SOW.
Additional Classifications String For MSOWs that have multiple classifications, this field displays the additional classifications added during creation or revision, separated by a (|) pipe delimiter. This field must be manually configured to appear in the download.
Additional Suppliers String Supplier code(s) for buyer separated by (|).Company configuration 'Master SOW' and 'Allow Multiple Suppliers' must be enabled.
Additional Legal Entities String Legal entities for buyer separated by (|).Company configuration 'Master SOW', 'Enable Legal Entities' and 'Allow Multiple Suppliers' must be enabled.
Additional Currency String Currency codes for buyer separated by (|).Company configuration 'Master SOW' and 'Allow Multiple Suppliers' must be enabled.
Commodity Code String Code for the commodity. This field must be manually configured to be in the download file template.
Commodity Code Description String Description of the commodity code.This field must be manually configured to be in the download file template.
Discount % Decimal The discount % on a SOW. If 'Enable Rates 2.0' is enabled, this field does not appear.
Work Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String The primary location name.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location Code String The primary location code.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.

SOWWorkerRoles

Retrieve worker roles in all statuses using the SOW Worker Role Download connector.

Columns
Name Type Description
Code String SOW Worker role code.
Name String SOW Worker role name.
Description String Description of SOW worker role
ONET Code String The ONET code of the job description.
Equipment String Indicates equipment flag on team member role.
Use Fees for Billing String Fee line item can be used for billing purpose / invoicing. Only applicable if SOW has fees.
Rate Grid String Indicates if rate grid needs to be applied. If 'Enable Rates 2.0' is enabled, this field does not appear.
Job Code String Indicates job code associated with SOW worker role.
Associate to all Suppliers who service SOW String Indicates if role can be associated to all SOW suppliers. If not entered, this field defaults to No.
Modification Type String A = Adds Worker Role. U = Updates Worker Role D = Deletes Worker Role.

Suppliers

Retrieve supplier configuration information using the Supplier Download connector.

Columns
Name Type Description
Status String Status of supplier.
Supplier Code String Fieldglass Supplier code to determine which supplier information needs to be edited for the buyer company uploading the file.
Supplier Name String Name of supplier.
Address 1 String Line 1 of the site's address. If the field is not entered, the default will be blank.
Address 2 String Line 2 of the site's address. If the field is not entered, the default will be blank.
City String City where the site is located. If the field is not entered, the default will be blank.
State/Province String State/Province where the site is located. Use the two-letter postal code. If the field is not entered, the default will be blank.
Country String Country where the site is located. If the field is not entered, the default will be blank.
Supplier ZIP/Postal Code String ZIP Code/Postal Code of the site. Both five- and nine-digit codes are accepted. If the field is not entered, the default will be blank.
Supplier Primary Contact Person String The primary contact's name.
Supplier Primary Contact Person for Services String The primary contact's name for Services.
Company Duns String Dun and Bradstreet number for supplier.

TimeJournals

Retrieve time journals that are in Submitted, Consolidated, and/or Errored status depending on a provided parameter using the Time Journal Download connector.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • Status supports the '=' operator. This parameter specifies the status of the time journal. Available values are: All, Pending Approval, Approved, Rejected, Consolidated, and Errored. By default, all time journals are retrieved.

For example, the following queries are processed server-side:

SELECT * FROM TimeJournals WHERE Status = 'Approved'
SELECT * FROM TimeJournals WHERE Status = 'Rejected'
Columns
Name Type Description
Time Journal ID String Reference ID for the time journal.
Resource String Resource name.
Buyer String Name of buyer associated to the time journal.
Buyer Code String Buyer code associated to the time journal.
Supplier String Name of supplier associated to the time journal.
Supplier Code String Supplier code associated to the time journal.
Date Date Date the resource time data for was logged to the time journal.
Create Date Date Date the time journal was created.
Assignment ID String Reference ID for the associated assignment.
Assignment String Name of the associated assignment.
Site String Site name.
Assignment Owner String Name of assignment owner at the time the time journal was created.
Total Hours Decimal Total number of hours worked by the resource on a given assignment line item and rate category.
Rate Category/UOM String Rate category and unit of measure of the rate
Rate Decimal Rate applicable for the hours and rate category worked by the resource.
Amount Decimal Time journal amount.
Cost Center String Cost center associated with the time journal.
Status String Status of the time journal. Available values are All, Pending Approval, Approved, Rejected, Consolidated, and Errored. Defaults to All.
PO Number String Assignment purchase order number.
Line Item Number String Assignment line item number.
Time Journal Segment Name String Any user selectable segment associated with Time Journal. The Segment Name should contain an [s] before the name. The Data Set company configuration must be enabled to view this field. Valid values of the user selectable segments are picked up from the Time Journal.
Lookup Name String Assignment rate lookup name. The Data Set company configuration must be enabled to view this field.
Job Code String Job code on the time journal.
Currency String Currency associated with the time journal.
Buyer Ref String Buyer reference field that can be used to reference the time journal.

TimeSheetBuyerDeductions

Retrieve time sheet deductions for buyers using the Deduction Buyer Download connector.

Columns
Name Type Description
Supplier Code String Fieldglass Supplier Code
Supplier Name String Fieldglass Supplier Name
Time Sheet ID String Fieldglass Time Sheet ID of time sheet with deductions
Time Sheet Status String Indicates status of time sheet with deductions
Time Sheet Start Date Date Start Date of Time Sheet
Worker First Name String Worker's First Name
Worker Last Name String Worker's Last Name
Worker ID String Fieldglass Worker ID
Job Seeker ID String Fieldglass Job Seeker ID
Currency String Currency in which billable amount is to be paid
Cost Center String Cost Center Code for the deduction
Deduction Name String Indicates name of deduction
Deduction Code String Indicates deduction code
Comments String Comments associated with deduction
Deduction Amount Decimal Amount of deduction on the time sheet
Invoice Amount Decimal Amount invoiced on the time sheet

TimeSheets

Retrieve contingent worker time sheets that are in Draft (with time entries), Rejected, and/or Pending Approval status, depending on a provided parameter using the Time Sheet Download connector.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • Time Sheet Status supports the '=' operator. This parameter specifies the status of the time sheets. Available values are: All, Draft, Rejected, Pending Approval, and Revoked. By default, all time sheets are retrieved.

For example, the following queries are processed server-side:

SELECT * FROM TimeSheets WHERE [Time Sheet Status] = 'Draft'
SELECT * FROM TimeSheets WHERE [Time Sheet Status] = 'Rejected'
Columns
Name Type Description
Time Sheet ID String Fieldglass Time Sheet ID
Time Sheet Status String This parameter specifies the status of the time sheets. Available values are All, Draft, Rejected, Pending Approval, and Revoked. Defaults to All.
Time Sheet Start Date Date Start Date of Time Sheet
Time Sheet End Date Date End Date of Time Sheet
Time Sheet Submit Date/Time Datetime Date and Time when Time Sheet was Submitted by the Worker
Time Sheet Approved Date Date Date the Time Sheet was fully approved. Blank if Time Sheet is yet to be approved.
Time Entry Date Date Date for which time is being recorded.
Buyer Name String Fieldglass Buyer Name
Buyer Code String Fieldglass Buyer Code
Supplier Name String Fieldglass Supplier Name
Supplier Code String Fieldglass Supplier Code
Account Name String Name of the Account, such as geographical area covered. See Glossary
Account Code String The unique system identifier for the account. See Glossary
Remit To Address Code String Supplier's Remit To Address Code
Job Posting Owner String Fieldglass Job Posting Owner in 'First, Last' format.
Work Order ID String Fieldglass Work Order ID
Worker ID String Fieldglass Worker ID
Job Seeker ID String Fieldglass Job Seeker ID
Worker Last Name String Worker's Last Name
Worker First Name String Worker's First Name
Site Code String Fieldglass Site Code associated to the Worker.
Site Name String Fieldglass Site Name associated to Site Code above.
Business Unit Code String Fieldglass Business Unit Code associated to worker.
Business Unit Name String Fieldglass Business Unit Name related to Business Unit Code above.
Final Approver First Name String First Name of the Time Sheet's Final Approver. Only appears if the Time Sheet has last approver ID populated.
Final Approver Last Name String Last Name of the Time Sheet's Final Approver. Only appears if the Time Sheet has last approver ID populated.
Final Approver Employee ID String Final Approver's Employee ID as stored on their SAP Fieldglass User Profile.
Cost Center Code String Cost Center Code against which time is being recorded.
Cost Center Name String Cost Center Name related to the Cost Center Code above.
Task Code String Task Code against which time is being recorded.
Task Name String Task Name associated to the Task Code above.
General Ledger Account Code String General Ledger Account associated to the Task against which time is being recorded. Will be downloaded only when the company is GL enabled. This field is mutually exclusive with Segmented Object Detail.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-) Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. Note - More than one string can appear for a cost center.
Billable Per Diem Decimal Amount of any Billable Per Diem to be paid for the Time Entry Date
Billable Hours Decimal Number of Billable Hours recorded for the Time Entry Date
Non-billable Hours Decimal Number Non-Billable Hours recorded for the Time Entry Date
Total Hours Decimal Sum Total of Billable and Non-Billable Hours recorded for the Time Entry Date.
Billable Amount Decimal Total Amount to be billed for the Time Entry Date
Currency String Currency in which Billable Amount is to be paid.
Rate Category / UOM String Rate Category and Unit of Measure for time recorded.
Bill Rate Buyer Decimal The Bill Rate that the Buyer will pay for each billable hour recorded.
Bill Rate Supplier Decimal The Bill Rate that the Supplier will receive for each billable hour recorded.
Pay Rate Decimal The Worker's pay rate.
Location Code String The location code of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.The 'Location Code' column does not display on any of the above mentioned downloads until the client has configured the download to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink
Work Location Name String The location name of the hours against the Rate/Rate Category for that day.Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.The 'Work Location Name' column does not display on any of the above mentioned downloads until the client has configured the download to do so via the Enabled Fields tab's '+Add Native Fields' hyperlink

TimeSheetSupplierDeductions

Retrieve time sheet deductions for suppliers using the Deduction Supplier Download connector.

Columns
Name Type Description
Buyer Code String Fieldglass Buyer Code associated with supplier
Buyer Name String Fieldglass Buyer Name
Time Sheet ID String Fieldglass Time Sheet ID of time sheet with deductions
Time Sheet Status String Indicates status of time sheet with deductions
Time Sheet Start Date Date Start Date of Time Sheet
Worker First Name String Worker's First Name
Worker Last Name String Worker's Last Name
Worker ID String Fieldglass Worker ID
Job Seeker ID String Fieldglass Job Seeker ID
Currency String Currency in which Billable Amount is to be paid.
Cost Center String Cost Center Code for the deduction
Deduction Name String Indicates name of deduction
Deduction Code String Indicates deduction code
Comments String Comments associated with deduction
Deduction Amount Decimal Amount of deduction on time sheet
Invoice Amount Decimal Amount invoiced on time sheet

TimeSheetsWithNoTimeEntry

Retrieve time sheets with no time entries using the Time Sheet with No Time Entry Download connector.

Columns
Name Type Description
Buyer Name String Fieldglass Buyer Name
Buyer Code String Fieldglass Buyer Code
Supplier Name String Fieldglass Supplier Name
Supplier Code String Fieldglass Supplier Code
Account Name String Name of the Account, such as geographical area covered. See Glossary
Account Code String The unique system identifier for the account. See Glossary
Remit To Address Code String Supplier's Remit To Address Code
Job Posting Owner String Fieldglass Job Posting Owner in 'First, Last' format.
Work Order ID String Fieldglass Work Order ID
Worker ID String Fieldglass Worker ID
Job Seeker ID String Fieldglass Job Seeker ID
Worker Last Name String Worker's Last Name
Worker First Name String Worker's First Name
Site Code String Fieldglass Site Code associated to the Worker.
Site Name String Fieldglass Site Name associated to Site Code above.
Business Unit Code String Fieldglass Business Unit Code associated to Worker.
Business Unit Name String Fieldglass Business Unit Name related to Business Unit Code above.
Final Approver First Name String First Name of the Time Sheet's Final Approver. Only appears if the Time Sheet has last approver ID populated.
Final Approver Last Name String Last Name of the Time Sheet's Final Approver. Only appears if the Time Sheet has last approver ID populated.
Final Approver Employee ID String Final Approver's Employee ID as stored on their SAP Fieldglass User Profile.
Final Approver Email String Final Approver's email address as stored on their SAP Fieldglass User Profile.
Time Sheet ID String Fieldglass Time Sheet ID
Time Sheet Status String Fieldglass Time Sheet Status
Time Sheet Start Date Date Start Date of Time Sheet
Time Sheet End Date Date End Date of Time Sheet
Time Sheet Submit Date/Time Date Date and Time when Time Sheet was Submitted by the Worker
Time Sheet Approved Date Date Date the Time Sheet was fully approved. Blank if Time Sheet is yet to be approved.
Time Entry Date Date Date for which time is being recorded.
Cost Center Code String Cost Center Code against which time is being recorded.
Cost Center Name String Cost Center Name related to the Cost Center Code above.
Task Code String Task Code against which time is being recorded.
Task Name String Task Name associated to the Task Code above.
General Ledger Account Code String General Ledger Account associated to the Task against which time is being recorded. Will be downloaded only when the company is GL enabled. This field is mutually exclusive with Segmented Object Detail.
Segmented Object Detail String Segmented Object Detail string. Segments will be separated by delimiter on the Segmented Object. Valid delimiters are colon (:), semi-colon (;), pipe (|), and dash (-). Required if 'Enable Segmented Object Detail' configuration set. This field is mutually exclusive with GL Account fields. Note - More than one string can appear for a cost center.
Billable Per Diem Decimal Amount of any Billable Per Diem to be paid for the Time Entry Date
Billable Hours Decimal Number of Billable Hours recorded for the Time Entry Date
Non-billable Hours Decimal Number Non-Billable Hours recorded for the Time Entry Date
Total Hours Decimal Sum Total of Billable and Non-Billable Hours recorded for the Time Entry Date.
Billable Amount Decimal Total Amount to be billed for the Time Entry Date
Billable Amount after Discount Decimal Billable Amount of the time sheet date after applying the discount.
Currency String Currency in which Billable Amount is to be paid.
Rate Category / UOM String Rate Category and Unit of Measure for time recorded.
Bill Rate Buyer Decimal The Bill Rate that the Buyer will pay for each billable hour recorded.
Bill Rate Supplier Decimal The Bill Rate the Supplier will receive for each billable hour recorded.
Pay Rate Decimal The Worker's pay rate.

TITOTimeSheets

Retrieve worker time in/time out (TITO) details based off a parameter entered during run time using the TITO Time Sheet Status Parameter Download connector.

View Specific Information

The connector will use the SAP Fieldglass API to process WHERE clause conditions built with the following columns and operators. The remaining filter criteria is executed client-side within the connector.

  • Time Sheet Status supports the '=' operator. This parameter specifies the status of the TITO time sheets. Available values are: Draft, Pending Validation, and Pending Supplier Review. By default, draft time sheets are retrieved.

For example, the following queries are processed server-side:

SELECT * FROM TITOTimeSheets WHERE Status = 'Pending Validation'
SELECT * FROM TITOTimeSheets WHERE Status = 'Pending Supplier Review'
Columns
Name Type Description
Worker_Id String Valid Worker ID
Last Name String Worker's Last Name
First Name String Worker's First Name
Time_Sheet_Id String Valid SAP Fieldglass Timesheet ID
Date Date Date of the Timesheet Day for which TITO Details are being added.
Time In String Worker Time In at the beginning of the work day.
Meal Break 1 Out String Meal Break 1 Out Time
Meal Break 1 In String Meal Break 1 In Time
Meal Break 2 Out String Meal Break 2 Out Time
Meal Break 2 In String Meal Break 2 In Time
Meal Break 3 Out String Meal Break 3 Out Time
Meal Break 3 In String Meal Break 3 In Time
Time Out String Worker Time Out at the conclusion of the work day.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Status String This parameter specifies the status of the TITO time sheets. Available values are Draft, Pending Validation, and Pending Supplier Review. Defaults to Draft.

Users

Retrieve all active users for the logged in user's company using the User Download connector.

Columns
Name Type Description
Username String The user's SAP Fieldglass username. This item must be unique to the system (not just the buyer). SAP Fieldglass recommends the user's email address as the username. For Bulk Full version, this key field must be in the first position. See the Configuration Considerations section for more information.
Prefix String The prefix of the user's name.
First Name String The user's first name.
Last Name String The user's last name.
Display Name String How the user's name should be displayed throughout the application. If left blank, the user's display name will default to the 'Last Name, First Name' format.
Email String The user's email.
Phone Number String The user's phone number.
Fax Number String The user's fax number.
Mobile Number String The user's mobile number.
Additional Roles String The user's additional user roles.
Address 1 String The user's address, Line 1.
Address 2 String The user's address, Line 2.
City String The user's city.
State String The user's state/province. Use the 2-digit state code.
Country String The user's country. For example 'USA'.
ZIP Code String The user's postal code/zip code. Both 5- and 9-digit codes are accepted.
Employee ID String The identifier appointed to the user by the buyer company.
Title String The user's job title.
MSP User String Indicates if user belongs to an MSP company.
Role Name String The user role as defined in the SAP Fieldglass system. The user role defines what access and security privileges the user has.
Primary Business Unit String The Business Unit Code as defined in the SAP Fieldglass system. The business unit identifies what data the user has access to in SAP Fieldglass, as well as the approval groups that are executed.
Primary Supervisor Username String The SAP Fieldglass username of the user's primary supervisor from the buyer side, which is used for escalation and notifications. Usernames are defined in the SAP Fieldglass system.
Default Cost Center String The Cost Center Code as defined in the SAP Fieldglass system. The Default Cost Center identifies the preferred cost center of the user and what data the user has access to in SAP Fieldglass.
Default Site String The Site Code as defined in the SAP Fieldglass system. The default site identifies the preferred site of the user and what data the user has access to in SAP Fieldglass.
Default Legal Entity String Default legal entity from user profile. Company configuration 'Enable Legal Entity' must be enabled. Applicable for version 2.0 only.
Cost Center Access String Determines the method for which cost center access will be given to a user. ALL = All cost centers are associated with the user. Build = As cost centers are used by users that are subordinate to the user or appear on transactions requiring the user's approval, the user is given access. Associate = Cost centers must be explicitly associated with the user on their profile in SAP Fieldglass.
Business Unit Access String Determines the method for which business unit access will be given to a user. ALL = All business units are associated with the user. Build = As business units are used by users that are subordinate to the user or appear on transactions requiring the user's approval, the user is given access. Associate = Business units must be explicitly associated with the user on their profile in SAP Fieldglass.
Site Access String Determines the method for which sites access will be given to a user. ALL = All sites are associated with the user. Build = As sites are used by users that are subordinate to the user or appear on transactions requiring the user's approval, the user is given access. Associate = Sites must be explicitly associated with the user on their profile in SAP Fieldglass.
User Last Login String Date the user last logged in to SAP Fieldglass.
Receive Notifications via email before Registration String Indicates if supplier emails should be sent prior to worker registration.
View Administrative Product Documentation String Indicates the user can view documentation for buyer administrators on the SAP Fieldglass product page on the SAP Help Portal.

WorkersFromWorkOrder

Retrieve multiple workers using the Worker from Work Order Download connector.

Columns
Name Type Description
Job Seeker ID String Tied to the work order. A worker can have many Job Seeker ID's.
Worker ID String Will be blank if the record is downloaded from the work order. Tied to the work order. A worker can have many worker IDs.
Person ID String Will be blank if the record is downloaded from the work order. Unique identifier for the worker as a person.
Security ID String This column will only appear in the file if the Security ID field functionality is activated in SAP Fieldglass for the buyer. If the functionality is not activated, this column will not be in the file.
Status String Pending - Work order created or accepted or activated. Closed - Work order rejected, declined, closed, or worker closed. Active - Worker confirmed or work order revised.
First Name String Worker First Name. Populated from Worker once registered; populated from Job Seeker prior to registration.
Last Name String Worker Last Name. Populated from Worker once registered; populated from Job Seeker prior to registration.
Worker Email String Worker's Email Address.
Job Posting Title String Job Posting Title for Temporary or Direct Hire Workers. SOW Name for SOW Workers.
Work Order ID String Work Order ID. *Will be blank for Profile Workers.
Work Order/WorkOrder RevisionOwner String Work Order Owner Name.
Work Order/WorkOrder RevisionOwner Employee ID String Work Order Owner Employee ID.
Business Unit Code String Business Unit Code.
Business Unit Name String Business Unit Name.
Vendor Number String Fieldglass Supplier Code.
Vendor Name String Supplier Name.
Buyer Code String Fieldglass Buyer Company Code.
Remit To Address Code String Code as assigned to the Remit To Address by the Supplier.
Worker Pay Type Code String Indicates any worker pay types.Company configuration 'Use Worker Type' must be enabled.
Cost Center Name String Cost Center Name.
Cost Center Code String Cost Center Code.
Task_Name String Task Name. If Worker has flag set to allow access to all Task Codes, this field will be blank.
Task_Code String Task Code If Worker has flag set to allow access to all Task Codes, this field will be blank.
Billable Per Diem Int Billable Per Diem Amount.
Start Date Date Start Date of latest Confirmed Work Order Revision.
End Date Date End Date of the latest Confirmed Work Order Revision.
Currency String Three-character ISO currency designation.
Site Code String Site Code.
Site Name String Site Name.
Rate Category/UOM String Rate category and rate unit (e.g. ST/Hr, OT/Day, ST/MTH).
Bill Rate Int Bill Rate for the Rate Category.
Pay Rate Int Pay Rate for the Rate Category. Populated for buyer downloads when buyer has access to supplier pay rate data, otherwise this field will default to 0.
Vendor ID String Native field for the buyer company's external ID.
Worker Country of Origin String Indicates worker's country of origin.Company configurations 'Allow Security ID format by Worker Country of Origin' and 'Enable Security Information' must be enabled.
Discount % Decimal Discount % from SOW Worker
Work Location Name String The location name. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location Code String Indicates primary location code when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Location Code String The location code. Company configuration 'Allow Multiple Locations' must be enabled. Row will be 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.
Primary Location String Indicates primary location name when Company Configuration 'Allow Multiple Locations' is enabled. Client must configure the download to include this field via the Enabled Fields +Add Native Fields hyperlink.
Original Revision Start Date Date This field returns the Start Date from the original work order regardless of what revision the work order is currently on.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with SAP Fieldglass.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Fieldglass, along with an indication of whether the procedure succeeded or failed.

SAP Fieldglass Connector Stored Procedures

Name Description
GetOAuthAccessToken Gets an authentication token from SAP Fieldglass.
ModifyItem Approve or reject an item.

GetOAuthAccessToken

Gets an authentication token from SAP Fieldglass.

Result Set Columns
Name Type Description
OAuthAccessToken String The access token used for communication with SAP Fieldglass.
ExpiresIn String The remaining lifetime on the access token.

ModifyItem

Approve or reject an item.

Input
Name Type Required Description
ModuleId String True The ID of the module.
WorkItemId String True The ID of the work item.
Action String True The action to take on the work item. If it is set to 'reject', then the reasonId is required. The allowed values are approve, reject.
Comments String False Any comments about the action.
ReasonId String False The reason ID for the rejection. This is required when the action is reject.
Result Set Columns
Name Type Description
Success Boolean Indicates whether the operation completed successfully.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for SAP Fieldglass:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the AuditTrails table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AuditTrails'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the AuditTrails table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AuditTrails'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:sapfieldglass:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Property Description
EnvironmentURL The Environment URL where the instance of SAP Fieldglass is located.
APIKey The API Key used to authenticate to SAP Fieldglass.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
ConnectorDataFormat The download data format configured during the Connector setup.
ConnectorNames Specify a comma-separated list of custom Connector names to list as tables.
IncludeCustomFields A boolean indicating if you would like to include custom fields in the column listing.
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme Sets the method for determining the data type of columns.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNames Boolean determining if simple names should be used for tables and columns.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
EnvironmentURL The Environment URL where the instance of SAP Fieldglass is located.
APIKey The API Key used to authenticate to SAP Fieldglass.

EnvironmentURL

The Environment URL where the instance of SAP Fieldglass is located.

Data Type

string

Default Value

""

Remarks

The Environment URL where the instance of SAP Fieldglass is located.

APIKey

The API Key used to authenticate to SAP Fieldglass.

Data Type

string

Default Value

""

Remarks

The API Key used to authenticate to SAP Fieldglass.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\SAPFieldglass Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\SAPFieldglass Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."
  • Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\SAPFieldglass Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\SAPFieldglass Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
ConnectorDataFormat The download data format configured during the Connector setup.
ConnectorNames Specify a comma-separated list of custom Connector names to list as tables.
IncludeCustomFields A boolean indicating if you would like to include custom fields in the column listing.
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme Sets the method for determining the data type of columns.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNames Boolean determining if simple names should be used for tables and columns.

ConnectorDataFormat

The download data format configured during the Connector setup.

Possible Values

CSV, JSON

Data Type

string

Default Value

CSV

Remarks

The property defaults to CSV since that is the standard when configuring Connectors. Change this to JSON if the download data format was set to JSON during the Connector setup.

ConnectorNames

Specify a comma-separated list of custom Connector names to list as tables.

Data Type

string

Default Value

""

Remarks

Make sure to include all spaces (matching the name in the SAP Fieldglass UI) when writing the Connector names.

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

false

Remarks

To include the custom fields, the connector needs to make an individualized request per table, which may cause poor performance when listing metadata.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

TypeDetectionScheme

Sets the method for determining the data type of columns.

Possible Values

None, RowScan

Data Type

string

Default Value

RowScan

Remarks
Property Description
None Setting TypeDetectionScheme to None returns all columns as "string" type. Note: Even when set to None, the column names are still scanned.
RowScan Setting TypeDetectionScheme to RowScan scans rows to heuristically determine the data type. The RowScanDepth determines the number of rows that are scanned. If no value is specified, RowScan is used by default.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM AuditTrails WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.

UseSimpleNames

Boolean determining if simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

SAP Fieldglass tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the connector easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.