CData Python Connector for SAP Fieldglass

Build 26.0.9655

CData Python Connector for SAP Fieldglass

Overview

The CData Python Connector for SAP Fieldglass allows developers to write Python scripts with connectivity to SAP Fieldglass. The connector wraps the complexity of accessing SAP Fieldglass data in an interface commonly used by Python connectors to common database systems.

Key Features

  • WHL installation packages that enable installation with "pip install".
  • Supported for Python 3.10 or newer on Windows, Linux, and macOS.
  • Write and execute SQL queries to fetch data in SAP Fieldglass.
  • Custom dialect class that enables SQLAlchemy 1.3 and 1.4 to use this connector.

Getting Started

See Getting Started to install the connector to your Python distribution and to create a basic connection to SAP Fieldglass.

Using the Python Connector/Using from Tools

See Using the Connector for examples of executing basic SELECT, INSERT, UPDATE, DELETE, and EXECUTE queries with the module's provided classes.

See Using from Tools to connect SAP Fieldglass data to tools such as Pandas or Petl.

SQLAlchemy ORM

SQLAlchemy can be leveraged to model the tables in SAP Fieldglass with mapped classes. See From SQLAlchemy for instructions for configuring the Python connector with SQLAlchemy.

Pandas

Pandas' DataFrames can be used alongside the connector to generate analytical graphics. See From Pandas for a guide.

Schema Discovery

See Schema Discovery to query the provided system tables, which allows users to discover the available tables, views, and stored procedure, alongside additional information about their columns or parameters.

Advanced Features

Advanced Features details additional features supported by the connector, such as defining user defined views, ssl configuration, remoting, caching, firewall/proxy settings, and advanced logging.

SQL Compliance

See SQL Compliance for a syntax reference and code examples outlining the supported SQL.

Data Model

See Data Model for the available database objects. This section also provides more detailed information on querying specific SAP Fieldglass entities.

Connection String Options

The Connection properties describe the various options that can be used to establish a connection.

CData Python Connector for SAP Fieldglass

Getting Started

Connecting to SAP Fieldglass

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for SAP Fieldglass can be installed and used in Python 3.10 or newer.

SAP Fieldglass Version Support

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

See Also

  • Using the Connector: Establish connections and query SAP Fieldglass through Python code.
  • From SQLAlchemy: Use SQLAlchemy to establish a connection with dialect URL, and interact with SAP Fieldglass data using mapped classes and Sessions.

CData Python Connector for SAP Fieldglass

Package Installation

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for SAP Fieldglass is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_sapfieldglass_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_sapfieldglass_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_sapfieldglass_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_sapfieldglass_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_sapfieldglass" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

  • Windows:
    ./install-license.exe <key>
  • Linux / Mac:
    ./install-license.sh <key>

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_sapfieldglass folder is trivial to find:

import os
import cdata.sapfieldglass
path = os.path.abspath(cdata.sapfieldglass.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-sapfieldglass-connector

CData Python Connector for SAP Fieldglass

Establishing a Connection

The objects available within our connector are accessible from the "cdata.sapfieldglass" module. To use the module's objects directly:

  1. Import the module as follows:
    import cdata.sapfieldglass as mod
  2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
    mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

Obtaining Your Credentials

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

Connecting to SAP Fieldglass

To authenticate to production environments, specify the following:

  • APIKey: Your SAP Fieldglass API Key. This is optional, but if you encounter an error from SAP Fieldglass indicating that an API Key is required, you can request one from SAP Fieldglass administration or log in to the SAP Fieldglass Integration Tools and click Create API Application.
  • 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.

CData Python Connector for SAP Fieldglass

Configuring JNI

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the SAP Fieldglass python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

  • For Linux:
    [sapfieldglass.cpython-311-x86_64-linux-gnu.so]
  • For Mac:
    [sapfieldglass.cpython-311-darwin.so]

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

  • LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
  • JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
  • CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

  • CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
  • CDATA_JVM_OPTIONS: Place JVM options here.
  • CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]

    • SCHEME: The options are STDOUT, FILE.
      • STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
      • FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
    • TAG
      • For STDOUT, set this to 1. For FILE, set this to the filename.
    • LEVEL
      • Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

  • STDOUT://1|DEBUG
  • FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

  1. Call setCustomLoggerFactory() with your factory function before opening connections.
  2. Set Logfile to CUSTOM:// followed by a context string to identify the connection.
  3. Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.sapfieldglass as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

CData Python Connector for SAP Fieldglass

Changelog

General Changes

DateVersionSourceCategoryTypeDescription
2026-05-2726.0.9643GeneralConnectionRemoved
  • Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-2226.0.9638PythonRemoved
  • Remove support for Intel x64 architecture on macOS
2026-05-0726.0.9623GeneralData ModelAdded
  • Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-0726.0.9623PythonChanged
  • Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-1526.0.9601GeneralQuery ExecChanged
  • String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-0126.0.9587SAP FieldglassRemoved
  • Removed the BatchSize connection property.
2026-01-1325.0.9509GeneralAdded
  • Added support for the REGEXP_REPLACE() string function.
2025-12-2125.0.9486PythonAdded
  • Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-0525.0.9470GeneralAdded
  • Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-10-3025.0.9434PythonChanged
  • Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-0625.0.9410GeneralAdded
  • Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-1225.0.9386GeneralAdded
  • Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-1025.0.9384GeneralChanged
  • All columns in statically defined Views are now reported as read-only.
2025-09-0325.0.9377GeneralChanged
  • Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-0125.0.9375GeneralAdded
  • Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-2125.0.9364GeneralChanged
  • Report behavior change:
    • Fixed inconsistent string value comparisons in non-table queries.
    • For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-1325.0.9356GeneralChanged
  • Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-07-0725.0.9319PythonRemoved
  • Removed the 32-bit version of Windows Python.
2025-07-0225.0.9314PythonRemoved
  • Removed support for Python 3.9.
2025-06-2525.0.9307GeneralRemoved
  • Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-2525.0.9307PythonAdded
  • Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-2525.0.9307PythonRemoved
  • Removed support for Python 3.8 as it is no longer supported.
2025-06-2025.0.9302GeneralAdded
  • Created the following functions:
    • TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result).
    • TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset.
    • BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar).
    • BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-1825.0.9300GeneralChanged
  • The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-2725.0.9278GeneralRemoved
  • Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-1225.0.9263PythonChanged
  • Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-02-1524.0.9177GeneralAdded
  • Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-11-2724.0.9097GeneralAdded
  • Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-06-0524.0.8922PythonAdded
  • Added support for Python 3.12.
2024-05-0924.0.8895GeneralChanged
  • The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-1523.0.8840GeneralAdded
  • Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2023-11-2923.0.8733GeneralChanged
  • The ROUND function doesn't accept the negative precision values anymore.
2023-11-2923.0.8733GeneralChanged
  • The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date.
  • The return type of the ABS function will be consistent with the parameter value type.
2023-11-2823.0.8732GeneralAdded
  • Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-08-2923.0.8641PythonAdded
  • Added support for SQLAlchemy 2.0.
2023-06-2123.0.8572SAP FieldglassAdded
  • SAP Fieldglass Connectors are now exposed as views and internally use the default connector names. 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. Set the IncludeCustomFields property to true to list custom fields or fields that are not part of the current schemas.
2023-06-2023.0.8571GeneralAdded
  • Added the new sys_lastresultinfo system table.
2023-06-1423.0.8565SAP FieldglassRemoved
  • Removed the User and Password connection properties.
