Versions Compared

Version Old Version 10 New Version 11
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleGETUSERDRAFTTABS

公開され、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードのメタデータを取得する場合は、こちらの呼び出しを使用します。IDを提供することで、特定のドラフト（編集中）のダッシュボードの詳細を取得することができます。公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードのメタデータを取得する場合は、こちらの呼び出しを使用します。IDを提供することで、特定のドラフト（編集中）のダッシュボードの詳細を取得することができます。

この呼び出しは、ダッシュボードのレポートのメタデータは取得しません。これを取得するには、GETUSERDRAFTTABSWITHREPORTSの呼び出しを使用します。こちらの呼び出しは、ダッシュボードのレポートのメタデータは取得しないことに注意してください。これを取得するには、GETUSERDRAFTTABSWITHREPORTSの呼び出しを使用します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringデフォルト組織に代わり、指定したクライアント組織内タブを検索するためのクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。
DashboardTabIdInteger詳細を取得するドラフト（編集中）ダッシュボードの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]ドラフト（編集中）ダッシュボードのメタデータを含む配列です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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の例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERDRAFTTABS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • ダッシュボードタブの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]ドラフト（編集中）ダッシュボードのメタデータを含む配列です。

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              ws_getdrafttabs.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("GETUSERDRAFTTABS");
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 tab 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: " + tab.getReportGroupStatus());
        out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
}
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>
Expand
titleGETUSERDRAFTPARENTTABS

公開され、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードから親タブのみのメタデータを取得する場合は、こちらの呼び出しを使用します。ダッシュボードタブのIDを提供することで、特定の親タブの詳細を取得することができます。公開、有効化されたダッシュボードではなく、ドラフト（編集中）モードのダッシュボードから親タブのみのメタデータを取得する場合は、こちらの呼び出しを使用します。ダッシュボードタブのIDを提供することで、特定の親タブの詳細を取得することができます。

こちらの呼び出しは、ダッシュボードのレポートのメタデータを取得しません。これを取得するためには、GETUSERDRAFTPARENTTABSWITHREPOTSの呼び出しを使用します。こちらの呼び出しは、ダッシュボードのレポートのメタデータを取得しないことに注意してください。これを取得するためには、GETUSERDRAFTPARENTTABSWITHREPOTSの呼び出しを使用します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

PersonAdministrationPersonユーザーの詳細を含むオブジェクトです。以下の表を参照してください。ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefStringデフォルト組織に代わり、指定したクライアント組織内タブを検索するためのクライアント組織の参照IDです。こちらのパラメーターは必須ではありません。デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDです。こちらのパラメーターは必須ではありません。
DashboardTabIdInteger詳細を取得するドラフト（編集中）ダッシュボードの一意のIDを提供する場合は、こちらのオプションパラメーターを使用します。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]

ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>bcca7768fd5b49e3358b7fb48489f117</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERDRAFTPARENTTABS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • ダッシュボードタブの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列です。

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              ws_getdraftparenttabs.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("GETUSERDRAFTPARENTTABS");
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 tab 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: " + tab.getReportGroupStatus());
        out.write("<br>InternalReference: " + tab.getReportGroupInternalReference());
    }
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>
Expand
titleGETUSERTABSWITHREPORTS

ユーザーの公開されたダッシュボードと、そのレポートのメタデータを取得します。これは、個別のAdministrationReportGroupオブジェクトの各ダッシュボードタブの詳細を返します。特定のダッシュボードやタブの詳細は、そのID番号を提供します。ユーザーを指定するために、AdministrationPersonオブジェクトを使用します。ユーザーの公開したダッシュボードと、そのレポートのメタデータを取得します。これは、各ダッシュボードタブの詳細を、個別のAdministrationReportGroupオブジェクトに返します。そのID番号を提供することで、特定のダッシュボードやタブの詳細を取得します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織内タブを検索するためのクライアント組織の参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdIntegerこちらのオプションパラメーターは、特定のダッシュボードたぶとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。こちらのオプションパラメーターは、特定のダッシュボードタブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードタブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。ダッシュボードが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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>GETUSERTABSWITHREPORTS</function>
            <dashboardTabId>61251</dashboardTabId>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>      
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]

以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。

 

ReportGroupsの各要素は、以下の要素を含みます。

