|
Wird zum Installieren des Experience Service das Installationsprogramm verwendet, so werden diese Parameter vom Installationsprogramm konfiguriert.
|
|
Informationen zur Konfiguration für Single Sign-On-Authentifizierung finden Sie im nachfolgenden Abschnitt "Konfigurationsparameter für die Authentifizierung mit Single Sign-On (SSO)".
|
Parameter
|
Beschreibung
|
authentication.type
|
Bei Verwendung von Standardauthentifizierung muss dieser Parameter auf twxUser festgelegt werden.
|
authentication.baseURL
|
Die URL für den ThingWorx Server, der für die Authentifizierung verwendet wird. Beispiel: https://twx.example.com:8443
|
authentication.authorization.appKey
|
Der ThingWorx Anwendungsschlüssel, mit dem der Experience Service die Mitgliedschaften von ThingWorx Gruppen liest. Mithilfe der Gruppenmitgliedschaften wird bestimmt, welche Experience Service Rolle ein Benutzer hat und welche Berechtigungen diesem Benutzer gewährt wurden.
Weitere Informationen zum Konfigurieren des Autorisierungs-Anwendungsschlüssels finden Sie unter Zugriff auf ThingWorx Gruppenmitgliedschaften konfigurieren.
|
authentication.authorization.refreshRate
|
Dieser Parameter bestimmt, wie häufig die Mitgliedschaft von Experience Service Rollen mit der Mitgliedschaft von ThingWorx Gruppen synchronisiert wird. Der Wert ist in Millisekunden angegeben.
Standardmäßig ist diese Einstellung auf 5 Minuten festgelegt. Die schnellste Rate, die eingestellt werden kann, beträgt 30 Sekunden.
|
Parameter
|
Beschreibung
|
authentication.type
|
Dieser Parameter muss auf openidUser festgelegt werden, wenn der Experience Service so konfiguriert wird, dass SSO verwendet wird.
|
authentication.baseUrl
|
Die URL für den ThingWorx Server, die bei der Verwendung von Standardauthentifizierung für die Authentifizierung verwendet wird sowie für die Gruppenmitgliedschafts-Synchronisierung, unabhängig vom Authentifizierungstyp. Beispiel: https://twx.example.com:8443.
|
authentication.authorization.refreshRate
|
Dieser Parameter bestimmt, wie häufig die Mitgliedschaft von Experience Service Rollen mit der Mitgliedschaft von ThingWorx Gruppen synchronisiert wird. Der Wert ist in Millisekunden angegeben.
Standardmäßig ist diese Einstellung auf 5 Minuten festgelegt. Die schnellste Rate, die eingestellt werden kann, beträgt 30 Sekunden.
|
authentication.openid.issuer
|
Legen Sie diese Eigenschaft auf den Parameter <as-base-url> fest, der im Abschnitt "SSO-Konfigurationsparameter" in Konfigurationsbeispiel für PingFederate identifiziert ist.
|
authentication.openid.clientId
|
Legen Sie diese Eigenschaft auf den Parameter <es-client-id> fest, der im Abschnitt "SSO-Konfigurationsparameter" in Konfigurationsbeispiel für PingFederate identifiziert ist.
|
authentication.openid.clientSecret
|
Legen Sie diese Eigenschaft auf den Parameter <es-client-secret> fest, der im Abschnitt "SSO-Konfigurationsparameter" in Konfigurationsbeispiel für PingFederate identifiziert ist.
|
authentication.openid.redirectUri
|
Legen Sie diese Eigenschaft auf den Parameter <es-redirect-uri> fest, der im Abschnitt "SSO-Konfigurationsparameter" in Konfigurationsbeispiel für PingFederate identifiziert ist.
|
authentication.openid.session.maxAge
|
Authentifiziert sich ein Benutzer beim Experience Service mit OpenID Connect, so wird für diesen Benutzer eine Sitzung erstellt. Diese Eigenschaft gibt an, wie viel Zeit verstreichen muss, bevor die Sitzung ungültig ist und sich der Benutzer erneut anmelden muss. Die Standardeinheit für diese Einstellung ist Millisekunden. Es können jedoch andere Einheiten angegeben werden, indem der Name der Einheit an den Wert angehängt wird. Beispiel: "10 Stunden". Es werden die folgenden Einheiten unterstützt:
• Sekunden: seconds, s
• Minuten: minutes, m
• Stunden: hours, hrs, hour, h
• Tage: days, day, d
|
authentication.openid.externalScope
|
Dies ist erforderlich für den Zugriff auf die ThingWorx APIs unter Verwendung von oauth2. Dieser Wert sollte auf den in ThingWorx konfigurierten Wert festgelegt werden, um ThingWorx als Ressourcen-Anbieter zu verwenden.
|
authentication.openid.esScope
|
Legen Sie diese Eigenschaft auf den Parameter <es-scope> fest, der im Abschnitt "SSO-Konfigurationsparameter" in Konfigurationsbeispiel für PingFederate identifiziert ist.
|
authentication.openid.studioClientId
|
Geben Sie den Namen der Studio Client-ID ein. Der Standardwert für dieses Feld ist PTC_Studio_Client_ID. Wurde jedoch eine andere Konfiguration vorgenommen, so muss diese hier angegeben werden.
|
authentication.openid.claimsMapping.username
|
Legen Sie den Parameter auf den Wert des Attributs sub, das in Ihrer OpenID Connect-Richtlinie identifiziert wird, fest. Weitere Informationen finden Sie unter Schritt 9 in OpenID-Richtlinienkonfiguration.
|
|
Stellen Sie bei der Bereitstellung des Experience Service in einem Cluster sicher, dass alle im Cluster ausgeführten Instanzen (projects.store, reps.store und upgrade.store) auf die Datenspeicherverzeichnisse zugreifen können.
|
Parameter
|
Beschreibung
|
projects.storePath
|
Der Pfad zum Verzeichnis, wo Projektinhalte gespeichert werden.
|
projects.staticOps.maxAge
|
Gibt den Wert der Maximalalter-Kopfzeile an, der in Antworten enthalten ist, wenn Projektinhalt auf einen Client heruntergeladen wird.
|
reps.storePath
|
Der Pfad zum Verzeichnis, wo die Darstellung von Repository-Inhalten gespeichert wird.
|
reps.staticOps.maxAge
|
Gibt den Wert der Maximalalter-Kopfzeile an, der in Antworten enthalten ist, wenn Darstellungsinhalt auf einen Client heruntergeladen wird.
|
upgrade.storePath
|
Der Pfad zum Verzeichnis, wo Migratorerfolgsdateien gespeichert werden. Diese Dateien geben an, wann ein Upgrade-Migrator seine Datenmigrationsaufgabe erfolgreich abgeschlossen hat, sodass die Migration nicht wiederholt wird.
|
|
Die für diese Konfigurationsparameter angegebenen Pfade können absolut oder relativ sein. Absolute Pfade beginnen mit "/" und werden relativ zum Stamm des Dateisystems behandelt, während relative Pfade mit "./" beginnen und relativ zum Installationsverzeichnis des Experience Service behandelt werden.
|
|
SQLite wird mit Experience Service installiert. PostgreSQL muss separat erworben und installiert werden.
|
Parameter
|
Beschreibung
|
||
dbHandler
|
Legen Sie für diese Parameter einen der folgende Werte fest:
• SQLiteHandler, wenn SQLite verwendet wird
• postgresHandler, wenn PostgreSQL verwendet wird
|
||
db.datafilePath
|
Dieser Parameter ist nur anwendbar, wenn SQLite verwendet wird, und gibt den Pfad zur SQLite-Datendatei an. Wenn der Experience Service gestartet wird, erstellt er die Datendatei, falls sie noch nicht vorhanden ist.
|
||
db.connectionString
|
Dieser Parameter ist nur anwendbar, wenn PostgreSQL verwendet wird, und gibt die Verbindungszeichenfolge für die Verbindung mit der PostgreSQL-Datendatei an. Das Format der Verbindungszeichenfolge ist wie folgt:
postgres://<Datenbank-Benutzername>:<Datenbankpasswort>@<Host>:<Port>/<Datenbankname>
Die verwendeten Anmeldeinformationen müssen über ausreichende Berechtigungen zum Erstellen neuer Datenbanktabellen in der PostgreSQL-Datenbank verfügen.
|
Parameter
|
Beschreibung
|
enable_irs_federation
|
Das Festlegen dieses Parameters auf true aktiviert den IRS-Verbund, während das Festlegen auf false ihn deaktiviert.
|
domain_id_resolver
|
Die Basis-URL, die für die Abfrage von Erlebnissen aus anderen Experience Services verwendet wird. Diese ist nur erforderlich, wenn der IRS-Verbund aktiviert ist. Im Allgemeinen muss die Basis-URL für den von PTC bereitgestellten Global Experience Index (GXI) verwendet werden:
https://gxi.vuforia.io/VuforiaExperienceService/id-resolution/resolutions/
|
Parameter
|
Beschreibung
|
||
logsPath
|
Das Globmuster, das die Pfade beschreibt, die Protokolldateien entsprechen. Standardmäßig ist dies auf /var/logs/thingserver.log* festgelegt. Dadurch können alle Dateien in den /var/logs heruntergeladen werden, deren Name mit thingserver.log beginnt.
|
trustProxy-Einstellung
|
Client-IP
|
Protokoll
|
false (Standard)
|
IP des Clients, der die Anforderung gesendet hat
|
Protokoll des Anforderung
|
true
|
Eintrag ganz links in der Kopfzeile X-Forwarded-For
|
Wert der Kopfzeile X-Forwarded-Proto
|
IP-Filterkriterien
|
Eintrag ganz rechts in der Kopfzeile X-Forwarded-For nach dem Filtern dieser Liste, um alle Einträge zu entfernen, die mit den angegebenen Filterkriterien übereinstimmen. (Weitere Informationen zum Konstruieren der Filterkriterien finden Sie nachfolgend.)
|
Wert der Kopfzeile X-Forwarded-Proto
|
Ganzzahl (n)
|
Der n-te Eintrag von rechts in der Kopfzeile X-Forwarded-For
|
Wert der Kopfzeile X-Forwarded-Proto
|
Filteroption
|
Zu filternde Adressen
|
loopback
|
Jede Adresse, die zum folgenden Subnetz gehört:
• IPv4: 127.0.0.1/8
• IPv6: ::1/128
|
linklocal
|
Jede Adresse, die zum folgenden Subnetz gehört:
• IPv4: 169.254.0.0/16
• IPv6: fe80::/10
|
uniquelocal
|
Jede Adresse, die zu einem der folgenden Subnetze gehört:
• IPv4: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16
• IPv6: fc00::/7
|
<ip address>
|
Die angegebene IP-Adresse (z.B. 203.0.113.13)
|
Anwendungsfall
|
Einstellung für den trustProxy-Parameter
|
Ignorieren Sie die Informationen in den Kopfzeilen X-Forwarded-*.
|
false
|
Behandeln Sie alle Einträge in der Kopfzeile X-Forwarded-For (mit Ausnahme des Eintrags ganz links) als bekannte, vertrauenswürdige Proxies. Der Eintrag ganz links wird als Client-IP behandelt.
|
true
|
Behandeln Sie lediglich den lokalen Host als bekannten, vertrauenswürdigen Proxy.
|
"loopback"
|
Behandeln Sie den lokalen Host und die IP-Adressen 203.0.113.13 und 203.0.113.15 als vertrauenswürdige Proxies.
|
"loopback, 203.0.113.13,203.0.113.15"
|
Behandeln Sie den lokalen Host und alle Hosts im lokalen Netzwerk als bekannte, vertrauenswürdige Proxies.
|
"loopback, linklocal, uniquelocal"
|
|
Ihr ThingWorx Server wurde möglicherweise für die Verwendung eines Bereichs konfiguriert, der sich vom Standard unterscheidet.
|
Parameter
|
Beschreibung
|
proxies.0.autoRewrite
|
Wenn true festgelegt ist, ändert der Experience Service vom ThingWorx Server bereitgestellte Umleitungs-URIs so, dass der Client über den Proxy umgeleitet wird. Nehmen wir z.B. an, dass sich der Experience ServiceThingWorx Proxy unter https://es.example.com/Thingworx befindet und der ThingWorx Server mit Proxy unter https://twx.example.com/Thingworx. Wenn der ThingWorx Server den Client an https://twx.example.com/Thingworx/something umleitet, schreibt der Experience Service diese URL als https://es.example.com/Thingworx/something um. Wenn diese Eigenschaft auf false gesetzt ist, werden diese Weiterleitungs-URIs von Experience Service nicht umgeschrieben.
|
proxies.0.protocolRewrite
|
Dieser Parameter gibt das Protokoll an, das beim Umschreiben von Weiterleitungs-URIs verwendet wird. Nehmen wir z.B. an, der Experience Service wird im sicheren HTTPS-Modus ausgeführt, der ThingWorx Server jedoch im unsicheren HTTP-Modus. In diesem Fall muss als Parameter "HTTPS" festgelegt werden, damit beim Umschreiben der Umleitungs-URIs diese so geändert werden, dass sie den Experience Service Proxy verwenden.
|
proxies.0.secure
|
Wenn der Parameter auf true gesetzt ist, weist der Experience ServiceThingWorx Proxy nicht autorisierte (selbstsignierte) Zertifikate zurück, die von dem ThingWorx Server mit Proxy verwendet werden. Daher muss dieser Parameter auf false gesetzt werden, wenn der ThingWorx Server mit Proxy selbstsignierte Zertifikate verwendet.
|
websocketProxies.0.autoRewrite
|
Dieser Parameter steuert das Umleitungs-Umschreibungsverhalten für den WebSocket-Proxy auf die gleiche Weise wie der Parameter proxies.0.autoRewrite das Umschreibungsverhalten für den HTTP-Proxy steuert.
|
websocketProxies.0.protocolRewrite
|
Dieser Parameter steuert das Protokoll, das verwendet wird, wenn Umschreibungs-URIs für den WebSocket-Proxy umgeleitet werden, so wie der Parameter proxies.0.protocolRewrite das Umschreibungsverhalten für den HTTP-Proxy steuert. Gültige Protokolloptionen sind ws oder wss.
|
websocketProxies.0.secure
|
Dieser Parameter steuert, ob der WebSocket-Proxy nicht autorisierte (selbstsignierte) Zertifikate zurückweist, so wie der Parameter proxies.0.secure steuert, ob der HTTP-Proxy nicht autorisierte (selbstsignierte) Zertifikate zurückweist.
|
proxies.0.disabled
|
Wenn der Parameter auf true gesetzt ist, deaktiviert er den ThingWorx Proxy. Wenn false festgelegt ist, wird der Proxy aktiviert.
|
proxies.0.target
|
Die Basis-URL für den ThingWorx Server. Diese URL muss in /Thingworx enden. Beispiel: https://twx.acme.com:8443/Thingworx.
|
proxies.0.appKey
|
Der ThingWorx Anwendungsschlüssel, mit dem der Experience Service öffentlichen Erlebnissen Zugriff auf ThingWorx Daten gewährt. Weitere Informationen zu öffentlichen Erlebnissen und zum Konfigurieren des öffentlichen Zugriffs auf ThingWorx finden Sie unter Öffentlichen Zugriff auf ThingWorx konfigurieren.
|
websocketProxies.0.disabled
|
Wenn der Parameter auf true gesetzt ist, deaktiviert er den ThingWorx WebSocket-Proxy. Wenn false festgelegt ist, wird der Proxy aktiviert.
|
websocketProxies.0.target
|
Die Basis-URL, die zum Einrichten eines Websocket zwischen dem Client und dem ThingWorx Server verwendet wird. Diese URL muss mit dem für proxies.0.target angegebenen Wert kompatibel sein. Wenn beispielsweise für proxies.0.targethttps://twx.acme.com:8443/Thingworx festgelegt ist, muss für diesen Parameter wss: //twx.acme.com: 8443 festgelegt werden.
|
|
Verbinden Sie keine Edge-Geräte und Mashups über den Experience ServiceThingWorx Proxy mit dem ThingWorx Server. Stattdessen sollte eine direkte Verbindung zum ThingWorx Server verwendet werden (über alternative Ports, ELB usw.). Der Experience ServiceThingWorx Proxy ist nicht dafür ausgelegt, die mit dem EDGE-Gerätedatenverkehr verbundene Last zu bewältigen, und bestimmte Edge SDKs funktionieren nicht über einen Proxy.
|
|
Stellen Sie bei der Bereitstellung des Experience Service in einem Cluster sicher, dass alle im Cluster ausgeführten Instanzen auf die Speicherorte für Schlüssel- und Zertifikatsdateien zugreifen können.
|
|
Es können Werte für die PEM-Eigenschaften (httpsKeyPath, httpsCrtPath und httpsCaPath) oder Werte für die Eigenschaft PCKS12 (PFX) (httpsPfxPath), eingegeben werden. Beides ist jedoch nicht möglich.
|
Parameter
|
Beschreibung
|
httpsKeyPath
|
Der Pfad zur Datei, die den PEM-kodierten, privaten Schlüssel enthält.
|
httpsCrtPath
|
Der Pfad zur Datei, die das PEM-kodierte, öffentliche Zertifikat enthält.
|
httpsCaPath
|
Der Pfad zur Zertifikatbündeldatei, welche die PEM-kodierten, öffentlichen Zertifikate für die Zwischenzertifizierungsstellen enthält.
|
httpsCertPassphrase
|
Die Passphrase, die zum Entschlüsseln des PEM-kodierten, privaten Schlüssels oder zum Entschlüsseln der PCKS12 (PFX)-kodierten Archivdatei verwendet wird.
|
httpsPfxPath
|
Der Pfad zur Datei, welche die PCKS12 (PFX)-kodierte Archivdatei enthält.
|
|
Die für diese Konfigurationsparameter angegebenen Pfade können absolut oder relativ sein. Absolute Pfade beginnen mit "/" und werden relativ zum Stamm des Dateisystems behandelt, während relative Pfade mit "./" beginnen und relativ zum Installationsverzeichnis des Experience Service behandelt werden.
In Windows kann ein absoluter Pfad entweder mit "/" beginnen oder mit einem Laufwerksbuchstaben, z.B. "C:/". Beginnt der absolute Pfad mit einem "/", so wird der Pfad als relativ zum Stamm des Laufwerks, welches das Experience Service Installationsverzeichnis enthält, interpretiert.
|
Parameter
|
Beschreibung
|
nohttp2
|
Fügen Sie diesen Parameter hinzu, und legen Sie ihn auf true fest, um Bilder, die während eines Erlebnisses mit dem Kamera-Widget aufgenommen wurden, in einem Repository in ThingWorx zu speichern.
Beispiel:
{
….. "nossl":true, "nohttp2":true } |
Parameter
|
Beschreibung
|
hmtg.credentials.baseUrl
|
URL für den Modellziel-Dienst Dieser Parameter wird automatisch für Sie gefüllt. Der Wert ist:
https://vws.vuforia.com
|
hmtg.credentials.tokenPath
|
HTTP-Anforderungs-Pfad für OAuth2-Authentifizierung. Dieser Parameter wird automatisch für Sie gefüllt. Der Wert ist:
oauth2/token
|
hmtg.credentials.amtgPath
|
HTTP-Anforderungs-Pfad für die Generierung erweiterter Modellziele. Dieser Parameter wird automatisch für Sie gefüllt. Der Wert ist:
modeltargets/advancedDatasets
|
hmtg.credentials.accessKey
|
Sie erhalten den Wert für diesen Parameter vom technischen Support von PTC. Weitere Informationen finden Sie unter Informationen anfordern, um die Generierung erweiterter Modellziele zu aktivieren.
|
hmtg.credentials.secretKey
|
Sie erhalten den Wert für diesen Parameter vom technischen Support von PTC. Weitere Informationen finden Sie unter Informationen anfordern, um die Generierung erweiterter Modellziele zu aktivieren.
|
Parameter
|
Beschreibung
|
publicAccess
|
Deaktivieren oder aktivieren Sie die Möglichkeit, Projekte zu veröffentlichen, für die das Feld Zugriff in Vuforia Studio auf Öffentlich festgelegt ist.
Beispiel:
{
….. "publicAccess":{ "disabled": true } |