Versions Compared

Version Old Version 5 New Version 6
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

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

...

Expand
titleAPPLYDASHBOARDFILTERS

The following code will accomplish this:これを実行するコードは以下の通りです。

Code Block
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardFilter[] dfarray = null;
DashboardFilter df = new DashboardFilter();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("APPLYDASHBOARDFILTERS");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);

df.setTabId(11111);
df.setReportId(12121);
df.setFilterId(33333);
df.setFilterType("BETWEEN");
df.setFilterValue("120|150");
dfarray[0] = df;
rsr.setDashboardFilters(dfarray);

rs = ReportService.remoteAdministrationCall(rsr);
Retrieval Code

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

Expand
titleGETDASHBOARDREPORTFILTERVALUES

The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab.

The following code will accomplish this:GETDASHBOARDREPORTFILTERVALUESリクエストは、ダッシュボードタブの特定のレポートに対するフィルターメタデータを返します。

これを実行するコードは以下の通りです。

Code Block
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportFilter[] rf = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETDASHBOARDREPORTFILTERVALUES");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);
rf = rs.getReportFilters();

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportFilters

Array (ReportFilter)Array of Filter objects containing metadata for each filter (see ReportFilter)

各フィルターのメタデータを含むFilterオブジェクトの配列（ReportFilterを参照）

getReportFilters()

The RUNDASHBOARDREPORT request will run and export a specified report on a dashboard tab. The response will include Base64 encoded generated html, including charts, GIS maps, and CSS styles.

The following code will accomplish this:

ReportServiceRequest rsr Retrieval Code

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

Expand
titleRUNDASHBOARDREPORT
Code Block

RUNDASHBOARDREPORTリクエストは、ダッシュボードタブの指定されたレポートを実行し、エクスポートします。応答には、グラフ、GISマップ、およびCSSスタイルを含む、Base64エンコードで生成されたHTMLが含まれます。

これを実行するコードは以下の通りです。

Code Block
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RUNDASHBOARDREPORT");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

BinaryData

String

Base64 encoded binary chunk of HTMLHTMLのBase64エンコードバイナリーチャンク

getBinaryData()

Charts

Array (ReportChart)Array of ReportChart objects (see ReportChart)

ReportChartオブジェクトの配列（ReportChartを参照）

getCharts()

ReportStyle

String

CSS stylesCSSスタイル

GetReportStyle()

Breadcrumbs

Array (Breadcrumb)

Array of Breadcrumb objectsArray（Breadcrumb）

Breadcrumbオブジェクトの配列

getBreadcrumbs()

GoogleMaps

Array (GMap)

Array of GoogleMaps objects if the report’s chart uses itArray（GMap）

GoogleMapsオブジェクトの配列（レポートのグラフで使用されている場合）

getGoogleMaps()

GisMap

Array (GISMap)

Array of GISMap objects if the report’s chart uses it

getGisMap()

...

Array（GISMap）

GISMapオブジェクトの配列（レポートのグラフで使用されている場合）

Array（GISMap）

オブジェクト定義

Anchor
ReportComment
ReportComment

Expand
titleReportComment

ReportComment ElementReportComment要素

Data Typeデータ型

Description説明

Retrieval Code取得コード

CommentId

Integer

ID of commentコメントのID

getCommentId()

AuthorId

Integer

ID of comment authorコメント作成者のID

getAuthorId()

Comment

String

Comment valueコメントの値

getComment()

ReportId

Integer

Report ID of which the comment resides onコメントが存在するレポートのID

getReportId()

ParentCommentId

Integer

Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent comment

