Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

 

プライマリー組織、またはクライアント組織のユーザーに属するオブジェクトを、こちらの項目に分類されるwebサービスを使用して、取得したり、操作したりすることができます。取得される情報は、オブジェクトのメタデータ（名前、説明、IDなど）に関連するものであり、実際のコンテンツではありません。レポートの実際のデータ（HTMLやPDF）を取得する場合は、Yellowfinのレポートwebサービスを使用します。

 

 

レポートオブジェクト

以下のwebサービスの呼び出しは、ユーザーのYellowfinの取得や管理に関連しています。

 GETUSERREPORT

特定のユーザーにアクセス可能な、指定したレポートIDのレポートメタデータを取得します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。

レポートを編集する際には、レポートIDは変更されるが、レポートのUUIDは常に同一であることに注意をしてください。レポートに対応するUUIDは、GETIDFORUUIDの呼び出しを使用して、確認することができます。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETUSERREPORT」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。
ReportIdInteger詳細を確認するレポートの一意のIDです。こちらのレポートは、既にYellowfinに存在していなくてはいけません。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringレポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSERREPORT</function>
            <reportId>56401</reportId>      
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
REportsAdministrationReport[]指定したレポートの詳細を含む配列です。

応答の例

サービスは、今回の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>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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERREPORT");

  • レポートを取得するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • 特定のクライアント組織を識別することもできます。

     

    rsr.setOrgRef("org1");

  • レポートIDを提供します。これは、既存のレポートのIDでなければいけません。

     

    rsr.setReportId(70292);

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、これらのパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    PersonAdministrationPersonユーザーの完全な詳細です。
    ReportsAdministrationReport[]指定したレポートの詳細を含む配列です。

     

     

  • レポートを取得します。

     

    AdministrationReport[] rpts = rs.getReports();
AdministrationReport report = rpts[0];          // getting the metadata of the first report

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getuserreport.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getuserreport.jsp」を実行します。

