Page History
Anchor | ||||
---|---|---|---|---|
|
以下のwebサービスは、ローカルデータベースに接続された複数のノード間でYellowfinを設定するクラスタ環境内で使用されます。大部分は、クラスタノード間でメッセージを送信したり、データがローカルで更新、または削除された時に特定ノードのキャッシュをクリアすることで、クラスタ全体を通したコンテンツの一貫性を確保するために使用されます。各サービスは、特定のタイプのコンテンツやデータを削除します。
以下のwebサービスは、インメモリストレージとデータの管理を提供するキャッシュを管理するために使用します。
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、バイナリclasローダー内のclassを削除するために使用します。例えば、コネクターやデータトランスフォーメーションステップのように、ファイルシステム上ではなく、データベース内に保存されるプラグインとして読み込まれるclassなどが該当します。こちらのwebサービスは、バイナリclassローダー内のclassを削除するために使用します。例えば、コネクターやデータトランスフォーメーションステップのように、ファイルシステム上ではなく、データベース内に保存されるプラグインとして読み込まれるclassなどが該当します。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、新規Yellowfinライセンスをアップロードするために使用します。こちらのwebサービスは、Yellowfinインスタンスに新規ライセンスをアップロードするために使用します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、ジオパックキャッシュから指定したジオパックを削除しますが、サーバから対象のジオパックを削除するわけではありません。こちらのwebサービスは、ジオパックキャッシュから指定したジオパックを削除します。これは、サーバ上のジオパックは削除しない点に注意をしてください。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例こちらのサービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、特定のダッシュボードに関連するキャッシュフィルターを更新します。対象のダッシュボードは、そのID、またはUUIDを提供することで指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、特定のビューに関連するキャッシュフィルターを更新します。対象のビューは、そのID、またはUUIDを提供することで指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
こちらのサービスは、特定のデータソース接続のすべてのアクセスソースフィルターを更新します。 こちらのwebサービスは、Yellowfin内の指定した参照コードを読み込みます。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | | ||||||||||||||||||||||||||||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADCODES"); |
Yellowfinに読み込む必要のある参照コードをします。
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
この関数は、ターゲットソースIDとなるひとつの文字列のみをパラメーターとして要求します。この値は、reportviewsourceテーブルのSourceIdカラム(列)から見つけることができます。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>REFRESH_SOURCE_FILTERS</function>
|
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_reloadcodes.jsp *<parameters>54700</ %>parameters> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("RELOADCODES"); rsr.setParameters(new String[] { "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS" }); rs = rssbs.remoteAdministrationCall(rsr); </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは今回のSOAPの例に基づき、以下の応答を返します。
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>13143fc20f2d7eeb52ec27f588a9942f</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
|
完成例
title | GEOMETRYFLUSH |
---|
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_refresh_source_filters.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_refresh_source_filters.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_refresh_source_filters.jsp */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account
rsr.setPassword("test"); // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("REFRESH_SOURCE_FILTERS");
rsr.setParameters(new String[] {"54700"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内の指定した参照コードを再読み込みします。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内のジオメトリーキャッシュをクリアします。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内のビューのキャッシュを削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、レポートのキャッシュされた定義を削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは今回のSOAPの例を基に、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内のダッシュボードタブのキャッシュされた定義を削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、このリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、キャッシュされたユーザーの詳細を削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、このリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内のライセンスを再読み込みします。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAP XMLの例は、必須パラメーターを使用して、こちらのパラメーターを実行する方法を示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例以下のSOAP XMLの応答が、 今回の例に基づき返されます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、指定したデータソースのコネクションプールを閉じます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAP XMLの例は、必須パラメーターを使用してこのリクエストを実行する方法を示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例今回の例に基づき、以下のSOAP XMLの応答が返されます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
こちらのwebサービスは、Yellowfin内のジオメトリーキャッシュをクリアします。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH"); |
ジオメトリーオブジェクトを更新するビューを指定します。
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"70103", "70104"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_geometryflush.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_geometryflushcloseconnectionpool.jsp」を実行します。
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<%<% /* /* ws_geometryflushcloseconnectionpool.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService tss_adm = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) tss_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); // provide rsr.setOrgId(new Integer(1)); rsr.setFunction("GEOMETRYFLUSH"); your Yellowfin web services admin account rsr.setPassword("test"); //View IDs from which geometry objects are to be removed rsr.setParameters(new String[] { "70103", "70104" }); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("CLOSECONNECTIONPOOL"); rsr.setParameters(new String[] {"74909"}); AdministrationServiceResponse rs = rssbsadminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success </br><br>Success"); } else { out.write(rs.getStatusCode()); } else { out.write(rs.toString()); } |
title | REMOVEVIEW |
---|
こちらのwebサービスは、Yellowfin内のビューのキャッシュを削除します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「REMOVEVIEW」に設定します。 |
Parameters | String[] | キャッシュを削除するビューのIDです。 |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||
---|---|---|---|---|
| ||||
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。 Code Block | | |||
|
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"70103", "70104"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
%> |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、キャッシュされたテキストエンティティを削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、必須パラメーターを使用してこのリクエストを実行するSOAP XMLの例を示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例今回の例に基づき、以下のSOAP XMLの応答が返されます。
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 こちらのwebサービスは、Yellowfin内のレポートキャッシュの定義を削除します。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
こちらのwebサービスは、Yellowfin内のダッシュボードタブのキャッシュ定義を削除します。 こちらのwebサービスは、キャッシュされたフィルター定義を削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例返される応答には、これらのパラメーターが含まれます。以下は、必須パラメーターを使用してこちらのリクエストを実行するSOAP XMLの例を示しています。 応答要素
| データ型 | 説明 | |||||||||||||||||||||
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||
---|---|---|---|---|
| ||||
| ||||
language | java | |||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB"); |
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"61251", "61253"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>FLUSHCACHEDFILTERCACHE</function>
<parameters>74909</parameters>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
今回の例に基づき、以下のSOAP XMLの応答が返されます。
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
|
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_flushtab.jsp <messages>Successfully Authenticated */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_flushcachedfilter.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_flushcachedfilter.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* //Dashboard tab IDs whose definitions are to be removed from the cache rsr.setParameters(new String[] { "61251", "61253" ws_flushcachedfilter.jsp }); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success </br>"); } else { out.write(rs.getStatusCode() */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new out.write(rs.toString()AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); } |
title | RELOADLICENCE |
---|
こちらのwebサービスは、Yellowfin内のライセンスを再読み込みします。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「RELOADLICENCE」に設定します。 |
リクエストの例
以下のSOAP XMLの例は、必須パラメーターを使用して、こちらのパラメーターを実行する方法を示しています。
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("FLUSHCACHEDFILTERCACHE"); //Specify filter ID to flush its cache rsr.setParameters(new String[] { <arg0> "12323" }); <loginId>admin@yellowfin.com.au</loginId> rs = rssbs.remoteAdministrationCall(rsr); <password>test</password> if ("SUCCESS".equals(rs.getStatusCode())) { <orgId>1</orgId>out.write("Success </br>"); } else { <function>RELOADLICENCE</function> out.write(rs.getStatusCode()); </arg0>out.write(rs.toString()); </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>} |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、キャッシュから指定したドキュメントを削除します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、必須パラメーターを使用してこちらのリクエストを実行するSOAP XMLの例を示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例以下のSOAP XMLの応答が、 今回の例に基づき返されます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE"); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
今回の例に基づき、以下のSOAP XMLの応答が返されます。
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
|
Code Block | ||||
---|---|---|---|---|
| ||||
<% <return> /* ws_reloadlicence.jsp <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>fe029927cc6aae20446f1a8caf25e83a</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_removedocument.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_removedocument.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_removedocument.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("RELOADLICENCE"); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success </br>"); } else { */ %> <%@ page out.write(rs.getStatusCode()); out.write(rs.toString()); } |
title | CLOSECONNECTIONPOOL |
---|
こちらのwebサービスは、指定したデータソースのコネクションプールを閉じます。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「CLOSECONNECTIONPOOL」に設定します。 |
Parameters | String[] | コネクションプールを閉じるデータソースのIDです。 |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||
---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。 Code Block | | |||
| ||||
Code Block | ||||
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
<% /* rsr.setParameters(new String[] { "70103" ws_closeconnectionpool.jsp}); rs = rssbs.remoteAdministrationCall(rsr); if */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("CLOSECONNECTIONPOOL"); //Data source IDs whose connection pools are to be closed rsr.setParameters(new String[] {("SUCCESS".equals(rs.getStatusCode())) { out.write("Success </br>"); } else { out.write(rs.getStatusCode()); out.write(rs.toString()); } %> |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、特定のコンテンツのアクセス権限を更新します。コンテンツはパラメーター要素を介してそのIDを提供することで指定します。これはレポートID、ダッシュボードタブID、またはETLプロセス(データトランスフォーメーションフロー)UUIDになります。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、必須パラメーターを使用してこちらのリクエストを実行するSOAP XMLの例を示しています。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、指定したフィルターのフィルターキャシュをクリアします。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例手順今回の例に基づき、以下のSOAP XMLの応答が返されます。Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。 返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「DELETEVIEW」に設定します。 |
Parameters | String[] | 削除するビューのID、またはUUIDです。 |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
title | 詳細手順 |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW"); |
ID、またはUUIDを提供することで、削除するビューを指定します。
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"70103"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
"70103" });
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success </br>");
} else {
out.write(rs.getStatusCode());
out.write(rs.toString());
}
%> |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、クラスタのメッセージングに使用します。これは、ローカルでコンテンツ管理レコードが変更されたり、削除された時に、リモートキャッシュからこれを削除します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例このサービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_deleteview.jsp */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
//Specify the view to be deleted by providing its ID or UUID
rsr.setParameters(new String[] {
"70103"
});
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success </br>");
} else {
out.write(rs.getStatusCode());
out.write(rs.toString());
} |
title | DELETESOURCE |
---|
こちらのwebサービスは、指定したデータソースを削除する場合に使用します。IDを提供することで、データソースを識別することができます。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「DELETESOURCE」に設定します。 |
Parameters | String[] | 削除するデータソースのIDです。 |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
title | 詳細手順 |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE"); |
ID、またはUUIDを提供することで、削除するデータソースを指定します。
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setParameters(new String[] {
"40563"
}); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deletesource.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deletesourceremovecontentmanagement.jsp」を実行します。
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<% /* ws_deletesourceremovecontentmanagement.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest();<% AdministrationServiceService tss_adm = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) tss_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("DELETESOURCE"); //Specify theset datato sourcethe topassword beof deletedthe by providing its ID account above rsr.setOrgId(1); rsr.setFunction("REMOVECONTENTMANAGEMENT"); rsr.setParameters(new String[] { "40567" "73118"}); AdministrationServiceResponse rs = rssbsadminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success </br><br>Success"); } } else { out.write(rs.getStatusCode()"<br>Failure"); out.write(" Code: " + rs.toStringgetErrorCode()); } } |
...
|
horizontalrule |
---|
Styleclass | ||
---|---|---|
| ||
...