Page History

Versions Compared

Old Version 2

changes.mady.by.user Yellowfin Admin

Saved on Mar 27, 2018

compared with

New Version Current

changes.mady.by.user Yuka Saito

Saved on Apr 15, 2021

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Migration of unmigrated content due to installation of a new plugin

Anchor

	top
	top

ユーザーグループとロールは、こちらの項目で紹介するwebサービスの呼び出しを使用して、作成、または変更をすることができます。

注意：「システム構成」ページで「クライアント組織」機能が有効になっている場合で、特定のタイプの呼び出しが適用可能な場合は、クライアント組織を指定することもできます。

注意：「システム構成」ページで「クライアント組織」機能を有効にすることで、特定タイプの呼び出しでは適用可能な場合に、クライアント組織を指定することができます。

ユーザーロール関数

これらの webサービスは、Yellowfinのユーザーロールに特化しています。

Note
LDAP認証を使用する場合、ロールを返すすべてのwebサービスは、LDAPユーザーが最後に正常にログインした時のロールを返します（これは、LDAPユーザーがログインをする度に更新されます）。

Expand

title	LISTROLES

こちらの関数は、Yellowfinで利用可能なすべてのユーザーロールを返します。応答は、利用可能なロールを表示するAdministrationRoleオブジェクトの配列が含まれます。こちらの関数は、Yellowfinで利用可能なすべてのユーザーロールを返します。応答は、利用可能なロールを表示する、AdministrationRoleオブジェクトの配列を含みます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「LISTROLES」に設定します。

リクエストの例

以下のSOAP XMLの例は、この呼び出しに渡すことのできるパラメーターを表示しています。以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	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>LISTROLES</function>                           
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

Roles

AdministrationRole[]

ロールの一覧です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse	language	xml

<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>CRUD</accessLevelCode>
                  <functionCode>ACTIVITYSTREAM</functionCode>
                  <functionDescription>Allows users to access the activity stream.</functionDescription>
                  <functionName>Activity Stream</functionName>
               </functions>
               <functions>
                  <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>TIMELINE</functionCode>
                  <functionDescription>Allows users to access their timeline.</functionDescription>
                  <functionName>Timeline</functionName>
               </functions>
               <functions>
                  <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>BROADCASTSUBSCRIBE</functionCode>
                  <functionDescription>Allows users to subscribe to report broadcasts.</functionDescription>
                  <functionName>Subscribe to Broadcast</functionName>
               </functions>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>STORYBOARD</functionCode>
                  <functionDescription>Allows users to view, create, edit or delete Storyboards.</functionDescription>
                  <functionName>Storyboard</functionName>
               </functions>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>DASHPUBLIC</functionCode>
                  <functionDescription>Allows users to create and edit Public dashboards.</functionDescription>
                  <functionName>Public Dashboards</functionName>
               </functions>
               <functions>
                  <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>TASKPERSONAL</functionCode>
                  <functionDescription>Allow users to create and assign tasks to themselves.</functionDescription>
                  <functionName>Personal Tasks</functionName>
               </functions>
               .
               .
               .
               <roleCode>YFADMIN</roleCode>
               <roleDescription>This user has the widest range of access to the system, and as such you should have a very limited number of people assigned this role. They can do everything from create content through to managing system tasks.</roleDescription>
               <roleName>System Administrator</roleName>
            </roles>
            <sessionId>4f86f0e30e30bf4b07dea21267de0a74</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse	language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("LISTROLES");

リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

Roles

AdministrationRole[]

ロールの一覧です。

完成例

以下は、LISTROLES関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_listrolelistroles.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_listroles.jsp」を実行します。

code

Code Block

language

java
theme	Eclipse
language	java

<%           
/*              ws_listroles.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 be the password of the account above
rsr.setOrgId(1);
 
rsr.setFunction("LISTROLES");
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success.<br>Available Roles:");
    AdministrationRole[] roles = rs.getRoles();
    for (AdministrationRole role: roles){
        out.write("<br>");
        out.write("<br>Role Name: " + role.getRoleName());
        out.write("<br>Role Code: " + role.getRoleCode());
        out.write("<br>Role Description: " + role.getRoleDescription());
                                   
        // uncomment to display all the security functions:
        /*
        out.write("<br>Function Name | Code | Description | TypeCode | AccessLevelCode");
        for (AdministrationFunction f: role.getFunctions()){
            out.write("<br>"    + f.getFunctionName() + " | "
                                + f.getFunctionCode() + " | "
                                + f.getFunctionDescription() + " | "
                                + f.getFunctionTypeCode() + " | "
                                + f.getAccessLevelCode());
        }
        */
 
    }
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	SAVEROLE

こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロール詳細を指定するためのAdministrationRoleオブジェクトと、ロールのためのAdministrationFunctionの配列を含まなくてはいけません。こちらの関数が、ロールの更新、または新規ロール作成に使用されるか同課に関わらず、すべてのYellowfinロールは、必須関数であるレポートアクセス（関数コード：MIREPORT）を要求することに注意してください。MIREPORTには、アクセスレベルコードとして、最低でもR（読み取り）を設定　しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ関数は上書きされます。

こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロールの詳細を指定するAdministrationRoleオブジェクトと、ロールのAdministrationFunctionの配列を含まなくてはいけません。こちらの関数を、ロールの更新、または新規ロール作成のいずれに使用するかに関わらず、すべてのYellowfinロールは、必須関数であるレポートアクセス（コード：MIREPORT）を要求することに注意してください。MIREPORTには、アクセスレベルコードとして、最低でもR（読み取り）を設定しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ機能は上書きされます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「SAVEROLE」に設定します。
Role	AdministrationRole	こちらのオブジェクトは追加、または更新されるロールの詳細を含みます。詳細は、以下の表を参照してください。

追加、または更新されるロールの詳細を含むオブジェクトです。詳細は、以下の表を参照してください。

Anchor

	以下の表
	以下の表

以下は、こちらの関数のAdministrationRoleオブジェクトに設定しなくてはいけない主要なパラメーターです。以下は、こちらの関数のために、「AdministrationRole」オブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationRole 要素	データ型	説明
RoleCode	String既存のロールの内部コードを指定します。こちらのパラメーターは、既存のロールを更新したい場合には、必ず含めなくてはいけません。こちらを指定しない場合は、既に同名のロールが存在するとしても、新規ロールとして作成されます。	既存のロールの内部コードです。既存のロールを更新したい場合は、こちらのパラメーターを必ず含めなくてはいけません。これがデータベース内の既存のロールコードと一致しない場合、既に同名のロールが存在していても、新規ロールとして作成されます。
RoleName	String	（必須）新規、または既存のロールの名前です。RoleCodeに一致する既存のロールを更新する場合、ロールの名前はこちらに設定されます。RoleCodeに一致するものがない場合、コードを生成するためにRoleNameを使用して新しいロールが作成されます。例えば、「Test Role」というRoleNameは、「TESTROLE」というRoleCodeを作成します。既存のロールが既に「TESTROLE」というRoleCodeを持つ場合、新しいRoleCodeは「TESTROLE1」になります。	新規、または既存のロールの名前です。こちらは、既存のロールの変更時にも必須です。こちらを設定しない場合、呼び出しはロール名空白に設定します。
RoleDescription	String	ロールの説明です。
FunctionFunctions	AdministrationFunction	こちらのオブジェクトは、セキュリティ関数の一覧を含みます。これらは、SAVEROLE関数を呼び出す度に上書きされます。レポートアクセス関数は必須です。より詳細な情報は、以下の表を参照してください。

セキュリティ機能の一覧を含むオブジェクトです。これらは、SAVEROLE関数を呼び出す度に上書きされます。レポートアクセス関数は必須です。より詳細な情報は、以下の表を参照してください。

Anchor

	以下の表２
	以下の表２

以下は、こちらのwebサービスのAdministrationFunctionオブジェクトに設定しなくてはいけない主要なパラメーターです。以下は、こちらのwebサービスのためにAdministrationFunctionオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationFunction要素	データ型	説明
FunctionCode	String	セキュリティ関数のコードを指定します。例えば、レポートアクセス関数を含める場合は、MIREPORTと設定します。セキュリティ機能のコードを指定します。例えば、レポートアクセス関数を含める場合は、MIREPORTと設定します。
AccessLevelCode	String	関数のアクセスレベルです。例えば、Rは読み取りを意味します。

Code Block

language	xml
theme	Eclipse	language	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>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

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse
language	xml

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("SAVEROLE");

ロールを定義します。ロールを指定します。
Code Block
language java
theme Eclipse
language java
AdministrationRole role = new AdministrationRole();

既存のロールを変更する場合は、ロールコードが必須になります。

Code Block

language	java
theme	Eclipse	language	java

role.setRoleCode("NEWROLE");          // If you want to create a new role, comment this out.

ロールコードを指定しない場合は、同名のロールが既に存在しているとしても、新規ロールとして作成されます。

ロールコードを指定しない場合は、同名のロールが既に存在していても、新規ロールとして作成されます。

Tip

YellowfinデータベースのOrgRoleテーブルから、ロールコードを取得することができます。（通常これはロール名に基づき、すべて大文字のスペースなしで表現されます）YellowfinデータベースのOrgRoleテーブルから、ロールコードを取得することができます。（通常これはロール名に基づき、すべて大文字のスペースなしで表現されます。）

既存のロールを変更する場合でもロール名は必須です。ロール名を指定しない場合、呼び出しはこれを空白にします。

Code Block
既存のロールを変更する場合でもロール名は必須です。ロール名を指定しない場合、呼び出しはこれを空白に設定します。code
language
language
java
theme Eclipse java
role.setRoleName("New Role"); role.setRoleDescription("testing");

SAVEROLE関数の呼び出す度に、セキュリティ機能の一覧を提供しなくてはいけません。この呼び出しは、ロール機能を上書きます。例えば、2つの機能をロールに割り当てます。レポートアクセス（必須）、アクティビティストリーム（オプション）

Code Block

language	java

SAVEROLE関数の呼び出し時には、セキュリティ機能の一覧を提供しなくてはいけません。この呼び出しは、ロール機能を上書きます。例えば、ロールに2つの機能を割り当てます。レポートアクセス（必須）、アクティビティストリーム（オプション）

code

language


theme	Eclipse		java

AdministrationFunction[] f = new AdministrationFunction[1];
f[0] = new AdministrationFunction();
f[0].setFunctionCode("MIREPORT");
f[0].setAccessLevelCode("R");
f[1] = new AdministrationFunction();
f[1].setFunctionCode("ACTIVITYSTREAM");
f[1].setAccessLevelCode("CRUD");

Note
セキュリティ機能を省略することはできません。呼び出しはエラーを生成します。セキュリティ機能を省略できないため、その場合呼び出しはエラーを生成します。

ロールにセキュリティ機能を割り当てます。
Code Block
language java
role.setFunctions(f); rsr.setRole(role);

リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

完成例

以下は、SAVEROLE関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_saverole.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_saverole.jsp」を実行します。

code

Code Block

language

language

java
theme	Eclipse		java

<%           
/*              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

title	DELETEROLE

こちらの関数は、指定したユーザーロールを削除します。AdministrationRoleオブジェクトのロールコードを提供することで、対象のロールを指定することができます。こちらの関数は、指定したユーザーロールを削除します。AdministrationRoleオブジェクトのロールコードを提供することで、対象のロールを識別することができます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「DELETEROLE」に設定します。
Role	AdministrationRole	削除するロールの詳細を含むオブジェクトです。以下の表を参照してください。

削除するロールの詳細を含むオブジェクトです。以下の表を参照してください。

Anchor

	以下の表３
	以下の表３

以下は、AdministrationRoleオブジェクトに設定しなくてはいけない主要なパラメーターです。以下は、「AdministrationRole」オブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationRole 要素	データ型	説明
RoleCode	String削除される既存のロールの内部コードを指定します。	削除する既存のロールの内部コードを指定します。

以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

以下のSOAP XMLの例は、この呼び出しに渡すことのできるパラメーターを表示しています。code

language

xml
theme	Eclipse
language	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>DELETEROLE</function>
            <role>
                <roleCode>REPORTWRITER</roleCode>
            </role>                          
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse
language	xml

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse	language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("DELETEROLE");

削除するロールを定義します。

Code Block

language	java
theme	Eclipse	language	java

AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");                     // existing role. Role Codes can be found by calling LISTROLES
                                                 // or retrieved from the Yellowfin database table OrgRole.
rsr.setRole(role);

リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。

返される応答には、StatusCodeとPeopleパラメーターが含まれます。詳細については、上記の応答パラメーターの表を参照してください。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

完成例

以下は、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

title	LISTGROUPS

LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。特定のクライアントに所属するグループの一覧を取得する場合は、呼び出しにクライアント組織参照IDを渡します。LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。指定したクライアントに所属するグループの一覧を取得する場合は、呼び出し内でクライアント組織参照IDを渡します。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「LISTGROUPS」に設定します。
OrgRef	String	特定のクライアントに所属するグループの一覧を取得する場合は、クライアント組織IDを含めます。こちらが指定されない場合は、デフォルト組織のグループが返されます。指定したクライアントに所属するグループの一覧を取得する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織のグループが返されます。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。code

language

language

xml
theme	Eclipse		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>LISTGROUPS</function>                          
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

Groups

AdministrationGroup[]

グループの一覧です。

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse	language	xml

<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>
            <groups>
               <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>
            </groups>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>79d937ead121745d93289f287d55b0ac</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的な呼び出しです。

Code Block

language	java
theme	Eclipse	language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("LISTGROUPS");

指定したクライアントのグループ一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織のグループが表示されます。）

Code Block
特定のクライアントのグループの一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー組織）のグループが表示されます）
code
language
java
theme Eclipse
language java
rsr.setOrgRef("org1");
リクエストの構成が完了したら、呼び出しを実行します。

Code Block
code
language
java
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

Groups

AdministrationGroup[]

グループの一覧です。

AdministrationGroup.getGroupMembers()を使用することで、各グループのメンバーを取得することができます。これは、AdministrationGroupMemberの配列を取得します。グループにメンバーとしてのユーザーロールが含まれる場合、これは取得されません。getGroupMembers()を介して、ユーザーアカウントのみが取得されます。

完成例

以下は、LISTGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_listgroups.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_listgroups.jsp」を実行します。

Code Block

code

language

java
theme	Eclipse	language	java

<%           
/*              ws_listgroups.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 above account
rsr.setOrgId(1);
 
rsr.setFunction("LISTGROUPS");
 
//rsr.setOrgRef("org1");                         // provide org reference if required. Default org groups will be retrieved otherwise
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success.<br>Available Groups:");
    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>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

title	GETGROUP

特定のユーザーグループを、そのメンバーとともに取得する場合は、こちらの関数を使用します。リクエストには、必ずグループ名を提供しなくてはいけません。指定したユーザーグループを、そのメンバーとともに取得する場合は、こちらの関数を使用します。リクエストには、必ずグループ名を提供しなくてはいけません。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「GETGROUP」に設定します。
Group	AdministrationGroup取得するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。	取得するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織のグループが検索されます。	指定したクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織のグループが検索されます。

Anchor

	以下の表４
	以下の表４

以下は、こちらの関数の以下は、こちらの関数のためにAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	詳細とメンバーの一覧を取得するユーザーグループの名前を指定します。その詳細とメンバー一覧を取得するユーザーグループの名前を指定します。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse
language	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>GETGROUP</function>
            <group>
                <groupName>Administrators</groupName>
            </group>                   
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

Group

AdministrationGroup[]

メンバーの一覧を含むグループの詳細です。

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language

language	xml
theme	Eclipse		xml

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETGROUP");

指定したクライアント組織のグループ一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織のグループが表示されます）特定のクライアント組織のグループ一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー組織）組織のグループが表示されます）

Code Block
code
language
java
theme Eclipse
language java
rsr.setOrgRef("org1");
メンバーを取得するためにユーザーグループの名前を提供します。
Code Block
themelanguage Eclipsejava
languagetheme javaEclipse
AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Administrators"); rsr.setGroup(group);
リクエストの構成が完了したら、呼び出しを実行します。

Code Block
リクエストの構成が完了したら、呼び出しを実行します。code
language
java
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

Group

AdministrationGroup[]

メンバーの一覧を含むグループの詳細です。メンバー含むグループです。

メンバーを取得するためには、以下を使用します。

Code Block

language	java
theme	Eclipse
language	java

AdministrationGroupMember[] members = rs.getGroup().getGroupMembers();

Tip

YellowfinアカウントのIpIdを取得するために、AdministrationGroupMember.getInternalId()を使用することができます。これを、GETUSERBYIPの呼び出しに渡すことで、ユーザーのAdministrationPersonオブジェクトが取得されます。を使用することができます。これを、GETUSERBYIPの呼び出しに渡すことで、ユーザーのAdministrationPersonオブジェクトを取得します。

完成例

以下は、GETGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_getgroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。環境に応じて、ホスト、ポート番号、管理ユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_getgroup.jsp」を実行します。

Code Block

code

language

language

java
theme	Eclipse		java

<%           
/*              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());
}
%>

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Expand

title	CREATEGROUPGETUSERGROUPS

こちらの関数は、特定のクライアント組織（参照IDが提供される場合）、またはデフォルト（プライマリー）組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。（追加するメンバーは、既存のYellowfinユーザーでなくてはいけません）

ユーザーが所属するすべてのユーザーグループを取得するには、こちらの関数を使用します。これは、AdministrationPersonをパラメーターとして受け付け、ユーザーを特定します。応答には、AdministrationGroupオブジェクトの配列が含まれます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	Stringログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「CREATEGROUPGETUSERGROUPS」に設定します。
GroupPerson	AdministrationGroupAdministrationPerson	追加するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。取得されるグループに所属するユーザーの詳細を含むオブジェクトです。注意：以下の表を参照してください。
OrgRef	String特定のクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織にグループが作成されます。	クライアント組織内部参照IDです（オプション）。

特定のクライアントに所属するグループを取得する場合に含めます。こちらを指定しない場合は、デフォルト組織のグループが返されます。

以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素データ型説明GroupName

Parameters

String[]

渡されるパラメーター配列内の最初のアイテムであり、返されるAdministrationGroupオブジェクトにAdministrationGroupMemberオブジェクトを含めるかどうかを指示します。trueに設定すると、返されるグループには、すべてのメンバーの情報が含まれます。

例：「TRUE」、または「FALSE」に設定します。大文字と小文字は区別されません。

AdministrationPersonオブジェクトに、以下のいずれかのパラメーターを設定します。

String新規グループの名前です。GroupMembers

AdministrationPerson要素	データ型	説明
AdministrationGroupMemberUserId	グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。String

取得されるグループに所属するユーザーを特定するユーザーIDです。

以下は、こちらの関数のために、AdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroupMember要素データ型説明

これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。
IpId	String	取得されるグループに所属するユーザーのIp IDです。LoginId

両方が設定された場合、IpIdがデフォルトで使用されます。

String

リクエストの例

既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。

Code Block

language	xml
theme	Eclipse	language	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>CREATEGROUP<    <function>GETUSERGROUPS</function>
            <group>
    <person>
            <groupName>Supervisors</groupName>
        <!-- Set one of userId and ipId. If both are set, ipId will  <groupMembers>be used by default. -->
                    <loginId>admin@yellowfin<userId>admin@yellowfin.com.au</loginId>userId>
                    <loginId>binish.sheikh@yellowfin.com.au</loginId><ipId>5</ipId>
                </groupMembers>person>
                </group>!-- orgRef is optional -->
                <orgRef>org1</orgRef>
         </arg0>
       </web:remoteAdministrationCall><parameters>
    </soapenv:Body>
</soapenv:Envelope>

応答の要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
     <!-- TRUE or FALSE. <return>
Case insensitive. -->
          <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages><string>true</string>
            <messages>Web Service Request Complete</messages>
            <sessionId>b1f1b17d503e1e11c05b72e674bc80ec</sessionId> </parameters>
            <statusCode>SUCCESS<</statusCode>arg0>
         </return>web:remoteAdministrationCall>
      </ns2:remoteAdministrationCallResponse>
   </S:soapenv:Body>
</Ssoapenv:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

応答要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

Groups

AdministrationGroup[]

グループの一覧です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

以下は、こちらの関数の基礎的なリクエストです。
code

特定のクライアントに新規グループを追加する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織にグループが作成されます。）

Code Block

language	xml

Expand

title	詳細手順


theme	Eclipse

language

java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("CREATEGROUP");

Code Block

theme	Eclipse
language	java

rsr.setOrgRef("org1");

追加する新規グループのパラメーターを設定します。

Code Block

theme	Eclipse
language	java

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");

グループにメンバーを含めます。例：

Code Block

theme	Eclipse
language	java

AdministrationGroupMember[] member = new AdministrationGroupMember[2];
 
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@yellowfin.com.au");
 
group.setGroupMembers(member);
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

完成例

以下は、CREATEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_creategroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。
インターネットブラウザから、「http://<host>:<port>/ws_creategroup.jsp」を実行します。

Code Block

theme	Eclipse
language	java

<%           
/*<?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"     ws_creategroup.jsp   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  */
%>
<%@ 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("CREATEGROUP");
 
