Zum Inhalt springen

Details zur Paylocity-Verbindung

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.9039 des Connectors.

Erste Schritte

Paylocity Versionsunterstützung

Der Connector nutzt die Paylocity API, um einen bidirektionalen Zugriff auf Paylocity zu ermöglichen.

Herstellen einer Verbindung

Mit Paylocity verbinden

Paylocity bietet zwei Verbindungsmöglichkeiten: über die Pay Entry API und über die Standard Paylocity API.

Legen Sie vor dem Herstellen der Verbindung die folgenden Eigenschaften fest (sofern zutreffend):

  • Wenn Sie ein Sandbox-Konto verwenden, setzen Sie UseSandbox Zu true; ansonsten, false.
  • Wenn IncludeCustomFields Ist true, Satz CustomFieldsCategory zur Kategorie „Benutzerdefinierte Felder“. Der Standardwert für diese Eigenschaft ist PayrollAndHR.

Für Websites, die sich für die Verschlüsselung entschieden haben:

  • Legen Sie nur eine der folgenden Verschlüsselung fest:
    • Key: Der symmetrische AES-Schlüssel (Base 64-kodiert) wird mit dem öffentlichen Schlüssel von Paylocity verschlüsselt. Dieser Schlüssel wird zum verschlüsseln von Paylocity Inhalten verwendet. Paylocity entschlüsselt den AES-Schlüssel mithilfe der RSA-Entschlüsselung.
      Wird verwendet, wenn IVWert wurde nicht angegeben.
    • IV: Der AES IV (Base 64-kodiert), der bei der Verschlüsselung von Paylocity verwendet wird. Wenn nein KeyWert angegeben ist, IV wird intern generiert.
  • Wenn die RSA Verschlüsselung in Ihrem Paylocity-Konto aktiviert ist, setzen Sie RSAPublicKey zum RSA-Schlüssel, der mit Ihrem Paylocity verknüpft ist. (Diese Eigenschaft ist zum Ausführen von Insert- und Update-Anweisungen erforderlich.) Wenn die Funktion deaktiviert ist, wird sie nicht benötigt.
Die Pay Entry API

Die Pay Entry API ist eine äußerst eingeschränkte Verbindung, die es Benutzern ermöglicht, automatisch Gehaltsabrechnungsinformationen für einzelne Mitarbeiter zu übermitteln, und sonst kaum etwas. Aufgrund der äußerst eingeschränkten Natur dessen, was die Pay Entry API bietet, verfügt sie nicht über ein separates Schema. Es kann jedoch

aktiviert über den UsePayEntryAPI Verbindungseigenschaft.

Die Pay Entry API ist vollständig vom Rest der Paylocity API getrennt. Sie verwendet eine separate Client-ID und ein separates Geheimnis und muss explizit bei Paylocity angefordert werden, damit der Zugriff auf ein Konto gewährt wird.

Beachten Sie, dass beim Setzen von UsePayEntryAPI Zu true, Sie dürfen nur die folgenden gespeicherten Prozeduren verwenden:

Versuche, andere Funktionen des Produkts zu verwenden, führen zu einem Fehler.

Außerdem ist das OAuthAccessToken die Sie für die Verwendung mit der Pay Entry API erhalten, müssen separat gespeichert werden. Dies erfordert häufig, dass Sie einen anderen festlegen OAuthSettingsLocation bei Verwendung dieser Verbindungseigenschaft.

Authentifizieren Sie sich bei Paylocity

Paylocity unterstützt die OAuth-Authentifizierung für alle Verbindungen zu Daten, entweder von der Pay Entry API oder der Standard-Payloticity-API. Um diese Authentifizierung von allen OAuth-Flows aus zu aktivieren, müssen Sie festlegen AuthScheme Zu OAuth, und Sie müssen eine benutzerdefinierte OAuth-Anwendung erstellen.

In den folgenden Unterabschnitten wird beschrieben, wie Sie sich bei Paylocity anhand der drei gängigsten Authentifizierungsabläufe authentifizieren. Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung. Eine vollständige Liste der in Paylocity verfügbaren Verbindungszeichenfolgeneigenschaften finden Sie unter Connection.

Desktop-Anwendungen

Um sich mit den Anmeldeinformationen für eine benutzerdefinierte OAuth-Anwendung zu authentifizieren, müssen Sie das OAuth-Zugriffstoken abrufen und aktualisieren. Danach können Sie eine Verbindung herstellen.

OAuth-Zugriffstoken abrufen und aktualisieren:

  • InitiateOAuth = GETANDREFRESH. Wird verwendet, um automatisch die abzurufen und zu aktualisieren OAuthAccessToken.
  • OAuthClientId = die Client-ID, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
  • OAuthClientSecret = das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
  • CallbackURL = die Umleitungs-URI, die bei der Registrierung Ihrer Anwendung definiert wurde.

Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Paylocity in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen.

Nachdem Sie der Anwendung Berechtigungen erteilt haben, schließt der Connector den OAuth-Prozess ab:

  1. Der Connector erhält einen Zugriffstoken von Paylocity und verwendet ihn, um Daten anzufordern.
  2. Die OAuth-Werte werden im in angegebenen Pfad gespeichert OAuthSettingsLocation. Diese Werte bleiben über Verbindungen hinweg bestehen.

Wenn das Zugriffstoken abläuft, aktualisiert der Connector es automatisch.

Automatische Aktualisierung des OAuth-Zugriffstokens:

Damit der Connector das OAuth-Zugriffstoken automatisch aktualisiert, gehen Sie wie folgt vor:

  1. Legen Sie vor der ersten Verbindung mit Daten die folgenden Verbindungsparameter fest:
    • InitiateOAuth = REFRESH.
    • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
    • OAuthClientSecret = das Client-Geheimnis in Ihren Anwendungseinstellungen.
    • OAuthAccessToken = der von GetOAuthAccessToken zurückgegebene Zugriffstoken.
    • OAuthSettingsLocation = der Pfad, in dem der Connector die OAuth-Werte speichern soll, die über Verbindungen hinweg bestehen bleiben.
  2. Legen Sie bei nachfolgenden Datenverbindungen Folgendes fest:
    • InitiateOAuth
    • OAuthSettingsLocation

Manuelle Aktualisierung des OAuth-Zugriffstokens:

Der einzige Wert, der zur manuellen Aktualisierung des OAuth-Zugriffstokens benötigt wird, ist das OAuth-Aktualisierungstoken.

  1. Um das OAuthAccessToken nach dem ExpiresIn-Zeitraum (zurückgegeben von GetOAuthAccessToken manuell zu aktualisieren) abgelaufen ist, rufen Sie den RefreshOAuthAccessToken gespeicherte Prozedur.
  2. Legen Sie die folgenden Verbindungseigenschaften fest:
    • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
    • OAuthClientSecret = das Client Secret in Ihren Anwendungseinstellungen.
  3. Rufen Sie RefreshOAuthAccessToken auf mit OAuthRefreshToken auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken gesetzt.
  4. Nachdem die neuen Token abgerufen wurden, setzen Sie das OAuthAccessTokenEigenschaft auf den von RefreshOAuthAccessToken zurückgegebenen Wert. Dadurch wird eine neue Verbindung geöffnet.

Speichern Sie das OAuth-Aktualisierungstoken, damit Sie es verwenden können, um das OAuth-Zugriffstoken nach Ablauf manuell zu aktualisieren.

Wichtige Hinweise

Konfigurationsdateien und ihre Pfade

  • Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des Paylocity-Connectors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert möglichst viel der Verarbeitung der SELECT-Anweisung auf Paylocity und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Paylocity-Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

  • Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
  • DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

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

Verwenden Sie UserDefinedViews Verbindungseigenschaft zur Angabe des Speicherorts Ihrer JSON-Konfigurationsdatei. Beispiel:

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

Definieren von Ansichten mit DDL-Anweisungen

Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.

Erstellen einer Ansicht

Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:

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

Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews Verbindungseigenschaft.

Ändern einer Ansicht

Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:

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

Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.

Löschen einer Ansicht

Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.

DROP LOCAL VIEW [MyViewName]

Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.

Schema für benutzerdefinierte Ansichten

Benutzerdefinierte Ansichten werden im angezeigt UserViews Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName Eigentum.

Arbeiten mit benutzerdefinierten Ansichten

Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers listet nur Kunden in Raleigh auf:

SELECT * FROM Customers WHERE City = 'Raleigh';

Ein Beispiel für eine Abfrage an den Treiber:

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

Daraus ergibt sich die effektive Abfrage an die Quelle:

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

Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.

SSL-Konfiguration

Anpassen der SSL-Konfiguration

Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.

Um ein anderes Zertifikat anzugeben, siehe SSLServerCert Eigenschaft für die verfügbaren Formate, um dies zu tun.

Client-SSL-Zertifikate

Der Paylocity-Connector unterstützt auch das Festlegen von Client-Zertifikaten. Legen Sie Folgendes fest, um eine Verbindung mithilfe eines Client-Zertifikats herzustellen.

  • SSLClientCert: Der Name des Zertifikatspeichers für das Client-Zertifikat.
  • SSLClientCertType: Der Typ des Schlüsselspeichers, der das TLS/SSL-Clientzertifikat enthält.
  • SSLClientCertPassword: Das Passwort für das TLS/SSL-Client-Zertifikat.
  • SSLClientCertSubject: Der Betreff des TLS/SSL-Client-Zertifikats.

Datenmodell

Überblick

Dieser Abschnitt zeigt die verfügbaren API Objekte und bietet weitere Informationen zur Ausführung von SQL für Paylocity APIs.

Hauptmerkmale

  • Der Connector modelliert Paylocity Entitäten wie Dokumente, Ordner und Gruppen als relationale Ansichten, sodass Sie SQL schreiben können, um Paylocity Daten Abfrage.
  • Gespeicherte Prozeduren ermöglichen Ihnen, Vorgänge für Paylocity auszuführen.
  • Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem Paylocity-Konto bei Verwendung des Connectors sofort angezeigt werden.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen. Tabellen werden statisch definiert, um Ressourcen wie Einnahmen, lokale Steuern und Mitarbeiterdetails zu modellieren.

Ansichten

Ansichten beschreibt die verfügbaren Ansichten. Ansichten werden statisch definiert, um Ressourcen wie Mitarbeiter, Firmencodes und benutzerdefinierte Felder zu modellieren.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu Paylocity. Gespeicherte Prozeduren ermöglichen Ihnen das Ausführen von Operationen an Paylocity, einschließlich dem Herunterladen von Dokumenten und dem Verschieben von Umschlägen.

Tabellen

Der Connector modelliert die Daten in Paylocity als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.

Paylocity Connector-Tabellen

Name Beschreibung
AdditionalRates Zusätzliche Tarife hinzufügen/aktualisieren
Earnings Alle Einnahmen abrufen. Einnahmen nach Einnahmencode und Startdatum löschen. Einnahmen hinzufügen/aktualisieren. Einnahmen nach Einnahmencode abrufen. Einnahmen nach Einnahmencode und Startdatum abrufen
EmergencyContacts Notfallkontakte hinzufügen/aktualisieren
EmployeeBenefitSetup Leistungseinstellungen des Mitarbeiters hinzufügen/aktualisieren
EmployeeDetails Neuen Mitarbeiter hinzufügen. Mitarbeiter abrufen. Mitarbeiter aktualisieren
Input_TimeEntry Um den CSV-Inhalt für CreatePayEntryImportBatch.TimeEntry zu erstellen, verwenden Sie dies als temporäre Tabelle. Wenn die Verbindung zu Paylocity geschlossen wird, werden alle Tabellennamen gelöscht, die mit Input beginnen.
LocalTaxes Lokale Steuern nach Steuercode abrufen. Alle lokalen Steuern abrufen. Neue lokale Steuer hinzufügen. Lokale Steuer nach Steuercode löschen
NonPrimaryStateTax Nicht-primäre staatliche Steuer hinzufügen/aktualisieren
PrimaryStateTax Primäre staatliche Steuer hinzufügen/aktualisieren
SensitiveData Ruft vertrauliche Mitarbeiterdaten direkt von Web Pay ab.

ZusätzlichePreise

Zusätzliche Tarife hinzufügen/aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM AdditionalRates WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Tabelle „AdditionalRates“. Beispiel:

INSERT INTO AdditionalRates (employeeid, Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ('123', '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Tabelle „AdditionalRates“:

UPDATE AdditionalRates SET CostCenter1 = '100', ratecode = 'CN', rate = 100, rateper = 'hour' WHERE employeeId = '123'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
CostCenter1 String Falsch Nicht erforderlich. Gültige Werte müssen mit einer der systemcodierten Kostenstellen übereinstimmen, die in der Dropdown-Liste „Kostenstelle für Zusatztarife, Ebene 1“ verfügbar sind. Diese Zelle muss im Textformat vorliegen.
CostCenter2 String Falsch Nicht erforderlich. Gültige Werte müssen mit einer der systemcodierten Kostenstellen übereinstimmen, die in der Dropdown-Liste „Kostenstelle für Zusatztarife, Ebene 2“ verfügbar sind. Diese Zelle muss im Textformat vorliegen.
CostCenter3 String Falsch Nicht erforderlich. Gültige Werte müssen mit einer der systemcodierten Kostenstellen übereinstimmen, die in der Dropdown-Liste „Kostenstelle für Zusatztarife“ auf Ebene 3 verfügbar sind. Diese Zelle muss im Textformat vorliegen.
RatePer String Falsch Erforderlich. Gültige Werte sind HOUR oder WEEK.
Rate Decimal Falsch Erforderlich. Geben Sie den Dollarbetrag ein, der der Auswahl pro entspricht.
RateCode String Falsch Erforderlich. Wenn ausgefüllt, muss es mit einem der systemcodierten Werte übereinstimmen, die in der Dropdown-Liste „Zusätzliche Tarife - Tarifcode“ verfügbar sind.
ChangeReason String Falsch Nicht erforderlich. Wenn ausgefüllt, muss es mit einem der systemcodierten Werte übereinstimmen, die im Dropdown-Menü „Grund für zusätzliche Tarifänderungen“ verfügbar sind.
EffectiveDate Date Falsch Erforderlich. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
EndCheckDate Date Falsch Nicht erforderlich. Muss mit einem der systemcodierten Scheckdaten übereinstimmen, die in der Dropdown-Liste „Enddatum für zusätzliche Tarife“ verfügbar sind. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
RateNotes String Falsch Nicht erforderlich.
Job String Falsch Nicht erforderlich. Wenn ausgefüllt, muss es mit einem der systemcodierten Werte übereinstimmen, die in der Dropdown-Liste „Zusätzliche Tarife für Jobs“ verfügbar sind.
Shift String Falsch Nicht erforderlich. Wenn ausgefüllt, muss es mit einem der systemcodierten Werte übereinstimmen, die im Dropdown-Menü „Zusätzliche Tarifverschiebung“ verfügbar sind.
CompanyId String True ID des Unternehmens.

Einnahmen

Alle Einnahmen abrufen. Einnahmen nach Verdienstcode und Startdatum löschen. Einnahmen hinzufügen/aktualisieren. Einnahmen nach Verdienstcode abrufen. Einnahmen nach Verdienstcode und Startdatum abrufen

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.
  • EarningCode unterstützt den '='-Vergleich.
  • StartDate unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Earnings WHERE EmployeeId = '123'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098' AND StartDate = '2019-04-01'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Gewinntabelle. Beispiel:

INSERT INTO Earnings (EmployeeId, EarningCode, StartDate) VALUES ('999621027', '1098', '2020-02-10')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Einnahmentabelle:

UPDATE Earnings SET EarningCode = '1098', StartDate = '2020-02-09' WHERE employeeId = '999621027'
Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen von Einnahmen in der Tabelle „Einnahmen“:

DELETE FROM Earnings WHERE employeeId = '123' AND EarningCode = '1' AND StartDate = '2021-01-01'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
PaidTowardsGoal Decimal Falsch Dem Mitarbeiter wurde bereits ein Betrag für das Ziel ausgezahlt. Decimal(12,2)
MiscellaneousInfo String Falsch Informationen, die auf den Gehaltsscheck gedruckt werden sollen, wenn die Agentur für dieses Einkommen eingerichtet ist.
EffectiveDate Date Falsch Datum, an dem der Verdienst aktiv ist. Standardmäßig wird das Ausführungsdatum oder das Prüfdatum basierend auf der Unternehmenseinrichtung verwendet. Übliche Formate sind MM-TT-CCYY, CCYY-MM-TT.
CostCenter1 String Falsch Mit dem Verdienst verbundene Kostenstelle. Muss mit der Unternehmenskonfiguration übereinstimmen.
CostCenter2 String Falsch Mit dem Verdienst verbundene Kostenstelle. Muss mit der Unternehmenskonfiguration übereinstimmen.
CostCenter3 String Falsch Mit dem Verdienst verbundene Kostenstelle. Muss mit der Unternehmenskonfiguration übereinstimmen.
AnnualMaximum Decimal Falsch Der für das laufende Jahr nicht zu überschreitende Dollarbetrag für einen Verdienst im Kalenderjahr. Wird nur bei unternehmensgesteuerten Höchstwerten verwendet. Decimal(12,2)
IsSelfInsured Bool Falsch Wird für ACA verwendet. Wenn nicht eingegeben, wird standardmäßig die Verdienstkonfiguration des Unternehmens verwendet.
Rate Decimal Falsch Rate wird in Verbindung mit dem Feld „Stunden oder Einheiten“ verwendet. Dezimal (12,2)
Frequency String Falsch Erforderlich, wenn der Verdienst anders als die Gehaltsabrechnungshäufigkeit angewendet wird (beispielsweise einmaliger Verdienst).
EndDate Date Falsch Enddatum eines Verdienstes. Übliche Formate sind MM-TT-CCYY, CCYY-MM-TT.
HoursOrUnits Decimal Falsch Der Wert wird in Verbindung mit dem Feld „Rate“ verwendet. Bei der Eingabe von „Group Term Life Insurance“ (GTL) sollte dieser den vollen Betrag der Gruppen-Risikolebensversicherungspolice enthalten. Dezimalzahl (12,2)
EarningCode String Falsch Verdienstcode. Muss mit der Unternehmenskonfiguration übereinstimmen.
RateCode String Falsch Der Tarifcode gilt für zusätzliche Lohnsätze, die für einen Mitarbeiter eingegeben werden. Muss mit den Unternehmenseinstellungen übereinstimmen.
Goal Decimal Falsch Dollarbetrag. Der Mitarbeiter verdient nicht mehr, wenn der Zielbetrag erreicht ist. Decimal(12,2)
CalculationCode String Falsch Definiert, wie das Einkommen berechnet wird. Übliche Werte sind *% (Prozentsatz des Bruttobetrags), pauschal (pauschaler Dollarbetrag)*. Standardmäßig wird der vom Unternehmen eingerichtete CalcCode für das Einkommen verwendet.
StartDate Date Falsch Beginndatum eines Verdienstes basierend auf dem Lohnkalender. Übliche Formate sind MM-TT-CCYY, CCYY-MM-TT.
PayPeriodMaximum Decimal Falsch Maximaler Verdienstbetrag pro Gehaltsscheck. Decimal(12,2)
JobCode String Falsch Mit dem Verdienst verknüpfter Jobcode. Muss mit der Unternehmenskonfiguration übereinstimmen.
Amount Decimal Falsch Wert, der dem Berechnungscode entspricht und zum Bruttolohn addiert werden soll. Geben Sie für den Prozentsatz (%) eine ganze Zahl ein (10 = 10 %). Dezimalzahl (12,2)
Agency String Falsch Mit dem Verdienst verbundene Drittagentur. Muss mit der Unternehmenskonfiguration übereinstimmen.
PayPeriodMinimum Decimal Falsch Mindestbetrag des Verdienstes pro Gehaltsscheck. Decimal(12,2)
CompanyId String True ID des Unternehmens.

Notfallkontakte

Notfallkontakte hinzufügen/aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM EmergencyContacts WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Tabelle „EmergencyContacts“. Beispiel:

INSERT INTO EmergencyContacts (EmployeeId, firstName, lastName, primaryPhone, priority, relationship, MobilePhone, Zip, Notes, Address1, City, County) VALUES ('123', 'firstName', 'lastName', 'M', 'P', 'Brother', 9876543210, 75791, 'Test Notes', 'Address Line1', 'NY', 'USA')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer EmergencyContacts-Tabelle:

UPDATE EmergencyContacts SET WorkPhone = '9876543210', firstName = 'firstName', lastName = 'lastName', primaryPhone = 'W', priority = 'S', relationship = 'brother' WHERE employeeId = '999621027'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
FirstName String Falsch Erforderlich. Vorname des Kontakts.
LastName String Falsch Erforderlich. Nachname des Kontakts.
MobilePhone String Falsch Mobiltelefon des Kontakts. Gültiges Telefonformat *(###) #######* oder *######-####* oder *### ### ####* oder *############* oder, wenn international, beginnt mit *+#*, nur Leerzeichen und Ziffern erlaubt.
Zip String Falsch Postleitzahl. Bei US-Adressen muss es sich um eine gültige Postleitzahl handeln.
Priority String Falsch Erforderlich. Kontaktpriorität. Gültige Werte sind *P* (Primär) oder *S* (Sekundär).
Notes String Falsch Notizen.
Address1 String Falsch 1. Adresszeile.
Pager String Falsch Gültiges Telefonformat *(###) ########* oder *#######-####* oder *### ### ####* oder *############* oder, wenn international, beginnt mit *+#*, nur Leerzeichen und Ziffern erlaubt.
WorkPhone String Falsch Kontakt: Telefonnummer (Arbeit). Gültiges Telefonformat *(###) ########* oder *######-####* oder *### ### ####* oder *############* oder, wenn international, beginnt mit *+#*, nur Leerzeichen und Ziffern erlaubt.
PrimaryPhone String Falsch Erforderlich. Primärer Telefontyp des Kontakts. Muss mit den Unternehmenseinstellungen übereinstimmen. Gültige Werte sind H (privat), M (mobil), P (Pager), W (geschäftlich)
Address2 String Falsch 2. Adresszeile.
HomePhone String Falsch Kontakt: Privatnummer. Gültiges Telefonformat *(###) #######* oder *######-####* oder *### ### ####* oder *############* oder, wenn international, beginnt mit *+#*, nur Leerzeichen und Ziffern erlaubt.
WorkExtension String Falsch Arbeitsverlängerung.
SyncEmployeeInfo Bool Falsch Gültige Werte sind *true* oder *false*.
City String Falsch Stadt.
Country String Falsch Grafschaft.
Relationship String Falsch Erforderlich. Kontaktbeziehung. Muss mit der Firmenkonfiguration übereinstimmen. Übliche Werte sind Ehepartner, Mutter, Vater.
County String Falsch Land. Muss ein gültiger 3-stelliger Ländercode sein. Gängige Werte sind *USA* (Vereinigte Staaten), *CAN* (Kanada).
Email String Falsch Kontakt-Email. Muss ein gültiges Email Adressformat sein.
State String Falsch Staat oder Provinz. Bei US-Adressen muss es sich um einen gültigen 2-stelligen Staatscode handeln. Gängige Werte sind *IL* (Illinois), *CA* (Kalifornien).
CompanyId String True ID des Unternehmens.

Mitarbeitervorteilssetup

Leistungseinstellungen des Mitarbeiters hinzufügen/aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM EmployeeBenefitSetup WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die EmployeeBenefitSetup-Tabelle. Beispiel:

INSERT INTO EmployeeBenefitSetup (EmployeeId, BenefitSalary, BenefitClass, BenefitSalaryEffectiveDate, BenefitClassEffectiveDate) VALUES ('123', '250', 'FULL', '2021-02-10', '2021-02-10')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer EmployeeBenefitSetup-Tabelle:

UPDATE EmployeeBenefitSetup SET BenefitSalary = '250', BenefitClass = 'FULL', BenefitClassEffectiveDate = '2021-02-10', BenefitSalaryEffectiveDate = '2021-02-10' WHERE EmployeeId = '123'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
BenefitSalary Decimal Falsch Gehalt, das zum Konfigurieren der Leistungen verwendet wird.Dezimal(12,2)
BenefitClass String Falsch Leistungsklassencode. Werte werden unter Web Pay Company > Setup > Leistungen > Klassen konfiguriert.
BenefitSalaryEffectiveDate Date Falsch Datum, an dem das Gehalt in Kraft tritt. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
DoNotApplyAdministrativePeriod Bool Falsch Gilt nur für HR Enhanced-Kunden und Leistungsklassen mit der ACA-Beschäftigungsart Vollzeit.
IsMeasureAcaEligibility Bool Falsch Nur gültig für HR Enhanced-Kunden und Leistungsklassen mit der ACA-Beschäftigungsart „Vollzeit“.
BenefitClassEffectiveDate Date Falsch Datum, an dem die Leistungsklasse wirksam wird. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
CompanyId String True ID des Unternehmens.

Mitarbeiterdetails

Neuen Mitarbeiter hinzufügen. Mitarbeiter abrufen. Mitarbeiter aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Employee WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Mitarbeitertabelle mit aggregierter Spalte (optional). Beispiel:

INSERT INTO AdditionalRates#TEMP (Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ( '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')

INSERT INTO Employee (FirstName, LastName, MiddleName, Gender, MaritalStatus, PreferredName, PriorLastName, Salutation, Currency, BirthDate, CompanyFEIN, CompanyName, DepartmentPositionChangeReason, DepartmentPositionCostCenter1, DepartmentPositionCostCenter2, DepartmentPositionCostCenter3, DepartmentPositionEffectiveDate, DepartmentPositionEmployeeType, DepartmentPositionIsMinimumWageExempt, DepartmentPositionIsOvertimeExempt, DepartmentPositionIsSupervisorReviewer, DepartmentPositionIsUnionDuesCollected, DepartmentPositionIsUnionInitiationCollected, DepartmentPositionJobTitle, FederalTaxAmount, FederalTaxExemptions, FederalTaxFilingStatus, FederalTaxPercentage, FederalTaxTaxCalculationCode, FederalTaxW4FormYear, HomeAddressAddress1, HomeAddressAddress2, HomeAddressCity, HomeAddressCountry, HomeAddressEmailAddress, HomeAddressMobilePhone, HomeAddressPhone, HomeAddressPostalCode, HomeAddressState, NonPrimaryStateTaxFilingStatus, NonPrimaryStateTaxHigherRate, NonPrimaryStateTaxOtherIncomeAmount, NonPrimaryStateTaxReciprocityCode, NonPrimaryStateTaxtaxCode, PrimaryPayRateAnnualSalary, PrimaryPayRateBaseRate, PrimaryPayRateChangeReason, PrimaryPayRateDefaultHours, PrimaryPayRateEffectiveDate, PrimaryPayRatePayFrequency, PrimaryPayRatePayType, PrimaryStateTaxAmount, PrimaryStateTaxExemptions, PrimaryStateTaxExemptions2, PrimaryStateTaxPercentage, PrimaryStateTaxFilingStatus, PrimaryStateTaxTaxCalculationCode, PrimaryStateTaxTaxCode, PrimaryStateTaxW4FormYear, StatusAdjustedSeniorityDate, StatusChangeReason, StatusEffectiveDate, StatusEmployeeStatus, StatusHireDate, StatusIsEligibleForRehire, TaxSetupSuiState, TaxSetupTaxForm, WorkAddressAddress1, WorkAddressCity, WorkAddressCountry, WorkAddressMobilePhone, WorkAddressPostalCode, WorkAddressState, suffix, IsSmoker, AdditionalRate) VALUES ('TestFirstName1', 'TestLastName', 'TestMiddleName', 'M', 'S', 'Test1', 'TestPrior', 'Mr', 'USD', '1985-11-01', '00-5554442', 'SusanW  Z2222 Clone', 'New Hire', '100', '101', '100', '2021-02-01', 'RFT', false, true, false, false, false, 'Clinical Psychologist', '1', '0', 'M', '1', 'AFAP', '2021', 'TestAddr1', 'TestAddr2', 'NewJordi', 'USA', 'test@test.com', '(961)062-1234', '(588)148-1234', '75791', 'NY', 'M', 'false', 0, 'Both', 'NY', '1000', '100', 'New Hire', '8', '2021-02-01', 'M', 'Salary', '1', '0', '0', 5, 'S', 'AFAP', 'AZ', '2019', '2021-02-01', 'New Hire', '2021-02-01', 'A', '2021-02-01', true, 'NY', 'W2', '78FraleighStreet', 'RedHook', 'USA', '(276)369-1234', '12571', 'NY', 'Jr.', true, 'AdditionalRates#TEMP')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Mitarbeitertabelle:

UPDATE Employee SET PriorLastName = 'PriorLastName',`[CF_PayrollAndHR_Voller Computerzugriff] `= true WHERE EmployeeId = '123'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Falsch Leer lassen, damit Web Pay automatisch die nächste verfügbare Mitarbeiter-ID zuweist.
PreferredName String Falsch Bevorzugter Anzeigename des Mitarbeiters.
FirstName String Falsch Vorname des Mitarbeiters.
LastName String Falsch Nachname des Mitarbeiters.
MiddleName String Falsch Zweiter Vorname des Mitarbeiters.
WebTimeChargeRate Decimal Falsch Satz, der Dritten für die vom Mitarbeiter geleistete Arbeitszeit in Rechnung gestellt wird. Am häufigsten wird darauf in den Berichten „Kostenstellengebühr“, „Kostenstellengebühr vs. Kosten“ und „Zeit- und Anwesenheitsberichte der Kundenrechnung“ verwiesen. Dezimal (12,2)
WebTimeIsTimeLaborEnabled Bool Falsch Wenn auf „True“ gesetzt, werden Änderungen an Mitarbeiterdaten in Web Time angezeigt.
WebTimeBadgeNumber String Falsch Die Ausweisnummer wird normalerweise für die Nutzung des Zeit- und Anwesenheitssystems ausgegeben.
WorkAddressCountry String Falsch Land.
WorkAddressAddress1 String Falsch 1. Adresszeile.
WorkAddressPager String Falsch Mitarbeiter-Pagernummer.
WorkAddressState String Falsch Staat oder Provinz.
WorkAddressMailStop String Falsch Mitarbeiter-Mailstopp.
WorkAddressEmailAddress String Falsch Email.
WorkAddressCity String Falsch Stadt.
WorkAddressPhoneExtension String Falsch Durchwahl der Telefonnummer.
WorkAddressLocation String Falsch Name des Arbeitsorts.
WorkAddressPostalCode String Falsch Postleitzahl.
WorkAddressCounty String Falsch Grafschaft.
WorkAddressAddress2 String Falsch 2. Adresszeile.
WorkAddressMobilePhone String Falsch Handynummer.
WorkAddressPhone String Falsch Telefonnummer.
Currency String Falsch Der Mitarbeiter wird in dieser Währung bezahlt.
EmergencyContacts String Falsch Notfallkontakte hinzufügen oder aktualisieren.
OwnerPercent Decimal Falsch Prozentualer Anteil des Mitarbeiterbesitzes am Unternehmen, eingegeben als ganze Zahl. Dezimal (12,2)
CustomTextFields String Falsch Bis zu 8 benutzerdefinierte Felder mit Werten vom Typ Text.
NonPrimaryStateTaxExemptions Decimal Falsch Wert der staatlichen Steuerfreibeträge.Dezimal (12,2)
NonPrimaryStateTaxOtherIncomeAmount Decimal Falsch Box 4a auf Formular W4 (Jahr 2020 oder später): Betrag sonstiger Einkünfte. Dezimalzahl (12,2)
NonPrimaryStateTaxAmount Decimal Falsch Staatliche Steuernummer.
NonPrimaryStateTaxDependentsAmount Decimal Falsch Box 3 auf Formular W4 (Jahr 2020 oder später): Gesamtbetrag für Angehörige. Dezimalzahl (12,2)
NonPrimaryStateTaxDeductionsAmount Decimal Falsch Box 4(b) auf Formular W4 (Jahr 2020 oder später): Abzugsbetrag. Dezimalzahl (12,2)
NonPrimaryStateTaxTaxCalculationCode String Falsch Steuerberechnungscode. Übliche Werte sind *F* (Pauschal), *P* (Prozentsatz), *FDFP* (Pauschaler Dollarbetrag plus fester Prozentsatz).
NonPrimaryStateTaxPercentage Decimal Falsch Staatlicher Steuersatz. Dezimal (12,2)
NonPrimaryStateTaxW4FormYear Int Falsch Der Staat W4-Abschlussjahr Integer
NonPrimaryStateTaxExemptions2 Decimal Falsch Staatliche Steuerbefreiungen 2 Wert.Dezimal (12,2)
NonPrimaryStateTaxFilingStatus String Falsch Staatlicher Steuerstatus des Arbeitnehmers. Übliche Werte sind *S* (ledig), *M* (verheiratet).
NonPrimaryStateTaxHigherRate Bool Falsch Box 2(c) auf Formular W4 (Jahr 2020 oder später): Mehrere Jobs oder Ehepartner arbeitet. Boolesch
NonPrimaryStateTaxTaxCode String Falsch Staatliche Steuernummer.
NonPrimaryStateTaxReciprocityCode String Falsch Nicht-primärer staatlicher Steuerreziprozitätscode.
NonPrimaryStateTaxSpecialCheckCalc String Falsch Berechnungscode für Zusatzschecks. Übliche Werte sind *Blocked* (Steuern auf Zusatzschecks gesperrt), *Supp* (Zusätzlichen Steuersatzcode verwenden).
DepartmentPositionPositionCode String Falsch Stellencode des Mitarbeiters. Muss mit den Unternehmenseinstellungen übereinstimmen.
DepartmentPositionShift String Falsch Arbeitsschicht des Mitarbeiters.
DepartmentPositionCostCenter1 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung* usw. Muss mit den Unternehmenseinstellungen übereinstimmen.
DepartmentPositionIsSupervisorReviewer Bool Falsch Gibt an, ob der Mitarbeiter ein Vorgesetzter oder Gutachter ist.
DepartmentPositionIsUnionDuesCollected Bool Falsch Gibt an, ob Gewerkschaftsbeiträge erhoben werden.
DepartmentPositionIsMinimumWageExempt Bool Falsch Gibt an, ob der Arbeitnehmer vom Mindestlohn ausgenommen ist.
DepartmentPositionUnionCode String Falsch Gewerkschaftscode des Arbeitnehmers. Muss mit der Unternehmenskonfiguration übereinstimmen.
DepartmentPositionSupervisorCompanyNumber String Falsch Firmennummer des Vorgesetzten. Standardmäßig die Firmennummer des Mitarbeiters.
DepartmentPositionJobTitle String Falsch Aktuelle Berufsbezeichnung des Mitarbeiters.
DepartmentPositionUnionPosition String Falsch Gewerkschaftsposition des Arbeitnehmers. Muss mit der Unternehmensstruktur übereinstimmen.
DepartmentPositionCostCenter2 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung* usw. Muss mit den Unternehmenseinstellungen übereinstimmen.
DepartmentPositionIsOvertimeExempt Bool Falsch Gibt an, ob der Mitarbeiter von Überstunden ausgenommen ist.
DepartmentPositionEffectiveDate Date Falsch Das Datum, an dem die Position wirksam wird. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
DepartmentPositionCostCenter3 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung* usw. Muss mit den Unternehmenseinstellungen übereinstimmen.
DepartmentPositionEqualEmploymentOpportunityClass String Falsch Werte werden unter Unternehmen > Setup > HR > EEO-Klassen konfiguriert.
DepartmentPositionClockBadgeNumber String Falsch Stempeluhr-Ausweisnummer des Mitarbeiters. Standardmäßig ist die Mitarbeiter-ID.
DepartmentPositionReviewerEmployeeId String Falsch Mitarbeiter-ID des Gutachters.
DepartmentPositionTipped String Falsch Gibt an, ob der Mitarbeiter Trinkgelder erhält.
DepartmentPositionReviewerCompanyNumber String Falsch Firmennummer des Rezensenten.
DepartmentPositionIsUnionInitiationCollected Bool Falsch Gibt an, ob Aufnahmegebühren erhoben werden.
DepartmentPositionSupervisorEmployeeId String Falsch Mitarbeiter-ID des Vorgesetzten.
DepartmentPositionChangeReason String Falsch Grund für den Abteilungs-/Positionswechsel des Mitarbeiters. Muss mit den Unternehmenseinstellungen übereinstimmen.
DepartmentPositionEmployeeType String Falsch Aktuelle Beschäftigungsart des Mitarbeiters. Häufige Werte *RFT (reguläre Vollzeit), RPT (reguläre Teilzeit), SNL (saisonal), TFT (vorübergehend Vollzeit), TPT (vorübergehend Teilzeit)*.
DepartmentPositionWorkersCompensation String Falsch Vergütungscode des Arbeitnehmers. Muss mit der Unternehmenskonfiguration übereinstimmen.
DepartmentPositionUnionAffiliationDate Date Falsch Datum des Inkrafttretens der Gewerkschaftszugehörigkeit des Arbeitnehmers. Gängige Formate sind *TT-MM-CCYY*, *CCYY-MM-TT*.
DepartmentPositionPayGroup String Falsch Lohngruppe des Mitarbeiters. Muss mit der Unternehmenskonfiguration übereinstimmen.
DisabilityDescription String Falsch Gibt an, ob der Mitarbeiter eine Behinderung hat.
Ethnicity String Falsch Ethnische Zugehörigkeit des Mitarbeiters.
AdditionalRate String Falsch Zusätzliche Tarife hinzufügen.
CustomBooleanFields String Falsch Bis zu 8 benutzerdefinierte Felder mit booleschen Werten (Kontrollkästchen).
AdditionalDirectDeposit String Falsch Fügen Sie zusätzlich zum Hauptkonto für direkte Einzahlungen bis zu 19 Konten für direkte Einzahlungen hinzu. WICHTIG: Bei einer Aktualisierung der direkten Einzahlung werden ALLE vorhandenen Haupt- und zusätzlichen Informationen zu direkten Einzahlungen in WebPay entfernt und durch die in der Anfrage bereitgestellten Informationen ersetzt. Die GET- API gibt keine Daten zu direkten Einzahlungen zurück.
CustomDropDownFields String Falsch Bis zu 8 benutzerdefinierte Felder vom Typ „Dropdown-Wert“.
CompanyFEIN String Falsch Firmen-FEIN wie in Web Pay definiert, nur anwendbar bei GET-Anfragen.
Suffix String Falsch Mitarbeiternamenssuffix. Übliche Werte sind *Jr, Sr, II*.
MainDirectDepositNameOnAccount String Falsch Name auf dem Bankkonto. Standardmäßig der Name des Mitarbeiters.
MainDirectDepositRoutingNumber String Falsch ABA Transit Routing Number, ohne Bindestriche oder Leerzeichen eingegeben.
MainDirectDepositBlockSpecial Bool Falsch Gibt an, ob die direkte Einzahlung gesperrt werden soll, wenn spezielle Scheckarten wie Boni verarbeitet werden.
MainDirectDepositIsSkipPreNote Bool Falsch Gibt an, ob für das Konto keine Vormerkung erfolgt.
MainDirectDepositAccountNumber String Falsch Kontonummer, ohne Sonderzeichen und Leerzeichen eingegeben.
MainDirectDepositAccountType String Falsch Kontotyp. Gültige Werte sind *C* (Girokonto), *S* (Sparkonto), *P* (Pay Card).
MainDirectDepositPreNoteDate Date Falsch Datum, an dem die Vornotiz des Kontos endet. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
WorkEligibilityIsSsnVerified Bool Falsch Gibt an, ob die Sozialversicherungsnummer des Mitarbeiters verifiziert ist.
WorkEligibilityForeignPassportNumber String Falsch Ausländische Passnummer.
WorkEligibilityIsI9Verified Bool Falsch Gibt an, ob Mitarbeiter I9 verifiziert ist.
WorkEligibilityAlienOrAdmissionDocumentNumber String Falsch USCIS- oder Zulassungsnummer des Mitarbeiters. Muss 7–10 Zeichen lang sein und kann mit einem „A“ beginnen
WorkEligibilityI9Notes String Falsch Hinweise zum i9 des Mitarbeiters.
WorkEligibilityVisaType String Falsch Art des Arbeitnehmervisums. Muss mit einem der systemcodierten Werte übereinstimmen.
WorkEligibilityWorkAuthorization String Falsch Arbeitserlaubnis des Mitarbeiters. Muss mit einem der systemcodierten Werte übereinstimmen.
WorkEligibilityI9DateVerified String Falsch Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
WorkEligibilitySsnDateVerified String Falsch Das Datum der Arbeitgeberüberprüfung der Sozialversicherungsnummer des Arbeitnehmers. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
WorkEligibilityCountryOfIssuance String Falsch Wenn eine ausländische Passnummer angegeben ist, geben Sie das Ausstellungsland an. Muss mit den Paylocity Einstellungen übereinstimmen.
WorkEligibilityAttestedDate Date Falsch Das Datum, an dem das I-9-Verifizierungsformular vom Arbeitgeber oder autorisierten Vertreter beglaubigt wurde. Übliche Formate sind *MM-TT-CCYY, CCYY-MM-TT*.
WorkEligibilityI94AdmissionNumber String Falsch Zulassungsnummer des Formulars I-94. Muss aus 11 numerischen Zeichen bestehen
WorkEligibilityWorkUntil String Falsch Enddatum der Arbeitsberechtigung des Mitarbeiters. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
WorkEligibilitySsnNotes String Falsch Hinweise zur Sozialversicherungsnummer des Mitarbeiters.
TaxSetupSitwExemptReason String Falsch Grundcode für SITW-Befreiung. Übliche Werte sind *SE* (gesetzlicher Angestellter), *CR* (Geistlicher/Ordensangehöriger).
TaxSetupSuiExemptReason String Falsch Grundcode für SUI-Befreiung. Übliche Werte sind *SE* (gesetzlicher Angestellter), *CR* (Geistlicher/Ordensangehöriger).
TaxSetupSuiState String Falsch Staatliche Arbeitslosenversicherung (SUI) für Arbeitnehmer.
TaxSetupIsStatutory Bool Falsch Gibt an, ob der Arbeitnehmer gesetzlich verpflichtet ist.
TaxSetupTaxDistributionCode1099R String Falsch 1099R-Verteilungscode für Mitarbeiter. Übliche Werte sind *7* (Normalverteilung), *F* (Wohltätige Geschenkrente).
TaxSetupMedExemptReason String Falsch Grundcode für Medicare-Befreiung. Übliche Werte sind *501* (5019c)(3) Organisation), *IC* (Unabhängiger Auftragnehmer).
TaxSetupFutaExemptReason String Falsch Grundcode für FUTA-Befreiung. Übliche Werte sind *501* (5019c)(3) Organisation), *IC* (Unabhängiger Auftragnehmer).
TaxSetupSitwExemptNotes String Falsch Hinweise zur SITW-Befreiung.
TaxSetupMedExemptNotes String Falsch Hinweise zur Medicare-Befreiung.
TaxSetupSsExemptNotes String Falsch Hinweise zur Befreiung von der Sozialversicherung.
TaxSetupIsEmployee943 Bool Falsch Gibt an, ob Arbeitnehmer in der Landwirtschaft oder im Ackerbau tätig ist.
TaxSetupIsPension Bool Falsch Gibt an, ob der Arbeitnehmer Anspruch auf eine Rente hat.
TaxSetupSuiExemptNotes String Falsch Hinweise zur SUI-Befreiung.
TaxSetupFitwExemptNotes String Falsch Hinweise zur FITW-Befreiung.
TaxSetupFitwExemptReason String Falsch Grundcode für FITW-Befreiung. Übliche Werte sind *SE* (gesetzlicher Angestellter), *CR* (Geistlicher/Ordensangehöriger).
TaxSetupSsExemptReason String Falsch Grundcode für die Befreiung von der Sozialversicherung. Übliche Werte sind *SE* (gesetzlicher Angestellter), *CR* (Geistlicher/Ordensangehöriger).
TaxSetupTaxForm String Falsch Steuerformular für Arbeitnehmer zur Meldung des Einkommens. Gültige Werte sind *W2, 1099M, 1099R*. Standard ist W2.
TaxSetupFutaExemptNotes String Falsch Hinweise zur FUTA-Befreiung.
CustomDateFields String Falsch Bis zu 8 benutzerdefinierte Felder mit dem Wert vom Typ „Datum“.
FederalTaxHigherRate Bool Falsch Box 2(c) auf Formular W4 (Jahr 2020 oder später): Mehrere Jobs oder Ehepartner arbeitet. Boolesch
FederalTaxDependentsAmount Decimal Falsch Box 3 auf Formular W4 (Jahr 2020 oder später): Gesamtbetrag für Angehörige. Dezimalzahl (12,2)
FederalTaxAmount Decimal Falsch Steuerbetrag. Dezimal (12,2)
FederalTaxTaxCalculationCode String Falsch Steuerberechnungscode. Übliche Werte sind *F* (Pauschal), *P* (Prozentsatz), *FDFP* (Pauschaler Dollarbetrag plus fester Prozentsatz).
FederalTaxDeductionsAmount Decimal Falsch Box 4(b) auf Formular W4 (Jahr 2020 oder später): Abzugsbetrag. Dezimalzahl (12,2)
FederalTaxFilingStatus String Falsch Bundesweiter Steuerstatus des Arbeitnehmers. Übliche Werte sind *S* (ledig), *M* (verheiratet).
FederalTaxPercentage Decimal Falsch Steuersatz. Dezimal (12,2)
FederalTaxOtherIncomeAmount Decimal Falsch Box 4a auf Formular W4 (Jahr 2020 oder später): Betrag sonstiger Einkünfte. Dezimalzahl (12,2)
FederalTaxW4FormYear Int Falsch Das bundesweite W4-Formularjahr Integer
FederalTaxExemptions Decimal Falsch Wert der bundesweiten Steuerfreibeträge. Dezimal (12,2)
MaritalStatus String Falsch Familienstand des Mitarbeiters. Häufige Werte *D (geschieden), M (verheiratet), S (ledig), W (verwitwet)*.
Ssn String Falsch Sozialversicherungsnummer des Arbeitnehmers. Lassen Sie das Feld leer, wenn keine gültige Sozialversicherungsnummer verfügbar ist.
BenefitSetupBenefitClassEffectiveDate Date Falsch Datum, an dem die Leistungsklasse wirksam wird. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
BenefitSetupBenefitClass String Falsch Leistungsklassencode. Werte werden unter Web Pay Company > Setup > Leistungen > Klassen konfiguriert.
BenefitSetupBenefitSalaryEffectiveDate Date Falsch Datum, an dem das Gehalt in Kraft tritt. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
BenefitSetupBenefitSalary Decimal Falsch Gehalt, das zum Konfigurieren der Leistungen verwendet wird.Dezimal(12,2)
BenefitSetupDoNotApplyAdministrativePeriod Bool Falsch Gilt nur für HR Enhanced-Kunden und Leistungsklassen mit der ACA-Beschäftigungsart Vollzeit.
BenefitSetupIsMeasureAcaEligibility Bool Falsch Nur gültig für HR Enhanced-Kunden und Leistungsklassen mit der ACA-Beschäftigungsart „Vollzeit“.
BirthDate Date Falsch Geburtsdatum des Mitarbeiters. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
PrimaryStateTaxExemptions Decimal Falsch Wert der staatlichen Steuerfreibeträge.Dezimal (12,2)
PrimaryStateTaxFilingStatus String Falsch Staatlicher Steuerstatus des Arbeitnehmers. Übliche Werte sind *S* (ledig), *M* (verheiratet).
PrimaryStateTaxAmount Decimal Falsch Staatliche Steuernummer.
PrimaryStateTaxSpecialCheckCalc String Falsch Berechnungscode für Zusatzschecks. Übliche Werte sind *Blocked* (Steuern auf Zusatzschecks gesperrt), *Supp* (Zusätzlichen Steuersatzcode verwenden).
PrimaryStateTaxTaxCalculationCode String Falsch Steuerberechnungscode. Übliche Werte sind *F* (Pauschal), *P* (Prozentsatz), *FDFP* (Pauschaler Dollarbetrag plus fester Prozentsatz).
PrimaryStateTaxW4FormYear Int Falsch Der Staat W4-Abschlussjahr Integer
PrimaryStateTaxHigherRate Bool Falsch Box 2(c) auf Formular W4 (Jahr 2020 oder später): Mehrere Jobs oder Ehepartner arbeitet. Boolesch
PrimaryStateTaxPercentage Decimal Falsch Staatlicher Steuersatz. Dezimal (12,2)
PrimaryStateTaxTaxCode String Falsch Staatliche Steuernummer.
PrimaryStateTaxExemptions2 Decimal Falsch Staatliche Steuerbefreiungen 2 Wert.Dezimal (12,2)
PrimaryStateTaxOtherIncomeAmount Decimal Falsch Box 4a auf Formular W4 (Jahr 2020 oder später): Betrag sonstiger Einkünfte. Dezimalzahl (12,2)
PrimaryStateTaxDeductionsAmount Decimal Falsch Box 4(b) auf Formular W4 (Jahr 2020 oder später): Abzugsbetrag. Dezimalzahl (12,2)
PrimaryStateTaxDependentsAmount Decimal Falsch Box 3 auf Formular W4 (Jahr 2020 oder später): Gesamtbetrag für Angehörige. Dezimalzahl (12,2)
LocalTax String Falsch Fügen Sie lokale Steuernummern, Steuerstatus und Befreiungen (einschließlich PA-PSD-Steuern) hinzu, aktualisieren oder löschen Sie diese.
Gender String Falsch Geschlecht des Mitarbeiters. Übliche Werte *M* (Männlich), *F* (Weiblich).
StatusChangeReason String Falsch Grund für die Statusänderung des Mitarbeiters. Muss mit den Unternehmenseinstellungen übereinstimmen.
StatusAdjustedSeniorityDate Date Falsch Angepasstes Dienstaltersdatum. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
StatusEffectiveDate Date Falsch Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
StatusHireDate Date Falsch Einstellungsdatum des Mitarbeiters. Aktualisierungen des Einstellungsdatums sind nicht zulässig und werden ignoriert. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
StatusEmployeeStatus String Falsch Aktueller Arbeitsstatus des Mitarbeiters. Übliche Werte sind *A* (Aktiv), *L* (Beurlaubt), *T* (Beendet).
StatusIsEligibleForRehire Bool Falsch Gibt an, ob der Mitarbeiter für eine Wiedereinstellung in Frage kommt.
StatusReHireDate Date Falsch Wiedereinstellungsdatum, wenn der Mitarbeiter wieder eingestellt wird. Aktualisierungen des Wiedereinstellungsdatums sind nicht zulässig und werden ignoriert. Übliche Formate sind *MM-TT-CCYY, CCYY-MM-TT*.
HomeAddressMobilePhone String Falsch Handynummer.
HomeAddressAddress1 String Falsch 1. Adresszeile.
HomeAddressPostalCode String Falsch Postleitzahl.
HomeAddressState String Falsch Staat oder Provinz.
HomeAddressCounty String Falsch Grafschaft.
HomeAddressAddress2 String Falsch 2. Adresszeile.
HomeAddressEmailAddress String Falsch Email.
HomeAddressPhone String Falsch Telefonnummer.
HomeAddressCity String Falsch Stadt.
HomeAddressCountry String Falsch Land.
PriorLastName String Falsch Ggf. vorheriger Nachname.
VeteranDescription String Falsch Gibt an, ob der Mitarbeiter ein Veteran ist.
IsSmoker Bool Falsch Gibt an, ob der Mitarbeiter Raucher ist.
Salutation String Falsch Vom Mitarbeiter bevorzugte Anrede.
IsHighlyCompensated Bool Falsch Gibt an, ob der Mitarbeiter die Kriterien für hochbezahlte Mitarbeiter erfüllt.
CustomNumberFields String Falsch Bis zu 8 benutzerdefinierte Felder mit numerischen Werten.
PrimaryPayRateSalary Decimal Falsch Bruttogehalt des Mitarbeiters pro Abrechnungszeitraum, verwendet mit Lohntyp Salary.Decimal (12,2)
PrimaryPayRateBeginCheckDate Date Falsch Das Datum der ersten Überprüfung, bei der der neue Lohnsatz angezeigt wird. Dieser Wert ist nur anwendbar, wenn ein bestehender Mitarbeiter aktualisiert wird. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
PrimaryPayRatePayRateNote String Falsch Hinweise zum Lohnsatz des Mitarbeiters.
PrimaryPayRateEffectiveDate Date Falsch Das Datum, an dem der Lohnsatz des Mitarbeiters in Kraft tritt. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
PrimaryPayRatePayType String Falsch Lohnart (Tarifcode) des Mitarbeiters. Gültige Werte sind *Stundenlohn* oder *Gehalt*.
PrimaryPayRateDefaultHours Decimal Falsch Die Standardarbeitsstunden des Mitarbeiters werden konstant geleistet. Wenn autoPayType auf D eingestellt ist, wird dem Mitarbeiter für die Standardarbeitsstunden der Stundengrundsatz bezahlt. Dezimal (12,2)
PrimaryPayRateAnnualSalary Decimal Falsch Jahresgehalt des Arbeitnehmers.Dezimal (12,2)
PrimaryPayRateChangeReason String Falsch Grund für die Lohnsatzänderung.
PrimaryPayRatePayGrade String Falsch Gehaltsstufe des Mitarbeiters. Muss mit der Unternehmenskonfiguration übereinstimmen.
PrimaryPayRateIsAutoPay Bool Falsch Wenn auf *True* gesetzt, wird der Mitarbeiter automatisch mit Standardstunden bezahlt.
PrimaryPayRateBaseRate Decimal Falsch Grundlohn für Mitarbeiter, wird für Stundenlöhner verwendet. Dezimal (12,2)
PrimaryPayRateRatePer String Falsch Häufigkeit des Basislohns für Mitarbeiter, die mit dem Lohntyp „Stündlich“ verwendet wird. Übliche Werte sind *Stunde, Woche*. Standard ist Stunde.
PrimaryPayRatePayFrequency String Falsch Aktuelle Zahlungshäufigkeit des Mitarbeiters. Übliche Werte sind *A (jährlich), B (zweiwöchentlich), D (täglich), M (monatlich), S (halbmonatlich), Q (vierteljährlich), W (wöchentlich)*.
CompanyName String Falsch Firmenname wie in Web Pay definiert, nur anwendbar bei GET-Anfragen.
CompanyId String True ID des Unternehmens.

Input_TimeEntry

Um den CSV-Inhalt für CreatePayEntryImportBatch.TimeEntry zu erstellen, verwenden Sie dies als temporäre Tabelle. Wenn die Verbindung zu Paylocity geschlossen wird, werden alle Tabellennamen, die mit Input beginnen, gelöscht.

Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId String Falsch ID des Mitarbeiters
Det String Falsch Gibt den Typ des zu importierenden Datensatzes an. Verwenden Sie E für Einnahmen, D für Abzüge oder A für Rückstellungssalden.
DetCode String Falsch Der Verdienst- oder Leistungscode. Dies muss ein aktuell für das Unternehmen definierter Code sein.
Hours Double Falsch Die Anzahl der vom Mitarbeiter gearbeiteten Stunden oder die genutzten Ansparstunden.
Amount Integer Falsch Der dem Mitarbeiter zu zahlende Dollarbetrag oder die verfügbaren Stunden. Wenn ein Betrag eingegeben wird, werden alle in den Feldern „Stunden“, „Satz“ und „Satzcode“ eingegebenen Informationen ignoriert.
TempRate String Falsch Der Lohnsatz des Mitarbeiters. Wenn kein Satz eingegeben wird, verwendet das System den Basislohn des Mitarbeiters.
RateCode String Falsch Der vom Unternehmen definierte Tarifcode, der für die Bezahlung des Mitarbeiters verwendet wird. Wenn ein Tarifcode eingegeben wird, ignoriert das System den Wert im Tariffeld.
CostCenter1 String Falsch Verwenden Sie dieses Feld, um einen Override-Wert für die Kostenstelle der ersten Ebene einzugeben, die dem Mitarbeiter in Rechnung gestellt wird.
CostCenter2 String Falsch Verwenden Sie dieses Feld, um einen Override-Wert für die Kostenstelle der zweiten Ebene einzugeben, die dem Mitarbeiter in Rechnung gestellt wird.
CostCenter3 String Falsch Geben Sie in diesem Feld einen Überschreibungswert für die Kostenstelle der dritten Ebene ein, die vom Mitarbeiter belastet wird. Wenn Sie einen Wert für CC3 eingeben, geben Sie auch Werte für CC1 und CC2 ein.
JobCode String Falsch In dieses Feld kann ein vom Unternehmen definierter Jobcode eingegeben werden, der dem Mitarbeiter in Rechnung gestellt werden soll.
Shift String Falsch In dieses Feld kann ein unternehmensspezifischer Schichtcode eingegeben werden, der dem Mitarbeiter in Rechnung gestellt werden soll.
BeginDate String Falsch Mit dieser Position verknüpftes Anfangsdatum.
EndDate String Falsch Mit dieser Position verknüpftes Enddatum.
WorkersCompCode String Falsch Das Unternehmen hat für die vom Arbeitnehmer geleistete Arbeit einen Arbeiterunfallversicherungscode festgelegt.
TCode1 String Falsch Wird nicht verwendet, sofern nicht vom Servicebüro angewiesen (staatliche Überschreibung). Bei Verwendung muss die eingegebene staatliche Überschreibung von der Einstellung des Steuercodes des Wohnsitzes des Mitarbeiters abweichen, andernfalls werden Blankoscheckdaten ausgegeben.
TCode2 String Falsch Wird nicht verwendet, sofern nicht vom Servicebüro angewiesen (lokale Überschreibung 1). Bei Verwendung muss die eingegebene staatliche Überschreibung von der Einrichtung des Steuercodes des Wohnsitzes des Mitarbeiters abweichen, andernfalls werden Blankoscheckdaten ausgegeben.
TCode3 String Falsch Wird nicht verwendet, sofern nicht vom Servicebüro angewiesen (Lokal 2-Überschreibung). Bei Verwendung muss die eingegebene staatliche Überschreibung von der Einrichtung des Steuercodes des Wohnsitzes des Mitarbeiters abweichen, andernfalls werden Blankoscheckdaten ausgegeben.
TCode4 String Falsch Darf nicht verwendet werden, sofern nicht vom Servicebüro dazu aufgefordert wird (Nicht verwenden).
Sequence String Falsch Verwenden Sie dieses Feld, um mehrere Prüfungen anzugeben.
CheckType String Falsch Verwenden Sie dieses Feld, um einen Überschreibungsprüftyp anzugeben.
CheckNumber String Falsch Verwenden Sie dieses Feld, um eine außer Kraft gesetzte Schecknummer anzugeben. Dies ist nur gültig, wenn der Schecktyp „Manuell“ ist. Schecknummern für reguläre Schecks werden während der Verarbeitung zugewiesen.

Lokale Steuern

Lokale Steuern nach Steuercode abrufen. Alle lokalen Steuern abrufen. Neue lokale Steuer hinzufügen. Lokale Steuer nach Steuercode löschen

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.
  • TaxCode unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM LocalTaxes WHERE EmployeeId = '123'

SELECT * FROM LocalTaxes WHERE EmployeeId = '123' AND TaxCode = 'AL-BIR1'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die LocalTaxes-Tabelle. Beispiel:

INSERT INTO LocalTaxes (EmployeeId, TaxCode, FilingStatus) VALUES ('999621027', 'AL-BIR1', 'N/A')
Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen von LocalTaxes aus der Tabelle:

DELETE FROM LocalTaxes WHERE employeeId = '123' AND TaxCode = 'AL-BIR1'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
Exemptions Decimal Falsch Wert der lokalen Steuerbefreiungen.Dezimal (12,2)
Exemptions2 Decimal Falsch Lokale Steuerbefreiungen 2 Wert.Dezimal (12,2)
FilingStatus String Falsch Lokaler Steuerstatus des Mitarbeiters. Muss mit der spezifischen lokalen Steuereinstellung übereinstimmen.
WorkPSD String Falsch PSD für Arbeitsort. Muss mit der Unternehmenskonfiguration übereinstimmen.
ResidentPSD String Falsch In PA geltender Resident-PSD (Political Subdivision Code). Muss mit der Unternehmenskonfiguration übereinstimmen.
TaxCode String Falsch Lokale Steuernummer.
CompanyId String True ID des Unternehmens.

Nicht primäre staatliche Steuer

Nicht-primäre staatliche Steuer hinzufügen/aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM NonPrimaryStateTax WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Tabelle „Non-PrimaryStateTax“. Beispiel:

INSERT INTO`[Nicht-PrimaryStateTax] `(Employeeid, TaxCalculationCode, Amount, TaxCode, ReciprocityCode, FilingStatus, W4FormYear, Percentage, Exemptions) VALUES ('123', 'AFAP', 50, 'NY', 'Both', 'M', 2019, 1.5, 5)
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Nicht-PrimaryStateTax-Tabelle:

UPDATE`[Nicht-PrimaryStateTax] `SET Percentage = 2.5, Exemptions = 10 WHERE employeeId = '123'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
TaxCalculationCode String Falsch Steuerberechnungscode. Übliche Werte sind *F* (Pauschal), *P* (Prozentsatz), *FDFP* (Pauschaler Dollarbetrag plus fester Prozentsatz).
Amount Decimal Falsch Staatliche Steuernummer.
TaxCode String Falsch Staatliche Steuernummer.
DeductionsAmount Decimal Falsch Box 4(b) auf Formular W4 (Jahr 2020 oder später): Abzugsbetrag. Dezimalzahl (12,2)
Exemptions2 Decimal Falsch Staatliche Steuerbefreiungen 2 Wert.Dezimal (12,2)
HigherRate Bool Falsch Box 2(c) auf Formular W4 (Jahr 2020 oder später): Mehrere Jobs oder Ehepartner arbeitet. Boolesch
OtherIncomeAmount Decimal Falsch Box 4a auf Formular W4 (Jahr 2020 oder später): Betrag sonstiger Einkünfte. Dezimalzahl (12,2)
DependentsAmount Decimal Falsch Box 3 auf Formular W4 (Jahr 2020 oder später): Gesamtbetrag für Angehörige. Dezimalzahl (12,2)
ReciprocityCode String Falsch Nicht-primärer staatlicher Steuerreziprozitätscode.
FilingStatus String Falsch Staatlicher Steuerstatus des Arbeitnehmers. Übliche Werte sind *S* (ledig), *M* (verheiratet).
SpecialCheckCalc String Falsch Berechnungscode für Zusatzschecks. Übliche Werte sind *Blocked* (Steuern auf Zusatzschecks gesperrt), *Supp* (Zusätzlichen Steuersatzcode verwenden).
W4FormYear Int Falsch Der Staat W4-Abschlussjahr Integer
Percentage Decimal Falsch Staatlicher Steuersatz. Dezimal (12,2)
Exemptions Decimal Falsch Wert der staatlichen Steuerfreibeträge.Dezimal (12,2)
CompanyId String True ID des Unternehmens.

PrimäreStaatlicheSteuer

Primäre staatliche Steuer hinzufügen/aktualisieren

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM PrimaryStateTax WHERE EmployeeId = '123'
Einfügen

Nachfolgend finden Sie ein Beispiel für das Einfügen in die Tabelle PrimaryStateTax. Beispiel:

INSERT INTO PrimaryStateTax (Employeeid, FilingStatus, TaxCalculationCode, Exemptions, Exemptions2, Percentage, W4FormYear, TaxCode, Amount) VALUES ('999621027', 'MS', 'AFAP', 10, 15, 5, 2019, GA, 100)
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer PrimaryStateTax-Tabelle:

UPDATE PrimaryStateTax SET Exemptions = 20, Amount = 125 WHERE employeeId = '123'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Wahr Mitarbeiter.EmployeeId ID des Mitarbeiters.
DeductionsAmount Decimal Falsch Box 4(b) auf Formular W4 (Jahr 2020 oder später): Abzugsbetrag. Dezimalzahl (12,2)
DependentsAmount Decimal Falsch Box 3 auf Formular W4 (Jahr 2020 oder später): Gesamtbetrag für Angehörige. Dezimalzahl (12,2)
FilingStatus String Falsch Staatlicher Steuerstatus des Arbeitnehmers. Übliche Werte sind *S* (ledig), *M* (verheiratet).
OtherIncomeAmount Decimal Falsch Box 4a auf Formular W4 (Jahr 2020 oder später): Betrag sonstiger Einkünfte. Dezimalzahl (12,2)
TaxCalculationCode String Falsch Steuerberechnungscode. Übliche Werte sind *F* (Pauschal), *P* (Prozentsatz), *FDFP* (Pauschaler Dollarbetrag plus fester Prozentsatz).
Exemptions Decimal Falsch Wert der staatlichen Steuerfreibeträge.Dezimal (12,2)
Exemptions2 Decimal Falsch Staatliche Steuerbefreiungen 2 Wert.Dezimal (12,2)
HigherRate Bool Falsch Box 2(c) auf Formular W4 (Jahr 2020 oder später): Mehrere Jobs oder Ehepartner arbeitet. Boolesch
Percentage Decimal Falsch Staatlicher Steuersatz. Dezimal (12,2)
W4FormYear Int Falsch Der Staat W4-Abschlussjahr Integer
TaxCode String Falsch Staatliche Steuernummer.
SpecialCheckCalc String Falsch Berechnungscode für Zusatzschecks. Übliche Werte sind *Blocked* (Steuern auf Zusatzschecks gesperrt), *Supp* (Zusätzlichen Steuersatzcode verwenden).
Amount Decimal Falsch Staatliche Steuernummer.
CompanyId String True ID des Unternehmens.

Sensible Daten

Erhält vertrauliche Mitarbeiterdaten direkt von Web Pay.

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM SensitiveData WHERE EmployeeId = '1234'
Einfügen

Nachfolgend finden Sie ein Beispiel zum Einfügen in eine SensitiveData-Tabelle.

INSERT INTO SensitiveData (EmployeeId, Disability, DisabilityClassifications, HasDisability, IsVeteran) VALUES ('1234', 'ads', 'dawd, afsc', '1', '0')
Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer SensitiveData-Tabelle:

UPDATE SensitiveData SET Disability = 'ads', DisabilityClassifications = 'dawd,afsc', HasDisability = '1' WHERE EmployeeId = '1234'
Spalten
Name Typ Nur Lesen Referenzen Beschreibung
EmployeeId [KEY] String Falsch Mitarbeiter.EmployeeId ID des Mitarbeiters.
CompanyId String Falsch ID des Unternehmens.
Disability String Falsch Beschreibung der Behinderung des Mitarbeiters oder der Unterbringung.
DisabilityClassifications String Falsch Gibt die Art der Behinderung an.
HasDisability String Falsch Gibt an, ob der Mitarbeiter eine Behinderung hat. Mögliche Werte: 0 = Nein, 1 = Ja oder 2 = Möchte ich nicht sagen.
Ethnicity String Falsch Gesetzliche Ethnizität oder Rasse des Arbeitnehmers.
EthnicRacialIdentities String Falsch Vom Mitarbeiter bevorzugte oder gewählte ethnische Zugehörigkeit oder Rasse.
DisplayPronouns String Falsch Gibt an, ob die bevorzugten Pronomen eines Mitarbeiters den Kollegen in der Community, im Verzeichnis usw. angezeigt werden. Mögliche Werte: 0 = Nein oder 1 = Ja.
GenderIdentityDescription String Falsch Vom Mitarbeiter bevorzugtes oder gewähltes Geschlecht. Mögliche Werte: 0 = Nein, 1 = Ja oder 2 = Möchte ich nicht sagen.
IdentifyAsLegalGender String Falsch Selbstidentifizierung des rechtlichen Geschlechts durch den Arbeitnehmer.
LegalGender String Falsch Gesetzliches Geschlecht des Mitarbeiters.
Pronouns String Falsch Vom Mitarbeiter bevorzugte oder gewählte Pronomen.
SexualOrientation String Falsch Selbstangabe der sexuellen Orientierung des Arbeitnehmers.
IsVeteran String Falsch Gibt an, ob der Mitarbeiter ein Veteran ist. Mögliche Werte: 0 = Nein, 1 = Ja oder 2 = Möchte ich nicht sagen.
Veteran String Falsch Veteranennotizen des Mitarbeiters.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

Ansichten des Paylocity Connectors

Name Beschreibung
CompanyCodes Alle Buchungskreise abrufen
CustomFields Alle benutzerdefinierten Felder abrufen
DirectDeposit Alle Direkteinzahlungen erhalten
Employees Alle Mitarbeiterinfos abrufen
PayStatementsdetails Holen Sie sich die detaillierten Gehaltsabrechnungsdaten des Mitarbeiters für das angegebene Jahr. Holen Sie sich die detaillierten Gehaltsabrechnungsdaten des Mitarbeiters für das angegebene Jahr und das angegebene Scheckdatum.
PayStatementssummary Ruft die zusammenfassenden Daten der Gehaltsabrechnungen der Mitarbeiter für das angegebene Jahr ab. Ruft die zusammenfassenden Daten der Gehaltsabrechnungen der Mitarbeiter für das angegebene Jahr und das angegebene Scheckdatum ab.

Firmencodes

Alle Unternehmenscodes abrufen

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • codeResource unterstützt den '='-Vergleich.

Bei einfachen SELECTs wird der CodeResource-Wert als costCenter1 betrachtet. Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CompanyCodes WHERE codeResource = 'costCenter1'
Spalten
Name Typ Referenzen Beschreibung
Code String Code.
Description String Beschreibung.
CodeResource String Art des Unternehmenscodes. Gemeinsame Werte Kostenstelle1, Kostenstelle2, Kostenstelle3, Abzüge, Einkünfte, Steuern, Gehaltsstufe, Positionen.
CompanyId String ID des Unternehmens.

Benutzerdefinierte Felder

Alle benutzerdefinierten Felder abrufen

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • category unterstützt den Vergleich '='.

Bei einfachen SELECTs wird der Kategoriewert als PayrollAndHR betrachtet. Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFields WHERE Category = 'PayrollAndHR'
Spalten
Name Typ Referenzen Beschreibung
Category String Die Kategorie des benutzerdefinierten Felds.
Label String Die benutzerdefinierte Feldbezeichnung.
Values String Eine Reihe von Werten, die auf das benutzerdefinierte Feld anwendbar sind.
Type String Der benutzerdefinierte Feldtyp.
IsRequired Bool Gibt an, ob das benutzerdefinierte Feld erforderlich ist.
DefaultValue String Gibt den Standardwert des benutzerdefinierten Felds an.
CompanyId String ID des Unternehmens.

Direkte Einzahlung

Alle Direkteinzahlungen erhalten

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM DirectDeposit WHERE EmployeeId = '123'
Spalten
Name Typ Referenzen Beschreibung
EmployeeId [KEY] String Mitarbeiter.EmployeeId ID des Mitarbeiters.
AdditionalDirectDeposit String Zusätzliche Direkteinzahlungen, die nicht die Hauptdirekteinzahlung sind.
MainDirectDepositRoutingNumber String ABA Transit Routing Number, ohne Bindestriche oder Leerzeichen eingegeben.
MainDirectDepositNameOnAccount String Name auf dem Bankkonto. Standardmäßig der Name des Mitarbeiters.
MainDirectDepositBlockSpecial Bool Gibt an, ob die direkte Einzahlung gesperrt werden soll, wenn spezielle Scheckarten wie Boni verarbeitet werden.
MainDirectDepositAccountNumber String Kontonummer, ohne Sonderzeichen und Leerzeichen eingegeben.
MainDirectDepositIsSkipPreNote Bool Gibt an, ob für das Konto keine Vormerkung erfolgt.
MainDirectDepositAccountType String Kontotyp. Gültige Werte sind *C* (Girokonto), *S* (Sparkonto), *P* (PayCard).
MainDirectDepositPreNoteDate Date Datum, an dem die Vornotiz des Kontos endet. Gängige Formate sind *MM-TT-CCYY*, *CCYY-MM-TT*.
CompanyId String ID des Unternehmens.

Mitarbeiter

Alle Mitarbeiterinformationen abrufen

Tabellenspezifische Informationen
Wählen

Paylocity unterstützt keine Spalte zum Filtern dieser Tabelle. Alle Filter werden clientseitig ausgeführt.

Spalten
Name Typ Referenzen Beschreibung
EmployeeId [KEY] String Mitarbeiter-ID
StatusCode String Aktueller Arbeitsstatus des Mitarbeiters. Übliche Werte sind *A* (Aktiv), *L* (Beurlaubt), *T* (Beendet).
StatusTypeCode String Aktueller Arbeitsstatus des Mitarbeiters.
CompanyId String ID des Unternehmens.

Gehaltsabrechnungsdetails

Daten zu den Gehaltsabrechnungen der Mitarbeiter für das angegebene Jahr abrufen. Daten zu den Gehaltsabrechnungen der Mitarbeiter für das angegebene Jahr und das angegebene Scheckdatum abrufen.

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.
  • Year unterstützt den '='-Vergleich.
  • CheckDate unterstützt den '='-Vergleich.

Im Falle eines einfachen SELECT gibt Paylocity die Datensätze des aktuellen und des letzten Jahres zurück. Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019 AND CheckDate = '2019-02-01'
Spalten
Name Typ Referenzen Beschreibung
EmployeeId [KEY] String Mitarbeiter.EmployeeId ID des Mitarbeiters
CheckDate [KEY] Date Das Prüfdatum der Gehaltsabrechnungsdetails
CompanyId [KEY] String ID des Unternehmens
TransactionNumber Int Die Transaktionsnummer der Lohnabrechnungsdetails
DetCode String Der Det-Code der Gehaltsabrechnungsdetails
Det String Die Detaildaten der Lohnabrechnung
Hours Decimal Die Daten zur Stundenlohnabrechnung
Rate Decimal Die detaillierten Daten zur Lohnsatzabrechnung
TransactionType String Der Transaktionstyp der Lohnabrechnungsdetails
Year Int Das Jahr, für das die Lohnabrechnungsdaten abgerufen werden sollen.
Amount Decimal Die Höhe der Lohnabrechnungsdetails
DetType String Lohnabrechnungsdetails im Zusammenhang mit bestimmten Abzugs-, Verdienst- oder Steuerarten.
EligibleCompensation Decimal Die Daten zur berechtigten Vergütung in den Gehaltsabrechnungsdetails

Gehaltsabrechnungszusammenfassung

Holen Sie sich die zusammengefassten Gehaltsabrechnungsdaten der Mitarbeiter für das angegebene Jahr. Holen Sie sich die zusammengefassten Gehaltsabrechnungsdaten der Mitarbeiter für das angegebene Jahr und das angegebene Prüfdatum.

Tabellenspezifische Informationen
Wählen

Der Connector verwendet die Paylocity API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • EmployeeId unterstützt den '='-Vergleich.
  • Year unterstützt den '='-Vergleich.
  • CheckDate unterstützt den '='-Vergleich.

Bei einfachen SELECT-Vorgängen gibt Paylocity Datensätze aus dem aktuellen und dem vorherigen Jahr zurück.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019 AND CheckDate = '2019-02-01'
Spalten
Name Typ Referenzen Beschreibung
EmployeeId [KEY] String Mitarbeiter.EmployeeId ID des Mitarbeiters
CheckDate [KEY] Date Das Prüfdatum der Gehaltsabrechnungsübersichtsdaten
CompanyId [KEY] String ID des Unternehmens
TransactionNumber Int Die Transaktionsnummer der Gehaltsabrechnungsübersichtsdaten
BeginDate Date Das Anfangsdatum der Lohnabrechnungsübersichtsdaten
AutoPay Bool Wenn AutoPay aktiviert ist, werden die Zahlungsabrechnungsübersichtsdaten
OvertimeDollars Decimal Zusammenfassung der Daten zur Überstundenvergütung
GrossPay Decimal Die Bruttolohn-Zusammenfassungsdaten der Gehaltsabrechnung
NetPay Decimal Der Nettolohn der Gehaltsabrechnungsübersichtsdaten
Hours Decimal Die zusammengefassten Daten der Stundenlohnabrechnung
RegularHours Decimal Die zusammenfassenden Daten der Lohnabrechnung für die regulären Stunden
Process Int Der Prozess der Gehaltsabrechnungszusammenfassungsdaten
CheckNumber Int Die Schecknummer der Gehaltsabrechnungsübersichtsdaten
WorkersCompCode String Der Workers CompCode der Gehaltsabrechnungszusammenfassungsdaten
NetCheck Decimal Der Netto-Check der Lohnabrechnungs-Zusammenfassungsdaten
VoucherNumber Int Die Belegnummer der Lohnabrechnungsübersichtsdaten
DirectDepositAmount Decimal Der direkte Einzahlungsbetrag der Gehaltsabrechnungsübersichtsdaten
RegularDollars Decimal Zusammenfassung der Gehaltsdaten in regulären Dollar
Year Int Die zusammengefassten Daten des Jahres der Gehaltsabrechnung
OvertimeHours Decimal Die zusammengefassten Daten der Lohnabrechnung „Überstunden“
EndDate Date Das Enddatum der Zusammenfassungsdaten der Gehaltsabrechnung

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Paylocity hinaus erweitern.

Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Paylocity zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.

Gespeicherte Prozeduren für den Paylocity Connector

Name Beschreibung
CreatePayEntryImportBatch Lohneintrag-Zeiterfassungsstapel erstellen oder zusammenführen.
CreateSchema Erstellt eine Schema einer Tabelle in Paylocity.
GetOAuthAccessToken Ruft ein Authentifizierungstoken von Paylocity ab.
MergePayEntryImportBatch Dies wird verwendet, um einen Charge zu erstellen oder zusammenzuführen, wenn der Importstatus des Lohneintrags bei TimeClockValidationPendingAcknowledgement angehalten wird.
OnBoardingEmployee Die Onboarding-API sendet Mitarbeiterdaten an Paylocity Onboarding, um einen einfachen und genauen Einstellungsprozess für die anschließende Durchführung in Web Pay zu gewährleisten.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei Paylocity verwendet wird.

ErstellenPayEntryImportBatch

Erstellen oder Zusammenführen eines Stapels mit Lohneintrag und Zeiterfassung.

Gespeicherte Prozeduren - Spezifische Informationen

Um in CreatePayEntryImportBatch einzufügen, müssen Sie die TimeEntry-Details und einen Zahlungszeitraum angeben. Die TimeEntry-Details können über eine temporäre Tabelle übermittelt werden, indem Sie sie zuerst in die reine Eingabetabelle Input_TimeEntry einfügen. Der Zahlungszeitraum kann durch Festlegen von PayPeriodBeginDate, PayPeriodEndDate und CheckDate angegeben werden. Alternativ kann die CalendarId angegeben werden. Beispiel:

INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623635, 'E', 'REG', 40.00, 30, '2021-08-08', '2021-08-14')
INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623636, 'E', 'REG', 40.00, 25, '2021-08-08', '2021-08-14')

EXECUTE CreatePayEntryImportBatch TimeEntry = 'Input_TimeEntry#TEMP', AutoAcknowledge = 'true', BatchName = 'Test', PayPeriodBeginDate = '2021-08-15', PayPeriodEndDate = '2021-08-21', CheckDate = '2021-08-27'

Um die verarbeiteten Dateninformationen abzurufen, verwenden Sie die folgende Abfrage.

SELECT * FROM LastResultInfo#TEMP
Eingang
Name Typ Erforderlich Beschreibung
TimeEntry String True Die CSV-Zeitimportdaten. Diese können übermittelt werden, indem sie in die Nur-Eingabe-Tabelle Input_TimeEntry eingefügt werden.
AutoAcknowledge Boolean Falsch Verwenden Sie „True“, um etwaige Fehler oder Warnungen für den Import automatisch zu bestätigen, „Falsch“, um sie nicht automatisch zu bestätigen
BatchName String Falsch Der Name der Charge.
MergeBatchId String Falsch Die ID des zusammenzuführenden Charge.
CalendarId String Falsch Die Kalender-ID für das Prüfdatum.
PayPeriodBeginDate String Falsch Das Beginndatum der Lohnperiode im Format JJJJ-MM-TT.
PayPeriodEndDate String Falsch Das Enddatum der Lohnperiode im Format JJJJ-MM-TT.
CheckDate String Falsch Das Scheckdatum des Lohnzeitraums im Format JJJJ-MM-TT.
Ergebnissatzspalten
Name Typ Beschreibung
TimeImportFileTrackingId String Die ID der Zeitimportdateiverfolgung.
Status String Status des Zeitimport-Batches.
BatchId String Die ID des Stapels.

Schema erstellen

Erstellt eine Schema einer Tabelle in Paylocity.

Schema erstellen

Erstellt eine lokale Schema (.rsd) aus einer vorhandenen Tabelle oder Ansicht im Datenmodell.

Die Schema wird in dem Verzeichnis erstellt, das in festgelegt ist Location Verbindungseigenschaft, wenn dieses Verfahren ausgeführt wird. Sie können die Datei bearbeiten, um Spalten ein- oder auszuschließen, Spalten umzubenennen oder Spaltendatentypen anzupassen.

Der Connector überprüft die Location um zu bestimmen, ob die Namen von .rsd-Dateien mit einer Tabelle oder Ansicht im Datenmodell übereinstimmen. Wenn ein Duplikat vorhanden ist, hat die Schema Vorrang vor der Standardinstanz dieser Tabelle im Datenmodell. Wenn eine Schema in vorhanden ist Location das nicht mit einer vorhandenen Tabelle oder Ansicht übereinstimmt, wird dem Datenmodell des Connectors ein neuer Tabellen- oder Ansichtseintrag hinzugefügt.

Eingang
Name Typ Erforderlich Beschreibung
TableName String True Der Name der Tabelle.
FileName String Falsch Der vollständige Dateipfad und Name des zu generierenden Schema, erforderlich, wenn die Standortverbindungseigenschaft nicht festgelegt ist. Beispiel: „C:\ Scripts\Employee.rsd“
SimplifyNames String Falsch Ob einfache Namen für Spalten ausgegeben werden sollen oder nicht. Standardmäßig wird vereinfacht.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Ob das Schema erfolgreich heruntergeladen wurde oder nicht.

GetOAuthAccessToken

Ruft ein Authentifizierungstoken von Paylocity ab.

Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Der Zugriffstoken, der für die Kommunikation mit Paylocity verwendet wird.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.

MergePayEntryImportBatch

Dies wird verwendet, um einen Charge zu erstellen oder zusammenzuführen, wenn der Importstatus des Lohneintrags bei TimeClockValidationPendingAcknowledgement angehalten wird.

Spezifische Informationen zu gespeicherten Prozeduren

TimeImportFileTrackingId ist erforderlich, um dieses Verfahren auszuführen. Die TimeImportFileTrackingId wird als Antwort von CreatePayEntryImportBatch generiert Gespeicherte Prozedur. Beispiel:

EXECUTE MergePayEntryImportBatch TimeImportFileTrackingId = 'e84b3808-4477-423a-89bf-e32f58c0e685'
Eingang
Name Typ Erforderlich Beschreibung
TimeImportFileTrackingId String True ID der Zeitimportdateiverfolgung.
Ergebnissatzspalten
Name Typ Beschreibung
Message String Meldung zum Charge „Erstellen“ oder „Zusammenführen“.

OnBoardingMitarbeiter

Die Onboarding-API sendet Mitarbeiterdaten an Paylocity Onboarding, um einen einfachen und genauen Einstellungsprozess für die anschließende Durchführung in Web Pay zu gewährleisten.

Gespeicherte Prozeduren - Spezifische Informationen

Paylocity erlaubt die Verwendung mehrerer Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Zur Ausführung dieses Verfahrens sind die Parameter FirstName und LastName erforderlich. Beispiel:

EXECUTE OnBoardingEmployee FirstName = 'EmpFirstName', LastName = 'EmpLastName', BaseRate = 350.0, CostCenter1 = '100', DefaultHours = '9', EmployeeStatus = 'A', MaritalStatus = 'S'
Eingang
Name Typ Erforderlich Beschreibung
FirstName String Richtig Vorname des Mitarbeiters
LastName String Wahr Nachname des Mitarbeiters.
EmployeeId String Falsch Mitarbeiter-ID (optional)
Address1 String Falsch 1. Adresszeile der Privatadresse des Mitarbeiters.
Address2 String Falsch 2. Adresszeile der Privatadresse des Mitarbeiters.
AutoPayType String Falsch N - Der Mitarbeiter erhält bei der Gehaltsabrechnung weder automatisch sein Gehalt noch seine Stunden, D - Der Mitarbeiter erhält bei der Gehaltsabrechnung automatisch seine Standardstunden, S - Der Mitarbeiter erhält bei der Gehaltsabrechnung automatisch seinen Gehaltsbetrag. Die zulässigen Werte sind N, D, S.
BaseRate Decimal Falsch 2. Adresszeile der Privatadresse des Mitarbeiters.
City String Falsch Heimatstadt des Mitarbeiters.
CostCenter1 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung usw.* Muss mit der Unternehmenskonfiguration übereinstimmen.
CostCenter2 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung usw.* Muss mit der Unternehmenskonfiguration übereinstimmen.
CostCenter3 String Falsch Vom Arbeitgeber definierter Standort, wie *Niederlassung, Bereich, Abteilung usw.* Muss mit der Unternehmenskonfiguration übereinstimmen.
DefaultHours Decimal Falsch Die Standardarbeitsstunden des Mitarbeiters werden konstant geleistet. Wenn autoPayType auf D eingestellt ist, wird dem Mitarbeiter für die Standardarbeitsstunden der Stundengrundsatz bezahlt.
EmployeeStatus String Falsch Aktueller Arbeitsstatus des Mitarbeiters. Übliche Werte sind *A (Aktiv), L (Beurlaubt), T (Beendet)*.
EmploymentType String Falsch Aktuelle Beschäftigungsart des Mitarbeiters. Häufige Werte: RFT * (Reguläre Vollzeit), RPT (Reguläre Teilzeit), SNL (Saisonal), TFT (Befristete Vollzeit), TPT (Befristete Teilzeit)*.
FederalFilingStatus String Falsch Bundesweiter Steuerstatus des Arbeitnehmers. Häufige Werte *M (verheiratet), S (ledig)*.
Sex String Falsch Geschlecht des Mitarbeiters. Häufige Werte *M (Männlich), F (Weiblich)*.
HireDate Date Falsch Einstellungsdatum des Mitarbeiters. Gängige Formate sind TT-MM-CCJJ, CCJJ-MM-TT
HomePhone String Falsch Geschlecht des Mitarbeiters. Häufige Werte *M (Männlich), F (Weiblich)*.
MaritalStatus String Falsch Familienstand des Mitarbeiters. Häufige Werte *D (geschieden), M (verheiratet), S (ledig), W (verwitwet)*.
PersonalMobilePhone String Falsch Private Mobiltelefonnummer des Mitarbeiters.
PayFrequency String Falsch Aktuelle Zahlungshäufigkeit des Mitarbeiters. Übliche Werte sind *A (jährlich), B (zweiwöchentlich), D (täglich), M (monatlich), S (halbmonatlich), Q (vierteljährlich), W (wöchentlich)*.
PersonalEmailAddress String Falsch Persönliche Email Adresse des Mitarbeiters.
PayType String Falsch Lohnart des Mitarbeiters. Gültige Werte sind *Stundenlohn oder Gehalt*.
RatePer String Falsch Häufigkeit des Basislohns des Mitarbeiters, die mit dem Lohntyp „Stündlich“ verwendet wird. Übliche Werte sind *Stunde oder Woche*. Standard ist Stunde.
Salary Decimal Falsch Bruttogehalt des Mitarbeiters pro Abrechnungszeitraum, verwendet mit der Lohnart „Gehalt“.
State String Falsch Heimatstaat des Mitarbeiters.
Ssn String Falsch Sozialversicherungsnummer des Arbeitnehmers. Lassen Sie das Feld leer, wenn keine gültige Sozialversicherungsnummer verfügbar ist.
StateFilingStatus String Falsch Steuerstatus des Arbeitnehmers im Bundesstaat. Übliche Werte sind *M (verheiratet), S (ledig)*.
SuiState String Falsch Staatliche Arbeitslosenversicherung (SUI) für Arbeitnehmer.
TaxForm String Falsch Steuerformular für Arbeitnehmer zur Meldung des Einkommens. Gültige Werte sind *W2, 1099M, 1099R*. Standard ist W2.
TaxState String Falsch Primärer Steuerstaat des Arbeitnehmers.
UserName String Falsch Erforderlich. Vom Arbeitgeber zugewiesener Benutzername für die Anmeldung beim Onboarding. Doppelte Benutzernamen sind nicht zulässig. Muss zwischen 3 und 20 Zeichen lang sein und darf keine Sonderzeichen außer. (Punkt) und _ (Unterstrich) enthalten.
WorkEmailAddress String Falsch Geschäftliche Email des Mitarbeiters.
Zip String Falsch Postleitzahl des Wohnorts des Mitarbeiters.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Ausführungsstatus der gespeicherten Prozedur

Aktualisieren Sie das OAuthAccessToken

Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei Paylocity verwendet wird.

Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Der Zugriffstoken, der für die Kommunikation mit Paylocity verwendet wird.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.

Systemtabellen

Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.

Schematabellen

Die folgenden Tabellen geben Datenbankmetadaten für Paylocity zurück:

Datenquellentabellen

Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:

  • sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
  • sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.

Abfrageinformationstabellen

Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück:

  • Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.

Sys_catalogs

Listet die verfügbaren Datenbanken auf.

Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:

SELECT * FROM sys_catalogs
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.
SchemaName String Der Schema.

Sys_tables

Listet die verfügbaren Tabellen auf.

Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:

SELECT * FROM sys_tables
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht.
TableType String Der Tabellentyp (Tabelle oder Ansicht).
Description String Eine Beschreibung der Tabelle oder Ansicht.
IsUpdateable Boolean Ob die Tabelle aktualisiert werden kann.

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle „Employee“ zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Employee'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht, die die Spalte enthält.
ColumnName String Der Spaltenname.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Speichergröße der Spalte.
DisplaySize Int32 Die normale Maximalbreite der angegebenen Spalte in Zeichen.
NumericPrecision Int32 Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt.
IsNullable Boolean Ob die Spalte Null enthalten kann.
Description String Eine kurze Beschreibung der Spalte.
Ordinal Int32 Die Sequenznummer der Spalte.
IsAutoIncrement String Ob der Spaltenwert in festen Schritten zugewiesen wird.
IsGeneratedColumn String Ob die Spalte generiert wird.
IsHidden Boolean Ob die Spalte ausgeblendet ist.
IsArray Boolean Ob die Spalte ein Array ist.
IsReadOnly Boolean Ob die Spalte schreibgeschützt ist.
IsKey Boolean Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle ist.

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:

SELECT * FROM sys_procedures
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Das Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur.
Description String Eine Beschreibung der gespeicherten Prozedur.
ProcedureType String Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION.

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur „CreateSchema“ zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateSchema' AND Direction=1 OR Direction=2
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Der Name des Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur, die den Parameter enthält.
ColumnName String Der Name des gespeicherten Prozedurparameters.
Direction Int32 Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern.
NumericPrecision Int32 Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten.
IsNullable Boolean Ob der Parameter Null enthalten kann.
IsRequired Boolean Ob der Parameter zur Ausführung der Prozedur erforderlich ist.
IsArray Boolean Ob der Parameter ein Array ist.
Description String Die Beschreibung des Parameters.
Ordinal Int32 Der Index des Parameters.

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Employee-Tabelle ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Employee'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
IsKey Boolean Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird.
IsForeignKey Boolean Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.

Sys_foreignkeys

Beschreibt die Fremdschlüssel.

Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.
ForeignKeyType String Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist.

Sys_primarykeys

Beschreibt die Primärschlüssel.

Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:

SELECT * FROM sys_primarykeys
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
KeySeq String Die Sequenznummer des Primärschlüssels.
KeyName String Der Name des Primärschlüssels.

Sys_indexes

Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.

Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Index enthält.
SchemaName String Der Name des Schema, das den Index enthält.
TableName String Der Name der Tabelle, die den Index enthält.
IndexName String Der Indexname.
ColumnName String Der Name der mit dem Index verknüpften Spalte.
IsUnique Boolean Wahr, wenn der Index eindeutig ist. Andernfalls falsch.
IsPrimary Boolean Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch.
Type Int16 Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3).
SortOrder String Die Sortierreihenfolge: A für aufsteigend oder D für absteigend.
OrdinalPosition Int16 Die Sequenznummer der Spalte im Index.

Sys_connection_props

Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:paylocity:config:

Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.

Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:

SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name Typ Beschreibung
Name String Der Name der Verbindungseigenschaft.
ShortDescription String Eine kurze Beschreibung.
Type String Der Datentyp der Verbindungseigenschaft.
Default String Der Standardwert, sofern nicht explizit einer festgelegt wurde.
Values String Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben.
Value String Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard.
Required Boolean Ob für die Immobilie eine Anschlusspflicht besteht.
Category String Die Kategorie der Verbindungseigenschaft.
IsSessionProperty String Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird.
Sensitivity String Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird.
PropertyName String Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise.
Ordinal Int32 Der Index des Parameters.
CatOrdinal Int32 Der Index der Parameterkategorie.
Hierarchy String Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen.
Visible Boolean Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist.
ETC String Verschiedene sonstige Informationen zum Objekt.

Sys_sqlinfo

Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.

Entdecken der SELECT-Funktionen der Datenquelle

Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.

Name Beschreibung Mögliche Werte
AGGREGATE_FUNCTIONS Unterstützte Aggregatfunktionen. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Ob die COUNT-Funktion unterstützt wird. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. [
IDENTIFIER_QUOTE_CLOSE_CHAR Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. ]
SUPPORTED_OPERATORS Eine Liste unterstützter SQL-Operatoren. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Unterstützte String-Funktionen. 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 Unterstützte numerische Funktionen. 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 Unterstützte Datums-/Uhrzeitfunktionen. 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 Zeigt an, dass während der Replikation Tabellen übersprungen wurden.
REPLICATION_TIMECHECK_COLUMNS Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen.
IDENTIFIER_PATTERN Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist.
SUPPORT_TRANSACTION Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. YES, NO
DIALECT Gibt den zu verwendenden SQL-Dialekt an.
KEY_PROPERTIES Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren.
SUPPORTS_MULTIPLE_SCHEMAS Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. YES, NO
DATASYNCVERSION Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY Die Kategorie „Datensynchronisierung“ dieses Treiber. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Ob Charge Operationen unterstützt werden. YES, NO
SQL_CAP Alle unterstützten SQL-Funktionen für diesen Treiber. 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 Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an.
ENABLE_EF_ADVANCED_QUERY Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. YES, NO
PSEUDO_COLUMNS Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt.
MERGE_ALWAYS Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation.
REPLICATION_MIN_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll.
REPLICATION_START_DATE Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben.
REPLICATION_MAX_DATE_QUERY Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation.
REPLICATION_MAX_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird.
CHECKCACHE_USE_PARENTID Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können.

Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.

Spalten
Name Typ Beschreibung
NAME String Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann.
VALUE String Details zum unterstützten SQL bzw. zur SQL-Syntax.

Systemidentität

Gibt Informationen zu versuchten Änderungen zurück.

Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:

SELECT * FROM sys_identity
Spalten
Name Typ Beschreibung
Id String Die von einer Operation zurückgegebene, von der Datenbank generierte ID.
Batch String Eine Kennung für den Charge. 1 für einen einzelnen Operation.
Operation String Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT.
Message String SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist.

Systeminformationen

Beschreibt die verfügbaren Systeminformationen.

Die folgende Abfrage ruft alle Spalten ab:

SELECT * FROM sys_information
Spalten
Name Typ Beschreibung
Product String Der Name des Produkts.
Version String Die Versionsnummer des Produkts.
Datasource String Der Name der Datenquelle, mit der das Produkt eine Verbindung herstellt.
NodeId String Die eindeutige Kennung der Maschine, auf der das Produkt installiert ist.
HelpURL String Die URL zur Hilfedokumentation des Produkts.
License String Die Lizenzinformationen für das Produkt. (Wenn diese Informationen nicht verfügbar sind, kann das Feld leer gelassen oder als „N/A“ markiert werden.)
Location String Der Dateipfad, in dem die Produktbibliothek gespeichert ist.
Environment String Die Version der Umfeld oder Rumtine, unter der das Produkt derzeit ausgeführt wird.
DataSyncVersion String Die zur Verwendung dieses Connectors erforderliche Synchronisierungsebene.
DataSyncCategory String Die Kategorie der Synchronisierungsfunktionalität (z. B. Quelle, Ziel).

Erweiterte Konfigurationseigenschaften

Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.

Verbindung

Eigenschaft Beschreibung
CompanyId Die ID der Firmendatei.
CustomFieldsCategory Die benutzerdefinierte Feldkategorie im Unternehmen.
UseSandbox Auf „True“ setzen, wenn Sie ein Sandbox-Konto verwenden.
RSAPublicKey Setzen Sie dies auf den von Paylocity freigegebenen öffentlichen Schlüssel.
Key Der geheime Schlüssel für den symmetrischen Algorithmus.
IV Der Initialisierungsvektor (IV).
UsePayEntryAPI Auf „true“ setzen, wenn Sie auf die Pay Entry API zugreifen möchten. Wenn diese Eigenschaft auf „true“ gesetzt ist, sollten Sie einen anderen Speicherort für OAuthSettingsFile angeben.

OAuth

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthAccessToken Der Zugriffstoken für die Verbindung mittels OAuth.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

SSL

Eigenschaft Beschreibung
SSLClientCert Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).
SSLClientCertType Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält.
SSLClientCertPassword Das Passwort für das TLS/SSL-Client-Zertifikat.
SSLClientCertSubject Der Betreff des TLS/SSL-Client-Zertifikats.
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

