Page History

Versions Compared

Key

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

...

Expand

title	ASSIGNDEFAULTDASHBOARD

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

リクエストパラメーター

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

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

Anchor

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

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

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

Anchor

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

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

ContentResource要素	データ型	説明
ResrouceIdResourceId	Integer	ダッシュボードのIDです。
ResourceType	String	固定値「GROUP」に設定しなくてはいけません。この値が正しく設定されていない要素は無視されます。

リクエストの例

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

Code Block

language	xml
theme	Eclipse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ASSIGNDEFAULTDASHBOARD</function>
            <group>
                <groupName>Administrators</groupName>
                <groupId>11950</groupId>
            </group>
            <contentResources>
                <resourceId>61251</resourceId>
                <ResourceType>GROUP</ResourceType>
            </contentResources>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答のパラメーター

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

応答の例

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

Code Block

language	xml
theme	Eclipse

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

手順

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

Expand

title	詳細手順

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

Code Block

language	java
theme	Eclipse

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

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

Code Block

language	java
theme	Eclipse

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

ContentResourceオブジェクトを使用して、ダッシュボードを指定します。

Code Block

language	java
theme	Eclipse

ContentResource dashboardContentResource = new ContentResource();
dashboardContentResource.setResourceId(61195);
dashboardContentResource.setResourceType("GROUP");

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

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

完成例

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

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

Code Block

language	java
theme	Eclipse

<%           
/*              ws_assigndefaultdashboard.jsp               */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("ASSIGNDEFAULTDASHBOARD");
     
// This is the group
AdministrationGroup administrationGroup = new AdministrationGroup();
administrationGroup.setGroupName("Administrators");
administrationGroup.setGroupId(11950);
     
rsr.setGroup(administrationGroup);
 
// This is the Dashboard
ContentResource dashboardContentResource = new ContentResource();
dashboardContentResource.setResourceId(61195);
dashboardContentResource.setResourceType("GROUP");
     
rsr.setContentResources(new ContentResource[] { dashboardContentResource });
     
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(rs.toString());
}
%>

horizontalrule

Styleclass

Class	topLink

ページトップ

...

Content

Space Tools

Versions Compared

Old Version 12

New Version 13

Key

リクエストパラメーター

リクエストの例

応答のパラメーター

応答の例

手順

完成例