管理オブジェクト定義

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

AdministrationServiceRequest

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

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

パラメーター名	型	説明
sessionId	String
loginId	String	こちらは、Yellowfin webサービス使用権を有効にしたYellowfinアカウントを参照します。Yellowfinのデフォルト（プライマリー）組織に所属するユーザーでなくてはいけません。
password	String	こちらは、上記アカウントのパスワードを参照します。
ntlm	Boolean
orgId	Integer	デフォルト組織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
高度なCSV機能使用権	ADVANCEDEXCEL	データソースの選択など、スプレッドシートやCSVレポート上で高度な操作を実行することができます。	null	CRUD
SQL書式設定・ストアドプロシジャー使用権	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
CSVテーブル作成権	CREATESSTABLE	CSVからビューを作成することができます。	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
CSVレポート作成権	EXCELREPORTS	スプレッドシートやCSVファイルに基づくレポートを作成できます。	null	CRUD
レポートエクスポート権（CSV形式）	EXPORTCSV	CSV形式でのレポートエクスポートを許可します。	null	CRUD
レポートエクスポート権（DOC形式）	EXPORTDOC	DOC形式でのレポートエクスポートを許可します。	null	CRUD
レポートエクスポート権（XLS形式）	EXPORTEXCEL	XLS形式でのレポートエクスポートを許可します。	null	CRUD
レポートエクスポート権（PDF形式）	EXPORTPDF	PDF形式でのレポートエクスポートを許可します。	null	CRUD
レポートエクスポート設定権	EXPORTSETTINGS	システムデフォルトではなく、保存メニューを通して、レポートのエクスポート設定を定義することができます。	null	CRUD
ビュー・レポート設計情報のエクスポート権	EXPORTVIEW	バックアップや、他のシステムへの移行のために、コンテンツをXMLファイルにエクススポートすることができます。	null	CRUD
マルチキャストレポート発行権	MULTICAST	外部ユーザーにレポートをブロードキャストすることができます。	null	CRUD
アクセスフィルターレポートのマルチキャスト配信権	MULTICASTSRCFILTER	ユーザーが外部ユーザーへ、アクセスフィルターを使用して、レポートをブロードキャストすることができます。ブロードキャストを作成したユーザーの資格情報が、外部ユーザーにレポートをブロードキャストするために使用されます。	null	CRUD
指名ユーザー	NAMEDUSER	ユーザーは同時ログオンによる制限に含まれません。	null	CRUD
OLAPデータソース使用権	OLAP	OLAPデータソースに接続することができます。	null	CRUD
システム構成管理権	ORGCONFIG	システムパラメーターを変更することができます。	null	CRUD
参照コード管理権	ORGREFCODES	管理コンソールから参照コードを管理することができます。	null	CRUD
Yellowfin画面設定権（ヘッダー、フッター、ナビゲーション）	PAGEFORMAT	ページレイアウト（統合設定、など）を構成することができます。	null	CRUD
ストーリーボード作成権	PUBLICSTORYBOARD	共有ストーリーボードを作成することができます。	null	CRUD
共有レポート発行権	REPORTCORPORATE	共有レポートを作成し、編集できます。	null	CRUD
ダッシュボードレポートメニューの非表示化	REPORTDASHBOARD	ダッシュボードページへアクセスし、ユーザーにだけ参照可能な非公開ダッシュボードを作成することができます。	null	CRUD
Assisted Discovery使用権	REPORTDATADISCOVERY	レポートビルダーでインサイトを使用することを許可します。	null	CRUD
レポート電子メール発行権	REPORTEMAIL	レポートのコピーをアドホック電子メール送信することができます。	null	CRUD
レポートからレポート作成権	REPORTFROMREPORT	レポートの結果を元にレポートを作成することを許可します。	null	CRUD
マネジメント情報レポート作成権（履歴・アーカイブ）	REPORTMI	コンテンツカテゴリーバージョン履歴設定に応じて、レポートの結果セットをアーカイブします。	null	CRUD
ロールの表示を制限	RESTRICTROLES	新しくユーザーやグループを追加する際に、ロールの表示を制限します。	null	CRUD
レポート更新の非表示化	RPTREFRESH	レポート更新メニューを非表示にします。	null	CRUD
SQLレポート・Jasperレポート作成権	RUNTYPE	フリーハンドSQLレポートや、Jasperレポートを作成することができます。	null	CRUD
ドラフト（編集中）共有レポート閲覧・管理権	SEECORPDRAFT	他のユーザーに作成されたドラフト（編集中）の共有レポートを参照することができます。	null	CRUD
サポート用電子メールアドレス設定権	SEMAIL	サポート用電子メールのアドレスを設定することができます。	null	CRUD
スキーマの確認のスキップ	SKIPSCHEMACHECK	CheckSchemaForUser機能を使用していても、スキーマの確認を無視します。	null	CRUD
アクセスフィルター設定権	SOURCEFILTER	アクセスフィルターを作成できます。	null	CRUD
SSRSレポート作成権	SSRS	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
テーマ管理権	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
DBMSエラーメッセージの非表示化	HIDEDBMSMSG	DBMSからのエラーメッセージを、一般的なメッセージに置き換えます。	null	CRUD
プロフィールでの電子メール変更禁止	HIDEEMAIL	ユーザーによるプロフィールでの電子メールアドレス変更を禁止します。	null	CRUD
埋め込みリンクの非表示化	HIDEEMBEDLINKS	JavaScript APIを使用して、レポートやダッシュボードへの埋め込みリンク表示の禁止します。	null	CRUD
外部レポートURLの非表示化	HIDEEXTLINKS	外部レポートやダッシュボードへのURL表示を禁止します。	null	CRUD
プロフィールでのパスワード変更禁止	HIDEPASSWORD	ユーザーによるプロフィールでのパスワード変更を禁止します。	null	CRUD
印刷の非表示	HIDEPRINT	レポートやダッシュボード上のレポートの印刷オプションを非表示にします。	null	CRUD
カラムオプションの非表示化（閲覧ページ）	HIDERPTLISTCOLUMNS	閲覧ページのカラム（列）オプションを非表示にします。ユーザーに表示するカラム（列）の変更を許可しません。	null	CRUD
レポート詳細の非表示化（閲覧ページ）	HIDERPTLISTDETAILS	閲覧ページのレポート詳細を非表示にします。	null	CRUD
レポートオープンの非表示化	HIDERPTMENUOPEN	レポートオープンメニューを非表示にします。	null	CRUD
レポートSQL情報の非表示化	HIDESQL	レポートSQLをユーザーから非表示にします。こちらの機能を有効にした場合、こちらのロールを付与されたユーザーはレポートSQLを参照することができません。	null	CRUD
プロフィールでのユーザーID変更禁止	HIDEUSERID	ユーザーによるプロフィールでのユーザーID変更を禁止します。	null	CRUD
ビュー・レポート設定情報のインポート権	IMPORTVIEW	XMLファイルからコンテンツをインポートすることができます。	null	CRUD
インスタントインサイト設定権	INSTANTINSIGHTSETTING	ビューレベルでインスタントインサイトを設定することを許可します。	null	CRUD
インスタントインサイト作成権	INSTANTINSIGHTUSE	インスタントインサイトの使用を許可します。	null	CRUD
JavaScriptグラフ作成権	JAVASCRIPTCHART	グラフビルダーを使用して、JavaScriptグラフを作成することを許可します。警告：カスタムのJavaScriptの実行を許可するため、信頼された開発者にのみ有効にしてください。	null	CRUD
ログインID（認証方法）設定権	LOGONID	ログインID（認証方法）の変更を許可します。	null	CRUD
日付フィルター期間管理権	MANAGEFILTERPERIOD	どの日付フィルター期間を有効にするか選択することができます。	null	CRUD
タグ作成編集権	MANAGETAG	タグを作成し、編集できます。	null	CRUD
ビューカテゴリー、フィールドカテゴリー管理権	VIEWCATEGORIES	管理コンソールからビューカテゴリーとフィールドカテゴリーを管理することができます。	null	CRUD
フリーハンドSQLビュー作成権	VIEWRUNTYPE	フリーハンドSQLビューの作成をすることができます。	null	CRUD
Yellowfin Webサービス使用権	WEBSERVICES	Yellowfin Webサービスの使用を許可します。Webサービスを利用する際の認証に使用します。	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

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

AdministrationClientOrg

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

AdministrationReportGroup

AdministrationReportGroup要素	データ型	説明
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String	値の選択肢は以下の通りです。 ANALYTIC KPI
ReportGroupInternalReference	String
GroupReports	AdministrationReport[]	ダッシュボードレポートの詳細を含む配列です。
AssociatedReports	Integer[]	関連するレポートIDの配列です。
PublishUUID	String	ダッシュボードのUUIDです。

ReportBinaryObject

ReportBinaryObject要素	データ型	説明
Key	String	バイナリーオブジェクトの保存に使用される一意のキーです。
ContentType	String	バイナリーオブジェクトのMIME型です。
Data	Byte[]	バイナリーオブジェクトのロウデータです。

ContentResource

ContentResource要素	データ型	説明
ResourceName	String
ResourceDescription	String
ResourceId	Integer
ResourceUUID	Integer
ResourceType	String	必須パラメーターです。各コンテンツタイプのリソース型は、以下の通りです。 RPTCATEGORY （レポートカテゴリー） RPTSUBCATEGORY（レポートサブカテゴリー） DATASOURCE （データソース） VIEW（ビュー） GROUP（ダッシュボード） REPORT（レポート） ETLPROCESS（トランスフォーメーションフロー）
ResourceOrgId	Integer
ResourceCode	String	必須パラメーターです。（Yellowfinのデータベースから確認することができます。）
ChangeDate	Date	オブジェクトが最後に更新された日時です。