Schema

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.

Verschiedenes

Eigenschaft Beschreibung
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Verbindung

Dieser Abschnitt enthält eine vollständige Liste der Verbindungseigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
CompanyId Die ID der Firmendatei.
CustomFieldsCategory Die benutzerdefinierte Feldkategorie im Unternehmen.
UseSandbox Auf „True“ setzen, wenn Sie ein Sandbox-Konto verwenden.
RSAPublicKey Setzen Sie dies auf den von Paylocity freigegebenen öffentlichen Schlüssel.
Key Der geheime Schlüssel für den symmetrischen Algorithmus.
IV Der Initialisierungsvektor (IV).
UsePayEntryAPI Auf „true“ setzen, wenn Sie auf die Pay Entry API zugreifen möchten. Wenn diese Eigenschaft auf „true“ gesetzt ist, sollten Sie einen anderen Speicherort für OAuthSettingsFile angeben.

Firmen-ID

Die ID der Firmendatei.

Datentyp

string

Standardwert

""

Hinweise

Die ID der Firmendatei.

BenutzerdefinierteFelderKategorie

Die benutzerdefinierte Feldkategorie im Unternehmen.

Datentyp

string

Standardwert

PayrollAndHR

Hinweise

Fügen Sie durch Kommas getrennte Werte hinzu, um mehr als eine benutzerdefinierte Feldkategorie festzulegen. Das Folgende ist ein Beispiel für eine benutzerdefinierte Feldkategorie:

  • PayrollAndHR

