管理サービス

注意：こちらに掲載されているすべてのコードは、「疑似コード」です。実際に使用するコードは、ユーザーの使用環境により異なります。こちらの例は、あくまで参照目的でご利用ください。

シングルサインオン

LOGINUSER（シングルサインオン）

このサービスは、Yellowfinに接続し、指定されたユーザーのログオントークンを取得します。このトークンがYellowfinログオンURLに渡されると、認証されるユーザーのログイン画面が無効化され、そのユーザーのセッションがただちに開始されます。

AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
   
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("LOGINUSER");
     
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
ap.setPassword("test");
rsr.setPerson(ap);
     
rs = rssbs.remoteAdministrationCall(rsr);
    
if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
	out.write("Success");
	out.write("URL:  http://<yellowfin-server>/logon.i4?LoginWebserviceId=" + rs.getLoginSessionId()); 
                			
} else {
			
	out.write("Failure");
				
}

「LOGINUSER」関数は、指定されたユーザーをYellowfinにシングルサインオンさせます。「AdministrationPerson」オブジェクトの内容は、ログインしているユーザーを定義するために使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LOGINUSER”		Webサービス関数です。
Person	AdministrationPerson	ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。
OrgRef	String	クライアント組織の内部参照IDです（こちらの設定は、オプションです）。ユーザーを、指定されたクライアント組織にログインさせます。こちらを設定しない場合、ユーザーのログオン時に「クライアント組織の選択」ページが表示されます。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

LoginSessionId

String

一意のログイントークンです。このトークンは、ログインURLに付加され、ユーザーをYellowfinに直接移動させます。

ログイントークンを使用したYellowfinへのリダイレクト

Webサービス呼び出しから受信したトークン（AdministrationResponse.LoginSessionIdのコンテンツ）を使用して、ユーザーを以下のURLに転送することができます。

http://<YELLOWFIN-SERVER>/logon.i4?LoginWebserviceId=<TOKEN>

このURLを使用することにより、Yellowfinの認証画面がバイパスされ、ユーザーはYellowfinに直接移動します。

トークンには有効期限があります。5分以内に使用する必要があり、一旦使用すると再利用はできません。サードパーティアプリケーションから、Yellowfinに呼び出しを行う場合は、LOGINUSER Webサービスを、再度呼び出す必要があります。

JavaScript APIでのトークンの使用

埋め込みJavaScript APIウィジェットで、SSO（シングルサインオン）トークンを使用することもできます。トークンは、以下のように、スクリプトレットURLに追加されます。

<script type="text/javascript" src="http://localhost/JsAPI?dashUUID=e9a6ab0a-bcb0-4fe6-9663-4dd33e58f08e&token=<TOKEN>"></script>

セッションオプションの指定

このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える、変数/スイッチを渡すことができます。このようなオプションを有効にするには、「AdministrationRequest」でParameters属性を使用して渡すか、リダイレクトURLに付加します。

パラメーターは、以下のようにキー値ペアの一覧として、「AdministrationRequest.Parameters」属性に追加されます。

YFTOOLBAR=TRUE

ENTRY=DASHBOARD

ログインURLで渡されるオプションは、以下のようになります。

http://<yellowfin-server>/logon.i4?LoginWebserviceId=<token>&yftoolbar=true&entry=DASHBOARD

使用可能なオプション一覧は、以下の通りです。