//Specify client org (if omitted, the group will be created in the default (primary) org):
rsr.setOrgRef("org1");
 
//Set parameters of the new group:
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");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" // mandatory. Other parameters are optional.
 
//Add members:
AdministrationGroupMember[] member = new AdministrationGroupMember[2];
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@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

title	MODIFYGROUP

こちらの関数は、グループのメンバーを更新するために使用されます。このリクエストともにメンバーの一覧が提供される場合、既存のメンバー一覧は上書きされます。そのため、サービスは既存のメンバーをすべて削除し、新しいメンバーを追加します。メンバー一覧が提供されない場合は、グループ内の既存のユーザーすべてが削除されます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「MODIFYGROUP」に設定します。
Group	AdministrationGroup	追加するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	新規グループの名前です。
GroupMembers	AdministrationGroupMember	グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。

以下は、こちらの関数のために、AdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroupMember要素	データ型	説明
LoginId	String	既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

theme	Eclipse
language	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>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"/>
         <arg0>
   <messages soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array">
        <loginId>admin@yellowfin.com.au</loginId>
        <messages xsi:type="soapenc:string">Successfully Authenticated  <password>test</password>
 User: admin@yellowfin.com.au</messages>
           <orgId>1</orgId>
     <messages xsi:type="soapenc:string">Web Service Request    <function>MODIFYGROUP</function>Complete</messages>
            <group></messages>
            <parentDashboard    <groupName>Supervisors</groupName>xsi:type="ns2:ParentDashboard" xsi:nil="true"/>
            <parentDashboards    <groupMembers>xsi:type="ns2:ArrayOfParentDashboard" xsi:nil="true"/>
               <parentReportGroups xsi:type="soapenc:Array" xsi:nil="true"/>
     <loginId>admin@yellowfin.com.au</loginId>       <people xsi:type="ns2:ArrayOfAdministrationPerson" xsi:nil="true"/>
            <person xsi:type="ns2:AdministrationPerson" xsi:nil="true"/>
  </groupMembers>
          <personfavourites  </group>xsi:type="ns2:ArrayOfPersonFavourite" xsi:nil="true"/>
            <queryResults xsi:type="ns2:ArrayOfReportRow" xsi:nil="true"/>
     
       <report  </arg0>xsi:type="ns2:AdministrationReport" xsi:nil="true"/>
      </web:remoteAdministrationCall>
      <reportGroups </soapenv:Body>
