...
ユーザーグループとロールは、こちらの項目で紹介するwebサービスの呼び出しを使用して、作成、または変更をすることができます。
注意:「システム構成1システム構成」ページで「クライアント組織1クライアント組織」機能を有効にすることで、特定タイプの呼び出しでは適用可能な場合に、クライアント組織を指定することができます。
...
Expand |
---|
title | EXCLUDEUSERFROMGROUP |
---|
|
こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。ユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 Image Removed Image Added
こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「EXCLUDEUSERFROMGROUP」に設定します。 | Person | AdministrationPerson | グループから除外されるユーザーの詳細を含むオブジェクトです。以下の表を参照してください。 | Group | AdministrationGroup | ユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。 | OrgRef | String | 指定したクライアント組織内のグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。 |
以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。AdministrationPerson要素 | データ型 | 説明 | UserId | String | グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります |
以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。AdministrationGroup要素 | データ型 | 説明 | GroupName | String | ユーザーを除外するグループの名前です。 |
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。 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>EXCLUDEUSERFROMGROUP</function>
<person>
<userId>binish.sheikh@yellowfin.com.au</userId>
</person>
<group>
<groupName>Administrators</groupName>
</group>
</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>c15a0993df4f37f4dbff9b3244f41ea2</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 Expand |
---|
| こちらの関数の基礎的なリクエストから開始します。
Code Block |
---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("EXCLUDEUSERFROMGROUP"); |
指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト(プライマリー)組織内のグループが検索されます。
Code Block |
---|
| rsr.setOrgRef("org1"); |
ユーザーを識別するパラメーターを設定します。
Code Block |
---|
| AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin user
rsr.setPerson(ap); |
グループのパラメーターを設定します。
Code Block |
---|
| AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators"); //must be an existing user group
rsr.setGroup(group); |
リクエストの構成が完了したら、呼び出しを実行します。
Code Block |
---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_excludeuserfromgroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、除外するユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_excludeuserfromgroup.jsp」を実行します。
Code Block |
---|
| <%
/* ws_ excludeuserfromgroup.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 the password of the above account
rsr.setOrgId(1);
rsr.setFunction("EXCLUDEUSERFROMGROUP");
//Specify the client org (if omitted, the default (primary) org groups will be searched):
rsr.setOrgRef("org1");
//Specify a user to exclude:
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin use
rsr.setPerson(ap);
//Specify which group to exclude from:
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators"); // must be an existing user group
rsr.setGroup(group);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
...
Expand |
---|
title | EXCLUDEUSERSFROMGROUP |
---|
|
こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。これらのユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 Image Removed Image Added
こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクトの配列、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「EXCLUDEUSERSFROMGROUP」に設定します。 | Person | AdministrationPerson[] | グループから除外されるユーザーの詳細を含むオブジェクト配列です。以下の表を参照してください。 | Group | AdministrationGroup | ユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。 | OrgRef | String | 指定したクライアント組織内のグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。 |
以下は、こちらの関数のAdministrationPersonオブジェクト配列に設定しなくてはいけない主要なパラメーターです。AdministrationPerson要素 | データ型 | 説明 | UserId | String | グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります |
以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。AdministrationGroup要素 | データ型 | 説明 | GroupName | String | ユーザーを除外するグループの名前です。 |
応答のパラメーター返される応答には、これらのパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 Expand |
---|
| こちらの関数の基礎的なリクエストから開始します。
Code Block |
---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("EXCLUDEUSERSFROMGROUP"); |
指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト(プライマリー)組織内のグループが検索されます。
Code Block |
---|
| rsr.setOrgRef("org1"); |
ユーザーを識別するパラメーターを設定します。
Code Block |
---|
| AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin user
rsr.setPerson(ap); |
グループのパラメーターを設定します。
Code Block |
---|
| AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators"); //must be an existing user group
rsr.setGroup(group); |
リクエストの構成が完了したら、呼び出しを実行します。
Code Block |
---|
| AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); |
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
|
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_excludeusersfromgroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、除外するユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_excludeusersfromgroup.jsp」を実行します。
Code Block |
---|
| <%
/* ws_ excludeusersfromgroup.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 the password of the above account
rsr.setOrgId(1);
rsr.setFunction("EXCLUDEUSERFROMGROUP");
//Specify the client org (if omitted, the default (primary) org groups will be searched):
rsr.setOrgRef("org1");
//Specify users to exclude:
AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin user
rsr.setPerson(ap);
//Specify which group to exclude from:
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators"); // must be an existing user group
rsr.setGroup(group);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|
...