Page History

Versions Compared

Old Version 1

changes.mady.by.user Yellowfin Admin

Saved on Mar 26, 2018

compared with

New Version 2

changes.mady.by.user Yellowfin Admin

Saved on Mar 27, 2018

Key

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

...

Expand

title	LISTROLES

こちらの関数は、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の例は、この呼び出しに渡すことのできるパラメーターを表示しています。

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

SUCCESS
FAILURE

Roles

AdministrationRole[]

ロールの一覧です。

応答の例

サービスは、今回の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>
            <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

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);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Roles

AdministrationRole[]

ロールの一覧です。

完成例

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

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

Code Block

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（読み取り）を設定　しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ関数は上書きされます。

リクエスト要素

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

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

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

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

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

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

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

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>SAVEROLE</function>
            <role>
                <roleCode>REPORTWRITER</roleCode>
                <roleName>Report Content Writer</roleName>
                <roleDescription>This role can generate reports.</roleDescription>
                <functions>
                    <functionCode>MIREPORT</functionCode>
                    <accessLevelCode>R</accessLevelCode>
                </functions>
            </role>                          
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答要素

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

応答要素

データ型

説明

StatusCode

String

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

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>
            <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の例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

ap[1] = new AdministrationPerson(); ap[1].setUserId("user2@yellowfin.com.au"); ap[1].setFirstName("user2"); ap[1].setLastName("Lastname2"); ap[1].setRoleCode("YFREPORTCONSUMER"

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("SAVEROLE");

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

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

Code Block

theme	Eclipse
language	java

AdministrationPerson[] ap = new AdministrationPerson[2];

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

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

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

既存のロールを変更する場合でもロール名は必須です。ロール名を指定しない場合、呼び出しはこれを空白に設定します。これらの必須パラメーターを提供することで、最初のユーザーの詳細を追加します。：UserId、FirstName、LastName、RoleCode、Password、EmailAddress

Code Block

theme	Eclipse
language	java

ap[0] = new AdministrationPerson(role.setRoleName("New Role");
ap[0].setUserId("user1@yellowfin.com.au");        
ap[0].setFirstName("user1");
ap[0].setLastName("Lastname1");
ap[0].setRoleCode("YFREPORTCONSUMER");         
ap[0].setPassword("test");                                
ap[0].setEmailAddress("user1@yellowfin.com.au");

AdministrationPersonオブジェクトのその他のパラメーターの設定はオプションです。

同様に、他のユーザーの詳細を提供します。

Code Block

theme	Eclipse
language	java

role.setRoleDescription("testing");

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

Code Block

theme	Eclipse
language	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);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

完成例

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

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

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

<%

);

ap[1].setPassword("test");

/*              ws_saverole.jsp               */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8"

ap[1].setEmailAddress("user2@yellowfin.com.au");

これを、必要なユーザー分繰り返します。

リクエストに「ap」オブジェクトを渡します。

Code Block

language	java

rsr.setPeople(ap);

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

Code Block

language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

完成例

以下は、ADDUSERS関数の完成例です。今回の例では、デフォルト組織に、user1@yellowfin.com.auとuser2@yellowfin.com.auという2つの新規ユーザーを追加します。

こちらを使用するには、以下の手順に従います。

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

<% %>
<%@ 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  ws_addusers.jspAdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web */
%>
 
 
<%@ 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);services admin account
rsr.setPassword("test");                           // adjustchange hostto andthe portpassword number
of 
AdministrationServiceSoapBindingStubthe adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest(account above
rsr.setOrgId(1);
 
rsr.setLoginIdsetFunction("admin@yellowfin.com.auSAVEROLE");          
 
//define provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("ADDUSERSa role:
AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
role.setRoleName("New Role");
role.setRoleDescription("testing");
 
AdministrationPersonAdministrationFunction[] apf = new AdministrationPersonAdministrationFunction[2];
 
apf[0] = new AdministrationPersonAdministrationFunction();
apf[0].setUserIdsetFunctionCode("user1@yellowfin.com.auMIREPORT");           // mandatory
apf[0].setFirstNamesetAccessLevelCode("user1R");
ap 
f[0].setLastName("Lastname1"1] = new AdministrationFunction();
apf[01].setRoleCodesetFunctionCode("YFREPORTCONSUMERACTIVITYSTREAM");              
apf[01].setPasswordsetAccessLevelCode("testCRUD");
 
 
//Feed the security functions to the                         
ap[0].setEmailAddress("user1@yellowfin.com.au");
 
ap[1] = new AdministrationPerson();
ap[1].setUserId("user2@yellowfin.com.au");        
ap[1].setFirstName("user2");
ap[1].setLastName("Lastname2");
ap[1].setRoleCode("YFREPORTCONSUMER");         
ap[1].setPassword("test");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());
}
%>                                
ap[1].setEmailAddress("user2@yellowfin.com.au");
 
 
rsr.setPeople(ap);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if
("SUCCESS".equals(rs.getStatusCode() ) ) {
    out.write("Success");
} else {
    out.write("Failure");
out.write("Code: " + rs.getErrorCode() );
}
%>

Expand

title	ADDUSERSIGNOREDUPLICATES

以下は、新規ユーザーを作成するために、「AdministrationPerson」オブジェクトに設定しなくてはいけない必須のパラメーターです。

Expand

title	DELETEROLE

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

リクエスト要素

こちらの関数は、重複を追加することなく、一度に複数のユーザーを作成します。ADDUSERS関数と同様に機能しますが、作成しようとしているユーザーのログインIDや電子メールアドレスが既に使用されていたり、パスワードが提供されない場合は、「例外なし」エラーが発生し、ユーザーは作成されません。応答には、追加されなかったユーザーとともに、AdministrationPersonオブジェクトが含まれます。

リクエストパラメーター

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

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

クライアント組織内部参照IDです（こちらの設定はオプションです）。こちらは、参照されるクライアント組織に新規ユーザーを作成します。こちらを設定しない場合、新規ユーザーはデフォルト（プライマリー）組織内に作成されます。

UserId

AdministrationRole 要素	AdministrationPerson 要素	データ型	説明	String	新規ユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。
Password	String	新規ユーザーのパスワードです。こちらは、Yellowfinのパスワードポリシーに準拠する必要があります。
FirstName	String	新規ユーザーの名です。
LastName	String	新規ユーザーの姓です。
RoleCode	String	新規ユーザーのロールを設定します。例：YFREPORTCONSUMER 注意：リポジトリデータベースから、Yellowfinのロールコードの一覧を取得することができます。例：SQLクエリーを使用する場合：SELECT * FROM OrgRole
EmailAddress	String	新規ユーザーの電子メールアドレスです。

応答パラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

People

AdministrationPerson[]

アカウントが作成されなかったユーザーです。

手順

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

削除される既存のロールの内部コードを指定します。

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

こちらは、Yellowfinの新規ユーザーを作成する基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
java特定のクライアント組織に新規ユーザーを作成する場合は、こちらをコードに追加します。

Expand

title	詳細手順

Code Block

language
theme	Eclipse

xml

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

