Details zur Freshdesk-Verbindung

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8895 des Connectors.

Erste Schritte

Unterstützung der Freshdesk-Version

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

Herstellen einer Verbindung

Mit Freshdesk verbinden

Freshdesk verwendet eine Basisauthentifizierung. Um eine Verbindung zu Daten herzustellen, legen Sie die folgenden Verbindungseigenschaften fest:

• Domain: Legen Sie hier die Domäne fest, die mit Ihrem Freshdesk-Konto verknüpft ist. In Ihrer URL beispielsweise: https://{domainValue}.freshdesk.com, daher sollte die Verbindungszeichenfolge lauten:

  Domain=Domänenwert

• APIKey: Legen Sie hier den API Schlüssel fest, der mit Ihrem Freshdesk-Konto verknüpft ist. Um Ihren API Schlüssel abzurufen, melden Sie sich bei Ihrem Support-Portal an. Klicken Sie auf das Profilbild in der oberen rechten Ecke und wählen Sie profile settings page. Den API Schlüssel finden Sie unter change passwordAbschnitt rechts.

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 Freshdesk 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 die Verarbeitung der SELECT-Anweisung so weit wie möglich auf Freshdesk und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

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

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

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

Definieren von Ansichten mithilfe einer Konfigurationsdatei

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

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

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

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

Zum Beispiel:

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

Verwenden Sie die UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. 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 Freshdesk APIs.

Hauptmerkmale

• Der Connector modelliert Freshdesk Entitäten als relationale Tabellen, sodass Sie SQL schreiben können, um Freshdesk Daten Abfrage.
• Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem Freshdesk-Konto bei Verwendung des Connectors sofort angezeigt werden.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen. Tabellen werden statisch definiert, um Tickets, Gespräche, Agenten und mehr zu modellieren.

Tabellen

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

Freshdesk Connector-Tabellen

Agenten

Aktualisieren, Löschen und Abfrage aus der Agententabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Agents WHERE ID = 100

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren eines Agenten:

UPDATE Agents SET GroupIdsAggregate = '111' WHERE ID = 100

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen eines Agenten:

DELETE FROM Agents WHERE ID = 100

Spalten

Geschäftszeiten

Abfrage aus der Tabelle „BusinessHours“

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der Tabelle „BusinessHours“:

SELECT * FROM BusinessHours

Sie können auch einen bestimmten Eintrag aus der Tabelle „Geschäftszeiten“ auswählen:

SELECT * FROM BusinessHours WHERE ID = 100

Spalten

Vorgefertigte Antworten

Erstellen, Aktualisieren und Abfrage der Tabelle „CannedResponses“

Tabellenspezifische Informationen

Wählen

Um die Tabelle CannedResponses Abfrage, muss FolderId in der WHERE-Klausel erwähnt werden. Beispiel:

SELECT * FROM CannedResponses WHERE FolderId = 100

Einfügen

FolderId, Visibility, Title und ContentHTML sind Pflichtspalten zum Einfügen in CannedResponses-Tabellen. Beispiel:

INSERT INTO CannedResponses (Title, ContentHTML, Visibility, FolderId) VALUES (Sample response, 'this is also a new sample response', 0, 100)

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Zeile in der Tabelle „CannedResponses“:

UPDATE CannedResponses SET Title = 'Updated title' WHERE ID = 100

Spalten

Ordner mit vorgefertigten Antworten

Abfrage aus der Tabelle „CannedResponsesFolder“

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der Tabelle „CannedResponsesFolder“:

SELECT * FROM CannedResponsesFolder

Sie können auch einen bestimmten Eintrag aus der Tabelle „CannedResponsesFolder“ auswählen:

SELECT * FROM CannedResponsesFolder WHERE ID = 100

Einfügen

Name ist eine Pflichtspalte zum Einfügen in die Tabelle CannedResponsesFolder.

INSERT INTO CannedResponsesFolder (Name) VALUES (directoryA)

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren von CannedResponsesFolder:

UPDATE CannedResponsesFolder SET Name = 'updated name' WHERE ID = 100

