Previous icon

Next icon

Configuration File Maintenance window

Use the Configuration File Maintenance window to:

Opening the Configuration File Maintenance window

Configuration File Maintenance window key fields and buttons

Configuration File Maintenance (fields and buttons)

Fields

Field

Description

Find

Type one or more characters that match those in:

  • one of the keys
  • the Value field, if Include Value Field in Search is selected.

The results are refined and displayed as each character is typed.

Include Value Field in Search

Select to include the Value field in the search.

Clear the field to find corresponding characters in the key fields only.

Comment

Included by the Synergetic Management Systems developers and/or support staff to assist people with updating the highlighted configuration setting.

If you cannot see all the comments, you can:

  • use the scroll bar to display comments further down
  • drag the bottom of the Configuration File Maintenance window, if possible.

Configuration File Maintenance window (drag arrow)

Show SelectionHistory Key

Some program selections are recorded here, such as timetable import, so they do not need changing next time the program is loaded.

Note: You would not normally need to modify this setting, as this is used by Synergetic internally to recall the user's previous selections.

Show User Key

Settings to recall the saved form size and position.

Note: You would not normally need to modify this setting, as this is used by Synergetic internally to recall the user's previous selections.

Show Tabs Key

Customised tab layouts for the user.

Note: You would not normally need to modify this setting, as this is used by Synergetic internally to recall the user's previous selections.

Key 1

First key used for identifying a configuration setting.

Configuration File Maintenance window (Key 1)

Generally either:

  • a system wide setting (System)
  • a Synergetic module or function, such as Staff Maintenance (StaffMaint)
  • other software, such as:
    • Community Portal (CommunityPortal)
    • Crystal Reports (CrystalReports).
  • interaction with an external system (ExternalSystem), such as exporting data to the New Zealand Ministry of Education (NZMOE).

Key 2 /

Key 3 /

Key 4 /

Key 5

Remaining part of the identifying keys for a configuration setting.

Configuration File Maintenance window (Key 1)Configuration File Maintenance window (Keys 2-5)

The number of keys used depends on the unique configuration settings required.

Field

Description

Type

 

Type of value used for the configuration setting:

Type

Description

STR

String value using alphanumeric characters.

Note: Use the Memo button button to edit long strings or add formatting characters, such as carriage return/line feed. See Updating string values using the memo button in the Synergetic System maintenance manual.

INT

Integer value used. That is, 1, 2, 3, 4... ...n.

BIT

True or False value.

Represented as either a selected value or a cleared flag. See True or False (BIT) examples below.

DAT

Date value.

Value

 

The value of the configuration setting.

The allowable value depends on the Type of value set:

Type

Further information

STR

Value consists of a string of alphanumeric characters.

It can also include:

  • characters used for formatting
  • Synergetic fields with brackets used for merging values from the Synergetic database. For example, {ClassDescription}.

BIT

The BIT type is displayed as a check box. Either:

  • select the Value check box to set the value to True
  • clear the Value check box to set the value to False.

See True or False (BIT) examples below.

DAT

The DAT date type is entered as dd/mm/yyyy format where:

  • dd is the day of the date
  • mm is the month of the date
  • yyyy is the year of the date.

For example, 25/07/2016.

Default

The default value of the configuration setting.

Tip: You can enter default configuration setting values for your organisation by typing the value into the Default field and clicking Save button (configuration file maintenance).

The allowable value depends on the Type of value set.

Note: The Type for the Default field is the same as for the Value field.

Buttons

Button

Description

Comment... button

Click to enter additional information about the highlighted configuration setting.

Edit Comment window

Tip: You can use the Copy To Clipboad button button to copy the comment to the clipboard for later use.

The comment added is displayed in the left-hand pane with any existing CDA comments.

Configuration File Maintenance window (example of comment and CDA comment)

Memo button

Click to display and edit string values for the Value or Default fields that are either:

  • too long to display in the field
  • include formatting characters, such as carriage return/line feed characters.

See Updating string values using the memo button in the Synergetic System maintenance manual.

Note: The Memo button button is only displayed for string (STR) values.

First record button

Go to the first configuration setting.

Previous record button

Go to the previous configuration setting.

Next record button

Go to the next configuration setting.

Last record button

Go to the last configuration setting.

Add button

Add a new configuration setting.

This inserts a new blank record at the end of the configuration settings.

Type the key values for the configuration, the type of setting, the value for the setting and any comments.

Tip: Click Undo button if you need to undo the new setting.

Add (copy) button

Add a new configuration setting, using values from the highlighted configuration setting.

This inserts a new record immediately after the configuration setting that has just been copied.

Update the key values for the configuration, the type of setting, the value for the setting and any comments.

Save button (configuration file maintenance)

Save the changes made to the current configuration setting.

Undo button

Undo the:

  • new record added
  • changes made to the current configuration setting.

Delete button

Delete the current configuration setting.

The following confirmation message is displayed.

Confirm - About to Delete Config Record

Note: Deleting existing records can cause some functions within Synergetic to perform incorrectly. Unless advised by Synergetic support staff you should not need to delete any settings.

Apply Default button

Overwrite the existing value with the default value for your organisation set in the Default field.

True or False (BIT) examples

The BIT type is used to represent True or False values.

Note: The word BIT is derived from the computing term which denotes one bit which can have a value of 1 or 0 used to represent True or False (Boolean) values, respectively.

In the first example below, the Value field for the highlighted configuration setting has been selected. This is displayed on the grid as True.

configuration file maintenance - example of true bit value

In the second example below, the Value field for the highlighted configuration setting has been cleared. This is displayed on the grid as False.

configuration file maintenance - example of false bit value

Last modified: 20/12/2016 5:04:34 PM

See Also

Maintaining configuration files

SES parent extraction settings

© 2017 Synergetic Management Systems. Published 20 July 2017.

Top of page