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

関数

PDFリクエストは指定されたレポートを実行し、それをPDF形式で返します。これを実行するコードは以下の通りです。

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("PDF");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

PDFのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「application/pdf」です。

getContentType()

CSVリクエストは指定されたレポートを実行し、それをCSV形式で返します。これを実行するコードは以下の通りです。

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("CSV");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

CSVのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「text/comma-separated-values」です。

getContentType()

XLSリクエストは指定されたレポートを実行し、それをXLS形式で返します。これを実行するコードは以下の通りです。

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("XLS");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

XLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「application/xls」です。

getContentType()

TEXTリクエストは指定されたレポートを実行し、それをTEXT形式で返します。これを実行するコードは以下の通りです。

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("TEXT");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

XLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「text/tab-separated-values」です。

getContentType()

RTFリクエストは指定されたレポートを実行し、それをRTF形式で返します。これを実行するコードは以下の通りです。

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("RTF");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

XLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「application/rtf」です。

getContentType()

DOCリクエストは指定されたレポートを実行し、それをDOC形式で返します。これを実行するコードは以下の通りです。

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("DOC");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

ReportName

String

指定されたレポートの名前

getReportName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

XLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

このオブジェクトのMIMEコンテンツタイプ。値は「application/vnd.ms-word」です。

getContentType()

SCHEMAリクエストは、指定されたレポートについて、レポートのカラムおよびフィルターのメタデータも含むスキーマ情報を返します。これを実行するコードは以下の通りです。

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("SCHEMA");
rsr.setReportId(12345);
// This is the report's web service name. If ReportId is set, this is not needed
rsr.setObjectName("MYREPORT");

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

ReportId

Integer

指定されたレポートのID

getReportId()

StatusCode

String

Webサービスリクエストのステータス

getStatusCode()

FormatCode

String

指定されたレポートのフォーマットコード

getFormatCode()

ReportType

String

指定されたレポートのレポートタイプ

getReportType()

LastRunStatus

String

最後のレポート実行のステータスコード

getLastRunStatus()

LastRunTime

Decimal

YYYYMMDDHHMMSS形式で示されるレポートの最終実行時間

getLastRunTime()

ReportName

String

指定されたレポートの名前

getReportName()

BinaryData

String

イメージ、HTML、CSV、またはPDFのBase64エンコードバイナリーチャンク

getBinaryData()

ViewName

String

レポートが依存するビューの名前

getViewName()

HitCount

Integer

指定されたレポートがアクセスされた回数

getHitCount()

DrillCode

String

ドリルタイプ(レポートで使用可能な場合)

getDrillCode()

Private

 

レポートが個人用または共有のいずれであるかを判別します。

getPrivate()

Results

Array (ReportRow)

レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列( ReportRow を参照)

getResults()

ContentType

String

返されたオブジェクトのMIMEコンテンツタイプ。可能な値は以下の通りです。

  • 「text/html」
  • 「text/comma-separated-values」
  • 「image/png」
  • 「application/pdf」

getContentType()

Messages

Array (String)

レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列。エラーのデバッグおよび追跡に使用します。

getMessages()

Charts

Array (ReportChart)

HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列 ( ReportChartを参照)

getCharts()

Columns

Array (ReportSchema)

レポート結果セットの各カラムの情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれるReportSchemaオブジェクトの配列(ReportSchemaを参照)

getColumns()

HTMLリクエストは、レポートをHTMLで表現したものを返します。HTMLドキュメントはBase64でエンコードされ、グラフとイメージがCharts配列フィールドに格納されます。これらのアーティファクトはクライアントシステムにより手動でデコードする必要があります。また、Base64イメージのデコード用に、URLリクエスト文字列を使用してHTML内にURLが埋め込まれます。
これを実行するコードは以下の通りです。

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("HTML");
rsr.setReportId(12345);
// This is the report's web service name. If ReportId is set, this is not needed
rsr.setObjectName("MYREPORT");

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

Chart

Array (ReportChart)

HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列 (ReportChartを参照)

getCharts()

ReportBinaryObject

Array (ReportBinaryObject)

BLOBおよびCLOBを含むReportBinaryObjectオブジェクトの配列 (ReportBinaryObjectを参照)

getBinaryObjects()

ReportStyles

String

CSSスタイル

getReportStyles()

Breadcrumbs

Array (Breadcrumb)

Breadcrumbオブジェクトの配列

getBreadcrumbs()

SeriesSelection

Array (SeriesSelection)

SeriesSelectionオブジェクトの配列

getSeriesSelections()

TimeAggregationSelection

Array (TimeAggregationSelection)

TimeAggregationSelectionオブジェクトの配列

getTimeAggregationSelection()

ReportTabSelection

Array (ReportTabSelection)

ReportTabSelectionオブジェクトの配列

getReportTabSelection()

ReportPageSelection

Array (ReportPageSelection)

ReportPageSelectionオブジェクトの配列

getReportPageSelection()

TimeSliderSelection

Array (TimeSliderSelection)

TimeSliderSelectionオブジェクトの配列

getTimeSliderSelection()

SortableColumns

Array (SortableTableColumn)

SortableTableColumnオブジェクトの配列

getSortableColumns()

SelectedSortColumn

Integer

並べかえに使用するカラム。このインデックスは、レポート内のカラムインデックスに適用されます。

getSelectedSortColumn()

SelectedSortOrder

Integer

並べかえに使用するカラムの並べかえ順序(0が昇順、1が降順)

getSelectedSortOrder()

DrillCode

String

ドリルタイプ(レポートで使用可能な場合)

getDrillCode()

RelatedReports

Array (RelatedReport)

RelatedReportオブジェクトの配列。これは、メインレポートにマルチ表示(タブ化)されるレポートです。

getRelatedReports()

BinaryData

String

HTMLドキュメントのBase64エンコードバイナリーチャンク

getBinaryData()

Private

 

レポートが個人用または共有のいずれであるかを判別します。

getPrivate()

ContentType

String

返されたオブジェクトのMIMEコンテンツタイプ。値は「text/html」です。

getContentType()

CanDrill

Boolean

レポートがドリル可能かどうか

getCanDrill()

GoogleMaps

Array (GMap)

GMapオブジェクトの配列

getGoogleMaps()

FILTEROPTIONSリクエストは、特定のレポートのフィルターで使用可能なフィルター値を返します。
これを実行するコードは以下の通りです。

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("FILTEROPTIONS");
// This is the Report ID
rsr.setReportId(12345);
// This is the Filter ID
rsr.setObjectName("11111");

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

Results

Array (ReportRow)

フィルター値を含むReportRowオブジェクトの配列(ReportRowを参照)

getResults()

RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果はReportRowオブジェクトの配列に格納され、各ReportRowオブジェクトがレポートデータセットの1つのロウを表します。ReportRowオブジェクトは、データセットの各カラムのデータを表す文字列の配列でも構成されます。
このデータを文字列表現から特定のカラムのデータ型に変換するのは、Webサービスクライアントの役割です。各カラムのデータ型は、SCHEMAリクエスト関数呼び出しにより取得できます。
これを実行するコードは以下の通りです。

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("RESULTSET");
// This is the Report ID
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

Results

Array (ReportRow)

レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列(ReportRowを参照)

getResults()

EXPIRESESSIONリクエストは、指定されたYellowfinセッションを期限切れにします。
これを実行するコードは以下の通りです。

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("EXPIRESESSION");
// This is the Session ID
rsr.setSessionId("5361781d-c3aa-4c97-bc13-883210ff8a6e");

rs = ReportService.remoteAdministrationCall(rsr);

GETCOMMENTSリクエストは、特定のレポートについてすべてのコメントを取得します。
これを実行するコードは以下の通りです。

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("GETCOMMENTS");
// This is the Report ID
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

Comments

Array (ReportComment)

レポートのコメントを含むReportCommentオブジェクトの配列(ReportCommentを参照)

getComments()

LEAVECOMMENTリクエストは、特定のレポートにコメントまたはコメントに対する応答を作成します。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LEAVECOMMENT");

comment.setComment("This is my comment");
comment.setAuthorId(5);
// If this is a response to a comment, then specify the parent comment ID
comment.setParentCommentId(702);
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

DELETECOMMENTリクエストは、レポートから特定のコメントを削除します。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("DELETECOMMENT");

comment.setCommentId(702);
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

COMMENTSTATUSリクエストは、特定のコメントのステータスを設定します。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("COMMENTSTATUS");

comment.setCommentId(702);
// The available status codes are OPEN, RESOLVED, or DELETED
comment.setStatusCode("OPEN");
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

DISTRIBUTEINBOXリクエストは、一覧に含まれる受信者の受信トレイにレポートを配信します。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
// Specify the Person ID values for your list of recipients
String[] reportoptions = { "11111", "5", "10101"};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("DISTRIBUTEINBOX");
rsr.setReportOptions(reportoptions);
rsr.setReportId(12345);
// This is an optional distribution text for all recipients
rsr.setDistributionText("A message for recipients");

