|
Experience Service をインストールするためにインストーラを使用する場合、これらのパラメータはインストーラによって設定されます。
|
|
シングルサインオン認証を設定する場合は、以下の「シングルサインオン (SSO) 認証のコンフィギュレーションパラメータ」のセクションを参照してください。
|
パラメータ
|
説明
|
authentication.type
|
「基本認証」を使用する場合は、このパラメータを twxUser に設定する必要があります。
|
authentication.baseURL
|
認証に使用する ThingWorx サーバーの URL。例: https://twx.example.com:8443
|
authentication.authorization.appKey
|
ThingWorx グループのメンバーシップを読み取るため、Experience Service によって使用される ThingWorx のアプリケーションキー。グループのメンバーシップは、ユーザーが所属する Experience Service の役割や、ユーザーに付与されているアクセス許可の特定に使用します。
認証のアプリケーションキーを設定する方法の詳細については、ThingWorx グループのメンバーシップに対するアクセスの設定を参照してください。
|
authentication.authorization.refreshRate
|
このパラメータは、Experience Service の役割のメンバーシップを ThingWorx グループのメンバーシップと同期化する頻度を決定します。値はミリ秒単位で指定します。
デフォルトでは、この時間は 5 分に設定されます。最短で 30 秒に設定できます。
|
パラメータ
|
説明
|
authentication.type
|
これは、SSO を使用するように Experience Service を設定するときに、openidUser に設定する必要があります。
|
authentication.baseUrl
|
基本認証が使用され、認証タイプに関係なくグループメンバーシップの同期に使用される際に、認証に使用される ThingWorx サーバーの URL。例: https://twx.example.com:8443。
|
authentication.authorization.refreshRate
|
このパラメータは、Experience Service の役割のメンバーシップを ThingWorx グループのメンバーシップと同期化する頻度を決定します。値はミリ秒単位で指定します。
デフォルトでは、この時間は 5 分に設定されます。最短で 30 秒に設定できます。
|
authentication.openid.issuer
|
この値を、PingFederate のコンフィギュレーション例の「SSO コンフィギュレーションパラメータ」セクションで識別した <as-base-url> パラメータと同じ値に設定します。
|
authentication.openid.clientId
|
この値を、PingFederate のコンフィギュレーション例の「SSO コンフィギュレーションパラメータ」セクションで識別した <es-client-id> パラメータと同じ値に設定します。
|
authentication.openid.clientSecret
|
この値を、PingFederate のコンフィギュレーション例の「SSO コンフィギュレーションパラメータ」セクションで識別した <es-client-secret> パラメータと同じ値に設定します。
|
authentication.openid.redirectUri
|
この値を、PingFederate のコンフィギュレーション例の「SSO コンフィギュレーションパラメータ」セクションで識別した <es-redirect-uri> パラメータと同じ値に設定します。
|
authentication.openid.session.maxAge
|
ユーザーが OpenID Connect を使用して Experience Service で認証を行うと、そのユーザーに対してセッションが作成されます。このプロパティは、セッションが無効になり、ユーザーが再認証しなければならなくなるまでの経過時間を指定します。この設定のデフォルト単位はミリ秒です。ただし、その値に単位名を追加することで、別の単位を指定できます。たとえば、「10 hours」などです。以下の単位がサポートされています。
• 秒: seconds、s
• 分: minutes、m
• 時間: hours、hrs、hour、h
• 日: days、day、d
|
authentication.openid.externalScope
|
これは、oauth2 を使用して ThingWorx API にアクセスするために必要です。この値は、ThingWorx をリソースプロバイダとして使用するために ThingWorx で設定されているものと同じ値に設定する必要があります。
|
authentication.openid.esScope
|
この値を、PingFederate のコンフィギュレーション例の「SSO コンフィギュレーションパラメータ」セクションで識別した <es-scope> パラメータと同じ値に設定します。
|
authentication.openid.studioClientId
|
Studio クライアント ID の名前を入力します。このフィールドのデフォルト値は PTC_Studio_Client_ID です。ただし、これが別の値に設定されている場合は、ここで入力する必要があります。
|
authentication.openid.claimsMapping.username
|
これは、OpenID Connect Policy で指定されている sub 属性の値と同じになるように設定します。詳細については、OpenID ポリシーコンフィギュレーションの手順 9 を参照してください。
|
|
Experience Service をクラスタにデプロイする場合は、クラスタで実行されているすべてのインスタンスが、データストアディレクトリ (projects.store、reps.store、upgrade.store) にアクセスできるようにしてください。
|
パラメータ
|
説明
|
projects.storePath
|
プロジェクトのコンテンツを保存するディレクトリへのパス。
|
projects.staticOps.maxAge
|
プロジェクトのコンテンツがクライアントにダウンロードされる際に応答に含まれる max-age ヘッダーの値を指定します。
|
reps.storePath
|
表示リポジトリのコンテンツを保存するディレクトリへのパス。
|
reps.staticOps.maxAge
|
表示コンテンツがクライアントにダウンロードされる際に応答に含まれる max-age ヘッダーの値を指定します。
|
upgrade.storePath
|
移行の成功ファイルを保存するディレクトリへのパス。これらのファイルは、アップグレードでデータの移行タスクが正常に完了したことを示します。これにより、移行が繰り返されるのを防ぎます。
|
|
これらのコンフィギュレーションパラメータに対して指定するパスは、絶対パスでも相対パスでもかまいません。絶対パスは「/」で始まり、ファイルシステムのルートに対する相対パスとして扱われる一方、相対パスは「./」で始まり、Experience Service のインストールディレクトリに対する相対パスとして扱われます。
|
|
SQLite は Experience Service とともにインストールされます。PostgreSQL は個別に取得してインストールする必要があります。
|
パラメータ
|
説明
|
||
dbHandler
|
このパラメータは次のどちらかに設定します。
• SQLiteHandler: SQLite を使用している場合
• postgresHandler: PostgreSQL を使用している場合
|
||
db.datafilePath
|
このパラメータを適用するのは、SQLite を使用していて、SQLite データファイルへのパスが指定されている場合のみになります。Experience Service を起動すると、データファイルが (存在しない場合は) 作成されます。
|
||
db.connectionString
|
このパラメータを適用するのは、PostgreSQL を使用していて、PostgreSQL データベースへの接続に使用される接続文字列が指定されている場合のみになります。接続文字列のフォーマットは次のとおりです。
postgres://<データベースユーザー名>:<データベースパスワード>@<ホスト>:<ポート>/<データベース名>
使用する資格証明には、PostgreSQL データベースに新しいデータベーステーブルを作成するための十分なアクセス許可が付与されている必要があります。
|
パラメータ
|
説明
|
enable_irs_federation
|
このパラメータを true に設定すると IRS フェデレーションが有効になり、false を設定すると IRS フェデレーションが無効になります。
|
domain_id_resolver
|
ほかの Experience Service のエクスペリエンスをクエリーする際に使用するベース URL。これは IRS フェデレーションが有効になっている場合にのみ必要になります。通常は、PTC が提供する Global experience Index (GXI) のベース URL を使用する必要があります。
https://gxi.vuforia.io/VuforiaExperienceService/id-resolution/resolutions/
|
パラメータ
|
説明
|
||
logsPath
|
ログファイルのパスを記述する glob パターン。これはデフォルトで /var/logs/thingserver.log* に設定されます。これにより、thingserver.log で始まる名前を持つ /var/logs 内のすべてのファイルがダウンロードできるようになります。
|
trustProxy 設定
|
クライアント IP
|
プロトコル
|
false (デフォルト)
|
リクエストを送信したクライアントの IP
|
リクエストのプロトコル
|
true
|
X-Forwarded-For ヘッダー内の最も左のエントリ
|
X-Forwarded-Proto ヘッダーの値
|
IP フィルタ基準
|
そのリストをフィルタして、指定したフィルタ基準に一致するエントリを除去した後の、X-Forwarded-For ヘッダー内の最も左のエントリ (フィルタ基準の作成方法の詳細については、以下を参照してください)。
|
X-Forwarded-Proto ヘッダーの値
|
整数 (n)
|
X-Forwarded-For ヘッダーの右から n 番目のエントリ
|
X-Forwarded-Proto ヘッダーの値
|
フィルタオプション
|
フィルタされるアドレス
|
loopback
|
次のサブネットに属する任意のアドレス:
• IPv4: 127.0.0.1/8
• IPv6: ::1/128
|
linklocal
|
次のサブネットに属する任意のアドレス:
• IPv4: 169.254.0.0/16
• IPv6: fe80::/10
|
uniquelocal
|
次のいずれかのサブネットに属する任意のアドレス:
• IPv4: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16
• IPv6: fc00::/7
|
<ip address>
|
指定された IP アドレス (例: 203.0.113.13)
|
ユースケース
|
trustProxy パラメータの設定
|
X-Forwarded-* ヘッダー内の情報を無視します。
|
false
|
X-Forwarded-For ヘッダー内のすべてのエントリ (最も左のエントリを除く) を既知の信頼されたプロキシとして処理します。最も左のエントリはクライアント IP として扱われます。
|
true
|
ローカルホストのみを、既知の信頼されたプロキシとして処理します。
|
"loopback"
|
ローカルホストと IP アドレス (203.0.113.13 および 203.0.113.15) を信頼されたプロキシとして処理します。
|
"loopback, 203.0.113.13,203.0.113.15"
|
ローカルホストとローカルネットワーク上のすべてのホストを、既知の信頼されたプロキシとして処理します。
|
"loopback, linklocal, uniquelocal"
|
|
ThingWorx サーバーは、デフォルトとは異なるドメインを使用するように設定されている場合があります。
|
パラメータ
|
説明
|
proxies.0.autoRewrite
|
true に設定すると、Experience Service はクライアントがプロキシ経由でリダイレクトされるようにするため、ThingWorx サーバーによって提供されたすべてのリダイレクト URI を変更します。たとえば、Experience ServiceThingWorx プロキシは https://es.example.com/Thingworx に存在し、プロキシ対象の ThingWorx サーバーは https://twx.example.com/Thingworx に存在するとします。ThingWorx サーバーがクライアントを https://twx.example.com/Thingworx/something にリダイレクトすると、Experience Service はこの URL を https://es.example.com/Thingworx/something に書き換えます。このプロパティを false に設定すると、Experience Service はこれらのリダイレクト URI を書き換えません。
|
proxies.0.protocolRewrite
|
このパラメータは、リダイレクト URI の書き換え時に使用するプロトコルを特定します。たとえば、Experience Service がセキュリティで保護された HTTPS モードで実行されていて、ThingWorx サーバーがセキュリティで保護されていない HTTP モードで実行されているとします。この場合、このパラメータを HTTPS に設定する必要があります。これにより、リダイレクト URI の書き換え時に、Experience Service プロキシによって使用されているプロトコルを使用するようにリダイレクト URI が書き換えられます。
|
proxies.0.secure
|
true に設定すると、Experience ServiceThingWorx プロキシはプロキシ対象の ThingWorx サーバーによって使用されている権限のない (自己署名された) 証明書を却下します。したがって、プロキシ対象の ThingWorx サーバーが自己署名証明書を使用している場合は、このパラメータを false に設定する必要があります。
|
websocketProxies.0.autoRewrite
|
このパラメータは、proxies.0.autoRewrite パラメータが HTTP プロキシの書き換え動作を制御する場合と同じ方法で、Web ソケットプロキシのリダイレクト書き換え動作を制御します。
|
websocketProxies.0.protocolRewrite
|
このパラメータは、proxies.0.protocolRewrite パラメータが HTTP プロキシの書き換え動作を制御する場合と同じ方法で、Web ソケットプロキシのリダイレクト URI の書き換え時に使用するプロトコルを制御します。有効なプロトコルの選択肢は ws または wss です。
|
websocketProxies.0.secure
|
このパラメータは、proxies.0.secure パラメータが HTTP プロキシで権限のない (自己署名された) 証明書を却下するかどうかを制御する場合と同じ方法で、権限のない (自己署名された) 証明書を却下するかどうかを Web ソケットプロキシで制御します。
|
proxies.0.disabled
|
true に設定すると、このパラメータは ThingWorx プロキシを無効にします。false に設定すると、プロキシを有効にします。
|
proxies.0.target
|
ThingWorx サーバーのベース URL です。この URL は /Thingworx で終る必要があります。例: https://twx.acme.com:8443/Thingworx
|
proxies.0.appKey
|
パブリックエクスペリエンスに ThingWorx データへのアクセスを付与するため、Experience Service によって使用される ThingWorx アプリケーションキー。パブリックエクスペリエンスと ThingWorx へのパブリックアクセスの設定の詳細については、ThingWorx に対するパブリックアクセスの設定を参照してください。
|
websocketProxies.0.disabled
|
true に設定すると、このパラメータは ThingWorx Web ソケットプロキシを無効にします。false に設定すると、プロキシを有効にします。
|
websocketProxies.0.target
|
クライアントと ThingWorx サーバー間の Web ソケットの確立に使用されるベース URL。この URL は proxies.0.target に指定されている値と互換性がある必要があります。たとえば、proxies.0.target が https://twx.acme.com:8443/Thingworx に設定されている場合は、このパラメータを wss://twx.acme.com:8443 に設定する必要があります。
|
|
Edge デバイスとマッシュアップを Experience ServiceThingWorx プロキシを使用して ThingWorx サーバーに接続しないようにしてください。代わりに、ThingWorx サーバーに (別のポートや ELB などを使用して) 直接接続するようにしてください。Experience ServiceThingWorx プロキシは Edge デバイスのトラフィック関連の負荷に対応するように設計されていません。また、特定の Edge SDK はプロキシ経由で機能しません。
|
|
Experience Service をクラスタにデプロイする場合は、クラスタ内で実行されているすべてのインスタンスが、キーの場所と証明書ファイルの場所にアクセスできるようにしてください。
|
|
値は、PEM プロパティ (httpsKeyPath、httpsCrtPath および httpsCaPath) または PCKS12 (PFX) プロパティ (httpsPfxPath) に対して指定できますが、これらの両方に対しては指定できません。
|
パラメータ
|
説明
|
httpsKeyPath
|
PEM でエンコードされた秘密キーを含むファイルへのパス。
|
httpsCrtPath
|
PEM でエンコードされた公開証明書を含むファイルへのパス。
|
httpsCaPath
|
中間証明機関の PEM でエンコードされた公開証明書を含む証明書バンドルファイルへのパス。
|
httpsCertPassphrase
|
PEM でエンコードされた秘密キーまたは PCKS12 (PFX) でエンコードされたアーカイブファイルの暗号解読に使用するパスフレーズ。
|
httpsPfxPath
|
PCKS12 (PFX) でエンコードされたアーカイブファイルを含むファイルへのパス。
|
|
これらのコンフィギュレーションパラメータに対して指定するパスは、絶対パスでも相対パスでもかまいません。絶対パスは「/」で始まり、ファイルシステムのルートに対する相対パスとして扱われる一方、相対パスは「./」で始まり、Experience Service のインストールディレクトリに対する相対パスとして扱われます。
Windows では、絶対パスは "/" またはドライブ文字 (たとえば "C:/") で開始できます。絶対パスが "/" で始まる場合、パスは、Experience Service インストールディレクトリを含むドライブのルートに対して相対的に扱われます。
|
パラメータ
|
説明
|
nohttp2
|
エクスペリエンス中にカメラウィジェットで撮影したイメージを ThingWorx のリポジトリに保存するには、このパラメータを追加して true に設定します。
例:
{
….. "nossl":true, "nohttp2":true } |
パラメータ
|
説明
|
hmtg.credentials.baseUrl
|
モデルターゲットサービスの URL。このパラメータは自動的に入力されます。値は次のとおりです。
https://vws.vuforia.com
|
hmtg.credentials.tokenPath
|
OAuth2 認証の HTTP リクエストパス。このパラメータは自動的に入力されます。値は次のとおりです。
oauth2/token
|
hmtg.credentials.amtgPath
|
アドバンスモデルターゲット生成の HTTP リクエストパス。このパラメータは自動的に入力されます。値は次のとおりです。
modeltargets/advancedDatasets
|
hmtg.credentials.accessKey
|
このパラメータの値は、PTC テクニカルサポートから取得する必要があります。詳細については、アドバンスモデルターゲット生成を有効にするための情報のリクエストを参照してください。
|
hmtg.credentials.secretKey
|
このパラメータの値は、PTC テクニカルサポートから取得する必要があります。詳細については、アドバンスモデルターゲット生成を有効にするための情報のリクエストを参照してください。
|
パラメータ
|
説明
|
publicAccess
|
Vuforia Studio で「アクセス」フィールドが「パブリック」に設定されているプロジェクトをパブリッシュする機能を無効または有効にします。
例:
{
….. "publicAccess":{ "disabled": true } |