パラメーターオプションキー	URLオプションキー	説明
YFTOOLBAR	yftoolbar	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinツールバーを隠します。
ENTRY	entry	ログインプロセス完了時の、ユーザーの唯一のエントリーポイントを指定します。他のパラメーターとともに使用することで、ユーザーに表示される内容を指定します。値の選択肢は、以下の通りです。 `DASHBOARD` `REPORTLIST` `BROWSE` `BROWSETAB` `CREATEREPORT` `EDITREPORT` `VIEWREPORT` `ADMINISTRATION` `EDITDASHBOARD` `VIEWDASHBOARD` `VIEWSTORYBOARD` `TIMELINE`
REPORTID	reportid	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートの内部IDです。
REPORTUUID	reportuuid	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートのUUIDです。
STORYBOARDUUID	storyboarduuid	`「ENTRY = VIEWSTORYBOARD」`とともに使用します。これは、リダイレクト先ストーリーボードのUUIDです。
MOBILEDEVICE	mobiledevice	`「TRUE」、または「FALSE」に設定します`。ユーザーを、Yellowfinインターフェースのモバイルバージョンに移動させます。
REPORTNAME	reportname	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートの名前です。
DISABLESOURCEFILTERS		`「TRUE」、または「FALSE」に設定します`。このセッションにおける、このユーザーのソースフィルター、またはクライアント参照フィルターを無効化します。これにより、ユーザーはすべてのデータを参照することができます。クライアントソースの置換に基づくコンテンツには、機能しません。
DISABLEHEADER	disableheader	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinヘッダーを隠します。
HIDEHEADER	hideheader	`「DISABLEHEADER」`と同様です。
DISABLEFOOTER	disablefooter	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinフッターを隠します。
HIDEFOOTER	hidefooter	`「DISABLEFOOTER」`と同様です。
DISABLESIDENAV	disablesidenav	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinサイドナビゲーションを隠します。
HIDESIDENAV	hidesidenav	`「DISABLESIDENAV」`と同様です。
DISABLELOGOFF	disablelogoff	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinログオフリンクを隠します。
HIDELOGOFF	hidelogoff	`「DISABLELOGOFF」`と同様です。
REASONCODE	reasoncode	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、JavaScript APIで使用することもできます。
REASONDESCRIPTION	reasondescription	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、JavaScript APIで使用することもできます。
DASHBOARDID	dashboardid	`「ENTRY = EDITDASHBOARD」、`または「`VIEWDASHBOARD」`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
DASHBOARDUUID	dashboarduuid	`「ENTRY = EDITDASHBOARD」、`または「`VIEWDASHBOARD」`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
FILTER<ID>	filter<ID>	`「ENTRY = VIEWREPORT」`とともに使用します。指定されたレポートのフィルター値を上書きします。「FILTER」にはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例： `FILTER2134=MALE` ひとつのレポートで、複数のフィルターを渡すことができます。
SOURCEFILTER_<FILTERCODE>		このセッションの、このユーザーのソースフィルター値を上書きします。 `「SOURCEFILTER_」`には、「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例： `SOURCEFILTER_COUNTRY=AU` ひとつのセッションで、複数のソースフィルター値を渡すことができます。こちらのオプションは、JavaScript APIで使用することもできます。
CONTENT_<INCLUDE/EXCLUDE>		このセッションで、ユーザーが持つコンテンツアクセス権を上書きします。「`CONTENT_」`には、「`INCLUDE」、`または「`EXCLUDE」`を付加します。このキーの値は、コンテンツフォルダーコードまたはコンテンツフォルダーUUIDです。 `「INCLUDE」`を選択した場合、これらは、ユーザーがアクセスできる唯一のコンテンツフォルダーになります。 `「EXCLUDE」`を選択した場合、これらの除外されたコンテンツフォルダーは、ユーザーが通常アクセスできるコンテンツから削除されます。コンテンツの「INCLUDE」、および「EXCLUDE」は、フォルダーレベルに基づきます。指定したフォルダーのすべてのフォルダーが「INCLUDE」、または「EXCLUDE」されます。フォルダーのコード、およびUUIDを使用した「INCLUDE」、または「EXCLUDE」の例： `CONTENT_INCLUDE=TUTORIAL` `CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` `CONTENT_EXCLUDE=TUTORIAL` `CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` 同じセッションで、「`INCLUDE」`と「`EXCLUDE」`の両方を使用することは論理的ではありません。このオプションは、JavaScript APIで使用することもできます。

LOGINUSERNOPASSWORD（シングルサインオン）

このサービスは、「LOGINUSER」と完全に互換がありますが、ログインするユーザーにパスワードは必要ありません。

オプションは「LOGINUSER」と同様ですが、以下の点が異なります。

「AdministrationRequest.Function」は、「LOGINUSERNOPASSWORD」に設定されます。
「AdministrationPerson.Password」は、空欄にすることができます。

この機能を有効にするためには、Yellowfinデータベースの構成テーブルに、追加のパラメーターを追加する必要があります。

IpOrg	ConfigTypeCode	ConfigCode	ConfigData
1	SYSTEM	SIMPLE_AUTHENTICATION	TRUE

データベースの変更を有効にするために、Yellowfinの再起動が必要になることがあります。