rs = ReportService.remoteAdministrationCall(rsr);

GETDISPLAYEDREPORTIDリクエストは、現在表示されているレポートのレポートIDを返します。
これを実行するコードは以下の通りです。

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("GETDISPLAYEDREPORTID");

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

DisplayedReportId

Integer

現在表示されているレポートのレポートID

getDisplayedReportId()

GETKPIリクエストは、特定のKPIレポートについてKPIオブジェクトを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。
これを実行するコードは以下の通りです。

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("GETKPI");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

KPI

KPI object

特定のKPIメトリック(数値)について、実績、目標、および差異の値を保持するカスタムKPIオブジェクト(KPIを参照)

getKPI()

GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラムで使用できる「ドリルエニウェア」メニューを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。
これを実行するコードは以下の通りです。

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("GETDRILLANYWHEREMENU");
rsr.setReportId(12345);
// This is an integer field which is the Field ID of the selected column
rsr.setDrillAnywhereFieldId(3);
// This is the actual value of the column
rsr.setDrillAnywhereCellValue("5000");

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

DrillAnywhereCategories

Array (String)

文字列の配列

getDrillAnywhereCategories()

DrillAnywhereTargets

Array (DrillAnywhereTarget)

ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示するDrillAnywhereTargetオブジェクトの配列(DrillAnywhereTargetを参照)

getDrillAnywhereTargets()

SUBSCRIBEDETAILSリクエストは、特定のレポートのスケジュールレコードを返します。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ScheduleRecord sr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("SUBSCRIBEDETAILS");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);
sr = rs.getSchedule();

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

応答要素

データ型

説明

取得コード

ScheduleRecord

ScheduleRecord object

購読詳細と条件を含むScheduleRecordオブジェクト(ScheduleRecordを参照)

getSchedule()

SUBSCRIBEリクエストは、指定されたユーザーの指定のレポートに対する購読を作成/変更します。この関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、この関数呼び出しのために、ScheduleRecordオブジェクトを作成して適切なデータを投入する必要があります(ScheduleRecordを参照)。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
// Either retrieve a current ScheduleRecord beforehand or create a new one. A new one is created in this example
ScheduleRecord sr = new ScheduleRecord();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("SUBSCRIBE");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

// Refer to the ScheduleRecord schema definition for all possible variables
sr.setRecipient(19090);
sr.setFormat("PDF");
sr.setSubject("Athlete Analysis");
sr.getBodyText("Pay attention to the data in October");
sr.setFrequencyTypeCode("FORTNIGHTLY");
sr.setFrequencyCode("ONE");
sr.setFrequencyUnit(1);
sr.setAdvancedTimezoneCode("AUSTRALIA/SYDNEY");
// total of seconds from 12am - the example below is set for 5.30pm
sr.setAdvancedTime(63000);

rs = ReportService.remoteAdministrationCall(rsr);

UNSUBSCRIBEリクエストは、指定のレポートから指定されたユーザーの購読を取り消します。
これを実行するコードは以下の通りです。

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("UNSUBSCRIBE");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);

LOADDASHBOARDTABリクエストは、指定されたダッシュボードタブとそのメタデータをロードします。
これを実行するコードは以下の通りです。

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardDefinition dd = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LOADDASHBOARDTAB");
// This is the ダッシュボードタブのID
rsr.setDashboardTabId(11111);

rs = ReportService.remoteAdministrationCall(rsr);
dd = rs.getDashboard();

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

応答要素

データ型

説明

取得コード

DashboardDefinition

DashboardDefinition object

ダッシュボードタブのメタデータを含むDashboardDefinitionオブジェクト(DashboardDefinitionを参照)

getDashboard()

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

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
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);

GETDASHBOARDREPORTFILTERVALUESリクエストは、ダッシュボードタブの特定のレポートに対するフィルターメタデータを返します。
これを実行するコードは以下の通りです。

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
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

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

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

応答要素

データ型

説明

取得コード

ReportFilters

Array (ReportFilter)

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

getReportFilters()

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

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
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);

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

応答要素

データ型

説明

取得コード

BinaryData

String

HTMLのBase64エンコードバイナリーチャンク

getBinaryData()

Charts

Array (ReportChart)

ReportChartオブジェクトの配列(ReportChartを参照)

getCharts()

ReportStyle

String

CSSスタイル

GetReportStyle()

Breadcrumbs

Array (Breadcrumb)

Breadcrumbオブジェクトの配列

