管理オブジェクト定義

これらのオブジェクトは、管理webサービスに固有です。

AdministrationServiceRequest

こちらのオブジェクトは、webサービスに対して行われる呼び出しの型を定義します。

オブジェクトパラメーター：

パラメーター名	型	説明
sessionId	String
loginId	String	こちらは、Yellowfin webサービス使用権を有効にしたYellowfinアカウントを参照します。Yellowfinのデフォルト（プライマリー）組織に所属するユーザーでなくてはいけません。
password	String	こちらは、上記アカウントのパスワードを参照します。
ntlm	Boolean
orgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、1に設定します。
loginSessionId	String
orgRef	String
query	String
reportId	Integer
dashboardTabId	Integer
function	String	こちらは、呼び出しの型を参照します。
person	AdministrationPerson
group	AdministrationGroup
report	AdministrationReport
client	AdministrationClientOrg
reportGroup	AdministrationReportGroup
favourite	PersonFavourite
contentResources	ContentResource[]
importOptions	ImportOption[]
role	AdministrationRole
retrospectiveDays	Integer
binaryData	byte[]
people	AdministrationPerson[]
datasource	AdministrationDataSource
sourceClientLink	AdministrationDataSourceClientLink
sourceId	Integer
schedule	AdministrationSchedule

すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例：

AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);

すべてのパラメーターを定義する必要はありません。各webサービスの呼び出しは、必要なパラメーターの一覧を持ちます。指定されないパラメーターは、デフォルトでnull値を持ちます。

しかし、以下の示すように、すべてのリクエストに必須のパラメーターがあります。

loginId
password
orgId
function

その他のパラメーターは、関数値に応じて要求されます。

各リクエストにはwebサービスユーザーの詳細を含めなくてはならず、これはYellowfinのwebサービスを呼び出せるユーザーになります。また、これは既存のユーザーでなくてはならず、「Yellowfin webサービス使用権」を付与され、これらの詳細がloginId、password、orgIdとして指定されていなくてはいけません。

AdministrationServiceResponse

こちらのオブジェクトは、webサービスにより返されます。

こちらのオブジェクトのパラメーター：

パラメーター名	型
ReportId	Integer
StatusCode	String
ErrorCode	Integer
Messages	String[]
SessionId	String
LoginSessionId	String
person	AdministrationPerson
people	AdministrationPerson[]
group	AdministrationGroup
groups	AdministrationGroup[]
roles	AdministrationRole[]
reports	AdministrationReport[]
reportGroups	AdministrationReportGroup[]
report	AdministrationReport
clients	AdministrationClientOrg[]
client	AdministrationClientOrg
personfavourites	PersonFavourite[]
binaryAttachments	ReportBinaryObject[]
contentResources	ContentResource[]
importIssues	ImportIssue[]
EntityId	Integer
parentDashboard	ParentDashboard
parentDashboards	ParentDashboard[]
parentReportGroups	ParentReportGroup[]
binaryData	String
contentType	String
fileName	String
queryResults	ReportRow[]
datasources	AdministrationDataSource[]
loadedDataSource	AdministrationDataSource
schedule	AdministrationSchedule

すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例：

AdministrationServiceResponse ssr = doWebserviceCall(sr);
 
String statusCode = ssr.getStatusCode();

AdministrationPerson

こちらのオブジェクトは、関数に含まれるYellowfinユーザーを定義するために使用します。

こちらのオブジェクトのパラメーター：

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 Administrator）です。
EmailAddress	String	Yellowfinユーザーの電子メールアドレスです。
LanguageCode	String	優先言語二文字のコードです。
IpId	Integer	Yellowfinの内部IP IDです。
TimeZoneCode	String	Yellowfinユーザーのんタイムゾーンコードです。
Status	String	ユーザーのステータスです。以下のいずれかになります。 ACTIVE INACTIVE INACTIVEWITHEMAIL

AdministrationGroup

AdministrationGroupオブジェクトのパラメーターです。