こちらの設定オプションがYellowfinに追加されていない場合、「Webサービスエラー26: UNSECURE_LOGIN_NOT_ENABLED」が発生します。

ユーザーの複製と管理

ユーザーの複製とは、OEMアプリケーション内の各ユーザーを、Yellowfinユーザーに同期させることを指します。

これにより、Yellowfinでは、ログインしているユーザーを識別し、必要に応じて、制限を適用することができます。同期は通常、OEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが静的である場合、手動で管理することもできます。

こちらのセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。

関数

ADDUSER

以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
person.setPassword("test");
person.setFirstName("Simple");
person.setLastName("Simon");
person.setInitial("S");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
out.write("Success");
				
} else {
			
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
				
}

このコードは「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、Yellowfinにユーザーを作成します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー作成プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “ADDUSER”		Webサービス関数です。
Person	AdministrationPerson	ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson 要素	データ型	説明
UserId	String	新規ユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	String	新規ユーザーのパスワードです。
FirstName	String	新規ユーザーの名です。
LastName	String	新規ユーザーの姓です。
Initial	String	新規ユーザーのミドルネームです。
SalutationCode	String	新規ユーザーの敬称です。値の選択肢、は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。
EmailAddress	String	新規ユーザーの電子メールアドレスです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

DELUSER / DELETEUSER

以下のコードは、ユーザーを削除するためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
out.write("Success");
				
} else {
			
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
				
}

このコードは「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、ユーザー削除プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、Yellowfinからユーザーを削除します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー削除プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “DELUSER”、または“DELETEUSER”		Webサービス関数です。
Person	AdministrationPerson	ユーザー削除プロセスに関するユーザー詳細のすべてを保持する、「AdministrationPerso」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ユーザー情報の取得とテスト

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

GETUSER

以下のコードは、ユーザー詳細を取得するためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
out.write("Success");
				
} else {
			
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
				
}

こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、Yellowfinの特定ユーザー詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSER”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。

GETUSERBYIP

以下のコードは、内部IpIdを介してユーザー詳細を取得するための、Yellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setIpId(5);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERBYIP");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
out.write("Success");
				
} else {
			
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
				
}

こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、Yellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERBYIP”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
IP ID	Integer\|	YellowfinユーザーのIP ID

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。

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」オブジェクトの配列です。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。

VALIDATEUSER

以下のコードは、ユーザーをテストするためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("admin@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setFunction("VALIDATEUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、成功すると、特定ユーザーの「AdministrationPerson」オブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーが、現在アプリケーション内に存在するかどうかを確認してテストします。「AdministrationPerson」オブジェクト内の詳細が、ユーザー検証プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “VALIDATEUSER”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

返されたユーザーの詳細すべてを保持する、「AdministrationPerson」オブジェクトです。

VALIDATEPASSWORD

以下のコードは、ユーザーのパスワードをテストするためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("testuser@yellowfin.com.au");
person.setPassword("test");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("VALIDATEPASSWORD");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、パスワードの有効期限が切れているかどうかを確認し、有効期限が切れていない場合は、「rs.getStatusCode()」で、「FAILURE」を返します。それ以外の場合は、「SUCCESS」を返します。

こちらの関数は、Yellowfinユーザーのパスワードをテストします。「AdministrationPerson」オブジェクト内の詳細が、パスワード検証プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “VALIDATEUSER”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ユーザー情報の操作

ユーザーの詳細は、Webサービスの呼び出しを使用して、後から変更することができます。「AdministrationPerson」オブジェクトの「User ID」フィールドは、ユーザーを識別するために使用されるため、変更することができません。「AdministrationPerson」オブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別の「CHANGEPASSWORD」関数（下記）を使用して変更することができます。

UPDATEUSER

以下のコードは、ユーザーの詳細を編集するためのYellowfin Webサービスを呼び出します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("testuser");
person.setFirstName("John");
person.setLastName("Doe");
person.setInitial("F");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("testuser@yellowfin.com.au")

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATEUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーの詳細を更新します。「AdministrationPerson」オブジェクト内の詳細が更新プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “UPDATEUSER”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで設定できるパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。
Password	String	Yellowfinユーザーのパスワードです。
FirstName	String	Yellowfinユーザーの名です。
LastName	String	Yellowfinユーザーの姓です。
Initial	String	Yellowfinユーザーのミドルネームです。
SalutationCode	String	Yellowfinユーザーの敬称です。値の選択肢は、は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。
EmailAddress	String	Yellowfinユーザーの電子メールアドレスです。
LanguageCode	String	優先言語を表す2文字のコードです。
IpId	Integer	内部Yellowfin IP IDです。
TimeZoneCode	String	YellowfinユーザーのTimeZoneCodeです。有効な値については、付録を参照してください。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

更新されたユーザーの詳細すべてを保持する「AdministrationPerson」オブジェクトです。

CHANGEPASSWORD

以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinユーザーのパスワードを変更します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
person.setPassword("testtest");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("CHANGEPASSWORD");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたYellowfinユーザーのパスワードを変更します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “CHANGEPASSWORD”		Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ユーザーに属するオブジェクトの取得

様々なWebサービス呼び出しを使用して、デフォルト組織、またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。

GETUSERREPORTS / GETALLUSERREPORTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能な「Webサービス名」を含むすべてのレポートを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERREPORTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーがアクセス可能な「Webサービス名」を含むすべてのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERREPORTS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Reports

AdministrationReport

AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

GETALLUSERREPORTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETALLUSERREPORTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERREPORTS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Reports

AdministrationReport

「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。

GETREPORTSWITHCOMMENTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのコメントされたレポートを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETREPORTSWITHCOMMENTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーがアクセス可能なYellowfin内のコメントされたすべてのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETREPORTSWITHCOMMENTS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Reports

AdministrationReport

「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。

GETFAVOURITES / GETFAVORITES

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべての「レポートのお気に入り」を返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETFAVOURITES");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETFAVOURITES”または“GETFAVORITES”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Reports

AdministrationReport

「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。

GETINBOX

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの「受信トレイ」内にあるすべてのレポートを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETINBOX");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

こちらの関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETINBOX”	String	Webサービス関数です。
OrgRef	String	この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Reports

AdministrationReport

「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。

GETUSERTABS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含まないすべてのダッシュボードタブを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReportGroups()」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERTABS”	String	Webサービス関数です。
OrgRef	String	この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ReportsGroups

AdministrationReportGroup

「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。

GETUSERTABSWITHREPORTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getReportGroups()」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、「AdministrationReportGroup」オブジェクト内に含まれます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERTABSWITHREPORTS”	String	Webサービス関数です。
OrgRef	String	この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ReportsGroups

AdministrationReportGroup

「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()」パラメーターにロードされます。

LOADTABREPORTS

こちらの関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LOADTABREPORTS”	String	Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。
ReportGroup	AdministrationReportGroup	取得プロセスに関するダッシュボードタブIDを保持する「AdministrationReportGroup」オブジェクトです。

「AdministrationPerson」、および「AdministrationReportGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

AdministrationReportGroup要素	データ型	説明
ReportGroupId	String	ダッシュボードタブIDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ReportGroups

AdministrationReportGroup

「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()」パラメーターにロードされます。

グループとロールの管理

Webサービス呼び出しを使用して、グループとロールの作成や変更をすることができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。

注意：システム構成ページで、クライアント組織機能を有効化している場合、特定のタイプの呼び出しについて適用可能な場合は、クライアント組織を指定することもできます。

LISTROLES

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getRoles()」で「AdministrationRole」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。

こちらの関数は、Yellowfin内で使用可能なすべてのロールを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LISTROLES”	String	Webサービス関数です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Role

AdministrationRole

「AdministrationRole」オブジェクトの配列です。これらのオブジェクトには、Yellowfinロールのメタデータが保持されます。

LISTGROUPS

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのグループを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get groups in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("LISTGROUPS");

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getGroups()」で「AdministrationGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LISTGROUPS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Groups

AdministrationGroup

「AdministrationGroup」オブジェクトの配列です。これらのオブジェクトには、Yellowfinユーザーグループのメタデータが保持されます。

GETGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループおよびそのメンバーを返します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);
group = rs.getGroup();

AdministrationGroupMember[] groupMembers = group.getGroupMembers();

こちらのコードは、「rs.getGroup()」で「AdministrationGroup」オブジェクトを返し、「rs.getGroupMembers()」で「AdministrationGroupMembers」の配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたYellowfinグループ、およびそのメンバーの一覧を返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。