getParentCommentId(

コメントが関連付けられているメインID。ある特定のコメントが親コメントへの返信である場合に、これが適用されます。

getParentCommentId()

StatusCode

String

Comment statusコメントのステータス

getStatusCode()

CommentDate

DateTime

Date and time value for comment creationコメントが作成された日時の値

getCommentDate()

LastActivityDate

DateTime

Date and time value for the most current update to that particular commentその特定のコメントが最後に更新された日時の値

getLastActivityDate()

Anchor
ReportRow
ReportRow

Expand
titleReportRow

ReportRow ElementReportRow要素

Data Typeデータ型

Description説明

Retrieval Code取得コード

DataValue

Array (String)

Array of Strings with data for each column in the report result setArray（String）

レポート結果セットの各カラムのデータを含む文字列の配列

getDataValue()

Anchor
ReportChart
ReportChart

Expand
titleReportChart

ReportChart ElementReportChart要素

Data Typeデータ型

Description説明

Retrieval Code取得コード

ReportIndex

Integer

Index of image in the embedded delivered HTML配信された埋め込みHTML内のイメージのインデックス

getReportIndex()

Content Type

String

MIME Content Type of this chart. Possible values include:

  • “image/png”
    • “image/jpg”

    このグラフのMIMEコンテンツタイプ。可能な値は以下の通りです。

    • 「image/png」
    • 「image/jpg」

    getContentType()

    Data

    String

    Base64 binary image dataBase64のバイナリーイメージデータ

    getData()

    Filename

    String

    Filename of embedded file in HTMLHTMLに埋め込まれているファイルのファイル名

    getFilename()

    Anchor
    ReportSchema
    ReportSchema

    Expand
    titleReportSchema

    ReportSchema ElementReportSchema要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    ColumnName

    String

    Column Nameカラム名

    getColumnName()

    DisplayName

    String

    Display name of columnカラムの表示名

    getDisplayName()

    FieldId

    Integer

    Field Id of columnカラムのフィールドID

    getFieldId()

    DataType

    String

    Data type of columnカラムのデータ型

    getDataType()

    ColumnLength

    String

    Column lengthカラム長

    getColumnLength()

    Hidden

    Boolean

    Whether the column is displayed in the report or not

    getHidden

    カラムがレポートに表示されるかどうか

    getHidden()

    Prompt

    Boolean

    Whether the column is a prompt field or notカラムがプロンプトフィールドかどうか

    getPrompt()

    FilterId

    Integer

    Filter Id if the column is a filterフィルターID（カラムがフィルターの場合）

    getFilterId()

    FilterType

    String

    Determines the filter type and what data would have to be posted to engage the promptフィルタータイプおよびプロンプトへの応答として投稿する必要があるデータを決定します。

    getFilterType()

    AllowPrompt

    Boolean

     

    getAllowPrompt()

    FilterOmittable

    Boolean

     

    getFilterOmittable()

    ParentFilterId

    Integer

    Filter Id of parent filter if a filter dependency is in place親フィルターのフィルターID（フィルターの従属関係が設定されている場合）

    getParentId()

    DefaultValue1

     

    First default value for filter if setフィルターの最初のデフォルト値（設定されている場合）

    getDefaultValue1()

    DefaultValue2

     

    Second default value for filter if setフィルターの2番目のデフォルト値（設定されている場合）

    getDefaultValue2()

    ValueUnitCode

     

    Time units for the filter if setフィルターの時間単位（設定されている場合）

    getValueUnitCode()

    FilterDisplayType

     

    Filter Display Type if the column is a filterフィルター表示タイプ（カラムがフィルターの場合）

    getFilterDisplayType()

    MinimumValue

     

    Minimum value for filter if setフィルターの最小値（設定されている場合）

    getMinimumValue()

    MaximumValue

     

    Maximum value for filter if setフィルターの最大値（設定されている場合）

    getMaximumValue()

    Anchor
    ReportBinaryObject
    ReportBinaryObject

    Expand
    titleReportBinaryObject

    ReportBinaryObject ElementReportBinaryObject要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    ContentType

    String

    MIME Content TypeMIMEコンテンツタイプ

    getContentType()

    Data

    String

    Base64 binary dataBase64バイナリーデータ

    getData()

    Key

    String

    Key of the ReportBinaryObject objectReportBinaryObjectオブジェクトのキー

    getKey()

    Anchor
    KPI
    KPI

    Expand
    titleKPI

    KPI ElementKPI要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    Actual

    String

    The actual value for a KPI metricKPIメトリック（数値）の実績値

    getActual()

    Target

    String

    The target value for a KPI metricKPIメトリック（数値）の目標値

    getTarget()

    Variance

    String

    The variance value for a KPI metric

    getVariance(

    KPIメトリック（数値）の差異値

    getVariance()

    Anchor
    DrillAnywhereTarget
    DrillAnywhereTarget

    Expand
    titleDrillAnywhereTarget

    DrillAnywhereTarget ElementDrillAnywhereTarget要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    ParentCategory

    String

    Parent Category value親カテゴリーの値

    getParentCategory()

    Targets

    Array (String)

    Array of String values which are the targets for a particular parent categoryArray（String）

    特定の親カテゴリーの目標である文字列値の配列

    getTargets()

    Anchor
    ScheduleRecord
    ScheduleRecord

    Expand
    titleScheduleRecord

    ScheduleRecord ElementScheduleRecord要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    Recipient

    Integer

    ID of recipient of the subscription購読の受信者のID

    getRecipient()

    Subject

    String

    Subscription subject購読の件名

    getSubject()

    BodyText

    String

    Subscription message購読のメッセージ

    getBodyText()

    FrequencyTypeCode

    String

    Subscription frequency. Values include:購読の頻度。次の値があります。

    • MINUTES
    • DAILY
    • WEEKLY
    • FORTNIGHTLY
    • MONTHLY
    • QUARTERLY
    • BIANNUAL
    • ANNUAL
    • ENDOFMONTH

    getFrequencyTypeCode()

    FrequencyCode

    String

    Additional frequency codes depending on the frequency type code頻度タイプコードに応じた追加の頻度コード

    getFrequencyCode()

    FrequencyUnit

    String

    Additional frequency units depending on the frequency type code頻度タイプコードに応じた追加の頻度単位

    getFrequencyCode()

    Format

    String

    Subscription File Type. Values include:購読ファイルタイプ。次の値があります。

    • PDF
    • HTML
    • CSV
    • DOC
    • XLS
    • RTF

    getFormat()

    ConditionList

    Array (Condition)

    Array of Condition objects that store delivery rules (see Condition)Array（Condition）

    配信ルールを格納するConditionオブジェクトの配列（Conditionを参照）

    getConditionList()

    AdvancedTimezoneCode

    String

    Timezone in which the subscription happens購読が行われるタイムゾーン

    getAdvancedTimezoneCode()

    AdvancedTime

    Integer

    Local run time for the subscription購読のローカル実行時間

    getAdvancedTime()

    Anchor
    Condition
    Condition

    Expand
    titleCondition

    Condition ElementCondition要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    Operator

    String

    Filter operator for the column(s). Values include:カラムのフィルター演算子。次の値があります。

    • BETWEEN
    • NOTBETWEEN
    • EQUAL
    • NOTEQUAL
    • GREATER
    • GREATEREQUAL
    • INLIST
    • NOTINLIST
    • ISNULL
    • ISNOTNULL
    • LESS
    • LESSEQUAL
    • STARTSWITH
    • NOTSTARTSWITH
    • CONTAINS
    • NOTCONTAINS
    • ENDSWITH
    • NOTENDSWITH

    getOperator()

    FieldId

    Integer

    Field Id of columnカラムのフィールドID

    getFieldId()

    Value1

    String

    First conditional value最初の条件値

    getValue1()

    Value2

    String

    Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc.2番目の条件値。演算子がBETWEENやNOTBETWEENなどの場合に必要です。

    getValue2()

    Anchor
    DashboardDefinition
    DashboardDefinition

    Expand
    titleDashboardDefinition

    DashboardDefinition ElementDashboardDefinition要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    TabId

    Integer

    ID of the dashboard tabダッシュボードタブのID

    getTabId()

    GroupTypeCode

    String

    Type of dashboard tab. Values include:ダッシュボードタブのタイプ。次の値があります。

    • ANALYTIC
    • KPI
    • STANDARD

    getGroupTypeCode()

    Owner

    Integer

    ID of dashboard ownerダッシュボード所有者のID

    getOwner()

    OwnerTypeCode

    String

    Type of dashboard owner. Value defaults to ORGANISATIONダッシュボード所有者のタイプ。値はデフォルトでORGANISATIONに設定されます。

    getOwnerTypeCode()

    AccessCode

    String

    Security level of the dashboard tabダッシュボードタブのセキュリティレベル

    getAccessCode()

    StartDate

    DateCreation Date

    作成日

    getStartDate()

    EndDate

    DateEnd Date (if applicable)

    終了日（適用される場合）

    getEndDate()

    StatusCode

    String

    Status of the dashboard tabダッシュボードタブのステータス

    getStatusCode()

    ShortDescription

    String

    Name of the dashboard tabダッシュボードタブの名前

    getShortDescription()

    LongDescription

    String

    Business description of the dashboard tabダッシュボードタブの説明

    getLongDescription()

    LanguageCode

    String

    Two letter language code2文字の言語コード

    getLanguageCode()

    StyleCode

    String

    Layout code. Values include:レイアウトコード。次の値があります。

    • SINGLE
    • TWO
    • THREE
    • WIDENARROW
    • NARROWWIDE

    getStyleCode()

    Audience

    String

    Audience description対象者の説明

    getAudience()

    ParentGroupId

    Integer

    If the dashboard tab is in draft mode, the original tab ID is saved into this columnダッシュボードタブがドラフト（編集中）モードの場合、元のタブIDがこのカラムに保存されます。

    getParentGroupId()

    Elements

    Array (DashboardElement)A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See DashboardElement)

    ダッシュボードタブ内に存在するレポートのポートレット情報を含むDashboardElementオブジェクト（DashboardElementを参照）

    getElements()

    Filters

    Array (DashboardFilterDefinition)

    A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See DashboardFilterDefinition)

    getFilters()

    Fields

    Array (DashboardFieldDefinition)

    A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tabダッシュボードタブ、分析フィルター、およびフィルターグループに関するフォーマットレコードを含むDashboardFilterDefinitionオブジェクト（DashboardFilterDefinitionを参照）

    getFilters()

    Fields

    Array (DashboardFieldDefinition)

    ダッシュボードタブにドリルダウンとして表示されるフィールドに関するフォーマットレコードを含むDashboardFieldDefinitionオブジェクト

    getFields()

    Anchor
    DashboardElement
    DashboardElement

    Expand
    titleDashboardElement

    DashboardElement ElementDashboardElement要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    TabId

    Integer

    ID of the dashboard tabダッシュボードタブのID

    getTabId()

    EntityId

    Integer

    ID of the portlet, which also happens to be the Report IDポートレットのID。レポートIDでもある場合があります。

    getEntityId()

    EntityTypeCode

    String

    Portlet entity type. Value defaults to REPORTポートレットのエンティティタイプ。値はデフォルトでREPORTに設定されます。

    getEntityTypeCode()

    ColumnNumber

    Integer

    Indicating where the portlet is column-wise. The first column starts at the value 1

    getColumnNumber(

    カラム方向でのポートレットの位置を示します。最初のカラムは値1から始まります。

    getColumnNumber()

    RowNumber

    Integer

    Indicating where the portlet is row-wise. The first row starts at the value 1ロウ方向でのポートレットの位置を示します。最初のロウは値1から始まります。

    getRowNumber()

    SequenceNumber

    Integer

    Portlet loading sequence within the dashboard tabダッシュボードタブ内のポートレットロード順序

    getSequenceNumber()

    StartDate

    DateDate the portlet was added

    ポートレットが追加された日付

    getStartDate()

    PortletStatus

    String

    Portlet statusポートレットのステータス

    getPortletStatus()

    PortletHeight

    Integer

    Portlet height in pixelsピクセル単位で示すポートレットの高さ

    getPortletHeight()

    Anchor
    DashboardFieldDefinition
    DashboardFieldDefinition

    Expand
    titleDashboardFieldDefinition

    DashboardFieldDefinition ElementDashboardFieldDefinition要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    TabId

    Integer

    ID of the dashboard tabダッシュボードタブのID

    getTabId()

    FieldId

    Integer

    Field ID of columnカラムのフィールドID

    getFieldId()

    FieldType

    String

    Field data type. Values include:

    フィールドのデータ型。次の値があります。

    • BOOLEAN
    • DATE
    • GISGEOMETRY
    • GISMULTIPOLY
    • GISPOINT
    • NUMERIC
    • TEXT
    • TIMESTAMP

    getFieldType()

    ReportId

    Integer

    ID of reportレポートのID

    getReportId()

    TemplateId

    Integer

    ID of corresponding field template record対応するフィールドテンプレートレコードのID

    getTemplateId()

    FieldName

    String

    Column nameカラム名

    getFieldName()

    FieldDescription

    String

    Column nameカラム名

    getFieldDescription()

    Anchor
    DashboardFilterDefinition
    DashboardFilterDefinition

    Expand
    titleDashboardFilterDefinition

    DashboardFilterDefinition ElementDashboardFilterDefinition要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    GroupId

    Integer

    ID of the dashboard tabダッシュボードタブのID

    getGroupId()

    ComponentId

    Integer

    Numeric ID for the component based on the component type要素タイプに基づく要素の数値ID

    getComponentId()

    ComponentTypeCode

    String

    Component types for a DashboardFilterDefinition object include:

  • FILTER (individual analytic filter)
  • FILTERGROUP (analytic filter group)
    • NULL (general dashboard tab)

    DashboardFilterDefinitionオブジェクトの要素タイプには、以下のものがあります。

    • FILTER（個別の分析フィルター）
    • FILTERGROUP（分析フィルターグループ）
    • NULL（一般的なダッシュボードタブ）

    getComponentTypeCode()

    EntityId

    Integer

     

    getEntityId()

    EntityTypeCode

    String

    Entity types for a DashboardFilterDefinition object include:

  • REPORT (analytic filters)
    • REPORTGROUP (general dashboard tab)

    DashboardFilterDefinitionオブジェクトのエンティティタイプには、以下のものがあります。

    • REPORT（分析フィルター）
    • REPORTGROUP（一般的なダッシュボードタブ）

    getEntityTypeCode()

    FormatKey

    String

    Format Codeフォーマットコード

    getFormatKey()

    FormatValue

    String

    Format Valueフォーマット値

    getFormatValue()

    Anchor
    ReportFilter
    ReportFilter

    ...

    Expand
    titleReportFilter

    ReportFilter ElementReportFilter要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    FilterId

    Integer

    ID of the filterフィルターのID

    getFilterId()

    IsOmitted

    Boolean

    If the filter is omitted by defaultフィルターをデフォルトで省略するかどうか

    getIsOmitted()

    DataValue

    String

    Filter values for a particular filter. If there are two values (i.e if the filter operator is BETWEEN, etc) then they are concatenated with a pipe value

    getDataValue()

    ...

    特定のフィルターのフィルター値。値が2つある場合（たとえば、フィルター演算子がBETWEENの場合）、値はパイプ値で連結されます。

    getDataValue()

    Anchor
    DashboardFilter
    DashboardFilter

    Expand
    titleDashboardFilter

    DashboardFilter ElementDashboardFilter要素

    Data Typeデータ型

    Description説明

    Retrieval Code取得コード

    ReportId

    Integer

    ID of the report that the filter belongs toフィルターが属するレポートのID

    getReportId()

    FilterType

    String

    Filter operatorフィルター演算子

    getFilterType()

    FilterId

    Integer

    ID of the filterフィルターのID

    getFilterId()

    TabId

    Integer

    ID of the dashboard tab that the reportレポートがあるダッシュボードタブのID

    getTabId()

    FilterValue

    String

    Filter values for a particular filter. If the filter operator involves the usage of two values (i.e BETWEEN, etc) then both values are concatenated with a pipe value特定のフィルターのフィルター値。フィルター演算子で2つの値を必要とする場合（たとえば、BETWEEN）、それらの値はパイプ値で連結されます。

    getFilterValue()

    TemplateId

    Integer

    ID of the field template record. This applies if the Filter Type is DRILL, etcフィールドテンプレートレコードのID。フィルタータイプがDRILLなどの場合に適用されます。

    getTemplateId()