管理サービス

シングルサインオン

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` 1つのレポートで複数のフィルターを渡すことができます。
SOURCEFILTER_<FILTERCODE>		このセッションのこのユーザーのソースフィルター値を上書きします。 `SOURCEFILTER_`には「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例： `SOURCEFILTER_COUNTRY=AU` 1つのセッションで複数のソースフィルター値を渡すことができます。このオプションは、JavaScript APIで使用することもできます。
CONTENT_<INCLUDE/EXCLUDE>		このセッションでユーザーが持つコンテンツアクセス権を上書きします。`CONTENT_`には`INCLUDE`または`EXCLUDE`を付加します。このキーの値は、コンテンツカテゴリーコードまたはコンテンツカテゴリーUUIDです。コンテンツの組み入れ（`INCLUDE`）を選択した場合、これらはユーザーがアクセスできるようにするコンテンツカテゴリーのみになります。コンテンツの除外（`EXCLUDE`）を選択した場合、これらの除外コンテンツカテゴリーは、ユーザーが通常アクセスできるコンテンツから削除されます。コンテンツの組み入れおよび除外は、カテゴリーレベルに基づきます。指定したカテゴリーのすべてのサブカテゴリーが組み入れまたは除外されます。カテゴリーのコードおよびUUIDを使用した組み入れ/除外の例： `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	ユーザー削除プロセスに関するユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

ユーザー情報の取得およびテスト

作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入された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オブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。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

The following code will call the Yellowfin web service and return all reports that are in the particular user’s inbox:

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

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

This function will return the reports that are in the inbox of a specified Yellowfin user.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETINBOX”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

SUCCESS
FAILURE

Reports

AdministrationReport

An array of AdministrationReport objects. These objects hold report metadata.

GETUSERTABS

The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:

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

This code will return an Array of AdministrationReportGroup objects in rs.getReportGroups() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETUSERTABS”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

SUCCESS
FAILURE

ReportsGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata.

GETUSERTABSWITHREPORTS

The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:

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

This code will return an Array of AdministrationReportGroup objects in rs.getReportGroups() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports’ metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETUSERTABSWITHREPORTS”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

SUCCESS
FAILURE

ReportsGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.

LOADTABREPORTS

This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “LOADTABREPORTS”	String	Web services function
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
ReportGroup	AdministrationReportGroup	The AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationReportGroup Element	Data Type	Description
ReportGroupId	String	Dashboard Tab ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

SUCCESS
FAILURE

ReportGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.

Group & Role Administration

Groups and Roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.

Note: if Client Org functionality is turned on in the システム設定 page, a Client Org can also be specified where applicable for certain types of calls.

LISTROLES

The following code will call the Yellowfin web service and return all available roles within Yellowfin:

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an Array of AdministrationRole objects in rs.getRoles() and SUCCESS in rs.getStatusCode().

This function will return all the available roles within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “LISTROLES”	String	Web services function

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Roles

AdministrationRole

An array of AdministrationRole objects. These objects hold Yellowfin Role metadata.

LISTGROUPS

The following code will call the Yellowfin web service and return all available groups within 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);

The code will return an Array of AdministrationGroup objects in rs.getGroups() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return all the available user groups within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “LISTGROUPS”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Groups

AdministrationGroup

An array of AdministrationGroup objects. These objects hold Yellowfin user group metadata.

GETGROUP

The following code will call the Yellowfin web service and return the specified group with its members in 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();

The code will return an AdministrationGroup object in rs.getGroup(), an Array of AdministrationGroupMembers in rs.getGroup().getGroupMembers(), and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a specified Yellowfin group with a list of its members.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin Group

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Group

AdministrationGroup

An array of AdministrationGroup objects holding group metadata. The group members are also loaded into this object's GroupMembers() parameter.

CREATEGROUP

The following code will call the Yellowfin web service and create the specified group in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().

This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “CREATEGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group
GroupDescription	String	Business description of the specified Yellowfin group
GroupMembers	Array (AdministrationPerson)	An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its UserId parameter set.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

INCLUDEUSERINGROUP

The following code will call the Yellowfin web service and include a specified user into a specified group in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will include a specified Yellowfin user into a specified group.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “INCLUDEUSERINGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

EXCLUDEUSERINGROUP

The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin.

Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

John Doe is a member of Group A
Group A is a member of Group B
John Doe shouldn’t be a member of Group B, therefore he should be excluded from Group 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("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

John Doe is a member of Group A
Group A is a member of Group B
John Doe shouldn’t be a member of Group B, therefore he is to be excluded from Group B

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “EXCLUDEUSERINGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETEUSERFROMGROUP

The following code will call the Yellowfin web service and delete a specified user from a specified group in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP – in this function a user will be permanently removed from the group.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “DELUSERFROMGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

MODIFYGROUP

The following code will call the Yellowfin web service and modify the specified group in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().

This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “MODIFYGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group
GroupDescription	String	Business description of the specified Yellowfin group
GroupMembers	Array (AdministrationPerson)	An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its LoginId parameter set.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETEGROUP

The following code will call the Yellowfin web service and delete the specified group in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete a specified group from Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “DELETEGROUP”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Client Organisation Functionality

Yellowfin contains functionality called クライアント組織, which allows multiple virtual instances of Yellowfin to reside in the same server instance.

Client Organisation functionality can be managed with the available web service calls listed below.

LISTCLIENTS

The following code will call the Yellowfin web service and list all client organisations within 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);

The code will return an Array of AdministrationClientOrg objects and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will list all client organisations available within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “LISTCLIENTS”	String	Web services function

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

GETCLIENT

The following code will call the Yellowfin web service and get the specified client organisation within 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);

The code will return an AdministrationClientOrg object in rs.getClient() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will retrieve details for a specified client organisation within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETCLIENT”	String	Web services function
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

CREATECLIENT

The following code will call the Yellowfin web service and create the specified client organisation within 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The function will create the specified client organisation in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “CREATECLIENT”	String	Web services function
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

AdministrationClientOrg Element	Data Type	Description
ClientName	String	Name of the client organisation
ClientReferenceID	String	Client Reference ID which is the unique ID used to identify a client
TimeZoneCode	String	A client organisation’s local time zone code.
DefaultOrg	Boolean	Boolean value that returns true if this organisation is the primary organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETECLIENT

The following code will call the Yellowfin web service and delete the specified client organisation within 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete the specified client organisation in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “DELETECLIENT”	String	Web services function
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

UPDATECLIENT

The following code will call the Yellowfin web service and update the specified client organisation within 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “UPDATECLIENT”	String	Web services function
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you can set in the AdministrationClientOrg object:

AdministrationClientOrg Element	Data Type	Description
ClientName	String	Name of the client organisation
ClientReferenceId	Integer	Client Reference ID for the specified client organisation. Note that this is used for the initial retrieval process, and cannot be modified during the usage of this function
TimeZoneCode	String	A client organisation’s local time zone code.
DefaultOrg	Boolean	Boolean value that returns true if this organisation is the primary organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

LISTUSERSATCLIENT

The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within 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();

The code will return an Array of AdministrationPerson objects in rs.getPeople() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “LISTUSERSATCLIENT”	String	Web services function
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

People

Array (AdministrationPerson)

Array of AdministrationPerson objects. Each object holds Yellowfin user metadata.

GETUSERACCESS

The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within 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();

The code will return an Array of AdministrationClientOrg objects in rs.getClients() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETUSERACCESS”	String	Web services function
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

AdministrationPersonElement	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Clients

Array (AdministrationClientOrg)

Array of AdministrationClientOrg objects. Each object holds Yellowfin client organisation metadata

ADDUSERACCESS

The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will add access to a specified client organisation for a specified user win Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “ADDUSERACCESS”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

REMOVEUSERACCESS

The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove access to a specified client organisation for a specified user in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “REMOVEUSERACCESS”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ISREPORTFAVOURITE

This function will check if a specified report is in a specified user’s favourites list in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “ISUSERFAVOURITE”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ADDTOFAVOURITES / ADDTOFAVORITES