Spalten

Unternehmen

Erstellen, Aktualisieren, Löschen und Abfrage aus der Firmentabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Companies WHERE CreatedAt >= '2017-10-01' AND CreatedAt <= '2017-10-07'

Die API erlaubt nur die Verwendung einer Teilmenge von Spalten als Filterkriterien in der WHERE-Klausel. Die folgenden Spalten können verwendet werden:

• Ausweis
• Domänenaggregat
• Erstellt am
• Aktualisiert am

WHERE CreatedAt >= '2019-09-22' AND CreatedAt <= '2019-09-24'

Einfügen

Der Name ist für die Gründung eines neuen Unternehmens obligatorisch. Nachfolgend finden Sie ein Beispiel für die Gründung eines neuen Unternehmens:

INSERT INTO Companies (Name, Description) VALUES ('Example', 'Example description of new company')

Aktualisieren

Nachfolgend finden Sie ein Beispiel für die Aktualisierung eines Unternehmens:

UPDATE Companies SET Description = 'New description' WHERE ID = 786

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Tabelle „Unternehmen“:

DELETE FROM Companies WHERE ID = 786

Spalten

Kontakte

Erstellen, Aktualisieren, Löschen und Abfrage aus der Kontakttabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Contacts WHERE Active = false AND (Email = 'example@cdata.com' OR CompanyId = 1)

Die API erlaubt nur die Verwendung einer Teilmenge von Spalten als Filterkriterien in der WHERE-Klausel. Die folgenden Spalten können verwendet werden:

• Ausweis
• Aktiv
• Firmen-ID
• E Email
• Sprache
• Etikett
• Zeitzone
• Erstellt am
• Aktualisiert am

WO Erstellt am >= '2019-09-22' UND Erstellt am <= '2019-09-24'

Einfügen

Name und Email sind beim Erstellen eines neuen Kontakts obligatorisch. Nachfolgend sehen Sie ein Beispiel zum Erstellen eines neuen Kontakts:

INSERT INTO Contacts (Name, Email, Language) VALUES ('Example', 'example@cdata.com', 'English')

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren eines Kontakts:

UPDATE Contacts SET Active = true WHERE ID = 786

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Tabelle „Kontakte“:

DELETE FROM Contacts WHERE ID = 786

Spalten

Gespräche

Löschen und Abfrage aus der Konversationstabelle

Tabellenspezifische Informationen

Wählen

Um die Tabelle „Conversations“ Abfrage, muss TicketId in der WHERE-Klausel angegeben werden. Beispiel:

SELECT * FROM Conversations WHERE TicketId = 100

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Konversationstabelle:

DELETE FROM Conversations WHERE ID = 786

Spalten

Gruppen

Erstellen, Aktualisieren, Löschen und Abfrage aus der Gruppentabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Groups WHERE ID = 100

Einfügen

Name ist eine Pflichtspalte zum Einfügen in die Gruppentabelle. Beispiel:

INSERT INTO Groups (Name, Description, AutoTicketAssign) VALUES ('Example', 'Example Description...', false)

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Gruppe:

UPDATE Groups SET Description = 'New description...' WHERE ID = 100

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Gruppentabelle:

DELETE FROM Groups WHERE ID = 786

Spalten

Postfächer

Erstellen, Aktualisieren, Löschen und Abfrage aus der Postfachtabelle

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der Mailbox-Tabelle:

SELECT * FROM Mailboxes

Die API erlaubt nur die Verwendung einer Teilmenge von Spalten als Filterkriterium in der WHERE-Klausel. Die aufgelisteten Filter können auch mit AND OR kombiniert werden. Folgende Spalten können verwendet werden:

• Ausweis
• Support-E-Mail
• E-Mail weiterleiten
• Produkt-ID
• Gruppen-ID
• Aktiv

Einfügen

SupportEmail und MailboxType müssen in die Mailboxes-Tabelle eingefügt werden. Zum Beispiel:

