Page Comparison

Anchor

	top
	top

...

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	EXCLUDEUSERINGROUP

以下のコードは、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("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

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

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

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

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

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

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

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

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

応答要素

データ型

説明

StatusCode

String

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

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	AdministrationPerson

AdministrationPerson ElementAdministrationPerson要素	Data Typeデータ型	Description説明
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Password of the Yellowfin userYellowfinユーザーのパスワード。
FirstName	String	First name of of the Yellowfin userYellowfinユーザーの名。
LastName	String	Last name of of the Yellowfin userYellowfinユーザーの姓。
Initial	String	Middle initial of the Yellowfin userYellowfinユーザーのミドルネームの頭文字。
SalutationCode	String	Title of the Yellowfin user. Possible values include:Yellowfinユーザーの敬称。可能な値は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。
EmailAddress	String	Email address of the Yellowfin userYellowfinユーザーの電子メールアドレス。
LanguageCode	String	Two letter code for the preferred language	優先言語を表す2文字のコード。
IpId	Integer	Internal Yellowfin 内部Yellowfin IP IDID。
TimeZoneCode	String	The TimeZoneCode of the Yellowfin user.YellowfinユーザーのTimeZoneCode。

Expand

title	AdministrationReport

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

Expand

title	AdministrationReportGroup

AdministrationReportGroup ElementAdministrationReportGroup要素	Data Typeデータ型	Description説明
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String
ReportGroupInternalReference	String
GroupReports	Array (AdministrationReports)	Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tabArray（AdministrationReports）	レポートメタデータを保持するAdministrationReportオブジェクトの配列。これらは、ダッシュボードタブ内のポートレットを構成するレポートです。
AssociatedReports	Array (Integer)Array（Integer）

Expand

title	AdministrationRole

AdministrationReportGroup ElementAdministrationReportGroup要素	Data Typeデータ型	Description説明
RoleName	String	The name of the Yellowfin RoleYellowfinロールの名前
RoleDescription	String	The business description of the Yellowfin RoleYellowfinロールの説明
RoleCode	String	The internal code for the Yellowfin Role that is generated and referenced in the databaseデータベースで生成されて参照されるYellowfinロールの内部コード

Expand

title	AdministrationGroup

AdministrationGroup ElementAdministrationGroup要素	Data Typeデータ型	Description説明
GroupName	String
GroupDescription	String
GroupId	Integer
GroupStatus	String
GroupInternalReference	String
GroupMembers	Array (AdministrationGroupMember)	An array of AdministrationGroupMember objects. These objects hold group member metadata

Expand

title	AdministrationClientOrg

Description

AdministrationClientOrg Element	Data Type		Array（AdministrationGroupMember）	AdministrationGroupMemberオブジェクトの配列。これらのオブジェクトにはグループメンバーのメタデータが保持されます。

Expand

title	AdministrationClientOrg

AdministrationClientOrg要素	データ型	説明
ClientName	String	Name of the client organisationクライアント組織の名前
ClientReferenceID	String	Client Reference ID which is the unique ID used to identify a clientクライアントの識別に使用される固有のIDであるクライアント参照ID
TimeZoneCode	String	A client organisation’s local time zone code. See appendix for valid values.クライアント組織のローカルタイムゾーンコード有効な値については、付録を参照してください。
DefaultOrg	BooleanBoolean value that returns true if this organisation is the primary organisation	この組織がデフォルト組織である場合にtrueを返すブール値

Expand

title	ReportBinaryObject

ReportBinaryObject ElementReportBinaryObject要素	Data Typeデータ型	Description説明
Key	String	Unique key used for Binary Object storageバイナリーオブジェクトストレージに使用される固有キー
ContentType	String	MIME type for the Binary ObjectバイナリーオブジェクトのMIMEタイプ
Data	Array (Byte)	Raw data for Binary ObjectArray（Byte）	バイナリーオブジェクトのRAWデータ

Expand

title	ContentResource

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

Expand

title	ImportOption

ImportOption ElementImportOption要素	Data Typeデータ型	Description説明
ItemIndex	Integer	The index of the item that this option is attached too.このオプションが付加されたアイテムのインデックス
OptionKey	String	The type of option.オプションのタイプ
OptionValue	String	A value associated with this option.このオプションに関連付けられた値

Version	Old Version 11	New Version 12
Changes made by	Yellowfin Admin	Yellowfin Admin
Saved on	Jul 22, 2015	Jul 22, 2015

Page Comparison

Versions Compared

Key