The following code will call the Yellowfin web service and add a specified report to a specified user’s favourites list:

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

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will add a specified report to a specified user’s report favourites list.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “ADDTOFAVOURITES" OR "ADDTOFAVORITES”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

REMOVEFAVOURITES / REMOVEFAVORITES

The following code will call the Yellowfin web service and remove a specified report to a specified user’s favourites list:

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

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove a specified report to a specified user’s report favourites list.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “REMOVETOFAVOURITES" OR "REMOVETOFAVORITES”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

GETAVATARS

This function will return all avatar images of specified users within Yellowfin:

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “GETAVATARS”	String Web services function
Parameters	Array (String)	The Unique IDs of Yellowfin users

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

BinaryAttachments

Array (ReportBinaryObject)

Array of ReportBinary objects holding the Base64 decoded avatar images

SETAVATARIMAGE

This function will set the avatar image of the specified user’s profile within Yellowfin:

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “SETAVATARIMAGE”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Parameters	Array (Bytes)	Base64 encoded avatar image

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
IpId	Integer	Unique IP ID of the Yellowfin user

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

RELOADCODES

This function will reload the specified Org Reference Codes within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “RELOADCODES”	String	Web services function
Parameters	Array (String)	The list of Org Reference Codes

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

GEOMETRYFLUSH

The following code will call the Yellowfin web service and clear the geometry cache in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The function will clear the geometry cache in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “GEOMETRYFLUSH”	String	Web services function
Parameters	Array (String)	The list of View IDs from which the geometry objects are cached with

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

REMOVEVIEW

The following code will call the Yellowfin web service and remove a view’s cache in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove a view's cache in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “REMOVEVIEW”	String	Web services function
Parameters	Array (String)	The list of View IDs

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

FLUSHREPORT

The following code will call the Yellowfin web service and remove a report’s cached definitions in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “FLUSHREPORT”	String	Web services function
Parameters	Array (String)	The list of Report IDs

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

FLUSHTAB

The following code will call the Yellowfin web service and remove a dashboard’s cached definitions in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “FLUSHTAB”	String	Web services function
Parameters	Array (String)	The list of Tab IDs

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETEREPORT

The following code will call the Yellowfin web service and delete a report in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “DELETEREPORT”	String	Web services function
Parameters	Array (String)	The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is set
ReportId	Integer	The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETEVIEW

The following code will call the Yellowfin web service and delete a view in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “DELETEVIEW”	String	Web services function
Parameters	Array (String)	Either the Yellowfin View ID or UUID can be set here

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETESOURCE

The following code will call the Yellowfin web service and delete a data source in 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);

The code will return {SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “DELETESOURCE”	String	Web services function
Parameters	Array (String)	Either the Yellowfin Data Source ID or UUID can be set here

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

DELETETAB

The following code will call the Yellowfin web service and delete a dashboard tab in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “DELETETAB”	String	Web services function
Parameters	Array (String)	UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is set
DashboardTabId	Integer	Dashboard Tab ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

RELOADLICENCE

The following code will call the Yellowfin web service and reload the licence definitions in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “RELOADLICENCE”	String	Web services function

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

CLOSECONNECTIONPOOL

The following code will call the Yellowfin web service and close the specified data source’s connection pool in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “CLOSECONNECTIONPOOL”	String	Web services function
Parameters	Array (String)	Yellowfin Data Source ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

FLUSHCACHEDFILTERCACHE

The following code will call the Yellowfin web service and flush the specified filter’s filter cache in 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);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “FLUSHCACHEDFILTERCACHE”	String	Web services function
Parameters	Array (String)	Filter ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

APPROVEREPORT

The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:

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

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “APPROVEREPORT”	String	Web services function
ReportId	Integer	Report ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

GETCONTENT

The following code will call the Yellowfin web service and obtain all exportable content within 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();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “GETCONTENT”	String	Web services function

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin.

GETEXPORTDEPENDENCIES

