ADP Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8803 of the connector.
Get Started¶
ADP Version Support
The connector leverages the following ADP APIs to enable access to ADP Workforce Now data:
- Applicant Onboard V2 API
- Payroll Data Input API
- Payroll Output API
- Team Time Cards API
- Time Cards API
- Time Off Balances API
- Time Off Request API
- Validation Table Code List API
- Work Assignment API
- Work Assignment API
- Work Schedules API
- Worker Management API
- Workers API
Establish a Connection¶
Before You Connect¶
Before you can establish a connection, you must contact ADP and ask that they provide you with an OAuth app and its associated credentials.
These credentials can only be obtained from ADP and can't be retrieved directly.
Connect to ADP¶
Connect to ADP by specifying the following properties:
OAuthClientId
: Set this to the client ID of the app provided by ADP.OAuthClientSecret
: Set this to the client secret of the app provided by ADP.SSLClientCert
: Set this to the certificate provided by ADP.SSLClientCertPassword
: Set this to the password of the certificate.UseUAT
: The connector makes requests to the production environment by default. If using a developer account, setUseUAT
= true.RowScanDepth
: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.
Note
SSLClientCert
requires that you create your own certificate. See ADP Developer Resources for more information.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the ADP connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to ADP and then processes the rest of the query in memory (client-side).
User Defined Views¶
The ADP connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Workers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
Insert Parent and Child Records¶
Use Case¶
When inserting records, often there is a need to fill in details about child records that have a dependency on a parent.
For instance, when dealing with a CRM system, Invoices often cannot be entered without at least one line item. Since invoice line items can have several fields, this presents a unique challenge when offering the data as relational tables.
When reading the data, it is easy enough to model an Invoice and an InvoiceLineItem table with a foreign key connecting the two. However, during inserts, the CRM system requires both the Invoice and the InvoiceLineItems to be created in a single submission.
To solve this sort of problem, our tools offer child collection columns on the parent. These columns can be used to submit insert statements that include details of both the parent and the child records.
For example, let's say that the Invoice table contains a single column called InvoiceLineItems. During the insert, we can pass the details of the records that must be inserted to the InvoiceLineItems table into Invoice record's InvoiceLineItems column.
The following subsection describes how this might be done.
Methods for Inserting Parent/Child Records¶
The connector facilitates two methods for inserting parent/child records: temporary table insertion and XML aggregate insertion.
Temporary (#TEMP) tables¶
The simplest way to enter data would be to use a #TEMP table, or temporary table, which the connector will store in memory.
Reference the #TEMP table with the following syntax:
TableName#TEMP
#TEMP tables are stored in memory for the duration of a connection.
Therefore, in order to use them, you cannot close the connection between submitting inserts to them, and they cannot be used in environments where a different connection may be used for each query.
Within that single connection, the table remains in memory until the bulk insert is successful, at which point the temporary table will be wiped from memory.
For example:
INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Basketball', 10, 9.99)
INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Football', 5, 12.99)
Once the InvoiceLineItems table is populated, the #TEMP table may be referenced during an insert into the Invoice table:
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
Under the hood, the connector will read in values from the #TEMP table.
Notice that the ReferenceNumber was used to identify what Invoice the lines are tied to. This is because the #TEMP table may be populated and used with a bulk insert, where there are separate lines for each invoice. This enables the #TEMP tables to be used with a bulk insert. For example:
INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV002', 'Jane Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices SELECT ReferenceNumber, Customer, InvoiceLines FROM Invoices#TEMP
In this case, we are inserting two different Invoices. The ReferenceNumber is how we determine which Lines go with which Invoice.
Note
The tables and columns presented here are an example of how the connector works in general. The specific table and column names may be different in the connector.
Direct XML Insertion¶
Direct XML can be used as an alternative to #TEMP tables. Since #TEMP tables are not used to construct them, it does not matter if you use the same connection or close the connection after insert.
For example:
[
{
"Item", "Basketball",
"Quantity": 10
"Amount": 9.99
},
{
"Item", "Football",
"Quantity": 5
"Amount": 12.99
}
]
OR
<Row>
<Item>Basketball</Item>
<Quantity>10</Quantity>
<Amount>9.99</Amount>
</Row>
<Row>
<Item>Football</Item>
<Quantity>5</Quantity>
<Amount>12.99</Amount>
</Row>
Note that the ReferenceNumber is not present in these examples because the XML, by its nature, is passed against the parent record in full per insert. Since the complete XML must be constructed and submitted for each row, there is no need to provide something to tie the child back to the parent.
Now insert the values:
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '{...}')
OR
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '<Row>...</Row>')
Note
The connector also supports the use of XML/JSON aggregates.
Example for ADP¶
For a working example of how temp tables can be used to insert data in ADP, please see the following. In ADP, the Input_* tables are special input only tables designed for assisting with #TEMP table insertion. You do not need to actually append "#TEMP" to them to use them.
Note that key references such as Ids may be different in your environment:
// Insert into Input_configurationTags child table
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Earning Type', 'String', '"T"', '1')
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Deduction Type', 'String', '"T"', '2')
INSERT INTO Input_configurationTags (TagCode, TagDataType, TagValues, ReferenceNumber) VALUES ('Deduction Type', 'String', '"P"', '2')
// Insert into Input_EarningInputs child table
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,RateValue,NumberOfHours,EarningConfigurationTags,ReferenceNumber) VALUES ('G3BGDF8JG32ERTGK','3TQ','R','50.50', '40', 'Input_configurationTags', '1')
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,RateValue,NumberOfHours) VALUES ('G3GGY14BNGZ313W8','3U7','R','50.40', '41');
INSERT INTO Input_EarningInputs (AssociateOID,PayrollGroupCode,EarningCodeValue,NumberOfHours) VALUES ('G3BGDF8JG32ERTGK','3TQ','O','4');
// Insert into Input_DeductionInputs child table
INSERT INTO Input_DeductionInputs (AssociateOID,PayrollGroupCode,DeductionCodeValue,DeductionRateValue,DeductionAmountcurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3TQ','A','10.50', 'USD');
INSERT INTO Input_DeductionInputs (AssociateOID,PayrollGroupCode,DeductionCodeValue,DeductionRateValue,DeductionAmountcurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3U7','A','10', 'USD');
// Insert into Input_ReimbursementInputs child table
INSERT INTO Input_ReimbursementInputs (AssociateOID,PayrollGroupCode,ReimbursementCodeValue,ReimbursementAmountValue,ReimbursementAmountCurrencyCode,ReimbursementConfigurationTags,ReferenceNumber) VALUES ('G3BGDF8JG32ERTGK','3TQ','B','25.00', 'USD', 'Input_configurationTags', '2');
INSERT INTO Input_ReimbursementInputs (AssociateOID,PayrollGroupCode,ReimbursementCodeValue,ReimbursementAmountValue,ReimbursementAmountCurrencyCode) VALUES ('G3BGDF8JG32ERTGK','3U7','B','25.00', 'USD');
//Insert into PayrollRuns parent table
INSERT INTO PayrollRuns#TEMP (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3TQ', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '050198', 'Input_EarningInputs', 'Input_DeductionInputs', 'Input_ReimbursementInputs');
INSERT INTO PayrollRuns#TEMP (PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', '1', 'TestProcessing', 'G3GGY14BNGZ313W8', '1', '020024', 'Input_EarningInputs', 'Input_DeductionInputs', 'Input_ReimbursementInputs');
// Execute the bulk insert
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) SELECT PayrollGroupCodeValue, PayrollWeekNumber, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs FROM PayrollRuns#TEMP
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model¶
The ADP connector models ADP objects as relational tables and views. An ADP 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 ADP APIs.
Schemas for most database objects are defined in simple, text-based configuration files.
Tables
The connector models the data exposed by the ADP APIs as relational Tables.
Views
Views describes the available read-only views.
Stored Procedures
Stored Procedures are function-like interfaces to ADP.
Tables¶
The connector models the data in ADP as a list of tables in a relational database that can be queried using standard SQL statements.
ADP Connector Tables¶
Name | Description |
---|---|
Input_AdditionalRemunerations | Create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_configurationTags | Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_DeductionInputs | Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_EarningInputs | Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_ReimbursementInputs | Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
PayrollRuns | Add and view the payroll runs. |
Workers | Returns workers details. |
WorkersPersonCommunicationEmails | Returns workers person communication emails. |
WorkersPersonCommunicationFaxes | Returns workers person communication faxes. |
WorkersPersonCommunicationLandlines | Returns workers person communication landlines. |
WorkersPersonCommunicationMobiles | Returns workers person communication mobiles. |
WorkersPersonCommunicationPagers | Returns workers person communication pagers. |
WorkersWorkAssignments | Returns workers details. |
Input_AdditionalRemunerations¶
Create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
RemunerationTypeCode | String | True | ||
RemunerationTypeCodeName | String | True | ||
RemunerationRate | Decimal | True | ||
RemunerationCurrencyCode | String | True | ||
effectiveDate | Date | True | ||
NameCode | String | True | AdditionalRemunerationNameCode.CodeValue | |
InactiveIndicator | Boolean | True |
Input_configurationTags¶
Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
TagCode | String | True | ||
TagDataType | String | True | ||
TagValues | String | True | Add comma separeted values with double quote | |
ReferenceNumber | Integer | True | Configuration tag reference number |
Input_DeductionInputs¶
Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
DeductionCodeValue | String | True | DeductionInputCode.CodeValue | |
DeductionRateValue | Decimal | True | ||
DeductionAmountcurrencyCode | String | True | ||
DeductionBaseUnitCodeValue | String | True | ||
DeductionConfigurationTags | String | True | ||
ReferenceNumber | Integer | True | Configuration tag reference number |
Input_EarningInputs¶
Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
EarningCodeValue | String | True | EarningInputCode.CodeValue | |
RateValue | Decimal | True | ||
RatecurrencyCode | String | True | ||
NumberOfHours | String | True | ||
EarningsAmountValue | Decimal | True | ||
EarningsCurrencyCode | String | True | ||
EarningConfigurationTags | String | True | ||
ReferenceNumber | Integer | True | Configuration tag reference number |
Input_ReimbursementInputs¶
Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
ReimbursementCodeValue | String | True | ReimbursementInputCode.CodeValue | |
ReimbursementAmountValue | Decimal | True | ||
ReimbursementAmountCurrencyCode | String | True | ||
ReimbursementConfigurationTags | String | True | ||
ReferenceNumber | Integer | True | Configuration tag reference number |
PayrollRuns¶
Add and view the payroll runs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ItemID
supports the '=' comparison.PayrollRegionCodeValue
supports the '=' comparison.PayrollGroupCodeValue
supports the '=' comparison.PayrollScheduleReferenceScheduleEntryID
supports the '=' comparison.PayrollScheduleReferencePayrollWeekNumber
supports the '=' comparison.PayrollScheduleReferencePayrollYear
supports the '=' comparison.PayrollScheduleReferencePayrollRunNumber
supports the '=' comparison.Level
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM PayrollRuns WHERE ItemID = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM PayrollRuns WHERE PayrollRegionCodeValue = 'BOST'
SELECT * FROM PayrollRuns WHERE PayrollGroupCodeValue = '3TN'
SELECT * FROM PayrollRuns WHERE PayrollScheduleReferenceScheduleEntryID = '20201117141612-l6OF8VuGHJD1ydLFoe5+nGBEm7rZkaRSorra0woRs04='
SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollWeekNumber = '40'
SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollYear = '2020'
SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollRunNumber = '1'
SELECT * FROM PayrollRuns WHERE Level = 'payroll'
Insert¶
Following is an example of how to inserting pay data inputs into PayrollRuns table. For example:
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '020024', '[{"earningCode":{"codeValue":"R"},"modifierCode":{"codeValue":"1"},"rate":{"rateValue":"44.50"},"configurationTags":[{"tagCode":"ShiftCode","tagValues":["1"]}],"numberOfHours":40},{"earningCode":{"codeValue":"O"},"modifierCode":{"codeValue":"2"},"numberOfHours":4}]', '[{"deductionCode":{"codeValue":"A"},"deductionRate":{"rateValue":9.5,"currencyCode":"USD"}}]', '[{"reimbursementCode":{"codeValue":"B"},"reimbursementAmount":{"amountValue":25,"currencyCode":"USD"}}]')
Inserting pay data inputs using Temp Table.
INSERT INTO PayrollRunsEarningInputs#TEMP (EarningCodeValue, RateValue, NumberOfHours) VALUES ('R', '50.50', '40');
INSERT INTO PayrollRunsDeductionInputs#TEMP (DeductionCodeValue, DeductionRateValue, DeductionAmountcurrencyCode) VALUES ('A', '10', 'USD');
INSERT INTO PayrollRunsReimbursementInputs#TEMP (ReimbursementCodeValue, ReimbursementAmountValue, ReimbursementAmountCurrencyCode) VALUES ('B', '25.00', 'USD');
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, PayrollWeekNumber, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', '53', 'G3BGDF8JG32ERTGK', '1', '020024', 'PayrollRunsEarningInputs#TEMP', 'PayrollRunsDeductionInputs#TEMP', 'PayrollRunsReimbursementInputs#TEMP');
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ItemID [KEY] | String | True | The unique identifier of a instance within the collection. | |
PayrollProcessingJobID | String | False | The unique identifier of the related payroll processing job. This is generated as the result of the payrollProcessingJob.initiate event. | |
AlternateJobIDs | String | True | ||
PayrollRegionCodeValue | String | True | The region in which the payroll is processed. | |
PayrollGroupCodeValue | String | False | PayrollGroup.Code | The payroll group code relevant to payroll processing. |
PayrollGroupCodeShortName | String | True | Short description of the related code. | |
PayrollGroupCodeLongName | String | True | Long description of the related code. | |
PayrollScheduleReferencePayrollScheduleID | String | True | The unique identifier of the payroll schedule associated with the payroll output. | |
PayrollScheduleReferenceScheduleEntryID | String | True | The unique identifier of payroll schedule entry associated to the payroll schedule associated with the payroll output. | |
PayrollScheduleReferencePayrollWeekNumber | String | True | The week number for a payroll in the payroll schedule. This does not necessarily align with the calendar week number. | |
PayrollScheduleReferencePayrollYear | String | True | The year associated to a payroll in the payroll schedule. | |
PayrollScheduleReferencePayrollRunNumber | String | True | For a given payroll week number, this is the numbered run for that week. | |
PayrollProcessingJobStatusCodeValue | String | True | The Job status code of the payroll processing. | |
PayrollProcessingJobStatusCodeShortName | String | True | Short description of the related Job status code. | |
PayrollProcessingJobStatusCodelongName | String | True | Long description of the related Job status code. | |
AssociatePayments | String | True | This column will return data. If level set to detail. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Level | String | The allowed values are payroll, pay, details, payDetails, acc, acc-all, error, dropped pay, wage garnishements. |
AssociateOID | String | Payroll Insert Only |
PayrollWeekNumber | String | Payroll Insert Only |
PayrollFileNumber | String | Payroll Insert Only |
PayNumber | String | Payroll Insert Only |
EarningInputs | String | Payroll Insert Only. Following Modifier codes are supported for pay data input 1 - 'Hours 1 (Regular)', 2 - 'Hours 3 Code & Quantity', 3 - 'Hours 3 Code & Quantity', 4 - 'Hours 4 Code & Quantity', 7 - 'Earnings 3 Code & Amount', 8 - 'Earnings 4 Code & Amount', 9 - 'Earnings 5 Code & Amount', 24 - 'Temporary Hourly Rate'. |
DeductionInputs | String | Payroll Insert Only |
ReimbursementInputs | String | Payroll Insert Only |
Workers¶
Returns workers details.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM Workers WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM Workers WHERE AsOfDate = '2020-01-01'
Insert¶
Following is an example of how to inserting into Workers table. For example:
INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonLegalNameGivenName, PersonLegalNameFamilyName1, PersonBirthDate, PersonHighestEducationLevelCode) VALUES ('3UD', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 4', '2020-11-10', 'TestGivenName', 'TestFamilyName', '1990-06-01', 'DOC')
Following is an example of how to inserting into Workers table with WorkAssignements. For example:
INSERT INTO WorkersWorkAssignments#TEMP (StandardHoursQuantity, PayCycleCodeValue, BaseRemunerationHourlyRateAmountValue, WageLawCoverageCodeValue, BaseRemunerationDailyRateAmountValue) VALUES ('45', '4', 300, 'N', 100)
INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonBirthDate, PersonLegalNameFamilyName1, PersonLegalNameGivenName, PersonDisabledIndicator, PersonGenderCode, PersonHighestEducationLevelCode, PersonLegalAddressCityName, PersonLegalAddressCountryCode, PersonLegalAddressCountrySubdivisionLevel1Code, PersonLegalAddressCountrySubdivisionLevel1SubdivisionType, PersonLegalAddressLineOne, PersonLegalAddressLineTwo, PersonLegalAddressLineThree, PersonLegalAddressNameCodeShortName, PersonLegalAddressPostalCode, PersonLegalNameFamilyName1Prefix, PersonLegalNameGenerationAffixCode, PersonLegalNameInitials, PersonLegalNameMiddleName, PersonLegalNameNickName, PersonLegalNameQualificationAffixCode, PersonMaritalStatusCode, PersonMilitaryDischargeDate, PersonMilitaryStatusCode, WorkAssignments) VALUES ('3TQ', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 16', '2020-12-30', '1990-06-02', 'TestGivenName', 'TestFamilyName', 'FALSE', 'M', 'GRD', 'Millburn', 'US', 'NJ', 'state', 'LineOne', 'LineTwo', 'LineThree', 'Legal Residence', '07041', 'Prefix1', '2nd', 'I', 'MiddleName', 'NickName', 'CFA', 'M', '2013-04-01', '12', 'WorkersWorkAssignments#TEMP')
Update¶
Following is an example of how to Update a Workers table:
UPDATE Workers SET PersonLegalNameGenerationAffixCode = '2nd', PersonLegalNameGivenName = 'GivenName', PersonLegalNameFamilyName1 = 'FamilyName1', PersonLegalNameFamilyName1Prefix = 'Prefix1', PersonLegalNameFamilyName2 = 'FamilyName2', PersonLegalNameFamilyName2Prefix = 'Prefix2', PersonLegalNameInitials = 'C', PersonLegalNameMiddleName = 'MiddleName', PersonLegalNameNickName = 'NickName', PersonLegalNamePreferredSalutations = '[{"salutationCode":{"codeValue":"Mr."},"typeCode":{"shortName":"Social"},"sequenceNumber":1}]', PersonLegalNameQualificationAffixCode = 'CFA' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonLegalAddressNameCodeShortName = 'Legal Residence', PersonLegalAddressLineOne = 'LineOne', PersonLegalAddressLineTwo = 'LineTwo', PersonLegalAddressCityName = 'Millburn', PersonLegalAddressCountryCode = 'US', PersonLegalAddressCountrySubdivisionLevel1SubdivisionType = 'state', PersonLegalAddressPostalCode = '07041' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonMaritalStatusCode = 'M', PersonMaritalStatusEffectiveDateTime = '2020-12-01T00:00:00Z' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonHighestEducationLevelCode = 'GRD' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonGenderCode = 'M' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonBirthDate = '1990-06-01' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
UPDATE Workers SET PersonMilitaryClassificationCodes = '[{"codeValue":"R"}]' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | ||
WorkerID | String | True | ||
WorkAssignments | String | False | ||
WorkerAcquisitionDate | Date | True | ||
WorkerAdjustedServiceDate | Date | True | ||
WorkerExpectedTerminationDate | Date | True | ||
WorkerOriginalHireDate | Date | False | ||
WorkerRehireDate | Date | True | ||
WorkerRetirementDate | Date | True | ||
WorkerTerminationDate | Date | True | ||
WorkerIDSchemeCode | String | True | ||
WorkerIDSchemeLongName | String | True | ||
WorkerIDSchemeShortName | String | True | ||
WorkerStatusEffectiveDate | Date | True | ||
WorkerStatusReasonCode | String | True | ||
WorkerStatusReasonLongName | String | True | ||
WorkerStatusReasonShortName | String | True | ||
WorkerStatusStatusCode | String | True | ||
WorkerStatusStatusLongName | String | True | ||
WorkerStatusStatusShortName | String | True | ||
Photos | String | True | ||
BusinessCommunicationEmails | String | False | ||
BusinessCommunicationFaxes | String | False | ||
BusinessCommunicationLandlines | String | False | ||
BusinessCommunicationMobiles | String | False | ||
BusinessCommunicationPagers | String | False | ||
PersonAlternatePreferredNames | String | True | ||
PersonCommunicationEmails | String | False | ||
PersonCommunicationFaxes | String | False | ||
PersonCommunicationLandlines | String | False | ||
PersonCommunicationMobiles | String | False | ||
PersonCommunicationPagers | String | False | ||
PersonDeathDate | Date | True | ||
PersonDeceasedIndicator | Boolean | True | ||
PersonDisabilityIdentificationDeclinedIndicator | Boolean | True | ||
PersonDisabilityPercentage | Integer | True | ||
PersonDisabilityTypeCodes | String | False | ||
PersonDisabledIndicator | Boolean | False | ||
PersonGenderCode | String | False | The allowed values are M, F, N. | |
PersonGenderLongName | String | True | ||
PersonGenderShortName | String | True | ||
PersonGovernmentIDs | String | False | ||
PersonHighestEducationLevelCode | String | False | HighestEducationLevelCode.CodeValue | |
PersonHighestEducationLevelLongName | String | True | ||
PersonHighestEducationLevelShortName | String | True | ||
PersonIdentityDocuments | String | True | ||
PersonImmigrationDocuments | String | True | ||
PersonLegalAddressCityName | String | False | ||
PersonLegalAddressCountryCode | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1Code | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1LongName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1ShortName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2Code | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2LongName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2ShortName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
PersonLegalAddressDeliveryPoint | String | False | ||
PersonLegalAddressLineOne | String | False | ||
PersonLegalAddressLineTwo | String | False | ||
PersonLegalAddressLineThree | String | False | ||
PersonLegalAddressNameCodeValue | String | False | ||
PersonLegalAddressNameCodeLongName | String | True | ||
PersonLegalAddressNameCodeShortName | String | False | ||
PersonLegalAddressPostalCode | String | False | ||
PersonLegalAddressSameAsAddressIndicator | Boolean | False | ||
PersonLegalAddressSameAsAddressLinkCanonicalUri | String | False | ||
PersonLegalAddressSameAsAddressLinkEncType | String | False | ||
PersonLegalAddressSameAsAddressLinkHref | String | False | ||
PersonLegalAddressSameAsAddressLinkMediaType | String | False | ||
PersonLegalAddressSameAsAddressLinkMethod | String | False | ||
PersonLegalAddressSameAsAddressLinkPayLoadArguments | String | False | ||
PersonLegalAddressSameAsAddressLinkRel | String | False | ||
PersonLegalAddressSameAsAddressLinkSchema | String | False | ||
PersonLegalAddressSameAsAddressLinkTargetSchema | String | False | ||
PersonLegalAddressSameAsAddressLinkTitle | String | False | ||
PersonLegalNameFamilyName1 | String | False | ||
PersonLegalNameFamilyName1Prefix | String | False | ||
PersonLegalNameFamilyName2 | String | False | ||
PersonLegalNameFamilyName2Prefix | String | False | ||
PersonLegalNameFormattedName | String | False | ||
PersonLegalNameGenerationAffixCode | String | False | GenerationAffixCode.CodeValue | |
PersonLegalNameGenerationAffixLongName | String | True | ||
PersonLegalNameGenerationAffixShortName | String | True | ||
PersonLegalNameGivenName | String | False | ||
PersonLegalNameInitials | String | False | ||
PersonLegalNameMiddleName | String | False | ||
PersonLegalNameCode | String | False | ||
PersonLegalNameLongName | String | True | ||
PersonLegalNameShortName | String | False | ||
PersonLegalNameNickName | String | False | ||
PersonLegalNamePreferredSalutations | String | False | ||
PersonLegalNameQualificationAffixCode | String | False | QualificationAffixCode.CodeValue | |
PersonLegalNameQualificationAffixLongName | String | False | ||
PersonLegalNameQualificationAffixShortName | String | False | ||
PersonLinks | String | True | ||
PersonMaritalStatusCode | String | False | MaritalStatusCode.CodeValue | |
PersonMaritalStatusEffectiveDateTime | Datetime | False | ||
PersonMaritalStatusLongName | String | True | ||
PersonMaritalStatusShortName | String | False | MaritalStatusCode.ShortName | |
PersonMilitaryClassificationCodes | String | False | Supported values Disabled Veteran,Active Duty Wartime or Campaign Badge Veteran,Armed Forces Service Medal Veteran,Recently Separated Veteran | |
PersonMilitaryDischargeDate | Date | False | ||
PersonMilitaryStatusCode | String | False | ||
PersonMilitaryStatusEffectiveDate | Datetime | True | ||
PersonMilitaryStatusLongName | String | True | ||
PersonMilitaryStatusShortName | String | False | ||
PersonOtherPersonalAddresses | String | False | ||
PersonPassports | String | False | ||
PersonPreferredNameFamilyName1 | String | True | ||
PersonPreferredNameFamilyName1Prefix | String | True | ||
PersonPreferredNameFamilyName2 | String | True | ||
PersonPreferredNameFamilyName2Prefix | String | True | ||
PersonPreferredNameFormattedName | String | True | ||
PersonPreferredNameGenerationAffixCode | String | True | ||
PersonPreferredNameGenerationAffixLongName | String | True | ||
PersonPreferredNameGenerationAffixShortName | String | True | ||
PersonPreferredNameGivenName | String | True | ||
PersonPreferredNameInitials | String | True | ||
PersonPreferredNameMiddleName | String | True | ||
PersonPreferredNameCode | String | True | ||
PersonPreferredNameLongName | String | True | ||
PersonPreferredNameShortName | String | True | ||
PersonPreferredNameNickName | String | True | ||
PersonPreferredNamePreferredSalutations | String | True | ||
PersonPreferredNameQualificationAffixCode | String | True | ||
PersonPreferredNameQualificationAffixLongName | String | True | ||
PersonPreferredNameQualificationAffixShortName | String | True | ||
PersonPreferredNameScriptCode | String | True | ||
PersonPreferredNameScriptLongName | String | True | ||
PersonPreferredNameScriptShortName | String | True | ||
PersonPreferredNameTitleAffixCodes | String | True | ||
PersonPreferredNameTitlePrefixCodes | String | True | ||
PersonReligionCode | String | True | ||
PersonReligionLongName | String | True | ||
PersonReligionShortName | String | True | ||
PersonResidencyCountryCodes | String | True | ||
PersonSexualOrientationCode | String | True | ||
PersonSexualOrientationLongName | String | True | ||
PersonSexualOrientationShortName | String | True | ||
PersonSocialInsurancePrograms | String | True | ||
PersonStudentIndicator | Boolean | True | ||
PersonStudentStatusCode | String | True | ||
PersonStudentStatusEffectiveDate | Date | True | ||
PersonStudentStatusLongName | String | True | ||
PersonStudentStatusShortName | String | True | ||
PersonTobaccoUserIndicator | Boolean | True | ||
PersonWorkAuthorizationDocuments | String | True | ||
Links | String | True | ||
AsOfDate | Date | True | ||
PersonBirthDate | Date | False |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
PayrollGroupCode | String | Insert Only |
OnboardingTemplateCode | String | Insert Only |
OnboardingTemplateCodeName | String | Insert Only |
OnboardingStatusCode | String | Insert Only |
OnboardingStatusCodeName | String | Insert Only |
HireReasonCode | String | Insert Only |
HireReasonCodeName | String | Insert Only |
WorkersPersonCommunicationEmails¶
Returns workers person communication emails.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonCommunicationEmails WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update a WorkersPersonCommunicationEmails table:
UPDATE WorkersPersonCommunicationEmails SET EmailUri = 'test@test.com' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerID | String | True | Workers.WorkerID | |
EmailUri | String | False | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
WorkersPersonCommunicationFaxes¶
Returns workers person communication faxes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update a WorkersPersonCommunicationFaxes table:
UPDATE WorkersPersonCommunicationFaxes SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerID | String | True | Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
WorkersPersonCommunicationLandlines¶
Returns workers person communication landlines.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update a WorkersPersonCommunicationLandlines table:
UPDATE WorkersPersonCommunicationLandlines SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerID | String | True | Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
WorkersPersonCommunicationMobiles¶
Returns workers person communication mobiles.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update a WorkersPersonCommunicationMobiles table:
UPDATE WorkersPersonCommunicationMobiles SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerID | String | True | Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
WorkersPersonCommunicationPagers¶
Returns workers person communication pagers.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonCommunicationPagers WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update a WorkersPersonCommunicationPagers table:
UPDATE WorkersPersonCommunicationPagers SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerID | String | True | Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
WorkersWorkAssignments¶
Returns workers details.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerIdValue
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignments WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignments WHERE WorkerIdValue = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignments WHERE AsOfDate = '2020-01-01'
Update¶
Following is an example of how to Update BaseRemuneration:
UPDATE WorkersWorkAssignments SET StandardHoursQuantity = '45', BaseRemunerationEffectiveDate = '2020-12-21', PayCycleCodeValue = '4', BaseRemunerationHourlyRateAmountValue = 300, WageLawCoverageCodeValue = 'N', BaseRemunerationCode = 'ADJ', ItemId = '34321368N' WHERE AssociateOID = 'G3GMC21PJFZT7K4F'
Following is an example of how to Update AdditionalRemuneration using aggregates:
UPDATE WorkersWorkAssignments SET AdditionalRemunerations = '[{"remunerationTypeCode":{"code":"AE","name":"additional earnings"},"remunerationRate":{"rate":70,"currencyCode":"USD"},"effectiveDate":"2020-12-20","nameCode":{"code":"1FA"},"inactiveIndicator":false}]', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update AdditionalRemuneration using Temp Table:
INSERT INTO Input_AdditionalRemunerations#TEMP (RemunerationTypeCode, RemunerationRate, RemunerationCurrencyCode, effectiveDate, NameCode, InactiveIndicator) VALUES ('AE', '70', 'USD', '2021-01-04', 'R', false)
UPDATE WorkersWorkAssignments SET AdditionalRemunerations = 'Input_AdditionalRemunerations#TEMP', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update Worker Assignment Termination:
UPDATE WorkersWorkAssignments SET TerminationDate = '2020-01-31', LastWorkedDate = '2020-01-31', AssignmentStatusReasonCodeValue = 'A00', RehireEligibleIndicator = true, SeveranceEligibleIndicator = true, TerminationComments = 'Looking for better growth and oppurtunities', itemid = '00691088N' WHERE AssociateOID = 'G3TGG0M57JZECKRB'
Following is an example of how to Update Worker Type:
UPDATE WorkersWorkAssignments SET WorkerTypeCodeValue = 'F', ItemId = '31095304_1668', EventReasonCode = 'ADL', EffectiveDate = '2021-01-01' WHERE AssociateOID = 'G3Q8G47NKHBV1SMT'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
AssociateOID [KEY] | String | True | Workers.AssociateOID | |
WorkerIdValue | String | True | Workers.WorkerID | |
ItemID [KEY] | String | False | ||
ActualStartDate | Date | True | ||
CompaRatio | Integer | True | ||
AdditionalRemunerations | String | False | ||
AnnualBenefitBaseRateAmountValue | Integer | True | ||
AnnualBenefitBaseRateCurrencyCode | String | True | ||
AnnualBenefitBaseRateNameCodeValue | String | True | ||
AnnualBenefitBaseRateNameCodeLongName | String | True | ||
AnnualBenefitBaseRateNameCodeShortName | String | True | ||
AssignedOrganizationalUnits | String | False | ||
AssignedWorkLocations | String | True | ||
AssignmentCostCenters | String | True | ||
AssignmentStatusEffectiveDate | Date | True | ||
AssignmentStatusReasonCodeValue | String | False | ||
AssignmentStatusReasonCodeLongName | String | True | ||
AssignmentStatusReasonCodeShortName | String | True | ||
AssignmentStatusStatusCodeValue | String | True | ||
AssignmentStatusStatusCodeLongName | String | True | ||
AssignmentStatusStatusCodeShortName | String | True | ||
AssignmentTermCodeValue | String | True | ||
AssignmentTermCodeLongName | String | True | ||
AssignmentTermCodeShortName | String | True | ||
BargainingUnitBargainingUnitCodeValue | String | False | ||
BargainingUnitBargainingUnitCodeLongName | String | True | ||
BargainingUnitBargainingUnitCodeShortName | String | False | ||
BargainingUnitSeniorityDate | Date | False | ||
BaseRemunerationAnnualRateAmountValue | Decimal | True | ||
BaseRemunerationAnnualRateAmountCurrencyCode | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeValue | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeLongName | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeShortName | String | True | ||
BaseRemunerationAssociatedRateQualifiers | String | True | ||
BaseRemunerationBiweeklyRateAmountValue | Decimal | True | ||
BaseRemunerationBiweeklyRateAmountCurrencyCode | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeValue | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeValue | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeLongName | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeValue | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeLongName | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentagePercentageValue | Integer | True | ||
BaseRemunerationDailyRateAmountValue | Decimal | False | ||
BaseRemunerationDailyRateAmountCurrencyCode | String | True | ||
BaseRemunerationDailyRateAmountNameCodeValue | String | False | ||
BaseRemunerationDailyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationDailyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationEffectiveDate | Date | False | ||
BaseRemunerationHourlyRateAmountValue | Decimal | False | ||
BaseRemunerationHourlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeValue | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationMonthlyRateAmountValue | Decimal | True | ||
BaseRemunerationMonthlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationMonthlyRateAmountNameCodeValue | String | False | ||
BaseRemunerationMonthlyRateAmountNameLongName | String | True | ||
BaseRemunerationMonthlyRateAmountNameShortName | String | False | ||
BaseRemunerationPayPeriodRateAmountValue | Decimal | True | ||
BaseRemunerationPayPeriodRateAmountCurrencyCode | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeValue | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeLongName | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeShortName | String | True | ||
BaseRemunerationRecordingBasisCodeValue | String | True | ||
BaseRemunerationRecordingBasisCodelongName | String | True | ||
BaseRemunerationRecordingBasisCodeShortName | String | True | ||
BaseRemunerationSemiMonthlyRateAmountValue | Decimal | True | ||
BaseRemunerationSemiMonthlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeValue | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationWeeklyRateAmountValue | Decimal | True | ||
BaseRemunerationWeeklyRateAmountCurrencyCode | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeValue | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeShortName | String | True | ||
ExecutiveIndicator | Boolean | True | ||
ExecutiveTypeCodeValue | String | True | ||
ExecutiveTypeCodeLongName | String | True | ||
ExecutiveTypeCodeShortName | String | True | ||
ExpectedStartDate | Date | True | ||
ExpectedTerminationDate | Date | True | ||
FullTimeEquivalenceRatio | Integer | True | ||
GeographicPayDifferentialCodeValue | String | True | ||
GeographicPayDifferentialCodeLongName | String | True | ||
GeographicPayDifferentialCodeShortName | String | True | ||
GeographicPayDifferentialPercentage | Integer | True | ||
HighlyCompensatedIndicator | Boolean | True | ||
HighlyCompensatedTypeCodeValue | String | True | ||
HighlyCompensatedTypeCodeLongName | String | True | ||
HighlyCompensatedTypeCodeShortName | String | True | ||
HireDate | Date | True | ||
HomeOrganizationalUnits | String | False | ||
HomeWorkLocationAddressAttentionOfName | String | True | ||
HomeWorkLocationAddressBlockName | String | True | ||
HomeWorkLocationAddressBuildingName | String | True | ||
HomeWorkLocationAddressBuildingNumber | String | True | ||
HomeWorkLocationAddressCareOfName | String | True | ||
HomeWorkLocationAddressCityName | String | False | ||
HomeWorkLocationAddressCountryCode | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1CodeValue | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1LongName | String | True | ||
HomeWorkLocationAddressCountrySubdivisionLevel1ShortName | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2CodeValue | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2LongName | String | True | ||
HomeWorkLocationAddressCountrySubdivisionLevel2ShortName | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
HomeWorkLocationAddressDeliveryPoint | String | True | ||
HomeWorkLocationAddressDoor | String | True | ||
HomeWorkLocationAddressFloor | String | True | ||
HomeWorkLocationAddressGeoCoordinateLatitude | Integer | True | ||
HomeWorkLocationAddressGeoCoordinateLongitude | Integer | True | ||
HomeWorkLocationAddressLineFive | String | True | ||
HomeWorkLocationAddressLineFour | String | True | ||
HomeWorkLocationAddressLineOne | String | False | ||
HomeWorkLocationAddressLineTwo | String | False | ||
HomeWorkLocationAddressLineThree | String | False | ||
HomeWorkLocationAddressNameCodeValue | String | True | ||
HomeWorkLocationAddressNameCodeLongName | String | True | ||
HomeWorkLocationAddressNameCodeShortName | String | True | ||
HomeWorkLocationAddressPlotID | String | True | ||
HomeWorkLocationAddressPostalCode | String | False | ||
HomeWorkLocationAddressPostOfficeBox | String | True | ||
HomeWorkLocationAddressScriptCodeValue | String | True | ||
HomeWorkLocationAddressScriptCodeLongName | String | True | ||
HomeWorkLocationAddressScriptCodeShortName | String | True | ||
HomeWorkLocationAddressStairCase | String | True | ||
HomeWorkLocationAddressStreetName | String | True | ||
HomeWorkLocationAddressStreetTypeCodeValue | String | True | ||
HomeWorkLocationAddressStreetTypeCodeLongName | String | True | ||
HomeWorkLocationAddressStreetTypeCodeShortName | String | True | ||
HomeWorkLocationAddressUnit | String | True | ||
HomeWorkLocationCommunicationEmails | String | True | ||
HomeWorkLocationCommunicationFaxes | String | True | ||
HomeWorkLocationCommunicationLandlines | String | True | ||
HomeWorkLocationCommunicationMobiles | String | True | ||
HomeWorkLocationCommunicationPagers | String | True | ||
HomeWorkLocationNameCodeValue | String | False | ||
HomeWorkLocationNameCodeLongName | String | True | ||
HomeWorkLocationNameCodeShortName | String | False | ||
IndustryClassifications | String | False | ||
JobCodeValue | String | False | ||
JobCodeEffectiveDate | Date | True | ||
JobCodeLongName | String | True | ||
JobCodeShortName | String | False | ||
JobTitle | String | True | ||
LaborUnionLaborUnionCodeValue | String | False | ||
LaborUnionLaborUnionCodeLongName | String | True | ||
LaborUnionLaborUnionCodeShortName | String | False | ||
LaborUnionSeniorityDate | Date | True | ||
LegalEntityID | String | True | ||
Links | String | True | ||
ManagementPositionIndicator | Boolean | False | ||
MinimumPayGradeStepDuration | String | True | ||
NationalityContextCodeValue | String | True | ||
NationalityContextCodeLongName | String | True | ||
NationalityContextCodeShortName | String | True | ||
NextPayGradeStepDate | Date | True | ||
OccupationalClassifications | String | False | ||
OfferAcceptanceDate | Date | True | ||
OfferExtensionDate | Date | True | ||
OfficerIndicator | Boolean | True | ||
OfficerTypeCodeValue | String | False | ||
OfficerTypeCodeLongName | String | True | ||
OfficerTypeCodeShortName | String | False | ||
PayCycleCodeValue | String | False | ||
PayCycleCodeLongName | String | True | ||
PayCycleCodeShortName | String | False | ||
PayGradeCodeValue | String | False | ||
PayGradeCodeLongName | String | True | ||
PayGradeCodeShortName | String | False | ||
PayGradePayRangeMaximumRateAmountValue | Decimal | True | ||
PayGradePayRangeMaximumRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMaximumRateCurrencyCode | String | True | ||
PayGradePayRangeMaximumRateUnitCodeValue | String | True | ||
PayGradePayRangeMaximumRateUnitCodeLongName | String | True | ||
PayGradePayRangeMaximumRateUnitCodeShortName | String | True | ||
PayGradePayRangeMedianRateAmountValue | Decimal | True | ||
PayGradePayRangeMedianRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMedianRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMedianRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMedianRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMedianRateCcurrencyCode | String | True | ||
PayGradePayRangeMedianRateUnitCodeValue | String | True | ||
PayGradePayRangeMedianRateUnitCodeLongName | String | True | ||
PayGradePayRangeMedianRateUnitCodeShortName | String | True | ||
PayGradePayRangeMinimumRateAmountValue | Decimal | True | ||
PayGradePayRangeMinimumRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMinimumRateCurrencyCode | String | True | ||
PayGradePayRangeMinimumRateUnitCodeValue | String | True | ||
PayGradePayRangeMinimumRateUnitCodeLongName | String | True | ||
PayGradePayRangeMinimumRateUnitCodeShortName | String | True | ||
PayGradeStepCodeValue | String | True | ||
PayGradeStepCodeLongName | String | True | ||
PayGradeStepCodeShortName | String | True | ||
PayGradeStepPayRateAmountValue | Decimal | True | ||
PayGradeStepPayRateBaseMultiplierValue | Integer | True | ||
PayGradeStepPayRateBaseUnitCodeValue | String | True | ||
PayGradeStepPayRateBaseUnitCodeLongName | String | True | ||
PayGradeStepPayRateBaseUnitCodeShortName | String | True | ||
PayGradeStepPayRateCurrencyCode | String | True | ||
PayGradeStepPayRateUnitCodeValue | String | True | ||
PayGradeStepPayRateUnitCodeLongName | String | True | ||
PayGradeStepPayRateUnitCodeShortName | String | True | ||
PayrollFileNumber | String | False | ||
PayrollGroupCode | String | False | ||
PayrollProcessingStatusCodeValue | String | True | ||
PayrollProcessingStatusCodeEffectiveDate | Date | True | ||
PayrollProcessingStatusCodeLongName | String | True | ||
PayrollProcessingStatusCodeShortName | String | True | ||
PayrollRegionCode | String | True | ||
PayrollScheduleGroupID | String | True | ||
PayScaleCodeValue | String | True | ||
PayScaleCodeLongName | String | True | ||
PayScaleCodeShortName | String | True | ||
PositionID | String | False | ||
PositionTitle | String | True | ||
PrimaryIndicator | Boolean | True | ||
RemunerationBasisCodeValue | String | True | ||
RemunerationBasisCodeLongName | String | True | ||
RemunerationBasisCodeShortName | String | True | ||
ReportsTo | String | False | ||
SeniorityDate | Date | True | ||
StandardHoursQuantity | Integer | False | ||
StandardHoursUnitCodeValue | String | True | ||
StandardHoursUnitCodeLongName | String | True | ||
StandardHoursUnitCodeShortName | String | True | ||
StandardPayPeriodHoursHoursQuantity | Integer | True | ||
StandardPayPeriodHoursUnitCodeValue | String | True | ||
StandardPayPeriodHoursUnitCodeLongName | String | True | ||
StandardPayPeriodHoursUnitCodeShortName | String | True | ||
StockOwnerIndicator | Boolean | True | ||
StockOwnerPercentage | Integer | True | ||
TerminationDate | Date | False | ||
VipIndicator | Boolean | True | ||
VipTypeCodeValue | String | True | ||
VipTypeCodeLongName | String | True | ||
VipTypeCodeShortName | String | True | ||
WageLawCoverageCodeValue | String | False | WageLawCoverageCode.CodeValue | |
WageLawCoverageCodeLongName | String | True | ||
WageLawCoverageCodeShortName | String | False | ||
WageLawCoverageWageLawNameCodeValue | String | True | ||
WageLawCoverageWageLawNameCodeLongName | String | True | ||
WageLawCoverageWageLawNameCodeShortName | String | True | ||
WorkArrangementCodeValue | String | True | ||
WorkArrangementCodeLongName | String | True | ||
WorkArrangementCodeShortName | String | True | ||
WorkerGroups | String | True | ||
WorkerProbationIndicator | Boolean | True | ||
WorkerProbationPeriodEndDate | Date | True | ||
WorkerProbationPeriodStartDate | Date | True | ||
WorkerTypeCodeValue | String | False | WorkerTypeCode.CodeValue | |
WorkerTypeCodeLongName | String | True | ||
WorkerTypeCodeShortName | String | True | ||
WorkLevelCodeValue | String | True | ||
WorkLevelCodeLongName | String | True | ||
WorkLevelCodeShortName | String | True | ||
WorkShiftCodeValue | String | True | ||
WorkShiftCodeLongName | String | True | ||
WorkShiftCodeShortName | String | True | ||
AsOfDate | Date | True |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
EffectiveDate | Date | To update positionid and AssignedOrganizationalUnits |
LastWorkedDate | Date | Worker Termination Update |
RehireEligibleIndicator | Boolean | Worker Termination Update |
SeveranceEligibleIndicator | Boolean | Worker Termination Update |
TerminationComments | String | Worker Termination Update |
BaseRemunerationCode | String | |
EventReasonCode | String |
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.
ADP Connector Views¶
Name | Description |
---|---|
AdditionalRemunerationNameCode | Returns additional remuneration name code. |
AssociatePaymentsAllocationsEarningsAndBenefits | View the associate payment allocation earnings and benefits in the payroll outputs. |
AssociatePaymentsAllocationsEarningSections | View the earning sections for the associate payments allocations in payroll outputs. |
AssociatePaymentsAllocationsNonStatutoryDeductions | View the non-statutory deductions for the associate payments allocations in payroll outputs. |
AssociatePaymentsAllocationsStatutoryDeductions | View the statutory deductions for the associate payments allocations in payroll outputs. |
AssociatePaymentsSummaryEarningsAndBenefits | View the associate payments earnings and benefits in the payroll outputs. |
AssociatePaymentsSummaryEarningsSections | View the associate payments earnings sections items in the payroll outputs. |
AssociatePaymentsSummaryNonStatutoryDeductions | To view the non statutory deduction for the associate in payroll outputs. |
AssociatePaymentsSummaryPayrollAccumulations | To View the associate payments payroll accumulations in the payroll outputs. |
AssociatePaymentsSummaryStatutoryDeductions | View the statutory deduction for the associate in payroll outputs. |
CostCenters | Returns all Cost number codes setup for the client. |
DeductionInputCode | Returns deduction input code. |
EarningInputCode | Returns earning input code. |
GenerationAffixCode | Returns legal name generation affix code. |
HighestEducationLevelCode | Returns highest education level code value. |
MaritalStatusCode | Returns marital status codes. |
OnboardingTemplate | Returns onboarding template. |
PaidTimeOffBalances | Returns Paid TimeOff Balances. |
PaidTimeOffRequestEntries | Returns PaidTimeOff Requests. |
PaidTimeOffRequests | Returns PaidTimeOff Requests. |
PayrollGroup | Returns payroll group. |
PersonalContacts | Personal emergency contacts. |
QualificationAffixCode | Returns work assignement worker type code. |
ReimbursementInputCode | Returns reimbursement input code. |
TeamTimeCards | View the Team Time Cards. |
TeamTimeCardsDailyTotals | View the Team Time Cards daily totals aggregate. |
TeamTimeCardsHomeLaborAllocations | View the Team Time Cards period totals aggregate. |
TeamTimeCardsPeriodTotals | View the Team Time Cards period totals aggregate. |
TimeCards | View the worker Time Cards. |
TimeCardsDailyTotals | View the worker Time Cards daily totals aggregate. |
TimeCardsPeriodTotals | View the worker Time Cards period totals aggregate. |
WageLawCoverageCode | Returns wage law coverage code. |
WorkAssignmentCustomHistoryCustomGroupAmountFields | Work assignment CustomGroup amount. |
WorkAssignmentCustomHistoryCustomGroupCodeFields | Work assignment CustomGroup code. |
WorkAssignmentCustomHistoryCustomGroupDateFields | Work assignment CustomGroup date. |
WorkAssignmentCustomHistoryCustomGroupDateTimeFields | Work assignment CustomGroup date time. |
WorkAssignmentCustomHistoryCustomGroupIndicatorFields | Work assignment CustomGroup indicator. |
WorkAssignmentCustomHistoryCustomGroupLinks | Work assignment CustomGroup links. |
WorkAssignmentCustomHistoryCustomGroupNumberFields | Work assignment CustomGroup number. |
WorkAssignmentCustomHistoryCustomGroupPercentFields | Work assignment CustomGroup percent. |
WorkAssignmentCustomHistoryCustomGroupStringFields | Work assignment CustomGroup string. |
WorkAssignmentCustomHistoryCustomGroupTelephoneFields | Work assignment CustomGroup telephone. |
WorkAssignmentHistory | Work assignment history. |
WorkAssignmentHistoryAdditionalRemunerations | Work assignment additionsla remunerations history. |
WorkAssignmentHistoryAssignedOrganizationalUnits | Work assignment organization units history. |
WorkAssignmentHistoryAssignedWorkLocations | Work assignment Assigned locations history. |
WorkAssignmentHistoryCommunicationsEmails | Work assignment communication history mail. |
WorkAssignmentHistoryCommunicationsFaxes | Work assignment communication Fax History. |
WorkAssignmentHistoryCommunicationsInstantMessages | Work assignment communication message History. |
WorkAssignmentHistoryCommunicationsInternetAddresses | Work assignment communication Internet address History. |
WorkAssignmentHistoryCommunicationsLandlines | Work assignment communication landline history. |
WorkAssignmentHistoryCommunicationsMobiles | Work assignment communication mobile History. |
WorkAssignmentHistoryCommunicationsPagers | Work assignment communication Pager History. |
WorkAssignmentHistoryCommunicationsSocialNetworks | Work assignment communication social network history. |
WorkAssignmentHistoryHomeOrganizationalUnits | Work assignment Home organization history. |
WorkAssignmentHistoryIndustryClassifications | Work assignment industry classification history. |
WorkAssignmentHistoryOccupationalClassifications | Work assignment occupational classification history. |
WorkAssignmentHistoryReport | Work assignment Report. |
WorkAssignmentHistoryWorkerGroups | Work assignment group history. |
WorkerDemographics | Returns a list of demographics for each worker in the organization. |
WorkersBusinessCommunicationEmails | Returns workers business communication emails. |
WorkersBusinessCommunicationFaxes | Returns workers business communication faxes. |
WorkersBusinessCommunicationLandlines | Returns workers business communication landlines. |
WorkersBusinessCommunicationMobiles | Returns workers business communication mobiles. |
WorkersBusinessCommunicationPagers | Returns workers business communication pagers. |
WorkersPersonBirthNamePreferredSalutations | Returns workers person birth name preferred salutations. |
WorkersPersonBirthNameTitleAffixCodes | Returns workers person birth name title affix codes. |
WorkersPersonBirthNameTitlePrefixCodes | Returns workers person birth name title prefix codes. |
WorkersPersonGovernmentIDs | Returns workers person government IDs. |
WorkersPersonLegalNamePreferredSalutations | Returns workers person legal name preferred salutations. |
WorkersPersonLegalNameTitleAffixCodes | Returns workers person legal name title affix codes. |
WorkersPersonLegalNameTitlePrefixCodes | Returns workers person legal name title prefix codes. |
WorkersPersonMilitaryClassificationCodes | Returns workers person military classification codes. |
WorkersPhotoLinks | Returns workers photo links. |
WorkersPhotos | Returns workers photos. |
WorkersWorkAssignmentReportsTo | Returns workers work assignment ReportsTo. |
WorkersWorkAssignmentsAssignedOrganizationalUnits | Returns workers work assignments assigned organizational units. |
WorkersWorkAssignmentsAssignedWorkLocations | Returns workers work assignments assigned work locations. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails | Returns workers work assignments assigned work locations communication emails. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes | Returns workers work assignments assigned work locations communication faxes. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines | Returns workers work assignments assigned work locations communication landlines. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles | Returns workers work assignments assigned work locations communication mobiles. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers | Returns workers work assignments assigned work locations communication pagers. |
WorkersWorkAssignmentsHomeOrganizationalUnits | Returns workers work assignments home organizational units. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails | Returns workers work assignments home work location communication emails. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationInstantMessages | Returns workers work assignments home work location communication instant messages. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines | Returns workers work assignments home work location communication landlines. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles | Returns workers work assignments home work location communication mobiles. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers | Returns workers work assignments home work location communication pagers. |
WorkersWorkAssignmentsIndustryClassifications | Returns workers work assignments industry classifications. |
WorkersWorkAssignmentsLinks | Returns workers work assignments links. |
WorkersWorkAssignmentsOccupationalClassifications | Returns workers work assignments occupational classifications. |
WorkersWorkAssignmentsWorkerGroups | Work assignments worker groups. |
WorkerTypeCode | Returns work assignement worker type code. |
WorkSchedules | View the Work Schedules. |
WorkSchedulesEntries | View the schedule days entries in Work Schedules. |
AdditionalRemunerationNameCode¶
Returns additional remuneration name code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String |
AssociatePaymentsAllocationsEarningsAndBenefits¶
View the associate payment allocation earnings and benefits in the payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
payments | String |
AssociatePaymentsAllocationsEarningSections¶
View the earning sections for the associate payments allocations in payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
ConfigurationTags | String | ||
EarningAmountValue | Double | ||
EarningClassificationCodeValue | String | ||
EarningClassificationCodeShortName | String | ||
EarningIDDescription | String | ||
EarningIDValue | String | ||
PayRateBaseUnitCodeValue | String | ||
PayRateBaseUnitCodeShortName | String | ||
PayRateValue | Double | ||
TimeWorkedQuantityValue | Double | ||
TimeWorkedQuantityunitTimeCodeValue | String | ||
TimeWorkedQuantityUnitTimeCodeShortName | String | ||
DepartmentId | String |
AssociatePaymentsAllocationsNonStatutoryDeductions¶
View the non-statutory deductions for the associate payments allocations in payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | . | |
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionTakenAmountValue | Double | ||
DeductionIDDescription | String | ||
DeductionIDValue | String | ||
DepartmentId | String |
AssociatePaymentsAllocationsStatutoryDeductions¶
View the statutory deductions for the associate payments allocations in payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionTakenAmountValue | Double | ||
AssociateTaxableAmountValue | Double | ||
ConfigurationTags | String | ||
EmployerPaidAmountValue | Double | ||
EmployerTaxableAmountValue | Double | ||
StatutoryDeductionTypeCodeValue | String | ||
StatutoryDeductionTypeCodeShortName | String | ||
StatutoryJurisdictionAdministrativeLevel1.codeValue | String | ||
StatutoryJurisdictionWorkedInIndicator | Boolean | ||
DepartmentId | String |
AssociatePaymentsSummaryEarningsAndBenefits¶
View the associate payments earnings and benefits in the payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
Payments | String |
AssociatePaymentsSummaryEarningsSections¶
View the associate payments earnings sections items in the payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
ConfigurationTags | String | ||
EarningAmountValue | Double | ||
EarningClassificationCodeValue | String | ||
EarningClassificationCodeShortName | String | ||
EarningIDDescription | String | ||
EarningIDValue | String | ||
PayRateBaseUnitCodeValue | String | ||
PayRateBaseUnitCodeShortName | String | ||
PayRateRateValue | Double | ||
PayrollAccumulations | String | ||
TimeWorkedQuantityValue | Double | ||
TimeWorkedQuantityUnitTimeCodeValue | String | ||
TimeWorkedQuantityUnitTimeCodeName | String | ||
DepartmentId | String |
AssociatePaymentsSummaryNonStatutoryDeductions¶
To view the non statutory deduction for the associate in payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection |
AssociateOID | String | ||
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionAmountValue | Double | ||
AssociateDeductionTakenAmountValue | Double | ||
DeductionIDDescription | String | ||
DeductionIDValue | String | ||
PayrollAccumulations | String | ||
DepartmentId | String |
AssociatePaymentsSummaryPayrollAccumulations¶
To View the associate payments payroll accumulations in the payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
AccumulatedAmountValue | Double | ||
AccumulatedTimeWorkedQuantityValue | Double | ||
AccumulatedTimeWorkedQuantityUnitTimeCodeValue | String | ||
AccumulatedTimeWorkedQuantityUnitTimeCodeShortName | String | ||
AccumulatorCodeValue | String | ||
AccumulatorCodeLongName | String | ||
AccumulatorCodeShortName | String | ||
AccumulatorDescription | String | ||
AccumulatorTimeUnitCodeValue | String | ||
AccumulatorTimeUnitCodeShortName | String | ||
DepartmentId | String |
AssociatePaymentsSummaryStatutoryDeductions¶
View the statutory deduction for the associate in payroll outputs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the connector.
ItemId
supports the '=' and IN comparisons.
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g=='
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
SectionCategory | String | ||
SectionName | String | ||
AssociateDeductionAmountValue | Double | ||
AssociateDeductionTakenAmountValue | Double | ||
AssociateTaxableAmountValue | Double | ||
ConfigurationTags | String | ||
EmployerPaidAmountValue | Double | ||
EmployerTaxableAmountValue | Double | ||
PayrollAccumulations | String | ||
StatutoryDeductionTypeCodeValue | String | ||
StatutoryDeductionTypeCodeASortName | String | ||
StatutoryJurisdictionAdministrativeLevel1CodeValue | String | ||
StatutoryJurisdictionWorkedInIndicator | Boolean | ||
DepartmentId | String |
CostCenters¶
Returns all Cost number codes setup for the client.
Table Specific Information¶
Select¶
No filters are supported server side for this table. All criteria will be handled client side within the connector.
For example, the following query is processed server side:
SELECT * FROM CostCenters
Columns¶
Name | Type | References | Description |
---|---|---|---|
Code | String | Code for the Cost Center. | |
Description | String | Description for the Cost Center. | |
CompanyCode | String | Payroll Group Code. | |
Active | Boolean | It indicate if the department is still in use. |
DeductionInputCode¶
Returns deduction input code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String | ||
Description | String |
EarningInputCode¶
Returns earning input code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String | ||
LongName | String | ||
Description | String |
GenerationAffixCode¶
Returns legal name generation affix code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String |
HighestEducationLevelCode¶
Returns highest education level code value.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String |
MaritalStatusCode¶
Returns marital status codes.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String | ||
Description | String |
OnboardingTemplate¶
Returns onboarding template.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | ||
Code | String | ||
Name | String |
PaidTimeOffBalances¶
Returns Paid TimeOff Balances.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM PaidTimeOffBalances WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
BalanceTypeCode | String | ||
BalanceTypeLabelName | String | ||
TotalQuantityValueNumber | Double | ||
TotalQuantityUnitTimeCode | String | ||
TotalQuantityLabelName | String | ||
TotalTime | String | ||
AccrualBalances | String | ||
PaidTimeOffEntries | String | ||
PaidTimeOffPolicyCode | String | ||
PaidTimeOffPolicyLabelName | String | ||
AsOfDate | Date | ||
PositionRefPositionID | String | ||
PositionRefSchemeName | String | ||
PositionRefSchemeAgencyName | String | ||
PositionReftitle | String |
PaidTimeOffRequestEntries¶
Returns PaidTimeOff Requests.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM PaidTimeOffRequestEntries WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
RequestID | String | ||
timeOffEntryID | String | ||
paidTimeOffID | String | ||
paidTimeOffPolicyCode | String | ||
paidTimeOffPolicyLabelName | String | ||
EntryStatusCode | String | ||
EntryStatusLabelName | String | ||
EarningTypeCode | String | ||
EarningTypeName | String | ||
StartDate | Date | ||
EndDate | Date | ||
startTime | String | ||
TotalQuantityvalueNumber | String | ||
TotalQuantityunitTimeCode | String | ||
TotalQuantitylabelName | String | ||
Meta | String |
PaidTimeOffRequests¶
Returns PaidTimeOff Requests.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM PaidTimeOffRequests WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
RequestID | String | ||
RequestStatusCode | String | ||
RequestStatusLabelName | String | ||
TotalQuantityvalueNumber | String | ||
TotalQuantityunitTimeCode | String | ||
TotalQuantitylabelName | String | ||
TotalTime | String | ||
paidTimeOffEntries | String | ||
RequestURI | String | ||
RequestDesc | String | ||
RequestStartDate | Date | ||
MetadataEntitlementCodes | String | ||
MetaMultiPeriodRequestIndicator | Boolean | ||
Actions | String | ||
RequestorComment | String | ||
ApprovalDueDate | Date | ||
PositionRefPositionID | String | ||
PositionRefSchemeName | String | ||
PositionRefSchemeAgencyName | String | ||
PositionReftitle | String |
PayrollGroup¶
Returns payroll group.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Category
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM PayrollGroup WHERE Category = 'US'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Code | String | ||
Name | String | ||
Category | String |
PersonalContacts¶
Personal emergency contacts.
Table Specific Information¶
Select¶
The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID
column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM PersonalContacts WHERE AssociateOID = 'G3349PZGBADQY8H7'
The rest of the filter is executed client-side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
PersonName | String | ||
AddressLine1 | String | ||
AddressLine2 | String | ||
AddressLine3 | String | ||
AddressCityName | String | ||
AddressCountrySubdivisionLevel1SubdivisionType | String | ||
AddressCountrySubdivisionLevel1Code | String | ||
AddressCountrySubdivisionLevel1ShortName | String | ||
AddressCountrySubdivisionLevel1LongName | String | ||
AddressCountryCode | String | ||
AddressPostalCode | String | ||
CommunicationLandlines | String | ||
CommunicationMobiles | String | ||
CommunicationEmails | String | ||
ContactTypeCode | String | ||
ContactTypeCodeShortName | String | ||
RelationshipTypeCode | String | ||
RelationshipTypeCodeShortName | String | ||
PrecedenceCode | String | ||
PrecedenceCodeShortName | String | ||
ItemID | String | ||
AssociateOID | String | Workers.AssociateOID |
QualificationAffixCode¶
Returns work assignement worker type code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String | ||
LongName | String | ||
Description | String |
ReimbursementInputCode¶
Returns reimbursement input code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String | ||
Description | String |
TeamTimeCards¶
View the Team Time Cards.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.
ManagerOID
supports the '=' comparison.
SELECT * FROM TeamTimeCards WHERE ManagerOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
PersonLegalName | String | ||
PersonLegalFamilyName1 | String | ||
PersonLegalFormattedName | String | ||
ProcessingStatusCodeValue | String | ||
ProcessingStatusCodeShortName | String | ||
periodCodeValue | String | Supported values: current, next, previous, etc. | |
periodCodeShortName | String | ||
periodCodeLongName | String | ||
TimePeriodStartDate | Date | ||
TimePeriodEndDate | Date | ||
TimePeriodPeriodStatus | String | ||
PositionID | String | ||
PeriodTotals | String | ||
DailyTotals | String | ||
TotalPeriodTimeDuration | String | ||
HomeLaborAllocations | String | ||
ExceptionsIndicator | Boolean | ||
ManagerOID | String | Workers.AssociateOID |
TeamTimeCardsDailyTotals¶
View the Team Time Cards daily totals aggregate.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.
ManagerOID
supports the '=' comparison.
SELECT * FROM TeamTimeCardsDailyTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
EntryDate | Date | ||
PayCodeCodeValue | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String | ||
HomeLaborAllocations | String | ||
DayEntries | String | ||
ManagerOID | String | Workers.AssociateOID |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
periodCodeValue | String | |
TimePeriodStartDate | String |
TeamTimeCardsHomeLaborAllocations¶
View the Team Time Cards period totals aggregate.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.
ManagerOID
supports the '=' comparison.
SELECT * FROM TeamTimeCardsHomeLaborAllocations WHERE ManagerOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
AllocationCode | String | ||
AllocationTypeCodeValue | String | ||
AllocationTypeCodeShortName | String | ||
ManagerOID | String | Workers.AssociateOID |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
periodCodeValue | String | |
TimePeriodStartDate | String |
TeamTimeCardsPeriodTotals¶
View the Team Time Cards period totals aggregate.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the connector.
ManagerOID
supports the '=' comparison.
SELECT * FROM TeamTimeCardsPeriodTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
payCodecodeValue | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String | ||
ManagerOID | String | Workers.AssociateOID |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
periodCodeValue | String | |
TimePeriodStartDate | String |
TimeCards¶
View the worker Time Cards.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM TimeCards WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
PersonLegalName | String | ||
PersonLegalFamilyName1 | String | ||
PersonLegalFormattedName | String | ||
ProcessingStatusCodeValue | String | ||
ProcessingStatusCodeShortName | String | ||
periodCodeValue | String | Supported values: current, next, previous, etc. | |
periodCodeShortName | String | ||
periodCodeLongName | String | ||
TimePeriodStartDate | Date | ||
TimePeriodEndDate | Date | ||
TimePeriodPeriodStatus | String | ||
PositionID | String | ||
ExceptionCounts | String | ||
PeriodTotals | String | ||
DailyTotals | String | ||
TotalPeriodTimeDuration | String | ||
HomeLaborAllocations | String | ||
Actions | String |
TimeCardsDailyTotals¶
View the worker Time Cards daily totals aggregate.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM TimeCardsDailyTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
EntryDate | Date | ||
PayCodeCodeValue | String | ||
PayCodeShortName | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
periodCodeValue | String | |
TimePeriodStartDate | String |
TimeCardsPeriodTotals¶
View the worker Time Cards period totals aggregate.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.
SELECT * FROM TimeCardsPeriodTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
payCodecodeValue | String | ||
payCodeshortName | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
periodCodeValue | String | |
TimePeriodStartDate | String |
WageLawCoverageCode¶
Returns wage law coverage code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String |
WorkAssignmentCustomHistoryCustomGroupAmountFields¶
Work assignment CustomGroup amount.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AmountValue | Integer | ||
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CurrencyCode | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupCodeFields¶
Work assignment CustomGroup code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CodeValue | String | ||
ItemID | String | ||
LongName | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
ShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupDateFields¶
Work assignment CustomGroup date.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
DateValue | Date | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupDateTimeFields¶
Work assignment CustomGroup date time.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
DateTimeValue | Datetime | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupIndicatorFields¶
Work assignment CustomGroup indicator.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
IndicatorValue | Boolean | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupLinks¶
Work assignment CustomGroup links.
Columns¶
Name | Type | References | Description |
---|---|---|---|
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupNumberFields¶
Work assignment CustomGroup number.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NumberValue | Integer | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupPercentFields¶
Work assignment CustomGroup percent.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
PercentValue | Integer | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupStringFields¶
Work assignment CustomGroup string.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
StringValue | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentCustomHistoryCustomGroupTelephoneFields¶
Work assignment CustomGroup telephone.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Access | String | ||
AreaDialing | String | ||
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistory¶
Work assignment history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
PrimaryIndicator | Boolean | ||
OfferExtensionDate | Date | ||
OfferAcceptanceDate | Date | ||
HireDate | Date | ||
SeniorityDate | Date | ||
ExpectedStartDate | Date | ||
ActualStartDate | Date | ||
TerminationDate | Date | ||
AssignmentStatusCode | String | ||
AssignmentStatusCodeValue | String | ||
AssignmentStatusLongName | String | ||
AssignmentStatusreasonCodeValue | String | ||
AssignmentStatusreasonCodeShortName | String | ||
AssignmentStatusreasonCodeLongName | String | ||
AssignmentStatusEffectiveDate | Date | ||
WorkerTypeCodeValue | String | ||
WorkerTypeShortName | String | ||
WorkerTypeLongName | String | ||
AssignmentTermCodeValue | String | ||
AssignmentTermCodeShortName | String | ||
AssignmentTermCodeLongName | String | ||
WorkLevelCodeValue | String | ||
WorkLevelCodeShortName | String | ||
WorkLevelCodeLongName | String | ||
NationalityContextCodeValue | String | ||
NationalityContextCodeShortName | String | ||
NationalityContextCodeLongName | String | ||
VipIndicator | Boolean | ||
VipTypeCodeValue | String | ||
VipTypeCodeShortName | String | ||
VipTypeCodeLongName | String | ||
ExecutiveIndicator | Boolean | ||
ExecutiveTypeCodeValue | String | ||
ExecutiveTypeCodeShortName | String | ||
ExecutiveTypeCodeLongName | String | ||
OfficerIndicator | Boolean | ||
OfficerTypeCodeValue | String | ||
OfficerTypeCodeShortName | String | ||
OfficerTypeCodeLongName | String | ||
ManagementPositionIndicator | Boolean | ||
LegalEntityID | String | ||
HighlyCompensatedIndicator | Boolean | ||
HighlyCompensatedTypeCodeValue | String | ||
HighlyCompensatedTypeCodeShortName | String | ||
HighlyCompensatedTypeCodeLongName | String | ||
StockOwnerIndicator | Boolean | ||
StockOwnerPercentage | Double | ||
JobCodeValue | String | ||
JobCodeShortName | String | ||
JobCodeLongName | String | ||
JobTitle | String | ||
WageLawCoverageCodeValue | String | ||
WageLawCoverageCodeShortName | String | ||
WageLawCoverageCodeLongName | String | ||
WageLawCoverageLawNameCodeValue | String | ||
WageLawCoverageLawNameCodeShortName | String | ||
WageLawCoverageLawNameCodeLongName | String | ||
PositionID | String | ||
PositionTitle | String | ||
LaborUnionCodeValue | String | ||
LaborUnionshortName | String | ||
LaborUnionlongName | String | ||
LaborUnionSeniorityDate | Date | ||
BargainingUnitCodeValue | String | ||
BargainingUnitshortName | String | ||
BargainingUnitlongName | String | ||
BargainingUnitSeniorityDate | Date | ||
WorkShiftCodeValue | String | ||
WorkShiftCodeshortName | String | ||
WorkShiftCodelongName | String | ||
WorkArrangementCodeValue | String | ||
WorkArrangementCodeshortName | String | ||
WorkArrangementCodelongName | String | ||
StandardHoursQuality | String | ||
StandardHoursCodeValue | Integer | ||
StandardHoursCodeshortName | String | ||
StandardHoursCodelongName | String | ||
FullTimeEquivalenceRatio | Integer | ||
HomeWorkLocationCodeValue | String | ||
HomeWorkLocationCodeshortName | String | ||
HomeWorkLocationCodelongName | String | ||
HomeWorkLocationAddressScriptCodeValue | String | ||
HomeWorkLocationAddressScriptCodeshortName | String | ||
HomeWorkLocationAddressScriptCodelongName | String | ||
HomeWorkLocationAddresslineFour | String | ||
HomeWorkLocationAddresslineFive | String | ||
HomeWorkLocationAddressbuildingNumber | String | ||
HomeWorkLocationAddressbuildingName | String | ||
HomeWorkLocationAddressblockName | String | ||
HomeWorkLocationAddressstreetName | String | ||
HomeWorkLocationAddressstreetTypeCodeValue | String | ||
HomeWorkLocationAddressstreetTypeCodeshortName | String | ||
HomeWorkLocationAddressstreetTypeCodelongName | String | ||
HomeWorkLocationAddressunit | String | ||
HomeWorkLocationAddressfloor | String | ||
HomeWorkLocationAddressstairCase | String | ||
HomeWorkLocationAddressdoor | String | ||
HomeWorkLocationAddresspostOfficeBox | String | ||
HomeWorkLocationAddressdeliveryPoint | String | ||
HomeWorkLocationAddressplotID | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2Value | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2shortName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2longName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2subdivisionType | String | ||
HomeWorkLocationAddressnameCodeValue | String | ||
HomeWorkLocationAddressnameCodeshortName | String | ||
HomeWorkLocationAddressnameCodelongName | String | ||
HomeWorkLocationAddressattentionOfName | String | ||
HomeWorkLocationAddresscareOfName | String | ||
HomeWorkLocationAddresslineOne | String | ||
HomeWorkLocationAddresslineTwo | String | ||
HomeWorkLocationAddresslineThree | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1Value | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1shortName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1longName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1subdivisionType | String | ||
HomeWorkLocationAddresscountryCode | String | ||
HomeWorkLocationAddresspostalCode | String | ||
HomeWorkLocationAddressgeoCoordinateLatitude | Double | ||
HomeWorkLocationAddressgeoCoordinateLongitude | Double | ||
RemunerationBasisCodeValue | String | ||
RemunerationBasisCodeshortName | String | ||
RemunerationBasisCodelongName | String | ||
PayCycleCodeValue | String | ||
PayCycleCodeshortName | String | ||
PayCycleCodelongName | String | ||
StandardPayPeriodHourshoursQuantity | Integer | ||
StandardPayPeriodHoursCodeValue | String | ||
StandardPayPeriodHoursCodeshortName | String | ||
StandardPayPeriodHoursCodelongName | String | ||
BaseRemunerationhourlyRateAmountcodeValue | String | ||
BaseRemunerationhourlyRateAmountshortName | String | ||
BaseRemunerationhourlyRateAmountlongName | String | ||
BaseRemunerationhourlyRateAmountValue | String | ||
BaseRemunerationhourlyRateAmountCurrencyCode | String | ||
BaseRemunerationdailyRateAmountcodeValue | String | ||
BaseRemunerationdailyRateAmountshortName | String | ||
BaseRemunerationdailyRateAmountlongName | String | ||
BaseRemunerationdailyRateAmountValue | String | ||
BaseRemunerationdailyRateAmountCurrencyCode | String | ||
BaseRemunerationweeklyRateAmountcodeValue | String | ||
BaseRemunerationweeklyRateAmountshortName | String | ||
BaseRemunerationweeklyRateAmountlongName | String | ||
BaseRemunerationweeklyRateAmountValue | String | ||
BaseRemunerationweeklyRateAmountCurrencyCode | String | ||
BaseRemunerationbiweeklyRateAmountcodeValue | String | ||
BaseRemunerationbiweeklyRateAmountshortName | String | ||
BaseRemunerationbiweeklyRateAmountlongName | String | ||
BaseRemunerationbiweeklyRateAmountValue | String | ||
BaseRemunerationbiweeklyRateAmountCurrencyCode | String | ||
BaseRemunerationsemiMonthlyRateAmountcodeValue | String | ||
BaseRemunerationsemiMonthlyRateAmountshortName | String | ||
BaseRemunerationsemiMonthlyRateAmountlongName | String | ||
BaseRemunerationsemiMonthlyRateAmountValue | String | ||
BaseRemunerationsemiMonthlyRateAmountCurrencyCode | String | ||
BaseRemunerationmonthlyRateAmountcodeValue | String | ||
BaseRemunerationmonthlyRateAmountshortName | String | ||
BaseRemunerationmonthlyRateAmountlongName | String | ||
BaseRemunerationmonthlyRateAmountValue | String | ||
BaseRemunerationmonthlyRateAmountCurrencyCode | String | ||
BaseRemunerationannualRateAmountcodeValue | String | ||
BaseRemunerationannualRateAmountshortName | String | ||
BaseRemunerationannualRateAmountlongName | String | ||
BaseRemunerationannualRateAmountValue | String | ||
BaseRemunerationannualRateAmountCurrencyCode | String | ||
BaseRemunerationpayPeriodRateAmountcodeValue | String | ||
BaseRemunerationpayPeriodRateAmountshortName | String | ||
BaseRemunerationpayPeriodRateAmountlongName | String | ||
BaseRemunerationpayPeriodRateAmountValue | String | ||
BaseRemunerationpayPeriodRateAmountCurrencyCode | String | ||
BaseRemunerationcommissionRatePercentagecodeValue | String | ||
BaseRemunerationcommissionRatePercentageshortName | String | ||
BaseRemunerationcommissionRatePercentagelongName | String | ||
BaseRemunerationcommissionRatePercentageValue | String | ||
BaseRemunerationcommissionRatePercentagebaseUnitCodeValue | String | ||
BaseRemunerationcommissionRatePercentageCurrencyCodeshortName | String | ||
BaseRemunerationcommissionRatePercentageCurrencyCodelongName | String | ||
BaseRemunerationeffectiveDate | Date | ||
PayrollProcessingStatusCodecodeValue | String | ||
PayrollProcessingStatusCodeshortName | String | ||
PayrollProcessingStatusCodelongName | String | ||
PayrollProcessingStatusCodeEffectiveDate | Date | ||
PayrollGroupCode | String | ||
PayrollFileNumber | String | ||
PayrollRegionCode | String | ||
PayScaleCodecodeValue | String | ||
PayScaleCodeshortName | String | ||
PayScaleCodelongName | String | ||
PayGradeCodecodeValue | String | ||
PayGradeCodeshortName | String | ||
PayGradeCodelongName | String | ||
PayGradePayRangeminimumRateamountValue | String | ||
PayGradePayRangeminimumRatecurrencyCode | String | ||
PayGradePayRangeminimumRateUnitCodeValue | String | ||
PayGradePayRangeminimumRateUnitshortName | String | ||
PayGradePayRangeminimumRateUnitlongName | String | ||
PayGradePayRangeminimumRateBaseUnitCodeValue | String | ||
PayGradePayRangeminimumRateBaseUnitshortName | String | ||
PayGradePayRangeminimumRateBaseUnitlongName | String | ||
PayGradePayRangeminimumRatebaseMultiplierValue | Integer | ||
PayGradePayRangemedianRateamountValue | String | ||
PayGradePayRangemedianRatecurrencyCode | String | ||
PayGradePayRangemedianRateUnitCodeValue | String | ||
PayGradePayRangemedianRateUnitshortName | String | ||
PayGradePayRangemedianRateBaseUnitCodeValue | String | ||
PayGradePayRangemedianRateBaseUnitshortName | String | ||
PayGradePayRangemedianRateBaseUnitlongName | String | ||
PayGradePayRangemedianRatebaseMultiplierValue | Integer | ||
PayGradePayRangemaximumRateamountValue | String | ||
PayGradePayRangemaximumRatecurrencyCode | String | ||
PayGradePayRangemaximumRateUnitCodeValue | String | ||
PayGradePayRangemaximumRateUnitshortName | String | ||
PayGradePayRangemaximumRateUnitlongName | String | ||
PayGradePayRangemaximumRateBaseUnitCodeValue | String | ||
PayGradePayRangemaximumRateBaseUnitshortName | String | ||
PayGradePayRangemaximumRateBaseUnitlongName | String | ||
PayGradePayRangemaximumRatebaseMultiplierValue | Integer | ||
CompaRatio | Double | ||
PayGradeStepCodeValue | String | ||
PayGradeStepshortName | String | ||
PayGradeSteplongName | String | ||
PayGradeStepPayRateamountValue | String | ||
PayGradeStepPayRatecurrencyCode | String | ||
PayGradeStepPayRateUnitCodeValue | String | ||
PayGradeStepPayRateUnitshortName | String | ||
PayGradeStepPayRateUnitlongName | String | ||
PayGradeStepPayRateBaseUnitCodeValue | String | ||
PayGradeStepPayRateBaseUnitshortName | String | ||
PayGradeStepPayRateBaseUnitlongName | String | ||
PayGradeStepPayRatebaseMultiplierValue | Integer | ||
NextPayGradeStepDate | Date | ||
MinimumPayGradeStepDuration | String | ||
GeographicPayDifferentialCodeValue | String | ||
GeographicPayDifferentialshortName | String | ||
GeographicPayDifferentiallongName | String | ||
GeographicPayDifferentialPercentage | Double | ||
ItemID | String | ||
EffectiveDate | Date | ||
FromDate | Date | ||
ThruDate | Date | ||
HistoryEventID | String | ||
HistoryEventNameCodeValue | String | ||
HistoryEventNameshortName | String | ||
HistoryEventNamelongName | String | ||
HistoryReasonCodeValue | String | ||
HistoryReasonshortName | String | ||
HistoryReasonlongName | String | ||
HistoryEventActorId | String | ||
HistoryEventActorCodeValue | String | ||
HistoryEventActorshortName | String | ||
HistoryEventActorlongName | String | ||
HistoryEventActorassociateOID | String | ||
HistoryEventActorpersonOID | String | ||
HistoryEventActorformattedName | String | ||
HistoryEventActordeviceID | String | ||
HistoryEventActorlatitude | Double | ||
HistoryEventActorlongitude | Double | ||
HistoryEventActordeviceUserAgentID | String | ||
WorkAssignmentID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryAdditionalRemunerations¶
Work assignment additionsla remunerations history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
TypeCodeValue | String | ||
TypeCodeCodeshortName | String | ||
TypeCodeCodelongName | String | ||
IntervalCodeCodeValue | String | ||
IntervalCodeCodeCodeshortName | String | ||
IntervalCodeCodeCodelongName | String | ||
NameCodeCodeValue | String | ||
NameCodeCodeCodeshortName | String | ||
NameCodeCodeCodelongName | String | ||
RateAmountValue | Integer | ||
RateCurrencyCode | String | ||
RateUnitCode | String | ||
RateshortName | String | ||
RateLongName | String | ||
RateBaseUnitCode | String | ||
RateBaseshortName | String | ||
RateBaseLongName | String | ||
BaseMultiplierValue | Integer | ||
ItemID | String | ||
EffectiveDate | Date | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryAssignedOrganizationalUnits¶
Work assignment organization units history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
NameCodeValue | String | ||
NameCodeshortName | String | ||
NameCodelongName | String | ||
TypeCodeValue | String | ||
TypeCodeshortName | String | ||
TypeCodelongName | String | ||
itemID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryAssignedWorkLocations¶
Work assignment Assigned locations history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
AddressScriptCode | String | ||
AddressShortName | String | ||
AddressLongName | String | ||
AddressLineFour | String | ||
AddressLineFive | String | ||
AddressBuildingNumber | String | ||
AddressBuildingName | String | ||
AddressBlockName | String | ||
AddressStreetName | String | ||
AddressStreetTypeCode | String | ||
AddressStreetTypeShortName | String | ||
AddressStreetTypeLongName | String | ||
AddressUnit | Integer | ||
AddressFloor | String | ||
AddressStairCase | String | ||
AddressDoor | String | ||
AddressPostOfficeBox | String | ||
AddressDeliveryPoint | String | ||
AddressPlotID | String | ||
AddressCountrySubdivisionLevel2 | String | ||
AddressCountrySubdivisionLevel2ShortName | String | ||
AddressCountrySubdivisionLevel2LongName | String | ||
AddressCountrySubdivisionLevel2Type | String | ||
AddressCountrySubdivisionLevel1 | String | ||
AddressCountrySubdivisionShortName | String | ||
AddressCountrySubdivisionLongName | String | ||
AddressCountrySubdivisionType | String | ||
AddressNameCode | String | ||
AddressNameShortName | String | ||
AddressNameLongName | String | ||
AddressAttentionOfName | String | ||
AddressCareOfName | String | ||
AddressLineOne | String | ||
AddressLineTwo | String | ||
AddressLineThree | String | ||
AddressCityName | String | ||
AddressCountryCode | String | ||
AddressPostalCode | String | ||
AddressLatitude | Double | ||
AddressLongitude | Double | ||
NameCode | String | ||
NameShortName | String | ||
NameLongName | String |
WorkAssignmentHistoryCommunicationsEmails¶
Work assignment communication history mail.
Columns¶
Name | Type | References | Description |
---|---|---|---|
EmailUri | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsFaxes¶
Work assignment communication Fax History.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsInstantMessages¶
Work assignment communication message History.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsInternetAddresses¶
Work assignment communication Internet address History.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsLandlines¶
Work assignment communication landline history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsMobiles¶
Work assignment communication mobile History.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsPagers¶
Work assignment communication Pager History.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryCommunicationsSocialNetworks¶
Work assignment communication social network history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryHomeOrganizationalUnits¶
Work assignment Home organization history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
NameCodeValue | String | ||
NameCodeshortName | String | ||
NameCodelongName | String | ||
TypeCodeValue | String | ||
TypeCodeshortName | String | ||
TypeCodelongName | String | ||
itemID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryIndustryClassifications¶
Work assignment industry classification history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
classificationCodeValue | String | ||
classificationCodeshortName | String | ||
classificationCodelongName | String | ||
itemID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryOccupationalClassifications¶
Work assignment occupational classification history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
classificationCodeValue | String | ||
classificationCodeshortName | String | ||
classificationCodelongName | String | ||
itemID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkAssignmentHistoryReport¶
Work assignment Report.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerIDValue | String | Workers.WorkerID | |
WorkerIDschemeCode | String | ||
WorkerIDShortName | String | ||
WorkerIDLongName | String | ||
WorkerGivenName | String | ||
WorkerMiddleName | String | ||
WorkerFamilyName1 | String | ||
WorkerFamilyName2 | String | ||
WorkerFormattedName | String | ||
RelationshipCode | String | ||
RelationshipShortName | String | ||
RelationshipLongName | String | ||
PositionID | String | ||
PositionTitle | String | ||
ItemID | String |
WorkAssignmentHistoryWorkerGroups¶
Work assignment group history.
Columns¶
Name | Type | References | Description |
---|---|---|---|
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
GroupCodeValue | String | ||
GroupCodeshortName | String | ||
GroupCodelongName | String | ||
itemID | String | ||
AssociateOID | String | Workers.AssociateOID |
WorkerDemographics¶
Returns a list of demographics for each worker in the organization.
Table Specific Information¶
Select¶
The connector uses the ADP API to process WHERE clause conditions built with the AssociateOID
column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM WorkerDemographics WHERE AssociateOID = 'G3349PZGBADQY8H7'
The rest of the filter is executed client-side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID [KEY] | String | Workers.AssociateOID | Associate OID of Worker Demographics |
WorkerID | String | Workers.WorkerID | WorkerID of Worker Demographicsof Worker Demographics |
GivenName | String | GivenName of Worker Demographics | |
FamilyName | String | FamilyName of Worker Demographics | |
AddressCode | String | AddressCode of Worker Demographics | |
AddressShortName | String | AddressShortName of Worker Demographics | |
AddressLineOne | String | AddressLineOne of Worker Demographics | |
CityName | String | CityName of Worker Demographics | |
CountrySubdivisionLevelCode | String | CountrySubdivisionLevelCode of Worker Demographics | |
CountrySubdivisionType | String | CountrySubdivisionType of Worker Demographics | |
CountrySubdivisionShortName | String | CountrySubdivisionShortName of Worker Demographics | |
AddressCountryCode | String | AddressCountryCode of Worker Demographics | |
AddressPostalCode | String | AddressPostalCode of Worker Demographics | |
CommunicationLandlines | String | CommunicationLandlines of Worker Demographics | |
CommunicationMobiles | String | CommunicationMobiles of Worker Demographics | |
CommunicationFaxes | String | CommunicationFaxes of Worker Demographics | |
CommunicationPagers | String | CommunicationPagers of Worker Demographics | |
CommunicationEmails | String | CommunicationEmails of Worker Demographics | |
GenderCode | String | GenderCode of Worker Demographics | |
GenderCodeShortName | String | GenderCodeShortName of Worker Demographics | |
MaritalStatusCode | String | MaritalStatusCode of Worker Demographics | |
MaritalStatusShortName | String | MaritalStatusShortName of Worker Demographics | |
DisabledIndicatior | Boolean | DisabledIndicatior of Worker Demographics | |
BirthName | String | BirthName of Worker Demographics | |
OtherPersonalAddresses | String | OtherPersonalAddresses of Worker Demographics | |
RaceCodeIdentificationMethodCode | String | RaceCodeIdentificationMethodCode of Worker Demographics | |
RaceCodeIdentificationMethodShortName | String | RaceCodeIdentificationMethodShortName of Worker Demographics | |
RaceCodeShortName | String | RaceCodeShortName of Worker Demographics | |
RaceCode | String | RaceCode of Worker Demographics | |
HireDate | Date | HireDate of Worker Demographics | |
WorkerStatusCode | String | WorkerStatusCode of Worker Demographics | |
BusinessCommunicationLandlines | String | BusinessCommunicationLandlines of Worker Demographics | |
BusinessCommunicationMobiles | String | BusinessCommunicationMobiles of Worker Demographics | |
BusinessCommunicationFaxes | String | BusinessCommunicationFaxes of Worker Demographics | |
BusinessCommunicationEmails | String | BusinessCommunicationEmails of Worker Demographics | |
BusinessCommunicationPagers | String | BusinessCommunicationPagers of Worker Demographics | |
WorkAssignments | String | WorkAssignments of Worker Demographics |
WorkersBusinessCommunicationEmails¶
Returns workers business communication emails.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersBusinessCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersBusinessCommunicationEmails WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersBusinessCommunicationFaxes¶
Returns workers business communication faxes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersBusinessCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersBusinessCommunicationLandlines¶
Returns workers business communication landlines.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersBusinessCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersBusinessCommunicationMobiles¶
Returns workers business communication mobiles.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersBusinessCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersBusinessCommunicationPagers¶
Returns workers business communication pagers.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersBusinessCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersBusinessCommunicationPagers WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersPersonBirthNamePreferredSalutations¶
Returns workers person birth name preferred salutations.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
SalutationCode | String | ||
SalutationLongName | String | ||
SalutationShortName | String | ||
SequenceNumber | Integer | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
WorkersPersonBirthNameTitleAffixCodes¶
Returns workers person birth name title affix codes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
WorkersPersonBirthNameTitlePrefixCodes¶
Returns workers person birth name title prefix codes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
PrefixCode | String | ||
PrefixCodeLongName | String | ||
PrefixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
WorkersPersonGovernmentIDs¶
Returns workers person government IDs.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonGovernmentIDs WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonGovernmentIDs WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonGovernmentIDs WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
CountryCode | String | ||
ExpirationDate | Date | ||
IdValue | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
StatusCode | String | ||
StatusCodeEffectiveDate | Date | ||
StatusCodeLongName | String | ||
StatusCodeShortName | String | ||
AsOfDate | Date |
WorkersPersonLegalNamePreferredSalutations¶
Returns workers person legal name preferred salutations.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
SalutationCode | String | ||
SalutationCodeLongName | String | ||
SalutationCodeShortName | String | ||
SequenceNumber | Integer | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
WorkersPersonLegalNameTitleAffixCodes¶
Returns workers person legal name title affix codes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
WorkersPersonLegalNameTitlePrefixCodes¶
Returns workers person legal name title prefix codes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
WorkersPersonMilitaryClassificationCodes¶
Returns workers person military classification codes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
CodeValue | String | ||
LongName | String | ||
ShortName | String | ||
AsOfDate | Date |
WorkersPhotoLinks¶
Returns workers photo links.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotoLinks WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPhotoLinks WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPhotoLinks WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
CanonicalUri | String | ||
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AsOfDate | Date |
WorkersPhotos¶
Returns workers photos.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotos WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersPhotos WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersPhotos WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
ItemID | String | ||
Links | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentReportsTo¶
Returns workers work assignment ReportsTo.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentReportsTo WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
WorkAssignmentsAssociateOID | String | ||
WorkAssignmentsWorkerID | String | ||
ItemID | String | ||
PositionID | String | ||
PositionTitle | String | ||
ReportsToRelationshipCode | String | ||
ReportsToRelationshipCodeLongName | String | ||
ReportsToRelationshipCodeShortName | String | ||
ReportsToWorkerNameFamilyName1 | String | ||
ReportsToWorkerNameFamilyName2 | String | ||
ReportsToWorkerNameFormattedName | String | ||
ReportsToWorkerNameGivenName | String | ||
ReportsToWorkerNameMiddleName | String | ||
WorkerIDSchemeCode | String | ||
WorkerIDSchemeCodeLongName | String | ||
WorkerIDSchemeCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedOrganizationalUnits¶
Returns workers work assignments assigned organizational units.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocations¶
Returns workers work assignments assigned work locations.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
AddressAttentionOfName | String | ||
AddressBlockName | String | ||
AddressBuildingName | String | ||
AddressBuildingNumber | String | ||
AddressCareOfName | String | ||
AddressCityName | String | ||
AddressCountryCode | String | ||
AddressCountrySubdivisionLevel1CodeValue | String | ||
AddressCountrySubdivisionLevel1LongName | String | ||
AddressCountrySubdivisionLevel1ShortName | String | ||
AddressCountrySubdivisionLevel1SubdivisionType | String | ||
AddressCountrySubdivisionLevel2CodeValue | String | ||
AddressCountrySubdivisionLevel2LongName | String | ||
AddressCountrySubdivisionLevel2ShortName | String | ||
AddressCountrySubdivisionLevel2SubdivisionType | String | ||
AddressDeliveryPoint | String | ||
AddressDoor | String | ||
AddressFloor | String | ||
AddressGeoCoordinateLatitude | Integer | ||
AddressGeoCoordinateLongitude | Integer | ||
AddressLineFive | String | ||
AddressLineFour | String | ||
AddressLineOne | String | ||
AddressLineThree | String | ||
AddressLineTwo | String | ||
AddressNameCode | String | ||
AddressNameCodeLongName | String | ||
AddressNameCodeShortName | String | ||
AddressPlotID | String | ||
AddressPostalCode | String | ||
AddressPostOfficeBox | String | ||
AddressScriptCodeValue | String | ||
AddressScriptCodeLongName | String | ||
AddressScriptCodeShortName | String | ||
AddressStairCase | String | ||
AddressStreetName | String | ||
AddressStreetTypeCode | String | ||
AddressStreetTypeCodeLongName | String | ||
AddressStreetTypeCodeShortName | String | ||
addressUnit | String | ||
CommunicationEmails | String | ||
CommunicationFaxes | String | ||
CommunicationLandlines | String | ||
CommunicationMobiles | String | ||
CommunicationPagers | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails¶
Returns workers work assignments assigned work locations communication emails.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes¶
Returns workers work assignments assigned work locations communication faxes.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines¶
Returns workers work assignments assigned work locations communication landlines.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles¶
Returns workers work assignments assigned work locations communication mobiles.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers¶
Returns workers work assignments assigned work locations communication pagers.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeOrganizationalUnits¶
Returns workers work assignments home organizational units.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
ItemID | String | ||
NameCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
TypeCodeValue | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails¶
Returns workers work assignments home work location communication emails.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeWorkLocationCommunicationInstantMessages¶
Returns workers work assignments home work location communication instant messages.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines¶
Returns workers work assignments home work location communication landlines.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles¶
Returns workers work assignments home work location communication mobiles.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers¶
Returns workers work assignments home work location communication pagers.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
WorkersWorkAssignmentsIndustryClassifications¶
Returns workers work assignments industry classifications.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
ClassificationCode | String | ||
ClassificationCodeLongName | String | ||
ClassificationCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsLinks¶
Returns workers work assignments links.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsLinks WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsLinks WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsLinks WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
CanonicalUri | String | ||
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsOccupationalClassifications¶
Returns workers work assignments occupational classifications.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
ClassificationCode | String | ||
ClassificationCodeLongName | String | ||
ClassificationCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
WorkersWorkAssignmentsWorkerGroups¶
Work assignments worker groups.
Table Specific Information¶
Select¶
The connector will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
AssociateOID
supports the '=' comparison.WorkerID
supports the '=' comparison.AsOfDate
supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AssociateOID = 'G3349PZGBADQY8H7'
SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE WorkerID = 'DRH9M9NPW'
SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AsOfDate = '2020-01-01'
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | Workers.AssociateOID | |
WorkerID | String | Workers.WorkerID | |
GroupCode | String | ||
GroupCodeLongName | String | ||
GroupCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
WorkerTypeCode¶
Returns work assignement worker type code.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CodeValue | String | ||
ShortName | String |
WorkSchedules¶
View the Work Schedules.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | ||
ScheduleID | String | ||
WorkerName | String | ||
WorkerFamilyName1 | String | ||
WorkerFormattedName | String | ||
workAssignmentID | String | ||
schedulePeriodStartDate | Date | ||
schedulePeriodEndDate | Date | ||
scheduleDays | String |
WorkSchedulesEntries¶
View the schedule days entries in Work Schedules.
Columns¶
Name | Type | References | Description |
---|---|---|---|
AssociateOID | String | ||
ScheduleID | String | ||
WorkerFormattedName | String | ||
workAssignmentID | String | ||
ScheduleEntryID | String | ||
DaySequenceNumber | String | ||
ScheduleDayDate | Date | ||
Actions | String | ||
categoryTypeCode | String | ||
ShiftTypeCode | String | ||
EarningAllocations | String | ||
EntryComments | String | ||
PayCodeValue | String | ||
PayCodeShortName | String | ||
EntryStatusCode | String | ||
StateDateTimePeriod | Datetime | ||
EndDateTimePeriod | Datetime | ||
StartDatePeriod | Date | ||
EndDatePeriod | Date | ||
TotalTimeValue | String | ||
TotalTimeNameCode | String | ||
TotalTimeNameCodeShortName | String | ||
ScheduledHoursQuantity | String |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with ADP.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from ADP, along with an indication of whether the procedure succeeded or failed.
ADP Connector Stored Procedures¶
Name | Description |
---|---|
GetOAuthAccessToken | Gets an authentication token from ADP. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with ADP. |
GetOAuthAccessToken¶
Gets an authentication token from ADP.
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with ADP. |
ExpiresIn | String | The remaining lifetime on the access token. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with ADP.
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with ADP. |
ExpiresIn | String | The remaining lifetime on the access token. |
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 ADP:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
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, including batch operations:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Workers table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Workers'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Workers table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Workers'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:adp:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
UseUAT | Whether the connection should be made to an ADP UAT account. |
MaskSensitiveData | To mask the sensitive data in the resultset. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLClientCert | The certificate provided by ADP during Registration. |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
UseUAT | Whether the connection should be made to an ADP UAT account. |
MaskSensitiveData | To mask the sensitive data in the resultset. |
UseUAT¶
Whether the connection should be made to an ADP UAT account.
Data Type¶
bool
Default Value¶
false
Remarks¶
To connect to a ADP UAT account, set UseUAT
= true.
MaskSensitiveData¶
To mask the sensitive data in the resultset.
Data Type¶
bool
Default Value¶
true
Remarks¶
To mask the sensitive data in the resultset.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\ADP Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\ADP Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLClientCert | The certificate provided by ADP during Registration. |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLClientCert¶
The certificate provided by ADP during Registration.
Data Type¶
string
Default Value¶
""
Remarks¶
The certificate provided by ADP during Registration. The connector requires a PXF or PFXBLOB type.
SSLClientCertType¶
The type of key store containing the TLS/SSL client certificate.
Possible Values¶
AUTO
, USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
AUTO
Remarks¶
This property can take one of the following values:
Property | Description |
---|---|
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword¶
The password for the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\ADP Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\ADP Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
RowScanDepth¶
The maximum number of rows to scan for the custom fields columns available in the table.
Data Type¶
string
Default Value¶
100
Remarks¶
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly.
IncludeCustomFields¶
A boolean indicating if you would like to include custom fields in the column listing.
Data Type¶
bool
Default Value¶
true
Remarks¶
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UsePayrollEndpoint¶
Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API.
Data Type¶
bool
Default Value¶
false
Remarks¶
Set this to true may affect the performance of above views.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Workers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.