プライマリー組織、またはクライアント組織のユーザーに属するオブジェクトを、こちらの項目に分類されるwebサービスの呼び出しを使用して、取得したり、操作したりすることができます。取得される情報は、オブジェクトのメタデータ（レポートやダッシュボードの名前、説明、IDなど）に関連するものであり、実際のコンテンツではありません。レポートの実際のデータ（HTMLやPDF）を取得する場合は、Yellowfinのレポートwebサービスを使用します。プライマリー組織（デフォルト組織）、またはクライアント組織のユーザーに属するYellowfinオブジェクトやコンテンツを、こちらの項目に分類されるwebサービスの呼び出しを使用して、取得したり、操作したりすることができます。取得される情報は、オブジェクトのメタデータ（レポートやダッシュボードの名前、説明、IDなど）に関連するものであり、実際のコンテンツではありません。レポートの実際のデータ（HTMLやPDF）を取得する場合は、Yellowfinのレポートwebサービスを使用します。
レポートオブジェクト
以下のwebサービスの呼び出しは、ユーザーのYellowfinレポートの取得や管理に関連しています。
| Expand |
|---|
|
特定のユーザーにアクセス可能な、指定したレポートIDのレポートメタデータを取得します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。 レポートを編集する度に、レポートIDは変更されますが、レポートのUUIDは常に同一であることに注意をしてください。現在のIDに対応するUUIDは、GETIDFORUUIDの呼び出しを使用して、確認することができます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERREPORT」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 | | ReportId | Integer | 詳細を確認するレポートの一意のIDです。こちらのレポートは、既にYellowfinに存在していなくてはいけません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERREPORT</function>
<reportId>56401</reportId>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>4</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<sessionId>3a4f9969aa278c03fa4cb891a87d6f36</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserreport.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserreport.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserreport.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERREPORT");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setReportId(70297); //existing report id. ReportId field of ReportHeader table (Yellowifn database)
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>");
// get the report details:
AdministrationReport[] rpts = rs.getReports();
for (AdministrationReport r: rpts){
out.write("<br>Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>Category: " + r.getReportCategory());
out.write("<br>Subcategory: " + r.getReportSubCategory());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらの関数は、特定のユーザーにアクセス可能な、すべてのレポートのメタデータを取得します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。 クライアント組織を指定する場合は、その組織内のすべてのレポートを取得します。それ以外の場合は、デフォルト組織のすべてのレポートが取得されます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETALLUSERREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETALLUSERREPORTS</function>
<person>
<userId>binish.sheikh@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>binish.sheikh@yellowfin.com.au</emailAddress>
<firstName>Binish</firstName>
<ipId>13000</ipId>
<lastName>Sheikh</lastName>
<roleCode>YFREPORTCONSUMER</roleCode>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode>
<userId>binish.sheikh@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>4</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>ROW</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56398</reportId>
<reportName>System Startup</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORT</reportTemplate>
<reportUUID>0866847b-03cc-43ef-9612-2f52467cac8c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>4</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>9</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-04-13T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-04-13T00:00:00+10:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>57703</reportId>
<reportName>Top N Data Sources by Report Usage</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>e0669303-77ab-459e-bb98-d2fa73851b83</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>0</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-04-13T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-04-13T00:00:00+10:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>57911</reportId>
<reportName>Top N Longest Avg Report Rows</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>f75a2389-39d8-497b-8fb2-5d1a3fc6d605</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>0</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<sessionId>c4919cd467b887a60fd4449eaa3ab9a1</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getalluserreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getalluserreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getalluserreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETALLUSERREPORTS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReports().length + " reports retrieved");
// get the report details:
AdministrationReport[] rpts = rs.getReports();
for (AdministrationReport r: rpts){
out.write("<br><br>Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>Category: " + r.getReportCategory());
out.write("<br>Subcategory: " + r.getReportSubCategory());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETREPORTSWITHCOMMENTS |
|---|
|
こちらの関数は、指定したユーザーにアクセス可能なすべてのコメント付きレポートを返します。AdministrationPersonオブジェクトを使用して、ユーザーを指定することができます。 クライアント組織を指定する場合は、その組織内のすべてのコメント付きレポートを取得します。それ以外の場合は、デフォルト組織のレポートが取得されます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETREPORTSWITHCOMMENTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETREPORTSWITHCOMMENTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2014-08-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Drill Anywhere report to compare invoicing figures by different categories.</reportDescription>
<reportId>61025</reportId>
<reportName>Invoice vs. Estimate</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>879d3175-1d40-4495-a4d4-45a24e781e53</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>1</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<sessionId>5504cc102037ca2193083902900abf75</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getreportswithcomments.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getreportswithcomments.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getreportswithcomments.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETREPORTSWITHCOMMENTS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReports().length + " reports retrieved");
// get the report details:
AdministrationReport[] rpts = rs.getReports();
for (AdministrationReport r: rpts){
out.write("<br><br>Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>Category: " + r.getReportCategory());
out.write("<br>Subcategory: " + r.getReportSubCategory());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
指定したユーザーからアクセス可能であり、webサービス名とともに保存されたレポートのメタデータのみを取得します。この名前は、以下に示すように、レポートがYellowfinに保存される際に提供されます。 
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | webサービスレポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERREPORTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject>monitor</executionObject>
<lastModifiedDate>2018-03-07T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2018-03-07T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This report provides a high level summary of campaigns</reportDescription>
<reportId>70012</reportId>
<reportName>Campaign Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>100</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>60543</viewId>
<viewName>New View</viewName>
</reports>
<sessionId>f491846df1520c32d27451e5b5529ac9</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserreports.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("GETUSERREPORTS");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReports().length + " reports retrieved");
// get the report details:
AdministrationReport[] rpts = rs.getReports();
for (AdministrationReport r: rpts){
out.write("<br><br>Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>Category: " + r.getReportCategory());
out.write("<br>Subcategory: " + r.getReportSubCategory());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
この関数は、指定されたユーザーにアクセス可能なドラフト（編集中）レポート（変更を保存していない、または有効化されていないレポート）を返します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDRAFTREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ドラフト（下書き中）レポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERDRAFTREPORTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2018-02-16T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<reportCategory>Audit Reports</reportCategory>
<reportDescription>Ski Team, 16/2/2018 12:09 PM</reportDescription>
<reportId>70079</reportId>
<reportName>Draft Report</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORT</reportTemplate>
<reportUUID>df0be222-2819-466c-9118-203f9d75acb9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>0</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2018-02-19T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<reportCategory>Audit Reports</reportCategory>
<reportDescription>Ski Team, 19/2/2018 5:37 PM</reportDescription>
<reportId>70284</reportId>
<reportName>Draft Report</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORT</reportTemplate>
<reportUUID>2fe4814b-98da-4c35-ab65-43c0916449fa</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>40</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2018-02-20T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<reportCategory>Audit Reports</reportCategory>
<reportDescription>Ski Team, 20/2/2018 10:56 AM</reportDescription>
<reportId>70299</reportId>
<reportName>Draft Report</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>1180e1db-a01c-478e-9d32-55276000abcc</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>100</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2018-02-22T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<reportCategory>Audit Reports</reportCategory>
<reportDescription>Ski Team, 22/2/2018 5:19 PM</reportDescription>
<reportId>70336</reportId>
<reportName>Draft Report</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORT</reportTemplate>
<reportUUID>52da336a-b35b-42a6-be64-8e53d598fbe4</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>0</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<sessionId>da91fe1685c8cb4496d8c8374c57035b</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getdraftreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getdraftreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getdraftreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTREPORTS");
//rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReports().length + " reports retrieved");
// get the report details:
AdministrationReport[] rpts = rs.getReports();
for (AdministrationReport r: rpts){
out.write("<br><br>Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>Category: " + r.getReportCategory());
out.write("<br>Subcategory: " + r.getReportSubCategory());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
この関数は、指定されたユーザーのレポートを削除します。レポートは、レポートID、またはレポートUUIDのいずれかで識別することができます。AdministrationPersonオブジェクトを使用してユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「DELETEREPORT」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | クライアント組織の参照IDです。こちらのパラメーターは必須ではありません。 | | ReportId | Integer | 削除するレポートの一意のIDです。これは、システム内に既に存在するものでなくてはいけません。 | | Parameters | String[] | または、ReportIdパラメーターの代わりに、こちらを使用してレポートUUIDとともに要素を渡します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートを削除するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>DELETEREPORT</function>
<reportId>56398</reportId>
<person>
<userId>binish.sheikh@yellowfin.com.au</userId>
</person>
</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>61860d8760ecb216bdf3f455f66c3b14</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_deletereport.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deletereport.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_deletereport.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 above account
rsr.setOrgId(1);
rsr.setFunction("DELETEREPORT");
//rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
//pass the report ID:
rsr.setReportId(71081);
//or the report UUID:
rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Report has been deleted.");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
これは、指定されたユーザーの受信箱のレポートを返します。これらは、ユーザーに配信されたレポートです。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETINBOX」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | 受信箱のレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETINBOX</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode>DISTRIBUTE</deliveryMode>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription>
<reportId>61053</reportId>
<reportName>Profitability by Customer Age & Location Breakdown</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>25</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode>DISTRIBUTE</deliveryMode>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription>
<reportId>61053</reportId>
<reportName>Profitability by Customer Age & Location Breakdown</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>25</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</reports>
<sessionId>76a9a9f93246f29678744bf60727943f</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getinbox.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getinbox.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getinbox.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETINBOX");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
AdministrationReport[] reports = rs.getReports();
if (reports != null)
for(AdministrationReport r: reports){
out.write("<br>Report Name: " + r.getReportName());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらのwebサービスの呼び出しは、指定したユーザーによりお気に入りに登録されたすべてのレポートを返します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETFAVOURITES」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | お気に入りに登録したレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETFAVOURITES</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>24</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>24</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<sessionId>dffb6a0f4f155d46c73d1e77dffbd81c</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getfavourites.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getfavourites.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getfavourites.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("GETFAVOURITES");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
AdministrationReport[] reports = rs.getReports();
if (reports != null)
for(AdministrationReport r: reports){
out.write("<br>Report Name: " + r.getReportName());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらのwebサービスの呼び出しは、特定のレポートが指定したユーザーのお気に入りに登録されているかどうかを確認します。ユーザーとレポートの両方を指定しなくてはいけません。レポートは、レポートIDを提供することで指定します。このIDは、Yellowfinデータベースのレポートヘッダーテーブルから取得することができます。また、GETIDFORUUID webサービスの呼び出しを使用することで、レポートIDを取得することもできます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「ISREPORTFAVOURITE」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | ReportId | Integer | ユーザーのお気に入りに登録されているかを確認するレポートのレポートIDです。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | お気に入りに登録したレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>ISREPORTFAVOURITE</function>
<reportId>56401</reportId>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 - SUCCESS：指定したレポートが、ユーザーのお気に入りに登録されている場合。
- FAILURE：レポートが、ユーザーのお気に入りに登録されていない場合。
|
応答の例サービスは、今回の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>ca75c7ebef710e4fc7c6ca6137baa784</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| レポートのお気に入り登録状況を確認するユーザーを識別します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
お気に入り登録状況を確認するレポートを指定します。 | Code Block |
|---|
| rsr.setReportId(61131); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_isreportfavourite.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_isreportfavourite.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_isreportfavourite.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("ISREPORTFAVOURITE");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setReportId(61131);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらのwebサービスの呼び出しは、特定のレポートを指定したユーザーのお気に入りに登録します。ユーザーとレポートの両方を指定しなくてはいけません。レポートは、レポートIDを提供することで指定します。レポートIDは、GETIDFORUUIS webサービスの呼び出しを使用するか、データベース（値は、レポートヘッダーテーブルに保存されています）から取得します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「ADDTOFAVOURITES」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | ReportId | Integer | ユーザーのお気に入りとして登録するレポートのレポートIDです。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートをお気に入りに登録するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>ADDTOFAVOURITES</function>
<reportId>56401</reportId>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 - SUCCESS：レポートが、ユーザーのお気に入りに登録される場合。
- FAILURE：レポートが、ユーザーのお気に入りに登録されない場合。
|
応答の例サービスは、今回の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>cf897244c65ceecd6c4c39e8ab8c4fcb</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| レポートのお気に入り登録状況を確認するユーザーを識別します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
お気に入り登録状況を確認するレポートを指定します。 | Code Block |
|---|
| rsr.setReportId(61131); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_addtofavourites.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_addtofavourites.jsp」を実行します。
| Code Block |
|---|
| /* ws_addtofavourites.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("ADDTOFAVORITES");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setReportId(56361);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらのwebサービスの呼び出しは、特定のレポートを指定したユーザーのお気に入り登録から削除します。ユーザーとレポートの両方を指定しなくてはいけません。レポートは、レポートIDを提供することで指定します。レポートIDは、GETIDFORUUIS webサービスの呼び出しを使用するか、データベース（値は、レポートヘッダーテーブルに保存されています）から取得します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「REMOVEFAVOURITE」、または「REMOVEFAVORITE」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | ReportId | Integer | ユーザーのお気に入り登録から削除するレポートのレポートIDです。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | レポートをお気に入り登録から削除するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>REMOVEFAVOURITE</function>
<reportId>56401</reportId>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 - SUCCESS：レポートが、ユーザーのお気に入り登録から削除される場合。
- FAILURE：レポートが、ユーザーのお気に入り登録から削除されない場合。
|
応答の例サービスは、今回の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>1be6b980918323dab6f41fec3c040c56</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| レポートのお気に入り登録状況を確認するユーザーを識別します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
お気に入り登録状況を確認するレポートを指定します。 | Code Block |
|---|
| rsr.setReportId(61131); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_removefavourite.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_removefavourite.jsp」を実行します。
| Code Block |
|---|
| /* ws_removefavourite.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("REMOVEFAVOURITE");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setReportId(56361);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
...
ダッシュボードオブジェクト
以下のwebサービスの呼び出しは、ユーザーのダッシュボードタブの取得や管理に関連しています。
| Expand |
|---|
| title | GETUSERTABSAPPROVEREPORT |
|---|
|
こちらのwebサービスの呼び出しは、指定したユーザーの公開したすべてのダッシュボードのメタデータを返します。また、ダッシュボード内の各タブを、個別のタブとして扱います。そのため、ダッシュボードに2つのタブがある場合は、2つの異なるダッシュボードのAdministrationReportGroupオブジェクトを取得します。親ダッシュボードの詳細だけ必要な場合は、GETUSERPARENTTABSの呼び出しを使用します。そのIDを渡すことで、特定のダッシュボードタブの詳細を取得することができます。こちらのwebサービスは、レポートを承認するために使用します。レポート承認者は、（このアカウントが承認者として一覧化されていないとしても）LonginIdパラメーターを使用して指定されたアカウントのユーザーです。 こちらのサービスは、ダッシュボードのレポートのメタデータは取得しないことに注意してください。これを取得するためには、GETUSERTABSWITHREPORTSの呼び出しを使用します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERTABSAPPROVEREPORT」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するダッシュボードタブの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
| Anchor |
|---|
| 以下の表１２ | 以下の表１２ | 以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 |
| UserId | String | ダッシュボードタブの所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
| ReportId | Integer | 承認が必要なレポートのIDです。 |
リクエストの例
以下は、こちらのリクエストの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>
<arg0> <loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>GETUSERTABS<<function>APPROVEREPORT</function>
<person><reportId>73740</reportId>
</arg0>
<userId>admin@yellowfin.com.au</userId></web:remoteAdministrationCall>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope></soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。返される応答には、以下のパラメーターが含まれます。
応答の例
サービスは、今回の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>Getting<messages>Web Service user information...<Request Complete</messages>
<messages>Getting user information...</messages><sessionId>4e375028ec457bba4985965d5d71e64e</sessionId>
<messages>Web Service Request Complete</messages><statusCode>SUCCESS</statusCode>
</return>
<person> </ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
<emailAddress>admin@yellowfinrsr.setLoginId("admin@yellowfin.com. |
au</emailAddress>au");
rsr.setPassword("test"); |
<firstName>System</firstName>
rsr.setOrgId(1);
rsr.setFunction("APPROVEREPORT"); |
そのIDを提供することで、承認が必要なレポートを指定します。 | Code Block |
|---|
| rsr.setReportId(73740); |
リクエストを構成したら、呼び出しを実行してサーバをテストします。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
<initial/> out.write("<br>Success");
|
<ipId>5</ipId><languageCode>EN</languageCode><lastName>Administrator</lastName>out.write("<br>Failure");
|
<roleCode>YFADMIN</roleCode>
out.write(" Code: " + rs.getErrorCode());
} |
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_approvereport.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_approvereport.jsp」を実行します。
| Code Block |
|---|
|
<% <salutationCode
/>* <status>ACTIVE</status>ws_approvereport.jsp <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode> <userId>admin@yellowfin.com.au<*/userId>
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, </person>
java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
<reportGroups>AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust <publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<reportGroupId>61251</reportGroupId>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"); <reportGroupName>Sales Performance</reportGroupName> <reportGroupStatus>OPEN</reportGroupStatus> // change to the password of the account above
rsr.setOrgId(1);
<reportGroupType>ANALYTIC</reportGroupType>rsr.setFunction("APPROVEREPORT");
rsr.setReportId(73740);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if </reportGroups>
("SUCCESS".equals(rs.getStatusCode()) ) {
<reportGroups> out.write("<br>Success");
<publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
}
else {
<reportGroupId>61210</reportGroupId> out.write("<br>Failure");
<reportGroupName>Campaign Analysis (Campaigns)</reportGroupName> out.write(" Code: " + rs.getErrorCode());
} <reportGroupStatus>OPEN</reportGroupStatus>
%> |
| Expand |
|---|
|
こちらのwebサービスは、ドラフト（編集中）モードに変更することで、レポートを却下します。レポート承認者は、（このアカウントが承認者として一覧化されていないとしても）LonginIdパラメーターを使用して指定されたアカウントのユーザーです。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「REJECTREPORT」に設定します。 | | ReportId | Integer | 却下が必要なレポートのIDです。 |
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。 | Code Block |
|---|
| <soapenv:Envelope <reportGroupType>ANALYTIC</reportGroupType>xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
</reportGroups><web:remoteAdministrationCall>
<arg0>
<reportGroups> <loginId>admin@yellowfin.com.au</loginId>
<publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID> <password>test</password>
<reportGroupId>61243</reportGroupId> <orgId>1</orgId>
<reportGroupName>Campaign Analysis (Marketing)</reportGroupName><function>REJECTREPORT</function>
<reportGroupStatus>OPEN</reportGroupStatus><reportId>73740</reportId>
</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 <reportGroupType>ANALYTIC</reportGroupType>User: admin@yellowfin.com.au</messages>
<messages>Web Service Request <Complete</reportGroups>messages>
<sessionId>0ad8c1b60e3fb4b013055ee6da9ff867<<sessionId>4e375028ec457bba4985965d5d71e64e</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 特定のクライアント組織を識別することもできます。そのIDを提供することで、却下するレポートを指定します。 | Code Block |
|---|
| rsr.setOrgRefsetReportId("org1"73740); |
ダッシュボードタブの所属するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
リクエストを構成したら、呼び出しを実行します。リクエストを構成したら、呼び出しを実行してサーバをテストします。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getusertabsrejectreport.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getusertabsrejectreport.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserreportrejectreport.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 webwebservices services admin account
rsr.setPassword("test"); // setchange to the password of the account above
account
rsr.setOrgId(1);
rsr.setFunction("GETUSERTABSREJECTREPORT");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(apsetReportId(73740);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved out.write("<br>Success");
// get the tabs details: AdministrationReportGroup[] tabs = rs.getReportGroups();
}
else {
for (AdministrationReportGroup tab: tabs){ out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());<br>Failure");
out.write("<br>UUID Code: " + tabrs.getPublishUUIDgetErrorCode());
out.write("<br>Id: " + tab.getReportGroupId());
out.write("<br>Group Type: " + tab.getReportGroupType());
out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
}
} else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }
%> |
|
| Expand |
|---|
| title | GETUSERPARENTTABSCOPYREPORT |
|---|
|
こちらの呼び出しは、ユーザーの公開した親ダッシュボードのメタデータを返します。ダッシュボードに複数のタブが含まれている場合でも、親ダッシュボードの詳細のみが返されます。タブの詳細を取得するためには、TABSFROMPARENTGROUPIDの呼び出しを使用します。親ダッシュボードのレポートのメタデータは表示されないことに注意をしてください。これは、GETUSERPARENTTABSWITHREPOTSの呼び出しを使用することで、取得することができます。そのIDを提供することで、特定の親タブの詳細を取得することもできます。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。こちらのwebサービスは、すべての依存関係（関連レポート、など）を含めて、定義されたカテゴリー・サブカテゴリー（フォルダー・サブフォルダ―）にレポートをコピーします。コピー先のフォルダーは、目標とするクライアント組織に存在するものでなくてはいけません。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERPARENTTABSCOPYREPORT」に設定します。 | | PersonReport | AdministrationPersonAdministrationReport | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。コピーされるレポートの詳細です。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するダッシュボードタブの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
| Anchor |
|---|
| 以下の表１２ | 以下の表１２ | 以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 |
| UserId | String | 親タブの所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 | レポートのコピー先となるクライアント組織です。こちらが指定されない場合、レポートはデフォルト組織にコピーされます。 |
以下のパラメーターは、AdministrationReportオブジェクトに設定されます。
| リクエスト要素 | データ型 | 説明 |
ReportUUID | String | コピーするレポートのUUIDを提供します。 |
| ReportId | Integer | または、レポートIDを指定します。 |
ReportCategory | String | 必須パラメーターです。レポートをコピーするカテゴリー（フォルダー）を指定します。 |
ReportSubCategory | String | 必須パラメーターです。レポートをコピーするサブカテゴリー（サブフォルダー）を指定します。 |
| Note |
|---|
ReportCategory、およびReportSubCategoryはリソースコードの形式にする必要があります。リソースコードは、GETCATEGORIES webサービスを使用するか、RefTypeCode IN（「RPTCATEGORY」、「RPTSUBCATEGORY」）によりフィルターが適用されたYellowfinのデータベース（orgReferenceCodeDescテーブル内）に直接移動することで確認できます。ここでは、リソースコードはRefCodeです。 |
リクエストの例
以下は、こちらのリクエストの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>GETUSERPARENTTABS<<function>COPYREPORT</function>
<person><report>
<userId>admin@yellowfin.com.au</userId><reportId>73753</reportId>
<reportUUID>4cd72d5e-68bb-4bb5-98e2-6562e7f228c5</reportUUID>
</person><reportCategory>TUTORIAL</reportCategory>
<reportSubCategory>TRAINING</reportSubCategory>
</arg0>report>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。返される応答には、以下のパラメーターが含まれます。
応答の例
サービスは、今回の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 <messages>GettingService user information...<Request Complete</messages>
<messages>Getting<report>
user information...</messages> <messages>Web Service<authoringMode>JAVA</authoringMode>
Request Complete</messages> <birtData/>
<person> <chartTypeCode/>
<emailAddress>admin@yellowfin.com.au</emailAddress> <firstName>System</firstName><dashboardEnabled>true</dashboardEnabled>
<initial<dataOutput>COLUMN</>dataOutput>
<ipId>5</ipId><deliveryMode/>
<languageCode>EN</languageCode><executionObject/>
<lastName>Administrator</lastName><lastModifiedDate>2018-06-04T00:00:00+10:00</lastModifiedDate>
<roleCode>YFADMIN<<lastModifierId>5</roleCode>lastModifierId>
<lastModifierName>System <salutationCodeAdministrator</>lastModifierName>
<status>ACTIVE</status><reportCategory/>
<reportDescription>A drill through <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>report displaying revenue by camp region and year, allowing to drill through to a detail <userId>admin@yellowfin.com.au</userId>report.</reportDescription>
</person> <reportId>73773</reportId>
<reportGroups> <reportName>Sales Report</reportName>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID><reportSubCategory/>
<reportGroupId>61251<<reportTemplate>REPORT</reportGroupId>reportTemplate>
<reportGroupName>Sales Performance</reportGroupName><reportUUID>687a5403-dd4c-44c8-a30b-7c9668305c46</reportUUID>
<reportGroupStatus>OPEN<<roleCode>OPERATIONAL</reportGroupStatus>roleCode>
<reportGroupType>ANALYTIC</reportGroupType><sourceName/>
<<usage>0</reportGroups>usage>
<reportGroups><viewDescription>Ski Team</viewDescription>
<publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID><viewId>60543</viewId>
<viewName>New <reportGroupId>61210</reportGroupId>
View</viewName>
<reportGroupName>Campaign Analysis (Campaigns)</reportGroupName>report>
<reportGroupStatus>OPEN</reportGroupStatus><sessionId>b9b1774145c8d3f2a1555e8eb9daf92a</sessionId>
<reportGroupType>ANALYTIC</reportGroupType>
<statusCode>SUCCESS</statusCode>
</reportGroups>return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
| Expand |
|---|
|
<reportGroups>new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test"); |
<publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID> <reportGroupId>61243</reportGroupId>
<reportGroupName>Campaign Analysis (Marketing)</reportGroupName>
rsr.setOrgId(1);
rsr.setFunction("COPYREPORT"); |
コピーするレポートを指定します。 | Code Block |
|---|
| AdministrationReport rpt = new AdministrationReport();
rpt.setReportId(73753); |
レポートをコピーするフォルダー、サブフォルダ―も指定します。 | Code Block |
|---|
| rpt.setReportCategory("TUTORIAL");
rpt.setReportSubCategory("TRAINING");
rsr.setReport(rpt); |
リクエストを構成したら、呼び出しを実行してサーバをテストします。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
<reportGroupStatus>OPEN</reportGroupStatus> out.write("<br>Success");
|
<reportGroupType>ANALYTIC</reportGroupType></reportGroups><sessionId>0ad8c1b60e3fb4b013055ee6da9ff867</sessionId>out.write("<br>Failure");
|
<statusCode>SUCCESS</statusCode> </return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
- 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
out.write(" Code: " + rs.getErrorCode());
} |
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_copyreport.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_copyreport.jsp」を実行します。
インターネットブラウザから、「http://<host>:<port>/ws_getuserparenttabs.jsp」を実行します。
| Code Block |
|---|
|
AdministrationServiceRequest<% rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERPARENTTABS");特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
親タブの所属するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。 返される応答には、これらのパラメーターが含まれます。
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
コードをコピーして、「ws_getuserparenttabs.jsp」として保存します。root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。<%
/*
/* ws_copyreport.jsp ws_getuserparenttabs.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 serviceswebservices admin account
rsr.setPassword("test"); // setchange to the password of the account above
account
rsr.setOrgId(1);
rsr.setFunction("GETUSERPARENTTABSCOPYREPORT");
rsr.setOrgRef("org1");
AdministrationPerson ap
AdministrationReport rpt = new AdministrationPerson(AdministrationReport();
rpt.setReportId(73753);
aprpt.setUserIdsetReportCategory("admin@yellowfin.com.auTUTORIAL");
rpt.setReportSubCategory("TRAINING");
rsr.setPersonsetReport(aprpt);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved"); // get the tabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups( out.write("<br>Success");
for (AdministrationReportGroup tab: tabs){
out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());}
else {
out.write("<br>UUID: " + tab.getPublishUUID());
out.write("<br>Id: " + tab.getReportGroupId())<br>Failure");
out.write("<br>Group Type: " + tab.getReportGroupType()); out.write("<br>InternalReference Code: " + tabrs.getReportGroupInternalReferencegetErrorCode());
} } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }
%> |
ダッシュボードオブジェクト
以下のwebサービスの呼び出しは、ユーザーのダッシュボードタブの取得や管理に関連しています。
| Expand |
|---|
| title | GETUSERDRAFTTABSGETUSERTABS |
|---|
|
公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードのメタデータを取得する場合は、こちらの呼び出しを使用します。IDを提供することで、特定のドラフト（編集中）のダッシュボードの詳細を取得することができます。こちらのwebサービスの呼び出しは、指定したユーザーの公開したすべてのダッシュボードのメタデータを返します。また、ダッシュボード内の各タブを、個別のタブとして扱います。そのため、ダッシュボードに2つのタブがある場合は、2つの異なるダッシュボードのAdministrationReportGroupオブジェクトを取得します。親ダッシュボードの詳細だけ必要な場合は、GETUSERPARENTTABSの呼び出しを使用します。そのIDを渡すことで、特定のダッシュボードタブの詳細を取得することができます。 こちらの呼び出しは、ダッシュボードのレポートのメタデータは取得しないことに注意してください。これを取得するには、GETUSERDRAFTTABSWITHREPORTSの呼び出しを使用します。こちらのサービスは、ダッシュボードのレポートのメタデータは取得しないことに注意してください。これを取得するためには、GETUSERTABSWITHREPORTSの呼び出しを使用します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDARTTABSGETUSERTABS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するドラフト（編集中）ダッシュボードの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。詳細を取得するダッシュボードタブの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。ダッシュボードタブの所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERDRAFTTABS<<function>GETUSERTABS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | ドラフト（編集中）ダッシュボードのメタデータを含む配列です。ダッシュボードのメタデータを含む配列です。 |
応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reports><reportGroups>
<authoringMode>JAVA</authoringMode><publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<averageRunTime>0<<reportGroupId>61251</averageRunTime>reportGroupId>
<birtData<reportGroupName>Sales Performance</>reportGroupName>
<chartTypeCode<reportGroupStatus>OPEN</>reportGroupStatus>
<dashboardEnabled>true<<reportGroupType>ANALYTIC</dashboardEnabled>reportGroupType>
</reportGroups>
<dataOutput>COLUMN</dataOutput> <reportGroups>
<deliveryMode/> <publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
<executionObject/> <reportGroupId>61210</reportGroupId>
<lastModifiedDate>2018-02-16T00:00:00+11:00</lastModifiedDate> <reportGroupName>Campaign Analysis (Campaigns)</reportGroupName>
<lastModifierId>5</lastModifierId> <reportGroupStatus>OPEN</reportGroupStatus>
<lastModifierName>System Administrator</lastModifierName> <reportGroupType>ANALYTIC</reportGroupType>
<reportCategory>Audit Reports</reportCategory> </reportGroups>
<reportDescription>Ski Team, 16/2/2018 12:09 PM</reportDescription> <reportGroups>
<reportId>70079</reportId><publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
<reportName>Draft Report</reportName><reportGroupId>61243</reportGroupId>
<reportGroupName>Campaign <reportSubCategory>Admin Reports</reportSubCategory>Analysis (Marketing)</reportGroupName>
<reportTemplate>REPORT<<reportGroupStatus>OPEN</reportTemplate>reportGroupStatus>
<reportUUID>df0be222-2819-466c-9118-203f9d75acb9</reportUUID><reportGroupType>ANALYTIC</reportGroupType>
<roleCode>OPERATIONAL</roleCode></reportGroups>
<sourceName/><sessionId>0ad8c1b60e3fb4b013055ee6da9ff867</sessionId>
<usage>0</usage><statusCode>SUCCESS</statusCode>
<viewDescription>Ski Team</viewDescription></return>
<viewId>70103</viewId></ns2:remoteAdministrationCallResponse>
<viewName>New View</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode></S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERTABS"); |
特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
ダッシュボードタブの所属するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getusertabs.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getusertabs.jsp」を実行します。
| Code Block |
|---|
| <%
/* <averageRunTime>0</averageRunTime> ws_getuserreport.jsp <birtData/> */
%>
<%@ page <chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
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); <dataOutput>COLUMN<//dataOutput> adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new <deliveryMode/>
AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin <executionObject/>web services admin account
rsr.setPassword("test"); <lastModifiedDate>2018-02-19T00:00:00+11:00</lastModifiedDate> <lastModifierId>5<//lastModifierId> set to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERTABS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new <lastModifierName>System Administrator</lastModifierName>AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
<reportCategory>AuditAdministrationServiceResponse Reports</reportCategory>rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + <reportDescription>Ski Team, 19/2/2018 5:37 PM</reportDescription>rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
<reportId>70284</reportId>
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
<reportName>Draft Report</reportName> out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());
<reportSubCategory>Admin Reports</reportSubCategory>
out.write("<br>UUID: " + tab.getPublishUUID());
out.write("<br>Id: " + <reportTemplate>REPORT</reportTemplate>tab.getReportGroupId());
out.write("<br>Group Type: " + tab.getReportGroupType());
<reportUUID>2fe4814b-98da-4c35-ab65-43c0916449fa</reportUUID> out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
}
} else <roleCode>OPERATIONAL</roleCode>{
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
<sourceName/>
<usage>40</usage>
}
%> |
|
| Expand |
|---|
|
こちらの呼び出しは、ユーザーの公開した親ダッシュボードのメタデータを返します。ダッシュボードに複数のタブが含まれている場合でも、親ダッシュボードの詳細のみが返されます。タブの詳細を取得するためには、TABSFROMPARENTGROUPIDの呼び出しを使用します。親ダッシュボードのレポートのメタデータは表示されないことに注意をしてください。これは、GETUSERPARENTTABSWITHREPOTSの呼び出しを使用することで、取得することができます。そのIDを提供することで、特定の親タブの詳細を取得することもできます。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERPARENTTABS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するダッシュボードタブの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | 親タブの所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>
<viewDescription>Ski Team</viewDescription> <loginId>admin@yellowfin.com.au</loginId>
<viewId>70103</viewId> <password>test</password>
<viewName>New View<<orgId>1</viewName>orgId>
<<function>GETUSERPARENTTABS</reports>function>
<person>
<reports> <authoringMode>JAVA</authoringMode><userId>admin@yellowfin.com.au</userId>
<averageRunTime>0</averageRunTime> </person>
<birtData/> </arg0>
<chartTypeCode</>web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。 | Code Block |
|---|
| <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<dashboardEnabled>true</dashboardEnabled><ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<dataOutput>COLUMN</dataOutput> <errorCode>0</errorCode>
<deliveryMode/> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<executionObject/> <messages>Getting user information...</messages>
<lastModifiedDate>2018-02-20T00:00:00+11:00</lastModifiedDate> <messages>Getting user information...</messages>
<lastModifierId>5</lastModifierId> <messages>Web Service Request Complete</messages>
<lastModifierName>System Administrator</lastModifierName> <person>
<reportCategory>Audit Reports</reportCategory><emailAddress>admin@yellowfin.com.au</emailAddress>
<reportDescription>Ski Team, 20/2/2018 10:56 AM</reportDescription><firstName>System</firstName>
<reportId>70299<<initial/reportId>>
<reportName>Draft Report<<ipId>5</reportName>ipId>
<reportSubCategory>Admin Reports<<languageCode>EN</reportSubCategory>languageCode>
<reportTemplate>REPORTANDCHART<<lastName>Administrator</reportTemplate>lastName>
<reportUUID>1180e1db-a01c-478e-9d32-55276000abcc</reportUUID><roleCode>YFADMIN</roleCode>
<roleCode>OPERATIONAL<<salutationCode/roleCode>>
<sourceName<status>ACTIVE</>status>
<usage>100<<timeZoneCode>AUSTRALIA/SYDNEY</usage>timeZoneCode>
<viewDescription>Ski Team</viewDescription><userId>admin@yellowfin.com.au</userId>
</person>
<viewId>70103</viewId> <reportGroups>
<viewName>New View</viewName> <publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
</reports> <reportGroupId>61251</reportGroupId>
<reports> <reportGroupName>Sales <authoringMode>JAVA<Performance</authoringMode>reportGroupName>
<averageRunTime>0<<reportGroupStatus>OPEN</averageRunTime>reportGroupStatus>
<birtData<reportGroupType>ANALYTIC</>reportGroupType>
<chartTypeCode/></reportGroups>
<reportGroups>
<dashboardEnabled>true</dashboardEnabled> <publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
<dataOutput>COLUMN</dataOutput> <reportGroupId>61210</reportGroupId>
<deliveryMode/> <reportGroupName>Campaign <executionObject/>Analysis (Campaigns)</reportGroupName>
<lastModifiedDate>2018-02-22T00:00:00+11:00</lastModifiedDate><reportGroupStatus>OPEN</reportGroupStatus>
<lastModifierId>5<<reportGroupType>ANALYTIC</lastModifierId>reportGroupType>
<lastModifierName>System Administrator</lastModifierName></reportGroups>
<reportGroups>
<reportCategory>Audit Reports</reportCategory> <reportDescription>Ski Team, 22/2/2018 5:19 PM</reportDescription>
<reportId>70336</reportId>
<reportName>Draft Report</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORT</reportTemplate>
<reportUUID>52da336a-b35b-42a6-be64-8e53d598fbe4</reportUUID><publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
<roleCode>OPERATIONAL<<reportGroupId>61243</roleCode>reportGroupId>
<sourceName/><reportGroupName>Campaign <usage>0</usage>Analysis (Marketing)</reportGroupName>
<viewDescription>Ski Team<<reportGroupStatus>OPEN</viewDescription>reportGroupStatus>
<viewId>70103</viewId>
<reportGroupType>ANALYTIC</reportGroupType>
<viewName>New View</viewName> </reports>reportGroups>
<sessionId>da91fe1685c8cb4496d8c8374c57035b<<sessionId>0ad8c1b60e3fb4b013055ee6da9ff867</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTTABSGETUSERPARENTTABS"); |
特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
ダッシュボードタブの所属するユーザーを指定します。親タブの所属するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getdrafttabsgetuserparenttabs.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getdrafttabsgetuserparenttabs.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getdrafttabsgetuserparenttabs.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTTABSGETUSERPARENTTABS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabtabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());
out.write("<br>UUID: " + tab.getPublishUUID());
out.write("<br>Id: " + tab.getReportGroupId());
out.write("<br>Status<br>Group Type: " + tab.getReportGroupStatusgetReportGroupType());
out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETUSERDRAFTPARENTTABSGETUSERDRAFTTABS |
|---|
|
公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードから親タブのみのメタデータを取得する場合は、こちらの呼び出しを使用します。ダッシュボードタブのIDを提供することで、特定の親タブの詳細を取得することができます。公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードのメタデータを取得する場合は、こちらの呼び出しを使用します。IDを提供することで、特定のドラフト（編集中）のダッシュボードの詳細を取得することができます。 こちらの呼び出しは、ダッシュボードのレポートのメタデータを取得しないことに注意してください。これを取得するためには、GETUSERDRAFTPARENTTABSWITHREPOTSの呼び出しを使用します。こちらの呼び出しは、ダッシュボードのレポートのメタデータは取得しないことに注意してください。これを取得するには、GETUSERDRAFTTABSWITHREPORTSの呼び出しを使用します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDARTPARENTTABSGETUSERDARTTABS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するドラフト（編集中）ダッシュボードの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERDRAFTPARENTTABS<<function>GETUSERDRAFTTABS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列です。ドラフト（編集中）ダッシュボードのメタデータを含む配列です。 |
応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reportGroups><reports>
<publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID><authoringMode>JAVA</authoringMode>
<reportGroupId>61250<<averageRunTime>0</reportGroupId>averageRunTime>
<reportGroupName>Sales Performance<<birtData/reportGroupName>>
<reportGroupStatus>OPEN<<chartTypeCode/reportGroupStatus>>
<reportGroupType>ANALYTIC<<dashboardEnabled>true</reportGroupType>dashboardEnabled>
</reportGroups> <dataOutput>COLUMN</dataOutput>
<reportGroups> <publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID><deliveryMode/>
<reportGroupId>61209<<executionObject/reportGroupId>>
<reportGroupName>Campaign Analysis</reportGroupName><lastModifiedDate>2018-02-16T00:00:00+11:00</lastModifiedDate>
<reportGroupStatus>OPEN<<lastModifierId>5</reportGroupStatus>lastModifierId>
<reportGroupType>ANALYTIC</reportGroupType><lastModifierName>System Administrator</lastModifierName>
</reportGroups><reportCategory>Audit Reports</reportCategory>
<sessionId>bcca7768fd5b49e3358b7fb48489f117</sessionId><reportDescription>Ski Team, 16/2/2018 12:09 PM</reportDescription>
<statusCode>SUCCESS</statusCode><reportId>70079</reportId>
</return><reportName>Draft Report</reportName>
<reportSubCategory>Admin </ns2:remoteAdministrationCallResponse>Reports</reportSubCategory>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
|
|
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTPARENTTABS"); |
特定のクライアント組織を識別することもできます。
| Code Block |
|---|
|
rsr.setOrgRef("org1"); |
ダッシュボードタブの所属するユーザーを指定します。
| Code Block |
|---|
|
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
|
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
| ReportGroups | AdministrationReportGroup[] | ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列です。 |
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
コードをコピーして、「ws_getdraftparenttabs.jsp」として保存します。root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。インターネットブラウザから、「http://<host>:<port>/ws_getdraftparenttabs.jsp」を実行します。
| Code Block |
|---|
|
<%<reportTemplate>REPORT</reportTemplate>
<reportUUID>df0be222-2819-466c-9118-203f9d75acb9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>0</*usage>
ws_getdraftparenttabs.jsp <viewDescription>Ski Team</viewDescription>
*/ %> <%@ 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); <viewId>70103</viewId>
<viewName>New View</viewName>
<//reports>
adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr<reports>
= new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <authoringMode>JAVA<//authoringMode>
provide your Yellowfin web services admin account rsr.setPassword("test"); <averageRunTime>0</averageRunTime>
<birtData/>
// set to the password of the above account rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTPARENTTABS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au"); <chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <dataOutput>COLUMN</dataOutput>
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved"); <deliveryMode//>
get the tab details: AdministrationReportGroup[] tabs = rs.getReportGroups(); <executionObject/>
for (AdministrationReportGroup tab: tabs){ out.write("<br><br>Dashboard Name: " + tab.getReportGroupName()); <lastModifiedDate>2018-02-19T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
out.write("<br>UUID: " + tab.getPublishUUID()); out.write("<br>Id: " + tab.getReportGroupId());<lastModifierName>System Administrator</lastModifierName>
out.write("<br>Status: " + tab.getReportGroupStatus()); <reportCategory>Audit Reports</reportCategory>
out.write("<br>InternalReference: " + tab.getReportGroupInternalReference()); } }<reportDescription>Ski else {
Team, 19/2/2018 5:37 PM</reportDescription>
out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }
%> |
| Expand |
|---|
| title | GETUSERTABSWITHREPORTS |
|---|
|
ユーザーの公開したダッシュボードと、そのレポートのメタデータを取得します。これは、各ダッシュボードタブの詳細を、個別のAdministrationReportGroupオブジェクトに返します。そのID番号を提供することで、特定のダッシュボードやタブの詳細を取得します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERTABSWITHREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のダッシュボードタブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。 |
| Anchor |
|---|
| 以下の表１５ | 以下の表１５ | 以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 |
| UserId | String | ダッシュボードが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例
以下は、こちらのリクエストの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> <reportId>70284</reportId>
<reportName>Draft Report</reportName>
<web:remoteAdministrationCall> <reportSubCategory>Admin Reports</reportSubCategory>
<arg0> <loginId>admin@yellowfin.com.au</loginId><reportTemplate>REPORT</reportTemplate>
<password>test</password><reportUUID>2fe4814b-98da-4c35-ab65-43c0916449fa</reportUUID>
<orgId>1</orgId><roleCode>OPERATIONAL</roleCode>
<function>GETUSERTABSWITHREPORTS</function><sourceName/>
<dashboardTabId>61251</dashboardTabId><usage>40</usage>
<person><viewDescription>Ski Team</viewDescription>
<userId>admin@yellowfin.com.au</userId><viewId>70103</viewId>
<viewName>New View</viewName>
</person>reports>
<reports>
</arg0><authoringMode>JAVA</authoringMode>
</web:remoteAdministrationCall><averageRunTime>0</averageRunTime>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
| ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
| Code Block |
|---|
|
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body> <birtData/>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <chartTypeCode/>
<return> <errorCode>0<<dashboardEnabled>true</errorCode>dashboardEnabled>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <dataOutput>COLUMN</dataOutput>
<messages>Getting user information...</messages><deliveryMode/>
<messages>Getting user information...</messages><executionObject/>
<messages>Web Service Request Complete</messages> <lastModifiedDate>2018-02-20T00:00:00+11:00</lastModifiedDate>
<person><lastModifierId>5</lastModifierId>
<lastModifierName>System <emailAddress>admin@yellowfin.com.au</emailAddress>Administrator</lastModifierName>
<firstName>System</firstName><reportCategory>Audit Reports</reportCategory>
<reportDescription>Ski Team, 20/2/2018 10:56 <initialAM</>reportDescription>
<ipId>5<<reportId>70299</ipId>reportId>
<reportName>Draft <languageCode>EN<Report</languageCode>reportName>
<reportSubCategory>Admin <lastName>Administrator<Reports</lastName>reportSubCategory>
<roleCode>YFADMIN<<reportTemplate>REPORTANDCHART</roleCode>reportTemplate>
<salutationCode/><reportUUID>1180e1db-a01c-478e-9d32-55276000abcc</reportUUID>
<status>ACTIVE<<roleCode>OPERATIONAL</status>roleCode>
<timeZoneCode>AUSTRALIA<sourceName/SYDNEY</timeZoneCode>>
<userId>admin@yellowfin.com.au</userId><usage>100</usage>
</person> <viewDescription>Ski Team</viewDescription>
<reportGroups> <viewId>70103</viewId>
<groupReports> <viewName>New View</viewName>
<authoringMode>JAVA</authoringMode> </reports>
<reports>
<averageRunTime>0</averageRunTime> <authoringMode>JAVA</authoringMode>
<birtData/> <averageRunTime>0</averageRunTime>
<chartTypeCode <birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00<lastModifiedDate>2018-02-22T00:00:00+1011:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<reportCategory>Audit <lastRunTime>0<Reports</lastRunTime>reportCategory>
<reportDescription>Ski <publishDate>2017-06-24T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete invoicing summaries by gender, demographic, and cost comparison over time.<Team, 22/2/2018 5:19 PM</reportDescription>
<reportId>61001<<reportId>70336</reportId>
<reportName>Draft <reportName>Invoice Summary<Report</reportName>
<reportSubCategory>Admin <reportSubCategory>Athletes<Reports</reportSubCategory>
<reportTemplate>CHART<<reportTemplate>REPORT</reportTemplate>
<reportUUID>d0f213a1-25ea-4ee6-8d5a-52a0a3cdcf49<<reportUUID>52da336a-b35b-42a6-be64-8e53d598fbe4</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>29<<usage>0</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>reports>
<sessionId>da91fe1685c8cb4496d8c8374c57035b</sessionId>
<groupReports> <statusCode>SUCCESS</statusCode>
<authoringMode>JAVA<</authoringMode>return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
| <averageRunTime>0</averageRunTime>
<birtData/> |
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getdrafttabs.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getdrafttabs.jsp」を実行します。
| Code Block |
|---|
|
<%
/* <chartTypeCode/> ws_getdrafttabs.jsp <dashboardEnabled>true<*/dashboardEnabled>
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ <dataOutput>COLUMN</dataOutput>
page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); <deliveryMode//> adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
<executionObject/>rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>rsr.setPassword("test"); <lastModifierId>5</lastModifierId> // set to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTTABS");
rsr.setOrgRef("org1");
AdministrationPerson <lastModifierName>Systemap Administrator</lastModifierName>= new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs <lastRunTime>0</lastRunTime>
= adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" <publishDate>2017-06-20T00:00:00+10:00</publishDate>
+ rs.getReportGroups().length + " tabs retrieved");
// get the tab details:
<reportCategory>Tutorial</reportCategory>
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
<reportDescription>A drill through report displaying revenue by camp region and year, allowing to drill through to a detail report.</reportDescription>
out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());
out.write("<br>UUID: " + tab.getPublishUUID());
out.write("<br>Id: " + tab.getReportGroupId());
<reportId>61097</reportId> out.write("<br>Status: " + tab.getReportGroupStatus());
out.write("<br>InternalReference: " <reportName>Region Revenue by Year</reportName>
+ tab.getReportGroupInternalReference());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
<reportSubCategory>Marketing & Booking</reportSubCategory>
%> |
| Expand |
|---|
| title | GETUSERDRAFTPARENTTABS |
|---|
|
公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードから親タブのみのメタデータを取得する場合は、こちらの呼び出しを使用します。ダッシュボードタブのIDを提供することで、特定の親タブの詳細を取得することができます。 こちらの呼び出しは、ダッシュボードのレポートのメタデータを取得しないことに注意してください。これを取得するためには、GETUSERDRAFTPARENTTABSWITHREPOTSの呼び出しを使用します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDARTPARENTTABS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。 | | DashboardTabId | Integer | 詳細を取得するドラフト（編集中）ダッシュボードの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>
<reportTemplate>REPORTANDCHART</reportTemplate> <arg0>
<loginId>admin@yellowfin.com.au</loginId>
<reportUUID>486d19ee-7976-450e-93cd-f475ae486fa0</reportUUID> <password>test</password>
<roleCode>OPERATIONAL</roleCode> <orgId>1</orgId>
<sourceName<function>GETUSERDRAFTPARENTTABS</>function>
<person>
<usage>28</usage> <userId>admin@yellowfin.com.au</userId> <viewDescription>Ski Team</viewDescription>
<viewId>70103<</viewId>person>
<viewName>New View</viewName></arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</groupReports></soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列です。 |
応答の例サービスは、今回の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/">
<groupReports> <return>
<authoringMode>JAVA<<errorCode>0</authoringMode>errorCode>
<messages>Successfully Authenticated <averageRunTime>1</averageRunTime>User: admin@yellowfin.com.au</messages>
<messages>Getting user information...</messages>
<birtData/> <messages>Getting user information...</messages>
<chartTypeCode/> <messages>Web Service Request Complete</messages>
<dashboardEnabled>true</dashboardEnabled> <person>
<dataOutput>COLUMN</dataOutput><emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<deliveryMode/> <initial/>
<executionObject/> <ipId>5</ipId>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate> <languageCode>EN</languageCode>
<lastModifierId>5</lastModifierId> <lastName>Administrator</lastName>
<lastModifierName>System Administrator<<roleCode>YFADMIN</lastModifierName>roleCode>
<salutationCode/>
<lastRunTime>1</lastRunTime> <status>ACTIVE</status>
<publishDate>2017-06-21T00:00:00+10:00</publishDate> <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<reportCategory>Tutorial</reportCategory> <userId>admin@yellowfin.com.au</userId>
<reportDescription>View invoicing</person>
and camp rating figures by athlete location on this GIS map.</reportDescription> <reportGroups>
<reportId>60947</reportId><publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
<reportName>Customer Sales by Location Map</reportName><reportGroupId>61250</reportGroupId>
<reportGroupName>Sales <reportSubCategory>Athletes<Performance</reportSubCategory>reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportTemplate>CHART</reportTemplate> <reportGroupType>ANALYTIC</reportGroupType>
<reportUUID>64470d8f-f0a9-4d31-bcda-28f26356034c</reportUUID> </reportGroups>
<roleCode>OPERATIONAL</roleCode> <reportGroups>
<sourceName/><publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
<usage>28</usage><reportGroupId>61209</reportGroupId>
<reportGroupName>Campaign <viewDescription>Ski Team</viewDescription>Analysis</reportGroupName>
<viewId>70103</viewId><reportGroupStatus>OPEN</reportGroupStatus>
<viewName>New View</viewName><reportGroupType>ANALYTIC</reportGroupType>
</groupReports>reportGroups>
<sessionId>bcca7768fd5b49e3358b7fb48489f117</sessionId>
<groupReports> <authoringMode>JAVA</authoringMode><statusCode>SUCCESS</statusCode>
</return>
<averageRunTime>1</averageRunTime></ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getdraftparenttabs.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getdraftparenttabs.jsp」を実行します。
| Code Block |
|---|
| <% <chartTypeCode
/>* ws_getdraftparenttabs.jsp <dashboardEnabled>true</dashboardEnabled> */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ <dataOutput>COLUMN</dataOutput>
<deliveryMode/>
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 = <executionObject/>
(AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); <lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
// provide your Yellowfin web services admin account
rsr.setPassword("test"); <lastModifierId>5</lastModifierId> // set to <lastModifierName>Systemthe Administrator</lastModifierName>password of the above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTPARENTTABS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au"); <lastRunTime>1</lastRunTime>
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
<reportCategory>Tutorial</reportCategory>
// get the tab details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
<reportDescription>Thisfor shows(AdministrationReportGroup profit over time...</reportDescription>tab: tabs){
out.write("<br><br>Dashboard Name: " + tab.getReportGroupName());
<reportId>61046</reportId> out.write("<br>UUID: " + tab.getPublishUUID());
out.write("<br>Id: " <reportName>Profit Trends & Forecast</reportName>+ tab.getReportGroupId());
out.write("<br>Status: " + tab.getReportGroupStatus());
<reportSubCategory>Athletes</reportSubCategory> out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
}
} else {
<reportTemplate>REPORTANDCHART</reportTemplate>out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
<reportUUID>39a5a365-4f26-4767-a723-a804de1babe9</reportUUID>
}
%> |
|
| Expand |
|---|
| title | GETUSERTABSWITHREPORTS |
|---|
|
ユーザーの公開したダッシュボードと、そのレポートのメタデータを取得します。これは、各ダッシュボードタブの詳細を、個別のAdministrationReportGroupオブジェクトに返します。そのID番号を提供することで、特定のダッシュボードやタブの詳細を取得します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERTABSWITHREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のダッシュボードタブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>
<roleCode>OPERATIONAL</roleCode> <arg0>
<sourceName/><loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<usage>29</usage> <orgId>1</orgId>
<viewDescription>Ski Team<<function>GETUSERTABSWITHREPORTS</viewDescription>function>
<viewId>70103</viewId><dashboardTabId>61251</dashboardTabId>
<person>
<viewName>New View</viewName> </groupReports><userId>admin@yellowfin.com.au</userId>
<groupReports> <authoringMode>JAVA</authoringMode></person>
<averageRunTime>1</averageRunTime></arg0>
</web:remoteAdministrationCall>
<birtData/>
<chartTypeCode/>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 応答の例サービスは、今回の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/">
<dashboardEnabled>true</dashboardEnabled> <return>
<dataOutput>COLUMN<<errorCode>0</dataOutput>errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<deliveryMode/> <messages>Getting user information...</messages>
<executionObject/> <messages>Getting user information...</messages>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<messages>Web Service Request Complete</messages>
<person>
<lastModifierId>5</lastModifierId> <emailAddress>admin@yellowfin.com.au</emailAddress>
<lastModifierName>System Administrator</lastModifierName> <firstName>System</firstName>
<lastRunTime>1</lastRunTime> <initial/>
<publishDate>2017-06-20T00:00:00+10:00</publishDate> <ipId>5</ipId>
<reportCategory>Tutorial<<languageCode>EN</reportCategory>languageCode>
<lastName>Administrator</lastName>
<reportDescription>View athlete profit summaries by gender, demographic, and invoiced comparison over time.</reportDescription> <roleCode>YFADMIN</roleCode>
<reportId>61067<<salutationCode/reportId>>
<status>ACTIVE</status>
<reportName>Region Profit Summary</reportName> <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<reportSubCategory>Marketing & Booking</reportSubCategory> <userId>admin@yellowfin.com.au</userId>
<reportTemplate>CHART<</reportTemplate>person>
<reportGroups>
<reportUUID>01c73f85-2da8-401c-8e1d-167a0a6b5b5c</reportUUID> <groupReports>
<roleCode>OPERATIONAL</roleCode>
<sourceName/> <usage>29</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-22T0024T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Examine<reportDescription>View athlete invoicing figuressummaries by Camp Location hierarchy gender, demographic, and cost comparison over time.</reportDescription>
<reportId>61035<<reportId>61001</reportId>
<reportName>Performance<reportName>Invoice by Region<Summary</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART<<reportTemplate>CHART</reportTemplate>
<reportUUID>80162f66<reportUUID>d0f213a1-b23e25ea-4a2b4ee6-b2098d5a-497a960d96d5<52a0a3cdcf49</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>32<<usage>29</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID> <reportGroupId>61251<<authoringMode>JAVA</reportGroupId>authoringMode>
<reportGroupName>Sales Performance</reportGroupName><averageRunTime>0</averageRunTime>
<reportGroupStatus>OPEN</reportGroupStatus><birtData/>
<reportGroupType>ANALYTIC</reportGroupType><chartTypeCode/>
</reportGroups><dashboardEnabled>true</dashboardEnabled>
<sessionId>4d9033f74b43feb65204865fde9ff023</sessionId><dataOutput>COLUMN</dataOutput>
<statusCode>SUCCESS<<deliveryMode/statusCode>>
</return> </ns2:remoteAdministrationCallResponse><executionObject/>
</S:Body>
</S:Envelope> <lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>A drill through report displaying revenue by camp region and year, allowing to drill through to a detail report.</reportDescription>
<reportId>61097</reportId>
<reportName>Region Revenue by Year</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>486d19ee-7976-450e-93cd-f475ae486fa0</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>28</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>1</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-21T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View invoicing and camp rating figures by athlete location on this GIS map.</reportDescription>
<reportId>60947</reportId>
<reportName>Customer Sales by Location Map</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>64470d8f-f0a9-4d31-bcda-28f26356034c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>28</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>1</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This shows profit over time...</reportDescription>
<reportId>61046</reportId>
<reportName>Profit Trends & Forecast</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>39a5a365-4f26-4767-a723-a804de1babe9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>29</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>1</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete profit summaries by gender, demographic, and invoiced comparison over time.</reportDescription>
<reportId>61067</reportId>
<reportName>Region Profit Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>01c73f85-2da8-401c-8e1d-167a0a6b5b5c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>29</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Examine invoicing figures by Camp Location hierarchy.</reportDescription>
<reportId>61035</reportId>
<reportName>Performance by Region</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>80162f66-b23e-4a2b-b209-497a960d96d5</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>32</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<reportGroupId>61251</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<sessionId>4d9033f74b43feb65204865fde9ff023</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getusertabswithreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getusertabswithreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getusertabswithreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERTABSWITHREPORTS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");
AdministrationReport[] rpts = tab.getGroupReports();
if (rpts != null)
for (AdministrationReport r: rpts){
out.write("Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>ReportId: " + r.getReportId());
out.write("<br>ReportUUID: " + r.getReportUUID());
out.write("<br>ExecutionObject: " + r.getExecutionObject());
out.write("<br>ReportCategory: " + r.getReportCategory());
out.write("<br>SubCategory: " + r.getReportSubCategory());
out.write("<br>BirtData: " + r.getBirtData());
out.write("<br>SourceName: " + r.getSourceName());
out.write("<br>SourceId: " + r.getSourceId());
out.write("<br>AuthoringMode: " + r.getAuthoringMode());
out.write("<br>ReportTemplate: " + r.getReportTemplate());
out.write("<br>DataOutput: " + r.getDataOutput());
out.write("<br>DashboardEnabled: " + r.isDashboardEnabled());
out.write("<br>ViewId: " + r.getViewId());
out.write("<br>ViewName: " + r.getViewName());
out.write("<br>ViewDescription: " + r.getViewDescription());
out.write("<br>LastModifierName: " + r.getLastModifierName());
out.write("<br>LastModifierId: " + r.getLastModifierId());
out.write("<br>LastModifiedDate: " + r.getLastModifiedDate());
out.write("<br>PublishDate: " + r.getPublishDate());
out.write("<br>DeliveryMode: " + r.getDeliveryMode());
out.write("<br>LastRunTime: " + r.getLastRunTime());
out.write("<br>AverageRunTime: " + r.getAverageRunTime());
out.write("<br>RoleCode: " + r.getRoleCode());
out.write("<br>ChartTypeCode: " + r.getChartTypeCode());
out.write("<br>Usage: " + r.getUsage());
out.write("<br><br>");
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETUSERPARENTTABSWITHREPORTS |
|---|
|
ダッシュボードレポートの詳細とともに、すべての公開されたダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブが含まれている場合は、親タブの詳細のみが取得されますが、こちらの呼び出しは、サブタブのレポートを含むダッシュボードレポート全体のメタデータを返します。AdministrationPersonオブジェクトを使用して、こちらの呼び出しのユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERPARENTTABSWITHREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードの親タブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERPARENTTABSWITHREPORTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ダッシュボードの親タブのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reportGroups>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-24T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete invoicing summaries by gender, demographic, and cost comparison over time.</reportDescription>
<reportId>61001</reportId>
<reportName>Invoice Summary</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>d0f213a1-25ea-4ee6-8d5a-52a0a3cdcf49</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-24T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete invoicing summaries by gender, demographic, and cost comparison over time.</reportDescription>
<reportId>61001</reportId>
<reportName>Invoice Summary</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>d0f213a1-25ea-4ee6-8d5a-52a0a3cdcf49</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>2</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>A drill through report displaying revenue by camp region and year, allowing to drill through to a detail report.</reportDescription>
<reportId>61097</reportId>
<reportName>Region Revenue by Year</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>486d19ee-7976-450e-93cd-f475ae486fa0</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>2</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>A drill through report displaying revenue by camp region and year, allowing to drill through to a detail report.</reportDescription>
<reportId>61097</reportId>
<reportName>Region Revenue by Year</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>486d19ee-7976-450e-93cd-f475ae486fa0</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>5</lastRunTime>
<publishDate>2017-06-21T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View invoicing and camp rating figures by athlete location on this GIS map.</reportDescription>
<reportId>60947</reportId>
<reportName>Customer Sales by Location Map</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>64470d8f-f0a9-4d31-bcda-28f26356034c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>5</lastRunTime>
<publishDate>2017-06-21T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View invoicing and camp rating figures by athlete location on this GIS map.</reportDescription>
<reportId>60947</reportId>
<reportName>Customer Sales by Location Map</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>64470d8f-f0a9-4d31-bcda-28f26356034c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This shows profit over time...</reportDescription>
<reportId>61046</reportId>
<reportName>Profit Trends & Forecast</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>39a5a365-4f26-4767-a723-a804de1babe9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This shows profit over time...</reportDescription>
<reportId>61046</reportId>
<reportName>Profit Trends & Forecast</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>39a5a365-4f26-4767-a723-a804de1babe9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete profit summaries by gender, demographic, and invoiced comparison over time.</reportDescription>
<reportId>61067</reportId>
<reportName>Region Profit Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>01c73f85-2da8-401c-8e1d-167a0a6b5b5c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete profit summaries by gender, demographic, and invoiced comparison over time.</reportDescription>
<reportId>61067</reportId>
<reportName>Region Profit Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>01c73f85-2da8-401c-8e1d-167a0a6b5b5c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Examine invoicing figures by Camp Location hierarchy.</reportDescription>
<reportId>61035</reportId>
<reportName>Performance by Region</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>80162f66-b23e-4a2b-b209-497a960d96d5</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>43</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Examine invoicing figures by Camp Location hierarchy.</reportDescription>
<reportId>61035</reportId>
<reportName>Performance by Region</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>80162f66-b23e-4a2b-b209-497a960d96d5</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>43</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
<reportGroupId>61250</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<reportGroups>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This report provides a high level summary of campaigns</reportDescription>
<reportId>60901</reportId>
<reportName>Campaign Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Revenue by media category pie chart</reportDescription>
<reportId>61131</reportId>
<reportName>Revenue by Media Category</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>32384c5a-7892-4ecb-93be-dc1efbdb7edd</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription>
<reportId>61053</reportId>
<reportName>Profitability by Customer Age & Location Breakdown</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Revenue treemap for campaigns by athlete demographic</reportDescription>
<reportId>61119</reportId>
<reportName>Revenue by Campaign and Demographic</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>ce3c4461-ea36-427d-bcd4-72448ec2722c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>An analysis of the agency sales and their ranked profitability</reportDescription>
<reportId>60724</reportId>
<reportName>Agency Sales by Profitability</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>876c7d79-21a9-4561-ada7-f97eaffe1186</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-18T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>An example of using canvas and set analysis from a single data set to create an infographic report.</reportDescription>
<reportId>60957</reportId>
<reportName>Infographic</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>00fd9f26-05a7-47b6-b87f-8270ca648f5d</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>1</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
<reportGroupId>61209</reportGroupId>
<reportGroupName>Campaign Analysis</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<sessionId>3749079ce15768d94c1750cfd01d54ad</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ダッシュボードの親タブのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 最初のダッシュボードタブのレポートを取得することができます。 | Code Block |
|---|
| AdministrationReport[] rpts = response.getReportGroups()[0].getGroupReports(); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserparenttabswithreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserparenttabswithreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserparenttabswithreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERPARENTTABSWITHREPORTS");
//rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");
AdministrationReport[] rpts = tab.getGroupReports();
if (rpts != null)
for (AdministrationReport r: rpts){
out.write("Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>ReportId: " + r.getReportId());
out.write("<br>ReportUUID: " + r.getReportUUID());
out.write("<br>ExecutionObject: " + r.getExecutionObject());
out.write("<br>ReportCategory: " + r.getReportCategory());
out.write("<br>SubCategory: " + r.getReportSubCategory());
out.write("<br>BirtData: " + r.getBirtData());
out.write("<br>SourceName: " + r.getSourceName());
out.write("<br>SourceId: " + r.getSourceId());
out.write("<br>AuthoringMode: " + r.getAuthoringMode());
out.write("<br>ReportTemplate: " + r.getReportTemplate());
out.write("<br>DataOutput: " + r.getDataOutput());
out.write("<br>DashboardEnabled: " + r.isDashboardEnabled());
out.write("<br>ViewId: " + r.getViewId());
out.write("<br>ViewName: " + r.getViewName());
out.write("<br>ViewDescription: " + r.getViewDescription());
out.write("<br>LastModifierName: " + r.getLastModifierName());
out.write("<br>LastModifierId: " + r.getLastModifierId());
out.write("<br>LastModifiedDate: " + r.getLastModifiedDate());
out.write("<br>PublishDate: " + r.getPublishDate());
out.write("<br>DeliveryMode: " + r.getDeliveryMode());
out.write("<br>LastRunTime: " + r.getLastRunTime());
out.write("<br>AverageRunTime: " + r.getAverageRunTime());
out.write("<br>RoleCode: " + r.getRoleCode());
out.write("<br>ChartTypeCode: " + r.getChartTypeCode());
out.write("<br>Usage: " + r.getUsage());
out.write("<br><br>");
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETUSERDRAFTTABSWITHREPORTS |
|---|
|
こちらの呼び出しは、GETUSERTABSWITHREPORTSと類似していますが、ドラフト（編集中）モードのダッシュボード（公開、有効化されていない）の詳細を返します。そのID番号を提供することで、特定のダッシュボードやタブの詳細を取得します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDRAFTTABSWITHREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードの取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERDRAFTTABSWITHREPORTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ドラフト（編集中）のダッシュボードのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reportGroups>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-24T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete invoicing summaries by gender, demographic, and cost comparison over time.</reportDescription>
<reportId>61001</reportId>
<reportName>Invoice Summary</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>d0f213a1-25ea-4ee6-8d5a-52a0a3cdcf49</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>2</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>A drill through report displaying revenue by camp region and year, allowing to drill through to a detail report.</reportDescription>
<reportId>61097</reportId>
<reportName>Region Revenue by Year</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>486d19ee-7976-450e-93cd-f475ae486fa0</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>5</lastRunTime>
<publishDate>2017-06-21T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View invoicing and camp rating figures by athlete location on this GIS map.</reportDescription>
<reportId>60947</reportId>
<reportName>Customer Sales by Location Map</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>64470d8f-f0a9-4d31-bcda-28f26356034c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>38</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This shows profit over time...</reportDescription>
<reportId>61046</reportId>
<reportName>Profit Trends & Forecast</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>39a5a365-4f26-4767-a723-a804de1babe9</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>2</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>6</lastRunTime>
<publishDate>2017-06-20T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>View athlete profit summaries by gender, demographic, and invoiced comparison over time.</reportDescription>
<reportId>61067</reportId>
<reportName>Region Profit Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>01c73f85-2da8-401c-8e1d-167a0a6b5b5c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>39</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>1</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Examine invoicing figures by Camp Location hierarchy.</reportDescription>
<reportId>61035</reportId>
<reportName>Performance by Region</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>80162f66-b23e-4a2b-b209-497a960d96d5</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>43</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<reportGroupId>61251</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<reportGroups>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-22T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>This report provides a high level summary of campaigns</reportDescription>
<reportId>60901</reportId>
<reportName>Campaign Summary</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>3e842fae-02f7-4ad3-a632-ca267e0078da</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Revenue by media category pie chart</reportDescription>
<reportId>61131</reportId>
<reportName>Revenue by Media Category</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>32384c5a-7892-4ecb-93be-dc1efbdb7edd</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription>
<reportId>61053</reportId>
<reportName>Profitability by Customer Age & Location Breakdown</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2017-06-19T00:00:00+10:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>Revenue treemap for campaigns by athlete demographic</reportDescription>
<reportId>61119</reportId>
<reportName>Revenue by Campaign and Demographic</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>ce3c4461-ea36-427d-bcd4-72448ec2722c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-17T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>An analysis of the agency sales and their ranked profitability</reportDescription>
<reportId>60724</reportId>
<reportName>Agency Sales by Profitability</reportName>
<reportSubCategory>Athletes</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>876c7d79-21a9-4561-ada7-f97eaffe1186</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>16</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
<reportGroupId>61210</reportGroupId>
<reportGroupName>Campaign Analysis (Campaigns)</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<reportGroups>
<groupReports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<lastRunTime>0</lastRunTime>
<publishDate>2016-11-18T00:00:00+11:00</publishDate>
<reportCategory>Tutorial</reportCategory>
<reportDescription>An example of using canvas and set analysis from a single data set to create an infographic report.</reportDescription>
<reportId>60957</reportId>
<reportName>Infographic</reportName>
<reportSubCategory>Marketing & Booking</reportSubCategory>
<reportTemplate>CHART</reportTemplate>
<reportUUID>00fd9f26-05a7-47b6-b87f-8270ca648f5d</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>1</usage>
<viewDescription>Ski Team</viewDescription>
<viewId>70103</viewId>
<viewName>New View</viewName>
</groupReports>
<publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
<reportGroupId>61243</reportGroupId>
<reportGroupName>Campaign Analysis (Marketing)</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<sessionId>da0e674bf04a010c4aed08fa1f009752</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ドラフト（編集中）のダッシュボードのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 最初のダッシュボードタブのレポートを取得することができます。 | Code Block |
|---|
| AdministrationReport[] rpts = response.getReportGroups()[0].getGroupReports(); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserdrafttabswithreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserdrafttabswithreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserdrafttabswithreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTTABSWITHREPORTS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");
out.write("<br>Dashboard tab Status: " + tab.getReportGroupStatus() + "<br>");
AdministrationReport[] rpts = tab.getGroupReports();
if (rpts != null)
for (AdministrationReport r: rpts){
out.write("Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>ReportId: " + r.getReportId());
out.write("<br>ReportUUID: " + r.getReportUUID());
out.write("<br>ExecutionObject: " + r.getExecutionObject());
out.write("<br>ReportCategory: " + r.getReportCategory());
out.write("<br>SubCategory: " + r.getReportSubCategory());
out.write("<br>BirtData: " + r.getBirtData());
out.write("<br>SourceName: " + r.getSourceName());
out.write("<br>SourceId: " + r.getSourceId());
out.write("<br>AuthoringMode: " + r.getAuthoringMode());
out.write("<br>ReportTemplate: " + r.getReportTemplate());
out.write("<br>DataOutput: " + r.getDataOutput());
out.write("<br>DashboardEnabled: " + r.isDashboardEnabled());
out.write("<br>ViewId: " + r.getViewId());
out.write("<br>ViewName: " + r.getViewName());
out.write("<br>ViewDescription: " + r.getViewDescription());
out.write("<br>LastModifierName: " + r.getLastModifierName());
out.write("<br>LastModifierId: " + r.getLastModifierId());
out.write("<br>LastModifiedDate: " + r.getLastModifiedDate());
out.write("<br>PublishDate: " + r.getPublishDate());
out.write("<br>DeliveryMode: " + r.getDeliveryMode());
out.write("<br>LastRunTime: " + r.getLastRunTime());
out.write("<br>AverageRunTime: " + r.getAverageRunTime());
out.write("<br>RoleCode: " + r.getRoleCode());
out.write("<br>ChartTypeCode: " + r.getChartTypeCode());
out.write("<br>Usage: " + r.getUsage());
out.write("<br><br>");
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETUSERDRAFTPARENTTABSWITHREPORTS |
|---|
|
ドラフト（編集中）モード（有効化、公開されていない）のダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブを含む場合は、親タブの詳細のみが取得されますが、こちらの呼び出しはサブタブ内のドラフト（編集中）のダッシュボードのレポート全体のメタデータを返します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。そのIDを提供することで、特定のダッシュボードタブを指定し、その詳細を取得することができます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERDRAFTPARENTTABSWITHREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ドラフト（編集中）ダッシュボードの親タブの詳細を取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERDRAFTPARENTTABSWITHREPORTS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<reportGroups>
<publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
<reportGroupId>61250</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<reportGroups>
<publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
<reportGroupId>61209</reportGroupId>
<reportGroupName>Campaign Analysis</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroups>
<sessionId>42075cc6bc5723e6daf997796aa00a57</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | 以下の表に一覧化されている要素とともに、ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列オブジェクトです。 |
ReportGroupsの各要素は、以下の要素を含みます。 最初のダッシュボードタブのレポートを取得することができます。 | Code Block |
|---|
| AdministrationReport[] rpts = response.getReportGroups()[0].getGroupReports(); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserdraftparenttabswithreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserdraftparenttabswithreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserdraftparenttabswithreports.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERDRAFTPARENTTABSWITHREPORTS");
//rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
AdministrationReportGroup[] tabs = rs.getReportGroups();
for (AdministrationReportGroup tab: tabs){
out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");
out.write("<br>Dashboard tab Status: " + tab.getReportGroupStatus() + "<br>");
AdministrationReport[] rpts = tab.getGroupReports();
if (rpts != null)
for (AdministrationReport r: rpts){
out.write("Report Name: " + r.getReportName());
out.write("<br>Description: " + r.getReportDescription());
out.write("<br>ReportId: " + r.getReportId());
out.write("<br>ReportUUID: " + r.getReportUUID());
out.write("<br>ExecutionObject: " + r.getExecutionObject());
out.write("<br>ReportCategory: " + r.getReportCategory());
out.write("<br>SubCategory: " + r.getReportSubCategory());
out.write("<br>BirtData: " + r.getBirtData());
out.write("<br>SourceName: " + r.getSourceName());
out.write("<br>SourceId: " + r.getSourceId());
out.write("<br>AuthoringMode: " + r.getAuthoringMode());
out.write("<br>ReportTemplate: " + r.getReportTemplate());
out.write("<br>DataOutput: " + r.getDataOutput());
out.write("<br>DashboardEnabled: " + r.isDashboardEnabled());
out.write("<br>ViewId: " + r.getViewId());
out.write("<br>ViewName: " + r.getViewName());
out.write("<br>ViewDescription: " + r.getViewDescription());
out.write("<br>LastModifierName: " + r.getLastModifierName());
out.write("<br>LastModifierId: " + r.getLastModifierId());
out.write("<br>LastModifiedDate: " + r.getLastModifiedDate());
out.write("<br>PublishDate: " + r.getPublishDate());
out.write("<br>DeliveryMode: " + r.getDeliveryMode());
out.write("<br>LastRunTime: " + r.getLastRunTime());
out.write("<br>AverageRunTime: " + r.getAverageRunTime());
out.write("<br>RoleCode: " + r.getRoleCode());
out.write("<br>ChartTypeCode: " + r.getChartTypeCode());
out.write("<br>Usage: " + r.getUsage());
out.write("<br><br>");
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | GETUSERPARENTREPORTGROUPS |
|---|
|
こちらのwebサービスの呼び出しは、指定したユーザーにアクセス可能なすべてのダッシュボードの親タブと、そのサブタブのメタデータを取得します。ユーザーは、AdministrationPersonオブジェクトを使用して指定します。返されるデータを制限するために、特定のダッシュボードやサブタブのIDを渡すこともできます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「GETUSERPARENTREPORTGROUPS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のダッシュボードタブやサブタブの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するタブでなくてはいけません。こちらが指定されない場合は、すべてのダッシュボードタブとサブタブの詳細が返されます。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>GETUSERPARENTREPORTGROUPS</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 ParentReportGroupsの各要素は、以下の要素を含みます。 応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<parentReportGroups>
<reportGroup>
<publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
<reportGroupId>61250</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroup>
<reportGroupId>61250</reportGroupId>
<reportGroupSubTabs>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<reportGroupId>61251</reportGroupId>
<reportGroupName>New Tab</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
</parentReportGroups>
<parentReportGroups>
<reportGroup>
<publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
<reportGroupId>61209</reportGroupId>
<reportGroupName>Campaign Analysis</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroup>
<reportGroupId>61209</reportGroupId>
<reportGroupSubTabs>
<publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
<reportGroupId>61210</reportGroupId>
<reportGroupName>Campaigns</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
<reportGroupSubTabs>
<publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
<reportGroupId>61243</reportGroupId>
<reportGroupName>Marketing</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
</parentReportGroups>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<sessionId>59ff828c9f26cbe0fdfd281a951d3ec9</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERPARENTREPORTGROUPS"); |
特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
レポートの所属するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
必要に応じて、ダッシュボードやサブタブのIDを提供します。 | Code Block |
|---|
| rsr.setDashboardTabId(61210); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_getuserparentreportgroups.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuserparentreportgroups.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_getuserparentreportgroups.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 above account
rsr.setOrgId(1);
rsr.setFunction("GETUSERPARENTREPORTGROUPS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setDashboardTabId(61210); // provide this dashboard sub tab id to get its parent dashboard tab details (optional)
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
ParentReportGroups[] tabs = rs.getParentReportGroups();
if (tabs != null)
for (AdministrationReportGroup tab: tabs){
out.write("<br><br>Tab Name: " + tab.getReportGroupName());
out.write("<br>Number of subtabs: " + tab.getReportGroup().length));
AdministrationReportGroup[] groups = tab.getReportGroup();
for (AdministrationReportGroup gr: groups){
out.write("<br>Subtab Name: " + gr.getReportGroupName());
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | TABSFROMPARENTGROUPID |
|---|
|
ユーザーのダッシュボードタブのメタデータを、サブタブのIDとともに返します。IDを提供することで、特定のタブやサブタブの詳細を取得します。AdministrationPersonオブジェクトを使用してユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「TABSFROMPARENTGROUPID」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | こちらのオプションパラメーターは、特定のダッシュボードタブの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードタブの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>TABSFROMPARENTGROUPID</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ParentDashboards | ParentDashboard[] | 以下の表に一覧化された要素を含むダッシュボードのメタデータを含む配列オブジェクトです。 |
ParentDashboardの各要素は、以下の要素を含みます。 | 応答要素 | データ型 | 説明 | | DashboardName | String | ダッシュボードの名前です。 | | DashboardGroupId | Integer | | | TabIds | String[] | サブタブのIDの配列です。 | | TabNames | String[] | サブタブの名前の配列です。 | | statusCodes | String[] | サブタブのステータスの配列です。 |
応答の例サービスは、今回の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>Getting user information...</messages>
<messages>Getting user information...</messages>
<messages>Web Service Request Complete</messages>
<parentDashboards>
<dashboardGroupId>61250</dashboardGroupId>
<dashboardName>Sales Performance</dashboardName>
<statusCodes>OPEN</statusCodes>
<tabIds>61251</tabIds>
<tabNames>New Tab</tabNames>
</parentDashboards>
<parentDashboards>
<dashboardGroupId>61209</dashboardGroupId>
<dashboardName>Campaign Analysis</dashboardName>
<statusCodes>OPEN</statusCodes>
<statusCodes>OPEN</statusCodes>
<tabIds>61210</tabIds>
<tabIds>61243</tabIds>
<tabNames>Campaigns</tabNames>
<tabNames>Marketing</tabNames>
</parentDashboards>
<person>
<emailAddress>admin@yellowfin.com.au</emailAddress>
<firstName>System</firstName>
<initial/>
<ipId>5</ipId>
<languageCode>EN</languageCode>
<lastName>Administrator</lastName>
<roleCode>YFADMIN</roleCode>
<salutationCode/>
<status>ACTIVE</status>
<timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
<userId>admin@yellowfin.com.au</userId>
</person>
<sessionId>1b1898c42b69302ce9b3426b5a17e5a0</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("TABSFROMPARENTGROUPID"); |
特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
ダッシュボードを取得するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
特定のダッシュボードの詳細のみを表示する場合は、ダッシュボードIDを提供します。 | Code Block |
|---|
| rsr.setDashboardTabId(61209); // dashboard Id (ReportGroup.GroupId field of Yellowfin's database) |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_tabsfromparentgroupid.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_tabsfromparentgroupid.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_tabsfromparentgroupid.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 above account
rsr.setOrgId(1);
rsr.setFunction("TABSFROMPARENTGROUPID");
//rsr.setDashboardTabId(61209); // add this to get subtabs for a particular dashboard tab.
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
//out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
ParentDashboard[] tabs = rs.getParentDashboards();
if (tabs != null)
for (ParentDashboard tab: tabs){
out.write("<br><br>Dashboard Name: " + tab.getDashboardName());
// set to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("TABSFROMPARENTGROUPID");
//rsr.setDashboardTabId(61209 out.write("<br>DashboardId: " + tab.getDashboardGroupId());
out.write("<br>tabIds (N): " + tab.getTabIds().length);
}
} else {
out.write("Failure");
out.write(" Code: " // add this to get subtabs for a particular dashboard tab.
rsr.+ rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらの呼び出しは、特定のユーザーにアクセス可能なダッシュボードタブレポートのメタデータを読み込むために使用します。ユーザーは、AdministrationPersonオブジェクトを通して指定します。特定のタブのレポートの詳細を取得する場合は、AdministrationReportGroupオブジェクトを介してダッシュボードタブのIDを提供します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「LOADTABREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | ReportGroup | AdministrationReportGroup | こちらのオプションパラメーターは、特定のダッシュボードタブのレポートの詳細を取得するために使用することができます。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | ダッシュボードの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
以下は、こちらのwebサービスの呼び出しのAdministrationReportGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationReportGroup要素 | データ型 | 説明 | | ReportGroupId | Integer | ダッシュボードタブのIDです。 |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | ReportGroups | AdministrationReportGroup[] | こちらの配列オブジェクトは、ダッシュボードのレポートのメタデータを含みます。こちらは、ひとつの項目のみを含みます。 |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
|
レポートを取得するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au"); |
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsrif ("SUCCESS".equals(rs.getStatusCode()) ){out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
// get the tabs details:
ParentDashboard[] tabs = rs.getParentDashboards();
if (tabs != null)
for (ParentDashboard tab: tabs){
out.write("<br><br>Dashboard Name: " + tab.getDashboardName());
out.write("<br>DashboardId: " + tab.getDashboardGroupId()); |
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_loadtabreports.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_loadtabreports.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_loadtabreports.jsp out.write("<br>tabIds (N): " + tab.getTabIds().length); } } else { */
%>
<%@ page out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらの呼び出しは、特定のユーザーにアクセス可能なダッシュボードタブレポートのメタデータを読み込むために使用します。ユーザーは、AdministrationPersonオブジェクトを通して指定します。特定のタブのレポートの詳細を取得する場合は、AdministrationReportGroupオブジェクトを介してダッシュボードタブのIDを提供します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「LOADTABREPORTS」に設定します。 | | Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | ReportGroup | AdministrationReportGroup | こちらのオプションパラメーターは、特定のダッシュボードタブのレポートの詳細を取得するために使用することができます。以下の表を参照してください。 |
| Anchor |
|---|
| 以下の表１９ | 以下の表１９ | 以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 |
| UserId | String | ダッシュボードの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
| Anchor |
|---|
以下の表２０ | 以下の表２０ | 以下は、こちらのwebサービスの呼び出しのAdministrationReportGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationReportGroup要素 | データ型 | 説明 |
| ReportGroupId | Integer | ダッシュボードタブのIDです。 |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
| ReportGroups | AdministrationReportGroup[] | こちらの配列オブジェクトは、ダッシュボードのレポートのメタデータを含みます。こちらは、ひとつの項目のみを含みます。 |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
インターネットブラウザから、「http://<host>:<port>/ws_loadtabreports.jsp」を実行します。
| Code Block |
|---|
|
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
|
|
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 the password of the above account
rsr.setOrgId(1);
rsr.setFunction("LOADTABREPORTS");特定のクライアント組織を識別することもできます。
| Code Block |
|---|
|
rsr.setOrgRef("org1");レポートを取得するユーザーを指定します。
| Code Block |
|---|
|
AdministrationPerson ap
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationReportGroup rg = new AdministrationPersonAdministrationReportGroup();
aprg.
setUserId("admin@yellowfin.com.au"setReportGroupId(61210);
rsr.
setPersonsetReportGroup(
ap);必要に応じて、ダッシュボードタブやサブタブのIDを提供します。
| Code Block |
|---|
|
rsr.setDashboardTabId(61209);rg);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
//
dashboard
Id
(ReportGroup.GroupId
field
of
Yellowfin's
database)リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
|
AdministrationServiceResponse
rs
= adminService.remoteAdministrationCall(rsr);管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます：StatusCode、ReportGroups。（より詳細な情報は、上記応答パラメーターの項目を参照してください。）
レポートの詳細を取得するには、以下を使用します。
| Code Block |
|---|
|
AdministrationReport AdministrationReportGroup[]
reportstabs =
responsers.getReportGroups
[0].getGroupReports();
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
コードをコピーして、「ws_loadtabreports.jsp」として保存します。root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。<%();
if (tabs != null)
for (AdministrationReportGroup tab: tabs){
/* ws_loadtabreports.jsp out.write("<br>Tab Name: " + tab.getReportGroupName());
*/ %> <%@ 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); out.write(tab.getGroupReports().length);
// adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au" AdministrationReport[] reports = tab.getGroupReports();
// provide your Yellowfin web services admin account rsr.setPassword("test"); for (AdministrationReport r: reports){
// set the password of the above account
rsr.setOrgId(1); rsr.setFunction("LOADTABREPORTS"); rsr.setOrgRef("org1"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); AdministrationReportGroup rg = new AdministrationReportGroup(); rg.setReportGroupId(61210); rsr.setReportGroup(rg); AdministrationServiceResponse rs = adminServiceout.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {write("<br><br>Report Name: " + r.getReportName());
AdministrationReportGroup[] tabs = rsout.getReportGroupswrite();"<br>Report Id: " + r.getReportId());
if (tabs != null) }
for (AdministrationReportGroup tab:}
tabs){
} else {
out.write("<br>Tab Name: " + tab.getReportGroupName())Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
| Expand |
|---|
|
こちらのwebサービスは、ユーザーのダッシュボードタブやサブタブを削除する場合に使用します。ダッシュボードタブ、またはサブタブは、ID番号かUUIDのいずれかを提供することで、指定しなくてはいけません。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「DELETETAB」に設定します。 | | Person | AdministrationPerson | ダッシュボードタブを削除するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | 削除するタブのダッシュボードタブIDを提供します。または、以下のパラメーターを使用します。 | | Parameter | String[] | こちらのパラメーターは、上記のパラメーターに代わり、削除するダッシュボードタブのUUIDを渡すために使用します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 | | UserId | String | 削除するダッシュボードタブの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例以下は、こちらのリクエストの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>
out.write(tab.getGroupReports().length); <web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
AdministrationReport[] reports = tab.getGroupReports();<password>test</password>
<orgId>1</orgId>
<function>DELETETAB</function>
<person>
for (AdministrationReport r: reports){ <userId>admin@yellowfin.com.au</userId>
</person>
out.write("<br><br>Report Name: " + r.getReportName());<dashboardTabId>61243</dashboardTabId>
</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>
out.write("<br>Report Id: " + r.getReportId()); <errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
} <sessionId>df716bf8bf6d71bd586da445e02b348e</sessionId>
<statusCode>SUCCESS</statusCode>
} </return>
</ns2:remoteAdministrationCallResponse>
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
|
こちらのwebサービスは、ユーザーのダッシュボードタブやサブタブを削除する場合に使用します。ダッシュボードタブ、またはサブタブは、ID番号かUUIDのいずれかを提供することで、指定しなくてはいけません。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「DELETETAB」に設定します。 | | Person | AdministrationPerson | ダッシュボードタブを削除するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | | OrgRef | String | デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。 | | DashboardTabId | Integer | 削除するタブのダッシュボードタブIDを提供します。または、以下のパラメーターを使用します。 | | Parameter | String[] | こちらのパラメーターは、上記のパラメーターに代わり、削除するダッシュボードタブのUUIDを渡すために使用します。 |
| Anchor |
|---|
| 以下の表２１ | 以下の表２１ | 以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。| AdministrationPerson要素 | データ型 | 説明 |
| UserId | String | 削除するダッシュボードタブの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
リクエストの例
以下は、こちらのリクエストの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></S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("DELETETAB"); |
特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
レポートを取得するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
ダッシュボードタブ、またはサブタブいずれかのIDを提供します。 | Code Block |
|---|
| rsr.setDashboardTabId(71081); |
または、ダッシュボードタブやサブタブのUUIDを渡します。 | Code Block |
|---|
| rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"}); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deletedashboard.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deletedashboard.jsp」を実行します。
| Code Block |
|---|
|
<%
/* ws_deletedashboard.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"); <orgId>1</orgId> <function>DELETETAB<//function> set to the password of the above account
rsr.setOrgId(1);
<person>
rsr.setFunction("DELETETAB");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
<userId>admin@yellowfin.com.au</userId> rsr.setPerson(ap);
// pass the dashboard tab/subtab Id:
//rsr.setDashboardTabtId(71081);
// or dashboard tab/subtab UUID:
rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) </person>{
out.write("<br>Dashboard tab has been deleted.");
} else {
<dashboardTabId>61243</dashboardTabId> out.write("Failure");
</arg0> </web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
| Code Block |
|---|
|
<S:Envelope xmlns:Sout.write(" Code: " + rs.getErrorCode());
}
%> |
その他のオブジェクトの操作
以下のwebサービスの呼び出しは、レポート、ダッシュボード、ビューなどを含む、異なるタイプのオブジェクトの操作に使用します。
| Expand |
|---|
| title | LISTPERSONFAVOURITES |
|---|
|
こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビュー、ダッシュボード、配信されたコンテンツ、ディスカッション、フラグ付きコメント含む、特定のユーザーのお気に入りに登録された項目を返します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「LISTPERSONTFAVOURITES」に設定します。 | | Favourite | PersonFavourite | こちらのオブジェクトは、取得するお気に入りに登録されたアイテムを指定するために使用します。ユーザーは、こちらで指定されなくてはいけませんが、その他のパラメーターはオプションです。より詳細な情報は、以下の表を参照してください。 | | Retospective Days | Integer | こちらのパラメーターはオプションです。 |
以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 | | PersonId | Integer | 必須パラメーターです。お気に入り項目を操作するユーザーのYellowfin内部ID（または、IP ID）です。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。 | | ContentType | String | こちらのオプションパラメーターは、特定のコンテンツタイプにより、結果にフィルターを適用するために使用することができます。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
| | ContentId | Integer | こちらのオプションパラメーターは、レポートやダッシュボード、ストーリーボードなど、その内部IDを提供することで、結果を特定のコンテンツに制限する場合に使用することができます。 | | FavouriteType | String | オプションです。お気に入りのタイプを指定するために使用します。 |
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。 | Code Block |
|---|
| <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<return> <web:remoteAdministrationCall>
<errorCode>0</errorCode> <arg0>
<messages>Successfully Authenticated User: admin@yellowfin<loginId>admin@yellowfin.com.au</messages>loginId>
<password>test</password>
<messages>Web Service Request Complete<<orgId>1</messages>orgId>
<sessionId>df716bf8bf6d71bd586da445e02b348e</sessionId><function>LISTPERSONFAVOURITES</function>
<favourite>
<statusCode>SUCCESS</statusCode> </return><personId>5</personId>
</ns2:remoteAdministrationCallResponse>favourite>
</S:Body> </S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| | AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("DELETETAB");特定のクライアント組織を識別することもできます。 | Code Block |
|---|
| rsr.setOrgRef("org1"); |
レポートを取得するユーザーを指定します。 | Code Block |
|---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
ダッシュボードタブ、またはサブタブいずれかのIDを提供します。 | Code Block |
|---|
| rsr.setDashboardTabId(71081); |
または、ダッシュボードタブやサブタブのUUIDを渡します。 | Code Block |
|---|
| rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"}); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 コードをコピーして、「ws_deletedashboard.jsp」として保存します。root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。インターネットブラウザから、「http://<host>:<port>/ws_deletedashboard.jsp」を実行します。 </arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | Personfavourites | Personfavourite[] | ユーザーのお気に入りオブジェクトを含む配列です。 |
応答の例サービスは、今回の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 ws_deletedashboard.jspUser: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<personfavourites>
<contentId>61209</contentId>
*<contentType>REPORTGROUP</
%>
<%@ 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);contentType>
<creationCode/>
<creationDate>2017-06-26</creationDate>
<creatorId>0</creatorId>
<favouriteType>REPORTDASHBOARD<//favouriteType>
adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr<message/>
= new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account
rsr.setPassword("test"); <personId>5</personId>
<textEntityId>0</textEntityId>
</personfavourites>
// set<personfavourites>
to the password of the above account rsr.setOrgId(1); rsr.setFunction("DELETETAB"); rsr.setOrgRef("org1"); AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");<contentId>61250</contentId>
rsr.setPerson(ap); <contentType>REPORTGROUP<//contentType>
pass the dashboard tab/subtab Id: //rsr.setDashboardTabtId(71081); // or dashboard tab<creationCode/subtab>
UUID: rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); <creationDate>2017-06-26</creationDate>
if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Dashboard tab has been deleted.");
} else { <creatorId>0</creatorId>
out.write("Failure"); <favouriteType>REPORTDASHBOARD</favouriteType>
out.write(" Code: " + rs.getErrorCode()); } %> |
|
その他のオブジェクトの操作
以下のwebサービスの呼び出しは、レポート、ダッシュボード、ビューなどを含む、異なるタイプのオブジェクトの操作に使用します。
| Expand |
|---|
| title | LISTPERSONFAVOURITES |
|---|
|
こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビュー、ダッシュボード、配信されたコンテンツ、ディスカッション、フラグ付きコメント含む、特定のユーザーのお気に入りに登録された項目を返します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「LISTPERSONTFAVOURITES」に設定します。 | | Favourite | PersonFavourite | こちらのオブジェクトは、取得するお気に入りに登録されたアイテムを指定するために使用します。ユーザーは、こちらで指定されなくてはいけませんが、その他のパラメーターはオプションです。より詳細な情報は、以下の表を参照してください。 | | Retospective Days | Integer | こちらのパラメーターはオプションです。 |
| Anchor |
|---|
| 以下の表２２ | 以下の表２２ | 以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 |
| PersonId | Integer | 必須パラメーターです。お気に入り項目を操作するユーザーのYellowfin内部ID（または、IP ID）です。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。 |
| ContentType | String | こちらのオプションパラメーターは、特定のコンテンツタイプにより、結果にフィルターを適用するために使用することができます。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
|
| ContentId | Integer | こちらのオプションパラメーターは、レポートやダッシュボード、ストーリーボードなど、その内部IDを提供することで、結果を特定のコンテンツに制限する場合に使用することができます。 |
| FavouriteType | String | オプションです。お気に入りのタイプを指定するために使用します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
| Code Block |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header<message/>
<soapenv:Body> <web:remoteAdministrationCall> <personId>5</personId>
<arg0> <loginId>admin@yellowfin.com.au</loginId><textEntityId>0</textEntityId>
<password>test<</password>personfavourites>
<orgId>1<<sessionId>09123071f17afb11be74ca07a6d25aef</orgId>sessionId>
<function>LISTPERSONFAVOURITES<<statusCode>SUCCESS</function>statusCode>
</return>
<favourite> </ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
<personId>5</personId>
</favourite> </arg0>use this for dashboards, or pf.setContentType("REPORT") to |
</web:remoteAdministrationCall> </soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
| Personfavourites | Personfavourite[] | ユーザーのお気に入りオブジェクトを含む配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。 | <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> |
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_listpersonfavourites.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_listpersonfavourites.jsp」を実行します。
| Code Block |
|---|
|
<%
/* <personfavourites> ws_listpersonfavourites.jsp <contentId>61209</contentId> <contentType>REPORTGROUP<*/contentType>
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ <creationCode/>
<creationDate>2017-06-26</creationDate>
<creatorId>0</creatorId>
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"); <favouriteType>REPORTDASHBOARD<//favouriteType> provide your Yellowfin webservices admin account
rsr.setPassword("test"); <message/> <personId>5</personId> <textEntityId>0</textEntityId> <//personfavourites> change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LISTPERSONFAVOURITES");
<personfavourites>
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentType("REPORT");
rsr.setFavourite(pf);
<contentId>61250</contentId>AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
<contentType>REPORTGROUP</contentType>
if ("SUCCESS".equals(rs.getStatusCode()) ) {
<creationCode/>out.write("<br>Success");
if (rs.getPersonfavourites() != <creationDate>2017-06-26</creationDate>null)
for (PersonFavourite f: pf){
<creatorId>0</creatorId> <favouriteType>REPORTDASHBOARD</favouriteType>
out.write("<br><br>contentId: " + f.getContentId());
<message/> out.write("<br>ContentType: " + f.getContentType());
<personId>5</personId> out.write("<br>CreationCode: " + f.getCreationCode());
<textEntityId>0</textEntityId> out.write("<br>CreationDate: " </personfavourites>
+ f.getCreationDate());
<sessionId>09123071f17afb11be74ca07a6d25aef</sessionId> out.write("<br>CreatorId: " + f.getCreatorId());
<statusCode>SUCCESS</statusCode> </return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
インターネットブラウザから、「http://<host>:<port>/ws_listpersonfavourites.jsp」を実行します。
| Code Block |
|---|
|
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("LISTPERSONFAVOURITES"); |
PersonFavouriteオブジェクトを使用して、ユーザーを識別します。 | Code Block |
|---|
| PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
以下の手順はオプションであり、こちらの呼び出しの応答にフィルターを適用するために含めることができます。 ユーザーのお気に入りレポートを取得する場合 | Code Block |
|---|
|
|
pf.setContentType("REPORT"); out.write("<br>FavouriteType: " + f.getFavouriteType());
out.write("<br>Message: " + f.getMessage());
pf.setFavouriteType("FAVOURITE");ユーザーのダッシュボードすべてを取得する場合
| Code Block |
|---|
|
pf.setContentType("REPORTGROUP");
pf.setFavouriteType("REPORTDASHBOARD"); |
ユーザーに配信されたレポートやダッシュボードを取得する場合
| Code Block |
|---|
|
pf.setContentType("REPORTGROUP"); out.write("<br>PersonId: " + f.getPersonId());
out.write("<br>textEntityId: " + f.getTextEntityId());
}
} else {
//
use
this
for
dashboards,
or
pfout.
setContentTypewrite("REPORTFailure")
to get distributed reports
pf.setFavouriteType("INBOX");ユーザーがメンバーであるディスカッションを取得する場合
| Code Block |
|---|
|
pf.setContentType("DISCUSSIONGROUP");
pf.setFavouriteType("DISCUSSIONMEMBER"); |
ユーザーのお気に入りビューを取得する場合
| Code Block |
|---|
|
pf.setContentType("REPORTVIEW"); |
ユーザーのお気に入りストーリーボードを取得する場合
| Code Block |
|---|
|
pf.setContentType("STORYBOARD");
pf.setFavouriteType("FAVOURITE"); |
リクエストにこちらのオブジェクトを追加します。
| Code Block |
|---|
|
rsr.setFavourite(pf); |
リクエストを構成したら、呼び出しを実行します。
| Code Block |
|---|
|
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
コードをコピーして、「ws_listpersonfavourites.jsp」として保存します。root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。<%;
out.write(" Code: " + rs.getErrorCode());
}
%> |
| Expand |
|---|
|
こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビューなどの項目を、ユーザのお気に入り一覧に追加します。また、ダッシュボードタブをユーザーのダッシュボードに追加し、コメントにフラグ付けをすることもできます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「SAVEPERSONFAVOURITE」に設定します。 | | Favourite | PersonFavourite | こちらのオブジェクトは、ユーザーのお気に入りに登録された項目を指定するために使用します。こちらで、ユーザーも指定します。より詳細な情報は、以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 | | PersonId | Integer | 内部ID（IP ID）とともにユーザーを識別するために必須のパラメーターです。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。選択された項目は、こちらのユーザーのお気に入りに追加されます。 | | ContentType | String | こちらの必須パラメーターは、お気に入りに追加する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
| | ContentId | Integer | こちらの必須パラメーターは、その内部IDを提供することで、ユーザーのお気に入りに登録する項目（レポート、ダッシュボード、ストーリーボードなど）を定義するために使用します。 | | FavouriteType | String | オプションです。お気に入りのタイプを指定します。 | | CreationCode | String | | | TextEntityId | Integer | こちらのパラメーターは、コメントにフラグ付けをする場合に必要です。 |
リクエストの例以下は、こちらのリクエストの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>SAVEPERSONFAVOURITE</function>
<favourite>
<personId>13000</personId>
/*<contentType>REPORTGROUP</contentType>
<contentId>61209</contentId>
ws_listpersonfavourites.jsp </favourite>
*/ %> <%@ 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); </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/">
// adjust host<return>
and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest();
<errorCode>0</errorCode>
rsr.setLoginId("admin@yellowfin.com.au"); // provide<messages>Successfully yourAuthenticated Yellowfin webservices admin account
rsr.setPassword("test");User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>6eb0b81605d3b355cf4a43ae608ab274</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</ change to be the password of the account aboveS:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| LISTPERSONFAVOURITES
REPORT
リクエストにこちらのオブジェクトを追加します。 | Code Block |
|---|
| rsr.setFavourite(pf); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_savepersonfavourite.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_savepersonfavourite.jsp」を実行します。
| Code Block |
|---|
| <% if ("SUCCESS".equals(rs.getStatusCode()) ) {
/* out.write("<br>Success");ws_savepersonfavourite.jsp if (rs.getPersonfavourites() != null) */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
for<%@ (PersonFavourite f: pf){
out.write("<br><br>contentId: " + f.getContentId())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 = out.write("<br>ContentType: " + f.getContentType()(AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); out.write("<br>CreationCode: " + f.getCreationCode()); // provide your Yellowfin web services admin account
outrsr.writesetPassword("<br>CreationDate: " + f.getCreationDate())test"); out.write("<br>CreatorId: " + f.getCreatorId()); // set to the password out.write("<br>FavouriteType: " + f.getFavouriteType()of the account above
rsr.setOrgId(1);
rsr.setFunction("SAVEPERSONFAVOURITE");
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
out.write("<br>Message: " + f.getMessage());
pf.setContentId(61252);
pf.setContentType("REPORTVIEW");
rsr.setFavourite(pf);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if out.write("<br>PersonId: " + f.getPersonIdSUCCESS".equals(rs.getStatusCode()); ) {
out.write("<br>textEntityId: " + f.getTextEntityId());"<br>Success");
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | SAVEPERSONFAVOURITEREMOVEPERSONFAVOURITE |
|---|
|
こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビューなどの項目を、ユーザのお気に入り一覧に追加します。また、ダッシュボードタブをユーザーのダッシュボードに追加し、コメントにフラグ付けをすることもできます。こちらのwebサービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどの項目やオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントのフラグを外すこともできます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「SAVEPERSONFAVOURITEREMOVEPERSONFAVOURITE」に設定します。 | | Favourite | PersonFavourite | こちらのオブジェクトは、ユーザーのお気に入りに登録された項目を指定するために使用します。こちらで、ユーザーも指定します。より詳細な情報は、以下のこちらのオブジェクトは、ユーザーのお気に入り登録から削除する項目を指定するために使用します。こちらでユーザーも指定します。より詳細な情報は、以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 | | PersonId | Integer | 内部ID（IP ID）とともにユーザーを識別するために必須のパラメーターです。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。選択された項目は、こちらのユーザーのお気に入りに追加されます。選択された項目は、ユーザーのお気に入りから削除されます。 | | ContentType | String | こちらの必須パラメーターは、お気に入りに追加する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。こちらの必須パラメーターは、お気に入りから削除する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
| | ContentId | Integer | こちらの必須パラメーターは、その内部IDを提供することで、ユーザーのお気に入りに登録する項目（レポート、ダッシュボード、ストーリーボードなど）を定義するために使用します。こちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りに登録された項目を定義するために使用します。 | | FavouriteType | String | オプションです。お気に入りのタイプを指定します。こちらは、ユーザーのお気に入りからレポートやダッシュボードを削除するために必要です。 | | CreationCode | String | | | TextEntityId | Integer | こちらのパラメーターは、コメントにフラグ付けをする場合に必要です。こちらのパラメーターは、コメントのフラグ付けを外すために必要です。 |
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。 | Code Block |
|---|
| <soapenv<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>SAVEPERSONFAVOURITE<<function>REMOVEPERSONFAVOURITE</function>
<favourite>
<personId>13000</personId>
<contentType>REPORTGROUP</contentType>
<contentId>61209</contentId>
</favourite>
</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>6eb0b81605d3b355cf4a43ae608ab274<<sessionId>0cc3673ed857e1e28fb0e326b8f3b24e</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("SAVEPERSONFAVOURITEREMOVEPERSONFAVOURITE"); |
PersonFavouriteオブジェクトを使用して、ユーザーを識別します。 | Code Block |
|---|
| PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
オブジェクト内でお気に入りに登録されるコンテンツを指定します。こちらのオブジェクト内でお気に入りから削除されるオブジェクトを指定します。 | Code Block |
|---|
| pf.setContentId(61252);
pf.setContentType("REPORTVIEW"); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_savepersonfavouriteremovepersonfavourite.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_savepersonfavouriteremovepersonfavourite.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_savepersonfavouriteremovepersonfavourite.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("SAVEPERSONFAVOURITEREMOVEPERSONFAVOURITE");
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(6125270270);
pf.setContentType("REPORTVIEW");
rsr.setFavourite(pf);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
| Expand |
|---|
| title | REMOVEPERSONFAVOURITEGETIDFORUUID |
|---|
|
こちらのwebサービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどの項目やオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントのフラグを外すこともできます。こちらの関数は、UUIDを渡すことでYellowfinコンテンツの内部IDを取得します。対象のコンテンツはビュー、レポート、ダッシュボード、データトランスフォーメーションです。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「REMOVEPERSONFAVOURITEGETIDFORUUID」に設定します。 | | FavouriteParameters | PersonFavourite | こちらのオブジェクトは、ユーザーのお気に入り登録から削除する項目を指定するために使用します。こちらでユーザーも指定します。より詳細な情報は、以下の表を参照してください。 |
| Anchor |
|---|
| 以下の表２４ | 以下の表２４ | 以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 |
| PersonId | Integer | 内部ID（IP ID）とともにユーザーを識別するために必須のパラメーターです。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。選択された項目は、ユーザーのお気に入りから削除されます。 |
| ContentType | String | こちらの必須パラメーターは、お気に入りから削除する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
|
| ContentId | Integer | こちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りに登録された項目を定義するために使用します。 |
| FavouriteType | String | こちらは、ユーザーのお気に入りからレポートやダッシュボードを削除するために必要です。 |
| CreationCode | String | |
| TextEntityId | Integer | こちらのパラメーターは、コメントのフラグ付けを外すために必要です。 |
| String[] | 文字列値の配列です。最初の文字列はUUIDを含む必要があります。二番目のパラメーターを使用して、コンテンツのタイプを指定することができます。以下のコンテンツタイプがサポートされています。 - VIEW
- REPORT
- DASHBOARD
- ETLPROCESS（データトランスフォーメーションフロー）
|
リクエストの例
以下は、こちらのリクエストの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>REMOVEPERSONFAVOURITE</function>
/loginId>
<favourite> <password>test</password>
<personId>13000<<orgId>1</personId>orgId>
<contentType>REPORTGROUP</contentType><function>GETIDFORUUID</function>
<contentId>61209</contentId><parameters>594d4da4-1b58-44d3-bf4f-11456a42f68c</parameters>
<<parameters>report</favourite>parameters>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
| 応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
| EntityId | Integer | 指定したコンテンツの内部IDです。 |
応答の例
サービスは、今回の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>
<entityId>56401</entityId>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>0cc3673ed857e1e28fb0e326b8f3b24e<<sessionId>806c38d4e47a8d7d4ccaff1360602693</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
| Expand |
|---|
|
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数のリクエストを定義します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("REMOVEPERSONFAVOURITEGETIDFORUUID"); |
PersonFavouriteオブジェクトを使用して、ユーザーを識別します。IDが必要なYellowfinコンテンツのUUIDとタイプを渡します。 | Code Block |
|---|
| PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
こちらのオブジェクト内でお気に入りから削除されるオブジェクトを指定します。rsr.setParameters(new String[]{"fb6416c4-441e-42b3-a442-e7426f25f6b4","VIEW"}); |
リクエストを構成したら、呼び出しを実行してサーバをテストします。
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
応答を取得するために、以下のコードを追加します。成功すると、エンティティID（コンテンツのID）が表示されます。 | Code Block |
|---|
| pf.setContentId(61252);
pf.setContentType("REPORTVIEW"); |
リクエストにこちらのオブジェクトを追加します。 | Code Block |
|---|
| rsr.setFavourite(pf); |
| Code Block |
|---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
out.write("<br>ID: " + rs.getEntityId());
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
} |
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_removepersonfavouriteidforuuid.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_removepersonfavouriteidforuuid.jsp」を実行します。
| Code Block |
|---|
|
<%
/* ws_removepersonfavouriteidforuuid.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("REMOVEPERSONFAVOURITEGETIDFORUUID");
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(70270);
pf.setContentType("REPORTVIEW");
rsr.setFavourite(pf);
rsr.setParameters(new String[]{"fb6416c4-441e-42b3-a442-e7426f25f6b4","VIEW"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
out.write("<br>ID: " + rs.getEntityId());
}
else {
out.write("Failure<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |