Settings

EdWard Settings File

The settings file is a crucial part of configuring EdWard to align with your environment. This document will explain the key sections of the settings file, including locale configuration, the release/model settings, and how the mapping system works to connect your Decisively rules with EdWard's UI elements.

Structure of the Settings File

The settings file follows a JSON format and contains several important sections:

{
  "locale": {
    "fullDate": "dd/MM/yyyy",
    "fullDateTime": "yyyy-MM-dd HH:mm:ss",
    "shortDate": "EEE, dd MMM"
  },
  "mapping": {
    // Various mapping settings
  },
  "release": "GUID", // The Decisively release to use. Blank if it will simply use the most current version in your environment
  "model": "GUID" // The Decisively model/project that contains your rule base
}

Locale Configuration

The locale section controls how dates are formatted in EdWard. We use the date-fn library to handle date formatting, which means the formatting standards follow the date-fn conventions.

Date Formats:

• fullDate: Controls the full date display. For example, dd/MM/yyyy would display the date as 12/04/2025.
• fullDateTime: Controls the full date-time display, including hours, minutes, and seconds. For example, yyyy-MM-dd HH:mm:ss would display 2025-04-12 14:45:30.
• shortDate: Controls the short date display. For example, EEE, dd MMM would display Sat, 12 Apr.

These settings allow you to adjust how dates are presented across EdWard, ensuring consistency with regional or organizational standards.

info

Note: data within EdWard is stored in ISO format in UTC timestamps regardless of the formatting you select. Formatting only effects display within the UI. Your API calls will return in the form YYYY-MM-DDTHH:mm:ssZ

Release and Model Configuration

The release and model settings dictate which Decisively rule base is used in EdWard. These values are pulled from Decisively and specify the exact release version and project model that EdWard will operate with.

• Release: The GUID for the specific Decisively release to use. If left blank, EdWard will automatically use the most current version in your environment.
• Model: The GUID for the Decisively model or project that contains the rule base. This is critical for ensuring EdWard is using the correct rules for decision-making processes.

Both of these settings are essential for ensuring that EdWard is connected to the right rule base and operates within the correct context.

Mapping Configuration

The mapping section is where you define how the rules within your Decisively model map to the UI elements shown in EdWard. This section allows you to configure the connection between the backend rules (stored as GUIDs) and the shorthand terms used in the UI.

Each entity within the Decisively model has a corresponding GUID for each rule attribute, and these GUIDs are mapped to short-hand terms that are used in the underlying code to display the relevant data in EdWard.

Mapping Table

Below is a table where you can explain what each shorthand term does and where it is displayed within EdWard. Please update this table as needed for your configuration.

