30日間の無料評価版をお試しいただけます。

Versions Compared

Key

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

...

Expand
titleREFRESH_VIEW_CACHED_FILTERS

こちらのwebサービスは、特定のビューに関連するキャッシュフィルターを更新します。対象のビューは、そのID、またはUUIDを提供することで指定します。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

ParametersString[]

キャッシュからフィルターを削除するビューのID、またはUUIDを含む配列stringです。配列内の最初のパラメーターのみが使用される点に注意してください。

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

手順

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

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

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");
  • パラメーター要素を使用してビューのUUIDを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setParameters(new String[] { "61209" });
  • リクエストを構成したら、呼び出しを実行します。

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

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

 

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

 

完成例

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

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

Code Block
themeEclipse
languagejava
<%      
/*      ws_refreshviewfilters.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.*" %>
  
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");
     
// Provide the View UUID
rsr.setParameters(new String[] { "61209" });
     
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write(rs.getStatusCode());
    out.write(rs.toString());
}
Expand
titleRELOADCODESREFRESH_SOURCE_FILTERS

こちらのサービスは、特定のデータソース接続のすべてのアクセスソースフィルターを更新します。こちらのwebサービスは、Yellowfin内の指定した参照コードを再読み込みします。

 

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

ParametersString[]

更新する参照コードの配列です。以下は、選択肢のいくつかとその説明です。

  • NAME:組織名をリロードするために使用します。
  • PARAMETER:システム構成、カスタムパラメーター、日付期間を含む、組織のパラメーターをリロードします。
  • REFCODE:参照コードをリロードします。
  • ROLEFN:関数とロール定義をリロードします。
  • ORGRELATIONSHIPS:「クライアント参照IDから組織ID」へのマッピングを含む、組織の関連性をリロードします。

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

手順

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

この関数は、ターゲットソースIDとなるひとつの文字列のみをパラメーターとして要求します。この値は、reportviewsourceテーブルのSourceIdカラム(列)から見つけることができます。

リクエストの例

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

管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
java
  • Yellowfinに再読み込みの必要がある参照コードを指定します。

     

  • Expand
    title詳細手順
    Code Block
    themeEclipse
    language
    xml
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setFunction("RELOADCODES");
    Code Block
    themeEclipse
    languagejava
    rsr.setParameters(new String[] {
        "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
    });
    リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_reloadcodes.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_reloadcodes.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    <%      
    /*      ws_reloadcodes.jsp      <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>REFRESH_SOURCE_FILTERS</function>
                *<parameters>54700</
    %>parameters>
    <%@ 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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADCODES");
         
        rsr.setParameters(new String[] {
                "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
          	</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>13143fc20f2d7eeb52ec27f588a9942f</sessionId>
                <statusCode>SUCCESS</statusCode>
         	</return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

    手順

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

    こちらのwebサービスは、Yellowfin内のジオメトリーキャッシュをクリアします。
    Expand
    title詳細手順
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数のリクエストを定義します。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("REFRESH_SOURCE_FILTERS");
    • ソースID番号を使用して、キャッシュからその定義を削除するデータソースを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {"54700"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

    • StatusCodeを含む応答を取得するために、以下のチェックを追加します。

       

      Code Block
      themeEclipse
      languagejava
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("
    Success </br>
    • <br>Success");
                    	
      }
    • 
      else {
                    	out.write(
    rs.getStatusCode()
    • "<br>Failure");
                    	out.write(" Code: " + rs.
    toString
    • getErrorCode());
      
    • }   
    }
    Expand
    titleGEOMETRYFLUSH

     

    リクエストパラメーター

    完成例

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    ジオメトリーオブジェクトがキャッシュされているビューのIDです。

    応答パラメーター

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

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

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

    Code Block
    themeEclipse
    languagejava
    <%        	
    /*          	ws_refresh_source_filters.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("REFRESH_SOURCE_FILTERS");
     
    rsr.setParameters(new String[] {"54700"});
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                  	out.write("<br>Success");
                  	
    }
    else {
                  	out.write("<br>Failure");
                  	out.write(" Code: " + rs.getErrorCode());
    }             	
    %>
    Expand
    titleRELOADCODES

    こちらのwebサービスは、Yellowfin内の指定した参照コードを再読み込みします。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    更新する参照コードの配列です。以下は、選択肢のいくつかとその説明です。

    • NAME:組織名をリロードするために使用します。
    • PARAMETER:システム構成、カスタムパラメーター、日付期間を含む、組織のパラメーターをリロードします。
    • REFCODE:参照コードをリロードします。
    • ROLEFN:関数とロール定義をリロードします。
    • ORGRELATIONSHIPS:「クライアント参照IDから組織ID」へのマッピングを含む、組織の関連性をリロードします。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("RELOADCODES");
    • Yellowfinに再読み込みの必要がある参照コードを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
          "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*      ws_reloadcodes.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADCODES");
         
        rsr.setParameters(new String[] {
                "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleGEOMETRYFLUSH

    こちらのwebサービスは、Yellowfin内のジオメトリーキャッシュをクリアします。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    ジオメトリーオブジェクトがキャッシュされているビューのIDです。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("GEOMETRYFLUSH");
    • ジオメトリーオブジェクトをクリアするビューを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "70103", "70104"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*      ws_geometryflush.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("GEOMETRYFLUSH");
         
        //View IDs from which geometry objects are to be removed
        rsr.setParameters(new String[] {
                "70103", "70104"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleREMOVEVIEW

    こちらのwebサービスは、Yellowfin内のビューのキャッシュを削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュを削除するビューのIDです。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("REMOVEVIEW");
    • キャッシュを削除するビューを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "70103", "70104"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*      ws_removeview.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("REMOVEVIEW");
         
        //View IDs whose caches are to be removed
        rsr.setParameters(new String[] {
                "70103", "70104"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleFLUSHREPORT

    こちらのwebサービスは、レポートのキャッシュされた定義を削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュされた定義やメタデータを削除するレポートのIDです。最初の文字列のみ読み込まれるため、それがレポートIDであることを確認します。

    リクエストの例

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

    Code Block
    themeEclipse
    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>FLUSHREPORT</function>
            	<parameters>65254</parameters>
           	</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>5a29f6eaf3ee084b00c76da124f31fe0</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(new Integer(1));
       
      rsr.setFunction("FLUSHREPORT");
    • キャッシュからその定義を削除するレポートを、IDを使用して指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "56401"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

    • StatusCodeを含む応答を取得するために、以下のチェックを追加します。

       

      Code Block
      themeEclipse
      languagejava
       if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      } 

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_FLUSHREPORT.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");                        // set to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("FLUSHREPORT");
    rsr.setParameters(new String[] {"65254"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("<br>Success");
                     
    }
    else {
                    out.write("<br>Failure");
                    out.write(" Code: " + rs.getErrorCode());
    }              
    %>

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

  • SUCCESS
  • FAILURE
    Expand
    titleFLUSHTAB

    こちらのwebサービスは、Yellowfin内のダッシュボードタブのキャッシュされた定義を削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュされた定義やメタデータを削除するダッシュボードタブのIDです。最初の文字列のみ読み込まれるため、そのIDが含まれていなくてはいけません。

    リクエストの例

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

    Code Block
    themeEclipse
    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>FLUSHTAB</function>
            	<parameters>65254</parameters>
           	</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>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
                <statusCode>SUCCESS</statusCode>
         	</return>
      	</ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>
    応答要素データ型説明

    StatusCode

    String

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("GEOMETRYFLUSHFLUSHTAB");
    • ジオメトリーオブジェクトをクリアするビューを指定します。キャッシされた定義を削除するダッシュボードタブのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "70103", "70104"
      "65254"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_geometryflush.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
    • 管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

    • StatusCodeである応答を取得するために、以下のコードを追加します。

       

    インターネットブラウザから、「http://<host>:<port>/ws_geometryflush.jsp」を実行します。
    • Code Block
      themeEclipse
      languagejava
    <%
    • if ("SUCCESS".equals(rs.getStatusCode()) ) {
         
    /*
    •       
    ws_geometryflush.jsp
    •      	out.write("<br>Success");
                    
    */ %> <%@ 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.*" %> AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("GEOMETRYFLUSH"); //View IDs from which geometry objects are to be removed rsr.setParameters(new String[] { "70103", "70104" }); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success </br>"); } else { out.write(rs.getStatusCode()); out.write(rs.toString()); }
    Expand
    titleREMOVEVIEW
    • 	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      } 

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_flushtab.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("FLUSHTAB");
    rsr.setParameters(new String[] {"65254"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("<br>Success");
                     
    }
    else {
                    out.write("<br>Failure");
                    out.write(" Code: " + rs.getErrorCode());
    }              
    %>
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    Expand
    titleFLUSHPERSON

    こちらのwebサービスは、キャッシュされたユーザーの詳細を削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュされた定義やメタデータを削除するユーザーレコードのIDです。最初の文字列のみ読み込まれるため、そのIDが含まれていなくてはいけません。

    リクエストの例

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

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

    こちらのwebサービスは、Yellowfin内のビューのキャッシュを削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュを削除するビューのIDです。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

    Expand
    title詳細手順
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setFunction("REMOVEVIEW");
  • キャッシュを削除するビューを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setParameters(new String[] {
         "70103", "70104"
    });
  • リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_removeview.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_removeview.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    <%      
    /*      ws_removeview.jsp               *<password>test</
    %>password>
    <%@ 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.*" %>
      
     	<orgId>1</orgId>
            	<function>FLUSHPERSON</function>
         AdministrationServiceResponse rs = null; 	<parameters>65254</parameters>
        AdministrationServiceRequest rsr = new AdministrationServiceRequest(); 	</arg0>
      	</web:remoteAdministrationCall>
      AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("REMOVEVIEW");
         
        //View IDs whose caches are to be removed
        rsr.setParameters(new String[] {
     </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>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
      "70103", "70104"
        });
         <statusCode>SUCCESS</statusCode>
         rs	</return>
     = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleFLUSHREPORT
     	</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(new Integer(1));
      
      rsr.setFunction("FLUSHTAB");
    • キャッシされた定義を削除するダッシュボードタブのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {"65254"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

    • StatusCodeである応答を取得するために、以下のコードを追加します。

       

    こちらのwebサービスは、Yellowfin内のレポートのキャッシュされた定義を削除します。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュされた定義やメタデータを削除するレポートのIDです。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("FLUSHREPORT");
    • キャッシュからその詳細を削除するビューのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "56401"
      });
    • リクエストを構成したら、呼び出しを実行します。
      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

    • if ("SUCCESS".equals(rs.getStatusCode()) ) {
                      out.write("<br>Success");
                       
      }
      else {
                      out.write("<br>Failure");
                      out.write(" Code: " + rs.getErrorCode());
      } 

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_flushreportflushperson.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("FLUSHREPORT");
         
        //Report IDs whose definitions are to be removed from the cache
        rsr.setParameters(new String[] {
    " %>
    <%
      
    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");                        // set to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("FLUSHPERSON");
    rsr.setParameters(new String[] {"65254"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("<br>Success");
                 "56401"
        
    });
    else     {
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br><br>Failure");
        }   else {
            out.write(" Code: " + rs.getStatusCodegetErrorCode());
    }          out.write(rs.toString());
        }
    %>
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    Expand
    titleFLUSHTABRELOADLICENCE

    こちらのwebサービスは、Yellowfin内のダッシュボードタブのキャッシュされた定義を削除します。こちらのwebサービスは、Yellowfin内のライセンスを再読み込みします。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    キャッシュされた定義やメタデータを削除するダッシュボードタブのIDです。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

    Expand
    title詳細手順
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setFunction("FLUSHTAB");
  • キャッシュからその詳細をするダッシュボードタブのIDを指定します。

     

    Code Block
    themeEclipse
    languagejava
    rsr.setParameters(new String[] {
         "61251", "61253"
    });
  • リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_flushtab.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • String

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

    OrgId

    Integer

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

    Function

    String

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

     

    リクエストの例

    以下の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>
      
    インターネットブラウザから、「http://<host>:<port>/ws_flushtab.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    <%      
    /*          ws_flushtab.jsp<orgId>1</orgId>
                <function>RELOADLICENCE</function>    
        */
    %>
    <%@ 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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("FLUSHTAB");
         
        //Dashboard tab IDs whose definitions are to be removed from the cache
        rsr.setParameters(new String[] {
     </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

    以下のSOAP XMLの応答が、 今回の例に基づき返されます。

    Code Block
    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 "61251", "61253"Request Complete</messages>
        });
         
       <sessionId>c4d0b6dec61e890a417132f05c3f0fbc</sessionId>
     rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {    <statusCode>SUCCESS</statusCode>
            out.write("Success </br>");return>
        } else {</ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = 
    out.write(rs.getStatusCode(
    • new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
    out.write(rs.toString()); }
    Expand
    titleRELOADLICENCE
    • 
      rsr.setFunction("RELOADLICENCE");
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%

    こちらのwebサービスは、Yellowfin内のライセンスを再読み込みします。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

     

    リクエストの例

    以下の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>
     ws_reloadlicence.jsp         <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <function>RELOADLICENCE</function>    
             </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

    以下のSOAP XMLの応答が、 今回の例に基づき返されます。

    Code Block
    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>c4d0b6dec61e890a417132f05c3f0fbc</sessionId>
                <statusCode>SUCCESS</statusCode>*/
    %>
    <%@ 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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADLICENCE");
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </return>br>");
        } else </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(new Integer(1));
     
    rsr.setFunction("RELOADLICENCE");
    リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_reloadlicene.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「http://<host>:<port>/ws_reloadlicene.jsp」を実行します。
         out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleCLOSECONNECTIONPOOL

    こちらのwebサービスは、指定したデータソースのコネクションプールを閉じます。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]コネクションプールを閉じるデータソースのIDです。

    リクエストの例

    以下のSOAP XMLの例は、必須パラメーターを使用してこのリクエストを実行する方法を示しています。

    Code Block
    themeEclipse
    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>
    
    Code Block
    themeEclipse
    languagejava
    <%      
    /*          ws_reloadlicence.jsp  	<function>CLOSECONNECTIONPOOL</function>
            	<parameters>74909</parameters>
           *	</
    %>
    <%@ 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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("RELOADLICENCE");
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleCLOSECONNECTIONPOOL
    arg0>
      	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

    今回の例に基づき、以下のSOAP XMLの応答が返されます。

    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>5a29f6eaf3ee084b00c76da124f31fe0</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(new Integer(1));
       
      rsr.setFunction("CLOSECONNECTIONPOOL");
    • コネクションプールを閉じるデータソースのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {"74909"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

    • StatusCodeを含む応答を取得するために、以下のコードを追加します。

       

    こちらのwebサービスは、指定したデータソースのコネクションプールを閉じます。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]コネクションプールを閉じるデータソースのIDです。

      

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("CLOSECONNECTIONPOOL");
    • コネクションプールを閉じるデータソースのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "61251", "61253"
      });
    • リクエストを構成したら、呼び出しを実行します。
      Code Block
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

    返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
    • if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      else {
                    	out.write("<br>Failure");
                    	out.write(" Code: " + rs.getErrorCode());
      }  

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_closeconnectionpool.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    <%
        
    AdministrationServiceService tss_adm = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs       // adjust host and port number
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) tss_adm.getAdministrationService();
    AdministrationServiceRequest rsr 
    = new AdministrationServiceRequest();
      
    rsr.setLoginId("admin@yellowfin.com.au");
               // provide your Yellowfin web services admin account
    rsr.setPassword("test");
              rsr.setOrgId(new Integer(1));
        rsr.setFunction("CLOSECONNECTIONPOOL");
         
        //Data set sourceto IDsthe whosepassword connectionof poolsthe are to be closed
        account above
    rsr.setOrgId(1);
    rsr.setFunction("CLOSECONNECTIONPOOL");
    rsr.setParameters(new String[] {
                "12323"
        "74909"});
         
       AdministrationServiceResponse rs = rssbsadminService.remoteAdministrationCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("Success </br><br>Success");
         }             
    }
    else {
                    out.write(rs.getStatusCode()"<br>Failure");
                    out.write(" Code: " + rs.toStringgetErrorCode());
    }         }     
    %>
    Expand
    titleFLUSHCACHEDFILTERCACHE

    こちらのwebサービスは、指定したフィルターのフィルターキャッシュをクリアします。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]フィルターキャッシュを更新するフィルターのIDです。

      

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("FLUSHCACHEDFILTERCACHE");
    • キャッシュを更新するフィルターのIDを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "12323"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*          ws_flushcachedfilter.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("FLUSHCACHEDFILTERCACHE");
         
        //Specify filter ID to flush its cache
        rsr.setParameters(new String[] {
                "12323"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleDELETEVIEW

    こちらのwebサービスは、Yellowfin内のビューを削除するために使用します。ID、またはUUIDを提供することで、ビューを指定することができます。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]削除するビューのID、またはUUIDです。

      

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("DELETEVIEW");
    • ID、またはUUIDを提供することで、削除するビューを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "70103"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*          ws_deleteview.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("DELETEVIEW");
         
        //Specify the view to be deleted by providing its ID or UUID
        rsr.setParameters(new String[] {
                "70103"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleDELETESOURCE

    こちらのwebサービスは、指定したデータソースを削除する場合に使用します。IDを提供することで、データソースを識別することができます。

     

    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]削除するデータソースのIDです。

      

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("DELETESOURCE");
    • ID、またはUUIDを提供することで、削除するデータソースを指定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "40563"
      });
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

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

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%      
    /*          ws_deletesource.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.*" %>
      
        AdministrationServiceResponse rs = null;
        AdministrationServiceRequest rsr = new AdministrationServiceRequest();
        AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
        AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     
        rsr.setLoginId("admin@yellowfin.com.au");
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("DELETESOURCE");
         
        //Specify the data source to be deleted by providing its ID
        rsr.setParameters(new String[] {
                "40567"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    Expand
    titleREMOVECONTENTMANAGEMENT

    こちらのwebサービスは、クラスタのメッセージングに使用します。これは、ローカルでコンテンツ管理レコードが変更されたり、削除された時に、リモートキャッシュからこれを削除します。

     

    リクエストパラメーター

    以下のパラメーターは、こちらのリクエストとともに渡されます。

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    parametersString[]コンテンツ管理IDを最初の文字列として渡すために使用します。(最初の文字列のみが読み込まれます。)

     

    リクエストの例

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

    Code Block
    themeEclipse
    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>REMOVECONTENTMANAGEMENT</function>
               <parameters>73118</parameters>
            </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>5a29f6eaf3ee084b00c76da124f31fe0</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(new Integer(1));
       
      rsr.setFunction("REMOVECONTENTMANAGEMENT");
    • 次に、パラメーター要素内のキャッシュから削除するコンテンツ管理IDを設定します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {"73118"});
    • リクエストを構成したら、呼び出しを実行します。

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

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

     

    • StatusCodeを含む応答を返すチェックを追加します。(より詳細な情報は、上記応答パラメーターの表を参照してください)

       

      Code Block
      themeEclipse
      languagejava
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                      out.write("<br>Success");
                       
      }
      else {
                      out.write("<br>Failure");
                      out.write(" Code: " + rs.getErrorCode());
      }

     

    完成例

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

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

    Code Block
    themeEclipse
    languagejava
    <%          
    /*              ws_removecontentmanagement.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("REMOVECONTENTMANAGEMENT");
    rsr.setParameters(new String[] {"73118"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("<br>Success");
                     
    }
    else {
                    out.write("<br>Failure");
                    out.write(" Code: " + rs.getErrorCode());
    }              
    %>

    ...