概要
TDV ServerからTIBCO Sportfire ServerのSOAP APIを実行する方法について説明します。
本手順ではUserDirectoryServiceを利用します。
WSDLのURLは以下のとおりです。http[s]://<Spotfire Serverのホスト>[:<port>]/spotfire/api/soap/UserDirectoryService/wsdl
検証環境
| 製品 | バージョン | 備考 |
|---|---|---|
| TDV Server |
8.5.5 |
RHEL8環境で実行 |
| TIBCO Spotfire Server |
12.5.0 |
Windows Server 2019環境で実行 |
OAuth2 APIクライアント登録
Spotfire ServerのSOAP APIを利用するためには、OAuth2 APIクライアントを登録する必要があります。
以下の手順に従って登録します。
1. Spotfire Serverにリモートデスクトップでログインし、管理者権限でコマンドプロンプトを起動し、<Spotfire Serverインストールフォルダ>tomcat\spotfire-binに移動します。
2. register-api-clientコマンドを実行し、APIクライアントを登録します。
config.bat register-api-client -n tdv-apiclient -Sapi.soap.user-directory-service
実行例は以下のとおりです。
コマンドの実行に成功すると、クライアントIDとクライアントシークレットが出力されます。
このクライアントIDは後続の手順で利用します。
アクセストークン要求
続いて、先ほど取得したクライアントIDを利用してアクセストークンを要求します。
config.bat issue-access-token -i <クライアントID> -Sapi.soap.user-directory-service -v <有効期間（単位：時間）>
実行例は以下のとおりです。
TDV SOAPアダプタでイントロスペクト
TDVのSOAPデータソースを新規作成し、以下の項目を入力して接続・イントロスペクトを実行します。
- WSDLのURL
- 取得したアクセストークン
動作確認
いくつかの操作を実行し、動作を確認します。
getMembers
特定のSpotfire既存グループのメンバー一覧を取得します。
ここでは、Administratorグループのメンバー一覧を取得する要求電文を記述し、実行します。
メンバー一覧が取得されたことを確認します。
createUser
Spotfireに新規ユーザーを作成します。
ここでは、SOAP_TESTUSER001というユーザーをSPOTFIREドメイン内に作成するための要求電文を記述し、実行します。
ユーザー作成に成功することを確認します。
APIクライアントの権限が不足しているため以下のようにAPIの実行に失敗する場合は、
Spotfire Analystの管理マネージャから該当のAPIクライアントをAdministratorグループに所属させてください。