getBreadcrumbs()

GoogleMaps

Array (GMap)

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

getGoogleMaps()

GisMap

Array (GISMap)

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

getGisMap()

オブジェクト定義

ReportComment要素

データ型

説明

取得コード

CommentId

Integer

コメントのID

getCommentId()

AuthorId

Integer

コメント作成者のID

getAuthorId()

Comment

String

コメントの値

getComment()

ReportId

Integer

コメントが存在するレポートのID

getReportId()

ParentCommentId

Integer

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

getParentCommentId()

StatusCode

String

コメントのステータス

getStatusCode()

CommentDate

DateTime

コメントが作成された日時の値

getCommentDate()

LastActivityDate

DateTime

その特定のコメントが最後に更新された日時の値

getLastActivityDate()

ReportRow 要素

データ型

説明

取得コード

DataValue

Array (String)

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

getDataValue()

ReportChart要素

データ型

説明

取得コード

ReportIndex

Integer

配信された埋め込みHTML内のイメージのインデックス

getReportIndex()

Content Type

String

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

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

getContentType()

Data

String

Base64のバイナリーイメージデータ

getData()

Filename

String

HTMLに埋め込まれているファイルのファイル名

getFilename()

ReportSchema要素

データ型

説明

取得コード

ColumnName

String

カラム名

getColumnName()

DisplayName

String

カラムの表示名

getDisplayName()

FieldId

Integer

カラムのフィールドID

getFieldId()

DataType

String

カラムのデータ型

getDataType()

ColumnLength

String

カラム長

getColumnLength()

Hidden

Boolean

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

getHidden()

Prompt

Boolean

カラムがプロンプトフィールドかどうか

getPrompt()

FilterId

Integer

フィルターID(カラムがフィルターの場合)

getFilterId()

FilterType

String

フィルタータイプおよびプロンプトへの応答として投稿する必要があるデータを決定します。

getFilterType()

AllowPrompt

Boolean

 

getAllowPrompt()

FilterOmittable

Boolean

 

getFilterOmittable()

ParentFilterId

Integer

親フィルターのフィルターID(フィルターの従属関係が設定されている場合)

getParentId()

DefaultValue1

 

フィルターの最初のデフォルト値(設定されている場合)

getDefaultValue1()

DefaultValue2

 

フィルターの2番目のデフォルト値(設定されている場合)

getDefaultValue2()

ValueUnitCode

 

フィルターの時間単位(設定されている場合)

getValueUnitCode()

FilterDisplayType

 

フィルター表示タイプ(カラムがフィルターの場合)

getFilterDisplayType()

MinimumValue

 

フィルターの最小値(設定されている場合)

getMinimumValue()

MaximumValue

 

フィルターの最大値(設定されている場合)

getMaximumValue()

ReportBinaryObject要素

データ型

説明

取得コード

ContentType

String

MIMEコンテンツタイプ

getContentType()

Data

String

Base64バイナリーデータ

getData()

Key

String

ReportBinaryObjectオブジェクトのキー

getKey()

KPI要素

データ型

説明

取得コード

Actual

String

KPIメトリック(数値)の実績値

getActual()

Target

String

KPIメトリック(数値)の目標値

getTarget()

Variance

String

KPIメトリック(数値)の差異値

getVariance()

DrillAnywhereTarget 要素

データ型

説明

取得コード

ParentCategory

String

親カテゴリーの値

getParentCategory()

Targets

Array (String)

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

getTargets()

ScheduleRecord要素

データ型

説明

取得コード

Recipient

Integer

購読の受信者のID

getRecipient()

Subject

String

購読の件名

getSubject()

BodyText

String

購読のメッセージ

getBodyText()

FrequencyTypeCode

String

購読の頻度。次の値があります。

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

getFrequencyTypeCode()

FrequencyCode

String

Additional 頻度タイプコードに応じた追加の頻度コード

getFrequencyCode()

FrequencyUnit

String

Additional 頻度タイプコードに応じた追加の頻度単位

getFrequencyCode()

Format

String

購読ファイルタイプ。次の値があります。

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

getFormat()

ConditionList

Array (Condition)

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

getConditionList()

AdvancedTimezoneCode

String

購読が行われるタイムゾーン

getAdvancedTimezoneCode()

AdvancedTime

Integer

購読のローカル実行時間

getAdvancedTime()

Condition要素

データ型

説明

取得コード

Operator

String

カラムのフィルター演算子。次の値があります。

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

getOperator()

FieldId

Integer

