Versions Compared

Version Old Version 10 New Version 11
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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ソースGENERICODBCMicrosoftアクセス
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になります。

...

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

Anchor
ParentDashboard
ParentDashboard

...

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

 

MANUAL

お気に入りビューです。

STORYBOARD

FAVOURITE

WEB

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

IMAGE

PROFILE

MANUAL

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

COMMENT

FLAGGED

MANUAL

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

Anchor
AdministrationDataSource
AdministrationDataSource

Expand
titleAdministrationDataSource
パラメーターデータ型説明
SourceDescription Stringデータソースの説明です。
SourceId Integerデータソースの一意のYellowfin IDです。
SourceName Stringデータソースの名前です。
SourceType Stringデータソースのタイプです。例として、MySQL、Oracleなどがあります。データソースのタイプです。例：MySQL、Oracleなど
Timezone String 
UserNameString データソースアカウントのユーザー名です。
UserPasswordString上記アカウントのパスワードです。
ConnectionDriverStringデータソース接続時に使用するドライバーです。
ConnectionStringStringデータソースの接続Stringです。
ConnectionTimeoutInteger 
ConnectionTypeString接続のタイプです。例として、JDBCなどがあります。接続のタイプです。例：JDBCなど
ConnectionTypeCodeString 
AccessLevelCodeStringアクセスレベルのコードです。
InheritChildSourceFiltersString 
MaxRowsInteger取得されるデータロウ（行）の最大数です。
MaxmimumConnectionsInteger 
MinimumConnectionsInteger 
RefreshTimeInteger 

...

Expand
titleAdministrationSchedule

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

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

Frequency

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

...