応答要素データ型説明
GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>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-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>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-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 &amp; 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 &amp; 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 &amp; 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の例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERTABSWITHREPORTS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • レポートの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]

    以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。

     

    ReportGroupsの各要素は、以下の要素を含みます。

    応答要素データ型説明
    GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

     

     

  • 最初のダッシュボードタブのレポートを取得します。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] rpts =  response.getReportGroups()[0].getGroupReports();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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
titleGETUSERPARENTTABSWITHREPORTS

ダッシュボードレポートの詳細とともに、すべての公開されたダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブが含まれている場合は、親タブの詳細のみが取得されますが、こちらの呼び出しは、サブタブのレポートを含むダッシュボードレポート全体のメタデータを返します。呼び出しのユーザーを指定するために、AdministrationPersonオブジェクトを使用します。ダッシュボードレポートの詳細とともに、すべての公開されたダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブが含まれている場合は、親タブの詳細のみが取得されますが、こちらの呼び出しは、サブタブのレポートを含むダッシュボードレポート全体のメタデータを返します。AdministrationPersonオブジェクトを使用して、こちらの呼び出しのユーザーを指定します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdIntegerこちらのオプションパラメーターは、特定のダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。こちらのオプションパラメーターは、特定のダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードの親タブが所属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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サービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]

以下の表に一覧化されている要素とともに、ダッシュボードの親タブのメタデータを含む配列オブジェクトです。

 

ReportGroupsの各要素は、以下の要素を含みます。

応答要素データ型説明
GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; Location Breakdown</reportName>
                  <reportSubCategory>Marketing &amp; 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 &amp; 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 &amp; 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
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERPARENTTABSWITHREPORTS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • レポートの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]

    以下の表に一覧化されている要素とともに、ダッシュボードの親タブのメタデータを含む配列オブジェクトです。

     

    ReportGroupsの各要素は、以下の要素を含みます。

    応答要素データ型説明
    GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

     

     

  • 最初のダッシュボードタブのレポートを取得します。最初のダッシュボードタブのレポートを取得することができます。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] rpts =  response.getReportGroups()[0].getGroupReports();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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
titleGETUSERDRAFTTABSWITHREPORTS

こちらの呼び出しは、GETUSERTABSWITHREPORTSと類似していますが、ドラフト（編集中）モードのダッシュボード（公開、有効化されていない）の詳細を返します。特定のダッシュボードやタブの詳細を取得するには、そのID番号を提供します。ユーザーを指定するには、AdministrationPersonオブジェクトを使用します。こちらの呼び出しは、GETUSERTABSWITHREPORTSと類似していますが、ドラフト（編集中）モードのダッシュボード（公開、有効化されていない）の詳細を返します。そのID番号を提供することで、特定のダッシュボードやタブの詳細を取得します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdIntegerこちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。こちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。

 

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

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

 

リクエストの例

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

Code Block
languagexml
<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サービスの呼び出しのステータスです。値の選択肢は、以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]

以下の表に一覧化されている要素とともに、ドラフト（編集中）のダッシュボードのメタデータを含む配列オブジェクトです。

 

ReportGroupsの各要素は、以下の要素を含みます。

応答要素データ型説明
GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; Location Breakdown</reportName>
                  <reportSubCategory>Marketing &amp; 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 &amp; 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 &amp; 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
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERDRAFTTABSWITHREPORTS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • レポートの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]

    以下の表に一覧化されている要素とともに、ドラフト（編集中）のダッシュボードのメタデータを含む配列オブジェクトです。

     

    ReportGroupsの各要素は、以下の要素を含みます。

    応答要素データ型説明
    GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

     

     

  • 最初のダッシュボードタブのレポートを取得します。最初のダッシュボードタブのレポートを取得することができます。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] rpts =  response.getReportGroups()[0].getGroupReports();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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
titleGETUSERDRAFTPARENTTABSWITHREPORTS

