これらのオブジェクトは、管理webサービスに固有です。
これらのオブジェクトは、管理webサービスに固有のものです。
| Anchor |
|---|
| AdministrationServiceRequest |
|---|
| AdministrationServiceRequest |
|---|
|
| Expand |
|---|
| title | AdministrationServiceRequest |
|---|
|
こちらのオブジェクトは、webサービスに対して行われる呼び出しの型を定義します。
オブジェクトパラメーター： | パラメーター名 | 型 | 説明 | | sessionId | String | |
| | loginId | String | こちらは、Yellowfin webサービス使用権を有効にしたYellowfinアカウントを参照します。Yellowfinのデフォルト（プライマリー）組織に所属するユーザーでなくてはいけません。 | | password | String | こちらは、上記アカウントのパスワードを参照します。 | | ntlm | Boolean | |
| | orgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、 デフォルト組織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」メソッドを持ちます。例： code
すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例： | Code Block |
|---|
| language | java |
|---|
| theme | Eclipse | language | java |
|---|
| 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 |
|---|
| title | AdministrationServiceResponse |
|---|
|
こちらのオブジェクトは、webサービスにより返されます。 こちらは、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」メソッドを持ちます。例： code
すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例： | Code Block |
|---|
| language | java |
|---|
| theme | Eclipse | language | java |
|---|
| AdministrationServiceResponse ssr = doWebserviceCall(sr);
String statusCode = ssr.getStatusCode(); |
|
| Anchor |
|---|
| AdministrationPerson |
|---|
| AdministrationPerson |
|---|
|
| Expand |
|---|
| title | AdministrationPerson |
|---|
|
こちらのオブジェクトは、関数に含まれるYellowfinユーザーを定義するために使用します。 こちらのオブジェクトのパラメーター：
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 | Password | String | Yellowfinユーザーのパスワードです。 | FirstName | String | Yellowfinユーザーの名です。 | LastName | String | Yellowfinユーザーの姓です。 | Initial | String | Yellowfinユーザーのミドルイニシャルです。 | SalutationCode | String | Yellowfinユーザーの敬称です。値の選択肢は、以下の通りです。 | 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 |
|---|
|
AdministrationGroupオブジェクトのパラメーターです。
| AdministrationGroup要素 | データ型 | 説明 | | GroupName | String | グループの名前です。 | | GroupDescreption | String | グループの説明です。 | | GroupId | Integer | グループを識別する一意のIDです。 | | GroupStatus | String | |
| | GroupInternalReference | String |
| | GroupMembers | AdministraionGroupMember[] | AdministrationGroupmemberオブジェクトの配列です。これらのオブジェクトは、グループメンバーのメタデータを保持します。 |
|
| Anchor |
|---|
| AdministrationGroupMember |
|---|
| AdministrationGroupMember |
|---|
|
| Expand |
|---|
| title | AdministrationGroupMember |
|---|
|
| パラメーター名 | データ型 | 説明 | | InternalId | Integer | Yellowfinデータベース内のPersonテーブルのIpIdフィールドです。 | | LoginId | String | グループメンバーのユーザーIDです。（ログインID方法に応じて、電子メールアドレス、またはユーザーIDになります） |
|
| Anchor |
|---|
| AdministrationRole |
|---|
| AdministrationRole |
|---|
|
| Expand |
|---|
|
| AdministrationReportGroup要素 | データ型 | 説明 | | RoleName | String | Yellowfinロールの名前です。 | | RoleDescription | String | Yellowfinロールの説明です。 | | RoleCode | String | データベースに生成され、参照されるYellowfinロールの内部コードです。 |
|
| Anchor |
|---|
| AdministrationFunction |
|---|
| AdministrationFunction |
|---|
|
| Expand |
|---|
| title | AdministrationFunction |
|---|
|
こちらのオブジェクトで利用可能なパラメーターです。
| パラメーター名 | データ型 | 説明 | | FunctionName | String | 関数の名前です。機能の名前です。 | | FunctionCode | String関数に一意のコードです。 | 各機能に一意のコードです。 | | FunctionDescription | String | その目的を定義する関数の説明です。その目的を定義する機能の説明です。 | | FunctionTypeCode | String |
| | AccessLevelCode | String | こちらの関数のアクセスレベルを定義するコードです。 こちらの機能のアクセスレベルを定義するコードです。 |
Yellwfinで利用可能な機能の一覧です。（レポート作成権は必須です） Yellwfinの利用可能な関数の一覧です。（レポートアクセスは必須です）注意：これは、ロールセキュリティ機能の拡張です。注意：これは、ロールセキュリティ関数の拡張です。 expand |
|
関数名 | コード | 説明 | 型コード | レポートアクセス| レポート作成権 | MIREPORT | ログインをし、レポートの参照、作成、編集、削除をすることができます。 | TN | CRUD |
| アクティビティストリーム使用権 | ACTIVITYSTREAM |
アクティビティストリームへのアクセスを許可します。 | null | CRUD |
| アドホック（臨時）レポート作成権 | ADHOCREPORTS |
| アドホック（臨時）レポートが作成できます。 | null | CRUD |
| 承認者に指定されていなくても、ユーザーはコンテンツの承認を管理することができます。 | null | CRUD |
| データソースの選択など、スプレッドシートやCSVレポート上で高度な操作を実行することができます。 | null | CRUD |
| SQL書式設定・ストアドプロシジャー使用権 | ADVANCEDSQL |
| ストアドプロシジャーに対してビューを作成することができます。 | null | CRUD |
| 高度なレポート検索の非表示化 | ADVRPTSEARCH | 閲覧ページで高度な検索を非表示にします。 | null | CRUD |
| フリーハンドSQL計算フィールド作成権 | ALLOWFREEHANDSQLCALCFIELD |
| レポートでフリーハンドSQLを使用して計算フィールドを作成することができます。 | null | CRUD |
| ダッシュボード、レポート、ビューをユーザーが入力したデータで翻訳することができます。 | null | CRUD |
| 注釈機能使用権 | ANNOTATIONS | 注釈を参照、編集、作成、削除することができます。 | null | CRUD |
| バックグラウンド実行管理権 | BACKGROUNDMANAGEMENT |
| 現在バックグランドで実行されているキューを表示し、現在のクエリーをキャンセルしたり、キューに入れられたアイテムを強制的に開始することができます。 | null | CRUD |
| サードパーティ製ソース接続や、JDBCドライバー、高度な関数を含む、プラグインを管理することができます。 | null | CRUD |
| ブックマーク＆スナップショット作成権 | BOOKMARKS |
| ブックマークやスナップショットを作成し、使用することができます。 | null | CRUD |
| ブロードキャストレポート発行権 | BROADCAST | 1回限り、またはスケジュールに基づき、レポートをブロードキャストすることができます。 | null | CRUD |
| ブロードキャストの購読設定権 | BROADCASTSUBSCRIBE |
| レポートのブロードキャストを購読することを許可します。 | null | CRUD |
| クライアント組織の設定と管理ができます。 | null | CRUD |
| コンポジットビュー作成権 | COMPOSITE | コンポジットビューを作成することができます。 | null | CRUD |
| CSVからビューを作成することができます。 | null | CRUD |
| カスタムクエリー・フィルター作成権 | CUSTOMFILTER |
| ドロップダウン・ユーザープロンプトフィルターを持つレポートで、フィルター値の取得にカスタムクエリーが使用できます。 | null | CRUD |
| 共有ダッシュボードの作成、編集ができます。 | null | CRUD |
| ダッシュボードレポートの更新時間設定権 | DASHREFRESH |
| ダッシュボードレポートの更新時間を設定します。 | null | CRUD |
| データソースを作成し、編集できます。 | null | CRUD |
| セキュリティ制限に関わらず、すべてのデータソースを作成し、編集できます。 | null | CRUD |
| データベースビューを作成し、編集できます。 | null | CRUD |
| キャッシュフィルター禁止 | DISABLECACHEDFILTERS |
| ユーザーによるレポートのキャッシュフィルターを禁止します。 | null | CRUD |
| モバイルアプリケーションからのレポートアクセスを禁止します。 | null | CRUD |
| コラボレーション管理権 | DISCUSSIONADMIN |
| 公開、非公開を問わず、すべてのディスカッションストリーム、コメント、タスクに管理者としてアクセスすることができます。 | null | CRUD |
| ディスカッショントピックス参加権 | DISCUSSIONGROUPS |
| ディスカッショントピックスの閲覧と投稿ができるようになります。 | null | CRUD |
| 他のユーザーへレポートや、ダッシュボードタブを配信することができます。 | null | CRUD |
| ストーリーボード配信権 | DISTRIBUTESTORYBOARD | 他のユーザーへストーリーボードを配信することができます。 | null | CRUD |
| ドラフト（編集中）ダッシュボード表示権 | DRAFTDASHBOARDS |
| 他のユーザーがドラフト（編集中）状態にしているダッシュボードを表示することができます。 | null | CRUD |
| ドラフト（編集中）レポート一覧表示権 | DRAFTRPTLIST |
| ダッシュボードや閲覧ページで最近アクセスされたドラフト（編集中）レポートの一覧を表示します。 | null | CRUD |
| ドラフト（編集中）ビュー表示権 | DRAFTVIEWS |
| 他のユーザーがドラフト（編集中）状態にしているビューを表示することができます。 | null | CRUD |
| マルチ表示、ドリルダウン、ドリルエニウェア、ドリルスルー機能を有効にすることができます。 | null | CRUD |
| ストーリーボード電子メール送信権 | EMAILSTORYBOARD |
| ストーリーボードのコピーをアドホック電子メールで送信することができます。 | null | CRUD |
| エラーページの電子メール送信非表示化 | ERROREMAIL |
| 不具合発生時に、エラーページに電子メール送信のリンクを表示しません。 | null | CRUD |
| エラーページのスタックトレース表示 | ERRORSTACKTRACE |
| 不具合発生時に、エラーページにスタックトレースを表示します。 | null | CRUD |
| データトランスフォーメーション作成権 | ETLPROCESS |
| トランスフォーメーションフローを作成し、編集することを許可します。警告：カスタムスクリプトの実行を許可するため、信頼された開発者にのみ有効にしてください。 | null | CRUD |
| スプレッドシートや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 |
| ユーザーは同時ログオンによる制限に含まれません。 | null | CRUD |
| OLAPデータソース使用権 | OLAP | OLAPデータソースに接続することができます。 | null | CRUD |
| システム構成管理権 | ORGCONFIG | システムパラメーターを変更することができます。 | null | CRUD |
| 参照コード管理権 | ORGREFCODES | 管理コンソールから参照コードを管理することができます。 | null | CRUD |
| Yellowfin画面設定権（ヘッダー、フッター、ナビゲーション） | PAGEFORMAT | ページレイアウト（統合設定、など）を構成することができます。 | null | CRUD |
| ストーリーボード作成権 | PUBLICSTORYBOARD |
| 共有ストーリーボードを作成することができます。 | null | CRUD |
| 共有レポートを作成し、編集できます。 | null | CRUD |
| ダッシュボードレポートメニューの非表示化 | REPORTDASHBOARD | ダッシュボードページへアクセスし、ユーザーにだけ参照可能な非公開ダッシュボードを作成することができます。 | null | CRUD |
| Assisted Discovery使用権 | REPORTDATADISCOVERY |
| レポートビルダーでインサイトを使用することを許可します。 | null | CRUD |
| レポートのコピーをアドホック電子メール送信することができます。 | null | CRUD |
| レポートからレポート作成権 | REPORTFROMREPORT |
| レポートの結果を元にレポートを作成することを許可します。 | null | CRUD |
| マネジメント情報レポート作成権（履歴・アーカイブ） | REPORTMI |
コンテンツカテゴリーバージョン履歴設定に応じて、レポートの結果セットをアーカイブします。 | null | CRUD |
| 新しくユーザーやグループを追加する際に、ロールの表示を制限します。 | null | CRUD |
| レポート更新メニューを非表示にします。 | null | CRUD |
| SQLレポート・Jasperレポート作成権 | RUNTYPE |
| フリーハンドSQLレポートや、Jasperレポートを作成することができます。 | null | CRUD |
| ドラフト（編集中）共有レポート閲覧・管理権 | SEECORPDRAFT |
| 他のユーザーに作成されたドラフト（編集中）の共有レポートを参照することができます。 | null | CRUD |
| サポート用電子メールのアドレスを設定することができます。 | null | CRUD |
| スキーマの確認のスキップ | SKIPSCHEMACHECK |
CheckSchemaForUser機能を使用していても、スキーマの確認を無視します。 | null | CRUD |
| アクセスフィルターを作成できます。 | null | CRUD |
| SSRSレポート作成権 | SSRS | SSRSレポートを作成することができます。 | null | CRUD |
ストーリーボード作成権 | STORYBOARD | ストーリーボードの参照、作成、編集、削除をすることができます。 | null | CRUD |
| ストーリーボード管理権 | STORYBOARDADMIN |
| 公開、非公開に関わらず、ストーリーボードを編集、削除することができます。 | null | CRUD |
ストーリーボードグローバルフィルター設定権 | STORYBOARDGLOBAL | ストーリーボードにグローバルフィルターを設定することができます。 | null | CRUD |
| サブクエリーレポートを作成できます。 | null | CRUD |
| システム情報 | SYSTEMINFO | 管理者にシステム情報の参照を許可します。 | null | CRUD |
| システムタスク管理権 | SYSTEMTASKADMIN |
| システムタスクの完了を承認、却下することができます。 | null | CRUD |
| 自分自身にタスクを割り当てることを許可します。 | null | CRUD |
| 自分自身と、他のユーザーにタスクを割り当てることを許可します。 | null | CRUD |
| テーマ管理権 | THEMES | ストーリーボードのテーマを管理することができます。 | null | CRUD |
| タイムラインにアクセスすることができます。 | null | CRUD |
| つながり機能使用権 | TIMELINECONNECTIONS |
| タイムラインとコミュニティパネルを通して、他のユーザーとつながることができます。 | null | CRUD |
| ユーザープロフィール設定権 | USERPROFILE | ユーザープロフィールを参照し、更新することができます。 | null | CRUD |
| キャッシュフィルターのデフォルト値に、最大値と最小値を設定することができます。 | 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 |
| レポートやダッシュボード上のレポートの印刷オプションを非表示にします。 | 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（認証方法）の変更を許可します。 | null | CRUD |
| 日付フィルター期間管理権 | MANAGEFILTERPERIOD |
| どの日付フィルター期間を有効にするか選択することができます。 | null | CRUD |
| ビューカテゴリー、フィールドカテゴリー管理権 | VIEWCATEGORIES |
| 管理コンソールからビューカテゴリーとフィールドカテゴリーを管理することができます。 | null | CRUD |
| フリーハンドSQLビュー作成権 | VIEWRUNTYPE |
| フリーハンドSQLビューの作成をすることができます。 | null | CRUD |
| Yellowfin Webサービス使用権 | WEBSERVICES |
| Yellowfin Webサービスの使用を許可します。Webサービスを利用する際の認証に使用します。 | null | CRUD |
| ライセンス管理権 | YFLICENCE | ライセンス詳細を参照し、新規ライセンスファイルをアップロードすることができます。 | null | CRUD |
| セキュリティロールを作成し、編集できます。 | null | CRUD |
| アクセスフィルター設定権 | ACCESSFILTER | レポートにアクセスフィルターを設定し、変更することができます。 | null | CRUD |
| コンテンツフォルダー管理権 | CONTENTACCESS | コンテンツフォルダーを構成することができます。 | CP | CRUD |
| 他のユーザーのアカウントを作成し、削除できます。 | DIR | CRUD |
| レポートをお気に入り一覧に追加できます。 | QL | CRUD |
| コメントの非表示化 | HIDERPTMENUCOMMENTS |
| レポート、ストーリーボード、ダッシュボードのコメント機能を非表示にします。 | null | CRUD |
| レポート詳細の非表示化（レポートメニュー） | HIDERPTMENUDETAILS |
| レポートメニューのレポート詳細を非表示にします。 | null | CRUD |
| 閲覧ページの非表示化 | REPORTSHIDDEN | 閲覧ページを非表示にします。 | null | CRUD |
| Anchor |
|---|
| AdministrationReport |
|---|
| AdministrationReport |
|---|
|
| Expand |
|---|
| title | 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 |
|
| Anchor |
|---|
| AdministrationClientOrg |
|---|
| AdministrationClientOrg |
|---|
|
| Expand |
|---|
| title | AdministrationClientOrg |
|---|
|
| AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前です。 | ClientReferenceID | String | クライアントの識別に使用する一意のIDであるクライアント参照IDです。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードです。有効な値は付録を参照してください。 | DefaultOrg | Boolean | こちらの組織がプライマリー組織の場合はtrueを返すBoolean値です。 | | ClientId | Integer | クライアントのIpIdです。 |
|
| Anchor |
|---|
| AdministrationReportGroup |
|---|
| AdministrationReportGroup |
|---|
|
| Expand |
|---|
| title | AdministrationReportGroup |
|---|
|
| AdministrationReportGroup要素 | データ型 | 説明 | ReportGroupName | String |
| | ReportGroupDescription | String |
| | ReportGroupId | Integer |
| | ReportGroupStatus | String |
| | ReportGroupType | String | 値の選択肢は以下の通りです。 | | ReportGroupInternalReference | String | |
| | GroupReports | AdministrationReport[] | ダッシュボードレポートの詳細を含む配列です。 | | AssociatedReports | Integer[] | 関連するレポートIDの配列です。 | | PublishUUID | String | ダッシュボードのUUIDです。 |
|
| Anchor |
|---|
| ReportBinaryObject |
|---|
| ReportBinaryObject |
|---|
|
| Expand |
|---|
|
| ReportBinaryObject要素 | データ型 | 説明 | Key | String | バイナリーオブジェクトの保存に使用される一意のキーです。 | ContentType | String | バイナリーオブジェクトのMIME型です。 | Data | Byte[] | バイナリーオブジェクトのロウデータです。 |
|
| Anchor |
|---|
| ContentResource |
|---|
| ContentResource |
|---|
|
| Expand |
|---|
|
| 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 | オブジェクトが最後に更新された日時です。 |
|
| Expand |
|---|
|
| ImportOption要素 | データ型 | 説明 | ItemIndex | Integer | こちらのオプションを添付できるアイテムのindexです。こちらのオプションが添付されたアイテムのインデックスです。 | OptionKey | String | オプションの型です。 | OptionValue | String | こちらのオプションに関連する値です。 |
| OptionKey | OptionValue | タスク | | SKIP | True False | インポートファイル内のアイテムをスキップします。 | | OPTION | ADD | インポートファイルのアイテムをインポートします。 | | OPTION | REPLACE | 既存のアイテムをインポートファイルのアイテムと置き換えます。注意：これには、既存のレコードの置き換えが必要です。 注意： これには、既存のレコードの置き換えが必要です。 | | EXISTING | Content UUID | 置き換えるコンテンツの内部IDが必要です。例えば、アイテムがビューの場合、こちらの値は既存のVIewIDになります。アイテムがカテゴリー、またはサブカテゴリーの場合、IDではなくCategoryCodeになります。置き換えるコンテンツの内部IDが必要です。例えば、アイテムがビューの場合、こちらの値は既存のViewIDになります。アイテムがカテゴリー、またはサブカテゴリーの場合、IDではなくCategoryCodeになります。 | DATABASETYPECODE| Expand |
|---|
| title | コード | Microsoftアクセス | Microsoft Access - MSACCESS
DB2 AS400 キャッシュDB | カラム（列）DB | Columnar DB - COLUMNAR
DB2 クラウド接続 | Connection Cloud - CONECTIONCLOUD
Derby - SQLITE
Microsoft SQL Server - MSSQLSERVER
Sybase ASA / Sybase SQL Anywhere インポート中にデータソースタイプの詳細を置き換えます。 |
|---|
| 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の設定も必要です。 | | PASSWORD2 | Password Validation | インポート中にデータソースパスワードを上書きます。 | | SOURCE | SOURCE<SourceId> | ビューを他のソースに添付します。Id 39003というソースの場合、値の例はSOURCE39003になります。 | | CACHEVIEW | True False | キャッシュされたビューが、インポート時にもキャッシュされているかどうかを切り替えます。キャッシュされたビューが、インポート時にもキャッシュされるどうかを切り替えます。 | | CACHESOURCE | SOURCE<SourceId> | インポート時にビューをキャッシュするソースを選択します。Id 39003というソースの場合、値の例はSOURCE39003になります。 | | CATEGORY | Category Code | インポート中に親カテゴリーにサブカテゴリーコードを割り当てます。 | | SOURCE | SOURCE<SourceId> | インポート中にソースにレポートを割り当てます。Id 39003というソースの場合、値の例はSOURCE39003になります。 | | VIEW | VIEW<ViewId> | インポート中にビューにレポートを割り当てます。Id 39003というソースの場合、値の例はSOURCE39003になります。 | | EXECUTIONOBJECTNAME | Name | インポート中にwebサービス実行オブジェクト名を割り当てます。webサービスを介して、こちらのレポートを一意に識別する名前を提供します。 | | CATEGORY | CAT<CategoryCode> | インポート中に既存のレポートカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はCATTUTORIALになります。 | | SUBCATEGORY | CAT<CategoryCode> | インポート中に、上記で指定されたカテゴリーの子に当たる既存のサブカテゴリーをレポートに割り当てます。インポート中に、上記で指定されたカテゴリーの子に当たる既存のサブカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はCATTUTORIALになります。 | | CATEGORY | IMP<CategoryCode> | インポート中に同一のエクスポートファイル内のカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。 | | SUBCATEGORY | IMP<CategoryCode> | インポート中に、上記で指定されたカテゴリーの子に当たる、同一エクスポートファイル内の既存のレポートサブカテゴリーにレポートを割り当てます。TUTORIALというコードのカテゴリーの場合、値の例はIMPTUTORIALになります。 |
|
| Expand |
|---|
|
| パラメーター | データ型 | | itemKey | String | | resource | ContentResource | | issueElements | ImportIssueElement[] |
|
| Expand |
|---|
|
| パラメーター | ソースパラメーターはデータソースのインポート時に渡すことができ、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で変更できる値です。
| Expand |
|---|
|
| パラメーター | データ型 | | itemKey | String | | resource | ContentResource | | issueElements | ImportIssueElement[] |
|
| Anchor |
|---|
| ImportIssueElement |
|---|
| ImportIssueElement |
|---|
|
| Expand |
|---|
|
| パラメーター | データ型 | | itemKey | String | | messageComponents | String[] | renderdMessage | String | String[] | | renderdMessage | String |
|
| Anchor |
|---|
| ParentReportGroup |
|---|
| ParentReportGroup |
|---|
|
| Anchor |
|---|
| ParentDashboard |
|---|
| ParentDashboard |
|---|
|
| Expand |
|---|
| title | ParentReportGroupParentDashboard |
|---|
|
| パラメーター | データ型 | 説明 | reportGroupId | | dashboardName | String | ダッシュボードの名前です。 | | dashboardGroupId | Integer | ダッシュボードタブのIDです。 |
| | reportGroupUUIDtabIds | String[] | ダッシュボードタブの公開されたUUIDです。サブタブのIDの配列です。 | | displayOrdertabNamesInteger | String[] | ユーザーダッシュボード内でのダッシュボードタブでの順番です。サブタブの名前の配列です。 | reportGroup| statusCodes | AdministrationReportGroupString[] | ダッシュボードタブです。サブタブのステータスの配列です。 | reportGroupSubTabs
|
...
...
| Expand |
|---|
| title | ParentDashboardPersonFavourite |
|---|
|
| パラメーター | データ型 | 説明 | dashboardName | PersonId | Integer | ユーザーIpIdです。（Yellowfinデータベース、Person.IpPerson） | ContentType | String | ダッシュボードの名前です。特定のコンテンツタイプにより結果にフィルターを適用する場合に使用できるオプションパラメーターです。値の選択肢は、以下の通りです。 | dashboardGroupId | Integer | | tabIds | String[] | サブタブのIDの配列です。 | tabNamesContentId | String[]Integer | サブタブの名前の配列です。 こちらのオプションパラメーターは、内部IDを提供することで、特定のコンテンツタイプにより結果を制限する場合に使用することができます。 | statusCodesFavouriteType | String | [] |
| サブタブのステータスの配列です。CreationCode |
|
expand | title | PersonFavouriteInteger | パラメーターこちらは、コンテンツをユーザーに配信するコンテンツの配信者を指します。こちらは、CreationCodeを「DISTRIBUTE」に設定して使用します。 | データ型TextEntityId | 説明Integer |
| PersonIdInstanceId | Integer |
| CreationDate | ユーザーIpIdです。（Yellowfinデータベース、Person.IpPerson） Date |
| ContentTypeSubject | String |
| Message | 特定のコンテンツタイプにより結果にフィルターを適用する場合に使用することのできるオプションパラメーターです。値の選択肢は、以下の通りです。String |
| | REPORT WidthCode | REPORTGROUP String DISCUSSIONGROUP |
|
以下は、ContentType、FavouriteType、CreationCodeの組み合わせの例を示しています。 REPORTVIEW| ContentType | STORYBOARDFavouriteType | IMAGECreationCode | ContentId説明 | IntegerREPORT | こちらのオプションパラメーターは、内部IDを提供することで、特定のコンテンツタイプにより結果を制限する場合に使用することができます。 FAVOURITE | FavouriteTypeMANUALString | お気に入りレポートです。 | | REPORTGROUP | CreationCodeREPORTDASHBOARDString |
| ユーザーがダッシュボード上で参照することのできるすべてのダッシュボードタブです。 | | REPORTGROUP | CreatorIdINBOX | IntegerDISTRIBUTE | こちらは、コンテンツをユーザーに配信するコンテンツの配信者を指します。こちらは、CreationCodeを「DISTRIBUTE」に設定して使用します。ユーザーに配信されたダッシュボードです。 | TextEntityIdDISCUSSIONGROUP | IntegerDISCUSSIONMEMBER |
| ユーザーがメンバーの一員であるディスカッションです。 | InstanceIdREPORTVIEW |
| IntegerMANUAL | お気に入りビューです。 | CreationDateSTORYBOARD | DateFAVOURITE | WEBSubject | お気に入りストーリーボードです。 | StringIMAGE | PROFILE | MessageMANUALString | ユーザーのプロフィールイメージです。 | | COMMENT | WidthCodeFLAGGED | StringMANUAL | ユーザーコメントによるフラグ付けです。 |
|
...
...
FavouriteType| Expand |
|---|
CreationCode | 説明 |
REPORT| リクエスト要素 | FAVOURITEデータ型 | MANUAL説明 | お気に入りレポートです。AccessLevelCode | REPORTGROUPString | REPORTDASHBOARDデータベースのアクセス権、アクセスレベルを指定します。 | ClientSources | ユーザーがダッシュボード上で参照することのできるすべてのダッシュボードタブです。AdministrationDataSourceClientLink | REPORTGROUP
| ConnectionDriver | INBOXString | DISTRIBUTEデータソースの接続に使用するドライバーです。ユーザーに配信されたダッシュボードです。 | ConnectionPath | DISCUSSIONGROUPString | DISCUSSIONMEMBER
| ConnectionString | String | ユーザーがメンバーの一員であるディスカッションです。データソースの接続文字列です。REPORTVIEW | ConnectionTimeout | Integer | MANUALこれは、秒単位で指定します。お気に入りビューです。 | ConnectionType | STORYBOARDString | FAVOURITE接続のタイプです。例：JDBC、などWEB | ConnectionTypeCode | お気に入りストーリーボードです。String |
| IMAGEInheritChildSourceFilters | PROFILEBoolean |
| MANUALLogFile | ユーザーのプロフィールイメージです。String |
| COMMENTMaxRows | FLAGGEDInteger | MANUAL取得されるデータロウ（行）の最大数です。ユーザーコメントによるフラグです。 | MaxmimumConnections |
|
expand | title | AdministrationDataSourceInteger | パラメーター
| RefreshTime | データ型Integer | 説明これは、時間単位で指定します。 | SourceDescription | String String | データソースの説明です。 | SourceId | Integer Integer | データソースの一意のYellowfin IDです。各データソースに固有のYellowfin IDです。こちらを提供しない場合は新しいデータソースが作成されるため、既存のデータソース編集時には、必ず指定しなくてはいけません。 | SourceName | String String | データソースの名前です。 | SourceOptions | AdministrationDataSourceOption |
| SourceType | String String | データソースのタイプです。例として、MySQL、Oracleなどがあります。データソースのタイプです。例：MySQL、Oracle、など | Timezone | String | String |
| UserName | String String | データソースアカウントのユーザー名です。 | UserPassword | String | 上記アカウントのパスワードです。上記アカウントのパスワードです。パスワードは、データソース保存時に自動的に暗号化されます。ConnectionDriver |
|
...
| AdministrationDataSourceOption |
|---|
|
...
| AdministrationDataSourceOption |
|---|
|
ConnectionString| Expand |
|---|
String | データソースの接続Stringです。| AdministrationDataSourceOption |
|
ConnectionTimeout| パラメーター | Integer型 | OptionKey | ConnectionType | String | 接続のタイプです。例として、JDBCなどがあります。OptionValue | ConnectionTypeCode | String | ValueDataType | AccessLevelCodeString | String
|
...
| AdministrationDataSourceClientLink |
|---|
|
...
| AdministrationDataSourceClientLink |
|---|
|
String| Expand |
|---|
| MaxRows| AdministrationDataSourceClientLink |
|
Integer取得されるデータロウ（行）の最大数です。MaxmimumConnectionsclientOrgId | Integer | clientOrgRef |
MinimumConnections | RefreshTime
|
...
...
| Expand |
|---|
| title | AdministrationSchedule |
|---|
|
Yellowfinスケジュール多数の管理サービスを表現する抽象classです。こちらのclassは、すべてのタスクスケジュールに共通する機能Yellowfinのスケジュール設定された管理サービスを表現する抽象classです。こちらのclassは、すべてのタスクスケジュールに共通する機能/データを提供します。Subclassは、ブロードキャスト情報などの、subclassに特化した情報を追加します。データを提供します。Subclassは、ブロードキャスト情報などの、subclassに特化したデータの情報を追加します。 | パラメーター | データ型 | 説明 | Frequency | ScheduleFrequency[] | スケジュール頻度型の詳細を含む配列オブジェクトです。 | | ScheduleActive | String | スケジュールが有効かどうかを返します。これは、スケジュールが現在実行中であるかどうかは示しませんが、次回のスケジュール時にスケジュールが実行されるかどうかを示します。 | | ScheduleDescription | String | スケジュール目的の短い説明です。こちらは通常、レポート名やフィルター名など、スケジュールの目的となるアイテムの名前を含みます。 | | ScheduleUUID | String | システムが生成するスケジュールのUUIDです。 | | ScheduleTypeCode | String | レコードのスケジュールタイプです。例：REPORTBROADCAST、SOURCEFILTERREFRESHなどこちらのレコードのスケジュールタイプです。例：REPORTBROADCAST、SOURCEFILTERREFRESHなど | | LastRunStatus | String | スケジュールの最終実行のステータスコードです。こちらの値は、スケジュール完了後にのみ更新されるため、スケジュールが現在実行中の場合は、以前の値が含まれます。 | | LastRunError | String | 最終実行が失敗した場合、こちらのフィールドには、何が起きたのかを示すエラーが含まれます。 | | LastRunDateTimeGMT | String | スケジュールの最終実行のGMT時間です。これは、スケジュールが開始された時刻であることをに注意してください。 | | NextRunDateTimeGMT | String | 現在のスケジュール設定に基づき、こちらは、次回スケジュールが実行される時間をGMTで返します。こちらの値は「ライブ」ではないことに注意をしてください。つまり、サーバが更新を変更を受信し、検証し、新しいスケジュールオブジェクトを返すまでは更新されません。 |
| 現在のスケジュール設定に基づき、こちらは、次回スケジュールが実行される時間をGMT時間で返します。こちらの値は「リアルタイム」ではないことに注意をしてください。つまり、サーバが変更を受信し、それを検証して、新しいスケジュールオブジェクトを返すまでは更新されません。 |
以下は、AdministrationSchedule classのサブclassの例です。 AdministrationScheduleサブclassclassのsub classの例です。 | AdministrationSchedule sub 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 |
|---|
|
すべての頻度タイプのベースclassです。こちらのclassは、頻度スケジュールのデータベース属性を保持します。各フィールドのデータベース値に基づく有効なデータを設定し、取得するユーザーフレンドリーなメソッドを提供は各subclassの責任です。すべての頻度型のベースclassです。こちらのclassは、頻度スケジュールのデータベース属性を保持します。各フィールドのデータベース値に基づく有効なデータを設定し、取得するユーザーフレンドリーなメソッドを提供するのが各subclassの責任です。 例：月の曜日は頻度単位に保存されることもありますが、スケジュールタイプが月の曜日を持つ場合は保存されません。subclassはまた、検証を強制します。 例：月の曜日は頻度単位に保存されることもありますが、スケジュールタイプが月の曜日をまったく持たない場合は保存されません。subclassはまた、検証を強制します。
| パラメーター | データ型 | 説明 | FrequencyTypeCode | String | こちらのオブジェクトの頻度タイプです。オブジェクトタイプの決定に使用されます。 | | FrequencyCode | String | 頻度タイプコードに応じて、異なる意味合いを持ちます。 | | FrequencyUnit | Integer | 頻度タイプコードに応じて、異なる意味合いを持ちます。 | | LocalRunTime | Integerこちらのスケジュールを実行する真夜中からの秒数を返します（こちらのスケジュールのタイムゾーンに関連します）。注意：MinutesFrequencyなどいくつかのスケジュールタイプは、こちらを適切に使用しません。 | こちらのスケジュールを実行する真夜中からの秒数を返します（こちらのスケジュールのタイムゾーンに関連します）。 注意： MinutesFrequencyなど、いくつかのスケジュールタイプは、こちらを適切に使用しません。 | | LocalTimezoneCode | String | 指定したローカルの実行時間をYellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード（例：AUSTRALIA 指定されたローカルの実行時間を、Yellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード（例：AUSTRALIA / SYDNEYなど）です。 | | DayOrdinals | String序数に対応する曜日の名前の順序付き一覧です。 |
以下は、ScheduleFrequency classのいくつかのサブclassの例です。 ScheduleFrequencyサブClassclassのいくつかのsub classの例です。 | ScheduleFrequency Sub Class | 説明 | フィールド | | AnnualFrequency | 年の特定の月に設定された特定の日です。 特定の月の特定の日に設定された時間です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する年の月の英語名を大文字で表記します。こちらの頻度コードは、こちらのスケジュールを実行する月の英語名を大文字で表記しなくてはいけません。
- FrequencyUnit：こちらのスケジュールを実行する月の曜日を指定します。
| | BiannualFrequency | 一年の中で等間隔に配置された二ヶ月の特定の日に設定された時間です。X月と（6 + X）月で、Xは「MonthOfYear」属性です。X）月で、Xは「MonthOfYear」属性です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する年の最初の月の数字名を英語の大文字で表記します。例えば、スケジュールが一月と七月に実行される場合、値は「ONE」（年の最初の月、そしてこれに6ヶ月を追加します）です。最大値はSIXです。こちらの頻度コードは、こちらのスケジュールを実行する最初の月の数字名を英語の大文字で表記しなくてはいけません。例えば、スケジュールが一月と七月に実行される場合、値は「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=00、など
| | MinutesFrequency | 毎X分です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyUnit：スケジュールの実行間隔です。
| | MonthlyFrequency | 各月の特定の曜日に設定された時間です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyUnit：こちらのスケジュールを実行する月の曜日です。
| | QuarterlyFrequency | 各四半期の第一、第二、または第三月の特定の曜日に設定された時間です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する各四半期の月の数字を英語の大文字で表記します。例えば、スケジュールを四半期の最初の月に実行する場合、値は「ONE」になり、スケジュールは一月、四月、七月、十月に実行されます。値の最大値はTHREEです。こちらの頻度コードは、こちらのスケジュールを実行する各四半期の月の数字を英語の大文字で表記しなくてはいけません。例えば、スケジュールを四半期の最初の月に実行する場合、値は「ONE」になり、スケジュールは一月、四月、七月、十月に実行されます。値の最大値はTHREEです。
- FrequencyUnit：こちらのスケジュールを実行する月の曜日を指定します。
| | WeekdaysFrequency | すべての平日に設定された時間です。こちらのclassに余分なフィールドはなく、そのためlocalRun Timeのみ必要です。 | すべての平日に設定された時間です。こちらのclassに追加フィールドはなく、localRunTimeのみが必要です。 |
| | WeeklyFrequency | 特定の曜日の特定の時間です。 特定の曜日に設定された時間です。 | こちらの class は、以下の フィールド を含みます。 - FrequencyCode：こちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記します。例：MONDAYこちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記しなくてはいけません。例：MONDAY
- FrequencyUnit：上記のfrequencyCodeで使用する曜日の序数を指定します。 序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。
例：MONDAY=1、SUNDAY=0
|
|
...