</soapenv:Envelope>

応答の要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"xsi:type="ns2:ArrayOfAdministrationReportGroup" xsi:nil="true"/>
   <S:Body>
          <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"<reportId xsi:type="xsd:int" xsi:nil="true"/>
         <return>
    <reports xsi:type="ns2:ArrayOfAdministrationReport" xsi:nil="true"/>
             <errorCode>0</errorCode><roles xsi:type="ns2:ArrayOfAdministrationRole" xsi:nil="true"/>
            <messages>Successfully<schedule Authenticated User: admin@yellowfin.com.au</messages>xsi:nil="true"/>
            <messages>Web Service Request Complete</messages><schedules xsi:type="ns3:ArrayOfAdministrationSchedule" xsi:nil="true" xmlns:ns3="http://schedule.service.web.mi.hof.com"/>
            <sessionId>6589bf668504fd3468e0b43844550a22<<sessionId xsi:type="xsd:string">974c65a870699f6f4059ba54c15ddc6c</sessionId>
            <statusCode>SUCCESS<<statusCode xsi:type="xsd:string">SUCCESS</statusCode>
         </return>multiRef>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("MODIFYGROUP");

特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。）
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1");
新規グループのパラメーターを設定します。
Code Block
theme Eclipse
language java
AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group");

グループにメンバーを含めます。例：

Code Block

theme	Eclipse
language	java

AdministrationGroupMember[] member = new AdministrationGroupMember[1];
 
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
group.setGroupMembers(member);
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

完成例

以下は、MODIFYGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_modifygroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_modifygroup.jsp」を実行します。

Code Block

theme	Eclipse
language	java

<%<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">
            ws_modifygroup.jsp    <groupMembers href="#id2"/></groupMembers>
           */
%>
<%@ 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"); <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>
       // mandatory. Other parameters are optional.
 
 
//Add members:
AdministrationGroupMember[] member</soapenv:Body>
</soapenv:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。
Code Block
language java
theme Eclipse
AdministrationServiceRequest rsr = new

AdministrationGroupMember[1]

AdministrationServiceRequest();

member[0] = new AdministrationGroupMember(); member[0]

rsr.setLoginId("admin@yellowfin.com.au");

group

rsr.

setGroupMembers

setPassword(

member

"test");

rsr.

setGroup

setOrgId(

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	RENAMEGROUP

rsr.setFunction("GETUSERGROUPS");
クライアント組織に特定のグループを取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織のグループが表示されます。）
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");
AdministrationPersonオブジェクトを使用して、ユーザーID、またはip IDを提供します。
Code Block
language java
theme Eclipse
AdministrationPerson ap = new AdministrationPerson(); // ap.setUserId("admin@yellowfin.com.au"); ap.setIpId(1); rsr.setPerson(ap);
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

Groups

AdministrationGroup[]

グループの一覧です。

AdministrationGroup.getGroupMembers()を使用することで、各グループのメンバーを取得することができます。これは、AdministrationGroupMemberの配列を取得します。グループにメンバーとしてのユーザーロールが含まれる場合、これは取得されません。getGroupMembers()を介して、ユーザーアカウントのみが取得されます。

完成例

以下は、GETUSERGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_getusergroups.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_getusergroups.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%
    /*              ws_getusergroups.jsp

こちらの関数は、グループの名前を変更するために使用されます。AdministrationGroupオブジェクトと、グループのIDを使用して対象のグループを指定します。グループIDは、Yellowfinのデータベース（AccessGroupテーブルのAccessGroupIdフィールド）、またはグループ名とresponse.getGroup().getGroupId()を取得してGETGROUPを呼び出すことで取得することができます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「RENANEGROUP」に設定します。
Group	AdministrationGroup	名前を変更するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	特定のクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが作成されます。

以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupId	Integer	グループを識別するための内部IDです。
GroupName	String	グループの新しい名前です。
GroupDescription	String	グループの説明です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

theme	Eclipse
language	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>RENAMEGROUP</function>
            <group>*/
%>
<%@ 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,
  <groupId>13001</groupId>            "/services/AdministrationService",
            false
    <groupName>Report Creators</groupName>);
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) adminServiceService.getAdministrationService();
    AdministrationServiceRequest rsr = new <groupDescription>Users of this group will create reports.</groupDescription>
            </group>                   
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<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>

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

title	CREATEGROUP

こちらの関数は、指定したクライアント組織（参照IDが提供される場合）、またはデフォルト（プライマリー）組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。（追加するメンバーは、既存のYellowfinユーザーでなくてはいけません）

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「CREATEGROUP」に設定します。
Group	AdministrationGroup	追加するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織にグループが作成されます。

Anchor

	以下の表５
	以下の表５

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	新規グループの名前です。
GroupMembers	AdministrationGroupMember	グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。

Anchor

	以下の表６
	以下の表６

以下は、こちらの関数のAdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroupMember要素	データ型	説明
LoginId	String	既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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>CREATEGROUP</function>
            <group>
                <groupName>Supervisors</groupName>
                <groupMembers>
                    <loginId>admin@yellowfin.com.au</loginId>
                    <loginId>binish.sheikh@yellowfin.com.au</loginId>
                </groupMembers>
            </group>                   
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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>b1f1b17d503e1e11c05b72e674bc80ec</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("CREATEGROUP");

指定したクライアントに新規グループを追加する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織にグループが作成されます。）
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");
新規グループのパラメーターを設定します。
Code Block
language java
theme Eclipse
AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group");

グループにメンバーを含めます。例：

Code Block

language	java
theme	Eclipse

AdministrationGroupMember[] member = new AdministrationGroupMember[2];
 
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@yellowfin.com.au");
 
