Zum Inhalt springen

QuickBooks Time-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.9039 des Connectors.

Erste Schritte

TSheets-Versionsunterstützung

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

Herstellen einer Verbindung

Mit TSheets verbinden

TSheets unterstützt den OAuth-Standard zur Benutzerauthentifizierung. Um diese Authentifizierung von allen OAuth-Flows aus zu aktivieren, müssen Sie eine benutzerdefinierte OAuth-Anwendung erstellen und festlegen AuthScheme Zu OAuth.

Die folgenden Unterabschnitte beschreiben, wie Sie sich über drei gängige Authentifizierungsabläufe bei TSheets authentifizieren:

  • Desktop: eine Verbindung zu einem Server auf dem lokalen Rechner des Benutzers, die häufig zum Testen und Prototyping verwendet wird.
  • Web: Zugriff auf Daten über eine gemeinsam genutzte Website.
  • Headless Server: ein dedizierter Computer, der anderen Computern und ihren Benutzern Dienste zur Verfügung stellt und so konfiguriert ist, dass er ohne Monitor und Tastatur funktioniert.

Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung.

Eine vollständige Liste der in TSheets 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 TSheets 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 TSheets 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:

So lässt der Connector das OAuth-Zugriffstoken automatisch aktualisieren:

  1. Legen Sie vor der ersten Verbindung mit Daten diese 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 diese 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.

Erstellen einer benutzerdefinierten OAuth-Anwendung

Erstellen einer benutzerdefinierten OAuth-Anwendung

Durch das Erstellen einer benutzerdefinierten OAuth-Anwendung können Sie OAuth-Anmeldeinformationen generieren, die während der Benutzerauthentifizierung übergeben werden.

Verfahren
  1. Melden Sie sich bei Ihrem TSheets-Konto an.

  2. Wählen Sie im linken Navigationsbereich Feature Add-ons > Manage Add-ons.

  3. Wählen Sie API Add-On.

  4. Klicken Sie auf Install.

  5. Wählen Sie Add a new application unten links. Wenn kein Folgefenster angezeigt wird, kehren Sie zum linken

    Navigationsbereich zurück Feature Add-onsBereich und AuswahlAPI.

  6. Geben Sie einen Kurznamen und eine aussagekräftige Beschreibung für die neue Anwendung ein.

  7. Setzen Sie die Weiterleitungs URL auf http://localhost:33333 (Standardeinstellung des Anschlusses) ODER legen Sie einen anderen Port Ihrer Wahl fest.
    Notieren Sie diesen Wert. Sie geben ihn als an CallbackURL.

  8. Klicken Sie auf Save. Das Admin-Tool generiert die OAuth-Client-ID und das Client-Geheimnis.
    Notieren Sie diese Werte für die zukünftige Verwendung.

  9. (Optional:) Wenn Sie jetzt Ihr Zugriffstoken generieren und sich mit verbinden möchten InitiateOAuth gesetzt auf OFF, klick Add Token im unteren linken Teil des Displays. Dadurch wird ein Token zur sofortigen Verwendung generiert.

Sie können auf die benutzerdefinierte OAuth-Anwendung (API Add-On genannt) über den linken Navigationsbereich zugreifen Feature Add-ons Abschnitt.

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 TSheets-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 TSheets und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Jitterbit Connector für TSheets 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 Timesheets WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die 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.

Datenmodell

Überblick

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

Hauptmerkmale

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

Ansichten

Ansichten beschreibt die verfügbaren Ansichten. Ansichten werden statisch definiert, um Arbeitszeitnachweise, Benutzer, Dateien und mehr zu modellieren.

Tabellen

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

Jitterbit-Connector für TSheets-Tabellen

Name Beschreibung
CustomFieldItemFilters Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Feldelementfilter in TSheets.
CustomFieldItems Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Feldelemente in TSheets.
CustomFields Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Felder in TSheets.
EstimateItems Erstellen, Aktualisieren und Abfragen des Kostenvoranschlagselements in TSheets.
Estimates Erstellen, Aktualisieren und Abfragen der Schätzungen in TSheets.
Files Diese Tabelle enthält eine Liste von Dateiobjekten.
GeoLocations Ruft eine Liste aller Geofence-Konfigurationen ab.
Groups Diese Tabelle enthält eine Liste aller mit Ihrem Unternehmen verknüpften Gruppen.
JobcodeAssignments Gibt eine Liste aller Jobcode-Zuweisungen zurück, die den Benutzern zugeordnet sind.
JobCodes Diese Tabelle enthält eine Liste der mit Ihrem Unternehmen verknüpften Jobcodes
Locations Ruft eine Liste aller mit Ihrem Unternehmen verknüpften Standorte ab.
Notifications Ruft eine Liste der mit Ihrem Unternehmen verknüpften Benachrichtigungen ab.
ProjectActivityReplies Erstellen, Aktualisieren und Abfragen der Projektaktivitätsantworten in TSheets.
ProjectNotes Erstellen, Aktualisieren und Abfragen der Projektnotizen in TSheets.
Projects Erstellen, Aktualisieren und Abfragen der Projekte in TSheets.
Reminders Ruft eine Liste mit Erinnerungen ab, die Ihren Mitarbeitern oder Ihrem Unternehmen zugeordnet sind.
ScheduleEvents Ruft eine Liste der mit Ihren Mitarbeitern oder Ihrem Unternehmen verknüpften Terminplanungsereignisse ab.
TimeOffRequestEntries Erstellen, Aktualisieren und Abfragen der Urlaubsanträge in TSheets.
TimeOffRequests Urlaubsanträge in TSheets erstellen, aktualisieren und abfragen.
Timesheets Diese Tabelle enthält eine Liste von Dateiobjekten.
Users Ruft eine Liste aller mit Ihrem Unternehmen verbundenen Benutzer ab.

BenutzerdefinierteFeldelementfilter

Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Feldelementfilter in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle CustomFieldItemFilters. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • Active unterstützt das '='
  • JobCodeId unterstützt das '='
  • UserId unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • GroupId unterstützt das '='
  • IncludeUserGroup unterstützt das '='
  • IncludeJobCodeFilters unterstützt das '='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFieldItemFilters
SELECT * FROM CustomFieldItemFilters WHERE ID = 11531340
Einfügen

Das Einfügen kann durch Angabe der Spalten CustomFieldId, CustomFieldItemId, Active, AppliesTo und AppliesToId ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO CustomFieldItemFilters (CustomFieldId, Name, ShortCode) VALUES (1140610, 15027812, true, 'jobcodes', 73209298)
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE CustomFieldItemFilters SET Active = true WHERE ID = '15011650'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des CustomField-Elementfilters.
CustomFieldId Integer True ID des benutzerdefinierten Felds, zu dem dieser Filter gehört.
CustomFieldItemId Integer True ID des CustomField-Elements, zu dem dieser Filter gehört.
Active Boolean Falsch Boolescher Wert. Wenn wahr, ist der benutzerdefinierte Feldelementfilter aktiv, und wenn falsch, ist der benutzerdefinierte Feldelementfilter archiviert.
AppliesTo String Falsch Entitätstyp, auf den sich dieser Filter bezieht. Bestimmt zusammen mit „applies_to_id“, worauf sich dieses gefilterte Element bezieht. Die möglichen Werte sind: „Jobcodes“, „Benutzer“ oder „Gruppen“. Beispiel: Wenn dieser Wert „Jobcodes“ wäre, würde der Wert „applies_to_id“ angeben, auf welchen Jobcode sich dieser Filter bezieht. Auf Anfrage enthalten die Zusatzdaten auch diesen Jobcode.
AppliesToId Integer Falsch Der Jobcode, Benutzer oder die Gruppe, auf die sich dieser Filter bezieht. Bestimmt zusammen mit „applies_to“, worauf sich dieses gefilterte Element bezieht. Beispiel: Wenn der Wert des Felds „applies_to“ „Jobcodes“ wäre, würde dieser Wert angeben, auf welchen Jobcode sich dieser Filter bezieht. Auf Anfrage enthalten die Zusatzdaten auch diesen Jobcode.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelementfilters.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
JobCodeId Integer Beschränkt die zurückgegebenen Filter auf diejenigen für die angegebene Jobcode-ID.
UserId Integer Beschränkt die zurückgegebenen Filter auf diejenigen für die angegebene Benutzer-ID. Sie können auch automatisch Elemente für die Gruppe dieses Benutzers einschließen, wenn Sie den Parameter „include_user_group“ einschließen.
GroupId Integer Beschränkt die zurückgegebenen Filter auf diejenigen für die angegebene Gruppen-ID.
IncludeUserGroup Boolean Wenn eine Benutzer-ID angegeben wird, werden auch Filter für die Gruppe dieses Benutzers zurückgegeben.
IncludeJobCodeFilters Boolean Wenn eine Benutzer-ID angegeben wird, werden zusätzlich Jobcode-Filter zurückgegeben.
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

BenutzerdefinierteFeldelemente

Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Feldelemente in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle CustomFieldItems. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • CustomFieldId unterstützt '=,IN'
  • Name unterstützt '=,IN'
  • Active unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFieldItems WHERE CustomFieldId=1140610
SELECT * FROM CustomFieldItems WHERE CustomFieldId=1140610 AND ID = 11531340
Einfügen

Das Einfügen kann durch Angabe der Spalten CustomFieldId, Name und ShortCode ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO CustomFieldItems (CustomFieldId, Name, ShortCode) VALUES (1140610, 'testField', 'cf')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE CustomFieldItems SET Name = 'yogesh_customfield', ShortCode='ycf' WHERE ID = '15011650'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des benutzerdefinierten Feldelements.
CustomFieldId Integer True ID des benutzerdefinierten Felds, zu dem das Element gehört.
Name String Falsch Name des benutzerdefinierten Felds.
Active Boolean True Boolescher Wert. Wenn True, ist das benutzerdefinierte Feldelement aktiv, und wenn False, ist das benutzerdefinierte Feldelement archiviert.
ShortCode String Falsch Dies ist ein verkürzter Code oder Alias, der mit dem CustomField-Element verknüpft ist. Er darf nur aus Buchstaben und Zahlen bestehen.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelements.
RequiredCustomFields String True IDs von benutzerdefinierten Feldern, die angezeigt werden sollen, wenn dieses benutzerdefinierte Feldelement auf einer Zeitkarte ausgewählt wird.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Benutzerdefinierte Felder

Erstellen, Aktualisieren und Abfragen der benutzerdefinierten Felder in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der CustomFields-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • Active unterstützt das '='
  • AppliesTo unterstützt das '='
  • Type unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFields
SELECT * FROM CustomFields WHERE ID = 24145
Einfügen

Das Einfügen kann durch Angabe der Spalten Name, Erforderlich, Aktiv, Gilt für, Typ, Für alle anzeigen und ShortCode ausgeführt werden. Die Spalten, die nicht erforderlich sind, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO CustomFields (Name, Required, Active, AppliesTo, Type, ShowToAll, ShortCode) VALUES ('Test', true, true, 'timesheet', 'managed-list', true, 'cstm')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE CustomFields SET Name = 'Updated name' WHERE ID = '1140410'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des benutzerdefinierten Felds.
Name String Falsch Name des benutzerdefinierten Felds.
Active Boolean Falsch Boolescher Wert. Wenn wahr, ist das benutzerdefinierte Feld aktiv, und wenn falsch, ist das benutzerdefinierte Feld ein Archiv.
Required Boolean Falsch Gibt an, ob in einem Arbeitszeitnachweis ein Wert für das benutzerdefinierte Feld erforderlich ist.
AppliesTo String Falsch Gibt an, auf welchen Objekttyp sich dieses benutzerdefinierte Feldobjekt bezieht. Werte sind „Zeiterfassung“, „Benutzer“ oder „Jobode“.
Type String Falsch „verwaltete Liste“ oder „Freiform“. Wenn „Freiform“, sollte es in einer Benutzeroberfläche als Textfeld angezeigt werden, in das Benutzer Werte für dieses benutzerdefinierte Feld eingeben können. Diese werden automatisch zum benutzerdefinierten Feld hinzugefügt, wenn sie noch nicht vorhanden sind. Wenn „verwaltete Liste“, sollte es als Auswahlfeld angezeigt werden und Benutzer können nur einen vorhandenen Wert auswählen.
ShortCode String Falsch Dies ist ein verkürzter Code oder Alias, der mit dem benutzerdefinierten Feld verknüpft ist. Er darf nur aus Buchstaben und Zahlen bestehen.
RegexFilter String True Regulärer Ausdruck, der auf alle neuen Elemente angewendet wird, wenn sie dem benutzerdefinierten Feld hinzugefügt werden. Wenn sie nicht mit dem Regex-Filter übereinstimmen, werden sie möglicherweise nicht hinzugefügt.
Created Datetime True Datum/Uhrzeit, wann dieses benutzerdefinierte Feld erstellt wurde.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Felds.
UIPreference String True „drop_down“ oder „text_box_with_suggest“. Gibt die vorgeschlagene Benutzeroberfläche abhängig vom angegebenen Typ an.
ShowToAll Boolean Falsch Gibt an, ob dieses benutzerdefinierte Feld auf Arbeitszeitnachweisen angezeigt werden soll, unabhängig vom gewählten Jobcode. Wenn es falsch ist, wird es nur angezeigt, wenn der gewählte Jobcode für einen Arbeitszeitnachweis mit diesem Feld verknüpft wurde. Dieses Feld kann nur auf falsch gesetzt werden, wenn das benutzerdefinierte Feld vom Typ „Arbeitszeitnachweis“ ist.
RequiredCustomFields String True IDs von benutzerdefinierten Feldern, die angezeigt werden sollen, wenn dieses benutzerdefinierte Feld auf einer Zeitkarte sichtbar ist.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Artikel schätzen

