Versions Compared

Key

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

...

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 <soapenv:Envelope xmlns:Ssoapenv="http://schemas.xmlsoap.org/soap/envelope/">    <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
 <return>     <web:remoteAdministrationCall>
       <errorCode>0</errorCode>  <arg0>
          <messages>Successfully Authenticated User: admin@yellowfin<loginId>admin@yellowfin.com.au</messages>loginId>
            <messages>Web Service Request Complete</messages><password>test</password>
            <personfavourites><orgId>1</orgId>
               <contentId>61209</contentId><function>SAVEPERSONFAVOURITE</function>
            <favourite>
  <contentType>REPORTGROUP</contentType>              <personId>13000</personId>
 <creationCode/>                <creationDate>2017-06-26</creationDate><contentType>REPORTGROUP</contentType>
                <creatorId>0<<contentId>61209</creatorId>contentId>
            </favourite>   <favouriteType>REPORTDASHBOARD</favouriteType> 
         </arg0>
    <message/>  </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>
   <personId>5</personId>   <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
           <textEntityId>0</textEntityId><return>
            <<errorCode>0</personfavourites>errorCode>
            <personfavourites><messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <contentId>61250</contentId><messages>Web Service Request Complete</messages>
            <contentType>REPORTGROUP<<sessionId>6eb0b81605d3b355cf4a43ae608ab274</contentType>sessionId>
               <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>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("LISTPERSONFAVOURITESSAVEPERSONFAVOURITE");
  • PersonFavouriteオブジェクトを使用して、ユーザーを識別します。

     

    Code Block
    themeEclipse
    languagejava
    PersonFavourite pf = new PersonFavourite();
    pf.setPersonId(13073);
  • 以下の手順はオプションであり、こちらの呼び出しの応答にフィルターを適用するために含めることができます。オブジェクト内でお気に入りに登録されるコンテンツを指定します。

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

     

    Code Block
    themeEclipse
    languagejava
    pf.
    setContentType
    setContentId(
    "REPORT"
    61252);
    
    
    pf.
    setFavouriteType
    setContentType("
    FAVOURITE
    REPORTVIEW");
  • ユーザーのダッシュボードすべてを取得する場合

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

     

    Code Block
    themeEclipse
    languagejava
    pf
    rsr.
    setContentType
    setFavourite(
    "REPORTGROUP"
    pf);
    pf.setFavouriteType("REPORTDASHBOARD");ユーザーに配信されたレポートやダッシュボードを取得する場合
  • リクエストを構成したら、呼び出しを実行します。

    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
インターネットブラウザから、「http://<host>:<port>/ws_listpersonfavourites.jsp」を実行します。
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サービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

  • コードをコピーして、「ws_listpersonfavourites.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • <%        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サービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどのアイテムやオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントを外すこともできます。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    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
    <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>    
       ws_listpersonfavourites.jsp      </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    */
    %>
    <%@ 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);</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>
             // adjust host and<errorCode>0</errorCode>
    port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); <messages>Successfully Authenticated User: rsr.setLoginId("admin@yellowfin.com.au");au</messages>
            // provide your Yellowfin webservices<messages>Web adminService account
    rsr.setPassword("test");Request Complete</messages>
                <sessionId>0cc3673ed857e1e28fb0e326b8f3b24e</sessionId>
                <statusCode>SUCCESS</statusCode>
             </return>
          </ns2:remoteAdministrationCallResponse>
              // change to be the password of the account above
    </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
    • REMOVEPERSONFAVOURITE");
    • PersonFavouriteオブジェクトを使用して、ユーザーを識別します。

       

      Code Block
      themeEclipse
      languagejava
      PersonFavourite pf = new PersonFavourite();
      pf.setPersonId(13073);
    • オブジェクト内でお気に入りから削除されるコンテンツを指定します。

       

      Code Block
      themeEclipse
      languagejava
      pf.setContentId(61252);
      pf.setContentType("
    REPORT
    • 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
    <%     if ("SUCCESS".equals(rs.getStatusCode()) ) {     
    /*              out.write("<br>Success");ws_removepersonfavourite.jsp            if (rs.getPersonfavourites() != null)     */
    %>
    <%@ page language="java" contentType="text/html;  for (PersonFavourite f: pf){
                    out.write("<br><br>contentId: " + f.getContentId())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>ContentType: " + f.getContentType());
                    out.write("<br>CreationCode: " + f.getCreationCode())(AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");             // provide your  out.write("<br>CreationDate: " + f.getCreationDate())Yellowfin web services admin account
    rsr.setPassword("test");                 out.write("<br>CreatorId: " + f.getCreatorId());        // set to the password of the account above
    outrsr.write("<br>FavouriteType: " + f.getFavouriteType())setOrgId(1);
    rsr.setFunction("REMOVEPERSONFAVOURITE");
      
    PersonFavourite pf = new PersonFavourite();
    pf.setPersonId(13073);
           out.write("<br>Message: " + f.getMessage())pf.setContentId(70270);
    pf.setContentType("REPORTVIEW");
      
    rsr.setFavourite(pf);
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
          out.writeif ("<br>PersonId: " + f.getPersonIdSUCCESS".equals(rs.getStatusCode());           ) {
         out.write("<br>textEntityId: <br>Success"); + f.getTextEntityId());            }
    } else {
    
               out.write("Failure");
       
            out.write(" Code: " + rs.getErrorCode());
    }
    %>

     

    ...