- Created by Yellowfin Admin , last modified on Jul 05, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Version History
« Previous Version 5 Next »
Yellowfinには、クライアント組織と呼ばれる機能があり、同一のサーバインスタンス上に、複数のYellowfinの仮想インスタンスを同居させることができます。この方法により、ある組織内で非公開コンテンツを作成し、その組織に所属するユーザーのみアクセス可能に設定することができます。これは、同一サーバにログインをする、他の組織に所属するユーザーからは非表示になります。以下のwebサービスの呼び出しは、こちらの機能を管理するために使用します。
注意:こちらの機能を使用するためには、Yellowfinインスタンスでクライアント組織機能を有効にします。
Yellowfinに新規クライアント組織を作成する場合は、こちらのwebサービスの呼び出しを使用します。新規クライアントの詳細を提供するために、AdministrationClientOrgオブジェクトが要求されます。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「CREATECLIENT」に設定します。 |
Client | AdministrationClientOrg | 作成する新規クライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgオブジェクトに設定することのできる主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | 新規クライアントを識別するために使用する一意のIDです。これは、必須パラメーターです。 |
ClientName | String | 新規クライアント組織の名前です。 |
TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードです。 |
DefaultOrg | Boolean | 作成する組織がプライマリー組織の場合は、こちらの値をtrueに設定します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>CREATECLIENT</function> <client> <clientReferenceId>org2</clientReferenceId> <clientName>ABC Organization</clientName> <defaultOrg>false</defaultOrg> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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>9204e289ced6e9ea7ed52b3cc5765663</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("CREATECLIENT");
新規クライアントの情報を提供します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // Mandatory. Other parameters are optional ac.setClientName("Organization 2"); ac.setTimeZoneCode("AUSTRALIA/SYDNEY"); ac.setDefaultOrg(false); rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_createclient.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織の詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_createclient.jsp」を実行します。
<% /* ws_createclient.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 above account rsr.setOrgId(1); rsr.setFunction("CREATECLIENT"); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // mandatory. Other parameters are optional ac.setClientName("Organization 2"); ac.setTimeZoneCode("AUSTRALIA/SYDNEY"); ac.setDefaultOrg(false); rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
Yellowfin内のすべてのクライアント組織の一覧を取得する場合は、こちらのwebサービスの呼び出しを使用します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「LISTCLIENTS」に設定します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>LISTCLIENTS</function> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Clients | AdministrationClientOrg[] | クライアント組織の一覧を含むオブジェクト配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <clients> <clientId>1</clientId> <clientName>Default</clientName> <defaultOrg>true</defaultOrg> <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode> </clients> <clients> <clientId>13003</clientId> <clientName>ABC Organization</clientName> <clientReferenceId>org2</clientReferenceId> <defaultOrg>false</defaultOrg> <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode> </clients> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>ce5a636b04d89dd4acd591b6056deb1c</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("LISTCLIENTS");
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
Clients AdministrationClientOrg[] クライアントの一覧です。 以下に示すように、クライアントの詳細を取得します。
AdministrationClientOrg[] clients = rs.getClients(); for (AdministrationClientOrg client: clients){ String name = client.getClientName()); Integer id = client.getClientId()); String orgRefId = client.getClientReferenceId()); String timezone = client.getTimeZoneCode()); boolean isDefault = client.isDefaultOrg()); }
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_listclients.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_listclients.jsp」を実行します。
<% /* ws_listclients.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 above account rsr.setOrgId(1); rsr.setFunction("LISTCLIENTS"); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>Clients:"); AdministrationClientOrg[] clients = rs.getClients(); for (AdministrationClientOrg client: clients){ out.write("<br>"); out.write("<br>Client Name: " + client.getClientName()); out.write("<br>Client Id: " + client.getClientId()); out.write("<br>Org Reference Id: " + client.getClientReferenceId()); out.write("<br>TimeZoneCode: " + client.getTimeZoneCode()); out.write("<br>DefaultOrg: " + client.isDefaultOrg()); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
クライアント参照IDに基づき、指定したクライアント組織の詳細を取得する場合は、こちらのwebサービスの呼び出しを使用します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「GETCLIENT」に設定します。 |
Client | AdministrationClientOrg | 詳細を取得するクライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
AdministrationClientOrgの主要なパラメーターを指定します。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | クライアント組織を識別するために使用する一意のIDです。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>GETCLIENT</function> <client> <clientReferenceId>org2</clientReferenceId> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Clients | AdministrationClientOrg | リクエストされたクライアント組織の詳細です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <client> <clientId>13003</clientId> <clientName>ABC Organization</clientName> <clientReferenceId>org2</clientReferenceId> <defaultOrg>false</defaultOrg> <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode> </client> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>43d74cd4d1a49e4119e1c0dd9ca1ba21</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETCLIENT");
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
Clients AdministrationClientOrg リクエストされたクライアント組織の詳細です。 以下に示すように、クライアントの詳細を取得します。
AdministrationClientOrg[] clients = rs.getClients(); for (AdministrationClientOrg client: clients){ String name = client.getClientName()); Integer id = client.getClientId()); String orgRefId = client.getClientReferenceId()); String timezone = client.getTimeZoneCode()); boolean isDefault = client.isDefaultOrg()); }
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getclient.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織ID値の詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getclient.jsp」を実行します。
<% /* ws_getclient.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 above account rsr.setOrgId(1); rsr.setFunction("GETCLIENT"); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org1"); rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>Clients:"); AdministrationClientOrg client = rs.getClient(); out.write("<br>"); out.write("<br>Client Name: " + client.getClientName()); out.write("<br>Client Id: " + client.getClientId()); out.write("<br>Org Reference Id: " + client.getClientReferenceId()); out.write("<br>TimeZoneCode: " + client.getTimeZoneCode()); out.write("<br>DefaultOrg: " + client.isDefaultOrg()); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
Yellowfinからクライアント組織を削除する場合は、こちらのwebサービスの呼び出しを使用します。クライアント参照IDを提供することで、対象のクライアントを指定することができます。しかし、デフォルト(プライマリー)組織は削除することができません。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「DELETECLIENT」に設定します。 |
Client | AdministrationClientOrg | 削除するクライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgに設定しなくてはいけない主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | 削除するクライアント組織を識別するために使用する一意のIDです。対象のクライアントは、システム内に既に存在していなくてはいけません。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>DELETECLIENT</function> <client> <clientReferenceId>org2</clientReferenceId> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービスの呼び出しステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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>2eb12c07838b0721343b66435e86cdd4</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("DELETECLIENT");
削除するクライアントを定義します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // must be an existing client org ref Id rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deleteclient.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deleteclient.jsp」を実行します。
<% /* ws_deleteclient.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 above account rsr.setOrgId(1); rsr.setFunction("DELETECLIENT"); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // must be an existing client org ref ID rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write("Code: " + rs.getErrorCode()); } %>
クライアント組織の詳細を更新する場合は、こちらのwebサービスの呼び出しを使用します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「UPDATECLIENT」に設定します。 |
Client | AdministrationClientOrg | 更新するクライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgに設定することができる主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | 詳細を更新するクライアント組織を識別するために使用する一意のIDです。対象のクライアントは、システム内に既に存在していなくてはいけません。(必須パラメーターです) |
クライアント組織の任意の詳細を変更するために、その他のパラメーターを使用します。例えば、ClientNameを使用して、クライアント組織の名前を変更することができます。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>UPDATECLIENT</function> <client> <clientReferenceId>org2</clientReferenceId> <clientName>Organization 2</clientName> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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>5f0deb399f6ed6afad38a091d836cc5f</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("UPDATECLIENT");
詳細を変更するクライアントを識別します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // Mandatory. Other parameters are optional
更新するクライアントの詳細を指定します。例えば、クライアント名を変更することができます。
ac.setClientName("Organization 2"); rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_updateclient.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_updateclient.jsp」を実行します。
<% /* ws_updateclient.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 above account rsr.setOrgId(1); rsr.setFunction("UPDATECLIENT"); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // mandatory. Other parameters are optional //the client details to be updated ac.setClientName("Organization 2"); ac.setTimeZoneCode("AUSTRALIA/SYDNEY"); ac.setDefaultOrg(false); rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
指定したクライアント組織のすべてのユーザーの一覧を取得する場合は、こちらのwebサービスの呼び出しを使用します。クライアント参照IDを使用して、クライアントを識別します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「LISTUSERATCLIENT」に設定します。 |
Client | AdministrationClientOrg | クライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgに設定しなくてはいけない主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | 所属するユーザーを取得するクライアント組織を識別するために使用する一意のIDです。対象のクライアントは、システム内に既に存在していなくてはいけません。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>LISTUSERSATCLIENT</function> <client> <clientReferenceId>org2</clientReferenceId> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
People | AdministrationPerson[] | クライアントに所属するユーザーの一覧を含むオブジェクト配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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> <people> <emailAddress>admin@yellowfin.com.au</emailAddress> <firstName>System</firstName> <initial/> <ipId>5</ipId> <languageCode>EN</languageCode> <lastName>Administrator</lastName> <roleCode>YFADMIN</roleCode> <salutationCode/> <status>ACTIVE</status> <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode> <userId>admin@yellowfin.com.au</userId> </people> <sessionId>9d7a9ea7f868bfd4cf4f632e9979db0a</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("LISTUSERSATCLIENT");
ユーザーの一覧を取得するクライアントを定義します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org1"); // must be an existing client org ref Id rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
Clients AdministrationClientOrg[] クライアントの一覧です。
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_listclientusers.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_listclientusers.jsp」を実行します。
<% /* ws_listclientusers.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 above account rsr.setOrgId(1); rsr.setFunction("LISTUSERSATCLIENT"); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org1"); // must be an existing client org ref ID rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); AdministrationPerson[] people = rs.getPeople(); out.write("<br>Number of Users: " + people.length + "<br>"); for (AdministrationPerson p: people){ out.write(p.getUserId()); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
指定したクライアント組織に、既存のYellowfinユーザーを追加する場合は、こちらのwebサービスの呼び出しを使用します。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「ADDUSERACCESS」に設定します。 |
Person | AdministrationPerson | クライアント組織へのアクセスを許可するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 |
Client | AdministrationClientOrg | クライアントの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserID | String | クライアント組織へのアクセスを許可する既存ユーザーを識別します。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgに設定しなくてはいけない主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | ユーザーを追加する既存のクライアント組織を識別します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>ADDUSERACCESS</function> <person> <userId>admin@yellowfin.com.au</userId> </person> <client> <clientReferenceId>org2</clientReferenceId> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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>ac657b27615227113530b79e1aa87fa4</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("ADDUSERACCESS");
クライアント組織に追加するユーザーを定義します。
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); //must be an existing user rsr.setPerson(ap);
ユーザーを追加するクライアント組織を指定します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org3"); // must be an existing client org rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_adduseraccess.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、アクセスを許可するユーザー、クライアント組織IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_adduseraccess.jsp」を実行します。
<% /* ws_adduseraccess.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 above account rsr.setOrgId(1); rsr.setFunction("ADDUSERACCESS"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); // must be an existing user rsr.setPerson(ap); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org2"); // must be an existing client org rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
指定したユーザーが所属するすべてのクライアント組織の一覧を取得する場合は、こちらのwebサービスの呼び出しを使用します。AdministrationPersonオブジェクトを使用して、ユーザーを識別することができます。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「GETUSERACCESS」に設定します。 |
Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserID | String | 所属するクライアント組織を取得するユーザーを識別します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>GETUSERACCESS</function> <person> <userId>admin@yellowfin.com.au</userId> </person> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Person | AdministrationPerson[] | ユーザーが所属するすべてのクライアント組織を含むオブジェクト配列です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <clients> <clientId>1</clientId> <clientName>Default</clientName> <defaultOrg>true</defaultOrg> <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode> </clients> <clients> <clientId>13004</clientId> <clientName>Organization 2</clientName> <clientReferenceId>org2</clientReferenceId> <defaultOrg>false</defaultOrg> </clients> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>fa52a1be31b08a3c44cfeb5198f42164</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETUSERACCESS");
所属するクライアントの一覧を取得するユーザーを定義します。
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
Clients AdministrationClientOrg[] ユーザーが所属するクライアントの一覧です。
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getuseraccess.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、クライアント組織IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getuseraccess.jsp」を実行します。
<% /* ws_getuseraccess.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 above account rsr.setOrgId(1); rsr.setFunction("GETUSERACCESS"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); // get user access to admin user's client list rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); AdministrationClientOrg[] orgs = rs.getClients(); out.write("<br>Number of Orgs: " + orgs.length + "<br>"); out.write("<br>Org Name (Org Reference Id):"); for (AdministrationClientOrg ac: orgs){ out.write("<br>" + ac.getClientName() + " (" + ac.getClientReferenceId() + ")"); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
指定したユーザーのクライアント組織へのアクセスを削除する場合は、こちらのwebサービスの呼び出しを使用します。AdministrationPersonとAdministrationClientOrgオブジェクトを使用して、それぞれユーザーとクライアント組織を識別することができます。
削除されたユーザーは、どのクライアント組織に属さないとして、システム内には残ります。システムからユーザーアカウントを削除するためには、DELETEUSERの呼び出しを実行します。または、ADDUSERACCESSの呼び出しを使用して、ユーザーをデフォルト組織に追加することもできます。
リクエストパラメーター
以下の要素は、こちらのリクエストとともに渡されます。
リクエスト要素 | データ型 | 説明 |
LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 |
Password | String | 上記アカウントのパスワードです。 |
OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 |
Function | String | Webサービス関数です。こちらは、「REMOVEUSERACCESS」に設定します。 |
Person | AdministrationPerson | ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 |
Client | AdministrationClientOrg | クライアント組織の詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserID | String | 所属するクライアント組織へのアクセスを削除するユーザーを識別します。これは、ログインID方法に応じて、ユーザーID、または電子メールアドレスになります。 |
以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationClientOrg要素 | データ型 | 説明 |
ClientReferenceID | String | ユーザーを削除する既存のクライアント組織を識別します。 |
リクエストの例
以下は、こちらのリクエストのSOAP XMLの例です。
<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>REMOVEUSERACCESS</function> <person> <userId>binish.sheikh@yellowfin.com.au</userId> </person> <client> <clientReferenceId>org2</clientReferenceId> </client> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>
応答パラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
<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>a30aafab603330389d2bfb5a3e0faae7</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("REMOVEUSERACCESS");
クライアント組織から削除するユーザーを定義します。
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap);
対象のクライアント組織を指定します。
AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org3"); // must be an existing client org rsr.setClient(ac);
リクエストを構成したら、呼び出しを実行します。
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明 StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
- SUCCESS
- FAILURE
完成例
以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_removeuseraccess.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、削除するユーザー、クライアント組織参照IDの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_removeuseraccess.jsp」を実行します。
<% /* ws_removeuseraccess.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 above account rsr.setOrgId(1); rsr.setFunction("REMOVEUSERACCESS"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org3"); // must be an existing client org rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
- No labels