「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Group

AdministrationGroup

グループメタデータを保持する「AdministrationGroup」オブジェクトの配列です。グループメンバーも、このオブジェクトの「GroupMembers()」のパラメーターにロードされます。

CREATEGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");
group.setGroupDescription("Group Description");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to create the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("CREATEGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

注意：「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列に入力することによって、新規作成されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。

こちらの関数は、Yellowfinグループを作成します。こちらの関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “CREATEGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。

「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。
GroupDescription	String	指定したYellowfinグループの説明です。
GroupMembers	Array（AdministrationPerson）	「AdministrationPerson」オブジェクトの配列です。これはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

INCLUDEUSERINGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループに指定されたユーザーを含めます。

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();

group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("INCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたグループに指定されたYellowfinユーザーを含めます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “INCLUDEUSERINGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

EXCLUDEUSERFROMGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。

注意：このユーザーは、グループから削除されるのではなく、グループ定義から除外されるだけです。こちらは、以下のような場合に有効です。

John Doeは、グループAのメンバーである。
グループAは、グループBのメンバーである。
John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();

group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("EXCLUDEUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。こちらは、以下のような場合に有効です。

John Doeは、グループAのメンバーである。
グループAは、グループBのメンバーである。
John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “EXCLUDEUSERFROMGROUP”	String	Webサービス関数です。
OrgRef	String	この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

DELETEUSERFROMGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();

group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、指定したグループから指定されたYellowfinユーザーを削除します。こちらのシナリオは、「EXCLUDEUSERFROMGROUP」のシナリオとは異なります。こちらの関数の場合、ユーザーはグループから完全に削除される点に注意してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “DELUSERFROMGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

MODIFYGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("MODIFYGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

注意：「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列を投入することによって、変更されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。

こちらの関数は、Yellowfinの指定されたグループの詳細を変更します。こちらの関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “MODIFYGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。

「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。
GroupDescription	String	指定したYellowfinグループの説明です。
GroupMembers	Array（AdministrationPerson）	「AdministrationPerson」オブジェクトの配列です。こちらはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、LoginIdパラメーターを設定することだけです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

DELETEGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELETEGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinから指定されたユーザーを削除します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “DELETEGROUP”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。

「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	指定したYellowfinグループの名前です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

クライアント組織機能

Yellowfinには、クライアント組織と呼ばれる機能があり、こちらの機能を使用することで、複数のYellowfin仮想インスタンスを、同じサーバーインスタンスに配置することができます。

クライアント組織機能は、以下に示す使用可能なWebサービスの呼び出しによって、管理することができます。

LISTCLIENTS

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内のすべてのクライアント組織を一覧表示します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTCLIENTS");

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfin内で使用可能なすべてのクライアント組織を一覧表示します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LISTCLIENTS”	String	Webサービス関数です。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

GETCLIENT

以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を取得します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getClient()」で「AdministrationClientOrg」オブジェクトを返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfin内の指定されたクライアント組織の詳細を取得します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETCLIENT”	String	Webサービス関数です。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

CREATECLIENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内に指定されたクライアント組織を作成します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinに指定されたクライアント組織を作成します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “CREATECLIENT”	String	Webサービス関数です。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientName	String	クライアント組織の名前です。
ClientReferenceID	String	クライアントの識別に使用される、固有のIDであるクライアント参照IDです。
TimeZoneCode	String	クライアント組織のローカルタイムゾーンコードです。
DefaultOrg	Boolean	こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

DELETECLIENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinの指定されたクライアント組織を削除します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “DELETECLIENT”	String	Webサービス関数です。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

UPDATECLIENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “UPDATECLIENT”	String	Webサービス関数です。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定できるパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientName	String	クライアント組織の名前です。
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。こちらのIDは、最初の取得プロセスに使用され、こちらの関数の使用中に変更することができない点に、注意が必要です。
TimeZoneCode	String	クライアント組織のローカルタイムゾーンコードです。
DefaultOrg	Boolean	こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

LISTUSERSATCLIENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属する、すべてのユーザーを一覧表示します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson[] people = null;

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTUSERSATCLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);
people = rs.getPeople();

こちらのコードは、「rs.getPeople()」で「AdministrationPerson」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinの指定されたクライアント組織に属する、すべてのYellowfinユーザーを一覧表示します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “LISTUSERSATCLIENT”	String	Webサービス関数です。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

People

Array（AdministrationPerson）

「AdministrationPerson」オブジェクトの配列です。各オブジェクトには、Yellowfinユーザーのメタデータが保持されます。

GETUSERACCESS

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーがアクセス可能なすべてのクライアント組織を一覧表示します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg[] clients = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERACCESS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);
clients = rs.getClients();

こちらのコードは、「rs.getClients()」で「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “GETUSERACCESS”	String	Webサービス関数です。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。

「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Clients

Array（AdministrationClientOrg）

「AdministrationClientOrg」オブジェクトの配列です。各オブジェクトには、Yellowfinクライアント組織のメタデータが保持されます。

ADDUSERACCESS

デフォルト組織への追加

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーへ、デフォルト組織へのアクセス権を追加します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
 
person.setUserId("test@yellowfin.com.au");
aco.setDefaultOrg(true);
 
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rsr.setClient(aco);
 
rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “ADDUSERACCESS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

クライアント組織への追加

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を追加します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); 

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “ADDUSERACCESS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

AdministrationClientOrg要素	データ型	説明
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

REMOVEUSERACCESS

デフォルト組織からの削除

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーから、デフォルト組織へのアクセス権を削除します。

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); 

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

