Page History
Anchor | ||||
---|---|---|---|---|
|
以下は、Yellowfinの構成に使用することのできるwebサービスです。以下は、Yellowfinのシステム構成に使用することのできるwebサービスです。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、Yellowfinのシステム構成設定を更新します。これは、Yellowfinのデータベース内の構成テーブルの設定詳細を直接変更することで機能しますが、一般的なシステム設定のみ適用することが可能で、カスタム設定には適用できません。Yellowfinは、ConfigTypeCodeカラム(列)の値が「SYSTEM」であることを確認することで、これを判断します。そのため、これは基本的にデフォルト組織に適用されます。こちらの関数は、Yellowfinのシステム構成設定を更新します。これは、Yellowfinデータベース内の構成テーブルの設定詳細を直接変更することで機能しますが、カスタム設定ではなく、一般的なシステム設定のみが影響を受けます。Yellowfinは、ConfigTypeCodeカラム(列)の値が「SYSTEM」であることを確認してこれらを判別します。そのため、これは基本的にデフォルト組織に影響します。 データベーステーブルが更新されたら、これらの変更を反映するためにYellowfinを再起動しなくてはいけません。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下は、新規ユーザーを作成するために、AdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。 以下は、新規ユーザーを作成するために、AdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、Yellowfinのカスタムシステム構成設定を更新します。カスタムパラメーターは、クライアント組織に適用することができます。これは、Yellowfinデータベース内の構成テーブルの詳細を直接変更することで機能します。Yellowfinは、ConfigTypeCodeカラム(列)の値が「CUSTOM」であることを確認して変更する設定を判別します。 データベーステーブルが更新されたら、変更内容を反映するためにYellowfinを再起動しなくてはいけません。 こちらの関数は、Yellowfin内のカスタム構成設定を更新します。カスタムパラメーターは、クライアント組織に適用することができます。これは、Yellowfinのデータベース内の構成テーブルの詳細を直接変更することで機能します。Yellowfinは、ConfigTypeCodeカラム(列)の値が「CUSTOM」のものを確認することで、変更をする設定を判断します。 データベーステーブルを更新したら、変更内容を反映するためにYellowfinを再起動しなくてはいけません。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下は、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。 以下は、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらのwebサービスは、現在のYellowfinのシステム構成詳細を取得します。これは、ConfigCode要素を指定することで実行されます。システムは、Yellowfinデータベース内の構成テーブルの該当するconfigDataカラム(列)に保存されている値を取得します。YellowfinはConfigTypeCodeカラム(列)に「SYSTEM」を含む値を確認するため、(カスタムではなく)システムパラメーターのみを読み込むことに留意してください。 例えばこれを使用することで、パスワードなしのログインをユーザーに許可する、simple認証が有効になっているかどうかを検証することができます。 こちらのwebサービスは、現在のYellowfinのシステム構成詳細を取得します。これは、ConfigCode要素を指定することで実行されます。システムは、Yellowfinのデータベース内の構成テーブルの要素の該当するconfigDataカラム(列)に保存されている値を取得します。YellowfinはConfigTypeCodeカラム(列)内の「SYSTEM」を含む値を確認するため、(カスタムではなく)システムパラメーターを読み込むことに留意してください。 例えば、これを使用することで、simple認証が有効になっているかどうかを確認し、パスワードなしにユーザーログインをすることができます。
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下のパラメーターは、新規ユーザーを作成するためにAdministrationClientOrgオブジェクトに設定しなくてはいけない必須パラメーターです。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下のパラメーターは、AdministrationDataSourceClientLinkに提供されます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
パラメーター | 型 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientOrgId | Integer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientOrgRef | String | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceId | Integer | 必須フィールド |
Code Block | ||
---|---|---|
| ||
<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>LINKDATASOURCE</function>
<sourceId>74374</sourceId>
<sourceClientLink>
<sourceId>74376</sourceId>
</sourceClientLink>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
LoadedDataSources | AdministrationDataSource | リンクされたデータソースの詳細を含むオブジェクト配列です。 |
応答の例
サービスは、今回の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>
<loadedDataSource>
<accessLevelCode>UNSECURE</accessLevelCode>
<clientSources>
<clientOrgId>13004</clientOrgId>
<clientOrgRef>org1</clientOrgRef>
<sourceId>74376</sourceId>
</clientSources>
<connectionDriver>com.mysql.jdbc.Driver</connectionDriver>
<connectionPath/>
<connectionString>jdbc:mysql://localhost:3306/default</connectionString>
<connectionTimeout>180</connectionTimeout>
<connectionType>JDBC</connectionType>
<connectionTypeCode>GENERICUSER</connectionTypeCode>
<inheritChildSourceFilters>false</inheritChildSourceFilters>
<maxRows>10000</maxRows>
<maxmimumConnections>5</maxmimumConnections>
<minimumConnections>1</minimumConnections>
<refreshTime>3</refreshTime>
<sourceDescription/>
<sourceId>74374</sourceId>
<sourceName>Default</sourceName>
<sourceOptions>
<optionKey>ISOLATIONLEVEL</optionKey>
<optionValue>1</optionValue>
<valueDataType>1</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>USESCHEMA</optionKey>
<optionValue>true</optionValue>
<valueDataType>6</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>HOSTNAME</optionKey>
<optionValue>localhost</optionValue>
<valueDataType>2</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>PORT</optionKey>
<optionValue>3306</optionValue>
<valueDataType>1</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>DATABASE</optionKey>
<optionValue>default</optionValue>
<valueDataType>2</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>USEFETCHSIZE</optionKey>
<optionValue>false</optionValue>
<valueDataType>6</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>FETCHSIZE</optionKey>
<optionValue/>
<valueDataType>2</valueDataType>
</sourceOptions>
<sourceOptions>
<optionKey>YF_DRIVER_SELECTION</optionKey>
<optionValue>com.mysql.jdbc.Driver</optionValue>
<valueDataType>2</valueDataType>
</sourceOptions>
<sourceType>MYSQL</sourceType>
<timezone>AUSTRALIA/SYDNEY</timezone>
<userName>root</userName>
<userPassword>kOjvh+lsaec=</userPassword>
</loadedDataSource>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>a8ea7db63b9b96bdcda9e0f9bba067d1</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
title | 詳細手順 |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("LINKDATASOURCE"); |
デフォルト組織のデータソースのIDを提供します。
Code Block | ||||
---|---|---|---|---|
| ||||
rsr.setSourceId(74374); |
リンクするクライアント組織のソースIDを提供します。
Code Block | ||||
---|---|---|---|---|
| ||||
AdministrationDataSourceClientLink link = new AdministrationDataSourceClientLink();
link.setSourceId(74376);
rsr.setSourceClientLink(link); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。
応答を取得します。(より詳細な情報は、上記応答パラメーターの表を参照してください)
Code Block theme Eclipse language java if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { out.write("<br>Failure"); out.write(" Code: " + rs.getErrorCode()); }
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
Code Block | ||||
---|---|---|---|---|
| ||||
/* ws_linkdatasource.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"); // change to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LINKDATASOURCE");
rsr.setSourceId(74374);
AdministrationDataSourceClientLink link = new AdministrationDataSourceClientLink();
link.setSourceId(74376);
rsr.setSourceClientLink(link);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
...