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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

関数

ページトップ

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オブジェクトは、以下の項目で構成されます。

応答要素

データ型

説明

取得コード

コメント

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オブジェクト

特定の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オブジェクト

購読詳細と条件を含む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 of the dashboard tab
rsr.setDashboardTabId(11111);

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

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

応答要素

データ型

説明

取得コード

DashboardDefinition

DashboardDefinitionオブジェクト

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

getDashboard()

The following code will accomplish this:

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

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

The following code will accomplish this:

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

Retrieval Code

ReportFilters

Array (ReportFilter)

Array of Filter objects containing metadata for each filter (see 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 = 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

Retrieval Code

BinaryData

String

Base64 encoded binary chunk of HTML

getBinaryData()

Charts

Array (ReportChart)

Array of ReportChart objects (see ReportChart)

getCharts()

ReportStyle

String

CSS styles

GetReportStyle()

Breadcrumbs

Array (Breadcrumb)

Array of Breadcrumb objects

getBreadcrumbs()

GoogleMaps

Array (GMap)

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

getGoogleMaps()

GisMap

Array (GISMap)

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

getGisMap()

Object Definitions

top

ReportComment Element

Data Type

Description

Retrieval Code

CommentId

Integer

ID of comment

getCommentId()

AuthorId

Integer

ID of comment author

getAuthorId()

Comment

String

Comment value

getComment()

ReportId

Integer

Report ID of which the comment resides on

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

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

ReportRow Element

Data Type

Description

Retrieval Code

DataValue

Array (String)

Array of Strings with data for each column in the report result set

getDataValue()

ReportChart Element

Data Type

Description

Retrieval Code

ReportIndex

Integer

Index of image in the embedded delivered HTML

getReportIndex()

Content Type

String

MIME Content Type of this chart. Possible values include:

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

getContentType()

Data

String

Base64 binary image data

getData()

Filename

String

Filename of embedded file in HTML

getFilename()

ReportSchema Element

Data Type

Description

Retrieval Code

ColumnName

String

Column Name

getColumnName()

DisplayName

String

Display name of column

getDisplayName()

FieldId

Integer

Field Id of column

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

Prompt

Boolean

Whether the column is a prompt field or not

getPrompt()

FilterId

Integer

Filter Id if the column is a filter

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

getParentId()

DefaultValue1

 

First default value for filter if set

getDefaultValue1()

DefaultValue2

 

Second default value for filter if set

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

ReportBinaryObject Element

Data Type

Description

Retrieval Code

ContentType

String

MIME Content Type

getContentType()

Data

String

Base64 binary data

getData()

Key

String

Key of the ReportBinaryObject object

getKey()

KPI Element

Data Type

Description

Retrieval Code

Actual

String

The actual value for a KPI metric

getActual()

Target

String

The target value for a KPI metric

getTarget()

Variance

String

The variance value for a KPI metric

getVariance()

DrillAnywhereTarget Element

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 category

getTargets()

ScheduleRecord Element

Data Type

Description

Retrieval Code

Recipient

Integer

ID of recipient of the subscription

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)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()

Condition Element

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

getFieldId()

Value1

String

First conditional value

getValue1()

Value2

String

Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc.

getValue2()

DashboardDefinition Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

GroupTypeCode

String

Type of dashboard tab. Values include:

  • ANALYTIC
  • KPI
  • STANDARD

getGroupTypeCode()

Owner

Integer

ID of dashboard owner

getOwner()

OwnerTypeCode

String

Type of dashboard owner. Value defaults to ORGANISATION

getOwnerTypeCode()

AccessCode

String

Security level of the dashboard tab

getAccessCode()

StartDate

Date

Creation Date

getStartDate()

EndDate

Date

End 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 code

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

getParentGroupId()

Elements

Array (DashboardElement)

A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See 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

getFields()

DashboardElement Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

EntityId

Integer

ID of the portlet, which also happens to be the Report ID

getEntityId()

EntityTypeCode

String

Portlet entity type. Value defaults to REPORT

getEntityTypeCode()

ColumnNumber

Integer

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

getColumnNumber()

RowNumber

Integer

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

getRowNumber()

SequenceNumber

Integer

Portlet loading sequence within the dashboard tab

getSequenceNumber()

StartDate

Date

Date the portlet was added

getStartDate()

PortletStatus

String

Portlet status

getPortletStatus()

PortletHeight

Integer

Portlet height in pixels

getPortletHeight()

DashboardFieldDefinition Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

FieldId

Integer

Field ID of column

getFieldId()

FieldType

String

Field data type. Values include:

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

getFieldType()

ReportId

Integer

ID of report

getReportId()

TemplateId

Integer

ID of corresponding field template record

getTemplateId()

FieldName

String

Column name

getFieldName()

FieldDescription

String

Column name

getFieldDescription()

DashboardFilterDefinition Element

Data Type

Description

Retrieval Code

GroupId

Integer

ID of the dashboard tab

getGroupId()

ComponentId

Integer

Numeric ID for the component based on the component type

getComponentId()

ComponentTypeCode

String

Component types for a DashboardFilterDefinition object include:

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

getComponentTypeCode()

EntityId

Integer

 

getEntityId()

EntityTypeCode

String

Entity types for a DashboardFilterDefinition object include:

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

getEntityTypeCode()

FormatKey

String

Format Code

getFormatKey()

FormatValue

String

Format Value

getFormatValue()

ReportFilter Element

Data Type

Description

Retrieval Code

FilterId

Integer

ID of the filter

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

DashboardFilter Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the report that the filter belongs to

getReportId()

FilterType

String

Filter operator

getFilterType()

FilterId

Integer

ID of the filter

getFilterId()

TabId

Integer

ID of the dashboard tab that the report

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

getFilterValue()

TemplateId

Integer

ID of the field template record. This applies if the Filter Type is DRILL, etc

getTemplateId()

 

top
 

 

  • No labels