INSERT INTO Mailboxes (SupportEmail, Name, MailboxType) VALUES ('testemail@gmail.com', 'Test', 'freshdesk_mailbox')

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren der Mailbox-Tabelle:

UPDATE Mailboxes SET Name = 'Test mailbox' WHERE ID = 786

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Mailbox-Tabelle:

DELETE FROM Mailboxes WHERE ID = 786

Spalten

Produkte

Abfrage aus der Produkttabelle

Tabellenspezifische Informationen

Wählen

Nachfolgend sehen Sie ein Beispiel für die Auswahl aller Einträge aus der Tabelle „Produkte“:

SELECT * FROM Products

Sie können auch einen bestimmten Eintrag aus der Produkttabelle auswählen:

SELECT * FROM Products WHERE ID = 100

Spalten

Rollen

Abfrage aus der Rollentabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Roles WHERE ID = 100

Spalten

Fähigkeiten

Erstellen, Aktualisieren, Löschen und Abfrage der Fähigkeitentabelle

Tabellenspezifische Informationen

Wählen

Nachfolgend sehen Sie ein Beispiel für die Auswahl aller Einträge aus der Tabelle „Skills“:

SELECT * FROM Skills

Sie können auch einen bestimmten Eintrag aus der Fähigkeitentabelle auswählen:

SELECT * FROM Skills WHERE ID = 73000001322

Einfügen

Der Name ist für die Erstellung einer neuen Fertigkeit obligatorisch. Nachfolgend finden Sie ein Beispiel für die Erstellung einer neuen Fertigkeit:

INSERT INTO Skills (Name) VALUES ('Example')

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren einer Fertigkeit:

UPDATE Skills SET Name = 'New name' WHERE ID = 73000001322

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen aus der Skills-Tabelle:

DELETE FROM Skills WHERE ID = 73000001322

Spalten

SLA-Richtlinien

SLAPolicies-Tabelle abfragen, erstellen und aktualisieren

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der SLAPolicies-Tabelle:

SELECT * FROM SLAPolicies

Sie können auch einen bestimmten Eintrag aus der SLAPolicies-Tabelle auswählen:

SELECT * FROM SLAPolicies WHERE ID = 100

Spalten

Umfragen

Abfrage aus der Umfragetabelle

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der Umfragetabelle:

SELECT * FROM Surveys

Sie können auch einen bestimmten Eintrag aus der Umfragetabelle auswählen:

SELECT * FROM Surveys WHERE ID = 73000092562

Spalten

TicketFelder

Abfrage aus der TicketFields-Tabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen clientseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird serverseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM TicketFields WHERE Type = 'default_requester'

Die Freshdesk API erlaubt nur die Verwendung der folgenden Spalten als Filterkriterien in der WHERE-Klausel:

• Typ

Einfügen

Label, LabelForCustomers und Type sind Pflichtspalten zum Einfügen in die TicketFields-Tabelle.

INSERT INTO TicketFields (Label, LabelForCustomers, Type) VALUES ('labelA', 'labelA', custom_text)

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren von Ticketfeldern:

UPDATE TicketFields SET Label = 'updated label' WHERE ID = 100

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen eines Ticketfelds:

DELETE FROM TicketFields WHERE ID = 100

Spalten

Tickets

Erstellen, Aktualisieren, Löschen und Abfrage aus der Tickettabelle

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Freshdesk API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Die meisten Spalten unterstützen serverseitiges Filtern mit den folgenden Operatoren: =,>,<,<=,>=,AND,OR. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:

SELECT * FROM Tickets WHERE Status = 2 AND (Priority = 1 OR Type = 'Other')

Die API erlaubt nur die Verwendung einer Teilmenge von Spalten als Filterkriterien in der WHERE-Klausel. Die folgenden Spalten können verwendet werden:

• Ausweis
• Agenten-ID
• Gruppen-ID
• Priorität
• Status
• Etikett
• Typ
• Fällig durch
• Erste Antwort fällig durch
• Erstellt am
• Aktualisiert am

Einfügen

Email, Betreff, Beschreibung, Gruppen-ID, Status und Priorität sind Pflichtfelder zum Einfügen/Erstellen eines neuen Tickets.