AdministrationGroup要素	データ型	説明
GroupName	String	グループの名前です。
GroupDescreption	String	グループの説明です。
GroupId	Integer	グループを識別する一意のIDです。
GroupStatus	String
GroupInternalReference	String
GroupMembers	AdministraionGroupMember[]	AdministrationGroupmemberオブジェクトの配列です。これらのオブジェクトは、グループメンバーのメタデータを保持します。

AdministrationGroupMember

パラメーター名	データ型	説明
InternalId	Integer	Yellowfinデータベース内のPersonテーブルのIpIdフィールドです。
LoginId	String	グループメンバーのユーザーIDです。（ログインID方法に応じて、電子メールアドレス、またはユーザーIDになります）

AdministrationRole

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

AdministrationFunction

こちらのオブジェクトで利用可能なパラメーターです。

パラメーター名	データ型	説明
FunctionName	String	関数の名前です。
FunctionCode	String	関数に一意のコードです。
FunctionDescription	String	その目的を定義する関数の説明です。
FunctionTypeCode	String
AccessLevelCode	String	こちらの関数のアクセスレベルを定義するコードです。

Yellwfinの利用可能な関数の一覧です。（レポートアクセスは必須です）

注意：これは、ロールセキュリティ関数の拡張です。

関数一覧を参照

関数名	コード	説明	型コード	アクセスレベルコード
レポートアクセス	MIREPORT	ログインをし、レポートの参照、作成、編集、削除をすることができます。	TN	CRUD
アクティビティストリーム	ACTIVITYSTREAM	アクティビティストリームにアクセスすることができます。	null	CRUD
アドホックレポート	ADHOCREPORTS	アドホックレポートを作成することができます。	null	CRUD
承認管理者	ADMINAPPROVE	承認者を指定することなく、コンテンツ承認を管理することができます。	null	CRUD
高度なスプレッドシート機能	ADVANCEDEXCEL	データソースの選択など、スプレッドシートやCSVレポート場で高度な操作を実行することができます。	null	CRUD
ストアドプロシージャ	ADVANCEDSQL	ストアドプロシージャに対してビューを作成することができます。	null	CRUD
高度なレポート検索の非表示	ADVRPTSEARCH	閲覧ページで高度な検索を非表示にします。	null	CRUD
フリーハンドSQL計算フィールドの許可	ALLOWFREEHANDSQLCALCFIELD	レポートにフリーハンドSQL計算フィールドを作成することができます。	null	CRUD
コンテンツ翻訳	ALLOWTRANSLATE	ダッシュボード、レポート、ビューにユーザーが入力したデータを翻訳することができます。	null	CRUD
注釈	ANNOTATIONS	注釈を参照、編集、作成、削除することができます。	null	CRUD
バックグラウンド実行管理	BACKGROUNDMANAGEMENT	現在実行中のバックグランドタスクの参照、現在のクエリーのキャンセル、待機中アイテムの強制開始をすることができます。	null	CRUD
プラグイン管理	BINARYLOADER	サードパーティ製ソース接続、JDBCドライバー、高度な関数を含むプラグインを管理することができます。	null	CRUD
ブックマークとスナップショット	BOOKMARKS	ブックマークとスナップショットの作成と使用ができます。	null	CRUD
ブロードキャストレポート	BROADCAST	1回限り、またはスケジュールに基づき、レポートをブロードキャストすることができます。	null	CRUD
	BROADCASTSUBSCRIBE		null	CRUD
	CLIENTORGS		null	CRUD
	COMPOSITE		null	CRUD
	CREATESSTABLE		null	CRUD
	CUSTOMFILTER		null	CRUD
	DASHPUBLIC		null	CRUD
	DASHREFRESH		null	CRUD
	DATASOURCE		null	CRUD
	DATASOURCEADMIN		null	CRUD
	DATAVIEW		null	CRUD
	DISABLECACHEDFILTERS		null	CRUD
	DISABLEMOBILE		null	CRUD
	DISCUSSIONADMIN		null	CRUD
	DISCUSSIONGROUPS		null	CRUD
	DISTRIBUTEREPORT		null	CRUD
	DISTRIBUTESTORYBOARD		null	CRUD
	DRAFTDASHBOARDS		null	CRUD
	DRAFTRPTLIST		null	CRUD
	DRAFTVIEWS		null	CRUD
	DRILLTHROUGH		null	CRUD
	EMAILSTORYBOARD		null	CRUD
	ERROREMAIL		null	CRUD
	ERRORSTACKTRACE		null	CRUD
	ETLPROCESS		null	CRUD
	EXCELREPORTS		null	CRUD
	EXPORTCSV		null	CRUD
	EXPORTDOC		null	CRUD
	EXPORTEXCEL		null	CRUD
	EXPORTPDF		null	CRUD
	EXPORTSETTINGS		null	CRUD
	EXPORTVIEW		null	CRUD
	MULTICAST		null	CRUD
	MULTICASTSRCFILTER		null	CRUD
	NAMEDUSER		null	CRUD
	OLAP		null	CRUD
	ORGCONFIG		null	CRUD
	ORGREFCODES		null	CRUD
	PAGEFORMAT		null	CRUD
	PUBLICSTORYBOARD		null	CRUD
	REPORTCORPORATE		null	CRUD
	REPORTDASHBOARD		null	CRUD
	REPORTDATADISCOVERY		null	CRUD
	REPORTEMAIL		null	CRUD
	REPORTFROMREPORT		null	CRUD
	REPORTMI		null	CRUD
	RESTRICTROLES		null	CRUD
	RPTREFRESH		null	CRUD
	RUNTYPE		null	CRUD
	SEECORPDRAFT		null	CRUD
	SEMAIL		null	CRUD
	SKIPSCHEMACHECK		null	CRUD
	SOURCEFILTER		null	CRUD
	SSRS		null	CRUD
	STORYBOARD		null	CRUD
	STORYBOARDADMIN		null	CRUD
	STORYBOARDGLOBAL		null	CRUD
	SUBQUERIES		null	CRUD
	SYSTEMINFO		null	CRUD
	SYSTEMTASKADMIN		null	CRUD
	TASKPERSONAL		null	CRUD
	TASKPUBLIC		null	CRUD
	TASKS		null	CRUD
	THEMES		null	CRUD
	TIMELINE		null	CRUD
	TIMELINECONNECTIONS		null	CRUD
	USERPROFILE		null	CRUD
	FILTERMINMAX		null	CRUD
	FORCECLONEVIEWS		null	CRUD
	GEOPACKMANAGEMENT		null	CRUD
	HIDEADDTODASHBOARD		null	CRUD
	HIDEDASHMAXIMISE		null	CRUD
	HIDEDASHRPTMENU		null	CRUD
	HIDEDBMSMSG		null	CRUD
	HIDEEMAIL		null	CRUD
	HIDEEMBEDLINKS		null	CRUD
	HIDEEXTLINKS		null	CRUD
	HIDEPASSWORD		null	CRUD
	HIDEPRINT		null	CRUD
	HIDERPTLISTCOLUMNS		null	CRUD
	HIDERPTLISTDETAILS		null	CRUD
	HIDERPTMENUOPEN		null	CRUD
	HIDESQL		null	CRUD
	HIDEUSERID		null	CRUD
	IMPORTVIEW		null	CRUD
	INSTANTINSIGHTSETTING		null	CRUD
	INSTANTINSIGHTUSE		null	CRUD
	JAVASCRIPTCHART		null	CRUD
	LOGONID		null	CRUD
	MANAGEFILTERPERIOD		null	CRUD
	MANAGETAG		null	CRUD
	VIEWCATEGORIES		null	CRUD
	VIEWRUNTYPE		null	CRUD
	WEBSERVICES		null	CRUD
	YFLICENCE		null	CRUD
	YFROLES		null	CRUD
	ACCESSFILTER		null	CRUD
	ACCESSGROUP		CP	CRUD
	CONTENTACCESS		CP	CRUD
	USERS		DIR	CRUD
	FAVOURITES		QL	CRUD
	HIDERPTMENUCOMMENTS		null	CRUD
	HIDERPTMENUDETAILS		null	CRUD
	REPORTSHIDDEN		null	CRUD