カラムのフィールドID

getFieldId()

Value1

String

最初の条件値

getValue1()

Value2

String

2番目の条件値。演算子がBETWEENやNOTBETWEENなどの場合に必要です。

getValue2()

DashboardDefinition要素

データ型

説明

取得コード

TabId

Integer

ダッシュボードタブのID

getTabId()

GroupTypeCode

String

ダッシュボードタブのタイプ。次の値があります。

  • ANALYTIC
  • KPI
  • STANDARD

getGroupTypeCode()

Owner

Integer

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

getOwner()

OwnerTypeCode

String

ダッシュボード所有者のタイプ。値はデフォルトでORGANISATIONに設定されます。

getOwnerTypeCode()

AccessCode

String

ダッシュボードタブのセキュリティレベル

getAccessCode()

StartDate

Date

作成日

getStartDate()

EndDate

Date

終了日(適用される場合)

getEndDate()

StatusCode

String

ダッシュボードタブのステータス

getStatusCode()

ShortDescription

String

ダッシュボードタブの名前

getShortDescription()

LongDescription

String

ダッシュボードタブの説明

getLongDescription()

LanguageCode

String

2文字の言語コード

getLanguageCode()

StyleCode

String

レイアウトコード。次の値があります。

  • SINGLE
  • TWO
  • THREE
  • WIDENARROW
  • NARROWWIDE

getStyleCode()

Audience

String

対象者の説明

getAudience()

ParentGroupId

Integer

ダッシュボードタブがドラフト(編集中)モードの場合、元のタブIDがこのカラムに保存されます。

getParentGroupId()

Elements

Array (DashboardElement)

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

getElements()

Filters

Array (DashboardFilterDefinition)

ダッシュボードタブ、分析フィルター、およびフィルターグループに関するフォーマットレコードを含むDashboardFilterDefinitionオブジェクト( DashboardFilterDefinitionを参照)

getFilters()

Fields

Array (DashboardFieldDefinition)

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

getFields()

DashboardElement要素

データ型

説明

取得コード

TabId

Integer

ダッシュボードタブのID

getTabId()

EntityId

Integer

ポートレットのID。レポートIDでもある場合があります。

getEntityId()

EntityTypeCode

String

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

getEntityTypeCode()

ColumnNumber

Integer

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

getColumnNumber()

RowNumber

Integer

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

getRowNumber()

SequenceNumber

Integer

ダッシュボードタブ内のポートレットロード順序

getSequenceNumber()

StartDate

Date

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

getStartDate()

PortletStatus

String

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

getPortletStatus()

PortletHeight

Integer

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

getPortletHeight()

DashboardFieldDefinition要素

データ型

説明

取得コード

TabId

Integer

ダッシュボードタブのID

getTabId()

FieldId

Integer

カラムのフィールドID

getFieldId()

FieldType

String

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

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

getFieldType()

ReportId

Integer

レポートのID

getReportId()

TemplateId

Integer

対応するフィールドテンプレートレコードのID

getTemplateId()

FieldName

String

カラム名

getFieldName()

FieldDescription

String

カラム名

getFieldDescription()

DashboardFilterDefinition要素

データ型

説明

取得コード

GroupId

Integer

ダッシュボードタブのID

getGroupId()

ComponentId

Integer

要素タイプに基づく要素の数値ID

getComponentId()

ComponentTypeCode

String

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

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

getComponentTypeCode()

EntityId

Integer

 

getEntityId()

EntityTypeCode

String

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

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

getEntityTypeCode()

FormatKey

String

フォーマットコード

getFormatKey()

FormatValue

String

フォーマット値

getFormatValue()

ReportFilter要素

データ型

説明

取得コード

FilterId

Integer

フィルターのID

getFilterId()

IsOmitted

Boolean

フィルターをデフォルトで省略するかどうか

getIsOmitted()

DataValue

String

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

getDataValue()

DashboardFilter要素

データ型

説明

取得コード

ReportId

Integer

フィルターが属するレポートのID

getReportId()

FilterType

String

フィルター演算子

getFilterType()

FilterId

Integer

フィルターのID

getFilterId()

TabId

Integer

ダッシュボードタブのID that the report

getTabId()

FilterValue

String

特定のフィルターのフィルター値。フィルター演算子で2つの値を必要とする場合(たとえば、BETWEEN)、それらの値はパイプ値で連結されます。e

getFilterValue()

TemplateId

Integer

フィールドテンプレートレコードのID。フィルタータイプがDRILLなどの場合に適用されます。

getTemplateId()