Jedes Ticket verwendet feste numerische Werte, um seinen Status und seine Priorität anzugeben. Numerische Werte werden wie folgt angegeben:

Status:

• Offen = 2
• Ausstehend = 3
• Gelöst = 4
• Geschlossen = 5

Priorität:

• Niedrig = 1
• Mittel = 2
• Hoch = 3
• Dringend = 4

Ein neues Ticket kann wie folgt erfasst werden:

INSERT INTO Tickets (Description, Subject, Email,  GroupId, Status, Priority) VALUES ('Details about the issue...', 'New support needed...', 'example@cdata.com', 12345, 3, 2)

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren eines Tickets:

UPDATE Tickets SET Priority = 1 WHERE ID = 100

Löschen

Nachfolgend finden Sie ein Beispiel zum Löschen eines Tickets:

DELETE FROM Tickets WHERE ID = 100

Spalten

Zeiteinträge

Erstellen, Aktualisieren, Löschen und Abfrage aus der Tabelle „TimeEntries“

Tabellenspezifische Informationen

Wählen

Nachfolgend sehen Sie ein Beispiel zum Auswählen aller Einträge aus der Tabelle TimeEntries:

SELECT * FROM TimeEntries

Die API erlaubt nur die Verwendung einer Teilmenge von Spalten als Filterkriterien in der WHERE-Klausel. Die folgenden Spalten können verwendet werden:

• Agenten-ID
• Abrechenbar
• Ausgeführt am

Einfügen

TicketId muss zwingend in die Tabelle TimeEntries eingefügt werden. Beispiel:

INSERT INTO TimeEntries (TicketId, Note, AgentId) VALUES ('255', 'Invoice Information', '122')

Notiz:

• Die Ticket-ID ist ein Pflichtfeld zum EINFÜGEN in die Tabelle „TimeEntries“.
• Der Standardwert für „Abrechnungsfähig“ ist „true“.
• Wenn das Attribut „TimeSpent“ und das Attribut „TimerRunning“ nicht angegeben sind, wird das Attribut „TimerRunning“ automatisch auf „true“ gesetzt.
• Wenn die StartTime angegeben ist, das TimerRunning-Attribut jedoch nicht, wird das TimerRunning-Attribut automatisch auf „true“ gesetzt.
• Die Startzeit kann nicht größer sein als die aktuelle Zeit.
• Die StartTime kann in der Abfrage nicht angegeben werden, wenn das Attribut TimerRunning auf „false“ gesetzt ist.

Aktualisieren

Nachfolgend finden Sie ein Beispiel zum Aktualisieren der Tabelle TimeEntries:

UPDATE TimeEntries SET Billable = 'true' WHERE ID = 786

Hinweis:

• Die Startzeit kann nicht aktualisiert werden, wenn der Timer bereits läuft.
• Die Startzeit kann nicht aktualisiert werden, es sei denn, das Attribut timer_running wird von „true“ auf „false“ aktualisiert.
• Die Startzeit kann nicht größer als die aktuelle Zeit sein.
• Das Attribut TimerRunning kann nicht auf denselben Wert wie zuvor gesetzt werden.
• Die AgentId kann nicht aktualisiert werden, wenn der Timer bereits läuft.

Löschen

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

DELETE FROM TimeEntries WHERE ID = 786

Spalten

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.

Freshdesk Connector-Ansichten

Benutzerdefinierte Objekte

Rufen Sie die verfügbaren benutzerdefinierten Objekte in FreshDesk ab.

Tabellenspezifische Informationen

Wählen

Nachfolgend finden Sie ein Beispiel zum Auswählen aller Einträge aus der Tabelle „CustomObjects“:

SELECT * FROM CustomObjects

Sie können auch einen bestimmten Eintrag aus der CustomObjects-Tabelle auswählen:

SELECT * FROM CustomObjects WHERE ID = 11704

Spalten

TicketAktivitäten

Fragen Sie die TicketActivities-Ansicht ab.