ImportOption

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

OptionKey

OptionValue

タスク

SKIP

True

False

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

OPTION

ADD

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

OPTION

REPLACE

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

注意： これには、既存のレコードの置き換えが必要です。

EXISTING

Content UUID

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

DATABASETYPECODE

コード

データベースシステム	データベースコード
汎用ODBCソース	GENERICODBC
Microsoft Access	MSACCESS
DB2 AS400	AS400
Cache DB	CACHEDB
Columnar DB	COLUMNAR
DB2	DB2
Connection Cloud	CONECTIONCLOUD
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 OenEdge	OPENEDGE
Oracle	ORACLE
Pervasive	PERVASIVE
PostgreSQL	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になります。

CATEGORY

IMP<CategoryCode>

インポート中に同一のエクスポートファイル内のカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。

SUBCATEGORY

IMP<CategoryCode>

インポート中に、上記で指定されたカテゴリーの子に当たる、同一エクスポートファイル内の既存のレポートサブカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。

ソースパラメーターはデータソースのインポート時に渡すことができ、SOURCEPARAMETER_が接頭辞として付きます。

ソースパラメーターは、Yellowfinの接続ウィザードに表示されるすべてのオプションであり、ソースごとに異なります。

以下は、よく使用されるデータソースのソースパラメーターオプションの一覧です。

PostgreSQL:

HOSTNAME
PORT
DATABASE
ADDITIONALPARAMETERS

MySQL:

HOSTNAME
PORT
DATABASE
ADDITIONALPARAMETERS
USEFETCHSIZE (TRUE/FALSE)
FETCHSIZE (Integer)

MS SQL Server:

HOSTNAME
PORT
DATABASE
ADDITIONALPARAMETERS
USEFETCHSIZE (TRUE/FALSE)
FETCHSIZE (Integer)
WINDOWSAUTH (WINDOWS/SQL)
DOMAIN (Windows Auth Domain)
USENAMEDINSTANCE (TRUE/FALSE)
NAMEDINSTANCE (Instance Name)
SSLOPTION (ENABLED/DISABLED)
DRIVER (net.sourceforge.jtds.jdbc.Driver/com.microsoft.jdbc.sqlserver.SQLServerDriver/com.microsoft.sqlserver.jdbc.SQLServerDriver)

Oracle:
MODE (SID/SERVICE/TSNAMES)
HOSTNAME
PORT
ADDITIONALPARAMETERS
SID (Sid)
SERVICE (Service)
TSNAMES (TSNames)
USEFETCHSIZE (TRUE/FALSE)
FETCHSIZE (Integer)

上記以外のソースについて、ソースパラメーターオプションはエクスポートファイルから抽出できます。これを実行するには、以下の手順に従います。

ステップ1:

ソースパラメーターを検索したいタイプのソースをYellowfinからエクスポートします。これにより、YFXファイルが生成されます。

ステップ2:

YFXファイルを解凍します。使用しているOSがアーカイブとして認識しない場合は、Zipファイルとして名前を変更する必要があります。

ステップ3:

ファイルを解凍すると、YFExport.xmlファイルが抽出されます。このファイルをテキストエディターで開きます。

ステップ4:

xmlファイル内で<sourceParameter>を検索します。xmlファイル内の各<sourceParameter>ノードには、parameterKeyが含まれており、これがインポート時に使用できるキーとなります。parameterValueにはエクスポート用のソースパラメーターの値が表示されます。これはインポート時にImportOptionで変更できる値です。

