Versions Compared

Key

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

...

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

こちらの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を指定するオプションパラメーターです。

DashboardTabIdInteger

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

 

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

  • 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>
            <person><parentReportGroups>
               <emailAddress>admin@yellowfin.com.au</emailAddress><reportGroup>
               <firstName>System</firstName>   <publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
            <initial/>      <reportGroupId>61250</reportGroupId>
         <ipId>5</ipId>         <reportGroupName>Sales Performance</reportGroupName>
     <languageCode>EN</languageCode>             <reportGroupStatus>OPEN</reportGroupStatus>
  <lastName>Administrator</lastName>                <roleCode>YFADMIN<<reportGroupType>ANALYTIC</roleCode>reportGroupType>
               <salutationCode</>reportGroup>
               <status>ACTIVE</status><reportGroupId>61250</reportGroupId>
               <reportGroupSubTabs>
  <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>                <userId>admin@yellowfin.com.au</userId><publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
            </person>      <reportGroupId>61251</reportGroupId>
      <reportGroups>            <reportGroupName>New Tab</reportGroupName>
  <publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>                <reportGroupId>61250<<reportGroupStatus>OPEN</reportGroupId>reportGroupStatus>
                 <reportGroupName>Sales Performance<<reportGroupType>SUBTAB</reportGroupName>reportGroupType>
               <reportGroupStatus>OPEN</reportGroupStatus></reportGroupSubTabs>
            </parentReportGroups>
     <reportGroupType>ANALYTIC</reportGroupType>       <parentReportGroups>
     </reportGroups>          <reportGroup>
  <reportGroups>                <publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
                  <reportGroupId>61209</reportGroupId>
                  <reportGroupName>Campaign Analysis</reportGroupName>
                  <reportGroupStatus>OPEN</reportGroupStatus>
                  <reportGroupType>ANALYTIC</reportGroupType>
               </reportGroups>reportGroup>
               <sessionId>42075cc6bc5723e6daf997796aa00a57</sessionId><reportGroupId>61209</reportGroupId>
               <reportGroupSubTabs>
        <statusCode>SUCCESS</statusCode>          </return><publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
              </ns2:remoteAdministrationCallResponse>    </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順
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サービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

    • SUCCESS
    • FAILURE
    ReportGroupsAdministrationReportGroup[]

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

     

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

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

     

     

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

     

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

    完成例

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

  • コードをコピーして、「ws_getuserdraftparenttabswithreports.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_getuserdraftparenttabswithreports.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    <%<reportGroupId>61210</reportGroupId>
                      <reportGroupName>Campaigns</reportGroupName>
                      <reportGroupStatus>OPEN</reportGroupStatus>
                      <reportGroupType>SUBTAB</*reportGroupType>
                 ws_getuserdraftparenttabswithreports.jsp  </reportGroupSubTabs>
               */ %> <%@ 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);<reportGroupSubTabs>
                      <publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
                 // adjust host and port number<reportGroupId>61243</reportGroupId>
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest();   rsr.setLoginId("admin@yellowfin.com.au");      <reportGroupName>Marketing</reportGroupName>
       // provide your Yellowfin web services admin account
    rsr.setPassword("test");        <reportGroupStatus>OPEN</reportGroupStatus>
                      <reportGroupType>SUBTAB<// 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");reportGroupType>
                   </reportGroupSubTabs>
              rsr.setPerson(ap);  </parentReportGroups>
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);   if ("SUCCESS".equals(rs.getStatusCode()) ) {   <person>
     out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");        <emailAddress>admin@yellowfin.com.au</emailAddress>
                   <firstName>System</firstName>
                   <initial/ get the tabs details:>
                   <ipId>5</ipId>
         AdministrationReportGroup[] tabs = rs.getReportGroups();     for (AdministrationReportGroup tab: tabs){ <languageCode>EN</languageCode>
             out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");<lastName>Administrator</lastName>
                   out.write("<br>Dashboard tab Status: " + tab.getReportGroupStatus() + "<br>");<roleCode>YFADMIN</roleCode>
                   AdministrationReport[] rpts = tab.getGroupReports();<salutationCode/>
               if (rpts != null) <status>ACTIVE</status>
               for (AdministrationReport r: rpts){
     <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
                   out.write("Report Name: " + r.getReportName());<userId>admin@yellowfin.com.au</userId>
                </person>
                <sessionId>59ff828c9f26cbe0fdfd281a951d3ec9</sessionId>
       out.write("<br>Description: " + r.getReportDescription());      <statusCode>SUCCESS</statusCode>
              out.write("<br>ReportId: " + r.getReportId());</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を指定するオプションパラメーターです。

    DashboardTabIdInteger

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

     

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

    • SUCCESS
    • FAILURE
    ParentDashboardsParentDashboard[]

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

     

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

    応答要素データ型説明
    DashboardNameStringダッシュボードの名前です。
    DashboardGroupIdInteger 
    TabIdsString[]サブタブ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を提供します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

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

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

    ReportGroupAdministrationReportGroup

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

     

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

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

     

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

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

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    ParentGroupsParentReportGroup[]

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

     

    手順

    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。(より詳細な情報は、上記応答パラメーターの表を参照してください。)

       

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

       

      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オブジェクトをしようして、ユーザーを指定します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

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

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

    DashboardTabIdInteger

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

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

     

    以下は、こちらの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>DELETETAB</function>
                <person>
                    <userId>admin@yellowfin.com.au</userId>             
                </person>
                <dashboardTabId>61243</dashboardTabId>
             </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

     

     

     

     

     

    その他のオブジェクトの操作

    以下のwebサービスの呼び出しは、レポート、ダッシュボード、ビューなどを含む、異なるタイプのオブジェクトの操作に使用します。

    Expand
    titleLISTPERSONFAVOURITES

    こちらの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こちらのパラメーターはオプションです。

     

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

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

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

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

     

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

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

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

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

     

    リクエストの例

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

    Code Block
    languagexml
     

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

    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
    <%        out.write("<br>ReportUUID: " + r.getReportUUID());
    /*              ws_listpersonfavourites.jsp   out.write("<br>ExecutionObject: " + r.getExecutionObject());           */
    %>
    <%@    out.write("<br>ReportCategory: " + r.getReportCategory());
                    out.write("<br>SubCategory: " + r.getReportSubCategory());
                    out.write("<br>BirtData: " + r.getBirtData()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 =  out.write("<br>SourceName: " + r.getSourceName());
                    out.write("<br>SourceId: " + r.getSourceId())(AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");         // provide your Yellowfin webservices admin account
     outrsr.writesetPassword("<br>AuthoringMode: " + r.getAuthoringMode()test");                 out.write("<br>ReportTemplate: " + r.getReportTemplate());                 out.write("<br>DataOutput: " + r.getDataOutput());              // change  out.write("<br>DashboardEnabled: " + r.isDashboardEnabled()to be the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("LISTPERSONFAVOURITES");
      
    PersonFavourite pf = new PersonFavourite();
            out.write("<br>ViewId: " + r.getViewId())pf.setPersonId(13073);
    pf.setContentType("REPORT");
      
    rsr.setFavourite(pf);
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
          out.writeif ("<br>ViewName: " + r.getViewNameSUCCESS".equals(rs.getStatusCode()); ) {
                  out.write("<br>ViewDescription: " + r.getViewDescription()<br>Success");
               if     out.write("<br>LastModifierName: " + r.getLastModifierName());
     (rs.getPersonfavourites() != null)
               for   out.write("<br>LastModifierId: " + r.getLastModifierId());(PersonFavourite f: pf){
                    out.write("<br>LastModifiedDate<br><br>contentId: " + rf.getLastModifiedDategetContentId());
                    out.write("<br>PublishDate<br>ContentType: " + rf.getPublishDategetContentType());
                    out.write("<br>DeliveryMode<br>CreationCode: " + rf.getDeliveryModegetCreationCode());
                    out.write("<br>LastRunTime<br>CreationDate: " + rf.getLastRunTimegetCreationDate());
                    out.write("<br>AverageRunTime<br>CreatorId: " + rf.getAverageRunTimegetCreatorId());
                    out.write("<br>RoleCode<br>FavouriteType: " + rf.getRoleCodegetFavouriteType());
                    out.write("<br>ChartTypeCode<br>Message: " + rf.getChartTypeCodegetMessage());
                    out.write("<br>Usage<br>PersonId: " + rf.getUsagegetPersonId());
                    out.write("<br><br>"<br>textEntityId: " + f.getTextEntityId());
               }
    } else {
      }
    } else {         out.write("Failure");
                out.write(" Code: " + rs.getErrorCode());
    }
    %>

     

    ...