Sandbox verwenden

Auf „true“ setzen, wenn Sie ein Sandbox-Konto verwenden.

Datentyp

bool

Standardwert

false

Hinweise

Auf „true“ setzen, wenn Sie ein Sandbox-Konto verwenden.

RSAPublicKey

Setzen Sie dies auf den von Paylocity freigegebenen öffentlichen Schlüssel.

Datentyp

string

Standardwert

""

Hinweise

Geben Sie entweder den Schlüsselwert oder den vollständigen Pfad der Datei ein. Dies ist für die Ausführung von Insert- und Update-Anweisungen erforderlich.

Schlüssel

Der geheime Schlüssel für den symmetrischen Algorithmus.

Datentyp

string

Standardwert

""

Hinweise

Der symmetrische AES-Schlüssel (Base 64-kodiert), verschlüsselt mit dem öffentlichen Schlüssel von Paylocity. Paylocity entschlüsselt den AES-Schlüssel mit RSA-Entschlüsselung und verwendet ihn zum Entschlüsseln des Inhalts. Es ist eine optionale Eigenschaft, wenn IV-Wert nicht angegeben ist. In diesem Fall generiert der Treiber intern einen Schlüssel.

IV

Der Initialisierungsvektor (IV).

Datentyp

string

Standardwert

