ServiceNow Verbindungsdetails
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.
Weitere Informationen zum Herstellen einer Verbindung finden Sie unter ServiceNow-Verbindung.
Eigenschaft | Beschreibung |
---|---|
Authentifizierungsschema | Das Autorisierungsschema, das verwendet werden soll, wenn eine Serverautorisierung durchgeführt werden soll. |
URL | Die Basis URL Ihrer ServiceNow Instanz. |
Benutzer | Das zur Authentifizierung verwendete ServiceNow Benutzerkonto. |
Passwort | Das zur Authentifizierung des Benutzers verwendete Kennwort. |
Eigenschaft | Beschreibung |
---|---|
SSOLoginURL | Die Anmelde URL des Identitätsanbieters. |
SSO-Eigenschaften | Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste. |
Eigenschaft | Beschreibung |
---|---|
OAuth initiieren | 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. |
OAuthZugriffstoken | 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 eingestellt ist. Alternativ kann dies im Speicher gehalten werden, indem ein Wert angegeben wird, der mit memory:// beginnt. |
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. |
OAuthGrantType | Der Berechtigungstyp für den OAuth-Flow. |
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. |
Eigenschaft | Beschreibung |
---|---|
SSLServerZertifikat | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
Eigenschaft | Beschreibung |
---|---|
FirewallTyp | Das von einer Proxy-basierten Firewall verwendete Protokoll. |
FirewallServer | Der Name oder die IP-Adresse einer Proxy-basierten Firewall. |
FirewallPort | Der TCP- Port für eine Proxy-basierte Firewall. |
FirewallBenutzer | Der Benutzername, der zur Authentifizierung bei einer Proxy-basierten Firewall verwendet werden soll. |
FirewallPasswort | Ein Kennwort zur Authentifizierung bei einer Proxy-basierten Firewall. |
Eigenschaft | Beschreibung |
---|---|
ProxyAutoDetect | Wenn diese Verbindungseigenschaft auf „true“ gesetzt ist, prüft der Anbieter Ihre Systemproxyeinstellungen auf vorhandene Proxyserverkonfigurationen (Proxyserverdetails müssen nicht manuell angegeben werden). Setzen Sie diese Eigenschaft auf „false“, wenn Sie den Anbieter manuell für die Verbindung mit einem bestimmten Proxyserver konfigurieren möchten. |
ProxyServer | Der Hostname oder die IP-Adresse des Proxyservers, über den Sie den HTTP-Verkehr Route möchten. |
ProxyPort | Der TCP- Port, auf dem der Proxyserver (angegeben in der Verbindungseigenschaft „ProxyServer“) ausgeführt wird. |
ProxyAuthentifizierungsschema | Die Authentifizierungsmethode, die der Anbieter bei der Authentifizierung gegenüber dem in der Verbindungseigenschaft „ProxyServer“ angegebenen Proxyserver verwendet. |
ProxyBenutzer | Der Benutzername eines Benutzerkontos, das bei dem in der Verbindungseigenschaft „ProxyServer“ angegebenen Proxyserver registriert ist. |
ProxyPasswort | Das Kennwort, das dem in der Verbindungseigenschaft „ProxyUser“ angegebenen Benutzer zugeordnet ist. |
ProxySSLTyp | Der für die Verbindung mit dem ProxyServer-Proxy zu verwendende SSL-Typ. |
ProxyExceptions | Eine durch Semikolon getrennte Liste von Ziel-Hostnamen oder IPs, die von der Verbindung über den Proxyserver ausgenommen sind. |
Eigenschaft | Beschreibung |
---|---|
Logdatei | Ein Dateipfad, der den Namen und den Speicherort der Protokolldatei angibt. |
Ausführlichkeit | Die Ausführlichkeitsstufe, die den Detailumfang der Protokolldatei bestimmt. |
LogModule | In die Protokolldatei aufzunehmende Kernmodule. |
MaximaleLogdateigröße | Eine Zeichenfolge, die die maximale Größe einer Protokolldatei in Bytes angibt (z. B. 10 MB). |
MaxLogFileCount | Eine Zeichenfolge, die die maximale Dateianzahl der Protokolldateien angibt. |
Eigenschaft | Beschreibung |
---|---|
Standort | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
DurchsuchbareSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tabellen | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC. |
Ansichten | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC. |
Datenbankansichten einschließen | Steuert, ob die Datenbankansichten angezeigt werden oder nicht. |
Systemtabellen einschließen | Steuert, ob die Systemtabellen verfügbar gemacht werden oder nicht. |
Eigenschaft | Beschreibung |
---|---|
AutoCache | Speichert die Ergebnisse von SELECT-Abfragen automatisch in einer Cache-Datenbank zwischen, die entweder durch CacheLocation oder durch CacheConnection und CacheProvider angegeben wird. |
Cache-Treiber | Der Driver, der zum Zwischenspeichern von Daten verwendet wird. |
CacheVerbindung | Die Verbindungszeichenfolge für die Cache-Datenbank. Diese Eigenschaft wird immer in Verbindung mit CacheProvider verwendet. Wenn Sie beide Eigenschaften festlegen, wird der für CacheLocation festgelegte Wert zum Zwischenspeichern von Daten überschrieben. |
Cache-Speicherort | Gibt den Pfad zum Cache an, wenn in eine Datei zwischengespeichert wird. |
CacheToleranz | Die in Sekunden angegebene Toleranz für veraltete Daten im Cache bei Verwendung von AutoCache. |
Offline | Verwenden Sie den Offlinemodus, um die Daten aus dem Cache statt aus der Livequelle abzurufen. |
CacheMetadata | Diese Eigenschaft legt fest, ob die Metadaten der Tabelle in einem Dateispeicher zwischengespeichert werden oder nicht. |
Eigenschaft | Beschreibung |
---|---|
PushEmptyValuesAsNull | Gibt an, ob die leeren Werte als leer oder als null gelesen werden sollen. |
Eigenschaft | Beschreibung |
---|---|
Batchgröße | Die maximale Größe jedes zu Operation. |
Verbindungslebensdauer | Die maximale Lebensdauer einer Verbindung in Sekunden. Nach Ablauf der Zeit wird das Verbindungsobjekt verworfen. |
VerbindenBeimÖffnen | Diese Eigenschaft gibt an, ob beim Öffnen der Verbindung eine Verbindung zu ServiceNow hergestellt werden soll. |
Anzeigewert | Basierend auf diesem Wert ruft der Anbieter den Anzeigewert oder den tatsächlichen Wert aus der Datenbank ab. |
AnzeigewertSpaltenname | Muster zum Anzeigen von Spaltennamen, wenn die DisplayValue-Eigenschaft auf ALL gesetzt ist. |
Spaltenwerte erzwingen | Steuert, ob beim Ausführen von INSERT- oder UPDATE-Anweisungen verfügbare Werte für ein Element abgerufen und überprüft werden. |
ExcludeReferenceLink | Basierend auf diesem Wert werden die für Referenzfelder bereitgestellten Zusatzinformationen unterdrückt oder nicht. |
GetColumnsMetadata | Gibt die Benutzerpräferenz an, wann und wie der Anbieter die Spaltenmetadaten abrufen soll. |
MaxZeilen | 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. |
Seitengröße | Die maximale Anzahl der Ergebnisse, die pro Seite von ServiceNow zurückgegeben werden sollen. |
PoolIdleTimeout | Die zulässige Leerlaufzeit einer Verbindung, bevor sie geschlossen wird. |
Maximale Poolgröße | Die maximale Anzahl an Verbindungen im Pool. |
Mindestgröße des Pools | Die Mindestanzahl an Verbindungen im Pool. |
PoolWartezeit | Die maximale Wartezeit in Sekunden auf eine verfügbare Verbindung. |
Pseudospalten | Geben Sie einen Satz von Pseudospalten an, die als Spalten angezeigt werden sollen. |
Schreibgeschützt | Sie können diese Eigenschaft verwenden, um vom Anbieter schreibgeschützten Zugriff auf ServiceNow zu erzwingen. |
RTK | Der für die Lizenzierung verwendete Laufzeit Schlüssel. |
Beschreibungen anzeigen | Steuert, ob Spalten- und Tabellenbeschreibungen über die API Endpoints sys_documentation und sys_db_object zurückgegeben werden. |
Zeitüberschreitung | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
Verbindungspooling verwenden | Diese Eigenschaft aktiviert das Verbindungspooling. |
UseDisplayTableNames | Boolescher Wert, der bestimmt, ob die Anzeigenamen für die Tabelle statt der API -Namen verwendet werden sollen. |
BenutzerdefinierteAnsichten | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Authentifizierungsschema | Das Autorisierungsschema, das verwendet werden soll, wenn eine Serverautorisierung durchgeführt werden soll. |
URL | Die Basis URL Ihrer ServiceNow Instanz. |
Benutzer | Das zur Authentifizierung verwendete ServiceNow Benutzerkonto. |
Passwort | Das zur Authentifizierung des Benutzers verwendete Kennwort. |
AuthScheme
Das Autorisierungsschema, das verwendet werden soll, wenn eine Serverautorisierung durchgeführt werden soll.
Mögliche Werte
Basic, OAuth, OAuthPassword, OKTA, ADFS, OneLogin, PingFederate
Datentyp
Zeichenfolge
Standardwert
"Grundlegend"
Hinweise
Diese Eigenschaft gibt die Art der durchzuführenden Authentifizierung an. Mögliche Werte sind:
-
Basic: Legen Sie dies fest, um die Basisauthentifizierung zu verwenden.
-
OAuth: Legen Sie dies fest, um die OAuth-Authentifizierung durchzuführen.
-
OAuthPassword: Legen Sie dies fest, um die OAuth-Authentifizierung mit GrantType Password durchzuführen.
AuthScheme ist standardmäßig auf Basic eingestellt. Der Connector führt die OAuth-Authentifizierung durch, wenn AuthScheme auf OAuth oder OAuthAccessToken eingestellt ist-Eigenschaft ist festgelegt.
Die folgenden Optionen sind für SSO verfügbar:
- OKTA: Festlegen, um eine Single-Sign-On-Verbindung mit OKTA als Identitätsanbieter zu verwenden.
- ADFS: Festlegen, um eine Single-Sign-On-Verbindung mit ADFS als Identitätsanbieter zu verwenden.
- OneLogin: Festlegen, um eine Single-Sign-On-Verbindung mit OneLogin als Identitätsanbieter zu verwenden.
- PingFederate: Festlegen, um eine Single-Sign-On-Verbindung mit PingFederate als Identitätsanbieter zu verwenden.
URL
Die Basis URL Ihrer ServiceNow Instanz.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Legen Sie die Basis URL Ihrer ServiceNow Instanzsite fest. Beispiel: https://dev47813.service-now.com/
.
Benutzer
Das zur Authentifizierung verwendete ServiceNow Benutzerkonto.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Zusammen mit Passwort, wird dieses Feld zur Authentifizierung gegenüber dem ServiceNow Server verwendet.
Passwort
Das zur Authentifizierung des Benutzers verwendete Passwort.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Der Benutzer und Passwort werden zusammen zur Authentifizierung beim Server verwendet.
SSO
Dieser Abschnitt enthält eine vollständige Liste der SSO-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
SSOLoginURL | Die Anmelde URL des Identitätsanbieters. |
SSO-Eigenschaften | Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste. |
SSOLoginURL
Die Anmelde-URL des Identitätsanbieters.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Die Anmelde-URL des Identitätsanbieters.
SSO-Eigenschaften
Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste. wird in Verbindung mit der SSOLoginURL verwendet.
Die SSO-Konfiguration wird ausführlicher in CDatas Herstellen einer Verbindung erläutert Dokumentation.
OAuth
Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
OAuth initiieren | 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. |
OAuthZugriffstoken | 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 eingestellt ist. Alternativ kann dies im Speicher gehalten werden, indem ein Wert angegeben wird, der mit memory:// beginnt. |
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. |
OAuthGrantType | Der Berechtigungstyp für den OAuth-Flow. |
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
AUS, GETANDREFRESH, AKTUALISIEREN
Datentyp
Zeichenfolge
Standardwert
"AUS"
Hinweise
Die folgenden Optionen sind verfügbar:
- OFF: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.
- GETANDREFRESH: Gibt an, dass der gesamte OAuth-Flow vom Connector gehandhabt wird. Wenn derzeit kein Token vorhanden ist, wird es abgerufen, indem der Benutzer über den Browser dazu aufgefordert wird. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.
- REFRESH: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessTokens übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessTokens und des OAuthRefreshTokens übernehmen.
OAuthClientId
Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie den 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
Zeichenfolge
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 in der Eigenschaft OAuthClientSecret fest.
OAuth-Zugriffstoken
Der Zugriffstoken für die Verbindung per OAuth.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Die Eigenschaft OAuthAccessToken wird zum Herstellen einer Verbindung über OAuth verwendet. Das OAuthAccessToken wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es verfügt über 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 kann dies im Speicher gehalten werden, indem ein Wert angegeben wird, der mit memory:// beginnt.
Datentyp
Zeichenfolge
Standardwert
„%APPDATA%\ ServiceNow Datenanbieter\OAuthSettings.txt“
Hinweise
Wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist, speichert der Connector OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen für mehrere Verbindungen oder Prozesse gemeinsam genutzt werden können.
Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit „memory://“ beginnt, 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. Anders als bei dateibasiertem Speicher, bei dem die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen beim Speicher in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an die Systemtabelle sys_connection_props abrufen. Wenn mehrere Verbindungen dieselben Anmeldeinformationen verwenden, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.
Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\ ServiceNow Data Provider\OAuthSettings.txt“, wobei %APPDATA% auf das Konfigurationsverzeichnis des Benutzers eingestellt ist:
Plattform | %APPDATA%-Standort |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Library/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
Zeichenfolge
Standardwert
http://localhost:33333
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.
OAuthGrantType
Der Berechtigungstyp für den OAuth-Flow.
Mögliche Werte
CODE, PASSWORT
Datentyp
Zeichenfolge
Standardwert
"CODE"
Hinweise
Der Berechtigungstyp für den OAuth-Flow. Folgende Optionen sind verfügbar: CODE, PASSWORT
OAuthVerifier
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
Datentyp
Zeichenfolge
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 CDatas Herstellen einer Verbindung Dokumentation, um den OAuthVerifier-Wert zu erhalten.
Legen Sie OAuthSettingsLocation fest zusammen mit OAuthVerifier. Wenn Sie eine Verbindung herstellen, tauscht der Connector den OAuthVerifier gegen die OAuth-Authentifizierungstoken aus und speichert sie verschlüsselt in der angegebenen Datei. Setzen Sie InitiateOAuth, um den Austausch mit GETANDREFRESH zu automatisieren.
Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie OAuthVerifier aus den Verbindungseigenschaften entfernen und eine Verbindung mit OAuthSettingsLocation herstellen 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
Zeichenfolge
Standardwert
""
Hinweise
Die Eigenschaft OAuthRefreshToken wird zum Aktualisieren des OAuthAccessToken verwendet bei Verwendung der OAuth-Authentifizierung.
OAuthLäuftAbIn
Die Lebensdauer des OAuth AccessToken in Sekunden.
Datentyp
Zeichenfolge
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
Zeichenfolge
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 |
---|---|
SSLServerZertifikat | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
SSLServerCert
Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.
Datentyp
Zeichenfolge
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----- MIIIChTCCAe4CAQAwDQYJKoZIhv......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 (Hex-Werte 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.
Firewall
Dieser Abschnitt enthält eine vollständige Liste der Firewall Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Firewalltyp | Das von einer Proxy-basierten Firewall verwendete Protokoll. |
FirewallServer | Der Name oder die IP-Adresse einer Proxy-basierten Firewall. |
FirewallPort | Der TCP- Port für eine Proxy-basierte Firewall. |
FirewallBenutzer | Der Benutzername, der zur Authentifizierung bei einer Proxy-basierten Firewall verwendet werden soll. |
FirewallPasswort | Ein Kennwort zur Authentifizierung bei einer Proxy-basierten Firewall. |
Firewall-Typ
Das von einer Proxy-basierten Firewall verwendete Protokoll.
Mögliche Werte
KEINE, TUNNEL, SOCKS4, SOCKS5
Datentyp
Zeichenfolge
Standardwert
"KEINE"
Hinweise
Diese Eigenschaft gibt das Protokoll an, das der Connector zum Tunneln des Datenverkehrs durch den FirewallServer verwendet-Proxy. Beachten Sie, dass der Connector standardmäßig eine Verbindung zum Systemproxy herstellt. Um dieses Verhalten zu deaktivieren und eine Verbindung zu einem der folgenden Proxytypen herzustellen, setzen Sie ProxyAutoDetect auf „false“.
Typ | Standardport | Beschreibung |
---|---|---|
TUNNEL | 80 | Wenn dies festgelegt ist, öffnet der Connector eine Verbindung zu ServiceNow und der Datenverkehr fließt hin und her durch den Proxy. |
SOCKS4 | 1080 | Wenn dies eingestellt ist, sendet der Connector Daten über den von FirewallServer angegebenen SOCKS 4-Proxy und FirewallPort und übergibt den FirewallUser-Wert für den Proxy, der bestimmt, ob die Verbindungsanforderung gewährt werden soll. |
SOCKS5 | 1080 | Wenn dies eingestellt ist, sendet der Connector Daten über den von FirewallServer angegebenen SOCKS 5-Proxy und FirewallPort. Wenn Ihr Proxy eine Authentifizierung erfordert, setzen Sie FirewallUser und FirewallPassword zu den Anmeldeinformationen, die der Proxy erkennt. |
Um eine Verbindung zu HTTP-Proxys herzustellen, verwenden Sie ProxyServer und ProxyPort. Zur Authentifizierung bei HTTP-Proxys verwenden Sie ProxyAuthScheme, ProxyBenutzer und ProxyPassword.
FirewallServer
Der Name oder die IP-Adresse einer Proxy-basierten Firewall.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Diese Eigenschaft gibt die IP-Adresse, den DNS-Namen oder den Host eines Proxys an, der das Durchqueren einer Firewall ermöglicht. Das Protokoll wird durch FirewallType angegeben: Verwenden Sie FirewallServer mit dieser Eigenschaft, um eine Verbindung über SOCKS herzustellen oder Tunneling durchzuführen. Verwenden Sie ProxyServer, um eine Verbindung zu einem HTTP-Proxy herzustellen.
Beachten Sie, dass der Connector standardmäßig den Systemproxy verwendet. Um einen anderen Proxy zu verwenden, legen Sie ProxyAutoDetect fest auf „false“.
FirewallPort
Der TCP- Port für eine Proxy-basierte Firewall.
Datentyp
int
Standardwert
0
Hinweise
Hiermit wird der TCP- Port für einen Proxy angegeben, der das Durchqueren einer Firewall ermöglicht. Verwenden Sie FirewallServer, um den Namen oder die IP-Adresse anzugeben. Geben Sie das Protokoll mit FirewallType an.
FirewallBenutzer
Der Benutzername, der zur Authentifizierung bei einer Proxy-basierten Firewall verwendet werden soll.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Der FirewallUser und das FirewallPassword-Eigenschaften werden zur Authentifizierung gegenüber dem in FirewallServer angegebenen Proxy verwendet und FirewallPort, gemäß der in FirewallType angegebenen Authentifizierungsmethode.
Firewall-Passwort
Ein Kennwort zur Authentifizierung bei einer Proxy-basierten Firewall.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Diese Eigenschaft wird an den von FirewallServer angegebenen Proxy übergeben und FirewallPort, gemäß der unter FirewallType angegebenen Authentifizierungsmethode.
Proxy
Dieser Abschnitt enthält eine vollständige Liste der Proxy-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
ProxyAutoDetect | Wenn diese Verbindungseigenschaft auf „true“ gesetzt ist, prüft der Anbieter Ihre Systemproxyeinstellungen auf vorhandene Proxyserverkonfigurationen (Proxyserverdetails müssen nicht manuell angegeben werden). Setzen Sie diese Eigenschaft auf „false“, wenn Sie den Anbieter manuell für die Verbindung mit einem bestimmten Proxyserver konfigurieren möchten. |
ProxyServer | Der Hostname oder die IP-Adresse des Proxyservers, über den Sie den HTTP-Verkehr Route möchten. |
ProxyPort | Der TCP- Port, auf dem der Proxyserver (angegeben in der Verbindungseigenschaft „ProxyServer“) ausgeführt wird. |
ProxyAuthentifizierungsschema | Die Authentifizierungsmethode, die der Anbieter bei der Authentifizierung gegenüber dem in der Verbindungseigenschaft „ProxyServer“ angegebenen Proxyserver verwendet. |
ProxyBenutzer | Der Benutzername eines Benutzerkontos, das bei dem in der Verbindungseigenschaft „ProxyServer“ angegebenen Proxyserver registriert ist. |
ProxyPasswort | Das Kennwort, das dem in der Verbindungseigenschaft „ProxyUser“ angegebenen Benutzer zugeordnet ist. |
ProxySSLTyp | Der zu verwendende SSL-Typ für die Verbindung mit dem ProxyServer-Proxy. |
ProxyExceptions | Eine durch Semikolon getrennte Liste von Ziel-Hostnamen oder IPs, die von der Verbindung über den Proxyserver ausgenommen sind. |
Automatische Proxy-Erkennung
Wenn diese Verbindungseigenschaft auf „true“ gesetzt ist, prüft der Anbieter Ihre Systemproxyeinstellungen auf vorhandene Proxyserverkonfigurationen (es ist nicht erforderlich, Proxyserverdetails manuell anzugeben). Setzen Sie diese Eigenschaft auf „false“, wenn Sie den Anbieter manuell für die Verbindung mit einem bestimmten Proxyserver konfigurieren möchten.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Diese Verbindungseigenschaft hat Vorrang vor anderen Proxy-Einstellungen. Daher müssen Sie „ProxyAutoDetect“ auf „False“ setzen, um benutzerdefinierte Proxy-Einstellungen verwenden zu können.
Wenn diese Eigenschaft auf „true“ gesetzt ist, wird der zu verwendende Proxy durch Überprüfen dieser Standorte in dieser Reihenfolge ermittelt. Wenn der Proxy an einem Standort nicht ermittelt werden kann, überprüft der Driver den nächsten.
- Der Driver führt eine Suche in den JVM-Eigenschaften durch (http.proxy, https.proxy, socksProxy usw.).
- Falls die JVM-Eigenschaften nicht vorhanden sind, führt der Driver eine Suche in java.home/lib/net.properties durch.
- Falls java.net.useSystemProxies auf true gesetzt ist, führt der Driver eine Suche im SystemProxy durch.
- Unter Windows werden die Proxy-Einstellungen aus den Internetoptionen in der Registrierung gelesen, genauer gesagt aus dem Registrierungsschlüssel HKCU\SOFTWARE\Microsoft\ Windows\CurrentVersion\Internet Settings. Unter Windows 10 und höher entspricht dies den Proxy-Einstellungen in den Windows-Einstellungen.
Beachten Sie, dass diese Einstellungen nur für den aktuellen Benutzer des Computers gelten. Wenn Sie eine Anwendung als Dienst ausführen, liest der Driver die Einstellungen Ihres eigenen Benutzers nicht. Sie müssen stattdessen die Proxy-Einstellungen manuell in den Verbindungseigenschaften des Treibers angeben.
Informationen zum Herstellen einer Verbindung mit einem HTTP-Proxy finden Sie unter ProxyServer. Informationen zu anderen Proxys, wie SOCKS oder Tunneling, finden Sie unter FirewallType.
ProxyServer
Der Hostname oder die IP-Adresse des Proxyservers, über den Sie den HTTP-Verkehr Route möchten.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Der Hostname oder die IP-Adresse eines Proxys, über den HTTP-Verkehr Route werden soll. Der Driver kann die Authentifizierungstypen HTTP, Windows (NTLM) oder Kerberos verwenden, um sich bei einem HTTP-Proxy zu authentifizieren.
Wenn Sie eine Verbindung über einen SOCKS-Proxy herstellen oder die Verbindung tunneln müssen, siehe FirewallType.
Standardmäßig verwendet der Driver den Systemproxy. Wenn Sie einen anderen Proxy verwenden müssen, stellen Sie ProxyAutoDetect ein auf „false“.
ProxyPort
Der TCP- Port, auf dem der Proxyserver (angegeben in der Verbindungseigenschaft „ProxyServer“) ausgeführt wird.
Datentyp
int
Standardwert
80
Hinweise
Der Port, auf dem der HTTP-Proxy läuft, über den Sie den HTTP-Verkehr umleiten möchten. Geben Sie den HTTP-Proxy in ProxyServer an. Weitere Proxy-Typen finden Sie unter FirewallType.
ProxyAuthSchema
Die Authentifizierungsmethode, die der Anbieter bei der Authentifizierung gegenüber dem in der Verbindungseigenschaft ProxyServer angegebenen Proxyserver verwendet.
Mögliche Werte
BASIC, DIGEST, KEINE, VERHANDELN, NTLM, PROPRIETÄR
Datentyp
Zeichenfolge
Standardwert
"GRUNDLEGEND"
Hinweise
Dieser Wert gibt den Authentifizierungstyp an, der zur Authentifizierung gegenüber dem durch ProxyServer angegebenen HTTP-Proxy verwendet werden soll und ProxyPort.
Beachten Sie, dass der Connector standardmäßig die Proxy-Einstellungen des Systems verwendet, ohne dass eine weitere Konfiguration erforderlich ist. Wenn Sie eine Verbindung zu einem anderen Proxy herstellen möchten, müssen Sie ProxyAutoDetect festlegen auf false, zusätzlich zu ProxyServer und ProxyPort. Zur Authentifizierung legen Sie ProxyAuthScheme fest und legen Sie ProxyUser fest und ProxyPassword, falls erforderlich.
Der Authentifizierungstyp kann einer der folgenden sein:
- BASIC: Der Connector führt eine HTTP-BASIC-Authentifizierung durch.
- DIGEST: Der Connector führt eine HTTP DIGEST-Authentifizierung durch.
- NEGOTIATE: Der Connector ruft basierend auf dem geltenden Protokoll zur Authentifizierung ein NTLM- oder Kerberos-Token ab.
- PROPRIETÄR: Der Connector generiert kein NTLM- oder Kerberos-Token. Sie müssen dieses Token im Header der HTTP-Anforderung angeben.
Wenn Sie einen anderen Authentifizierungstyp verwenden müssen, z. B. die SOCKS 5-Authentifizierung, siehe FirewallType.
ProxyBenutzer
Der Benutzername eines Benutzerkontos, das beim Proxyserver registriert ist, der in der Verbindungseigenschaft ProxyServer angegeben ist.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Der ProxyUser und das ProxyPassword-Optionen werden für die Verbindung und Authentifizierung gegenüber dem in ProxyServer angegebenen HTTP-Proxy verwendet.
Sie können einen der verfügbaren Authentifizierungstypen in ProxyAuthScheme auswählen. Wenn Sie die HTTP-Authentifizierung verwenden, legen Sie hier den Benutzernamen eines Benutzers fest, der vom HTTP-Proxy erkannt wird. Wenn Sie die Windows oder Kerberos-Authentifizierung verwenden, legen Sie diese Eigenschaft auf einen Benutzernamen in einem der folgenden Formate fest:
user@domain
domain\user
ProxyPassword
Das dem in der Verbindungseigenschaft ProxyUser angegebenen Benutzer zugeordnete Passwort.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Diese Eigenschaft wird zur Authentifizierung bei einem HTTP-Proxyserver verwendet, der NTLM (Windows), Kerberos oder HTTP-Authentifizierung unterstützt. Um den HTTP-Proxy anzugeben, können Sie ProxyServer festlegen und ProxyPort. Um den Authentifizierungstyp festzulegen, legen Sie ProxyAuthScheme.
Wenn Sie HTTP-Authentifizierung verwenden, legen Sie zusätzlich ProxyUser fest und ProxyPassword auf HTTP-Proxy.
Wenn Sie NTLM-Authentifizierung verwenden, legen Sie ProxyUser fest und ProxyPassword zu Ihrem Windows Passwort. Sie benötigen diese möglicherweise auch, um die Kerberos-Authentifizierung abzuschließen.
Informationen zur SOCKS 5-Authentifizierung oder zum Tunneln finden Sie unter FirewallType.
Standardmäßig verwendet der Connector den Systemproxy. Wenn Sie eine Verbindung zu einem anderen Proxy herstellen möchten, setzen Sie ProxyAutoDetect auf „false“.
ProxySSLType
Der SSL-Typ, der bei der Verbindung mit dem ProxyServer-Proxy verwendet werden soll.
Mögliche Werte
AUTO, IMMER, NIE, TUNNEL
Datentyp
Zeichenfolge
Standardwert
"AUTO"
Hinweise
Diese Eigenschaft bestimmt, wann SSL für die Verbindung zu einem durch ProxyServer angegebenen HTTP-Proxy verwendet werden soll. Dieser Wert kann AUTO, ALWAYS, NEVER oder TUNNEL sein. Die anwendbaren Werte sind die folgenden:
- AUTO: Standardeinstellung. Wenn die URL eine HTTPS URL ist, verwendet der Driver die Option TUNNEL. Wenn die URL eine HTTP- URL ist, verwendet die Komponente die Option NEVER.
- IMMER: Die Verbindung ist immer SSL-fähig.
- NIE: Die Verbindung ist nicht SSL-fähig.
- TUNNEL: Die Verbindung erfolgt über einen Tunnel-Proxy. Der Proxy-Server öffnet eine Verbindung zum Remote-Host und der Datenverkehr fließt durch den Proxy hin und her.
ProxyExceptions
Eine durch Semikolon getrennte Liste von Ziel-Hostnamen oder IPs, die von der Verbindung über den Proxy-Server ausgenommen sind.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Der ProxyServer wird für alle Adressen verwendet, außer für die in dieser Eigenschaft definierten Adressen. Verwenden Sie Semikolons, um Einträge zu trennen.
Beachten Sie, dass der Connector standardmäßig die Systemproxyeinstellungen verwendet, ohne dass eine weitere Konfiguration erforderlich ist. Wenn Sie für diese Verbindung explizit Proxyausnahmen konfigurieren möchten, müssen Sie ProxyAutoDetect festlegen = false, und konfigurieren Sie ProxyServer und ProxyPort. Zur Authentifizierung legen Sie ProxyAuthScheme fest und setze ProxyUser und ProxyPassword, falls erforderlich.
Protokollierung
Dieser Abschnitt enthält eine vollständige Liste der Protokollierungseigenschaften, die Sie in der Verbindungszeichenfolge für diesen Anbieter konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Logdatei | Ein Dateipfad, der den Namen und den Speicherort der Protokolldatei angibt. |
Ausführlichkeit | Die Ausführlichkeitsstufe, die den Detailumfang der Protokolldatei bestimmt. |
LogModule | In die Protokolldatei aufzunehmende Kernmodule. |
MaximaleLogdateigröße | Eine Zeichenfolge, die die maximale Größe einer Protokolldatei in Bytes angibt (z. B. 10 MB). |
MaxLogFileCount | Eine Zeichenfolge, die die maximale Dateianzahl der Protokolldateien angibt. |
Logdatei
Ein Dateipfad, der den Namen und den Speicherort der Protokolldatei angibt.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Sobald diese Eigenschaft festgelegt ist, füllt der Driver die Protokolldatei, während er verschiedene Aufgaben ausführt, z. B. wenn eine Authentifizierung durchgeführt oder Abfragen ausgeführt werden. Wenn die angegebene Datei noch nicht vorhanden ist, wird sie erstellt.
Verbindungszeichenfolgen und Versionsinformationen werden ebenfalls protokolliert, Verbindungseigenschaften mit vertraulichen Informationen werden jedoch automatisch maskiert.
Wenn ein relativer Dateipfad angegeben wird, wird der Speicherort der Protokolldatei anhand des im Feld Speicherort gefundenen Pfads aufgelöst Verbindungseigenschaft.
Um mehr Kontrolle darüber zu haben, was in die Protokolldatei geschrieben wird, können Sie die Ausführlichkeit anpassen-Eigenschaft.
Die Protokollinhalte sind in mehrere Module unterteilt. Sie können einzelne Module mithilfe der Funktion LogModules ein-/ausblenden-Eigenschaft.
Um die maximale Größe einer einzelnen Protokolldatei zu bearbeiten, bevor eine neue erstellt wird, siehe MaxLogFileSize.
Wenn Sie die Anzahl der generierten Protokolldateien begrenzen möchten, verwenden Sie MaxLogFileCount.
Java-Protokollierung
Java-Protokollierung wird ebenfalls unterstützt. Um die Java-Protokollierung zu aktivieren, setzen Sie Logfile auf:
Logfile=JAVALOG://myloggername
Wie im obigen Beispiel ist JAVALOG:// ein erforderliches Präfix, um Java-Logging zu verwenden, und Sie ersetzen es durch Ihren eigenen Logger.
Anschließend wird die getLogger-Methode des bereitgestellten Loggers aufgerufen und der bereitgestellte Wert verwendet, um die Logger-Instanz zu erstellen. Wenn bereits eine Logging-Instanz vorhanden ist, wird auf die vorhandene Instanz verwiesen.
Wenn Java-Logging aktiviert ist, wird die Ausführlichkeit entsprechen nun bestimmten Protokollierungsebenen.
Ausführlichkeit
Die Ausführlichkeitsstufe bestimmt, wie viele Details in die Protokolldatei aufgenommen werden.
Datentyp
Zeichenfolge
Standardwert
"1"
Hinweise
Der Ausführlichkeitsgrad bestimmt den Detailgrad, den der Driver an die Protokolldatei meldet. Es werden Ausführlichkeitsstufen von 1 bis 5 unterstützt. Diese sind detailliert in CDatas Logging Dokumentation.
LogModule
Kernmodule, die in die Protokolldatei aufgenommen werden sollen.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Nur die angegebenen Module (getrennt durch ';') werden in die Protokolldatei aufgenommen. Standardmäßig sind alle Module enthalten.
Siehe CDatas Logging Dokumentation für einen Überblick.
MaxLogFileSize
Eine Zeichenfolge, die die maximale Größe einer Protokolldatei in Bytes angibt (z. B. 10 MB).
Datentyp
Zeichenfolge
Standardwert
„100 MB“
Hinweise
Wenn das Limit erreicht ist, wird im selben Ordner ein neues Protokoll erstellt, an dessen Ende Datum und Uhrzeit angehängt werden. Das Standardlimit beträgt 100 MB. Bei Werten unter 100 kB wird stattdessen 100 kB als Wert verwendet.
Passen Sie die maximale Anzahl der generierten Protokolldateien mit MaxLogFileCount an.
MaxLogFileCount
Eine Zeichenfolge, die die maximale Dateianzahl der Protokolldateien angibt.
Datentyp
int
Standardwert
-1
Hinweise
Wenn das Limit erreicht ist, wird im selben Ordner ein neues Protokoll erstellt, an dessen Ende Datum und Uhrzeit angehängt werden, und die älteste Protokolldatei wird gelöscht.
Der unterstützte Mindestwert ist 2. Ein Wert von 0 oder ein negativer Wert bedeutet, dass keine Begrenzung der Anzahl besteht.
Passen Sie die maximale Größe der generierten Protokolldateien mit MaxLogFileSize an.
Schema
Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Standort | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
DurchsuchbareSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tabellen | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC. |
Ansichten | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC. |
Datenbankansichten einschließen | Steuert, ob die Datenbankansichten angezeigt werden oder nicht. |
Systemtabellen einschließen | Steuert, ob die Systemtabellen verfügbar gemacht werden oder nicht. |
Standort
Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
Datentyp
Zeichenfolge
Standardwert
„%APPDATA%\ ServiceNow Datenanbieter\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. Die Location-Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.
Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\ ServiceNow Data Provider\Schema“, wobei %APPDATA% auf das Konfigurationsverzeichnis des Benutzers eingestellt ist:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Library/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
Zeichenfolge
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
Zeichenfolge
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
Zeichenfolge
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.
IncludeDatabaseViews
Steuert, ob die Datenbankansichten angezeigt werden oder nicht.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Steuert, ob die Datenbankansichten angezeigt werden oder nicht. Wenn dies der Fall ist, sendet der Connector mehrere zusätzliche Metadatenaufrufe, um die Metadaten der Datenbankansichten abzurufen.
IncludeSystemTables
Steuert, ob die Systemtabellen angezeigt werden oder nicht.
Datentyp
bool
Standardwert
WAHR
Hinweise
Steuert, ob die Systemtabellen angezeigt werden oder nicht. Normalerweise haben nur Benutzer mit Administratorrolle Zugriff auf diese Tabellen. Wenn Sie diese Eigenschaft auf „false“ setzen, werden sie bei Metadatenaufrufen nicht aufgelistet.
Zwischenspeicherung
Dieser Abschnitt enthält eine vollständige Liste der Caching-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AutoCache | Speichert die Ergebnisse von SELECT-Abfragen automatisch in einer Cache-Datenbank zwischen, die entweder durch CacheLocation oder durch CacheConnection und CacheProvider angegeben wird. |
Cache-Treiber | Der Driver, der zum Zwischenspeichern von Daten verwendet wird. |
CacheVerbindung | Die Verbindungszeichenfolge für die Cache-Datenbank. Diese Eigenschaft wird immer in Verbindung mit CacheProvider verwendet. Wenn Sie beide Eigenschaften festlegen, wird der für CacheLocation festgelegte Wert zum Zwischenspeichern von Daten überschrieben. |
Cache-Speicherort | Gibt den Pfad zum Cache an, wenn in eine Datei zwischengespeichert wird. |
CacheToleranz | Die in Sekunden angegebene Toleranz für veraltete Daten im Cache bei Verwendung von AutoCache. |
Offline | Verwenden Sie den Offlinemodus, um die Daten aus dem Cache statt aus der Livequelle abzurufen. |
CacheMetadata | Diese Eigenschaft legt fest, ob die Metadaten der Tabelle in einem Dateispeicher zwischengespeichert werden oder nicht. |
AutoCache
Speichert die Ergebnisse von SELECT-Abfragen automatisch in einer Cache-Datenbank, die entweder durch CacheLocation oder durch CacheConnection und CacheProvider angegeben wird.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Wenn AutoCache wahr ist, verwaltet der Connector automatisch einen Cache der Daten Ihrer Tabelle in der Datenbank Ihrer Wahl. Standardmäßig aktualisiert der Connector den Cache inkrementell und ruft nur Änderungen seit der letzten Ausführung der SELECT Abfrage ab, wenn die Zeitspanne seit der letzten Ausführung die CacheTolerance überschritten hat. Nachdem der Cache aktualisiert wurde, wird die Abfrage für die zwischengespeicherten Daten ausgeführt.
Festlegen der Caching-Datenbank
Wenn AutoCache wahr ist, speichert der Connector in einem einfachen, dateibasierten Cache. Sie können seinen Speicherort konfigurieren oder mit den folgenden Eigenschaften in einer anderen Datenbank zwischenspeichern:
- CacheLocation: Gibt den Pfad zum Dateispeicher an.
- CacheDriver und CacheConnection: Gibt einen Driver für eine Datenbank und die Verbindungszeichenfolge an.
Siehe auch
- CacheToleranz: Diese Eigenschaft steuert die Toleranz gegenüber veralteten Daten im Cache.
- CacheMetadata: Diese Eigenschaft reduziert die Menge der Metadaten, die das Netzwerk durchlaufen, indem Tabellenschemata beibehalten werden, die aus den ServiceNow Metadaten abgerufen wurden. Metadaten müssen dann nur einmal und nicht bei jeder Verbindung abgerufen werden.
- Explizites Zwischenspeichern von Daten: CData bietet weitere Beispiele zur Verwendung von AutoCache in Offline-Modus.
- CACHE-Anweisungen: CData beschreibt im Detail, wie Sie die CACHE-Anweisung verwenden können, um jede SELECT Abfrage beizubehalten und den Cache zu verwalten, z. B. zum Aktualisieren von Schemas.
Cache-Treiber
Der Driver, der zum Zwischenspeichern von Daten verwendet werden soll.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Sie können in jeder Datenbank zwischenspeichern, für die Sie einen JDBC- Driver haben, einschließlich JDBC-Treiber.
Die Cache-Datenbank wird basierend auf CacheDriver und CacheConnection bestimmt Eigenschaften. CacheDriver ist der Name der JDBC- Driver, die Sie zum Zwischenspeichern von Daten verwenden möchten.
Beachten Sie, dass Sie auch die JAR-Datei CacheDriver zum Klassenpfad hinzufügen müssen.
Die folgenden Beispiele zeigen, wie Sie in mehreren großen Datenbanken zwischenspeichern. Siehe CacheConnection für weitere Informationen zur JDBC- URL -Syntax und typischen Verbindungseigenschaften.
Derby und Java DB
Der Driver vereinfacht die Derby-Konfiguration. Java DB ist die Oracle Distribution von Derby. Die JAR-Datei wird im JDK mitgeliefert. Sie finden die JAR-Datei derby.jar im Unterordner db der JDK-Installation. In den meisten Caching-Szenarien müssen Sie nur Folgendes angeben, nachdem Sie derby.jar zum Klassenpfad hinzugefügt haben:
jdbc:servicenow:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
Um die Derby JDBC- URL anzupassen, verwenden Sie CacheDriver und CacheConnection. Um beispielsweise in einer In-Memory-Datenbank zwischenzuspeichern, verwenden Sie eine JDBC- URL wie die folgende:
jdbc:servicenow:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
SQLite
Nachfolgend finden Sie eine JDBC- URL für den SQLite JDBC- Driver:
jdbc:servicenow:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
MySQL
Nachfolgend finden Sie eine JDBC- URL für den enthaltenen JDBC-Treiber für MySQL:
jdbc:servicenow:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
SQL Server
Die folgende JDBC- URL verwendet den Microsoft JDBC-Treiber für SQL Server:
jdbc:servicenow:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
Oracle
Nachfolgend sehen Sie eine JDBC- URL für den Oracle Thin Client:
jdbc:servicenow:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
HINWEIS: Wenn Sie eine Oracle-Version verwenden, die älter als 9i ist, lautet der Cache Driver stattdessen oracle.jdbc. Driver.OracleDriver.
PostgreSQL
Die folgende JDBC- URL verwendet den offiziellen PostgreSQL JDBC- Driver:
jdbc:servicenow:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
CacheVerbindung
Die Verbindungszeichenfolge für die Cache-Datenbank. Diese Eigenschaft wird immer in Verbindung mit CacheProvider verwendet. Wenn Sie beide Eigenschaften festlegen, wird der für CacheLocation festgelegte Wert zum Zwischenspeichern von Daten überschrieben.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Die Cache-Datenbank wird anhand des CacheDriver bestimmt und CacheConnection Eigenschaften. Beide Eigenschaften sind erforderlich, um die Cache-Datenbank zu verwenden. Beispiele für allgemeine Cache-Datenbankeinstellungen finden Sie weiter unten. Weitere Informationen zum Einstellen des Driver der Cache-Datenbank finden Sie unter CacheDriver.
Die in der Eigenschaft CacheConnection angegebene Verbindungszeichenfolge wird direkt an den zugrunde liegenden CacheDriver übergeben. Weitere Informationen zu den verfügbaren Eigenschaften finden Sie in der Dokumentation des jeweiligen JDBC- Driver. Achten Sie darauf, den JDBC- Driver in den Klassenpfad Ihrer Anwendung aufzunehmen.
Derby und Java DB
Der Driver vereinfacht das Caching für Derby und erfordert lediglich das Festlegen von CacheLocation, um eine Basisverbindung herzustellen.
Alternativ können Sie die Verbindung zu Derby manuell mit CacheDriver konfigurieren und CacheConnection. Nachfolgend sehen Sie die Derby JDBC- URL Syntax:
jdbc:derby:[subsubprotocol:][Datenbankname][;attribute=value[;attribute=value] ... ]
Um beispielsweise in einer In-Memory-Datenbank zwischenzuspeichern, verwenden Sie Folgendes:
jdbc:derby:memory
SQLite
Zum Zwischenspeichern in SQLite können Sie den SQLite JDBC- Driver verwenden. Die Syntax der JDBC- URL lautet wie folgt:
jdbc:sqlite:dataSource
- Datenquelle: Der Pfad zu einer SQLite-Datenbankdatei. Oder verwenden Sie einen Wert von
:memory
im Speicher zwischenspeichern.
MySQL
Die Installation umfasst den JDBC-Treiber für MySQL. Nachfolgend sehen Sie ein Beispiel für eine JDBC- URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Im Folgenden sind typische Verbindungseigenschaften aufgeführt:
- Server: Die IP-Adresse oder der Domänenname des Servers, mit dem Sie eine Verbindung herstellen möchten.
- Port: Der Port, auf dem der Server läuft.
- Benutzer: Der für die Authentifizierung bei der Datenbank angegebene Benutzername.
- Passwort: Das für die Authentifizierung bei der Datenbank angegebene Passwort.
- Datenbank: Der Name der Datenbank.
SQL Server
Die JDBC- URL für den Microsoft JDBC-Treiber für SQL Server hat die folgende Syntax:
jdbc:sqlserver://[serverName[\instance][: Port]][;database=databaseName][;Eigenschaft=Wert[;Eigenschaft=Wert] ... ]
Beispiel:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Im Folgenden sind typische SQL Server Verbindungseigenschaften aufgeführt:
-
Server: Der Name oder die Netzwerkadresse des Computers, auf dem SQL Server ausgeführt wird. Um eine Verbindung zu einer benannten Instanz statt zur Standardinstanz herzustellen, können Sie mit dieser Eigenschaft den Host und die Instanz angeben, getrennt durch einen Backslash.
-
Port: Der Port, auf dem SQL Server ausgeführt wird.
-
Datenbank: Der Name der SQL Server-Datenbank.
-
Integrierte Sicherheit: Setzen Sie diese Option auf „true“, um das aktuelle Windows-Konto zur Authentifizierung zu verwenden. Setzen Sie diese Option auf „false“, wenn Sie Benutzer und Passwort in der Verbindung festlegen.
Um integrierte Sicherheit zu verwenden, müssen Sie auch sqljdbc_auth.dll zu einem Ordner im Windows-Systempfad hinzufügen. Diese Datei befindet sich im Unterordner „auth“ der Microsoft JDBC-Treiberinstallation für SQL Server. Die Bitanzahl der Assembly muss mit der Bitanzahl Ihrer JVM übereinstimmen.
-
Benutzer-ID: Der Benutzername, der für die Authentifizierung mit SQL Server angegeben wird. Diese Eigenschaft wird nur benötigt, wenn Sie keine integrierte Sicherheit verwenden.
-
Passwort: Das für die Authentifizierung mit SQL Server bereitgestellte Passwort. Diese Eigenschaft wird nur benötigt, wenn Sie keine integrierte Sicherheit verwenden.
Oracle
Nachfolgend sehen Sie die herkömmliche JDBC- URL Syntax für den Oracle JDBC Thin Driver:
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:Seite]]
Beispiel:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Im Folgenden sind typische Verbindungseigenschaften aufgeführt:
-
Datenquelle: Der Verbindungsdeskriptor, der die Oracle-Datenbank identifiziert. Dies kann ein TNS-Verbindungsdeskriptor, ein Oracle Net Services-Name, der in einen Verbindungsdeskriptor aufgelöst wird, oder ab Version 11g eine Easy Connect-Benennung (der Host des Oracle-Servers mit einem optionalen Port und Dienstnamen) sein.
-
Passwort: Das für die Authentifizierung bei der Oracle-Datenbank bereitgestellte Passwort.
-
Benutzer-ID: Die für die Authentifizierung bei der Oracle Datenbank bereitgestellte Benutzer-ID.
PostgreSQL
Nachfolgend finden Sie die JDBC- URL Syntax für den offiziellen PostgreSQL JDBC- Driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&Option=Wert][&option=value] ... ]]
Beispielsweise stellt die folgende Verbindungszeichenfolge eine Verbindung zu einer Datenbank auf dem Host (localhost) und Port (5432) her:
jdbc:postgresql:postgres
Im Folgenden sind typische Verbindungseigenschaften aufgeführt:
- Host: Die Adresse des Servers, auf dem die PostgreSQL Datenbank gehostet wird.
- Port: Der Port, der für die Verbindung mit dem Server verwendet wird, auf dem die PostgreSQL Datenbank gehostet wird.
- Datenbank: Der Name der Datenbank.
- Benutzername: Die zur Authentifizierung bei der PostgreSQL -Datenbank bereitgestellte Benutzer-ID. Diese können Sie in der JDBC- URL mit dem Parameter „user“ angeben.
- Passwort: Das für die Authentifizierung bei der PostgreSQL Datenbank bereitgestellte Passwort.
CacheSpeicherort
Gibt den Pfad zum Cache an, wenn in eine Datei zwischengespeichert wird.
Datentyp
Zeichenfolge
Standardwert
„%APPDATA%\ ServiceNow-Datenanbieter“
Hinweise
CacheLocation ist ein einfacher, dateibasierter Cache. Der Connector verwendet Java DB, die Oracle-Distribution der Derby-Datenbank. Um in Java DB zu cachen, müssen Sie die Java DB-JAR-Datei zum Klassenpfad hinzufügen. Die JAR-Datei derby.jar ist im JDK enthalten und befindet sich im Unterordner db der JDK-Installation.
Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\ ServiceNow Data Provider“, wobei %APPDATA% auf das Konfigurationsverzeichnis des Benutzers eingestellt ist:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Library/Anwendungsunterstützung |
Linux | ~/.config |
Siehe auch
- AutoCache: Einrichten, um implizit einen Cache für die spätere Offline-Verwendung zu erstellen und zu verwalten.
- CacheMetadata: Eingestellt, um den ServiceNow Katalog in CacheLocation beizubehalten.
CacheToleranz
Die Toleranz für veraltete Daten im Cache wird in Sekunden angegeben, wenn AutoCache verwendet wird.
Datentyp
int
Standardwert
600
Hinweise
Die Toleranz für veraltete Daten im Cache wird in Sekunden angegeben. Dies gilt nur, wenn AutoCache verwendet. Der Connector prüft nach Ablauf des Toleranzintervalls bei der Datenquelle, ob neuere Datensätze vorliegen. Andernfalls gibt er die Daten direkt aus dem Cache zurück.
Offline
Verwenden Sie den Offlinemodus, um die Daten aus dem Cache statt aus der Livequelle abzurufen.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Wenn Offline wahr ist, werden alle Abfragen im Cache ausgeführt und nicht in der Live-Datenquelle. In diesem Modus sind bestimmte Abfragen wie INSERT, UPDATE, DELETE und CACHE nicht zulässig.
CacheMetadata
Diese Eigenschaft bestimmt, ob die Tabellenmetadaten in einem Dateispeicher zwischengespeichert werden sollen oder nicht.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Wenn Sie Abfragen mit diesem Eigenschaftensatz ausführen, werden Tabellenmetadaten im ServiceNow Katalog im durch CacheLocation angegebenen Dateispeicher zwischengespeichert, falls festgelegt, andernfalls das Home-Verzeichnis des Benutzers. Die Metadaten einer Tabelle werden nur einmal abgerufen, wenn die Tabelle zum ersten Mal abgefragt wird.
Wann werden CacheMetadata verwendet?
Der Connector speichert Metadaten automatisch bis zu zwei Stunden lang im Speicher, wenn Sie die Metadaten für eine Tabelle oder Ansicht zum ersten Mal entdecken. Daher ist CacheMetadata im Allgemeinen nicht erforderlich. CacheMetadata ist nützlich, wenn Metadatenvorgänge teuer sind, z. B. wenn Sie mit großen Mengen an Metadaten arbeiten oder wenn Sie viele kurzlebige Verbindungen haben.
Wann sollten CacheMetadata nicht verwendet werden?
- Wenn Sie mit flüchtigen Metadaten arbeiten: Metadaten für eine Tabelle werden nur beim ersten Herstellen der Verbindung zur Tabelle abgerufen. Um neue, geänderte oder gelöschte Spalten abzurufen, müssen Sie den Metadaten-Cache löschen und neu erstellen. Daher ist es am besten, sich in Fällen, in denen sich Metadaten häufig ändern, auf das In-Memory-Caching zu verlassen.
- Wenn Sie in einer Datenbank zwischenspeichern: CacheMetadata kann nur mit CacheLocation verwendet werden. Wenn Sie mit dem CacheDriver in einer anderen Datenbank zwischenspeichern und CacheConnection Eigenschaften, verwenden Sie AutoCache zum impliziten Zwischenspeichern. Oder verwenden Sie REPLICATE-Anweisungen oder CACHE-Anweisungen explizit zwischenzuspeichern.
Datenformatierung
Dieser Abschnitt enthält eine vollständige Liste der Datenformatierungseigenschaften, die Sie in der Verbindungszeichenfolge für diesen Anbieter konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
PushEmptyValuesAsNull | Gibt an, ob die leeren Werte als leer oder als null gelesen werden sollen. |
PushEmptyValuesAsNull
Gibt an, ob die leeren Werte als leer oder als Null gelesen werden sollen.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Gibt an, ob die leeren Werte als leer oder als Null gelesen werden sollen.
Verschiedenes
Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Batchgröße | Die maximale Größe jedes zu Operation. |
Verbindungslebensdauer | Die maximale Lebensdauer einer Verbindung in Sekunden. Nach Ablauf der Zeit wird das Verbindungsobjekt verworfen. |
VerbindenBeimÖffnen | Diese Eigenschaft gibt an, ob beim Öffnen der Verbindung eine Verbindung zu ServiceNow hergestellt werden soll. |
Anzeigewert | Basierend auf diesem Wert ruft der Anbieter den Anzeigewert oder den tatsächlichen Wert aus der Datenbank ab. |
AnzeigewertSpaltenname | Muster zum Anzeigen von Spaltennamen, wenn die Eigenschaft DisplayValue auf ALL gesetzt ist. |
Spaltenwerte erzwingen | Steuert, ob beim Ausführen von INSERT- oder UPDATE-Anweisungen verfügbare Werte für ein Element abgerufen und überprüft werden. |
ExcludeReferenceLink | Basierend auf diesem Wert werden die für Referenzfelder bereitgestellten Zusatzinformationen unterdrückt oder nicht. |
GetColumnsMetadata | Gibt die Benutzerpräferenz an, wann und wie der Anbieter die Spaltenmetadaten abrufen soll. |
MaxZeilen | 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. |
Seitengröße | Die maximale Anzahl der Ergebnisse, die pro Seite von ServiceNow zurückgegeben werden sollen. |
PoolIdleTimeout | Die zulässige Leerlaufzeit einer Verbindung, bevor sie geschlossen wird. |
Maximale Poolgröße | Die maximale Anzahl an Verbindungen im Pool. |
Mindestgröße des Pools | Die Mindestanzahl an Verbindungen im Pool. |
PoolWartezeit | Die maximale Wartezeit in Sekunden auf eine verfügbare Verbindung. |
Pseudospalten | Geben Sie einen Satz von Pseudospalten an, die als Spalten angezeigt werden sollen. |
Schreibgeschützt | Sie können diese Eigenschaft verwenden, um vom Anbieter schreibgeschützten Zugriff auf ServiceNow zu erzwingen. |
RTK | Der für die Lizenzierung verwendete Laufzeit Schlüssel. |
Beschreibungen anzeigen | Steuert, ob Spalten- und Tabellenbeschreibungen über die API Endpoints sys_documentation und sys_db_object zurückgegeben werden. |
Zeitüberschreitung | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
Verbindungspooling verwenden | Diese Eigenschaft aktiviert das Verbindungspooling. |
UseDisplayTableNames | Boolescher Wert, der bestimmt, ob die Anzeigenamen für die Tabelle statt der API -Namen verwendet werden sollen. |
BenutzerdefinierteAnsichten | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
Batchgröße
Die maximale Größe jeder zu Operation.
Datentyp
int
Standardwert
0
Hinweise
Wenn BatchSize auf einen Wert größer als 0 gesetzt ist, wird der gesamte Batch Operation in separate Batches der Größe BatchSize aufgeteilt. Die aufgeteilten Batches werden dann einzeln an den Server übermittelt. Dies ist nützlich, wenn der Server Beschränkungen hinsichtlich der Größe der Anfrage hat, die übermittelt werden kann.
Wenn Sie BatchSize auf 0 setzen, wird der gesamte Batch wie angegeben übermittelt.
Verbindungslebensdauer
Die maximale Lebensdauer einer Verbindung in Sekunden. Nach Ablauf der Zeit wird das Verbindungsobjekt entsorgt.
Datentyp
int
Standardwert
0
Hinweise
Die maximale Lebensdauer einer Verbindung in Sekunden. Nach Ablauf der Zeit wird das Verbindungsobjekt entsorgt. Der Standardwert ist 0, was bedeutet, dass es keine Begrenzung für die Verbindungslebensdauer gibt.
Verbinden bei Öffnen
Diese Eigenschaft gibt an, ob beim Öffnen der Verbindung eine Verbindung zu ServiceNow hergestellt werden soll.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Wenn auf „true“ gesetzt, wird beim Öffnen der Verbindung eine Verbindung zu ServiceNow hergestellt. Diese Eigenschaft aktiviert die Funktion „Verbindung testen“, die in verschiedenen Datenbanktools verfügbar ist.
Diese Funktion fungiert als NOOP-Befehl, da sie verwendet wird, um zu überprüfen, ob eine Verbindung zu ServiceNow hergestellt werden kann und nichts von dieser ersten Verbindung beibehalten wird.
Das Festlegen dieser Eigenschaft auf „false“ kann zu Leistungsverbesserungen führen (abhängig von der Häufigkeit, mit der eine Verbindung geöffnet wird).
Anzeigewert
Basierend auf diesem Wert ruft der Anbieter den Anzeigewert oder den tatsächlichen Wert aus der Datenbank ab.
Mögliche Werte
RICHTIG, FALSCH, ALLES
Datentyp
Zeichenfolge
Standardwert
"FALSCH"
Hinweise
Hinweis: Wenn Sie diese Verbindungseigenschaft auf „TRUE“ setzen, sind aufgrund von API Einschränkungen alle zurückgegebenen Felder vom Typ „String“.
- TRUE: gibt Anzeigewerte für alle Felder zurück.
- FALSE: gibt tatsächliche Werte aus der Datenbank zurück.
- ALL: gibt sowohl tatsächliche als auch Anzeigewerte zurück.
Anzeigewertspaltenname
Muster zum Anzeigen von Spaltennamen, wenn die Eigenschaft DisplayValue auf ALL eingestellt ist.
Datentyp
Zeichenfolge
Standardwert
"{0}_Anzeige_Wert"
Hinweise
Die Eigenschaft akzeptiert einen musterähnlichen Wert, der zum Formatieren der Spaltennamen verwendet wird, wenn DisplayValue=ALL. „{0}“ dient als Platzhalter für die Spaltennamen.
Spaltenwerte erzwingen
Steuert, ob verfügbare Werte für ein Element beim Ausführen von INSERT- oder UPDATE-Anweisungen abgerufen und überprüft werden.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Steuert, ob verfügbare Werte für ein Element abgerufen und überprüft werden, wenn INSERT- oder UPDATE-Anweisungen ausgeführt werden. Wenn der Wert keine gültige Auswahl ist, wird ein Fehler ausgegeben. Elemente (Spalten) in ServiceNow könnten auf eine Reihe gültiger Werte (Auswahlmöglichkeiten in einer Liste) beschränkt sein. Beispielsweise könnte ein Element „Problemtyp“ nur gültige Werte wie „Fehler“, „Verbesserung“ oder „Dokumentation“ haben. Wenn ein Datensatz mit einem ungültigen Wert erstellt wird, verwirft ServiceNow den Wert und weist dem Datensatz einen Standardwert zu. Wenn diese Eigenschaft auf „true“ gesetzt wird, werden die verfügbaren Auswahlmöglichkeiten im Voraus abgerufen und wenn möglich überprüft, ob eingefügte Werte Teil der Liste gültiger Werte sind. Beachten Sie, dass bei Anzeigewerten die Groß- und Kleinschreibung beachtet wird. Diese Eigenschaft berücksichtigt die Verbindungseigenschaft DisplayValue.
Referenzlink ausschließen
Basierend auf diesem Wert werden die für Referenzfelder bereitgestellten Zusatzinformationen unterdrückt oder nicht.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Basierend auf diesem Wert werden die für Referenzfelder bereitgestellten Zusatzinformationen unterdrückt oder nicht.
Spaltenmetadaten abrufen
Gibt die Benutzerpräferenz an, wann und wie der Anbieter die Spaltenmetadaten abrufen soll.
Mögliche Werte
Beim Start, bei Verwendung
Datentyp
Zeichenfolge
Standardwert
"BeiVerwendung"
Hinweise
Die folgenden Einstellungen sind verfügbar:
- OnStart: Der Connector führt die Metadatenaufrufe aus, um alle Spalten für jede Tabelle zu ermitteln und zwischenzuspeichern, bevor die erste Anweisung ausgeführt wird.
- OnUse: Der Connector führt die tabellenspezifischen Metadatenaufrufe aus, wenn zum ersten Mal auf die Tabelle verwiesen wird, vorausgesetzt, die Metadaten für die Tabelle sind noch nicht zwischengespeichert.
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
Zeichenfolge
Standardwert
""
Hinweise
Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Connectors sollten diese Eigenschaften nicht erforderlich sein.
Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.
Caching-Konfiguration
Immobilie | Beschreibung |
---|---|
CachePartial=True | Zwischenspeichert nur eine Teilmenge der Spalten, die Sie in Ihrer Abfrage angeben können. |
QueryPassthrough=True | Übergibt die angegebene Abfrage an die Cache-Datenbank, anstatt den SQL-Parser des Connectors zu verwenden. |
Integration und Formatierung
Immobilie | Beschreibung |
---|---|
DefaultColumnSize | Legt die Standardlänge von Zeichenfolgenfeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000. |
ConvertDateTimeToGMT | Legt fest, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen. |
RecordToFile=Dateiname | Zeichnet den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei auf. |
Seitengröße
Die maximale Anzahl der Ergebnisse, die pro Seite von ServiceNow zurückgegeben werden sollen.
Datentyp
int
Standardwert
5000
Hinweise
Die Eigenschaft Pagesize beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von ServiceNow zurückgegeben werden. Während die Datenquelle die Standardseitengröße für die meisten Anwendungsfälle optimiert, müssen Sie diesen Wert möglicherweise je nach dem spezifischen Objekt oder Endpoint, den Sie abfragen, anpassen. Eine Erhöhung der Seitengröße kann die Leistung verbessern, kann aber auch zu einem höheren Speicherverbrauch pro Seite führen.
PoolIdleTimeout
Die zulässige Leerlaufzeit für eine Verbindung, bevor sie geschlossen wird.
Datentyp
int
Standardwert
60
Hinweise
Die zulässige Leerlaufzeit, die eine Verbindung im Pool verbleiben kann, bis sie geschlossen wird. Der Standardwert beträgt 60 Sekunden.
PoolMaxSize
Die maximale Anzahl an Verbindungen im Pool.
Datentyp
int
Standardwert
100
Hinweise
Die maximale Anzahl an Verbindungen im Pool. Der Standardwert ist 100. Um diese Eigenschaft zu deaktivieren, setzen Sie den Eigenschaftswert auf 0 oder weniger.
PoolMinSize
Die Mindestanzahl an Verbindungen im Pool.
Datentyp
int
Standardwert
1
Hinweise
Die Mindestanzahl von Verbindungen im Pool. Der Standardwert ist 1.
PoolWartezeit
Die maximale Wartezeit in Sekunden auf eine verfügbare Verbindung.
Datentyp
int
Standardwert
60
Hinweise
Die maximale Wartezeit in Sekunden, bis eine Verbindung verfügbar wird. Wenn eine neue Verbindungsanforderung auf eine verfügbare Verbindung wartet und diese Zeit überschreitet, wird ein Fehler ausgegeben. Standardmäßig warten neue Anforderungen ewig auf eine verfügbare Verbindung.
Pseudospalten
Geben Sie eine Reihe von Pseudospalten an, die als Spalten angezeigt werden sollen.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
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; zum Beispiel „*=*“.
Schreibgeschützt
Mit dieser Eigenschaft können Sie vom Anbieter aus schreibgeschützten Zugriff auf ServiceNow erzwingen.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Wenn diese Eigenschaft auf „true“ gesetzt ist, lässt der Connector nur SELECT-Abfragen zu. Bei INSERT-, UPDATE-, DELETE- und gespeicherten Prozedurabfragen wird ein Fehler ausgegeben.
RTK
Der für die Lizenzierung verwendete Laufzeit.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Die RTK-Eigenschaft kann zum Lizenzieren eines Builds verwendet werden. Informationen zum Festlegen dieser Eigenschaft finden Sie in der enthaltenen Lizenzdatei. Der Laufzeit Schlüssel ist nur verfügbar, wenn Sie eine OEM-Lizenz erworben haben.
Beschreibungen anzeigen
Steuert, ob Spalten- und Tabellenbeschreibungen über die API Endpoints sys_documentation und sys_db_object zurückgegeben werden.
Mögliche Werte
KEINE, Tabellenbeschriftungen, Spaltenbeschriftungen, Tabellen- und Spaltenbeschriftungen, Spaltenkommentare
Datentyp
Zeichenfolge
Standardwert
"KEINE"
Hinweise
Hinweis: Standardmäßig ist es auf KEINE eingestellt und die Beschreibungen für die Tabellen und ihre jeweiligen Spalten werden nicht angezeigt. Zusätzliche API Aufrufe werden ausgeführt, wenn diese Eigenschaft auf einen anderen Wert als KEINE eingestellt ist. Setzen Sie den Wert dieser Eigenschaft auf TableLabels, wenn Sie die Beschriftungen (Anzeigenamen) für jede Tabelle vom API Endpoint sys_db_object abrufen möchten. Setzen Sie den Wert dieser Eigenschaft auf ColumnLabels, wenn Sie die Beschriftungen (Anzeigenamen) für jede Spalte vom API Endpoint sys_documentation abrufen möchten. Setzen Sie den Wert dieser Eigenschaft auf TableAndColumnLabels, wenn Sie die Beschriftungen (Anzeigenamen) für jede Tabelle und ihre jeweiligen Spalten von den API Endpoints sys_db_object und sys_documentation abrufen möchten. Setzen Sie den Wert dieser Eigenschaft auf ColumnComments, wenn Sie die Kommentare für jede Spalte vom sys_dictionary-API Endpoint abrufen möchten.
Zeitüberschreitung
Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
Datentyp
int
Standardwert
60
Hinweise
Wenn Timeout = 0 ist, wird bei Vorgängen kein Timeout durchgeführt. Die Vorgänge werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.
Wenn das Timeout abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.
Verwenden Sie ConnectionPooling
Diese Eigenschaft aktiviert das Verbindungspooling.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Diese Eigenschaft aktiviert das Verbindungspooling. Der Standardwert ist „false“. Siehe CDatas Verbindungspooling Seite für Informationen zur Verwendung von Verbindungspools.
Verwenden SieDisplayTableNames
Boolescher Wert, der bestimmt, ob die Anzeigenamen für die Tabelle anstelle der API -Namen verwendet werden sollen.
Datentyp
bool
Standardwert
FALSCH
Hinweise
Standardmäßig werden die Tabellen unter Verwendung der internen Tabellennamen angezeigt.
Wenn diese Eigenschaft auf „true“ gesetzt ist, stellt der Anbieter die Tabellen unter Verwendung der Anzeigenamen der ServiceNow GUI bereit.
BenutzerdefinierteAnsichten
Boolescher Wert, der bestimmt, ob die Anzeigenamen für die Tabelle anstelle der API -Namen verwendet werden sollen.
Datentyp
Zeichenfolge
Standardwert
""
Hinweise
Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json definiert. Der Driver erkennt die in dieser Datei angegebenen Ansichten automatisch.
Sie können auch mehrere Ansichtsdefinitionen haben und diese mit der Verbindungseigenschaft UserDefinedViews steuern. Wenn Sie diese Eigenschaft verwenden, werden dem Driver nur die angegebenen Ansichten angezeigt.
Diese benutzerdefinierte Ansichtskonfigurationsdatei ist wie folgt formatiert:
- Jedes Stammelement definiert den Namen einer Ansicht.
- Jedes Stammelement enthält ein untergeordnetes Element namens Abfrage, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.
Zum Beispiel:
{
"MyView": {
"query": "SELECT * FROM incident WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie die Verbindungseigenschaft UserDefinedViews, 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.