Versions Compared

Key

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

...

Expand
titleLISTROLES

こちらの関数は、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
languagexml
<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
RolesAdministrationRole[]

ロールの一覧です。

 

応答の例

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

Code Block
themeEclipse
languagexml
<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
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("LISTROLES");
  • リクエストを構成したら、呼び出しを実行します。

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    RolesAdministrationRole[]

    ロールの一覧です。

 

完成例

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

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

 

Code Block
themeEclipse
languagejava
<%           
/*              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
titleSAVEROLE

こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロール詳細を指定するための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
themeEclipse
languagexml
<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
themeEclipse
languagexml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <roles>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>MIREPORT</functionCode>
               </functions>
               <roleCode>REPORTCONTENTWRITER</roleCode>
               <roleDescription>This role can generate reports.</roleDescription>
               <roleName>Report Content Writer</roleName>
            </roles>
            <sessionId>ceaa85d0ca1eb6057dc4facb0a7a5aa9</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 

手順

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

Expand
title詳細手順
  • 以下は、こちらの関数の基礎的なリクエストです。

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("SAVEROLE");
  • ロールを指定します。

    Code Block
    themeEclipse
    languagejava
    AdministrationRole role = new AdministrationRole();
  • 既存のロールを変更する場合は、ロールコードが必須になります。

    Code Block
    themeEclipse
    languagejava
    AdministrationPerson[] ap = new AdministrationPerson[2];
    これらの必須パラメーターを提供することで、最初のユーザーの詳細を追加します。:UserId、FirstName、LastName、RoleCode、Password、EmailAddress
    role.setRoleCode("NEWROLE");          // If you want to create a new role, comment this out.

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

     

    Tip

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

     

     

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

    Code Block
    themeEclipse
    languagejava
    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
    themeEclipse
    languagejava
    ap[1] = new AdministrationPerson();
    ap[1].setUserId("user2@yellowfin.com.au");        
    ap[1].setFirstName("user2");
    ap[1].setLastName("Lastname2");
    ap[1].setRoleCode("YFREPORTCONSUMER");role.setRoleDescription("testing");
  • SAVEROLE関数の呼び出し時には、セキュリティ機能の一覧を提供しなくてはいけません。この呼び出しは、ロール機能を上書きます。例えば、ロールに2つの機能を割り当てます。レポートアクセス(必須)、アクティビティストリーム(オプション)

     

    Code Block
    themeEclipse
    languagejava
    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
    languagejava
    role.setFunctions(f);
    rsr.setRole(role);
  • リクエストを構成したら、呼び出しを実行します。

    Code Block
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

 

完成例

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

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

 

Code Block
themeEclipse
languagejava
Code Block
themeEclipse
languagejava
<%           
ap[1].setPassword("test");
/*              ws_saverole.jsp               */
%>
<%@ 
ap[1].setEmailAddress("user2@yellowfin.com.au");

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

 

リクエストに「ap」オブジェクトを渡します。
Code Block
languagejava
rsr.setPeople(ap);
リクエストを構成したら、呼び出しを実行します。
Code Block
languagejava
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

完成例

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

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

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

 

