30日間の無料評価版をお試しいただけます。

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

 

Anchor
top
top
 


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


Anchor
 
AdministrationServiceRequest
 
AdministrationServiceRequest

Expand
titleAdministrationServiceRequest

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


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

       
パラメーター名説明
sessionIdString 
loginIdStringこちらは、Yellowfin webサービス使用権を有効にしたYellowfinアカウントを参照します。Yellowfinのデフォルト(プライマリー)組織に所属するユーザーでなくてはいけません。
passwordStringこちらは、上記アカウントのパスワードを参照します。
ntlmBoolean
orgIdIntegerYellowfin内のデフォルト(プライマリー)組織IDです。常に、

デフォルト組織IDです。常に、1に設定します。

loginSessionIdString
orgRefString
queryString 
reportIdInteger
dashboardTabIdInteger 
functionStringこちらは、呼び出しの型を参照します。
personAdministrationPerson 
groupAdministrationGroup 
reportAdministrationReport
clientAdministrationClientOrg
reportGroupAdministrationReportGroup
favouritePersonFavourite 
contentResourcesContentResource[] 
importOptionsImportOption[] 
roleAdministrationRole 
retrospectiveDaysInteger 
binaryDatabyte[] 
peopleAdministrationPerson[] 
datasourceAdministrationDataSource 
sourceClientLinkAdministrationDataSourceClientLink 
sourceIdInteger 
scheduleAdministrationSchedule 

 

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



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

code
Code Block
languagejava
themeEclipselanguagejava
AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);
 


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

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

  • loginId
  • password
  • orgId
  • function

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

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

 

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


Anchor
AdministrationServiceResponse
AdministrationServiceResponse

Expand
titleAdministrationServiceResponse

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

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


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

パラメーター名
ReportId Integer
StatusCode String
ErrorCode Integer
Messages String[]
SessionId String
LoginSessionId String
person AdministrationPerson
peopleAdministrationPerson[]
group AdministrationGroup
groups AdministrationGroup[]
roles AdministrationRole[]
reports AdministrationReport[]
reportGroups AdministrationReportGroup[]
report AdministrationReport
clients AdministrationClientOrg[]
client AdministrationClientOrg
personfavourites PersonFavourite[]
binaryAttachments ReportBinaryObject[]
contentResources 

ContentResource[]

importIssues ImportIssue[]
EntityIdInteger
parentDashboard ParentDashboard
parentDashboards ParentDashboard[]
parentReportGroups ParentReportGroup[]
binaryData String
contentType String
fileName String
queryResults ReportRow[]
datasources AdministrationDataSource[]
loadedDataSource AdministrationDataSource
schedule AdministrationSchedule

 

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


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

code
Code Block
languagejava
themeEclipselanguagejava
AdministrationServiceResponse ssr = doWebserviceCall(sr);
 
String statusCode = ssr.getStatusCode();



Anchor

...

AdministrationPerson

...

AdministrationPerson

Expand
titleAdministrationPerson

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

 

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


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 Administrator)です。

Yellowfinのロールです。こちらで指定されたロールは、参照コード(YFADMIN)、またはロール名(Yellowfin Administrator)になります。

EmailAddress

String

Yellowfinユーザーの電子メールアドレスです。

LanguageCode

String

優先言語二文字のコードです。優先言語の二文字のコードです。

IpId

Integer

Yellowfinの内部IP IDです。

TimeZoneCode

String

Yellowfinユーザーのんタイムゾーンコードです。Yellowfinユーザーのタイムゾーンコードです。

Status

String

ユーザーのステータスです。以下のいずれかになります。

  • ACTIVE
  • INACTIVE
  • INACTIVEWITHEMAIL


Anchor
AdministrationGroup
AdministrationGroup

Expand
titleAdministrationGroup

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

 


AdministrationGroup要素データ型説明
GroupNameStringグループの名前です。
GroupDescreptionStringグループの説明です。
GroupIdIntegerグループを識別する一意のIDです。
GroupStatusString 
GroupInternalReferenceString 
GroupMembersAdministraionGroupMember[]AdministrationGroupmemberオブジェクトの配列です。これらのオブジェクトは、グループメンバーのメタデータを保持します。


Anchor
AdministrationGroupMember
AdministrationGroupMember

Expand
titleAdministrationGroupMember


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


Anchor
AdministrationRole
AdministrationRole

Expand
titleAdministrationRole


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


Anchor
AdministrationFunction
AdministrationFunction

Expand
titleAdministrationFunction

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

 


