ProMaster Keying V8 - User Manual
ProMaster Keying V8 - User Manual
by WH Software Limited
I ProMaster Master Keying
Table of Contents
Part 1 About 1
Part 5 Introduction 9
5.1 Using this guide
................................................................................................................................... 10
5.2 Understanding concepts
................................................................................................................................... 10
5.3 Product editions
................................................................................................................................... 15
5.4 Design module overview
................................................................................................................................... 18
Part 6 Installing 23
6.1 Architecture ...................................................................................................................................
overview 24
6.2 System requirements
................................................................................................................................... 24
6.3 Installing ................................................................................................................................... 26
6.4 File locations
................................................................................................................................... 27
6.5 Description of files
................................................................................................................................... 28
6.6 Licensing and product activation
................................................................................................................................... 29
Part
1
2 ProMaster Master Keying
1 About
Welcome to ProMaster Master Keying version 8 and thank you for choosing ProMaster Master Keying.
ProMaster Master Keying is a master-keying design and maintenance program for professionals. With this
comprehensive instructional documentation, you will find creating your master-key systems a quick and simple
task.
We are confident you will find it an easy and enjoyable program to use. Any suggestions/comments for
improvements in future versions are welcome, and may be addressed via email to [email protected]
Part
2
4 ProMaster Master Keying
2 Copyright notice
Copyright © 2019 WH Software Limited
All rights reserved.
Licensed material - program property of WH Software Limited. Law strictly prohibits unauthorised use,
duplication or distribution.
ProMaster Master Keying™ is a trademark of WH Software Limited.
Disclaimer
WH Software Limited provides this software and accompanying user guide ("publication"), as is, without
warranties, express, implied or statutory. This is in respect to its contents and includes, without limitations,
any implied warranties of application for a particular purpose, all of which are expressly disclaimed. Neither
WH Software Limited, nor any of its agents, consultants, distributors or dealers shall in any event be liable for
any indirect, incidental or consequential damages arising from the use of this publication. WH Software
Limited may make improvements and/or changes in the product or program, as described in this user guide,
at any time and without notice.
Although WH Software Limited has used its best efforts to eliminate inaccuracies from this user guide, it could
contain technical inaccuracies and typographical errors. Changes made from time to time to the information
contained in this user guide will be incorporated in later editions of this user guide.
Product manufacturers do not authorise the information contained in ProMaster Master Keying. Manufacturer
names are used for identification purposes only.
License
Full license agreement: The ProMaster Master Keying installation program includes the full license
agreement, which you must read and agree to in order to continue the installation. After installation,
the license agreement may be read by clicking the menu Help then License on the main application
window.
WH Software Limited
P.O. Box 300-655
Albany
Auckland 0752
New Zealand
Part
3
6 ProMaster Master Keying
Part
4
8 ProMaster Master Keying
7. Create your key sections and keyways. See Key sections and keyways 91 .
8. If you are using a system that requires manufacturer lists, import them. See Lists 93 .
That is the minimum required to get up and running. It is strongly recommended that you spend some time
reading the help to learn about other tasks.
6. Visit ALL your key sections and keyways and for each one, in each design module, open it, fix anything that
is missing and save it. Largely the upgrade process does whit can to make the data right but there is some
old data that users have not entered correctly and if you have any such data you must fix it. See Key
sections and keyways 91 .
7. Check your system types and add any missing information. See System types 87 .
8. Read the log file that was created by the upgrade, and fix the errors that it has found in your data (e.g.
Key colours, locks, signatories)
The log file is C:\Users\<WindowsUserName>\AppData\Local\WH Software\PM8\Log\PM8DBCfg.log
That is the minimum required to get up and running.
Part
5
10 ProMaster Master Keying
5 Introduction
· The installer and users are familiar with and confident using Microsoft Windows
· The installer has administrator access on the computers where the installation is to be performed
· The users understand master keying concepts. This guide teaches you about the software, but does not
train you in the principles of master-keying, the characteristics of various lock systems or good master-
keying practice.
If you are operating on a single computer then your computer plays the roll of the server and client.
See System requirements 24 for hardware requirements.
Database
The database is the most important file used by ProMaster Master Keying. In fact there are 2 database files.
Generally they are called PM8.fdb and PM8DocStor.fdb.
If you lost everything, but still had these two files then you are in a happy place. Ok, you may need some help
reinstalling and reconfiguring ProMaster Master Keying, but that is all easy stuff.
In the topic Backing up your data 40 we give plenty of advice about backing up. Please take this seriously.
Client computer
If you are in multi-computer environment, one computer (Hopefully one with good quality hardware, UPS,
backup solutions and fast SSD storage) is the server (see above).
Every computer where a user sits to operate ProMaster Master Keying is a client computer or workstation.
See System requirements 24 for hardware requirements, and Architecture overview 24 for more about the
architecture.
ProMaster Master Keying supports a wide range of locking products. These are supported through the
technical part of ProMaster Master Keying called design modules. Each design module supports one or more
locking products and implements the rules accordingly.
See Design module overview 18 for a high level overview of the design modules.
System type
System types define a set of rules. At their core they define the design module, but there are numerous other
settings that are very important also.
Each system you create for your clients belongs to a system type, and that defines the design module, lock
system (if the design module gives a choice), key cutting data (again, if the design module gives a choice).
So what about the question "Why do I need more than 1 system type for a design module?". If you use a
product where the design module defines all the rules, which is more common for high end locking products,
then the answer may be that for that design you need only one system type. Now consider if the system type
is for inline keys - you need at least one design module per depth and space card. Additional system types for
a single set of parameters are also useful for segmenting your systems by market.
See System types 87 .
Key colours
Key colours are the coloured bits on the head of the key. Most design module offer a range of colours (they
are under your control) and the colours are assigned to keys when the coding is performed.
See Key colours 89 .
Lists
Lists are a mechanism to control the quality of systems by controlling the TMK. Several design modules use
lists, and if you are a user of one of those design modules you will receive your list data from the
manufacturer.
93
See Lists .
Keying types
Keying types are a value attached to each system. Their largest non-technical function is simply an annotation
on the structure of the system. The most important technical function provided by the keying type is to specify
if the system is construction keyed or not.
See Keying types 53 .
Factories
Factory is a fancy word for "Where you make the stuff". If you have multiple manufacturing locations, then
having a factory for each allows you to work-flow your jobs.
See Factories 55 .
Hardware
Hardware refers to additional door hardware that may be recorded. It has nothing to do with the lock or
cylinder and is simply a way of recording other items on the door.
See Hardware 73
Users
Users are created in ProMaster Master Keying to control security and record who performed particular tasks
such as creating jobs.
Everyone who uses ProMaster Master Keying must be configured as a user. You may create as many users
as you want, but the total number of users who may be using ProMaster Master Keying concurrently is
controlled by the license.
See Users 44 , Security groups 45
123
See Keys
Key issues
Keys are entered and given a key number and assigned to doors. Then the keys are coded (the process of
assigning the technical data to them). When you want to manufacture the key, a job is created, and the job is
for 1 or more copies of the key. Each copy is numbered sequentially. Those copies of the key that you
manufacture are called key issues.
Door
Doors are doors most of the time. A door may represent a real physical door, or it may be a "virtual" door
representing a locking product such as a padlock.
Each door has an associated locking product (lock or cylinder) and is assigned to operate by 1 or more keys.
Normally you would order only 1 of each door, but in the case where a door represents a padlock it is likely to
be ordered multiple times.
132
See Doors
Keying
Keying is the relationship between keys and doors. Keying can be seen and altered from the point of view of
a door, or from the point of view of a key, or globally in the keying matrix.
145
See Keying matrix
Coding
Coding is the process where the technical design for the keys is created and the key codes are assigned to
each key.
The assignment of key codes to keys results in the technical construction of the lock product being calculated,
and that door lock assembly is referred to "door pinning" or simply "pinning".
171
See Coding
Jobs
The job is where you record the keys and doors that are required to be manufactured. The job represents a
unit of work on the system for the client. Once a job is entered and coding is complete, the job is
manufactured.
196
See Jobs
Job manufacturing
Job manufacturing is the process of taking the job, on which keys and lock product are ordered, and turning it
into physical product. Manufacturing produces all the necessary paperwork, labels, sends data to key cutting
machines, sends data to marking machines etc.
205
See Job manufacturing
Concepts related to terminology
System number
The system number is the system identifier. Sometimes the system number is dictated by lock
manufacturers, other times it is under your control. The system number is a unique value in your database.
Key number
The key number is the key identifier. The key number is unique within each system.
Door number
The door number is the door identifier. The door number is unique within each system.
Door stamping
The door stamping is the information that is marked on the cylinder. Some people create stamping the same
as the door number. Others create the stamping sequentially (1, 2, 3...). Others, and particularly using DHI
numbering, create the stamping as the key number of the lowest level key that operates the door.
TMK
TMK is the Top Master Key for the system. It is the main key code from which all other key codes are derived.
Rules
Rules are the parameters that govern the key codes permitted when coding the system. When you start
coding a system, the default values for the rules are copied from the system type associated with the system,
and from there you may adjust the values if required.
SOP
SOP, or sequence of progression, is the order that positions on the TMK are progressed to create other key
codes. It is used primarily when using the coding matrix.
Designation
Designation is the purpose that each chamber in the lock will be used for. The designation is used to build the
data for the coding tree. Examples of designation are "grand master key", "master key' and "change key".
Depth step
Depth step is the distance between derived codes in any position on the key. Some lock systems allow a
depth step of 1, where others have a minimum depth step of 2 or more.
Code progression
A code progression is the rule that takes the TMK, and defines a SOP, designation, depth step (and some
other values depending on the design module) to generate a tree or matrix of codes.
Standard progression
One of 2 types of code progression, this is the simple type that used depths steps and generates all possible
codes in any specified positions on the key.
Custom progression
A custom progression differs from a standard progression in that you specify the depth values to be used for
each position on the key. This is more complex but opens the door to more flexible coding for complex
systems.
Coding tree
One of 3 ways of coding systems, this is where the code progression is present as a tree of codes. The
coding tree is where codes are assigned and door pinning is calculated.
Coding matrix
The second of 3 ways of coding systems, this is where the code progression is present as a matrix of codes.
The coding matrix is where codes are assigned and door pinning is calculated.
Coding grid
The last of 3 ways of coding systems applies to Kaba dimple systems and this is where the coding is
performed according to the Kaba grid style progression. A code progression is not used by the coding grid.
The coding grid is where codes are assigned and door pinning is calculated.
Key code
This is the value for the cuts that are assigned to the key.
Pinning
This edition is single user only, and a limited range of design modules are supported. It is ideal for users who
need comprehensive master keying capabilities for inline key products and do not need more than one user.
ProMaster Master Keying Premium
This is the main-steam product edition. Any number of concurrent user licenses may be purchased and
almost all design modules are available.
ProMaster Master Keying Manufacturer
This product edition has additional features for manufacturers. Customers requiring bespoke feature
development must be using this product edition as any such feature is not added to the other editions.
Any number of concurrent user licenses may be purchased and all design modules are available.
Support options for this edition are more comprehensive.
Design modules by edition
This table shows the design modules that may be licensed for each edition. See Design module overview 18
Cylinder marking
Key cutting
Cylinder manufacturing
Features by edition
This table is a brief overview of feature availability that differs between editions. Some features are licensed
separately.
Description Assa Abloy UK Union extension (dimple cut inside flat cut)
Key cutting machines Silca UnoCode 299, 399, 399 Evo, 399 Plus, Pro, Silca Triax eCode, Triax Quattro,
Triax Pro
Part
6
24 ProMaster Master Keying
6 Installing
This section describes the architecture of ProMaster Master Keying, and the installation options available. It
describes the installation process and components that are installed onto your computer.
On versions of Windows prior to Windows 10, to achieve correct presentation you must use 100% font
size in your display settings. On Windows 10 the font size may be set larger (125% or 150% for
example) and ProMaster Master Keying will display correctly. On Windows 10 you may benefit from
changing the compatibility settings for "High DPI scaling override" to "System (Enhanced)".
Notes about hardware requirements
· Ensure the most recent service pack for your operating system is installed.
· System requirements are minimum requirements and good performance depends on ensuring your
hardware and networking reflect your usage style and resources required by other running applications.
Networking protocol requirements
ProMaster Master Keying requires that the TCP/IP networking protocol be installed and functioning correctly.
Normally this is done as part of installing Windows. If you do not have TCP/IP installed and correctly
configured then you should install it before proceeding with the installation. See your Windows
documentation or systems support person for help installing TCP/IP.
If you are on a PC without a network connection (i.e. No LAN and no WIFI) then you will need to
ensure that TCP/IP is available despite not having a network connection. This is because the database
connection uses TCP/IP.
On Windows 10, this is how you install a loop-back adaptor, however you must seek professional
advice before making any such change as it is not something that WH Software Limited can help you
with.
Firewall software is increasingly popular to help protect from malicious computer attacks. If you are running
any type of firewall software you must ensure that it allows ProMaster Master Keying to communicate on
TCP port 30636 and port 30637.
If ProMaster Master Keying is unable to communicate with its database (on the network server), try disabling
your firewall software to identify the source of the problem.
6.3 Installing
Before you begin
· Make sure your computer meet the minimum requirements
· Make sure you have your ProMaster Master Keying registration information
· Make sure you understand what type of installation you want to perform
When installing ProMaster Master Keying, always install the server first.
Starting ProMaster Master Keying setup
· User permissions are created on groups, not individual users. The best way is to not create security groups
for each user (this is a choice during the upgrade) but to do it yourself after upgrade. Regardless of your
choice, there are many new permissions in PM8 that do not map to permissions in previous versions
because tasks previously performed by the "admin" user are now performed by users according to their
permissions.
· Depending on the design module, and the age of the key section in the old database, you may need to visit
all key section families and verify that they are not missing information. Typically this needs attention when
there were old tree-style key section families.
· Renamed colours, locks etc. Older versions would allow data that is not permitted in version 8. For
example, you may have "Red" and "RED". During the import these will become "Red" and RED_1" and
logged in the results. This is because such fields are now "case insensitive, accent insensitive, unique".
The bad data needs to be merged fixed (according to the type of data), so for example with RED_1 you
would right click on it, choose to replace it with another colour and then pick "Red". Do these changes
carefully so you don't stuff up all your systems. Other data may get renamed in the same manner because
it contains leading or trailing spaces which are now removed.
Upgrading from ProMaster Master Keying 3, 2
There is no automatic process to upgrade from ProMaster Master Keying 3 or 2.
This is a lengthy multi-step process and requires assistance from WH Software Limited.
· The Windows operating system (32 bit or 64 bit) that you are running.
For information on the files installed to each location see the topic Description Of Files Installed.
File Description
PM8.exe The main application file for ProMaster Master Keying
PM8Back.exe Database backup program
PM8Upg.exe Application upgrade helper
File Description
PM8.fdb ProMaster Master Keying database
ProMaster Master Keying requires Product activation before it becomes fully functional. Product activation
is an anti-piracy technology designed to verify that the product has been legitimately licensed and thwart the
spread of software piracy.
Activation is completed either directly via the Internet or by a telephone call to a customer service
representative.
Activation on your server: Your ProMaster Master Keying installation is activated on and locked into your
server. The first user to log into ProMaster Master Keying other than the admin user must perform the
activation.
Activation can be achieved in one of the following ways:
· Over the internet direct to the WH Software Limited activation server
· Via your web browser to the ProMaster Master Keying web site activation page
Part
7
32 ProMaster Master Keying
7 Getting started
The first thing you must enter is your ProMaster Master Keying registration information. This information is
provided by your ProMaster Master Keying reseller when you make your purchase. The details must be
entered exactly as they are shown on your registration sheet or the registration will not be accepted. It is
long and complex, so copy and paste it into ProMaster Master Keying rather than attempting to type it!
Proceed to configure ProMaster Master Keying by visiting these areas of the product:
· Company information 49
· Application parameters 49
· Users 44
These are the "basics" for getting the product up and running. Other configurations are necessary for your
data.
See Setting your preferences 33 for help configuring ProMaster Master Keying to behave the way you work.
35
See Printer setup to decide where your reports will be sent.
Making a change
You must enter your old password then enter your new password twice.
The MAPI option sends email using your windows default MAPI mail client. To use this you must have a mail
application must be installed correctly and configured as the MAPI client.
The Outlook option automates Outlook to send the email. You must have the 32bit version of Outlook
installed.
The SMTP option sends the mail message direct to a mail server and several settings are required - see
below.
Normally when Outlook is used, an add-in called "Outlook Security Manager" is used to make Outlook more
cooperative. You can disable use of the Outlook Security Manager if it is problematic.
Option Description
SMTP server The name or IP address of your mail server.
Port The port on your mail server that receives the email.
SMTP login name If your mail server uses login based authentication, enter your mail login
name.
SMTP password If your mail server uses login based authentication, enter your mail login
password.
Encryption Choose if you use an unencrypted mail connection and how the
encryption works.
Sender's name The name of the person to appear as the sender.
Sender's email The email address of the person to appear as the sender. Some mail
servers require the sender email to be the same as the SMTP login name
if SMTP login name is used.
CC email to If you put an email address in this field, it will be added as a CC recipient
to each email message. This is useful for including yourself as a
recipient.
Read receipt email If you put an email address in this field, the email message will be
flagged as requesting a read receipt and using this email address (usually
your own) as the receipt recipient.
Send email as HTML instead of Chooses if the email message is delivered in HTML format or plain text.
plain text Unless you have issues sending HTML email, it is a better option.
Send test message Sends a test message using the current settings. Useful for testing
before saving.
A work of warning about Office 365 SMTP. It is slow sending. Very slow. When very large messages
take a long time to send, or sometimes fail, this is outside of our control. It has been slowed down
deliberately by Microsoft. That said, unless your messages are huge you may never notice a problem
Door entry
The various door entry options determine if values are copied from the previous door when adding a new
door, and also which values are copied.
Key entry
The various key entry options determine if values are copied from the previous key when adding a new key,
and also which values are copied.
Report stretching
For each type of information on reports, a pre-determined width is allocated. This gives the best balance
between the various pieces of information shown. If the information cannot fit in the allocated space, in most
places it will automatically stretch down the report. You may use these options to determine for each type of
data if it will be allowed to stretch on the reports. If stretching is disabled for a type of data and it is not able
to fit then it will be truncated on the report. Generally some types of data (e.g. System number, Door
number, Lock part code) should always be allowed to stretch as truncating them makes little sense, while
other types would be ok to truncate.
Default factory for new jobs
If the application parameter "Allow user preferences for factory to use on new jobs" is on, the will be 2
options available that alter the behaviour when creating jobs.
If a default factory is set for a user and the default factory set by the system type is blank, or the preference
"Always use this selection as the default factory..." is checked, the factory selected here is used as the factory
when creating a job.
Changing printers
There are printer for non-manufacturing related reports, and several for manufacturing related reports.
Almost all non-manufacturing reports are sent to the "Standard reports" printer.
Reports must be configured for each factory. Factory reports are sent to the "Factory reports" printer.
There are separate configurations for each label printer used by a factory (thus allowing each to have a
different label size permanently loaded)
For each printer, select it then click Edit, then choose the printer you want.
Restricting printer access
There are some Application parameters 49 that control the configuration of users.
Parameter Description
Allow empty printer setup to print to default printer Normally this option is on, meaning that if the report
destination is not configured then ProMaster Master
Keying will sent it to your default printer.
Users may select the printer for factory reports If you turn this option off, users will be unable to
configure the factory printers and a user with
permissions to edit users will need to perform the
configuration (See Users 44 )
This would not normally be done, but may be useful if
you want to force a user to print to the correct printer
for factory reports and never print to another printer
by mistake.
Where are printer configurations stored Normally printer settings are stored on the local
machine. If you change this to be the "in the
database" option then user settings are the same
regardless of which computer the user logs in from,
but the printers configured must be available where
ever the user logs in.
If this document says, Choose the menu option System then select Open, you could do this in any of the
following ways:
· Click your mouse on the menu System then when the drop down menu appears click your mouse on the
menu Open
Or
· Using your keyboard press Alt-S for the System menu then O for the Open menu.
Or
· Press Ctrl-O because that is the short cut key to perform the Open action.
Navigating windows
Moving around
The Tab key on your keyboard moves forward between fields.
Buttons
Click a button means; Either click the button with your mouse, or Tab to the button so it is the active control
and press the Enter key on your keyboard, or Tab to the button so it is the active control and press the
Space Key on your keyboard, or if there is a hot key for the button you may press that key combination.
Now that's a whole lot of different ways to use that button, but the real point here being that while the
documentation refers to clicking a button, often the better way is to use the keyboard, especially if it is only a
couple of key presses away from where you are. You certainly would not want to read the previous paragraph
over and over again!
Check boxes
Checks boxes, may be referred to as flags or options throughout this document. They are called this because
they are either on (they contain a tick or cross) or off (empty box). Tabbing onto them and using your Space
Key, or clicking on them with your mouse changes check boxes.
Drop down lists or combo boxes
Combo boxes, or drop down lists give you a list of choice for that field. A value may be selected using your
mouse, or by tabbing onto the field and using your keyboard. The key combination Alt-Down Arrow makes the
list drop down. Often the fastest way to make a selection is to tab onto the combo box and press the first
letter of the selection.
Default button
You may notice that many windows have one button that looks a little different to all other buttons. It may be
a different colour or it may have a dark border around it. This button is called the Default button. The default
button is operated by the Enter key on your keyboard from wherever you are on the window, provided that
the current control does not have a use for the Enter key.
On some of the more complex windows with multiple buttons, you will notice that as you tab from one
control to another the default button may change. The reason for this is to allow the Enter key to
perform to most common action.
An example of this behaviour is all search windows.
As you tab between the criteria fields at the top of the window, the Find button is the default button. Pressing
Enter actions the Find button.
After you action the Find button, and the results are displayed, you are positioned on the list so you can make
your selection using the arrow keys on your keyboard. When you are on the list, the Find button is no longer
the default button, but instead the OK button (or some other button) is now the default button.
This means that when you are on the list, pressing the Enter key will action the OK button and effectively
choose that action on the highlighted item.
Cancel button
With few exceptions, when a window has a Cancel button, the Escape key on your keyboard will operate
that button.
Learning to navigate and make selections with your keyboard rather than your mouse will dramatically
improve the speed with which you operate.
Convert case
Various data entry fields support the key press Shift-F3 that cycles case between lower-case, upper-case and
title-case. This works on the whole entry if nothing is selected, or just the selected text if you have made a
selection.
Search starting. The search on the field matches data that starts with the value you entered.
Search containing. The search on the field matches data that contains with the value you entered, but
not necessarily at the start.
Search exact match. The search on the field matches data that exactly matches the value you
entered.
Search all values. The search on the field must contain each of the words you entered. The words
must all exist in the matched value, but may appear in any order. This search is most often used in address
searches where it is enhanced to search for all the words you enter in all of the associated address fields.
Notes
· All search parameters you enter must be met for any item of data to be considered a match, so enter
enough information to refine your search, but not so much that you exclude items you want to see.
· After you perform the search, you are placed on the list of results where you can move up and down with
the arrow keys then perform any action allowed on the selected item.
· See Setting your preferences 33 for information about auto find and find warnings.
Part
8
40 ProMaster Master Keying
Updates are always in the form of a setup program (PM8Update.exe) that installs a new version of the
ProMaster Master Keying program and any necessary support files.
Updates must be installed only on the server. During the update process other users must not be using
ProMaster Master Keying. When workstations log into ProMaster Master Keying subsequent to the update they
will be upgraded automatically.
When the update is installed, ProMaster Master Keying is run automatically and you are taken to the
Database Upgrade Wizard. The tasks shown in the Database Upgrade Wizard vary depending on the
version you have installed and the previous version that was in use.
You need to know the Admin password to apply database updates.
The database upgrade window may also be accessed from the Tools menu when you are not logged in. This
is necessary only if for some reason the update does not complete during its installation.
Both the installation of the update onto your server, and subsequent updates that are propagated to
your workstations require administrator access to run as they write new versions of the program files
on to your system.
WARNING: Live backups made with ShadowProtect or similar when the database is in use are of
limited use. The reason why is that they make a point in time snapshot of the database, but do not
capture a read-consistent view of the data. If a backup made with ShadowProtect or similar is
restored, there is a very good chance that it will be corrupt, and look to the database engine very much
like someone pulled the power cord out of the wall. Consider this to be a expensive exercise to repair
the database. ALWAYS run the ProMaster Master Keying backup program. The backup files produced
by the ProMaster Master Keying backup can be captured safely by ShadowProtect etc.
Producing Backups
To produce a backup:
· Select the Database to backup (most likely you have only the database called Default)
· Alter the destination Folder if you wish. You may choose to have the backup copied to a second folder. The
backup folder must be a local drive on the server. The second folder is accessed by the backup program
rather than the database engine, and may be located on a network share.
· Click the Save settings and run backup button.
The file that the backup creates has a FBK file extension. Should then need arise, the backup program can be
used to restore this file to reconstruct your database.
In the normal operation of ProMaster Master Keying, the option Perform database maintenance during
the backup is an important part of maintaining a healthy and efficient database. The only times you should
do a backup with this option turned off is if you plan to discard the original database and immediately restore
your backup, or if you need the backup to be performed as fast as possible. This option, while important, does
add a small amount of time to the backup process.
The Backup also the associated document database option identifies the database used for storing
ProMaster Master Keying documents and runs a separate backup for that database after the primary database
backup is finished.
Backups can be configured to automatically zip the FBK file into a ZIP file. This is achieved by turning on the
Compress the backup flag. Zipping a backup reduces the amount of disk storage required for the backup,
but does use more disk space and time during the backup process. Be aware that there is a maximum file size
for zip files. Failure to do this may result in an unusable zip file. Unless disk space is is critically low, it is not
recommended to use this option as it makes backups significantly slower and the backup file must be
extracted in the event that it is to be restored.
The Output additional progress and diagnostic messages option produces messages about the various
stages of backup. Many messages are produced and the backup will therefore run measurably slower. There
is no need to use this option unless instructed to by ProMaster Master Keying support staff.
Copy the backup to somewhere else
Backup files (either those with a FBK file extension or the zipped backups with a ZIP file extension) should be
copied off your computer onto separate media. Backups should then be stored according to good business and
computing practice to safeguard your data investment.
The cost of producing permanent backups is extremely small compared to the cost of re-entering data.
Restoring Databases
The process of restoring a backup to produce a working database will not overwrite an existing database. If it
is your intention to replace your database by restoring a backup you must first locate your existing database
and rename it.
To restore a backup:
· Click the Restore... button.
· Choose what you are restoring (main database, document database or both)
· Click the Select... button, and select the backup file (the FBK file) for database, document database or
both. If you zipped the backup, you must first extract the backup files from the zip archive (using WinZip or
similar).
· Select the destination Database to restore (most likely you have only the environment called Default)
The Output additional progress and diagnostic messages option produces messages about the various
stages of restore. Many messages are produced and the restore will therefore run measurably slower. There
is no need to use this option unless instructed to by ProMaster Master Keying support staff.
Configure Auto Backup
In the ideal world you would create daily backups.
ProMaster Master Keying Backup can be configured to:
· Backup multiple databases.
· Backup to one location and produce a copy of the backup at another location (e.g. another computer).
· Click the Select Folder... button to choose the destination folder for the backups. This must be on a local
disk.
· If you wish, check the option After the backup is created, copy it to the folder below and click the
corresponding Select Folder... button to choose the destination folder copy the backup to. Be aware that
the backup process must have access to this location, so there is no point in choosing a remote folder that
you can see when logged in as a user unless the scheduled backup process is also able to access that
folder.
· Set the options. See the notes earlier about backup options.
· There is one additional option for the auto backup - Recalculate index selectivity. This option should be
left on as it is responsible for maintaining database optimisation. It adds a small amount of time to the
backup.
· Choose how long you want to keep backups. There are separate settings for the backup folder and the
"copy to" folder. It is highly recommended that you keep a reasonable number of backups, perhaps 14
days. If you don't have enough disk space, get more.
Email
If you want an email notification after the scheduled backup has run, use the settings on the Email tab.
You may need to check with your mail administrator for the settings, and as there is a variety of mail servers
in use, each with different characteristics, you may need to experiment a bit to get it right.
Option Description
Server The name or IP address of your mail server.
Port The port on your mail server that receives the email.
Login name If your mail server uses login based authentication, enter your mail login
name.
Password If your mail server uses login based authentication, enter your mail login
password.
Encryption Choose if you use an unencrypted mail connection and how the
encryption works.
Sender's name The name of the person to appear as the sender.
Sender's email The email address of the person to appear as the sender. Some mail
servers require the sender email to be the same as the SMTP login name
if SMTP login name is used.
Sent to Put in the email recipients, one per line.
Test Sends a test message using the current settings. Useful for testing
before saving.
· If you want to configure Windows Scheduled Tasks to start your backup each night, click the button
Schedule Auto Backup...
· If you want to add the scheduled task yourself, the command to run is shown in the yellow area at the
bottom of the settings.
· Finally, click Save to save your settings for Auto Backups.
· You will be prompted for the password for the Windows user account. The password is verified against the
computer or domain and on success the schedule is saved.
If you wish to configure Windows Scheduled Tasks manually, consult your Windows documentation or
Computer Consultant for information on how to configure your version of Windows for this task.
Your computer must remain on for Windows to be able to schedule tasks.
Here's a simple rule: No power = No backup.
Just like with a backup file that you create interactively, the backups produced when your schedule software
starts the ProMaster Master Keying Backup program should be copied to external media for safe keeping.
SCHEDULED TASK USER ACCOUNT
It is strongly recommended that you create a Windows user specifically for running the backup and use
that user for no other purpose. The user will need to have permissions to log on to run a batch job,
and will need permissions to the folders where the backup files are produced (including delete
permissions so old backups can be removed). If you do this, make sure the account password is
secure and never expires. It is all too common for users to configure scheduled tasks with an account,
such as their own login then at some time in the future change their password. After that the backups
will not run as scheduled task no longer has permissions to run.
Security
For security reasons, the ProMaster Master Keying Backup program will not allow you to backup a database
located on another computer. i.e. The backup must be performed on the server where the database is
located.
Always test your scheduled backup by opening your Windows Scheduled Tasks and choosing to run the
task immediately and verify that the backup files are produced. Check the task options to ensure that
they make sense and that the task will run even if a user is not logged in.
8.2 Configuring
8.2.1 Users
For each person who uses ProMaster Master Keying you should create a user account.
Each person then has their own login name and password, and ProMaster Master Keying tracks information
about who performed changes and restricts individual user access to functionality based on the access rights
that you have defined.
Initially the admin user must configure user accounts, but you may (although not necessarily should!)
give a user the ability to configure user accounts.
You may create as many user accounts as you wish. ProMaster Master Keying restricts the number of
concurrent users allowed by your license, but not the overall number of users that you define.
Any user that has performed activities is not able to be removed (but can be made inactive).
Getting started
· From the Setup and Admin menu, select Users
Making a change
· Use the Add, Remove and Edit buttons to set up your users.
reports. Generally printers are left under the control of the user and the application parameter for this
should be changed only if you want to tighten control over the print location for factory reports.
· When you create a user, the Active flag should be on. You can disable a user at any time by editing that
user and removing the Active flag.
Security
Each user belongs to a security group. Security groups control the activities that a user can perform. See
Security groups 45 and Security categories 48 for more information.
Branch
You may define branch addresses and associate an address with a user. See Branch addresses 50 for more
information.
Making a change
· Use the Add, Remove and Edit buttons to set up your security groups.
Note that in some situations, ProMaster Master Keying checks more than one permission and often in
conjunction with application parameters and license options. Some tasks may be permitted by more
than one permission (Edit a client on the currently open system checks "Setup clients" or "Edit the
client on the open system") and others may require a combination of permissions (Change the TMK on
a system requires "Coding" and "Access restricted coding features")
Permission Description
Group: Setup
Setup company and associated data Allows setup of company information, branch addresses, company
logo on reports
Setup users and user security Allows setup of users, security groups, security categories.
Setup general administrative settings Allows setup of factories, lockshops, keying types
Setup application parameters Allows application parameters to be altered.
Setup templates Allows the user to design templates for importing and exporting to
Excel.
Allows configuration of templates such as registration form
instructions.
Setup locks and cylinders Allows setup of locks and cylinders and door hardware.
Setup marker models Allows configuration of the relationship between marking models
and key sections when manufacturing on the Silca Marker 2000.
Setup system types Allows setup of system types.
Setup design parameters (Key Allows setup of key sections, key head colours.
sections, keyways, key head colours)
Import and maintain lists for restricted Allows lists to be imported and maintained if you have an applicable
design modules design module registered.
Export parameter data (CSV) Allows various types of data to be exported including locks, door
hardware, key colours, keying types, lockshops (manufacturers
only), clients, factories, branch addresses
Group: Client
Setup clients Allows clients to be created, altered etc.
Allows system signatories to be converted to a client signatory.
Group: System
Open systems Allows systems to be opened. Required for pretty much everyone
unless the user is for admin purposes or used only for "Manufacture
job".
Open high security systems Required for the user to open systems marked as high security.
Normally most users would have this permission and most systems
would be marked as high security. Low security systems and
users should be used for low-end master keys systems only.
Without this permission, any systems created by a user are
marked as low security.
User must have "Open systems" also to be able to open systems.
Open unsecured systems as well as Allows unsecured systems to be opened as well as those with a
those secured by security categories security category. Without this permission all systems that the
user creates/edits must have a security category assigned.
Open systems based on its design Allows key section and key code to be used when searching for a
system.
Allows the option "Only systems with pending jobs and that require
coding" when searching for a system.
Allows the user to use the "Change key sections" to alter all keys
in a system on applicable design modules.
Allows the system type to be altered (to a compatible one only)
after the system design has been created.
Access advanced coding features (e.g. Allows the user to create progressions in the coding tree that
create overlapping progressions) "overlap". Without this permission each chamber in the lock is
used for a single purpose.
Group: Job
Create and edit jobs Allows jobs to be created or edited.
Allows jobs to be imported from ProMaster Key Manager.
Order obsolete product Allows the user to order a lock product that is obsolete (marked as
inactive).
Manufacture jobs Allows the option to open jobs for manufacturing (can be used in a
factory where other permissions are not granted).
Allows jobs to be manufactured from the jobs screen.
Allows configuration of machines for manufacturing.
Change a job after it is released Allows the user to change the status of a job from "Manufacturing"
to "Entering" so changes may be made to the job.
Allows the user to change the status of a job from "Complete" to
"Manufacturing" if permitted by the Application parameters 49 .
Allows the invoice number to be edited on a job when it is
"Manufacturing" or "Complete"
Also allows the print status of a job to be toggled when the job is in
"Manufacturing".
Allows a key or door to be removed after it is ordered and
manufactured.
Group: Admin
Export data Allows systems analysis export
Allows export of the list when searching for systems.
Print admin reports Print all types of admin reports.
Design labels (everyone) and reports Allows the user to design label layouts for manufacturing output to
(requires custom reporting license) label printers.
If ProMaster Master Keying is licensed for the end user report
writer, it also gives the user permissions to design reports.
Group: Publishing
Configure publishing Allows ProMaster Master Keying to be configured as a publisher,
thereby allowing devices to be configured.
Configure publishing devices Allows devices to be created ready to receive jobs. If you have
configured publishing to be restricted by factory or system type
then this allows those device configurations also.
Publish jobs to devices Allows jobs to be sent to devices from the job manufacturing
screen.
Making a change
· Use the Add, Remove and Edit buttons to set up your users.
The systems associated with the security category are shown but not editable. The relationship between a
system and security category is controlled by the system.
· Expand or collapse branches of the tree by clicking on the [+] or [-] buttons beside the folders.
· Double Click on the item that you want to change, make your change and click OK.
· When you have finished making changes, click Save to make them permanent.
Notes
· Items set to their default value are indicated by the empty page icon.
· Items that have been altered are indicated by the lined page icon.
· An item you have changed and is not yet saved is indicated with a disk icon.
· To reset an item to the default value, highlight the item and press Shift+Ctrl+Alt+Delete.
· Changes are not seen by other users until they log out then log in again.
· Users of earlier versions of ProMaster Master Keying will notice that there are significantly fewer options
than in the past. This is because wherever possible the parameters have been move to more accessible
and more applicable locations such as System Types, User Preferences etc.
Unless you know the application parameter you require, it is usually beneficial to search for some text
in the parameter you are looking for. Use Ctrl-F to Find and F3 to Find next.
· Click OK to save.
· Choose the Standard Image tab for small graphic in the top left corner of reports or the Full Width
Image tab for the logo that replaces the replace the entire company portion of report headers.
Changing the logo
· If you have a logo load and you no longer want to use it, clear it by clicking Remove logo.
· Click OK to save.
Notes
· The logo must be a png file. If you have a graphic in another format, you must first convert it (using a
graphics editing application) to a png file.
· The small logo is rendered on the reports in a 25mm x 25mm square.
· The full width logo is rendered on the report 190mm wide for portrait reports and 277mm wide for
landscape reports.
· Because the small logo is rendered in a square, you must ensure that your graphic is square (I.e. the height
and width dimensions must be the same)
· The absolute number of pixels in your graphics file will determine the quality of the rendered image.
Consider about 300 dpi to be satisfactory quality in which case the graphics file needs to be about 240
pixels high and 240 pixels wide.
· Change the Application parameters 49
Report header style under Reports to specify no logo, small log
or full width logo.
Making your graphics file excessively large will not result in a noticeable quality improvement, but will
have an adverse impact on performance, particularly in printing speed and the size of any PDF files
produced.
Making a change
· Use the Add, Remove and Edit buttons to set up your addresses.
After adding an address you likely will assign it to a user. See Users 44 .
· Other address fields are used on report headers for linked users instead of the main company address.
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
· The Current registration tab shows details of the registration currently being used by the database.
· After pasting your new registration, the Preview tab is available to see the contents of the new license.
· Click OK to save.
If your ProMaster Master Keying is registered and activated, the Fetch latest registration button is
available and will retrieve the latest registration from the WH Software Limited activation site. This is
useful when support and maintenance is renewed or design modules or users added.
Or put another way, the data is split into 2 databases because that is the best way to store it.
It is possible to change the way documents are stored, but it is best to seek technical advice before
doing this.
Really, there is no good reason for ever doing any of this - the ProMaster Master Keying installation
already did the best thing!
DON'T MAKE ANY CHANGE BECAUSE YOU FEEL LIKE HAVING A PLAY WITH IT. SEEK GUIDANCE FROM
WH Software Limited FIRST.
Getting started
· You must be logged in as the admin user
Option Description
Repair DocStor connection alias The connection alias for the DocStor is stored inside the main
database. It must follow the naming convention as such:
Main database = PM8
The second and third options can take some considerable time (perhaps hours) to run if your database
is large. You must plan downtime to perform these tasks.
· After making a selection, click the OK button to proceed.
Never run this process while other users are using ProMaster Master Keying. Run this process only
after you have discussed it with WH Software Limited support staff.
Getting started
· From the Setup and Admin menu, select Keying types
Making a change
· Use the Add, Remove and Edit buttons to set up your keying types.
· Choose if the keying type is for construction keyed systems. Do not change this setting after creating
systems using the keying type.
The application parameter Default keying type for new systems is used to pre-select a keying
type when you create a system. For users who do not require keying types (other than for creating
construction keyed systems), this application parameter should be set.
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
· Click Next
Data analysis
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
8.3.2 Factories
Factories model the practical scenario of manufacturing jobs in more than one location. If you make all your
jobs on the bench at your only shop, then the default factory called Workshop is all you will need.
If however you run two shops, and you may manufacture product for master key systems at either location,
then right away you can get a benefit in defining a second factory to represent the second shop. In this
scenario you may wish to rename Workshop to the actual name of your first shop.
Another example where defining additional factories will benefit is if you have a mobile unit who will
manufacture and install a job. Set the mobile guy up as a factory, being sure to include his mobile email
address when entering the factory. Now, when you enter a job in ProMaster Master Keying, select the mobile
guy as the factory. Now you now have a record against the job saying where the job was manufactured.
Getting started
· From the Setup and Admin menu, select Factories
Making a change
· Use the Add, Remove and Edit buttons to set up your factories.
Other functionality
Click the Options button then Export csv to export the data to a csv file. See Exporting parameter data to a
csv file 98.
Click the Options button then Import csv to import data from a csv file. See Importing factories from a csv
file 56
An explanation of the options
· Internally ProMaster Master Keying knows if it a factory you created or if it is imported from another user
when importing a system file.
· Each factory name may appear only once (Although if you import systems from another ProMaster Master
Keying user they may have a factory with the same name).
· If a factory is marked as inactive it may not be selected for a new job.
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Each lock may have cylinders specified for each system type (See System types 87 ) for external, internal, or
double usage (In many cases it will be only an external cylinder specified).
Cylinders have a different set of properties that relate to how it operates (E.g. Core type, part type, driver
pins, axes).
Getting started
· From the Setup and Admin menu, select Locks and cylinders
Making a change
· Use the Add cylinder, Add lock, Remove and Edit buttons to set up your locks and cylinders.
Right click a lock or cylinder and choose Duplicate to add another item with the fields (except part code)
copied from the selected item.
Right click a lock and choose Copy cylinders from this lock to other locks to do as it says. See Copy lock
cylinders 60 .
Right click a cylinder and choose Copy driver pins from this cylinder to other cylinders to do as it says.
See Copy cylinder driver pins 61 .
Right click a cylinder and choose Cylinder sub assembly to edit sub assembly information for the cylinder.
See Cylinder sub assembly 68 .
Right click a lock or cylinder and choose Remove this lock or cylinder and replace it with another lock
or cylinder. See Replace lock 61 .
Right click a lock or cylinder and choose Usage report to see where a lock or cylinder is used. See Lock
156
usage .
Click the Options button then Bulk change to allow easy changes to all the locks and cylinders returned by
your search. See Bulk change locks 59 .
Click the Options button then Export csv to export the data to a csv file. See Exporting parameter data to a
csv file 98.
Click the Options button then one of the 6 Import csv options to import data from a csv file. See Importing
locks from a csv file 61 , Importing cylinders from a csv file 65 and other surrounding topics.
Getting started
· From the Setup and Admin menu, select Locks and cylinders
Which axes does the cylinder use Normally this is unimportant. For example, an inline cylinder has a single
axis, that axis is always used and there are no options.
For Abus XY14, Axis a and Axis 2 must be set correctly as this determines
if pinning is calculated as X14, Y14 or XY14.
Image The lock image can be loaded from a file, linked to the image used by
another lock or scanned. Basic editing capabilities are provided. See also
308
Image editor .
· Search for a lock or cylinders. Bulk change acts on the locks and cylinders returned by your search.
General
· Within this window, the change select is applied only to the items that are checked.
· You can check and uncheck items individually or right click and use the various selection options.
· You can make as many different changes in this window as you want before saving.
· Changes are stored in memory and saved only when you click OK, so if you stuff it up then you can cancel
and start again.
· Any item that has been changed displays a graphic next to the check-box.
· If you want each value that has been changed, right click the list and choose Show changed values.
Then a flag graphic is shown next to all changed values.
Making a change
The bulk change process is:
· Use the data type list to select the type of change you want.
· The options for that change are shown. Enter the new information for your change.
· Ensure that the correct items are selected, selecting or deselecting them as necessary.
· From the Setup and Admin menu, select Locks and cylinders.
· Right click on a lock and choose Copy cylinders from this lock to other locks.
· On the Destination locks page, choose the locks to which the cylinders will be copied. Click Select to
search for locks to add to the list, or if you have a document that contains part codes (1 per line) you can
copy the part codes to the clipboard and load them into the destination locks list by clicking Paste from
clipboard.
· After selecting the destination locks, click Next, review the task and click Finish to apply the changes.
Getting started
· From the Setup and Admin menu, select Locks and cylinders.
· Right click on a cylinder and choose Copy driver pins from this cylinder to other cylinders.
· The cylinder is shown. You can click Details to check it before proceeding then click Next.
· On the Destination cylinders page, choose the cylinders to which the driver pins will be copied. Click
Select to search for cylinders to add to the list, or if you have a document that contains part codes (1 per
line) you can copy the part codes to the clipboard and load them into the destination cylinders list by clicking
Paste from clipboard.
· After selecting the destination cylinders, click Next, review the task and click Finish to apply the changes.
· Right click on a item and choose Remove this lock or cylinder and replace it with another lock or
cylinder.
Making a change
· Click Select to choose the replacement item
There is no undo. When you type the confirmation text and click OK, the old lock or cylinder is gone
and all doors using it are affected.
Getting started
· From the Setup and Admin menu, select Locks and cylinders.
Importing data
To import data from a csv file, click on the Options a button then choose Import locks csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import lock cylinders csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import lock pictures csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import cylinders csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import cylinder driver pins csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
You may change the source column for each type of data. In each drop-down list, the column number,
heading and first piece of data is shown.
Before proceeding you must correct any errors in the automatic column selection and also for any unassigned
column make a selection for the source.
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import cylinder pictures csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Making a change
· Use the Add, Remove and Edit buttons to set up your cylinder sub assembly information.
· When you click Add, you will then be asked to choose the system type you want, and then taken to the
editor for adding components.
Other functionality
Right click a sub assembly line for a system type and choose Duplicate to add the same information to
another system type.
Click the Options button then Item types to set up your categories (Core, Housing Etc.). This should be
done before setting up sub assembly information for a cylinder.
The list will be small, and once done it is unlikely that you need to alter it as it is used for all cylinders
and all system types.
Click the Options button then Export csv to export the data to a csv file. See Exporting parameter data to a
csv file 98.
Click the Options button then Import cylinder sub assembly csv to import the sub assembly parts from a
csv file. See Importing cylinder sub assembly from a csv file 69 .
Click the Options button then Import images csv to import the sub assembly images from a csv file. See
Importing cylinder sub assembly images from a csv file 71 .
Click the Options button then Import video URLs csv to import the sub assembly video links from a csv file.
See Importing cylinder sub assembly video URL from a csv file 72 .
The cylinder sub assembly editor
· Use the Add, Remove and Edit buttons to assign the components required.
· For each component you specify the part code, quantity, and optionally a location (where it is in your
factory)
· You may load an image in the same manner as for lock and cylinder images.
· A video URL is provided and if used is available when using on-screen pinning.
Setting up sub assembly components for a large number of cylinders is a cumbersome process. It is
recommended that you set up one or two for play purposes, then when you want to do the bulk of it, start by
exporting the information, then create the CSV files externally based on the exported files, then when you are
ready, use the import functions to bring it back into ProMaster Master Keying
The combination of part code + system type + component type fields in the import is matched
to existing values to determine if the information is new (and therefore will be added) or existing (and
therefore will be updated to the new information).
The part code must exist as a cylinder or double cylinder.
The system type must exist.
The component type must exist.
Getting started
· From the Setup and Admin menu, select Locks and cylinders.
Importing data
To import data from a csv file, click on the Options a button then choose Import cylinder sub assembly
csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Importing data
To import data from a csv file, click on the Options a button then choose Import images csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
You may change the source column for each type of data. In each drop-down list, the column number,
heading and first piece of data is shown.
Before proceeding you must correct any errors in the automatic column selection and also for any unassigned
column make a selection for the source.
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
Ready to finish
A summary is displayed.
Click Finish to perform the import.
8.3.3.16 Importing cylinder sub assembly video URL from a csv file
Manufacturer edition only. Cylinder sub assembly feature must be in your ProMaster Master Keying license.
If you have a CSV file with cylinder sub assembly video URL information you can import this data.
296
Read the topic Cylinder sub assembly video URL import (CSV) file format for more information on the file
contents allowed.
The combination of part code + system type fields in the import is matched to existing cylinder sub
assembly values.
The part code must exist as a cylinder or double cylinder.
The system type must exist.
The folder from where the pictures are loaded is the folder that contains the CSV file you are importing
and then a sub folder CylinderSubAssemblyPicture
Getting started
· From the Setup and Admin menu, select Locks and cylinders.
Importing data
To import data from a csv file, click on the Options a button then choose Import video URLs csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
The wizard looks at the column headings (if they are included in the file) and from these it attempts to
determine what each column in the file is used for.
You may change the source column for each type of data. In each drop-down list, the column number,
heading and first piece of data is shown.
Before proceeding you must correct any errors in the automatic column selection and also for any unassigned
column make a selection for the source.
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
8.3.4 Hardware
Hardware is for recording any items on the door other than the locking product. Recording of hardware is for
informational purposes only and does not impact master keying or jobs.
Getting started
· From the Setup and Admin menu, select Hardware
Making a change
· Use the Add, Remove and Edit buttons to set up your hardware.
· Click Add group to add a hardware group (a group part code that encompasses several other parts). See
the topic "Hardware groups" lower in this topic.
Other functionality
You may right click a hardware item and choose Duplicate from the pop-up menu to add hardware with the
fields (except part code) copied from the selected item.
Click the Options button then Hardware types to open the editor for hardware types. Hardware types are
a classification of hardware items, such as "Closer", "Handle" and "Kick plate". You will need to add hardware
types before adding any hardware items.
Click the Options button then Exporting to a csv file to export the data to a csv file. See Exporting
parameter data to a csv file 98 .
Click the Options button then Import from a csv file to import data from a csv file. See Importing
hardware from a csv file 74
Explanation of data fields
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Before proceeding you must correct any errors in the automatic column selection and also for any unassigned
column make a selection for the source.
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
· Click Next
The wizard shows you the first four lines of the file so that you can see how it has been parsed. From this you
may determine if the file content is what you were expecting or not.
It is common for the first line of a CSV file to contain column headings. The wizard tries to determine if that is
the case with the file you selected, and sets the options accordingly. If the option for the first line is not
correct, be sure to check or un-check it as necessary.
The Operation determines how the import is processed. Choose if you want new items, if you are updating
existing items, or both.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
8.3.5 Templates
Templates are rich text entries that are used in various places. For example when you print a Signature
167
registration form you can pick the template containing instructions to the client.
Getting started
· From the Setup and Admin menu, select Templates
Making a change
· Use the Add, Remove and Edit buttons to set up your templates.
Type The type of template. The options here depend on your product registration.
E.g. Signature registration, order form
Usage What the template is used for. Currently the only option is "Template" but
there may be other options if required in the future.
Description A description that you call the template. Must be unique.
The templates, according to their type, may be selected in the place where they are required and the user
selection is remembered for next time it is required. Some users may require multiple templates such as two
different signature registration instructions, although for most people a single template for each type is
sufficient.
8.3.6 Lockshops
Manufacturer edition only.
Lockshops are for manufacturers to store the name and details of locksmiths who may then me designated as
the key cutting agent for a system or to record that the system was sent to a locksmith.
Getting started
· From the Setup and Admin menu, select Lockshops
Making a change
· Use the Add, Remove and Edit buttons to set up your lockshops
Other functionality
Click the Options button then Export csv to export the data to a csv file. See Exporting parameter data to a
csv file 98.
Click the Options button then Import csv to import data from a csv file. See Importing lockshops from a csv
file 77
Explanation of data fields
The lockshop name must be unique.
301
Read the topic Lockshop import (CSV) file format for more information on the file contents allowed.
The name field in the import is matched to existing values to determine if the lockshop is new (and
therefore will be added) or existing (and therefore will be updated to the new information).
Getting started
· From the Setup and Admin menu, select Lockshops
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
· Click Next
Before proceeding you must correct any errors in the automatic column selection and also for any unassigned
column make a selection for the source.
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
The publishing server is used also for sending system updates to ProMaster Key Manager 8.
The publishing server is hosted and available to users of ProMaster Master Keying as a no-cost service that is
available while ProMaster Master Keying support and maintenance is current.
The number of devices available is determined by your license, and is set at 3 devices per user license. For
example if your ProMaster Master Keying license permits 5 users then you will be permitted 15 devices.
Architecture
The publishing service is implemented as a web HTTPS service. ProMaster Master Keying communicates with
the publishing server from each workstation, so to use the service the workstation must have internet access
to the publishing server permitted.
Jobs on mobile devices
Devices run the ProMaster mobile app for Android or iOS and also communicate with the publishing server
using HTTPS.
Devices are configured and associated with your ProMaster Master Keying using a handshake process during
which a pairing code must be entered on the phone and the pairing code is used to retrieve and decrypt an
encryption key specific to the device.
For all subsequent communications to the device (i.e. Sending jobs), the data transmitted is encrypted to the
individual encryption key of the device.
The encryption keys for the device are passed through the publishing server, but are themselves encrypted
and unable to be decrypted other than by the device retrieving the encryption key with the pairing code.
The only system information stored in plain text on the publishing server for each job is the system number,
number of keys in the job and number of doors in the job. This information is used only in the case of
technical problems that require us to aid you.
Put another way, the system description, address, client name, job details, key names, key sections, cut data,
door names, keying, pinning etc are all stored encrypted to an encryption key specific to the device to which
the job was published.
Furthermore, if you generate a new encryption key and pairing code for a device (See Configuring devices 84
), the device will be unable to communicate with the server to retrieve job data until the new pairing code is
entered and even then, existing jobs will be unreadable to the device because the encryption has changed,
and in this case if you want a device to see a job you must re-publish the job to that device.
ProMaster Key Manager 8 ("KM8")
KM8 users may get system updates via the publishing server instead of receiving the updates from you by
email.
KM8 users are configured and associated with your ProMaster Master Keying using a handshake process
during which a pairing code must be entered into KM8 and the pairing code is used to retrieve and decrypt an
encryption key specific to the KM8 installation.
For all subsequent communications to the KM8 (i.e. Sending systems), the data transmitted is encrypted to
the individual encryption key of the KM8 user.
The encryption keys for the KM8 user are passed through the publishing server, but are themselves encrypted
and unable to be decrypted other than by the KM8 user retrieving the encryption key with the pairing code.
The only system information stored in plain text on the publishing server for each system is the system
number, number of keys in the system and number of doors in the system. This information is used only in
the case of technical problems that require us to aid you.
Put another way, the system description, address, client name, job details, key names, door names, keying
etc are all stored encrypted to an encryption key specific to the KM8 user to which the system was published.
Furthermore, if you generate a new encryption key and pairing code for a KM8 user, the KM8 user will be
unable to communicate with the server to retrieve system data until the new pairing code is entered and even
then, existing systems will be unreadable to the KM8 user because the encryption has changed, and in this
case if you want a KM8 user to see a system you must re-publish the system to that KM8 user.
User permissions
There are 5 publishing permissions that you may apply to users.
Configure publishing: This permission allows the publishing service to be configured. See Configuring
publishing 80 .
Configure publishing devices: This permission allows devices to be configured. See Configuring
devices 84 .
Publish jobs to devices: This permissions allows jobs to be sent to the publishing service. See
Manufacture: Publish to device 223 .
Configure publishing for key manager users: This permission allows devices to be configured. See
Configuring Key Manager users 85 .
Publish systems to Key Manager users: This permissions allows systems to be sent to the publishing
114
service in Key Manager format. See Exporting to ProMaster Key Manager .
Support and maintenance
The publishing server is available to users of ProMaster Master Keying as a no-cost service that is available
while ProMaster Master Keying support and maintenance is current.
When your support and maintenance expires, publishing services are no longer available until support and
maintenance is renewed and the new registration information applied to ProMaster Master Keying.
Technical information
The URL of the publishing server is pmpublish01.whsoftware.com
Data is transmitted using HTTPS and operates on the standard port 443.
If the registration information in your ProMaster Master Keying database is not the same as that on the
publishing server then publishing is disabled until you perform Configure publishing again.
Getting started
· From the Setup and Admin menu, select Mobile services then Configure publishing
Configuration status
The configuration status reports the current status of the publishing configuration for your database.
Some examples are:
Message Description
OK Publishing is configured and may be used.
Not configured Publishing has not been configured. To use publishing you must perform
the configure publishing process.
Reconfiguration required The registration information last sent to the publishing server is different
to your registration. To use publishing you must perform the configure
publishing process.
Maintenance and support expired Support and maintenance for your ProMaster Master Keying license has
expired, and publishing services are unavailable until support and
maintenance is renewed.
To use publishing you renew support and maintenance, apply your new
registration code to ProMaster Master Keying and then perform the
configure publishing process.
Publishing status
The publishing status reports the current status of the publishing configuration on the publishing server.
Some examples are:
Message Description
OK Publishing is configured and may be used.
Maintenance and support expired Support and maintenance for your ProMaster Master Keying license has
expired, and publishing services are unavailable until support and
maintenance is renewed.
To use publishing you renew support and maintenance, apply your new
registration code to ProMaster Master Keying and then perform the
configure publishing process.
Publishing service not contactable The publishing service could not be contacted. Most likely this means that
your computer does not have internet access or that your firewall or
security services are prohibiting access to the publishing server.
It is possible, but rare that this may result from the publishing server
being unavailable due to maintenance requirements.
Publishing service remote failure Communication with the publishing server failed. This is not an expected
condition and you should seek support.
Publishing service remote There has been an unexpected condition where your publishing data is not
registration mismatch. Seek consistent with that on the publishing server and this needs support
support. intervention to be resolved.
Not registered with publishing Publishing has not been registered on the publish server. To use
service publishing you must perform the configure publishing process.
Publishing service remote The registration information last sent to the publishing server is different
registration requires updating to your registration. To use publishing you must perform the configure
publishing process.
Publishing is disallowed The publishing server has disallowed your access. This may result from
tampering or unreasonable use or abuse of the publishing service.
Option Description
Allow publishing service to be This must be on for publishing to be available. If you turn this option off
used then publishing will not be available in ProMaster Master Keying.
Option Description
Restrict which devices are When this option is on, the devices available for publishing a job (See
available for job publishing by the Manufacture: Publish to device 223 ) are restricted to those devices
job factory permitted for the factory (See Configuring devices 84 ) used on the job.
This can be useful if you want to configure a factory for a mobile person
and specify that factory on the job, then with your device-factory
relationships configured you can make only the appropriate device
available.
Restrict which devices are When this option is on, the devices available for publishing a job (See
223
available for job publishing by the Manufacture: Publish to device ) are restricted to those devices
system type permitted for the system type (See Configuring devices 84 ) used on the
job. This can be useful restrict which devices are available by system
type.
Option Description
Duration in minutes After you configure a device, a 12 character pairing code is displayed and
this code must be entered into the device. This setting determines the
default amount of time for which the pairing code is valid.
Allow the duration to be altered Normally, this should not be required and the pairing code should be
when configuring a device entered immediately. In the event that you need more flexibility in the
time from generating the pairing code to when it may no longer be used,
you may turn this option on and alter the next two settings.
Duration minimum The minimum duration that may be set for the life of a pairing code.
Duration maximum The maximum duration that may be set for the life of a pairing code.
Option Description
Job life in minutes The default value, in minutes, for how long the job is available on the
publishing server from publishing time.
Job life minimum The minimum value, in minutes, for how long the job is available on the
publishing server from publishing time.
Job life maximum The maximum value, in minutes, for how long the job is available on the
publishing server from publishing time.
Allow the server job life to be If you want each device to have different values for the three previous
configured separately for each settings, turn this option on and configure the job life settings for each
device device.
Option Description
Job life in minutes The default value, in minutes, for how long the job is available on the
device from publishing time.
Job life minimum The minimum value, in minutes, for how long the job is available on the
device from publishing time.
Job life maximum The maximum value, in minutes, for how long the job is available on the
device from publishing time.
Allow the server job life to be If you want each device to have different values for the three previous
configured separately for each settings, turn this option on and configure the job life settings for each
device device.
Option Description
Duration in minutes After you configure a Key Manager user, a 12 character pairing code is
displayed and this code must be entered into the Key Manager. This
setting determines the default amount of time for which the pairing code
is valid.
Allow the duration to be altered Normally, this should not be required and the pairing code should be
when configuring a Key Manager entered immediately. In the event that you need more flexibility in the
time from generating the pairing code to when it may no longer be used,
you may turn this option on and alter the next two settings.
Duration minimum The minimum duration that may be set for the life of a pairing code.
Duration maximum The maximum duration that may be set for the life of a pairing code.
Option Description
System life The default value for how long the system is available on the publishing
server from publishing time.
Allow the server system life to be If you want to alter how long the system may exist on the publishing
altered when sending a system server each time you send a system, you may turn this option on and alter
to Key Manager the next two settings.
System life minimum The minimum value for how long the system is available on the publishing
server from publishing time.
System life maximum The maximum value for how long the system is available on the publishing
server from publishing time.
Making a change
· Use the Add, Remove and Edit buttons to set up your user devices.
When adding a device, a 12 digit pairing code is shown when the device is saved and must be entered on the
device.
When editing an existing device, you may make it inactive.
When editing an existing device, you may choose Make new encryption and pairing code for this
device. A new 12 digit pairing code is shown when the device is saved and must be entered on the device.
Until the device re-registered, it will be unable to retrieve jobs.
Other functionality
Right click a device and choose Factories to choose which factories may send jobs to the device if this
restriction is enabled in the publishing settings.
Right click a device and choose System types to choose which system types may be sent to the device if this
restriction is enabled in the publishing settings.
Right click a device and choose Device info to retrieve information about the device from the publishing
server, including when it was last seen and when the device retrieved the encryption key.
Right click a device and choose Job Info to retrieve a list of jobs that have been sent to the device. Jobs up
to 1 year old are shown. See Device jobs 85 .
The last time a device was seen by the publishing server refreshes automatically when a device is accessed
however you options Refresh last seen time and Refresh all last seen times to force a data update.
An explanation of the options
Use the description field to record who the device is used by. This information must be unique and is shown
on the device also.
Device encryption
These settings are about the pairing code generated for authorising a device to receive published data.
Option Description
For how many minutes will the This value determines how long the device has to retrieve the encryption
key be able to be retrieved by the key by entering the 12 character pairing code.
device The default value and the permitted range are set by the publishing
settings.
These settings determine the length of time that a published job is available on the publishing server for
download to the device.
If permitted by the publishing settings, the values for the device may be entered and then will be used in place
of the global settings.
Option Description
Override the global settings for If you want the device to have different values for the global settings (See
the server job life when sending Configuring publishing 80 ), turn this option on and configure the job life
jobs to this device settings.
Job life in minutes The default value, in minutes, for how long the job is available on the
publishing server from publishing time.
Job life minimum The minimum value, in minutes, for how long the job is available on the
publishing server from publishing time.
Job life maximum The maximum value, in minutes, for how long the job is available on the
publishing server from publishing time.
Option Description
Override the global settings for If you want the device to have different values for the global settings (See
the device job life when sending Configuring publishing 80 ), turn this option on and configure the job life
jobs to this device settings.
Job life in minutes The default value, in minutes, for how long the job is available on the
device from publishing time.
Job life minimum The minimum value, in minutes, for how long the job is available on the
device from publishing time.
Job life maximum The maximum value, in minutes, for how long the job is available on the
device from publishing time.
· From the System menu, select Mobile services then Configure Key Manager publishing
Making a change
· Use the Add, Remove and Edit buttons to set up your Key Manager users.
When adding a Key Manager user, a 12 digit pairing code is shown when the Key Manager Publishing is saved
and must be entered on the client's Key Manager.
When editing an existing Key Manager Publishing, you may make it inactive.
When editing an existing Key Manager Publishing, you may choose Make new encryption and pairing
code for this Key Manager publishing. A new 12 digit pairing code is shown when the Key Manager
publishing is saved and must be entered on the client's Key Manager. Until the Key Manger re-registered, it
will be unable to retrieve systems.
Normally each client will have a single Key Manger Publishing and unless you change the name then it
will be called "Default".
If your client has multiple Key Manager installations and some systems are sent to each location,
create a Key Manager Publishing for each Key Manager installation and permit the appropriate systems
for each Key Manager Publishing.
Other functionality
Right click a Key Manager Publishing and choose System to choose which system may be sent to the Key
Manager.
Right click a Key Manager Publishing and choose Key Manager Publishing info to retrieve information about
the Key Manager Publishing from the publishing server, including when it was last seen and when the Key
Manager retrieved the encryption key.
Right click a device and choose System Info to retrieve a list of systems that have been sent to the Key
Manager. See System Info 86.
The last time a Key Manager was seen by the publishing server refreshes automatically when a Key Manager
Publishing is accessed however you options Refresh last seen time and Refresh all last seen times to
force a data update.
An explanation of the options
Use the description field is used to name the Key Manager pairing when a client has multiple Key Manager
installations. This information must be unique and is shown on the Key Manager also.
Device encryption
These settings are about the pairing code generated for authorising a Key Manager to receive published data.
Option Description
For how many minutes will the This value determines how long the Key Manager has to retrieve the
key be able to be retrieved by the encryption key by entering the 12 character pairing code.
Key Manager The default value and the permitted range are set by the publishing
settings.
· Parameters for the systems that belong to the system type, such as locking system, number of cuts, depth
and space data and defaults that are used when creating new systems.
· The manner in which systems are numbered for the system type.
· The relationship between locks and cylinders for the system type.
ProMaster Master Keying does not automatically create system types because almost always there are
choices that you must make.
You may create as many system types as you like, and is particularly useful for design modules that support a
diverse range of products to create system types for each product and for each use the functionality
(described below) to restrict each system type to only the applicable key sections.
Getting started
· From the Setup and Admin menu, select System types
Making a change
· Use the Add, Remove and Edit buttons to set up your system types.
Once a system type is created, the design module, lock system and card cannot be changed. If you
then use the system type, and code a system on the wrong lock system or card, the only way to
correct this is to remove the system coding and change the system to a correct system type. The
choice of card (on applicable design modules) determines the depth symbols available.
Explanation of data fields
Pad length to Used to generate system numbers. Used in conjunction with the field
above. For example if this value is 6, then the system numbers generated
will be ABC001, ABC002 etc.
Cylinder position A lock (let's call it an XYZ) may be fitted to a door, but depending on the
locking system one of several cylinders may be fitted. Each lock has 100
slots where the cylinder part codes for a system type are associated with
the lock parts. So, our XYZ lock may use slot 1 for Sargent 6 Pin, slot 2 for
EVVA DPE, slot 5 for Kaba Expert.
This value is used when creating locks and defining the relationship
between locks and cylinders. See Entering locks 58
· The actual slot number you use for a system type is not important,
provided you do not alter it after you begin defining the relationship
between locks and cylinders.
· Make a selection from the drop down list for the lock cylinder ranking.
The list shows you where each slot is already used to assist you in
avoiding duplications.
· If you only ever record cylinders against your doors, and you never use,
record, supply or otherwise think about a lock that may have a cylinder
installed in it, then the lock cylinder rank has not meaning to you.
Default days for job When a job is made, the job due date is set automatically based on the
current date and the "Default days for job" defined by the system type.
· Enter your expected lead time in this field.
· Unless you work with known or significant lead times, you may choose
to set this to 1.
Default factory You may specify a default factory for this system type that will be used
automatically when creating jobs. This is particularly useful if you
manufacture one type of locking system at one location and another type
of locking system at another location.
Key sections Some design modules allow you to restrict the key section families that
are available to each system type at the time when you create a system
design.
· To restrict the profiles available, check the key section families that are
allowed.
· If none are checked then all will be available.
Advanced parameters Premium and Manufacturer edition only.
Various parameters that control which data is mandatory when jobs are
released to manufacturing.
Test key method Premium and Manufacturer edition only, and only if test key functionality is
included in your license.
Determines what type of test keys will be generated when a job is
released to manufacturing. Unless special circumstances exist, "Method
1" is the correct choice if you want the test key calculation to be
performed and "None" if you do not want it.
Integration Manufacturer edition only.
Some parameters that can be used defined for integrating with
manufacturing processed.
Getting started
· From the Setup and Admin menu, select Key colours
· Select the design module you want to alter. The list of design modules contains all design modules you
have available in your license that use key colours.
Making a change
· Use the Add, Remove and Edit buttons to set up your colours.
· Enter your colour and short colour. Short colours are required for design modules that have multi-colour
keys. Try to keep the colours short and short colours very short - if you make them too long they will be
truncated on screen and on printouts.
Other functionality
Click the Options button then Export csv to export the data to a csv file. See Exporting design module
data 98 .
An explanation of the options
· Within each design module, each colour may appear only once
Each time a colour is used, it is referenced to the colours you define here. So, if you make a colour
called Yellow, then use that colour on some keys, then later decide to be smart by changing the colour
to Red, what you have done is alter every key that uses the colour. So to put it another way, then you
click Edit to alter a colour, do so with the intention of fixing a spelling mistake or if applicable the short
colour, but not to completely change a colour.
Fixing duplicate colours
You may do a lovely job of setting up your colours, then one day you import a system from another user who
has defined the colours differently. ProMaster Master Keying does not have any magic linguistic powers, so it
creates any colours required by the import rather than applying rules to detect misspelt colours. Now for
example you have Yello and Yellow, and you really don't want the misspelt Yello. Here's what you do:
· Select the colour that is the erroneous duplicate.
· Right click on it and select "Remove this colour and replace it with another colour"
· Enter the confirmation requested, pausing to ensure you have selected the correct colour for the
replacement.
· Click OK to apply the change. Everywhere that the replaced colour is used is changed to the replacement
colour, then the replaced colour is removed.
This affects every key in the design module using the replaced colour. If you do something stupid like
replacing "red" with "yellow" there is no going back.
· Select the design module you want to alter. The list of design modules contains all design modules you
have available in your license that use key colours.
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
· Select the design module you want to alter. The list of design modules contains all design modules you
have available in your license that use key sections.
· For design modules that use rotor stators, see the topic Kaba rotor stators 93 .
Other functionality
You may right click key section and choose Replace key section family from the pop-up menu to remove
the selected keys section family and change all systems that use it to another family. See further down this
topic for details.
You may right click key section and choose Systems on this key section from the pop-up menu to see a list
of systems that use the key section family.
You may right click key section and choose Print key section family from the pop-up menu to produce a
matrix report off the key sections and keyways in the family.
Click the Options button then Print to produce a report of key section families returned in the search.
Making a change
· Use the Add, Remove and Edit buttons to set up your key section families.
· When you add a key section family, the behaviour differs between design modules.
· For modules that always or almost always don't use key section families, you are first asked for a key
section and then a key section and keyway are created with that name, and often that is the only
information required.
· For design modules where it is more normal to have multiple key sections or keyways in a family, you are
presented with the "New key section-keyway family" screen. This is a "quick start" option - anything you do
here can be altered in the full editor so don't panic.
Each time a key section is used, it is referenced to the key sections you define here. If you make a
change to a key section family, it affects all the systems using those key sections.
Exercise the utmost care when making changes as the change may affect many systems and some
changes are not reversible.
If there are other key sections and keyways, add them on the corresponding lists, one per line.
After you click OK you will be placed in the editor.
Key sections and keyways editor
The editor is a moderately complex screen where you can add, remove and edit key sections and keyways,
sort key sections, sort keyways, and change which keys sections fit each keyway.
Any key sections and keyways that are not assigned are indicated with a warning graphic.
Right click on the editor where the key section and keyway intersect for a pop-up menu with more options.
When you "find" for a key section or keyway the matching items are indicated with an arrow graphic.
The root key section is always first, but all other key sections and all keyways may be rearranged using the
sort options.
The family description is optional, but can be useful for clarification if you have key section families belonging
to a variety of lock systems.
When you save a key section family, it marked as complete if all key sections are assigned to a keyway and
all keyways are assigned a key section. If the family is incomplete, fix it.
Users of previous versions of ProMaster Master Keying should note that all functions are integrated into
the editor instead of using popup task windows as in the previous versions.
Replace key section family
This option is used to replace an entire key section family with another, and make the changes to all systems
using the replaced key section family.
To give an example of replacing a key section family, imagine this scenario:
Let's say you had a key section called ABC with profile DEF beneath it.
Now you import a system from another ProMaster Master-Keying user and because their key sections are
wrongly named, the system import has created let's say ABC1 with DEF1 beneath it.
What we want to do is change all occurrences of ABC1 to ABC, and change all occurrences of DEF1 to DEF.
Here's how:
· Select key section family ABC1, right click, select Replace key section family
· The Replace Key Section Family window opens. Click Select replacement key section family then
select the key section family that is to replace ABC1, in this example ABC.
· The key sections from the replacement family are loaded.
· Now you define the relationship between the old (replaced) key sections and the new (replacement) key
sections.
Use the two lists and the Assign replacement key section button to create a mapping from each replaced
key section to the appropriate replacement key section.
Now, key and each system using each of the old key sections will have its references changed to that of the
new key sections. This may take a little time. Each system that is changed will be marked to indicate that it
needs its coding checked. Finally, the replaced key sections, which are no longer in use, will be removed.
Interchangeable Core
In some design modules (E.g. Medeco Original 10, Medeco Biaxial 10, Interchangeable Core) the key section
properties include an option for the core removal type.
Most key sections will be "Standard" but for families that have other key sections for core removal purposes
(E.g. Yale long key, Schlage long key) you must set the core removal type correctly on those key sections.
See also the properties in the cylinder setup for defining the cylinder core removal method.
· From the Setup and Admin menu, select Key sections and keyways
· Select the design module you want from the ones listed above.
8.5.5 Lists
Lists are the mechanism by which lock manufacturers may control the top master key for their locking
products to ensure geographic separation and avoid system interchangeability.
They control the way ProMaster Master Keying creates the TMK for your system and which positions on the
code may be progressed to generate permutations.
Lists are used primarily in high end lock systems that are positioned to the customer as having unique or
restricted key codes.
WH Software Limited does not supply the list data. List data is always supplied and maintained by your
lock manufacturer.
· From the Setup and Admin menu, select Lists then Import and maintain Abloy Novel lists.
If you have permissions to setup lists, then you will be able to access this screen from the list selection when
creating the design for a system.
Managing lists
The "Manage Lists" window shows lists available to you.
The graphic indicates the list level (I.e. how many positions are under your control).
On the list value, "X" positions are under your control and other positions are fixed.
Each list is for the key section shown adjacent to the list.
Lists are created by the manufacturer as split-able (or not) and reuse-able (or not).
Split-able lists, provided they are not used, may be split into a number of smaller lists. If the list has been
split, it becomes unavailable for systems, and the sub-lists beneath it are available.
Reuse-able lists may be used for multiple systems.
Importing lists
· Click the Import button then select the file supplied by the lock manufacturer.
· To join a list, highlight the split list that you want to join and click the Join button.
o A list may not be joined if any of the split portions have been used.
o A list may not be joined if any of the split portions have been split.
· From the Setup and Admin menu, select Lists then Import and maintain Abloy Protec lists.
If you have permissions to setup lists, then you will be able to access this screen from the list selection when
creating the design for a system.
Managing lists
The "Manage Lists" window shows lists available to you.
The graphic indicates the list level (I.e. how many positions are under your control).
On the list value, "X" positions are under your control and other positions are fixed.
Each list is for the key section shown adjacent to the list.
Lists are created by the manufacturer as split-able (or not) and reuse-able (or not).
Split-able lists, provided they are not used, may be split into a number of smaller lists. If the list has been
split, it becomes unavailable for systems, and the sub-lists beneath it are available.
Reuse-able lists may be used for multiple systems.
Importing lists
· Click the Import button then select the file supplied by the lock manufacturer.
· To join a list, highlight the split list that you want to join and click the Join button.
o A list may not be joined if any of the split portions have been used.
o A list may not be joined if any of the split portions have been split.
· From the Setup and Admin menu, select Lists then Import and maintain Kaba ACE lists.
If you have permissions to setup lists, then you will be able to access this screen from the list selection when
creating the design for a system.
Each list may be used only once.
Make a selection of the type of lists you want to see (Serial perms, Base perms LEFT, Base perms RIGHT).
Managing lists
If a serial perm has been used on a system that has been created as a KD System, then the Used by
system value is shown as "KD System"
If a serial perm has been allocated to a KD system, and then subsequently removed (either the key was
removed or the system coding was deleted), the serial perm is not released to be re-used. This would not
happen under normal circumstances, but may happen during the creating and deletion of test systems. In this
scenario it is necessary to recover the serial perm values. To do this, chose "Serial perms" at the top of the
window, then right-click on the list of serial perms and choose the option Recover serial perms that were
allocated to keys and the keys no longer exist.
The recovery process should not be performed whilst other people are performing coding on Kaba ACE
KD systems.
If you have permissions to setup lists, then you will be able to access this screen from the list selection when
creating the design for a system.
Each list may be used only once.
Managing lists
The "Manage Lists" window shows lists available to you.
The capacity (number of positions that may be progressed) are shown for Left only, Right only and total (Left
+ Right).
The number of rotor stators allowed is shown.
If the list is for serial permutation the Kaba system number is shown.
Importing lists
· Click the Import button then select the file supplied by the lock manufacturer.
If you have permissions to setup lists, then you will be able to access this screen from the list selection when
creating the design for a system.
Each list may be used multiple times.
Managing lists
The "Manage Lists" window shows lists available to you.
On the list value, "X" positions are under your control and other positions are fixed.
Each list is for the key section shown adjacent to the list.
Importing lists
· Click the Import button then select the file supplied by the lock manufacturer.
In addition to the export from the file menu described here, within most of the search screens for each type of
data there is an menu option "Export csv" on the options button that invokes this export with the types of data
refined to those related to the screen from where you chose to export data.
Getting started
· From the File menu, select Export then Export parameter data (CSV).
A simple wizard steps you through the process of choosing where the data will be written, choosing which
data to export and choosing export options.
Multiple types of data may be exported at the same time. Each type of data is written to a separate file,
named according to the type of data.
When choosing the range of data to export, you may right click on the list for selection options. The types of
data are defined in logical groups allowing you to select or deselect the whole group in a single operation.
Notes
When exporting lock or cylinder images, CSV files are produced and the data files for the images and
documents are written to sub folders beneath the export location.
Clearly any notes that are stored in rich text format are not suitable for exporting to a CSV file and these data
fields will not be included in the export.
Part
9
100 ProMaster Master Keying
9.1 Clients
Each system belongs to a client. A client may have more than one system.
Getting started
· From the Setup and Admin menu, select Clients
Making a change
· Use the Add, Remove and Edit buttons to set up your clients.
Other functionality
You may right click a client and choose Client signatories from the pop-up menu to maintain client-level
101
signatories. See Client signatories .
Click the Options button then Export csv to export the data to a csv file. See Exporting parameter data to a
csv file 98.
Click the Options button then Import csv to import data from a csv file. See Import clients from a csv
file 100
An explanation of the options
When adding a client or editing an existing client, the only mandatory data field is the client name. However
is is good practice to record as much information as accurately as possible.
The notes tab provides a space for you to record miscellaneous information about the client.
The systems tab shows the systems that are associated with the client.
Notes
If you have a system open and permissions to edit the client (see Security groups 45 ) then the client for the
current system will be editable from the System menu then Client.
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Next
The Operation determines how the import is processed. Choose if you want new items, if you are updating
existing items, or both.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Making a change
· Use the Add, Remove and Edit buttons to set up your client signatories for the selected client.
9.3 Systems
Before any work may be done on a system, you must first open it.
If the system is open by another user you will be denied access to it.
Getting started
Option Description
Status Normally only Active systems are returned. Change this value if you
want to find closed systems or system snapshots.
Show only systems with pending This option is useful for work flowing your coding staff. It allows you to
jobs that require coding find systems that are not completely coded, but have a job that is in the
data entry state (if you have not turned on the "Coding" status in the
application parameter "Send jobs to coding when released if coding is
required") or are in the coding required state.
System type Allows you to specify the system type of the system you are searching
for. Also enables searching by key section. Additionally you may select
from the list a design module instead of a system type, thereby
searching all system types for that design module.
Key number The system must have a key with the exact Key number that you enter,
or if you have enabled Key stamping in your application parameters then
the key number you enter must match either the key number or the key
stamping of a key within the system.
System key section You may select the System key section for systems that will be located.
You must first select the System type.
Key key section The system must have a key with the selected key section, and if the key
number was entered then it must match the same key as the key number.
Code Allows you to specify a Key code for the search.
Look in change keys also Normally the key search excludes change keys (I.e. Masters, selective,
control keys etc only). Turn this option on to search in change keys also.
In performing a search, ProMaster Master Keying returns systems that match all criteria, so while
entering more information may narrow your search, it is also possible that you may refine the search
so much that nothing matches.
System security
If you do not have security rights to Open high security systems, then only low security systems will be
shown.
If you do not have security rights to Open systems based on its design, then some search criteria will be
unavailable.
When you open the system, any assigned Security categories are validated against your security category
rights, and if you do not have the necessary permissions then you will be unable to open the system.
Getting started
· From the System menu, select New system
For the System description, enter a description of the master-key system that provides some meaning as to
its location and/or client and/or building.
Step 3: Address and contact
Enter the address of the installation, and any other contact information you have.
Step 4: System Details
Installed on: Alter the installation date to reflect when the system is likely to be installed. In the future you
may do some systems analysis to determine the level of system activity and the age of systems, so this date
will become important.
Keying type: Keying type serves a few purposes. First, on some design modules it is used to select a keying
type that allows construction keying. Second, it allows you to classify systems for analysis purposes, and third
it may be used as an indication to the type of coding required when later the coding is performed. See Keying
types 53
Use key and door issue numbers: Normally this option would be left on. Sometimes records are so poor
on old paper based systems or from basic master-key software that there are no records of issue numbers. In
that situation you may want to turn this option off so that future keys and doors are not marked with an issue
number.
Allow door hardware recording: If you turn this option on, you will be able within this system to record
door hardware items other than the locking products.
User must have high security access to open this system: Each user has a flag as to whether they
may access high security systems. That flag is matched with this one to determine if the user may open the
system. This is a bit of a blunt instrument, and you may wish to consider Security categories (described later)
for more granular control over system security.
Use DHI key and door numbering: Defaults according to to the application parameter Terminology. If it
is set to USA then this parameter will default to on.
Marking 1, 2, 3: Additional marking parameters available on premium and manufacturer editions. These
values are used in the job XML files.
Step 5: Signatories And Orders
Number of signatories required to order keys: This is the global number of signatories required to order
any any key, provided that there is not individual signatory security in place for the key.
Type of key signatory security: This option controls the type of signatory security that is applied to the
115
keys. See Signatories for an explanation of the choices.
Number of signatories required to order doors: This is the global number of signatories required to
order any any door, provided that there is not individual signatory security in place for the door.
Type of door signatory security: This option controls the type of signatory security that is applied to the
115
doors. See Signatories for an explanation of the choices.
Quantity of each key to order: This number is used when adding keys. If you set this to 2, then as you
add keys, the default quantity of each to order will be 2. If you don't like ordering keys at the same time as
you create them, make this option zero. The default for this option comes from the corresponding Application
parameter 49.
Quantity of each door to order: This is for doors as the option above is for keys.
Step 6: System notes
This is where you may record a virtually unlimited amount of notes about the system.
Step 7: Job Notes
Any notes you enter in the job notes are copied into each new job as the default notes. If the customer has
particular job instructions that you want to accompany each job, this is the place to record them.
Step 8: Security
Security categories are used to restrict access to systems and correspondingly grant access to particular
users.
Select any security categories that you want to apply to this system.
If the current user is not permitted to access systems without a security category then you must select one or
more security categories. A user is permitted to assign only those security categories to which the user is a
member.
Here's how it works: If a system is associated with a security category, then only users who are in a security
group associated with the same security category may open that system. A system may be associated with
several security categories, thereby allowing several groups of users access, and similarly a security group
may be associated with several security categories, allowing access to any systems in those security
categories.
See Security categories 48 to define security categories.
Step 9: Finish
Click Finish to save the new system.
Level: If DHI numbering is not being used, leave this at 0. If DHI numbering is used, choose the level you
require for the system (from 2 to 7).
For DHI systems with a simple hierarchy, all you need to do is change the quantity of each key that is required
and if doors are to be created, select the lock to be used (on the "Change' key node)
Then, use the Add master, Add change and Add selective buttons to build up a structure of your system.
If your system is asymmetric you can add multiple masters under any master to build the structure.
Step 10: Finish
Click Finish to save the new system.
How it works - International
There are a number of parameters that control how the keys are generated. Most settings are stored so that
next time you add a key (in the current system or another one) your preferences are remembered.
Setting Description
Starting characters The characters you want at the start of the key number. If the option
"Create a single key" is chosen then this value is the entire key number,
otherwise the rest of the key number is generated according to your other
choices.
Create a single key... Available when the quantity is set to 1, this makes a single master key.
This is particularly useful for asymmetric systems for creating masters
with each branch with a different name.
Quantity of keys to create... The number of keys to create. 1 or more. If the value is 1 for master
keys, the option "Create a single key" is available
Numbering style Numeric: Numbers keys using the sequence 1,2,3...
Alpha: Numbers keys using the sequence A, B, C...
Length to make the number When numbering style is numeric, this is the minimum length to use
forthe numeric portion.
E.g.: Starting characters = "MK", Numbering style Numeric, Length = 4,
then key numbers will be MK0001, MK0002 etc.
Number from the key above For an example, the master above is "MK", numeric, Length = 0, quantity
3, resulting in keys MK1, MK2, MK3.
Now make a change key node, starting "C", numeric, Length = 0, quantity
2, separator "."
For each of the choices, here are the key names produced:
Do not use it to make this key: C1, C2, C3, C4, C5, C6
Place it before the number of this key: C1.1, C1.2, C2.1, C2.2, C3.1,
C3.2
Place it after the number of this key: C1.1, C2.1, C1.2, C2.2, C1.3,
C2.3
Separate the number from the This is the character to place between the key number and the number
key above with this character from the key above if it is being used. In the example C1.1 the separator
used is "."
If alpha numbering is used for masters and numeric for change keys then
it may be desirable to have the separator blank.
For change keys, there is an option to create a door. The door settings are:
Setting Description
Create a door for each key Select this option to have the doors created
Numbering Generate: The door number is formed from the door prefix and then the
key number.
Same as key: The door number is made the same as the key number.
Sequential: The door number is created sequentially. 1,2,3... and is
prefixed by value of Door prefix.
Door prefix The starting characters if the numbering is Generate or Sequential.
Stamping Key number: The stamping is set to the key number.
Door number: The stamping is set to the door number (which could be
the same as the key number).
Sequential: The door number is created sequentially. 1,2,3...
Description The description to use for each door.
Area The area to use for each door.
Lock The lock or cylinder to use on the door. Choose from the list of values
already used or click Select lock.
Two templates are provided. They are stored in the Templates folder beneath the ProMaster Master Keying
program folder (e.g. C:\Program Files (x86)\WH Software\PM8\Templates)
Premium and Manufacturer edition only: There is a template definition provided for reading old PM7 "xls" files.
This will read the first page only. This should be used for transitional purposes only and all future work
should use the PM8 excel template definition. The PM7 template definition is for new systems only, not for
extending or for exporting.
Using the templates
Entering doors
Doors are entered one per line. The cells on the first line of doors have notes that you may read in Excel on
how to enter the data. You may leave blank lines between doors to improve readability, however a gap of
more than 4 lines is considered to be the end, and any doors after such a gap will be ignored.
Entering Keys
Keys are entered one per column. The cells for the first key have notes that you may read in Excel on how to
enter the data. You may leave blank columns between keys to improve readability, however a gap of more
than 4 columns is considered to be the end, and any keys after such a gap will be ignored.
Entering keying
At the intersection of each key and door, place an X if the key is to operate that door.
Before you import the system into ProMaster Master Keying
When you get your file back from your customer, here's some do's and don't's:
· Do save the file onto your computer.
· Do open it in Excel before you import it into ProMaster Master Keying and study it for mistakes. If it has
errors, the import will reject it, so best you find them first.
· Do not leave the spreadsheet open in Excel when you perform the import into ProMaster Master Keying.
Getting started
· From the System menu, select New system from Excel file
After the import is complete, review your doors, keys and keying, then proceed to coding and manufacturing
as you would with a system you entered yourself.
· Once the system has been exported to a client using ProMaster Key Manager you may not change the
System number.
Getting started
· You must be logged in with a system open.
· From the System menu, select Import system extension from Excel file
Importing data
Select the Excel file to import and choose the template definition that corresponds to the file you are
308
importing. See Excel template definition for information about making your own definitions to match a
custom Excel file layout.
Several options allow you to decide how doors, keys and keying will be imported.
After opening the file, its contents are analysed and if there are errors they are reported. Errors must be
corrected before importing.
Some comparison information is shown between the system that is open and that within the Excel file. Please
confirm that this information is correct before proceeding.
Select the Factory that will be used for making a job if doors or keys are ordered by the extension.
Other than changing the description on existing keys, and the description, area, stage and notes on
existing doors, no other modification will be made to existing items. Keying will never be altered for
existing doors unless you make the choice to create keying for any doors that have not yet been keyed.
Any door that has keying will never have its keying altered by importing a system extension.
Getting started
· You must be logged in with a system open.
Making a change
Choose the new status you want.
Notes
Here is an explanation of the system status values.
Status Description
Active The system is able to be worked on. This is the normal status for
systems.
Closed Use this status when a system is no longer in service. This will prohibit
any further activity to the system (other than opening the system and
changing its status). This is a better option than deleting s system.
Snapshot This is the status that is set when you make a snapshot of a system - see
110
System snapshot (it is set on the copy, not on the original system - the
original system is not altered). A snapshot system may not be altered,
but you may wish to revert to it by changing its status to "Active". If you
do this you should also mark the previously active system as being a
snapshot (or possibly even deleting it) so there is absolutely no confusion
about which copy of the system you are working on.
Notes
A new system number will be offered for the snapshot. You may alter this if you wish but generally the
generated name is adequate.
See also Change system status 110 for turning a snapshot into an active system and Systems 102
for finding
snapshots (Normally snapshots are not returned by the system search).
· From the System menu, select Create a new system from this system.
· Keys, key groups, doors, door groups, keying, signatories etc are copied according to the options you
selected.
· The coding design is not copied.
What next
The system that is created is just like that which would result from you creating a new system, then entering
keys, doors, keying etc.
Next you should modify the new system to set its system type and other such parameters, make any key or
door changes required, then proceed with coding.
Deleting a system removes the system, all doors, keys, keying, jobs etc. A system cannot be deleted
until its design is deleted.
Getting started
· You must be logged in with a system open.
Making a change
· You must enter the specified text before proceeding.
There is no undo. When you type the confirmation text and click OK, the system is gone.
· To sent the system to a lock manufacturer so that a large order may be processed by their factory.
ProMaster Master Keying allows systems to be exported without restriction to ProMaster Master Keying.
Premium and Manufacturer edition only: It is also capable of exporting to ProMaster Master-Keying 7,
however some rules are applied to govern the data integrity.
Export to versions prior to version 7 are not supported.
· If the ProMaster Master Keying system uses a design module that was not available in a previous version of
ProMaster, then the export is not possible.
· If the ProMaster Master Keying system uses features that result in data that is not possible to use in a
previous version of ProMaster, then the export is not possible.
There is an extensive set of reasons why a system might not be able to export to an older ProMaster,
including longer field names, new features, internal keying on doors, characters not supported by the
older version.
If you choose to export to an old version and the export is not possible, you will be shown the reason(s) why.
Getting started
· You must be logged in with a system open.
Exporting data
· Choose what to export. The default selection is to export just the current system, however if you have
multiple systems for the client you may choose to export them all.
· Choose the folder where the file(s) will be written
· You may choose to omit documents from the export, and to include an descriptive annotation to include in
the export file.
Finally, choose what you want to happen after the export and click Finish.
Importing data
File
Select the ProMaster file to import.
File contents and origin
A summary of the file contents is shown, including where the file came from, when it was created, the system
type, the design module and the number of doors, keys, keying and jobs.
System number
You are asked about system numbers. The choices available depend on a number of things, including:
· Is there an existing system with the same System Number?
If there is an existing system with the same system number, you must rename either the existing system
(which you may be planning to remove anyway) or the system being imported.
Make your choice on system numbers.
If you choose to change the existing number, there is a choice to convert the existing system to a
110
snapshot (See System snapshot ). This is a good thing to do.
System type
The system type for the system being imported is shown.
A list of compatible system types that you have defined is shown.
Choose the system type to use when the system is imported.
Key sections on the import are matched up to your key sections.
· If a key section family with the same top key section exists and it contains all the necessary key sections,
then there is no further action required.
· If a key section family with the same top key section exists and is is missing some key sections required by
the import, you must fix it before importing.
· If a key section family with the same top key section does not exist, and the file is a version 8 file, the key
section family will be created.
· If a key section family with the same top key section does not exist, and the file is a version 7 file, the key
section family will not be created, and you must create it yourself. This is because the key section storage
has changed in ProMaster Master Keying and sometimes not all necessary information is present for the key
section family to be created automatically.
Locks
For each lock, choose if you want to use the existing item (if it exists), use a different item, or create the item
(if it does not already exist).
If the file is from ProMaster Master Keying then these choices are remembered in relation to who sent you the
file and automatically offered next time.
If the file is from version 7, then these choices are remembered as a global set of information and
automatically offered next time. The version 7 file does not contain the necessary identifying information to
remember your choice in relation to the source of the file.
Post import tasks
If a system existed with the same system number as that you imported, you have the opportunity to analyse
the differences between the original system and the imported system, and also to remove the original system.
Unless you are confident that the new system genuinely replaces the existing system, it is better to
leave the old system, preferably as a snapshot (i.e. Don't remove it), then examine both systems
111
carefully before deleting the old system. See Deleting a system to learn about deleting a system at
some later time.
Exporting data
· A name for the export is offered. You may choose a different file.
· Choose the excel template to use (there are two that ship with ProMaster Master Keying byt you may have
added some of your own)
· Choose the template definition that corresponds to the excel template layout. See Creating a system from
107
Excel for information about excel files and template definitions.
· Choose how you want door quantities and key quantities exported.
· Finally, choose what you want to happen after the export and click Finish.
The ProMaster Master Keying Excel imports and exports do not require Excel to be installed to read or
write the files. You must have Excel installed if you want to view or alter the Excel files.
Exporting data
· Choose what to export. The default selection is to export just the current system, however if you have
multiple systems for the client you may choose to export them all.
· Choose the folder where the file(s) will be written
· The first time you perform an export to your client, you must select from the drop down list the version of
ProMaster Key Manager that your client has. This selection is remembered for future exports, but may be
altered if necessary (e.g. Client upgrades to a new version of ProMaster Key Manager).
Versions prior to ProMaster Key Manager 7 are not supported due to the changes in field lengths and
Unicode character set.
ProMaster Key Manager 8
If you have publishing configured (See Configuring publishing) 80 and your client is using ProMaster Key
Manager 8 then you can send the Key Manager system data to your client via the ProMaster publishing
service.
See Mobile services 79 about permissions for configuring Key Manager Publishing and permissions for
sending systems via the publishing service.
· Choose the Key Manager publishing configuration. Almost always for each client there should be just 1 to
choose from and it will be called "Default"
· Note that the system you are exporting must be permitted for the selected publishing configuration (See
Configuring Key Manager users 85 ). If you have the required permission, the Configure Key Manager
publishing button will be available.
· If you are not using the Key Manager 8 publishing service then choose what you want to happen after the
export and click Finish.
Update your client regularly. You must export this key management data to your client whenever
changes are made to the system or an order is processed for doors or keys.
9.5 Signatories
Signatories are the people who are authorised to order keys and doors. The manner in which signatories are
treated depends on way signatories are configured for your system.
System settings
The system settings which you configure are:
· Number of signatories required per to order keys.
· All keys require the system specified number of signatories: The quantity set for "Number of
signatories required per to order keys" is required to order any key. Any active signatories may make up the
required number of signatories - but read also about mandatory signatories.
· Allow a different number of signatories required for each key: The quantity set for "Number of
signatories required per to order keys" is required to order any key, but each key may be given an
overriding number of signatories required for just that key. Any active signatories may make up the
required quantity of signatories - but read also about mandatory signatories.
· Individual signatories permitted and allow different number of signatories required for each
key: The quantity set for "Number of signatories required per to order keys" is required to order to order
any key, but each key may be given an overriding quantity of signatories required for just that key. Each key
must be assigned the signatories who are allowed to authorise that particular key. Any active signatories
from those assigned to each key may make up the required number of signatories for that key - but read
also about mandatory signatories.
The choices for doors are the same, but separate from the key choices.
Getting started
· You must be logged in with a system open.
Making a change
· Use the Add, Remove and Edit buttons to set up your signatories.
Right click a signatory and choose Key authorities to change which keys this signatory may order. Available
118
when the type of key signatory security is "Individual signatories...". See Key authorities .
Right click a signatory and choose Door authorities to change which doors this signatory may order.
Available when the type of door signatory security is "Individual signatories...". See Door authorities 119 .
Right click a signatory and choose Copy authorities from another signatory to copy key or door
authorities from another signatory to the selected signatory. Available when the type of key or door signatory
security is "Individual signatories...". See Copying authorities from another signatory 120 .
Right click a signatory and choose Convert signatory from system signatory to client signatory to
promote the system signatory to become a client signatory. If a client signatory exists with the same name
then the that client signatory will be used, otherwise a client signatory will be added.
Right click a signatory and choose Convert signatory from client signatory to system signatory to de-
attach the signatory from the client signatory of the same name and leave it as a stand-alone signatory in the
system.
Click the Options button then Add from client to select a client signatory and add it to the system.
Click the Options button then Import signatories from another system to select the signatories in
another system and add them to the current system. See Copy signatories to this system from another
121
system .
Click the Options button then Key authorities matrix to open a matrix of signatories and keys where you
may alter an authority. Available when the type of key signatory security is "Individual signatories...". See
Key authorities matrix 118 .
Click the Options button then Door authorities matrix to open a matrix of signatories and doors where
you may alter an authority. Available when the type of door signatory security is "Individual signatories...".
See Door authorities matrix 119.
Click the Options button then Display authorities to toggle the display of doors and keys on or off.
The choices Copy this signatory to other systems and Import signatories from another
system make copies of signatories but is better replaced with the client signatory functionality.
Photo
Like for the signature, the signatory photo is displayed for verification when you are entering an order, and
may be beneficial for verifying over-the-counter orders.
115
See Signatories .
A list of jobs is displayed.
Option Description
Find key Search for keys. Keys that start with the text you enter are indicated with
a purple arrow. If there is a key that is a full match for the text you
entered then that key is selected as well as the purple arrow.
Key details Shows information about the current key.
Find signatory Search for signatories. Signatories that start with the text you enter are
indicated with a purple arrow. If there is a signatory that is a full match
for the text you entered then that signatory is selected as well as the
purple arrow.
Signatory details Shows information about the current signatory.
Toggle authority Toggles the authority for the selected cells.
Authority on Turns authority on for the selected cells.
Authority off Turns authority off for the selected cells.
This key | Key on Turns authority on for the selected key for all signatories.
This key | Key off Turns authority off for the selected key for all signatories.
This key | Undo changes to this Undoes all changes to the selected key, reverting it to the authorities it
key had when you opened the window.
This signatory | Signatory on Turns authority on for the selected signatory for all keys.
This signatory | Signatory off Turns authority off for the selected signatory for all keys.
This signatory | Undo changes to Undoes all changes to the selected signatory, reverting it to the authorities
this signatory it had when you opened the window.
Other functionality
Right click on the matrix for other option. Some options on this pop-up menu are the same as the toolbar
(however you can learn the shortcut keys by looking at the pop-up menu), but he new options are listed here.
Option Description
Change orientation Swaps the location of signatories and keys in columns/rows.
Show indicator for unassigned Turn on to show a warning graphic by each key that does not have
signatories and keys signatories assigned and by each signatory that does not have keys
assigned.
Find next ... Navigates from the current location to other authorities in each direction.
Notes
A green + graphic indicates each authority added and a red - graphic indicates each authority removed.
Changes are not saved until you click OK.
Option Description
Find door Search for doors. Doors that start with the text you enter are indicated
with a purple arrow. If there is a door that is a full match for the text you
entered then that door is selected as well as the purple arrow.
Other functionality
Right click on the matrix for other option. Some options on this pop-up menu are the same as the toolbar
(however you can learn the shortcut doors by looking at the pop-up menu), but he new options are listed
here.
Option Description
Change orientation Swaps the location of signatories and doors in columns/rows.
Show indicator for unassigned Turn on to show a warning graphic by each door that does not have
signatories and doors signatories assigned and by each signatory that does not have doors
assigned.
Find next ... Navigates from the current location to other authorities in each direction.
Notes
A green + graphic indicates each authority added and a red - graphic indicates each authority removed.
Changes are not saved until you click OK.
When you click OK, authorities on the signatory are replaced to be the same as the one that you choose to
copy from.
Choose if you want to only add new signatories, or if the signatory matches an existing one if you want to
update the signatory details.
9.6 Documents
Any amount of documentation may be stored within a system. Documentation may be notes only, or images,
or any of the supported document types (e.g. zip, rar, pdf, xps, msg, rtf, txt, doc, docm, docx, xls, xlsm, xlsx,
ppt, pptm, pps, ppsm, pptx, ppsx).
Documents may be related to the system only, or may be tied to a particular job.
Once a document has been added to the system it is immutable.
Getting started
· You must be logged in with a system open.
Making a change
· Use the Add, Remove and Edit buttons the manage your documents.
When you add a document, you will be asked if you want to add a document, image (load from disk, capture
from scanner or paste from clipboard) or notes only.
If you are storing an image (from a file, your scanner of the clipboard), you will be presented with the image
308
in the image editor (see Image editor ) where you can perform edits to the image to optimise it for
readability and size.
You may drag a file from Windows Explorer or Microsoft Outlook and drop it onto the target instead of
choosing a source and clicking OK to select the file. The file you drop must be one of the accepted document
or image types and it must be a single file.
You may drag the whole message (.msg file) from Outlook into the document store. Outlook Express EML files
are not supported.
Document properties
· You must provide a Type for your document before you store it. The Type is used for easy identification of
the document at a later time.
· The document description should contain a useful description, helpful when later retrieving the document.
· A tab shows your document, and another tab is provided where you may record notes about the document.
The document properties may be edited at a later time, but once saved, the actual document (image, PDF,
DOC etc) is immutable.
You may print the graphic by clicking on the Print button.
Other functionality
Option Description
Move up Changes the order that documents will appear in the system. Available
only when all items are being displayed.
Move down Changes the order that documents will appear in the system. Available
only when all items are being displayed.
Sort by date Sorts the documents according to the date. Available only when all items
are being displayed.
9.7 Alerts
Alerts are messages that appear either always or after a particular date. They are shown at the bottom of
the ProMaster Master Keying main window when the system is open.
Alerts flagged to always show are always shown, provided you have not unselected the Show this alert flag.
Alerts set to show on and after a date show on that date, provided you have not unselected the Show this
alert flag and only until they are flagged as acknowledged.
Where the alerts are shown at the bottom of the ProMaster Master Keying main window, buttons step
between the alerts and for alerts with a date, there is a button to acknowledge the alert so that it disappears.
Click on the alert description at the bottom of the ProMaster Master Keying main window to open the alert so
thay you may read its notes.
Getting started
· You must be logged in with a system open.
Making a change
· Use the Add, Remove and Edit buttons to set up your alerts.
· Right click on an alert to access options for sorting the alerts. Sorting choices are available only if you have
searched for all items.
Notes
The description is shown on the ProMaster Master Keying main window.
Deselecting the Show this alert flag will, regardless of date choices, always hide the alert.
If the alert is to be shown only after a date, you must enter the date.
The notes are shown only when you open the alert
9.8 Keys
The keys window is the hub for almost all key activity. Depending on where you have accessed keys,
functionality is made available or removed to match the current requirements. None the less, the basics of
how you search for keys remains the same.
Getting started
· You must be logged in with a system open.
While all the search options are clearly worded, there are some more complex options that can help you
refine your key search and it is worthwhile having a look at some of the options like "Key above" and
"Replaced" so that you are familiar with them should the need arise.
Making a change
· Use the Add, Remove and Edit buttons to set up your keys.
Click the Options button then Import CSV to import keys from a csv file. See Importing keys from a csv
file 128
Key above The Key above specifies the key above this key in hierarchy. The top level
key in a system will have no keys above. See Understanding key
designations and hierarchy 126 .
Designation The designation specifies the keys purpose. See Understanding key
126
designations and hierarchy .
Part code Available when the application parameter Allow entry of key part
code is turned on. Allows a part code to be recorded for the key.
Generally this would not be used, and is provided for customers with
manufacturing integration processes.
Stamping Available when the application parameter Allow entry of key stamping
is turned on. Stamping is optional, but when entered the value is used in
preference to the key number when marking keys during manufacturing.
Ship this key separate from lock This option, if checked, is considered during the job process. If a key
parts which has this option checked is ordered on the same job as any lock
products (i.e. Doors) then this option will enforce the entry of two shipping
addresses for the job.
Key is disabled This flag allows you to effectively obsolete a key. A disabled key may not
be assigned to any doors, nor may it be ordered.
Signatory quantity required If your system is restricted by signatory, or allows for a different number
of signatories required to order each key then this field will be available.
The system default is shown, and if you enter a value for Signatories
quantity required then it will take precedence when validating a job
with this key.
Add this key to a job Available when adding a key (but not modifying an existing one), the
Quantity specifies the quantity of this key to order. The default value for
Quantity is set for the system (and you may change the default by
modifying the system details).
The note is added to the line item for this key if you order it by entering a
quantity. Most often this note is not required, but may be used to convey
special manufacturing or delivery instructions.
Add a door for this key If you turn on this option, then after the key is added, you will be given the
opportunity to add a door, which will then be operated by this key. This
option is available only when adding keys (I.e. Not when modifying
existing keys).
While editing a key, the History option access a list of jobs on which the key was ordered, and gives you the
ability to see the job details.
Notes
Add a door for this key: The default for this flag is determined by the Preference 33 When adding keys
default "Add door" to checked. The are many ways of entering doors, keys and keying so you should alter
this preference to correspond to the way you operate.
In the top right of this window, Issues indicates the number of times this key has been ordered.
· If key A is above key B, then key A must operate all doors operated by key B. Or put another way, key B
must not operate any doors that are not operate by key A.
· If a key is not the Key above another key, then its designation must not be Master.
Designation
Designation Description
Master A Master key fits into a pure hierarchy layout and is the Key above for one or more
other keys
Change A Change key is a bottom level key that fits into a pure hierarchy layout. A Change key
must not be the key above for another key.
Selective A Selective key does not fit into a pure hierarchy layout. A selective key must not be the
Key above for another key.
Construction The Construction key is available on construction keyed systems for design modules that
support construction keying.
Control The Control key available only on design modules that have interchangeable code
cylinders.
If a key is the Key above another key, then it must operate all doors that the lower level key opens.
123
See Keys .
The Door access for key window shows the door that the key operates.
Making a change
· Click Add to add doors to the key. When you add a door, and if the key has a key above, ProMaster Master
Keying will offer to add also keys above the key you are working on to the door.
· Click Remove to Remove the selected door from the key.
When doors have different internal keying (for double cylinders), be careful to select the correct side of the
door when adding it to the key.
Be aware that once a system is coded, any changes you make will affect the pinning for your doors.
When you make keying changes, ProMaster Master Keying marks the system as Coding required so
that coding for affected doors must be recalculated before any manufacturing may proceed.
You must enter the key number for the replacement key.
Keying the replaced key
The keying from the replaced key is attributed to the replacement key, and the replaced key (which still exists
out there somewhere) maintains its coding information. All the normal data entry places for controlling keying
do not allow you to assign any keying to the replaced key.
Now, if the replaced key previously operated a central or maison keyed door, you may find that the replaced
key appears as a phantom or error when performing coding. This is because the lock coding still allows the
replaced key to pass but the replaced key is no longer keyed to operate that lock.
This is intentional, and you must make a simple choice on how you wish to handle it.
· Your first choice is to replace other keys that operate the central door, thereby changing the lock pinning so
that the initial replaced key no longer presents an error. In a high security situation this will likely be the
preferred answer, then the time and cost of numerous system changes must be considered.
· The other choice, and one frequently adopted is that the replaced key (the one that was lost) does not
present sufficient security compromise to warrant further cost, and the replaced key should be allowed to
continue operating the central door. In this case you must assign the to operate the door, thereby
eliminating the phantom key error report.
All the normal data entry places for controlling keying do not allow you to assign any keying to the
replaced key. When you are performing coding for a replaced key, you must assign the replaced key's
keying from within the keying matrix on the coding screens (Coding tree or Coding matrix).
Assigning keying while replacing key
If you have coding permissions, then on the Replace key window there will be the option to select doors that
will continue to be operated by the replaced key (as well as by the replacement key). Do this only if you are
certain about the requirements, otherwise leave the keying until you perform the coding.
· Click Next
The wizard shows you the first four lines of the file so that you can see how it has been parsed. From this you
may determine if the file content is what you were expecting or not.
It is common for the first line of a CSV file to contain column headings. The wizard tries to determine if that is
the case with the file you selected, and sets the options accordingly. If the option for the first line is not
correct, be sure to check or un-check it as necessary.
The Operation determines how the import is processed. Choose if you want new items, if you are updating
existing items, or both.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Making a change
· Use the Add, Remove and Edit buttons to set up your key groups.
· The group must have a name, and than group name must not be used by another key group within this
system
· Click Add to select keys that you want in the group. You may do this as many times as you need.
When you have finished editing the group, click OK to save it.
Getting started
· You must be logged in with a system open.
Alternatively, initiate the bulk change from the keys window after having searched for a range of keys. See
Keys 123 .
Making a change
The process of making a bulk change is very simple, just follow these steps.
· Ensure that the correct keys are selected, selecting or deselecting them as necessary.
· The options for what you may change depend on the selection made. Enter the information for your change
(e.g. new value, selection, etc)
· Click the Apply change button.
Getting started
· You must be logged in with a system open.
Making a change
The process of sorting keys involves selecting the keys to sort then applying a sorting operation to those
selected keys. The process may be repeated as many times as necessary.
Selection and sorting operations are accessible through the button bar at the top of the window, through a
pop-up context menu (right click mouse) and through various hot-key combinations.
Selecting keys
Keys may be selected using mouse/keyboard, including shift-clicking to select a range and ctrl-clicking to
select dis-contiguous keys, or various menu options such as:
· Select all
· Select none
· Select keys with the same category (The currently highlighted key must have a category)
· Select to bottom (Selects from the currently highlighted key to the end)
Sorting keys
The sorting operation is applied to the selected keys.
Option Description
Move up Moves all selected keys up one position.
Move down Moves all selected keys down one position.
Move up page Moves all the selected keys up half the height of the window.
Move down page Moves all the selected keys down half the height of the window.
Bring together Brings all the selected keys together, positioning them under the topmost
selected key.
Sort key number as text Sorts the selected keys by doing a text comparison on their key numbers.
Sort key number Sorts the selected keys in logical numerical order. All selected keys must
have a numerical component in the key number. Each key number is
broken into multiple numerical components and these are compared for
sorting purposes. A numeric sort will correctly produce the sequence 1.1,
1.2, ..., 1.9. 1.10, 1.11, 2.1, 2.2, ..., 2.9, 2.10
Sort USA Sorts the selected keys according to the USA key naming convention.
Sort by description Sorts the selected keys by their descriptions.
Getting started
· You must be logged in with a system open.
Making a change
· Drag a key onto a different master to change it's key above.
Exercise caution - is it easy to make a mess by dropping keys in the wrong place.
Print key hierarchy
161
From the Options menu choose Print. See Key hierarchy .
You may print the original hierarchy or the changed hierarchy (if you have made a change).
Making a change
All keys are show, along with the quantity currently known, and as a comparison the quantity accounted for on
jobs in ProMaster Master Keying.
Enter the new quantity that has been produced for any keys that are incorrect.
Do this only for legacy systems. Incorrect values will interfere with the automatic allocation of issue
numbers on jobs.
9.9 Doors
The doors window is the hub for almost all door activity. Depending on where you have accessed doors,
functionality is made available or removed to match the current requirements. None the less, the basics of
how you search for doors remains the same.
Getting started
· You must be logged in with a system open.
While all the search options are clearly worded, there are some more complex options that can help you
refine your door search and it is worthwhile having a look at some of the options like "Duplicate stamping",
"Keys" and "Multiple keyings" so that you are familiar with them should the need arise.
Making a change
· Use the Add, Remove and Edit buttons to set up your doors.
Other functionality
135
Click the Key access button to see or alter the keys that operate the door. See Door keying .
Click the Signatories button to see or alter the signatories permitted to order the key. See Authorised
signatories for door 136 .
Right click a key and choose Hardware to record hardware other than the locking product. See Recording
door hardware 136.
139
Right click a key and choose History to see a list of jobs where the door was ordered. See Door history .
Right click a key and choose Move up / Move down to change the order of the doors. This is available only
144
if the search has returned all doors. See also Sort doors .
Click the Options button then Bulk change to open the bulk changer with the current selection of doors. See
Bulk change doors 143 .
144
Click the Options button then Sorter to open the door sorter. See Sort doors .
Click the Options button then Keying matrix to open the keying matrix with the initial view set to the current
selection of keys. See Keying matrix 145.
Click the Options button then Duplicate doors to duplicate one or more doors multiple times. See
136
Duplicating doors .
Click the Options button then Duplicate area to duplicate a door areas one or more times. See Duplicating
a door area 138 .
Click the Options button then Import CSV to import keys from a csv file. See Importing doors from a csv
file 140.
Click the Options button then Import door renaming CSV to import keys from a csv file. See Importing
door renaming from a csv file 141.
Stage While normally not used, the stage allows you to record doors by stage in
large ongoing building projects.
Non keyed Used to indicate that the door does not have a locking product and is not
operated by any keys. You may record the details of non-keyed doors,
including additional hardware if you have enabled the hardware recording
functionality, however a non-keyed door may not be assigned any keys
and may not be ordered.
Lock If the door is keyed (I.e. It has a lock on it and is operated by one or more
keys) then this lock is the part code of the lock or cylinder installed on this
door. You may select a lock by clicking on the Select lock button, or
choose one from the drop down list of locks used on other doors within
this system.
Different keying side 2 Turn this on for doors with a double cylinder that are keyed differently on
the inside. If the internal keying is the same as the external keying, do not
turn this on.
Notes A place for you to store a small amount of notes about this door
Height, Width, Thickness The dimensions of the door. Useful if you have this information and wish
to record it so you have it available later to assist in determining
appropriate products.
Signatory quantity required If your system is restricted by signatory, or allows for a different number
of signatories required to order each key then this field will be available.
The system default is shown, and if you enter a value for Signatories
quantity required then it will take precedence when validating a job
with this key.
Pinning notes Available only if you have coding rights, the pinning notes allow you to
record any special manufacturing instructions for this door. Typically the
pinning notes would not be required.
Add this door to a job Available when adding a door (but not modifying an existing one), the
Quantity specifies the quantity of this door to order. The default value for
Quantity is set for the system (and you may change the default by
modifying the system details).
The note is added to the line item for this door if you order it by entering
a quantity. Most often this note is not required, but may be used to convey
special manufacturing or delivery instructions.
Add a key to this door If you turn on this flag, then after the door is added, you will be given the
opportunity to add a key, which will then be assigned to operate this door.
This option is available only when adding doors (I.e. not when modifying
existing doors).
Add hardware to this door If you turn on this flag, then after the door is added, you will be given the
opportunity to record additional hardware (e.g. closer) against the door.
This option is available only if you have enabled hardware recording in the
configuration of this system.
Save / Add another is available when adding doors, but not when modifying an existing door.
Editing doors
If you edit a door that has been ordered, the Door number and stamping will be protected from change.
The Edit door number button allows you to make these fields editable. If doors have been manufactured
and stamped, or data sent to the client then exercise discretion in doing this.
While editing a door, the History option access a list of jobs on which the door was ordered, and gives you
the ability to see the job details.
Notes
Stamping: Then you are adding a door, and then save it, the application parameter When adding doors,
copy keying from doors with the same stamping is read, and if the parameter is set on, ProMaster
Master Keying then locates a door with the same stamping and copies the keying from that door to the one
that you have just added. For those users who use the stamping to identify doors that are keyed identically,
this is a parameter which you might consider turning on.
Add a key to this door: The default for this flag is determined by the Preference 33 When adding doors
default "Add key" to checked. The are many ways of entering doors, keys and keying so you should alter
this preference to correspond to the way you operate.
In the top right of this window, Issues indicates the number of times this door has been ordered.
When doors have different internal keying (for double cylinders), two sets of keyiong are shown. Click in then
external or internal keying to select that side of the door.
Bottom level key
If the application parameter Allow keys to be ordered as "Key quantity per cylinder" on each door is
turned on to allow the ordering of change keys for an ordered cylinder, then the bottom level key for the
door will be shown at the top of the window. By default, the bottom level key is defined as the only change
key that operates a door. In the event that several change keys operate a door, or that no change keys
operate a door then you must define which key is considered the bottom level key. This is done by right
clicking on the key within the list that you want to make into the bottom level key and choosing the menu
option to Set bottom level key. Your setting may be removed with the Clear bottom level key menu
selection, reverting to the algorithm than selects the singular change key for the door. This feature is not
available for internal keying on doors.
Be aware that once a system is coded, any changes you make will affect the pinning for your doors.
When you make keying changes, ProMaster Master Keying marks the system as Coding required so
that coding for affected doors must be recalculated before any manufacturing may proceed.
· Search a door.
Making a change
· Use the Add, Remove and Edit buttons to set up your door hardware.
· Use Increase and Decrease to alter the quantity of the selected item.
Making a change
Select doors
The first door will be displayed.
· Use the Select doors and Remove door buttons to build up the list of doors you want to duplicate.
Door numbering
The door numbers of the doors you selected are analysed, and ProMaster Master Keying determines which
parts of the door numbers can be changed to produce the new doors.
· Choose the method for how new door numbers will be created.
Method Description
Create new door numbers using Looks for common parts in the door numbers and if common parts are
structured numbering available then this method is allowed. For example, doors 1.1A, 1.1B and
1.1C would be analysed as Numeric,Symbol,Numeric,Alpha and as the
numeric parts are the same on all doors, they would be available for this
method.
You must enter the number that new doors will start from and progress
up to.
So, in this example, if you chose the second numeric portion and choose
starting from 2 and progressing up to 4, then the following door numbers
are generated: 1.2A, 1.2B, 1.2C, 1.3A, 1.3B, 1.3C, 1.4A, 1.4B, 1.4C.
Create new door numbers using This method works regardless of how existing doors are numbered and
door number generation rules generates a sequence of new numbers for the new doors.
You may enter a prefix and suffix. You must specify what the starting
number is and how many of each door are generated.
So, using the example where you are duplicating 3 doors, and you enter
Prefix "X", Suffix "SP", Number from "2", Qty of each door "3" and pad
number length to "2", then the following door numbers are generated:
X02SP, X03SP, X04SP, X05SP, X06SP, X07SP, X08SP, X09SP, X10SP.
Door description
If there is no portion of the door description that reflects the door number, there are no options available.
More often than not this should be the case as it is usually superfluous to include the door number as part of
the door description.
If however the door Descriptions did include a representation of the door number (e.g. Apartment Entrance
1.1, Bedroom 1.1, Bathroom 1.1) then the wizard determines if the door descriptions can be automatically
generated and gives you choices accordingly.
The option to change the way door descriptions are generated is available only when you are using structured
numbering.
Door stamping
Choose if the stamping for each new door is to be the same as the door from which it was created, or if the
stamping for the new doors should be made the same as the new door number.
Confirm new door numbers
All the door numbers and descriptions that will be created are displayed. Peruse the list to be certain that it is
what you are expecting.
Ready to duplicate doors
A summary of the change that will be applied is shown.
Each door generated will have the same lock, area and other attributes as the door from which it is
generated.
Making a change
Select area
Select the area you want to duplicate. The choice is pre-populated with the door you selected before starting
the wizard.
Select doors
The doors in the area you selected are shown. Initially they are all selected. Before proceeding, peruse the list
and deselect any doors that you do not want to duplicate for the new area.
Door numbering
The door numbers of the doors you selected are analysed, and ProMaster Hardware determines which parts
of the door numbers can be changed to produce the new doors.
· Choose the method for how new door numbers will be created.
Method Description
Create new door numbers using Looks for common parts in the door numbers and if common parts are
structured numbering available then this method is allowed. For example, doors 1.1A, 1.1B and
1.1C would be analysed as Numeric,Symbol,Numeric,Alpha and as the
numeric parts are the same on all doors, they would be available for this
method.
You must enter the number that new doors will start from and progress
up to.
So, in this example, if you chose the first numeric portion and choose
starting from 2 and progressing up to 3, then two areas are created with
the following door numbers are generated: 2.1A, 2.1B, 2.1C, 3.1A, 3.1B,
3.1C.
Create new door numbers using This method works regardless of how existing doors are numbered and
door number generation rules generates a sequence of new numbers for the new doors.
You may enter a prefix and suffix. You must specify what the starting
number is and how many of each door are generated. The number of
each door generated is effectively the number of new areas created.
So, using the example where you are duplicating 3 doors, and you enter
Prefix "X", Suffix "SP", Number from "2", Qty of each door "3" and pad
number length to "2", then the following door numbers are generated:
(X02SP, X03SP, X04SP), (X05SP, X06SP, X07SP), (X08SP, X09SP,
X10SP). The parentheses show each of the 3 areas.
Create new door numbers by Using this method, you enter pairs of existing leading characters and what
altering the leading characters of those characters will be replaced with on the new doors.
the door number
Using this method, only one new area may be generated. To make
another area you must run the wizard again.
Here's an example.
Say you are copying doors called DL4-1, DL4-2, APT401-1, APT401-2,
APT403-1, APT402-2
The door numbers produced will be: DL5-1, DL5-2, APT501-1, APT501-2,
APT503-1, APT502-2
Area names
ProMaster Master Keying shows the first new door in each new area, and what it has determined the new
areas will be called.
If you want to change the names of the new areas, then for each entry in the list, click to highlight the new
area, enter a new area name in the space provided below then click Update to apply the new area name.
You must then specify the name for each area.
Door stamping
Choose if the stamping for each new door is to be the same as the door from which it was created, or if the
stamping for the new doors should be made the same as the new door number.
Confirm new door numbers
All the door numbers and descriptions that will be created are displayed. Peruse the list to be certain that it is
what you are expecting.
Ready to duplicate doors
A summary of the change that will be applied is shown.
Each door generated will have the same lock, area and other attributes as the door from which it is
generated.
Getting started
132
See Doors .
Importing data
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Data remapping
Any values that match existing information are mapped automatically and you will see on those lines the
Value from database will be completed. For all lines where the Value from database is blank, you must:
Click the line then choose the correct value from the Use value drop down list, then click she Set button to
set that value for the line you are working on. Repeat this process for all incomplete lines. If you make a
mistake simply repeat the process on the erroneous line to alter it.
Ready to finish
A summary is displayed.
Click Finish to perform the import.
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
For all data types not contained in the import file the selection Not available must be made.
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
· From the System menu, select Import doors and keys from ProMaster Hardware 7.
Importing data
The wizard shows you information about the data in the file and asks about how you want doors and keys
imported.
The doors and/or keys are added to your system.
Any doors or keys that already exist with the same door number or key number as one being imported
will not be altered. Those doors or keys in the import file will be ignored.
Making a change
· Use the Add, Remove and Edit buttons to set up your door groups.
When you have finished editing the group, click OK to save it.
Getting started
· You must be logged in with a system open.
Alternatively, initiate the bulk change from the doors window after having searched for a range of doors. See
Doors 132.
Making a change
The process of making a bulk change is very simple, just follow these steps.
· Ensure that the correct doors are selected, selecting or deselecting them as necessary.
· The options for what you may change depend on the selection made. Enter the information for your change
(e.g. new value, selection, etc)
· Click the Apply change button.
Notes
Within this window, the selected change is applied only to items that are checked (in the far left column of
each item)
You can check and uncheck items individually, or use the Select all and Clear selection buttons. Right click
on the list for more selection options.
You can make as many different types of changes as you like within this window.
Changes are stored in memory, and are not saved until you click the OK button.
Doors that have been changed are indicated by a pencil graphic next to the door selection. You may
undo changes to keys by right clicking and choosing Undo.
Right click and choose Show changed values so see a graphic indicator of the individual values that
have been altered.
Making a change
The process of sorting doors involves selecting the doors to sort then applying a sorting operation to those
selected doors. The process may be repeated as many times as necessary.
Selection and sorting operations are accessible through the button bar at the top of the window, through a
pop-up context menu (right click mouse) and through various hot-key combinations.
Selecting doors
Doors may be selected using mouse/keyboard, including shift-clicking to select a range and ctrl-clicking to
select dis-contiguous doors, or various menu options such as:
· Select all
· Select none
· Select doors with the same area (The currently highlighted door must have an area)
· Select doors with the same stage (The currently highlighted door must have a stage)
· Select to bottom (Selects from the currently highlighted door to the end)
Sorting doors
The sorting operation is applied to the selected doors.
Option Description
Move up Moves all selected doors up one position.
Move down Moves all selected doors down one position.
Move up page Moves all the selected doors up half the height of the window.
Move down page Moves all the selected doors down half the height of the window.
Bring together Brings all the selected doors together, positioning them under the topmost
selected door.
Sort door number as text Sorts the selected doors by doing a text comparison on their door
numbers.
Sort door number Sorts the selected doors in logical numerical order. All selected doors
must have a numerical component in the door number. Each door number
is broken into multiple numerical components and these are compared for
sorting purposes. A numeric sort will correctly produce the sequence 1.1,
1.2, ..., 1.9. 1.10, 1.11, 2.1, 2.2, ..., 2.9, 2.10
Sort by description Sorts the selected doors by their descriptions.
Making a change
All doors are show, along with the quantity currently known, and as a comparison the quantity accounted for
on jobs in ProMaster Master Keying.
Enter the new quantity that has been produced for any doors that are incorrect.
Do this only for legacy systems. Incorrect values will interfere with the automatic allocation of issue
numbers on jobs.
· Also accessible from doors search window and keys search window
Option Description
Find key Search for keys. Keys that start with the text you enter are indicated with
a purple arrow. If there is a key that is a full match for the text you
entered then that key is selected as well as the purple arrow.
Show selection: This option is available if you invoke the keying matrix
from the keys search window and restricts the keys displayed to those
returned in the key search window.
Hide masters: Master keys are not shown but all other keys are shown.
This can be use for for large hierarchical, particularly in conjunction with
the propagation options, to simplify the display.
Show keys in group: This option is available if you have key groups
defined. After you choose a group, the matrix is redrawn to show only
the keys in that group.
Changed keys: This option shows keys where keying has been added or
removed, and is useful for checking your changes before saving. This
option makes the keying matrix read-only.
Find door Search for doors. Doors that start with the text you enter are indicated
with a purple arrow. If there is a door that is a full match for the text you
entered then that door is selected as well as the purple arrow.
Door details Shows information about the current door.
Door display Show all doors: All doors are shown.
Show selection: This option is available if you invoke the keying matrix
from the doors search window and restricts the doors displayed to those
returned in the door search window.
When this display mode is used and you change the keying, it is
always propagated to other doors with the same stamping,
regardless of the propagation settings.
Show only first door for each keying: This option shows the first door
for each unique combination of keying. It does this by walking through all
the doors and each time a door has a different set of keys to previous
doors then the door is added to the display. This option makes the keying
matrix read-only.
Show doors in group: This option is available if you have door groups
defined. After you choose a group, the matrix is redrawn to show only
the doors in that group.
Changed doors: This option shows doors where keying has been added
or removed, and is useful for checking your changes before saving. This
option makes the keying matrix read-only.
Propagation Same stamping: With this option on, then when you turn keying on or off
for a cell, the same change is made to all doors with the same stamping
and on the same side (External/Internal).
stamping or (b) Doors with the same stamping only if they are displayed
according to the "Door display" options.
Normally if doors are stamped according to the keying, the first and
default choice is correct. In the rare (and messy) case when
stamping relates to keying for only some doors, and you have
entered the keying matrix from the door search to restrict the
displayed doors by some other criteria then the second choice may
be helpful.
Add keys above: With this option on, then when you turn keying on for
a key, all keys above that key are turned on also.
Remove keys above: With this option on, then when you turn keying off
for a key, all keys above that key are turned off also.
Remove keys below: With this option on, then when you turn keying off
for a key, all keys below that key are turned off also.
Toggle keying Toggles the keying when a single cell selected or a valid selection (green
highlight, horizontal, vertical or diagonal).
Keying on Turns keying on when a single cell selected or a valid selection (green
highlight, horizontal, vertical or diagonal).
Keying off Turns keying off when a single cell selected or a valid selection (green
highlight, horizontal, vertical or diagonal).
Selection on Turns keying on for all cells in a selection, regardless of the shape of the
selection. Propagation does not apply.
Selection off Turns keying off for all cells in a selection, regardless of the shape of the
selection. Propagation does not apply.
This key | Key on Turns keying on for the selected key for all doors.
This key | Key off Turns keying off for the selected key for all doors.
This key | Undo changes to this Undoes all changes to the selected key, reverting it to the keying it had
key when you opened the window.
This door | Door on Turns keying on for the selected door for all keys.
This door | Door off Turns keying off for the selected door for all keys.
This door | Undo changes to this Undoes all changes to the selected door, reverting it to the keying it had
door when you opened the window.
Other functionality
Right click on the keying matrix for other options. Some options on this pop-up menu are the same as the
toolbar (however you can learn the shortcut keys by looking at the pop-up menu), but the new options are
listed here.
Option Description
Disallow changes to When on, changes to doors that have been manufactured are not
manufactured doors possible. The default value for this option is from an Application
Parameter "In keying matrix, make manufactured doors read-only by
default"
Copy keying to doors with the Copies the keying from the current door and side, to other doors with the
same stamping same stamping and to the same side of each of those doors.
148
Import keying from CSV file See Import keying from a csv file .
Notes
In normal layout (not condensed), a green + graphic indicates each keying added and a red - graphic
indicates each keying removed.
Changes are not saved until you click OK.
To import data from a csv file, click on the Options button then choose Import csv.
A simple wizard steps you through the import process.
Select the file to import
· Click Select file to select the file you are importing.
· Click Next
· Click Next
Data analysis
A comprehensive data analysis is performed and any problems are reported.
If the analysis indicates that there are errors contained in the file, then you have the option to see the detail of
those errors.
If there are errors, you must either fix the file and restart the import, of if you are happy to ignore the
erroneous rows then then you can check the option to skip those rows.
· Click Next
Ready to finish
A summary is displayed.
Click Finish to perform the import.
Notes
The imported keying is stored in the keying matrix. To save it, you must now click OK in the keying matrix. If
the keying imported was not what you expected, click Cancel in the keying matrix to discard all changes.
9.11 Reporting
9.11.1 Printer options
Most reports allows you to access printer options by clicking on the Printer options link on the bottom left of
the report options screen.
Printer options allow you to:
· Choose a different printer and paper tray for the report to be sent to.
· Print on both sides of the paper (if your printer supports duplexing)
If you select the option to Show advanced printer settings before printing, the printer settings for your
printer are displayed before the report is sent to the printer. This allows you to access printer specific
features such as printing multiple pages onto a single sheet of paper, selecting a different output bin or
requesting the report be stapled.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include. This can be useful for partitioning your follow-up
calls between high-end security systems and low security ones.
How should the follow-up date be Systems where the follow-up date is before today: The follow
treated update date on each system printed has passed.
Notes
When you add, edit or import signatories for a system and a registration form has been printed but not
received you will be asked if it has now been received.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Getting started
· From the Admin Reports menu, choose Blank Signature registration form.
Options
Option Description
Show the client name Shows a placed for the client name on the form.
Show system information Shows a place for the system address and other properties on the form.
Show user's choice of agent Manufacturer edition only. Prints a place for the client to enter the name
of there preferred key cutting agent.
Number of blank signatory places After any existing signatories, places for new signatories will be printed.
to show You can choose from 1 to 20 places.
Use layout with increased text Choose between 2 layouts.
size
Template Choose your instructions to the signatories. This is printed at the top of
the form. See Templates 76 to create templates.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Include systems where the Normally systems that require no signatories to order keys will be
required number of signatories s excluded from this report. Select this option to include these systems.
zero
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Which job status do you want to Choose between "coding and manufacturing", "coding" only and
include "manufacturing" only.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which factory do you want to You may choose all factories or an individual factory
include in the report
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Which job status do you want to Select which of the job status you want to include. Your selection
include determines which dates are considered.
What date range do you want to You may select a date range for each job status.
include If you do not want a starting date or an ending date to be applied when
selecting the date, check the proximate "Any" check box and the date will
be disabled and ignored in the data selection.
Notes
The more options you select, the more restricted will be the result.
For example, if you request "entering" and "manufacturing" jobs, and specify a start and end date for both the
"created" date and the "manufacturing" date, then what you will get is:
· Jobs in the data entry state (and those in the coding state) that were created in the date period stipulated
for the "created" date.
and also
· Jobs in the manufacturing state that were sent to manufacturing in the date period stipulated by the
"manufacturing" dates and that were created in the date period stipulated for the "created" date.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which factory do you want to You may choose all factories or an individual factory
include in the report
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
What date range do you want to You may select a date range for when the job was sent to manufacturing.
include If you do not want a starting date or an ending date to be applied when
selecting the date, check the proximate "Any" check box and the date will
be disabled and ignored in the data selection.
Option Description
Print The report is printed to the printer you have selected.
Preview The report is previewed on your screen. See Previewing reports 310
for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Select systems by considering Allows you to select systems by specifying a date after which a job has
the most recent job not been created.
Select systems by considering Allows you to select systems by specifying a date before which the system
the system installation date was installed.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Getting started
· From the Admin Reports menu, choose Key manager users.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which system types do you want Include all system types: No particular attention is applied to system
to include types when making the selection for the report
Include only selected system types: You may choose one or more
system types to include.
Which Key Manager versions do Select one or more versions of Key Manager to include.
you want to include
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Options
Option Description
Include doors using a lock that When the chosen product is a cylinder, and this option is checked, then
contain this cylinder any door using a lock that references the cylinder is included.
Include closed systems Determines of systems marked as "closed" are included.
Include system snapshots Determines of systems marked as "snapshot" are included.
Show only the system summary If checked, the report is significantly shorter with only a quantity for each
and do not show doors system.
If unchecked, each door is listed.
The first is useful for seeing how many times a lock is used whereas the
second is useful for locating doors using a lock or cylinder.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
Choose from the list the report you want.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Initial system reports has most of the options that the individual reports have, but simplified to some extent in
that all keys and doors rather than having a selection available.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Show client Choose if you want the client information included on the report.
Show signatories Choose if you want the signatories included on the report.
Inactive signatories are not included in the report.
Output options
Option Description
Print The report is printed to the printer you have selected.
Preview The report is previewed on your screen. See Previewing reports 310
for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
How do you want to count locks Count the items defined for each door: This choice examines all
doors and their locks, and counts the quantity of each lock product. I.e.
The quantity of products defined for each door, not the quantity actually
ordered.
Count the product ordered on a single job: Much the same as the
previous choice, but for a single job that you select from the list.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Getting started
· You must be logged in with a system open.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which keys do you want to None: Keys are not show on the order form.
include
Located on the "keys" tab All: All keys are included on the order form.
Keys fitting a single door area: Select a door area. All keys that fit
doors in that area are included on the order form.
Which doors do you want to None: Doors are not show on the order form.
include
Located on the "doors" tab All: All doors are included on the order form.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
9.11.3.5 Keys
This is one of the most frequently used reports. It is also part of the collection of reports produced by the
158
Initial system reports .
Getting started
· You must be logged in with a system open.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which keys do you want to All: All keys are printed.
include in this report
A selection of keys: You select the keys to be included on the report.
Keys in a group: Select a key group. Keys in that group are included on
the report.
Keys that have been manufactured: All keys that have been
manufactured are included on the report.
Keys that have not been manufactured: All keys that have not been
manufactured are included on the report.
Options
Option Description
Show key category When selected, the key category will be shown on the report.
Show doors When selected, each key will be followed by the doors that it operates.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Option Description
Print the key hierarchy Prints all keys showing the key hierarchy
Print the modified key hierarchy Available when printed from the key hierarchy editor and changes have
which is not yet saved been made. This selection prints the modified key hierarchy which has
not yet been saved.
Show expanded and collapsed Available when printed from the key hierarchy editor.
branches as displayed When unchecked, all keys are shows.
When checked each branch is printed as currently displayed (expanded or
collapsed)
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
9.11.3.7 Doors
This is one of the most frequently used reports. It is also part of the collection of reports produced by the
158
Initial system reports .
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which doors do you want to All: All doors are printed.
include in this report
A selection of doors: You select the doors to be included on the report.
Doors that fit a selection of keys: You select one or more keys and all
doors that are operated by any of those keys are included on the report.
Doors in a group: Select a door group. Doors in that group are included
on the report.
Doors that have been manufactured: All doors that have been
manufactured are included on the report.
Doors that have not been manufactured: All doors that have not
been manufactured are included on the report.
Options
Option Description
Report layout The report layout determines the type of report that is produced.
Door detail: Shows doors and associated information, but not keys.
Doors with keys: Shows doors and associated information, and after
each door shows the keys that operate the door.
Non keyed doors: Shows only the doors that are marked as non-keyed.
Show lock information Shows lock information on the report (First 2 layouts).
Show door notes Shows notes associated with each door.
Show quantity issued Shows the quantity of each door manufactured (First 2 layouts).
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which doors do you want to All: All doors are printed.
include in this report
A selection of doors: You select the doors to be included on the report.
Doors that fit a selection of keys: You select one or more keys and all
doors that are operated by any of those keys are included on the report.
Doors in a group: Select a door group. Doors in that group are included
on the report.
Doors that have been manufactured: All doors that have been
manufactured are included on the report.
Doors that have not been manufactured: All doors that have not
been manufactured are included on the report.
Options
Option Description
Show door description Shows the door description - results in fewer doors per page.
Show door area Shows the door area - results in fewer doors per page.
Show door quantity Shows the quantity of each door manufactured.
manufactured
Show key description Shows the key description - results in fewer keys per page.
Show key quantity manufactured Shows the quantity of each key manufactured.
Show keys not used by selected Shows all keys instead of only those required for the doors being printed.
doors
Show only first door for each Determines which doors to print by looking at each door in order and
keying looking at its keying then showing only those doors with a unique keying.
The purpose of this layout is to allow a printout to read when determining
the system structure for coding.
Show unkeyed indicator Shows a warning graphic next to each door and key that is not assigned
any keying.
Print on large paper Prints more doors and keys per page. Useful if you have a large format
printer. The other thing is that many modern printers will automatically
resize A3 content to A4 if the printer does not support the larger paper -
the result if this is more doors and keys per page and somewhat smaller
writing which is agreeable only to younger eyes!
Notes
Large systems may require a number of pages to be joined together sideways as well as vertically. When you
preview the report, one vertical section is shown at a time.
Producing the report
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which keys do you want to All: All keys are printed.
include in this report
A selection of keys: You select the keys to be included on the report.
Keys in a group: Select a key group. Keys in that group are included on
the report.
Keys on jobs in a date range: Select a date range for the job
manufactured date.
Options
Option Description
Show signatories Beneath each job the signatories for that job are shown.
Notes
When the range "Keys on jobs in a date range" is select, a different report layout is generated and the criteria
for the report is considered differently.
· The layout shows each job then keys on that job instead of keys and the jobs on which the key was
ordered.
· Jobs in manufacturing and completed state are included.
· The date range entered is matched to the date on which the job was released to manufacturing. The date
shown for each job is the released to manufacturing date. The other variants of this report don't select the
data based on a date range, but display the date when the job was created.
Producing the report
See Printer options 149
for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which doors do you want to All: All doors are printed.
include in this report
A selection of doors: You select the doors to be included on the report.
Doors that fit a selection of keys: You select one or more keys and all
doors that are operated by any of those keys are included on the report.
Doors in a group: Select a door group. Doors in that group are included
on the report.
Options
Option Description
Show lock information Shows lock information on the report.
Show door notes Shows notes associated with each door.
Show issue numbers Shows the issue numbers assigned on each job. Generally this is
significant only when a door represents a padlock that may be ordered
multiple times.
Show signatories Beneath each job the signatories for that job are shown.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Options
Option Description
Show the client name Shows the client name on the form.
Show system information Shows the system address and other properties on the form.
Show system description Shows the system description on the form.
Show existing active signatories This option is useful for gathering signatures on signatories that you have
that do not have a signature entered but don't have a signature, or if you want to get updated
recorded signatory details
Show existing active signatories This option is useful if you want to get updated signatory details
that have a signature recorded
Show user's choice of agent Manufacturer edition only. Prints a place for the client to enter the name
of there preferred key cutting agent.
Number of blank signatory places After any existing signatories, places for new signatories will be printed.
to show You can choose from 0 to 20 places.
Use layout with increased text Choose between 2 layouts.
size
Template Choose your instructions to the signatories. This is printed at the top of
the form. See Templates 76 to create templates.
System update
Option Description
Update the system to record Causes a follow up date to be recorded, so that you may later report on
printed date and follow-up date unreturned registration forms. See Unreturned system registration
forms 150
How many days from today until If the system is to be updated with a follow up date, this option allows you
follow-up date to specify how far in the future that date is from today.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which information do you want All: All keys and active signatories are printed.
to include in this report
A selection of signatories: You select the signatories to include in the
report. All keys are shown.
Options
Option Description
Show keys that are not used by Determines if unassigned keys are shown. If you are using the report to
any signatories gather information on permissions then likely you want this on, however if
the report is to convey information about the current permissions then
having this off may be useful in reducing the amount of information
shown.
Show signatories that are not Determines if unassigned signatories are shown. Particularly useful in
used by any keys reducing the size of the report when only a few keys are selected for the
report.
Show signatory title Includes the signatory title after each signatory. This results in fewer
signatories per page.
Notes
Large systems may require a number of pages to be joined together sideways as well as vertically. When you
preview the report, one vertical section is shown at a time.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which information do you want All: All doors and active signatories are printed.
to include in this report
A selection of signatories: You select the signatories to include in the
report. All doors are shown.
Options
Option Description
Show doors that are not used by Determines if unassigned doors are shown. If you are using the report to
any signatories gather information on permissions then likely you want this on, however if
the report is to convey information about the current permissions then
having this off may be useful in reducing the amount of information
shown.
Show signatories that are not Determines if unassigned signatories are shown. Particularly useful in
used by any doors reducing the size of the report when only a few doors are selected for the
report.
Show signatory title Includes the signatory title after each signatory. This results in fewer
signatories per page.
Notes
Large systems may require a number of pages to be joined together sideways as well as vertically. When you
preview the report, one vertical section is shown at a time.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
Range
Choose from the list the report you want.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
This report is available at the time you modify a system (See Modifying a system 109 ) and change the keying
type from a construction-keyed keying type to a non-construction-keyed keying type. After confirming that you
want the change, and before all doors are modified to make them non-construction keyed, this report is
available.
The report includes all construction-keyed doors.
Options
Option Description
Show keys Shows doors and associated information, and after each door shows the
keys that operate the door.
Show lock information Shows lock information on the report.
Show door notes Shows notes associated with each door.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
9.12 Coding
9.12.1 Coding overview
Coding is the process of assigning key codes to keys and calculating the door pinning then checking for errors.
Coding can be performed in the Coding tree, Coding matrix of Kaba coding grid, depending on the way
you prefer to work and also on the design module of your key system.
The first time you open a coding window, you are taken to the System design window to create the system
design. The system design window can be accessed at any time to alter or expand the system design.
In the System design window you choose the TMK, and how to progress codes. You can alter the system
rules (which are copied from the associated System type).
In the Coding window, keys are assigned to keys, and when all keys are assigned and door pinning
calculated successfully, the system is marked that the coding is complete, allowing jobs to be manufactured.
Any changes to the system, such as adding keys, adding doors or altering keying, results in the system being
flagged as coding required. You must then return to the coding window to complete any coding steps
necessary including a successful pinning calculation and error check.
After you create a system (I.e. You've entered the doors, keys and keying), you will proceed to coding the
system. Depending on the way you work, coding is performed using the Coding tree, Coding matrix, or
Coding grid. These three methods are referred to generically as Coding windows.
Creating the design
When you first open a coding window, ProMaster Master Keying identifies that the system does not have its
design parameters defined, and opens the appropriate system design window.
After you have defined the design parameters, you then proceed to a coding window (See Coding screen
180 184 186
overview , Coding using the coding tree , Coding using the coding matrix , Coding using the kaba
188
coding grid ).
Changing the design
You may revisit the system design at any time by first opening a coding window, then click the Change
design button (top right of the window).
The capabilities available when you are changing the design are similar to those you use when creating the
design, the most notable difference being the ability to add multiple Code progression when changing the
design.
More on changing the design later.
General process for creating system design
The general process for creating a system design is:
· Select the appropriate key section, if applicable, from the drop down list.
· Enter the TMK, or allow ProMaster Master Keying to generate one for you by clicking the Create TMK
button.
· Define a Code progression, which is the rule that ProMaster Master Keying uses to derive codes for your
system from the TMK. If all the keys in your system have correct designations and key above, you may use
178
the Design assistant to create the Code progression.
· Click OK to save the design and proceed to the coding window.
233
Design module specific features apply, see Design modules
Creating system design: Key section and TMK
When you create a system design, the first thing you must do is select the highest level key section that the
design will use. The drop down list of key sections shows key sections grouped into their families, so if you
have the same key section name in two different families, be sure to select the correct one. Most design
modules have a key section.
Next, the TMK is required. In most design modules you may enter a TMK. Most design provide a button,
Create TMK, that will create a TMK that adheres to the rules. Create TMK is not offered in design modules
where the TMK is provided by the lock manufacturer. Some design modules require that you pick a List
provided by the lock manufacturer before creating the TMK.
Creating system design: Rules
Some design modules have few rules that you may alter, while others have many. The rules are generally a
mixture of physical constraints and quality control constraints. The default value for each rule is determined by
your system type. See System types 87
Get the system type defaults right, and each time you make a system the values are correct.
Creating system design: Standard progression
In order to produce a hierarchy of codes, you must progress some chambers and specify what each chamber
is used for (e.g. Master, Change etc). The are two ways of specifying a progression. The more flexible but
more complicated way is to enter your own values for SOP (sequence of progression), Depth step and
Designation. Later we will look at how to do this. The easy way is to click the Assist button and allow the
Design assistant 178 to determine the progressed and rotated chambers.
The Design Assistant attempts to compute the size required for your system by examining your key hierarchy.
However, even if your key hierarchy is not in place you may still use the Design Assistant to determine the
Code Progression by entering into the Design Assistant the quantities you require of each key hierarchy.
Entering your own code progression
This might seem like a lot of information when you first read it, but knowing how it works gives you greater
flexibility and many users prefer to always define their own code progression.
To enter your own code progression, most design modules require three pieces of information as follows (but
remember there are differences in design modules - some do not use depth steps, others require additional
information):
· Sequence of progression (SOP): All positions being progressed must have a value of 1 or greater. All other
positions, including positions for rotated constants, must have the value 0. No value other than 0 may
appear more than once. Numbered positions must be contiguous, but not necessarily in order, starting from
1. SOP is used primarily to control the drawing of the coding matrix, but also determines if codes on the
coding tree progress from left to right or right to left.
· Depth step: When used by the design module, all positions that are progressed or rotated must have a
depth step of 1 or greater. All other positions must have the value 0. Depth Steps are used to determine the
values of code differs that will be produced.
· Designations: Designations specify the hierarchy of codes on the coding tree. They are not used in the
coding matrix. The following table explains the symbols used for designating a chamber as progressed for
each level of key hierarchy, and also the symbols used to designate the corresponding rotated constant.
Right click on any cell in the code progression to get a menu of available values. Learn them, it is
easier to type them, but when you forget, right click for the options.
A number of rules govern the use of the symbols to ensure a sensible result.
When any hierarchy symbol (L, K, J, H, G, M) is used then one of the symbols immediately beneath it must
exist. E.g. If you use a "G", then you must use at least one "M" or "X" must be used.
When any cross master symbol (V, W, Z, Y, X) is used then so must the hierarchy symbol (K, J, H, G, M) at
the same level.
When any rotated constant symbol is used, the corresponding progressed symbol must be used also.
Special Symbols: In addition to the symbols used for Progressed and Rotated Constants, the following special
symbols are available.
Symbol Description
B Designates that the chamber is used for a ball for lost ball
construction keying when allowed by the design module. When "B"
is used, the depth step specifies the ball size and the SOP must
be 0. See Construction keying 177.
A Used on pure keyed-to-differ. "A" is construed to mean All. If you
use the symbol A then you may have only one code progression,
and other than 0, A is the only symbol allowed. Available only on
design modules that support pure keyed-to-differ. When "A" is
used, then all combinations of codes are produced, without any
consideration to master keys. This is suitable only for systems that
have many individual keys, but absolutely no master keys.
After entering the values for a progression, it is a good idea to review it (Click Test, see Testing the system
design - coding tree 179 , Testing the system design - coding matrix) 180
Creating system design: Custom progression
The standard progressions we have looked at until now use a constant depth step for each chamber and
generated codes are produced in ascending order. Many design modules allow you to specify a custom
progression.
Custom progressions use SOP and designations in the manner described above, but instead of depth step you
specify for each progressed or rotated chamber the actual depth values you want to use and the order in
which they are to be used.
To make a custom progression, click on the custom progression tab. In the appropriate cells enter the
progress order and designations as you would for a standard progression, then for the depths enter the
values that you want that chamber progressed to.
Custom progressions give the ability for the agile minded to produce multiple code progressions,
each time using only part of a chamber. They may also assist you in making a coding tree that is
compatible with a legacy system. Unless you have special coding requirements is is advisable to use
standard progressions where possible.
Modifying a system design
You may revisit the system design at any time by first opening a coding window, then click the Change
design button (top right of the window).
Here's an overview of things specific to changing the system design.
Making more key section available
If the design module allows multi-section systems, then the button Promote key section will allow you to
select a new higher level key section for the system from the key section family already assigned to the
system. Having promoted the system key section, there will be more key sections available in the coding
window. See Promote key section 176.
Changing the TMK
There is little if any reason to alter a TMK after a system is coded, however as you start coding you may
determine that a better main permutation selection would be beneficial. To allow the main permutation to be
altered, click on the adjacent Edit TMK button.
Adding another code progression
Many systems need only a single code progression to derive all the codes you will need. However on occasion
you may want to "slice and dice" the codes in such a way that a single code progression cannot produce. For
example, when you want to make several coding trees to tightly represent a non-symmetrical system..
· To add another code progression, enter it into the Standard progression or Custom progression as
described earlier.
· Enter a brief description of the code progression in the place provided. Please do this! When you design
systems with multiple code progressions is will often be unclear why each code progression was created,
particularly when you revisit the system some time later. The description appears on the coding window to
assist you while coding.
· Click the Test button to see the solution.
· Click Add progression to add the code progression to the system design.
You may enter noted for the progression on the notes tab. Click back on onto the Standard
progression or Custom progression (choose the one you where entered the progression) tab
clicking Add progression.
· Click OK to save the system design changes. On returning to the coding window the new code progression
will be available.
When you add multiple code progressions, ProMaster Master Keying applies constraints to prohibit you
from entering conflicting code progressions. In particular, once a chamber has been used for one
purpose you are prohibited from using it for another purpose. This is a good solution for many user,
however some users will find this too restrictive. It is possible to disable these checks in the security
group permissions by turning on the security flag Access advanced coding features. Be aware that
turning on Access advanced coding features disables a number of sanity checks, so you are now
responsible for more of the system integrity. Don't turn on Access advanced coding features
because you want to be the most powerful person around! Turn it on only if you really need it.
Altering a code progression
There are a number of reasons why you might want to alter a code progression. For example, you might
want to introduce some rotated constants.
When you alter a code progression, be careful not to make it incompatible with any existing codes. To make a
simple example, let's say the Designations were 000CC0 and using this progression you coded the system.
Then later you need more codes, and decide to change the Designations to 00CCC0. This will produce key
codes that are not compatible with the ones you have already used, because instead of 2 positions varying
from the TMK, you now have 3 positions varying. In this situation, to get more codes for an existing system
and to keep them compatible, you must rotate a constant like this: 00cCC0. (Notice the lower case c which
specifies the rotated constant).
To alter a code progression:
· Select the Code progression in the list.
The code progression will be displayed in the standard progression or custom progression depending on the
type of progression.
· Make your changes, being sure to enter a description if appropriate.
· Click Save progression to save the progression or Cancel edit to discard your changes.
To convert a standard progression into a custom progression so that you may specify the precise depth
progressions:
· Select the Code progression in the list.
· Make your changes (you must enter the depths), being sure to enter a Description if appropriate.
· Click Save progression to save the progression as a custom progression or Cancel edit to discard your
changes.
Removing a code progression
You may not remove the only code progression, but if you have added multiple code progressions you may
also remove them.
· Select the Code progression in the list.
Sorting progressions
Right click on the progression list to see options for sorting progressions into the order that you want.
If you need to expand the system to use a broader range of key sections, you then use the promote key
section feature.
When you Promote key section, the key sections available to you are determined from the current system
key section and the key section (and keyway) definitions. You may then choose a new key section to use as
the system key section, and subsequently you will have all key sections beneath that new key section available
for coding.
Promoting the key section is a one way operation - you can not then demote the key section. Promoting
the key section does not change the coding of any keys within the system, it merely changes the
system design to allow more key section to be used.
Getting started
171
See System design .
· Flag all doors that need to be construction keyed. This can be done as you add the doors (if you had
already selected a Construction Keyed Keying Type) or later in the Door Bulk Change window.
· Any and all construction keys must have the designation Construction. Once a key is flagged through its
designation as being a construction key, various functions and capabilities are automatically enabled.
· Assign the construction key to operate all the construction keyed doors.
To use the half key method of construction keying, you must manually enter the appropriate half code for your
construction keys. Do this in the coding tree or coding matrix by selecting the construction key then click the
Enter code button.
Lost ball construction keying
To use the lost ball method of construction keying, your coding progression must have the symbol B in the
designation, and the corresponding position in the depth step indicates the ball size. Leave the SOP in this
position as 0. In the coding tree or coding matrix you can right click on the construction key to access menu
options for assigning the construction key code.
Here's an example of a system design for lost ball construction keying.
Item Value
TMK 365144
SOP 000120
Designation 000CCB
Depth step 000224
Item Value
TMK 365144
SOP 000321
Designation 000CCM
Custom depth step Chamber 4 = 3, 5, 7, 9
Chamber 5 = 0, 2, 6, 8
Chamber 6 = 0, 2
That's the custom progression that will generate all your normal codes. Now we need to add a standard
progression to define where the construction keying ball will appear. Here how:
Item Value
TMK 365144
SOP 000000
Designation 00000B
Depth step 000004
Now, when you return to the coding tree or coding matrix, there will be one tab with the custom progression
for all your standard codes, and another one for retaining the ball information.
To create the two code progressions described here, the user needs to have their security rights set to
Access advanced coding features as the normal checks will prohibit the reuse of the chamber (It
is used for M and B purposes)
The TMK is generated according to the rules you entered when creating the design. Any TMK that ProMaster
Master Keying generates is then checked against existing systems to check for a duplication.
If you accept the TMK that has been generated, click OK, else click Calculate to have another one generated.
The option to generate a TMK is not available for all design modules. Generally if the manufacturer's
guide is that main permutations are to be taken from a manufacturer provided list then the option to
generate one will not be available.
The key hierarchy evaluation displays in the quantity calculated column and offers the Quantity required of
each level within the key hierarchy. You should adjust these numbers to allow for spare keys, system growth,
etc. Some design modules will allow you to alter the depth step used for progressing the TMK in each
chamber.
Logic rules are applied, and an error reported if your request does not make sense (e.g. 2 GMK keys and 3
CK, but no MK).
Options
The choice Use rotated constants if needed, if checked, instructs ProMaster Master Keying to construct a
design using rotated constants to yield more keys if such a solution is possible.
233
Other choices depend on the design module you are working with. See Design modules
Calculation
After making your adjustments, click Calculate. ProMaster Master Keying will compute a solution, or notify
you if a solution is not possible.
After the solution is computed, you will see:
· For each level of hierarchy the minimum number of codes available at that level.
· The Solution, showing the chamber usage, depth steps and rotated constants.
You may recompute the solution if you wish by clicking the Calculate button again.
Viewing the solution
You may view the solution in the matrix or tree by clicking the corresponding buttons.
When you are satisfied with the proposed solution, click OK to return to the system design window. The
computed solution will be transferred into the Standard progression ready for you to complete the system
design.
· The minimum number of good codes in any branch for each designation.
Beneath the legend, the Bad code reasons gives the reasons why the selected code is bad. As you move
about the tree the reasons change to reflect your selection.
· A coding work-space on the right (used to show the tree, matrix or grid).
· Buttons on the top right for changing the system design, coding reports and notes.
· Click the button above and to the right of the lists of key colours.
· Click the Enter code. button to manually enter a key code. See Code entry
191
.
· Click the Remove button to remove the key code.
· Click the Find key above in designer button to find the key above the selected key in the coding tree or
coding matrix.
· Click the Find key above in key list button to find the key above the selected key in the key list.
· Click the Assign branch button to auto assign the codes in just that branch of the key hierarchy within the
coding tree.
· Right click on the key list in some design modules to perform tasks such as assigning construction key
codes and assigning control key codes.
Within the key list, in addition to the normal navigation key presses that operate in any such list, you
may also use Ctrl-UpArrow and Ctrl-DownArrow to move to the previous or next key that does not
have a code assigned and F3 to search for a Key Number. Right click on the list for a menu with more
options and the corresponding key presses.
Automatic Code Assignment: The buttons for automatic code assignment appear only on the coding tree.
See Coding using the coding tree 184.
Coding: Click Calculate coding and errors to perform a complete calculation on all doors and to check for
errors.
After coding is finished, you must always click Calculate coding and errors to complete the process.
If Calculate coding and errors is successful, and other conditions are met (e.g. each key has a code
assigned, each door has one or more keys assigned) then the system will be flagged to indicate that
coding is complete, and jobs will be allowed to progress to manufacturing.
Coding errors: Down the bottom of the keys tab is an area that displays any errors that are identified. The
coding errors area is initially shrunk (you may resize it using your mouse on the splitter just above the
heading), and if errors are identified it appears automatically.
In the coding errors area, all errors are shown on the Door errors tab where each problem door is listed
with the keys that erroneously operate it, and each error is also shown on the By Key tab where each problem
key is listed with the doors that it erroneously operates. Print and Print preview are available for the error
list, as well as Door pinning report for the selected door.
If your system shows coding errors, click on one of the errors (in the Doors errors or the Key errors
lists) and then click the Find button. The offending key will be located on the coding work space, and
also the offending door-key combination will be located in the Keying matrix. This may also be
achieved by double clicking on the phantom.
When a system is correctly coded, there will be no coding errors. Your first step to resolving coding errors
should always be to assign new codes to the offending keys. If however the error is unavoidable, perhaps
because of the limitations of the locking system or because it is a replaced key whose code still operates a
central door, then the resolution will be to assign that key to operate the door, thereby removing the error
condition. Changing the keying should not be done without due consideration, and in the case of complex
cross keyed systems that simply cannot be coded, you may have to redesign the key system in conjunction
with your client.
On systems that use Control keys (A control key removes an interchangeable core, and is specified by
setting the key designation to Control), the error check is performed on both the lock shear line (or
equivalent) and also the control shear line. When error keys are displayed, they are sufficed with information
to indicate which shear lines the key phantoms through.
Left Tab: Lockout codes
When you click on the Lockout codes tab, you change the operating mode of the coding windows from that
of assigning key codes to locking out or reserving codes.
Locked out codes are codes that you have for one reason or another prohibited from use. Typically you might
lock out a branch or more of codes that you
After having selected the Lockout codes tab, to create a locked out code, do one of the following:
· Double click on an unused code on the Coding tree or Coding matrix, then when prompted, enter a
reason for the locked out code.
· Or, click the Enter code button to enter the code manually.
In the same way that keys are shown in the coding tree and coding matrix, so too are locked out
codes, showing that the code is locked out and also on the coding tree the reason that you entered.
Left Tab: Options
Options
The Display option (Coding matrix only) allows you to choose how the coding matrix appears, whether is is
small, large, shows codes or shows keys.
Here are other options available:
Option Description
Move after code assigned After you assign a code to a key, causes the next un-coded key to
be selected. Generally you would want this turned on, however if
you have a messy system and you are repeatedly guessing a code
and checking for errors, you would benefit from leaving this off so
the key remains selected.
Calculate pinning while assigning codes Causes pinning and phantom check calculation to occur as you
assign each code. This is the best way to operate as error
conditions are immediately brought to your attention.
Allow cut keys to be rekeyed Available only if the user has the necessary security permissions.
This allows the code to be altered or removed on a key that has
been manufactured. For safety reasons, the setting for this option
is not remembered, and if you leave and re-enter a coding
window it will be off.
Show code quantities on tree Coding tree: When the Options tab is selected, having this
option on draws the tree to show the quantities of codes beneath
each master.
Hide bad codes Coding tree. Bad codes are hidden on the coding tree rather
than being shown with a bad-code graphic.
As you select any key in the coding tree or coding matrix, the bad code reasons show any reasons why the
selected code is considered bad. It is possible to use bad codes (see Options earlier), but before doing so you
should consider the reason why a code is bad. For example, you may choose to use a code that is deeper in
the first cut than desirable, thereby producing a weak key, but to use a key code that violates the Maximum
adjacent cut variations (MACS) makes no sense since usually the key is not able to be produced.
Left tab: Doors
Shows a list of all doors in the system, and beneath each door the keys that operate the door. Right click on a
door or key for more options.
In many design modules you may select a door, then click Special pinning to specify special pinning for the
191
door. See Special pinning .
In some design modules it is possible to have a key assigned to a door, but for the door coding to not be
calculated. The menu options Find prior door without pinning and Find next door without pinning
locate doors that have no pinning solution. An example of this is in the interchangeable code module, having a
door with a control key assigned but no operating keys.
Top right buttons
171
Click Change design to alter the system design. See System design .
Change design
The Change design button gives access to a menu of options for altering the system design.
The drop down part of the Change design button access more system options, depending on the design
module:
Change key sections: Allows the key sections to be replaced with different ones. See Change key
193
sections .
Change a constant cut: Opens the system design window in a manner that allows the TMK to be altered in
positions that are common to all keys. The only positions that may be altered on the TMK are those that are
constant across all keys. Typically this would be used if you have an existing key system where keys have
been lost, and instead of a complete re-key and new keys you choose to re-cut one position in each key to a
deeper code and to alter the pinning only in a single chamber in each cylinder, effectively making the system
secure against the lost keys without a complete new system being required. Note however, the new value for
the constant chamber must be a deeper cut than the original.
Coding work space
The coding work space appearance and functionality depends on the particular coding window you are using.
184 186
See Coding using the coding tree , Coding using the coding matrix , Coding using the kaba coding
188
grid .
Keying matrix
Over on the right with of the coding window, below the coding work space is the keying matrix. This keying
matrix is similar in appearance to that you use when assigning keys to doors while entering the system, but
with somewhat reduced functionality.
To make the keying matrix visible, grab the splitter above the keying matrix with your mouse and drag it up.
This keying matrix serves two purposes:
It allows you to view the keying in a matrix layout.
It allows you to right click any door-key junction and select Keying on or Keying off. Do this with caution as
altering keying should generally not be the first tool you turn to when you have difficulty coding a complex
system. When you alter the keying, the door is recalculated and errors are updated accordingly.
If the system has not yet been designed, the system design windows will open first. Complete the design
171
process (see System design )
After the system design is complete, the coding tree window appears.
Coding work space
The coding work space is the area on the right of the coding window. At the top of the coding work space are
one or more tabs, which show the code progression used to produce the coding tree.
Initially, any system will have just one code progression, and hence just one tab at the top of the
coding work space. Advanced coding, or coding in some design modules may require multiple code
progressions, and these will be displayed, each on their own tab.
If the code progression has a description, that (or the first part if it is long) is shown on the code
progression tab. If the code progression has noted, a note graphic is shown on the tab and you may right
click to get access to the code progression notes.
When you are on the coding tree, the navigation keys on your keyboard navigate around it. To assign a code
from the tree to a the selected key, either double click the code with your mouse, or press the Space key on
your keyboard. If you use automatic code assignment then you will not need to do this.
When a code on the tree is assigned to a key, or is reserved as a lockout code, the key number or lockout
reason is shown beside the key code.
On multi-section systems, the coding tree displays the keys that are assigned codes using the currently
selected key section.
If there are multiple tabs at the top (I.e. Multiple code progressions have been defined, then the coding tree is
drawn using the definitions from the currently selected code progression tab).
Automatic code assignment
To perform automatic code assignment, the key above and designation must be correct for all keys and
the system design must have a code progression suitable for the key hierarchy. I.e. You cannot create
an inappropriate design and expect ProMaster Master Keying to wave a magic wand and make it work.
The Assign codes attempts to assign a code to every key that does not already have a code. If you are doing
automatic coding and the system does not require any intervention (such as is required on a multi-section
system) then this is the button you click to do the business.
The Assign branch button is used when you want automatic code assignment but want some control over
where the coding starts from. Here's an example of how you might do this. Imagine a multi-section system
and you want a branch of a system on a particular key section. To do this, first select the key section then
select the master key at the top of the branch and then assign it a single code. Now, with the master key
assigned a code and still highlighted, click the Assign branch button to have all keys below that master key
assigned a code. When you click Assign branch, a key section window will prompt you for the key section to
use id there is a choice. E.g. Key sections ABC, AB, AC, BC, and your master or sub-master is on ABC then
the window will give you a choice of ABC or the key sections beneath ABC.
The Remove unordered button removes the coding information from all keys that have not been ordered.
Don't panic – it makes you type in a confirmation message first.
What about removing codes from all keys including ordered keys? First you must have sufficient security
access, then on the Options tab you need turn on the flag Allow cut keys to be rekeyed. Now when you
click on the Remove unordered button it gives you an option to allow all codes to be removed.
If this all seems like way too much functionality for a simple system, consider this. If you enter a
straight forward sort of system, and correctly enter the Designation and Key above for each key,
171
then the coding takes just a few seconds to (a) Create the design (See System design ), then (b)
178
Use the Design assistant (See Design assistant ) to make a suitable Code progression, then (c) In
the Coding tree, click the Assign codes button. Straight forward system? All done!
Key head colours and automatic code assignment
When ProMaster Master Keying performs automatic code assignment on a system that uses key head colours,
186
you are asked how colours are to be assigned. See Colour rules
Sometimes on highly selective systems it is very hard to find a code for a key that will not produce
errors and it comes down to trying dozens of codes and seeing what happens. Here's a hint to make
this process easier. First, on the Options tab turn off the option Move after code assigned.
Highlight the troublesome key. Now when you assign a code to the key, hold down the Shift key on
your keyboard. The Shift key allows you to assign a new code to the key without first removing the old
code, and because you turned off the option Move after code assigned, then the key will remain
selected after the code is assigned, thereby allowing you to immediately try a new code if errors were
produced by your code assignment.
Assign the same came colour to all keys: The colour(s) you select are applied to all keys that are
assigned a code.
Assign the colour to each key based on the key hierarchy: You must select the colour(s) for each
level of key hierarchy, and those hierarchy colour choices are applied to all keys that are assigned a code.
The colours you select are remembered for each design module, so when you return to automatic code
assignment the colours remain the same.
Getting started
· You must be logged in with a system open.
If the system has not yet been designed, the system design windows will open first. Complete the design
171
process (see System design )
After the system design is complete, the coding matrix window appears.
How the coding matrix works
The coding matrix takes a code progression and produces an array of codes, displaying them in a hierarchy
of codes within codes. Each hierarchy of code is shown in a different colour, and the Codes to hide option
allow you to alter the view of the codes to simplify it down to just show the code structure that you require.
The nature of the coding matrix is such that:
· When you create the design, the design assistant is not available.
· When you create the design, rotated constants are not used.
· If you open the coding matrix for a system that has designations or rotated constants defined, they are
ignored.
· To produce the equivalent of rotating a constant, you define multiple code progressions for the coding
matrix.
Coding work space
The coding work space is the area on the right of the coding window. At the top of the coding work space are
one or more tabs, which show the code progression used to produce the coding tree.
Initially, any system will have just one code progression, and hence just one tab at the top of the
coding work space. Advanced coding, or coding in some design modules may require multiple code
progressions, and these will be
If the code progression has a description, that (or the first part if it is long) is shown on the code
progression tab. If the code progression has noted, a note graphic is shown on the tab and you may right
click to get access to the code progression notes.
When you are on the coding matrix, navigation keys on your keyboard move around it. To assign a code from
the matrix to a the selected key, either double click the code with your mouse, or press the Space key on
your keyboard.
When a code on the matrix is assigned to a key, or is reserved as a Lockout code, the code is modified to
indicate that it has been used.
On multi-section systems, the coding matrix displays the keys that are assigned codes using the currently
selected key section.
If there are multiple tabs at the top (I.e. Multiple code progressions have been defined, then the coding matrix
is drawn using the definitions from the currently selected code progression tab).
We have covered coding in the matrix fairly quickly. There are 2 reasons for this. Firstly, no amount of
words are as good as getting in and trying it and learning how the codes work. Second, most users
who do matrix coding are already trained in the matrix-coding principals.
Option on the options tab
The first option is the matrix Display style. This determines how the the keys and codes represented on the
matrix - as a cube (3 sizes), showing the key code, or showing the key number assigned that code (2 sizes).
For a large matrix it is often more manageable to display the matrix as a series of colour coded cubes and not
display the code or key number.
Codes to hide controls which of the generated codes are shown on the matrix.
If you turn off the flag in Incidental masters and click the Apply settings button, you will see the matrix in
its full glory. It is a good idea to do this on a smallish matrix (maximum 4 chambers progressed) and examine
the colours and key codes to understand how the matrix shows every key code and their relationships.
When you progress several chambers from the TMK, there are many codes produced, and we want to look at
how to classify these.
Any code that has every progressed position different from the TMK is a Level 1 key. It is a Change key.
Now look at the yellow cells in the matrix. These key codes have all but one of the progressed chambers
different from the TMK and are referred to as a Level 2 key. An on it goes for all other levels.
Hierarchical masters form a hierarchy going up through the levels, from Level 1 right up to the TMK. Out
of the codes we also select a set of master codes that we call Cross masters. Cross masters operate
through different sets of keys to those operated by each Hierarchical master. If it helps you can think of
them as horizontal versus vertical masters. Finally, Incidental masters are all masters that are not a Cross
master or a Hierarchical master. Incidental masters are the most complicated to understand, and
should only be turned on if you need to select one of them for a key.
Sometimes on highly selective systems it is very hard to find a code for a key that will not produce
errors and it comes down to trying dozens of codes and seeing what happens. Here's a hint to make
this process easier. First, on the Options tab turn off the option Move after code assigned.
Highlight the troublesome key. Now when you assign a code to the key, hold down the Shift key on
your keyboard. The Shift key allows you to assign a new code to the key without first removing the old
code, and because you turned off the option Move after code assigned, then the key will remain
selected after the code is assigned, thereby allowing you to immediately try a new code if errors were
produced by your code assignment.
Design modules
This topic is applicable to these design modules:
· Kaba ACE
· Kaba Expert
· Kaba Quattro
· Kaba Gemini
General
The Kaba modules all allow you to perform tree based coding (see Coding using the coding tree 184 ) and this
is often an easier option for simple systems. The coding grid is used to code Kaba systems is the traditional
manner and is the best way to code with multiple rotor stators or cross keying.
A prerequisite for using these design modules within ProMaster Master Keying is that you have
completed appropriate Kaba training and have a comprehensive understanding of positional keying.
If the system has not yet been designed, the system design windows will open first. Complete the design
171
process (see System design )
After the system design is complete, the coding grid window appears.
How the coding grid works
All coding happens by adding keys into the designer, altering the code, then saving the keys in the designer.
On the Keys tab there are several buttons for adding codes to the designer:
Add all to designer: Adds all the keys to the designer.
Add to designer: Adds just the selected key to the designer
Add keys below to designer: Adds all the keys below the selected to the designer.
Often you will need to add more keys into the designer than just those you plan to alter, as you need to
see the pattern of how the codes are progressed. For manageability, you may find it easiest to work on
a branch of the system at a time when your system is large.
When you add codes into the designer, one of two things happen.
· If the key already has a code, then it is added to the designer with its code, and the code is displayed.
· In the key is un-coded, then when it is added to the designer, the Set TMK when adding options above
the designer are used to determine which parts of the TMK will be used to make a code for the key. So for
example, if you want to make a key that has only left side, then you would turn on the LXX options and turn
off the RXX options then add the un-coded key to the designer.
You may sort keys in the designer by dragging the Key number further up or further down the grid using
your mouse.
Progressing individual codes
To progress codes, navigate to the designer cell that you want progress, and press the Space key. You will
see the code at that position change to a 4 (or a 3 in some circumstances) and the cell will be coloured green.
Right click on the designer for more options.
Progressing multiple codes
When a single cell on a master is selected, the option Copy master cuts to keys below is available.
To progress a block of codes, select that block and use the Selection progressed and Selection not
progressed options.
When a single cell is selected, the options Column progressed and Column not progressed are available.
Automatic progression of codes
ProMaster Master Keying provides a facility to automatically progress codes for a selected range of keys.
To do this:
· Either select a single cell on a master and use the option Progress keys below this master
· Or select a range of keys in a single column and use the option Progress
190
The Progression window opens. See Coding grid progression
Other functionality
There are a number of buttons beneath the designer and are available options on the designer popup menu
also (have a look and learn the key presses).
· Set key cuts to TMK cuts: Sets the selected key in the designer to the cuts of the TMK.
· Set block to TMK cuts: Sets the current block or segment of the selected key in the designer to the cuts
of the TMK.
· Clear block: Clears the current block or segment of the selected key.
· Undo key changes: Undoes all changes to the key, reverting it to the value it had when it was loaded into
the designer.
· Discard key: Removes the selected key from the designer without saving it.
· Discard all: Removes all keys from the designer without saving.
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
General
All possible rotors for the selected keys are shown in the left top list. You must first select which rotor you
want to use.
Standard method
After selecting the rotor:
· Choose which positions on the rotor you want to use. Unavailable segments are disabled. A segment will
be unavailable if it is the dealer segment, has no common positions across all keys that can be progressed,
or is empty on one or more keys. Select which segments on the rotor you want to use for coding.
· Choose the progression direction. Right to left is normal for change keys. Left to right is often used for
master keys for the reason that it makes them visually distinct on the designer.
Now a solution, if one is possible, will be shown. It will be the solution that uses the fewest positions.
· Under Keys required and yield, change the drop down selection for Progress to generate additional
codes (e.g. For expansion and replacement keys) if you wish. A new solution will be shown.
· Click OK to produce the progression and return to the designer.
Advanced method
· In the Positions available and selection in advanced mode toggle on the positions that you want to
use. When enough positions are selected to generate a solution, the OK buttons is available.
· Under Keys required and yield, change the drop down selection for Progress if you want to tailor the
solution.
· Click OK to produce the progression and return to the designer.
The choices vary by design module, and also by depth/space card used (when applicable).
The values available for selection are constrained by those values permitted, and any other factors, such as
the List in some design modules.
On some design modules, the option to leave a chamber empty is available. If you specify that a chamber is
empty, it results in blank pinning in that position, and phantom checking adjusted accordingly to not check that
position.
Getting started
On the coding window:
· Click on the doors tab.
Making a change
Please enter a note to explain why you have special pinning.
· For design modules that support multiple key sections, you may select any key sections that you want to
operate the door.
· In the Additional cuts to operate door area, turn on any codes you want to operate the door.
· In the Additional cuts to operate door area, if you want a chamber left empty, turn on Empty for that
position.
· Click OK to save.
When you return to the coding window, there is a indicator graphic beside the door.
Pinning is recalculated for the door.
Making a change
· You must enter the specified text before proceeding.
There is no undo. When you type the confirmation text and click OK, the design is gone.
This is not a once only process. Each time you make a system change that ProMaster Master Keying knows
will affect coding integrity, it flags the system as "coding not complete", and even though you want to override
this, you must still enter the coding window, perform Calculate coding and errors (which may not be
successful). Then to accept the system errors and enable the manufacturing processes, you must then follow
this process.
Getting started
· You must be logged in with a system open.
On systems using multiple key sections, the process of changing key sections not only requires you select a
new system key sections, but for each key sections used within the system you must choose a replacement
key sections from the new key sections family.
Getting started
· From the coding tree or coding matrix, click the down arrow by the Change design button to get the
menu, then choose Change key sections.
Making a change
· From the Change key section to drop down list, choose the new key section for the system.
· Then click Load key sections. The right side list is loaded with all the key sections below the key
selection you selected.
· Now, for each key section on the left list "Old key section", select it, then on the right list select the
replacement key section, and click Assign replacement key section. Repeat for each old key section.
· When you are finished, read your choices carefully, then enter the confirmation text and click OK.
Our advice: Don't print this report. Here's why. If you are printing it to keep a paper copy of your
systems, please consider how practical and reliable that is compared to a comprehensive computer
backup solution. If you are printing this so you can cut keys without entering a job, which some people
do, ask yourself why you are deliberately avoiding generating accurate history for your customer's
system. To top it off, most likely there will be few customers who are happy about having printed
copies of their security investment floating around.
Getting started
or
· From the coding windows, click the Key codes report button. See Coding screen overview
180
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which keys do you want to All: All keys are printed.
include in this report
A selection of keys: You select the keys to be included on the report.
Keys in a group: Select a key group. Keys in that group are included on
the report.
Keys that have been manufactured: All keys that have been
manufactured are included on the report.
Keys that have not been manufactured: All keys that have not been
manufactured are included on the report.
Options
Option Description
Show codes that have not been When selected, keys that have not been assigned a code will be included
assigned a code in the report, otherwise they are excluded.
Show a line between keys May increase readability if on.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
or
· From the coding windows, click the Door pinning report button. See Coding screen overview
180
or
· From the coding windows, right click on a door on the doors tab and choose the Door pinning report.
or
· From the coding windows, right click on a door error (coding errors section at the bottom left of the coding
window)and choose the Door pinning report.
Range
The range specifies the set of data that will included in the report. Here is an explanation of the range
choices:
Range Description
Which doors do you want to All: All doors are printed.
include in this report
A selection of doors: You select the doors to be included on the report.
Doors that fit a selection of keys: You select one or more keys and all
doors that are operated by any of those keys are included on the report.
Doors in a group: Select a door group. Doors in that group are included
on the report.
Doors that have been manufactured: All doors that have been
manufactured are included on the report.
Doors that have not been manufactured: All doors that have not
been manufactured are included on the report.
Options
Option Description
Report layout Do not show keys: Keys are not shown.
Key numbers only: The key numbers are shown beneath each door.
Show doors that have not been When selected, doors that have not codes will be included in the report,
coded otherwise they are excluded.
Show door notes Turn on to show any notes entered in the job for each door.
Show a line between keys Complete key information layout only.
Turn on to show a line between each key. This make improve readability.
Show lock finish Turn on to include the lock finish in the door information area.
Show lock part item number Turn on to include the lock "item number" in the door information area.
Show a line between information Turn on to show a line between each information item. This make
items improve readability.
Show cylinder assembly Manufacturer edition only. Cylinder sub assembly feature must be in your
ProMaster Master Keying license.
Turn on to include cylinder sub assembly information in the door
information area.
Pinning font size Allows you to decide the font size used for the pinning information part of
the report. A larger size may be preferable for readability.
Sort order Choose how the doors will be sorted.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
9.13 Jobs
Throughout the life of a system, from the initial order, through system extensions and key reorders, you will
visit the Jobs window to enter the customer job.
When the customer places an order, always create a job. DO NOT cut keys or supply cylinders without
processing a job, or there will be no history of system activity.
Getting started
Making a change
· Use the Add, Remove and Edit buttons the manage up your jobs.
Job tab
The job tab is where you record the basic information about the job, including the factory where it is to be
manufactured. It is also where you see the status of the job and information about who has performed each
stage of the job and when.
Signatories tab
The signatories tab is where you record the signatories who have authorised the order. All active signatories
are shown, and as you select each signatory the corresponding signature and photo is shown. To indicate that
a signatory has authorised the job, place a check next to that signatory. At the bottom of the window is a
summary of the signatory security that has been configured for the system. If applicable you may right click
on a signatory to see individual keys and doors that the selected signatory may authorise.
Key authorities and door authorities are accessed from the toolbar also.
Notes tab
The notes tab allows you to record some notes about the job. The notes are printed on the manufacturing
paperwork. The default notes may be configured for the system, and on a job-by-job basis you may enter
whatever notes are necessary.
Delivery tab
As you would expect, the delivery tab is the destination to which the order will be shipped.
There are two addresses. Normally only the first address would be used, however if you order keys and doors
on the same order, and one or more of those keys is flagged as Ship this key separate from lock parts,
then you must enter a delivery address and a delivery address for keys.
Keys tab
The keys tab is where you order the keys. More on this later.
Doors tab
The doors tab is where you order the doors. More on this later.
Documents tab
122
The documents tab allows you to store documents for the system (see Documents ), but rather than being
general document they will be associated with the job. For example, you may receive an order on paper and
decide to store a scanned copy of the order.
Ordering keys
This section is focused on what you do in the keys tab.
When the job is being entered, the keys list shows all active keys in the system. After you release the job
(Order complete), the list is revised to show just the keys you have ordered.
The list shows:
· The key number.
· If the order has been released, the issue numbers allocated to this order.
· If the order has not been released, the quantity already cut.
· The type for the current order (Shows Key if you are ordering new keys, or Reissue if you are ordering
an existing key to be re-cut).
· The quantity on this order.
Signatories: If the system uses individual key authorities, the Signatories button will show you the
signatories who are permitted to authorise the selected key.
Ordering reissues: To order reissues of the selected key, click the Reissue button. You may enter any valid
issue numbers, and also ranges or issue numbers. For example, if there had been 20 previous issues of a
key, then this would be a valid way to order some reissues: 6-8,3,10,14,12
Reissues are to replace a damaged or broken key. The ability to order key reissues must be turned on,
as it is disabled by default. In many cases, reissues should not be ordered, and you should always
consider if there is a good case for ordering another copy of an existing key. In most cases, it is better
that the old key be recorded as damaged and a new key with a new issue number be produced.
· To order a key, enter a quantity on that line.
At times you have a pile of keys to order, and they are all the same quantity. There's an easier way to
do this. After entering the quantity (and possibly a note) for the first key, press F12 to copy the quantity
to the next line, or press Shift-F12 to copy the quantity and note down to the next line.
· To remove a key from the order, change its quantity to 0, or for reissues, click the Reissue button and
alter the reissue numbers.
· To find a key, click Find key and enter the key number you want to locate.
· To restrict the keys that are displayed, click on the Key display button and make your filter choices.
· If the system uses individual key authorities, click Signatories to see the signatories who may authorise
the key order.
· To print the keys for customer approval, click Print then Print keys. See Report: Job pre-release key
204
confirmation .
You may right click on the keys list for a menu with more choices, including a door access and a history of
key orders.
Ordering doors
This section is focused on what you do in the doors tab.
When the job is being entered, the doors list shows all keyed doors in the system. After you release the job
(Order complete), the list is revised to show just the doors you have ordered.
The list shows:
· The door number.
· If the order has been released, the issue numbers allocated to this order.
· The quantity of Keys per cylinder that is required (Must be enabled in the Application parameters 49 ).
Because you enter each door as a separate entity, the order quantity for a door will almost always be
one. The exception to this is when a door entity represents a padlock rather than a physical door, in
which case you might order more than one.
· To order a door, enter a quantity on that line.
· If you are using keys per cylinder ordering, enter a quantity for this also.
At times you have a pile of doors to order, and they are all the same quantity. There's an easier way to
do this. After entering the quantity (and possibly a note) for the first door, press F12 to copy the
quantity to the next line, or press Shift-F12 to copy the quantity and note down to the next line.
· To remove a door from the order, change its quantity to 0.
· To find a door, click Find door and enter the door number you want to locate.
· To restrict the doors that are displayed, click on the Door display button and make your filter choices.
· If the system uses individual key authorities, click Signatories to see the signatories who may authorise
the key order.
· To print the doors for customer approval, click Print then Print doors. See Report: Job pre-release door
205
confirmation .
You may right click on the doors list for a menu with more choices, including a key access and a history of
door orders.
Modifying the ordered product
Right click on the door for menu choices, or use the toolbar buttons to alter the order if required.
Cylinders: If the product is a lock part, allows you to order all cylinders for the lock. If the product is a
cylinder, reverts the order to ordering the cylinder (assuming it had previously been changed to be say just
the core).
Rekey: Orders a re-key of the door, without supplying a lock or cylinder.
Core: Orders a Core (plug etc depending on your naming convention) and of course the keying/assembly, but
not a lock or cylinder.
Change product: Allows you to change the product being ordered for the selected door. A list shows
associated items, or you may select a completely new lock product (Must be enabled in the Application
parameters 49 ). There should be little or no reason to ever do this.
Rekey for key: Allows you to select a key, then orders a re-key for all doors that are operated by that key.
Final steps
After the order is entered, the keys are specified, the doors are specified, signatories selected and job details
entered, the next thing you do is tell ProMaster Master Keying that you're finished. To do that, click the Order
complete or Release to mfg button (Button changes depending on whether or not you have enabled the
"Coding required' job status in application parameters).
When you click the button, a number of things happen:
· The job is saved.
· The job is checked to ensure that the signatories are appropriate for the keys and doors that have been
ordered.
· If you have orders keys by specifying Keys per cylinder then those keys are located and added to the
order. If a bottom level key cannot be determined for a door, the process of completing the order will halt
and you will be presented with a list of problem doors. So for example, if a door has two bottom level keys
that operate it, and you specify that you want to order some keys for that door, there is no logical way to
tell which key you mean, and in this case you must specify the actual keys you require rather than
specifying Keys per cylinder.
· Depending on whether or not coding is complete for the system or not, and also depend in on your
Application parameters 49 setting "Send jobs to coding when released if coding is required", the job is
released to manufacturing or it is flagged as coding required.
· If the order has been released to manufacturing, issue numbers are allocated for all keys and doors that
have been ordered.
At the time that the job is changed to Manufacturing required status, a snapshot of the keying for
each door on the order is created, and also a snapshot of the pinning for each door on the order. All
subsequent operations on the job, such as viewing keying, printing manufacturing reports, exporting to
machines etc uses the keying and pinning snapshot, so a change to the door's keying does not alter
historical orders. Key codes are not included in the snapshot because they are considered immutable.
205
To manufacture the job, click on the Manufacture button. See the topic Job manufacturing .
Other functionality
The More button gives access to less frequently used functionality. The availability of each function depends
on the job status, application parameters, user permissions and the tab selected in the job.
Return job to manufacturing: Provided it has been allowed in the application parameters, this choice
returns a completed job to the manufacturing status, from where you may manufacture the job or return it
to data entry. Generally this should not be allowed as uncontrolled use of this functionality may result in
reduced history integrity.
Return job to data entry: Returns a job that is awaiting coding or manufacturing to data entry so it may
be altered. Note that when you return a Manufacturing required job to data entry, the history snapshot is
discarded, and later recreated when you release the job to manufacturing.
Order all keys: Allows you to enter a quantity to order for all visible keys (see Key display earlier). The
keys tab must be active.
Order all doors: Allows you to enter a quantity to order for all visible doors (see Door display earlier).
The doors tab must be active.
Order doors for a key: Allows you to elect a key and orders all doors that are operated by that key. The
doors tab must be active.
Edit invoice no: On a job that is no longer in the data entry phase, allows entry of an invoice number. See
Edit job invoice number 203
Toggle "printed" status: Changes the job printed status from yes to no, or no to yes.
Application parameters that affect jobs
Numerous application parameters affect the way jobs work. Here is a list of some you may want to look at
and tailor to the way your company operates.
Consider also the option to be given the same prompt when you
have finished manufacturing the job and mark it as complete.
Is the job "Invoice number" mandatory Turning this parameter on makes the invoice number mandatory.
Is the job "Required date" mandatory Turning this parameter on makes the required date mandatory.
Send jobs to coding when released if Premium and manufacturer editions only.
coding is required
When a job is entered, and you click the button to say "order
complete", and assuming the order is correct and with sufficient
signatories, then one of two things may happen.
If this parameter is set to Yes then the job will enter the Coding
status if coding is not complete, effectively locking the order, but not
allowing it to be manufactured until coding has been completed.
Generally this is the best choice for large organisations, factories or
any shop where the order entry, coding and manufacturing are
treated as distinct processes, often requiring disparate staff
What check should be performed for This option determines how ProMaster Master Keying will check for
duplicate order numbers duplicate customer order numbers (No check, check in system,
check in all systems for client)
· Paste the keys into the space provided in the Order Keys From List window.
The list is checked and reports an error if any keys are duplicated or do not exist.
Click OK to add the keys to the order.
· Paste the doors into the space provided in the Order Doors From List window.
· Enter the quantity you require (typically the quantity is 1 for doors) and any other options.
The list is checked and reports an error if any doors are duplicated or do not exist.
When you import a job using method 1, the job must be for the system that is open.
Method 2: Importing An order file without opening the system
· From the Jobs menu, select Jobs then Import job from Key Manager
When you import a job using method 2, the current system (if one is open) will be closed and the system
required for the job will be opened.
Importing data
After opening the file, the wizard shows some summary information about the order file.
If there are any jobs with the same order number, you will be shown a list of those jobs. From this you may
determine if the job is being imported in error a second time.
Choose the Factory that will manufacture the job.
Click Finish to perform the import.
197
After the import is done, you will be taken to the Job window. See Entering jobs
· If there are subsequent jobs that have ordered the same keys or doors then you must make a choice on
how to handle those items.
Option Description
Deallocate key issues that can be For this choice, the job always remains, and is marked as Cancelled.
removed, leave those that cannot Anything that can be removed from the job is removed, and all keys and
be deallocated and mark the job doors that have issue numbers allocated and are ordered on subsequent
as "Cancelled" jobs remain on the cancelled job to account for the issue numbers. Thsi
was the behaviour of previous versions of ProMaster Key Manager.
Force the job to be deleted. The job will be removed. Any keys and doors that have issue numbers
There will be gaps in the issue associated with them in the job will be removed, and those issue numbers
number sequence for some of will not be accounted for.
the keys or doors
· Click OK to delete the job.
Option Description
Show received signing area Shows an area on the report for the recipient to sign for the goods.
Show signatories Turn on to list the signatories who are on the job.
Show job notes Turn on to include the job notes in the report
Show key notes Turn on to show any notes entered in the job for each key.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Options
Option Description
Show received signing area Shows an area on the report for the recipient to sign for the goods.
Show signatories Turn on to list the signatories who are on the job.
Show job notes Turn on to include the job notes in the report
Show door notes Turn on to show any notes entered in the job for each door.
Show lock finish Turn on to include the lock finish.
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
Email The report is sent via email as a PDF attachment.
The items that are available depend on your job. For exampke, a job with only keys will not have any door
reports available.
· All have a corresponding button that will print, preview, save, send or view depending on the option.
Option Description
Print all selected This button prints all the select reports.
Manufacture all selected This button performs all the selected manufacturing tasks.
Publish to device Opens a window for device publishing. See Manufacture: Publish to
device 223.
Mark job as complete When, and only when, the job is manufactured, click Mark job as
complete to change its status from manufacturing to complete. If the
Application Parameter "Export system to client when job is marked as
complete" is turned on and if the system is configured to use ProMaster
Key Manager, then you will be prompted to sent the client an update for
their ProMaster Key Manager.
Marking the job as complete stops it from being manufactured by mistake, and allows accurate
reporting on outstanding jobs.
Other functionality
Click the options button for more choices
Option Description
Default print action "preview" Adjacent to menu reports is a button that has a default action and also a
drop down from which you may choose "Preview" or "Print". The default
action of that button is controlled by this setting. If you usually preview
reports rather tan printing them, turn this option on. The availability of
preview some reports is controlled by the Application parameter 49
"Allow print preview of manufacturing reports".
Printer setup Access your printer settings. See Printer setup 35 .
223
Machine setup Access your machine settings. See Machine setup .
Search for the job you want then click Manufacture to begin the manufacturing process.
Option Description
Show job notes Turn on to include the job notes in the report
Option Description
Show job notes Turn on to include the job notes in the report
Show key section summary Turn on to include total key section requirements at the top of the report.
Show key notes Turn on to show any notes entered in the job for each key.
Show a line between keys Turn on to show a line between each key. This make improve readability.
Key cuts font size Allows you to decide the font size used for the key cut part of the report.
A larger size may be preferable for readability.
Option Description
Show job notes Turn on to include the job notes in the report
Show key section summary Turn on to include total key section requirements at the top of the report.
Show a line between keys Turn on to show a line between each key. This make improve readability.
Key cuts font size Allows you to decide the font size used for the key cut part of the report.
A larger size may be preferable for readability.
For labels to print correctly on almost all label printers, the label size requested by ProMaster Master
Keying must be defined in the printer preferences.
To do this:
(1) Observe the exact label size for the layout you have selected in the Layout.
(2) Open the properties for your label printer and locate the place where you define "stock' or "paper
sizes".
(3) Add a new stock size. Give it a name and set the dimensions to the size of the layout you have
selected.
(4) Set the unprintable area as small as possible.
(5) Save the stock size. There is no need to set it as the default paper size - it simply must exist so
the printer knows about the size you are printing.
Options
Option Description
Layout Choose the label size you are using. Standard sizes are listed first
followed by any custom labels you have created.
Labels per bag The quantity of each label to produce. Normally this will be 1.
Keys per bag The number of keys that you put into each packet.
Option Description
Report layout Do not show keys: Keys are not shown.
Key numbers only: The key numbers are shown beneath each door.
Show job notes Turn on to include the job notes in the report
Show door notes Turn on to show any notes entered in the job for each door.
Show a line between keys Complete key information layout only.
Turn on to show a line between each key. This make improve readability.
Show key quantity Complete key information layout only.
Turn on to show the quantity of each key manufactured on the job.
Show lock finish Turn on to include the lock finish in the door information area.
Show lock part item number Turn on to include the lock "item number" in the door information area.
Show a line between information Turn on to show a line between each information item. This make
items improve readability.
Show cylinder assembly Manufacturer edition only. Cylinder sub assembly feature must be in your
ProMaster Master Keying license.
For labels to print correctly on almost all label printers, the label size requested by ProMaster Master
Keying must be defined in the printer preferences.
To do this:
(1) Observe the exact label size for the layout you have selected in the Layout.
(2) Open the properties for your label printer and locate the place where you define "stock' or "paper
sizes".
(3) Add a new stock size. Give it a name and set the dimensions to the size of the layout you have
selected.
(4) Set the unprintable area as small as possible.
(5) Save the stock size. There is no need to set it as the default paper size - it simply must exist so
the printer knows about the size you are printing.
Options
Option Description
Layout Choose the label size you are using. Standard sizes are listed first
followed by any custom labels you have created.
Quantity The quantity of each label, with the qualifiers
For each line item (ignore quantity): Ignores the quantity of each
door ordered and produces just the selected quantity of labels for each
line item on the order. This is useful where the line item represents items
with a quantity greater than 1, such as padlocks, and you do not require
individual labels.
Option Description
Show lock finish Turn on to include the lock finish in the door information area.
Show lock part item number Turn on to include the lock "item number" in the door information area.
Show a line between information Turn on to show a line between each information item. This make
items improve readability.
Pinning font size Allows you to decide the font size used for the pinning information part of
the on-screen pinning. A larger size may be preferable for readability.
Sort order Choose how the doors will be sorted. Generally you should pick the same
sort order when producing labels.
Option Description
Show received signing area Shows an area on the report for the recipient to sign for the goods.
Show signatories Turn on to list the signatories who are on the job.
Show job notes Turn on to include the job notes in the report
Show key notes Turn on to show any notes entered in the job for each key.
Option Description
Show received signing area Shows an area on the report for the recipient to sign for the goods.
Show signatories Turn on to list the signatories who are on the job.
Show job notes Turn on to include the job notes in the report
Show door notes Turn on to show any notes entered in the job for each door.
Show lock finish Turn on to include the lock finish.
· To print the report individually, click on the preview button adjacent to the option.
For labels to print correctly on almost all label printers, the label size requested by ProMaster Master
Keying must be defined in the printer preferences.
To do this:
(1) Observe the exact label size for the layout you have selected in the Layout.
(2) Open the properties for your label printer and locate the place where you define "stock" or "paper
sizes".
(3) Add a new stock size. Give it a name and set the dimensions to the size of the layout you have
selected.
(4) Set the unprintable area as small as possible.
(5) Save the stock size. There is no need to set it as the default paper size - it simply must exist so
the printer knows about the size you are printing.
Options
Option Description
Layout Choose the label size you are using. Standard sizes are listed first
followed by any custom labels you have created.
311
Design labels Click this to design labels. See Custom reports
Delivery address The address to print on the label. This is pre-populated from the job
delivery address.
Delivery address quantity The quantity of delivery labels that you want.
Key delivery address The address to print on the label for keys if there is a separate delivery
address. This is pre-populated from the job key delivery address.
Key delivery address quantity The quantity of key delivery labels that you want.
Return address The information to print on a "sender" label.
One return address label is printed for each delivery and key delivery label
printed.
Print return address labels Turn on to print the return address label.
The font size on the label is scaled to accommodate the details on the label size chosen.
Producing the report
149
See Printer options for printer specific choices.
Output options
Option Description
Print The report is printed to the printer you have selected.
310
Preview The report is previewed on your screen. See Previewing reports for
more information.
· To perform this task individually, click on the Send button adjacent to the option.
· Manufacturing behaviour varies depending on the machine. Some machines sent all the data in a single
operation. Some machines take many keys in a single operation but allow you to choose a batch size. Some
machines handle a single key only and you are prompted to send the next key when ready.
Options
Option Description
Which keys do you want to All keys (ordered and test): All ordered keys and all test keys are sent
manufacture to the machine.
All ordered keys: All ordered keys are sent to the machine.
All test keys: All test keys are sent to the machine.
Selected entry only: You select from the adjacent list the item you
want for the key section and ordered/test.
Manufacturing order Manufacture keys in order by key section, then as sorted: This
option ensures that key sections are not intermingled.
Manufacture keys in the order that the keys are sorted: The
system key order is respected, even if that means mixing key sections.
When manufacturing ordered This option controls how test keys are manufactured in relation to ordered
and test keys keys
Mix according to key section and sort order: Ordered keys and test
keys are manufactured according to the order they are sorted in the
system. This is usually not a good choice as it mixes the keys you are
delivering to the customer with test keys.
Test keys before ordered keys: Test keys are produced first,
respecting the manufacturing order, then ordered keys.
Test keys after ordered keys: Ordered keys are produced first,
respecting the manufacturing order, then test keys.
Change start point When "Selected entry only" is chosen, This button can be used to view the
items for manufacturing and select the start point. This is useful for
resuming an interrupted job.
Keys per batch On machines where multiple keys may be sent in a single operation, this
controls how many keys are sent in each batch. If there are multiple
batches required, you are prompted to send the next batch.
Machine settings and information Machine specific information or options are shown.
Option Description
Use configured models for each This option uses your pre-configured choices to request the marking
key section model for each key marked according to the key section. Click Configure
models to make the association between the Silca Marker 2000 models
and your key sections.
· To perform this task individually, click on the Send button adjacent to the option.
· Manufacturing behaviour varies depending on the machine. Some machines sent all the data in a single
operation. Some machines take many keys in a single operation but allow you to choose a batch size. Some
machines handle a single key only and you are prompted to send the next key when ready.
Options
Option Description
Which keys do you want to All keys (ordered and test): All ordered keys and all test keys are sent
manufacture to the machine.
All ordered keys: All ordered keys are sent to the machine.
All test keys: All test keys are sent to the machine.
Selected entry only: You select from the adjacent list the item you
want for the key section and ordered/test.
Manufacturing order Manufacture keys in order by key section, then as sorted: This
option ensures that key sections are not intermingled.
Manufacture keys in the order that the keys are sorted: The
system key order is respected, even if that means mixing key sections.
When manufacturing ordered This option controls how test keys are manufactured in relation to ordered
and test keys keys
Mix according to key section and sort order: Ordered keys and test
keys are manufactured according to the order they are sorted in the
system. This is usually not a good choice as it mixes the keys you are
delivering to the customer with test keys.
Test keys before ordered keys: Test keys are produced first,
respecting the manufacturing order, then ordered keys.
Test keys after ordered keys: Ordered keys are produced first,
respecting the manufacturing order, then test keys.
Change start point When "Selected entry only" is chosen, This button can be used to view the
items for manufacturing and select the start point. This is useful for
resuming an interrupted job.
Keys per batch On machines where multiple keys may be sent in a single operation, this
controls how many keys are sent in each batch. If there are multiple
batches required, you are prompted to send the next batch.
Machine settings and information Machine specific information or options are shown.
Option Description
Use ideal cut (laser cut) rather If the key uses a normal cut, the option to use an ideal cut will be
than normal cut available. Keys should be cut to manufacturer specification, so turn this
on only with a good reason.
Adjustments It should never be necessary to adjust cuts if your machine is calibrated
correctly and product is manufactured correctly.
On rare occasions, you may wish to adjust the cuts. Any changes you set
are remembered on a card-by-card basis.
For Best A2/A4 (Cards 752/754) Available on Interchangeable core module. When selected then tip stop 4
use tip stop 4 instead of tip stop will be used.
3
Option Description
Use ideal cut (laser cut) rather If the key uses a normal cut, the option to use an ideal cut will be
than normal cut available. Keys should be cut to manufacturer specification, so turn this
on only with a good reason.
Adjustments It should never be necessary to adjust cuts if your machine is calibrated
correctly and product is manufactured correctly.
On rare occasions, you may wish to adjust the cuts. Any changes you set
are remembered on a card-by-card basis.
For Best A2/A4 (Cards 752/754) Available on Interchangeable core module. When selected then tip stop 4
use tip stop 4 instead of tip stop will be used.
3
Option Description
Use ideal cut (laser cut) rather If the key uses a normal cut, the option to use an ideal cut will be
than normal cut available. Keys should be cut to manufacturer specification, so turn this
on only with a good reason.
Adjustments It should never be necessary to adjust cuts if your machine is calibrated
correctly and product is manufactured correctly.
On rare occasions, you may wish to adjust the cuts. Any changes you set
are remembered on a card-by-card basis.
Option Description
Use ideal cut (laser cut) rather If the key uses a normal cut, the option to use an ideal cut will be
than normal cut available. Keys should be cut to manufacturer specification, so turn this
on only with a good reason.
Option Description
Data for "T02" token Determines the contents of the marking token T02 in the data sent to the
machine.
Option Description
Adjustments It should never be necessary to adjust cuts if your machine is calibrated
correctly and product is manufactured correctly.
On rare occasions, you may wish to adjust the cuts.
Option Description
Use Dromo If the Dromo is detected on your Dezmo, the option to request the Dromo
is available.
Option Description
Add trailing '0' cuts on 7 disc and Turn on to pad the code length to 10 characters (the leading tip '0' is
9 disc systems removed first)
Option Description
Reset CodeMax At times, CodeMax machines can be temperamental. If communication
with the machines fails, you may try sending a reset to the machine to
sort it out.
Option Description
Use ideal cut (laser cut) rather If the key uses a normal cut, the option to use an ideal cut will be
than normal cut available. Keys should be cut to manufacturer specification, so turn this
on only with a good reason.
· To perform this task individually, click on the Save button adjacent to the option.
Options
Option Description
Folder Choose the folder where you want the XML files created.
File name format Choose how the file will be named.
Export without prompting for When this option is on, and only if all settings are valid, the XML output
"Manufacture all selected" will be written without prompting when you click "Manufacture all
selected". This is useful for eliminating additional user choices during
manufacturing.
Spawn the following program If you want a program to be launched after the XML file is created, choose
that program by clicking the Select button. When the program is
launched, the full name of the XML file is passed as the first parameter to
the program.
By default, the output is written if version 8 format. Version 7 format can be enabled by turning on the
option Application parameter 49 "Use legacy format for "XML export" manufacturing output". Version
7 format does not support new features, and will not be enhanced in the future. Use version 7 format
only for compatibility with existing applications. Use version 8 for all new integration development.
To enable XML exports you must turn on the the Application parameter 49 "Allow "XML export" as a
manufacturing output"
205
The export is accessed from the Job manufacturing window.
Getting started
· Turn on the option Save cutting data to XML file under Key manufacturing.
· To perform this task individually, click on the Save button adjacent to the option.
Options
Option Description
Folder Choose the folder where you want the XML files created.
File name format Choose how the file will be named.
Export without prompting for When this option is on, and only if all settings are valid, the XML output
"Manufacture all selected" will be written without prompting when you click "Manufacture all
selected". This is useful for eliminating additional user choices during
manufacturing.
Spawn the following program If you want a program to be launched after the XML file is created, choose
that program by clicking the Select button. When the program is
launched, the full name of the XML file is passed as the first parameter to
the program.
By default, the output is written if version 8 format. Version 7 format can be enabled by turning on the
option Application parameter 49 "Use legacy format for "XML export" manufacturing output". Version
7 format does not support new features, and will not be enhanced in the future. Use version 7 format
only for compatibility with existing applications. Use version 8 for all new integration development.
· To perform this task individually, click on the Send button adjacent to the option.
· Manufacturing behaviour varies depending on the machine. Some machines sent all the data in a single
operation. Some machines take many keys in a single operation but allow you to choose a batch size. Some
machines handle a single key only and you are prompted to send the next key when ready.
Options
Option Description
Which doors do you want to All doors: All doors are sent to the machine.
manufacture
Selected entry only: You select from the adjacent list the item you
want for the part code.
Manufacturing order Manufacture doors in order by part code, key-way, then as
sorted: This option ensures that part codes are not intermingled.
Manufacture doors in the order that the doors are sorted: The
system door order is respected, even if that means mixing part codes.
Change start point When "Selected entry only" is chosen, This button can be used to view the
items for manufacturing and select the start point. This is useful for
resuming an interrupted job.
Doors per batch On machines where multiple doors may be sent in a single operation, this
controls how many doors are sent in each batch. If there are multiple
batches required, you are prompted to send the next batch.
Machine settings and information Machine specific information or options are shown.
Option Description
Separate files for each part code This option produces multiple files so part codes are not mixed in a single
or cylinder style file. The options is available for the first two options for manufacturing
order (I.e. where the doors are sorted by part code and possible cylinder
style)
Output only door stamping Normally the output has:
System Stamping,Door Stamping,Issue Number,Door Number
Turn this option on to output only the Door Stamping.
Option Description
Separate files for each part code This option produces multiple files so part codes are not mixed in a single
or cylinder style file. The options is available for the first two options for manufacturing
order (I.e. where the doors are sorted by part code and possible cylinder
style)
Option Description
Marking model Choose the model you want to use from the list. All doors sent to the
machine will use this marking model.
· To perform this task individually, click on the Send button adjacent to the option.
· This machine manufactures keys and door parts, so the options available will vary depending on whether
the job has keys or doors or both.
Options
Option Description
Send keys to the machine Turn on to send keys as part of the data transfer to the machine.
Which keys do you want to All keys (ordered and test): All ordered keys and all test keys are sent
manufacture to the machine.
All ordered keys: All ordered keys are sent to the machine.
All test keys: All test keys are sent to the machine.
Selected entry only: You select from the adjacent list the item you
want for the key section and ordered/test.
When manufacturing ordered This option controls how test keys are manufactured in relation to ordered
and test keys keys
Mix according to key section and sort order: Ordered keys and test
keys are manufactured according to the order they are sorted in the
system. This is usually not a good choice as it mixes the keys you are
delivering to the customer with test keys.
Test keys before ordered keys: Test keys are produced first,
respecting the manufacturing order, then ordered keys.
Test keys after ordered keys: Ordered keys are produced first,
respecting the manufacturing order, then test keys.
Send doors to the machine Turn on to send doors as part of the data transfer to the machine.
Which doors do you want to All doors: All doors are sent to the machine.
manufacture
Selected entry only: You select from the adjacent list the item you
want for the part code.
Change key start point When "Selected entry only" is chosen, This button can be used to view the
keys for manufacturing and select the start point. This is useful for
resuming an interrupted job.
Change door start point When "Selected entry only" is chosen, This button can be used to view the
doors for manufacturing and select the start point. This is useful for
· To perform this task individually, click on the View button adjacent to the option.
· Manufacturing behaviour varies depending on the machine. Some machines sent all the data in a single
operation. Some machines take many keys in a single operation but allow you to choose a batch size. Some
machines handle a single key only and you are prompted to send the next key when ready.
Options
Check the option then click on the settings link. After you change the output settings, your changes are
shown on the Job manufacture window and are remembered.
Option Description
Show lock finish Turn on to include the lock finish in the door information area.
Show lock part item number Turn on to include the lock "item number" in the door information area.
Show a line between information Turn on to show a line between each information item. This make
items improve readability.
Pinning font size Allows you to decide the font size used for the pinning information part of
the display. A larger size may be preferable for readability.
Sort order Choose how the doors will be sorted. Generally you should pick the same
sort order when producing labels.
Control Description
Prior Navigates back 1 door, to the prior door. The door number and quantity
of the prior door is shown on the button.
Next Navigates forward 1 door, to the next door. The door number and
quantity of the next door is shown on the button.
Seq, Go to Doors are allocated a sequence, according to the position in the job
according to the sort order selected. To go to a door in the job, enter
the sequence number and click Go to. This is useful if you know a door
you need to return to for checking.
Door, Go to To go to a door in the job where you know the door number, enter the
door number and click Go to. This is useful if you know a door you need
Labels
The Print label button prints a label (or labels) for the current door.
The options are the same that are used for labels from the Manufacture Job window. See Settings: Print
209
door labels . The label settiongs may be accessed by right clicking the Print label button;
· To perform this task individually, click on the Save button adjacent to the option.
Options
Option Description
Folder Choose the folder where you want the XML files created.
File name format Choose how the file will be named.
Export without prompting for When this option is on, and only if all settings are valid, the XML output
"Manufacture all selected" will be written without prompting when you click "Manufacture all
selected". This is useful for eliminating additional user choices during
manufacturing.
Spawn the following program If you want a program to be launched after the XML file is created, choose
that program by clicking the Select button. When the program is
launched, the full name of the XML file is passed as the first parameter to
the program.
By default, the output is written if version 8 format. Version 7 format can be enabled by turning on the
option Application parameter 49 "Use legacy format for "XML export" manufacturing output". Version
7 format does not support new features, and will not be enhanced in the future. Use version 7 format
only for compatibility with existing applications. Use version 8 for all new integration development.
To enable XML exports you must turn on the the Application parameter 49 "Allow "XML export" as a
manufacturing output"
205
The export is accessed from the Job manufacturing window.
Getting started
· Turn on the option Save assembly data to XML file under Door manufacturing.
· To perform this task individually, click on the Save button adjacent to the option.
Options
Option Description
Folder Choose the folder where you want the XML files created.
File name format Choose how the file will be named.
Export without prompting for When this option is on, and only if all settings are valid, the XML output
"Manufacture all selected" will be written without prompting when you click "Manufacture all
selected". This is useful for eliminating additional user choices during
manufacturing.
Spawn the following program If you want a program to be launched after the XML file is created, choose
that program by clicking the Select button. When the program is
launched, the full name of the XML file is passed as the first parameter to
the program.
By default, the output is written if version 8 format. Version 7 format can be enabled by turning on the
option Application parameter 49 "Use legacy format for "XML export" manufacturing output". Version
7 format does not support new features, and will not be enhanced in the future. Use version 7 format
only for compatibility with existing applications. Use version 8 for all new integration development.
· To perform this task individually, click on the Save button adjacent to the option.
Options
Option Description
Folder Choose the folder where you want the XML files created.
File name format Choose how the file will be named.
Export without prompting for When this option is on, and only if all settings are valid, the XML output
"Manufacture all selected" will be written without prompting when you click "Manufacture all
selected". This is useful for eliminating additional user choices during
manufacturing.
Spawn the following program If you want a program to be launched after the XML file is created, choose
that program by clicking the Select button. When the program is
launched, the full name of the XML file is passed as the first parameter to
the program.
By default, the output is written if version 8 format. Version 7 format can be enabled by turning on the
option Application parameter 49 "Use legacy format for "XML export" manufacturing output". Version
7 format does not support new features, and will not be enhanced in the future. Use version 7 format
only for compatibility with existing applications. Use version 8 for all new integration development.
· Choose how long the job is allow to be available on the publishing server.
Other functionality
Click Device queue and job history to see jobs from this system that have been sent to the device.
If you are using publishing to re-key cylinders on site then you should consider:
(a) Make a separate job for only the re-keying and put it on a factory that is specific to the destination
device
(b) Configure publishing and devices to restrict the device to that factory
This makes it difficult to send the job to the wrong device and avoids sending key information if it was
not intended for the device.
· From the main window, select the Setup and Admin menu, then select Machines
· When manufacturing keys or doors, click the Machine setup button below the machine selection.
Making a change
· Use the Add, Remove and Edit buttons to set up your factories.
· When you add a machine, the first selection required is the machine type.
Machine serial number: It is important that this matches the machine. If it is wrong then the machine will
not communicate. Ensure the machine is turned on and click Read from machine to retrieve the serial
number from your machine.
Marker 2000 folder: Choose the folder where the Marker 2000 software and marking models are stored.
Often this is C:\Marcator
Read machine version: After completing the com port and serial number, this button will read the machine
version information and report it. This useful for getting the version information, but also verifying the
communication is functioning.
Marking tokens
Keys
The marking tokens are send with the following information.
Token Description
0 Key number, or Key stamping if different stamping is defined.
1 A description of the key and issue number
2 Blank
3 Key section
4 Issue number (if used by the system)
5 System number, or System stamping if different stamping is defined.
Doors
The marking tokens are send with the following information.
Token Description
0 Door stamping
1 Door number
2 Blank
3 Part code
4 Issue number (if used by the system)
5 System number, or System stamping if different stamping is defined.
TCP/IP address: Enter the TCP/IP address used on the machine. You may need to seek assistance from
your network administrator.
Test: After entering the TCP/IP address, this button will communicate with the machine and report the
version number and other information. This useful for getting the version information, but also verifying the
communication is functioning.
Com port: Select the communication port to which the machine is connected.
Speed: Ensure that the speed matches the settings on your CodeMax machine.
Model: If you have the auto-angler machine, change this setting accordingly. This changes the data sent to
the machine to make the head rotate for Medeco keys.
Settings
Folder: Choose the folder where you want the machine files created.
only the user defined values, but the others will be overwritten if the machine fails to keep up with the data
transfer).
Wait for the machine to notify that reset is complete: Normally this should be on, but we have seen
some ITL machines that don't respond correctly. If you turn this option off, a small delay is used in to allow
them reset to complete instead of waiting for the machine notification.
Machine does not respond correctly: Normally this should be off, but we have seen some ITL machines
that do not acknowledge the data sent to the machine. If you turn this option off, the data transfer assumes
that the data was received.
Folder: Choose the folder where you want the machine files created.
Settings
Com port: Select the communication port to which the machine is connected.
Speed: Ensure that the speed matches the settings on your ECM 200 machine.
Timing: This controls how fast data is sent to the machine. The default of 5 is fine for most ECM 200
machines, but some need this to be slowed down.
File format: Choose if you want the file written as ASCII (Non-ASCII characters, if any will be omitted), UTF-
8 (supports all characters and writes the UTF-8 preamble to the file).
Quantity and issues: There are 3 fields available in the Key Items, Quantity, Issue Number and Starting
Issue Number.
File Start
Add the items you want to the list.
This is written once at the start of the file.
File Items
Add the items you want to the list.
At least 1 item must be chosen.
This is written for each key or each key issue depending on the value selected for "Quantity and issues".
The CutData and CutData reversed values are available only on Inline and Interchangeable Core design
modules and it is not recommended that you mark this on the key.
File End
Add the items you want to the list.
File format: Choose if you want the file written as ASCII (Non-ASCII characters, if any will be omitted), UTF-
8 (supports all characters and writes the UTF-8 preamble to the file).
Quantity and issues: There are 3 fields available in the Door Items, Quantity, Issue Number and Starting
Issue Number.
File Start
Add the items you want to the list.
This is written once at the start of the file.
File Items
Add the items you want to the list.
At least 1 item must be chosen.
This is written for each key or each key issue depending on the value selected for "Quantity and issues".
File End
Add the items you want to the list.
This is written once at the end of the file.
Folder: Choose the folder where you want the machine files created.
A simple wizard steps you through the process of choosing where the data will be written, choosing which
data to export and choosing export options.
Multiple types of data may be exported at the same time. Each type of data is written to a separate file,
named according to the type of data.
When choosing the range of data to export, you may right click on the list for selection options. The types of
data are defined in logical groups allowing you to select or deselect the whole group in a single operation.
Notes
The fields exported depend on a variety of parameters. e.g. Key stamping will be exported only if it is enabled
in your application parameters. Signatory quantity required will be exported only if the system uses per-key or
per-door signatory restrictions.
Exporting data
Choose if you want data about systems, signatories or jobs.
Continue through the following steps, making selections to refine the data that will be exported.
For example, you may be interested in only some system yypes, a particular date range for jobs or only some
lock products.
Choose a file name for the CSV file that will be produced.
Finally, click Finish to perform the export.
Because of the wide range of choices available for this export, you may need to try a variety of options
to get just the data that you want.
Example
If you progress 2 positions through 9 available positions (referred to as 2 in 9), this will produce 36 codes.
Note however, unless there are any other factors involved then 2 in 9 is not an ideal choice, because:
(a) if you are progressing through 9 positions then you should progress 4 positions to yield 126 codes
(b) if you required only 36 codes then you should select fewer positions to progress through (perhaps 4 in 8 to
produce 70 codes, or 3 in 7 if 35 codes is enough for your purpose)
Dealer cuts
For Disklock Pro only, Novel uses lists to control the dealer cuts.
You may select a key section and the 2 dealer cut values and click Add to add the combination to the list.
You may make dealer cut values for each key section.
The dealer cut values are used when generating a TMK value for a new system.
If you have defined your dealer cuts (See System type setup 235
) then these will be used when creating the
TMK.
Choose an appropriate size list. If there is not an appropriate size list, split a larger one. Contact the
lock manufacturer for assistance.
Restrictions
Promote key section is not available for this design module.
Depth steps are not applicable to this design module, but do understand Group 2 codes and custom
progressions for limiting the codes produced.
9.16.2.4 Coding
Enter code - Abloy Novel
If you manually enter a code for a key, it must comply with the list selected for the system design.
Special pinning - Abloy Novel
Positions allowed in special pinning are limited to those that may be progressed in the list selected for the
system design.
This design module implements the Abloy Protec 1 and Abloy Protec 2 lock systems.
TMK values are controlled by lists proved to you by the lock manufacturer and you choose an appropriate list
for your system size.
Key head colours are supported.
Key section families with multiple key sections are possible, but it is extremely unlikely to affect anyone
outside of Abloy factories and you should consider key section families to have a single key section and a
single keyway (in this case the keyway is the profile disc)
Key codes and cylinder pinning are presented tip to head in keeping with Abloy convention.
Lists are labelled B, A, 0, 1... according to the number of positions that may be progressed. A "B" list is a
single code. An "A" list has one position that may be progressed (Denoted by "X"). A "o" list has two
positions that may be progressed. Etc, all the way up to a "7" list that has nine positions that can be
progressed.
Depth steps are not applicable to this design module, but do understand Group 2 codes and custom
progressions for limiting the codes produced.
9.16.3.4 Coding
Enter code
If you manually enter a code for a key, it must comply with the list selected for the system design.
Special pinning
Positions allowed in special pinning are limited to those that may be progressed in the list selected for the
system design.
Use group 2 codes Default value applied when creating new system designs.
Group 2 codes, when used with a standard progression, produce more
codes but require a fill disc kit. Without group 2 codes the systems you
produce will be much smaller but the parts requirement to keep stock of is
somewhat smaller.
Suppress profile cuts on printout Removes the profile cuts from each end of the key code on printouts.
Makes it easier to read when cutting keys on a manual machine.
9.16.4.4 Coding
There are no special considerations.
233
system type parameters
Minimum total variation Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
233
system type parameters
Disallow ramp up Default value applied when creating new system designs. See Common
system type parameters 233
Disallow ramp down Default value applied when creating new system designs. See Common
233
system type parameters
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Allow X cut progression XY14 only.
Prohibits the progression of the X axis value when. See also the next item
about Default X axis cuts.
Depth steps for Axis 2 (The dimple cuts) is always represented by the character "1" when the axis 2 pins are
to be progressed. The manner in which the axis 2 pins are progressed is determined by then number of "A"
pins and also the designation of that position (hierarchy is progressed differently to selective).
The depths on the last position of Axis 1 are controlled by the geometry of the lock so some cut values are
unavailable.
9.16.5.4 Coding
There are no special considerations.
Key section families with multiple key sections and multiple keyways are allowed.
Key codes and cylinder pinning are presented head to tip.
Too many times we have seen systems where the control key is designated as a master key and is
assigned as the key above the TMK. This is wrong, so don't listen to anyone saying this. The control
key should be designated as a change key for QCC and as a control key for CQCC, and should have the
TMK as its key above (unless the system is more complex, having multiple branches with multiple
control keys)
Bilock CQCC
For QCC (the previous generation of Bilock) there was no need to distinguish between the control key and the
operating keys from a coding point of view.
With CQCC it is necessary to identify control keys because they affect the cylinder coding in a different way to
operating keys. For this reason, the key designation Control key must be used for the CQCC core removal
key. Do not use the Control key designation for control keys for QCC.
While you could mark the control key for QCC systems as designation Control key in QCC only systems with
no adverse effect, it is important it understand that in mixed QCC/CQCC systems the QCC keys must not have
the designation Control key.
It is necessary to distinguish between CQCC cylinders and QCC cylinders so that coding may be calculated
accordingly. When setting up cylinders for CQCC, select the value Bilock CQCC for the field Core type.
Failure to configure CQCC cylinders correctly will result in incorrect pinning being calculated.
For CQCC you may want to have multiple control keys on larger systems. Generally each cylinder would have
only one control key operating it, but it is possible to have multiple control keys operating a single CQCC
cylinder. If you do this then you must be aware of the effect it has on coding. For example, in one position the
operating cut may be "1" and the first control key cut "3", which results in a B3 pin being used. If you now
assign a second control key that has a cut "4" in that position (now making the coding requirement 1 shallow,
3 deep, 4 deep) the pin that is selected is "I" because of the 2 deep cuts and that there are no pins with
shallow cuts and more than one deep cut.
When coding CQCC, it is important to assign the control key first. If you don't then the operating keys
will show up as phantoms for the cylinder removal because the resultant coding will use pins with only
deep holes.
Bilock CQCC - 12 pin
In selecting your control key:
It must differ from any other operating key in one position, provided that position is in 3, 4, 5, 9, 10, 11
If that condition is not met then it must differ from any other operating key in two positions, provided those
positions are in 2, 3, 4, 5, 8, 9, 10, 11
If that condition is not met then it must differ from any other operating key in three positions, provided those
positions are in 2, 3, 4, 5, 6, 8, 9, 10, 11, 12
If that condition is not met then it must differ from any other operating key in four positions.
CQCC 12 Pin: recommendation: For anything except huge systems, make it differ from the main
permutation in any 2 of the positions 3, 4, 5, 9, 10, 11. On huge systems, reduce that to 1.
Bilock CQCC - 8 pin
For a code to not remove the core in error, it must differ from the control code by at least one of the following
combinations of positions:
Left 2 + Right 2
Left 3 + Right 3
Left 2 + Right 3
Left 3 + Right 2
Left 1 + Right 3
Left 3 + Right 1
Left 3 + Right 4
Left 4 + Right 3.
CQCC 8 Piin: There must be a blocking position on each side of the key and any combinations other
than those shown to not provide a positive block against core removal.
Dealer cuts
You may select a key section and the dealer cut values and click Add to add the combination to the list.
You may make dealer cut values for each key section.
The dealer cut values are used when generating a TMK value for a new system.
For traditional Bilock, your dealer cut will consist of 2 values and the remainder are left as "x".
For Bilock CQCC this may be used also, by specifying dealer cut(s) where you want fixed values that will not
240
be coded that you may keep for the QCC key. See Product description for information about CQCC
positions.
9.16.6.4 Coding
CQCC Control key
When coding CQCC, it is important to assign the control key first. If you don't then the operating keys will
show up as phantoms for the cylinder removal because the resultant coding will use pins with only deep
holes.
240
Read the CQCC information here: Product description
9.16.7.4 Coding
Enter code
If you manually enter a code for a key, is uses the handing of the current code progression.
Control key
The control key code is assigned by selecting the control key and clicking Enter code. The code offered will
be the control code value specified in the system design, and you must choose the key section.
Assign the control key before other keys.
The key used depths 1 to 9, and B,C,D,E,F,G,H,J. The letter cuts correspond to depths 2 through 9 (there is
no letter cut the depth of a "1" cut). Letter cuts are wider and slot cut inside the flat of the cut, and use a
special pin "DuraPIN".
Each position in a code progression specifies if the TMK letter cut is to be used (and not progressed) of if a
number cut is to be used.
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
233
system type parameters
Disallow ramp down Default value applied when creating new system designs. See Common
233
system type parameters
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Has coloured key heads Default value applied when creating new system designs. See Common
system type parameters 233
Use anti-bump pins Default value applied when creating new system designs. See Common
233
system type parameters
Anti-bump pin type Controls the gerneration of anti-bump pins.
Options are "Old" with "G" top pin and "New" with "M" and "N" bottom
pins.
233
Depth step for design assistant See Common system type parameters
· In any position where the TMK is progressed, Letter cuts must contain the value N.
· In any position where the TMK is a letter, and it is not progressed, then normally the corresponding position
in Letter cuts will be L, however you may make it N so that the corresponding number cut is used in the
code progression.
Use anti-bump pins
When turned on, checking will take place during the system design to ensure that the use of anti-bump pins
may be possible.
Anti-bump will then be used in any cylinder where the use is possible and will always be placed as far back in
the cylinder as possible.
9.16.8.4 Coding
There are no special considerations.
The key used depths 1 to 7 on the first axis and 0/1 depths on the 2 profile pin axes.
There are particular values permitted for the profile pins and when used will be allocated to you by the lock
manufacturer. Your profile pins will match the pre-cut on the key blanks.
The minimum master pin available is "2", and "3" is the minimum wafer size allowed in position 6.
9.16.9.4 Coding
There are no special considerations.
The key used depths 1 to 6, and A to F. Letter cuts are wider and dimple cut inside the flat of the cut, and
use a special pin.
Each position in a code progression specifies if the TMK letter cut is to be used (and not progressed) of if a
number cut is to be used.
Each code progression defines, in addition to the standard rules, a letter progression rule.
· In any position where the TMK is numeric, Letter cuts must contain the value N.
· In any position where the TMK is progressed, Letter cuts must contain the value N.
· In any position where the TMK is a letter, and it is not progressed, then normally the corresponding position
in Letter cuts will be L, however you may make it N so that the corresponding number cut is used in the
code progression.
9.16.10.4 Coding
There are no special considerations.
The data is always stored internally as head to tip. If you change the presentation direction in the
system type, it affects everywhere the key code and pinning is displayed. Changing the presentation in
the system type does not alter your data. However you must be certain to observe the presentation
direction and enter/read codes correctly. If you enter data in the reverse order then it is wrong, and
always be wrong. Entering data in the wrong order will result in incorrect calculations for deepest first
cut, ramp up, ramp down and some core removal calculations.
The depth symbols permitted are standard Assa UA depths (9 shallow to 1 deep).
Maximum variation Default value applied when creating new system designs. See Common
system type parameters 233
Minimum different cuts Default value applied when creating new system designs. See Common
233
system type parameters
Minimum total variation Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
system type parameters 233
Disallow ramp up Default value applied when creating new system designs. See Common
233
system type parameters
Disallow ramp down Default value applied when creating new system designs. See Common
233
system type parameters
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Has coloured key heads Default value applied when creating new system designs. See Common
system type parameters 233
Display codes TIP -> HEAD Assa convention is tip to head. For this design module the default setting
is tip to head and it is recommended tat you do not change this.
Internally all codes for this design module are calculated and stored head
to tip. If you want the codes and pinning to display tip to head, turn this
displayed, Etc.
The setting for this option is shown on screen, on printouts Etc, so you
can seeoption on. It does not change any data, only the presentation of
data when printed, the order that the data is being presented.
233
Depth step for design assistant See Common system type parameters
Cylinder types
When you first create a design, ProMaster Master Keying calculates the cylinder types used in the system and
sets the Cylinder types flags accordingly.
These flags are used to calculate the TMK and also for code progressions. If you want to ensure a system
design that allows for other cylinder types to be added you can change these flags before creating your TMK
and code progression.
9.16.11.4 Coding
Consideration must be given to the cylider types operated by each key and the rules of each cylinder type.
9.16.12.4 Coding
There are no special considerations.
Sliders
Type 1 sliders
Usage: 3KS single track positions 1..6, 3KS plus single track positions 1..6, 4KS single track positions 1..5
76 2468
90 13579
Type 2 sliders
Usage: 3KS double track positions 1..6, 3KS plus double track positions 1..5, 4KS double track positions 1..5
Type 3 sliders
Usage: 3KS plus double track position 6
Note: These are sometimes referred to C and D orientation
Type 4 sliders
Usage: 4KS single track position 6
56 246 468
57 248 268
76 2468
Axis 2 cuts
Allows you to define values that will always be used for axis 2 when generating a TMK.
This is useful if you cut only axis 1 and your keys are pre-cut on axis 2.
You may select a key section and the cut values and click Add to add the combination to the list.
You may make axis 2 cut values for each key section.
The axis 2 cut values are used when generating a TMK value for a new system.
The default value for Axis 2 cuts may be defined for each key section in the system type setup (See System
type setup 253 ). You may use any value for Axis 2, however as only Axis 1 is cut on your key cutting machine,
any Axis 2 value that differs from the keys you stock will require ordering additional stock.
If you order key blanks without axis 2 precut, then treate axis 2 like axis1 and code as you please.
9.16.13.4 Coding
There are no special considerations.
Disallow ramp up Default value applied when creating new system designs. See Common
system type parameters 233
Disallow ramp down Default value applied when creating new system designs. See Common
233
system type parameters
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Has coloured key heads Default value applied when creating new system designs. See Common
233
system type parameters
233
Depth step for design assistant - See Common system type parameters
hierarchy keys
233
Depth step for design assistant - See Common system type parameters
selective keys
9.16.14.4 Coding
There are no special considerations.
9.16.15 Inline
9.16.15.1 Product description
This design module is called Inline.
This design module implements the a wide variety of flat key products, and a few special lock systems.
TMK values are user entered/generated.
Key head colours are supported.
Key section families with multiple key sections and multiple keyways are allowed.
233
system type parameters
Deepest last cut Default value applied when creating new system designs. See Common
233
system type parameters
Maximum variation Default value applied when creating new system designs. See Common
233
system type parameters
Minimum different cuts Default value applied when creating new system designs. See Common
233
system type parameters
Minimum total variation Default value applied when creating new system designs. See Common
system type parameters 233
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
233
system type parameters
Disallow ramp up Default value applied when creating new system designs. See Common
233
system type parameters
Disallow ramp down Default value applied when creating new system designs. See Common
system type parameters 233
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Has coloured key heads Default value applied when creating new system designs. See Common
233
system type parameters
Minimum wafer size The depth step of the smallest master pin.
Differ from TMK less < minimum If this option is on, and a code differs from the TMK by less than the
is bad code Minimum wafer size then is is marks as a bad code. If this option is off
then Minimum wafer size is not considered when calculating the bad
code reason for a key.
233
Depth step for design assistant See Common system type parameters
9.16.15.4 Coding
There are no special considerations.
This design module implements a wide variety of flat key products with SFIC and LFIC cylinders.
TMK values are user entered/generated.
Key head colours are supported.
Key section families with multiple key sections and multiple keyways are allowed.
Key codes and cylinder pinning are presented head to tip or tip to head depending on the choice you make in
the system type setup.
The data is always stored internally as head to tip. If you change the presentation direction in the
system type, it affects everywhere the key code and pinning is displayed. Changing the presentation in
the system type does not alter your data. However you must be certain to observe the presentation
direction and enter/read codes correctly. If you enter data in the reverse order then it is wrong, and
always will be wrong. Entering data in the wrong order will result in incorrect calculations for deepest
first cut, ramp up, ramp down and some core removal calculations.
The depth symbols permitted are determined by the depth/space card chosen when creating the system type.
Has coloured key heads Default value applied when creating new system designs. See Common
system type parameters 233
Display codes TIP -> HEAD Internally all codes for this design module are calculated and stored head
to tip. If you want the codes and pinning to display tip to head, turn this
option on. It does not change any data, only the presentation of data
when printed, displayed, Etc.
The setting for this option is shown on screen, on printouts Etc, so you
can see the order that the data is being presented.
Note that if you have entered codes in the wrong manner, then
changing this won't actually fix your data, simply reverse its
display.
Conventional cylinder stack This is the stack height used for any keys that are not operated by a
height control key.
Available on some lock systems supported by this design module - others
the value is fixed according to the lock system.
This is not used by the 4 Kaba Peaks locks systems - they use the core
type on the cylinder to determine the stack height.
233
Depth step for design assistant See Common system type parameters
9.16.16.4 Coding
Consideration must be given to the rules of the lock system being used.
Notes for Kaba Peaks
The 4 Kaba Peaks lock systems require that the correct cylinders are used. On cylinders the core type should
be set to the appropriate core type. This controls the core removal ability (SFIC, LFIC) as well as the stack
heights and split driver pins.
Pinning charts are presented in the order required for the rotor-stator loading machine.
Pinning charts show the location for mushroom/hardened pins and Titlis springs. Where blind pins are
required, these are shown by the symbol B. Where blind pins are not required, these are shown as a dash.
Rotor Stator Charts
The Designation can be set for any suitable positions where the mode is "0". With Kaba coding you need to
specify which chambers to use for each designation and also the number of positions to rotate across. E.g. To
progress 3 positions over 7 for change keys, the following designations would be used ccccCCC.
On each key axis (A, B and C) you may progress only the left or the right segment. It is not possible to make a
cylinder that used left and right (or even and odd) in the same axis, so such a code progression would not
make sense.
About KD Systems
KD systems contain multiple keys which are never operating the same door. Or put another way, each door
mush have only one key operating it. The coding of these systems requires you to choose that is a KD
system, then in the coding there is an option that (a) Assignes serial perm codes to the keys and (b) changes
the key number of each key to the Kaba system number associated with that serial perm code.
When you make a Keyed-to-differ system by clicking the KD System button when creating the design then
the behaviour of the coding changes.
· It is not possible to create a code progression.
· Functionality to enter codes manually, remove codes and remove unordered codes are not available.
· There is a new option in each coding screen on the pop-up menu from the list of keys. This option is called
260
Assign serial perm codes and Kaba system number. See Coding for more information.
9.16.17.4 Coding
188
For general information about the coding grid see Coding using the kaba coding grid .
Rotor selection
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
Coding KD systems
259
See Creating and modifying the system design for an overview of hos KD systems are created.
The only functionality available within the coding windows for KD systems is the right-click pop-up menu
option on the list of keys called Assign serial perm codes and Kaba system number.
When you add keys to a KD system, the naming of the keys is not important as the key number is
altered during the coding process to match the Kaba serial number associated with the code that is
assigned to each key,
Do not attempt to assign real Kaba serial numbers to keys when you create them. Thses will not be
used when coding is performed and may result in a naming conflict.
In either coding window, perform the KD system coding by choosing the option described above. This is what
happens:
· For each key that not coded, ProMaster Master Keying gets an unused serial permutation and assigns it to
the key, and changes the key number to the corresponding Kaba serial number.
· The currently selected colour is assigned to keys during coding - ensure you choose the colour you want
prior to choosing to assign serial perm codes.
· The pinning is calculated.
· The serial perm list value that was assigned is marked as used.
If you remove a key that has been coded, or remove the coding for a coded system, the allocated
serial perm codes are not released. See Managing Kaba ACE lists 96 for the procedure to retrieve the
previously-allocated codes and make them available again.
Code progression is not required for using the coding grid, but is for using the coding tree.
The Mode specifies how a position is treated
9.16.18.4 Coding
188
For general information about the coding grid see Coding using the kaba coding grid .
Rotor selection
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
All 16 rotor-stators (P21 to P36) may be used as allowed by the list you select.
The dealer pre-cuts occupy L5S and R6S and those positions are unavailable for coding.
Key codes are shown in the order: L5S, L6S, L5C, L6C, R5S, R6S, R5C, R6C
Each door (rotor stator) has 4 positions, and each must be coded on the keys that operate the door.
Pinning charts are presented in the order required for the rotor-stator loading machine.
Pinning charts show the location for hardened pins. Where blind pins are required, these are shown by the
symbol B. Where blind pins are not required, these are shown as a dash.
Control keys are allowed. Control keys may not be ordered on the same job as other keys. Cutting the
control key is not possible on standard key cutting machines, including the manual machine.
Rotor Stator Charts
TMK
Select a list from the available ones. Consider the capacity of the list to ensure it has sufficient capacity for
now and the future but is not wasteful.
The available rotors are shown.
Calculator
A calculator is provided to assist in determining the outcome for any combination progressed and rotated
positions. The calculator does not change your code progression (when using the coding tree), but can be
used to help you understand the possible outcomes.
Code progression
Code progression is not required for using the coding grid, but is for using the coding tree.
The Mode specifies how a position is treated
0 = No special mode, the position may have a designation
X = The position is to be blank. If a position is blank then the whole segment must be blank. That segment
of the code is not generated in the code progression.
4 = Force the position to be progressed to a 4. This is for advanced coding only.
The Designation can be set for any suitable positions where the mode is "0". With Kaba coding you need to
specify which chambers to use for each designation and also the number of positions to rotate across. E.g. To
progress 3 positions over 7 for change keys, the following designations would be used ccccCCC.
On each key axis (A, B, C and D) you may progress only the left or the right segment. It is not possible to
make a cylinder that used left and right in the same axis, so such a code progression would not make sense.
9.16.19.4 Coding
188
For general information about the coding grid see Coding using the kaba coding grid .
Rotor selection
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
Code progression
Code progression is not required for using the coding grid, but is for using the coding tree.
The Designation can be set for any suitable positions where the mode is "0". With Kaba coding you need to
specify which chambers to use for each designation and also the number of positions to rotate across. E.g. To
progress 3 positions over 7 for change keys, the following designations would be used ccccCCC.
On each key axis (A, B and C) you may progress only the left or the right segment. It is not possible to make a
cylinder that used left and right (or even and odd) in the same axis, so such a code progression would not
make sense.
9.16.20.4 Coding
188
For general information about the coding grid see Coding using the kaba coding grid .
Rotor selection
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
TMK values are user entered and you must select them from the list provided to you as a Kaba Quattro dealer
and make an appropriate selection from that list for the size of your system.
Key codes are shown in the order: L5S, L6S, L5C, L6C, R5S, R6S, R5C, R6C
Each door (rotor stator) has 4 positions, and each must be coded on the keys that operate the door.
Pinning charts are presented in the order required for the rotor-stator loading machine.
Pinning charts show the location for hardened pins. Where blind pins are required, these are shown by the
symbol B. Where blind pins are not required, these are shown as a dash.
Rotor Stator Charts
TMK
Enter a TMK from your Kaba book of permitted TMK values and mark the code as used in your book.
Dealer pins
262
The TMK is checked to verify its compliance with your dealer pins (See System type setup ).
Factory system
If you specify that the system is a factory system, then coding is allowed through the dealer pins. Don't do
this unless it is supplied by a Kaba factory and progresses through the dealer positions.
Calculator
A calculator is provided to assist in determining the outcome for any combination progressed and rotated
positions. The calculator does not change your code progression (when using the coding tree), but can be
used to help you understand the possible outcomes.
Code progression
Code progression is not required for using the coding grid, but is for using the coding tree.
The Mode specifies how a position is treated
0 = No special mode, the position may have a designation
X = The position is to be blank. If a position is blank then the whole segment must be blank. That segment
of the code is not generated in the code progression.
3/4 = Force the position to be progressed to a 3/4. This is for advanced coding only.
The Designation can be set for any suitable positions where the mode is "0". With Kaba coding you need to
specify which chambers to use for each designation and also the number of positions to rotate across. E.g. To
progress 3 positions over 7 for change keys, the following designations would be used ccccCCC.
On each key axis (A, B, C and D) you may progress only the left or the right segment. It is not possible to
make a cylinder that used left and right in the same axis, so such a code progression would not make sense.
9.16.21.4 Coding
188
For general information about the coding grid see Coding using the kaba coding grid .
Rotor selection
Whenever possible, ProMaster Master Keying will determine the correct rotor automatically.
If the coding is wrong, no rotor will be possible.
If the combination of keys produces multiple rotor possibilities, you will be asked to make a rotor selection for
those doors.
Each door is shown, and for each segment the following apply:
Yellow key = the segment is used on all keys and is the same on each.
Purple key = the segment is used on all keys and is not the same on each, because there is variation in the
coding.
To the right is the rotor currently assigned to the door. If a previously assigned rotor is no longer suitable
then it will be removed.
At the top of the screen are a series of buttons, named after the rotors (and they show you which segments
of the code are used). Any rotors that are not suitable for the selected door are disabled. Click on the rotor
that you want for the door.
The bottom of the screen shows the keys that operate the selected door.
After you click OK, the calculation will continue with the rotors that you selected.
9.16.22.4 Coding
Enter code
If you manually enter a code for a key, it must comply with the list selected for the system design.
Special pinning
Positions allowed in special pinning are limited to those that may be progressed in the list selected for the
system design.
Driver pin calculation
The driver pin calculation uses the cylinder "core type" to determine the correct pin to use.
If the core type is neither "Lockwood MT5/MT5+ top pin 22" nor "Lockwood MT5/MT5+ top pin 29" then a
question mark is used inthe counter pin name to indacate that cylinders are not configured correctly.
Pointed drivers S1/S2
Pointed drivers S1 and S2 are used to replace a single 1+ or double 1+ master pins respectively.
Examples for 29 size cylinder:
Dealer cuts
Allows you to define values that will always be used for the side cuts when generating a TMK.
You may select a key section and the cut values and click Add to add the combination to the list.
You may make side cut values for each key section.
The side cut values are used when generating a TMK value for a new system.
9.16.23.4 Coding
There are no special considerations.
Key sections
When configuring key sections, the core removal value for each key section must be set correctly. For
Medeco-style core removal, a standard key section is used, but for Schlage long key or Yale long key the key
sections for these must have their core removal type set (I.e. "Schlage long key" or "Yale long key").
Cylinders
When configuring cylinders that use either the Schlage or Yale method, the core type on the cylinder must
be set accordingly
233
system type parameters
Minimum total variation Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
233
system type parameters
Relax MACS from 4332 to 4442 Determines the permitted maximum adjacent depths which are
determined from the forward or aft orientation of the adjacent cuts.
Use more restrictive factory rules Controls the combinations of double angles and adjacent angles that are
permitted. When turned on, there are fewer combinations that are
allowed. For locksmith generated systems this option would normally be
turned off.
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Code progression
For each code progression, in each position, you choose the angle (assuming the corresponding TMK value
was a double angle otherwise there is only one choice) and also the progression type.
The progression type is either "D" for depth or "A" for angle and depth.
If the angle is a single angle, then the only possible choice for progression type is "D".
If the angle is a double angle, then you may choose "D" or "A".
Here's an example of how the progression is generated.
If TMK = 3KD and progression type "D", then values generated are 1KD, 2KD, 4KD, 5KD, 6KD
If TMK = 3KD and progression type "A", then values generated are 1K, 1D, 2K, 2D, 4K, 4D, 5K, 5D, 6K, 6D
So, in this example, the first progression is good for making masters with double angles, while the second
method produces 10 change keys in a single operation.
Code progression - M4
The sided cuts must be selected for each code progression. Normally this will be the same as the TMK side
cuts.
KD System
If you want to make a keyed-to-differ system where all codes are entered manually, then after you click
Create TMK, click Make KD system.
A pseudo TMK is assigned, and no code progression is possible.
In this type of keyed-to-differ system, each key code must be entered manually and because it is not a
master-key hierarchy, you must ensure that the keying is correct. This is intended for storing codes for
Medeco padlocks etc. without making a separate system for each padlock.
KD System is not available on M4 product.
Restrictions
Depth steps are not applicable to this design module.
9.16.24.4 Coding
Control keys
If a control key is for Medeco style removal, then the key is assigned a normal key section and normal code.
If a control key is for Schlage or Yale long key removable core cylinders then you must choose the appropriate
key section for the key when assigning its code.
233
system type parameters
Minimum different cuts Default value applied when creating new system designs. See Common
233
system type parameters
Minimum total variation Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
system type parameters 233
Use more restrictive factory rules Default value applied when creating new system designs.
Controls the combinations of double angles and adjacent angles that are
permitted. When turned on, there are fewer combinations that are
allowed. For locksmith generated systems this option would normally be
turned off.
Disallow code with all centre cuts Default value applied when creating new system designs.
Determines if codes with all centre cuts are permitted.
Disallow progress to centre cut Default value applied when creating new system designs.
Determines if the TMK cut can be progressed to a centre cut or not.
Disallow bump codes Default value applied when creating new system designs.
Certain codes are known to be used for bumping locks. This option allows
those codes to be excluded.
Disallow stair codes Default value applied when creating new system designs.
Disallows codes that ramp from a deep cut at the key head to a shallow
cut at the key tip.
Disallow progress to defined TMK Default value applied when creating new system designs.
code Disallows generation of codes defined in the "Defined TMK codes"
Safe from re-cutting Default value applied when creating new system designs. See Common
233
system type parameters
Allows you to define codes that are to be prohibited for codes derived from the TMK.
The reason for these codes to be excluded is that they are the best codes for generating large master key
systems and are kept for TMK codes.
If you wish to use this feature, ask the lock manufacturer for appropriate values.
If you want to make a keyed-to-differ system where all codes are entered manually, then after you click
Create TMK, click Make KD system.
9.16.25.4 Coding
Control keys
Select the control key and click Enter code. The code entered is 1 position shorter than the TMK.
Restrictions
Depth steps are not applicable to this design module.
9.16.26.4 Coding
Control keys
If a control key is for Medeco style removal, then the key is assigned a normal key section and normal code.
If a control key is for Schlage or Yale long key removable core cylinders then you must choose the appropriate
key section for the key when assigning its code.
The control key is assigned a code that is 1 cut shorter than the operating codes.
TMK
When creating the system design, you must first select the key section, then click Create TMK to generate
the TMK, or select the values you want on the TMK line of drop-down values. You must choose the depth and
angle for each position.
Code progression
For each code progression, in each position, you choose the angle. It is hard to imagine why this would ever
be different from the corresponding TMK angle.
KD System
If you want to make a keyed-to-differ system where all codes are entered manually, then after you click
Create TMK, click Make KD system.
A pseudo TMK is assigned, and no code progression is possible.
In this type of keyed-to-differ system, each key code must be entered manually and because it is not a
master-key hierarchy, you must ensure that the keying is correct. This is intended for storing codes for
Medeco padlocks etc. without making a separate system for each padlock
Restrictions
Depth steps are not applicable to this design module.
9.16.27.4 Coding
Control keys
Select the control key and click Enter code. The code entered is 1 position shorter than the TMK.
Maximum depth Default value applied when creating new system designs. See Common
system type parameters 233
Deepest first cut Default value applied when creating new system designs. See Common
233
system type parameters
Deepest last cut Default value applied when creating new system designs. See Common
233
system type parameters
Maximum variation Default value applied when creating new system designs. See Common
233
system type parameters
Minimum different cuts Default value applied when creating new system designs. See Common
system type parameters 233
Minimum total variation Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike adjacent Default value applied when creating new system designs. See Common
233
system type parameters
Maximum alike total Default value applied when creating new system designs. See Common
233
system type parameters
Safe from re-cutting Default value applied when creating new system designs. See Common
system type parameters 233
Has coloured key heads Default value applied when creating new system designs. See Common
233
system type parameters
· T = Trap pin
9.16.28.4 Coding
There are no special considerations.
· B = Anti-bump pin
· D = Deep pin
9.16.29.4 Coding
There are no special considerations.
9.16.30.4 Coding
There are no special considerations.
· From the Setup and Admin menu, select Mottura Champions recognition codes.
Making a change
· Use the Add, Remove and Edit buttons to set up your recognition codes.
Notes
When you save a recognition code, the value is validated to ensure it meets the algorithm required by the
manufacturer.
Restrictions
Depth steps are not applicable to this design module.
9.16.31.4 Coding
There are no special considerations.
9.16.32.4 Coding
There are no special considerations.
Part
10
288 ProMaster Master Keying
10 Appendix
· From the Tools menu, select the item Diagnose database connection
At the top your connection details are shown, so the first thing you should determine is if this information is
correct.
Running a test
To perform a test, first highlight the test that you want, then click the Test button. The results of the test are
displayed at the bottom of the window, and when a test is completed successfully the test is flagged with a
check mark.
The tests
Resolve host
This test takes the host name and resolves it to an IP Address. If the host name is already an IP Address (e.g.
127.0.0.1) then the Resolve host test will indicate that the host name does not need to be resolved. In all
other cases, the test should resolve the host name to the IP Address of the machine that is hosting the
database. If the name cannot be resolved, first check that the host name is correct, then address the name
resolution issue with your computer network support person.
Ping host
This test attempts to ping the host. While a successful outcome for this test is useful in knowing that
communication is possible, a failed test does not necessarily indicate a problem as the host machine may be
configured to not respond to ping requests, or another network appliance may be blocking the ping (ICMP)
requests.
Test port
This test attempts to open a socket on the host machine on the port specified in the Server name, or that
resolved from the service port name if a service port name was specified. This test must succeed otherwise
there is a problem. The success of this test does not however indicate that the Firebird database engine is the
process that responded to the test, and in rare cases the socket connection request may be answered by
another process that has hijacked the database port on the host machine.
Test database connection
This is the definitive test. If this test passes then ProMaster Master Keying should connect to the database,
whereas if this test fails then ProMaster Master Keying will fail to operate. Any error messages returned from
this test are indicators of the source of any problems.
The operation may take a small amount of time, dependent on the amount of data in your database.
Never run this process while other users are using ProMaster Master Keying. Run this process only if
you are asked to by WH Software Limited support staff.
· Each line in the file is terminated by a Carriage Return and Line Feed pair of characters.
· Within each record (line) fields are delimited (separated) by using a single comma.
· A delimiting comma must not appear after the final field in each line.
· Any field that contains a comma (,) or quotation mark (") must be quoted according to standard quoting
rules (The field is prefixed and suffixed with a quotation mark, and any quotation mark is repeated)
· Additionally, each line must contain the same number of fields as the first line of the file. Exercise caution
using programs like Excel that will modify a perfectly readable csv file and remove trailing delimiters
thereby making a different number of fields on each line. Before saving from Excel, the addition of a
column containing arbitrary data (e.g. a single letter) as the rightmost column avoids this problem in Excel
and when importing the data file into ProMaster Master Keying that rightmost column can be ignored just
like any other column that you do not require.
ProMaster Master Keying is Unicode capable and will detect the file format being imported if it includes
the standard preamble characters to designate the file as UTF-8, UTF-16BE or UTF16LE. If the
preamble characters are not present for one of these three formats then the data file will be treated as
an ASCII file.
ProMaster Master Keying exports CSV data in UTF-8 format (including the preamble) unless the export
is for a specific purpose where only ASCII would be possible.
File Names
CSV files should always be supplied with:
Headings
It is common when using CSV files for the first line in the file to contain field or column heading that describe
the data on the subsequent lines.
ProMaster Master Keying will accept a file with or without the first line containing headings, however it is
strongly recommended that the file does contain these headings as it effectively documents the data that is
contained within the file and also ProMaster Master Keying will read these headings to automatically
determine the contents of each field. This is particularly important as ProMaster Master Keying does not
mandate the order in which fields appear in the CSV file.
Omitting the headings means that the person importing the data into ProMaster Master Keying will do so with
less certainty about the fields being imported.
The following table list all the fields that ProMaster Master Keying will accept for this import.
Boolean, see
Uses axis 4 No usesaxis4
above.
Boolean, see
Uses axis 5 No usesaxis5
above.
Boolean, see
Uses axis 6 No usesaxis6
above.
Boolean, see
Uses axis 7 No usesaxis7
above.
Boolean, see
Uses axis 8 No usesaxis8
above.
Boolean, see
Uses axis 9 No usesaxis9
above.
Boolean, see
Uses axis 10 No usesaxis10
above.
Boolean, see
Active No isactive
above.
Boolean, see
Complete No complete
above.
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
The folder from where the pictures are loaded is the folder that contains the CSV file you are importing
and then a sub folder CylinderPicture
Picture requirements
Minimum width 10, Maximum width 800, Minimum height 10, Maximum height 800
File type JPG or PNG
System type Character (100) yes systemtype System type must exist.
Component type Character (100) yes componenttype Sub assembly component type must exist.
Part code Character (30) yes partcode
Quantity Numeric, 1 to 999 Yes quantity
Location Character (50) Yes location
The folder from where the pictures are loaded is the folder that contains the CSV file you are importing
and then a sub folder CylinderSubAssemblyPicture
Picture requirements
Minimum width 10, Maximum width 1000, Minimum height 10, Maximum height 800
File type JPG or PNG
10.2.2.8 Cylinder sub assembly video URL import (CSV) file format
Manufacturer edition only. Cylinder sub assembly feature must be in your ProMaster Master Keying license.
ProMaster Master Keying provides a wizard for importing cylinder assembly video URL data that is supplied in
a comma separated values (CSV) file. This topic explains the file contents required.
289
For information about the physical structure of a CSV file, read the topic CSV file format definition .
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Boolean, False
being one of 'F',
'False', '0', 'N',
Active 'No' and True No isactive
being one of 'T',
'True', '1', 'Y',
'Yes'
Code Character (20) No clientcode Unique if provided.
Contact Character (50) No contactname
Phone Character (20) No contactphone
Fax Character (20) No contactfax
Email Character (250) No contactemail
Contact 2 Character (50) No contactname2
Phone 2 Character (20) No contactphone2
Fax 2 Character (20) No contactfax2
Email 2 Character (250) No contactemail2
Postal address 1 Character (30) No postaladdress1
Postal address 2 Character (30) No postaladdress2
Postal address 3 Character (30) No postaladdress3
Postal address 4 Character (30) No postaladdress4
Postal city Character (30) No postalcity
Postal state Character (5) No postalstate
Postal post code Character (10) No postalpostcode
Postal country Character (30) No postalcountry
Physical address
Character (30) No physicaladdress1
1
Physical address
Character (30) No physicaladdress2
2
Physical address
Character (30) No physicaladdress3
3
Physical address
Character (30) No physicaladdress4
4
Physical city Character (30) No physicalcity
Physical state Character (5) No physicalstate
Physical post
Character (10) No physicalpostcode
code
Physical country Character (30) No physicalcountry
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
289
For information about the physical structure of a CSV file, read the topic CSV file format definition .
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
The folder from where the pictures are loaded is the folder that contains the CSV file you are importing
and then a sub folder CylinderPicture (I.e. The same folder used for cylinder pictures)
Picture requirements
Minimum width 10, Maximum width 800, Minimum height 10, Maximum height 800
File type JPG or PNG
Headings
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
The table below shows one heading that ProMaster Master Keying will accept for automatically determining
the contents of each field. For each field there are several variations that are checked.
For example, to determine a field containing the Part Code from the heading, the following headings are
matched: part code, partcode, part, code, part no, partno, sku, article.
Additionally, headings are matched in a case insensitive manner.
Fields
The order of the fields within the CSV file is not important as the ProMaster Master Keying CSV import wizard
provides a powerful interface for selecting the source of each item of data.
The following table list all the fields that ProMaster Master Keying will accept for this import.
M = Master Key
S = Selective Key
C = Change Key
B = Construction
Z = Control
Designation Character (1) Yes* designation Other designations may not be imported.
B and Z must be used only on appropriate
design modules.
· After you acquire an image from your scanner it is displayed in the image editor.
· After you paste an image from the clipboard it is displayed in the image editor.
Resize image
When the image editor is loaded as a result of a new image being loaded (load, scanner or paste from
clipboard), the size of the image is checked.
If the image dimensions exceed the preferred size pre-set for that image purpose then you are prompted to
resize them image. As you will not be allowed to save the image unless it is within the maximum allowed
dimensions, then you should proceed with the image resize.
Options are provided to:
· Allow the width and height to be set. The image aspect ratio is maintained.
The status bar at the bottom of the image editor shows you the image dimensions and the image format.
Toolbar options
Option Description
Editing | Undo Undo the last change you made to the picture.
Editing | Redo Reapply the last undo you made to the picture.
Undo all changes you have made to the picture, reverting to the picture
Editing | Reload
you started with.
Select | Select all Selects the whole image
Select | Select none Removes the selection
Select | Select rectangle tool Use the mouse to make a selection on the image.
Select | Select ellipse tool Use the mouse to make a selection on the image.
Select | Select lasso tool Use the mouse to make a freehand selection on the image.
Use the mouse to make a selection on the image. This tools works best
Select | Select magic wand tool
with pictures with clearly defined areas.
Image | Flip horizontal Flip the picture horizontally.
Image | Flip vertical Flip the picture vertically.
Image | Rotate left 90 Rotate the picture left by 90 degrees.
Image | Rotate right 90 Rotate the picture right by 90 degrees.
Image | Decrease brightness Decrease the brightness of the picture.
Image | Increase brightness Increase the brightness of the picture.
Image | Decrease contrast Decrease the contrast of the picture.
Image | Increase contrast Increase the contrast of the picture.
Image | Sharpen Sharpen the picture.
Image | Blur Blur the picture.
Crop the picture, leaving just the area you have selected with your
Image | Crop
mouse.
Image | Clear selection Clears the area you have selected with your mouse.
Zoom | Full size Show the picture at 100% resolution.
Zoom | Fit to screen Show the picture sized to fit the window
View | Zoom in Show the picture larger.
View | Zoom out Show the picture smaller.
General use
More often than not, the tasks you will be performing in the Image Editor are:
· Crop To Selection (For pictures where you want to remove the surrounding white space)
When you have finished your changes, click OK to save the picture.
When you Connect to the camera the live camera view is shown. Click OK to take the photo when ready.
If you want to change Size or Camera, you must first Disconnect.
Page Layout
Four buttons are available to change the way the pages are presented (Single page, Two pages side-by-side,
Continuous and Two pages side-by-side continuous). The side-by-side layouts are useful for seeing two
pages at a time on a larger display. In the continuous views the mouse wheel scrolls down the page(s)
instead of jumping between pages as it does for a single page view.
Getting started
On the main ProMaster Master Keying window, select the Environment you are unable to connect to.
· From the Tools menu, select the item Reset Admin password
Resetting password
Enter your registration code
Enter the new password you want and confirm it by repeating it.
Click OK.
The registration code must be for the product registration used in this database. It does not have to
be the current registration code (e.g. You have renewed support and updates, but not entered the new
registration code), but it must be the same product registration that is in use for the database.
· If you have a window open where you may be performing a task, then ProMaster Master Keying locks the
console. To unlock the console, the user who is logged in must enter their password, or alternatively, the
holder of the admin password may perform an admin unlock.
The admin unlock is useful for times where the user has disappeared, and the admin wishes to unlock
the ProMaster Master Keying and log the user out.
When users are working on data, a lock is granted to the user and that prohibits other users from changing
the same data until the first user is finished.
System data is locked at the system level, whereas global data is usually locked at the record level.
Getting started
· You must be logged in as the admin user
· From the Setup and Admin menu, select Show user data locks
These reports are for administration purposes, and do not have any system or job context.
You must write the queries to return the data required by the report.
Designer location: Setup and Admin menu then Design custom reports - general.
Run location: Admin Reports menu then Custom reports - general.
System reports
Available in premium and manufacturer editions.
Required custom reporting license.
These reports are for system purposes, and provide the system context as a parameter.
You must write the queries to return the data required by the report.
Designer location: Setup and Admin menu then Design custom reports - system.
Run location: Reports menu then Custom reports - system.
Job reports
Available in premium and manufacturer editions.
Required custom reporting license.
These reports are for job purposes, and provide the system and job contexts as parameters.
You must write the queries to return the data required by the report.
Designer location: Manufacture Job screen click the Design button.
Run location: Manufacture Job screen select the report(s) then click Print or Print preview.
Job labels - shipping
Available in all editions.
Included in standard license.
Allows you to define your own label layouts, and own label size.
The data required is provided, so all you must do is lay out the labels.
Designer location: Manufacture Job screen check Print shipping labels and click the Design labels
button.
Run location: Manufacture Job screen check Print shipping labels and select the desired layout from the
list before printing.
Job labels - keys
Available in all editions.
Included in standard license.
Allows you to define your own label layouts, and own label size.
The data required is provided, so all you must do is lay out the labels.
Designer location: Manufacture Job screen check Print key labels and click the Settings and click the
Design labels button.
Run location: Manufacture Job screen check Print key labels and click the Settings and select the
desired layout from the list and click OK.
Job labels - doors
Allows you to define your own label layouts, and own label size.
The data required is provided, so all you must do is lay out the labels.
Designer location: Manufacture Job screen check Print door labels and click the Settings and click the
Design labels button.
Run location: Manufacture Job screen check Print door labels and click the Settings and select the
desired layout from the list and click OK.
About designing reports and labels
· Use the Add, Remove and Edit buttons to set up your reports or labels.
Each report must have a description and that description appears in the report or label selection.
If a report is not active, it will not be available for printing.
Click the Edit report button to open the report designer.
Special fields
There are some fields you may use the report layouts that automatically populate, or behave in a special
manner.
All the custom fields must be the correct field type and named correctly for the automatic behaviour. All the
names start with __ (That is two underscore characters).
All custom reports and labels
Shipping labels
At the top your machine details are shown, so the first thing you should determine is if this information is
correct.
Running a test
To perform a test, first highlight the test that you want, then click the Test button. The results of the test are
displayed at the bottom of the window.
The tests
Resolve host
This test takes the host name and resolves it to an IP Address. If the host name is already an IP Address (e.g.
127.0.0.1) then the Resolve host test will indicate that the host name does not need to be resolved. In all
other cases, the test should resolve the host name to the IP Address of the machine that is hosting the
database. If the name cannot be resolved, first check that the host name is correct, then address the name
resolution issue with your computer network support person.
Ping host
This test attempts to ping the host. While a successful outcome for this test is useful in knowing that
communication is possible.
Open TCP/IP port
This test attempts to open the a socket on the host machine on the communication port.
Read machine status
This test communicate with the machine and asks its status.
Read machine information
This test communicate with the machine and returns information about its configuration.
Part
11
316 ProMaster Master Keying
11 Version numbers
The following table shows the various file format versions used in each product release version.
Part
12
322 ProMaster Master Keying
Version 8.17301.0.0
Customer specific changes.
If the job notes on a system are added or altered and there are job(s) in the Entering status, and the job(s)
do not have notes, you will be asked if the notes should be copied to the job(s).
Version 8.17205.0.0
Fixed an error message when adding signatories.
Version 8.17204.0.0
Add "Find in results" for searching for a key or door in the key and door search windows.
Improved the performance of adding a system type which was sluggish when networks preformance was
poor.
Version 8.17203.0.0
Added "Remove description" as an option when bulk-changing keys.
When opening a system by searching for a signatory name, there is now an option for signatory active
(All/Yes/No) and it defaults to "Yes".
When door signatories is set to "All doors require the system specified number of signatories" and "Number of
signatories required to order doors" is 0 then the check for all mandatory signatories being on the job is now
ignored.
Added an option to the keys report to not show the key category.
Version 8.17202.0.0
Fixed an error message when replacing a key section family and selecting the replacement key section.
Version 8.17201.0.0
Fixed a problem stopping manufacturing XML being written in legacy format.
Version 8.17111.0.0
Faster opening key and door search windows, particularly on systems with a huge number of jobs.
Version 8.17110.0.0
Customer specific changes.
Version 8.17109.0.0
Mottura Champions improvements.
Version 8.17108.0.0
Customer specific changes.
Version 8.17107.0.0
Changed the output when manufacturing EVVA 3KS/4KS keys on the Silca Protech machine because the
Protech interpretation of the data is not the same as the Protech documentation and the machine was
reversing the depths.
Version 8.17106.2.0
Improvements to design assistant algorithm for selecting rotated constants.
Version 8.17105.2.0
Improvements to colour assignment in Medeco modules.
Version 8.17104.0.0
Medeco Biaxial 10 and 60 - fixed progression editor for coding matrix to not add a designation value.
Version 8.17102.0.0
Medeco Biaxial 10 series M4 support added.
Version 8.17101.0.0
Improvements to the database upgrade process from PM7.
Added design module Mottura Champions.
Version 8.17006.0.0
Improvements to the database upgrade process from PM7.
Version 8.17005.0.0
Fixed an issue searching for key sections when there are hundreds of sub sections.
Improvements in the performance of releasing a job to manufacturing when the test keys feature is licensed
and the system has thousands of keys on each door.
Version 8.17004.0.0
Customer specific changes.
Evva DPE module - changes to allow no colour assignment to keys.
Version 8.17003.1.0
Version 8.17001.0.0
Improvements to download program updates.
Fixed an error message exporting all systems to a client when publishing is not configured.
Added card 1943 (CorbinRusswin).
Version 8.16903.0.0
Key Manager 8 related changes.
Altered card 453 (Yale).
Version 8.16704.1.0
New "Stamping only" option for Gravograph cylinder marking output.
Updated database engine to version 3.0.7
Version 8.16703.0.0
Signatory and client signatory screen layout changes.
Added automatic checking for updates. Additionally, download of updates is available on the server.
Fixed an issue importing Key Manager jobs when a snapshot of the system exists.
Version 8.16503.0.0
Improves speed of list selection and management for Abloy Protec, Abloy Novel and Lockwood MT5.
Version 8.16502.0.0
Installer improvements.
Customer specific changes.
Generic key marker, Generic door marker - file name was not always correct when using sales order number.
Version 8.16501.0.0
Resolved an issue importing locks from a CSV file.
Allowed key designation "Control" for Kaba Expert and Kaba Expert Plus. Control key may not be ordered on
the same job as other keys.
Improved job entry to disallow ordering a cylinder re-key quantity greater than previously manufactured. An
exception is made for doors that were never ordered to allow a re-key quantity of 1 so that legacy systems
without door orders can be re-keyed.
Fixed an error when searching for door hardware by description.
Version 8.16402.0.0
Further to the enhancement in version 8.16103.0.0 regarding Abloy Protec pre-cuts, when the key cutting is
sent to the Abloy LT-120, the pre-cut positions are changed to a "0" cut so they are not re-cut.
Door CSV import would not always sort new doors after existing doors. Fixed.
Version 8.16401.0.0
Fixed job display after editing customer order number on released job.
Fixed a rare problem in "Door access for key" where sometimes a door could not be added.
Added some handling for key section family errors when opening the coding screens. This is a rare scenario
from old data imported from other software products that affects very few users. Now the key section
indicates an error rather than generating an repeated error message.
Version 8.16306.0.0
Resolve an issue cutting Kaba Ace keys on the Silca Protech for serial perms.
Version 8.16305.0.0
Resolve an issue cutting Kaba Ace keys on the Silca Protech for serial perms.
Version 8.16304.0.0
Marking output for the gravograph machine - added an option for "Items per line" to support the Gravotrace
software.
Version 8.16303.0.0
Customer specific changes.
Backup email settings storage issue fixed. If you have the ProMaster Master Keying backup program
configured to send email, check the settings for the encryption after installing this update and correct the
encryption method if necessary.
Fixed Kaba ACE list selection - fixed the capacity display for right lists.
Version 8.16301.0.0
Fixed Kaba Gemini cutting on Triax machines.
Version 8.16205.0.0
Publishing - improvements on setting device availability.
A new Application parameter 49 under Coding called Allow coding reports (Key codes, door pinnings)
to be printed. This parameter stops the Key codes report and Door pinnings report from being printed or
saved as a PDF. This parameter has been added to decrease the chance of these reports being printed in
error and entering the production rather than using a job. These two reports are for checking coding ONLY
194
and must never be used for manufacturing. See the warnings in Report: Key codes and Report: Door
195
pinnings . The default behaviour for this setting is to not allow the two coding reports to be printed, and
this will be the correct setting for most users. If you want to print these reports (i.e. Like the previous
behaviour) then change the value of the application parameter mentioned above.
Fixed the status bar link for renewing support and maintenance.
Improvements in list selection for Kaba Expert Plus to seperate master-key perms and serial perms and
improved sorting.
Version 8.16204.0.0
Improvements to Kaba ACE serial permutation management.
Fixed an issue that stopped a key being removed when not ordered but referenced by a job on a door that
had been ordered.
Version 8.16203.0.0
Improvements to Kaba ACE serial permutation management.
Version 8.16202.0.0
Changes to the Kaba ACE design module to support systems that are KD and use multiple serial permutation
sin the same system.
Version 8.16201.1.0
Duplicate system - fixed a minor error when incompatible choices were selected.
Database upgrade from PM7 for ABUS XY14 improved for pre-cut values.
On 2-level DHI systems with the TMK other than "AA", improved the generation of key numbers when adding
keys.
Improvements self-heal connection loss to make it more robust for consecutive multiple failures.
Fixed an issue where replacing a key did not move the signatory authorities onto the new key.
Fixed an issue printing door labels for re-keyed cylinders.
Fixed the factory list in the preferences to exclude inactive factories.
Resolved an issue manufacturing doors that have 29 or more construction keys operating the door (Inline,
LWTwin, AAKeyUltra, AAPerk, AAUnion).
Version 8.16103.0.0
Kaba ACE - when cutting on the Silca Protech added dummy perm where necessary to make smoother key
operation.
Abloy Protec system types now have the ability for each key section to define which positions are pre-cut on
the blanks. When the key cutting is sent to the Silca Protech, Keyline SigmaPro or Silca UnoCode 399, the
pre-cut positions are changed to a "0" cut so they are not re-cut.
Version 8.16102.0.0
The list of devices when publishing a job was not sorted according to the sort order set when configuring the
devices. Fixed.
Bilock systems - allowed "weak" positions to be up to 6, not limited to the first 4 positions.
Several typo errors corrected.
Added cards 1534, 1066 (Wilka)
Version 8.16101.0.0
Improved "Create a system from Excel" to allow retrying when Excel file has errors (i.e. after you fix the
errors).
Version 8.16003.0.0
Adjustments to cutting Kaba Ace keys on the Silca Protech machine.
Version 8.16002.0.0
Database upgrade from PM7 - fixed a problem that would stop some databases from upgrading.
Added ability to cut Kaba Ace keys on the Silca Protech machine.
Version 8.16001.0.0
ProMaster Mobile publishing service is now available for sending jobs (particularly re-key jobs) to a mobile
phone. See Mobile services 79 and Manufacture: Publish to device
223
.
Version 8.15906.0.0
Improved selection of text when editing doors and keys.
Improvements to self-heal when disconnected from database and systems remain locked.
Version 8.15905.0.0
Job key labels fixed partcode field.
Job XML outputs now include key part codes (if turned on in the application parameters).
Added the job sales order number to the display of the door history and key history windows.
Added the ability to order a "core" for ALC Galaxy jobs.
Version 8.15904.0.0
Customer specific changes.
Key history and door history reports - added sales order field to the reports.
Version 8.15903.0.0
Customer specific changes.
When editing invoice number on completed job, allowed other related fields to be edited.
Changed the default value from "No" to "Yes" for the application parameter "In keying matrix, make
manufactured doors read-only by default". This is the safer setting. If you want the original behaviour,
change the value of this parameter to "No".
Added an application parameter to permit saving documents without a description.
Version 8.15902.0.0
Fixed a problem generating test keys on Medeco Biaxial 10 if the test keys feature was licensed.
Version 8.15901.0.0
Enhanced import from ProMaster Hardware (For use with ProMaster Hardware 7.15901 or later).
Version 8.15807.0.0
Improved Silca Protech marking token output.
Version 8.15806.0.0
Added a search for stamping when editing doors on a job.
Added options to the keying matrix to determine how propagation to doors with the same stamping operates.
Added "Customer code" as a search parameter for jobs.
Various search windows - improved the tab order for moving from the result to the bottom buttons.
Version 8.15805.0.0
Customer specific changes.
Version 8.15804.0.0
Job list report was not showing the customer order number. Fixed.
Windows 2008/2008 R2 dropped from supported platforms.
Added a variant of the Key History report based on a range of job dates. Check the report documentation
before using because it works a bit different to other key history reports.
Version 8.15803.0.0
Systems with multiple replaced keys could not always be deleted. Fixed.
Evva 4KS system code generation for standard progressions has been enhanced.
Version 8.15802.3.0
Signatory search was not respecting the value for "Active". Fixed.
Email body not always correct when using Windows 7. Fixed.
Cutting Best A2/A4 (Cards 752/754) on Silca UnoCode/UltraCode machines - added option to use tip stop 4.
Silca UnoCode/UltraCode machines - fixed cutting problems on some tip aligned keys.
Adjusted card 1932 for cutting on UnoCode machines.
Fixed a problem downloading keys to the ITL machine.
Version 8.15801.0.0
Improved backwards compatibility of manufacturing XML output of test keys when using legacy output file
format.
Version 8.15708.0.0
Fixed an error message when adding doors/keys with very long numeric key number or door number.
Version 8.15707.0.0
Fixed an issue on some systems with manual code entry on Medeco Biaxial 10 series systems.
Version 8.15706.0.0
On interchangeable core systems when displayed tip to head, and entering a progression by using the mouse
(popup menus) instead of the keyboard then values appeared in the incorrect columns. Fixed.
Version 8.15705.1.0
Improved colour setting during coding on systems that permit two colours and a single colour is being used.
When adding a door and selecting a lock or cylinder, if the user has permissions to alter locks and cylinders
then add/edit/remove are now available.
When coding on Interchangeable Core systems and doors not having a lock/cylinder (not good anyway!), auto
coding was slow. Fixed.
Report subtitle font size adjusted.
Manual code entry on Medeco Biaxial 10 series systems improved to allow easier angle selection.
Version 8.15704.0.0
Fixed an error when importing a Medeco Biaxial 60 system from PM7.
Fixed an error releasing a job on the MT5 design module when the "Test keys" feature is licensed.
Version 8.15703.0.0
Added card 1933.
Version 8.15702.0.0
Added card 1932.
Version 8.15701.0.0
Fixed an error message when copying signatories to other systems if the user had never opened those other
systems.
When acquiring a document from a scanner, then editor maximum size was incorrect.
Added an option to the system signature registration report to not show the system description.
On the order for keys and doors, added a template that may be user defined.
Improved the speed of saving a job on large systems when the "test keys" feature is licensed.
Several job door outputs (Pinning chart, On-screen pinning, XML) showed keys multiple times when key re-
issues were ordered on the job. Fixed.
Version 8.15605.0.0
Backups. When compression a backup (zip), some third party programs (e.g. Carbon Black) can interfere
with the ability to completely read the backup and the zip is incomplete. This version adds checking for
anything keeping hold of the backup file and if the ProMaster Master Keying backup program cannot acquire
exclusive access to the backup for zipping then it reverts to a non zipped backup.
Version 8.15604.0.0
Fixed an error message when creating a job and the client name was more than 50 characters.
Fixed a problem with construction keying being removed prematurely.
Version 8.15603.0.0
XML export from manufacturing for Medeco Original 60 series product and sorting by key symbol produced an
error. Fixed.
XML job manufacturing outputs - various improvements including segment information for Kaba modules.
Version 8.15508.0.0
Door pinning report for the Assa design module - fixed alignment of stamping field.
Key part code - various places fixed to convert the part code to upper case.
Printing door labels sorted by key symbol produced an error message. Fixed.
Importing systems - improved the selection of items to make the process easier.
Version 8.15507.0.0
Improvements in job XML output.
Version 8.15506.0.0
Improvements for downloading Gen6T keys to Keyline machines. December 2019 Keyline update is required
to cut these keys.
Jobs - editing notes for keys and doors works a little better now.
When creating a system from hierarchy quantities, the key part code may be entered if you have this
functionality enabled in the application parameters.
Job XML exports now include the Customer Code on the job.
Job list when searching for doors or keys is now sorted by the job opened time.
Version 8.15502.0.0
Abloy Novel - fixed problem with list selection.
Version 8.15501.0.0
Gravograph machine - allowed multiple machines to be configured.
Version 8.15410.0.0
Version 8.15405.0.0
Fixed error when double clicking to manufacture a job.
Fixed an anomaly when adding a door from whilst adding a key then adding a second door to the same key.
Door number progression was not logical.
Added functionality for converting EVVA DPE/DPS/EPS systems from the Inline module to the EVVA DPE
module.
Version 8.15404.0.0
Improved weak key options for Abloy Protec and ALC Bilock.
Version 8.15403.0.0
Medeco Biaxial 10 series - added ability to create a TMK with single cuts only.
Customer specific changes.
Version 8.15402.0.0
Customer specific changes.
Version 8.15401.0.0
Fixed an error when open a system by system description and search option "a + b".
Job test keys feature - fixed an error that could happen on some systems using control keys.
Version 8.15308.1.0
ASSA USA module - improvements.
Version 8.15307.0.0
Added door and key preferences for how the quantity to order is set.
ASSA USA module - added support for directional and limited rotation cylinders.
Version 8.15306.0.0
Fixed an error while exporting Kaba Expert job door assembly to XML.
Improved error checking during coding when a code is assigned to a key that operated no doors.
Preliminary support for ASSA USA locking products.
Jobs, changed maximum number of each key ordered on each job from 999 to 9999. Same change for doors.
Added an Application Parameter turn on the display of the system creator when searching for systems.
New system from hierarchy quantities when using DHI numbering. When making a level 3 system and adding
a second master node it was not named correctly.
Fixed an occasional access violation error when releasing a job to manufacturing.
Version 8.15305.0.0
Compatibility improvements for importing older PM7 system files.
Fixed key colour search when setting up key colours was not always working.
Version 8.15304.0.0
Improved the logic for printing "(Copy)" on manufacturing reports when reprinted.
Job manufacturing reports - include system stamping in the report title when it has been set.
Key and door history issue numbers were displaying incorrect on some items. Fixed.
Lowered CPU usage during database backup.
Job search - fixed issue with date selection.
Job search for manufacturing - fixed issue with date selection, removed nonsensical options for the "Look in"
selection.
Version 8.15207.1.0
Job manufacturing. Fixed an error message closing a job if the PM8 user had never previously opened the
system or worked on it in any way.
Emailing system reports. Improved the handling of email addresses when emailing system reports.
Job manufacturing reports - new application parameter to permit large text identifier in the top right corner
(e.g. Invoice, Sales Order etc) to assist in collating paperwork in factories.
Adjusted some XML manufacturing outputs to be compatible with PM7 when using the legacy export mode.
Affects Union and KeyUltra design modules as well as Inline lock systems B8B10, CLCS, CounterR.
Version 8.15206.0.0
Job signatories - improved logic for checking signatories so that keys and doors work completely
independently.
Version 8.15205.0.0
Job administration summary report was not using the selected factory parameter.
Creating a new system from an existing systems - improved key and door sorting.
Interchangeable core (A2, A4 etc) - fixed and error message when control key was the only key assigned a
code.
Construction keyed systems (Inline LW Twin, AA Perk, AA Union, AA KeyUltra) did not display construction
keying information correctly when manufacturing a job without having the system open.
Version 8.15204.0.0
Minor visual improvements in job window.
Customer specific changes.
Job search screens added Customer Code to the display.
Interchangeable Code - new lock systems for Kaba Peaks.
Version 8.15203.0.0
Fixed an error when cutting Abloy Protec keys on a Silca UnoCode 399.
Version 8.15202.0.0
Interchangeable core module - allowed empty position use in special pinning A2/A3/A4 systems.
Version 8.15201.0.0
Customer specific changes.
Version 8.15103.0.0
Abloy Protec and Abloy Novel, added support for cutting keys on Keyline Sigma Pro machine.
Version 8.15102.0.0
Fixed an error that could happen when turning on key head colours after creating the design.
Tidied up some warning messages to make them more concise.
Customer specific changes.
Version 8.15101.0.0
Silca Protech output - more options for T02 marking data.
Improved the order that doors and keys are added.
Silca Protech output - added support for Abloy Sentry short keys.
Silca Protech output - added support for EVVA 3KS+ and 4KS.
Resolved a problem cutting Abloy Protec keys on the Silca UnoCode 399.
Performance improvement opening coding matrix on Bilock systems with all positions progressed.
Jobs key cutting report now has font size choice.
Customer specific changes.
Added card 799.
Version 8.15013.0.0
Minor visual adjustments.
Fixed an error message when generating a TMK for Sargent 6300 systems.
Coding now reports an error on Bilock CQCC doors that do not have a control key assigned (I.e. an impossible
situation).
Version 8.15009.0.0
Improved speed when creating system from hierarchy quantities.
Improved speed when creating system from Excel.
Version 8.15008.0.0
Version 8.15004.0.0
Customer specific changes.
Version 8.15003.0.0
Improved the way the next system number is generated.
Fixed the default parameters for signatory requirements when creating a new system.
Version 8.15002.0.0
Card 401 parameter improvements.
Version 8.15001.2.0
XML job output - enhanced output for Interchangeable Core module to repect the system type setting for
presentation direction and also output a flag indicating the direction.
General speed enhancements.
Added generic key marker to manufacturer and premium edition.
Added generic cylinder marker to manufacturer and premium edition.
Version 8.14912.4.0
Construction keyed systems - fixed a problem when printing pinning reports when the construction ball was
specified on a custom progression.
Version 8.14905.0.0
Fixed anomalies in key marking output for GravoGraph and EngraveIT Pro machines.
Version 8.14904.0.0
Improved the search for systems by customer order number.
Kaba ACE enhancements.
Version 8.14903.0.0
In the database upgrade from PM7 to PM8, fixed the import of Bilock dealer cut definitions.
Import from version 7 - added support for some earlier import files.
Kaba ACE enhancements.
Version 8.14902.0.0
Fixed an error duplicating door areas.
Increased default text size for rich text fields.
When exporting to ProMaster Key Manager, the email address of the system contact 1 is added to the email
recipient list.
Version 8.14901.0.0
Kaba ACE enhancements.
Various small corrections.
Improved speed opening coding tree or coding matrix over slow connection.
Fixed problem deleting a system if the client had client signatories.
In the database upgrade from PM7 to PM8, accommodates some unusual key section data.
Adjustments to cards 38, 1754, 1755, 1756.
Added cards 1920, 1921.
Added ability to print door pinning report in coding screens from (a) a door phantom and (b) from the doors
list.
Improved handling of special pinning with empty positions.
Version 8.14811.0.0
Improved system import of key section families.
Version 8.14810.0.0
Changed the default value for some application parameters to better fit the requirements of most users.
Fixed a problem importing systems with driver pins specified on the cylinder.
Version 8.14809.0.0
Job On-screen pinning and job XML outputs - added handling when lock data used by job missing from lock
database.
Version 8.14808.0.0
When creating users, allowed user to be created using windows domain login rather than creating user first
then changing to windows domain login.
Version 8.14807.0.0
Various cosmetic fixes and tidying up of error messages when saving data.
In the database upgrade from PM7 to PM8, speed improvements.
Job door pinning report - added handling for lock data used by job missing from lock database.
Version 8.14806.0.0
Open job for manufacturing - improved performance.
AL Bilock CQCC systems - fixed incorrect phantom report on some keys.
Version 8.14805.0.0
Various cosmetic fixes.
Version 8.14804.0.0
When creating users, disallowed upper case in the login name.
Version 8.14803.0.0
In the database upgrade from PM7 to PM8, made changes to reduce memory consumption during the
upgrade.
Version 8.14802.1.0
In the database upgrade from PM7 to PM8, handling has been added for key numbers and door numbers
duplicated in a system.
Version 8.14801.0.0
Initial release of ProMaster Master Keying 8.