Report Management

1 Pre-Requisite
- 1.1 Steps to Configure Report:
- 1.2 Report Actions Walkthrough:

Pre-Requisite

Create KPI, Content and Report Template from UI. (Refer https://onedevops.atlassian.net/wiki/spaces/OI/pages/edit-v2/2548170757?draftShareId=23f22afb-1abe-4406-a3d8-5503e1f2913b and https://onedevops.atlassian.net/wiki/spaces/OI/pages/2549743647 )
Setup Workflow by following steps mentioned in https://onedevops.atlassian.net/wiki/spaces/OI/pages/1476460548
Add required workflow type in table INSIGHTS_WORKFLOW_TYPE
- Do manual entry into DB as id: 1 and type as: <workflow type name>.
Add required workflow task from UI. (Refer )
Update SMTP configuration details in server-config.json to use Email task. (Refer )
Only Admin and Editor user can access this functionality.
Update "maxWorkflowRetries" in server-config.json. This is an integer number which refers to how many times workflow should retry in case of report failures. The recommend value is 3.
Permission required for folder $INSIGHTS_HOME/assessmentReportPdfTemplate. This folder is used for PDF task.
Insights supports Neo4j database for this functionality.

{  

"description": "REPORT_KPI_Execute",  

"mqChannel": "WORKFLOW.TASK.KPI.EXCECUTION",  

"componentName": "com.cognizant.devops.platformreports.assessment.core.ReportKPISubscriber",  

"dependency": 1,  

"workflowType": "Report"  

} 

{  

"description": "REPORT_PDF_Execute",  

"mqChannel": "WORKFLOW.TASK.PDF.EXCECUTION",  

"componentName": "com.cognizant.devops.platformreports.assessment.core.PDFExecutionSubscriber",  

"dependency": 2,  

"workflowType": "Report"  

}

{  

"description": "REPORT_EMAIL_Execute",  

"mqChannel": "WORKFLOW.TASK.EMAIL.EXCECUTION",  

"componentName": "com.cognizant.devops.platformreports.assessment.core.ReportEmailSubscriber",  

"dependency": 3,  

"workflowType": "Report"  

}

Steps to Configure Report:

Navigate to Report Management, existing reports are listed here. To create a new report, click on Add(+) icon.
Fill all required details.
- Report Name: Input a unique report name (can contain alphanumeric characters and underscore).
- Report Title: Provide report title which is used as a display name in visualization.
- Report Template: Drop down to select available report template.
  - Once template is selected then click on View button to see list of KPI’s attached to selected report template.
- Frequency: Select appropriate frequency (Refer Workflow frequency section for detail info).
- Reoccurrence: A boolean flag to keep report executing on defined frequency.(Optional configuration by default it is false)
- Add Task: Click on Add(+) icon and select task in correct sequence as below.
- Drag available task from left side and drop into right side.
- Shuffle selected task on the right hand side to define sequence.
If email task is selected then then user needs to fill necessary mailing details as below.
Click on Add(+) button to fill mailing details.
User can add and remove selected task by clicking add / remove button as highlighted below.
Select data source from dropdown, this is basically input data source from which data is read. Although this is optional configuration.
- Click on Save button on right top corner to save report.
- Once report is created then user is redirected to landing page where user can see details on created reports.
When user creates GRAFANAPDF report with PDF task and clicks on Save button then a preview of saved dashboard will be shown. Using this dashboard, PDF will be generated.

Report Actions Walkthrough:

Edit the report by clicking Edit button as shown above. In edit section only modifying task, reoccurrence flag, mailing details is allowed. For GRAFANAPDF reports task modification in edit section is not allowed.
Deletion of report is allowed if it does not have any execution history. If it has execution history then report cannot be deleted until it completes 100 days.
Mark any NOT_STARTED / RESTART / TASK_INITILIZE _ERROR report to run immediate in turn which is picked by workflow immediate job scheduler.
Restart any ABORTED state report to run again, report is turned into ABORTED state when any report has crossed its maxretrycount. In such cases it is possible to select those reports in ABORTED state and Restart them after fixing possible issues.
Download PDF button gets enabled for the report which completes its execution at least once, for the reports which are in ERROR state but has completed at least once execution successfully the PDF gets downloaded for that execution. For the reports those are completed their execution without any errors and in COMPLETED state, latest PDF gets downloaded for such reports.
Refresh the landing page.
Activate / Deactivate report whenever required.
It shows detailed execution history of the each task execution of selected report.