パラメーター名データ型説明
FunctionNameString関数の名前です。機能の名前です。
FunctionCodeString関数に一意のコードです。機能に一意のコードです。
FunctionDescriptionStringその目的を定義する関数の説明です。その目的を定義する機能の説明です。
FunctionTypeCodeString 
AccessLevelCodeStringこちらの関数のアクセスレベルを定義するコードです。

こちらの機能のアクセスレベルを定義するコードです。

 

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

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


Yellwfinで利用可能な機能の一覧です。(レポート作成権は必須です)

注意: これは、ロールセキュリティ機能の拡張です。 


Expand
title関数一覧を参照機能一覧を参照


関数名機能名コード説明型コードアクセスレベルコード
レポートアクセスレポート作成権

MIREPORT 

ログインをし、レポートの参照、作成、編集、削除をすることができます。

TN 

CRUD 

 アクティビティストリーム アクティビティストリーム使用権

ACTIVITYSTREAM

アクティビティストリームにアクセスすることができます。 

アクティビティストリームへのアクセスを許可します。 

null

CRUD

 アドホックレポート アドホック(臨時)レポート作成権

ADHOCREPORTS

アドホックレポートを作成することができます。アドホック(臨時)レポートが作成できます。

null

CRUD

 承認管理者 承認管理権

ADMINAPPROVE

承認者を指定することなく、コンテンツ承認を管理することができます。承認者に指定されていなくても、ユーザーはコンテンツの承認を管理することができます。

null

CRUD

高度なスプレッドシート機能高度なCSV機能使用権

ADVANCEDEXCEL

データソースの選択など、スプレッドシートやCSVレポート場で高度な操作を実行することができます。データソースの選択など、スプレッドシートやCSVレポート上で高度な操作を実行することができます。

null

CRUD

ストアドプロシージャSQL書式設定・ストアドプロシジャー使用権

ADVANCEDSQL

ストアドプロシージャに対してビューを作成することができます。ストアドプロシジャに対してビューを作成することができます。

null

CRUD

高度なレポート検索の非表示高度なレポート検索の非表示化

ADVRPTSEARCH

閲覧ページで高度な検索を非表示にします。

null

CRUD

フリーハンドSQL計算フィールドの許可フリーハンドSQL計算フィールド作成権

ALLOWFREEHANDSQLCALCFIELD

レポートにフリーハンドSQL計算フィールドを作成することができます。レポートでフリーハンドSQLを使用して計算フィールドを作成することができます。

null

CRUD

コンテンツ翻訳コンテンツ翻訳作成権

ALLOWTRANSLATE

ダッシュボード、レポート、ビューにユーザーが入力したデータを翻訳することができます。ダッシュボード、レポート、ビューをユーザーが入力したデータで翻訳することができます。

null

CRUD

注釈注釈機能使用権

ANNOTATIONS

注釈を参照、編集、作成、削除することができます。

null

CRUD

バックグラウンド実行管理バックグラウンド実行管理権

BACKGROUNDMANAGEMENT

現在実行中のバックグランドタスクの参照、現在のクエリーのキャンセル、待機中アイテムの強制開始をすることができます。現在バックグランドで実行されているキューを表示し、現在のクエリーをキャンセルしたり、キューに入れられたアイテムを強制的に開始することができます。

null

CRUD

プラグイン管理プラグイン管理権

BINARYLOADER

サードパーティ製ソース接続、JDBCドライバー、高度な関数を含むプラグインを管理することができます。サードパーティ製ソース接続や、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

カスタム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

スプレッドシートレポートCSVレポート作成権

EXCELREPORTS

スプレッドシートやCSVファイルに基づきレポートを作成することができます。スプレッドシートやCSVファイルに基づくレポートを作成できます。

null

CRUD

CSV形式でレポートをエクスポートレポートエクスポート権(CSV形式)

EXPORTCSV

CSV形式でレポートをエクスポートすることができます。CSV形式でのレポートエクスポートを許可します。

null

CRUD

DOC形式でレポートやダッシュボードをエクスポートレポートエクスポート権(DOC形式)

EXPORTDOC

コンテンツアイテムをDOC形式でエクスポートすることができます。DOC形式でのレポートエクスポートを許可します。

null

CRUD

XLS形式でレポートやダッシュボードをエクスポーレポートエクスポート権(XLS形式)

EXPORTEXCEL

コンテンツアイテムをXLS形式でエクスポートすることができます。XLS形式でのレポートエクスポートを許可します。

null

CRUD

PDF形式でコンテンツをエクスポートレポートエクスポート権(PDF形式)

EXPORTPDF

