Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 1

changes.mady.by.user Yellowfin

Saved on 27 Aug, 2014

compared with

New Version 2

changes.mady.by.user Yellowfin

Saved on 27 Aug, 2014

Key

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

Comment: Migrated to Confluence 4.0

...

Expand

title	PDF

The PDF request runs a specified report and returns it in PDF form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of PDF	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "application“application/pdf"pdf”	`getContentType()`

Expand

title	CSV

The CSV request runs a specified report and returns it in CSV form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of CSV	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "text“text/comma-separated-values"values”	`getContentType()`

Expand

title	XLS

The XLS request runs a specified report and returns it in XLS form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLS	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "application“application/xls"xls”	`getContentType()`

Expand

title	TEXT

The TEXT request runs a specified report and returns it in TEXT form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLS	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "text“text/tab-separated-values"values”	`getContentType()`

Expand

title	RTF

The RTF request runs a specified report and returns it in RTF form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLS	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "application“application/rtf"rtf”	`getContentType()`

Expand

title	DOC

The DOC request runs a specified report and returns it in DOC form. The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
ReportName	String	Name of the specified report	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLS	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be "application“application/vnd.ms-word"word”	`getContentType()`

Expand

title	SCHEMA

The SCHEMA request returns schematic information of the specified report, which includes metadata for report columns and filters as well. The following code will accomplish this:

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

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report	`getReportId()`
StatusCode	String	Status of the web service request	`getStatusCode()`
FormatCode	String	Format code of the specified report	`getFormatCode()`
ReportType	String	Report type of the specified report	`getReportType()`
LastRunStatus	String	Status code of last report run	`getLastRunStatus()`
LastRunTime	Decimal	Last report run time in the format of YYYYMMDDHHMMSS	`getLastRunTime()`
ReportName	String	Name of the specified report	`getReportName()`
BinaryData	String	Base64 encoded binary chunk of image, HTML, CSV, or PDF	`getBinaryData()`
ViewName	String	Name of view that the report depends on	`getViewName()`
HitCount	Integer	Number of times the specified report has been accessed	`getHitCount()`
DrillCode	String	Drill type if available on the report	`getDrillCode()`
Private		Determines if the report is a private or a public one	`getPrivate()`
Results	Array (ReportRow)	Array of ReportRow objects that contain results in the report result set (see ReportRow)	`getResults()`
ContentType	String	MIME ContentType of the returned object. Possible values include: "text“text/html"html” "text“text/comma-separated-values"values”"image “image/png"png”"application “application/pdf"pdf”	`getContentType()`
Messages	Array (String)	Array of Strings that show debug information as the report is run on the server. Used for debugging and tracing errors	`getMessages()`
Charts	Array (ReportChart)	Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see ReportChart)	`getCharts()`
Columns	Array (ReportSchema)	Array of ReportSchema objects that contain information on each column in the report result set, and whether the report requires user prompt filter data to be passed to it (see ReportSchema)	`getColumns()`

Expand

title	HTML / HTMLCHARTONLY / HTMLTABLEONLY

The HTML request will return a HTML representation of the report. The HTML document will be Base64 encoded, with the charts/images being stored in the Charts array field. These artefacts will need to be manually decoded by the client system, and the URL request string is used to embed the URL within the HTML for decoding the Base64 images.