ImportIssue

パラメーター	データ型
itemKey	String
resource	ContentResource
issueElements	ImportIssueElement[]

ImportIssueElement

パラメーター	データ型
itemKey	String
messageComponents	String[]
renderdMessage	String

ParentReportGroup

パラメーター	データ型	説明
reportGroupId	Integer	ダッシュボードタブのIDです。
reportGroupUUID	String	ダッシュボードタブの公開されたUUIDです。
displayOrder	Integer	ユーザーダッシュボード内でのダッシュボードタブの順序です。
reportGroup	AdministrationReportGroup	ダッシュボードタブです。
reportGroupSubTabs	AdministrationReportGroup[]	ダッシュボードとサブタブです。

ParentDashboard

パラメーター	データ型	説明
dashboardName	String	ダッシュボードの名前です。
dashboardGroupId	Integer
tabIds	String[]	サブタブのIDの配列です。
tabNames	String[]	サブタブの名前の配列です。
statusCodes	String[]	サブタブのステータスの配列です。

PersonFavourite

パラメーター	データ型	説明
PersonId	Integer	ユーザーIpIdです。（Yellowfinデータベース、Person.IpPerson）
ContentType	String	特定のコンテンツタイプにより結果にフィルターを適用する場合に使用できるオプションパラメーターです。値の選択肢は、以下の通りです。 REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	こちらのオプションパラメーターは、内部IDを提供することで、特定のコンテンツタイプにより結果を制限する場合に使用することができます。
FavouriteType	String
CreationCode	String
CreatorId	Integer	こちらは、コンテンツをユーザーに配信するコンテンツの配信者を指します。こちらは、CreationCodeを「DISTRIBUTE」に設定して使用します。
TextEntityId	Integer
InstanceId	Integer
CreationDate	Date
Subject	String
Message	String
WidthCode	String

以下は、ContentType、FavouriteType、CreationCodeの組み合わせの例を示しています。

ContentType	FavouriteType	CreationCode	説明
REPORT	FAVOURITE	MANUAL	お気に入りレポートです。
REPORTGROUP	REPORTDASHBOARD		ユーザーがダッシュボード上で参照することのできるすべてのダッシュボードタブです。
REPORTGROUP	INBOX	DISTRIBUTE	ユーザーに配信されたダッシュボードです。
DISCUSSIONGROUP	DISCUSSIONMEMBER		ユーザーがメンバーの一員であるディスカッションです。
REPORTVIEW		MANUAL	お気に入りビューです。
STORYBOARD	FAVOURITE	WEB	お気に入りストーリーボードです。
IMAGE	PROFILE	MANUAL	ユーザーのプロフィールイメージです。
COMMENT	FLAGGED	MANUAL	ユーザーコメントによるフラグ付けです。

AdministrationDataSource

リクエスト要素	データ型	説明
AccessLevelCode	String	データベースのアクセス権、アクセスレベルを指定します。
ClientSources	AdministrationDataSourceClientLink
ConnectionDriver	String	データソースの接続に使用するドライバーです。
ConnectionPath	String
ConnectionString	String	データソースの接続文字列です。
ConnectionTimeout	Integer	これは、秒単位で指定します。
ConnectionType	String	接続のタイプです。例：JDBC、など
ConnectionTypeCode	String
InheritChildSourceFilters	Boolean
LogFile	String
MaxRows	Integer	取得されるデータロウ（行）の最大数です。
MaxmimumConnections	Integer
MinimumConnections	Integer
RefreshTime	Integer	これは、時間単位で指定します。
SourceDescription	String	データソースの説明です。
SourceId	Integer	各データソースに固有のYellowfin IDです。こちらを提供しない場合は新しいデータソースが作成されるため、既存のデータソース編集時には、必ず指定しなくてはいけません。
SourceName	String	データソースの名前です。
SourceOptions	AdministrationDataSourceOption
SourceType	String	データソースのタイプです。例：MySQL、Oracle、など
Timezone	String
UserName	String	データソースアカウントのユーザー名です。
UserPassword	String	上記アカウントのパスワードです。パスワードは、データソース保存時に自動的に暗号化されます。

AdministrationDataSourceOption

パラメーター	型
OptionKey	String
OptionValue	String
ValueDataType	String

AdministrationDataSourceClientLink

パラメーター	型
clientOrgId	Integer
clientOrgRef	String
sourceId	Integer

AdministrationSchedule