コンテンツアイテムをPDF形式でエクスポートすることができます。PDF形式でのレポートエクスポートを許可します。

null

CRUD

レポート設定のエクスポートレポートエクスポート設定権

EXPORTSETTINGS

システムデフォルトではなく、保存メニューを通して、レポートのエクスポート設定を定義することができます。

null

CRUD

エクスポートビュー・レポート設計情報のエクスポート権

EXPORTVIEW

バックアップや、他のシステムへの移行のために、コンテンツをXMLファイルにエクススポートすることができます。

null

CRUD

マルチキャストレポートマルチキャストレポート発行権

MULTICAST

外部ユーザーにレポートをブロードキャストすることができます。

null

CRUD

マルチキャストアクセスフィルターレポートアクセスフィルターレポートのマルチキャスト配信権

MULTICASTSRCFILTER

外部ユーザーに、アクセスフィルター付きのレポートをブロードキャストすることができます。ブロードキャストを作成するユーザーの詳細情報は、外部ユーザーにレポートを送信する際に使用されます。ユーザーが外部ユーザーへ、アクセスフィルターを使用して、レポートをブロードキャストすることができます。ブロードキャストを作成したユーザーの資格情報が、外部ユーザーにレポートをブロードキャストするために使用されます。

null

CRUD

名前付きユーザー指名ユーザー

NAMEDUSER

同時ログオン制限をバイパスすることができます。ユーザーは同時ログオンによる制限に含まれません。

null

CRUD

OLAPOLAPデータソース使用権

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 Reportをを作成することができます。フリーハンドSQLレポートや、Jasperレポートを作成することができます。

null

CRUD

ドラフト(編集中)公開レポートドラフト(編集中)共有レポート閲覧・管理権

SEECORPDRAFT

他のユーザーに作成されたドラフト(編集中)バージョンの公開レポートを参照することができます。他のユーザーに作成されたドラフト(編集中)の共有レポートを参照することができます。

null

CRUD

サポートメールの構成サポート用電子メールアドレス設定権

SEMAIL

サポートメールあの宛先を設定することができます。サポート用電子メールのアドレスを設定することができます。

null

CRUD

スキーマチェックのスキップスキーマの確認のスキップ

SKIPSCHEMACHECK

CheckSchemaForUser機能使用時のバイパススキーマチェックです。

CheckSchemaForUser機能を使用していても、スキーマの確認を無視します。

null

CRUD

ソースフィルターアクセスフィルター設定権

SOURCEFILTER

データソースフィルターを作成することができます。アクセスフィルターを作成できます。

null

CRUD

SSRSレポート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メッセージの非表示DBMSエラーメッセージの非表示化

HIDEDBMSMSG

DBMSからのエラーメッセージを一般的なメッセージに置き換えます。DBMSからのエラーメッセージを、一般的なメッセージに置き換えます。

null

CRUD

プロフィール電子メールの変更の無効化プロフィールでの電子メール変更禁止

HIDEEMAIL

プロフィール設定から電子メールアドレスの変更を禁止します。ユーザーによるプロフィールでの電子メールアドレス変更を禁止します。

null

CRUD

埋め込みリンクの非表示埋め込みリンクの非表示化

HIDEEMBEDLINKS

JavaScript APIをしようして、レポートやダッシュボードへの埋め込みリンクを削除します。APIを使用して、レポートやダッシュボードへの埋め込みリンク表示の禁止します。

null

CRUD

外部リンクの非表示外部レポートURLの非表示化

HIDEEXTLINKS

外部レポートやダッシュボードへの直接リンクを削除します。外部レポートやダッシュボードへのURL表示を禁止します。

null

CRUD

プロフィールパスワードの非表示プロフィールでのパスワード変更禁止

HIDEPASSWORD

プロフィール設定のパスワードのリセットオプションを非表示にします。ユーザーによるプロフィールでのパスワード変更を禁止します。

null

CRUD

レポートとダッシュボードの印刷を非表示印刷の非表示

HIDEPRINT

レポートやダッシュボードページの印刷オプションを非表示にします。レポートやダッシュボード上のレポートの印刷オプションを非表示にします。

null

CRUD

カラム(列)オプションの非表示(閲覧ページ)カラムオプションの非表示化(閲覧ページ)

HIDERPTLISTCOLUMNS

閲覧ページのカラム(列)オプションを非表示にします。表示されるカラム(列)を変更することはできません。閲覧ページのカラム(列)オプションを非表示にします。ユーザーに表示するカラム(列)の変更を許可しません。

null

CRUD

レポート詳細の非表示(閲覧ページ)レポート詳細の非表示化(閲覧ページ)

