Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
top
top


 以下のwebサービスは、ローカルデータベースに接続された複数のノード間でYellowfinを設定するクラスタ環境内で使用されます。大部分は、クラスタノード間でメッセージを送信したり、データがローカルで更新、または削除された時に特定ノードのキャッシュをクリアすることで、クラスタ全体を通したコンテンツの一貫性を確保するために使用されます。各サービスは、特定のタイプのコンテンツやデータを削除します。

以下のwebサービスは、インメモリストレージとデータの管理を提供するキャッシュを管理するために使用します。

 


Expand
titleBINARYCACHEFLUSH

こちらのwebサービスは、バイナリclasローダー内のclassを削除するために使用します。例えば、コネクターやデータトランスフォーメーションステップのように、ファイルシステム上ではなく、データベース内に保存されるプラグインとして読み込まれるclassなどが該当します。こちらのwebサービスは、バイナリclassローダー内のclassを削除するために使用します。例えば、コネクターやデータトランスフォーメーションステップのように、ファイルシステム上ではなく、データベース内に保存されるプラグインとして読み込まれるclassなどが該当します。

 


リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

 


リクエストの例

以下は、こちらのリクエストの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>BINARYCACHEFLUSH</function>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
 


応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

応答の例

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

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


手順

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

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

    Code Block
    language
    languagejava
    themeEclipsejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
     
    rsr.setFunction("BINARYCACHEFLUSH");

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

     

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


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

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

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

 


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

 



完成例

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

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