こちらの関数は、Yellowfinの指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を削除します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。
Function = “REMOVEUSERACCESS”	String	Webサービス関数です。
OrgRef	String	こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。
Client	AdministrationClientOrg	取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。

「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。

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

AdministrationClientOrg要素	データ型	説明
ClientReferenceId	Integer	指定されたクライアント組織のクライアント参照IDです。

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ISREPORTFAVOURITE

この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ISUSERFAVOURITE”	String	Webサービス関数。
OrgRef	String	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ADDTOFAVOURITES / ADDTOFAVORITES

以下のコードは、Yellowfin Webサービスを呼び出し、指定されたレポートを指定されたユーザーのお気に入り一覧に追加します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDTOFAVOURITES");
rsr.setPerson(person);
rs.setReportId(12345);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ADDTOFAVOURITES"または"ADDTOFAVORITES”	String	Webサービス関数。
OrgRef	String	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

REMOVEFAVOURITES / REMOVEFAVORITES

以下のコードは、Yellowfin Webサービスを呼び出し、指定されたユーザーのお気に入り一覧に対して指定されたレポートを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEFAVOURITE");
rsr.setPerson(person);
rs.setReportId(12345);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたユーザーのレポートのお気に入り一覧に対して指定されたレポートを削除します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVETOFAVOURITES"または"REMOVETOFAVORITES”	String	Webサービス関数。
OrgRef	String	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

GETAVATARS

この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETAVATARS”	String Webサービス関数。
Parameters	Array（String）	Yellowfinユーザーの固有のID。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

BinaryAttachments

Array（ReportBinaryObject）

Base64でデコードされたアバターイメージを保持するReportBinaryオブジェクトの配列。

SETAVATARIMAGE

この関数は、Yellowfin内の指定されたユーザーのプロファイルのアバターイメージを設定します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “SETAVATARIMAGE”	String	Webサービス関数。
OrgRef	String	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
Parameters	Array（Bytes）	Base64でエンコードされたアバターイメージ。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

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

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

RELOADCODES

この関数は、Yellowfin内の指定された参照コードを再読み込みします。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADCODES”	String	Webサービス関数。
Parameters	Array（String）	参照コードの一覧。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

GEOMETRYFLUSH

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのジオメトリキャッシュをクリアします。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"48910"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinのジオメトリキャッシュをクリアします。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GEOMETRYFLUSH”	String	Webサービス関数。
Parameters	Array（String）	ジオメトリオブジェクトのキャッシュ元となるビューIDの一覧。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

REMOVEVIEW

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューのキャッシュを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"49283"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEVIEW");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinのビューのキャッシュを削除します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVEVIEW”	String	Webサービス関数。
Parameters	Array（String）	ビューIDの一覧。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

FLUSHREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHREPORT");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHREPORT”	String	Webサービス関数。
Parameters	Array（String）	レポートIDの一覧。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

FLUSHTAB

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Dashboard Tab ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHTAB”	String	Webサービス関数。
Parameters	Array（String）	タブIDの一覧。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

DELETEREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEREPORT");
// If the report ID is not set, then the code will look for the UUID in parameters
rsr.setReportId(12345);
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEREPORT”	String	Webサービス関数。
Parameters	Array（String）	YellowfinレポートのUUID。ReportIdが設定されている場合、この設定は必要ありません。
ReportId	Integer	YellowfinレポートのID。Parameterの配列にUUIDが設定されている場合、この設定は必要ありません。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

DELETEVIEW

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This example has a Yellowfin View UUID. The parameter value here can be either the UUID 
// or the Yellowfin View ID 
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEVIEW”	String	Webサービス関数。
Parameters	Array（String）	ここには、YellowfinのビューIDまたはUUIDを設定することができます。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

DELETESOURCE

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのデータソースを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Data Source ID
String[] parameters ={
"23456"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETESOURCE”	String	Webサービス関数。
Parameters	Array（String）	ここには、YellowfinのデータソースIDまたはUUIDを設定することができます。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

DELETETAB

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Dashboard Tab UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETETAB");
rsr.setDashboardTabId(11223);
// If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETETAB”	String	Webサービス関数。
Parameters	Array（String）	YellowfinダッシュボードタブのUUID。DashboardTabIdパラメーターが設定されている場合、この設定は必要ありません。
DashboardTabId	Integer	ダッシュボードタブID。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

RELOADLICENCE

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinでライセンス定義を再読み込みします。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE");

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADLICENCE”	String	Webサービス関数。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

CLOSECONNECTIONPOOL

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたデータソースの接続プールを閉じます。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Data Source ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CLOSECONNECTIONPOOL");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “CLOSECONNECTIONPOOL”	String	Webサービス関数。
Parameters	Array（String）	YellowfinのデータソースID。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

FLUSHCACHEDFILTERCACHE

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたフィルターのフィルターキャッシュをフラッシュします。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Filter ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHCACHEDFILTERCACHE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHCACHEDFILTERCACHE”	String	Webサービス関数。
Parameters	Array（String）	フィルターID。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

APPROVEREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("APPROVEREPORT");
rsr.setReportId(12345)

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “APPROVEREPORT”	String	Webサービス関数。
ReportId	Integer	レポートID。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

GETCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内でエクスポート可能なすべてのコンテンツを取得します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCONTENT");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETCONTENT”	String	Webサービス関数。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array（ContentResource）

ContentResourceオブジェクトの配列。各ContentResourceオブジェクトには、Yellowfinでエクスポート可能なすべてのコンテンツのエクスポートメタデータが保持されます。

GETEXPORTDEPENDENCIES

以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETEXPORTDEPENDENCIES");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、特定のYellowfin成果物についての従属関係を取得します。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。このコンテンツメタデータはContentResourceオブジェクトの配列という形式で取得され、この関数呼び出しでそれぞれの従属関係を取得するために使用することができます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETEXPORTDEPENDENCIES”	String	Webサービス関数。
ContentResources	Array（ContentResource）	ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。

ContentResource要素	データ型
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには従属関係メタデータが保持されます。

EXPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定された成果物をエクスポートします。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// It is advisable to run a GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects
// This list can be copied over to the exportList array below
ContentResource[] exportList;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("EXPORTCONTENT");
rsr.setContentResources(exportList);

rs = AdministrationService.remoteAdministrationCall(rsr);
rbo = rs.getBinaryAttachments();

このコードは、rs.getBinaryAttachments()でReportBinaryObjectsオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfin内の指定された成果物をエクスポートします。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “EXPORTCONTENT”	String	Webサービス関数。
ContentResources	Array（ContentResource）	ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。

ContentResource要素	データ型
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

BinaryAttachments

Array（ReportBinaryObjects）

ReportBinaryObjectオブジェクトの配列。これらのオブジェクトには、エクスポートされた成果物のXMLが保持されます。

GETIMPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートファイルを読み取り、インポートするオブジェクトを返します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。

この関数は、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数の入力には、Base64でエンコードされたXMLファイルを使用してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETIMPORTCONTENT”	String	Webサービス関数。
Parameters	Array（String）	Base64でエンコードされた多数のXMLインポートファイルの配列。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

TESTIMPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ImportIssue[] ii = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("TESTIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
ii = rs.getImportIssues();

このコードは、インポートファイルに問題がある場合にはrs.getImportIssues()でImportIssueオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。

この関数はYellowfinのインポートオブジェクトの一覧をテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行され、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数は、この一覧内のすべてのオブジェクトについて検証プロセスを実行します。検証プロセス中に発生したすべての問題は、応答でImportIssueオブジェクトとして返されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “TESTIMPORTCONTENT”	String	Webサービス関数。
Parameters	Array（String）	Base64でエンコードされた多数のXMLインポートファイルの配列。
ImportOptions	Array（ImportOption）	コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ImportIssues

Array（ImportIssue）

ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。

IMPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinのインポートオブジェクトをアプリケーションにインポートします。

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("IMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “IMPORTCONTENT”	String	Webサービス関数。
Parameters	Array（String）	Base64でエンコードされた多数のXMLインポートファイルの配列。
ImportOptions	Array（ImportOption）	コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

オブジェクト定義

AdministrationPerson

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Yellowfinユーザーのパスワード。
FirstName	String	Yellowfinユーザーの名。
LastName	String	Yellowfinユーザーの姓。
Initial	String	Yellowfinユーザーのミドルネームの頭文字。
SalutationCode	String	Yellowfinユーザーの敬称。可能な値は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。
EmailAddress	String	Yellowfinユーザーの電子メールアドレス。
LanguageCode	String	優先言語を表す2文字のコード。
IpId	Integer	内部Yellowfin IP ID。
TimeZoneCode	String	YellowfinユーザーのTimeZoneCode。

AdministrationReport

AdministrationReport要素	データ型
ReportName	String
ReportDescription	String
ReportId	Integer
ExecutionObject	String
ReportCategory	String
ReportSubCategory	String
BirtData	String
SourceName	String
SourceId	Integer
AuthoringMode	String
ReportTemplate	String
DataOutput	String
DashboardEnabled	Boolean
ViewId	Integer
ViewName	String
ViewDescription	String
LastModifierName	String
LastModifierId	Integer
LastModifiedDate	Date
PublishDate	Date
DeliveryMode	String
LastRunTime	Integer
AverageRunTime	Integer
RoleCode	String
ChartTypeCode	String
Usage	Integer

AdministrationReportGroup

AdministrationReportGroup要素	データ型	説明
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String
ReportGroupInternalReference	String
GroupReports	Array（AdministrationReports）	レポートメタデータを保持するAdministrationReportオブジェクトの配列。これらは、ダッシュボードタブ内のポートレットを構成するレポートです。
AssociatedReports	Array（Integer）

AdministrationRole

AdministrationReportGroup要素	データ型	説明
RoleName	String	Yellowfinロールの名前
RoleDescription	String	Yellowfinロールの説明
RoleCode	String	データベースで生成されて参照されるYellowfinロールの内部コード

AdministrationGroup

AdministrationGroup要素	データ型	説明
GroupName	String
GroupDescription	String
GroupId	Integer
GroupStatus	String
GroupInternalReference	String
GroupMembers	Array（AdministrationGroupMember）	AdministrationGroupMemberオブジェクトの配列。これらのオブジェクトにはグループメンバーのメタデータが保持されます。

AdministrationClientOrg

AdministrationClientOrg要素	データ型	説明
ClientName	String	クライアント組織の名前
ClientReferenceID	String	クライアントの識別に使用される固有のIDであるクライアント参照ID
TimeZoneCode	String	クライアント組織のローカルタイムゾーンコード有効な値については、付録を参照してください。
DefaultOrg	Boolean	この組織がデフォルト組織である場合にtrueを返すブール値

ReportBinaryObject

ReportBinaryObject要素	データ型	説明
Key	String	バイナリーオブジェクトストレージに使用される固有キー
ContentType	String	バイナリーオブジェクトのMIMEタイプ
Data	Array（Byte）	バイナリーオブジェクトのRAWデータ

ContentResource

ContentResource要素	データ型
ResourceName	String
ResourceDescription	String
ResourceId	Integer
ResourceUUID	Integer
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

ImportOption

ImportOption要素	データ型	説明
ItemIndex	Integer	このオプションが付加されたアイテムのインデックス
OptionKey	String	オプションのタイプ
OptionValue	String	このオプションに関連付けられた値