IBM DataPower Operations Dashboard v1.0.11.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Reports Setup
- Avi Falah
- Sara Weisz
- Amit Munwes
Owned by Avi Falah
Click on "Add Report" to create a new report.
Click on the report name and press "Edit" to enter the alert details page.Â
| Column | Description |
|---|---|
| Description | A description of the report |
| Product | Product Type |
| REST URL | Report invocation can be integrated with external application via rest api, see Reports REST API from more details. |
| Schedule | When an alert execution will be scheduled |
| Recipients | Email addresses of the recipients for the report publishing. |
Add / Edit Report
Report Details Section
| Field | Description |
|---|---|
| Name | Name of the report |
| Description | Description of the report |
| Product | Product Type |
| API Reference | A unique key to be used in REST API. See Reports REST API for more details. |
| Schedule | When the report will be executed. See Scheduling a Report for more details. |
| Recipients | Email addresses of the recipients for the report publishing |
Report Query Section
| Field | Description |
|---|---|
| Index Sets | Which ElasticSearch index sets will be queried (according to product type) |
| Document Types | Which 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)
| Field | Description | Product Type |
|---|---|---|
| Time Range | Time frame for the query to sample the data for the report | Gateway/API-C |
| Device | Which DataPower devices the alert's query should check | Gateway/API-C |
| Domain | Which DataPower domains the alert's query should check | Gateway/API-C |
| Service | Which DataPower services the alert's query should check | Gateway |
| Service Field Override | Apply the service filter value to a specific Store field. You may leave this field empty unless otherwise advised. | Gateway |
| Catalog | Which API-C catalog names the alert's query should check | API-C |
| Space | Which API-C space names the alert's query should check | API-C |
| Product | Which API-C product names the alert's query should check | API-C |
| Plan | Which API-C plan names the alert's query should check | API-C |
| API Name | Which API-C names the alert's query should check | API-C |
| API Version | Which API-C versions the alert's query should check | API-C |
| App Name | Which API-C names the alert's query should check | API-C |
*By choosing "Adjustable Before Execution", the filter/s will/won't be available in the "Execute Report" page.