Erstellen, Aktualisieren und Abfragen des Kostenvoranschlagselements in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der EstimateItems-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • EstimateId unterstützt '=,IN'
  • Active unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM EstimateItems
SELECT * FROM EstimateItems WHERE ID = '11531340'
Einfügen

Das Einfügen kann durch Angabe der Spalten EstimateId, Type und TypeId ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO EstimateItems (EstimateId, Type, TypeId) VALUES (47482, 'tag_clouds', 15011650)
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE EstimateItems SET EstimatedSeconds = 2 WHERE ID = '11531340'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des geschätzten Artikels.
EstimateId Integer Falsch Der Kostenvoranschlag, zu dem dieser Kostenvoranschlagsposten gehört.
EstimatedSeconds Integer Falsch Die geschätzte Anzahl von Sekunden.
Active Boolean Falsch Boolescher Wert. Wenn falsch, wird diese Schätzung als gelöscht betrachtet.
Created Datetime True Datum/Uhrzeit der Erstellung dieser Schätzung.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieser Schätzung.
Type String Falsch Der geschätzte Artikeltyp. Entweder „keine“ oder „Tag_Clouds“. HINWEIS: Der Typ „Tag_Clouds“ sollte stattdessen „Customfields“ sein. Dies wird bald korrigiert.
TypeId Integer Falsch Die benutzerdefinierte Element-ID, wenn der Typ „tag_clouds“ ist.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Schätzungen

Erstellen, Aktualisieren und Abfragen der Schätzungen in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Estimations“. Der Connector verwendet die TSheets API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • Active unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Estimates
SELECT * FROM Estimates WHERE ID = '11531340'
Einfügen

Das Einfügen kann durch Angabe der Spalten ProjectId und EstimatedBy ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Estimates (ProjectId, EstimatedBy) VALUES (2064876, 'none')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Estimates SET Active = true WHERE ID = '11531340'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID der Schätzung.
ProjectId Integer True ID des zugehörigen Projekts.
EstimatedBy String Falsch Der Schätztyp. Mögliche Werte sind „keine“ oder „benutzerdefinierte Felder“.
EstimateById Integer True Die Customfield-ID, wenn der estimate_by-Wert „customfields“ ist.
Active Boolean Falsch Boolescher Wert. Wenn falsch, wird diese Schätzung als gelöscht betrachtet.
Created Datetime True Datum/Uhrzeit der Erstellung dieser Schätzung.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieser Schätzung.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Dateien

Diese Tabelle enthält eine Liste von Dateiobjekten.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Dateien“. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und NameFelder unterstützen die Operatoren '=' und IN.
  • ActiveStatus unterstützt die = Betreiber.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Files WHERE Name IN ('IMG_20181004_214839.png', 'healthy.jpg')

SELECT * FROM Files WHERE LastModified = '2019-01-01 15:30' AND ActiveStatus = 'both'
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Files SET FileDescription = 'test' WHERE ID = '3688644'
Löschen

Das Löschen kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Beispiel:

Delete FROM Files WHERE ID = '3688644'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True ID dieser Datei.
Name String Falsch Name dieser Datei.
UploadByUserId Int True ID des Benutzers, der diese Datei hochgeladen hat.
Active Boolean True Wenn False, wird diese Datei als gelöscht betrachtet.
Size Int True Größe der Datei in Bytes.
Created Datetime True Datum/Uhrzeit, als dieses benutzerdefinierte Feld erstellt wurde
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Felds.
FileDescription String Falsch Beschreibung dieser Datei.
ImageRotation Int Falsch Ursprüngliche Bildausrichtung in Grad. Akzeptierte Werte sind: 0 (oben), 90 (rechts), 180 (unten), 270 (links).
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

GeoStandorte

Ruft eine Liste aller Geofence-Konfigurationen ab.

Tabellenspezifische Informationen
Wählen

Abfrage der GeoLocations-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id, UserId Und GroupIdFelder unterstützen die Operatoren '=' und IN.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM GeoLocations WHERE GroupId IN ('29474', '29474') AND LastModified <= '2020-01-01 00:00'
Einfügen

Das Einfügen kann durch Angabe der Spalten „Erstellt“, „Benutzer-ID“, „Genauigkeit“, „Höhe“, „Breitengrad“ und „Längengrad“ ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle.

INSERT INTO Geolocations (Created, UserId, Accuracy, Altitude, Latitude, Longitude) VALUES ('2018-08-19T11:30:09-06:00', '1242515', '20.375', '0', '43.68662580', '-116.35166460')
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Int Wahr ID der Geolokalisierung.
UserId Int Falsch Benutzer-ID für den Benutzer, dem diese Geolokalisierung gehört.
Accuracy Double Falsch Gibt den Genauigkeitsradius um die Geolokalisierung in Metern an.
Altitude Double Falsch Gibt die Höhe des Geostandorts in Metern an.
Latitude Double Falsch Gibt den Breitengrad der Geolokalisierung in Grad an.
Longitude Double Falsch Gibt den Längengrad der Geolokalisierung in Grad an.
Speed Double Falsch Gibt die Reisegeschwindigkeit (Meter pro Sekunde) an, als die Geolokalisierung aufgezeichnet wurde.
Source String Falsch Gibt an, wie der GPS-Punkt ermittelt wurde. Eines der folgenden: „GPS“, „WLAN“ oder „Zelle“.
DeviceIdentifier String Falsch Eindeutige Kennung (für den angegebenen Client) für das mit dieser Geolokalisierung verknüpfte Gerät.
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieser Geolokalisierung
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieser Geofence-Konfiguration.
GroupId String Eine durch Kommas getrennte Liste von Gruppen-IDs. Es werden nur Geostandorte zurückgegeben, die mit Benutzern aus diesen Gruppen verknüpft sind.

Gruppen

Diese Tabelle enthält eine Liste aller mit Ihrem Unternehmen verbundenen Gruppen.

Tabellenspezifische Informationen
Wählen

Abfrage der Gruppentabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und NameFelder unterstützen die Operatoren '=' und IN.
  • ActiveStatus unterstützt die = Betreiber.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Groups WHERE Name IN ('Group 1', 'Group 2') AND LastModified > '2019-01-01 15:30'

SELECT * FROM Groups WHERE ActiveStatus = 'both'
Einfügen

Das Einfügen kann durch Angabe der Spalte „Name“ ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Groups (Name) VALUES ('Group 1')
INSERT INTO Groups (Name, ManagerIds) VALUES ('Group 1', '300, 316')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Groups SET Name = 'Group 1a', Active = 'false'  WHERE ID = '10055'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr ID dieser Gruppe.
Active Boolean Falsch Wenn falsch, wird diese Gruppe als archiviert betrachtet.
Name String Falsch Mit dieser Gruppe verknüpfter Name
LastModified Datetime Wahr Datum/Uhrzeit der letzten Änderung dieser Gruppe
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieser Gruppe
ManagerIds String True Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

JobcodeAufgaben

Gibt eine Liste aller Jobcode-Zuweisungen zurück, die Benutzern zugeordnet sind.

Tabellenspezifische Informationen
Wählen

Abfrage der JobcodeAssignments-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und UserId-Felder unterstützen die Operatoren '=' und IN.
  • JobcodeId, JobCodeType, JobCodeParentId Felder und ActiveStatus Alle Filter unterstützen den '='-Operator.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM JobcodeAssignments WHERE UserId IN (1242515, 1242515)

SELECT * FROM JobcodeAssignments WHERE JobCodeParentId = 17285791
Einfügen

Das Einfügen kann durch Angabe der Spalten UserId und JobcodeId ausgeführt werden. Die nicht benötigten Spalten können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO JobcodeAssignments (UserId, JobcodeId) VALUES ('1234', '39')
Löschen

Das Löschen kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Beispiel:

DELETE FROM JobcodeAssignments WHERE Id = '41321421'

DELETE FROM JobcodeAssignments WHERE ID IN ('41321421', '41321435')
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Int True ID der Jobcode-Zuweisung.
UserId Int Falsch ID des Benutzers, auf den sich diese Zuweisung bezieht.
JobcodeId Int Falsch ID des Jobcodes, auf den sich diese Zuweisung bezieht.
Active Boolean True Gibt an, ob diese Zuweisung „aktiv“ ist oder nicht. Wenn „false“, wurde die Zuweisung gelöscht. „true“ bedeutet, dass sie in Kraft ist.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieser Jobcode-Zuweisung.
Created Datetime True Datum/Uhrzeit der Erstellung dieser Jobcode-Zuweisung
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
JobCodeType String Bezieht sich auf den Jobcodetyp - „regulär“, „pto“, „unbezahlte Pause“, „bezahlte Pause“ oder „alle“. Der Standardwert ist „regulär“.
JobCodeParentId Integer Wenn es weggelassen wird, werden alle Jobcode-Zuweisungen unabhängig vom übergeordneten Jobcode zurückgegeben. Wenn angegeben, werden nur Zuweisungen für Jobcodes mit der angegebenen Jobcode-Übergeordneten-ID zurückgegeben. Um eine Liste nur der Jobcode-Zuweisungen der obersten Ebene zu erhalten, geben Sie eine Jobcode-Übergeordneten-ID von 0 ein.
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

JobCodes

Diese Tabelle enthält eine Liste der mit Ihrem Unternehmen verknüpften Jobcodes

Tabellenspezifische Informationen
Wählen

Abfrage der Jobcodes-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und NameFelder unterstützen die Operatoren '=' und IN.
  • Type Feld und ActiveStatus Filter unterstützen den '='-Operator.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Jobcodes WHERE Id IN (1242515, 1242515)

SELECT * FROM Jobcodes WHERE Type = 'unpaid_break'
Einfügen

Das Einfügen kann durch Angabe der Spalten Name und Typ ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Jobcodes (Name, Type) VALUES ('Group 1', 'pto')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Jobcodes SET Name = 'Group 2', Type = 'pto'  WHERE ID = '10055'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Int True ID des Jobcodes.
ParentId Int Falsch ID des übergeordneten Elements dieses Jobcodes. 0, wenn es sich um die oberste Ebene handelt.
Name String Falsch ID des übergeordneten Elements dieses Jobcodes. 0, wenn es sich um die oberste Ebene handelt.
ShortCode String Falsch Dies ist ein verkürzter Code oder Alias, der mit dem Jobcode verknüpft ist. Er darf nur aus Buchstaben und Zahlen bestehen. Muss für alle Jobcodes mit derselben übergeordneten ID eindeutig sein.
Type String Falsch Gibt den Jobcode-Typ an. Eines von „regulär“, „pto“, „bezahlte Pause“ oder „unbezahlte Pause“
Billable Boolean Falsch Gibt an, ob dieser Jobcode abrechenbar ist oder nicht.
BillableRate Double Falsch Dollarbetrag, der diesem Jobcode für Abrechnungszwecke zugeordnet ist. Nur wirksam, wenn „bilable“ wahr ist.
HasChildren Boolean Wahr Wenn wahr, gibt es Jobcodes, die unterhalb dieses Codes existieren. Daher sollte dieser Jobcode als Container oder Ordner mit darunter liegenden untergeordneten Jobcodes behandelt werden.
AssignedToAll Boolean False Gibt an, ob dieser Jobcode allen Mitarbeitern zugewiesen ist oder nicht.
RequiredCustomFields String True IDs von benutzerdefinierten Feldern, die angezeigt werden sollen, wenn dieser Jobcode auf einer Zeitkarte ausgewählt wird.
Active Boolean True Wenn True, ist dieser Jobcode aktiv. Wenn False, wird dieser Jobcode archiviert. Um einen Jobcode zu archivieren, setzen Sie dieses Feld auf False. Wenn ein Jobcode archiviert wird, werden auch alle untergeordneten Elemente unter dem Jobcode archiviert. Beachten Sie, dass beim Archivieren eines Jobcodes alle Jobcodezuweisungen oder benutzerdefinierten Feldabhängigkeiten entfernt werden. Um einen Jobcode wiederherzustellen, setzen Sie dieses Feld auf True. Wenn ein Jobcode wiederhergestellt wird, werden auch alle übergeordneten Elemente dieses Jobcodes wiederhergestellt.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Jobcodes.
Created Datetime True Datum/Uhrzeit der Erstellung dieses Jobcodes
FilteredCustomFiledsItems String True Zeigt an, welche benutzerdefinierten Feldelemente angezeigt werden sollen, wenn dieser Jobcode für eine Arbeitszeittabelle ausgewählt wird. Jede Eigenschaft des Objekts ist eine benutzerdefinierte Feld-ID, deren Wert ein Array von benutzerdefinierten Feldelement-IDs ist. Wenn keine vorhanden ist, wird eine leere Zeichenfolge zurückgegeben.
ConnectWithQuickBooks String True Wenn True und die Betafunktion für die bidirektionale Synchronisierung aktiviert ist, werden am Jobcode vorgenommene Änderungen sofort mit QBO geteilt.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

Standorte

