Anchor | ||||
---|---|---|---|---|
|
ユーザーグループとロールは、こちらの項目で紹介するwebサービスの呼び出しを使用して、作成、または変更をすることができます。
注意:「システム構成」ページで「クライアント組織」機能を有効にすることで、特定タイプの呼び出しでは適用可能な場合に、クライアント組織を指定することができます。
ユーザーロール関数
これらの webサービスは、Yellowfinのユーザーロールに特化しています。
Note |
---|
LDAP認証を使用する場合、ロールを返すすべてのwebサービスは、LDAPユーザーが最後に正常にログインした時のロールを返します(これは、LDAPユーザーがログインをする度に更新されます)。 |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、Yellowfinで利用可能なすべてのユーザーロールを返します。応答は、利用可能なロールを表示する、AdministrationRoleオブジェクトの配列を含みます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、LISTROLES関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロールの詳細を指定するAdministrationRoleオブジェクトと、ロールのAdministrationFunctionの配列を含まなくてはいけません。こちらの関数を、ロールの更新、または新規ロール作成のいずれに使用するかに関わらず、すべてのYellowfinロールは、必須関数であるレポートアクセス(コード:MIREPORT)を要求することに注意してください。MIREPORTには、アクセスレベルコードとして、最低でもR(読み取り)を設定しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ機能は上書きされます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
Anchor | | 以下の表 | 以下の表 |
追加、または更新されるロールの詳細を含むオブジェクトです。詳細は、以下の表を参照してください。 |
以下は、こちらの関数のAdministrationRoleオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationRole 要素 | データ型 | 説明 |
RoleCode | String | 既存のロールの内部コードを指定します。既存のロールを更新したい場合は、既存のロールの内部コードです。既存のロールを更新したい場合は、こちらのパラメーターを必ず含めなくてはいけません。こちらを指定しない場合は、既に同名のロールが存在していても、新規ロールとして作成されます。必ず含めなくてはいけません。これがデータベース内の既存のロールコードと一致しない場合、既に同名のロールが存在していても、新規ロールとして作成されます。 |
RoleName | String新規、または既存のロールの名前です。こちらは、既存のロールの変更時にも必須です。こちらを設定しない場合、呼び出しはロール名を空白にします。 | (必須)新規、または既存のロールの名前です。RoleCodeに一致する既存のロールを更新する場合、ロールの名前はこちらに設定されます。RoleCodeに一致するものがない場合、コードを生成するためにRoleNameを使用して新しいロールが作成されます。例えば、「Test Role」というRoleNameは、「TESTROLE」というRoleCodeを作成します。既存のロールが既に「TESTROLE」というRoleCodeを持つ場合、新しいRoleCodeは「TESTROLE1」になります。 |
RoleDescription | String | ロールの説明です。 |
Functions | セキュリティ機能の一覧を含むオブジェクトです。これらは、SAVEROLE関数を呼び出す度に上書きされます。レポートアクセス関数は必須です。より詳細な情報は、以下の表を参照してください。 |
セキュリティ機能の一覧を含むオブジェクトです。これらは、SAVEROLE関数を呼び出す度に上書きされます。レポートアクセス関数は必須です。より詳細な情報は、以下の表を参照してください。 |
以下は、こちらのwebサービスのAdministrationFunctionオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationFunction要素 | データ型 | 説明 |
FunctionCode | String | セキュリティ機能のコードを指定します。例えば、レポートアクセス関数を含める場合は、MIREPORTと設定します。 |
AccessLevelCode | String | 関数のアクセスレベルです。例えば、Rは読み取りを意味します。 |
以下の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>SAVEROLE</function> <role> <roleCode>REPORTWRITER</roleCode> <roleName>Report Content Writer</roleName> <roleDescription>This role can generate reports.</roleDescription> <functions> <functionCode>MIREPORT</functionCode> <accessLevelCode>R</accessLevelCode> </functions> </role> </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> <roles> <functions> <accessLevelCode>R</accessLevelCode> <functionCode>MIREPORT</functionCode> </functions> <roleCode>REPORTCONTENTWRITER</roleCode> <roleDescription>This role can generate reports.</roleDescription> <roleName>Report Content Writer</roleName> </roles> <sessionId>ceaa85d0ca1eb6057dc4facb0a7a5aa9</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、SAVEROLE関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_saverole.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_saverole.jsp」を実行します。
Code Block |
---|
| |||||
| |||||
<% /* ws_saverole.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("SAVEROLE"); //define a role: AdministrationRole role = new AdministrationRole(); role.setRoleCode("NEWROLE"); role.setRoleName("New Role"); role.setRoleDescription("testing"); AdministrationFunction[] f = new AdministrationFunction[2]; f[0] = new AdministrationFunction(); f[0].setFunctionCode("MIREPORT"); // mandatory f[0].setAccessLevelCode("R"); f[1] = new AdministrationFunction(); f[1].setFunctionCode("ACTIVITYSTREAM"); f[1].setAccessLevelCode("CRUD"); //Feed the security functions to the role: role.setFunctions(f); rsr.setRole(role); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したユーザーロールを削除します。AdministrationRoleオブジェクトのロールコードを提供することで、対象のロールを識別することができます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
Anchor | | 以下の表3 | 以下の表3
削除するロールの詳細を含むオブジェクトです。以下の表を参照してください。 |
以下は、AdministrationRoleオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationRole 要素 | データ型 | 説明 |
RoleCode | 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>DELETEROLE</function> <role> <roleCode>REPORTWRITER</roleCode> </role> </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> <roles> <roleCode>REPORTWRITER</roleCode> </roles> <sessionId>6c494a263bb684c1082317d0e1d695eb</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
完成例
以下は、DELETEROLE関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deleterole.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、ロールコード値を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_deleterole.jsp」を実行します。
Code Block language java theme Eclipse language java <% /* ws_deleterole.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 the password of the above account above rsr.setOrgId(1); rsr.setFunction("DELETEROLE"); AdministrationRole role = new AdministrationRole(); role.setRoleCode("NEWROLE"); rsr.setRole(role); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
...
ユーザーグループ関数
ユーザーグループに関連するwebサービスは、以下のように定義されます。
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。指定したクライアントに所属するグループの一覧を取得する場合は、呼び出し内でクライアント組織参照IDを渡します。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、LISTGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
指定したユーザーグループを、そのメンバーとともに取得する場合は、こちらの関数を使用します。リクエストには、必ずグループ名を提供しなくてはいけません。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
| 以下の表4 | 以下の表4 | 以下は、こちらの関数の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>GETGROUP</function> <group> <groupName>Administrators</groupName> </group> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> |
応答の要素
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Group | メンバーの一覧を含むグループの詳細です。 |
サービスは、今回の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> <group> <groupDescription>This group contains all users with the Admin role.</groupDescription> <groupId>11950</groupId> <groupMembers> <internalId>5</internalId> <loginId>admin@yellowfin.com.au</loginId> </groupMembers> <groupMembers> <internalId>13000</internalId> <loginId>binish.sheikh@yellowfin.com.au</loginId> </groupMembers> <groupName>Administrators</groupName> <groupStatus>OPEN</groupStatus> </group> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>54c5cf263f323b439c5834d1f6d8b645</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、GETGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getgroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getgroup.jsp」を実行します。
Code Block |
---|
| |||||
| |||||
<% /* ws_getgroup.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("GETGROUP"); //rsr.setOrgRef("org1"); // provide org reference ID if required. Default org will be searched otherwise AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Administrators"); rsr.setGroup(group); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>"); group = rs.getGroup(); out.write("<br>"); out.write("<br>Group Name: " + group.getGroupName()); out.write("<br>Group Id: " + group.getGroupId()); out.write("<br>Group Description: " + group.getGroupDescription()); out.write("<br>Group Status: " + group.getGroupStatus()); out.write("<br>Group Internal Reference: " + group.getGroupInternalReference()); // display the members: out.write("<br>Members:<br>Login Id | Internal Id "); for (AdministrationGroupMember member: group.getGroupMembers()){ out.write("<br>" + member.getLoginId() + " | " + member.getInternalId() ); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したクライアント組織(参照IDが提供される場合)、またはデフォルト(プライマリー)組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。(追加するメンバーは、既存のYellowfinユーザーでなくてはいけません)ユーザーが所属するすべてのユーザーグループを取得するには、こちらの関数を使用します。これは、AdministrationPersonをパラメーターとして受け付け、ユーザーを特定します。応答には、AdministrationGroupオブジェクトの配列が含まれます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。AdministrationPersonオブジェクトに、以下のいずれかのパラメーターを設定します。
Anchor | | 以下の表6 | 以下の表6
String | 取得されるグループに所属するユーザーのIp IDです。 |
両方が設定された場合、IpIdがデフォルトで使用されます。
リクエストの例
以下の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>GETUSERGROUPS</function>
<person>
<!-- Set one of userId and ipId. If both are set, ipId will be used by default. -->
<userId>admin@yellowfin.com.au</userId>
<ipId>5</ipId>
</person>
<!-- orgRef is optional -->
<orgRef>org1</orgRef>
<parameters>
<!-- TRUE or FALSE. Case insensitive. -->
<string>true</string>
</parameters>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答要素
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Groups | AdministrationGroup[] | グループの一覧です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:remoteAdministrationCallResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://webservices.web.mi.hof.com/">
<remoteAdministrationCallReturn href="#id0"/>
</ns1:remoteAdministrationCallResponse>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AdministrationServiceResponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://service.web.mi.hof.com">
<binaryAttachments xsi:type="ns2:ArrayOfReportBinaryObject" xsi:nil="true"/>
<binaryData xsi:type="xsd:string" xsi:nil="true"/>
<client xsi:type="ns2:AdministrationClientOrg" xsi:nil="true"/>
<clients xsi:type="ns2:ArrayOfAdministrationClientOrg" xsi:nil="true"/>
<contentResources xsi:type="ns2:ArrayOfContentResource" xsi:nil="true"/>
<contentType xsi:type="xsd:string" xsi:nil="true"/>
<datasources xsi:type="ns2:ArrayOfAdministrationDataSource" xsi:nil="true"/>
<entityId xsi:type="xsd:int" xsi:nil="true"/>
<errorCode xsi:type="xsd:int">0</errorCode>
<fileName xsi:type="xsd:string" xsi:nil="true"/>
<group xsi:type="ns2:AdministrationGroup" xsi:nil="true"/>
<groups soapenc:arrayType="ns2:AdministrationGroup[1]" xsi:type="soapenc:Array">
<groups href="#id1"/></groups>
<importIssues xsi:type="ns2:ArrayOfImportIssue" xsi:nil="true"/>
<loadedDataSource xsi:type="ns2:AdministrationDataSource" xsi:nil="true"/>
<loginSessionId xsi:type="xsd:string" xsi:nil="true"/>
<messages soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array">
<messages xsi:type="soapenc:string">Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages xsi:type="soapenc:string">Web Service Request Complete</messages>
</messages>
<parentDashboard xsi:type="ns2:ParentDashboard" xsi:nil="true"/>
<parentDashboards xsi:type="ns2:ArrayOfParentDashboard" xsi:nil="true"/>
<parentReportGroups xsi:type="soapenc:Array" xsi:nil="true"/>
<people xsi:type="ns2:ArrayOfAdministrationPerson" xsi:nil="true"/>
<person xsi:type="ns2:AdministrationPerson" xsi:nil="true"/>
<personfavourites xsi:type="ns2:ArrayOfPersonFavourite" xsi:nil="true"/>
<queryResults xsi:type="ns2:ArrayOfReportRow" xsi:nil="true"/>
<report xsi:type="ns2:AdministrationReport" xsi:nil="true"/>
<reportGroups xsi:type="ns2:ArrayOfAdministrationReportGroup" xsi:nil="true"/>
<reportId xsi:type="xsd:int" xsi:nil="true"/>
<reports xsi:type="ns2:ArrayOfAdministrationReport" xsi:nil="true"/>
<roles xsi:type="ns2:ArrayOfAdministrationRole" xsi:nil="true"/>
<schedule xsi:nil="true"/>
<schedules xsi:type="ns3:ArrayOfAdministrationSchedule" xsi:nil="true" xmlns:ns3="http://schedule.service.web.mi.hof.com"/>
<sessionId xsi:type="xsd:string">974c65a870699f6f4059ba54c15ddc6c</sessionId>
<statusCode xsi:type="xsd:string">SUCCESS</statusCode>
</multiRef>
<multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:AdministrationGroup" xmlns:ns4="http://service.web.mi.hof.com" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<groupDescription xsi:type="xsd:string">This group contains all users with the Admin role.</groupDescription>
<groupId xsi:type="xsd:int">11950</groupId>
<groupInternalReference xsi:type="xsd:string" xsi:nil="true"/>
<groupMembers soapenc:arrayType="ns4:AdministrationGroupMember[1]" xsi:type="soapenc:Array">
<groupMembers href="#id2"/></groupMembers>
<groupName xsi:type="xsd:string">Administrators</groupName>
<groupStatus xsi:type="xsd:string" xsi:nil="true"/>
</multiRef>
<multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:AdministrationGroupMember" xmlns:ns5="http://service.web.mi.hof.com" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<internalId xsi:type="xsd:int">5</internalId>
<loginId xsi:type="xsd:string">admin@yellowfin.com.au</loginId>
</multiRef>
</soapenv:Body>
</soapenv:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
完成例
以下は、GETUSERGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getusergroups.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getusergroups.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_getusergroups.jsp */
%>
<%@ page contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.mi.web.service.AdministrationGroup" %>
<%@ page import="com.hof.mi.web.service.AdministrationGroupMember" %>
<%@ page import="com.hof.mi.web.service.AdministrationPerson" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceRequest" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceResponse" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceService" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceServiceLocator" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceSoapBindingStub" %>
<%
// Adjust host and port number
AdministrationServiceService adminServiceService = new AdministrationServiceServiceLocator(
"localhost", 8080,
"/services/AdministrationService",
false
);
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) adminServiceService.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
// Provide your Yellowfin web services admin account
rsr.setLoginId("admin@yellowfin.com.au");
// Change to the password of the above account
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERGROUPS");
// Provide org reference if required. Default org groups will be retrieved otherwise
// rsr.setOrgRef("org1");
// Provide userId or ipId of the user
AdministrationPerson ap = new AdministrationPerson();
// Set one of userId and ipId. If both are set, ipId will be used by default.
// ap.setUserId("admin@yellowfin.com.au");
ap.setIpId(1);
rsr.setPerson(ap);
// Set the first item in the parameters array as "true" or "false" (String, case insensitive) to indicate
// whether to include AdministrationGroupMember objects in the returned AdministrationGroup objects.
// If true, the returned groups will contain the information of all their members.
rsr.setParameters(new String[]{"TRUE"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success.<br><br>Groups which the user belongs to:");
AdministrationGroup[] groups = rs.getGroups();
for (AdministrationGroup group : groups) {
out.write("<br>");
out.write("<br>Group Name: " + group.getGroupName());
out.write("<br>Group Id: " + group.getGroupId());
out.write("<br>Group Description: " + group.getGroupDescription());
out.write("<br>Group Status: " + group.getGroupStatus());
out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
// Uncomment to display the members:
out.write("<br><br>Members:<br>Login Id | Internal Id ");
for (AdministrationGroupMember member : group.getGroupMembers()) {
out.write("<br>" + member.getLoginId() + " | " + member.getInternalId());
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
out.write("<br><br>Messages:");
for (String msg : rs.getMessages()) {
out.write("<br>");
out.write(msg);
}
}
%> |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したクライアント組織(参照IDが提供される場合)、またはデフォルト(プライマリー)組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。(追加するメンバーは、既存のYellowfinユーザーでなくてはいけません) リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。
以下は、こちらの関数のAdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答の要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、CREATEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、グループのメンバーを更新するために使用します。このリクエストともにメンバーの一覧が提供される場合、既存のメンバー一覧は上書きされます。そのため、サービスは既存のメンバーをすべて削除し、新しいメンバーを追加します。メンバー一覧が提供されない場合は、グループ内の既存のユーザーすべてが削除されます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
| 以下の表8 | 以下の表8 | 以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationGroup要素 | データ型 | 説明 |
GroupName | String | グループの名前です。 |
GroupMembers | AdministrationGroupMember | グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。 |
グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。 |
以下は、こちらの関数のAdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationGroupMember要素 | データ型 | 説明 |
LoginId | String | 既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。 |
以下の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>MODIFYGROUP</function> <group> <groupName>Supervisors</groupName> <groupMembers> <loginId>admin@yellowfin.com.au</loginId> </groupMembers> </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>6589bf668504fd3468e0b43844550a22</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、MODIFYGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_modifygroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_modifygroup.jsp」を実行します。
Code Block | |||||
---|---|---|---|---|---|
| |||||
| |||||
<% /* ws_modifygroup.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); AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("MODIFYGROUP"); //Specify client org (if omitted, default (primary) org will be searched): rsr.setOrgRef("org1"); //Set parameters of the new group: AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group"); // mandatory. Other parameters are optional. //Add members: AdministrationGroupMember[] member = new AdministrationGroupMember[1]; member[0] = new AdministrationGroupMember(); member[0].setLoginId("admin@yellowfin.com.au"); group.setGroupMembers(member); 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、グループの名前を変更するために使用します。AdministrationGroupオブジェクトと、グループのIDを使用して対象のグループを指定します。グループIDは、Yellowfinのデータベース(AccessGroupテーブルのAccessGroupIdフィールド)、またはグループ名とresponse.getGroup().getGroupId()を取得してGETGROUPを呼び出すことで取得することができます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
Anchor | | 以下の表10 | 以下の表10
以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationGroup要素 | データ型 | 説明 |
GroupId | Integer | グループを識別するための内部IDです。 |
GroupName | String | グループの新しい名前です。 |
GroupDescription | 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>RENAMEGROUP</function> <group> <groupId>13001</groupId> <groupName>Report Creators</groupName> <groupDescription>Users of this group will create reports.</groupDescription> </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>2ca79b1696913aa7a4f8b601ac1641a4</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、RENAMEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_renamegroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループIDを調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_renamegroup.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_renamegroup.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"); //password of the account above rsr.setOrgId(1); rsr.setFunction("RENAMEGROUP"); rsr.setOrgRef("org1"); // provide org reference if required. Default org will be searched otherwise AdministrationGroup group = new AdministrationGroup(); group.setGroupId(13002); // identify the group to rename group.setGroupName("Org1"); // new group name group.setGroupDescription("Organization 1 user group"); // new description rsr.setGroup(group); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
グループ名を提供することで、Yellowfinから既存のユーザーグループを削除する場合は、こちらのwebサービスを呼び出します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
| 以下の表11 | 以下の表11 | 以下は、こちらの関数の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>DELETEGROUP</function> <group> <groupName>Admin</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>db18f2503e80ca02a9d37da13fc540a5</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、DELETEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deletegroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deletegroup.jsp」を実行します。
Code Block | |||||
---|---|---|---|---|---|
| |||||
| |||||
<% /* ws_deletegroup.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("DELETEGROUP"); rsr.setOrgRef("org1"); // specify a client org reference if required. Or skip this to search through the default org AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group"); // this group must exist in the specified client org rsr.setGroup(group); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したYellowfinのユーザーを、指定したユーザーグループに追加する場合に使用します。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
| 以下の表12 | 以下の表12 | 以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | グループに追加する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
Anchor
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>INCLUDEUSERINGROUP</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>a26d9c279a9c1a4f0dfda86424ca4267</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_includeuseringroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、既存ユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_includeuseringroup.jsp」を実行します。
Code Block | |||||
---|---|---|---|---|---|
| |||||
| |||||
<% /* ws_includeuseringroup.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 password of the above account rsr.setOrgId(1); rsr.setFunction("INCLUDEUSERINGROUP"); //Specify a client org (if omitted, default (primary) org groups will be searched): rsr.setOrgRef("org1"); //Identify a user: AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin user rsr.setPerson(ap); //Specify group to add the user to 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加する場合に使用します。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
Anchor | | 以下の表14 | 以下の表14
以下は、こちらの関数のAdministrationPersonオブジェクト配列に設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | グループに追加する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。 |
Anchor
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>INCLUDEUSERSINGROUP</function> <people> <userId>binish.sheikh@yellowfin.com.au</userId> <userId>admin@yellowfin.com.au</userId> </people> <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>799b3c35c5359c6105586e426f1b9f8c</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_includeusersingroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、既存ユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_includeusersingroup.jsp」を実行します。
Code Block | |||||
---|---|---|---|---|---|
| |||||
| |||||
<% /* ws_includeusersingroup.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 password of the above account rsr.setOrgId(1); rsr.setFunction("INCLUDEUSERINGROUP"); //Specify a client org (if omitted, default (primary) org groups will be searched): rsr.setOrgRef("org1"); //Provide all the users that are to be included: 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 group to add the users to 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。ユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
Anchor | | 以下の表16 | 以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。これらのユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクトの配列、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
| 以下の表18 | 以下の表18 | 以下は、こちらの関数のAdministrationPersonオブジェクト配列に設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります |
以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationGroup要素 | データ型 | 説明 |
GroupName | String | ユーザーを除外するグループの名前です。 |
応答のパラメーター
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「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()); } %> |
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループから削除します。こちらを実行することで、対象のユーザーはグループメンバーの一覧に表示されなくなります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
Anchor | | 以下の表20 | 以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | グループから削除する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります |
Anchor
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>DELUSERFROMGROUP</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>ed4f6504e415411875b2c359b9384cf9</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_deluserfromgroup.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、削除するユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_deluserfromgroup.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_ deluserfromgroup.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("DELUSERFROMGROUP"); //Specify the client org (if omitted, the default (primary) org groups will be searched): rsr.setOrgRef("org1"); //Specify a user to remove from a group: AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin use rsr.setPerson(ap); //Specify which group to remove user 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、特定のダッシュボードを指定したユーザーグループのデフォルトダッシュボードとして設定するために使用します。ダッシュボードを指定するためにContentResourceオブジェクト、ユーザーグループを識別するためにAdministrationGroupオブジェクトを使用します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
Anchor | | 以下の表23 | 以下の表23 |
グループのデフォルトに設定するダッシュボードの詳細を含むオブジェクト配列です。以下の表を参照してください。 |
以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。
AdministrationGroup要素 | データ型 | 説明 |
GroupName | String | デフォルトダッシュボードを設定するグループの名前です。 |
GroupId | Integer | ユーザーグループに一意のIDです。 |
ContentResource要素 | データ型 | 説明 |
ResrouceIdResourceId | Integer | ダッシュボードのIDです。 |
ResourceType | String | 固定値「GROUP」に設定しなくてはいけません。この値が正しく設定されていない要素は無視されます。 |
リクエストの例
以下の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>ASSIGNDEFAULTDASHBOARD</function>
<group>
<groupName>Administrators</groupName>
<groupId>11950</groupId>
</group>
<contentResources>
<resourceId>61251</resourceId>
<resourceType>GROUP</resourceType>
</contentResources>
</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>7b5510bf9919823f6067747b5d305984</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
完成例
以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_assigndefaultdashboard.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザー、削除するユーザー、グループ名を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_assigndefaultdashboard.jsp」を実行します。
Code Block |
---|
| |||||
| |||||
<% /* ws_assigndefaultdashboard.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.*" %> <% AdministrationServiceResponse rs = null; AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("ASSIGNDEFAULTDASHBOARD"); // This is the group AdministrationGroup administrationGroup = new AdministrationGroup(); administrationGroup.setGroupName("Administrators"); administrationGroup.setGroupId(11950); rsr.setGroup(administrationGroup); // This is the Dashboard ContentResource dashboardContentResource = new ContentResource(); dashboardContentResource.setResourceId(61195); dashboardContentResource.setResourceType("GROUP"); rsr.setContentResources(new ContentResource[] { dashboardContentResource }); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success"); } else { out.write("Failure"); out.write(rs.toString()); } |
...
|