Business Entity Services Guide

10.5 HotFix 2

Back Next

Managing Custom Reports

Register and configure the custom reports that you want to use to collect information about your master data. Then in the Provisioning tool, you can populate the Chart component with the report data.

Before you begin, determine the data you want to collect.

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

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

GET http://localhost:8080/cmx/report/localhost-orcl-DS_UI1/list

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 report, use the Add or Update Report Data REST API.

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 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": "MDM.RPT.2",
    "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 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

Managing Custom Reports