Page History

Versions Compared

Key

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

...

Expand

title	LOADCONFIGURATION

こちらのwebサービスは、現在のYellowfinのシステム構成詳細を取得します。これは、ConfigCode要素を指定することで実行されます。システムは、Yellowfinデータベース内の構成テーブルの該当するconfigDataカラム（列）に保存されている値を取得します。YellowfinはConfigTypeCodeカラム（列）に「SYSTEM」を含む値を確認するため、（カスタムではなく）システムパラメーターのみを読み込むことに留意してください。

例えばこれを使用することで、パスワードなしのログインをユーザーに許可する、simple認証が有効になっているかどうかを検証することができます。

リクエストパラメーター

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

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「LOADCONFIGRATION」に設定します。
Parameter	String[]	文字列の配列です。これは、ConfigCode要素の値を渡すために使用します。
Client	AdministrationClientOrg	システム構成を更新する特定のクライアント組織を指定するために使用するオプションパラメーターです。しかし、こちらが指定されない場合、システム構成設定はデフォルト組織に適用されます。

以下のパラメーターは、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。

以下のパラメーターは、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。

パラメーター	データ型	説明
ClientReferenceId	String	クライアント組織を識別するために使用する固有のIDです。

応答パラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

BinaryData

String

（Yellowfinリポジトリデータベースから）指定したConfiguration.configCode要素のconfigDataの値を含みます。構成テーブル内に指定したConfigCodeが見つからない場合は、Null値が返されます。

手順

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

Expand

title	詳細手順

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

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");  
rsr.setOrgId(1);
rsr.setFunction("LOADCONFIGURATION");

パラメーターオブジェクト内で更新するシステム構成設定を渡します。以下のコード例では、Yellowfinの認証方法を「Simple」に設定しています。
Code Block
theme Eclipse
language java
rsr.setParameters(new String[]{"SIMPLE_AUTHENTICATION"});
リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答を取得するために以下のコードを追加します。（返される応答については、上記応答パラメーターの表を参照してください）

Code Block

theme	Eclipse
language	java

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%          
/*              ws_loadconfiguration.jsp                    */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);       // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");       // provide your Yellowfin webservices admin account
rsr.setPassword("test");                                                        // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LOADCONFIGURATION");
  
rsr.setParameters(new String[]{"SIMPLE_AUTHENTICATION"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
                out.write("<br>Success");
String data = rs.getBinaryData();
                out.write("<br>ConfigData: " + data);
                }
else {
                out.write("<br>Failure");
                out.write(" Code: " + rs.getErrorCode());
}              
%>

Expand

title	LOADCUSTOMPARAMETER

こちらのwebサービスは、Yellowfinのカスタムシステム構成詳細を取得します。これは、ConfigCode要素を指定することで実行されます。システムは、Yellowfinデータベース内の構成テーブルの該当するconfigDataカラム（列）に保存されている値を取得します。YellowfinはConfigTypeCodeカラム（列）に「CUSTOM」を含む値を確認するため、カスタムパラメーターのみが読み込まれます。

リクエストパラメーター

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

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスに接続する管理者アカウントです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「LOADCUSTOMPARAMETER」に設定します。
Parameter	String[]	文字列の配列です。これは、ConfigCode要素の値を渡すために使用します。
Client	AdministrationClientOrg	システム構成を更新する特定のクライアント組織を指定するために使用するオプションパラメーターです。しかし、こちらが指定されない場合、システム構成設定はデフォルト組織に適用されます。

以下のパラメーターは、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。

パラメーター	データ型	説明
ClientReferenceId	String	クライアント組織を識別するために使用する固有のIDです。

応答パラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

BinaryData

String

手順

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

Expand

title	詳細手順

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

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");  
rsr.setOrgId(1);
rsr.setFunction("LOADCUSTOMPARAMETER");

パラメーターオブジェクト内で更新するシステム構成設定を渡します。以下のコード例では、Yellowfinの認証方法を「Simple」に設定しています。
Code Block
theme Eclipse
language java
rsr.setParameters(new String[]{"SIMPLE_AUTHENTICATION"});
リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答を取得するために以下のコードを追加します。（返される応答については、上記応答パラメーターの表を参照してください）

Code Block

theme	Eclipse
language	java

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

完成例

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

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

Code Block

theme	Eclipse
language	java

/*              ws_loadcustomparameter.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("LOADCUSTOMPARAMETER");
  
rsr.setParameters(new String[]{"SIMPLE_AUTHENTICATION"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
                out.write("<br>Success");
String data = rs.getBinaryData();
                out.write("<br>ConfigData: " + data);
                }
else {
                out.write("<br>Failure");
                out.write(" Code: " + rs.getErrorCode());
}              
%>

...

Content

Space Tools

Versions Compared

Old Version 2

New Version 3

Key

リクエストパラメーター

応答パラメーター

手順

完成例

リクエストパラメーター

応答パラメーター

手順

完成例