ドラフト（編集中）モード（有効化、公開がされていない）のダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブを含む場合は、親タブの詳細のみが取得されますが、この呼び出しはサブタブ内のドラフト（編集中）のダッシュボードのレポート全体のメタデータを返します。ユーザーを指定するために、AdministrationPersonオブジェクトを使用します。そのIDを提供して、特定のダッシュボードタブを指定することで、その詳細を取得することができます。ドラフト（編集中）モード（有効化、公開されていない）のダッシュボードの親タブのメタデータを返します。ダッシュボードに複数のサブタブを含む場合は、親タブの詳細のみが取得されますが、こちらの呼び出しはサブタブ内のドラフト（編集中）のダッシュボードのレポート全体のメタデータを返します。AdministrationPersonオブジェクトを使用して、ユーザーを指定します。そのIDを提供することで、特定のダッシュボードタブを指定し、その詳細を取得することができます。　　　

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdInteger

こちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。こちらのオプションパラメーターは、特定のドラフト（編集中）ダッシュボードの親タブとそのレポートの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけない点に注意してください。

 

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

AdministrationPerson要素データ型説明
UserIdStringドラフト（編集中）ダッシュボードの親タブの取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。ドラフト（編集中）ダッシュボードの親タブの詳細を取得するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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サービスの呼び出しのステータスです。値の選択肢は、以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
ReportGroupsAdministrationReportGroup[]

以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。

 

ReportGroupsの各要素は、以下の要素を含みます。

応答要素データ型説明
GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERDRAFTPARENTTABSWITHREPORTS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • レポートの所属するユーザーを指定します。

     

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

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]

    以下の表に一覧化されている要素とともに、ダッシュボードのメタデータを含む配列オブジェクトです。以下の表に一覧化されている要素とともに、ドラフト（編集中）ダッシュボードの親タブのメタデータを含む配列オブジェクトです。

     

    ReportGroupsの各要素は、以下の要素を含みます。

    応答要素データ型説明
    GroupReportsAdministrationReport[]すべてのダッシュボードのレポートのメタデータを含む配列オブジェクトです。すべてのドラフト（編集中）ダッシュボードのレポートのメタデータを含む配列オブジェクトです。

     

     

  • 最初のダッシュボードタブのレポートを取得します。最初のダッシュボードタブのレポートを取得することができます。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] rpts =  response.getReportGroups()[0].getGroupReports();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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
titleGETUSERPARENTREPORTGROUPS

こちらのwebサービスの呼び出しは、指定したユーザーがアクセスできるすべてのダッシュボードの親タブと、そのサブタブのメタデータを取得します。ユーザーは、AdministrationPersonオブジェクトを使用して指定します。返されるデータを制限するために、特定のダッシュボードやサブタブのIDを渡すこともできます。こちらのwebサービスの呼び出しは、指定したユーザーにアクセス可能なすべてのダッシュボードの親タブと、そのサブタブのメタデータを取得します。ユーザーは、AdministrationPersonオブジェクトを使用して指定します。返されるデータを制限するために、特定のダッシュボードやサブタブのIDを渡すこともできます。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdInteger

こちらのオプションパラメーターは、特定のダッシュボードやサブタブの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。こちらが指定されない場合は、すべてのダッシュボードとサブタブの詳細が返されます。こちらのオプションパラメーターは、特定のダッシュボードタブやサブタブの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するタブでなくてはいけません。こちらが指定されない場合は、すべてのダッシュボードタブとサブタブの詳細が返されます。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
parentReportGroupsParentReportGroup[]

サブタブを含むダッシュボードタブの配列です。以下の表を参照してください。

PersonAdministrationPersonユーザーの詳細です。ユーザーの完全詳細です。

 

ParentReportGroupsの各要素は、以下の要素を含みます。

要素データ型説明
reportGroupIntegerダッシュボードタブのIDです。
reportGroupUUIDStringダッシュボードタブの公開UUIDです。
displayOrderIntegerユーザーダッシュボード内でのダッシュボードの表示順です。ユーザーダッシュボード内でのダッシュボードタブの表示順です。
reportGroupAdministrationReportGroupダッシュボードタブです。
reportGroupsSubTabsAdministrationReportGroup[]ダッシュボードのサブタブです。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETUSERPARENTREPORTGROUPS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • レポートの所属するユーザーを指定します。

     

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

  • 必要に応じて、ダッシュボードやサブタブのIDを提供します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setDashboardTabId(61210);

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

  • 返される応答には、これらのパラメーターが含まれます：StatusCode、ReportGroups、GroupReports（より詳細な情報は、上記応答パラメーターの表を参照してください）

     

  • 返される最初のダッシュボードのサブタブの詳細を取得するには、以下を使用します。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReportGroup[] subtabs = response.getParentReportGroups()[0].getReportGroupSubTabs();

  • 最初のダッシュボードの親ダッシュボードタブの詳細を取得するには、以下を使用します。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] rpts =  response.getReportGroups()[0].getGroupReports();

  • ダッシュボードタブのID番号を取得するには、こちらを使用します。

     

    Code Block
    themeEclipse
    languagejava
    Integer tabId= response.getParentReportGroups()[0].getReportGroupId();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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
