Creating custom alert icons
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 in the Synergetic System maintenance manual.
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 from the Synergetic main menu.
The Configuration File Maintenance window is displayed. - Find Icon.
The CustomIcon 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:
|
2 | CustomIcon. |
3 | Number of the custom icon, from 1 to 5. Note: You can have up to five icons per maintenance window. Custom icons for the same maintenance window must not have the same number. |
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. Note: If the custom icon uses an SQL function, this key is overridden. |
5 | Not used. |
Type | STR. |
Value | Full file path of the image to be used as the icon. For example: |
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 from the Synergetic main menu.
The Configuration File Maintenance window is displayed. - Find Icon.
The CustomIcon 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:
|
2 | CustomIcon. |
3 | Number of the custom icon, from 1 to 5. Note: You can have up to five icons per maintenance window. Custom icons for the same maintenance window must not have the same number. |
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. Note: If the custom icon uses an SQL function, this key is overridden. |
5 | Not used. |
Type | STR. |
Value | Full file path of the image to be used as the icon, and the SQL function to control whether or not the icon is displayed, separated by two pipe characters (||). For example: SELECT dbo.ufnIsUnder18(:@ID)* tells Synergetic to:
|
Creating a custom icon linked to a navigation bar
You can create custom icons that open the relevant navigation bar when clicked. To create custom icons linked to a navigation bar:
- Select Module > System > Configuration File Maintenance from the Synergetic main menu.
The Configuration File Maintenance window is displayed. - Find Icon.
The CustomIcon 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:
|
2 | CustomIcon. |
3 | Number of the custom icon, from 1 to 5. Note: You can have up to five icons per maintenance window. Custom icons for the same maintenance window must not have the same number. |
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. Note: If the custom icon uses an SQL function, this key is overridden. |
5 | Not used. |
Type | STR. |
Value | Type the information in the following order, each separated by a pipe (|) character:
Note: Do not add spaces or extra characters such as commas or periods.
|