The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:

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();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “GETEXPORTDEPENDENCIES”	String	Web services function
ContentResources	Array (ContentResource)	Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

These are the parameters that you need to set in the ContentResource object:

ContentResource Element	Data Type
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold dependency metadata

EXPORTCONTENT

The following code will call the Yellowfin web service and export the specified artifacts within 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();

The code will return an Array of ReportBinaryObjects objects in rs.getBinaryAttachments() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “EXPORTCONTENT”	String	Web services function
ContentResources	Array (ContentResource)	Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

These are the parameters that you need to set in the ContentResource object:

ContentResource Element	Data Type
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

BinaryAttachments

Array(ReportBinaryObjects)

Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts.

GETIMPORTCONTENT

The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:

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();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.

This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.
Function = “GETIMPORTCONTENT”	String	Web services function
Parameters	Array (String)	Array of Base64 encoded chunks of the XML import file.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

TESTIMPORTCONTENT

The following code will call the Yellowfin web service and validate the Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call:

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();

The code will return an Array of ImportIssue objects in rs.getImportIssues() if there are issues with the import file and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.

This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1
Function = “TESTIMPORTCONTENT”	String	Web services function
Parameters	Array (String)	An array of Base64 encoded chunks of the XML import file
ImportOptions	Array(ImportOption)	An array of ImportOption objects that controls how content is imported.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

ImportIssues

Array (ImportIssue)

Array of ImportIssue objects. These objects will contain error messages returned from the validation process

IMPORTCONTENT

The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:

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

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1
Function = “IMPORTCONTENT”	String	Web services function
Parameters	Array (String)	An array of Base64 encoded chunks of the XML import file
ImportOptions	Array(ImportOption)	An array of ImportOption objects that controls how content is imported.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Object Definitions

AdministrationPerson

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
Password	String	Password of the Yellowfin user
FirstName	String	First name of of the Yellowfin user
LastName	String	Last name of of the Yellowfin user
Initial	String	Middle initial of the Yellowfin user
SalutationCode	String	Title of the Yellowfin user. Possible values include: DR MISS MR MRS MS
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)
EmailAddress	String	Email address of the Yellowfin user
LanguageCode	String	Two letter code for the preferred language
IpId	Integer	Internal Yellowfin IP ID
TimeZoneCode	String	The TimeZoneCode of the Yellowfin user.

AdministrationReport

AdministrationReport Element	Data Type
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 Element	Data Type	Description
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String
ReportGroupInternalReference	String
GroupReports	Array (AdministrationReports)	Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab
AssociatedReports	Array (Integer)

AdministrationRole

AdministrationReportGroup Element	Data Type	Description
RoleName	String	The name of the Yellowfin Role
RoleDescription	String	The business description of the Yellowfin Role
RoleCode	String	The internal code for the Yellowfin Role that is generated and referenced in the database

AdministrationGroup

AdministrationGroup Element	Data Type	Description
GroupName	String
GroupDescription	String
GroupId	Integer
GroupStatus	String
GroupInternalReference	String
GroupMembers	Array (AdministrationGroupMember)	An array of AdministrationGroupMember objects. These objects hold group member metadata

AdministrationClientOrg

AdministrationClientOrg Element	Data Type	Description
ClientName	String	Name of the client organisation
ClientReferenceID	String	Client Reference ID which is the unique ID used to identify a client
TimeZoneCode	String	A client organisation’s local time zone code. See appendix for valid values.
DefaultOrg	Boolean	Boolean value that returns true if this organisation is the primary organisation

ReportBinaryObject

ReportBinaryObject Element	Data Type	Description
Key	String	Unique key used for Binary Object storage
ContentType	String	MIME type for the Binary Object
Data	Array (Byte)	Raw data for Binary Object

ContentResource

ContentResource Element	Data Type
ResourceName	String
ResourceDescription	String
ResourceId	Integer
ResourceUUID	Integer
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

ImportOption

ImportOption Element	Data Type	Description
ItemIndex	Integer	The index of the item that this option is attached too.
OptionKey	String	The type of option.
OptionValue	String	A value associated with this option.