Yellowfinのスケジュール設定された管理サービスを表現する抽象classです。こちらのclassは、すべてのタスクスケジュールに共通する機能/データを提供します。Subclassは、ブロードキャスト情報などの、subclassに特化したデータの情報を追加します。

パラメーター	データ型	説明
Frequency	ScheduleFrequency[]	スケジュール頻度型の詳細を含む配列オブジェクトです。
ScheduleActive	String	スケジュールが有効かどうかを返します。これは、スケジュールが現在実行中であるかどうかは示しませんが、次回のスケジュール時にスケジュールが実行されるかどうかを示します。
ScheduleDescription	String	スケジュール目的の短い説明です。こちらは通常、レポート名やフィルター名など、スケジュールの目的となるアイテムの名前を含みます。
ScheduleUUID	String	システムが生成するスケジュールのUUIDです。
ScheduleTypeCode	String	こちらのレコードのスケジュールタイプです。例：REPORTBROADCAST、SOURCEFILTERREFRESHなど
LastRunStatus	String	スケジュールの最終実行のステータスコードです。こちらの値は、スケジュール完了後にのみ更新されるため、スケジュールが現在実行中の場合は、以前の値が含まれます。
LastRunError	String	最終実行が失敗した場合、こちらのフィールドには、何が起きたのかを示すエラーが含まれます。
LastRunDateTimeGMT	String	スケジュールの最終実行のGMT時間です。これは、スケジュールが開始された時刻であることをに注意してください。
NextRunDateTimeGMT	String	現在のスケジュール設定に基づき、こちらは、次回スケジュールが実行される時間をGMT時間で返します。こちらの値は「リアルタイム」ではないことに注意をしてください。つまり、サーバが変更を受信し、それを検証して、新しいスケジュールオブジェクトを返すまでは更新されません。

以下は、AdministrationSchedule classのsub classの例です。

AdministrationSchedule sub class	説明	フィールド
CompositeViewRefreshSchedule	コンポジットビューのタスク更新を表現するスケジュールです。	こちらのclassは、以下のフィールドを含みます。 ViewId：コンポジットビューのデータベースIDを返します。
FilterGroupCacheRefreshSchedule	キャッシュフィルターやフィルターグループのタスクを更新します。	こちらの class は、以下のフィールドを含みます。 ViewId：コンポジットビューのデータベースIDを返します。 FilterGroupId：フィルターグループのデータベースIDを返します。
RefCodeRefreshSchedule	カスタム参照コードのタスクを更新します。	こちらの class は、以下のフィールドを含みます。 SourceId：参照コードが更新されるソースのデータベースIDを返します。
ReportBroadcastSchedule	レポートのブロードキャストタスクです。ブロードキャストレポートと受信者の情報を含みます。	こちらの class は、以下のフィールドを含みます。 ReportId：ブロードキャストされるレポートのIDを返します。 Recipients：ブロードキャストの各受信者のIDの配列を返します。各入力はグループ、または個人のIDになります。 Subject：ブロードキャストの件名を返します。いくつかのブロードキャストタイプは、こちらのフィールドを使用しません。 AppendDate：いくつかのブロードキャストタイプ（特に、FTPとEMALタイプ）は、件名やファイル名にブロードキャストの日時を追加するオプションがあります。 BodyText：電子メールブロードキャストのメール本文を返します。 Format：ブロードキャスト出力形式コードを返します。HTML、PDFなど ConditionList：複雑なブロードキャスト条件を表現するConditionオブジェクトの配列を返します。 FailureNotificationGroup：ブロードキャストが失敗した際に通知をするグループのIDを返します。 BroadcastStartDate：ブロードキャストスケジュールの開始が設定された日時を返します。 BroadcastEndDate：ブロードキャストスケジュールの終了が設定された日時を返します。
ReportFilterCacheRefreshSchedule	レポートキャッシュフィルターのタスクを更新します。	こちらの class は、以下のフィールドを含みます。 ReportId：キャッシュフィルターを含むレポートのIDを返します。
ReportRefreshSchedule	読み込み時に自動実行されないレポートのタスクを更新します。	こちらの class は、以下のフィールドを含みます。 ReportId：スケジュールが設定されたレポートのIDを返します。
SourceFilterRefreshSchedule	ソースフィルターのタスクを更新します。ソースからのクエリーに基づきソースフィルター値を更新しましょう。	こちらの class は、以下のフィールドを含みます。 SourceId：ソースタイプの応じて、データソースID、またはレポートIDになります。 SourceType：SOURCE または REPORTが、SourceIdが指すオブジェクトのタイプを指定します。
SourceFilterUpdateReminderSchedule	ソースフィルター値更新のリマインダータスクです。スケジュールの特定のユーザーにリマインダーを送信します。	こちらの class は、以下のフィールドを含みます。 SourceId：ソースフィルターを更新するデータソースのデータベースIDです。
ThirdPartySourceAutoRunSchedule	サードパーティ製データソースの自動実行タスクです。	こちらの class は、以下のフィールドを含みます。 SourceId：サードパーティ製データソースのデータベースIDです。