titleTABSFROMPARENTGROUPID

ユーザーのダッシュボードタブのメタデータを、サブタブのIDとともに返します。IDを提供することで、特定のタブやサブタブの詳細を取得します。AdministrationPersonオブジェクトを使用してユーザーを指定します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdInteger

こちらのオプションパラメーターは、特定のダッシュボードタブの詳細を取得するために使用することができます。しかし、これは既にYellowfinに存在するものでなくてはいけません。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードタブの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

リクエストの例

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

Code Block
languagexml
<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サービスの呼び出しのステータスです。値の選択肢は、以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

  • SUCCESS
  • FAILURE
ParentDashboardsParentDashboard[]

以下の表に一覧化された要素を含むダッシュボードのメタデータを含む配列オブジェクトです。

 

ParentDashboardの各要素は、以下の要素を含みます。

応答要素データ型説明
DashboardNameStringダッシュボードの名前です。
DashboardGroupIdInteger 
TabIdsString[]サブタブIDの配列です。サブタブのIDの配列です。
TabNamesString[]サブタブの名前の配列です。
statusCodesString[]サブタブのステータスの配列です。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("TABSFROMPARENTGROUPID");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

  • ダッシュボードを取得するユーザーを指定します。

     

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

  • 特定のダッシュボードの詳細のみを表示する場合は、ダッシュボードIDを提供します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setDashboardTabId(61209);               // dashboard Id (ReportGroup.GroupId field of Yellowfin's database)

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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());
        out.write("<br>DashboardId: " + tab.getDashboardGroupId());
        out.write("<br>tabIds (N): " + tab.getTabIds().length);
    }
} else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode());
}
%>
Expand
titleLOADTABREPORTS

こちらの呼び出しは、特定のユーザーにアクセス可能なダッシュボードタブのメタデータを読み込むために使用します。ユーザーは、AdministrationPersonオブジェクトを通して指定します。特定のタブのレポートの詳細を取得する場合は、AdministrationReportGroupオブジェクトを介してダッシュボードタブのIDを提供します。こちらの呼び出しは、特定のユーザーにアクセス可能なダッシュボードタブレポートのメタデータを読み込むために使用します。ユーザーは、AdministrationPersonオブジェクトを通して指定します。特定のタブのレポートの詳細を取得する場合は、AdministrationReportGroupオブジェクトを介してダッシュボードタブのIDを提供します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

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

デフォルト組織に代わり、指定したクライアント組織のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

ReportGroupAdministrationReportGroup

こちらのオプションパラメーターは、特定のダッシュボードタブのレポートの詳細を取得するために使用することができます。以下の表を参照してください。こちらのオプションパラメーターは、特定のダッシュボードタブのレポートの詳細を取得するために使用することができます。以下の表を参照してください。

 

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

AdministrationPerson要素データ型説明
UserIdStringダッシュボードタブの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。ダッシュボードの帰属するユーザーを識別します。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

 

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

AdministrationReportGroup要素データ型説明
ReportGroupIdIntegerダッシュボードタブのIDです。

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
ParentGroupsReportGroupsParentReportGroupAdministrationReportGroup[]

