こちらで紹介するwebサービスの呼び出しは、コンテンツのエクスポートとインポートに関連しています。webサービスAPIは現在、以下のタイプのコンテンツのエクスポートとインポートを制限しています。
- レポート
- レポートカテゴリー
- レポートサブカテゴリー
- データソース
- ビュー
- ダッシュボード
- トランスフォーメーションフロー
エクスポートwebサービス
こちらのプロセスは、エクスポート可能な情報を取得し、他のサービスで再利用するために、エクスポートwebサービスを実行する方法を紹介します。
エクスポート可能なすべてのYellowfinコンテンツを取得するためには、GETCONTENT関数を使用します。これは、すべてをエクスポートする場合にも役立ちます。
こちらの関数は、Yellowfinコンテンツの詳細を含む、ContentResourceオブジェクトの配列を返し、これは他の呼び出しで詳細をインポート、エクスポート、検証するために再利用することができます。
独自のエクスポート一覧を構成し、コンテンツ定義をContent Resourceオブジェクトに配置することもできます。オブジェクト定義は、各Yellowfinコンテンツに必要となる要素を明確にします。
Yellowfinの各コンテンツタイプで、オブジェクトのresorceType値を把握する必要があります。
すべてのコンテンツタイプの依存関係を手動で検索する代わりに、GETEXPORTDEPENDRNCIES関数を使用して、ContentResorceオブジェクトにその詳細を格納することで、依存関係が必要なコンテンツを指定します。
例えば、あるダッシュボードをエクスポートする場合、その特定のダッシュボードを表す単一のオブジェクトをContentResorceに含めることができます。この関数は、レポート、ビュー、データソース、カテゴリー、サブカテゴリーを含むダッシュボードの依存関係を返します（これらは、ContentResourceオブジェクト配列として返されます）
YellowfinコンテンツとともにXMLファイルを取得する場合は、複数のContentResorceオブジェクトの配列を作成し、EXPORTCONTENT関数を呼び出します。このファイルは、異なるYellowfinの環境にインポートすることもできます。
注意：GETEXPORTDEPENDENCIESとEXPORTCONTENT webサービスは、クライアント組織リソースで適切に機能しません。デフォルト組織リソースでのみ、これらの関数を使用して、適切にエクスポートすることができます。
主要なエクスポート関数
こちらの関数は、エクスポート可能なすべてのYellowfinコンテンツを返します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
| リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「GETCONTENT」に設定します。 |
| OrgRef | String | こちらのオプションパラメーターは、クライアント組織IDを指定するために使用することができます。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>GETCONTENT</function>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
| ContentResorces | ContentResorce[] | エクスポート可能なYellowfinのコンテンツの詳細を含むオブジェクト配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<contentResources>
<resourceCode>AUDITREPORTS</resourceCode>
<resourceDescription>Audit Reports</resourceDescription>
<resourceId>56339</resourceId>
<resourceName>Audit Reports</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTCATEGORY</resourceType>
<resourceUUID>a6bdc6b5-a832-42a2-98c7-18273900d0aa</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>ADMINREPORTS</resourceCode>
<resourceDescription>Admin Reports</resourceDescription>
<resourceId>56340</resourceId>
<resourceName>Admin Reports</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>f7fb32b7-1573-4899-916f-c34afb9a865d</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>CONTENTUSAGE</resourceCode>
<resourceDescription>Content Usage</resourceDescription>
<resourceId>56341</resourceId>
<resourceName>Content Usage</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>6bae5230-c1f9-4491-8a8b-f14b1ae660d7</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>USERACCESS</resourceCode>
<resourceDescription>User Access</resourceDescription>
<resourceId>56342</resourceId>
<resourceName>User Access</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>0c7ddde4-fa03-4e88-b37b-7b5e4aad5e1d</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>TUTORIAL</resourceCode>
<resourceDescription>Tutorial</resourceDescription>
<resourceId>60706</resourceId>
<resourceName>Tutorial</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTCATEGORY</resourceType>
<resourceUUID>a23c2ec6-a2fa-45c7-b5da-dcf3f02e6633</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>ATHLETES</resourceCode>
<resourceDescription>Athletes</resourceDescription>
<resourceId>60707</resourceId>
<resourceName>Athletes</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>72e4b4bd-a482-4a01-a031-c6ab76dbb3a5</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>CAMP</resourceCode>
<resourceDescription>Camp</resourceDescription>
<resourceId>60708</resourceId>
<resourceName>Camp</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>465411e5-594b-478e-af64-c0f59fc4546f</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>KPIS</resourceCode>
<resourceDescription>KPIs</resourceDescription>
<resourceId>60709</resourceId>
<resourceName>KPIs</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>d514c643-dc01-4781-8905-d34e761ccd19</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>MARKETINGBOOKING</resourceCode>
<resourceDescription>Marketing & Booking</resourceDescription>
<resourceId>60710</resourceId>
<resourceName>Marketing & Booking</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>dbe6d0a3-c088-4d71-b65a-f383aaa54be9</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>TRAINING</resourceCode>
<resourceDescription>Training</resourceDescription>
<resourceId>60711</resourceId>
<resourceName>Training</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>c503ea57-cc69-43a9-98bc-a90ebbe1c864</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70101</resourceId>
<resourceName>Oracle database</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70109</resourceId>
<resourceName>Oracle</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription>Ski Team is the demonstration and tutorial database.</resourceDescription>
<resourceId>54700</resourceId>
<resourceName>Ski Team</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>54701</resourceId>
<resourceName>Yellowfin Configuration Database</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70108</resourceId>
<resourceName>c</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70110</resourceId>
<resourceName>f</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription>This is a tutorial view for training and demo purposes.</resourceDescription>
<resourceId>60543</resourceId>
<resourceName>Ski Team</resourceName>
<resourceType>VIEW</resourceType>
<resourceUUID>e3632adb-5194-460c-a172-c085416f493f</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This view should be used to monitor usage of Yellowfin by User and Content Type.</resourceDescription>
<resourceId>56169</resourceId>
<resourceName>Yellowfin Usage Audit</resourceName>
<resourceType>VIEW</resourceType>
<resourceUUID>fb6416c4-441e-42b3-a442-e7426f25f6b4</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This dashboard contains a set of reports covering general system and admin information, including performance, sessions, data source & view usage.</resourceDescription>
<resourceId>57438</resourceId>
<resourceName>Admin</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>GROUP</resourceType>
<resourceUUID>33827292-cda6-4071-965f-730ccbc53519</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This is an analytic tab that is used to understand examine metrics split by various demographics and filters.</resourceDescription>
<resourceId>61195</resourceId>
<resourceName>Analysis</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>GROUP</resourceType>
<resourceUUID>f19e63f5-7175-4c57-897d-ed865aba8972</resourceUUID>
</contentResources>
</contentResources>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>92029c8ae4f1db0f33bf0b7370c1088a</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETCONTENT");特定のクライアント組織を識別することもできます。
rsr.setOrgRef("org1");リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、次の要素が含まれます。：StatusCodeとContentResorce。（より詳細な情報は、上記応答パラメーターの表を参照してください）
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getcontent.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getcontent.jsp」を実行します。
<%
/* ws_getcontent.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 webservices admin account
rsr.setPassword("test"); // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("GETCONTENT");
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
ContentResource[] crs = rs.getContentResources();
out.write("<table>");
out.write("<tr><td> id </td><td> type </td><td> UUID </td></tr>");
for (ContentResource c: crs) {
out.write("<tr>");
out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceUUID() + "</td>");
out.write("</tr>");
}
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
こちらの関数は、
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
| リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「GETCONTENT」に設定します。 |
| OrgRef | String | こちらのオプションパラメーターは、クライアント組織IDを指定するために使用することができます。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>GETCONTENT</function>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
|
| ContentResorces | ContentResorce[] | エクスポート可能なYellowfinのコンテンツの詳細を含むオブジェクト配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<contentResources>
<resourceCode>AUDITREPORTS</resourceCode>
<resourceDescription>Audit Reports</resourceDescription>
<resourceId>56339</resourceId>
<resourceName>Audit Reports</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTCATEGORY</resourceType>
<resourceUUID>a6bdc6b5-a832-42a2-98c7-18273900d0aa</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>ADMINREPORTS</resourceCode>
<resourceDescription>Admin Reports</resourceDescription>
<resourceId>56340</resourceId>
<resourceName>Admin Reports</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>f7fb32b7-1573-4899-916f-c34afb9a865d</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>CONTENTUSAGE</resourceCode>
<resourceDescription>Content Usage</resourceDescription>
<resourceId>56341</resourceId>
<resourceName>Content Usage</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>6bae5230-c1f9-4491-8a8b-f14b1ae660d7</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>USERACCESS</resourceCode>
<resourceDescription>User Access</resourceDescription>
<resourceId>56342</resourceId>
<resourceName>User Access</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>0c7ddde4-fa03-4e88-b37b-7b5e4aad5e1d</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>TUTORIAL</resourceCode>
<resourceDescription>Tutorial</resourceDescription>
<resourceId>60706</resourceId>
<resourceName>Tutorial</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTCATEGORY</resourceType>
<resourceUUID>a23c2ec6-a2fa-45c7-b5da-dcf3f02e6633</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>ATHLETES</resourceCode>
<resourceDescription>Athletes</resourceDescription>
<resourceId>60707</resourceId>
<resourceName>Athletes</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>72e4b4bd-a482-4a01-a031-c6ab76dbb3a5</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>CAMP</resourceCode>
<resourceDescription>Camp</resourceDescription>
<resourceId>60708</resourceId>
<resourceName>Camp</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>465411e5-594b-478e-af64-c0f59fc4546f</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>KPIS</resourceCode>
<resourceDescription>KPIs</resourceDescription>
<resourceId>60709</resourceId>
<resourceName>KPIs</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>d514c643-dc01-4781-8905-d34e761ccd19</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>MARKETINGBOOKING</resourceCode>
<resourceDescription>Marketing & Booking</resourceDescription>
<resourceId>60710</resourceId>
<resourceName>Marketing & Booking</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>dbe6d0a3-c088-4d71-b65a-f383aaa54be9</resourceUUID>
</contentResources>
<contentResources>
<resourceCode>TRAINING</resourceCode>
<resourceDescription>Training</resourceDescription>
<resourceId>60711</resourceId>
<resourceName>Training</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>RPTSUBCATEGORY</resourceType>
<resourceUUID>c503ea57-cc69-43a9-98bc-a90ebbe1c864</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70101</resourceId>
<resourceName>Oracle database</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70109</resourceId>
<resourceName>Oracle</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription>Ski Team is the demonstration and tutorial database.</resourceDescription>
<resourceId>54700</resourceId>
<resourceName>Ski Team</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>54701</resourceId>
<resourceName>Yellowfin Configuration Database</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70108</resourceId>
<resourceName>c</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription/>
<resourceId>70110</resourceId>
<resourceName>f</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>DATASOURCE</resourceType>
</contentResources>
<contentResources>
<resourceDescription>This is a tutorial view for training and demo purposes.</resourceDescription>
<resourceId>60543</resourceId>
<resourceName>Ski Team</resourceName>
<resourceType>VIEW</resourceType>
<resourceUUID>e3632adb-5194-460c-a172-c085416f493f</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This view should be used to monitor usage of Yellowfin by User and Content Type.</resourceDescription>
<resourceId>56169</resourceId>
<resourceName>Yellowfin Usage Audit</resourceName>
<resourceType>VIEW</resourceType>
<resourceUUID>fb6416c4-441e-42b3-a442-e7426f25f6b4</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This dashboard contains a set of reports covering general system and admin information, including performance, sessions, data source & view usage.</resourceDescription>
<resourceId>57438</resourceId>
<resourceName>Admin</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>GROUP</resourceType>
<resourceUUID>33827292-cda6-4071-965f-730ccbc53519</resourceUUID>
</contentResources>
<contentResources>
<resourceDescription>This is an analytic tab that is used to understand examine metrics split by various demographics and filters.</resourceDescription>
<resourceId>61195</resourceId>
<resourceName>Analysis</resourceName>
<resourceOrgId>1</resourceOrgId>
<resourceType>GROUP</resourceType>
<resourceUUID>f19e63f5-7175-4c57-897d-ed865aba8972</resourceUUID>
</contentResources>
</contentResources>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>92029c8ae4f1db0f33bf0b7370c1088a</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETCONTENT");特定のクライアント組織を識別することもできます。
rsr.setOrgRef("org1");リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、次の要素が含まれます。：StatusCodeとContentResorce。（より詳細な情報は、上記応答パラメーターの表を参照してください）
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getcontent.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getcontent.jsp」を実行します。
<%
/* ws_getcontent.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 webservices admin account
rsr.setPassword("test"); // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("GETCONTENT");
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
ContentResource[] crs = rs.getContentResources();
out.write("<table>");
out.write("<tr><td> id </td><td> type </td><td> UUID </td></tr>");
for (ContentResource c: crs) {
out.write("<tr>");
out.write("<td>" + c.getResourceId() + "</td><td>" + c.getResourceType() + "</td><td>" + c.getResourceUUID() + "</td>");
out.write("</tr>");
}
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>