Page Comparison

Anchor

	top
	top

Yellowfinには、クライアント組織と呼ばれる機能があり、同一のサーバインスタンス上に複数のYellowfinの仮想インスタンスを同居させることができます。この方法により、ある組織内で非公開コンテンツを作成し、その組織に所属するユーザーのみアクセス可能に設定することができます。これは、同一サーバにログインをする、他の組織に所属するユーザーからは非表示になります。以下のwebサービスの呼び出しは、こちらの機能を管理するために使用します。

注意：こちらの機能を使用するためには、Yellowfinインスタンスでクライアント組織機能を有効にします。

Image RemovedYellowfinには、クライアント組織と呼ばれる機能があり、同一のサーバインスタンス上に、複数のYellowfinの仮想インスタンスを同居させることができます。この方法により、ある組織内で非公開コンテンツを作成し、その組織に所属するユーザーのみアクセス可能に設定することができます。これは、同一サーバにログインをする、他の組織に所属するユーザーからは非表示になります。以下のwebサービスの呼び出しは、こちらの機能を管理するために使用します。

注意：こちらの機能を使用するためには、Yellowfinインスタンスでクライアント組織機能を有効にします。

Image Added

Expand

title	CREATECLIENT

Yellowfinに新規クライアント組織を作成する場合は、こちらのwebサービスの呼び出しを使用します。新規クライアントの詳細を提供するために、AdministrationClientOrgオブジェクトが要求されます。

リクエストパラメーター

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

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

以下は、こちらのwebサービスの呼び出しのAdministrationClientOrgオブジェクトに設定することのできる主要なパラメーターです。

AdministrationClientOrg要素	データ型	説明
ClientReferenceID	String	新規クライアントを識別するために使用する一意のIDです。これは、必須パラメーターです。
ClientName	String	新規クライアント組織の名前です。
TimeZoneCode	String	クライアント組織のローカルタイムゾーンコードです。
DefaultOrg	Boolean	作成する組織がプライマリー組織の場合は、こちらの値をtrueに設定します。

リクエストの例

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

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>CREATECLIENT</function>
            <client>
                <clientReferenceId>org2</clientReferenceId>
                <clientName>ABC Organization</clientName>
                <defaultOrg>false</defaultOrg>
            </client>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

応答の例

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

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>9204e289ced6e9ea7ed52b3cc5765663</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

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

Expand

title	詳細手順

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

Code Block

theme	Eclipse
language	java

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

新規クライアントの情報を提供します。

Code Block

theme	Eclipse
language	java

AdministrationClientOrg ac = new AdministrationClientOrg();

ac.setClientReferenceId("org2");                  // Mandatory. Other parameters are optional
ac.setClientName("Organization 2");
ac.setTimeZoneCode("AUSTRALIA/SYDNEY");
ac.setDefaultOrg(false);

rsr.setClient(ac);

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

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

完成例

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

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

Code Block

theme	Eclipse
language	java

<%           
/*              ws_createclient.jsp              */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set to the password of the above account
rsr.setOrgId(1);
 
rsr.setFunction("CREATECLIENT");
 
AdministrationClientOrg ac = new AdministrationClientOrg();
ac.setClientReferenceId("org2");                   // mandatory. Other parameters are optional
ac.setClientName("Organization 2");
ac.setTimeZoneCode("AUSTRALIA/SYDNEY");
ac.setDefaultOrg(false);
 
rsr.setClient(ac);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Success");      
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>

...

Version	Old Version 2	New Version 3
Changes made by	Yellowfin Admin	Yellowfin Admin
Saved on	Mar 28, 2018	Mar 28, 2018

Versions Compared

Key

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例