AcademicYearOffset
Use this configuration to set the Academic Year definition of an educational institution in the Date dimensions of the Datawarehouse. The AcademicYearOffset value is the month offset from January to the beginning of the Academic Year month. For example, if the Academic year begins with September, the AcademicYearOffset value is 8 (calculated as Begin Month Number minus 1). By default, the value of AcademicYearOffset value is set to 8 in the configuration table when the Analytics Datawarehouse is installed. The AcademicYearOffset value must be set correctly based on the Academic Year definition of an educational institution after the Analytics Datawarehouse installation or upgrade (Post Installation steps).
To change the AcademicYearOffset value and update the Date dimensions records, execute the below script on the Datawarehouse database. The script can also be executed after running the “StudentAnalytics <datawarehouse database name> Initial Load” SQL Server job.
Along with configuring Academic Year offset, configure the “Months in Academic Year Semesters”. The default configuration is 2 semesters in an Academic Year and each semester will be of 6 months. If the educational institution has unequal semesters, use the below configurations to set the semesters in the Academic year. Up to three semesters can be configured for an Academic Year. For example, if the academic year has 3 semesters where the first semester is of 5 months, second semester is of 4 months and third semester is of 3 months, then set the MonthsInFirstAcademicYearSemester value to 5, MonthsInSecondAcademicYearSemester value to 4 and MonthsInThirdAcademicYearSemester value to 3.
Please note that the sum of months in all semesters should be 12. Value 0 for MonthsInThirdAcademicYearSemester indicates that there is no third semester. The intermediate semester cannot be skipped.
DECLARE @ConfigKey NVARCHAR(255) = '' ,@ConfigValue NVARCHAR(255) = '' --AcademicYearOffset SET @ConfigKey = 'AcademicYearOffset' SET @ConfigValue = '8' ---<<Change value in quotes>> UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey --MonthsInFirstAcademicYearSemester SET @ConfigKey = 'MonthsInFirstAcademicYearSemester' SET @ConfigValue = '6' ---<<Change value in quotes>> UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey --MonthsInSecondAcademicYearSemester SET @ConfigKey = 'MonthsInSecondAcademicYearSemester' SET @ConfigValue = '6' ---<<Change value in quotes>> UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey --MonthsInThirdAcademicYearSemester SET @ConfigKey = 'MonthsInThirdAcademicYearSemester' SET @ConfigValue = '0' ---<<Change value in quotes>> UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey EXEC [dbo].[usp_UpdateDimDate] GO
FiscalPeriodMonthOffset
Use this configuration to set the Fiscal Period definition of an educational institution in the Date dimensions of the Datawarehouse. The FiscalPeriodMonthOffset value is the month offset from January to the beginning of the Fiscal Year month. For example, if the Fiscal year begins with July, the FiscalPeriodMonthOffset value is 6 (calculated as Begin Month Number minus 1). By default, the value of FiscalPeriodMonthOffset value is set to 6 in the configuration table when the Analytics Datawarehouse is installed. FiscalPeriodMonthOffset value must be set correctly based on the Fiscal Year definition of an educational institution after the Analytics datawarehouse installation or upgrade (Post Installation steps).
To change the FiscalPeriodMonthOffset value and update the Date dimensions records, execute the below script on the Datawarehouse database. The script can also be executed after running the “StudentAnalytics <data warehouse database name> Initial Load” SQL Server job.
DECLARE @ConfigKey NVARCHAR(255) = 'FiscalPeriodMonthOffset' ,@ConfigValue NVARCHAR(255) = '6' ---<<Change value in quotes UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey EXEC [dbo].[usp_UpdateDimDate] GO
CleanupRetentionDays
Use this configuration to set the retention period that identifies the duration of time for which the data in the staging (*_CT) tables should be maintained for any troubleshooting or verification purposes, before it is deleted.
Suppose the institution decides to store the staging data for 2 days, the CleanupRetentionDays value would be set to 2. Any staging data that is older than 2 days will be will be deleted when the StudentAnalytics <data warehouse database name> Cleanup SQL Server job is run.
The default value of CleanupRetentionDays key is 2. To change the CleanupRetentionDays value, execute the below script on the Datawarehouse database.
DECLARE @ConfigKey NVARCHAR(255) = 'CleanupRetentionDays' ,@ConfigValue NVARCHAR(255) = '2' ---<<Change value here UPDATE [core].[Configuration] SET ConfigValue = @ConfigValue WHERE ConfigKey = @ConfigKey