group.setGroupMembers(member);
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、CREATEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_creategroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループ名の詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_creategroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*              ws_creategroup.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("CREATEGROUP");
 
//Specify client org (if omitted, the group will be created in the default (primary) org):
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[2];
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@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

title	MODIFYGROUP

こちらの関数は、グループのメンバーを更新するために使用します。このリクエストともにメンバーの一覧が提供される場合、既存のメンバー一覧は上書きされます。そのため、サービスは既存のメンバーをすべて削除し、新しいメンバーを追加します。メンバー一覧が提供されない場合は、グループ内の既存のユーザーすべてが削除されます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「MODIFYGROUP」に設定します。
Group	AdministrationGroup	変更するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

Anchor

	以下の表８
	以下の表８

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	グループの名前です。
GroupMembers	AdministrationGroupMember	グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。

Anchor

	以下の表９
	以下の表９

以下は、こちらの関数のAdministrationGroupMemberオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroupMember要素	データ型	説明
LoginId	String	既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("MODIFYGROUP");

クライアント組織に所属するグループを検索する場合は、クライアント組織IDを提供します。（こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。）
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");
新規グループのパラメーターを設定します。
Code Block
language java
theme Eclipse
AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group");

グループにメンバーを含めます。例：

Code Block

language	java
theme	Eclipse

AdministrationGroupMember[] member = new AdministrationGroupMember[1];
 
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");
 
group.setGroupMembers(member);
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、MODIFYGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_modifygroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_modifygroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*              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

title	RENAMEGROUP

こちらの関数は、グループの名前を変更するために使用します。AdministrationGroupオブジェクトと、グループのIDを使用して対象のグループを指定します。グループIDは、Yellowfinのデータベース（AccessGroupテーブルのAccessGroupIdフィールド）、またはグループ名とresponse.getGroup().getGroupId()を取得してGETGROUPを呼び出すことで取得することができます。

リクエスト要素

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「RENANEGROUP」に設定します。
Group	AdministrationGroup	名前を変更するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内にグループが作成されます。