HIDERPTLISTDETAILS

閲覧ページのレポート詳細を非表示にします。

null

CRUD

 レポートオープンの非表示化

HIDERPTMENUOPEN

 レポートオープンメニューを非表示にします。

null

CRUD

SQLの非表示レポートSQL情報の非表示化

HIDESQL

レポートSQLをユーザーから非表示にします。こちらの機能を有効にした場合、こちらのロールを付与されたユーザーはレポートSQLを参照することができません。

null

CRUD

プロフィールユーザーIDの非表示プロフィールでのユーザーID変更禁止

HIDEUSERID

プロフィール設定からユーザーIDオプションを削除します。ユーザーによるプロフィールでのユーザーID変更を禁止します。

null

CRUD

インポートビュー・レポート設定情報のインポート権

IMPORTVIEW

XMLファイルからコンテンツをインポートすることができます。

null

CRUD

インスタントインサイト設定インスタントインサイト設定権

INSTANTINSIGHTSETTING

ビューレベルでインスタントインサイト設定を変更することができます。ビューレベルでインスタントインサイトを設定することを許可します。

null

CRUD

インスタントインサイトインスタントインサイト作成権

INSTANTINSIGHTUSE

インスタントインサイトを使用することができます。インスタントインサイトの使用を許可します。

null

CRUD

JavaScript ChartsJavaScriptグラフ作成権

JAVASCRIPTCHART

グラフビルダーから、JavaScript Chartsを作成することができます。警告:こちらは、カスタムJavaScriptを実行することができるため、信頼できる開発者にのみ有効化すべきです。グラフビルダーを使用して、JavaScriptグラフを作成することを許可します。警告:カスタムのJavaScriptの実行を許可するため、信頼された開発者にのみ有効にしてください。

null

CRUD

ログオンIDの構成ログインID(認証方法)設定権

LOGONID

ユーザーの認証方法を指定することができます。ログインID(認証方法)の変更を許可します。

null

CRUD

フィルター期間の管理日付フィルター期間管理権

MANAGEFILTERPERIOD

利用可能にする事前に定義された日付フィルターを選択することができます。どの日付フィルター期間を有効にするか選択することができます。

null

CRUD

タグの作成と編集タグ作成編集権

MANAGETAG

タグを作成し、編集することができます。タグを作成し、編集できます。

null

CRUD

ビューとフィールドカテゴリービューカテゴリー、フィールドカテゴリー管理権

VIEWCATEGORIES

管理コンソールからビューとフィールドカテゴリーを管理することができます。管理コンソールからビューカテゴリーとフィールドカテゴリーを管理することができます。

null

CRUD

フリーハンドSQLビューフリーハンドSQLビュー作成権

VIEWRUNTYPE

フリーハンドSQLビューを作成することができます。フリーハンドSQLビューの作成をすることができます。

null

CRUD

webサービス
Yellowfin Webサービス使用権

WEBSERVICES

こちらの機能は、webサービスへのアクセスに使用されるユーザーアカウントに要求されます。
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



Anchor
AdministrationReport
AdministrationReport

Expand
titleAdministrationReport


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


Anchor
AdministrationClientOrg
AdministrationClientOrg

Expand
titleAdministrationClientOrg


AdministrationClientOrg要素データ型説明

ClientName

String

クライアント組織の名前です。

ClientReferenceID

String

クライアントの識別に使用する一意のIDであるクライアント参照IDです。

TimeZoneCode

String

クライアント組織のローカルタイムゾーンコードです。有効な値は付録を参照してください。

DefaultOrg

Boolean

こちらの組織がプライマリー組織の場合はtrueを返すBoolean値です。
ClientIdIntegerクライアントのIpIdです。


Anchor
AdministrationReportGroup
AdministrationReportGroup

Expand
titleAdministrationReportGroup


AdministrationReportGroup要素データ型説明

ReportGroupName

String 
ReportGroupDescriptionString 
ReportGroupIdInteger 
ReportGroupStatusString 
ReportGroupTypeString

値の選択肢は以下の通りです。

  • ANALYTIC
  • KPI
ReportGroupInternalReferenceString 
GroupReportsAdministrationReport[]ダッシュボードレポートの詳細を含む配列です。
AssociatedReportsInteger[]関連するレポートIDの配列です。
PublishUUIDStringダッシュボードのUUIDです。


Anchor
ReportBinaryObject
ReportBinaryObject

expand
Expand
titleReportBinaryObject


ReportBinaryObject要素データ型説明

Key

String

バイナリーオブジェクトの保存に使用される一意のキーです。

ContentType

String

バイナリーオブジェクトのMIME型です。

Data

Byte[]

バイナリーオブジェクトのロウデータです。


Anchor

...

ContentResource
ContentResource

Expand
titleContentResource


   
ContentResource要素データ型説明

ResourceName

String


ResourceDescription

String

 

ResourceId

Integer


ResourceUUID

Integer

 

ResourceType

String

必須パラメーターです。各コンテンツタイプのリソース型は、以下の通りです。各コンテンツタイプのリソース型は、以下の通りです。
  • RPTCATEGORY (レポートカテゴリー)
  • RPTSUBCATEGORY(レポートサブカテゴリー)
  • DATASOURCE (データソース)
  • VIEW(ビュー)
  • GROUP(ダッシュボード)
  • REPORT(レポート)
  • ETLPROCESS(トランスフォーメーションフロー)

ResourceOrgId

Integer


ResourceCodeString 必須パラメーターです。(Yellowfinのデータベースから確認することができます。)


Anchor
ImportOption
ImportOption

Expand
titleImportOption


ImportOption要素データ型説明

ItemIndex

Integer

こちらのオプションを添付できるアイテムのindexです。こちらのオプションが添付されたアイテムのインデックスです。

OptionKey

String

オプションの型です。

OptionValue

String

こちらのオプションに関連する値です。


OptionKeyOptionValueタスク
SKIP

True

False

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

既存のアイテムをインポートファイルのアイテムと置き換えます。注意:これには、既存のレコードの置き換えが必要です。

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

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


Expand
titleコード


データベースシステムデータベースコード
汎用ODBCソースGENERICODBC
Microsoftアクセス
Microsoft AccessMSACCESS
DB2 AS400AS400
キャッシュDB
Cache DBCACHEDB
カラム(列)DB
Columnar DBCOLUMNAR
DB2DB2
クラウド接続
Connection CloudCONECTIONCLOUD
DerbyDERBY
DIAPRISMDIAPRISM
FileMaker ProFILEMAKER
FirebirdFIREBIRD
FoxProFOXPROODBC
H2H2
HiveHIVE
HSQLDBHSQLDB
informixINFORMIX
IngresINGRES
VectorwiseVECTORWISE
InterbaseINTERBASE
LucidLUCIDDB
MonetDBMONETDB
MySQLMYSQL
NetezzaNETEZZA
Lotus NotesNOTES
NouDBNOUDB
Progress OenEdgeOPENEDGE
OracleORACLE
PervasivePERVASIVE
PostgreSQLPOSTGRESQL
ProgressPROGRESS
SAP HANASAPHANA
SASSASJDBC
SqLiteSQLITE
Microsoft SQL ServerMSSQLSERVER
Sybase ASA / Sybase SQL AnywhereSYBASEASA
Sybase ASESYBASEASE
Sybase IQSYBASEIQ
TeraDataTERADATA
UniverseUNIVERSE
VerticaVERTICA



インポート中にデータソースタイプの詳細を置き換えます。
DRIVERJDBC Driver classnameインポート中にデータソースホストの詳細を上書きます。
URLA JDBC URLインポート中にデータソースURLの詳細を上書きます。
DATASOURCEXMLA Data Sourceインポート中にXMLAデータソースの詳細を上書きます。
CATALOGXMLA Catalogインポート中にXMLAデータソースカタログの詳細を上書きます。
USERNAMESource Usernameインポート中にデータソースユーザー名の詳細を上書きます。
PASSWORD1Source Password

インポート中にデータソースパスワードの詳細を上書きます。注意:こちらは、PASSWORD2の設定も必要になります。

注意: PASSWORD2の設定も必要です。

PASSWORD2Password Validationインポート中にデータソースパスワードを上書きます。
SOURCESOURCE<SourceId>

ビューを他のソースに添付します。Id 39003というソースの場合、値の例はSOURCE39003になります。

CACHEVIEW

True

False

キャッシュされたビューが、インポート時にもキャッシュされているかどうかを切り替えます。キャッシュされたビューが、インポート時にもキャッシュされるどうかを切り替えます。
CACHESOURCESOURCE<SourceId>インポート時にビューをキャッシュするソースを選択します。Id 39003というソースの場合、値の例はSOURCE39003になります。
CATEGORYCategory Codeインポート中に親カテゴリーにサブカテゴリーコードを割り当てます。
SOURCESOURCE<SourceId>インポート中にソースにレポートを割り当てます。Id 39003というソースの場合、値の例はSOURCE39003になります。
VIEWVIEW<ViewId>インポート中にビューにレポートを割り当てます。Id 39003というソースの場合、値の例はSOURCE39003になります。
EXECUTIONOBJECTNAMENameインポート中にwebサービス実行オブジェクト名を割り当てます。webサービスを介して、こちらのレポートを一意に識別する名前を提供します。
CATEGORYCAT<CategoryCode>インポート中に既存のレポートカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はCATTUTORIALになります。
SUBCATEGORYCAT<CategoryCode>インポート中に、上記で指定されたカテゴリーの子に当たる既存のサブカテゴリーをレポートに割り当てます。インポート中に、上記で指定されたカテゴリーの子に当たる既存のサブカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はCATTUTORIALになります。
CATEGORYIMP<CategoryCode>インポート中に同一のエクスポートファイル内のカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。
SUBCATEGORYIMP<CategoryCode>インポート中に、上記で指定されたカテゴリーの子に当たる、同一エクスポートファイル内の既存のレポートサブカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。


Anchor
ImportIssue
ImportIssue

Expand
titleImportIssue


パラメーターデータ型
itemKeyString
resourceContentResource
issueElementsImportIssueElement[]


Anchor
ImportIssueElement
ImportIssueElement

Expand
Expand
titleImportIssueElement


パラメーターデータ型
itemKeyString
messageComponentsString[]
renderdMessageString


Anchor
ParentReportGroup
ParentReportGroup

Expand
titleParentReportGroup


パラメーターデータ型説明
reportGroupIdIntegerダッシュボードタブのIDです。
reportGroupUUIDStringダッシュボードタブの公開されたUUIDです。
displayOrderIntegerユーザーダッシュボード内でのダッシュボードタブでの順番です。ユーザーダッシュボード内でのダッシュボードタブの順序です。
reportGroupAdministrationReportGroupダッシュボードタブです。
reportGroupSubTabsAdministrationReportGroup[]ダッシュボードとサブタブです。


Anchor
ParentDashboard
ParentDashboard

Expand
titleParentDashboard


パラメーターデータ型説明
dashboardNameStringダッシュボードの名前です。
dashboardGroupIdInteger 
tabIdsString[]サブタブのIDの配列です。
tabNamesString[]サブタブの名前の配列です。
statusCodesString[]サブタブのステータスの配列です。


Anchor
PersonFavourite
PersonFavourite

Expand
titlePersonFavourite


パラメーターデータ型説明

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」に設定して使用します。
こちらは、コンテンツをユーザーに配信するコンテンツの配信者を指します。こちらは、CreationCodeを「DISTRIBUTE」に設定して使用します。

TextEntityId

Integer

 

InstanceId

Integer

 


CreationDate

Date

 

Subject

String

 

Message

String

 


WidthCode

String

 

 



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

ContentTypeFavouriteTypeCreationCode説明

REPORT

FAVOURITE

MANUAL

お気に入りレポートです。

REPORTGROUP

REPORTDASHBOARD 


ユーザーがダッシュボード上で参照することのできるすべてのダッシュボードタブです。

REPORTGROUP

INBOX

DISTRIBUTE

ユーザーに配信されたダッシュボードです。

DISCUSSIONGROUP

DISCUSSIONMEMBER

 


ユーザーがメンバーの一員であるディスカッションです。

REPORTVIEW

 


MANUALMANUAL

お気に入りビューです。

STORYBOARD

FAVOURITE

WEB

お気に入りストーリーボードです。

IMAGE

PROFILE

MANUAL

ユーザーのプロフィールイメージです。

COMMENT

FLAGGED

MANUAL

ユーザーコメントによるフラグです。

ユーザーコメントによるフラグ付けです。


Anchor
AdministrationDataSource
AdministrationDataSource

Expand
titleAdministrationDataSource


SourceDescription String Integerデータソースの一意のYellowfin IDです。SourceNameSourceType Stringデータソースのタイプです。例として、MySQL、Oracleなどがあります。 UserPassword
パラメーターリクエスト要素データ型説明

AccessLevelCode

String

データソースの説明です。データベースのアクセス権、アクセスレベルを指定します。SourceId

ClientSources

AdministrationDataSourceClientLink


ConnectionDriver

String

 Stringデータソースの接続に使用するドライバーです。データソースの名前です。

ConnectionPath

String


ConnectionString

String

Timezoneデータソースの接続文字列です。 String

ConnectionTimeout

Integer

UserNameString データソースアカウントのユーザー名です。
これは、秒単位で指定します。

ConnectionType

String

上記アカウントのパスワードです。接続のタイプです。例:JDBC、などConnectionDriver

ConnectionTypeCode

String

データソース接続時に使用するドライバーです。

InheritChildSourceFilters

Boolean


LogFile

String


MaxRows

Integer

取得されるデータロウ(行)の最大数です。

MaxmimumConnections

Integer


MinimumConnections

Integer


RefreshTime

Integer

これは、時間単位で指定します。

SourceDescription

ConnectionString

String

データソースの接続Stringです。データソースの説明です。
ConnectionTimeout

SourceId

Integer

 
ConnectionTypeString接続のタイプです。例として、JDBCなどがあります。
ConnectionTypeCodeString 
AccessLevelCodeStringアクセスレベルのコードです。
InheritChildSourceFiltersString 
MaxRowsInteger取得されるデータロウ(行)の最大数です。
MaxmimumConnectionsInteger 
MinimumConnectionsInteger 
RefreshTimeInteger 

各データソースに固有のYellowfin IDです。こちらを提供しない場合は新しいデータソースが作成されるため、既存のデータソース編集時には、必ず指定しなくてはいけません。

SourceName

String

データソースの名前です。

SourceOptions

AdministrationDataSourceOption


SourceType

String

データソースのタイプです。例:MySQL、Oracle、など

Timezone

String


UserName

String

データソースアカウントのユーザー名です。

UserPassword

String

上記アカウントのパスワードです。パスワードは、データソース保存時に自動的に暗号化されます。


Anchor
AdministrationDataSourceOption
AdministrationDataSourceOption

Expand
titleAdministrationDataSourceOption


パラメーター

OptionKey

String

OptionValue

String

ValueDataType

String


Anchor
AdministrationDataSourceClientLink
AdministrationDataSourceClientLink

Expand
titleAdministrationDataSourceClientLink


パラメーター

clientOrgId

Integer

clientOrgRef

String

sourceId

Integer


Anchor
AdministrationSchedule
AdministrationSchedule

Expand
titleAdministrationSchedule

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

パラメーターデータ型説明

Frequency

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


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

AdministrationSchedule sub classAdministrationScheduleサブclass説明フィールド
CompositeViewRefreshScheduleコンポジットビューの更新タスクを表現するスケジュールです。コンポジットビューのタスク更新を表現するスケジュールです。

こちらのclassは、以下のフィールドを含みます。

  • ViewId:コンポジットビューのデータベースIDを返します。
FilterGroupCacheRefreshScheduleキャッシュフィルターやフィルターグループのタスクを更新します。

こちらの class は、以下の フィールド を含みます。

  • ViewId: コンポジットビューのデータベースIDを返します。
  • FilterGroupId:フィルターグループのデータベースIDを返します。
RefCodeRefreshScheduleカスタム参照コードのタスクを更新します。

こちらの class は、以下の フィールド を含みます。

  • SourceId:更新される参照コードのソースのデータベースIDを返します。SourceId:参照コードが更新されるソースのデータベースIDを返します。
ReportBroadcastScheduleレポートのブロードキャストタスクです。ブロードキャストレポートと受信者の情報を含みます。

こちらの class は、以下の フィールド を含みます。

  • ReportId:ブロードキャストするレポートのIDを返します。ブロードキャストされるレポートのIDを返します。
  • Recipients:ブロードキャストの各受信者のIDの配列を返します。各入力はグループ、または個人IDになります。ブロードキャストの各受信者のIDの配列を返します。各入力はグループ、または個人のIDになります。
  • Subject:ブロードキャストの件名を返します。いくつかのブロードキャストタイプは、こちらのフィールドを使用しません。
  • AppendDate:いくつかのブロードキャストタイプは、ブロードキャストの日時を件名やファイル名に追加するオプションがあります。FTPとEMALタイプがあります。いくつかのブロードキャストタイプ(特に、FTPとEMALタイプ)は、件名やファイル名にブロードキャストの日時を追加するオプションがあります。
  • BodyText:電子メールブロードキャストのメール本文を返します。
  • Format:ブロードキャスト出力形式コードを返します。HTML、PDFなど
  • ConditionList:複雑なブロードキャスト条件を表現するConditionオブジェクトの配列を返します。
  • FailureNotificationGroup:ブロードキャストが失敗した際に通知をするグループのIDを返します。
  • BroadcastStartDate:ブロードキャストスケジュールの開始が設定された日時を返します。
  • BroadcastEndDate:ブロードキャストスケジュールの終了が設定された日時を返します。
ReportFilterCacheRefreshScheduleレポートキャッシュフィルターのタスクを更新します。