2023-06-1423.0.8565SAP FieldglassReplacements
  • They are replaced by OAuthClientId and OAuthClientSecret to follow the OAuth 2.0 standard which is utilized by SAP Fieldglass.
2023-05-1923.0.8539PythonAdded
  • Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-1623.0.8536PythonRemoved
  • Removed support for Python 3.7 on Windows and Linux
2023-04-2523.0.8515GeneralRemoved
  • Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2022-12-1422.0.8383GeneralChanged
  • Added the Default column to the sys_procedureparameters table.
2022-11-1522.0.8354PythonChanged
  • Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-09-3022.0.8308GeneralChanged
  • Added the IsPath column to the sys_procedureparameters table.
2022-05-1822.0.8173PythonAdded
  • Added support for Python 3.10 on Windows, Linux, and Mac
  • Added support for Python 3.9 on Mac
  • Added support for Mac M1
2022-05-1822.0.8173PythonRemoved
  • Removed support for Python 3.6 on Windows and Linux
2021-09-0221.0.7915GeneralAdded
  • Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-0721.0.7889GeneralChanged
  • Added the KeySeq column to the sys_foreignkeys table.
2021-08-0621.0.7888GeneralChanged
  • Added the new sys_primarykeys system table.
2021-07-2321.0.7874GeneralChanged
  • Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match.
  • As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-04-2321.0.7783GeneralChanged
  • Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-1621.0.7776GeneralChanged
  • Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-1621.0.7776GeneralChanged
  • Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-1621.0.7776GeneralChanged
  • Updated index naming convention to avoid duplicates.

CData Python Connector for SAP Fieldglass

Using the Connector

This section provides a walk-through for writing SAP Fieldglass data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to SAP Fieldglass, see Package Installation and Establishing a Connection.

For information on how to connect with the sapfieldglass.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data.

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

CData Python Connector for SAP Fieldglass

Connecting

Connecting with the cdata.sapfieldglass Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:
import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

Once the connection is created, you can use it to execute subsequent SQL queries.

CData Python Connector for SAP Fieldglass