Ruft eine Liste aller Standorte ab, die mit Ihrem Unternehmen verknüpft sind.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Standorte“. Der Connector verwendet die TSheets API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und GeoCodingStatus-Felder unterstützen die Operatoren '=' und IN.
  • ActiveStatus unterstützt die = Betreiber.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Locations WHERE GeoCodingStatus IN ('in_progress', 'retry')

SELECT * FROM Locations WHERE ByJobcodeAssignment = true
Einfügen

Das Einfügen kann durch Angabe beliebiger Spalten ausgeführt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Locations (Address1, City, State, Country) VALUES (' office', 'Bangalore', 'KA', 'IN')

INSERT INTO Locations (Address1, City, State, Country, Zip) VALUES (' office', 'Bangalore', 'KA', 'IN', '560100')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Locations SET Address1 = 'Microsoft' WHERE ID = '10055'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True ID des Standorts.
Address1 String Falsch Die erste Zeile der Standortadresse.
Address2 String Falsch Die zweite Zeile der Standortadresse.
City String Falsch Die Stadt der Standortadresse.
State String Falsch Der Status der Standortadresse.
Zip String Falsch Die Postleitzahl der Standortadresse.
Country String Falsch Das Land der Standortadresse.
FormattedAddress String True Formatierte Adresse, die aus den Objekten addr1, addr2, Stadt, Bundesland und Postleitzahl erstellt wird. Wenn der Standort die Eigenschaften addr1, addr2 oder Stadt nicht enthält, wird standardmäßig der Wert verwendet, der in der Label-Eigenschaft festgelegt ist.
Active Boolean Falsch Ob dieser Standort aktiv ist. Wenn falsch, wird dieser Standort archiviert.
Latitude Double Falsch Der Breitengrad des Standorts (im vorzeichenbehafteten Gradformat).
Longitude Double Falsch Der Längengrad des Standorts (im vorzeichenbehafteten Gradformat).
PlaceIdHash String Falsch Der MD5-Hash der eindeutigen ID für den Standort, der vom Geokodierungsdienst zurückgegeben wurde.
Label String True Der formatierte Name für den Standort. Wenn der Standort mithilfe des Geokodierungsdiensts gefunden wurde, wird die formatierte Adresse in diesem Feld gespeichert, andernfalls wird die vom Benutzer angegebene Adresse verwendet.
Notes String Falsch Hinweise zum Standort.
GeoCodingStatus String Falsch Der Geokodierungsstatus dieser Adresse. Kann einer der folgenden Werte sein: „Keine“, „In Bearbeitung“, „Wiederholen“, „Fehler“ oder „Abgeschlossen“.
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieses Standorts
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Felds.
LinkedObjects String Falsch Eine Schlüssel-/Wertzuordnung aller mit diesem Standort verknüpften Objekte und der entsprechenden Objekt-IDs.
GeofenceConfigId Int True ID der mit diesem Standort verknüpften Geofence_config.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ByJobcodeAssignment Boolean Wenn angegeben, werden nur Standorte zurückgegeben, die einem Jobcode zugeordnet sind, dem der Benutzer zugewiesen ist.
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

Benachrichtigungen

Ruft eine Liste der mit Ihrem Unternehmen verknüpften Benachrichtigungen ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Benachrichtigungstabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Feld unterstützt die Operatoren '=' und IN.
  • MessageTrackingId Und UserIdFelder unterstützen den Operator '='.
  • DeliveryTime-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Notifications WHERE Id IN (94140223, 94140225) AND UserId = 37

SELECT * FROM Notifications WHERE MessageTrackingId = 'baabeb0ab03d62ce'

SELECT * FROM Notifications WHERE DeliveryTime = '2019-12-25 19:00'
Einfügen

Das Einfügen kann durch Angabe der Nachrichtenspalte ausgeführt werden. Die nicht benötigten Spalten können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Notifications (Message) VALUES ('Please clock Out!')

INSERT INTO Notifications (Message, UserId) VALUES ('Please clock Out!', '56329')
Löschen

Das Löschen kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Beispiel:

DELETE FROM Notifications WHERE Id = '41321421'

DELETE FROM Notifications WHERE ID IN ('41321421', '4132567')
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID der Benachrichtigung.
UserId Integer True Benutzer-ID für den Benutzer, an den diese Benachrichtigung gesendet wird.
MessageTrackingId String True Eine GUID-Zeichenfolge, die zur zusätzlichen Nachverfolgung verwendet wird.
Message String False Der Nachrichtentext der Benachrichtigung. Die maximale Nachrichtenlänge beträgt 2000 Zeichen.
Method String Falsch Die Transportmethode der Benachrichtigung. Wir unterstützen „Push“, „Email“ und „Dashboard“.
Precheck String Falsch Der Name des Vorabprüfungsmakros. Unterstützte Makros sind „on_the_clock“, „off_the_clock“ und „none“.
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieser Benachrichtigung
DeliveryTime Datetime Falsch Datum/Uhrzeit, wann diese Benachrichtigung zugestellt wird.

ProjektAktivitätAntworten

Erstellen, Aktualisieren und Abfragen der Projektaktivitätsantworten in TSheets.

Tabellenspezifische Informationen
Wählen

Fragen Sie die Tabelle ProjectActivityReplies ab. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • UserId unterstützt '=,IN'
  • ProjectActivityId unterstützt das '='
  • Active unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectActivityReplies WHERE ProjectActivityId = 8348378
SELECT * FROM ProjectActivityReplies WHERE ProjectActivityId = 8348378 AND ID = 2062894
Einfügen

Das Einfügen kann durch Angabe der ProjectActivityId und der Notizspalte ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO ProjectActivityReplies (ProjectActivityId, Note) VALUES (8348382, 'Test')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE ProjectActivityReplies SET Note = 'updated' WHERE ID = '2062894'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID der Projektaktivitätsantworten.
ProjectActivityId Integer Falsch ID der zugehörigen Projektaktivität.
UserId Integer True ID des zugehörigen Benutzers.
Note String Falsch Inhalt der Notiz.
Active Boolean Falsch Boolescher Wert. Wenn falsch, wird diese Antwort zur Projektaktivität als Archiv betrachtet.
Created Datetime True Datum/Uhrzeit, wann diese Projektnotiz erstellt wurde.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieser Projektnotiz.
Mentions String Stimmt Erwähnungen.
LinkedObjects String True Eine Schlüssel-Wert-Zuordnung aller mit diesem Projekt verknüpften Objekte und der entsprechenden Objekt-IDs.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Projektnotizen

Erstellen, Aktualisieren und Abfragen der Projektnotizen in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der ProjectNotes-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • UserId unterstützt '=,IN'
  • ProjectId unterstützt das '='
  • Active unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectNotes
SELECT * FROM ProjectNotes WHERE ProjectId = 203282
Einfügen

Das Einfügen kann durch Angabe der Projekt-ID und der Notizspalte ausgeführt werden. Die nicht benötigten Spalten können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO ProjectNotes (ProjectId, Note) VALUES (203282, 'Test note'))
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE ProjectNotes SET Note = 'Updated value' WHERE ID = '1675236'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID der Projektnotiz.
ProjectId Integer True ID des zugehörigen Projekts.
UserId Integer True ID des zugehörigen Benutzers.
Note String Falsch Inhalt der Notiz.
Active Boolean True Boolescher Wert. Wenn falsch, wird diese Projektnotiz als Archiv betrachtet.
Created Datetime True Datum/Uhrzeit, wann diese Projektnotiz erstellt wurde.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieser Projektnotiz.
Mentions String Falsch Erwähnungen.
Files String True Liste der IDs für die an diese Notiz angehängte Datei.
LinkedObjects String True Eine Schlüssel-Wert-Zuordnung aller mit diesem Projekt verknüpften Objekte und der entsprechenden Objekt-IDs.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Projekte

Erstellen, Aktualisieren und Abfragen der Projekte in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Projekte“. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • JobCodeId unterstützt '=,IN'
  • ParentJobCodeId unterstützt das '='
  • Name unterstützt das '='
  • Active unterstützt das '='
  • ByJobCodeAssignment unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Projects
SELECT * FROM Projects WHERE ID = 2056676
Einfügen

Das Einfügen kann durch Angabe der Spalte „Name“ ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Projects (Name, Description) VALUES ('ProjectTest', 'This is a test project')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Projects SET Status = 'complete' WHERE ID = '2062894'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID dieses Projekts.
JobCodeId Integer Falsch Der Jobcode, der das Projekt für die Zeiterfassung darstellt.
ParentJobCodeId Integer Falsch ID des übergeordneten Projektjobcodes. 0, wenn es sich um die oberste Ebene handelt.
Name String Falsch Name des Projekts. Auf 64 Zeichen begrenzt.
Description String Falsch Mit dem Projekt verknüpfter Beschreibungstext. Auf 300 Zeichen begrenzt.
Status String Falsch Status des Projekts. Die zulässigen Werte sind nicht_gestartet, in_Bearbeitung, abgeschlossen.
StartDate Datetime Falsch Datumszeichenfolge im Format JJJJ-MM-TT. Muss vor dem Fälligkeitsdatum liegen, falls eines definiert ist.
DueDate Datetime Falsch Datumszeichenfolge im Format JJJJ-MM-TT. Muss nach dem Startdatum liegen, falls eines definiert ist.
CompletedDate Datetime Falsch Datumszeichenfolge im Format JJJJ-MM-TT. Muss nach dem Startdatum liegen, falls eines definiert ist.
Active Boolean Wahr Wahr oder falsch. Wenn „false“, wird das Projekt als gelöscht betrachtet.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Projekts im ISO 8601-Format.
Created Datetime True Datum/Uhrzeit der Erstellung dieses Projekts im ISO 8601-Format.
LinkedObjects String True Eine Schlüssel-Wert-Zuordnung aller mit diesem Projekt verknüpften Objekte und der entsprechenden Objekt-IDs.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ByJobCodeAssignment Boolean Wenn angegeben, werden nur Projekte mit einer Jobcode-ID zurückgegeben, der der Benutzer zugewiesen ist.

Erinnerung

Ruft eine Liste mit Erinnerungen ab, die mit Ihren Mitarbeitern oder Ihrem Unternehmen verknüpft sind.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Erinnerungen“. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und UserId-Felder unterstützen die Operatoren '=' und IN.
  • ReminderType Feld und ActiveStatus Filter unterstützen den '='-Operator.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Reminders WHERE Id IN (72595, 72599) AND UserId = 37

SELECT * FROM Reminders WHERE ReminderType = 'clock-in'
Einfügen

Das Einfügen kann durch Angabe der Spalten UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active und Enabled ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Reminders (UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active, Enabled) VALUES ('37', 'clock-in', '08:10:00', 'Mon, Tue, Sat', 'Push', 'true', 'true')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Reminders SET DueTime = '08:10:00', DistributionMethods = 'Email'  WHERE ID = '10055'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID der Erinnerung.
UserId Integer True Benutzer-ID des Benutzers, auf den sich diese Erinnerung bezieht. 0 gibt an, dass dies eine unternehmensweite Erinnerung ist.
ReminderType String True Der Typ dieses Erinnerungsobjekts. Unterstützte Erinnerungstypen sind „Einstempeln“ und „Ausstempeln“.
DueTime String Falsch Die 24-Stunden-Zeit, zu der die Erinnerung gesendet werden soll, ausgedrückt als „hh🇲🇲ss“.
DueDaysOfWeek String Falsch Eine durch Kommas getrennte Liste der Wochentage, an denen die Erinnerung gesendet werden soll. Der Wert kann eine beliebige Kombination aus „So“, „Mo“, „Di“, „Mi“, „Do“, „Fr“ und „Sa“ sein.
DistributionMethods String False Der Nachrichtentext der Benachrichtigung. Die maximale Nachrichtenlänge beträgt 2000 Zeichen.
Active Boolean Falsch Wenn wahr, ist diese Erinnerung aktiv und wird zur Fälligkeitszeit und an den Fälligkeitstagen der Woche ausgewertet. Wenn falsch, ist diese Erinnerung inaktiv und wird nicht ausgewertet. Wenn aktiv=false für benutzerspezifische Erinnerungen, dann gilt die unternehmensweite Erinnerung desselben Erinnerungstyps.
Enabled Boolean Falsch Wenn wahr, ist die Erinnerung aktiviert und wird zur Fälligkeitszeit und an den Fälligkeitstagen der Woche gesendet. Wenn falsch, ist die Erinnerung deaktiviert und wird nicht gesendet. Ein Benutzer mit einer aktiven (aktiv = wahr), aber deaktivierten (aktiviert = falsch) Erinnerung erhält diesen Erinnerungstyp nicht, unabhängig davon, wie unternehmensweite Erinnerungen konfiguriert sind.
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieser Erinnerung
LastModified Datetime Wahr Datum/Uhrzeit der letzten Änderung dieser Erinnerung,
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

TermineVeranstaltungen

Ruft eine Liste der Termine ab, die mit Ihren Mitarbeitern oder Ihrem Unternehmen verknüpft sind.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle ScheduleEvents. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Und ScheduleCalendarId-Felder unterstützen die Operatoren '=' und IN.
  • Start unterstützt die >= Betreiber.
  • End unterstützt die <= Betreiber.
  • ActiveStatus Filter und Draft Und TeamEventsFelder unterstützen den Operator '='.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ScheduleEvents WHERE TeamEvents = 'instance'

SELECT * FROM ScheduleEvents WHERE LastModified > '2019-01-01 18:30' AND Id IN (1, 2, 3)

