これらのオブジェクトは、管理webサービスに固有のものです。
...
| Expand |
|---|
|
| ContentResource要素 | データ型 | 説明 | ResourceName | String | | ResourceDescription | String | | ResourceId | Integer | | ResourceUUID | Integer | | ResourceType | String | 各コンテンツタイプのリソース型は、以下の通りです。必須パラメーターです。各コンテンツタイプのリソース型は、以下の通りです。
- RPTCATEGORY （レポートカテゴリー）
- RPTSUBCATEGORY（レポートサブカテゴリー）
- DATASOURCE （データソース）
- VIEW（ビュー）
- GROUP（ダッシュボード）
- REPORT（レポート）
- ETLPROCESS（トランスフォーメーションフロー）
| ResourceOrgId | Integer | | | ResourceCode | String | 必須パラメーターです。（Yellowfinのデータベースから確認することができます。） |
|
...
| Expand |
|---|
| title | AdministrationDataSource |
|---|
|
| パラメーターリクエスト要素 | データ型 | 説明 | SourceDescriptionAccessLevelCode | StringString | データソースの説明です。データベースのアクセス権、アクセスレベルを指定します。 | | SourceId | Integer | データソースの一意のYellowfin IDです。 | | SourceName | String | データソースの名前です。 | | SourceType | String | データソースのタイプです。例：MySQL、Oracleなど | | Timezone | String | | | UserName | String | データソースアカウントのユーザー名です。 | UserPasswordClientSources | AdministrationDataSourceClientLink | | ConnectionDriver | String | 上記アカウントのパスワードです。データソースの接続に使用するドライバーです。ConnectionDriver | ConnectionPath | String | データソース接続時に使用するドライバーです。 | ConnectionString | String | データソースの接続Stringです。データソースの接続文字列です。 | ConnectionTimeout | Integer | これは、秒単位で指定します。 | ConnectionType | String | 接続のタイプです。例：JDBCなど接続のタイプです。例：JDBC、など | ConnectionTypeCode | String | | | AccessLevelCode | String | アクセスレベルのコードです。 | | InheritChildSourceFilters | String | | | MaxRows | Integer | 取得されるデータロウ（行）の最大数です。 | | MaxmimumConnections | Integer | | | MinimumConnections | Integer | | | RefreshTime | Integer | | InheritChildSourceFilters | Boolean | | LogFile | String | | MaxRows | Integer | 取得されるデータロウ（行）の最大数です。 | MaxmimumConnections | Integer | | MinimumConnections | Integer | | RefreshTime | Integer | これは、時間単位で指定します。 | SourceDescription | String | データソースの説明です。 | SourceId | Integer | 各データソースに固有のYellowfin IDです。こちらを提供しない場合は新しいデータソースが作成されるため、既存のデータソース編集時には、必ず指定しなくてはいけません。 | SourceName | String | データソースの名前です。 | SourceOptions | AdministrationDataSourceOption | | SourceType | String | データソースのタイプです。例：MySQL、Oracle、など | Timezone | String | | UserName | String | データソースアカウントのユーザー名です。 | UserPassword | String | 上記アカウントのパスワードです。パスワードは、データソース保存時に自動的に暗号化されます。 |
|
| Anchor |
|---|
| AdministrationDataSourceOption |
|---|
| AdministrationDataSourceOption |
|---|
|
| Expand |
|---|
| title | AdministrationDataSourceOption |
|---|
|
| パラメーター | 型 | OptionKey | String | OptionValue | String | ValueDataType | String |
|
| Anchor |
|---|
| AdministrationDataSourceClientLink |
|---|
| AdministrationDataSourceClientLink |
|---|
|
| Expand |
|---|
| title | AdministrationDataSourceClientLink |
|---|
|
| パラメーター | 型 | clientOrgId | Integer | clientOrgRef | String | sourceId | Integer |
|
| Anchor |
|---|
| AdministrationSchedule |
|---|
| AdministrationSchedule |
|---|
|
| Expand |
|---|
| title | AdministrationSchedule |
|---|
|
Yellowfinのスケジュール設定された管理サービスを表現する抽象classです。こちらのclassは、すべてのタスクスケジュールに共通する機能/データを提供します。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です。
|
|
...
| 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
|
|
...