こちらの配列オブジェクトは、ダッシュボードのレポートのメタデータを含みます。こちらは、ひとつのアイテムのみを含みます。こちらの配列オブジェクトは、ダッシュボードのレポートのメタデータを含みます。こちらは、ひとつの項目のみを含みます。

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("LOADTABREPORTS");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

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

     

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

  • 必要に応じて、ダッシュボードタブやサブタブのIDを提供します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setDashboardTabId(61209);               // dashboard Id (ReportGroup.GroupId field of Yellowfin's database)

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

     

  • レポートの詳細を取得するには、以下を使用します。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationReport[] reports = response.getReportGroups[0].getGroupReports();

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%          
/*              ws_loadtabreports.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 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 = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
                 
                AdministrationReportGroup[] tabs = rs.getReportGroups();
                 
                if (tabs != null)
                for (AdministrationReportGroup tab: tabs){
                                    out.write("<br>Tab Name: " + tab.getReportGroupName());
                                    out.write(tab.getGroupReports().length);
                                    AdministrationReport[] reports = tab.getGroupReports();
                                    for (AdministrationReport r: reports){
                                                    out.write("<br><br>Report Name: " + r.getReportName());
                                                    out.write("<br>Report Id: " + r.getReportId());
                                    }
                }
                 
} else {
                out.write("Failure");
                out.write(" Code: " + rs.getErrorCode());
}
%>
Expand
titleDELETETAB

こちらのwebサービスは、ユーザーのダッシュボードやサブタブを削除する場合に使用します。ダッシュボードタブ、またはサブタブは、ID番号かUUIDのいずれかを提供することで、指定しなくてはいけません。AdministrationPersonオブジェクトをしようして、ユーザーを指定します。こちらの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」に設定します。

PersonAdministrationPersonダッシュボードを削除するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。ダッシュボードタブを削除するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRefString

デフォルト組織に代わり、指定したクライアント組織のダッシュボードを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。デフォルト組織に代わり、特定のクライアント組織内のダッシュボードタブを検索するためのクライアント組織参照IDを指定するオプションパラメーターです。

DashboardTabIdInteger

削除するたぶのダッシュボードタブIDを提供します。または、以下のパラメーターを使用します。削除するタブのダッシュボードタブIDを提供します。または、以下のパラメーターを使用します。

ParameterString[]こちらのパラメーターは、上記のパラメーターに代わり、削除するダッシュボードタブのUUIDを渡すために使用します。

 

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

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

 

リクエストの例

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

Code Block
languagexml
<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>DELETETAB</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>             
            </person>
            <dashboardTabId>61243</dashboardTabId>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>df716bf8bf6d71bd586da445e02b348e</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("DELETETAB");

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

     

    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");

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

     

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

  • ダッシュボードタブ、またはサブタブいずれかのIDを提供します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setDashboardTabId(71081);

  • または、ダッシュボードタブやサブタブのUUIDを渡します。

     

    Code Block
    themeEclipse
    languagexml
    rsr.setParameters(new String[] {"0ac13905-aa14-4887-9718-44c29b11311b"});

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%           
/*              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");                           // set 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");          
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()) ) {
    out.write("<br>Dashboard tab has been deleted.");
} else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode());
}
%>

...

Expand
titleLISTPERSONFAVOURITES

こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビュー、ダッシュボード、配信されたコンテンツ、ディスカッション、フラグ付きコメント含む、特定のユーザーのお気に入りに登録されたアイテムを返します。こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビュー、ダッシュボード、配信されたコンテンツ、ディスカッション、フラグ付きコメント含む、特定のユーザーのお気に入りに登録された項目を返します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

FavouritePersonFavouriteこちらのオブジェクトは、取得するお気に入りに登録されたアイテムを指定するために使用します。ユーザーは、こちらで指定されなくてはいけませんが、その他のパラメーターはオプションです。より詳細な情報は、以下の表を参照してください。こちらのオブジェクトは、取得するお気に入りに登録されたアイテムを指定するために使用します。ユーザーは、こちらで指定されなくてはいけませんが、その他のパラメーターはオプションです。より詳細な情報は、以下の表を参照してください。
Retospective DaysIntegerこちらのパラメーターはオプションです。

 

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

PersonFavourite要素データ型説明
PersonIdIntegerお気に入り一覧からレポートを削除するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。
ContentTypeString

こちらのオプションパラメーターは、特定のコンテンツタイプにより、結果にフィルターを適用するために使用することができます。値の選択肢は、以下の通りです。

  • REPORT
  • REPORTGROUP
  • DISCUSSIONGROUP
  • REPORTVIEW
  • STORYBOARD
  • IMAGE
ContentIdIntegerこちらのオプションパラメーターは、その内部IDを提供することで、結果を特定のコンテンツに制限する場合に使用することができます。

 

リクエストの例

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

Code Block
languagexml
<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>LISTPERSONFAVOURITES</function>
            <favourite>
                <personId>5</personId>
            </favourite>    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
PersonfavouritesPersonfavourite[]ユーザーのお気に入りオブジェクトを含む配列です。

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>
            <personfavourites>
               <contentId>61209</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <personfavourites>
               <contentId>61250</contentId>
               <contentType>REPORTGROUP</contentType>
               <creationCode/>
               <creationDate>2017-06-26</creationDate>
               <creatorId>0</creatorId>
               <favouriteType>REPORTDASHBOARD</favouriteType>
               <message/>
               <personId>5</personId>
               <textEntityId>0</textEntityId>
            </personfavourites>
            <sessionId>09123071f17afb11be74ca07a6d25aef</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);

rsr.setFunction("LISTPERSONFAVOURITES");

  • PersonFavouriteオブジェクトを使用して、ユーザーを識別します。

     

    Code Block
    themeEclipse
    languagejava
    PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);

  • 以下の手順はオプションであり、こちらの呼び出しの応答にフィルターを適用するために含めることができます。

    • ユーザーのお気に入りレポートを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("REPORT");       
pf.setFavouriteType("FAVOURITE");


    • ユーザーのダッシュボードすべてを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("REPORTGROUP");
pf.setFavouriteType("REPORTDASHBOARD");


    • ユーザーに配信されたレポートやダッシュボードを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("REPORTGROUP");           // use this for dashboards, or pf.setContentType("REPORT") to get distributed reports
pf.setFavouriteType("INBOX");

    • ユーザーがメンバーであるディスカッションを取得する場合

      Code Block
      themeEclipse
      languagejfx
      pf.setContentType("DISCUSSIONGROUP");
pf.setFavouriteType("DISCUSSIONMEMBER");

    • ユーザーのお気に入りビューを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("REPORTVIEW");

    • ユーザーのお気に入りストーリーボードを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("STORYBOARD");
pf.setFavouriteType("FAVOURITE");

    • ユーザーのプロフィール画像を取得する場合ユーザーのプロフィールイメージを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("IMAGE");
pf.setFavouriteType("PROFILE");

    • ユーザーがフラグ付けをしたコメント付きレポートを取得する場合

      Code Block
      themeEclipse
      languagejava
      pf.setContentType("COMMENT");
pf.setFavouriteType("FLAGGED");

  • リクエストにこちらのオブジェクトを追加します。

     

    Code Block
    themeEclipse
    languagexml
    rsr.setFavourite(pf);

     

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

      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%          
/*              ws_listpersonfavourites.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("LISTPERSONFAVOURITES");
  
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentType("REPORT");
  
rsr.setFavourite(pf);
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
           out.write("<br>Success");
           if (rs.getPersonfavourites() != null)
           for (PersonFavourite f: pf){
                out.write("<br><br>contentId: " + f.getContentId());
                out.write("<br>ContentType: " + f.getContentType());
                out.write("<br>CreationCode: " + f.getCreationCode());
                out.write("<br>CreationDate: " + f.getCreationDate());
                out.write("<br>CreatorId: " + f.getCreatorId());
                out.write("<br>FavouriteType: " + f.getFavouriteType());
                out.write("<br>Message: " + f.getMessage());
                out.write("<br>PersonId: " + f.getPersonId());
                out.write("<br>textEntityId: " + f.getTextEntityId());
           }
} else {
            out.write("Failure");
            out.write(" Code: " + rs.getErrorCode());
}
%>
Expand
titleSAVEPERSONFAVOURITE

こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビューなどのアイテムを、ユーザのお気に入り一覧に追加します。また、ダッシュボードタブをユーザーのダッシュボードに追加し、コメントにフラグ付けすることもできます。こちらのwebサービスの呼び出しは、レポート、ストーリーボード、ビューなどの項目を、ユーザのお気に入り一覧に追加します。また、ダッシュボードタブをユーザーのダッシュボードに追加し、コメントにフラグ付けをすることもできます。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

FavouritePersonFavouriteこちらのオブジェクトは、ユーザーのお気に入りアイテムを指定するために使用します。こちらではユーザーも指定します。より詳細な情報は、以下の表を参照してください。

こちらのオブジェクトは、ユーザーのお気に入りに登録された項目を指定するために使用します。こちらで、ユーザーも指定します。より詳細な情報は、以下の表を参照してください。

 

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

PersonFavourite要素データ型説明
PersonIdInteger内部ID（IP IDです）とともにユーザーを識別するために必須のパラメーターです。選択されたアイテムは、ユーザーのお気に入りに追加されます。ID）とともにユーザーを識別するために必須のパラメーターです。選択された項目は、こちらのユーザーのお気に入りに追加されます。
ContentTypeString

こちらの必須パラメーターは、お気に入りに追加するアイテムのコンテンツタイプを姉弟するために使用します。値の選択肢は、以下の通りです。こちらの必須パラメーターは、お気に入りに追加する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。

  • REPORT
  • REPORTGROUP
  • DISCUSSIONGROUP
  • REPORTVIEW
  • STORYBOARD
  • IMAGE
ContentIdIntegerこちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りアイテムを定義するために使用します。こちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りに登録する項目を定義するために使用します。
FavouriteTypeString 
CreationCodeString 
TextEntityIdIntegerこちらのパラメーターは、コメントにフラグ付けをする場合に必要です。

 

リクエストの例

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

Code Block
languagexml
 <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>
            </favourite>    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("SAVEPERSONFAVOURITE");

  • PersonFavouriteオブジェクトを使用して、ユーザーを識別します。

     

    Code Block
    themeEclipse
    languagejava
    PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);

  • オブジェクト内でお気に入りに登録されるコンテンツを指定します。

     

    Code Block
    themeEclipse
    languagejava
    pf.setContentId(61252);
pf.setContentType("REPORTVIEW");

  • リクエストにこちらのオブジェクトを追加します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setFavourite(pf);

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%          
/*              ws_savepersonfavourite.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("SAVEPERSONFAVOURITE");
  
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(61252);
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
titleREMOVEPERSONFAVOURITE

こちらのwebサービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどのアイテムやオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントを外すこともできます。こちらのwebサービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどの項目やオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントのフラグを外すこともできます。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

FavouritePersonFavouriteこちらのオブジェクトは、削除するユーザーのお気に入りアイテムを指定するために使用します。こちらではユーザーも指定します。より詳細な情報は、以下の表を参照してください。こちらのオブジェクトは、ユーザーのお気に入り登録から削除する項目を指定するために使用します。こちらでユーザーも指定します。より詳細な情報は、以下の表を参照してください。

 

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

PersonFavourite要素データ型説明
PersonIdInteger内部ID（IP IDです）とともにユーザーを識別するために必須のパラメーターです。選択されたアイテムは、ユーザーのお気に入りから削除されます。ID）とともにユーザーを識別するために必須のパラメーターです。選択された項目は、ユーザーのお気に入りから削除されます。
ContentTypeString

こちらの必須パラメーターは、お気に入りから削除するアイテムのコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。こちらの必須パラメーターは、お気に入りから削除する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。

  • REPORT
  • REPORTGROUP
  • DISCUSSIONGROUP
  • REPORTVIEW
  • STORYBOARD
  • IMAGE
ContentIdIntegerこちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りアイテムを定義するために使用します。こちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りに登録された項目を定義するために使用します。
FavouriteTypeStringこちらは、ユーザーのお気に入りからレポートやダッシュボードを削除するために必要です。 
CreationCodeString 
TextEntityIdIntegerこちらのパラメーターは、コメントのフラグ付けを外すために必要です。

 

リクエストの例

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

Code Block
languagexml
<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>
            <favourite>
                <personId>13000</personId>
                <contentType>REPORTGROUP</contentType>
                <contentId>61209</contentId>
            </favourite>    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block
themeEclipse
languagexml
<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>0cc3673ed857e1e28fb0e326b8f3b24e</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("REMOVEPERSONFAVOURITE");

  • PersonFavouriteオブジェクトを使用して、ユーザーを識別します。

     

    Code Block
    themeEclipse
    languagejava
    PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);

  • オブジェクト内でお気に入りから削除されるコンテンツを指定します。こちらのオブジェクト内でお気に入りから削除されるオブジェクトを指定します。

     

    Code Block
    themeEclipse
    languagejava
    pf.setContentId(61252);
pf.setContentType("REPORTVIEW");

  • リクエストにこちらのオブジェクトを追加します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setFavourite(pf);

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

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%          
/*              ws_removepersonfavourite.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("REMOVEPERSONFAVOURITE");
  
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(70270);
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());
}
%>

...