Page History
Anchor | ||||
---|---|---|---|---|
|
以下は、Yellowfinのシステム構成に使用することのできるwebサービスです。これらのwebサービスでは、Yellowfinのシステム構成設定を管理し、管理者モードに入ることができます。
基礎的な構成関数
以下のwebサービスは、Yellowfinのシステムやカスタム設定を更新するために使用します。以下のwebサービスは、Yellowfinのシステムや、カスタムシステム構成設定を更新するために使用します。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、Yellowfinのシステム構成設定を更新します。これは、Yellowfinデータベース内の構成テーブルの設定詳細を直接変更することで機能しますが、カスタム設定ではなく、一般的なシステム設定のみが影響を受けます。Yellowfinは、ConfigTypeCodeカラム(列)の値が「SYSTEM」であることを確認してこれらを判別します。そのため、これは基本的にデフォルト組織に影響します。 データベーステーブルが更新されたら、これらの変更を反映するためにYellowfinを再起動しなくてはいけません。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下は、新規ユーザーを作成するために、AdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfinのカスタムシステム構成詳細を取得します。これは、ConfigCode要素を指定することで実行されます。システムは、Yellowfinデータベース内の構成テーブルの該当するconfigDataカラム(列)に保存されている値を取得します。YellowfinはConfigTypeCodeカラム(列)に「CUSTOM」を含む値を確認するため、カスタムパラメーターのみが読み込まれます。 例えばこれを使用することで、パスワードなしのログインをユーザーに許可する、simple認証が有効になっているかどうかを検証することができます。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下のパラメーターは、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
管理者モード関数
以下のwebサービスでは、ユーザーの「管理者」モードへの以下のwebサービスを使用することで、「管理者」モードの有効/無効を設定することができます。管理者モードは、特定のユーザーロール権限のセットに設定することが可能で、これはモードが有効な場合に、すべてのユーザーに適用されます。
こちらの項目では、このモードが有効、または無効の場合の挙動について、より詳細に紹介にします。
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfinインスタンスの管理者モードを有効にします。こちらのサービスを使用することで、すべてのユーザーロールに適用されるユーザー権限のセットを渡すことができます。これにより、現在アクティブなユーザーおよび、こちらの関数を呼び出した後にログインするユーザーも含めて、すべてのユーザーの権限を、この関数内で定義されたひとつに変更することができます。 これは、閲覧権限のみの基礎的な「report consumer」ロールを付与されたユーザーがいる場合に、こちらの関数を使用して、有効なセッション権限を変更し、レポートの削除を含み、完全なレポートアクセスを許可することができます。同様に、こちらのサービスを使用することで、すべてのアクティブユーザーのロールからレポート編集機能を削除し、Yellowfinを編集不可にすることもできます。 こちらのwebサービスは、Yellowfinインスタンスの管理者モードを有効にします。こちらのサービスを使用することで、すべてのユーザーロールに適用されるユーザー権限のセットを渡すことができます。これにより、現在アクティブなユーザー、こちらの関数を呼び出した後にログインをしたユーザーを含めて、すべてのユーザーの権限を関数内で定義されたひとつに変更することができます。 これは、閲覧権限のみの基礎的な「report consumer」ロールを付与されたユーザーがいる場合、こちらの関数を使用して、有効なセッション権限を変更し、レポートの削除を含む完全なレポートアクセスを許可することができます。同様に、こちらのサービスを使用することで、すべてのアクティブユーザーのロールからレポート編集機能を削除し、Yellowfinを編集不可にすることもできます。 これらのロール関数を設定するには、関数コードとアクセスレベルを指定しなくてはいけません。一覧に無い関数はすべて、既存のロールのアクセスレベルを使用します。アクセスレベルの未指定は、関数の無効化と同義です。クラスタ設定の場合、この関数は、パラメーターリクエスト要素を使用して管理者モードを有効にするために、クラスタ内の特定のノードに通知するよう設定することができます。 クラスタ設定の場合、この関数は、パラメーターリクエスト要素を使用して、クラスタ内の特定のノードに通知し、管理者モードを有効にするよう設定することができます。 このモードに入ると、すべての新しいセッションはモード内の権限セットを適用します。すべてのアクティブと、これからログインするユーザーの権限を元に戻すには、DISABLEADMINMODEを渡し、このモードを無効にします。このモードを有効にすると、すべての新しいセッションはモード内の権限セットを適用します。すべての有効なセッションと、これからログインするユーザーの権限を元に戻すには、DISABLEADMINMODEを渡し、このモードを無効にします。 このモードは、一度有効化した後に設定内容を更新することができないため、既に管理者モードが有効で、新しいアクセスレベルのセットを設定したい場合は、まずモードを無効化し、更新されたアクセスレベルとともに再びこれを有効化しなくてはいけません。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 Expand | | ||||||||||||||||||||||||||||||||
|
Code Block | |||||
---|---|---|---|---|---|
| java
| ||||
<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>
<orgRef>org1</orgRef>
<function>ENABLEADMINMODE</function>
<parameters>true</parameters>
<roleFunctionList>
<key>MIREPORT</key>
<value>CRUD</value>
</roleFunctionList>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは今回のSOAPの例に基づき、以下の応答を返します。
Code Block | ||||
---|---|---|---|---|
| ||||
<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>517ce15c32a079dc1528424c03d86691</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_enableadminmode.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_enableadminmode.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<%@ 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.*" %>
<%
/*
Enable Admin Mode
Enables administrative mode with the list of functions in roleFunctionList.
A parameter is set to indicate this should notify the cluster.
*/
AdministrationServiceResponse rs = null;
AdministrationServiceRequest asr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080,
"/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts
.getAdministrationService();
asr.setLoginId("admin@yellowfin.com.au");
asr.setPassword("test");
asr.setOrgId(new Integer(1));
asr.setFunction("ENABLEADMINMODE");
asr.setParameters(new String[] { "true" });
Map<String, String> roleFunctionList = new HashMap<>();
roleFunctionList.put("SYSTEMINFO", "");
roleFunctionList.put("REPORTDASHBOARD", "R");
roleFunctionList.put("DASHPUBLIC", "R");
roleFunctionList.put("MIREPORT", "R");
roleFunctionList.put("STORYBOARD", "R");
asr.setRoleFunctionList(roleFunctionList);
rs = rssbs.remoteAdministrationCall(asr);
if ("SUCCESS".equals(rs.getStatusCode())) {
for (String message : rs.getMessages()) {
out.write(message + "<BR>");
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfinインスタンスの管理者モードを無効にします。これにより、アクティブユーザーと、これからログインするユーザーのユーザー権限が、元のロール権限に戻ります。クラスタ環境の場合、すべてのノードに通知をして管理者モードを無効にするためには、パラメーターリクエスト要素を使用して、「true」、または「TRUE」いずれかの文字列を渡さなくてはいけません。要素内で値が指定されない場合は、デフォルトで「false/FALSE」が設定されるので、管理者モードを無効にすることはできません。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、Yellowfinで利用可能なすべてのロール関数と、その説明情報を取得します。結果は、データベースクエリーから返された、ロウ(行)を表す文字列の二次元配列になります。カラム(列)は、以下の通りです。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを示しています。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
以下のパラメーターが、ReportRowオブジェクトに返されます。
応答の例サービスは今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
...
horizontalrule |
---|
Styleclass | ||
---|---|---|
| ||
...