Page Comparison

...

Expand

title	ADDUSER

こちらの関数は、Yellowfinに新規ユーザーアカウントを作成します。

リクエストパラメーター

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

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

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

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

リクエストの例

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

Code Block

theme	Eclipse
language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ADDUSER</function>       
            <person>
                <userId>binish.sheikh@yellowfin.com.au</userId>
                <emailAddress>binish.sheikh@yellowfin.com.au</emailAddress>
                <password>admin</password>
                <firstName>Binish</firstName>
                <lastName>Sheikh</lastName>
                <roleCode>YFREPORTCONSUMER</roleCode>
            </person>         
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

応答の例

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

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Creating New User via Webservices...</messages>
            <messages>Creating SessionBean for webservices user...</messages>
            <messages>Looking up user...</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>8090cb7879f7d5e72eab9625772c00b5</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

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

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();


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

rsr.setFunction("ADDUSER");

特定のクライアント組織に新規ユーザーを作成する場合は、こちらをコードに追加します。
Code Block
theme Eclipse
language java
rsr.setOrgRef("org1"); // A new user will be added to the client org with "org1" as an organization reference ID
orgRefパラメーターを定義しない場合は、新規ユーザーはデフォルト（プライマリー）組織内に作成されます。

ADDUSER関数は、新規Yellowfinユーザーの詳細を定義するために、AdministrationPersonオブジェクトを要求します。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson();

新規ユーザーを作成するには、これら必須パラメーターの提供が必要です。：UserId、FirstName、LastName、RoleCode、Password、EmailAddress

Code Block

theme	Eclipse
language	java

ap.setUserId("john.smith@yellowfin.com.au");      // if Yellowfin authentication option is set to "email address"
ap.setFirstName("John");
ap.setLastName("Smith");
ap.setRoleCode("YFREPORTCONSUMER");                // Yellowfin role codes can be found performing this query against
                                                   // Yellowfin configuration database: SELECT * FROM OrgRole

ap.setPassword("test");                              // Password must comply with your Yellowfin password policy
ap.setEmailAddress("john.smith@yellowfin.com.au");

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

リクエストに「ap」オブジェクトを渡します。
Code Block
language java
rsr.setPerson(ap);

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_adduser.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 service admin account
rsr.setPassword("test");                           // change this to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("ADDUSER");
 
 
AdministrationPerson ap = new AdministrationPerson();
 
 
ap.setUserId("john.smith@yellowfin.com.au");      // If Yellowfin authentication option is set to "email address"
ap.setFirstName("John");
ap.setLastName("Smith");
ap.setRoleCode("YFREPORTCONSUMER");                // Yellowfin role codes can be found performing this query against
                                                   // Yellowfin configuration database: SELECT * FROM OrgRole
 
ap.setPassword("test");                          // Password must comply with your Yellowfin password policy
ap.setEmailAddress("john.smith@yellowfin.com.au");
rsr.setPerson(ap);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if
("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>

...

Expand

title	GETAVATARS

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

リクエスト要素

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

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

リクエストの例

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

Code Block

theme	Eclipse
language	java

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
           <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETAVATARS</function>
            <parameters>5</parameters>
         </arg0>
    </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答のパラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

binaryAttachments

ReportBinaryObject[]

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

応答の例

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

Code Block

theme	Eclipse
language	java

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <binaryAttachments>
<errorCode>0</errorCode>             <messages>Successfully Authenticated User:<data>iVBORw0KGgoAAAANSUhEUgAAA admin@yellowfin..com.au</messages> your            <messages>Getting user information...</messages>image string</data>
            <messages>Getting user information...</messages>binaryAttachments>
            <messages>Web Service Request Complete</messages><errorCode>0</errorCode>
            <person><messages>Successfully Authenticated               <emailAddress>admin@yellowfinUser: admin@yellowfin.com.au</emailAddress>messages>
            <messages>Web Service Request <firstName>System<Complete</firstName>messages>
               <initial/><sessionId>5547ebe153fd0fc7fcf63014ffe61b5c</sessionId>
               <ipId>5</ipId><statusCode>SUCCESS</statusCode>
         </return>
      <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:ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

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

Code Block

theme	Eclipse
language	java

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

IpIdを提供し、詳細を取得するユーザーを識別するために、AdministrationPersonオブジェクトを使用します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson();
 
ap.setIpId(5);                  //IpId of the ();
 
rsr.setLoginId("admin@yellowfin.com.au account");
rsr.setPassword("test");
rsr.setPersonsetOrgId(ap1);

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

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse
rs =
adminServicersr.remoteAdministrationCallsetFunction(rsr"GETAVATARS");

管理Webサービスを初期化します。実行方法の詳細は、こちらを参照してください。ユーザーのIP IDを指定することができます。

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

Code Block

theme	Eclipse
language	java

<%

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

Code Block

theme	Eclipse
language	java

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

完成例

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

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

rsr.setParameters(new String[] {"5","13073"});

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

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

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

完成例

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

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

Code Block

theme	Eclipse
language	xml

<%           
/*              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");         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 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) adjust{
host and port number   AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService()byte[] data,encodeBase64;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au")String base64Encoded;
 
       // provide your Yellowfin web services admin account
rsr.setPassword("test");for(ReportBinaryObject o: objects){
            data = o.getData();
            if (data != null){
// change
to the password of the above account rsr.setOrgId(1); rsr.setFunction("GETUSERBYIP");   AdministrationPerson ap = new AdministrationPerson(); encodeBase64 = ap.setIpId(5);
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {java.util.Base64.getEncoder().encode(data);
                apbase64Encoded = new rs.getPerson(String(encodeBase64, "UTF-8");
    out.write("User Id: " + ap.getUserId() + "<br>");     out.write("Password: " + ap.getPassword() + "<br>"); if (base64Encoded != null) 
     out.write("First Name: " + ap.getFirstName() + "<br>");     out.write("Last Name: " + apout.getLastNamewrite() + "<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>");<img src="data:image/jpg;base64,<%=base64Encoded%>" alt="No image">
        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() );
}
%>
</body>
</html>

Expand

title	GETUSERFROMSEARCH

この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERSFROMSEARCH”		Webサービス関数です。
Parameters	Array（String）	Yellowfinユーザーの名、姓、および電子メールアドレスと照合する検索文字列です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

People

Array（AdministrationPerson）

「AdministrationPerson」オブジェクトの配列です。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。

...

Version	Old Version 5	New Version 6
Changes made by	Yellowfin Admin	Yellowfin Admin
Saved on	Mar 23, 2018	Mar 23, 2018

Versions Compared

Key

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例

リクエスト要素

リクエストの例

応答のパラメーター

応答の例

手順

完成例

完成例