<%           
/*              ws_addusers.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 page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number


AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the account above
account
rsr.setOrgId(1);
 
rsr.setFunction("ADDUSERSSAVEROLE");
 
//define a 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");           // apmandatory
f[0].setFirstNamesetAccessLevelCode("user1R");
ap 
f[0].setLastName("Lastname1"1] = new AdministrationFunction();
apf[01].setRoleCodesetFunctionCode("YFREPORTCONSUMERACTIVITYSTREAM");          ap[0    
f[1].setPasswordsetAccessLevelCode("testCRUD");
 
 
//Feed the security functions to the role:
role.setFunctions(f);
 
                 
ap[0].setEmailAddress("user1@yellowfin.com.au"rsr.setRole(role);
AdministrationServiceResponse rs ap[1] = new AdministrationPerson();
ap[1].setUserId("user2@yellowfin.com.au"adminService.remoteAdministrationCall(rsr);
 
 
   
ap[1].setFirstNameif ("user2");
ap[1].setLastName("Lastname2");
ap[1].setRoleCode("YFREPORTCONSUMER");  SUCCESS".equals(rs.getStatusCode()) ) {
      
ap[1].setPasswordout.write("testSuccess");
} 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
titleADDUSERSIGNOREDUPLICATES

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

 

リクエストパラメーター

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

Expand
titleDELETEROLE

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

 

リクエスト要素

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

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です(こちらの設定はオプションです)。こちらは、参照されるクライアント組織に新規ユーザーを作成します。こちらを設定しない場合、新規ユーザーはデフォルト(プライマリー)組織内に作成されます。

String
AdministrationPerson 要素AdministrationRole 要素データ型説明

UserId

String

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

Password

新規ユーザーのパスワードです。こちらは、Yellowfinのパスワードポリシーに準拠する必要があります。

FirstName

String

新規ユーザーの名です。

LastName

String

新規ユーザーの姓です。

RoleCode

String

新規ユーザーのロールを設定します。例:YFREPORTCONSUMER

注意:リポジトリデータベースから、Yellowfinのロールコードの一覧を取得することができます。例:SQLクエリーを使用する場合:SELECT * FROM OrgRole

EmailAddress

String

新規ユーザーの電子メールアドレスです。

 

応答パラメーター

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
PeopleAdministrationPerson[]アカウントが作成されなかったユーザーです。

 

手順

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

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

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

 

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

javaap[0] = new AdministrationPerson(); ap[0].setUserId("user1@yellowfin.com.au");
<soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            
ap[0].setFirstName("user1"); ap[0].setLastName("Lastname1"); ap[0].setRoleCode("YFREPORTCONSUMER");
<password>test</password>
           
ap[0].setPassword("test");
 <orgId>1</orgId>
            <function>DELETEROLE</function>
            <role>
     
ap[0].setEmailAddress("user1@yellowfin.com.au");

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

 

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

 

ap[1]
 
=
 
new
 
AdministrationPerson();
 
ap[1].setUserId("user2@yellowfin.com.au");
       <roleCode>REPORTWRITER</roleCode>
 
ap[1].setFirstName("user2");
 
ap[1].setLastName("Lastname2");
 
ap[1].setRoleCode("YFREPORTCONSUMER");
         
ap[1].setPassword("test");
</role>                          
         </arg0>
      </web:remoteAdministrationCall>
   
ap[1].setEmailAddress("user2@yellowfin.com.au");

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

 

リクエストに「ap」オブジェクトを渡します。
Code Block
themeEclipse
language
xml
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   
rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("ADDUSERSIGNOREDUPLICATES");特定のクライアント組織に新規ユーザーを作成する場合は、こちらをコードに追加します。
Code Block
themeEclipse
languagejava
rsr.setOrgRef("org1");
orgRefパラメーターを定義しない場合は、新規ユーザーはデフォルト(プライマリー)組織内に作成されます。

 

新規Yellowfinユーザーの詳細を定義するために、AdministrationPersonオブジェクトを使用します。
Code Block
themeEclipse
languagejava
AdministrationPerson[] ap = new AdministrationPerson[2];
これらの必須パラメーターを提供することで、最初のユーザーの詳細を追加します。:UserId、FirstName、LastName、RoleCode、Password、EmailAddress
Code Block
themeEclipse
languagejava
Code Block
themeEclipse
languagejava
Code Block
languagejava
rsr.setPeople(ap);
リクエストを構成したら、呼び出しを実行します。
Code Block
languagejava
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

 

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

 

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

 

応答要素

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

応答要素データ型説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

 

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

Code Block
themeEclipse
language
java
AdministrationPerson[] failed_users = rs.getPeople();
Expand
titleDELUSER / DELETEUSER

こちらの関数は、指定されたユーザーを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[]

削除されるユーザーアカウントの詳細を含むオブジェクトです。以下の表を参照してください。

OrgRefString

クライアント組織内部参照IDです(こちらの設定はオプションです)。指定したクライアント組織にユーザーをログインさせます。こちらを設定しない場合、ユーザーはログイン先を指定するために、クライアント組織選択ページへ移動します。

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

AdministrationPerson 要素データ型説明

UserId

String

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

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

 

リクエストの例

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web
Code Block
themeEclipse
languagexml
xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="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>
            </roles>
<person>                 <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
データ型

 

応答の例

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

title
説明

StatusCode

String

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

  • SUCCESS
  • FAILURE
詳細手順
Expand
title詳細手順
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
  • 以下は、こちらの関数の基礎的なリクエストです。

    Code Block
    themeEclipse
    language
xml
  • java
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("DELETEROLE");
  • 削除するロールを定義します。

    Code Block
    themeEclipse
    languagejava
    AdministrationRole role = new AdministrationRole();
    role.setRoleCode("NEWROLE");     
<return>
  •              
<errorCode>0</errorCode>
  •    // existing role. Role Codes can be found by calling 
<messages>Successfully
  • LISTROLES
    
Authenticated
  •  
User:
  •  
admin@yellowfin.com.au</messages>
  •              
<messages>Web
  •  
Service
  •  
Request
  •  
Complete</messages>
  •              
<sessionId>cc8c2b81d06485fdd20fe4cd24f5f70c</sessionId>
  •              
<statusCode>SUCCESS</statusCode>
  •      // or retrieved from the 
</return>
  • Yellowfin database table OrgRole.
    rsr.setRole(role);
  • リクエストを構成したら、呼び出しを実行します。

    Code Block
    languagejava
    AdministrationServiceResponse rs 
</ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>

 

手順

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

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

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

 

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

 

完成例

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

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

    Code Block
    themeEclipse
    languagejava
AdministrationServiceRequest
  1. <%   
rsr
  1.  
=
  1.  
new
  1.  
AdministrationServiceRequest();
  1.    
rsr.setLoginId("admin@yellowfin.com.au");
  1.  
rsr.setPassword("test");
  1.  
rsr.setOrgId(1); rsr.setFunction("DELETEUSER");

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

 

Code Block
themeEclipse
languagejava
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test@yellowfin.com.au");
  1. 
    /*              ws_deleterole.jsp              
//
  1.  
test@yellowfin.com.au
  1.  
should
  1.  
be
  1.  
an
  1. */
    
existing
  1. %>
    
Yellowfin
  1. <%@ 
user. rsr.setPerson(ap);

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

 

Code Block
themeEclipse
languagejava
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

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

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <% /* ws_deleteuser.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.
    1. 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.*" %>
      
    1. <%
      AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
    1. 
      AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
      
    1. AdministrationServiceRequest rsr = new AdministrationServiceRequest();
      
    1. rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin 
    web
    1. webservices 
    services
    1. admin account
      rsr.setPassword("test");                           // change to the password of the above account above
      rsr.setOrgId(1);
       
       
      rsr.setFunction("
    DELETEUSER
    1. DELETEROLE");
       
       
      
    AdministrationPerson
    1. AdministrationRole 
    ap
    1. role = new 
    AdministrationPerson
    1. AdministrationRole();
      
    ap
    1. role.
    setUserId
    1. setRoleCode("
    test@yellowfin.com.au
    1. NEWROLE");
      rsr.
    setPerson
    1. setRole(
    ap
    1. role);
       
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
       
       
      if ("SUCCESS".equals(rs.getStatusCode()
    1. ) ) {
          out.write("Success");
      } else {
          out.write("Failure");
          out.write(" Code: " + rs.getErrorCode()
    1. );
      }
      %>

     

     

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

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

     

     

    ユーザーグループ関数

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

    Expand
    titleGETUSERLISTGROUPS

    こちらの関数は、既存のYellowfinユーザーの詳細を取得します。これは、AdministrationPersonオブジェクトを、ユーザーの識別に使用できるパラメーターとして受け付けます。応答には、ユーザー詳細のすべてが含まれたAdministrationPersonオブジェクトが含まれます。LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。特定のクライアントに所属するグループの一覧を取得する場合は、呼び出しにクライアント組織参照IDを渡します。

     

    リクエスト要素

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

    リクエスト要素データ型説明

    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」に設定します。

    OrgRefString

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

     

    クライアント組織内部参照IDです(こちらの設定はオプションです)。指定したクライアント組織にユーザーをログインさせます。こちらを設定しない場合、ユーザーはログイン先を指定するために、クライアント組織選択ページへ移動します。

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

    AdministrationPerson要素データ型説明

    UserId

    String

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

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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>       
                <person>
                <function>LISTGROUPS</function>    <userId>admin@yellowfin.com.au</userId>             </person>         
             </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答の要素

    応答要素

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

    AdministrationPersonユーザー詳細を含むオブジェクトです。
    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    Person
    GroupsAdministrationGroup[]グループの一覧です。

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <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 informationrole...</messages>groupDescription>
                 <messages>Getting user information...</messages><groupId>11950</groupId>
                <messages>Web Service Request Complete</messages><groupMembers>
                <person>         <internalId>5</internalId>
          <emailAddress>admin@yellowfin.com.au</emailAddress>                <firstName>System</firstName><loginId>admin@yellowfin.com.au</loginId>
                   <initial</>groupMembers>
                   <ipId>5</ipId><groupMembers>
                   <languageCode>EN</languageCode>   <internalId>13000</internalId>
                <lastName>Administrator</lastName>                <roleCode>YFADMIN</roleCode><loginId>binish.sheikh@yellowfin.com.au</loginId>
                   <salutationCode</>groupMembers>
                   <status>ACTIVE<<groupName>Administrators</status>groupName>
                   <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode></groups>
                <messages>Successfully Authenticated User: <userId>admin@yellowfinadmin@yellowfin.com.au</userId>messages>
                <messages>Web Service Request <Complete</person>messages>
                <sessionId>70dc3c7158a340e19b590f0ed6ea6a8b<<sessionId>79d937ead121745d93289f287d55b0ac</sessionId>
                <statusCode>SUCCESS</statusCode>
             </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
      rsr.setFunction("GETUSERLISTGROUPS");
    • AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。特定のクライアントのグループの一覧を取得する場合は、クライアント組織IDを含めます。(こちらを指定しない場合は、デフォルト(プライマリー組織)のグループが表示されます)

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setUserId("john.smith@yellowfin.com.au");
      rsr.setPerson(aprsr.setOrgRef("org1");
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

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


      応答要素
     
    • データ型
      取得したユーザーの詳細を表示するには、以下の例を使用します。
      説明
      code

      StatusCode

    theme

    String

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

    • SUCCESS
    • FAILURE
    GroupsAdministrationGroup[]グループの一覧です。

     

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

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
    <%          
    ap
     
    = rs.getPerson();
    
    /*     
    out.write("UserId:"
     
    +
     
    ap.getUserId()
     
    +
     
    "<br>");
         
    out.write("Password:" + ap.getPassword() + "<br>");
    ws_listgroups.jsp         
    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>"
          */
    %>
    <%@ 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("EmailAddress:" + ap.getEmailAddress() + "<br>"); out.write("LanguageCode:" + ap.getLanguageCode() + "<br>"); out.write("IpId:" + ap.getIpId() + "<br>
       // adjust host and port number
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");     
    out.write("TimeZoneCode:" + ap.getTimeZoneCode() + "<br>"); out.write("Status:" + ap.getStatus() + "<br>"); } else { out.write("Failure");
         // provide your Yellowfin web services admin account
    rsr.setPassword("test");                      
    out.write("
     
    Code:
     
    "
     
    +
     
    rs.getErrorCode());
     
    }

          

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*    change to the password of the above account
    rsr.setOrgId(1);
     
    rsr.setFunction("LISTGROUPS");
     
    //rsr.setOrgRef("org1");           ws_getuser.jsp              *// %>provide org reference <%@if 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", falserequired. 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  // adjust host and port number
     
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au"= 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: " +  // provide your Yellowfin web services admin account
    rsr.setPassword("test")group.getGroupDescription());
            out.write("<br>Group Status: " + group.getGroupStatus());
            out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
     
     
            // changeuncomment to display the passwordmembers:
      of the above account
    rsr.setOrgId(1);
    rsr.setFunction("GETUSER");   /*
       AdministrationPerson ap = new AdministrationPerson(); apout.setUserId("john.smith@yellowfin.com.auwrite("<br>Members:<br>Login Id | Internal Id ");
    rsr.setPerson(ap);    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); for (AdministrationGroupMember if ("SUCCESS".equals(rs.getStatusCodemember: group.getGroupMembers()){
    ) {     ap = rs.getPerson();     out.write("User Id:<br>" + apmember.getUserIdgetLoginId() + "<br>"); |    out.write("Password:" + apmember.getPasswordgetInternalId() + "<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>" */
        }
    } else {
        out.write("Failure");
        out.write("Role Code:" + ap.getRoleCode() + "<br>");
        out.write("Email Address:" + aprs.getEmailAddressgetErrorCode() + "<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
    titleGETALLUSERS

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

     

    リクエスト要素

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

    リクエスト要素データ型説明

    LoginId

    String

    ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「GETUSER」に設定します。

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

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteAdministrationCall>}
    %>
    Expand
    titleGETGROUP

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

    リクエスト要素

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

    リクエスト要素データ型説明

    LoginId

    String

    ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、GETGROUP」に設定します。

    Group

    AdministrationGroup

    取得するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。

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


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

    AdministrationGroup要素データ型説明

    GroupName

    String

    詳細とメンバーの一覧を取得するユーザーグループの名前を指定します。

     

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

    Code Block
    themeEclipse
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteAdministrationCall>
             <arg0>
                <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>
                <orgId>1</orgId>
                <function>GETGROUP</function>
                <group>
                  <arg0>             <loginId>admin@yellowfin.com.au</loginId><groupName>Administrators</groupName>
                <password>test</password>
         </group>       <orgId>1</orgId>             <function>GETALLUSERS</function>
             </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答の要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    PeopleGroupAdministrationPerson

    AdministrationGroup[]

    ユーザー詳細を含むオブジェクトの配列です。メンバーの一覧を含むグループの詳細です。

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <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<group>
    Authenticated User: admin@yellowfin.com.au</messages>             <messages>Web<groupDescription>This Servicegroup Requestcontains Complete</messages>all users with the Admin role.</groupDescription>
           <people>        <groupId>11950</groupId>
           <firstName>System</firstName>        <groupMembers>
           <ipId>5</ipId>            <internalId>5</internalId>
       <lastName>Administrator</lastName>                <userId>admin@yellowfin<loginId>admin@yellowfin.com.au</userId>loginId>
                   </people>
    groupMembers>
               <sessionId>2c32528279baa26b730f9e3c8787880d</sessionId>    <groupMembers>
            <statusCode>SUCCESS</statusCode>          <<internalId>13000</return>internalId>
          </ns2:remoteAdministrationCallResponse>    </S:Body> </S:Envelope>

     

    手順

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

    AdministrationServiceRequest
     
    rsr
     
    =
     
    new
     
    AdministrationServiceRequest();
       
    rsr.setLoginId("admin@yellowfin
    <loginId>binish.sheikh@yellowfin.com.
    au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETALLUSERS");
    • クライアント組織を指定しない場合は、すべてのクライアント組織が検索されます。

       

    Expand
    title詳細手順
    Code Block
    themeEclipse
    languagejava
    こちらは、すべてのユーザーを取得するリクエストの例であり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    rsr.setOrgRef("org1");
  • 検索基準:GETALLUSERS関数は、2つの文字列の配列を受け付けます。最初の配列(searchingCriteria[0])は、「%John%」のような条件を使用して、Yellowfinデータベースユーザーの名、姓、電子メールの@よりも左側、または右側と比較されます。次の配列(seachingCriteria[1])は、Yellowfinデータベースユーザーの電子メール右側(ドメイン)と比較されます。

     

    Code Block
    themeEclipse
    languagejava
    String[] searchingCriteria = new String[] {"John","yellowfin.com.au"};
    rsr.setParameters(searchingCriteria);
  • リクエストの構成が完了したら、呼び出しを実行します。

     

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

  •  

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

    完成例

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

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

     

    <%au</loginId>
                   </groupMembers>
                   <groupName>Administrators</groupName>
                   <groupStatus>OPEN</*groupStatus>
                 ws_getallusers.jsp</group>
                <messages>Successfully Authenticated  */
    %>User: admin@yellowfin.com.au</messages>
         <%@ 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);<messages>Web Service Request Complete</messages>
                <sessionId>54c5cf263f323b439c5834d1f6d8b645</sessionId>
                <statusCode>SUCCESS</statusCode>
             <//return>
    adjust host and port number  </ns2:remoteAdministrationCallResponse>
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
     </S:Body>
    </S:Envelope> 

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストです。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
      rsr.setFunction("
    GETALLUSERS
    • GETGROUP");
    • 特定のクライアント組織のグループ一覧を取得する場合は、クライアント組織IDを含めます。(こちらを指定しない場合は、デフォルト(プライマリー組織)組織のグループが表示されます)

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    String[] searchingCriteria
    • メンバーを取得するためにユーザーグループの名前を提供します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new 
    String[] {"John","yellowfin.com.au"}
    • AdministrationGroup();
      group.setGroupName("Administrators");
      rsr.
    setParameters
    • setGroup(
    searchingCriteria);
    • group);

       

       

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

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE

      Group

      AdministrationGroup[]

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

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

      Code Block
      themeEclipse
      languagejava
      AdministrationGroupMember[] members 
    if ("SUCCESS".equals(
    • = rs.
    getStatusCode
    • getGroup()
    ) ) { out.write("Success. " + rs.getPeople().length + " people found."); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode() ); } %>
    Expand
    titleGETUSERBYIP

    こちらの関数は、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」に設定します。

    PersonAdministrationPerson情報が取得されるユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

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

    AdministrationPerson要素データ型説明
    IpIdInteger|情報が取得されるユーザーのIP IDです。

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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>
    • .getGroupMembers();
      Tip

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

          

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              ws_getgroup.jsp                 */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%
    AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
     
    rsr.setLoginId("admin@yellowfin.com.au");             <password>test<//password> provide your Yellowfin web services admin account
    rsr.setPassword("test");     <orgId>1</orgId>             <function>GETUSERBYIP</function>         // change <person>to the password of the account above
     
    rsr.setOrgId(1);
     
    rsr.setFunction("GETGROUP");
     
    //rsr.setOrgRef("org1");  <ipId>5</ipId>             </person>          <//arg0> provide org reference ID if  </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答の要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    Person

    AdministrationPerson

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

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <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>
     required. Default org will be searched otherwise
     
    AdministrationGroup group = new AdministrationGroup();
    group.setGroupName("Administrators");
    rsr.setGroup(group);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
        out.write("Success.<br>");
        group = rs.getGroup();
         
        <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>out.write("<br>");
        out.write("<br>Group Name: " + group.getGroupName());
       <messages>Getting user information...</messages>
       out.write("<br>Group Id: " + group.getGroupId());
        out.write("<br>Group Description: " + <messages>Getting user information...</messages>group.getGroupDescription());
        out.write("<br>Group Status: " + group.getGroupStatus());
       <messages>Web Service Request Complete</messages>
       out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
     
     
        // <person>display the members:
                 <emailAddress>admin@yellowfin.com.au</emailAddress>
        out.write("<br>Members:<br>Login Id | Internal Id ");
        for (AdministrationGroupMember member: group.getGroupMembers()){
      <firstName>System</firstName>      out.write("<br>" + member.getLoginId() + " | "  +  <initial/>member.getInternalId() );
        }
    } else {
        out.write("Failure");
      <ipId>5</ipId>  out.write(" Code: " + rs.getErrorCode());
             <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
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("GETUSERBYIP");
    • IpIdを提供し、詳細を取得するユーザーを識別するために、AdministrationPersonオブジェクトを使用します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
       
      ap.setIpId(5);                  //IpId of the admin@yellowfin.com.au account
      rsr.setPerson(ap);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    この呼び出しの結果を表示するには、以下の例を使用します。
    Code Block
    themeEclipse
    languagejava
    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関数の完成例です。こちらを使用するには、以下の手順に従います。

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              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
    titleGETAVATARS

    こちらの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」に設定します。

    ParametersString[]プロフィール画像を取得するYellowfinユーザーの内部ID(または、IpId)が含まれる配列です。各IDは、Integerのものもすべて、Stringとして渡されなくてはいけません。

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("GETAVATARS");
    • ユーザーのIP IDを指定することができます。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setParameters(new String[] {"5","13073"});
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

    最初の画像を取得するためには、以下を使用します。
    Code Block
    themeEclipse
    languagejava
    byte[] data = response.getBinaryAttachments[0].getData();

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              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
    titleVALIDATEUSER

    こちらの関数は、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」に設定します。

    PersonAdninistrationPerson検証されるユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

    OrgRef

    String

    クライアント組織参照IDです(こちらの設定はオプションです)。特定の組織のユーザーの検証が必要な場合は、こちらを設定します。

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

    AdministrationPerson要素データ型説明

    User ID

    String

    検証するユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

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

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("VALIDATEUSER");
    • AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      
      ap.setUserId("john.smith@yellowfin.com.au");
      ap.setPassword("test");
      
      rsr.setPerson(ap);
    • 特定の組織のユーザーの検証が必要な場合は、クライアント組織参照IDを提供します。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");

      OrgRefパラメーターが省略された場合、ユーザーはデフォルト(プライマリー)組織に対して検証されます。

     

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

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              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
    titleVALIDATEPASSWORD

    こちらの呼び出しは、ユーザーのパスワードを検証します。パスワードの有効期限が切れている場合、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」に設定します。

    PersonAdninistrationPersonパスワードが検証されるユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

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

    AdministrationPerson要素データ型説明

    UserId

    String

    パスワードが検証されるユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

    Password

    String

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

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("VALIDATEPASSWORD");
    • AdministrationPersonオブジェクトを介して、ユーザーIDを提供します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setUserId("john.smith@yellowfin.com.au");
      ap.setPassword("test");
       
      rsr.setPerson(ap);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              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オブジェクトのその他のフィールドには、新しい変更内容が投入されます。

     

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

     

    リクエストの要素

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

    Expand
    titleCHANGEPASSWORD
    リクエスト要素データ型説明

    LoginId

    String

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

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「CHANGEPASSWORD」に設定します。

    PersonAdninistrationPerson

    パスワードを変更するユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

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

    AdministrationPerson要素データ型説明

    UserId

    String

    パスワードを変更するユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

    Password

    String

    ユーザーの新規パスワードです。これは、Yellowfinのパスワードポリシーに準拠していなくてはいけません。

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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
    themeEclipse
    languagexml
    <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詳細手順
    こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("CHANGEPASSWORD");
    • AdministrationPersonオブジェクトを使用して、ユーザーを指定します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
       
      ap.setUserId("john.smith@yellowfin.com.au");
      ap.setPassword("test123");
      rsr.setPerson(ap);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              ws_changepwd.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("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
    titleRESETPASSWORD

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

     

    リクエストの要素

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

    リクエスト要素データ型説明

    LoginId

    String

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

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「RESETPASSWORD」に設定します。

    PersonAdninistrationPerson

    パスワードをリセットしなくてはいけないユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

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

    AdministrationPerson要素データ型説明

    UserId

    String

    パスワードをリセットするユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

    Password

    String

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

     

    リクエストの例

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

    Code Block
    themeEclipse
    languagexml
    <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>test321</password>
                <orgId>1</orgId>
                <function>RESETPASSWD</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
    themeEclipse
    languagexml
    <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>beabd94a9ffaa562a8b9ba823fc291a0</sessionId>
                <statusCode>SUCCESS</statusCode>
             </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("RESETPASSWD");
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    /*              ws_ resetpwd.jsp                  */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%
    AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
     
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
     
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
    rsr.setPassword("test");                           // change to the password of the account above
    rsr.setOrgId(1);
    rsr.setFunction("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");
    } else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode() );
    }
    %>
    Expand
    titleUPDATEUSER

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

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

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

     

    リクエストの要素

    }
    %>
    ap.setStatus("INACTIVE
    CREATEGROUP");
     
    //Specify client org (if omitted, the group will be created in the default (primary) org):
    rsr.setOrgRef("org1");
     
    //Set parameters of the new group:
    AdministrationGroup group = new AdministrationGroup();
    group.setGroupName("Test Group");                          //
    This
     
    shows
    mandatory. 
    that
    Other 
    the
    parameters 
    user "john.smith@yellowfin.com.au" will not be able to log in rsr.setPerson(ap);
  • リクエストの構成が完了したら、呼び出しを実行します。

     

  • Expand
    titleCREATEGROUP

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

     

    リクエスト要素

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

    AdministrationPerson要素
    リクエスト要素データ型説明

    LoginId

    String

    Yellowfin Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「UPDATEUSER」に設定します。

    PersonAdninistrationPerson

    更新しなくてはいけないユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

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

    CREATEGROUP」に設定します。

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

     

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

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

     

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

    AdministrationGroupMember要素データ型説明
    UserIdLoginIdString

    詳細を変更するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。

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

     

    リクエストの例

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

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


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

    Code Block
    themeEclipse
    languagexml
    <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>UPDATEUSER</function><function>CREATEGROUP</function>
                <group>
                    <groupName>Supervisors</groupName>
                    <groupMembers>
                        <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
    PersonAdministrationPerson更新されたユーザーの詳細を含むオブジェクトです。

     

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    <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>
      .com/">
             <messages>Successfully<return>
    Authenticated User: admin@yellowfin.com.au</messages>          <errorCode>0</errorCode>
      <messages>Getting user information...</messages>        <messages>Successfully Authenticated    <messages>Getting user information...<User: admin@yellowfin.com.au</messages>
                <messages>Web Service Request Complete</messages>
                <person><sessionId>b1f1b17d503e1e11c05b72e674bc80ec</sessionId>
                   <emailAddress>binish.sheikh@yellowfin.com.au</emailAddress><statusCode>SUCCESS</statusCode>
                   <firstName>Binish</firstName></return>
          </ns2:remoteAdministrationCallResponse>
            <ipId>13000</ipId>
                   <lastName>Sheikh</lastName>
                   <roleCode>YFADMIN</roleCode>
                   <status>ACTIVE</status>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストです。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
      rsr.setFunction("CREATEGROUP");
    • 特定のクライアントに新規グループを追加する場合は、クライアント組織IDを含めます。(こちらを指定しない場合は、デフォルト(プライマリー)組織にグループが作成されます。)

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    • 追加する新規グループのパラメーターを設定します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new AdministrationGroup();
      group.setGroupName("Test Group");
    • グループにメンバーを含めます。例:

       

      Code Block
      themeEclipse
      languagejava
      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
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    <timeZoneCode>AUSTRALIA/BRISBANE</timeZoneCode>*                <userId>binish.sheikh@yellowfin.com.au</userId>
                </person>ws_creategroup.jsp               <sessionId>586e172a7c4850bb3edbaaf5264a312d</sessionId>  */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page  <statusCode>SUCCESS</statusCode>
             </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    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オブジェクトを使用します。

     

  • Expand
    title詳細手順
    Code Block
    themeEclipse
    languagejava
    こちらは、この呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    AdministrationPerson ap = new AdministrationPerson();
     
    ap.setUserId("john.smith@yellowfin.com.au");

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

     

    Code Block
    themeEclipse
    languagejava
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    <%           
    /*             ws_updateuser.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");           are optional.
     
    //Add members:
    AdministrationGroupMember[] member = new AdministrationGroupMember[2];
    member[0] = new AdministrationGroupMember();
    member[0].setLoginId("admin@yellowfin.com.au");
     
    member[1] = new AdministrationGroupMember();
    member[1].setLoginId("john.smith@yellowfin.com.au");
     
    group.setGroupMembers(member);
     
    rsr.setGroup(group);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
        out.write("Success");
    } else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode() );
    }
    %>
    <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>

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

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

     

    Expand
    titleMODIFYGROUP

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

    リクエスト要素

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

    リクエスト要素データ型説明

    LoginId

    String

    ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「MODIFYGROUP」に設定します。

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

     

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

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

     

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

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

     

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

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

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

     

    リクエストの要素

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

    リクエスト要素データ型説明

    LoginId

    String

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

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「SETAVATARIMAGE」に設定します。

    PersonAdninistrationPerson

    プロフィール画像を変更するユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

    ParametersString[]アップロードされるプロフィールど画像を表示する単一要素を含む配列です。画像は、文字列に変換可能な、UTF-8形式のバイト配列でなければいけません。

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

    AdministrationPerson要素データ型説明

    IpId

    Integer

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

     

    リクエストの例

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

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

     

    応答の要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

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

    Code Block
    themeEclipse
    languagexml
    <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>         <arg0>
                <loginId>admin@yellowfin.com.au</loginId><errorCode>0</errorCode>
                <password>test</password>
                <orgId>1</orgId>    <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
                <messages>Web Service Request <function>SETAVATARIMAGE<Complete</function>messages>
                <person><sessionId>6589bf668504fd3468e0b43844550a22</sessionId>
                <statusCode>SUCCESS</statusCode>
       <ipId>5</ipId>      </return>
          </person>ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストです。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      
    <parameters> <string>iVBORw0KGgoAAAANSUhEUgAAAdsAAA ... your image string</string> </parameters> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>

     

    応答のパラメーター

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

    • rsr.setOrgId(1);
       
      rsr.setFunction("MODIFYGROUP");
    • 特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。(こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。)

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    • 新規グループのパラメーターを設定します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new AdministrationGroup();
      group.setGroupName("Test Group");
    • グループにメンバーを含めます。例:

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroupMember[] member = new AdministrationGroupMember[1];
       
      member[0] = new AdministrationGroupMember();
      member[0].setLoginId("admin@yellowfin.com.au");
       
      group.setGroupMembers(member);
       
      rsr.setGroup(group);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE
     

    完成例

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    Code Block
    themeEclipse
    languagejava
    <%           
    /* <messages>Web Service Request Complete</messages>          ws_modifygroup.jsp   <sessionId>5fbbf0f2d8a6f4902adde5bfb659fed7</sessionId>             <statusCode>SUCCESS<*/statusCode>
    %>
    <%@ page       </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("SETAVATARIMAGE");
    • IP IDを提供することで、ユーザーを指定することができます。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
      ap.setIpId(5);
       
      rsr.setPerson(ap);
    • java.nio.fileライブラリを使用して画像ファイルを選択します。

       

      Code Block
      themeEclipse
      languagejava
      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
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%          
    /*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_setavatarimagemandatory.jsp 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);
     
      */
    %>
    <%@ 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.*" %>
    <%@ 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");      rsr.setGroup(group);
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
        out.write("Success");
    } else {
        out.write("Failure");
        out.write(" Code: " + rs.getErrorCode() );
    }
    %>
    Expand
    titleRENAMEGROUP

    こちらの関数は、グループの名前を変更するために使用されます。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」に設定します。

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

     

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

    AdministrationGroup要素データ型説明
    GroupIdIntegerグループを識別するための内部IDです。
    GroupNameStringグループの新しい名前です。
    GroupDescriptionStringグループの説明です。

     

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

    Code Block
    themeEclipse
    languagexml
    <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>
        // 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<function>RENAMEGROUP</function>
    account rsr.setOrgId(1); rsr.setFunction("SETAVATARIMAGE");    AdministrationPerson ap = new AdministrationPerson(); ap.setIpId(5); <group>
      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()) ) { <groupId>13001</groupId>            
                    <groupName>Report Creators</groupName>
                    <groupDescription>Users of this group will create out.write("<br>Success");
    } else {reports.</groupDescription>
                </group>       out.write("Failure");            
        out.write(" Code: " + rs.getErrorCode()); }
    %>

     

     

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

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

     

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

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

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

     

    Expand
    titleLOGOUTUSER

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

    Code Block
    languagejava
    String token = response.getLoginSessionId();

     

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

    Code Block
    languagejava
    request.setLoginSessionId(token);

     

    リクエストの要素

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

    リクエスト要素データ型説明

    LoginId

    String

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

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「LOGOUTUSER」に設定します。

    PersonAdninistrationPerson

    プロフィール画像を変更するユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

    LoginSessionIdString終了しなくてはいけないYellowfinインスタンスのセッショントークンです。これは、ユーザーを識別するに十分です。

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

    AdministrationPerson要素データ型説明

    UserId

    String

    詳細を変更するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

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

     

    リクエストの例

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

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

     

    応答の要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

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

    Code Block
    themeEclipse
    languagexml
    <soapenv<S:Envelope xmlns:soapenvS="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>
     <S:Body>
          <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
      <password>test</password>       <return>
         <orgId>1</orgId>       <errorCode>0</errorCode>
         <function>LOGOUTUSER</function>       <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
      <person>          <messages>Web Service Request Complete</messages>
                 <userId>admin@yellowfin.com.au</userId><sessionId>2ca79b1696913aa7a4f8b601ac1641a4</sessionId>
                <statusCode>SUCCESS</statusCode>
       <password>test</password>      </return>
          </person>ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストです。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      
    <loginSessionId>39fb11047affb98c9d081fb48bed0093</loginSessionId> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>

     

    応答の要素

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

    • rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
      rsr.setFunction("RENAMEGROUP");
    • 特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。(こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。)

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    • 名前を変更するグループを定義します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new AdministrationGroup();
    • グループIDを使用して、グループを識別します。

       

      Code Block
      themeEclipse
      languagejava
      group.setGroupId(13002);
    • 新しいグループ名と説明を提供します。

       

      Code Block
      themeEclipse
      languagejava
      group.setGroupName("Org 1");
      group.setGroupDescription("Organization 1 user group");
       
      rsr.setGroup(group);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE
     

    完成例

    応答の例

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

    Code Block
    themeEclipse
    languagexml
    Code Block
    themeEclipse
    languagejava
    <%           
    /* <messages>Web Service Request Complete</messages>          ws_renamegroup.jsp   <sessionId>9cad6c76734e329c298e7b15c57a19db</sessionId>             <statusCode>SUCCESS<*/statusCode>
    %>
    <%@ page       </return>
          </ns2:remoteAdministrationCallResponse>
       </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    以下は、こちらの呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("LOGOUTUSER");
    • ログインセッションIDを渡します。

       

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

       

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

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

       

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

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

     

     

    完成例

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

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

     

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%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                */ %> <%@ 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 of the account above
    rsr.setOrgId(1);
     
    rsr.setFunction("RENAMEGROUP");
     
    rsr.setOrgRef("org1");                        // adjust host and port number
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr provide org reference if required. Default org will be searched otherwise
     
    AdministrationGroup group = new AdministrationServiceRequestAdministrationGroup();
     
    String token = request.getParameter("token"group.setGroupId(13002);   if    (token == null) {           //login the admin user: // identify the group to rename
    rsrgroup.setLoginIdsetGroupName("admin@yellowfin.com.auOrg1");          //  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.setOrgId(1);
    rsr.setGroup(group);
     
     
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
        rsrout.setFunctionwrite("LOGINUSERSuccess.<br>");
    } else {
       AdministrationPerson ap = new AdministrationPerson( out.write("Failure");
        out.write(" Code: 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...");
     " + rs.getErrorCode());
    }
    %>
    Expand
    titleINCLUDEUSERINGROUP

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

     

    リクエストパラメーター

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

    リクエスト要素データ型説明

    LoginId

    String

    ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「DELETEGROUP」に設定します。

    GroupAdministrationGroup削除するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
    OrgRefString特定のクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。

     

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

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

     

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

    Code Block
    themeEclipse
    languagexml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
       <soapenv:Header/>
       <soapenv:Body>
          <web:remoteAdministrationCall>
          out.write("<BR>Login: <A href='http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "'>"); <arg0>
               out.write("http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "</a><br>");<loginId>admin@yellowfin.com.au</loginId>
                out.write("<BR>Logout: <A href='http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "'>");<password>test</password>
               out.write("http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "</a><br>");<orgId>1</orgId>
               <function>DELETEGROUP</function>
          } else {   <group>
         out.write("Failure");       <groupName>Admin</groupName>
     out.write(" Code: " + rs.getErrorCode() );     </group>    return;     }
    } else {       <//logoutarg0>
    the user:     </web:remoteAdministrationCall>
     out.write("Trying to logout " + token + " session...<br>");
     
        rsr = new AdministrationServiceRequest();
     
        rsr.setLoginId("admin@yellowfin.com.au");</soapenv:Body>
    </soapenv:Envelope>

     

    応答のパラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

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

    Code Block
    themeEclipse
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
             //<return>
    provide your Yellowfin web services admin account     rsr.setPassword("test");  <errorCode>0</errorCode>
                <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
             // set the password<messages>Web ofService the above account
        rsr.setOrgId(1);Request Complete</messages>
          rsr.setFunction("LOGOUTUSER");       rsr.setLoginSessionId(token);<sessionId>db18f2503e80ca02a9d37da13fc540a5</sessionId>
           AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);  <statusCode>SUCCESS</statusCode>
        if ("SUCCESS".equals(rs.getStatusCode()) ) {  </return>
          out.write("Logout: Success");</ns2:remoteAdministrationCallResponse>
       </S:Body>
     } else {
            out.write("Failure");
            out.write("Code: " + rs.getErrorCode() );
        }
    }
    %>
    Expand
    titleLOGOUTBYUSERID

    こちらのサービスは、指定したユーザーをログアウトすることで、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」に設定します。

    PersonAdninistrationPerson

    ログアウトするユーザーの詳細を含むオブジェクトです。注意:以下の表を参照してください。

     

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

    AdministrationPerson要素データ型説明

    UserId

    String

    Yellowfinのセッションを終了するユーザーを識別するためのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    IpIdStringセッションを終了するユーザーのIp IDです。

     

    リクエストの例

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

    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストから開始します。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
      rsr.setFunction("DELETEGROUP");
    • 特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    • 削除するグループのパラメーターを設定します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new AdministrationGroup();
      group.setGroupName("Test Group");
       
      rsr.setGroup(group);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE

    完成例

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

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

     

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall>
    Code Block
    themeEclipse
    languagexml
    java
    <%           
    /*              ws_deletegroup.jsp                */
    %>
    <%@ page language="java" contentType="text/html; charset=UTF-8" %>
    <%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
    <%@ page import="com.hof.web.form.*" %>
    <%@ page import="com.hof.mi.web.service.*" %>
    <%
    AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
     
    AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
    rsr.setPassword("test");              <arg0>             <loginId>admin@yellowfin.com.au</loginId>
                <password>test</password>// set the password of the above account
     
    rsr.setOrgId(1);
     
    rsr.setFunction("DELETEGROUP");
     
    rsr.setOrgRef("org1");               <orgId>1</orgId>             <function>LOGOUTBYUSERID<//function> specify a client org reference if required. Or skip this to search <person>through the default org
     
     
    AdministrationGroup group = new AdministrationGroup();
     
    group.setGroupName("Test Group");           <userId>admin@yellowfin.com.au</userId>
              // this group must exist in the specified client org
     
     
    rsr.setGroup(group);
     
    <password>test</password> 
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
     
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
     </person>   out.write("Success.<br>");
    } else {
       </arg0>
     out.write("Failure");
         </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答の要素

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

    応答の例

    以下は、上記のSOAPの呼び出しの応答です。
    out.write(" Code: " + rs.getErrorCode());
    }
    %>

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

     

    リクエストパラメーター

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

    リクエスト要素データ型説明

    LoginId

    String

    ログインをして、この関数を実行する、Webサービス管理者ユーザーのIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。

    このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。

    Password

    String

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

    OrgId

    Integer

    Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。

    Function

    String

    Webサービス関数です。こちらは、「DELETEGROUP」に設定します。

    GroupAdministrationGroup削除するユーザーグループの詳細を含むオブジェクトです。以下の表を参照してください。
    OrgRefString特定のクライアント組織に新規グループを追加する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。

     

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

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

     

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

    以下は、こちらの呼び出しの基礎的なリクエストであり、管理ユーザーとしてのログインと、実行するWebサービスの呼び出しの指定を含みます。
    Code Block
    themeEclipse
    languagexml
    <S
    <soapenv:Envelope xmlns:
    S
    soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    > <S:Body>
     
    <ns2:remoteAdministrationCallResponse
    xmlns:
    ns2
    web="http://webservices.web.mi.hof.com/">
       
    <return> <errorCode>0</errorCode>
    <soapenv:Header/>
       <soapenv:Body>
          
    <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages>
    <web:remoteAdministrationCall>
           
    <sessionId>f8a04d7c9530ff18f65f95048e6a4500</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    Code Block
    themeEclipse
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(1);
     
    rsr.setFunction("LOGOUTBYUSERID");

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

     

    Code Block
    themeEclipse
    languagejava
    AdministrationPerson ap = new AdministrationPerson(); ap.setUserId(userId);
      <arg0>
               <loginId>admin@yellowfin.com.au</loginId>
               
    rsr.setPerson(ap);
  • ユーザーが複数のTomcatセッションに同時にログインしている場合は、パラメーターを設定することで、どのセッションを終了するのかを指定することができます。例:

     

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

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

     

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

     

    Code Block
    themeEclipse
    languagejava
    AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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

  •  

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

     

     

    完成例

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

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

     

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%
    <password>test</password>
               <orgId>1</orgId>
               <function>DELETEGROUP</function>
          
    /*
         <group>
            
    test.jsp
        <groupName>Admin</groupName>
               
    *
    </group> 
    %>
        
    <%@
     
    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) {
      
             </arg0>
          </web:remoteAdministrationCall>
       </soapenv:Body>
    </soapenv:Envelope>

     

    応答のパラメーター

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

    応答要素データ型説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

     

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

    Code Block
    themeEclipse
    languagexml
    <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>
               
    //login
     
    the
    <messages>Successfully 
    admin
    Authenticated 
    user
    User: 
    rsr.setLoginId("
    admin@yellowfin.com.
    au"); // provide your Yellowfin web services admin account
    au</messages>
             
    rsr.setPassword("test");
       <messages>Web Service Request Complete</messages>
                <sessionId>db18f2503e80ca02a9d37da13fc540a5</sessionId>
            
    //
     
    set
     
    the
     
    password
     
    of
    <statusCode>SUCCESS</statusCode>
    
    the
     
    above
     
    account
         
    rsr.setOrgId(1);
      </return>
      
    rsr.setFunction("LOGINUSER");
        </ns2:remoteAdministrationCallResponse>
       
    AdministrationPerson ap
    </S:Body>
    </S:Envelope>

     

    手順

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

    Expand
    title詳細手順
    • 以下は、こちらの関数の基礎的なリクエストから開始します。

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceRequest rsr = new 
    AdministrationPerson
    • AdministrationServiceRequest();
       
      rsr.setLoginId("admin@yellowfin.com.au");
      rsr.setPassword("test");
      rsr.setOrgId(1);
       
    userId = "john.smith@yellowfin.com.au"; ap.setUserId(userId); ap.setPassword("test"); rsr.setPerson(ap);
    • 
      rsr.setFunction("DELETEGROUP");
    • 特定のクライアント組織に所属するグループを検索する場合は、クライアント組織IDを含めます。こちらを指定しない場合は、デフォルト(プライマリー)組織内のグループが検索されます。

       

      Code Block
      themeEclipse
      languagejava
      rsr.setOrgRef("org1");
    • 削除するグループのパラメーターを設定します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationGroup group = new AdministrationGroup();
      group.setGroupName("Test Group");
       
      rsr.setGroup(group);
    • リクエストの構成が完了したら、呼び出しを実行します。

       

      Code Block
      themeEclipse
      languagejava
      AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
    if ("SUCCESS".equals(rs.getStatusCode()) ) {
    • 管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

     

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

      応答要素データ型説明

      StatusCode

      String

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

      • SUCCESS
      • FAILURE

    完成例

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

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

     

    Code Block
    themeEclipse
    languagejava
    <%           
    String
    
    
    token_
    /* 
    =
     
    rs.getLoginSessionId();
             
    out.write("Login
     
    by
     
    opening the link in a new subtab prior to Logout. The tomcat session must be initialized...");
     ws_deletegroup.jsp              
    out.write("<BR>Login:
     
    <A href='http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "'>"); out.write("http://localhost:8080/logon.i4?LoginWebserviceId=" + token_ + "</a><br>"); out.write("<BR>Logout: <A href='http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "'>"); out.write("http://localhost:8080/test.jsp?token=" + token_ + "&userId=" + userId + "</a><br>"
     */
    %>
    <%@ 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);       
    }else {
     // adjust host and port number
     
    AdministrationServiceSoapBindingStub 
    out.write("Failure"
    adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
     
    
    out
    rsr.
    write
    setLoginId("
    Code: " + rs.getErrorCode() ); return; } } else {
    admin@yellowfin.com.au");          //
    logout
     
    the
    provide 
    user:
    your Yellowfin web services admin 
    out.write("Trying to logout " + userId + " session...<br>");
    account
    rsr.setPassword("test");            
    rsr
     
    =
     
    new AdministrationServiceRequest();
           
    rsr.setLoginId("admin@yellowfin.com.au");
          // set the password 
    //
    of 
    provide
    the 
    your
    above 
    Yellowfin
    account
    
    web
     
    services admin account
    
    rsr.setOrgId(1);
     
    rsr.setFunction("DELETEGROUP");
     
    rsr.
    setPassword
    setOrgRef("
    test
    org1");                            // 
    change to the password of the above account rsr.setOrgId(1);
    specify a client org reference if required. Or skip this to search through the default org
     
     
    AdministrationGroup group = new AdministrationGroup();
     
    
    rsr
    group.
    setFunction
    setGroupName("
    LOGOUTBYUSERID
    Test Group");       
    AdministrationPerson
     
    ap
     
    =
     
    new
     
    AdministrationPerson();
      // this 
    ap.setUserId(userId);
    group must exist in the specified client org
     
     
    rsr.
    setPerson
    setGroup(
    ap
    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()
    );
    
    }
    
    }
    %>