Description of the EntraGuardConfig.xml file - Synergis™ Softwire 10.11

Synergis™ Softwire 10.11 Integration Guide for Keri EntraGuard Systems

Applies to
Synergis™ Softwire 10.11
Last updated
2021-11-26
Content type
Guides > Integration guides
Language
English (United States)
Product
Synergis™ Softwire
Version
10.11

The EntraGuardConfig.xml file is where you define the phone commands and the welcome banner displayed on the EntraGuard LCD screen.

Sample EntraGuardConfig.xml file

Telephone commands

The telephone commands are defined as attributes of the <EG … > tag.

The values you can change are:

  • DoorOpenTimeout="n". Time the message "Please enter" is displayed on the LCD after the tenant sends the door unlock command to EntraGuard (default = 7 seconds).
  • ConnectionTime="n". Time the message "Resident Disconnect" is displayed on the LCD after the tenant disconnects from EntraGuard (default = 120 seconds).
    NOTE: The value of this parameter must be equal or greater than 10 seconds.
  • TeletoneUnlockA="d". The number the tenant must dial on the phone to unlock the door (default = 9).
  • TeletoneDisconnect="d". The number the tenant must dial on the phone to disconnect the call (default = 7).
  • DirectoryCodeLength="n". The expected number of digits for the Directory Code (default = 5).

Welcome banner

The welcome banner is defined as three pages with four lines of text each. Each line can be up to 12 characters long. The banner syntax is as follows:


<Banners>
    <Screen1>
        <String>Page1 Line1</String>
        <String>Page1 Line2</String>
        <String>Page1 Line3</String>
        <String>Page1 Line4</String>
    </Screen1>
    <Screen2>
        <String>Page2 Line1</String>
        <String>Page2 Line2</String>
        <String>Page2 Line3</String>
        <String>Page2 Line4</String>
    </Screen2>
    <Screen3>
        <String>Page3 Line1</String>
        <String>Page3 Line2</String>
        <String>Page3 Line3</String>
        <String>Page3 Line4</String>
    </Screen3>
    <CyclingTime>n1 n2 n3</CyclingTime >
</Banners>

The tag <CyclingTime> defines the number of seconds each screen is displayed. By default, n1=5, n2=5, n3=2.

IMPORTANT: All tags must be present for the syntax to be valid. If you wish to skip a line, leave the text blank, but do not remove the <String></String> tags from the file.