ETL Developers' Guide - Application Configuration

MinimumLogLevel

Verbose, Debug, Information, Warning, Error, Fatal

Sets the logging level for the ETL. Performance may be adversely affected when the logging level is set to "Verbose", so this setting should only be used for active troubleshooting. The default setting is "Information".

Example:

EnableConsoleLogging

boolean

Shows log output in the console.

Example:

SqlQueryCommandTimeout

int

Sets the SQL query command timeout. Specified in seconds.

Example:

DailyAttendanceCalculationSource 

Both, School, Section

For Daily Attendance Rate calculations, this setting determines which method below is used.

• If the flag is set to "School", then Daily Attendance is used.

• If the flag is set to "Section", then Section Attendance is used.

• If the flag is set to "Both" (which is the default), then both are used. In the case of a student having both, priority is given to Daily Attendance.

Example:

ReportingPeriodLastXDays

int

For attendance calculations, this setting provides the range of instructional days upon which to perform the metric calculation. For example, a reporting period of four weeks is 20 instructional days.

Example:

ReportingPeriodLastYDays

int

For attendance calculations, this setting provides range of instructional days to perform the metric calculation. For example, a reporting period of eight weeks is 40 instructional days.

Example:

APScoreMasteryLevel

int

For student advanced course mastery calculations, this setting provides the threshold for AP score mastery.

Example:

IBScoreMasteryLevel

int

For student advanced course mastery calculations, this setting provides the threshold for IB score mastery.

Example:

DaysNeededForLateEnrollment

int

For student information calculations, this setting provides the number of calendar days after which a student is considered for late enrollment.

Example:

RunOnlyYearEndSnapshot

boolean

If set to true, the ETL will roll over the end-of-year metric calculations from the DDS to the DDW. The ETL will not re-calculate metrics in the DDS prior to the rollover.

Example:

IncludeWithdrawnStudents

boolean

When true, students who have withdrawn from school or are not enrolled will be processed normally. If false, students not enrolled in school will be excluded from output and metric calculations. The default is true.

Example:

ExcludeExtensionList

Names of metric extensions (e.g., StudentAttendance, StudentCourseGrades)

Comma-separated list of container metric projects to exclude from the ETL execution. Commonly used to debug.

Example:

CacheAllQueries

boolean

Caches streamed objects in bus. Commonly used for debugging the ETL but may also be necessary if dealing with large datasets to avoid timeouts.

Example:

DryRun

boolean

When DryRun is true the ETL does not write to the output databases. Commonly used for debugging the ETL.

Example:

UseFileBuffer

boolean

When the streamed data reaches the BulkCopyBufferSizeMax, the data in the buffer will be written to a file, to free up memory. The file will be read into SQL Server using SQL Bulk Copy.

This feature is useful when dealing with large datasets (i.e., 250K+ students).

Example:

FileBufferLocation

Path to folder (e.g., C:\Windows\Temp)

When UseFileBuffer is true, FileBufferLocation specifies the directory into which the file will be written. SQL Server must have permissions to read the directory. The ETL application must have permissions to write to the directory.

The disk containing the directory must be able to store the amount of data being buffered to the server, which depends on the amount of data in the ODS. The storage requirements listed in the ETL Developers' Guide - Overview should be sufficient for this process.

Example:

CalculateDailyHistoricalAttendance

boolean

Determines if daily historical attendance calculations are performed. Daily historical attendance is a time-consuming process, so the feature can be turned off. However, the historical graph for attendance will not show the daily period link.

Example:

RebuildHistoricalCalculations

boolean

When true, the ETL will recalculate historicals for all time periods in the current school year. When false, the ETL will only calculate historical metrics for time periods that have not been completed previously.

Example:

SessionTraceFlags

Comma-separated list of ints

Turns on SQL Server trace flags for executed queries.

Example:

DashboardLink

string

Used for advanced linked server configurations only: for most configurations, this option should be left as default, which is empty.

Linked server name for the instance containing the Dashboard.

For users with a linked server configuration where the Data Warehouse and Dashboard exist on different instances, ensure that the Data Warehouse has a linked server configured by this name with access to the Dashboard.

Example:

OdsLink

string

Used for advanced linked server configurations only. For most configurations, this option should be left as default, which is empty.

Linked server name for the instance containing the ODS.

For users with a linked server configuration where the Data Warehouse and ODS exist on different instances, ensure that the Data Warehouse has a linked server configured by this name with access to the ODS.

Example: