Page Comparison

Anchor

	top
	top

...

Expand

title	UPDATEUSER

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Person

AdministrationPerson

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

...

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

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

...

Expand

title	CREATEGROUP

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

...

Expand

title	EXCLUDEUSERFROMGROUP

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

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

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

...

Expand

title	MODIFYGROUP

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

Code Block

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

group.setGroupName("Group Name");

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

...

Expand

title	ADDUSERACCESS

デフォルト組織への追加

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

Code Block

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

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

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

...

Expand

title	ISREPORTFAVOURITE

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Expand

title	ADDTOFAVOURITES / ADDTOFAVORITES

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Expand

title	REMOVEFAVOURITES / REMOVEFAVORITES

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

Code Block

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

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Expand

title	GETAVATARS

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

BinaryAttachments

Array（ReportBinaryObject）

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

Expand

title	SETAVATARIMAGE

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

Expand

title	APPROVEREPORT

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

Code Block

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

応答要素

データ型

説明

StatusCode

String

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

SUCCESS
FAILURE

オブジェクト定義

Expand

title	AdministrationPerson

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

Expand

title	AdministrationReport

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

Expand

title	AdministrationReportGroup

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

Expand

title	AdministrationRole

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

Expand

title	AdministrationGroup

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

Expand

title	AdministrationClientOrg

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

Expand

title	ReportBinaryObject

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

Expand

title	ContentResource

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

Expand

title	ImportOption

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

オプションキー

オプション値

タスク

SKIP

True

False

インポートファイル内のアイテムをスキップします。

OPTION

ADD

インポートファイルのアイテムをインポートします。

OPTION

REPLACE

インポートファイルのアイテムで、既存のアイテムを置き換えます。

注意：置き換えるためには、既存のレポートが必要です。

EXISTING

Content UUID

置き換えるコンテンツの内部IDが必要です。例えば、アイテムがビューの場合、こちらの値は、既存のビューIDになります。アイテムが、フォルダー、またはサブフォルダーの場合、IDではなくフォルダーコードになります。

DATABASETYPECODE

Expand

title	Code

データベースシステム	データベースコード
Generic ODBC Source	GENERICODBC
Microsoft Access	MSACCESS
DB2 AS400	AS400
Cache DB	CACHEDB
Columnar DB	COLUMNAR
DB2	DB2
Connection Cloud	CONNECTIONCLOUD
Derby	DERBY
DIAPRISM	DIAPRISM
FileMaker Pro	FILEMAKER
Firebird	FIREBIRD
FoxPro	FOXPROODBC
H2	H2
Hive	HIVE
HSQLDB	HSQLDB
Informix	INFORMIX
Ingres	INGRES
Vectorwise	VECTORWISE
Interbase	INTERBASE
Lucid	LUCIDDB
MonetDB	MONETDB
MySQL	MYSQL
Netezza	NETEZZA
Lotus Notes	NOTES
NouDB	NOUDB
Progress OpenEdge	OPENEDGE
Oracle	ORACLE
Pervasive	PERVASIVE
PostgresSQL	POSTGRESQL
Progress	PROGRESS
SAP HANA	SAPHANA
SAS	SASJDBC
SqLite	SQLITE
Microsoft SQL Server	MSSQLSERVER
Sybase ASA / Sybase SQL Anywhere	SYBASEASA
Sybase ASE	SYBASEASE
Sybase IQ	SYBASEIQ
TeraData	TERADATA
Universe	UNIVERSE
Vertica	VERTICA

インポート中に、データソースタイプの詳細を上書きします。

DRIVER

JDBC Driver classname

インポート時に、データソースホストの詳細を上書きします。

URL

A JDBC URL

インポート時に、データソースURLの詳細を上書きします。

DATASOURCE

XMLA Data Source

インポート時に、XMLAデータソースの詳細を上書きします。

CATALOG

XMLA Catalog

インポート時に、XMLAデータソースカタログの詳細を上書きします。

USERNAME

Source Username

インポート時に、データの詳細を上書きします。

PASSWORD1

Source Password

インポート時に、データソースパスワードの詳細を上書きします。

注意：「PASSWORD2」の設定も必要です。

PASSWORD2

Password Validation

インポート時に、データソースパスワードの詳細を上書きします。

SOURCE

SOURCE<SourceId>

別のソースにビューを添付します。例：ID 39003のソースに添付する場合は、「SOURCE39003」になります。

CACHEVIEW

True

False

キャッシュされたビューを、インポートでもキャッシュするかどうかを切り替えます。

CACHESOURCE

SOURCE<SourceId>

インポート時に、ビューをキャッシュするソースを選択します。例：ID 39003のソースを選択する場合は、「SOURCE39003」になります。

Version	Old Version 1	New Version 2
Changes made by	Yellowfin Admin	Yellowfin Admin
Saved on	May 31, 2017	Aug 21, 2017

Page Comparison

Versions Compared

Key

デフォルト組織への追加

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

オブジェクト定義