<%           
/*              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());
}
%>
 GETALLUSERREPORTS

こちらの関数は、特定のユーザーにアクセス可能な、すべてのレポートのメタデータを取得します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。

クライアント組織を指定する場合は、その組織内のすべてのレポートを取得します。それ以外の場合は、デフォルト組織のすべてのレポートが取得されます。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETALLUSERREPORTS」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringレポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETALLUSERREPORTS</function>
            <person>
                <userId>binish.sheikh@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationReport[]すべてのレポートの詳細を含む配列です。

応答の例

サービスは、今回の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>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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETALLUSERREPORTS");

  • レポートを取得するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • その組織のレポートのみを検索するために、特定のクライアント組織を識別することもできます。

     

    rsr.setOrgRef("org1");

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、これらのパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    PersonAdministrationPersonユーザーの完全な詳細です。
    ReportsAdministrationReport[]すべてのレポートの詳細を含む配列です。

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getalluserreports.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getalluserreports.jsp」を実行します。

<%           
/*              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());
}
%>
 GETREPORTSWITHCOMMENTS

こちらの関数は、指定したユーザーにアクセス可能なすべてのレポートを、コメントとともに返します。AdministrationPersonオブジェクトを使用して、ユーザーを指定することができます。

クライアント組織を指定する場合は、その組織内のすべてのコメント付きレポートを取得します。それ以外の場合は、デフォルト組織のレポートが取得されます。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETREPORTSWITHCOMMENTS」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringレポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETREPORTSWITHCOMMENTS</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationReport[]すべてのコメント付きレポートの詳細を含む配列です。

応答の例

サービスは、今回の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>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 &amp; 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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETREPORTSWITHCOMMENTS");

  • レポートを取得するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、これらのパラメーターが含まれます。

    応答要素データ型説明

    StatusCode

    String

    Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    PersonAdministrationPersonユーザーの完全な詳細です。
    ReportsAdministrationReport[]コメント付きレポートの詳細を含む配列です。

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getreportswithcomments.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getreportswithcomments.jsp」を実行します。

<%           
/*              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());
}
%>
 GETUSERREPORTS

指定したユーザーからアクセス可能であり、webサービス名とともに保存されたレポートのメタデータのみを取得します。この名前は、以下に示すように、レポートがYellowfinに保存される際に提供されます。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETUSERREPORTS」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringwebサービスレポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSERREPORTS</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationReport[]webサービスレポートの詳細を含む配列です。

応答の例

サービスは、今回の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>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 &amp; 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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERREPORTS");

  • レポートを取得するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、StatusCode、Person、Reportsパラメーターが含まれます。より詳細な情報は、上記応答の表を参照してください。

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getuserreports.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getuserreports.jsp」を実行します。

<%          
/*              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());
}
%>
 GETUSERDRAFTREPORTS

この関数は、指定されたユーザーにアクセス可能なドラフト（編集中）レポート（変更を保存していない、または有効化されていないレポート）を返します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETUSERDRAFTREPORTS」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringドラフト（下書き中）レポートを取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSERDRAFTREPORTS</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationReport[]ドラフト（編集中）レポートの詳細を含む配列です。

応答の例

サービスは、今回の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>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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERDRAFTREPORTS");

  • レポートを取得するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、これらのパラメーターが含まれます。

     

    応答要素データ型説明

    StatusCode

    String

    Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    PersonAdministrationPersonユーザーの完全な詳細です。
    ReportsAdministrationReport[]ドラフト（編集中）レポートの詳細を含む配列です。

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getdraftreports.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getdraftreports.jsp」を実行します。

<%           
/*              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());
}
%>
 DELETEREPORT

この関数は、指定されたユーザーのレポートを削除します。レポートは、レポートID、またはレポートUUIDのいずれかで識別することができます。AdministrationPersonオブジェクトを使用してユーザーを指定します。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「DELETEREPORT」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。
ReportIdInteger削除するレポートの一意のIDです。これは、システム内に既に存在するものでなくてはいけません。
ParametersString[]または、ReportIdパラメーターの代わりに、こちらを使用してレポートUUIDとともに要素を渡します。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringレポートを削除するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>DELETEREPORT</function>
            <reportId>56398</reportId>
            <person>
                <userId>binish.sheikh@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE

応答の例

サービスは、今回の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>
            <sessionId>61860d8760ecb216bdf3f455f66c3b14</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

 詳細手順

  • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("DELETEREPORT");

  • レポートを削除するユーザーを指定します。

     

    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
 
rsr.setPerson(ap);

  • IDを提供することで、削除するレポートを指定します。

     

    rsr.setReportId(71081);

  • リクエストを構成したら、呼び出しを実行します。

    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、これらのパラメーターが含まれます。

     

    応答要素データ型説明

    StatusCode

    String

    Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_deletereport.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_deletereport.jsp」を実行します。

<%           
/*              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());
}
%>
 GETINBOX

これは、指定されたユーザーの受信箱のレポートを返します。これらは、ユーザーに配信されたレポートです。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETINBOX」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdString受信箱のレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETINBOX</function>        
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationreports[]ユーザーの受信箱のレポートの配列です。

応答の例

サービスは、今回の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>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 &amp; Location Breakdown</reportName>
               <reportSubCategory>Marketing &amp; 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 &amp; Location Breakdown</reportName>
               <reportSubCategory>Marketing &amp; 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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
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);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、StatusCode、Person、Reportsパラメーターが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

     

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getinbox.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getinbox.jsp」を実行します。

<%          
/*              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());
}
%>
 GETFAVOURITES

こちらのwebサービスの呼び出しは、指定したユーザーによりお気に入りに登録されたすべてのレポートを返します。

 

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素データ型説明

LoginId

String

Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。

Password

String

上記アカウントのパスワードです。

OrgId

Integer

Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。

Function

String

Webサービス関数です。こちらは、「GETFAVOURITE」に設定します。

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。

 

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素データ型説明
UserIdStringお気に入りに登録したレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETFAVOURITES</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素データ型説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
PersonAdministrationPersonユーザーの完全な詳細です。
ReportsAdministrationreports[]ユーザーのお気に入りレポートの配列です。

応答の例

サービスは、今回の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>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サービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
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);

    管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

 

  • 返される応答には、StatusCode、Person、Reportsパラメーターが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

     

 

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  1. コードをコピーして、「ws_getfavourites.jsp」として保存します。
  2. root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
  3. 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  4. インターネットブラウザから、「http://<host>:<port>/ws_getinbox.jsp」を実行します。

<%          
/*              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());
}
%>

 

 

 


  • No labels