""

Hinweise

Der AES IV (Base 64-kodiert), der beim Verschlüsseln des Inhalts verwendet wird. Wenn Sie den Schlüssel, diese Eigenschaft ist optional, da der Treiber intern einen IV generiert.

Verwenden SiePayEntryAPI

Auf „true“ setzen, wenn Sie auf die Pay Entry API zugreifen möchten. Wenn diese Eigenschaft auf „true“ gesetzt ist, sollten Sie einen anderen Speicherort für OAuthSettingsFile angeben.

Datentyp

bool

Standardwert

false

Hinweise

Auf „true“ setzen, wenn Sie auf die Pay Entry API zugreifen möchten. Wenn diese Eigenschaft auf „true“ gesetzt ist, sollten Sie einen anderen Speicherort für OAuthSettingsFile angeben.

OAuth

Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthAccessToken Der Zugriffstoken für die Verbindung mittels OAuth.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

OAuth initiieren

Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

OFF

Hinweise

Folgende Optionen stehen zur Verfügung:

  1. OFF: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.
  2. GETANDREFRESH: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.
  3. REFRESH: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshToken übernehmen.

OAuthClientId

Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.

OAuthClientSecret

Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret Eigentum.

OAuth-Zugriffstoken

Der Zugriffstoken für die Verbindung per OAuth.

Datentyp

string

Standardwert

""

Hinweise

Der OAuthAccessToken Eigenschaft wird für die Verbindung per OAuth verwendet. Die OAuthAccessToken wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es hat ein serverabhängiges Timeout und kann zwischen Anfragen wiederverwendet werden.

Das Zugriffstoken wird anstelle Ihres Benutzernamens und Passworts verwendet. Das Zugriffstoken schützt Ihre Anmeldeinformationen, indem es sie auf dem Server speichert.

OAuthSettingsLocation

Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

%APPDATA%\Paylocity Data Provider\OAuthSettings.txt

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.

Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

Der Standardspeicherort ist „%APPDATA%\ Paylocity Data Provider\OAuthSettings.txt“ mit %APPDATA% auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind

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

wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.

Die folgende Tabelle listet den Wert von auf %APPDATA% nach Operationssystem:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Mac ~/Bibliothek/Anwendungsunterstützung
Linux ~/.config

OAuthVerifier

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.

Datentyp

string

Standardwert

""

Hinweise

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.

Authentifizierung auf Headless-Maschinen

Siehe, um die zu erhalten OAuthVerifier Wert.

OAuthSettingsLocation festlegen zusammen mit OAuthVerifier. Beim Verbinden tauscht der Connector die OAuthVerifier für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.

Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.

Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.