SELECT * FROM ScheduleEvents WHERE End <= '2019-12-31 18:00'
Einfügen

Das Einfügen kann durch Angabe der Spalten ScheduleCalendarId, Start, End und AllDay ausgeführt werden. Die nicht benötigten Spalten können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true')

INSERT INTO ScheduleEvents (ScheduleCalendarId, Start, End, AllDay, AssignedUserIds) VALUES ('37', '2018-12-05T16:00:00+00:00', '2020-12-05T16:00:00+00:00', 'true', '11, 1365, 729')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE ScheduleEvents SET Title = 'New Title'  WHERE ID = '14055'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des Zeitplankalenders.
ScheduleCalendarId Integer True ID des Kalenders, der dieses Ereignis enthält.
Start Datetime Falsch Datum/Uhrzeit, die die Startzeit dieses Zeitplanereignisses darstellen.
End Datetime Falsch Datum/Uhrzeit, die die Endzeit dieses Zeitplanereignisses darstellen.
AllDay Boolean Falsch Wenn „true“, ist die Ereignisdauer der ganze Tag an dem unter „Start“ angegebenen Tag. Wenn „false“, wird die Ereignisdauer durch das unter „Ende“ angegebene Datum/die angegebene Uhrzeit bestimmt.
AssignedUserIds String True IDs der Benutzer, die diesem Ereignis zugewiesen sind. Leeres Array, wenn das Ereignis nicht zugewiesen ist.
JobcodeId String Falsch ID des mit diesem Ereignis verknüpften Jobcodes.
Active Boolean Falsch Ob das Ereignis aktiv ist. Wenn falsch, wurde das Ereignis gelöscht/archiviert.
Draft Boolean Falsch Gibt an, ob es sich bei dem Ereignis um einen Entwurf handelt. Wenn „false“, wird das Ereignis veröffentlicht. Beim Speichern eines veröffentlichten Ereignisses werden die entsprechenden Benachrichtigungen über veröffentlichte Ereignisse an die zugewiesenen Benutzer gesendet.
TimeZone String Falsch Zeitzone des geplanten Ereignisses.
Title String Falsch Titel oder Name dieser Veranstaltung.
Notes String Falsch Mit dem Ereignis verknüpfte Notizen.
Location String Falsch Ort der Veranstaltung. Der Ort kann eine Adresse, ein Firmenname, eine GPS-Koordinate usw. sein. Wenn Benutzer also auf den Ort klicken, wird dieser in ihrer Kartenanwendung geöffnet.
Color String Falsch Diesem Zeitplanereignis zugewiesener Hex-Farbcode.
Created Datetime Wahr Datum/Uhrzeit der Erstellung dieses Zeitplanereignisses
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Zeitplanereignisses.
CustomFields String Falsch Nur vorhanden, wenn das Advanced Tracking Add-on installiert ist. Dies ist eine Schlüssel-/Wertzuordnung von benutzerdefinierten Feld-IDs zu den benutzerdefinierten Feldelementen, die mit dem Ereignis verknüpft sind.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
TeamEvents String Mögliche Werte: „base“ oder „instance“. Standard ist „instance“. Wenn „instance“ angegeben ist, werden Ereignisse, die mehreren Benutzern zugewiesen sind, als einzelne Ereignisse für jeden zugewiesenen Benutzer zurückgegeben. Wenn „base“ angegeben ist, werden Ereignisse, die mehreren Benutzern zugewiesen sind, als ein kombiniertes Ereignis für alle zugewiesenen Benutzer zurückgegeben.
ActiveUsers Integer „0“, „-1“ oder „1“. Der Standardwert ist „1“. Standardmäßig werden nur Zeitplanereignisse zurückgegeben, deren Benutzer aktiv sind. 0 gibt Ereignisse für inaktive Benutzer zurück. -1 gibt Ereignisse für aktive und inaktive Benutzer zurück.
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

Freistellungsanforderungseinträge

Erstellen, Aktualisieren und Abfragen der Urlaubsanträge in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle TimeOffRequestEntries. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • TimeOffRequestId unterstützt '=,IN'
  • Status unterstützt '=,IN'
  • ApproverUserId unterstützt '=,IN'
  • UserId unterstützt '=,IN'
  • JobcodeId unterstützt '=,IN'
  • Date unterstützt das '='
  • StartTime unterstützt das '='
  • EndTime unterstützt das '='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM TimeOffRequestEntries
SELECT * FROM TimeOffRequestEntries WHERE ID = 11531340
Einfügen

Das Einfügen kann durch Angabe von TimeOffRequestId, EntryMethod, Duration, JobcodeId und Date-Spalte ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO TimeOffRequestEntries (TimeOffRequestId, EntryMethod, Duration, JobcodeId, Date) VALUES (12345, 'manual', 3600, 10984254, '2024-05-29')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE TimeOffRequestEntries SET Duration = 500 WHERE ID = '15011650'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des Zeitpunkts der Anforderungseingabe.
TimeOffRequestId Integer True ID des Urlaubsantrags, zu dem dieser Eintrag gehört.
Status String Falsch Eines der folgenden Objekte: ‚Ausstehend‘, ‚Genehmigt‘, ‚Abgelehnt‘ oder ‚Abgebrochen‘.
ApproverUserId Integer True Benutzer-ID des Benutzers, der den Urlaubsantrag genehmigt oder abgelehnt hat.
Date Date Falsch Das Datum, für das der Abwesenheitsantrag gilt (Format JJJJ-MM-TT).
EntryMethod String Falsch Entweder „manuell“ oder „regulär“. Manuelle Urlaubsanträge haben ein Datum und eine Dauer (in Sekunden). Reguläre Urlaubsanträge haben eine Start-/Endzeit (Dauer wird von TSheets berechnet), um die Verfügbarkeit im Zeitplan zu bestimmen. Die eindeutigen Eigenschaften für jeden Eintragsmethodentyp finden Sie weiter unten.
Duration Integer Falsch Die Gesamtanzahl der für diesen Abwesenheitsantrag aufgezeichneten Sekunden.
StartTime Datetime Falsch Startzeit.
EndTime Datetime Falsch Endzeit.
TzString String True Die Zeitzone des Eintrags im Stringformat.
JobcodeId Integer Falsch Jobcode-ID für den Jobcode, für den dieser Urlaubsantrag erfasst wird.
UserId Integer True Benutzer-ID für den Benutzer, dem dieser Abwesenheitsantrag gehört.
ApprovedTimesheetId Integer True ID des Zeitnachweises, der mit diesem Abwesenheitsantragseintrag verknüpft ist, wenn er genehmigt wird.
Active Boolean True Wenn True, ist dieser Urlaubsantrag aktiv. Wenn False, wird dieser Urlaubsantrag archiviert.
Created Datetime True Datum/Uhrzeit, wann dieser Abwesenheitsantragseintrag erstellt wurde.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Urlaubsantragseintrags.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Freizeitanfragen

Erstellen, Aktualisieren und Abfragen der Urlaubsanträge in TSheets.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle TimeOffRequests. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • UserId unterstützt '=,IN'
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM TimeOffRequests
SELECT * FROM TimeOffRequests WHERE ID = 11531340
Einfügen

Das Einfügen kann durch Angabe der Spalten TimeOffRequestNotes und TimeOffRequestEntries ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO TimeOffRequests (TimeOffRequestNotes, TimeOffRequestEntries) VALUES ('[{"note":"Taking a four day weekend to go on vacation."}]', '[{"date":"2024-05-29","start_time":"2024-01-17T00:00:00-06:00","end_time":"2024-04-17T00:00:00-06:00","entry_method":"regular","duration":28800,"jobcode_id":10984254}]')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE TimeOffRequests SET TimeOffRequestNotes = '[{"note":"Taking a four day weekend to go on vacation."}]' WHERE ID = '15011650'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer True ID des Urlaubsantrags.
UserId Integer True Benutzer-ID für den Benutzer, dem dieser Abwesenheitsantrag gehört.
TimeOffRequestNotes String Falsch Ein Array von Abwesenheitsantragsnotiz-IDs, die mit diesem Abwesenheitsantrag verknüpft sind.
TimeOffRequestEntries String Falsch Ein Array von Urlaubsantrags-Eintrags-IDs, die mit diesem Urlaubsantrag verknüpft sind.
Status String Falsch Eines der folgenden Objekte: ‚Ausstehend‘, ‚Genehmigt‘, ‚Abgelehnt‘ oder ‚Abgebrochen‘.
Active Boolean Falsch Wenn wahr, ist dieser Urlaubsantrag aktiv. Wenn falsch, wird dieser Urlaubsantrag archiviert.
Created Datetime True Datum/Uhrzeit, wann dieser Abwesenheitsantragseintrag erstellt wurde.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Urlaubsantragseintrags.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Arbeitszeitnachweise

Diese Tabelle enthält eine Liste von Dateiobjekten.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „Timesheets“. Der Connector verwendet die TSheets API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id, UserId, JobcodeId, PayrollIds, GroupIdsFelder unterstützen die Operatoren '=' und IN.
  • OnTheClock Und JobCodeTypeFelder unterstützen den Operator '='.
  • LastModified Und Date-Felder unterstützen die Operatoren <=,<=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Timesheets WHERE OnTheClock = false

SELECT * FROM Timesheets WHERE LastModified > '2019-01-01 18:30' AND GroupIds IN (1, 2, 3)

SELECT * FROM Timesheets WHERE JobcodeId IN (1, 2, 3)
Einfügen

Das Einfügen kann durch Angabe der Spalten UserId, JobcodeId, Typ und Startzeit, Endzeit im Fall von Typ = regulär oder UserId, JobcodeId, Typ und Dauer, Datum im Fall von Typ = manuell ausgeführt werden. Die Spalten, die nicht benötigt werden, können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Timesheets (UserId, JobcodeId, Type, StartTime, EndTime) VALUES ('1242123', '17288283', 'regular', '2019-12-05', '2019-12-05')

INSERT INTO Timesheets (UserId, JobcodeId, Type, Date, Duration) VALUES ('1242123', '17288283', 'manual', '2019-12-05', 600)
Aktualisieren

Die Aktualisierung kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Timesheets SET Date = '2018-08-08', EndTime = '2018-08-08T14:00:00-07:00'  WHERE ID = '1242123'
Löschen

Das Löschen kann durch Angabe der ID in der WHERE-Klausel ausgeführt werden. Beispiel:

DELETE FROM Timesheets WHERE ID = '41321421'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True ID des Stundenzettels.
UserId String Falsch Benutzer-ID für den Benutzer, dem dieses Arbeitszeitnachweisblatt gehört.
JobcodeId Int Falsch Jobcode-ID für den Jobcode, für den dieser Stundenzettel erfasst wird.
Locked Boolean True Wenn der Wert größer als 0 ist, ist das Arbeitszeitnachweisformular für die Bearbeitung gesperrt. Ein Arbeitszeitnachweis kann aus verschiedenen Gründen gesperrt sein.
Notes String Falsch Mit diesem Stundenzettel verknüpfte Notizen.
LastModified Datetime True Datum/Uhrzeit der letzten Änderung dieses Stundenzettels.
Type String Falsch Entweder „normal“ oder „manuell“.
OnTheClock Boolean True Wenn True, arbeitet der Benutzer derzeit an dieser Arbeitszeittabelle. Wenn False, arbeitet der Benutzer derzeit nicht an dieser Arbeitszeittabelle. Bei manuellen Arbeitszeittabellen ist diese Eigenschaft immer auf False gesetzt.
CreatedByUserId String Falsch Benutzer-ID für den Benutzer, der dieses Arbeitszeitnachweis ursprünglich erstellt hat.
StartTime Datetime Falsch Datum/Uhrzeit, die die Startzeit dieses Zeitnachweises darstellen. Bei manuellen Zeitnachweisen ist dies immer eine leere Zeichenfolge.
EndTime Datetime Falsch Datum/Uhrzeit, die die Endzeit dieses Zeitnachweises darstellen. Bei manuellen Zeitnachweisen ist dies immer eine leere Zeichenfolge.
Date Date Falsch Das Datum des Stundenzettels
Duration Int Falsch Die Gesamtanzahl der für dieses Arbeitszeitnachweisblatt aufgezeichneten Sekunden.
OriginHint String Falsch Eine Zeichenfolge, die als Teil des Arbeitszeitnachweisverlaufs protokolliert wird, wenn jemand ein- oder ausgestempelt wird oder ein Arbeitszeitnachweis erstellt wird (bei beiden Ein-/Ausstempeln). Bei manuellen Arbeitszeitnachweisen ist dies immer eine leere Zeichenfolge.
JobCodeType String True Der Typ des Jobcodes, der mit diesem Stundenzettel verknüpft ist. Alle der folgenden Typen: „regulär“, „pto“, „bezahlte Pause“, „unbezahlte Pause“
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
PayrollIds Int Eine durch Kommas getrennte Zeichenfolge mit Gehaltsabrechnungs-IDs. Es wird nur die für Benutzer mit diesen Gehaltsabrechnungs-IDs erfasste Zeit zurückgegeben.
GroupIds Int Eine durch Kommas getrennte Liste von Gruppen-IDs. Es werden nur Zeitnachweise zurückgegeben, die mit Benutzern aus diesen Gruppen verknüpft sind.

Benutzer

Ruft eine Liste aller Benutzer ab, die mit Ihrem Unternehmen verknüpft sind.

