Maintaining custom maintenance window icons

Modified on Sun, 19 Apr at 11:55 PM

You can use custom icons to display important information at all times on a maintenance window. Custom icons are linked to either:

a field within the program
an SQL function.

You can display up to ten custom icons in a maintenance window.

Custom icons are also displayed in the Attendance window. See IconAlertsDisplay configuration setting.

Creating a custom icon linked to a field
To create or edit a custom icon that is linked to a field in the maintenance window:

Select Module > System > Configuration File Maintenance.
The Configuration File Maintenance window is displayed.
Type Icon in the Find field.
The Custom Icon configuration settings are displayed.
Select the configuration setting you want to edit, or click to create a new one.
Type in the keys from the table below.

Key	Description
1	Maintenance window the custom icon appears on. Values include: CommunityMaint FutureStudentMaint PastStudentMaint StaffMaint StudentMaint StudentMedicalMaint.
2	CustomIcon.
3	Number of the custom icon, from 1 to 10. Note: You can have up to ten icons per maintenance window, including any standard alert icons. Custom icons for the same maintenance window must not have the same number. Tip: Prioritise your most commonly used icons by giving them a lower number. If you have more than ten icons for the one maintenance window, only the first ten are displayed.
4	Name of the checkbox the custom icon connects to. For example: Staff.ActiveFlag connects to the Active Staff Member checkbox on the School tab of Staff Maintenance.
5	Not used.
Type	STR.
Value	Full file path of the image to be used as the icon. For example: i:\images\assorted\pin.bmp tells Synergetic to use the pin.bmp file in the images\assorted directory for the icon.

Creating a custom icon linked to an SQL function
To create or edit a custom icon linked to an SQL function:

Select Module > System > Configuration File Maintenance.
The Configuration File Maintenance window is displayed.
Type Icon in the Find field.
The Custom Icon configuration settings are displayed.
Select the configuration setting you want to edit, or click to create a new one.
Type in the keys from the table below.

Key	Description
1	Maintenance window the custom icon appears on. Values include: CommunityMaint FutureStudentMaint PastStudentMaint StaffMaint StudentMaint StudentMedicalMaint.
2	CustomIcon.
3	Number of the custom icon, from 1 to 10. Note: You can have up to ten icons per maintenance window, including any standard alert icons. Custom icons for the same maintenance window must not have the same number. Tip: Prioritise your most commonly used icons by giving them a lower number. If you have more than ten icons for the one maintenance window, only the first ten are displayed.
4	Name of the checkbox the custom icon connects to. For example: Staff.ActiveFlag connects to the Active Staff Member checkbox on the School tab of Staff Maintenance.
5	Not used.
Type	STR.
Value	Values for the: full file path of the image to be used as the icon tip to be displayed when the cursor is on the icon SQL function to control whether or not the icon is displayed name of the tab to be displayed when the user clicks the icon warning beep, if Synergetic should beep when the icon is displayed. These values must be separated by pipe characters (\|). Tip: If you leave any values blank, enter the same number of pipe characters ( \| ) as if they were filled. For example: i:\images\assorted\pin.bmp \| Student is under 18yrs \| SELECT dbo.ufnIsUnder18(:@ID) \| Personal \| WarningBeep tells Synergetic to: use the pin.bmp image in the images\assorted directory for the icon display the text Student is under 18yrs when the cursor is hovered over the icon use the value returned by the SQL function ufnIsUnder18 to determine whether or not the icon displays and pass the Synergetic ID of the community member whose maintenance screen is open as a parameter to the SQL function Note: The SQL function must be a stored function that returns either 1 or 0. open the community member's Personal tab in the maintenance screen when the user clicks the icon beep when the icon is displayed for the selected community member.