Querying Data

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT Id, Category FROM AuditTrails")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT Id, Category FROM AuditTrails WHERE Company = ?"
params = ["CData"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for SAP Fieldglass

Calling Stored Procedures

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:
cmd = "EXECUTE SampleProcedure Id = ?"
params = ["7"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:
cur = conn.cursor()
params = ["7"]
cur.callproc("SampleProcedure", params)

CData Python Connector for SAP Fieldglass

Using from Tools

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

Complete List of SAP Fieldglass Integration Quickstarts

For information on connecting from other applications, see SAP Fieldglass integration guides.

CData Python Connector for SAP Fieldglass

From SQLAlchemy

The CData Python Connector for SAP Fieldglass includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model SAP Fieldglass tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

CData Python Connector for SAP Fieldglass

Connecting

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format. For this connector, you can create the engine using either of the following URL formats:

Format 1


from sqlalchemy import create_engine
engine = create_engine("sapfieldglass:///?EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

Format 2


from sqlalchemy import create_engine
engine = create_engine("sapfieldglass://OAuthClientId:OAuthClientSecret@/?APIKey=xxxxxxxx-xxxx-xxxx-xxxx;EnvironmentURL=https://myinstance.com;")

For SQLAlchemy 2.0, the dialect name is sapfieldglass_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("sapfieldglass_2:///?EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

CData Python Connector for SAP Fieldglass

Reflecting Metadata

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class AuditTrails(Base):
	__tablename__ = "AuditTrails"
	Id = Column(String, primary_key=True)
	Id = Column(String)
	Category = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:
from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
AuditTrails = abase.classes.AuditTrails

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
AuditTrails_table = Table("AuditTrails", meta)
insp.reflect_table(AuditTrails_table, ["Id","Category"])

CData Python Connector for SAP Fieldglass

Querying Data

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("sapfieldglass:///?EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AuditTrails).filter_by(Company="CData"):
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Category: ", instance.Category)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:
AuditTrails_table = AuditTrails.metadata.tables["AuditTrails"]
for instance in session.execute(AuditTrails_table.select().where(AuditTrails_table.c.Company == "CData")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

CData Python Connector for SAP Fieldglass

Executing JOINs

Implicit Joining

If mapped classes of related SAP Fieldglass objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:
  • Explicit condition (necessary if there are no foreign keys in your mapped classes):
    rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
    for Ac, Ct in rs:
  • Left-to-right relationship:
    rs = session.query(Account, Contact).join(Account.Contact_Link)
    for Ac, Ct in rs:
  • Left-to-right relationship with explicit target:
    rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
    for Ac, Ct in rs:
  • String form of a left-to-right relationship:
    rs = session.query(Account, Contact).join("Contact_Link")
    for Ac, Ct in rs:

CData Python Connector for SAP Fieldglass

Other SQL Clauses

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:
rs = session.query(AuditTrails).order_by(AuditTrails.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Category: ", instance.Category)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(AuditTrails_table.select().order_by(AuditTrails_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:
rs = session.query(func.count(AuditTrails.Id).label("CustomCount"), AuditTrails.Id).group_by(AuditTrails.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(AuditTrails_table.select().with_only_columns([func.count(AuditTrails_table.c.Id).label("CustomCount"), AuditTrails_table.c.Id]).group_by(AuditTrails_table.c.Id))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:
rs = session.query(AuditTrails).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("Category: ", instance.Category)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(AuditTrails_table.select().limit(25).offset(100))
for instance in rs:

CData Python Connector for SAP Fieldglass

Aggregate Functions

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.
rs = session.query(func.count(AuditTrails.Id).label("CustomCount"), AuditTrails.Id).group_by(AuditTrails.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(AuditTrails_table.select().with_only_columns([func.count(AuditTrails_table.c.Id).label("CustomCount"), AuditTrails_table.c.Id])group_by(AuditTrails_table.c.Id))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(AuditTrails.AnnualRevenue).label("CustomSum"), AuditTrails.Id).group_by(AuditTrails.Id)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("Id: ", instance.Id)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(AuditTrails_table.select().with_only_columns([func.sum(AuditTrails_table.c.AnnualRevenue).label("CustomSum"), AuditTrails_table.c.Id]).group_by(AuditTrails_table.c.Id))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:
rs = session.query(func.avg(AuditTrails.AnnualRevenue).label("CustomAvg"), AuditTrails.Id).group_by(AuditTrails.Id)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(AuditTrails_table.select().with_only_columns([func.avg(AuditTrails_table.c.AnnualRevenue).label("CustomAvg"), AuditTrails_table.c.Id]).group_by(AuditTrails_table.c.Id))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.
rs = session.query(func.max(AuditTrails.AnnualRevenue).label("CustomMax"), func.min(AuditTrails.AnnualRevenue).label("CustomMin"), AuditTrails.Id).group_by(AuditTrails.Id)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(AuditTrails_table.select().with_only_columns([func.max(AuditTrails_table.c.AnnualRevenue).label("CustomMax"), func.min(AuditTrails_table.c.AnnualRevenue).label("CustomMin"), AuditTrails_table.c.Id]).group_by(AuditTrails_table.c.Id))
for instance in rs:

CData Python Connector for SAP Fieldglass

From Pandas

When combined with the connector, Pandas can be used to generate data frames that contain your SAP Fieldglass data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:
import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("sapfieldglass:///?EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.
df = pd.read_sql("""
	SELECT
	   Id,
	   Category,
     $exNumericCol;
	FROM AuditTrails;""", engine)
print(df)

CData Python Connector for SAP Fieldglass

From Matplotlib

Matplotlib contains a number of tools that can graphically model SAP Fieldglass data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:
from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing SAP Fieldglass data. For example, the following plot generates and displays a bar graph relating Id and AnnualRevenue values:

df.plot(kind="bar", x="Id", y=["AnnualRevenue"])
plt.show()

CData Python Connector for SAP Fieldglass

From Petl

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.
pip install petl

Connecting

After you import the modules, including the CData Python Connector for SAP Fieldglass, you can use the connector's connect function to create a connection using a valid SAP Fieldglass connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.
import petl as etl
import cdata.sapfieldglass as mod
cnxn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")

Extract, Transform, and Load the SAP Fieldglass Data

Create a SQL query string and store the query results in a DataFrame.
sql = "SELECT	Id, Category FROM AuditTrails "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.
etl.tocsv(table1,'output.csv')

CData Python Connector for SAP Fieldglass

Schema Discovery

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

CData Python Connector for SAP Fieldglass

Tables and Views

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables


import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views


import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for SAP Fieldglass

Columns

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'AuditTrails'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for SAP Fieldglass

Procedures

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:
import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:
import cdata.sapfieldglass as mod
conn = mod.connect("EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for SAP Fieldglass

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

Configure the connector for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

CData Python Connector for SAP Fieldglass

User Defined Views

The CData Python Connector for SAP Fieldglass supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view 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.

Defining 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 so that each root element defines the name of a view, and includes 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"

Defining 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

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

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

CData Python Connector for SAP Fieldglass

SSL Configuration

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Python Connector for SAP Fieldglass

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

CData Python Connector for SAP Fieldglass

Caching Data

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Contents

The sections in this chapter detail the connector's caching functionality and link to the corresponding connection properties, as well as SQL statements.

Configuring the Cache Connection

Configuring the Cache Connection describes the properties that you can set when configuring the cache database.

Caching Metadata

Caching Metadata describes the CacheMetadata property. This property determines whether or not to cache the table metadata to a file store.

Automatically Caching Data

Automatically Caching Data describes how the connector automatically refreshes the cache when the AutoCache property is set.

Explicitly Caching Data

Explicitly Caching Data describes how you can decide what data is stored in the cache and when it is updated.

Data Type Mapping

Data Type Mapping shows the mappings between the data types configured in the schema and the data types in the database.

CData Python Connector for SAP Fieldglass

Configuring the Cache Connection

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

CData Python Connector for SAP Fieldglass

Caching Metadata

This section describes how to enable caching metadata and how to update the metadata cache.

Before being able to query data, the connector requires relevant metadata to be retrieved. By default, metadata is cached in memory and shared across connections. But if you want to persist across processes, or if metadata requests are expensive, the solution is to cache the metadata to disk.

Enable Caching Metadata

To enable caching of metadata, set CacheMetadata = true and see Configuring the Cache Connection for instructions on how to configure your connection string. The connector caches the metadata the first time it is needed and uses the metadata cache for subsequent requests.

Update the Metadata Cache

Because metadata is cached, changes to metadata on the live source, for example, adding or removing a column or attribute, are not automatically reflected in the metadata cache. To get updates to the live metadata, you need to delete or drop the cached data.

CData Python Connector for SAP Fieldglass

Automatically Caching Data

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

Configuring Automatic Caching

Caching the AuditTrails Table

The following example caches the AuditTrails table in the file specified by the CacheLocation property of the connection string.

SELECT Id, Category FROM AuditTrails WHERE Company = 'CData'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

CData Python Connector for SAP Fieldglass

Explicitly Caching Data

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM AuditTrails WHERE Company = 'CData'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM AuditTrails WHERE Company = 'CData'
  

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM AuditTrails#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM AuditTrails WHERE Company='CData' ORDER BY Category ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

  • AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
  • Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

CData Python Connector for SAP Fieldglass

Data Type Mapping

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.

Schema .NET JDBC SQL Server Derby MySQL Oracle SQLite Access
int, integer, int32 Int32 int int INTEGER INT NUMBER integer LONG
smallint, short, int16 Int16 short smallint SMALLINT SMALLINT NUMBER integer SHORT
double, float, real Double double float DOUBLE DOUBLE NUMBER double DOUBLE
date DateTime java.sql.Date date DATE DATE DATE date DATETIME
datetime, timestamp DateTime java.sql.Date datetime TIMESTAMP DATETIME TIMESTAMP datetime DATETIME
time, timespan TimeSpan java.sql.Time time TIME TIME TIMESTAMP datetime DATETIME
string, varchar String java.lang.String If length > 4000: nvarchar(max), Otherwise: nvarchar(length)If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)If length > 255: LONGTEXT, Otherwise: VARCHAR(length)If length > 4000: CLOB, Otherwise: VARCHAR2(length)nvarchar(length)If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint Int64 long bigint BIGINT BIGINT NUMBER bigint LONG
boolean, bool Boolean boolean tinyint SMALLINT BIT NUMBER tinyint BIT
decimal, numeric Decimal java.math.BigDecimal decimal DECIMAL DECIMAL DECIMAL decimal CURRENCY
uuid Guid java.util.UUID nvarchar(length) VARCHAR(length)VARCHAR(length) VARCHAR2(length)nvarchar(length) VARCHAR(length)
binary, varbinary, longvarbinary byte[] byte[] binary(1000) or varbinary(max) after SQL Server 2000, image otherwise BLOB LONGBLOB BLOB BLOB LONGBINARY

CData Python Connector for SAP Fieldglass

Query Processing

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to SAP Fieldglass and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The SAP Fieldglass Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The SAP Fieldglass Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

CData Python Connector for SAP Fieldglass

Logging

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

  • Logfile: A filepath that designates the name and location of the log file.
  • Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
  • MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
  • MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:

1Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

  • Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
  • Verbosity 4: SSL certificates
  • Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files.
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules.
DEMN Messages related to SQL remoting.
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module.
TRANCE Advanced messages concerning low-level product operations.

CData Python Connector for SAP Fieldglass

Exception Handling

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for SAP Fieldglass. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.

0 NONE Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537 TCP_UNKNOWN_HOST Unable to resolve a hostname (DNS failure).
65538 TCP_CONNECTION_REFUSED Could not connect to the remote port.
65539 TCP_AUTH_FAILED Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540 TCP_TIMEOUT Did not receive a response after sending a request to the server.
65541 TCP_PROTOCOL For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073 TLS_SERVER_UNTRUSTED Could not verify SSL server certificate.
131074 TLS_CLIENT_UNTRUSTED Server did not accept the client certificate we sent.
196609 OAUTH_DECRYPT_FAILED OAuthEncryptKey did not decrypt the OAuthSettings file.
196610 OAUTH_MISSING_CLIENT_INFO OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611 OAUTH_MISSING_PROP General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612 OAUTH_NO_ACCESS_TOKEN Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613 OAUTH_TOKEN_EXPIRED The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614 OAUTH_INVALID_PROP OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145 HTTP_REQUEST_TIMEOUT Did not receive a response from the HTTP server.
262146 HTTP_CLIENT_ERROR Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147 HTTP_AUTH_FAILED HTTP 401 error.
262148 HTTP_LIMIT_EXCEEDED HTTP 429 error.
262149 HTTP_SERVER_ERROR HTTP 5xx error.
262150 HTTP_NOT_FOUND_ERROR HTTP 404 error.
327681 CORE_TIMEOUT General timeout. Not related to a specific network request.
327682 CORE_OP_NOT_ALLOWED Operation blocked by provider permissions.
327683 CORE_CONNECTION_CONFIG Connection configuration is not valid.
327684 CORE_SERIALIZE Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685 CORE_DESERIALIZE Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217 SQL_SYNTAX_ERROR Unable to parse a SQL query.
393218 SQL_MISSING_COLUMNS Query did not include required columns.
393219 SQL_MISSING_PARAMS Stored procedure call did not include required parameters.
393220 SQL_QUERY_NOT_SUPPORTED A part of the query is not allowed in the current context.
458753 SSH_SERVER_UNTRUSTED Could not verify SSH server.
524289 STORAGE_LIST_EXCEPTION Issue listing storage resources.
524290 STORAGE_RESOURCE_NOT_FOUND Issue finding storage resources.
524291 STORAGE_ROOT_RESOURCE_NOT_FOUND The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292 STORAGE_RESOURCE_NOT_A_DIRECTORY Storage resource is not a directory.
524293 STORAGE_RESOURCE_NOT_A_FILE Storage resource is not a file.
524294 STORAGE_PERMISSIONS_DENIED Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:

07007 REQUIRED_CLAUSE Class Code 07: Dynamic SQL Error.
08001 OPEN_CONNECTION Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004 REJECT_CONNECTION The application server rejected establishment of the connection.
42501 PRIVILEGE_IDENTIFIED_OBJECT Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506 AUTH_FAILED Owner authorization failure occurred.
42601 SQL_SYNTAX A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

CData Python Connector for SAP Fieldglass

SQL Compliance

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the SAP Fieldglass API.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

  • Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
  • To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
  • Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
  • Strings must be quoted using single quotes (e.g., 'John Doe').

CData Python Connector for SAP Fieldglass

SQL Functions

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

  • SQL Server:
    SELECT DATENAME(yy,GETDATE())
  • connector:
    SELECT DATENAME('yy',GETDATE())

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

CData Python Connector for SAP Fieldglass

STRING Functions

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

  • character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48
                    

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

  • input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='
                    

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

  • input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)
                    

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

  • integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'
                    

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

  • expressionToFind: The character expression to find.
  • expressionToSearch: The character expression, typically a column, to search.
  • start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1
                    

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

  • character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11			
				

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

  • string_value1: The first string to be concatenated.
  • string_value2: The second string to be concatenated.
  • string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'
                    

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

  • expressionToSearch: The character expression, typically a column, to search.
  • expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0
                    

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

  • character_expression: The character expression.
  • character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0
                    

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

  • uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684
				

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

  • value: The string to format.
  • format: The string specifying the output syntax of the date or numeric format.
  • parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'
                    

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

  • algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
  • value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
                    

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

  • expressionToSearch: The character expression, typically a column, to search.
  • expressionToFind: The character expression to find.
  • start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1
                    

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0
                    

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0
                    

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0
                    

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to extract.
  • jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2
                    

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

  • character_expression: The character expression.
  • integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'
                    

LEN(string_expression)

Returns the number of characters of the specified string expression.

  • string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5
                    

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

  • substring: The substring to find inside larger string.
  • string: The larger string that is searched for the substring.
  • start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0
				

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

  • character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'
                    

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

  • character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'
                    

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

  • string_expression: The string expression to be searched.
  • mask_character: The character to mask with.
  • start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
  • end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'  
                    

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

  • integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

  • character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4
				

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

  • pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
  • expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4
                    

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

  • expressionToFind: The character expression to find.
  • expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0
                    

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

  • character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
  • quote_character: An optional single character to be used as the delimiter. These include:
    • a single quotation mark (')
    • a left or right bracket ([])
    • a double quotation mark (")
    • a left or right parenthesis ( () )
    • a greater or less than sign (><)
    • a left or right brace ({})
    • a backtick (`)

    If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.


                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'
                    

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

  • expr: The string expression to be searched.
  • pattern: The regular expression pattern to match.
  • replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
  • position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
  • occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
  • match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'
                    

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

  • string_expression: The string expression to be searched. This can be a character or binary data type.
  • string_pattern: The substring to be found. Cannot be an empty string.
  • string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'
                    

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

  • string_expression: The string to replicate.
  • integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'
                    

REVERSE ( string_expression )

Returns the reverse order of the string expression.

  • string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'
                    

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

  • character_expression: The character expression.
  • integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'
                    

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

  • character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'
                    

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

  • character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'
                    

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

  • repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '
                    

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

  • string: The string to split.
  • delimiter: The character to split the string with.
  • offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'
                    

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

  • character_expression: The character expression.
  • character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0
                    

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

  • float_expression: The float expression.
  • length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
  • decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'
                    

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

  • character_expression: The string expression.
  • start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
  • length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
  • replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'
                    

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

  • string_value: The character string.
  • start: The positive integer that specifies the start index of characters to return.
  • length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'
                    
You can also drop the FROM and FOR clauses:
                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'
                    

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

  • input_string: The plain text string.
  • charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)
                    

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

  • input_binary: The binary value to decode.
  • charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'
                    

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

  • string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''
                    

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

  • trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
  • trimchar: Optional. If included should be a one-character string value.
  • string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'
                    

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

  • ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

  • character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'
                    

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

  • xml: The XML document to extract.
  • xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
  • separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'
                    

CData Python Connector for SAP Fieldglass

MATH Functions

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15
                    

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

  • float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966
                    

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

  • float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299
                    

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

  • float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373
                    

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

  • float_expression1: The float expression that is the y-coordinate.
  • float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448
                    

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2
                    

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

  • float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814
                    

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

  • float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331
                    

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

  • numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531
                    

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

  • float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065
                    

EXPR ( expression )

Evaluates the expression.

  • expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true
                    

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1
                    

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10			
				

HEX(value)

Returns a the equivalent hex for the input value.

  • value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874
				

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5
                    

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2
                    

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4
                    

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4
                    

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9
                    

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1			
				

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

  • float_expression: The float expression.
  • base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119
                    

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

  • float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4
                    

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

  • dividend: The number to take the modulus of.
  • divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1
				

NEGATE(real_number)

Returns the opposite to the real number input.

  • real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4
				

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979 
                

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

  • float_expression: The float expression.
  • y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25
                    

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

  • float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979
                    

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

  • seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093
                    

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

  • numeric_expression: The expression of a numeric data type.
  • length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
  • function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0
                    

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

  • numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1
                    

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

  • float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897
                    

SQRT ( float_expression )

Returns the square root of the specified float value.

  • float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10
                    

SQUARE ( float_expression )

Returns the square of the specified float value.

  • float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100
                    

TAN ( float_expression )

Returns the tangent of the input expression.

  • float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549
                    

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

  • decimal_number: The decimal value to truncate.
  • precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34
				

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2
				

CData Python Connector for SAP Fieldglass

DATE Functions

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01
                

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05
                

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

  • datepart: The part of the date to add the specified number to. The valid values and abbreviations are
    • year (yy, yyyy)
    • quarter (qq, q)
    • month (mm, m)
    • week (wk, ww)
    • weekday (dw)
    • dayofyear (dy, y)
    • day (dd, d)
    • hour (hh)
    • minute (mi, n)
    • second (ss, s)
    • millisecond (ms)
  • number: The number to be added.
  • date: The expression of the datetime data type.
  • dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00
                

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

  • datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
    • Year (year, yyyy, yy)
    • Quarter (quarter, qq, q)
    • Month (month, mm, m)
    • Week (week, wk, ww)
    • Weekday (weekday, dw)
    • Dayofyear (dayofyear, dy, y)
    • Day (day, dd, d)
    • Hour (hour, hh)
    • Minute (minute, mi, n)
    • Second (second, ss, s)
    • Millisecond (millisecond, ms)
  • startdate: The datetime expression of the start date.
  • enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12
                

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

  • date: A date or timestamp string.
  • format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03
				  

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01
                  

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

  • datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
  • date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'
                   

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

  • datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
  • date: The datetime string.
  • datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5
                  

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • fractions: The integer expression specifying the fractions of the second.
  • precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

  • date: The datetime string that specifies the date.
  • datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'                    
                  

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

  • datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
  • date: The datetime string that specifies the date.
  • weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday
                  

DAY(date)

Returns the integer that specifies the day component of the specified date.

  • date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1
                  

DAYNAME(date)

Returns the name of the day of the week of the specified date.

  • date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday
                  

DAYOFMONTH(date)

Returns the day of the month of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15
				  

DAYOFWEEK(date)

Returns the day of the week of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7
				  

DAYOFYEAR(date)

Returns the day of the year of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106
				  

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

  • date: The datetime expression specifying the date for which to return the last day of the month.
  • integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30
                

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

  • date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
  • date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021
                

FDWEEK(date)

Returns the first day of the week of the given date part.
  • date: The datetime string that specifies the date.
  • weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018
				  

FDMONTH(date)

Returns the first day of the month of the given date part.
  • date: The datetime string that specifies the date.
  • month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018
				  

FDQUARTER(date)

Returns the first day of the quarter of the given date part.
  • date: The datetime string that specifies the date.
  • quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018
				  

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

  • uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM
				 

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

  • datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015
				

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

  • time: The time stamp value from epoch time. Milliseconds are accepted.
  • issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37
                    

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05
                

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'
                

HOUR(date)

Returns the hour component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11
				

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

  • date: The datetime string.
  • date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0
                    

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00
				

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00
				

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00
				

LDWEEK(date)

Returns the last day of the provided week.

  • date: The datetime string.
  • weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020
				

LDMONTH(date)

Returns the last day of the provided month.

  • date: The datetime string.
  • months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020
				

LDQUARTER(date)

Returns the last day of the provided quarter.

  • date: The datetime string.
  • quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020
				

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

  • year: The year
  • days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01
        

MINUTE(date)

Returns the minute component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15
				

MONTH(date)

Returns the month component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2
				

QUARTER(date)

Returns the quarter associated with the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1
				

SECOND(date)

Returns the second component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23
				

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00
                    

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

  • string: The string value to be converted to datetime format.
  • format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020
				

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05
                

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05
                

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • fractions: The integer expression specifying the fractions of the second.
  • precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456
                    

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

  • date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000
				

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8
				

YEAR(date)

Returns the integer that specifies the year of the specified date.

  • date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018
                    

CData Python Connector for SAP Fieldglass

Date Literal Functions

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()
Also available:
  • L_LAST/L_THIS/L_NEXT MONTH
  • L_LAST/L_THIS/L_NEXT QUARTER
  • L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)
Also available:
  • L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)
Also available:
  • L_LAST/L_NEXT_N_MONTHS(n)
  • L_LAST/L_NEXT_N_QUARTERS(n)
  • L_LAST/L_NEXT_N_YEARS(n)

CData Python Connector for SAP Fieldglass

SELECT Statements

A SELECT statement can consist of the following basic clauses.

  • SELECT
  • INTO
  • FROM
  • JOIN
  • WHERE
  • GROUP BY
  • HAVING
  • UNION
  • ORDER BY
  • LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
}

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ] 

Examples

  1. Return all columns:
    SELECT * FROM AuditTrails
  2. Rename a column:
    SELECT [Category] AS MY_Category FROM AuditTrails
  3. Cast a column's data as a different data type:
    SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM AuditTrails
  4. Search data:
    SELECT * FROM AuditTrails WHERE Company = 'CData'
  5. Return the number of items matching the query criteria:
    SELECT COUNT(*) AS MyCount FROM AuditTrails 
  6. Return the number of unique items matching the query criteria:
    SELECT COUNT(DISTINCT Category) FROM AuditTrails 
  7. Return the unique items matching the query criteria:
    SELECT DISTINCT Category FROM AuditTrails 
  8. Sort a result set in ascending order:
    SELECT Id, Category FROM AuditTrails  ORDER BY Category ASC
  9. Restrict a result set to the specified number of rows:
    SELECT Id, Category FROM AuditTrails LIMIT 10 
  10. Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
    SELECT * FROM AuditTrails WHERE Company = @param
See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from SAP Fieldglass.

    SELECT * FROM AuditTrails WHERE Query = 'PassportComponentType > 100'
    

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

CData Python Connector for SAP Fieldglass

Aggregate Functions

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM AuditTrails WHERE Company = 'CData'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT Id) AS DistinctValues FROM AuditTrails WHERE Company = 'CData'

AVG

Returns the average of the column values.

SELECT Category, AVG(AnnualRevenue) FROM AuditTrails WHERE Company = 'CData'  GROUP BY Category

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), Category FROM AuditTrails WHERE Company = 'CData' GROUP BY Category

MAX

Returns the maximum column value.

SELECT Category, MAX(AnnualRevenue) FROM AuditTrails WHERE Company = 'CData' GROUP BY Category

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM AuditTrails WHERE Company = 'CData'

CData Python Connector for SAP Fieldglass

JOIN Queries

The CData Python Connector for SAP Fieldglass supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT Customers.ContactName, Orders.OrderDate FROM Customers, Orders WHERE Customers.CustomerId=Orders.CustomerId

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

SELECT Customers.ContactName, Orders.OrderDate FROM Customers LEFT OUTER JOIN Orders ON Customers.CustomerId=Orders.CustomerId

CData Python Connector for SAP Fieldglass

Window Functions

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From AuditTrails

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT Id, Category, RANK() OVER (ORDER BY Category) AS Rank FROM AuditTrails

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, Category, RANK() OVER (PARTITION BY Id ORDER BY Category) AS Rank FROM AuditTrails

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT Id, Category, DENSE_RANK() OVER (PARTITION BY Id ORDER BY Category) AS Rank FROM AuditTrails

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, Category, DENSE_RANK() OVER (PARTITION BY Id ORDER BY Category) AS Rank FROM AuditTrails

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees
If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.
SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)
The following are paramaters that NTILE() supports:

  • buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
  • PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
  • ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;
This statement uses the NTILE() function to divide ten rows into three groups:
SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )
  
This syntax uses the following parameters.

  • PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
  • ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

CData Python Connector for SAP Fieldglass

Table-Valued Functions

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.
SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

  • input_text: A column whose value you want to parse.
  • delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three
To unpack this value across multiple records:
SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

  • json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
    • The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
  • jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

  • xml_content: A column containing an XML structure.
  • xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
    • When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
    • When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
  • child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
    • You can supply the following values:
      • 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
      • 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
      • 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
    • When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:
<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

  • csv_content: A column containing a CSV table.
  • delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

CData Python Connector for SAP Fieldglass

CACHE Statements

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement> 

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM AuditTrails

Use the following cache statement to cache all rows of a table into the cache table CachedAuditTrails:

CACHE CachedAuditTrails SELECT * FROM AuditTrails

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedAuditTrails SELECT * FROM AuditTrails WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only Id and Category even though the cache table CachedAuditTrails has all the columns in AuditTrails.

CACHE CachedAuditTrails SCHEMA ONLY SELECT * FROM AuditTrails
CACHE CachedAuditTrails SELECT Id, Category FROM AuditTrails

CData Python Connector for SAP Fieldglass

EXECUTE Statements

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3; 

CData Python Connector for SAP Fieldglass

PIVOT and UNPIVOT

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.
PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.
UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

CData Python Connector for SAP Fieldglass

Data Model

The CData Python Connector for SAP Fieldglass 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.

CData Python Connector for SAP Fieldglass

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]

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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 (~).

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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 more granular control over the data 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass Stored Procedures

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

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.
IsInsertable Boolean Whether the table can be inserted into.
IsDeleteable Boolean Whether rows can be deleted from the table.

CData Python Connector for SAP Fieldglass

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.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities Int32 A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

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.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric 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.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native SAP Fieldglass procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

sys_connection_props

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

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.

CData Python Connector for SAP Fieldglass

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

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.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Python Connector for SAP Fieldglass

Connection String Options

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
EnvironmentURLThe Environment URL where the instance of SAP Fieldglass is located.
APIKeyThe API Key used to authenticate to SAP Fieldglass.

OAuth


PropertyDescription
InitiateOAuthSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocationSpecifies the location of the settings file where OAuth values are saved.
OAuthExpiresInSpecifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestampDisplays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogfileSpecifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCountSpecifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Caching


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProviderThe namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriverThe driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnectionSpecifies the connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceNotes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
OfflineGets the data from the specified cache database instead of live SAP Fieldglass data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.

Miscellaneous


PropertyDescription
ConnectorDataFormatThe download data format configured during the Connector setup.
ConnectorNamesSpecify a comma-separated list of custom Connector names to list as tables.
IncludeCustomFieldsA boolean indicating if you would like to include custom fields in the column listing.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSets the method for determining the data type of columns.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
CData Python Connector for SAP Fieldglass

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
EnvironmentURLThe Environment URL where the instance of SAP Fieldglass is located.
APIKeyThe API Key used to authenticate to SAP Fieldglass.
CData Python Connector for 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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
InitiateOAuthSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocationSpecifies the location of the settings file where OAuth values are saved.
OAuthExpiresInSpecifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestampDisplays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
CData Python Connector for SAP Fieldglass

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

"OFF"

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:

  • Logging in users.
  • Exchanging user credentials for an OAuth access token to be used for authentication.
  • Providing limited access to applications.

The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:

OFF The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user.
This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires.
GETANDREFRESH The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login.
REFRESH The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token.

For more information on how to set up OAuth and use this property when configuring a connection, see Establishing a Connection.

CData Python Connector for SAP Fieldglass

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the connector and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for SAP Fieldglass

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Python Connector for SAP Fieldglass

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for SAP Fieldglass

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved.

Data Type

string

Default Value

"%APPDATA%\\CData\\SAPFieldglass Data Provider\\OAuthSettings.txt"

Remarks

Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

  • Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
  • Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\\CData\\SAPFieldglass Data Provider\\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory. Default values vary, depending on the user's operating system.

  • Windows (ODBC and Power BI): registry://%DSN%
  • Windows: %APPDATA%CDataSAPFieldglass Data Provider\OAuthSettings.txt
  • Mac: %APPDATA%/CData/SAPFieldglass Data Provider/OAuthSettings.txt
  • Linux: %APPDATA%/CData/SAPFieldglass Data Provider/OAuthSettings.txt

Loading Credentials Via 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 it 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.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

  • memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
  • registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://CData Python Connector for SAP Fieldglass Data Source, or registry://%DSN%.
  • %DSN%: The name of the DSN you are connecting with.
  • Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for SAP Fieldglass

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, check OAuthTokenTimestamp.

CData Python Connector for SAP Fieldglass

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

Data Type

string

Default Value

""

Remarks

The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

CData Python Connector for SAP Fieldglass

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Python Connector for SAP Fieldglass

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Python Connector for SAP Fieldglass

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
CData Python Connector for SAP Fieldglass

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Possible Values

NONE, TUNNEL, SOCKS4, SOCKS5

Data Type

string

Default Value

"NONE"

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the connector connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the connector opens a connection to SAP Fieldglass. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the connector opens a connection to SAP Fieldglass. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the connector sends data to SAP Fieldglass. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

CData Python Connector for SAP Fieldglass

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for SAP Fieldglass

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Data Type

int

Default Value

0

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for SAP Fieldglass

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for SAP Fieldglass

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for SAP Fieldglass

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
CData Python Connector for SAP Fieldglass

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Data Type

bool

Default Value

true

Remarks

When this connection property is set to True, the connector checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the connector to connect to a specific proxy server, set ProxyAutoDetect to False.

On Windows, the connector reads the proxy settings from the Internet Options in the registry, specifically the registry key HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\. On Windows 10 and later, this corresponds to the Proxy Settings found in the Windows Settings.

Note that these settings apply only to the current user of the machine. If you're running an application as a service, the connector does not read your own user's settings. You must instead manually supply the proxy settings in the connector's connection properties.

On Mac, the connector reads proxy settings from the system-configured CFNetwork settings.

On Linux, this property is unsupported, and is set to False by default.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

CData Python Connector for SAP Fieldglass

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Data Type

string

Default Value

""

Remarks

The connector only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server specified in your system proxy settings.

CData Python Connector for SAP Fieldglass

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Data Type

int

Default Value

80

Remarks

The connector only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

CData Python Connector for SAP Fieldglass

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Possible Values

BASIC, DIGEST, NONE, NEGOTIATE, NTLM

Data Type

string

Default Value

"BASIC"

Remarks

Note: The connector only uses this ProxyAuthScheme when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the authentication method specified in your system proxy settings.

Supported authentication types :

  • BASIC: The connector performs HTTP basic authentication.
  • DIGEST: The connector performs HTTP digest authentication.
  • NTLM: The connector retrieves an NTLM token.
  • NEGOTIATE: The connector retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

CData Python Connector for SAP Fieldglass

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The username of a user registered with the proxy server.
DIGEST The username of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

Note: The connector only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the username specified in your system proxy settings.

CData Python Connector for SAP Fieldglass

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The connector only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the password specified in your system proxy settings.

CData Python Connector for SAP Fieldglass

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Possible Values

AUTO, ALWAYS, NEVER, TUNNEL

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the connector uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

CData Python Connector for SAP Fieldglass

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

CData Python Connector for SAP Fieldglass

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogfileSpecifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCountSpecifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.
CData Python Connector for SAP Fieldglass

Logfile

Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.

Data Type

string

Default Value

""

Remarks

This property specifies the location and name of the log file where the connector records its operations, including authentication events, query execution, and connection details. If the specified file does not exist, the connector creates it. Ensure that the user or the service running the connector has write access to the specified path or file. Without sufficient permissions, the log file is not created.

Sensitive information from the connection string, such as passwords and tokens, is automatically masked in the logs. However, sensitive information present in the data itself may not be masked.

If you specify a relative path for Logfile, and if the Location property is set, that directory is used as the base path for the log file.

Additional properties allow you to customize logging behavior:

CData Python Connector for SAP Fieldglass

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the connector includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Python Connector for SAP Fieldglass

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Data Type

string

Default Value

""

Remarks

The connector writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual connector operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the connector to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files.
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules.
DEMN Messages related to SQL remoting.
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module.
TRANCE Advanced messages concerning low-level product operations.

CData Python Connector for SAP Fieldglass

MaxLogFileSize

Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.

Data Type

string

Default Value

"100MB"

Remarks

For values lower than 100 KB, the connector uses 100 KB as the minimum allowable size.

To control the total number of log files retained, use the MaxLogFileCount property in conjunction with this property. Together, these properties allow you to manage the size and retention of log files effectively.

CData Python Connector for SAP Fieldglass

MaxLogFileCount

Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Data Type

int

Default Value

-1

Remarks

Each log file name includes the date and time for easier identification.

This property accepts the following values:

  • A value of 2 or higher sets the maximum number of log files retained.
  • A value of 1 retains only one log file. When it reaches the maximum size, the file is deleted and replaced by a new one, leaving no history beyond the current log.
  • A value of 0 or negative indicates no limit on the number of log files, and logging continues indefinitely.

To manage log file size, use the MaxLogFileSize property. The two properties work together to control the size and retention of log files in the logging folder.

CData Python Connector for SAP Fieldglass

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
CData Python Connector for SAP Fieldglass

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

"%APPDATA%\\CData\\SAPFieldglass Data Provider\\Schema"

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

CData Python Connector for SAP Fieldglass

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Python Connector for SAP Fieldglass

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

CData Python Connector for SAP Fieldglass

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

CData Python Connector for SAP Fieldglass

Caching

This section provides a complete list of the Caching properties you can configure in the connection string for this provider.


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProviderThe namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriverThe driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnectionSpecifies the connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceNotes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
OfflineGets the data from the specified cache database instead of live SAP Fieldglass data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.
CData Python Connector for SAP Fieldglass

AutoCache

Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, the connector automatically caches the contents of tables targeted by SELECT queries. The content of these tables is cached to the cache database specified by the CacheConnection and CacheProvider connection properties.

See Also

For additional information, see:

  • CacheMetadata: With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from SAP Fieldglass.
  • Explicitly Caching Data: This topic provides examples for using AutoCache in Offline mode.
  • CACHE Statements: You can use the CACHE statement to explicitly cache the content of any table targeted by a SELECT query.

CData Python Connector for SAP Fieldglass

CacheProvider

The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to ADO.NET providers saved in your ADO.NET global assembly cache (GAC).

CData ADO.NET providers automatically register themselves with the GAC during installation, so you don't need to do so manually.

Third-party ADO.NET providers may or may not automatically register themselves with the GAC during installation. If you want to cache to a third-party ADO.NET provider, consult the documentation for that provider to determine what steps (if any) you must take to register them with the GAC. Once they have been registered, you can supply their namespace in this connection property.

You must also set the CacheConnection connection property to provide a connection string for the specified ADO.NET provider.

The following sections show connection examples and address other requirements for several popular database providers. Refer to CacheConnection for more information on typical connection properties.

SQLite

You can use the Microsoft ADO.NET Provider for SQLite to cache to SQLite databases.

CacheProvider=Microsoft.Data.Sqlite;CacheConnection='DataSource=C:\\Users\\Public\\cache.db;'EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

MySQL

To cache to MySQL, you can use the CData ADO.NET Provider for MySQL:
Cache Provider=System.Data.CData.MySQL;Cache Connection='Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

SQL Server

You can use the Microsoft .NET Framework Provider for SQL Server, included in the .NET Framework, to cache to SQL Server:

Cache Provider=System.Data.SqlClient;Cache Connection="Server=MyMACHINE\MyInstance;Database=SQLCACHE;User Id=root;Password=admin";EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

Oracle

To cache to Oracle, you can use the Oracle Data Provider for .NET, as shown in the following example:

Cache Provider=Oracle.DataAccess.Client;Cache Connection='User Id=scott;Password=tiger;Data Source=ORCL';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

The Oracle Data Provider for .NET also requires the Oracle Database Client. When you download the Oracle Database Client, ensure that its bitness matches the bitness of your machine. When you install, select either the Runtime or Administrator installation type. The Instant Client is not sufficient.

PostgreSQL

To cache to PostgreSQL, you can use the CData ADO.NET Provider for PostgreSQL:
Cache Provider=System.Data.CData.PostgreSQL;Cache Connection='Server=localhost;Port=5432;Database=cache;User=postgres;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

CData Python Connector for SAP Fieldglass

CacheDriver

The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

Note: You must add the JAR file of the specified JDBC driver to the classpath. For CData JDBC drivers, you can find this JAR file in the "lib" subfolder of that driver's installation directory.

You must also set the CacheConnection connection property to provide a connection string for the specified JDBC driver.

For Linux systems and macOS, you need to create a config.ini file on the installation path of the driver (site-packages/cdata). The config.ini file has the following format (the driver and the path of the JDBC driver):

[salesforce.cpython-38-x86_64-linux-gnu.so]
CLASSPATH = /home/usrname/Downloads/lib/cdata.jdbc.postgresql.jar

Examples

The following examples show how to cache to several major databases. For more information on the JDBC URL syntax and typical connection properties, see CacheConnection.

Derby and Java DB

Java DB is the Oracle distribution of Derby. You must add the Derby JDBC driver's JAR file, derbytools.jar, to your classpath to cache to Java DB.

The Derby JDBC driver's JAR file is bundled in db-derby-10.17.1.0-bin.zip, which you can download from this page. You can find derbytools.jar in the "lib" subfolder of this zip file.

After adding derbytools.jar to the classpath, you can cache to a Java DB database as follows:

jdbc:sapfieldglass:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;
To cache to an in-memory database, use a JDBC URL like the following:
jdbc:sapfieldglass:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:sapfieldglass:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

MySQL

The following is a JDBC URL for the CData JDBC Driver for MySQL:

  jdbc:sapfieldglass:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;
  

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:sapfieldglass:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:sapfieldglass:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sapfieldglass:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';EnvironmentURL='https://myinstance.com';OAuthClientId=clientId;OAuthClientSecret=clientSecret;APIKey=xxxxxxxx-xxxx-xxxx-xxxx;

CData Python Connector for SAP Fieldglass

CacheConnection

Specifies the connection string for the specified cache database.

Data Type

string

Default Value

""

Remarks

The target cache database is determined by a combination of this connection property and the CacheProvider connection property. Both properties are required to use the specified cache database.

The connection string specified in this connection property is passed directly to the specified in the CacheProvider connection property. Consult the documentation for the specified for more information on its available connection properties.

Examples of common cache database settings can be found below.

SQLite

MySQL

The following are typical connection properties:

  • Server: The IP address or domain name of the server hosting the MySQL database that you want to cache to.
  • Port: The port on the specified server where your MySQL instance is running.
  • Database: The name of the MySQL database that you want to cache to. Must match the name of a MySQL database hosted on the specified server.
  • User: The username of a user registered with the selected MySQL database.
  • Password: The password associated with the specified MySQL user.

SQL Server

The following are typical SQL Server connection properties:

  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, specify the host name and the instance name, separated by a backslash.
  • Port: The port on the specified server where your SQL Server instance is running.
  • Database: The name of the SQL Server database you want to cache to. Must match the name of a SQL Server database hosted on the specified server.
  • Integrated Security: To use the current Windows account for authentication, set this option to True. To authenticate with User and Password instead, set this option to False.
  • User Id: The username of a user registered with the selected SQL Server database. This property is only needed if you are not using integrated security.
  • Password: The password associated with the specified SQL Server user. This property is only needed if you are not using integrated security.

Oracle

The following are typical connection properties:

  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • User Id: The username of a user registered with the selected Oracle database.
  • Password: The password associated with the specified Oracle user.

PostgreSQL

The following are typical connection properties:

  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port on the specified host server where your PostgreSQL database is hosted.
  • Database: The name of the PostgreSQL database you want to cache to. Must match the name of a PostgreSQL database hosted on the specified server.
  • User name: The username of a user registered with the selected PostgreSQL database.
  • Password: The password associated with the specified user.

CData Python Connector for SAP Fieldglass

CacheLocation

Specifies the path to the cache when caching to a file.

Data Type

string

Default Value

"%APPDATA%\\CData\\SAPFieldglass Data Provider"

Remarks

The CacheLocation is a simple, file-based cache.

If left unspecified, the default location is %APPDATA%\\CData\\SAPFieldglass Data Provider, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

See Also

  • AutoCache: Set to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set to persist the SAP Fieldglass catalog in CacheLocation.

CData Python Connector for SAP Fieldglass

CacheTolerance

Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.

Data Type

int

Default Value

600

Remarks

When you execute a query for tables in the cache, the connector checks the time elapsed since the last update to the cache.

If the last update to the cache is older than the value of this connection property (measured in seconds), the connector refreshes the cache.

Otherwise, the connector returns data directly from the cache.

CData Python Connector for SAP Fieldglass

Offline

Gets the data from the specified cache database instead of live SAP Fieldglass data.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, all queries execute against the cache database instead of the live SAP Fieldglass data.

In this mode, some SQL operations like INSERT, UPDATE, DELETE, and CACHE are disabled.

CData Python Connector for SAP Fieldglass

CacheMetadata

Determines whether the provider caches table metadata to a file-based cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, as you execute queries, table metadata in the SAP Fieldglass catalog is cached to the cache database specified by CacheConnection and CacheProvider, or, if those connection properties are not set, to the user's home directory.

The location of your home directory varies by platform:

PlatformHome Directory
Windows %APPDATA%\\CData\\SAPFieldglass Data Provider
Mac ~/Library/Application Support/CData/SAPFieldglass Data Provider
Unix ~/.config/CData/SAPFieldglass Data Provider

A table's metadata is retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

When there are a large number of SAP Fieldglass tables and columns for the connector to retrieve during metadata discovery, the connector may take a while to list all table metadata.

You may experience slow metadata retrieval when:

  • Your SAP Fieldglass instance naturally has a large table count.
  • The connector has been configured, via its connection properties, to discover more tables than it would under its default configuration.
  • You make many short-lived connections to the connector.
With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from SAP Fieldglass.

When Not to Use CacheMetadata

The connector automatically persists metadata in memory for up to an hour when you first discover the metadata for a table or view, so CacheMetadata is generally not necessary.

CacheMetadata is not ideal in scenarios where you are working with volatile metadata. The first time you query a table, the connector caches its metadata to the cache database file. This cache is not dynamically updated to reflect updates to the table schema, so you must delete and rebuild the cache database file to pick up new, changed, or deleted columns.

CData Python Connector for SAP Fieldglass

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
ConnectorDataFormatThe download data format configured during the Connector setup.
ConnectorNamesSpecify a comma-separated list of custom Connector names to list as tables.
IncludeCustomFieldsA boolean indicating if you would like to include custom fields in the column listing.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSets the method for determining the data type of columns.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.
CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

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.

CData Python Connector for SAP Fieldglass

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Python Connector for SAP Fieldglass

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Caching Configuration

PropertyDescription
CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the connector.

Integration and Formatting

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

CData Python Connector for SAP Fieldglass

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Python Connector for SAP Fieldglass

RTK

Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.

Data Type

string

Default Value

""

Remarks

This property is typically unnecessary, as most configurations support a standard licensing mechanism.

Warning: The value of this property takes precedence over all existing licensing information. To avoid licensing errors, ensure the provided runtime key is correct.

CData Python Connector for SAP Fieldglass

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Python Connector for SAP Fieldglass

TypeDetectionScheme

Sets the method for determining the data type of columns.

Possible Values

None, RowScan

Data Type

string

Default Value

"RowScan"

Remarks

NoneSetting TypeDetectionScheme to None returns all columns as "string" type. Note: Even when set to None, the column names are still scanned.
RowScanSetting 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.

CData Python Connector for SAP Fieldglass

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the connector only sees that view.

For further information, see User Defined Views.

CData Python Connector for SAP Fieldglass

UseSimpleNames

Specifies whether or not simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

SAP Fieldglass tables can include special characters in their names that are typically not allowed in standard databases. This property makes the connector easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.

Notes:

  • Any non-alphanumeric characters are converted to underscores.
  • If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

CData Python Connector for SAP Fieldglass

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

AdoptOpenJDK / Adoptium Temurin JRE 17.0.18_8

Copyright (c) Eclipse Foundation AISBL. All Rights Reserved.

Apache License, Version 2.0

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

  1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
  2. You must cause any modified files to carry prominent notices stating that You changed the files; and
  3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
  4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Eclipse Distribution License - v 1.0

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Eclipse Public License - v 2.0

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS "Contribution" means:

  • a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and
  • b) in the case of each subsequent Contributor:
    • i) changes to the Program, and
    • ii) additions to the Program;
    where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution "originates" from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works.
"Contributor" means any person or entity that Distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions Distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors.

"Derivative Works" shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship.

"Modified Works" shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof.

"Distribute" means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy.

"Source Code" means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Secondary License" means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor.

2. GRANT OF RIGHTS

  • a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works.
  • b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
  • c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
  • d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
  • e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3).

3. REQUIREMENTS 3.1 If a Contributor Distributes the Program in any form, then:

  • a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and
  • b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license:
    • i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
    • ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
    • iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and
    • iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3.
3.2 When the Program is Distributed as Source Code:
  • a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and
  • b) a copy of this Agreement must be included with each copy of the Program.
3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices') contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices.

4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version.

Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement.

Exhibit A – Form of Secondary Licenses Notice "This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}."

Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

GNU Classpath

Classpath is distributed under the terms of the GNU General Public License with the following clarification and special exception.

Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination.

As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

As such, it can be used to run, create and distribute a large class of applications and applets. When GNU Classpath is used unmodified as the core class library for a virtual machine, compiler for the java languge, or for a program written in the java programming language it does not affect the licensing for distributing those programs directly.

OpenJDK Assembly Exception

The OpenJDK source code made available by Oracle America, Inc. (Oracle) at openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 only ("GPL2"), with the following clarification and special exception.

Linking this OpenJDK Code statically or dynamically with other code is making a combined work based on this library. Thus, the terms and conditions of GPL2 cover the whole combination.

As a special exception, Oracle gives you permission to link this OpenJDK Code with certain code licensed by Oracle as indicated at http://openjdk.java.net/legal/exception-modules-2007-05-08.html ("Designated Exception Modules") to produce an executable, regardless of the license terms of the Designated Exception Modules, and to copy and distribute the resulting executable under GPL2, provided that the Designated Exception Modules continue to be governed by the licenses under which they were offered by Oracle.

As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code to build an executable that includes those portions of necessary code that Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 with the Classpath exception). If you modify or add to the OpenJDK code, that new GPL2 code may still be combined with Designated Exception Modules if the new code is made subject to this exception by its copyright holder.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655