ユーザーの複製および管理
ユーザーの複製では、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" or "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要素 | データ型 | 説明 |
|---|---|---|
IpId | Integer | 返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
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 | Password of the Yellowfin user |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。* SUCCESS* FAILURE |
ユーザー情報の操作
ユーザーの詳細は、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 | Internal 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" or "GETFAVORITES" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | 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 | 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("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 String Webサービス呼び出しのステータス。可能な値は以下の通りです。
| |
ReportsGroups | 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 | 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 Element | データ型 | 説明 |
ReportGroupId | String | Dashboard Tab ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | String Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ReportGroups |
| AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。 |
グループおよびロールの管理
Webサービス呼び出しを使用して、グループとロールを作成および変更することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。注意: if クライアント組織 機能を システム構成 ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。
The following code will call the Yellowfin web service and return all available roles within Yellowfin:
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードは、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 = "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サービス呼び出しのステータス。可能な値は以下の通りです。
|
Groups | 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 Element | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
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
The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process
Person
AdministrationPerson
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
AdministrationGroup Element
データ型
説明
GroupName
String
Name of the specified Yellowfin group
AdministrationPerson要素
データ型
説明
UserId
String
YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Webサービス呼び出しのステータス。可能な値は以下の通りです。
- SUCCESS
- FAILURE |
The 以下のコードは、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 Element | データ型 | 説明 |
|---|---|---|
GroupName | String | Name of the specified Yellowfin group |
AdministrationPerson要素 | データ型 | 説明 |
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
The 以下のコードは、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 Element | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
GroupName | String | Name of the specified Yellowfin group |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
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 services function |返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
ClientReferenceId | Integer | AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
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 Element | データ型 | 説明 |
|---|---|---|
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。常に1に設定します。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationClientOrg Element | データ型 | 説明 |
|---|---|---|
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();
The code will return an Array of AdministrationClientOrg objects in rs.getClients() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
リクエスト要素 | データ型 | 説明 |
|---|---|---|
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オブジェクト。 |
These are the parameters that you need to set in the AdministrationClientOrg object:
AdministrationPersonElement | データ型 | 説明 |
|---|---|---|
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);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "ADDUSERACCESS" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
AdministrationClientOrg Element | データ型 | 説明 |
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "REMOVEUSERACCESS" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
Client |
| 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
AdministrationClientOrg Element | データ型 | 説明 |
ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "ISUSERFAVOURITE" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
ReportId | Integer | レポートの固有のID。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。|
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたレポートを指定されたユーザーのお気に入り一覧に追加します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDTOFAVOURITES");
rsr.setPerson(person);
rs.setReportId(12345);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "ADDTOFAVOURITES" OR "ADDTOFAVORITES" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
ReportId | Integer | レポートの固有のID。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。|
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
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);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "REMOVETOFAVOURITES" OR "REMOVETOFAVORITES" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
ReportId | Integer | レポートの固有のID。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "GETAVATARS" | String | String Webサービス関数。 |
Parameters | Array (String) | Yellowfinユーザーの固有のID。 |
返される応答には、以下のパラメーターが含まれます。|
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
BinaryAttachments | Array (ReportBinaryObject) | Base64でデコードされたアバターイメージを保持するReportBinaryオブジェクトの配列。 |
この関数は、Yellowfin内の指定されたユーザーのプロファイルのアバターイメージを設定します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "SETAVATARIMAGE" | String | Webサービス関数。 |
OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 |
Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
Parameters | Array (Bytes) | Base64でエンコードされたアバターイメージ。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素 | データ型 | 説明 |
|---|---|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
IpId | Integer | Unique IP ID of the Yellowfin user |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
この関数は、Yellowfin内の指定された参照コードを再読み込みします。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "RELOADCODES" | String | Webサービス関数。 |
Parameters | Array (String) | 参照コードの一覧。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのジオメトリキャッシュをクリアします。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin View ID
String[] parameters ={
"48910"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinのジオメトリキャッシュをクリアします。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "GEOMETRYFLUSH" | String | Webサービス関数。 |
Parameters | Array (String) | ジオメトリオブジェクトのキャッシュ元となるビューIDの一覧。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューのキャッシュを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin View ID
String[] parameters ={
"49283"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEVIEW");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinのビューのキャッシュを削除します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "REMOVEVIEW" | String | Webサービス関数。 |
Parameters | ビューIDの一覧。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Report ID
String[] parameters ={
"11111"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHREPORT");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "FLUSHREPORT" | String | Webサービス関数。 |
Parameters | Array (String) | レポートIDの一覧。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Dashboard Tab ID
String[] parameters ={
"12345"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "FLUSHTAB" | String | Webサービス関数。 |
Parameters | Array (String) | タブIDの一覧。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Report UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEREPORT");
// If the report ID is not set, then the code will look for the UUID in parameters
rsr.setReportId(12345);
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "DELETEREPORT" | String | Webサービス関数。 |
Parameters | Array (String) | YellowfinレポートのUUID。ReportIdが設定されている場合、この設定は必要ありません。 |
ReportId | Integer | YellowfinのレポートID。Parameterの配列にUUIDが設定されている場合、この設定は必要ありません。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This example has a Yellowfin View UUID. The parameter value here can be either the UUID
// or the Yellowfin View ID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "DELETEVIEW" | String | Webサービス関数。 |
Parameters | Array (String) | ここには、YellowfinのビューIDまたはUUIDを設定することができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのデータソースを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is the Yellowfin Data Source ID
String[] parameters ={
"23456"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "DELETESOURCE" | String | Webサービス関数。 |
Parameters | Array (String) | ここには、YellowfinのデータソースIDまたはUUIDを設定することができます。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is the Yellowfin Dashboard Tab UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETETAB");
rsr.setDashboardTabId(11223);
// If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "DELETETAB" | String | Webサービス関数。 |
Parameters | Array (String) | YellowfinダッシュボードタブのUUID。DashboardTabIdパラメーターが設定されている場合、この設定は必要ありません。 |
DashboardTabId | Integer | ダッシュボードタブID。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinでライセンス定義を再読み込みします。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE");
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "RELOADLICENCE" | String | Webサービス関数。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたデータソースの接続プールを閉じます。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Data Source ID
String[] parameters ={
"11111"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CLOSECONNECTIONPOOL");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "CLOSECONNECTIONPOOL" | String | Webサービス関数。 |
Parameters | Array (String) | YellowfinのデータソースID。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたフィルターのフィルターキャッシュをフラッシュします。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Filter ID
String[] parameters ={
"12345"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHCACHEDFILTERCACHE");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "FLUSHCACHEDFILTERCACHE" | String | Webサービス関数。 |
Parameters | Array (String) | フィルターID。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("APPROVEREPORT");
rsr.setReportId(12345)
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "APPROVEREPORT" | String | Webサービス関数。 |
ReportId | Integer | Report ID |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内でエクスポート可能なすべてのコンテンツを取得します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCONTENT");
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "GETCONTENT" | String | Webサービス関数。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ContentResources | Array (ContentResource) | ContentResourceオブジェクトの配列。各ContentResourceオブジェクトには、Yellowfinでエクスポート可能なすべてのコンテンツのエクスポートメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETEXPORTDEPENDENCIES");
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、特定のYellowfin成果物についての従属関係を取得します。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。このコンテンツメタデータはContentResourceオブジェクトの配列という形式で取得され、この関数呼び出しでそれぞれの従属関係を取得するために使用することができます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "GETEXPORTDEPENDENCIES" | String | Webサービス関数。 |
ContentResources | Array (ContentResource) | ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
ContentResource Element | データ型 |
|---|---|
ResourceName | String |
ResourceDescription | String |
ResourceType | String |
ResourceOrgId | Integer |
ResourceCode | String |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ContentResources | ContentResourceオブジェクトの配列。これらのオブジェクトには従属関係メタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定された成果物をエクスポートします。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// It is advisable to run a GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects
// This list can be copied over to the exportList array below
ContentResource[] exportList;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("EXPORTCONTENT");
rsr.setContentResources(exportList);
rs = AdministrationService.remoteAdministrationCall(rsr);
rbo = rs.getBinaryAttachments();
このコードは、rs.getBinaryAttachments()でReportBinaryObjectsオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfin内の指定された成果物をエクスポートします。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "EXPORTCONTENT" | String | Webサービス関数。 |
ContentResources | Array (ContentResource) | ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
ContentResource Element | データ型 |
|---|---|
ResourceName | String |
ResourceDescription | String |
ResourceType | String |
ResourceOrgId | Integer |
ResourceCode | String |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
BinaryAttachments | Array(ReportBinaryObjects) | ReportBinaryObjectオブジェクトの配列。これらのオブジェクトには、エクスポートされた成果物のXMLが保持されます。. |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートファイルを読み取り、インポートするオブジェクトを返します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
このコードは、rs.getContentResources()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。
この関数は、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数の入力には、Base64でエンコードされたXMLファイルを使用してください。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "GETIMPORTCONTENT" | String | Webサービス関数。 |
Parameters | Array (String) | Base64でエンコードされた多数のXMLインポートファイルの配列。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ContentResources | Array (ContentResource) | ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ImportIssue[] ii = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("TESTIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
ii = rs.getImportIssues();
このコードは、インポートファイルに問題がある場合にはrs.getImportIssues()でImportIssueオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。
この関数はYellowfinのインポートオブジェクトの一覧をテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行され、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数は、この一覧内のすべてのオブジェクトについて検証プロセスを実行します。検証プロセス中に発生したすべての問題は、応答でImportIssueオブジェクトとして返されます。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "TESTIMPORTCONTENT" | String | Webサービス関数。 |
Parameters | Array (String) | Base64でエンコードされた多数のXMLインポートファイルの配列。 |
ImportOptions | Array(ImportOption) | コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
ImportIssues | Array (ImportIssue) | ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。 |
ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("IMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。
リクエスト要素 | データ型 | 説明 |
|---|---|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 |
Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 |
OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 |
Function = "IMPORTCONTENT" | String | Webサービス関数。 |
Parameters | Array (String) | Base64でエンコードされた多数のXMLインポートファイルの配列。 |
ImportOptions | Array(ImportOption) | コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。 |
返される応答には、以下のパラメーターが含まれます。
応答要素 | データ型 | 説明 |
|---|---|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。
|
オブジェクト定義
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 | Internal 内部Yellowfin IP ID。 |
TimeZoneCode | String | YellowfinユーザーのTimeZoneCode。 |
AdministrationReport Element | データ型 |
|---|---|
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 | データ型 | 説明 |
|---|---|---|
ReportGroupName | String |
|
ReportGroupDescription | String |
|
ReportGroupId | Integer |
|
ReportGroupStatus | String |
|
ReportGroupType | String |
|
ReportGroupInternalReference | String |
|
GroupReports | Array (AdministrationReports) | レポートメタデータを保持するAdministrationReportオブジェクトの配列。これらは、ダッシュボードタブ内のポートレットを構成するレポートです。 |
AssociatedReports | Array (Integer) |
|
AdministrationReportGroup Element | データ型 | 説明 |
|---|---|---|
RoleName | String | Yellowfinロールの名前 |
RoleDescription | String | Yellowfinロールの説明 |
RoleCode | String | データベースで生成されて参照されるYellowfinロールの内部コード |
AdministrationGroup Element | データ型 | 説明 |
|---|---|---|
GroupName | String |
|
GroupDescription | String |
|
GroupId | Integer |
|
GroupStatus | String |
|
GroupInternalReference | String |
|
GroupMembers | Array (AdministrationGroupMember) | AdministrationGroupMemberオブジェクトの配列。これらのオブジェクトにはグループメンバーのメタデータが保持されます。 |
AdministrationClientOrg Element | データ型 | 説明 |
|---|---|---|
ClientName | String | クライアント組織の名前。 |
ClientReferenceID | String | クライアントの識別に使用される固有のIDであるクライアント参照ID。 |
TimeZoneCode | String | クライアント組織のローカルタイムゾーンコード。有効な値については、付録を参照してください。 |
DefaultOrg | Boolean | この組織がデフォルト組織である場合にtrueを返すブール値。 |
ReportBinaryObject Element | データ型 | 説明 |
|---|---|---|
Key | String | バイナリーオブジェクトストレージに使用される固有キー |
ContentType | String | バイナリーオブジェクトのMIMEタイプ |
Data | Array (Byte) | バイナリーオブジェクトのRAWデータ |
ContentResource Element | データ型 |
|---|---|
ResourceName | String |
ResourceDescription | String |
ResourceId | Integer |
ResourceUUID | Integer |
ResourceType | String |
ResourceOrgId | Integer |
ResourceCode | String |
ImportOption Element | データ型 | 説明 |
|---|---|---|
ItemIndex | Integer | このオプションが付加されたアイテムのインデックス |
OptionKey | String | オプションのタイプ |
OptionValue | String | このオプションに関連付けられた値 |