|
Si vous installez Experience Service à l'aide du programme d'installation, ces paramètres sont configurés par le programme d'installation.
|
|
Si vous effectuez une configuration pour l'authentification unique, consultez la section "Paramètres de configuration de l'authentification unique (SSO)" ci-dessous.
|
Paramètre
|
Description
|
authentication.type
|
Si vous utilisez l'Authentification de base, ce paramètre doit être défini sur twxUser.
|
authentication.baseURL
|
URL du serveur ThingWorx utilisé pour l'authentification. Par exemple : https://twx.example.com:8443
|
authentication.authorization.appKey
|
Clé d'application ThingWorx utilisée par Experience Service pour lire les membres des groupes ThingWorx. L'appartenance aux groupes sert à déterminer le rôle Experience Service auquel un utilisateur appartient et les permissions qui lui sont accordées.
Pour plus d'informations sur la configuration de la clé d'application d'autorisation, consultez Configuration de l'accès aux membres du groupe ThingWorx.
|
authentication.authorization.refreshRate
|
Ce paramètre détermine la fréquence de synchronisation des membres des rôles Experience Service avec les membres des groupes ThingWorx. La valeur est spécifiée en millisecondes.
Par défaut, ce paramètre est défini sur 5 minutes. Le taux le plus rapide définissable est 30 secondes.
|
Paramètre
|
Description
|
authentication.type
|
Cette valeur doit être définie sur openidUser lors de la configuration d'Experience Service pour l'authentification unique.
|
authentication.baseUrl
|
URL du serveur ThingWorx utilisée pour l'authentification, lorsque l'authentification de base est utilisée, et pour la synchronisation de l'appartenance aux groupes, quel que soit le type d'authentification. Par exemple : https://twx.example.com:8443
|
authentication.authorization.refreshRate
|
Ce paramètre détermine la fréquence de synchronisation des membres des rôles Experience Service avec les membres des groupes ThingWorx. La valeur est spécifiée en millisecondes.
Par défaut, ce paramètre est défini sur 5 minutes. Le taux le plus rapide définissable est 30 secondes.
|
authentication.openid.issuer
|
Définissez cette valeur de sorte qu'elle soit égale au paramètre <as-base-url> identifié à la section "Paramètres de configuration de l'authentification unique (SSO)" de la rubrique Exemple de configuration PingFederate.
|
authentication.openid.clientId
|
Définissez cette valeur de sorte qu'elle soit égale au paramètre <es-client-id> identifié à la section "Paramètres de configuration de l'authentification unique (SSO)" de la rubrique Exemple de configuration PingFederate.
|
authentication.openid.clientSecret
|
Définissez cette valeur de sorte qu'elle soit égale au paramètre <es-client-secret> identifié à la section "Paramètres de configuration de l'authentification unique (SSO)" de la rubrique Exemple de configuration PingFederate.
|
authentication.openid.redirectUri
|
Définissez cette valeur de sorte qu'elle soit égale au paramètre <es-redirect-uri> identifié à la section "Paramètres de configuration de l'authentification unique (SSO)" de la rubrique Exemple de configuration PingFederate.
|
authentication.openid.session.maxAge
|
Lorsqu'un utilisateur s'authentifie auprès d'Experience Service à l'aide d'OpenID Connect, une session est créée pour lui. Cette propriété spécifie combien de temps doit s'écouler avant que la session soit invalidée et que l'utilisateur doive s'authentifier de nouveau. L'unité par défaut de ce paramètre est les millisecondes. Toutefois, d'autres unités peuvent être spécifiées en ajoutant le nom de l'unité à la valeur. Par exemple, "10 heures". Les unités suivantes sont prises en charge :
• Secondes : seconds, s
• Minutes : minutes, m
• Heures : hours, hrs, hour, h
• Jours : days, day, d
|
authentication.openid.externalScope
|
Cette option est requise pour accéder aux API ThingWorx à l'aide d'oauth2. Cette valeur doit être définie sur la même valeur configurée dans ThingWorx pour l'utilisation de ThingWorx en tant que fournisseur de ressources.
|
authentication.openid.esScope
|
Définissez cette valeur de sorte qu'elle soit égale au paramètre <es-scope> identifié à la section "Paramètres de configuration de l'authentification unique (SSO)" de la rubrique Exemple de configuration PingFederate.
|
authentication.openid.studioClientId
|
Entrez le nom de l'ID du client Studio. La valeur par défaut de ce champ est PTC_Studio_Client_ID. Toutefois, si l'application a été configurée avec un nom différent, vous devez l'entrer ici.
|
authentication.openid.claimsMapping.username
|
Attribuez une valeur égale à celle de l'attribut sub identifié dans votre stratégie de OpenID Connect. Pour plus d'informations, reportez-vous à l'étape 9 de la rubrique Configuration d'une politique OpenID.
|
|
Si Experience Service est déployé dans une grappe, vérifiez que les répertoires de magasin de données (projects.store, reps.store et upgrade.store) sont accessibles par toutes les instances s'exécutant dans la grappe.
|
Paramètre
|
Description
|
projects.storePath
|
Chemin d'accès au répertoire de stockage du contenu des projets.
|
projects.staticOps.maxAge
|
Spécifie la valeur de l'en-tête max-age inclus avec les réponses lorsque le contenu de projet est téléchargé sur un client.
|
reps.storePath
|
Chemin d'accès au répertoire où le contenu de référentiel de représentation est stocké.
|
reps.staticOps.maxAge
|
Spécifie la valeur de l'en-tête max-age inclus avec les réponses lorsque le contenu de représentation est téléchargé sur un client.
|
upgrade.storePath
|
Chemin d'accès au répertoire où sont stockés les fichiers de réussite de migration. Ces fichiers sont utilisés pour indiquer qu'un migrateur de mise à niveau a terminé sa tâche de migration de données afin que la migration ne soit pas répétée.
|
|
Les chemins spécifiés pour ces paramètres de configuration peuvent être des chemins absolus ou relatifs. Les chemins absolus commencent par "/" et sont traités comme relatifs à la racine du système de fichiers, tandis que les chemins relatifs commencent par "./" et sont traités comme relatifs au répertoire d'installation d'Experience Service.
|
|
SQLite est installé avec Experience Service. PostgreSQL doit être obtenu et installé séparément.
|
Paramètre
|
Description
|
||
dbHandler
|
Définissez ce paramètre sur l'une des valeurs suivantes :
• SQLiteHandler si SQLite est utilisé
• postgresHandler si PostgreSQL est utilisé
|
||
db.datafilePath
|
Ce paramètre est uniquement applicable si SQLite est utilisé et spécifie le chemin d'accès au fichier de données SQLite. Au démarrage d'Experience Service, il crée le fichier de données s'il n'existe pas.
|
||
db.connectionString
|
Ce paramètre est uniquement applicable si PostgreSQL est utilisé et spécifie la chaîne de connexion utilisée pour la connexion à la base de données PostgreSQL. Le format de la chaîne de connexion est le suivant :
postgres://<nomutilisateurBdD>:<motdepasseBdD>@<hôte>:<port>/<nomBdD>
Les informations d'identification utilisées doivent disposer des permissions suffisantes pour créer de nouveaux tableaux de base de données dans la base de données PostgreSQL.
|
Paramètre
|
Description
|
enable_irs_federation
|
La définition de ce paramètre sur true active la fédération IRS, alors que la définition sur false désactive la fédération IRS.
|
domain_id_resolver
|
URL de base utilisée pour interroger des expériences provenant d'autres Experience Services. Ce paramètre est uniquement requis si la fédération IRS est activée. En général, l'URL de base du GXI (Global Experience Index) fourni par PTC doit être utilisée :
https://gxi.vuforia.io/VuforiaExperienceService/id-resolution/resolutions/
|
Paramètre
|
Description
|
||
logsPath
|
Modèle glob décrivant les chemins qui correspondent aux fichiers journaux. Par défaut, cette valeur est définie sur /var/logs/thingserver.log*. Ainsi, tous les fichiers dans /var/logs dont les noms commencent par thingserver.log peuvent être téléchargés.
|
Paramètre trustProxy
|
Adresse IP du client
|
Protocole
|
false (par défaut)
|
Adresse IP du client qui a envoyé la requête
|
Protocole de la requête
|
true
|
Entrée la plus à gauche dans l'en-tête X-Forwarded-For
|
Valeur de l'en-tête X-Forwarded-Proto
|
Critères de filtre IP
|
Entrée la plus à droite dans l'en-tête X-Forwarded-For après le filtrage de cette liste pour supprimer toutes les entrées correspondant aux critères spécifiés (voir ci-dessous pour plus d'informations sur la construction des critères de filtre)
|
Valeur de l'en-tête X-Forwarded-Proto
|
Entier (n)
|
Nième entrée à partir de la droite dans l'en-tête X-Forwarded-For
|
Valeur de l'en-tête X-Forwarded-Proto
|
Option de filtre
|
Adresses qui seront filtrées
|
loopback
|
Toute adresse appartenant au sous-réseau suivant :
• IPv4 : 127.0.0.1/8
• IPv6 : ::1/128
|
linklocal
|
Toute adresse appartenant au sous-réseau suivant :
• IPv4 : 169.254.0.0/16
• IPv6 : fe80::/10
|
uniquelocal
|
Toute adresse appartenant à l'un des sous-réseaux suivants :
• IPv4 : 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16
• IPv6 : fc00::/7
|
<ip address>
|
Adresse IP spécifiée (par ex., 203.0.113.13).
|
Cas d'utilisation
|
Paramétrage de trustProxy
|
Ignorer les informations dans les en-têtes X-Forwarded-*.
|
false
|
Traiter toutes les entrées de l'en-tête X-Forwarded-For (à l'exception de celles qui sont les plus à gauche) comme des proxys approuvés connus. L'entrée la plus à gauche est traitée comme l'adresse IP du client.
|
true
|
Traiter uniquement l'hôte local comme un proxy connu et approuvé.
|
"loopback"
|
Traiter l'hôte local et les adresses IP 203.0.113.13 et 203.0.113.15 en tant que proxys approuvés.
|
"loopback, 203.0.113.13,203.0.113.15"
|
Traiter l'hôte local et n'importe quel hôte sur le réseau local en tant que proxy connu et approuvé.
|
"loopback, linklocal, uniquelocal"
|
|
Votre serveur ThingWorx peut avoir été configuré pour utiliser un domaine différent du domaine par défaut.
|
Paramètre
|
Description
|
proxies.0.autoRewrite
|
Si la valeur est définie sur true, Experience Service changera toutes les URI de redirection fournies par le serveur ThingWorx afin que le client soit redirigé par le proxy. Par exemple, supposons que le proxy Experience ServiceThingWorx se trouve à l'adresse https://es.example.com/Thingworx et que le serveur ThingWorx en proxy se trouve à l'adresse https://twx.example.com/Thingworx. Si le serveur ThingWorx redirige le client vers https://twx.example.com/Thingworx/something, Experience Service réécrit cette URL comme https://es.example.com/Thingworx/something. Si cette propriété est définie sur false, Experience Service ne réécrit pas ces URI de redirection.
|
proxies.0.protocolRewrite
|
Ce paramètre identifie le protocole utilisé lors de la réécriture des URI de redirection. Par exemple, supposons qu'Experience Service est en cours d'exécution en mode sécurisé HTTPS, mais que le serveur ThingWorx est en cours d'exécution en mode non sécurisé HTTP. Dans ce cas, ce paramètre doit être défini sur HTTPS de sorte que, lorsque les URI de redirection sont réécrites, elles le soient pour utiliser le protocole utilisé par le proxy Experience Service.
|
proxies.0.secure
|
Si la valeur est définie sur true, le proxy Experience ServiceThingWorx rejette les certificats non autorisés (autosignés) utilisés par le serveur ThingWorx en proxy. Par conséquent, ce paramètre doit être défini sur false si le serveur ThingWorx en proxy utilise des certificats autosignés.
|
websocketProxies.0.autoRewrite
|
Ce paramètre contrôle le comportement de réécriture de redirection pour le proxy socket Web de la même manière que le paramètre proxies.0.autoRewrite contrôle le comportement de réécriture pour le proxy HTTP.
|
websocketProxies.0.protocolRewrite
|
Ce paramètre contrôle le protocole utilisé lors de la réécriture des URI de redirection pour le proxy socket Web de la même manière que le paramètre proxies.0.protocolRewrite contrôle le comportement de réécriture pour le proxy HTTP. Les choix de protocole valides sont ws ou wss.
|
websocketProxies.0.secure
|
Ce paramètre contrôle si le proxy socket Web rejette les certificats non autorisés (autosignés) de la même manière que le paramètre proxies.0.secure contrôle le rejet ou non des certificats non autorisés (autosignés) par le proxy HTTP.
|
proxies.0.disabled
|
S'il est défini sur true, ce paramètre désactive le proxy ThingWorx. S'il est défini sur false , il active le proxy.
|
proxies.0.target
|
URL de base du serveur ThingWorx. Cette URL doit se terminer par /Thingworx. Par exemple : https://twx.acme.com:8443/Thingworx.
|
proxies.0.appKey
|
Clé d'application ThingWorx utilisée par Experience Service pour accorder aux expériences publiques l'accès aux données ThingWorx. Pour plus d'informations sur les expériences publiques et la configuration de l'accès public à ThingWorx, consultez la rubrique Configuration de l'accès public à ThingWorx.
|
websocketProxies.0.disabled
|
S'il est défini sur true, ce paramètre désactive le proxy socket Web ThingWorx. S'il est défini sur false , il active le proxy.
|
websocketProxies.0.target
|
URL de base utilisée pour établir un socket Web entre le client et le serveur ThingWorx. Cette URL doit être compatible avec la valeur spécifiée pour proxies.0.target. Par exemple, si proxies.0.target est défini sur https://twx.acme.com:8443/Thingworx, ce paramètre doit être défini sur wss://twx.acme.com:8443.
|
|
Ne connectez pas de périphériques et d'applications composites Edge au serveur ThingWorx à l'aide du proxy Experience ServiceThingWorx. Utilisez plutôt une connexion directe au serveur ThingWorx (à l'aide d'autres ports, ELB, etc.). Le proxy Experience ServiceThingWorx n'est pas conçu pour gérer la charge associée au trafic de périphériques EDGE et certains SDK Edge ne fonctionnent pas via un proxy.
|
|
Si Experience Service est déployé dans une grappe, vérifiez que les emplacements des fichiers de certificat et de clé sont accessibles par toutes les instances s'exécutant dans la grappe.
|
|
Des valeurs peuvent être spécifiées pour les propriétés PEM (httpsKeyPath, httpsCrtPath et httpsCaPath) ou la propriété PCKS12 (PFX) (httpsPfxPath), mais pas les deux.
|
Paramètre
|
Description
|
httpsKeyPath
|
Chemin d'accès au fichier contenant la clé privée codée en PEM.
|
httpsCrtPath
|
Chemin d'accès au fichier contenant le certificat public codé en PEM.
|
httpsCaPath
|
Chemin d'accès au fichier du paquet de certificat contenant les certificats publics codés en PEM pour les autorités de certification intermédiaires.
|
httpsCertPassphrase
|
Phrase secrète utilisée pour déchiffrer la clé privée codée en PEM ou le fichier d'archive codé en PCKS12 (PFX).
|
httpsPfxPath
|
Chemin d'accès au fichier contenant le fichier d'archive codé en PCKS12 (PFX).
|
|
Les chemins spécifiés pour ces paramètres de configuration peuvent être des chemins absolus ou relatifs. Les chemins absolus commencent par "/" et sont traités comme relatifs à la racine du système de fichiers, tandis que les chemins relatifs commencent par "./" et sont traités comme relatifs au répertoire d'installation d'Experience Service.
Sous Windows, un chemin absolu peut commencer par "/" ou par une lettre de lecteur, par ex. "C:/". Si le chemin absolu commence par "/", le chemin est traité comme étant relatif à la racine du lecteur qui contient le répertoire d'installation d'Experience Service.
|
Paramètre
|
Description
|
nohttp2
|
Ajoutez ce paramètre et définissez-le sur true afin d'enregistrer les images prises avec le widget Caméra durant une expérience dans un référentiel de ThingWorx.
Par exemple :
{
….. "nossl":true, "nohttp2":true } |
Paramètre
|
Description
|
hmtg.credentials.baseUrl
|
URL du service Cible de modèle. Ce paramètre est renseigné pour vous. La valeur est :
https://vws.vuforia.com
|
hmtg.credentials.tokenPath
|
Chemin de requête HTTP pour l'authentification OAuth2. Ce paramètre est renseigné pour vous. La valeur est :
oauth2/token
|
hmtg.credentials.amtgPath
|
Chemin de requête HTTP pour la génération d'une cible de modèle avancée. Ce paramètre est renseigné pour vous. La valeur est :
modeltargets/advancedDatasets
|
hmtg.credentials.accessKey
|
La valeur de ce paramètre doit être obtenue auprès du Support technique de PTC. Pour plus d'informations, consultez la rubrique Demande d'informations pour activer la génération de cibles de modèles avancées.
|
hmtg.credentials.secretKey
|
La valeur de ce paramètre doit être obtenue auprès du Support technique de PTC. Pour plus d'informations, consultez la rubrique Demande d'informations pour activer la génération de cibles de modèles avancées.
|
Paramètre
|
Description
|
publicAccess
|
Activez ou désactivez l'option de publier des projets dont le champ Accès est défini sur Public dans Vuforia Studio.
Par exemple :
{
….. "publicAccess":{ "disabled": true } |