Entity	Name	Description
global	start	The start of the timesheet period. Displayed in multiple locations across the UI
global	end	The end of the timesheet period. Displayed in multiple locations across the UI
global	name	The employee's name
global	mealAllowance	The total meal allowance. Displayed on timesheet summaries
global	toilAccrued	The total amount of TOIL accrued during the period. Displayed on timesheet summaries
global	ordinaryHours	The total ordinary hours for the period. Displayed on timesheet summaries
global	totalHours	The total hours (ordinary + others) for the period. Displayed on timesheet summaries
global	travelTime	The total travel time for the period. Displayed on timesheet summaries
global	leaveTaken	The total amount of leave taken during the period. Displayed on timesheet summaries
global	paidOrdinaryHours	The total amount of ordinary hours that should be paid. Displayed on timesheet summaries
global	academicHours	The total amount of academic hours (if applicable) for an employee. Displayed on timesheet summaries
global	totalPublicHolidayHours	The total amount of hours worked during a public holiday. Displayed on timesheet summaries
employees	mealAllowanceByDay	A temporal value of the meal allowance by day. Used to determine meal allowance for timesheet entry display
employees	restPauses	The number of rest pauses an employee is entitled to
employees	employeeTotalHoursInSpan	The total amount of hours worked during the employee's span of hours
employees	academicUnits	The academic units assigned to an employee (if applicable)
employees	employeeIsWorkingOvertime	Indicates if the employee is working overtime
employees	employeeIsSessional	Indicates if the employee is a sessional worker
employees	employeeTotalHours	The total hours worked by the employee for the specified period
employees	employeeOvertimeHours	The total number of overtime hours worked by the employee
employees	employeeLeaveHours	The total number of leave hours taken by the employee
employees	employeeTravelHours	The total number of travel hours worked by the employee
employees	employeePublicHolidayHours	The total number of hours worked on public holidays by the employee
employees	employeeTotalPublicHolidayHours	The total number of public holiday hours worked by the employee
roles	roleLevel	The level of the role assigned to the employee
roles	roleIsSessional	Indicates if the role is sessional
roles	roleIsProfessional	Indicates if the role is a professional role
role_positions	positionOrdinaryHours	The ordinary hours assigned to the role/position
role_positions	positionAcademicHours	The academic hours assigned to the role/position
role_positions	positionAcademicUnits	The academic units assigned to the role/position
role_positions	positionTravelTime	The travel time assigned to the role/position
role_positions	positionLeaveTaken	The leave taken assigned to the role/position
role_positions	positionPaidOrdinaryHours	The paid ordinary hours assigned to the role/position
role_positions	positionOvertimeHours	The overtime hours assigned to the role/position
role_positions	positionOvertimePaid	The overtime paid assigned to the role/position
role_positions	positionToilAccrued	The accrued TOIL assigned to the role/position
role_positions	positionPenaltiesHours	The penalties hours assigned to the role/position
role_positions	positionOnCallAllowance	The on-call allowance assigned to the role/position
role_positions	positionTitle	The job title assigned to the role/position
role_positions	positionHasPenalty	Indicates if the role has associated penalties
role_positions	positionPublicHolidays	The public holiday hours assigned to the role/position
role_positions	positionTotalHours	The total hours assigned to the role/position
timesheets	status	The status of the timesheet
timesheet_workdays	onCallForDay	Indicates whether the employee is on-call for a particular day
timesheet_work_periods	start	The start of the work period
timesheet_work_periods	end	The end of the work period
timesheet_work_periods	status	The status of the work period
timesheet_work_periods	type	The type of the work period (e.g., regular, overtime)
timesheet_work_periods	leave	The leave type for the work period
timesheet_work_periods	academicHours	The academic hours for the work period
timesheet_work_periods	jobNumber	The job number associated with the work period
timesheet_work_periods	units	The units worked for the work period
timesheet_work_periods	comment	Additional comments for the work period
timesheet_work_periods	callBack	Indicates if a callback was made during the work period
timesheet_work_periods	workFromHome	Indicates if the work was done from home
timesheet_work_periods	overtime	Indicates overtime worked during the period
timesheet_work_periods	toilAccrued	Indicates the TOIL accrued during the work period
timesheet_work_periods	publicHoliday	Indicates if the work period falls on a public holiday
timesheet_work_periods	minEngagement	The minimum engagement for the work period
timesheet_work_periods	isLeave	Indicates if the work period was a leave period
timesheet_work_periods	sessionalType	The type of sessional work for the period
timesheet_work_periods	penaltyAmount	The penalty amount applied during the work period
timesheet_work_periods	penaltyRate	The penalty rate applied during the work period
timesheet_work_periods	overtimeRate	The overtime rate applied during the work period
timesheet_work_periods	toilRate	The TOIL rate applied during the work period
timesheet_work_periods	publicHolidayRate	The public holiday rate applied during the work period
timesheet_work_periods	periodTotalHours	The total hours worked during the period
timesheet_work_periods	periodOrdinaryHours	The total ordinary hours worked during the period
timesheet_work_periods	periodOvertime	The total overtime hours worked during the period
timesheet_work_periods	overtimeApproved	Indicates if the overtime was approved for the period
timesheet_work_periods	overtimeJustification	The justification for overtime worked during the period
timesheet_work_periods	isCasual	Indicates if the employee is working as a casual during the period
on_call_arrangements	onCallStart	The start time for the on-call arrangement
on_call_arrangements	onCallEnd	The end time for the on-call arrangement
on_call_arrangements	onCallSaturday	Indicates if the employee is on call on Saturday
on_call_arrangements	onCallSunday	Indicates if the employee is on call on Sunday
timesheet_work_breaks	start	The start time for the work break
timesheet_work_breaks	end	The end time for the work break