ScheduleFrequency

すべての頻度型のベースclassです。こちらのclassは、頻度スケジュールのデータベース属性を保持します。各フィールドのデータベース値に基づく有効なデータを設定し、取得するユーザーフレンドリーなメソッドを提供するのが各subclassの責任です。

例：月の曜日は頻度単位に保存されることもありますが、スケジュールタイプが月の曜日をまったく持たない場合は保存されません。subclassはまた、検証を強制します。

パラメーター	データ型	説明
FrequencyTypeCode	String	こちらのオブジェクトの頻度タイプです。オブジェクトタイプの決定に使用されます。
FrequencyCode	String	頻度タイプコードに応じて、異なる意味合いを持ちます。
FrequencyUnit	Integer	頻度タイプコードに応じて、異なる意味合いを持ちます。
LocalRunTime	Integer	こちらのスケジュールを実行する真夜中からの秒数を返します（こちらのスケジュールのタイムゾーンに関連します）。注意： MinutesFrequencyなど、いくつかのスケジュールタイプは、こちらを適切に使用しません。
LocalTimezoneCode	String	指定されたローカルの実行時間を、Yellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード（例：AUSTRALIA / SYDNEYなど）です。
DayOrdinals	String	序数に対応する曜日名の順序付き一覧です。

以下は、ScheduleFrequency classのいくつかのsub classの例です。

ScheduleFrequency Sub Class	説明	フィールド
AnnualFrequency	特定の月の特定の日に設定された時間です。	こちらの class は、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する月の英語名を大文字で表記しなくてはいけません。 FrequencyUnit：こちらのスケジュールを実行する月の曜日を指定します。
BiannualFrequency	一年の中で等間隔に配置された二ヶ月の特定の日に設定された時間です。X月と（6 + X）月で、Xは「MonthOfYear」属性です。	こちらの class は、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する最初の月の数字名を英語の大文字で表記しなくてはいけません。例えば、スケジュールが一月と七月に実行される場合、値は「ONE」（年の最初の月、そしてこれに6ヶ月を追加します）です。最大値はSIXです。 FrequencyUnit：スケジュールを実行する月の曜日を指定します。
DailyFrequency	毎日設定された時間です。こちらのclassに追加フィールドはなく、localRun Timeのみが必要です。
EndOfMonthFrequency	毎月最終日に設定された時間です。こちらのclassに追加フィールドはなく、localRun Timeのみが必要です。
FortnightlyFrequency	二週間に一度、特定の曜日に設定された時間です。	こちらの class は、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する曜日の英語名を大文字で表記しなくてはいけません。（例：MONDAY） FrequencyUnit：上記のFrequencyCodeで使用されている曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。例：MONDAY=1、SUNDAY=0、など
MinutesFrequency	毎X分です。	こちらの class は、以下のフィールドを含みます。 FrequencyUnit：スケジュールの実行間隔です。
MonthlyFrequency	各月の特定の曜日に設定された時間です。	こちらの class は、以下のフィールドを含みます。 FrequencyUnit：こちらのスケジュールを実行する月の曜日です。
QuarterlyFrequency	各四半期の第一、第二、または第三月の特定の曜日に設定された時間です。	こちらの class は、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する各四半期の月の数字を英語の大文字で表記しなくてはいけません。例えば、スケジュールを四半期の最初の月に実行する場合、値は「ONE」になり、スケジュールは一月、四月、七月、十月に実行されます。値の最大値はTHREEです。 FrequencyUnit：こちらのスケジュールを実行する月の曜日を指定します。
WeekdaysFrequency	すべての平日に設定された時間です。こちらのclassに追加フィールドはなく、localRunTimeのみが必要です。
WeeklyFrequency	特定の曜日に設定された時間です。	こちらの class は、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記しなくてはいけません。例：MONDAY FrequencyUnit：上記のfrequencyCodeで使用する曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。例：MONDAY=1、SUNDAY=0、など