Date: Fri, 29 Mar 2024 03:20:30 -0600 (MDT) Message-ID: <585462749.2801.1711704030506@confluence-external-wiki> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_2800_1366970180.1711704030506" ------=_Part_2800_1366970180.1711704030506 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
=
The PDF request runs a specified report and returns it in PDF form. The = following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of PDF |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Capplication/pdf=E2=80=9D |
|
The CSV request runs a specified report and returns it in CSV form. The = following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of CSV |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Ctext/comma-separated-values=E2=80=9D |
|
The XLS request runs a specified report and returns it in XLS form. The = following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of XLS |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Capplication/xls=E2=80=9D |
|
The TEXT request runs a specified report and returns it in TEXT form. Th= e following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of XLS |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Ctext/tab-separated-values=E2=80=9D |
|
The RTF request runs a specified report and returns it in RTF form. The = following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of XLS |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Capplication/rtf=E2=80=9D |
|
The DOC request runs a specified report and returns it in DOC form. The = following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
ReportName |
String |
Name of the specified report |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
FormatCode |
String |
Format code of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of XLS |
|
ContentType |
String |
MIME Content Type of this object. Value will = be =E2=80=9Capplication/vnd.ms-word=E2=80=9D |
|
The SCHEMA request returns schematic information of the specified report= , which includes metadata for report columns and filters as well. The follo= wing code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 n= eeded rsr.setObjectName("MYREPORT"); rs =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the specified report |
|
StatusCode |
String |
Status of the web service request |
|
FormatCode |
String |
Format code of the specified report |
|
ReportType |
String |
Report type of the specified report |
|
LastRunStatus |
String |
Status code of last report run |
|
LastRunTime |
Decimal |
Last report run time in the format of YYYYMMD= DHHMMSS |
|
ReportName |
String |
Name of the specified report |
|
BinaryData |
String |
Base64 encoded binary chunk of image, HTML, C= SV, or PDF |
|
ViewName |
String |
Name of view that the report depends on = td> |
|
HitCount |
Integer |
Number of times the specified report has been= accessed |
|
DrillCode |
String |
Drill type if available on the report |
|
Private |
|
Determines if the report is a private or a pu= blic one |
|
Results |
Array (ReportRow) |
Array of ReportRow objects that contain resul= ts in the report result set (see Repor= tRow) |
|
ContentType |
String |
MIME ContentType of the returned object. Poss= ible values include:
|
|
Messages |
Array (String) |
Array of Strings that show debug information = as the report is run on the server. Used for debugging and tracing errors= p> |
|
Charts |
Array (ReportChart) |
Array of ReportChart objects that contains mu= ltiple chart bitmaps when attached to a HTML report response (see ReportChart) |
|
Columns |
Array (ReportSchema) |
Array of ReportSchema objects that contain in= formation on each column in the report result set, and whether the report r= equires user prompt filter data to be passed to it (see ReportSchema) |
|
The HTML request will return a HTML representation of the report. The HT= ML 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 wit= hin the HTML for decoding the Base64 images.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 n= eeded rsr.setObjectName("MYREPORT"); rs =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Chart |
Array (ReportChart) |
Array of ReportChart objects that contains mu= ltiple chart bitmaps when attached to a HTML report response (see ReportChart) |
|
ReportBinaryObject |
Array (ReportBinaryObject) |
Array of ReportBinaryObject objects that cont= ain BLOBs and CLOBs (see Repo= rtBinaryObject) |
|
ReportStyles |
String |
CSS styles |
|
Breadcrumbs |
Array (Breadcrumb) |
Array of Breadcrumb objects |
|
SeriesSelection |
Array (SeriesSelection) |
Array of SeriesSelection objects |
|
TimeAggregationSelection |
Array (TimeAggregationSelection) |
Array of TimeAggregationSelection objects = |
|
ReportTabSelection |
Array (ReportTabSelection) |
Array of ReportTabSelection objects |
|
ReportPageSelection |
Array (ReportPageSelection) |
Array of ReportPageSelection objects |
|
TimeSliderSelection |
Array (TimeSliderSelection) |
Array of TimeSliderSelection objects |
|
SortableColumns |
Array (SortableTableColumn) |
Array of SortableTableColumn objects |
|
SelectedSortColumn |
Integer |
Column used for sorting. The index here appli= es to the column index within the report |
|
SelectedSortOrder |
Integer |
The sort order of the column used for sorting= (0 for ascending and 1 for descending) |
|
DrillCode |
String |
Drill type if available on the report |
|
RelatedReports |
Array (RelatedReport) |
Array of RelatedReport objects. These are rep= orts that are tabbed/codisplayed to the main report |
|
BinaryData |
String |
Base64 encoded binary chunk of the HTML docum= ent |
|
Private |
|
Determines if the report is a private or a pu= blic one |
|
ContentType |
String |
MIME ContentType of the returned object. Valu= e will be =E2=80=9Ctext/html=E2=80=9D |
|
CanDrill |
Boolean |
If the report is able to drill or not |
|
GoogleMaps |
Array (GMap) |
Array of GMap objects |
|
The FILTEROPTIONS request will return the filter values available for a = particular report=E2=80=99s filter.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Results |
Array (ReportRow) |
Array of ReportRow objects that contain filte= r values (see ReportRow) |
|
The RESULTSET request will return the result data set for a particular r= eport. This result will be stored in an array of ReportRow objects, with ea= ch ReportRow object representing a row in the report data set. The ReportRo= w 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 typ= es for each column can be obtained with the SCHEMA request function call.= p>
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Results |
Array (ReportRow) |
Array of ReportRow objects that contain resul= ts in the report result set (see Repor= tRow) |
|
The EXPIRESESSION request will cause a specified Yellowfin session to ex= pire.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The GETCOMMENTS request will retrieve all comments for a particular repo= rt.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Comments |
Array (ReportComment) |
Array of ReportComment objects that contain t= he report=E2=80=99s comments (see = ReportComment) |
|
The LEAVECOMMENT request will create a comment/response to a comment in = a particular report.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; ReportComment comment =3D 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 =3D ReportService.remoteReportCall(rsr);
The DELETECOMMENT request will delete the particular comment from a repo= rt.
The following code with accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; ReportComment comment =3D 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 =3D ReportService.remoteReportCall(rsr);
The COMMENTSTATUS request will set the status of a particular comment.= p>
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; ReportComment comment =3D 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 =3D ReportService.remoteReportCall(rsr);
The DISTRIBUTEINBOX request will distribute a report to the inboxes of a= list of recipients.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; // Specify the Person ID values for your list of recipients String[] reportoptions =3D { "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 =3D ReportService.remoteReportCall(rsr);
The GETDISPLAYEDREPORTID request will return the report ID of the curren= tly displayed report.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organization rsr.setOrgId(new Integer(1)); rsr.setReportRequest("GETDISPLAYEDREPORTID"); rs =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
DisplayedReportId |
Integer |
Report ID of the currently displayed report= p> |
|
The GETKPI request will return you the KPI object for a particular KPI r= eport. This function request is usually utilised within the mobile applicat= ion.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
KPI |
KPI object |
This is a custom KPI object which holds the a= ctual, target, and variance values for a particular KPI metric (see KPI) |
|
The GETDRILLANYWHEREMENU request will return you the Drill Anywhere menu= that is available for the selected report column. This function request is= usually utilized within the mobile application.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
DrillAnywhereCategories |
Array (String) |
Array of Strings |
|
DrillAnywhereTargets |
Array (DrillAnywhereTarget) |
Array of DrillAnywhereTarget objects that lis= ts the drill anywhere targets for a drill anywhere category (see DrillAnywhereTarget) |
|
The SUBSCRIBEDETAILS request will return the schedule record for a parti= cular report.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; ScheduleRecord sr =3D 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 =3D ReportService.remoteReportCall(rsr); sr =3D rs.getSchedule();
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ScheduleRecord |
ScheduleRecord object |
ScheduleRecord object which contains subscrip= tion details and conditions (see = ScheduleRecord) |
|
The SUBSCRIBE request will create/modify a subscription to a specified r= eport for a specified user. This function request is usually called after S= UBSCRIBEDETAILS to retrieve a current subscription first, otherwise a Sched= uleRecord object must be created and populated appropriately (refer to ScheduleRecord) for this function= call.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; // Either retrieve a current ScheduleRecord beforehand or create a new one.= A new one is created in this example ScheduleRecord sr =3D 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.setBodyText("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 =3D ReportService.remoteReportCall(rsr);
The UNSUBSCRIBE request will unsubscribe a specified user from a specifi= ed report.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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 =3D ReportService.remoteReportCall(rsr);
The LOADDASHBOARDTAB request will load a specified dashboard tab and its= metadata.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; DashboardDefinition dd =3D 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 =3D ReportService.remoteReportCall(rsr); dd =3D rs.getDashboard();
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
DashboardDefinition |
DashboardDefinition object |
DashboardDefinition object which contains das= hboard tab metadata (see Das= hboardDefinition) |
|
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; DashboardFilter[] dfarray =3D null; DashboardFilter df =3D 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] =3D df; rsr.setDashboardFilters(dfarray); rs =3D ReportService.remoteReportCall(rsr);
The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata f= or a particular report on a dashboard tab.
The following code will accomplish this:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D null; ReportFilter[] rf =3D 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); rsr.setReportId(22222); rs =3D ReportService.remoteReportCall(rsr); rf =3D rs.getReportFilters();
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportFilters |
Array (ReportFilter) |
Array of Filter objects containing metadata f= or each filter (see ReportFilter) |
|
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:
ReportS= erviceRequest rsr =3D new ReportServiceRequest(); ReportServiceResponse rs =3D 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); rsr.setReportId(22222); rs =3D ReportService.remoteReportCall(rsr);
The returned ReportServiceResponse object consists of:
Response Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
BinaryData |
String |
Base64 encoded binary chunk of HTML |
|
Charts |
Array (ReportChart) |
Array of ReportChart objects (see ReportChart) |
|
ReportStyle |
String |
CSS styles |
|
Breadcrumbs |
Array (Breadcrumb) |
Array of Breadcrumb objects |
|
GoogleMaps |
Array (GMap) |
Array of GoogleMaps objects if the report=E2= =80=99s chart uses it |
|
GisMap |
Array (GISMap) |
Array of GISMap objects if the report=E2=80= =99s chart uses it |
|
ReportComment Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
CommentId |
Integer |
ID of comment |
|
AuthorId |
Integer |
ID of comment author |
|
Comment |
String |
Comment value |
|
ReportId |
Integer |
Report ID of which the comment resides on = |
|
ParentCommentId |
Integer |
Main ID of comment it is connected to. This a= pplies if the particular comment is a reply to a parent comment |
|
StatusCode |
String |
Comment status |
|
CommentDate |
DateTime |
Date and time value for comment creation <= /td> |
|
LastActivityDate |
DateTime |
Date and time value for the most current upda= te to that particular comment |
|
= span>
ReportRow Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
DataValue |
Array (String) |
Array of Strings with data for each column in= the report result set |
|
=
ReportChart Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportIndex |
Integer |
Index of image in the embedded delivered HTML= |
|
Content Type |
String |
MIME Content Type of this chart. Possible val= ues include:
|
|
Data |
String |
Base64 binary image data |
|
Filename |
String |
Filename of embedded file in HTML |
|
ReportSchema Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ColumnName |
String |
Column Name |
|
DisplayName |
String |
Display name of column |
|
FieldId |
Integer |
Field Id of column |
|
DataType |
String |
Data type of column |
|
ColumnLength |
String |
Column length |
|
Hidden |
Boolean |
Whether the column is displayed in the report= or not |
|
Prompt |
Boolean |
Whether the column is a prompt field or not= p> |
|
FilterId |
Integer |
Filter Id if the column is a filter |
|
FilterType |
String |
Determines the filter type and what data woul= d have to be posted to engage the prompt |
|
AllowPrompt |
Boolean |
|
|
FilterOmittable |
Boolean |
|
|
ParentFilterId |
Integer |
Filter Id of parent filter if a filter depend= ency is in place |
|
DefaultValue1 |
|
First default value for filter if set |
|
DefaultValue2 |
|
Second default value for filter if set |
|
ValueUnitCode |
|
Time units for the filter if set |
|
FilterDisplayType |
|
Filter Display Type if the column is a filter= |
|
MinimumValue |
|
Minimum value for filter if set |
|
MaximumValue |
|
Maximum value for filter if set |
|
ReportBinaryObject Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ContentType |
String |
MIME Content Type |
|
Data |
String |
Base64 binary data |
|
Key |
String |
Key of the ReportBinaryObject object |
|
<= /p>
KPI Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Actual |
String |
The actual value for a KPI metric |
|
Target |
String |
The target value for a KPI metric |
|
Variance |
String |
The variance value for a KPI metric |
|
DrillAnywhereTarget Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ParentCategory |
String |
Parent Category value |
|
Targets |
Array (String) |
Array of String values which are the targets = for a particular parent category |
|
ScheduleRecord Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Recipient |
Integer |
ID of recipient of the subscription |
|
Subject |
String |
Subscription subject |
|
BodyText |
String |
Subscription message |
|
FrequencyTypeCode |
String |
Subscription frequency. Values include:
|
|
FrequencyCode |
String |
Additional frequency codes depending on the f= requency type code |
|
FrequencyUnit |
String |
Additional frequency units depending on the f= requency type code |
|
Format |
String |
Subscription File Type. Values include:
|
|
ConditionList |
Array (Condition) |
Array of Condition objects that store deliver= y rules (see Condition) |
|
AdvancedTimezoneCode |
String |
Timezone in which the subscription happens |
|
AdvancedTime |
Integer |
Local run time for the subscription |
|
= span>
Condition Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
Operator |
String |
Filter operator for the column(s). Values inc= lude:
|
|
FieldId |
Integer |
Field Id of column |
|
Value1 |
String |
First conditional value |
|
Value2 |
String |
Second conditional value. This is needed if t= he operators are BETWEEN, NOTBETWEEN, etc. |
|
DashboardDefinition Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
TabId |
Integer |
ID of the dashboard tab |
|
GroupTypeCode |
String |
Type of dashboard tab. Values include:
|
|
Owner |
Integer |
ID of dashboard owner |
|
OwnerTypeCode |
String |
Type of dashboard owner. Value defaults to OR= GANISATION |
|
AccessCode |
String |
Security level of the dashboard tab |
|
StartDate |
Date |
Creation Date |
|
EndDate |
Date |
End Date (if applicable) |
|
StatusCode |
String |
Status of the dashboard tab |
|
ShortDescription |
String |
Name of the dashboard tab |
|
LongDescription |
String |
Business description of the dashboard tab = |
|
LanguageCode |
String |
Two letter language code |
|
StyleCode |
String |
Layout code. Values include:
|
|
Audience |
String |
Audience description |
|
ParentGroupId |
Integer |
If the dashboard tab is in draft mode, the or= iginal tab ID is saved into this column |
|
Elements |
Array (DashboardElement) |
A DashboardElement object contains portlet in= formation for reports that reside within the dashboard tab (See DashboardElement) |
|
Filters |
Array (DashboardFilterDefinition) |
A DashboardFilterDefinition object contains f= ormat records pertaining the dashboard tab, analytic filters, and filter gr= oups (See DashboardFil= terDefinition) |
|
Fields |
Array (DashboardFieldDefinition) |
A DashboardFieldDefinition object contains fo= rmat records pertaining fields being displayed as drilldowns on the dashboa= rd tab |
|
DashboardElement Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
TabId |
Integer |
ID of the dashboard tab |
|
EntityId |
Integer |
ID of the portlet, which also happens to be t= he Report ID |
|
EntityTypeCode |
String |
Portlet entity type. Value defaults to REPORT= |
|
ColumnNumber |
Integer |
Indicating where the portlet is column-wise. = The first column starts at the value 1 |
|
RowNumber |
Integer |
Indicating where the portlet is row-wise. The= first row starts at the value 1 |
|
SequenceNumber |
Integer |
Portlet loading sequence within the dashboard= tab |
|
StartDate |
Date |
Date the portlet was added |
|
PortletStatus |
String |
Portlet status |
|
PortletHeight |
Integer |
Portlet height in pixels |
|
DashboardFieldDefinition Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
TabId |
Integer |
ID of the dashboard tab |
|
FieldId |
Integer |
Field ID of column |
|
FieldType |
String |
Field data type. Values include:
|
|
ReportId |
Integer |
ID of report |
|
TemplateId |
Integer |
ID of corresponding field template record = |
|
FieldName |
String |
Column name |
|
FieldDescription |
String |
Column name |
|
DashboardFilterDefinition Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
GroupId |
Integer |
ID of the dashboard tab |
|
ComponentId |
Integer |
Numeric ID for the component based on the com= ponent type |
|
ComponentTypeCode |
String |
Component types for a DashboardFilterDefiniti= on object include:
|
|
EntityId |
Integer |
|
|
EntityTypeCode |
String |
Entity types for a DashboardFilterDefinition = object include:
|
|
FormatKey |
String |
Format Code |
|
FormatValue |
String |
Format Value |
|
ReportFilter Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
FilterId |
Integer |
ID of the filter |
|
IsOmitted |
Boolean |
If the filter is omitted by default |
|
DataValue |
String |
Filter values for a particular filter. If the= re are two values (i.e if the filter operator is BETWEEN, etc) then they ar= e concatenated with a pipe value |
|
DashboardFilter Element |
Data Type |
Description |
Retrieval Code |
---|---|---|---|
ReportId |
Integer |
ID of the report that the filter belongs to= p> |
|
FilterType |
String |
Filter operator |
|
FilterId |
Integer |
ID of the filter |
|
TabId |
Integer |
ID of the dashboard tab that the report = td> |
|
FilterValue |
String |
Filter values for a particular filter. If the= filter operator involves the usage of two values (i.e BETWEEN, etc) then b= oth values are concatenated with a pipe value |
|
TemplateId |
Integer |
ID of the field template record. This applies= if the Filter Type is DRILL, etc |
|