OAuthRefreshToken

Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.

Datentyp

string

Standardwert

""

Hinweise

Der OAuthRefreshToken Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.

OAuthLäuftAbIn

Die Lebensdauer des OAuth AccessToken in Sekunden.

Datentyp

string

Standardwert

""

Hinweise

Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.

OAuthTokenTimestamp

Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

Datentyp

string

Standardwert

""

Hinweise

Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.

SSL

Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
SSLClientCert Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).
SSLClientCertType Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält.
SSLClientCertPassword Das Passwort für das TLS/SSL-Client-Zertifikat.
SSLClientCertSubject Der Betreff des TLS/SSL-Client-Zertifikats.
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

SSLClientCert

Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).

Datentyp

string

Standardwert

""

Hinweise

Der Name des Zertifikatspeichers für das Client-Zertifikat.

Der SSLClientCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an SSLClientCert. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in SSLClientCertPassword an.

SSLClientCert wird in Verbindung mit SSLClientCertSubject verwendet, um Client-Zertifikate anzugeben. Wenn SSLClientCert hat einen Wert und SSLClientCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Siehe SSLClientCertSubject für weitere Informationen.

Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.

Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:

Eigenschaft Beschreibung
MY Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält.
CA Zertifikate der Zertifizierungsstelle.
ROOT Stammzertifikate.
SPC Zertifikate von Softwareherstellern.

