Web Playerサービス設定を変更するには以下の手順に従って実施してください。
※手順はSpotfire Server 12.0 LTSで画面コピーを取得して記載していますが、Spotfire Server 10.10 LTS以降には利用可能です。
①現行Web Playerサービス設定の確認
ブラウザからSpotfire ServerのURLへアクセスし、Spotfire管理者権限でログインしてWeb管理画面「Nodes & Services」⇒「Network」を開いて対象Web Playerサービスを選択して「Configuration」部分を確認してください。
ここで確認した結果には2つの可能性があります。
1.Configurationに「Default」が表示されている場合はWeb Playerサービスのデフォルト設定を使っていることになります。この場合は次のステップではデフォルト設定をエクスポートして編集します。
2.Configurationに「Default」以外の設定名が表示されている場合、過去にWeb Playerサービスの設定を変更したことがあることを示しております。この場合は次のステップでは既存設定(Configuration部分に表示されている設定名、本例:wp-config-20230201)をエクスポートして編集します。
②現行Web Playerサービス設定のエクスポート
上記①の確認結果に従ってWeb Playerサービスの設定をエクスポートしてください。
1.Spotfire Server端末内でOS管理者権限でコマンドプロンプトを起動して、以下のインストール先フォルダへ移動してください。
C:\tibco\tss\12.0.0\tomcat\spotfire-bin
2.デフォルトの設定を利用している場合、以下のコマンド(export-service-config)を実行してWeb Playerサービスのデフォルト設定をエクスポートしてください。
※コマンド実行時にはConfiguration Toolのパスワードが必要です。(以下同)
config.bat export-service-config --capability=WEB_PLAYER --deployment-area=Production --platform=WINDOWS -f
引数の説明:
・「--capability=WEB_PLAYER --deployment-area=Production --platform=WINDOWS」はWindows版Web Playerサービスのデフォルト設定をエクスポートすることを示しています。「Production」以外のデプロイメントエリアを利用している場合はそれに合わせて書き換えてください。※Spotfire 12.0より前のバージョンの場合は引数「--platform=WINDOWS」が利用できないため指定しないでください。
・「-f」はエクスポート先フォルダやファイルが既に存在している場合に強制的に上書きすることを示しています。
※コマンド実行時に出力先のファイルが既に存在しており、かつテキストエディタによって開かれている場合にはコマンドの実行が失敗してしまいますので事前にテキストエディタを閉じてください。
3.デフォルト以外の設定を利用している場合、以下のコマンドを実行して該当設定をエクスポートしてください。
config.bat export-service-config --config-name=wp-config-20230201 -f
引数の説明:
・「--config-name=wp-config-20230201」には現行設定の名前(本例:wp-config-20230201)を指定します。
4.エクスポートされたファイルを確認してください。
Web Playerサービスの設定は作業フォルダの下に(サブフォルダ「config\root\」)以下の4つファイルにエクスポートされます。
・log4net.config:Web Playerサービスのログ出力設定(Apache Log4netを利用、参考資料)
・Spotfire.Dxp.Worker.Core.config:Web PlayerサービスとSpotfire Server間の通信に関する設定(参考資料)
・Spotfire.Dxp.Worker.Host.exe.config:Web Playerサービス設定(参考資料)
・Spotfire.Dxp.Worker.Web.config:Web Playerサービス設定(参考資料)
③設定ファイル編集による設定変更
エクスポートされたファイルをテキストエディターで開いて必要に応じて変更箇所を編集してください。
例えば、すべての外部ファイルへのアクセスを許可するには設定ファイル「Spotfire.Dxp.Worker.Host.exe.config」を編集して、以下の太字の部分(AllowAllFilePathsをTrueに設定)を追記してください。
・Spotfire.Dxp.Worker.Host.exe.config
<!--A list of paths determining which parts of the file system may be accessed by file data sources-->
<setting name="AllowedFilePaths" serializeAs="Xml">
<value>
<ArrayOfString>
<string />
</ArrayOfString>
</value>
</setting>
<setting name="AllowAllFilePaths" serializeAs="String">
<value>True</value>
</setting>
...省略
例:
各設定ファイルはXML形式となっているためXMLの文法に従って編集してください。
特に誤って全角文字を使ってしまったり、もしくは下記赤い枠のようにタグの中にコメントを記載した場合は不正な設定になります。不正な設定であっても次のステップ④でインポートする際には正常に実施できますが、ステップ⑤で適用する際にはエラーが発生してしまい、対象Web Playerが立ち上がらなくなりますので十分注意して下さい。
④変更後設定のインポート
以下のコマンド(import-service-config)を実行して変更後の設定ファイルをインポートしてください。
config.bat import-service-config --config-name=wp-config-20230510
引数の説明:
・「--config-name=wp-config-20230510」にはインポートで作る設定名(任意文字列)を指定します。この名前は①で確認していた既存設定の名前を指定しても構いません(既存設定が上書きされます)。
引数--config-nameには「Default」を指定しないでください。「Default」を指定してもデフォルト設定を上書きすることにはなりません。
⑤インポートした設定の適用
Web管理画面「Nodes & Services」にて④でインポートした設定を対象Web Playerサービスに適用してください。
Web Playerサービスが複数存在している場合、同じ設定を複数のWeb Playerサービスともに適用しても構いません。
1.対象Web Playerサービスを選択して「Edit」を押してください。
2.ポップアップ画面に「Configuration」から対象設定(本例:wp-config-20230510)を選択してOKボタンを押して適用してください。
ここで対象Web Playerサービスが自動的に再起動されますので、ユーザー様の利用時間外に実施してください。
3.もし④で既存設定と同じ名前(本例:wp-config-20230201)でインポートした場合、Web管理画面をリフレッシュすると該当設定が更新されている旨を示すメッセージ(本例:wp-config-20230201 (New version of configuration available))が表示されます。
この場合はメッセージの部分をクリックするとWeb Playerサービスが再起動され、更新後設定が適用されます。
※補足
通常は上記の5つのステップでWeb Playerサービスの設定を変更できますが、一部設定項目の変更においては追加の手順が必要となります。これらの設定項目はWeb管理画面「Library」の動きを変更していますのでWeb PlayerサービスのほかにSpotfire Serverにも反映させる必要があります。
1.以下のセクションまたは設定項目を変更した場合、次のステップを追加で実施してください。
2.以下のコマンドを実行して、上記の設定変更をSpotfire Serverに反映させてください。
config.bat set-server-service-config --config-name=wp-config-20230510
コマンド名が「set-server-service-config」になっていることにご注意ください。
3.対象Spotfire Serverサービスを再起動してください。
参考資料
・Manually editing the service configuration files
以上