管理オブジェクト定義

これらのオブジェクトは、管理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	カスタムSQLクエリーを使用して、レポートにドロップダウンユーザープロンプトフィルターを作成することができます。	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	スプレッドシートや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
ページ形式の構成	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	フリーハンドSQLレポートやJasper Reportをを作成することができます。	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
外部リンクの非表示	HIDEEXTLINKS	外部レポートやダッシュボードへの直接リンクを削除します。	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 Charts	JAVASCRIPTCHART	グラフビルダーから、JavaScript Chartsを作成することができます。警告：こちらは、カスタムJavaScriptを実行することができるため、信頼できる開発者にのみ有効化すべきです。	null	CRUD
ログオンIDの構成	LOGONID	ユーザーの認証方法を指定することができます。	null	CRUD
フィルター期間の管理	MANAGEFILTERPERIOD	利用可能にする事前に定義された日付フィルターを選択することができます。	null	CRUD
タグの作成と編集	MANAGETAG	タグを作成し、編集することができます。	null	CRUD
ビューとフィールドカテゴリー	VIEWCATEGORIES	管理コンソールからビューとフィールドカテゴリーを管理することができます。	null	CRUD
フリーハンドSQLビュー	VIEWRUNTYPE	フリーハンドSQLビューを作成することができます。	null	CRUD
webサービス	WEBSERVICES	こちらの機能は、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

ImportOption

ImportOption要素	データ型	説明
ItemIndex	Integer	こちらのオプションを添付できるアイテムのindexです。
OptionKey	String	オプションの型です。
OptionValue	String	こちらのオプションに関連する値です。

OptionKey

OptionValue

タスク

SKIP

True

False

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

OPTION

ADD

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

OPTION

REPLACE

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

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

EXISTING

Content UUID

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

DATABASETYPECODE

コード

データベースシステム	データベースコード
汎用ODBCソース	GENERICODBC
Microsoftアクセス	MSACCESS
DB2 AS400	AS400
キャッシュDB	CACHEDB
カラム（列）DB	COLUMNAR
DB2	DB2
クラウド接続	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になります。

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

パラメーター	データ型	説明
SourceDescription	String	データソースの説明です。
SourceId	Integer	データソースの一意のYellowfin IDです。
SourceName	String	データソースの名前です。
SourceType	String	データソースのタイプです。例として、MySQL、Oracleなどがあります。
Timezone	String
UserName	String	データソースアカウントのユーザー名です。
UserPassword	String	上記アカウントのパスワードです。
ConnectionDriver	String	データソース接続時に使用するドライバーです。
ConnectionString	String	データソースの接続Stringです。
ConnectionTimeout	Integer
ConnectionType	String	接続のタイプです。例として、JDBCなどがあります。
ConnectionTypeCode	String
AccessLevelCode	String	アクセスレベルのコードです。
InheritChildSourceFilters	String
MaxRows	Integer	取得されるデータロウ（行）の最大数です。
MaxmimumConnections	Integer
MinimumConnections	Integer
RefreshTime	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のサブclassの例です。

AdministrationScheduleサブ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のいくつかのサブclassの例です。

ScheduleFrequencyサブ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：こちらの頻度コードは、こちらのスケジュールを実行する曜日の英語名を大文字で表記します。 FrequencyUnit：上記のFrequencyCodeで使用されている曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。例：MONDAY=1、SUNDAY=0
MinutesFrequency	毎X分です。	こちらのclassは、以下のフィールドを含みます。 FrequencyUnit：スケジュールの実行間隔です。
MonthlyFrequency	各月の特定の曜日に設定された時間です。	こちらのclassは、以下のフィールドを含みます。 FrequencyUnit：こちらのスケジュールを実行する月の曜日です。
QuarterlyFrequency	各四半期の第一、第二、または第三月の特定の曜日に設定された時間です。	こちらのclassは、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する各四半期の月の数字を英語の大文字で表記します。例えば、スケジュールを四半期の最初の月に実行する場合、値は「ONE」になり、スケジュールは一月、四月、七月、十月に実行されます。値の最大値はTHREEです。 FrequencyUnit：こちらのスケジュールを実行する月の曜日を指定します。
WeekdaysFrequency	すべての平日に設定された時間です。こちらのclassに余分なフィールドはなく、そのためlocalRun Timeのみ必要です。
WeeklyFrequency	特定の曜日の特定の時間です。	こちらのclassは、以下のフィールドを含みます。 FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記します。例：MONDAY FrequencyUnit：上記のfrequencyCodeで使用する曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。例：MONDAY=1、SUNDAY=0