IBM DataPower Operations Dashboard v1.0.12.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Reports Setup

Click on "Add Report" to create a new report.
Click on the report name and press "Edit" to enter the alert details page. 

ColumnDescription
DescriptionA description of the report
ProductProduct Type
REST URLReport invocation can be integrated with external application via rest api, see Reports REST API from more details.
ScheduleWhen an alert execution will be scheduled
RecipientsEmail addresses of the recipients for the report publishing.

Add / Edit Report

Report Details Section

FieldDescription
NameName of the report
DescriptionDescription of the report
ProductProduct Type
API ReferenceA unique key to be used in REST API.  See Reports REST API for more details.
ScheduleWhen the report will be executed. See Scheduling a Report for more details.
RecipientsEmail addresses of the recipients for the report publishing


Report Query Section

FieldDescription
Index SetsWhich ElasticSearch index sets will be queried (according to product type)
Document TypesWhich ElasticSearch document types will be queried (according to product type)
Query (JSON)An ElasticSearch query
Parameters (JSON)

Named parameters to replace placeholders in the query. i.e:

Headers (JSON)Named parameters to replace column headers in reports outcome with more meaningful headers.


Report Filters Section (according to product type and document type)

FieldDescriptionProduct Type
Time RangeTime frame for the query to sample the data for the reportGateway/API-C
DeviceWhich DataPower devices the alert's query should checkGateway/API-C
DomainWhich DataPower domains the alert's query should checkGateway/API-C
ServiceWhich DataPower services the alert's query should checkGateway
Service Field OverrideApply the service filter value to a specific Store field. You may leave this field empty unless otherwise advised.Gateway
CatalogWhich API-C catalog names the alert's query should checkAPI-C
SpaceWhich API-C space names the alert's query should checkAPI-C
ProductWhich API-C product names the alert's query should checkAPI-C
PlanWhich API-C plan names the alert's query should checkAPI-C
API NameWhich API-C names the alert's query should checkAPI-C
API VersionWhich API-C versions the alert's query should checkAPI-C
App NameWhich API-C names the alert's query should checkAPI-C

*By choosing "Adjustable Before Execution", the filter/s will/won't be available in the "Execute Report" page.

IBM DataPower Operations Dashboard (DPOD) v1.0.12.0