こちらの class は、以下の フィールド を含みます。

  • ReportId:キャッシュフィルターを含むレポートのIDを返します。
ReportRefreshSchedule読み込み時に自動実行されないレポートのタスクを更新します。

こちらの class は、以下の フィールド を含みます。

  • ReportId:スケジュールされたレポートのIDを返します。スケジュールが設定されたレポートのIDを返します。
SourceFilterRefreshScheduleソースフィルターのタスクを更新します。ソースからのクエリーに基づきソースフィルター値を更新しましょう。

こちらの class は、以下の フィールド を含みます。

  • SourceId:ソースタイプの応じて、データソースID、またはレポートIDになります。
  • SourceType:SOURCE または REPORTが、SourceIdが指すオブジェクトのタイプを指定します。
SourceFilterUpdateReminderScheduleソースフィルター値更新のリマインダータスクです。スケジュールの特定のユーザーにリマインダーを送信します。

こちらの class は、以下の フィールド を含みます。

  • SourceId:ソースフィルターを更新するデータソースのデータベースIDです。
ThirdPartySourceAutoRunScheduleサードパーティ製データソースの自動実行タスクです。

こちらの class は、以下の フィールド を含みます。

  • SourceId:サードパーティ製データソースのデータベースIDです。


Anchor
ScheduleFrequency
ScheduleFrequency

Expand
titleScheduleFrequency

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

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

 


パラメーターデータ型説明

FrequencyTypeCode

Stringこちらのオブジェクトの頻度タイプです。オブジェクトタイプの決定に使用されます。
FrequencyCodeString頻度タイプコードに応じて、異なる意味合いを持ちます。
FrequencyUnitInteger頻度タイプコードに応じて、異なる意味合いを持ちます。
LocalRunTimeIntegerこちらのスケジュールを実行する真夜中からの秒数を返します(こちらのスケジュールのタイムゾーンに関連します)。注意:MinutesFrequencyなどいくつかのスケジュールタイプは、こちらを適切に使用しません。こちらのスケジュールを実行する真夜中からの秒数を返します(こちらのスケジュールのタイムゾーンに関連します)。 注意: MinutesFrequencyなど、いくつかのスケジュールタイプは、こちらを適切に使用しません。
LocalTimezoneCodeString指定したローカルの実行時間をYellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード(例:AUSTRALIA 指定されたローカルの実行時間を、Yellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード(例:AUSTRALIA / SYDNEYなど)です。
DayOrdinalsString序数に対応する曜日の名前の順序付き一覧です。
 
序数に対応する曜日名の順序付き一覧です。


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

ScheduleFrequency Sub ClassScheduleFrequencyサブClass説明フィールド
AnnualFrequency年の特定の月に設定された特定の日です。

特定の月の特定の日に設定された時間です。

こちらの class は、以下の フィールド を含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行するとしの月の英語名を大文字で表記します。こちらの頻度コードは、こちらのスケジュールを実行する月の英語名を大文字で表記しなくてはいけません。
  • FrequencyUnit:こちらのスケジュールを実行する月の曜日を指定します。
BiannualFrequency一年の中で等間隔に配置された二ヶ月の特定の日に設定された時間です。X月と(6 + X)月で、Xは「MonthOfYear」属性です。 

こちらの class は、以下の フィールド を含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する最初の月の数字名を英語の大文字で表記しなくてはいけません。例えば、スケジュールが一月と七月に実行される場合、値は「ONE」(年の最初の月、そしてこれに6ヶ月を追加します)です。最大値はSIXです。
  • FrequencyUnit:スケジュールを実行する月の曜日を指定します。
DailyFrequency 毎日設定された時間です。こちらのclassに余分なフィールドはなく、そのためlocalRun Timeのみ必要です。 毎日設定された時間です。こちらのclassに追加フィールドはなく、localRun Timeのみが必要です。
EndOfMonthFrequency毎月最終日に設定された時間です。こちらのclassに余分なフィールドはなく、そのためlocalRun Timeのみ必要です。  こちらの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に余分なフィールドはなく、そのためlocalRun Timeのみ必要です。 すべての平日に設定された時間です。こちらのclassに追加フィールドはなく、localRunTimeのみが必要です。 
WeeklyFrequency 特定の曜日の特定の時間です。 特定の曜日に設定された時間です。

こちらの class は、以下の フィールド を含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記しなくてはいけません。例:MONDAY
  • FrequencyUnit:

 

 

 

 

  • 上記のfrequencyCodeで使用する曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。
    例:MONDAY=1、SUNDAY=0、など




horizontalrule

Styleclass
ClasstopLink

ページトップ

...