Tabellenspezifische Informationen
Wählen

Abfrage der Benutzertabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id, GroupId, Username, PayrollId Und EmployeeNumber-Felder unterstützen die Operatoren '=' und IN.
  • FirstName Und LastNameFelder unterstützen die Operatoren '=' und LIKE.
  • ActiveStatus unterstützt die = Betreiber.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Users WHERE ActiveStatus = 'both'

SELECT * FROM Users WHERE LastModified > '2019-01-01 18:30' AND GroupId IN (1, 2, 3)

SELECT * FROM Users WHERE FirstName LIKE 'josh%' AND PayrollId IN ('562348', '45457')
Einfügen

Das Einfügen kann durch Angabe der Spalten Benutzername, Vorname und Nachname ausgeführt werden. Die nicht benötigten Spalten können optional eingefügt werden. Nachfolgend finden Sie ein Beispiel für das Einfügen in diese Tabelle

INSERT INTO Users (UserName, FirstName, LastName) VALUES ('cdatagroup@123', 'cdata', 'group')
Aktualisieren

Die Aktualisierung kann durch Angabe der ID oder des Benutzernamens in der WHERE-Klausel ausgeführt werden. Die Spalten, die nicht schreibgeschützt sind, können aktualisiert werden. Beispiel:

UPDATE Users SET FirstName = 'New Name'  WHERE Id = '14055'

UPDATE Users SET FirstName = 'New User Name', LastName = 'New Title' WHERE UserName = 'cdatagroup@123' 
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] Integer Falsch ID dieses Benutzers.
FirstName String Falsch Vorname des Benutzers.
LastName String Falsch Nachname des Benutzers.
DisplayName String Falsch Der Anzeigename des Benutzers. HINWEIS: Das Feld ist null, sofern die Funktion GED_INCLUSION nicht aktiviert ist (wenden Sie sich für weitere Informationen an den Support). Wenn die Funktion aktiviert ist, ist der Wert ein Anzeigename ungleich null (Benutzer, die ihren Anzeigenamen nicht eingerichtet haben, geben eine leere Zeichenfolge zurück).
Pronouns String Falsch Die persönlichen Pronomen des Benutzers. HINWEIS: Das Feld ist null, sofern die Funktion GED_INCLUSION nicht aktiviert ist (kontaktieren Sie den Support für weitere Informationen). Wenn die Funktion aktiviert ist, ist der Wert ein Pronomenwert ungleich null (Benutzer, die ihre Pronomen nicht eingerichtet haben, geben eine leere Zeichenfolge zurück).
GroupId Integer Falsch ID der Gruppe, zu der dieser Benutzer gehört.
Active Boolean Falsch Ob dieser Benutzer aktiv ist. Wenn falsch, wird dieser Benutzer als archiviert betrachtet.
EmployeeNumber Integer Falsch Eindeutige Nummer, die diesem Benutzer zugeordnet ist.
Salaried Boolean Falsch Gibt an, ob der Benutzer ein Gehalt bezieht oder nicht.
Exempt Boolean Falsch Gibt an, ob der Benutzer Anspruch auf Überstundenvergütung hat oder nicht.
Username String Falsch Mit diesem Benutzer verknüpfter Benutzername.
Email String Falsch Mit diesem Benutzer verknüpfte Email Adresse.
EmailVerified Boolean Falsch Gibt an, ob der Benutzer Anspruch auf Überstundenvergütung hat oder nicht.
PayrollId String Falsch Eindeutige unternehmensweite Zeichenfolge, die diesem Benutzer zugeordnet ist. Wird normalerweise für die Verknüpfung mit externen Systemen verwendet.
HireDate Date Falsch Datum, an dem dieser Benutzer eingestellt wurde.
TermDate Date Falsch Datum, an dem dieser Benutzer gekündigt wurde.
LastModified Datetime Falsch Datum/Uhrzeit der letzten Änderung dieses Benutzers.
LastActive Datetime Falsch Datum/Uhrzeit, wann dieser Benutzer zuletzt eine Aktion ausgeführt hat.
Created Datetime Falsch Datum/Uhrzeit der Erstellung dieses Benutzers
ClientUrl String Falsch Mit diesem Benutzer verknüpfte URL Kennung des Client-Kontos.
CompanyName String Falsch Dem Benutzer zugeordneter Client-Kontoname-Bezeichner.
ProfileImageUrl String Falsch Mit dem Profilbild dieses Benutzers verknüpfte URL-Kennung.
MobileNumber String Falsch Mit diesem Benutzer verknüpfte Mobiltelefonnummer.
PTOBalances String Falsch Liste der Jobcode-Kennungen und ihrer jeweiligen PTO-Guthaben für diesen Benutzer (in Sekunden).
SubmittedTo Date Falsch Das letzte Datum, bis zu dem dieser Benutzer Stundennachweise übermittelt hat.
ApprovedTo Date Falsch Das letzte Datum, bis zu dem für diesen Benutzer Arbeitszeitnachweise genehmigt wurden.
ManagerOfGroupIds String Falsch Die Gruppen-IDs, die dieser Benutzer verwaltet.
RequirePasswordChange Boolean Falsch Ob dieser Benutzer bei der nächsten Anmeldung sein Kennwort ändern muss.
LoginPIN Integer Falsch Wird zum Anmelden bei einem Kiosk o. Ä. verwendet.
PayRate Double Falsch Der mit diesem Benutzer verknüpfte Lohnsatz. Nur für Administratoren sichtbar.
PayInterval String Falsch Der Zeitraum, für den der Lohnsatz dieses Benutzers gilt, entweder „Stunde“ oder „Jahr“. Nur für Administratoren sichtbar.
CustomFields String Falsch Eine Schlüssel-/Wertzuordnung von benutzerdefinierten Feld-IDs zu den benutzerdefinierten Feldelementen, die dem Benutzer zugeordnet sind.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus Boolean Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

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.

Jitterbit-Connector für TSheets-Ansichten

Name Beschreibung
CurrentTotalsReport Bericht über die aktuellen Gesamtstunden (Schicht und Tag) mit zusätzlichen Informationen für diejenigen, die sich derzeit im Dienst befinden.
CurrentUser Aktuelle Benutzerdetails in TSheets abfragen.
CustomFieldItemJobCodeFilters Abfrage der JobCode-Filter für benutzerdefinierte Feldelemente in TSheets.
CustomFieldItemUserFilters Abfrage der Benutzerfilter für benutzerdefinierte Feldelemente in TSheets.
GeneralSettings Ruft eine Liste aller effektiven Einstellungen ab, die einem einzelnen Benutzer zugeordnet sind.
GeofenceConfigs Ruft eine Liste aller Geofence-Konfigurationen ab.
LastModifiedTimestamps Ruft eine Liste der last_modified - Zeitstempel ab, die mit jedem angeforderten API - Endpoint verknüpft sind.
LocationMaps Ruft eine Liste aller mit Ihrem Unternehmen verknüpften Standortkarten ab.
ManagedClients Ruft eine Liste der verwalteten Clients ab, die über Ihr Konto verfügbar sind.
PayrollReport Lohn- und Gehaltsabrechnung mit einem Zeitrahmen verknüpft.
PayrollReportByJobCode Lohn- und Gehaltsabrechnung nach Jobcode
ProjectActivities Abfrage der Projektaktivitäten in TSheets.
ProjectActivityReadTimes Aktualisieren und Abfragen der ProjectActivity-Lesezeit in TSheets.
ProjectEstimateDetailReport Ruft einen detaillierten Bericht zur Projektschätzung ab.
ProjectEstimateReport Ruft einen Projektkostenbericht ab.
ProjectReport Ruft einen Projektbericht ab.
ScheduleCalendars Ruft eine Liste der Dienstkalender ab, die Ihren Mitarbeitern oder Ihrem Unternehmen zugeordnet sind.
TimesheetsDeleted Abfrage der Projektnotizen in TSheets.
UserPermissions Die einem einzelnen Benutzer zuweisbaren Rechte.

AktuellerTotalsBericht

Bericht über die aktuellen Gesamtstunden (Schicht und Tag) zusammen mit zusätzlichen Informationen für diejenigen, die gerade im Dienst sind.

Tabellenspezifische Informationen
Wählen

Abfrage der CurrentTotalsReport-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • GroupId, UserId Und OnTheClockFelder unterstützen die Operatoren „=“ und IN.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM CurrentTotalsReport

SELECT * FROM CurrentTotalsReport WHERE GroupId IN ('29474', '29474') AND OnTheClock IN (true, false)

SELECT * FROM CurrentTotalsReport WHERE UserId IN (1751136, 1738864) AND OnTheClock = false
Spalten
Name Typ Beschreibung
UserId Int ID der Benutzer, für die diese Summen berechnet werden.
GroupId String Eindeutige Gruppen-ID für diesen Benutzer. Der Wert Null steht für Benutzer ohne Gruppe.
OnTheClock Boolean Ob dieser Benutzer derzeit im Einsatz ist.
ShiftGeolocationsAvailable Boolean Ob Geolokalisierungen für das aktuelle Arbeitszeitblatt verfügbar sind.
ShiftSeconds Int Gesamtzeit der aktuellen Schicht in Sekunden.
DaySeconds Int Gesamtzeit für den Tag in Sekunden.

AktuellerBenutzer

Fragen Sie die aktuellen Benutzerdetails in TSheets ab.

Tabellenspezifische Informationen
Wählen

Abfrage der CurrentUser-Tabelle. Dabei werden die Bedingungen der WHERE-Klausel auf der API -Seite nicht unterstützt, nur eine einfache SELECT Abfrage funktioniert auf der API Seite. Die Filter werden clientseitig innerhalb des Connectors ausgeführt.

Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM CurrentUser
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID des aktuellen Benutzers.
FirstName String Vorname
LastName String Nachname
DisplayName String Anzeigename
GroupId Integer Gruppen-ID.
Active Boolean Boolescher Wert, der den aktiven Status anzeigt.
EmployeeNumber Integer Die Mitarbeiternummer.
Salaried Boolean Angestellte
Exempt Boolean Ausgenommen
UserName String Benutzername
Email String Email
EmailVerified String Email verifiziert
PayrollId String Gehaltsabrechnungs-ID
HireDate String Einstellungsdatum
TermDate String Semesterdatum
LastModified Datetime Zuletzt geändert
LastActive Datetime Zuletzt aktiv
Created Datetime Erstellt
ClientUrl String Client URL
CompanyName String Firmenname
ProfileImageUrl String Profilbild-URL
MobileNumber String Mobilnummer
PtoBalances String Zapfwellenbilanzen
SubmittedTo Datetime Gesendet an
ApprovedTo Datetime Genehmigt für
ManagerOfGroupIds String Manager von Gruppen-IDs
RequirePasswordChange Boolean Passwortänderung erforderlich
PayRate Integer Lohnsatz
PayInterval String Zahlungsintervall
PermissionsAdmin Boolean Berechtigungen - Admin
PermissionsMobile Boolean Berechtigungen - Mobil
PermissionsStatusBox Boolean Berechtigungen - Box
PermissionsReports Boolean Berechtigungen - Berichte
PermissionsManageTimesheets Boolean Berechtigungen - Arbeitszeitnachweise verwalten
PermissionsManageAuthorization Boolean Berechtigungen - Autorisierung verwalten
PermissionsManageUsers Boolean Berechtigungen - Benutzer verwalten
PermissionsManageMyTimesheets Boolean Berechtigungen - Meine Arbeitszeitnachweise verwalten
PermissionsManageJobcodes Boolean Berechtigungen - Jobcodes verwalten
PermissionsPinLogin Boolean Berechtigungen - PIN-Anmeldung
PermissionsApproveTimesheets Boolean Berechtigungen - Arbeitszeitnachweise genehmigen
PermissionsManageSchedules Boolean Berechtigungen - Zeitpläne verwalten
PermissionsExternalAccess Boolean Berechtigungen - Externer Zugriff
PermissionsManageMySchedule Boolean Berechtigungen - Meinen Zeitplan verwalten
PermissionsManageCompanySchedules Boolean Berechtigungen - Unternehmenspläne verwalten
PermissionsViewCompanySchedules Boolean Berechtigungen - Unternehmenspläne anzeigen
PermissionsViewGroupSchedules Boolean Berechtigungen - Gruppenpläne anzeigen
PermissionsManageNoSchedules Boolean Berechtigungen - Keine Zeitpläne verwalten
PermissionsViewMySchedules Boolean Berechtigungen - Meine Zeitpläne anzeigen
PermissionsViewProjects Boolean Berechtigungen - Projekte anzeigen
PermissionsManageProjects Boolean Berechtigungen - Projekte verwalten
PermissionsTimeTracking Boolean Berechtigungen - Zeiterfassung

BenutzerdefinierteFeldelementeJobCodeFilters

Fragen Sie die JobCode-Filter für benutzerdefinierte Feldelemente in TSheets ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle CustomFieldItemJobCodeFilters. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • JobCodeId unterstützt '=,IN'
  • LastModified unterstützt '<,<=,>,>='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFieldItemJobCodeFilters
SELECT * FROM CustomFieldItemJobCodeFilters WHERE JobCodeId = '679721'
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID des Jobcodes, zu dem der Filter gehört.
LastModified Datetime Das letzte Datum/die letzte Uhrzeit, zu der eines der gefilterten Elemente aktualisiert wurde.
FilteredCustomFieldItems String Jede Entität stellt die aktiven Filter eines benutzerdefinierten Felds dar, wobei der Schlüssel die benutzerdefinierte Feld-ID und der Wert ein Array von Artikel-IDs ist, denen der Jobcode zugewiesen ist.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
JobCodeId Integer Durch Komma getrennte Liste einer oder mehrerer Jobcode-IDs, nach denen Sie filtern möchten.

BenutzerdefinierteFeldelementeBenutzerfilter

Fragen Sie die Benutzerfilter für benutzerdefinierte Feldelemente in TSheets ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle CustomFieldItemUserFilters. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • UserId unterstützt das '='
  • GroupId unterstützt das '='
  • IncludeUserGroup unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM CustomFieldItemUserFilters
SELECT * FROM CustomFieldItemUserFilters WHERE JobCodeId = '679721'
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID des Jobcodes, zu dem der Filter gehört.
Type String Der Entitätsfiltertyp: Benutzer oder Gruppe.
LastModified Datetime Das letzte Datum/die letzte Uhrzeit, zu der eines der gefilterten Elemente aktualisiert wurde.
FilteredCustomFieldItems String Jede Entität stellt die aktiven Filter eines benutzerdefinierten Felds dar, wobei der Schlüssel die benutzerdefinierte Feld-ID und der Wert ein Array von Artikel-IDs ist, denen der Benutzer zugewiesen ist.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
UserId Integer Beschränkt die zurückgegebenen Filter auf diejenigen für die angegebene Benutzer-ID. Sie können Elemente für die Gruppe dieses Benutzers auch automatisch einschließen, wenn Sie den Parameter „include_user_group“ einschließen.
GroupId Integer Beschränkt den zurückgegebenen Filter auf die Filter für die angegebene Gruppen-ID.
IncludeUserGroup Boolean Boolescher Wert. Wenn eine Benutzer-ID angegeben ist, werden auch Filter für die Gruppe dieses Benutzers zurückgegeben.

AllgemeineEinstellungen

Ruft eine Liste aller effektiven Einstellungen ab, die einem einzelnen Benutzer zugeordnet sind.

Tabellenspezifische Informationen
Wählen

Frage die Tabelle „GeneralSettings“ ab. Alle Filter werden clientseitig innerhalb des Connectors ausgeführt.

Spalten
Name Typ Beschreibung
CalculateOvertime Boolean Die Einstellung „CalculateOvertime“.
ClockoutOverride Boolean Die ClockoutOverride-Einstellung.
ClockoutOverrideHours Integer Die ClockoutOverrideHours-Einstellung.
ClockoutOverrideNotifyAdmin Boolean Die Einstellung ClockoutOverrideNotifyAdmin.
ClockoutOverrideNotifyManager Boolean Die Einstellung ClockoutOverrideNotifyManager.
DailyDoubletime Integer Die DailyDoubletime-Einstellung.
DailyOvertime Integer Die DailyOvertime-Einstellung.
DailyRegularHours Integer Die DailyRegularHours-Einstellung.
DateLocale String Die DateLocale-Einstellung.
EmpPanel Boolean Die EmpPanel-Einstellung.
EmpPanelMail String Die EmpPanelMail-Einstellung.
EmpPanelPassword String Die EmpPanelPassword-Einstellung.
EmployeePtoEntry Boolean Die EmployeePtoEntry-Einstellung.
EnableTimesheetNotes String Die Einstellung „EnableTimesheetNotes“.
HideWorkingTime String Die HideWorkingTime-Einstellung.
JcLabel String Die JcLabel-Einstellung.
LunchDeduct Boolean Die LunchDeduct-Einstellung.
LunchLength Boolean Die LunchLength-Einstellung.
LunchThreshold Integer Die LunchThreshold-Einstellung.
MaxCustomFieldItems Integer Die MaxCustomFieldItems-Einstellung.
MaxJobCodes Integer Die MaxJobCodes-Einstellung.
ParentClockinDisplay Integer Die ParentClockinDisplay-Einstellung.
PayrollEndDate Date Die PayrollEndDate-Einstellung.
PayrollFirstEndDay String Die Einstellung „PayrollFirstEndDay“.
PayrollLastEndDay String Die Einstellung „PayrollLastEndDay“.
PayrollMonthEndDay String Die Einstellung „PayrollMonthEndDay“.
PayrollType String Die PayrollType-Einstellung.
PtoEntry Boolean Die PtoEntry-Einstellung.
PtoOvertime Boolean Die PtoOvertime-Einstellung.
SimpleClockin Boolean Die SimpleClockin-Einstellung.
TimeFormat Integer Die TimeFormat-Einstellung.
TimecardFields String Die TimecardFields-Einstellung.
TimeclockLabel String Die TimeclockLabel-Einstellung.
TimesheetEditNotesForAllUsers Boolean Die Einstellung „TimesheetEditNotesForAllUsers“.
TimesheetNotesNotifyAdmin Boolean Die Einstellung TimesheetNotesNotifyAdmin.
TimesheetNotesNotifyManagers Boolean Die Einstellung „TimesheetNotesNotifyManagers“.
TimesheetNotesRequired Boolean Die Einstellung „TimesheetNotesRequired“.
Timezone String Die Zeitzoneneinstellung.
WeekStart String Die WeekStart-Einstellung.
WeeklyRegularHours String Die WeeklyRegularHours-Einstellung.
LastModified Datetime Wann der Datensatz zuletzt geändert wurde.

GeofenceKonfigurationen

Ruft eine Liste aller Geofence-Konfigurationen ab.

Tabellenspezifische Informationen
Wählen

Abfrage der GeofenceConfigs-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id, TypeId Und Type-Felder unterstützen die Operatoren '=' und IN.
  • Enabled Feld und ActiveStatus Filter unterstützen den '='-Operator.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM GeofenceConfigs WHERE TypeId IN (282316, 323445) AND Type = 'Locations'

SELECT * FROM GeofenceConfigs WHERE Enabled = false
Spalten
Name Typ Beschreibung
Id [KEY] Int ID der Geofence-Konfiguration.
Type String Der Entitätstyp, auf den sich die Geofence-Konfiguration bezieht.
TypeId Int Die ID der Entität, auf die sich die Geofence-Konfiguration bezieht.
Active Boolean Ob diese Geofence-Konfiguration aktiv ist. Wenn „false“, wird diese Geofence-Konfiguration archiviert.
Enabled Boolean Gibt an, ob ein Geofence für die zugehörige Entität aktiviert werden soll.
Radius Int Konfiguriert die Größe des Geofence.
Created Datetime Datum/Uhrzeit der Erstellung dieser Geofence-Konfiguration
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieser Geofence-Konfiguration.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

LastModifiedTimestamps

Ruft eine Liste der last_modified-Zeitstempel ab, die mit jedem angeforderten API Endpoint verknüpft sind.

Tabellenspezifische Informationen
Wählen

Fragen Sie eine Liste der Zeitstempel der letzten Änderung ab, die mit jedem angeforderten API Endpoint verknüpft sind.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM LastModifiedTimestamps WHERE endpoints = 'timesheets,current_user,groups'
Spalten
Name Typ Beschreibung
CurrentUser Datetime Datum/Uhrzeit der letzten Änderung dieses aktuellen Benutzers.
CustomFields Datetime Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Felds.
CustomFielditems Datetime Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelements.
CustomFieldItemFilters Datetime Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelementfilters.
CustomFieldItemUserFilters Datetime Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelement-Benutzerfilters.
CustomFieldItemJobCodeFilters Datetime Datum/Uhrzeit der letzten Änderung dieses benutzerdefinierten Feldelement-Jobcode-Filters.
ContactInfo Datetime Datum/Uhrzeit der letzten Änderung dieser Kontaktinformationen.
EffectiveSettings Datetime Datum/Uhrzeit der letzten Änderung dieser effektiven Einstellungen.
GeoLocations Datetime Datum/Uhrzeit der letzten Änderung dieses geografischen Standorts.
GeofenceConfigs Datetime Datum/Uhrzeit der letzten Änderung dieser Geofence-Konfigurationen.
GeofenceActiveHours Datetime Datum/Uhrzeit der letzten Änderung dieser aktiven Geofence-Stunden.
Groups Datetime Datum/Uhrzeit der letzten Änderung dieser Gruppe.
JobCodes Datetime Datum/Uhrzeit der letzten Änderung dieses Jobcodes.
JobCodeAssignments Datetime Datum/Uhrzeit der letzten Änderung dieser Jobcodezuweisungen.
Locations Datetime Datum/Uhrzeit der letzten Änderung dieser gelöschten Standorte.
LocationsMap Datetime Datum/Uhrzeit der letzten Änderung dieser Standortkarte.
Reminders Datetime Datum/Uhrzeit der letzten Änderung dieser Erinnerung.
ScheduleCalendars Datetime Datum/Uhrzeit der letzten Änderung dieses Zeitplankalenders.
ScheduleEvents Datetime Datum/Uhrzeit der letzten Änderung dieser Zeitplanereignisse.
TimeSheets Datetime Datum/Uhrzeit der letzten Änderung dieses Stundenzettels.
TimeSheetsDeleted Datetime Datum/Uhrzeit der letzten Änderung dieser gelöschten Arbeitszeittabellen.
TimeOffRequests Datetime Datum/Uhrzeit der letzten Änderung dieses Abwesenheitsantrags.
TimeOffRequestEntries Datetime Datum/Uhrzeit der letzten Änderung dieses Abwesenheitsantragseintrags.
Terms Datetime Datum/Uhrzeit der letzten Änderung dieser Bedingungen.
Users Datetime Datum/Uhrzeit der letzten Änderung dieses Benutzers.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
Endpoints String Durch Komma getrennte Liste von einem oder mehreren Endpoints.

Standortkarten

Ruft eine Liste aller mit Ihrem Unternehmen verknüpften Standortkarten ab.

Tabellenspezifische Informationen
Wählen

Abfrage der LocationMaps-Tabelle. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Feld unterstützt die Operatoren '=' und IN.
  • ByJobcodeAssignment unterstützt die = Betreiber.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM LocationMaps WHERE Id IN ('102839', '110761')

SELECT * FROM LocationMaps WHERE ByJobcodeAssignment = true
Spalten
Name Typ Beschreibung
Id [KEY] String ID der Standortkarte.
XTable String Der Name der Entität, der der Standort zugeordnet ist.
XId Integer Die ID der Entität, der der Standort zugeordnet ist.
LocationId Integer Die ID des Standorts, der der Entität zugeordnet ist.
Created Datetime Datum/Uhrzeit der Erstellung dieser Standortkarte
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieser Standortkarte.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ByJobcodeAssignment Boolean Wenn angegeben, werden nur Standortkarten zurückgegeben, die einem Jobcode zugeordnet sind, dem der Benutzer zugewiesen ist.

Verwaltete Kunden

Ruft eine Liste der verwalteten Clients ab, die über Ihr Konto verfügbar sind.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle ManagedClients. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • ActiveStatus unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ManagedClients WHERE ActiveStatus = 'both'
Spalten
Name Typ Beschreibung
Id [KEY] String ID des verwalteten Clients.
CompanyUrl String Vom verwalteten Client zur Anmeldung bei TSheets verwendete URL.
CompanyName String Name des Unternehmens des verwalteten Kunden.
Active Boolean Ob dieser Client aktiv ist. Wenn „false“, wird dieser Client als archiviert betrachtet.
Created Datetime Datum/Uhrzeit der Erstellung dieses verwalteten Kundendatensatzes
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieses verwalteten Clientdatensatzes.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ActiveStatus String Filterspalte, um festzulegen, ob nur aktive Datensätze, nur archivierte Datensätze oder beides abgerufen werden sollen. Standardmäßig werden nur aktive Datensätze abgerufen. Mögliche Werte sind: ja, nein, beides

Lohn- und Gehaltsabrechnung

Lohn- und Gehaltsabrechnung mit einem Zeitrahmen verknüpft.

Tabellenspezifische Informationen
Wählen

Fragen Sie die Tabelle „PayrollReport“ ab, um Gehaltsabrechnungen abzurufen, die einem bestimmten Zeitraum zugeordnet sind, und verwenden Sie Filter, um die Ergebnisse einzugrenzen. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Standardmäßig enthält der Bericht Ergebnisse für einen Zeitraum innerhalb der letzten 30 Tage. Sie können nach StartDate- und EndDate-Filtern filtern, um einen Gehaltsabrechnungsbericht für einen anderen Zeitraum zu erhalten.

  • UserId Und GroupId-Felder unterstützen die Operatoren '=' und IN.
  • StartDate, EndDate Und IncludeZeroTime-Felder unterstützen den Operator '='.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM PayrollReport WHERE GroupId IN ('29474', '29475') AND IncludeZeroTime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'