Anchor

	以下の表１０
	以下の表１０

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupId	Integer	グループを識別するための内部IDです。
GroupName	String	グループの新しい名前です。
GroupDescription	String	グループの説明です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストです。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("RENAMEGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。（こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。）
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");
名前を変更するグループを定義します。
Code Block
language java
theme Eclipse
AdministrationGroup group = new AdministrationGroup();
グループIDを使用して、グループを識別します。
Code Block
language java
theme Eclipse
group.setGroupId(13002);

新しいグループ名と説明を提供します。

Code Block

language	java
theme	Eclipse

group.setGroupName("Org 1");
group.setGroupDescription("Organization 1 user group");
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、RENAMEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_renamegroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループIDを調整します。
インターネットブラウザから、「http://<host>:<port>/ws_renamegroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*              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

title	DELETEGROUP

グループ名を提供することで、Yellowfinから既存のユーザーグループを削除する場合は、こちらのwebサービスを呼び出します。

リクエストパラメーター

以下のパラメーターは、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「DELETEGROUP」に設定します。
Group	AdministrationGroup	削除するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表１１
	以下の表１１

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	削除するグループの名前です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

以下は、こちらの関数の基礎的なリクエストから開始します。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("DELETEGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");

削除するグループのパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、DELETEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_deletegroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_deletegroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*              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

title	INCLUDEUSERINGROUP

こちらの関数は、指定したYellowfinのユーザーを、指定したユーザーグループに追加する場合に使用します。

こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。

リクエストパラメーター

以下のパラメーターは、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「INCLUDEUSERINGROUP」に設定します。
Person	AdministrationPerson	グループに追加するユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
Group	AdministrationGroup	追加するユーザーのユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織内のグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表１２
	以下の表１２

以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	グループに追加する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

Anchor

	以下の表１３
	以下の表１３

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	ユーザーを追加するグループの名前です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

こちらの関数の基礎的なリクエストから開始します。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("INCLUDEUSERINGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");

グループに追加する既存ユーザーを識別するパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  // must be an existing Yellowfin user
 
rsr.setPerson(ap);

ユーザーを含めるグループのパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_includeuseringroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、既存ユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_includeuseringroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*             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

title	INCLUDEUSERSINGROUP

こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加する場合に使用します。

こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。

リクエストパラメーター

以下のパラメーターは、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「INCLUDEUSERSINGROUP」に設定します。
Person	AdministrationPerson[]	グループに追加するユーザーの詳細を含むオブジェクト配列です。以下の表を参照してください。
Group	AdministrationGroup	追加するユーザーのユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織内のグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表１４
	以下の表１４

以下は、こちらの関数のAdministrationPersonオブジェクト配列に設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	グループに追加する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

Anchor

	以下の表１５
	以下の表１５

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	ユーザーを追加するグループの名前です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

こちらの関数の基礎的なリクエストから開始します。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("INCLUDEUSERSINGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");

グループに追加する既存ユーザーを識別するために、パラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");              // must be an existing Yellowfin user
 
 
rsr.setPeople(ap);

ユーザーを含めるグループのパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 //must be an existing group
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_includeusersingroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、既存ユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_includeusersingroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*             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

title	EXCLUDEUSERFROMGROUP

こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。ユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。

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を含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表１６
	以下の表１６

以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります

Anchor

	以下の表１７
	以下の表１７

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	ユーザーを除外するグループの名前です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

<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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

<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

title	詳細手順

こちらの関数の基礎的なリクエストから開始します。

Code Block

language	java
theme	Eclipse

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("EXCLUDEUSERFROMGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");

ユーザーを識別するパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");      // must be an existing Yellowfin user
 
rsr.setPerson(ap);

グループのパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");         //must be an existing user group
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答要素 データ型 説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_excludeuserfromgroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、除外するユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_excludeuserfromgroup.jsp」を実行します。

Code Block

language	java
theme	Eclipse

<%           
/*              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 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を含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表１８
	以下の表１８

以下は、こちらの関数のAdministrationPersonオブジェクト配列に設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	グループから除外する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります

Anchor

	以下の表１９
	以下の表１９

以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	ユーザーを除外するグループの名前です。

応答のパラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

こちらの関数の基礎的なリクエストから開始します。以下は、こちらの関数の基礎的なリクエストです。

Code Block

language

language	java
theme	Eclipse		java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("RENAMEGROUPEXCLUDEUSERSFROMGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

Code Block
特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。）
code
language
language
java
theme Eclipse java
rsr.setOrgRef("org1");
ユーザーを識別するパラメーターを設定します。名前を変更するグループを定義します。

Code Block
code
language
java
theme Eclipse
language java
AdministrationGroup group = new AdministrationGroup();
グループIDを使用して、グループを識別します。
Code Block
theme Eclipse
language java
group.setGroupId(13002);

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

language	java
theme	Eclipse

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");         //must be an existing user group

新しいグループ名と説明を提供します。

Code Block

theme	Eclipse
language	java

group.setGroupName("Org 1");
group.setGroupDescription("Organization 1 user group");
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。

Code Block
code
language
java
theme Eclipse language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

完成例

以下は、RENAMEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_renamegroupexcludeusersfromgroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループメンバー、グループIDを調整します。環境に応じて、ホスト、ポート番号、管理ユーザー、除外するユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_renamegroupexcludeusersfromgroup.jsp」を実行します。

Code Block

code

language

java
theme	Eclipse
language	java

<%           
/*              ws_renamegroup 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");                           //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(set the password of the above account
 
rsr.setOrgId(1);
 
grouprsr.setGroupIdsetFunction(13002"EXCLUDEUSERFROMGROUP");
 
 
//Specify the client org (if omitted, the default (primary) org groups will be searched):
 
 
rsr.setOrgRef("org1");
 
 
//Specify users to exclude:
 
AdministrationPerson[] ap //= identify the group to rename
group.setGroupName("Org1new 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 group name
 
AdministrationGroup();
group.setGroupDescriptionsetGroupName("Organization 1 user groupAdministrators");                 // new descriptionmust be an existing user group
 
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

title	INCLUDEUSERINGROUPDELUSERFROMGROUP

こちらの関数は、特定のYellowfinユーザーを特定のユーザーグループに追加する場合に使用されます。こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループから削除します。こちらを実行することで、対象のユーザーはグループメンバーの一覧に表示されなくなります。

こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。

リクエストパラメーター

以下のパラメーターは、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「DELETEGROUPDELUSERFROMGROUP」に設定します。
Person	AdministrationPerson	グループから削除されるユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
Group	AdministrationGroup	削除するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	特定のクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

ユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
OrgRef	String	指定したクライアント組織内のグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト組織内のグループが検索されます。

Anchor

	以下の表２０
	以下の表２０

以下は、こちらの関数のAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	グループから削除する既存のYellowfinユーザーです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります

Anchor

	以下の表２１
	以下の表２１

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。以下は、こちらの関数のために、AdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	削除するグループの名前です。ユーザーを削除するグループの名前です。

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse
language	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>/loginId>
           <password>test</password>
           <orgId>1</orgId>
           <function>DELUSERFROMGROUP</function>
           <password>test</password><person>
            <orgId>1</orgId><userId>binish.sheikh@yellowfin.com.au</userId>
           <function>DELETEGROUP<</function>person>
           <group>
            <groupName>Admin<<groupName>Administrators</groupName>
           </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答のパラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language

language	xml
theme	Eclipse		xml

<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>ed4f6504e415411875b2c359b9384cf9</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

こちらの関数の基礎的なリクエストから開始します。以下は、こちらの関数の基礎的なリクエストから開始します。

Code Block

language	java
theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("DELETEGROUP");("DELUSERFROMGROUP");

指定したクライアント組織に所属するグループを検索する場合は、クライアント組織を指定します。こちらを含めない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
language java
theme Eclipse
rsr.setOrgRef("org1");

削除するユーザーを識別するパラメーターを設定します。

Code Block

language	java
theme	Eclipse

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");      // must be an existing Yellowfin user
 
rsr.setPerson(ap);

ユーザーを削除するグループのパラメーターを設定します。

Code Block
language java
theme Eclipse
特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1");

削除するグループのパラメーターを設定します。

Code Block

theme	Eclipse
language	java

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test GroupAdministrators");         //must be an existing user group
 
rsr.setGroup(group);

リクエストの構成が完了したら、呼び出しを実行します。

code
Code Block
language
language
java
theme Eclipse java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、これらのパラメーターが含まれます。
応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

SUCCESS
FAILURE

完成例

以下は、DELETEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_deletegroupdeluserfromgroup.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザー、グループ名を調整します。環境に応じて、ホスト、ポート番号、管理ユーザー、削除するユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_deletegroupdeluserfromgroup.jsp」を実行します。

Code Block

code

language

language

java
theme	Eclipse		java

<%           
/*              ws_deletegroup 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 password of the above account
 
rsr.setOrgId(1);
 
rsr.setFunction("DELETEGROUP");
 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");             // specifymust abe clientan orgexisting referenceYellowfin ifuse
 required. Or skip this
rsr.setPerson(ap);
 
 
//Specify which group to searchremove through the default orguser from:
 
 
AdministrationGroup group = new AdministrationGroup();
 
group.setGroupName("Test GroupAdministrators");             // this group must exist// inmust thebe specifiedan clientexisting org
user group
 
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());
}
%>

Yellowfinから既存のユーザーグループを削除するには、グループ名を提供し、こちらのwebサービスを呼び出します。

...

%>

Expand

title	ASSIGNDEFAULTDASHBOARD

こちらの関数は、特定のダッシュボードを指定したユーザーグループのデフォルトダッシュボードとして設定するために使用します。ダッシュボードを指定するためにContentResourceオブジェクト、ユーザーグループを識別するためにAdministrationGroupオブジェクトを使用します。

リクエストパラメーター

以下のパラメーターは、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「

...

ASSIGNDEFAULTDASHBOARD」に設定します。
Group	AdministrationGroup

...

	ユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
ContentResource	ContentResource[]	グループのデフォルトに設定するダッシュボードの詳細を含むオブジェクト配列です。以下の表を参照してください。

Anchor

	以下の表２３
	以下の表２３

以下は、こちらの関数のAdministrationGroupオブジェクトに設定しなくてはいけない主要なパラメーターです。

...

AdministrationGroup要素	データ型	説明
GroupName	String	デフォルトダッシュボードを設定するグループの名前です。
GroupId	Integer	ユーザーグループに一意のIDです。

Anchor

	以下の表２４
	以下の表２４

以下は、こちらの関数のContentResourceオブジェクトに設定しなくてはいけない主要なパラメーターです。

ContentResource要素	データ型	説明
ResourceId	Integer	ダッシュボードのIDです。
ResourceType	String

...

固定値「GROUP」に設定しなくてはいけません。この値が正しく設定されていない要素は無視されます。

...

リクエストの例

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。

Code Block

language	xml
theme	Eclipse

language

xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"

> <soapenv:Header/> <soapenv:Body>

>
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>

<web:remoteAdministrationCall>

   <function>ASSIGNDEFAULTDASHBOARD</function>

<arg0>

      <group>

<loginId>admin@yellowfin.com.au</loginId>

<password>test<

<groupName>Administrators</

password>

groupName>

<orgId>1<

 <groupId>11950</

orgId>

groupId>

<function>DELETEGROUP<

</

function>

group>

<group>

 <contentResources>

<groupName>Admin<

  <resourceId>61251</

groupName>

resourceId>

</group>

 <resourceType>GROUP</resourceType>
            </contentResources>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

...

応答のパラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String

...

Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

...

language

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

language	xml
theme	Eclipse

xml

<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>7b5510bf9919823f6067747b5d305984</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

...

java

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

以下は、こちらの関数の基礎的なリクエストから開始します。

こちらの関数の基礎的なリクエストから開始します。

Code Block
language java
theme Eclipse

language

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("

DELETEGROUP

ASSIGNDEFAULTDASHBOARD");

特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

AdministrationGroupオブジェクトを使用して、グループを指定します。

Code Block

language

code

java
theme Eclipse

languagejava

rsr.setOrgRef("org1");

削除するグループのパラメーターを設定します。

Code Block

theme	Eclipse
language	java

AdministrationGroup group

AdministrationGroup administrationGroup = new AdministrationGroup();
administrationGroup.setGroupName("Administrators");
administrationGroup.setGroupId(11950);

ContentResourceオブジェクトを使用して、ダッシュボードを指定します。
Code Block
language java
theme Eclipse
ContentResource dashboardContentResource = new

AdministrationGroup

ContentResource();

group

dashboardContentResource.

setGroupName("Test Group"

setResourceId(61195);

rsr

dashboardContentResource.

setGroup

setResourceType(

group

"GROUP");

リクエストの構成が完了したら、呼び出しを実行します。

こちらのオブジェクトをリクエストに設定します。

Code Block

language

code

java
theme	Eclipse

rsr.setContentResources(new ContentResource[] { dashboardContentResource });

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
language java
theme Eclipse
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、これらのパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

完成例

...

返される応答には、StatusCodeパラメーターが含まれます。より詳細な情報は、上記応答のパラメーターの表を参照してください。

完成例

以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_

...

assigndefaultdashboard.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。

...

環境に応じて、ホスト、ポート番号、管理ユーザー、削除するユーザー、グループ名を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_

...

assigndefaultdashboard.jsp」を実行します。

...

code

Code Block

language

java
theme	Eclipse

language

java

<%           
/*              ws_

deletegroup

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

s_adm

ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService",

false); // adjust host and port number

 false);
AdministrationServiceSoapBindingStub

adminService

rssbs = (AdministrationServiceSoapBindingStub)

s_adm

ts.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(new Integer(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

"ASSIGNDEFAULTDASHBOARD");
     
// This is the group
AdministrationGroup administrationGroup = new AdministrationGroup();

group

administrationGroup.setGroupName("

Test Group"

Administrators");
administrationGroup.setGroupId(11950);
     
rsr.setGroup(administrationGroup);
 
// This is the Dashboard
ContentResource dashboardContentResource =

// this group must exist in the specified client org rsr.setGroup(group); AdministrationServiceResponse rs = adminService

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

.<br>

");
} else {
    out.write("Failure");
    out.write(

" Code: " +

rs.

getErrorCode

toString());
}
%>

horizontalrule

Styleclass

Class	topLink

ページトップ

...

Content

Space Tools

Page History

Versions Compared

Old Version 2

New Version Current

Key

ユーザーロール関数

リクエスト要素

リクエストの例

応答要素

応答の例

手順

完成例

リクエスト要素

応答要素

手順

完成例

リクエスト要素

応答要素

手順

完成例

ユーザーグループ関数

ユーザーグループ関数

リクエスト要素

応答要素

手順

完成例

リクエスト要素

応答の要素

手順

完成例

リクエスト要素

リクエストの例

応答の要素

手順

応答要素

応答の例

完成例

リクエスト要素

応答の要素

手順

完成例

手順

完成例

リクエスト要素

応答の要素

リクエスト要素

応答の要素

手順

完成例

リクエスト要素

応答の要素

手順

完成例

リクエスト要素

応答の要素

手順

完成例

リクエストパラメーター

応答のパラメーター

手順

完成例

リクエストパラメーター

応答のパラメーター

手順

完成例

リクエストパラメーター

応答のパラメーター

手順

完成例

リクエストパラメーター

応答のパラメーター

手順

完成例

リクエストパラメーター

応答のパラメーター

手順

完成例

リクエストパラメーター