Business Entity Services Guide

10.5 HotFix 2
- 10.5
- 10.4 HotFix 3
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 3
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

Managing Custom Reports with Drilldown Reports

Register the custom reports that you want to use and add data entries to your report. Then register the drilldown reports and add data entries to the drilldown reports. When you add or update data entries in your root reports, you can associate your drilldown reports to the data entries. Then in the Provisioning tool, you can populate the Chart component with the report data and link the root chart to a drilldown chart.

Before you begin, determine the data you want to collect. Also, determine the drilldown reports you want to configure and associate to your data entries in your custom report.

To review the registered reports, use the List Reports REST API.

For example, the following request lists the registered root reports and drilldown reports:

GET http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/list?show=all

To register a custom report, use the Register Report REST API.

For example, the following request registers a custom report:

POST http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/list
{
  "DIMENSION_NAME_1": "Task Priority",
  "DIMENSION_NAME_2": "Task Type",
  "TIMEPERIOD_NAME": "null",
  "RPT_NAME": "Task Priority/Type Report",
  "RPT_DESC": "Metrics for task status/type",
  "METRIC_NAME": "Number of tasks"
 }

The following sample response shows the registered report:

{
  "ROWID_RPT_CONFIG": "SVR1.2X9N0",
  "DIMENSION_NAME_1": "Task Priority",
  "DIMENSION_NAME_2": "Task Type",
  "TIMEPERIOD_NAME": "null",
  "RPT_NAME": "Task Priority/Type Report",
  "RPT_DESC": "Metrics for task status/type",
  "METRIC_NAME": "Number of tasks",
  "RPT_TYPE": "null"
}

The request returns the report ID in the

ROWID_RPT_CONFIG

parameter.

To add data entries in a root report, use the Add or Update Report Data REST API.

Later, you can associate a drilldown report to a data entry.

For example, the following request adds data entries in a report:

POST http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/data/SVR1.2X9N0
[
  {
    "DIMENSION_VALUE_1": "High",
    "DIMENSION_VALUE_2": "AVOSBeMerge",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "3",
    "DRILLDOWN_RPT_ID": "null"
  },
  {
    "DIMENSION_VALUE_1": "High",
    "DIMENSION_VALUE_2": "AVOSBeReviewNoApprove",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "0",
    "DRILLDOWN_RPT_ID": "null"
 },
 {
    "DIMENSION_VALUE_1": "High",
    "DIMENSION_VALUE_2": "AVOSBeUpdate",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "0",
    "DRILLDOWN_RPT_ID": "null"
 }
 ...
]

To register a drilldown report, use the Register Report REST API.

For example, the following request registers the drilldown report:

POST http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/list
{
  "DIMENSION_NAME_1": "Task's Owner",
  "DIMENSION_NAME_2": "null",
  "TIMEPERIOD_NAME": "null",
  "RPT_NAME": "Task's Owner per Task Priority and Task Type",
  "RPT_DESC": "Number of tasks for each users for Task Priority/Task Type",
  "METRIC_NAME": "Number of Tasks"
 }

The following sample response shows the registered drilldown report:

{
  "ROWID_RPT_CONFIG": "SVR1.48P5G",
  "DIMENSION_NAME_1": "Task's Owner",
  "DIMENSION_NAME_2": "null",
  "TIMEPERIOD_NAME": "null",
  "RPT_NAME": "Task's Owner per Task Priority and Task Type",
  "RPT_DESC": "Number of tasks for each users for Task Priority/Task Type",
  "METRIC_NAME": "Number of Tasks",
  "RPT_TYPE": "High/AVOSBeMerge"
}

The request returns the drilldown report ID in the

ROWID_RPT_CONFIG

parameter.

To add data entries in a drilldown report, use the Add or Update Report Data REST API.

For example, the following request adds data entries in a drilldown report:

POST http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/data/SVR1.48P5G
[
  {
    "DIMENSION_VALUE_1": "admin",
    "DIMENSION_VALUE_2": "null",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "0",
    "DRILLDOWN_RPT_ID": "null"
 },
  {
    "DIMENSION_VALUE_1": "srmgr2",
    "DIMENSION_VALUE_2": "null",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "0",
    "DRILLDOWN_RPT_ID": "null"
 },
 {
    "DIMENSION_VALUE_1": "mgr2",
    "DIMENSION_VALUE_2": "null",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "0",
    "DRILLDOWN_RPT_ID": "null"
 }
]

To associate a drilldown report to a data entry in a report, use the Add or Update Report Data REST API. Specify the drilldown report ID in

DRILLDOWN_RPT_ID

parameter.

For example, the following request associates a drilldown report to the data entry:

POST http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/data/SVR1.2X9N0
[
  {
    "DIMENSION_VALUE_1": "High",
    "DIMENSION_VALUE_2": "AVOSBeMerge",
    "TIMEPERIOD_VALUE": "null",
    "METRIC_VALUE": "5",
    "DRILLDOWN_RPT_ID": "SVR1.48P5G"
  }
]

To retrieve the report configuration and data, use the Get Report Configuration and Data REST API.

For example, the following request retrieves the report configuration and data:

GET http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/data/SVR1.2X9N0

The following sample response shows the report configuration and the data:

{ 
  "metadata":{ 
    "fieldsMetadata":[ 
      "DIMENSION_VALUE_1",
      "DIMENSION_VALUE_2",
      "TIMEPERIOD_VALUE",
      "METRIC_VALUE",
      "DRILLDOWN_RPT_ID"
    ],
    "ROWID_RPT_CONFIG": "SVR1.2X9N0",
    "DIMENSION_NAME_1": "Task Priority",
    "METRIC_NAME": "Number of tasks",
    "DIMENSION_NAME_2": "Task Type",
    "TIMEPERIOD_NAME": "null",
    "RPT_NAME": "Task Priority/Type Report",
    "RPT_DESC": "Metrics for task status/type",
    "RPT_TYPE": "null"
  },
  "data":[ 
    [ 
      "High",
      "AVOSBeMerge",
      "null",
      "3",
      "SVR1.48P5G"
    ],
    [ 
      "High",
      "AVOSBeReviewNoApprove",
      "null",
      "0",
      "null"
    ],
    [ 
      "High",
      "AVOSBeUpdate",
      "null",
      "0",
      "null"
    ],
    [ 
      "High",
      "AVOSBeFinalReview",
      "null",
      "0",
      "null"
    ]
    ...
  ]
}

To retrieve the registered reports, including your custom reports and drilldown reports, use the List Reports REST API.

For example, the following request lists the registered root reports and drilldown reports:

GET http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/list?show=all

The following sample response shows the registered root reports and drilldown reports:

[ 
  { 
    "ROWID_RPT_CONFIG": "SVR1.2X9N0",
    "DIMENSION_NAME_1": "Task Priority",
    "METRIC_NAME": "Number of tasks",
    "DIMENSION_NAME_2": "Task Type",
    "TIMEPERIOD_NAME": "null",
    "RPT_NAME": "Task Priority/Type Report",
    "RPT_DESC": "Metrics for task status/type",
    "RPT_TYPE": "null"
  },
  { 
    "ROWID_RPT_CONFIG": "SVR1.48P5G",
    "DIMENSION_NAME_1": "Task's Owner",
    "DIMENSION_NAME_2": "null",
    "TIMEPERIOD_NAME": "null",
    "RPT_NAME": "Task's Owner per Task Priority and Task Type",
    "RPT_DESC": "Number of tasks for each users for Task Priority/Task Type",
    "METRIC_NAME": "Number of Tasks",
    "RPT_TYPE": "High/AVOSBeMerge"
  }
]

To delete a report, use the Delete Report REST API.

For example, the following request deletes a report:

DELETE http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/data/SVR1.2X9N0

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Managing Custom Reports with Drilldown Reports

Managing Custom Reports with Drilldown Reports