This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Reporting microservice.
External Events via EventBridge
The following events contain the entity changed in the event message payload.
List of Events
| S.No. | API call | Call detail | Event Type | Identifier |
|---|---|---|---|---|
| 1. | PATCH | PatchUpdateReport | reportservice/report/patch | response_report.id |
| 2. | DELETE | DeleteReport | reportservice/report/delete | response_report.id |
| 3. | DELETE | DeleteReportProperty | reportservice/reportproperty/delete | response_report.id |
Payload
PatchUpdateReport
Event Type: reportservice/report/patch
{
"version": "0",
"id": "7bed08a6-aafd-027a-a6e8-c57a44995668",
"detail-type": "reportservice/report/patch",
"source": "reportservice",
"account": "277827593990",
"time": "2024-03-06T07:42:15Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "9",
"timestamp": 1709710935429,
"payload": {
"code": "REPORT_UPDATED",
"report": {
"id": 9,
"collectionId": 6,
"name": "Externalevent",
"description": "Reports",
"reportProperties": [
{
"name": "New",
"value": "2"
}
],
"reportParams": [
],
"processorClassName": "",
"downloadable": false,
"createdBy": "1",
"createdTime": 1709710928000,
"updatedBy": "1",
"updatedTime": 1709710928000
}
},
"collectionId": "6",
"eventType": "reportservice/report/patch",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_REPORTING_ADMIN"
],
"channel": "CSR"
}
}
DeleteReport
Event Type: reportservice/report/delete
{
"version": "0",
"id": "3bce8e33-93e0-4f5e-c0ef-74fdd95b198f",
"detail-type": "reportservice/report/delete",
"source": "reportservice",
"account": "277827593990",
"time": "2024-03-06T07:43:36Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "12",
"timestamp": 1709711016159,
"payload": {
"responseCode": "REPDEL0000",
"responseMessage": "Report Id 12 deleted successfully.",
"timeStamp": "1709711016152"
},
"collectionId": "7",
"eventType": "reportservice/report/delete",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_REPORTING_ADMIN"
],
"channel": "CSR"
}
}
DeleteReportProperty
Event Type: reportservice/reportproperty/delete
{
"version": "0",
"id": "627d39f5-0a4f-b528-6cad-f4d176e0bb37",
"detail-type": "reportservice/reportproperty/delete",
"source": "reportservice",
"account": "277827593990",
"time": "2024-03-06T07:42:19Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "9",
"timestamp": 1709710939849,
"payload": {
"code": "PROP_DELETED",
"report": {
"id": 9,
"collectionId": 6,
"name": "Externalevent",
"description": "Reports",
"reportProperties": [
],
"reportParams": [
],
"processorClassName": "",
"downloadable": false,
"createdBy": "1",
"createdTime": 1709710928000,
"updatedBy": "1",
"updatedTime": 1709710928000
}
},
"collectionId": "6",
"eventType": "reportservice/reportproperty/delete",
"userId": "1",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_REPORTING_ADMIN"
],
"channel": "CSR"
}
}
Internal Events via RabbitMQ/AWS MQ
The following events communicate with the internal microservices.
List of Events
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | Report Created | This event will be generated when a report is created | Topic: ReportMsgTopic | report.created | false | ReportPayload |
| 2 | Report Updated | This event will be generated when a report is updated | Topic: ReportMsgTopic | report.updated | false | ReportPayload |
Payload Model
ReportPayload
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
name | string | Indicates the name of the report. | REPORT_CREATED/REPORT_UPDATED |
report.reportId | long | Indicates the ID of the report, which is created or updated. | 123 |
report.name | string | Indicates the name of the report. | totalsale |
report.description | string | Indicates the description of the report. | Total sale report |
report.processorClassName | string | Indicates the class name of the custom report processor. | ReportClassName |
report.downloadable | boolean | Indicates whether the report is exportable type or not. | TRUE |
Revision History
2024-05-24 | SW – Added external event details for release 8.17.4.
2019-05-17 | AN – Updated to a new table tool.
2019-04-11 | MA – Page created and content uploaded.