New functionalities to configure and generate reports

[pferrariuy]

Description

Generate the required endpoints for report configuration and report generation from the UI.

• [x] Report settings: will enable the user the posibility to determinate which reports should be send by email.
• [x] Report generation: will enable the user to select a report and a period of time and request the generation and send of the report by email.

Use Case

Use case set report settings

• Actor: User
• Description: User access Email settings functionality and can see the available reports for each location to which it has access.
• Precondition: User logged into the system and client / location / user are enabled to recevied reports
• Basic flow:
  1. User access the functionality
  2. A table with the locations (rows) and reports (columns) shows in the intersection a checkbox
  3. Checkbox that are selected are the report that the user will received for the location
  4. User clicks submit
  5. Values are saved in the database

Use case generate report

• Actor: User
• Description: User access Report generation, selects a report and a period of time
• Precondition: User logged into the system and client / location / user are enabled to recevied reports
• Basic flow:
  1. User access the functionality
  2. User selects the report (from a list of availabel options)
  3. User selects the period of time
  4. User clicks submit
  5. Email is send with the report

Expected Behavior

The selected terports by the user will be send to the user's email.

Implementation Suggestions

Report generation must be done in background / thread in order to avoid the use to keep waiting during the generation of the report.

Impact on Existing Features

None, feature is a new requeriment.

Related Issues

• https://github.com/Renovus-Tech/solarec-react/issues/23

[pferrariuy]

Endpoints and and payloads

GET /api/rest/report/configure

Payload: none Response:

{
    "reports": [
        {
            "id": 2,
            "title": "Weekly",
            "order": 1
        }
    ],
    "locations": [
        {
            "id": 20,
            "code": "a code",
            "name": "a name",
            "address": "an address",
            "state": "a state",
            "country": null,
            "typeOf": null,
            "latitude": -34
            "longitude": -56
            "outputCapacity": 27.0,
            "outputTotalCapacity": 27.0,
            "referenceDensity": null,
            "type": "solar",
            "gridConnected": true,
            "enabled": true,
            "demoDate": null,
            "dataDefinitionId": null,
            "dataDefinition": null,
            "stations": null,
            "generators": null,
            "sdgs": null
        }
    ],
    "settings": [
        {
            "locId": 20,
            "repId": 2,
            "selected": false
        }
    ],
    "loaded": true,
    "saved": false
}

POST /api/rest/report/configure

Payload:

{
    "settings": [
        {
            "locId": 20,
            "repId": 2,
            "selected": true
        }
    ]
}

Response:

{
    "reports": [
        {
            "id": 2,
            "title": "Weekly",
            "order": 1
        }
    ],
    "locations": [
        {
            "id": 20,
            "code": "a code",
            "name": "a name",
            "address": "an address",
            "state": "a state",
            "country": null,
            "typeOf": null,
            "latitude": -34
            "longitude": -56
            "outputCapacity": 27.0,
            "outputTotalCapacity": 27.0,
            "referenceDensity": null,
            "type": "solar",
            "gridConnected": true,
            "enabled": true,
            "demoDate": null,
            "dataDefinitionId": null,
            "dataDefinition": null,
            "stations": null,
            "generators": null,
            "sdgs": null
        }
    ],
    "settings": [
        {
            "locId": 20,
            "repId": 2,
            "selected": false
        }
    ],
    "loaded": true,
    "saved": false
}

GET /api/rest/report/generate

Payload: none Response:

{
    "reports": [
        {
            "id": 2,
            "name": "WEEKLY",
            "title": "Weekly",
            "requires": "week"
        }
    ]
}

POST /api/rest/report/generate

Payload:

{
    "location": "20",
    "report": {
        "id": "2",
        "values": [
            "2024-08-12"
        ]
    }
}

Response:

{
    "report": {
        "id": 2,
        "name": "WEEKLY",
        "title": "Weekly",
        "requires": "week",
        "values": [
            "2024-08-12"
        ]
    },
    "generated": true,
    "willSendTo": "user_email@domain.com"
}