Previous icon

Next icon

Maintaining custom maintenance window icons

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

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

Staff Maintenance - Custom icons

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

Attendance window - Alerts field (cutdown for wn)

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:

  1. Select Module > System > Configuration File Maintenance.

    The Configuration File Maintenance window is displayed.

  2. Find Icon.

    The CustomIcon configuration settings are displayed.

    Configuration File Maintenance - Custom Icons

  3. Select the configuration setting you want to edit, or click Add button to create a new one.
  4. Type in the keys from the table below.

Key

Description

1

Maintenance window the custom icon appears on. Values include:

  • StudentMaint
  • StaffMaint
  • CommunityMaint
  • FutureStudentMaint
  • PastStudentMaint.

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:

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:

  1. Select Module > System > Configuration File Maintenance.

    The Configuration File Maintenance window is displayed.

  2. Find Icon.

    The CustomIcon configuration settings are displayed.

    Configuration File Maintenance - Custom Icons

  3. Select the configuration setting you want to edit, or click Add button to create a new one.
  4. Type in the keys from the table below.

Key

Description

1

Maintenance window the custom icon appears on. Values include:

  • StudentMaint
  • StaffMaint
  • CommunityMaint
  • FutureStudentMaint
  • PastStudentMaint.

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:

i:\images\assorted\pin.bmp || SELECT dbo.ufnIsUnder18(:@ID) tells Synergetic to:

  • use the pin.bmp image in the images\assorted\ directory for the icon
  • use the value returned by the SQL function ufnIsUnder18 to determine whether or not the icon displays
  • 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.

Last modified: 29/09/2014 1:59:30 PM

See Also

Configuring Custom Icons

Creating custom icon images for SynWeb

© 2015 Synergetic Management Systems. Published 5 March 2015.

Top of page