Configuration Descriptor: Report Configuration
- DevaDarshini.S
This key contains the default properties that are applicable for report configuration in Sigma Application.
Config Key | Mandatory/ Optional | Type | Purpose |
|---|---|---|---|
REPORT_SENDER_MAIL_ID | Optional | String | This key is used to provide the report sender's email address. |
| REPORT_INST_DEF_FETCH_INTERVEL | Mandatory | String | This key indicates the defined instance of the report generation fetch interval. The report generation fetch interval indicates the required time interval to fetch the data of the report during its generation. |
| REPORT_STATUS_MONITOR_TIME_OUT | Optional | String | This key indicates the timeout monitoring of the report's generated status. |
| REPORT_DATA_FETCH_TIME_OUT | Optional | Number | This key indicates the timeout of the fetched data for a report. The data fetch timeout should be specified only in seconds and within the specified timeout period, the report should fetch the data to get generated in the Sigma Application and if suppose, the report is unable to fetch the data sets within the stipulated timeout period, then the report will eventually get failed, owing to a timeout error. You must specify the report data fetch timeout only in terms of seconds, for instance, if the timeout is specified as 180, it is indicated that the report data fetch timeout is 3 minutes. |
REPORT_GROUP_NAME | Mandatory | String | This key indicates the report group name. |
REPORT_TRIGGER_GROUP_NAME | Mandatory | String | This key indicates the report group trigger name. |
| REPORT_ARCHIEVED_PATH | Mandatory | String | This key indicates the archived path of the generated reports. |
| REPORT_FILE_NAME | Mandatory | String | This key indicates the report file name. |
REPORT_GROUP_ARCHIEVED_PATH | Mandatory | String | This key indicates the archived path of the generated report groups. |
REPORT_GROUP_FILE_NAME | Mandatory | String | This key indicates the report group file name. |
| Category: SVG Headless URL Configuration | |||
REPORT_SVG_HEADLESS_URL | Optional | String | This key indicates the Sigma Application URL, which needs to be specified as the SVG Headless URL to enable the usage of charts in reports. |
| DRIVER_FILE_NAME | Optional | String | This key indicates the driver file name of the browser, which is used to access the Sigma Application. |
| Category: User Role | |||
| DEFAULT_SIGMA_ROLE | Optional | String | This key is used to indicate the user roles to be assigned for the Sigma Application end users. The possible values are: SIGMAGRP and OP_READONLY. SIGMAGRP enables the users to gain the complete access of the Sigma Application while OP_READONLY allows the users only to view the generated and scheduled report instances. |
| Category: Automatic Trigger of Failed Reports | |||
AUTO_RETRY_FAILED_REPORTS | Optional | Boolean | This key is used to enable the automatic trigger of failed reports. Provide Y to enable the automatic trigger of failed reports, whereas specify N to disable the automatic trigger of failed reports. Reports that failed due to exceeding the system capacity are not included in the auto retry process. |
AUTO_RETRY_FAILED_REPORTS_AFTER | Optional | Number | This key is used to specify the time period from which the automatic trigger of failed reports will get enabled. The time period should be specified in the 24 hour time format. For instance, if you specify the time period as 18:30 (06:30 p.m.), then the automatic trigger of failed reports will get enabled, once the specified time period ends. After the specified time period elapses, the automatic trigger of failed reports will get enabled. |
| MAX_AUTO_RETRY_ALLOWED | Optional | Number | This key is used to specify the number of times for the failed report schedules to get automatically retried or retriggered. |
| MAX_RETRY_BATCH_SIZE | Optional | Integer | This key is used to specify the batch size for retriggering the failed report instances. For instance, if the batch size is specified as 100, then one hundred failed report instances will get retriggered. Hence, the maximum limit for the batch size is specified to retrigger and process the failed report instances. |
MAX_REPORT_EXECUTION_TIME_TO_FAIL | Optional | Number | This key is used to define the maximum execution time for the queued reports. For instance, if the value is specified as 1, then the queued reports will get automatically failed after the lapse of one hour. |
| KEEP_SCHEDULER_IN_STAND_BY_MODE | Optional | Boolean | This key is used to halt the report scheduling process. If the value of this key is specified as Y, then the report schedules will be on the standby mode, as all the report scheduling processes will get halted, whereas if the value of the key is specified as N, then all the report schedules will get triggered at the exact mentioned time on the basis of the provided schedule configurations. |
BURSTING_SCHEDULE_START_DELAY_TIME | Optional | Number | This key determines the start delay time before report-bursting executions begin. The value should be specified in seconds. The default setting is 10 seconds, but you can modify it or retain the same. |
| SCHEDULER_HEALTH_FAIL_THRESHOLD | Optional | Number | This key specifies a tolerable threshold to wait before restart of a scheduler that is not firing any schedules that are supposed to be fired. The value should be specified in minutes. The default setting is 10 minutes, but you can modify it or retain the same. |
The following is a sample logger configuration Sigmainforreportconfig.properties (as per the name given in the default descriptor):
REPORT_SENDER_MAIL_ID=mailreport@intellectdesign.com
REPORT_INST_DEF_FETCH_INTERVEL=3
REPORT_STATUS_MONITOR_TIME_OUT=${env.reportSubTaskTimeout}
REPORT_DATA_FETCH_TIME_OUT=${env.reportDataFetchTimeout}
REPORT_GROUP_NAME=canvas_reporting_group
REPORT_TRIGGER_GROUP_NAME=canvas_reporting_trigger
REPORT_ARCHIEVED_PATH=/InfoReport/Archived/CORPORATE_ID/USER_NUMBER
REPORT_FILE_NAME=REPORT_NAME+YEAR+MONTH2+DAY+HOURS+MINUTES+SECONDS
REPORT_GROUP_ARCHIEVED_PATH=/InfoReport/Archived/CORPORATE_ID/USER_NUMBER
REPORT_GROUP_FILE_NAME=REPORT_GROUP_NAME+YEAR+MONTH2+DAY+HOURS+MINUTES+SECONDS
REPORT_SVG_HEADLESS_URL=http://localhost:8082/sigma/CT_Report.html
#Window version of chromedriver
DRIVER_FILE_NAME=chromedriver.exe
# Linux version of chromedriver
#DRIVER_FILE_NAME=chromedriver
#AUTO_RETRY_FAILED_REPORTS holds whether the auto retry of failed report instances of current day is enabled or not
#It should be configured as Y / N
AUTO_RETRY_FAILED_REPORTS=${env.autoRetryFailedReports}
#AUTO_RETRY_FAILED_REPORTS_AFTER indicates the time in 24 hours format after which the failed reports
#should get picked for re execution. The value is in HH:mm format e.g 18:30 indicates to pick them after 6:30 pm
AUTO_RETRY_FAILED_REPORTS_AFTER=${env.autoRetryFaildReportsAfter}
#MAX_REPORT_EXECUTION_TIME_TO_FAIL is configured in hours to identify the long running reports. If the value is 2, then the reports
#running more than 2 hours will be considered as long running and system will automatically fail them.
MAX_REPORT_EXECUTION_TIME_TO_FAIL=${env.maxReportExecutionTimeToFail}
#Default user role which needs to be added for all the users logging into SIGMA application. The possible values are
#SIGMAGRP,OP_READONLY
DEFAULT_SIGMA_ROLE=NA
#This is constant holding the indicator whether to start the scheduler or keep it in stand by mode.
#MAX_AUTO_RETRY_ALLOWED holds the maximum no of auto retries should be performed after the specified time in case of failures.
MAX_AUTO_RETRY_ALLOWED=${env.maxAutoRetryAllowedPerReport}
#MAX_RETRY_BATCH_SIZE It contains an integer to specify batch size to be used to pick the retry report instances for processing
MAX_RETRY_BATCH_SIZE=${env.maxRetryBatchSize}
#If the scheduler is kept in stand by mode, then the scheduler temporarily halts the firing of triggers. Default value will be N
KEEP_SCHEDULER_IN_STAND_BY_MODE=${env.keepSchedulerInStandByMode}
#This is the amount of time that a bursting schedule for client / client criteria grp or value should be created with start time delay so that
#the schedule will fire without fail. The value should be specified in seconds
BURSTING_SCHEDULE_START_DELAY_TIME=${env.burstingScheduleStartDelayTime}
#This is the number specifying maximum threshold that an unhealthy scheduler can keep in the system. After this threashold
#the liveness probecheck will send fail command and the pod will be restarted. The value should be specified in minutes
SCHEDULER_HEALTH_FAIL_THRESHOLD=${env.schedulerHealthFailThreashold}