Spalten
Name Typ Beschreibung
UserId Int ID der Benutzer, für die diese Summen berechnet werden.
ClientId Int ID des Clients.
StartDate Date Beginn des Berichtszeitraums.
EndDate Date Ende des Lohnmeldezeitraums.
TotalReSeconds Int Gesamtzeit der aktuellen Schicht in Sekunden.
TotalOTSeconds Int Überstunden in Sekunden.
TotalDTSeconds Int Doppelte Zeit, in Sekunden.
TotalPTOSeconds Int Gesamte PTO-Zeit in Sekunden.
TotalWorkSeconds Int Gesamtzeit in Sekunden.
OvertimeSeconds String Das Verlängerungssekundenobjekt, wobei der Schlüssel der Multiplikatorsatz und der Wert die Anzahl der Verlängerungssekunden bei diesem Satz ist
FixedRateSeconds String Das Objekt mit dem festen Satz in Sekunden, wobei der Schlüssel der Multiplikatorsatz und der Wert die Anzahl der Überstundensekunden zu diesem Satz ist
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
GroupId String Eine durch Kommas getrennte Liste von Gruppen-IDs. Nur die Zeit für Benutzer aus diesen Gruppen wird einbezogen.
IncludeZeroTime String Wenn diese Option „true“ ist, werden alle Benutzer in die Ausgabe einbezogen, selbst wenn sie für den Zeitraum null Stunden hatten.

Gehaltsabrechnungsbericht nach Jobcode

Lohn- und Gehaltsabrechnung nach Stellenbezeichnung aufgeschlüsselt

Tabellenspezifische Informationen
Wählen

Fragen Sie die Tabelle PayrollReportByJobCode ab, um einen nach Jobcode aufgeschlüsselten Gehaltsabrechnungsbericht abzurufen, mit Filtern zum Eingrenzen der Ergebnisse. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Standardmäßig enthält der Bericht Ergebnisse für einen Zeitraum innerhalb der letzten 30 Tage. Sie können nach den Filtern StartDate und EndDate filtern, um einen Gehaltsabrechnungsbericht für einen anderen Zeitraum abzurufen. Der durch StartDate und EndDate definierte Datumsbereich darf 31 Tage nicht überschreiten.

  • GroupId Feld unterstützt die Operatoren '=' und IN.
  • StartDate, EndDate Und IncludeAdvancedOvertime-Felder unterstützen den Operator '='.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM PayrollReportByJobCode WHERE GroupId IN ('29474', '29474') AND IncludeAdvancedOvertime = false
SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Basierend auf den in der Projektion explizit ausgewählten Spalten können sich die angezeigten aggregierten Daten ändern. Aggregierte Gehaltsabrechnungsmetriken aufgeschlüsselt nach Jobcode-ID:

SELECT * FROM PayrollReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Gesamtzahlen der Gehaltsabrechnung aufgeschlüsselt nach Jobcode-ID für jeden Benutzer:

SELECT UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode

Gesamtzahlen der Gehaltsabrechnung aufgeschlüsselt nach Jobcode-ID und Datum für jeden Benutzer:

SELECT Date, UserId, JobCodeId, TotalWorkSeconds, TotalReSeconds, TotalPtoSeconds, OvertimeSeconds FROM PayrollReportByJobCode
Spalten
Name Typ Beschreibung
UserId Int ID der Benutzer, für die diese Summen berechnet werden.
JobcodeId Int ID des Jobcodes, auf den sich die Metriken beziehen.
StartDate Date Beginn des Berichtszeitraums.
EndDate Date Ende des Lohnmeldezeitraums.
Date String Datum, für das diese Summe berechnet wird.
TotalReSeconds Int Gesamtzeit der aktuellen Schicht in Sekunden.
TotalOTSeconds Int Überstunden in Sekunden.
TotalDTSeconds Int Doppelte Zeit, in Sekunden.
TotalPTOSeconds Int Gesamte PTO-Zeit in Sekunden.
TotalWorkSeconds Int Gesamtzeit in Sekunden.
OvertimeSeconds String Das Verlängerungssekundenobjekt, wobei der Schlüssel der Multiplikatorsatz und der Wert die Anzahl der Verlängerungssekunden bei diesem Satz ist
FixedRateSeconds String Das Objekt mit dem festen Satz in Sekunden, wobei der Schlüssel der Multiplikatorsatz und der Wert die Anzahl der Überstundensekunden zu diesem Satz ist
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
GroupId String Eine durch Kommas getrennte Liste von Gruppen-IDs. Nur die Zeit für Benutzer aus diesen Gruppen wird einbezogen.
IncludeAdvancedOvertime Boolean Wenn wahr, wird die Überstundenzeit so formatiert, dass sie die Zeit für einzelne Multiplikatoren beinhaltet und mehr als nur 1,5x (ot) und 2x (dt) Überstunden unterstützt.

ProjektAktivitäten

Fragen Sie die Projektaktivitäten in TSheets ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „ProjectActivities“. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • ProjectId unterstützt das '='
  • ActivityType unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectActivities WHERE ProjectId = 2056676
SELECT * FROM ProjectActivities WHERE ProjectId = 2056676 AND ID = 8375474
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID dieser Projektaktivität.
UserId Integer ID des zugehörigen Benutzers.
ProjectId Integer ID des zugehörigen Projekts.
Active Boolean Boolescher Wert. Wenn falsch, wird diese Projektaktivität als Archiv betrachtet.
UnreadRepliesCount Integer Die Anzahl der ungelesenen Antworten.
Following Boolean Folgen.
ActivityType String Aktivitätstyp.
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieses Projekts im ISO 8601-Format.
Created Datetime Datum/Uhrzeit der Erstellung dieses Projekts im ISO 8601-Format.
ProjectActivityMetadata String Metadaten der Projektaktivität.
LinkedObjects String Eine Schlüssel-/Wertzuordnung aller mit diesem Projekt verknüpften Objekte und der entsprechenden Objekt-IDs.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

ProjektAktivitätLeseZeiten

Aktualisieren und fragen Sie die Lesezeit von ProjectActivity in TSheets ab.

Tabellenspezifische Informationen
Wählen

Fragen Sie die Tabelle ProjectActivityReadTimes ab. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • LatestReadTime unterstützt '<,<=,>,>='
  • SupplementalData unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectActivityReadTimes
SELECT * FROM ProjectActivities WHERE ID = 8375474
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID der Lesezeit dieser Projektaktivität.
ProjectId Integer ID des zugehörigen Projekts.
UserId Integer ID des zugehörigen Benutzers. Nur die aktuelle Benutzer-ID ist zulässig.
LatestReadTime Datetime Datum/Uhrzeit, wann diese Projektaktivität zuletzt gelesen wurde.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

ProjektschätzungDetailbericht

Ruft einen detaillierten Bericht zur Projektschätzung ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle „ProjectEstimateDetailReport“. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt das '='
  • SupplementalData unterstützt das '='
  • ResultsAsArray unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectEstimateDetailReport
SELECT * FROM ProjectEstimateDetailReport WHERE ID = 8375474
Spalten
Name Typ Beschreibung
Id Int ID des Projektschätzungsberichts.
JobcodeId Int Die JobCode-ID.
ParentJobcodeId Int Eine JobCode-ID. Nur die Zeit für Projekte unter diesem Jobcode wird berücksichtigt.
Name String Name.
Status String Status. Die zulässigen Werte sind in_progress, complete.
Description String Beschreibung.
StartDate Datetime Startdatum.
DueDate Datetime Fälligkeitsdatum.
CompletedDate Datetime Datum der Fertigstellung.
Active Boolean Boolescher Wert, der den aktiven Status darstellt.
LastModified Datetime Datum der letzten Änderung.
Created Datetime Erstellungsdatum.
EstimateId Int Kostenvoranschlags-ID
EstimateBy String Geschätzt von.
EstimateById Int Schätzung nach ID.
TotalClockedInSeconds Int Insgesamt in Sekunden gemessen.
TotalClockedOutSeconds Int Gesamtzahl der ausgestempelten Sekunden.
TotalTrackedSeconds Int Gesamtzahl der erfassten Sekunden.
TotalEstimatedSeconds Int Geschätzte Gesamtzahl an Sekunden.
TotalNoteCount Int Gesamtzahl der Notizen.
UnreadPostsCount Int Anzahl ungelesener Beiträge.
UnreadRepliesCount Int Anzahl der ungelesenen Antworten.
BudgetProgress String Haushaltsfortschritt.
ClockedInUserIds String Eingeloggte Benutzer-IDs.
QboMapped Boolean Boolescher Wert.
EstimateItems String Artikel schätzen.
CustomFieldItemId Int Benutzerdefiniertes Feld „Artikel-ID“.
assigned_to_all Boolean Allen zugewiesen.
PreviewAssignedUserIds Int Vorschau der zugewiesenen Benutzer-IDs.
TotalAssignedUsers Int Gesamtzahl der zugewiesenen Benutzer.
TrackedTimeUsers Int Erfasste Zeit der Benutzer.
TrackedTimeGroups Int Verfolgte Zeitgruppen.
TrackedTimeJobcodes Int Jobcodes für die erfasste Zeit.
TrackedTimeCustomFields Int Benutzerdefinierte Felder für die erfasste Zeit.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.
ResultsAsArray Boolean Der Standardwert ist „Ja“. Gibt an, ob Ergebnisse als Array statt als Objekt zurückgegeben werden sollen.

ProjektKostenvoranschlagsbericht

Ruft einen Projektschätzungsbericht ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle ProjectEstimateReport. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • JobcodeId unterstützt '=,IN'
  • ProjectId unterstützt '=,IN'
  • ParentJobcodeId unterstützt das '='
  • Status unterstützt das '='
  • Active unterstützt das '='
  • SupplementalData unterstützt das '='
  • ResultsAsArray unterstützt das '='
  • HasTimeTracked unterstützt das '='
  • TimeTrackedStartDate unterstützt das '='
  • TimeTrackedEndDate unterstützt das '='

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectEstimateReport
SELECT * FROM ProjectEstimateReport WHERE ProjectId = 8375474
Spalten
Name Typ Beschreibung
Id Int ID des Projektschätzungsberichts.
JobcodeId Int Die JobCode-ID.
ParentJobcodeId Int Eine JobCode-ID. Nur die Zeit für Projekte unter diesem Jobcode wird berücksichtigt.
Name String Name.
Status String Stand.
Description String Beschreibung.
StartDate Datetime Startdatum.
DueDate Datetime Fälligkeitsdatum.
CompletedDate Datetime Datum der Fertigstellung.
Active Boolean Boolescher Wert, der den aktiven Status darstellt.
LastModified Datetime Datum der letzten Änderung.
Created Datetime Erstellungsdatum.
EstimateId Int Kostenvoranschlags-ID
EstimateBy String Geschätzt von.
EstimateById Int Schätzung nach ID.
TotalClockedInSeconds Int Insgesamt in Sekunden gemessen.
TotalClockedOutSeconds Int Gesamtzahl der ausgestempelten Sekunden.
TotalTrackedSeconds Int Gesamtzahl der erfassten Sekunden.
TotalEstimatedSeconds Int Geschätzte Gesamtzahl an Sekunden.
TotalNoteCount Int Gesamtzahl der Notizen.
UnreadPostsCount Int Anzahl ungelesener Beiträge.
UnreadRepliesCount Int Anzahl der ungelesenen Antworten.
BudgetProgress String Haushaltsfortschritt.
ClockedInUserIds String Eingeloggte Benutzer-IDs.
QboMapped Boolean Boolescher Wert.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ProjectId Integer Array aus einer oder mehreren Projekt-IDs. Nur die Zeit für diese Projekte wird einbezogen.
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.
ResultsAsArray Boolean Der Standardwert ist „Ja“. Gibt an, ob Ergebnisse als Array statt als Objekt zurückgegeben werden sollen.
HasTimeTracked Boolean Der Standardwert ist „Nein“. Gibt an, ob die Ergebnisse nach Zeiterfassungsdaten gefiltert werden sollen.

ProjektBericht

Ruft einen Projektbericht ab.

Tabellenspezifische Informationen
Wählen

Fragen Sie die ProjectReport-Tabelle ab, um einen Projektbericht abzurufen, aufgeschlüsselt nach Benutzer, Gruppe oder Jobcode. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Standardmäßig enthält der Bericht Ergebnisse für einen Zeitraum innerhalb der letzten 30 Tage. Sie können nach StartDate- und EndDate-Filtern filtern, um einen Gehaltsabrechnungsbericht für einen anderen Zeitraum zu erhalten.

  • UserId, JobcodeId Und GroupId-Felder unterstützen die Operatoren '=' und IN.
  • StartDate Und EndDate-Felder unterstützen den Operator '='.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ProjectReport WHERE GroupId IN (29474, 29474)
SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Basierend auf den in der Projektion explizit ausgewählten Spalten können sich die angezeigten aggregierten Daten ändern. Aggregierte Projektmetriken aufgeschlüsselt nach Benutzer-ID:

SELECT * FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'
SELECT UserId, TotalHours FROM ProjectReport WHERE StartDate = '2019-11-01' AND EndDate = '2019-12-31'

Aggregierte Projektmetriken aufgeschlüsselt nach Jobcode-ID:

SELECT JobCodeId, TotalHours FROM ProjectReport

Gesamtzahlen der Gehaltsabrechnung aufgeschlüsselt nach Gruppen-ID:

SELECT GroupId, TotalHours FROM ProjectReport
Spalten
Name Typ Beschreibung
UserId Int ID der Benutzer, für die diese Summen berechnet werden.
JobcodeId Int ID des Jobcodes, auf den sich die Metriken beziehen.
GroupId Int ID der Gruppe, auf die die Metriken zutreffen.
StartDate Date Beginn des Berichtszeitraums.
EndDate Date Ende des Lohnmeldezeitraums.
TotalHours Double Gesamtstundenzahl pro Benutzer, Gruppe oder Jobcode.

ZeitplanKalender