Tabellenspezifische Informationen

Wählen

Nachfolgend sehen Sie ein Beispiel zum Auswählen aller Einträge aus der TicketActivities-Tabelle:

SELECT * FROM TicketActivities

Spalten

Ticketeigenschaften

Fragen Sie die TicketProperties-Ansicht ab.

Spalten

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Freshdesk Connector

An Ticket anhängen

Erstellen oder aktualisieren Sie ein Ticket mit Anhängen.

Um ein vorhandenes Ticket zu bearbeiten, geben Sie einen Wert für die ID-Spalte ein:

EXEC AttachToTicket ID = 100000 FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

Sie können neben dem Hinzufügen von Anhängen auch Ticketfelder angeben, um das Ticket zu aktualisieren:

EXEC AttachToTicket ID = 100000, Status = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

Wenn Sie keinen Wert für die ID-Spalte angeben, erstellt der Connector ein neues Ticket mit den angegebenen Werten. Sie müssen mindestens eine Email, eine Beschreibung, einen Betreff, einen Status und eine Priorität angeben. Abhängig von den Ticketregeln, die in Ihrem Freshdesk-Konto eingerichtet sind, können für die Ticketerstellung andere Felder erforderlich sein.

EXEC AttachToTicket Email = 'test@company.com', Description = 'Sample Description', GroupId = 2222222222222, Status = 3, Subject = 'Testing', Priority = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

Eingang

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 Freshdesk zurück:

• sys_catalogs: Listet die verfügbaren Datenbanken auf.
• sys_schemas: Listet die verfügbaren Schemata auf.
• sys_tables: Listet die verfügbaren Tabellen und Ansichten auf.
• sys_tablecolumns: Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
• sys_procedures: Beschreibt die verfügbaren gespeicherten Prozeduren.
• sys_procedureparameters: Beschreibt Parameter gespeicherter Prozeduren.
• sys_keycolumns: Beschreibt die Primär- und Fremdschlüssel.
• sys_indexes: Beschreibt die verfügbaren Indizes.

Datenquellentabellen

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

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

Abfrageinformationstabellen

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

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

Sys_catalogs

Listet die verfügbaren Datenbanken auf.

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

SELECT * FROM sys_catalogs

Spalten

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas

Spalten

Sys_tables

Listet die verfügbaren Tabellen auf.

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

SELECT * FROM sys_tables

Spalten

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tickets'

Spalten

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

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

SELECT * FROM sys_procedures

Spalten

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Spalten

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Tabelle „Tickets“ ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tickets'

Spalten

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

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

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

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:freshdesk: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

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.

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

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

Systeminformationen

Beschreibt die verfügbaren Systeminformationen.

Die folgende Abfrage ruft alle Spalten ab:

SELECT * FROM sys_information

Spalten

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.

Authentifizierung

SSL

Schema

Verschiedenes

Authentifizierung

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

Domain

Die Domäne wird für den Zugriff auf Ihr Freshdesk-Konto verwendet.

Datentyp

string

Standardwert

""

Hinweise

Die Domäne wird für den Zugriff auf Ihr Freshdesk-Konto verwendet. In Ihrer URL beispielsweise: https://** {Domänenwert}**.freshdesk.com, daher sollte die Verbindungszeichenfolge wie folgt lauten:

Domain=Domänenwert

APISchlüssel

Der API Schlüssel für den Zugriff auf Ihr Freshdesk-Konto.

Datentyp

string

Standardwert

""

Hinweise

Der API Schlüssel, der für den Zugriff auf Ihr Freshdesk-Konto verwendet wird. Den API Schlüssel finden Sie in Freshdesk unter „Profileinstellungen -> API Schlüssel“.

SSL

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

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:

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.

Standort

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

Datentyp

string

Standardwert

%APPDATA%\FreshDesk 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%\FreshDesk Data Provider\Schema“ mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

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.

FetchTicketsAktualisiertSeit

Verwenden Sie FetchTicketsUpdatedSince, um Tickets Abfrage, die älter als 30 Tage sind. Hinweis: TicketStats muss auf True gesetzt sein.