The following code will accomplish this:

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

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
Chart	Array (ReportChart)	Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see ReportChart)	`getCharts()`
ReportBinaryObject	Array (ReportBinaryObject)	Array of ReportBinaryObject objects that contain BLOBs and CLOBs (see ReportBinaryObject)	`getBinaryObjects()`
ReportStyles	String	CSS styles	`getReportStyles()`
Breadcrumbs	Array (Breadcrumb)	Array of Breadcrumb objects	`getBreadcrumbs()`
SeriesSelection	Array (SeriesSelection)	Array of SeriesSelection objects	`getSeriesSelections()`
TimeAggregationSelection	Array (TimeAggregationSelection)	Array of TimeAggregationSelection objects	`getTimeAggregationSelection()`
ReportTabSelection	Array (ReportTabSelection)	Array of ReportTabSelection objects	`getReportTabSelection()`
ReportPageSelection	Array (ReportPageSelection)	Array of ReportPageSelection objects	`getReportPageSelection()`
TimeSliderSelection	Array (TimeSliderSelection)	Array of TimeSliderSelection objects	`getTimeSliderSelection()`
SortableColumns	Array (SortableTableColumn)	Array of SortableTableColumn objects	`getSortableColumns()`
SelectedSortColumn	Integer	Column used for sorting. The index here applies to the column index within the report	`getSelectedSortColumn()`
SelectedSortOrder	Integer	The sort order of the column used for sorting (0 for ascending and 1 for descending)	`getSelectedSortOrder()`
DrillCode	String	Drill type if available on the report	`getDrillCode()`
RelatedReports	Array (RelatedReport)	Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report	`getRelatedReports()`
BinaryData	String	Base64 encoded binary chunk of the HTML document	`getBinaryData()`
Private		Determines if the report is a private or a public one	`getPrivate()`
ContentType	String	MIME ContentType of the returned object. Value will be "text“text/html"html”	`getContentType()`
CanDrill	Boolean	If the report is able to drill or not	`getCanDrill()`
GoogleMaps	Array (GMap)	Array of GMap objects	`getGoogleMaps()`

Expand
title FILTEROPTIONS
The FILTEROPTIONS request will return the filter values available for a particular

...

report’s filter.

The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
Results	Array (ReportRow)	Array of ReportRow objects that contain filter values (see ReportRow)	`getResults()`

Expand

title	RESULTSET

The RESULTSET request will return the result data set for a particular report. This result will be stored in an array of ReportRow objects, with each ReportRow object representing a row in the report data set. The ReportRow object will also consist of an array of strings that represents the data in each column in the data set.

It is up to the web services client to convert this data from the string representation into the data type for each particular column. The data types for each column can be obtained with the SCHEMA request function call.

The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
Results	Array (ReportRow)	Array of ReportRow objects that contain results in the report result set (see ReportRow)	`getResults()`

...

Expand

title	GETCOMMENTS

The GETCOMMENTS request will retrieve all comments for a particular report.

The following code will accomplish this:

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element	Data Type	Description	Retrieval Code
Comments	Array (ReportComment)	Array of ReportComment objects that contain the report's report’s comments (see ReportComment)	`getComments()`

...

Expand

title	RUNDASHBOARDREPORT

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:

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	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 report’s chart uses it	`getGoogleMaps()`
GisMap	Array (GISMap)	Array of GISMap objects if the report's report’s chart uses it	`getGisMap()`

Object Definitions

...

Anchor

	ReportChart
	ReportChart

Expand
title ReportChart
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()`

Anchor

	ReportSchema
	ReportSchema

...

Content

Space Tools

Page History

Versions Compared

Old Version 1

New Version 2

Key

ExpandtitleFILTEROPTIONSThe FILTEROPTIONS request will return the filter values available for a particular

Object Definitions

ExpandtitleReportChartReportChart ElementData TypeDescriptionRetrieval CodeReportIndexIntegerIndex of image in the embedded delivered HTMLgetReportIndex()Content TypeStringMIME Content Type of this chart. Possible values include:

“image/

png”

“image/

jpg”getContentType()DataStringBase64 binary image datagetData()FilenameStringFilename of embedded file in HTMLgetFilename()

Expand
title FILTEROPTIONS
The FILTEROPTIONS request will return the filter values available for a particular

Expand
title ReportChart
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:

jpg”
`getContentType()`
Data
String
Base64 binary image data
`getData()`
Filename
String
Filename of embedded file in HTML
`getFilename()`