Ruft eine Liste der Terminkalender Ihrer Mitarbeiter oder Ihres Unternehmens ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle ScheduleCalendars. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id Feld unterstützt die Operatoren '=' und IN.
  • LastModified-Feld unterstützt die Operatoren <=,<,>=,>,=.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ScheduleCalendars WHERE Id IN (72595, 72597)

SELECT * FROM ScheduleCalendars WHERE LastModified < '2019-01-01 18:30'
Spalten
Name Typ Beschreibung
Id [KEY] Integer ID des Zeitplankalenders.
Name String Der Name des Zeitplankalenders.
Created Datetime Datum/Uhrzeit der Erstellung dieses Zeitplankalenders
LastModified Datetime Datum/Uhrzeit der letzten Änderung dieses Zeitplankalenders.

ArbeitszeitnachweiseGelöscht

Fragen Sie die Projektnotizen in TSheets ab.

Tabellenspezifische Informationen
Wählen

Abfrage der Tabelle TimesheetsDeleted. Der Connector verwendet die TSheets-API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • Id unterstützt '=,IN'
  • UserId unterstützt '=,IN'
  • JobcodeId unterstützt '=,IN'
  • StartDate unterstützt das '='
  • EndDate unterstützt das '='
  • Type unterstützt das '='
  • LastModified unterstützt '<,<=,>,>='
  • GroupId unterstützt '=,IN'
  • Username unterstützt das '='
  • JobcodeType unterstützt das '='
  • SupplementalData unterstützt das '='

Zum Abfrage der TimesheetsDeleted-Ansicht sind entweder StartDate und EndDate oder ID erforderlich. Die folgenden Abfragen werden beispielsweise serverseitig verarbeitet:

SELECT * FROM TimesheetsDeleted WHERE StartDate = '2023-02-01' AND EndDate = '2024-07-01'
SELECT * FROM TimesheetsDeleted WHERE ID = 8375474
Spalten
Name Typ Beschreibung
Id [KEY] String ID der Projektnotiz.
UserId Integer ID des zugehörigen Benutzers.
JobcodeId Integer JobCode-ID.
StartDate Datetime Startdatum.
EndDate Datetime Enddatum.
Duration Int Dauer.
Date Datetime Datum.
Tz Int Zeitzone.
TzStr String Zeitzone str.
Type String Typ.
Location String Standort.
Active Boolean Aktiv.
Locked String Gesperrt.
Notes String Notizen.
LastModified Datetime Datum der letzten Änderung.
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
GroupId Integer ID der zugehörigen Gruppen.
Username String Benutzername.
JobcodeType String Jobcode-Typ.
SupplementalData Boolean Der Standardwert ist „Ja“. Gibt an, ob zusätzliche Daten angegeben werden sollen.

Benutzerberechtigungen

Die einem einzelnen Benutzer zuweisbaren Rechte.

Tabellenspezifische Informationen
Wählen

Frage die UserPermissions-Tabelle ab. Alle Filter werden clientseitig innerhalb des Connectors ausgeführt.

Spalten
Name Typ Beschreibung
UserId [KEY] String Die ID des Benutzers, für den diese Berechtigungen gelten.
Admin Boolean Administrator, kann beliebige Änderungen am Konto vornehmen.
Mobile Boolean Ob dieser Benutzer mobile Geräte zur Zeiterfassung verwenden darf.
StatusBox Boolean Ob dieser Benutzer die Liste der Benutzer anzeigen kann, die derzeit für das Unternehmen arbeiten.
Reports Boolean Ob dieser Benutzer alle Berichte für das Unternehmen ausführen/anzeigen kann.
ManageTimesheets Boolean Ob dieser Benutzer für jeden im Unternehmen Arbeitszeitnachweise erstellen/bearbeiten/löschen darf.
ManageAuthorization Boolean Ob dieser Benutzer die Computerautorisierung für das Unternehmen verwalten darf.
ManageUsers Boolean Ob dieser Benutzer Benutzer, Gruppen und Manager für das gesamte Unternehmen erstellen/bearbeiten/löschen kann.
ManageMyTimesheets Boolean Ob dieser Benutzer die Möglichkeit hat, seine eigenen Arbeitszeitnachweise vollständig zu verwalten.
ManageJobcodes Boolean Ob dieser Benutzer Jobcodes und benutzerdefinierte Feldelemente für das gesamte Unternehmen erstellen/bearbeiten/löschen kann.
PinLogin Boolean Ob sich dieser Benutzer bei Apps per PIN anmelden kann.
ApproveTimesheets Boolean Ob dieser Benutzer Genehmigungsberichte ausführen und die Zeit für alle Mitarbeiter genehmigen darf.
ManageSchedules Boolean Ob dieser Benutzer Ereignisse im Zeitplan für die Gruppen erstellen/bearbeiten/löschen kann, die der Benutzer verwalten kann.
ManageMySchedule Boolean Ob dieser Benutzer nur für sich selbst Ereignisse im Zeitplan erstellen/bearbeiten/löschen kann.
ManageCompanySchedules Boolean Ob dieser Benutzer Ereignisse im Zeitplan für jeden Benutzer im Unternehmen erstellen/bearbeiten/löschen kann.
ManageNoSchedule Boolean Gibt an, ob dieser Benutzer im Zeitplan für keinen anderen Benutzer Ereignisse erstellen/bearbeiten/löschen kann.
ViewCompanySchedules Boolean Ob dieser Benutzer veröffentlichte Ereignisse im Zeitplan für jeden Benutzer im Unternehmen anzeigen kann.
ViewGroupSchedules Boolean Ob dieser Benutzer veröffentlichte Ereignisse im Zeitplan für die Gruppen anzeigen kann, deren Mitglied er ist.
ViewMySchedules Boolean Ob dieser Benutzer veröffentlichte Ereignisse im Zeitplan selbst anzeigen kann.

Gespeicherte Prozeduren

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

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

Jitterbit-Connector für gespeicherte TSheets-Prozeduren

Name Beschreibung
CreateInvitation Laden Sie einen oder mehrere Benutzer zu Ihrem Unternehmen ein.
DownloadFile Laden Sie die Datei im Rohbinärformat herunter.
GetOAuthAccessToken Ruft ein Authentifizierungstoken von TSheets ab.
GetOAuthAuthorizationURL Ruft die Autorisierungs-URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern das Authentifizierungstoken von dieser URL an.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen MSTeams-Diensten verwendet wird.
UpdateProjectActivityReadTime Aktualisieren Sie den Zeitpunkt des letzten Lesens für ein oder mehrere Projekte.
UploadFile Lädt die Datei hoch. Zulässig sind nur die Dateiformate .png, .jpeg und .jpg.

Einladung erstellen

Laden Sie einen oder mehrere Benutzer zu Ihrem Unternehmen ein.

Eingang
Name Typ Erforderlich Beschreibung
ContactMethod String Falsch Für die Einladung zu verwendende Methode, entweder „SMS“ oder „Email“.
ContactInfo String Falsch Die Email Adresse oder Mobiltelefonnummer, die dem durch den Parameter contact_method angegebenen Typ entspricht.
UserId String Falsch ID des einzuladenden Benutzers.
ContactAggregate String Falsch

Datei herunterladen

Laden Sie die Datei im Rohbinärformat herunter.

Gespeicherte Prozedurspezifische Informationen

TSheets erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:

EXECUTE DownloadFile FileId = '3688662', DownloadLocation = 'D:\Desktop'
Eingang
Name Typ Erforderlich Beschreibung
FileId String True Die Datei-ID.
DownloadLocation String Falsch Download-Speicherort.
Encoding String Falsch Der FileData-Eingabecodierungstyp. Die zulässigen Werte sind NONE, BASE64. Der Standardwert ist BASE64.
Ergebnissatzspalten
Name Typ Beschreibung
Status String Ausführungsstatus der gespeicherten Prozedur
FileData String Die FileData-Ausgabe

GetOAuthAccessToken

Holt ein Authentifizierungstoken von TSheets.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String Falsch Der zu verwendende Authentifizierungsmodustyp. Wählen Sie „App“, um Authentifizierungstoken über eine Desktop-App abzurufen. Wählen Sie „Web“, um Authentifizierungstoken über eine Web-App abzurufen. Die zulässigen Werte sind APP, WEB. Der Standardwert ist APP.
CallbackUrl String Falsch Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Legen Sie hier die HTTPS- URL fest, die Sie als „OAuth-Umleitungs-URI“ angegeben haben, als Sie Ihre App im TSheets API -Add-On eingerichtet haben.
Verifier String Falsch Der von Microsoft Entra ID zurückgegebene Prüfer, nachdem der Benutzer Ihrer App den Zugriff auf seine Daten autorisiert hat. Dieser Wert wird als Parameter an die Rückruf-URL zurückgegeben.
State String Falsch Eine beliebige Zeichenfolge Ihrer Wahl, die an Ihre App zurückgegeben wird. Ein erfolgreicher Roundtrip dieser Zeichenfolge stellt sicher, dass Ihre App die Anforderung initiiert hat. Der Standardwert ist Test.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Der Zugriffstoken, der für die Kommunikation mit TSheets verwendet wird.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft.
OAuthRefreshToken String Aktualisierungstoken zum Erneuern des Zugriffstokens.

GetOAuthAuthorizationURL

Ruft die Autorisierungs URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern das Authentifizierungstoken von dieser URL an.

Eingang
Name Typ Erforderlich Beschreibung
CallbackUrl String Falsch Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der HTTPS- URL übereinstimmen, die in Schritt 1 der Autorisierungsanforderung angegeben wurde.
State String Falsch Derselbe Statuswert, den Sie gesendet haben, als Sie den Autorisierungscode angefordert haben.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren.

Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen MSTeams-Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von der TSheets API zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.

Aktualisieren Sie die Projektaktivität, und lesen Sie die Zeit ein.

Aktualisieren Sie die letzte Lesezeit für ein oder mehrere Projekte.

Gespeicherte Prozedurspezifische Informationen

TSheets erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:

EXECUTE UpdateProjectActivityReadTime ProjectId = '10001'

EXECUTE UpdateProjectActivityReadTime ProjectId = '10001, 10002'
Eingang
Name Typ Erforderlich Beschreibung
ProjectId String True ID des Projekts. Wenn Sie mehrere Projekt-IDs haben, geben Sie diese bitte als durch Kommas getrennte Werte an.
Ergebnissatzspalten
Name Typ Beschreibung
Success String Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht.

Datei hochladen

Lädt die Datei hoch. Es sind nur die Dateiformate .png, .jpeg und .jpg zulässig.

Gespeicherte Prozedurspezifische Informationen

TSheets erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:

EXECUTE UploadFile FileLocation = 'D:\\Desktop\\Test.png'

EXECUTE UploadFile FileLocation = 'D:\Desktop\Test.png', FileDescription = 'Test file'
Eingang
Name Typ Erforderlich Beschreibung
FileLocation String Falsch Hochzuladende Datei.
FileName String Falsch Name der Datei. Wenn der Inhalt nicht leer ist.
FileDescription String Falsch Beschreibung dieser Datei.
ImageRotation Integer Falsch Ursprüngliche Bildausrichtung in Grad. Akzeptierte Werte sind: 0 (oben), 90 (rechts), 180 (unten), 270 (links). Die zulässigen Werte sind 0, 90, 180, 270.
Ergebnissatzspalten
Name Typ Beschreibung
Success String Wahr, wenn das Bild erfolgreich hochgeladen wurde.

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 TSheets 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, einschließlich Charge:

  • 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 „Timesheets“ zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Timesheets'
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 CreateInvitation zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateInvitation' 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 Tabelle „Timesheets“ ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Timesheets'
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:tsheets: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.

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://'.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
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
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
IncludeCustomFields Ein Boolescher Wert, der angibt, ob Sie benutzerdefinierte Felder in die Spaltenliste aufnehmen möchten.
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.
Pagesize Die maximale Anzahl der Ergebnisse, die pro Seite von TSheets zurückgegeben werden sollen.
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.

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://'.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
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 über 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 behalten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

%APPDATA%\TSheets 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 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_props Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

Der Standardspeicherort ist „%APPDATA%\TSheets 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

Rückruf-URL

Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

Datentyp

string

Standardwert

""

Hinweise

Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

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
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

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%\TSheets 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-Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (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%\TSheets 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
IncludeCustomFields Ein Boolescher Wert, der angibt, ob Sie benutzerdefinierte Felder in die Spaltenliste aufnehmen möchten.
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.
Pagesize Die maximale Anzahl der Ergebnisse, die pro Seite von TSheets zurückgegeben werden sollen.
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.

Benutzerdefinierte Felder einschließen

Ein Boolescher Wert, der angibt, ob Sie benutzerdefinierte Felder in die Spaltenliste aufnehmen möchten.

Datentyp

bool

Standardwert

true

Hinweise

Wenn Sie dies auf „true“ setzen, werden benutzerdefinierte Felder in die Spaltenliste aufgenommen, dies kann jedoch zu Leistungseinbußen beim Auflisten von Metadaten führen.

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.

Seitengröße

Die maximale Anzahl von Ergebnissen, die pro Seite von TSheets zurückgegeben werden sollen.

Datentyp

int

Standardwert

50

Hinweise

Der Pagesize Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von TSheets zurückgegeben werden. Das Festlegen eines höheren Wertes kann zu einer besseren Leistung führen, allerdings auf Kosten des zusätzlichen Speichers, der pro verbrauchter Seite zugewiesen wird.

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