Datentyp

string

Standardwert

""

Hinweise

Wenn TicketStats = true ist, werden alle Anfragen (einschließlich Filteranfragen) an den Endpoint„Alle auflisten“ gesendet. Der Endpoint „Alle auflisten“ ruft nur die in den letzten 30 Tagen erstellten Tickets ab, es sei denn, FetchTicketsUpdatedSince ist auf ein bestimmtes Datum eingestellt. Setzen Sie FetchTicketsUpdatedSince auf ein bestimmtes Datum, um Tickets abzurufen, die in den letzten 30 Tagen erstellt wurden. (Beispiel: FetchTicketsUpdatedSince=2022-01-01 oder FetchTicketsUpdatedSince=2022-01-01T00:00:00Z)

Überschüssige Ergebnisse ignorieren

Verwenden Sie IgnoreSurplusResults, um Ergebnisse über 300 zu ignorieren, die denselben „CreatedAt“-Wert haben.

Datentyp

bool

Standardwert

false

Hinweise

Standardmäßig gibt die FreshDesk API nur bis zu 300 Ergebnisse zurück, die einem bestimmten Filter entsprechen. Der Paging-Mechanismus des Treiber verwendet das Attribut „CreatedAt“ als Filter. Daher führen mehr als 300 Ergebnisse mit demselben CreateAt-Wert dazu, dass das Paging fehlschlägt. „IgnoreSurplusResults“ bewirkt, dass diese überzähligen Ergebnisse ignoriert werden, ohne eine Ausnahme auszulösen, und weiterhin Ergebnisse abgerufen werden.

Benutzerdefinierte Objekte einschließen

Ob benutzerdefinierte Objekte einbezogen werden sollen oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Wenn der Wert auf TRUE gesetzt ist, werden die benutzerdefinierten Objekte abgerufen. Hinweis: Um diese Eigenschaft verwenden zu können, muss die Funktion „Benutzerdefinierte Objekte“ aktiviert sein.

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

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. „*=*“.

Zeilenscantiefe

Legen Sie diese Eigenschaft fest, um die Anzahl der gescannten Zeilen zu steuern, wenn TypeDetectionScheme auf RowScan eingestellt ist.

Datentyp

string

Standardwert

30

Hinweise

Bestimmt die Anzahl der Zeilen, die zur Bestimmung der Spaltendatentypen verwendet werden.

Das Festlegen eines hohen Wertes kann die Leistung beeinträchtigen. Das Festlegen eines niedrigen Wertes kann dazu führen, dass der Datentyp nicht richtig bestimmt wird, insbesondere wenn Nulldaten vorhanden sind.

TicketEigenschaftenURL

Verwenden Sie TicketPropertiesURL, um Ticketeigenschaften Abfrage.

Datentyp

string

Standardwert

""

Hinweise

Setzen Sie TicketPropertiesURL auf die API URL, die auf der Seite „Zeitplan“ des erstellten geplanten Exports zu finden ist. Um diese zu finden, gehen Sie zu „Berichte/Export planen/Klicken Sie auf den Namen des Zeitplans“ und die URL befindet sich im Abschnitt „Empfangen über API“.

TicketStats

Verwenden Sie TicketsStats, um Statistikattribute eines Tickets abzurufen, die normalerweise nicht verfügbar sind.

Datentyp

bool

Standardwert

false

Hinweise

Wenn TicketStats = true ist, werden alle Anfragen (einschließlich Filteranfragen) an den Endpoint„Alles auflisten“ gesendet. Dies würde die Leistung leicht beeinträchtigen, da die Filterung clientseitig erfolgt, würde aber die Statistikattribute jedes Tickets abrufen. Der Endpoint „Alles auflisten“ ruft nur die in den letzten 30 Tagen erstellten Tickets ab.

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.

Typerkennungsschema

Bestimmt, wie der Datentyp von Spalten ermittelt wird.

Mögliche Werte

None, RowScan

Datentyp

string

Standardwert

RowScan

Hinweise

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 Tickets WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

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