Code Block

theme	Eclipse
language	java

rsr.setOrgRef("org1");

orgRefパラメーターを定義しない場合は、新規ユーザーはデフォルト（プライマリー）組織内に作成されます。

新規Yellowfinユーザーの詳細を定義するために、AdministrationPersonオブジェクトを使用します。

Code Block

theme	Eclipse
language	java

AdministrationPerson[] ap = new AdministrationPerson[2];

これらの必須パラメーターを提供することで、最初のユーザーの詳細を追加します。：UserId、FirstName、LastName、RoleCode、Password、EmailAddress
Code Block

theme	Eclipse
language	java

ap[0] = new AdministrationPerson(); ap[0].setUserId("user1@yellowfin.com.au");

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

ap[0].setFirstName("user1"); ap[0].setLastName("Lastname1"); ap[0].setRoleCode("YFREPORTCONSUMER");

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

ap[0].setPassword("test");

<password>test</password>
            <orgId>1</orgId>
            <function>DELETEROLE</function>

ap[0].setEmailAddress("user1@yellowfin.com.au");

AdministrationPersonオブジェクトのその他のパラメーターの設定はオプションです。

同様に、他のユーザーの詳細を提供します。

Code Block

theme	Eclipse
language	java

ap[1] = new AdministrationPerson(); ap[1].setUserId("user2@yellowfin.com.au");

<role>

ap[1].setFirstName("user2"); ap[1].setLastName("Lastname2"); ap[1].setRoleCode("YFREPORTCONSUMER");

<roleCode>REPORTWRITER</roleCode>
            </role>

ap[1].setPassword("test");

              
         </arg0>
      </web:remoteAdministrationCall>

ap[1].setEmailAddress("user2@yellowfin.com.au");

これを、必要なユーザー分繰り返します。

リクエストに「ap」オブジェクトを渡します。

Code Block

language	java

rsr.setPeople(ap);

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

Code Block

language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

追加されなかったユーザーを取得するには、こちらのコマンドを使用します。

</soapenv:Body>
</soapenv:Envelope>

応答要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

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

Code Block

language
theme	Eclipse

java

AdministrationPerson[] failed_users = rs.getPeople();

Expand

title	DELUSER / DELETEUSER

xml

<S

こちらの関数は、指定されたユーザーをYellowfinから削除します。注意：クライアント組織からユーザーを削除するには、「REMOVEUSERACCESS」の呼び出しを実行します。

リクエスト要素

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

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

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

AdministrationPerson 要素

データ型

説明

UserId

String

削除するユーザーのユーザーIDです。こちらのユーザーは、既にYellowfinインスタンス内に存在していなくてはいけません。

これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

リクエストの例

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

Code Block

theme	Eclipse
language	xml

<soapenv:Envelope xmlns:soapenvS="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:webns2="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
      <soapenv:Body><return>
      <web:remoteAdministrationCall>
      <errorCode>0</errorCode>
   <arg0>
         <messages>Successfully Authenticated User: <loginId>admin@yellowfinadmin@yellowfin.com.au</loginId>messages>
            <password>test</password><messages>Web Service Request Complete</messages>
            <orgId>1</orgId><roles>
            <function>DELETEUSER</function>       <roleCode>REPORTWRITER</roleCode>
            <person></roles>
                <userId>binish.sheikh@yellowfin.com.au</userId><sessionId>6c494a263bb684c1082317d0e1d695eb</sessionId>
            </person>         <statusCode>SUCCESS</statusCode>
         </arg0>return>
      </webns2:remoteAdministrationCall>remoteAdministrationCallResponse>
   </soapenvS:Body>
</soapenvS:Envelope>

応答要素

手順

返される応答には、これらのパラメーターが含まれます。Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

応答要素

Expand

データ型

title

説明

応答の例

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

詳細手順

StatusCode

String

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

SUCCESS
FAILURE

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

Code Block
theme Eclipse
language

xml

java

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

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

Code Block

theme	Eclipse
language	java

AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">

<errorCode>0<

errorCode>

 existing role. Role Codes can be found by calling LISTROLES

<messages>Successfully

Authenticated

User:

admin@yellowfin.com.au</messages>

<messages>Web

Service

Request

Complete</messages>

<statusCode>SUCCESS</statusCode>

// or retrieved

</return>

from the Yellowfin database

</ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>

手順

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

Expand

title	詳細手順

table OrgRole. rsr.setRole(role);

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

返される応答には、StatusCodeとPeopleパラメーターが含まれます。詳細については、上記の応答パラメーターの表を参照してください。
応答要素 データ型 説明
StatusCode
String
Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

完成例

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

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

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

Code Block
theme Eclipse
language java

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

関数は、削除するユーザーの指定に使用するAdministrationPersonオブジェクトを要求するので、ID（例：電子メールアドレスや、その他タイプのIDなど、ログインID方法に応じたID）を提供します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test@yellowfin.com.au");

<%           
/*              ws_deleterole.jsp                  */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@

// test@yellowfin.com.au should be an existing Yellowfin user. rsr.setPerson(ap);

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

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<% /* ws_deleteuser.jsp

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");

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

// provide your Yellowfin webservices admin account
rsr.setPassword("test");

adjust

change

host

and

port

password

number

AdministrationServiceSoapBindingStub

adminService

above

account above rsr.setOrgId(

AdministrationServiceSoapBindingStub

s_adm.getAdministrationService(

; rsr.setFunction("DELETEROLE");

AdministrationServiceRequest

AdministrationRole

rsr

role = new

AdministrationServiceRequest

AdministrationRole();

role.setRoleCode("NEWROLE"); rsr.

setLoginId("admin@yellowfin.com.au"

setRole(role);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {

provide

your Yellowfin web services admin account rsr.setPassword("test

 out.write("Success");
} else {
    out.write("Failure");
    out.write(" Code:

// change to the password of the above account rsr.setOrgId(1); rsr.setFunction("DELETEUSER"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode() ) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode() ); } %>

ユーザー情報の取得と検証

ユーザー作成後は、Webサービスの呼び出しを使用してユーザーの詳細を取得することができます。「AdministrationPerson」オブジェクトのUser IDフィールドは、ユーザーを識別するために使用されます。結果として、投入された「AdministrationPerson」オブジェクトが返されます。セキュリティ上の理由からパスワードは返されず、「NULL」になります。ユーザー情報は、こちらの項目内のアプリケーションに照らし合わせて検証することもできます。

" + rs.getErrorCode()); } %>

ユーザーグループ関数

ユーザーグループに関連するwebサービスは、以下のように定義されます。

Expand

title	LISTGROUPS

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

Expand

title	GETUSER

こちらの関数は、既存のYellowfinユーザーの詳細を取得します。これは、AdministrationPersonオブジェクトを、ユーザーの識別に使用できるパラメーターとして受け付けます。応答には、ユーザー詳細のすべてが含まれたAdministrationPersonオブジェクトが含まれます。

リクエスト要素

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

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

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

AdministrationPerson要素	データ型	説明
UserId	String	情報が取得されるユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

リクエストの例

特定のクライアントに所属するグループの一覧を取得する場合は、クライアント組織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>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSER<<function>LISTGROUPS</function>       
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>         
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

応答要素

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

AdministrationPersonユーザー詳細を含むオブジェクトです。

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

Groups

AdministrationGroup[]

グループの一覧です。

応答の例

サービスは、今回の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>
            <groups>
     <messages>Successfully  Authenticated User: admin@yellowfin.com.au</messages>
      <groupDescription>This group contains all users with <messages>Gettingthe userAdmin information.role..</messages>groupDescription>
            <messages>Getting  user information...</messages><groupId>11950</groupId>
            <messages>Web Service Request Complete</messages>
<groupMembers>
                 <person> <internalId>5</internalId>
               <emailAddress>admin@yellowfin   <loginId>admin@yellowfin.com.au</emailAddress>loginId>
               <firstName>System<</firstName>groupMembers>
               <initial/>
<groupMembers>
                  <ipId>5<<internalId>13000</ipId>internalId>
                 <languageCode>EN</languageCode> <loginId>binish.sheikh@yellowfin.com.au</loginId>
               <lastName>Administrator<</lastName>groupMembers>
               <roleCode>YFADMIN<<groupName>Administrators</roleCode>groupName>
               <salutationCode/></groups>
            <messages>Successfully Authenticated  <status>ACTIVE</status>User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request <timeZoneCode>AUSTRALIAComplete</SYDNEY</timeZoneCode>messages>
               <userId>admin@yellowfin.com.au</userId><sessionId>79d937ead121745d93289f287d55b0ac</sessionId>
            </person>
            <sessionId>70dc3c7158a340e19b590f0ed6ea6a8b</sessionId><statusCode>SUCCESS</statusCode>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

以下は、こちらの関数の基礎的な呼び出しです。こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

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

AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。特定のクライアントのグループの一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー組織）のグループが表示されます）
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); rsr.setPerson(ap);rsr.setOrgRef("org1");
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。
応答には、これらのパラメーターが含まれます。
応答要素データ型説明
StatusCode
String
Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
SUCCESS
FAILURE

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

取得したユーザーの詳細を表示するには、以下の例を使用します。

Groups AdministrationGroup[] グループの一覧です。

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

完成例

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

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

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

if ("SUCCESS".equals(rs.getStatusCode()) ) {

<%

rs.getPerson();

/*

out.write("UserId:"

ap.getUserId()

" ");

out.write("Password:"

ap.getPassword() + " ");

ws_listgroups.jsp

out.write("FirstName:"

ap.getFirstName()

" ");

out.write("LastName:"

+ ap.getLastName() + " "); out.write("Initial:" + ap.getInitial() + " "); out.write("SalutationCode:" + ap.getSalutationCode() + " "); out.write("RoleCode:" + ap.getRoleCode() + " "); out.write("EmailAddress:" + ap.getEmailAddress() + " "); out.write("LanguageCode:" + ap.getLanguageCode() + " "); out.write("IpId:" + ap.getIpId() + " "); out.write("TimeZoneCode:" + ap.getTimeZoneCode() + " "); out.write("Status:" + ap.getStatus() + " "); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }

完成例

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

コードをコピーして、「ws_getuser.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じた詳細を追加するために、ホスト、ポート番号、管理ユーザー、ユーザーを調整します。
インターネットブラウザから、「http://<host>:<port>/ws_getuser.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");           
/*              ws_getuser.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");// 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());
     // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("GETUSER");
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    ap = rs.getPerson();
 out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
 
 
        // uncomment to display the members:
        /*
        out.write("User<br>Members:<br>Login Id:" + ap.getUserId() +| Internal Id "<br>");
    out.write("Password:" + ap.getPassword() + "<br>");
    for (AdministrationGroupMember member: group.getGroupMembers()){
            out.write("First Name:<br>" + apmember.getFirstNamegetLoginId() + "<br>");
 | " + outmember.write("Last Name:" + ap.getLastName() + "<br>"getInternalId() );
    out.write("Initial:" + ap.getInitial() + "<br>");}
    out.write("Salutation Code:" + ap.getSalutationCode() + "<br>"); */
    out.write("Role Code:" + ap.getRoleCode() + "<br>");}
} else {
    out.write("Email Address:" + ap.getEmailAddress() + "<br>")Failure");
    out.write("Language Code: " + aprs.getLanguageCodegetErrorCode() + "<br>");
    out.write("IpId:" + ap.getIpId() + "<br>");
    out.write("Time Zone Code:" + ap.getTimeZoneCode() + "<br>");
    out.write("Status:" + ap.getStatus() + "<br>");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
}
%>

こちらは、すべてのユーザーを取得するリクエストの例であり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Expand

title	GETALLUSERS	GETGROUP

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

こちらの関数は、指定されたクライアント組織内の、すべてのユーザーの詳細を取得します。情報は、AdministrationPersonオブジェクトの配列で取得されます。クライアント組織を指定しない場合は、すべてのユーザーが取得されます。取得するユーザーの検索基準を指定するために、「setParameters()」メソッドを使用することができます。セキュリティ上の理由からパスワードは返されず、「NULL」になります。

リクエスト要素

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

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

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

クライアント組織内部参照IDです（こちらの設定はオプションです）。こちらを設定しない場合は、すべてのクライアント組織が検索されます。

AdministrationGroup要素	データ型	説明
GroupName	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>GETALLUSERS<<function>GETGROUP</function>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

People

AdministrationPerson

ユーザー詳細を含むオブジェクトの配列です。

応答の例

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

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><group>
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <people>
               <firstName>System</firstName>
               <ipId>5</ipId>
               <lastName>Administrator</lastName>
               <userId>admin@yellowfin.com.au</userId>
            </people>
            <sessionId>2c32528279baa26b730f9e3c8787880d</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </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("GETALLUSERS");

クライアント組織を指定しない場合は、すべてのクライアント組織が検索されます。
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1");
検索基準：GETALLUSERS関数は、2つの文字列の配列を受け付けます。最初の配列（searchingCriteria[0]）は、「%John%」のような条件を使用して、Yellowfinデータベースユーザーの名、姓、電子メールの@よりも左側、または右側と比較されます。次の配列（seachingCriteria[1]）は、Yellowfinデータベースユーザーの電子メール右側（ドメイン）と比較されます。
Code Block
theme Eclipse
language java
String[] searchingCriteria = new String[] {"John","yellowfin.com.au"}; rsr.setParameters(searchingCriteria);
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_getallusers.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");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETALLUSERS");
 
rsr.setOrgRef("org1");
 
String[] searchingCriteria = new String[] {"John","yellowfin.com.au"};
rsr.setParameters(searchingCriteria);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success. " + rs.getPeople().length + " people found.");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	GETUSERBYIP

こちらの関数は、IPを使用して、ユーザーの詳細を取得します。関数は、IPID（Yellowfinリポジトリデータベース内で、これはPersonテーブルのIpIdフィールドになります）を提供することで、ユーザー指定に使用するためのAdministrationPersonオブジェクトを、パラメーターとして受け付けます。応答には、すべてのユーザー詳細を含むAdministrationPersonオブジェクトが含まれます。

リクエスト要素

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

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

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

AdministrationPerson要素	データ型	説明
IpId	Integer\|	情報が取得されるユーザーのIP 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>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETUSERBYIP</function>
          <person>
                <ipId>5</ipId>
            </person>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

ユーザー詳細を含むオブジェクトです。

応答の例

サービスは、今回の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>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person>
               <emailAddress>admin@yellowfin.com.au</emailAddress>
               <firstName>System</firstName>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>
            </person>
            <sessionId>81e76f1222d0dd12d9871efc7cbf0811</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

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

IpIdを提供し、詳細を取得するユーザーを識別するために、AdministrationPersonオブジェクトを使用します。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setIpId(5); //IpId of the admin@yellowfin.com.au account rsr.setPerson(ap);
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

この呼び出しの結果を表示するには、以下の例を使用します。

Code Block

theme	Eclipse
language	java

if ("SUCCESS".equals(rs.getStatusCode()) ) {
    ap = rs.getPerson();
    out.write("UserId: " + ap.getUserId() + "<br>");
    out.write("Password: " + ap.getPassword() + "<br>");
    out.write("FirstName: " + ap.getFirstName() + "<br>");
    out.write("LastName: " + ap.getLastName() + "<br>");
    out.write("Initial: " + ap.getInitial() + "<br>");
    out.write("SalutationCode: " + ap.getSalutationCode() + "<br>");
    out.write("RoleCode: " + ap.getRoleCode() + "<br>");
    out.write("EmailAddress: " + ap.getEmailAddress() + "<br>");
    out.write("LanguageCode: " + ap.getLanguageCode() + "<br>");
    out.write("IpId: " + ap.getIpId() + "<br>");
    out.write("TimeZoneCode: " + ap.getTimeZoneCode() + "<br>");
    out.write("Status: " + ap.getStatus() + "<br>");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_getuserbyip.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("GETUSERBYIP");
 
AdministrationPerson ap = new AdministrationPerson();
 
ap.setIpId(5);
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    ap = rs.getPerson();
    out.write("User Id: " + ap.getUserId() + "<br>");
    out.write("Password: " + ap.getPassword() + "<br>");
    out.write("First Name: " + ap.getFirstName() + "<br>");
    out.write("Last Name: " + ap.getLastName() + "<br>");
    out.write("Initial: " + ap.getInitial() + "<br>");
    out.write("Salutation Code: " + ap.getSalutationCode() + "<br>");
    out.write("Role Code: " + ap.getRoleCode() + "<br>");
    out.write("Email Address: " + ap.getEmailAddress() + "<br>");
    out.write("Language Code: " + ap.getLanguageCode() + "<br>");
    out.write("IpId: " + ap.getIpId() + "<br>");
    out.write("Time Zone Code: " + ap.getTimeZoneCode() + "<br>");
    out.write("Status: " + ap.getStatus() + "<br>");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	GETAVATARS

こちらのWebサービスは、ユーザーのプロフィール画像を取得するために使用されます。ユーザーがYellowfinにプロフィール画像を設定していない場合は、画像は取得されません。こちらのサービスは、ユーザーの内部ID（IP ID）を要求します。

リクエストパラメーター

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

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

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

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>GETAVATARS</function>
            <parameters>5</parameters>
         </arg0>
    </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答のパラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

binaryAttachments

ReportBinaryObject[]

指定したユーザーのプロフィール画像を含みます。

応答の例

サービスは、今回の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>
            <binaryAttachments>
               <data>iVBORw0KGgoAAAANSUhEUgAAA ... your image string</data>
            </binaryAttachments>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>5547ebe153fd0fc7fcf63014ffe61b5c</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

Code Block

theme	Eclipse
language	java

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

ユーザーのIP IDを指定することができます。
Code Block
theme Eclipse
language java
rsr.setParameters(new String[] {"5","13073"});
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

応答には、StatusCode要素と、BinaryAttachment配列が含まれます。

最初の画像を取得するためには、以下を使用します。

Code Block

theme	Eclipse
language	java

byte[] data = response.getBinaryAttachments[0].getData();

完成例

以下は、Webサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_getavatars.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.*" %>
<html>
<body>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set to the password of the above account
rsr.setOrgId(1);
 
rsr.setFunction("GETAVATARS");
rsr.setParameters(new String[] {"5","13073"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    ReportBinaryObject[] objects = rs.getBinaryAttachments();
    if (objects != null) {
        byte[] data,encodeBase64;
        String base64Encoded;
 
        for(ReportBinaryObject o: objects){
            data = o.getData();
            if (data != null){
 
                encodeBase64 = java.util.Base64.getEncoder().encode(data);
                base64Encoded = new String(encodeBase64, "UTF-8");
                if (base64Encoded != null) 
                    out.write("<br>");
                %>
                <img src="data:image/jpg;base64,<%=base64Encoded%>" alt="No image">
                <%
            }
        }
    }
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>
</body>
</html>

Expand

title	VALIDATEUSER

こちらの関数は、Yellowfinのユーザーを検証します。AdministrationPersonオブジェクトをパラメーターに使用して、ユーザーを指定することができます。

提供された詳細を持つユーザーが存在する場合、応答はSUCCESSを返します。ユーザーが有効でない場合は、コード25（COULD_NOT_AUTHENTICATE_USER）が応答に返されます。

リクエストの要素

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

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

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

AdministrationPerson要素	データ型	説明
User ID	String	検証するユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	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>VALIDATEUSER</function>
          <person>
                <userId>admin@yellowfin.com.au</userId>
                <password>test</password>
            </person>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

ユーザー詳細を含むオブジェクトです。

応答の例

サービスは、今回の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>
            <person>
               <ipId>5</ipId>
               <userId>admin@yellowfin.com.au</userId>
            </person>
            <sessionId>0ee8ae23d21ff01f365d1e03ea49c47a</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

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

AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson();

ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test");

rsr.setPerson(ap);

特定の組織のユーザーの検証が必要な場合は、クライアント組織参照IDを提供します。
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1");
OrgRefパラメーターが省略された場合、ユーザーはデフォルト（プライマリー）組織に対して検証されます。

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_validateuser.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("VALIDATEUSER");
 
AdministrationPerson ap = new AdministrationPerson();
 
ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test");
 
rsr.setPerson(ap);
rsr.setOrgRef("org1");
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("User is authenticated");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	VALIDATEPASSWORD

こちらの呼び出しは、ユーザーのパスワードを検証します。パスワードの有効期限が切れている場合、StatusCodeとしてSUCCESSを返します。それ以外の場合は、FAILUREを返します。

Yellowfinにログインをしていない新規ユーザーの場合は、パスワードの有効期限が切れているため、呼び出しはSUCCESSを取得します。これは、新規ユーザーの初回ログイン時に、Yellowfinはパスワードのリセットを要求するからです。

リクエストの要素

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

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

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

AdministrationPerson要素	データ型	説明
UserId	String	パスワードが検証されるユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	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>VALIDATEPASSWORD</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>
                <password>test</password>
            </person>
         </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>fb024963bdc94034557f95b01f53a138</sessionId>
            <statusCode>FAILURE</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

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

AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test");
 
rsr.setPerson(ap);

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_validatepwd.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("VALIDATEPASSWORD");
 
AdministrationPerson ap = new AdministrationPerson();
 
ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test");
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Password is expired");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

ユーザー情報の操作

ユーザーの詳細は、Webサービスの呼び出しを使用して、後から変更することができます。AdministrationPersonオブジェクトのUser IDフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクトのその他のフィールドには、新しい変更内容が投入されます。

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Expand

title	CHANGEPASSWORD

こちらの関数は、指定したYellowfinユーザーのパスワードを変更します。パスワードは、ユーザーID（ログインIDの方法に応じて、電子メールアドレス、またはその他のタイプのIDになります。）をもとに、AdministrationPersonパラメーターを通してリセットされます。

リクエストの要素

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

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

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

AdministrationPerson要素	データ型	説明
UserId	String	パスワードを変更するユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	String	ユーザーの新規パスワードです。これは、Yellowfinのパスワードポリシーに準拠していなくてはいけません。

リクエストの例

以下の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>CHANGEPASSWORD</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>
                <password>test321</password>
            </person>
         </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>f6bdc33348cd76d7898f3bed3e54ff31</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </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("CHANGEPASSWORD");

AdministrationPersonオブジェクトを使用して、ユーザーを指定します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson();
 
ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test123");
rsr.setPerson(ap);

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%<groupName>Administrators</groupName>
            
</*group>              ws_changepwd.jsp     
         *</arg0>
%>
<%@ 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); </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Group

AdministrationGroup[]

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

サービスは、今回の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>
 adjust host and port number
 
 
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au"); <errorCode>0</errorCode>
           // provide your Yellowfin web services admin account
rsr.setPassword("test"); <group>
               <groupDescription>This group contains all users with the Admin role.</groupDescription>
       // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("CHANGEPASSWORD");
 
AdministrationPerson ap = new AdministrationPerson();
 
ap.setUserId("john.smith@yellowfin.com.au");
ap.setPassword("test123");
 
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Password is reset");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	RESETPASSWORD

こちらの関数は、ユーザーのYellowfinアカウントをリセットし、パスワードを変更するよう要求します。この呼び出しがアカウントのパスワードを変更するのではありません。パスワードを変更するには、CHANGEPASSWORD関数を使用します。

リクエストの要素

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

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

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

AdministrationPerson要素	データ型	説明
UserId	String	パスワードをリセットするユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	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>
<groupId>11950</groupId>
               <groupMembers>
                  <internalId>5</internalId>
                  <loginId>admin@yellowfin.com.au</loginId>
               </groupMembers>
               <groupMembers>
                  <arg0><internalId>13000</internalId>
            <loginId>admin@yellowfin      <loginId>binish.sheikh@yellowfin.com.au</loginId>
            <password>test321</password>
   </groupMembers>
               <orgId>1<<groupName>Administrators</orgId>groupName>
             <function>RESETPASSWD<  <groupStatus>OPEN</function>groupStatus>
            <person></group>
            <messages>Successfully Authenticated User:  <userId>admin@yellowfinadmin@yellowfin.com.au</userId>messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>54c5cf263f323b439c5834d1f6d8b645</sessionId>
            <statusCode>SUCCESS</statusCode>
    <password>test321</password>
     </return>
       </person>ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

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

</arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>

応答の要素

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

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

特定のクライアント組織のグループ一覧を取得する場合は、クライアント組織IDを含めます。（こちらを指定しない場合は、デフォルト（プライマリー組織）組織のグループが表示されます）
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1");
メンバーを取得するためにユーザーグループの名前を提供します。
Code Block
theme Eclipse
language java
AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Administrators"); rsr.setGroup(group);
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

応答の例

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

Group
AdministrationGroup[]
メンバーの一覧を含むグループの詳細です。
メンバーを取得するためには、以下を使用します。

Code Block
theme Eclipse
language

xml

java

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%<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>
      ws_getgroup.jsp      <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
          */
%>
<%@ page <messages>Web Service Request Complete</messages>
            <sessionId>beabd94a9ffaa562a8b9ba823fc291a0</sessionId>
            <statusCode>SUCCESS</statusCode>
 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);        <//return>
 adjust host and port  </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

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

RESETPASSWD

GETGROUP");

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

Expand

title	詳細手順

Code Block

theme	Eclipse
language	java

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

完成例

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

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

<%      
 
//rsr.setOrgRef("org1");     
/*              ws_ resetpwd.jsp     // provide org reference ID if required. Default org will be searched otherwise
 */
%>
<%@AdministrationGroup pagegroup 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("RESETPASSWD");
 
AdministrationPerson ap = new AdministrationPerson();
 
ap.setUserId("john.smith@yellowfin.com.au");
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Account is reset");= new AdministrationGroup();
group.setGroupName("Administrators");
rsr.setGroup(group);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success.<br>");
    group = rs.getGroup();
     
    out.write("<br>");
    out.write("<br>Group Name: " + group.getGroupName());
    out.write("<br>Group Id: " + group.getGroupId());
    out.write("<br>Group Description: " + group.getGroupDescription());
    out.write("<br>Group Status: " + group.getGroupStatus());
    out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
 
 
    // display the members:
    out.write("<br>Members:<br>Login Id | Internal Id ");
    for (AdministrationGroupMember member: group.getGroupMembers()){
        out.write("<br>" + member.getLoginId() + " | "  + member.getInternalId() );
    }
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	UPDATEUSERCREATEGROUP

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

こちら呼び出しは、ユーザーの詳細を編集します。これは、ユーザーID（例：ログインID方法に応じて、電子メールアドレス、または他のタイプのIDになります）を提供することで、ユーザーの識別に使用することのできるAdministrationPersonオブジェクトをパラメーターとして受け付けます。

応答には、すべてのユーザー詳細を含むAdministrationPersonオブジェクトが含まれます。

注意：この呼び出しがアカウントのパスワードを変更するのではありません。パスワードを変更するには、CHANGEPASSWORD関数を使用します。

リクエストの要素

リクエスト要素

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

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

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

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

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

AdministrationPerson要素更新しなくてはいけないユーザーの詳細に関連する任意のパラメーターを提供することができます。例えば、新しい名や、更新が必要なステータスなどです。

AdministrationGroup要素		データ型	説明
UserIdGroupName	String	新規グループの名前です。
GroupMembers	AdministrationGroupMember詳細を変更するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。	グループメンバーの詳細を提供するために使用されるオブジェクトです。以下の表を参照してください。

リクエストの例

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

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

以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。今回は、ユーザーのステータスを「無効（Inactive）」にする例を示しています。

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>
            <arg0><function>CREATEGROUP</function>
            <loginId>admin@yellowfin.com.au</loginId>
<group>
                <password>test<<groupName>Supervisors</password>groupName>
            <orgId>1</orgId>    <groupMembers>
            <function>UPDATEUSER</function>
        <loginId>admin@yellowfin.com.au</loginId>
    <person>
                <userId>binish<loginId>binish.sheikh@yellowfin.com.au</userId>loginId>
                <status>ACTIVE<</status>groupMembers>
            </person>group>                   
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

更新されたユーザーの詳細を含むオブジェクトです。

応答の例

サービスは、今回の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>
     <return>       <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>b1f1b17d503e1e11c05b72e674bc80ec</sessionId>
            <errorCode>0<<statusCode>SUCCESS</errorCode>statusCode>
         </return>
   <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> </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("CREATEGROUP");

特定のクライアントに新規グループを追加する場合は、クライアント組織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[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

<%    <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person>
               <emailAddress>binish.sheikh@yellowfin.com.au</emailAddress>
               <firstName>Binish</firstName>
               <ipId>13000</ipId>
            
/*   <lastName>Sheikh</lastName>
            ws_creategroup.jsp   <roleCode>YFADMIN</roleCode>
               <status>ACTIVE<*/status>
%>
<%@ page language="java" contentType="text/html;            <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode>
               <userId>binish.sheikh@yellowfin.com.au</userId>
            </person>
            <sessionId>586e172a7c4850bb3edbaaf5264a312d</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

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("UPDATEUSER");

詳細が更新されるユーザーを識別するために、AdministrationPersonオブジェクトを使用します。

AdministrationPerson ap = new AdministrationPerson(

setOrgId(1);

rsr.

setUserId

setFunction("

john.smith@yellowfin.com.au

CREATEGROUP");

変更する詳細を指定します。例えば、ユーザーアカウントを無効（Inactive）にすることができます。

Expand

title	詳細手順

Code Block

theme	Eclipse
language	java

こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

ap.setStatus("INACTIVE");               // This shows that the user "john.smith@yellowfin.com.au" will not be able to log in
 
rsr.setPerson(ap);

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

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

完成例

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

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

<%   
 
//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");        
/*             ws_updateuser.jsp     // mandatory. Other parameters are optional.
 */
%>
<%@ page language="java" contentType="text/html; charset=UTF-
//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() );
}
%>

管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

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>
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");                     <arg0>
      // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("UPDATEUSER");
 
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");
ap.setStutus("INACTIVE");
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    ap = rs.getPerson();
    out.write("User Id: " + ap.getUserId() + "<br>");
    out.write("Password: " + ap.getPassword() + "<br>");
    out.write("First Name: " + ap.getFirstName() + "<br>");
    out.write("Last Name: " + ap.getLastName() + "<br>");
    out.write("Initial: " + ap.getInitial() + "<br>");
    out.write("Salutation Code: " + ap.getSalutationCode() + "<br>");
    out.write("Role Code: " + ap.getRoleCode() + "<br>");
    out.write("Email Address: " + ap.getEmailAddress() + "<br>");
    out.write("Language Code: " + ap.getLanguageCode() + "<br>");
    out.write("IpId: " + ap.getIpId() + "<br>");
    out.write("Time Zone Code: " + ap.getTimeZoneCode() + "<br>");
    out.write("Status: " + ap.getStatus() + "<br>");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

Expand

title	SETAVATARIMAGE

 <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の例に基づき、以下の応答を返します。

こちらのWebサービスは、指定したユーザーのプロフィール画像をアップロードするために使用されます。画像は、文字列値に変換可能な、UTF-8のバイト配列でなければいけません。

リクエストの要素

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

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「SETAVATARIMAGE」に設定します。
Person	AdninistrationPerson	プロフィール画像を変更するユーザーの詳細を含むオブジェクトです。注意：以下の表を参照してください。
Parameters	String[]	アップロードされるプロフィールど画像を表示する単一要素を含む配列です。画像は、文字列に変換可能な、UTF-8形式のバイト配列でなければいけません。

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

AdministrationPerson要素	データ型	説明
IpId	Integer	ユーザーの内部Yellowfin IP IDを提供します。値は、YellowfinのデータベースのPersonパラメーターのIpIdフィールドに保存されます。

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

Code Block

theme	Eclipse
language	xml

<soapenv<S:Envelope xmlns:soapenvS="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:webns2="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
      <soapenv:Body><return>
      <web:remoteAdministrationCall>
      <errorCode>0</errorCode>
  <arg0>
          <messages>Successfully Authenticated User: <loginId>admin@yellowfinadmin@yellowfin.com.au</loginId>messages>
            <password>test</password>
<messages>Web Service           <orgId>1</orgId>       Request Complete</messages>
            <function>SETAVATARIMAGE<<sessionId>6589bf668504fd3468e0b43844550a22</function>sessionId>
            <person><statusCode>SUCCESS</statusCode>
         </return>
       <ipId>5</ipId></ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

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

Expand

title	詳細手順

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

</person> <parameters> <string>iVBORw0KGgoAAAANSUhEUgAAAdsAAA ... your image string</string> </parameters> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>

応答のパラメーター


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

完成例

応答の例

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

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

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

Code Block

theme	Eclipse
language	java

<%

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>5fbbf0f2d8a6f4902adde5bfb659fed7</sessionId>
     ws_modifygroup.jsp       <statusCode>SUCCESS</statusCode>
         <*/return>
%>
<%@ page     </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("SETAVATARIMAGE");

IP IDを提供することで、ユーザーを指定することができます。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setIpId(5); rsr.setPerson(ap);

java.nio.fileライブラリを使用して画像ファイルを選択します。

Code Block

theme	Eclipse
language	java

Path path = Paths.get("D:/TMP/fish.jpg"); // existing image file
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String img = new String(encodeBase64, "UTF-8");
 
rsr.setParameters(new String[] {img});

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

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

完成例

以下は、こちらのWebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

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

Code Block

theme	Eclipse
language	java

<%          
/*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");              ws_setavatarimage.jsp // 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()) ) {
    */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>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を含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが作成されます。

以下は、こちらの関数のために、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>

<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="java.nio.file.Files" %>
<%@ page import="java.nio.file.Paths" %>
<%@ page import="java.nio.file.Path" %>
<%
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");               <arg0>
      // provide your Yellowfin web services admin account
rsr.setPassword("test"); <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("SETAVATARIMAGE");
  
AdministrationPerson ap = new AdministrationPerson();
ap.setIpId(5);
  
rsr.setPerson(ap);
  
Path path = Paths.get("D:/TMP/fish.jpg"); // existing image file
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String img = new String(encodeBase64, "UTF-8");
  
rsr.setParameters(new String[] {img});
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
<function>RENAMEGROUP</function>
            <group>
               <groupId>13001</groupId>            
                <groupName>Report Creators</groupName>
                <groupDescription>Users of this group will out.write("<br>Success");
} else {
   create reports.</groupDescription>
            </group>             out.write("Failure");
      
         </arg0>
  out.write(" Code: " + rs.getErrorCode());
}
%>

ユーザーセッションの終了

これらのサービスは、Yellowfinユーザーのセッションを終了することができます。

以下は、こちらの呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

 </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答の要素

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

応答要素

Expand

title	LOGOUTUSER

こちらのサービスは、Yellowfinのセッションを終了しますが、ユーザーをログアウトさせるために「LoginSessionId」を要求します。これはユーザーを識別するに十分であるため、ユーザーIDは要求されません。LOGINUSER、またはLOGINUSERNOPASSWORD関数とともにシングルサインオンが実行されている場合、以下を介してLoginSessionIdを取得することができます。

Code Block

language	java

String token = response.getLoginSessionId();

こちらの値を保存することで、後ほどLOGOUTUSERリクエストに渡すことができます。

Code Block

language	java

request.setLoginSessionId(token);

リクエストの要素

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

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

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

Password上記アカウントのパスワードです。

AdministrationPerson要素	データ型	説明
UserIdStatusCode	String	詳細を変更するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。	SUCCESS	String	FAILURE

リクエストの例

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

以下は、上記のパラメーターを使用して、こちらの関数のリクエストを示すSOAP XMLの例です。

Code Block

theme	Eclipse
language	xml

<soapenv<S:Envelope xmlns:soapenvS="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:webns2="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
      <soapenv:Body><return>
      <web:remoteAdministrationCall>
      <errorCode>0</errorCode>
   <arg0>
         <messages>Successfully Authenticated User: <loginId>admin@yellowfinadmin@yellowfin.com.au</loginId>messages>
            <password>test</password>
<messages>Web Service           <orgId>1</orgId>Request Complete</messages>
            <function>LOGOUTUSER<<sessionId>2ca79b1696913aa7a4f8b601ac1641a4</function>sessionId>
            <person><statusCode>SUCCESS</statusCode>
           </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

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

<userId>admin@yellowfin.com.au</userId> <password>test</password> </person> <loginSessionId>39fb11047affb98c9d081fb48bed0093</loginSessionId> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>

応答の要素

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

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

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

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

Code Block

theme	Eclipse
language	java

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

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

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

応答要素 データ型 説明
StatusCode
String
Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS
FAILURE

応答の例

以下は、上記のSOAP XMLの呼び出しの応答です。

SUCCESS
FAILURE

完成例

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

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

Code Block

theme	Eclipse
language	xml	java

<% <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>9cad6c76734e329c298e7b15c57a19db</sessionId>
            <statusCode>SUCCESS</statusCode>
ws_renamegroup.jsp          </return>
      </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("LOGOUTUSER");

ログインセッションIDを渡します。
Code Block
theme Eclipse
language java
rsr.setLoginSessionId(token);
ユーザーが複数のTomcatセッションに同時にログインしている場合は、パラメーターを設定することで、どのセッションを終了するのかを指定することができます。例：
Code Block
theme Eclipse
language java
String[] _sessionId = new String[]{sessionId}; // log out by Tomcat session Id (cookies JSESSIONID) rsr.setParameters(_sessionId);
終了のリクエストごとに、ひとつのセッションを提供します。TomcatセッションIDはオプションです。こちらを省略する場合、Yellowfinはすべてのユーザーのセッションを終了します。
リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

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

完成例

以下は、LOGOUTUSER関数の完成例です。スクリプトは、以下の手順を実行するために設計されています。

- LoginSessionIdを取得するLOGINUSERサービスの呼び出し。
- ログインリンクの構成。指定したユーザーのYellowfinセッションを初期化するために、まずはこちらのリンクをクリックしなくてはいけません。（今回の例では、john.smith@yellowfin.com.auをログインユーザーに使用します。指定するユーザーは、既にYellowfinインスタンスに存在していなくてはいけません。または、userIdを変更することもできます。）
- ログアウトするためのリンクを構成。セッションを開始したら、こちらをクリックしなくてはいけません。

こちらのスクリプトを使用するには、以下の手順に従います。

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

Code Block

theme	Eclipse
language	java

<%           
/**/
%>
<%@ 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");                      logoutuser.jsp     //password of the account above
rsr.setOrgId(1);
 
rsr.setFunction("RENAMEGROUP");
 
rsr.setOrgRef("org1");     */
%>
<%@ 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();
 
String token = request.getParameter("token");
 
if (token == null) {
 provide org reference if required. Default org will be searched otherwise
 
AdministrationGroup group = new AdministrationGroup();
 
group.setGroupId(13002);                     
    //login identify the admingroup user:
to rename
    rsr.setLoginId("admin@yellowfin.com.augroup.setGroupName("Org1");          // provide your Yellowfin web services admin account
    rsr.setPassword("test");         // new group name
 
group.setGroupDescription("Organization 1 user group");               // new description
  // change to the password of the above account
rsr.setGroup(group);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    rsrout.setOrgId(1write("Success.<br>");
} else {
  rsr  out.setFunctionwrite("LOGINUSERFailure");
 
    AdministrationPerson ap = new AdministrationPerson();
 
    String userId = "john.smith@yellowfin.com.au";
 
    ap.setUserId(userId);
    ap.setPassword("test");
 
    rsr.setPerson(ap);
 
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
        String token_ = rs.getLoginSessionId();
        out.write("Login by opening the link in a new subtab prior to Logout. The tomcat session must be initialized...");out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	INCLUDEUSERINGROUP

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

リクエストパラメーター

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

リクエスト要素	データ型	説明
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を含めます。こちらを指定しない場合は、デフォルト（プライマリー）組織内のグループが検索されます。

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

AdministrationGroup要素	データ型	説明
GroupName	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>
        out.write("<BR>Login: <A href='http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "'>");
   <password>test</password>
           out.write("http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "</a><br>");
<orgId>1</orgId>
            out.write("<BR>Logout: <A href='http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "'>");<function>DELETEGROUP</function>
           <group>
        out.write("http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "</a><br>");
    <groupName>Admin</groupName>
           </group>       } else {
        out.write("Failure"); </arg0>
      </web:remoteAdministrationCall>
  out.write(" Code: " + rs.getErrorCode() );
        return; </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>
    }
} else {
 
    //logout the user:
 
    out.write("Trying to logout " + token + " session...<br>");
 
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
     rsr = new AdministrationServiceRequest();
 <return>
    rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
    rsr.setPassword("test"); <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
           // set<messages>Web theService password of the above account
Request Complete</messages>
       rsr.setOrgId(1);
 
    rsr.setFunction("LOGOUTUSER");<sessionId>db18f2503e80ca02a9d37da13fc540a5</sessionId>
 
    rsr.setLoginSessionId(token);
 
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
 <statusCode>SUCCESS</statusCode>
      if ("SUCCESS".equals(rs.getStatusCode()) ) {</return>
        out.write("Logout: Success");</ns2:remoteAdministrationCallResponse>
    } else {
        out.write("Failure");
        out.write("Code: " + rs.getErrorCode() );
    }
}
%>

Expand

title	LOGOUTBYUSERID

</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("DELETEGROUP");

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

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

Code Block

theme	Eclipse
language	java

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

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
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」を実行します。

こちらのサービスは、指定したユーザーをログアウトすることで、LOGOUTUSER関数と類似していますが、こちらは、ユーザーを識別するためにログインセッションIDではなく、ユーザーID（例：ログインIDの方法に応じて、電子メールアドレス、または他のタイプのIDになります）、またはユーザーのIP ID（YellowfinデータベースのPersonテーブルのIpIdフィールドの値）のいずれかを要求します。

こちらの呼び出しは、ユーザーID、またはIpIdの提供に使用されるAdministrationPersonオブジェクトを使用します。

リクエストの要素

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

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

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

AdministrationPerson要素	データ型	説明
UserId	String	Yellowfinのセッションを終了するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。
IpId	String	セッションを終了するユーザーのIp IDです。

リクエストの例

以下は、関数に渡されるリクエストを示すXML SOAPの例です。

Code Block

theme	Eclipse
language	xml	java

<%<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>
 ws_deletegroup.jsp           <password>test</password>
            <orgId>1</orgId>
            <function>LOGOUTBYUSERID</function>
            <person>           
               <userId>admin@yellowfin.com.au</userId>
      */
%>
<%@ 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);         <password>test<//password>
 adjust host and port        </person>
         </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>
number
 
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");         <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
 provide your Yellowfin web services admin account
rsr.setPassword("test");               <return>
            <errorCode>0</errorCode>
// set the password of the above account
 
rsr.setOrgId(1);
 
rsr.setFunction("DELETEGROUP");
 
rsr.setOrgRef("org1");                      <messages>Successfully  Authenticated User: admin@yellowfin.com.au</messages>
  // specify a client org reference if required. Or skip <messages>Webthis Serviceto Request Complete</messages>
            <sessionId>f8a04d7c9530ff18f65f95048e6a4500</sessionId>
search through the default org
 
 
AdministrationGroup group = new AdministrationGroup();
 
group.setGroupName("Test Group");             <statusCode>SUCCESS<//statusCode>
 this group must exist in the specified client </return>org
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

AdministrationServiceRequest rsr = new AdministrationServiceRequest(


 
rsr.setGroup(group);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

rsr.setLoginId

if ("

admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("LOGOUTBYUSERID");

ユーザーID、またはIpIdを渡すことで、ログアウトをするユーザーを識別します。

AdministrationPerson ap = new AdministrationPerson(); ap.setUserId(userId

SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success.<br>");
} else {
    out.write("Failure");
    out.write(" Code: "

rsr.setPerson(ap);ユーザーが複数のTomcatセッションに同時にログインしている場合は、パラメーターを設定することで、どのセッションを終了するのかを指定することができます。例：

+ rs.getErrorCode());
}
%>

Expand

title	詳細手順

以下は、こちらの呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。

Code Block

theme	Eclipse
language	java

Code Block

theme	Eclipse
language	java

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

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

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

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

終了のリクエストごとに、ひとつのセッションを提供します。TomcatセッションIDはオプションです。こちらを省略する場合、Yellowfinはすべてのユーザーのセッションを終了します。

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

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>DELETEGROUP</function>
           <group>

java

String[] _sessionId = new String[]{sessionId}; // log out by Tomcat session Id (cookies JSESSIONID)
rsr.setParameters(_sessionId);

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

完成例

以下は、こちらの関数の完成例です。スクリプトは、以下の手順を実行するために設計されています。

- ログインリンクの構成。指定したユーザーのYellowfinセッションを初期化するために、まずはこちらのリンクをクリックしなくてはいけません。（今回の例では、john.smith@yellowfin.com.auをログインユーザーに使用します。指定するユーザーは、既にYellowfinインスタンスに存在していなくてはいけません。または、userIdを変更することもできます。）
- ログアウトするためのリンクを構成。セッションが設定されたら、こちらをクリックしなくてはいけません。

こちらのスクリプトを使用するには、以下の手順に従います。

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

Code Block

theme	Eclipse
language	java

<% /* test.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(); String userId = request.getParameter("userId"); if (userId == null) { //login the admin user: rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account rsr.setPassword("test");

            <groupName>Admin</groupName>
           </

group>

set

the

password

the

above

account

rsr.setOrgId(1);

    </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>db18f2503e80ca02a9d37da13fc540a5</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </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("DELETEGROUP");

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

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

Code Block

theme	Eclipse
language	java

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

リクエストの構成が完了したら、呼び出しを実行します。
Code Block
theme Eclipse
language java
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

theme	Eclipse
language	java

<%           
/*

rsr.setFunction("LOGINUSER"); AdministrationPerson ap = new AdministrationPerson(); userId = "john.smith@yellowfin.com.au"; ap.setUserId(userId); ap.setPassword("test"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { String token_ = rs.getLoginSessionId(); out.write("Login by opening the link in a new subtab prior to Logout. The tomcat session must be initialized..."); out.write(" Login: <A href='http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "'>"); out.write("http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "</a> "); out.write(" Logout: <A href='http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "'>"); out.write("http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "</a> "); }else {

out.write("Failure");

ws_deletegroup.jsp

out.write("

Code:

rs.getErrorCode() ); return; } } else { //logout the user:

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

//

out.write("Trying to logout " + userId + " session... ");

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

 admin account
rsr.setPassword("test");                           // set the password of the above account
 
rsr.setOrgId(1);
 
rsr.setFunction("DELETEGROUP");
 
rsr.setOrgRef("org1");                            //

change

specify

the

client

password

org

reference

the

if

above

required.

account

Or skip this

rsr.setOrgId(1); rsr.setFunction("LOGOUTBYUSERID");

to search through the default org
 
 
AdministrationGroup group = new AdministrationGroup();
 
group.setGroupName("Test Group");

AdministrationPerson

new

AdministrationPerson();

//

ap.setUserId(userId); rsr.setPerson(ap

this group must exist in the specified client org
 
 
rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {

out.write("

Logout:

Success.<br>");

} else {

    out.write("Failure");

out.write(" Code: " + rs.getErrorCode()

);

}

%>

horizontalrule

Styleclass

Class	topLink

ページトップ

...

Content

Space Tools

Page History

Versions Compared

Old Version 1

New Version 2

Key

リクエスト要素

リクエストの例

応答要素

応答の例

手順

完成例

リクエスト要素

応答要素

手順

完成例

完成例

リクエスト要素

応答パラメーター

手順

応答要素

リクエスト要素

リクエストの例

手順

応答の例

手順

完成例

完成例

ユーザー情報の取得と検証

ユーザーグループ関数

リクエスト要素

リクエストの例

応答要素

手順

完成例

完成例

リクエスト要素

応答の要素

応答の例

手順

完成例

リクエスト要素

リクエストの例

応答の要素

応答の例

手順

完成例

リクエストパラメーター

リクエストの例

応答のパラメーター

応答の例

手順

完成例

リクエストの要素

リクエストの例

応答の要素

応答の例

手順

完成例

リクエストの要素

リクエストの例

応答の要素

応答の例

手順

完成例

ユーザー情報の操作

リクエストの要素

リクエストの例

応答の要素

応答の例

手順

完成例

応答の要素

リクエストの要素

リクエストの例

手順

応答の要素

応答の例

完成例