Code Block
languagejava
themeEclipselanguagejava
<%      
/*      ws_binarycacheflush.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("BINARYCACHEFLUSH");   
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(rs.toString());
}



Expand
titleUPLOADLICENCE

 

こちらのwebサービスは、新規Yellowfinライセンスをアップロードするために使用します。こちらのwebサービスは、Yellowfinインスタンスに新規ライセンスをアップロードするために使用します。


リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

BinaryDatabyte[]新規ライセンスを含むバイト配列です。

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

手順

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

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

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


  • インスタンスに新規ライセンスを提供します。ライセンスはバイト配列になります。これは、Base64にエンコードし、utilメソッドを使用して変換することができます。


    Code Block
     code
    language
    java
    themeEclipselanguagejava
    byte[] lic = com.hof.util.Base64.decode("Base64 Encoded String of licence file");
    rsr.setBinaryData(lic);


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

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

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

 

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


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


完成例

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

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

Code Block
 code
language
java
themeEclipselanguagejava
<%      
/*      ws_uploadlicence.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("UPLOADLICENCE");
     
// Licence needs to be a byte array. An easy way to do this is to encode it to Base64 and use the util method to convert it
byte[] lic = com.hof.util.Base64.decode("Base64 Encoded String of licence file");
rsr.setBinaryData(lic);
     
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write(rs.getStatusCode());
    out.write(rs.toString());
}

 

 

 





Expand
titleDELGEOPACK

 こちらのwebサービスは、ジオパックキャッシュから指定したジオパックを削除しますが、サーバから対象のジオパックを削除するわけではありません。こちらのwebサービスは、ジオパックキャッシュから指定したジオパックを削除します。これは、サーバ上のジオパックは削除しない点に注意をしてください。

リクエストパラメーター

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

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

LoginId

String

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

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

Password

String

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

OrgId

Integer

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

Function

String

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

OrgRefStringこちらのオプションパラメーターは、クライアント組織IDの指定に使用することができます。
ParametersStringキャッシュから削除するジオパックのUUIDの指定に使用しますキャッシュから削除するジオパックのUUIDを指定するために使用します。

リクエストの例

以下は、こちらのリクエストの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>DELGEOPACK</function>
            <parameters>
                <string>db1cf6f7-3561-45a0-b6bc-ff7b94117741</string>
            </parameters>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

応答の例

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

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>9a3871407a758998334a2d780c44f9ae</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 


手順

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

 

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

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


  • パラメーター要素を通してUUIDを提供することで、キャッシュから削除するジオパックを指定します。


    Code Block
     code
    language
    java
    themeEclipselanguagejava
    rsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );


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

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

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

 


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

 



完成例

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

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

Code Block
 code
language
java
themeEclipselanguagejava
<%      
/*      ws_delgeopack.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("DELGEOPACK");
rsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );
     
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(rs.toString());
}


...

Expand
titleREFRESH_DASHBOARD_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_DASHBOARD_CACHED_FILTERS」に設定します。

ParametersString[]

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

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

手順

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

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

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


  • パラメーター要素を使用してダッシュボードのUUIDを指定します。


    Code Block
     code
    language
    language
    java
    themeEclipsejava
    rsr.setParameters(new String[] { "61209" });


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

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

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

 


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

 



完成例

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

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

Code Block
languagejava
themeEclipselanguagejava
<%      
/*      ws_refreshdashboardfilters.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_DASHBOARD_CACHED_FILTERS");
     
// Provide the Dashboard 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
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です。配列内の最初のパラメーターのみが使用されます。キャッシュされたフィルターを削除するビューのID、またはUUIDを含む配列stringです。配列内の最初のパラメーターのみが使用される点に注意してください。

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

手順

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

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

    Code Block
    languagejava
    themeEclipselanguagejava
    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
     code
    language
    java
    themeEclipselanguagejava
    rsr.setParameters(new String[] { "61209" });


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

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

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

 


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

 



完成例

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

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

Code Block
languagejava
themeEclipselanguagejava
<%      
/*      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());
}



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

 

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

こちらのサービスは、特定のデータソース接続のすべてのアクセスソースフィルターを更新します。


リクエストパラメーター

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

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

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[]

更新する参照コードの配列です。選択肢は、以下の通りです。

  • ADDRESS
  • HIERARCHY
  • NAME
  • PARAMETER
  • REFCODE
  • ROLEFN
  • ORGRELATIONSHIPS

応答パラメーター

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

応答要素データ型説明

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("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サービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

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

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

    リクエストの例

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

    Code Block
    languagexml
    themeEclipse
    <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>
           ws_reloadcodes.jsp     <function>REFRESH_SOURCE_FILTERS</function>
                *<parameters>54700</parameters>
    %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@	</arg0>
    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);
     
          	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

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

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

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

      Code Block
      languagejava
      themeEclipse
      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
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {"54700"});


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

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

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


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


      Code Block
      languagejava
      themeEclipse
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("
    Success </br>
    • <br>Success");
                    	
      }
      else {
                    	out.write(
    rs.getStatusCode()
    • "<br>Failure");
              
    out.write(rs.toString());
    •       	out.write(" Code: " + rs.getErrorCode());
      }   
    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

    以下は、こちらの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
    languagejava
    themeEclipse
    <%        	
    /*          	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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("RELOADCODES");


    • Yellowfinに再読み込みの必要がある参照コードを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
          "ADDRESS", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
      });


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

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

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


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


    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%      
    /*      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", "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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("GEOMETRYFLUSH");


    • ジオメトリーオブジェクトをクリアするビューを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
           "70103", "70104"
      });


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

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

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


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


    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%      
    /*      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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("REMOVEVIEW");


    • キャッシュを削除するビューを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
           "70103", "70104"
      });


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

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

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


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


    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%      
    /*      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
    languagexml
    themeEclipse
    <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
    languagexml
    themeEclipse
    <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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("FLUSHREPORT");


    • キャッシュからその定義を削除するレポートを、IDを使用して指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
           "56401"
      });


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

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

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


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


      Code Block
      languagejava
      themeEclipse
       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
    languagejava
    themeEclipse
    <%          
    /*              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());
    }              
    %>



    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
    languagexml
    themeEclipse
    <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
    languagexml
    themeEclipse
    <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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("FLUSHTAB");


    • キャッシされた定義を削除するダッシュボードタブのIDを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {"65254"});


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

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

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


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


      Code Block
      languagejava
      themeEclipse
      if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    	out.write("<br>Success");
                    	
      }
      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
    languagejava
    themeEclipse
    <%          
    /*              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());
    }              
    %>



    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
    languagexml
    themeEclipse
    <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>FLUSHPERSON</function>
            	<parameters>65254</parameters>
           	</arg0>
      	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例 

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

    Code Block
    languagexml
    themeEclipse
    <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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
      
      rsr.setFunction("FLUSHTAB");


    • キャッシされた定義を削除するダッシュボードタブのIDを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {"65254"});


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

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

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


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


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



    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%          
    /*              ws_flushperson.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("FLUSHPERSON");
    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());
    }              
    %>



    Expand
    titleRELOADLICENCE

    こちらの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>
              <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>
             </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>


    手順

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

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

      Code Block
      languagejava
      themeEclipse
      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);

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


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


    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%      
    /*          ws_reloadlicence.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("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

    こちらの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
    languagexml
    themeEclipse
    <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>CLOSECONNECTIONPOOL</function>
            	<parameters>74909</parameters>
           	</arg0>
      	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

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

    Code Block
    languagexml
    themeEclipse
    <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
      languagejava
      themeEclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("CLOSECONNECTIONPOOL");


    • コネクションプールを閉じるデータソースのIDを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {"74909"});


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

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

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


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


      Code Block
      languagejava
      themeEclipse
      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
    languagejava
    themeEclipse
    インターネットブラウザから、「http://<host>:<port>/ws_geometryflush.jsp」を実行します。
    "CLOSECONNECTIONPOOL");
    rsr.setParameters(new String[] {
    "70103", "70104" });リクエストを構成したら、呼び出しを実行します。
    "74909"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

    返される応答には、StatusCodeが含まれます。(より詳細な情報は、上記応答パラメーターの表を参照してください)
    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.*" %>
    <%
      
    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
    (new Integer
    (1
    )
    );
    
    rsr.setFunction(
    "GEOMETRYFLUSH");

    ジオメトリーオブジェクトを更新するビューを指定します。

     

    Code Block
    themeEclipse
    languagejava
    Code Block
    languagejava

     

    完成例

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

  • コードをコピーして、「ws_geometryflush.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • <%      
    /*
      
    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.*" %>
    }
    else {
                    AdministrationServiceResponse rs = null;
    out.write("<br>Failure");
       AdministrationServiceRequest rsr = new AdministrationServiceRequest();     AdministrationServiceService ts = new AdministrationServiceServiceLocatorout.write("localhost", 8080,Code: "/services/AdministrationService", false + rs.getErrorCode());
    }    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[] {%>



    rsr.setParameters(new String[] {
    Expand
    titleFLUSHTEXTENTITY

    こちらのwebサービスは、キャッシュされたテキストエンティティを削除します。


    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]キャッシュから削除するテキストエンティティのIDです。(最初のパラメーターのみ読み込まれるため、テキストIDであることを確認します。)

    リクエストの例

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

    Code Block
    languagexml
    themeEclipse
    <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>
                     "70103", "70104"<loginId>admin@yellowfin.com.au</loginId>
         });       <password>test</password>
       rs = rssbs.remoteAdministrationCall(rsr);       if ("SUCCESS".equals(rs.getStatusCode())) {<orgId>1</orgId>
               out.write("Success </br>"); <function>FLUSHTEXTENTITY</function>
         } else {     <parameters>65254</parameters>
       out.write(rs.getStatusCode());     </arg0>
       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です。

     </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
     

    応答の例

    手順

    今回の例に基づき、以下のSOAP XMLの応答が返されます。Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

    Code Block

     

    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    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
    languagexml
    themeEclipse
    インターネットブラウザから、「http://<host>:<port>/ws_removeview.jsp」を実行します。
    Code Block
    themeEclipse
    languagejava
    <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>
              
    "70103",
     
    "70104" });リクエストを構成したら、呼び出しを実行します。
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_removeview.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • <% <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Web Service Request Complete</messages>
                <sessionId>5a29f6eaf3ee084b00c76da124f31fe0</*sessionId>
          ws_removeview.jsp      <statusCode>SUCCESS</statusCode>
            *</return>
    %>   <%@ 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.*" %> </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>


    手順

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

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

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


    • キャッシュを削除するテキストのIDを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
           
    • "12323"
      });


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

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

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


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


    完成例

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

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

    Code Block
    languagejava
    themeEclipse
    <%     AdministrationServiceRequest rsr = new AdministrationServiceRequest();     AdministrationServiceService
    ts =/* new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);     AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
     ws_flushtextentity.jsp      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()
    %>
    <%@ 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");       //  out.write(rs.toString());
        }
    Expand
    titleFLUSHREPORT

    こちらの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詳細手順
    インターネットブラウザから、「http://<host>:<port>/ws_flushreport.jsp」を実行します。
    AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au
    provide your Yellowfin webservices admin account
    rsr.setPassword("test");                        // change to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("FLUSHTEXTENTITY");
    rsr.
    setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("FLUSHREPORT");

    キャッシュからその詳細をするビューのIDを指定します。

     

    rsr.setParameters(new String[] {
    setParameters(new String[] {"65254"});
      
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
      
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
                    out.write("<br>Success");
                     
    "56401"
    
    }
    );リクエストを構成したら、呼び出しを実行します。
    Code Block
    themeEclipse
    languagejava
    管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_flushreport.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • <%
    else {
          /*          ws_flushreport.jspout.write("<br>Failure");
                    out.write(" Code: "  */
    %>
    <%@ 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");+ rs.getErrorCode());
    }              
    %>



    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です。(最初のパラメーターのみ読み込まれるため、フィルターIDであることを確認します。)

    リクエストの例

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

    Code Block
    languagexml
    themeEclipse
    <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>FLUSHCACHEDFILTERCACHE</function>
       //Report IDs whose definitions are to	<parameters>74909</parameters>
    be removed from the cache   	</arg0>
     rsr.setParameters(new String[] { 	</web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

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

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
      	<ns2:remoteAdministrationCallResponse "56401"xmlns:ns2="http://webservices.web.mi.hof.com/">
         	<return>
     });           rs<errorCode>0</errorCode>
    = rssbs.remoteAdministrationCall(rsr);       if ("SUCCESS".equals(rs.getStatusCode())) {	<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            	<messages>Web  out.write("Success </br>");Service Request Complete</messages>
        } else {      <sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
      out.write(rs.getStatusCode());         out.write(rs.toString());
        }
    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です。

    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    手順

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

     
     <statusCode>SUCCESS</statusCode>
         	</return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>


    手順

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

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

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


    • キャッシュから削除するフィルターのIDを指定します。キャッシュからその詳細をするダッシュボードのIDを指定します。


      Code Block
       code
      language
      java
      themeEclipselanguagejava
      rsr.setParameters(new String[] {
           "61251", "6125312323"
      });


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

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

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

     


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

     



    完成例

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

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

    Code Block
    languagejava
    themeEclipselanguagejava
    <%      
    /*          ws_flushtabflushcachedfilter.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("FLUSHTABFLUSHCACHEDFILTERCACHE");
         
        //Dashboard tab IDs whose definitions areSpecify filter ID to beflush removedits from the cache
        rsr.setParameters(new String[] {
                "6125112323",
    "61253"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }



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

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

     こちらのwebサービスは、キャッシュから指定したドキュメントを削除します。


    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

     

    REMOVEDOCUMENT」に設定します。

    ParametersString[]キャッシュから削除するドキュメントのIDです。(最初のパラメーターのみ読み込まれるため、ドキュメントIDであることを確認します。)

    リクエストの例

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

    Code Block
    languagexml
    themeEclipse
    <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>
     <arg0>           <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <function>RELOADLICENCE<<function>REMOVEDOCUMENT</function>
                <parameters>74909</parameters>
            </arg0>
     
        </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>
     


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

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

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


    手順

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

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

      Code Block
      languagejava
      themeEclipselanguagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("RELOADLICENCE"rsr.setFunction("REMOVEDOCUMENT");


    • キャッシュから削除するドキュメントのIDを指定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {
           "12323"
      });


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

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

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

     


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

     



    完成例

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

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

    Code Block
    languagejava
    themeEclipselanguagejava
    <%          
    /*              ws_reloadlicenceremovedocument.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("RELOADLICENCE");
         
        rs = rssbs.remoteAdministrationCall(rsr);
     
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {REMOVEDOCUMENT");
         
         outrsr.write(rs.getStatusCode());
    setParameters(new String[] {
           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です。

      

    応答パラメーター

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

    応答要素データ型説明

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

     

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

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

     

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

     

    完成例

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

  • コードをコピーして、「ws_closeconnectionpool.jsp」として保存します。
  • root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
  • 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
  • インターネットブラウザから、「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 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("CLOSECONNECTIONPOOL");
         
        //Data source IDs whose connection pools are to be closed
        rsr.setParameters(new String[] {
                "12323"
        });
           "70103" });
         
        rs = rssbs.remoteAdministrationCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString());
        }
    %>



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

    こちらのwebサービスは、特定のコンテンツのアクセス権限を更新します。コンテンツはパラメーター要素を介してそのIDを提供することで指定します。これはレポートID、ダッシュボードタブID、またはETLプロセス(データトランスフォーメーションフロー)UUIDになります。


    リクエストパラメーター

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

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]

    アクセス権限をリセットするコンテンツのIDです。(最初のパラメーターのみ読み込まれるので、コンテンツIDであることを確認します。)

    • レポートID
    • ダッシュボードタブID
    • ETLプロセス(データトランスフォーメーションフロー)UUID

    リクエストの例

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

    Code Block
    languagexml
    themeEclipse
    <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>REFRESHACLL</function>
                <parameters>74909</parameters>
            </arg0>
        </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    応答の例

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

    Code Block
    languagexml
    themeEclipse
    <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>
           rs = rssbs.remoteAdministrationCall(rsr);   <messages>Web Service Request Complete</messages>
    if ("SUCCESS".equals(rs.getStatusCode())) {         out.write("Success </br>"); <sessionId>fe029927cc6aae20446f1a8caf25e83a</sessionId>
         } else {     <statusCode>SUCCESS</statusCode>
       out.write(rs.getStatusCode());     </return>
       out.write(rs.toString());
     </ns2:remoteAdministrationCallResponse>
       }
    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の例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

     
    </S:Body>
    </S:Envelope>


    手順

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

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

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


    • アクセス権限をリセットするコンテンツのIDを指定します。キャッシュを更新するフィルターのIDを指定します。


      Code Block
       code
      language
      java
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {
           "12323"
      });


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

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

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

     


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

     



    完成例

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

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

    Code Block
    languagejava
    themeEclipselanguagejava
    <%          
    /*              ws_flushcachedfilterrefreshacll.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("FLUSHCACHEDFILTERCACHEREFRESHACLL");
         
        //Specify filter
    ID to flush its cache
        rsr.setParameters(new String[] {
                "1232370103"
        });
         
        rs = rssbs.remoteAdministrationCall(rsr);
      
        if ("SUCCESS".equals(rs.getStatusCode())) {
            out.write("Success </br>");
        } else {
            out.write(rs.getStatusCode());
            out.write(rs.toString()"Success </br>");
        }
    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詳細手順
    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サービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

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



    DELETESOURCE管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    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
    languagexml
    themeEclipse
    <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>
            */ %> <%@ 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.*" %> <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
              AdministrationServiceResponse rs =<orgId>1</orgId>
    null;     AdministrationServiceRequest rsr = new AdministrationServiceRequest();   <function>REMOVECONTENTMANAGEMENT</function>
     AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);   <parameters>73118</parameters>
     AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();   </arg0>
       rsr.setLoginId("admin@yellowfin.com.au"); </web:remoteAdministrationCall>
        rsr.setPassword("test");
        rsr.setOrgId(new Integer(1));
        rsr.setFunction("DELETEVIEW");</soapenv:Body>
    </soapenv:Envelope>


    応答パラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE


    応答の例

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

    Code Block
    languagexml
    themeEclipse
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
        <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
            <return>
     //Specify the view to be deleted by providing its ID or UUID<errorCode>0</errorCode>
        rsr.setParameters(new String[] {      <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
       "70103"     });    <messages>Web Service 
        rs = rssbs.remoteAdministrationCall(rsr);
     Request Complete</messages>
        if ("SUCCESS".equals(rs.getStatusCode())) {      <sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
      out.write("Success </br>");     } else {  <statusCode>SUCCESS</statusCode>
          out.write(rs.getStatusCode());  </return>
          out.write(rs.toString());</ns2:remoteAdministrationCallResponse>
        }</S:Body>
    </S:Envelope>



    手順

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

    Expand
    title
    詳細手順
    こちらのwebサービスは、指定したデータソースを削除する場合に使用します。IDを提供することで、データソースを識別することができます。
    • 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数のリクエストを定義します。

     

    • Code Block
    リクエストパラメーター
    • language
    以下の要素は、こちらのリクエストとともに渡されます。
    • java
    リクエスト要素

      

    応答パラメーター

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

    応答要素データ型説明

    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("DELETESOURCE");
  • ID、またはUUIDを提供することで、削除するデータソースを指定します。

     

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

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

     

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

    LoginId

    String

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

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

    Password

    String

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

    OrgId

    Integer

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

    Function

    String

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

    ParametersString[]削除するデータソースのIDです。
    • Eclipse
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(new Integer(1));
       
      rsr.setFunction("REMOVECONTENTMANAGEMENT");


    • 次に、パラメーター要素内のキャッシュから削除するコンテンツ管理IDを設定します。


      Code Block
      languagejava
      themeEclipse
      rsr.setParameters(new String[] {"73118"});


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

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

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


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


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



    完成例

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

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

    Code Block
    languagejava
    themeEclipselanguagejava
    <%          
    /*              ws_deletesourceremovecontentmanagement.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();
     %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%
      
    AdministrationServiceService tss_adm = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);       // adjust host and port number
    AdministrationServiceSoapBindingStub rssbsadminService = (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("DELETESOURCE");           //Specify the data sourceset to bethe deletedpassword byof providingthe itsaccount ID
       above
    rsr.setOrgId(1);
    rsr.setFunction("REMOVECONTENTMANAGEMENT");
    rsr.setParameters(new String[] {
                "40567"
        "73118"});
      
      
       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());
    }              
    }

     

     

    ...

    %>