シングルサインオン
このサービスは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
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 |
|
ENTRY | entry | ログインプロセスを完了するためのユーザーの唯一の起点を指定します。ほかのパラメーターとともに使用して、ユーザーに表示される内容を指定します。可能な値：
|
REPORTID | reportid |
|
REPORTUUID | reportuuid |
|
STORYBOARDUUID | storyboarduuid |
|
MOBILEDEVICE | mobiledevice |
|
REPORTNAME | reportname |
|
DISABLESOURCEFILTERS |
|
|
DISABLEHEADER | disableheader |
|
HIDEHEADER | hideheader |
|
DISABLEFOOTER | disablefooter |
|
HIDEFOOTER | hidefooter |
|
DISABLESIDENAV | disablesidenav |
|
HIDESIDENAV | hidesidenav |
|
DISABLELOGOFF | disablelogoff |
|
HIDELOGOFF | hidelogoff |
|
REASONCODE | reasoncode | このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 |
REASONDESCRIPTION | reasondescription | このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 |
DASHBOARDID | dashboardid |
|
DASHBOARDUUID | dashboarduuid |
|
FILTER<ID> | filter<ID> |
|
SOURCEFILTER_<FILTERCODE> |
| このセッションのこのユーザーのソースフィルター値を上書きします。 |
CONTENT_<INCLUDE/EXCLUDE> |
| このセッションでユーザーが持つコンテンツアクセス権を上書きします。 |
このサービスは、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サービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。
関数
以下のコードは、ユーザーを作成するための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 | 新規ユーザーの敬称。可能な値は以下の通りです。
|
RoleCode | String | Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。 |
EmailAddress | String | 新規ユーザーの電子メールアドレス。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、ユーザーを削除するための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サービス呼び出しのステータス。可能な値は以下の通りです。
|
ユーザー情報の取得およびテスト
作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入されたAdministrationPersonオブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、NULLとなります。また、このセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。
以下のコードは、ユーザーの詳細を取得するための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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Person | AdministrationPerson | 返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
以下のコードは、内部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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Person | AdministrationPerson | 返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
この関数は、特定の検索文字列に基づいて、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
People | Array（AdministrationPerson） | AdministrationPersonオブジェクトの配列。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。 |
以下のコードは、ユーザーをテストするための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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Person | AdministrationPerson | 返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
以下のコードは、ユーザーのパスワードをテストするための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サービス呼び出しのステータス。可能な値は以下の通りです。
|
ユーザー情報の操作
ユーザーの詳細は、Webサービス呼び出しを使用してあとから変更することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別のCHANGEPASSWORD関数（下記）を使用して変更することができます。
以下のコードは、ユーザーの詳細を編集するための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ユーザーの敬称。可能な値は以下の通りです。
|
RoleCode | String | Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。 |
EmailAddress | String | Yellowfinユーザーの電子メールアドレス。 |
LanguageCode | String | 優先言語を表す2文字のコード。 |
IpId | Integer | 内部Yellowfin IP ID。 |
TimeZoneCode | String | YellowfinユーザーのTimeZoneCode。有効な値については、付録を参照してください。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
Person | AdministrationPerson | 更新されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
以下のコードは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
ユーザーに属するオブジェクトの取得
さまざまなWebサービス呼び出しを使用して、デフォルト組織またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。以下のコードは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
以下のコードは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
以下のコードは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
以下のコードは、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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの受信トレイ内にあるすべてのレポートを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETINBOX");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getReports()でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
この関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETINBOX” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | |
Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含まないすべてのダッシュボードタブを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getReportGroups()でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETUSERTABS” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ReportsGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getReportGroups()でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、AdministrationReportGroupオブジェクト内に含まれます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETUSERTABSWITHREPORTS” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ReportsGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。 |
この関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “LOADTABREPORTS” | String | Webサービス関数。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
ReportGroup | AdministrationReportGroup | 取得プロセスに関するダッシュボードタブIDを保持するAdministrationReportGroupオブジェクト。 |
AdministrationPersonおよびAdministrationReportGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
AdministrationReportGroup要素 | データ型 | 説明 |
|---|---|---|
ReportGroupId | String | ダッシュボードタブID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ReportGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。 |
グループ及びロールの管理
Webサービス呼び出しを使用して、グループとロールを作成および変更することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。注意：クライアント組織機能を「システム設定」ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getRoles()でAdministrationRoleオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。
この関数は、Yellowfin内で使用可能なすべてのロールを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “LISTROLES” | String | Webサービス関数。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ロール | AdministrationRole | AdministrationRoleオブジェクトの配列。これらのオブジェクトにはYellowfinロールのメタデータが保持されます。 |
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのグループを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get groups in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("LISTGROUPS");
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getGroups()でAdministrationGroupオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “LISTGROUPS” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
グループ | AdministrationGroup | AdministrationGroupオブジェクトの配列。これらのオブジェクトにはYellowfinユーザーグループのメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループおよびそのメンバーを返します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
group = rs.getGroup();
AdministrationGroupMember[] groupMembers = group.getGroupMembers();
このコードは、rs.getGroup()でAdministrationGroupオブジェクトを返し、rs.getGroupMembers()でAdministrationGroupMembersの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたYellowfinグループおよびそのメンバーの一覧を返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
Group | AdministrationGroup | グループメタデータを保持するAdministrationGroupオブジェクトの配列。グループメンバーもこのオブジェクトのGroupMembers()のパラメーターにロードされます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
group.setGroupDescription("Group Description");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to create the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("CREATEGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列に入力することによって、新規作成されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。
この関数はYellowfinグループを作成します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “CREATEGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
GroupDescription | String | 指定したYellowfinグループの説明 |
GroupMembers | Array（AdministrationPerson） | AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループに指定されたユーザーを含めます。
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("INCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたグループに指定されたYellowfinユーザーを含めます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “INCLUDEUSERINGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。
注意：このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。
- John DoeはグループAのメンバーである
- グループAはグループBのメンバーである
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。これが役立つのは、たとえば以下のような場合です。
- John DoeはグループAのメンバーである
- グループAはグループBのメンバーである
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “EXCLUDEUSERINGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定したグループから指定されたYellowfinユーザーを削除します。このシナリオはEXCLUDEUSERINGROUPのシナリオとは異なります。この関数の場合、ユーザーはグループから完全に削除される点に注意してください。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “DELUSERFROMGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("MODIFYGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、変更されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。
この関数はYellowfinの指定されたグループの詳細を変更します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “MODIFYGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
GroupDescription | String | 指定したYellowfinグループの説明 |
GroupMembers | Array（AdministrationPerson） | AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのLoginIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELETEGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinから指定されたユーザーを削除します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “DELETEGROUP” | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationGroup要素 | データ型 | 説明 |
|---|---|---|
GroupName | String | 指定したYellowfinグループの名前 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
マルチテナント機能
Yellowfinには、クライアント組織と呼ばれる機能があり、この機能を使用するとYellowfinの複数の仮想インスタンスを同じサーバーインスタンスに配置できます。クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内のすべてのクライアント組織を一覧表示します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTCLIENTS");
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、AdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、Yellowfin内で使用可能なすべてのクライアント組織を一覧表示します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “LISTCLIENTS” | String | Webサービス関数。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を取得します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、rs.getClient()でAdministrationClientOrgオブジェクトを返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfin内の指定されたクライアント組織の詳細を取得します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETCLIENT” | String | Webサービス関数。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationClientOrg要素 | データ型 | 説明 |
|---|---|---|
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内に指定されたクライアント組織を作成します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinに指定されたクライアント組織を作成します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “CREATECLIENT” | String | Webサービス関数。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationClientOrg要素 | データ型 | 説明 |
|---|---|---|
ClientName | String | クライアント組織の名前 |
ClientReferenceID | String | クライアントの識別に使用される固有のIDであるクライアント参照ID |
TimeZoneCode | String | クライアント組織のローカルタイムゾーンコード |
DefaultOrg | Boolean | この組織がデフォルト組織である場合にtrueを返すブール値 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinの指定されたクライアント組織を削除します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “DELETECLIENT” | String | Webサービス関数。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationClientOrg要素 | データ型 | 説明 |
|---|---|---|
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “UPDATECLIENT” | String | Webサービス関数。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationClientOrgオブジェクトで設定できるパラメーターは、以下の通りです。
AdministrationClientOrg要素 | データ型 | 説明 |
|---|---|---|
ClientName | String | クライアント組織の名前 |
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID。このIDは最初の取得プロセスに使用され、この関数の使用中には変更することができない点に注意が必要です。 |
TimeZoneCode | String | クライアント組織のローカルタイムゾーンコード |
DefaultOrg | Boolean | この組織がデフォルト組織である場合にtrueを返すブール値 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属するすべてのユーザーを一覧表示します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson[] people = null;
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTUSERSATCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
people = rs.getPeople();
このコードは、rs.getPeople()でAdministrationPersonオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinの指定されたクライアント組織に属するすべてのYellowfinユーザーを一覧表示します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “LISTUSERSATCLIENT” | String | Webサービス関数。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationClientOrg要素 | データ型 | 説明 |
|---|---|---|
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
People | Array（AdministrationPerson） | AdministrationPersonオブジェクトの配列。各オブジェクトにはYellowfinユーザーのメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーがアクセス可能なすべてのクライアント組織を一覧表示します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg[] clients = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERACCESS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
clients = rs.getClients();
このコードは、rs.getClients()でAdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = “GETUSERACCESS” | String | Webサービス関数。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
Clients | Array（AdministrationClientOrg） | AdministrationClientOrgオブジェクトの配列。各オブジェクトにはYellowfinクライアント組織のメタデータが保持されます。 |
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
BinaryAttachments | Array (ReportBinaryObject) | Array of ReportBinary objects holding the Base64 decoded avatar images |
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
ContentResources | Array (ContentResource) | Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin. |
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:
|
ContentResources | Array (ContentResource) | Array of ContentResource objects. These objects will hold dependency metadata |
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:
|
BinaryAttachments | Array(ReportBinaryObjects) | Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts. |
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:
|
ContentResources | Array (ContentResource) | Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata |
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:
|
ImportIssues | Array (ImportIssue) | Array of ImportIssue objects. These objects will contain error messages returned from the validation process |
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:
|
Object Definitions
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:
|
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 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 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) |
|
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 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 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 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 Element | Data Type |
|---|---|
ResourceName | String |
ResourceDescription | String |
ResourceId | Integer |
ResourceUUID | Integer |
ResourceType | String |
ResourceOrgId | Integer |
ResourceCode | String |
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. |