In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.

Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei gesetzt werden (z. B. PKCS12-Zertifikatsspeicher).

SSLClientCertType

Der Typ des Schlüsselspeichers, der das TLS/SSL-Clientzertifikat enthält.

Mögliche Werte

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

Datentyp

string

Standardwert

USER

Hinweise

Diese Eigenschaft kann einen der folgenden Werte annehmen:

Eigenschaft Beschreibung
USER - default Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist.
MACHINE Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist.
PFXFILE Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält.
PFXBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt.
JKSFILE Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist.
JKSBLOB Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen Zertifikatsspeicher im JKS-Format darstellt. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist.
PEMKEY_FILE Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PEMKEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält.
PUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
PUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält.
SSHPUBLIC_KEY_FILE Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält.
SSHPUBLIC_KEY_BLOB Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält.
P7BFILE Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält.
PPKFILE Der Zertifikatsspeicher ist der Name einer Datei, die einen privaten PuTTY-Schlüssel (PPK) enthält.
XMLFILE Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält.
XMLBLOB Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält.

SSLClientCertPassword

Das Passwort für das TLS/SSL-Client-Zertifikat.

Datentyp

string

Standardwert

""

Hinweise

Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort zum Öffnen des Zertifikatspeichers anzugeben.

SSLClientCertSubject

Der Betreff des TLS/SSL-Client-Zertifikats.

Datentyp

string

Standardwert

*

Hinweise

Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.

Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten. Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.

Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.

Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Beispiel: „CN=www.server.com, OU=test, C=US, E=support@company.com“. Die allgemeinen Felder und ihre Bedeutungen werden unten angezeigt.

Feld Bedeutung
CN Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com.
O Organisation
OU Organisationseinheit
L Ort
S Staat
C Land
E Email Adresse

Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.

SSLServerCert

Das vom Server zu akzeptierende Zertifikat bei einer Verbindung über TLS/SSL.

Datentyp

string

Standardwert

""

Hinweise

Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.

Diese Eigenschaft kann folgende Formen annehmen:

Beschreibung Beispiel
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält C:\\cert.cer
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
Der MD5-Fingerabdruck (Hexadezimalwerte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) ecadbdda5a1529c58a1e9e09828d70e4
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.

Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).

Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.

Schema

Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.

Standort

Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.

Datentyp

string

Standardwert

%APPDATA%\Paylocity Data Provider\Schema

Hinweise

Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location Die Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.

Wenn nichts angegeben wird, ist der Standardspeicherort "%APPDATA%\ Paylocity Data Provider\Schema" mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Mac ~/Bibliothek/Anwendungsunterstützung
Linux ~/.config

DurchsuchbareSchemas

Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Schemata aus Datenbanken kann aufwändig sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.

Tabellen

Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Ansichten

Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Verschiedenes

Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

MaxRows

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Datentyp

int

Standardwert

-1

Hinweise

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Andere

Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.

Datentyp

string

Standardwert

""

Hinweise

Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.

Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.

Integration und Formatierung
Eigenschaft Beschreibung
DefaultColumnSize Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000.
ConvertDateTimeToGMT Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen.
RecordToFile=filename Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei.

Pseudospalten

Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.

Datentyp

string

Standardwert

""

Hinweise

Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.

Zeitüberschreitung

Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.

Datentyp

int

Standardwert

60

Hinweise

Wenn Timeout = 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.

Wenn Timeout abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.

BenutzerdefinierteAnsichten

Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Datentyp

string

Standardwert

""

Hinweise

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

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

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

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

Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.