Keycode Update Procedure

It might be necessary to apply a new keycode, for example to add new features, or increase system limits. Usually, keycodes come as a small file with a .kcd extension. You can either boot the Call Server from the software installation Compact Flash card (RMD), and from the Tools Menu, pick option <r> "To install Keycode only." OR, you can use knew in LD 143. This method has no downtime.

Copy the .kcd file to a directory called keycode (all lowercase) on a compact flash card (the EDD card is fine). Make sure the filename is not longer than 8.3 characters, if it is, rename it. Place the RMD in the Call Server, access LD 143, and enter knew rmd, and select.

With older (rel. 3) "large systems", rename the .kcd file keycode.kcd, copy it to a floppy disk (root), and use knew f0 to install it.

Remotely:

If you're not on-site (or don't have a CF card reader), you can copy the .kcd file by FTP, or Xmodem (in PDT).
Make sure there's a RMD in the (Active) Call Server flash drive, and follow the steps below:

➤ Using FTP:

open an FTP session to the Call Server, login with the PDT2 username/password.
Change to the RMD keycode directory: cd /cf2, ls, mkdir keycode (if not exist), cd keycode
Change to bin mode, and mput the local .kcd file. eg: mput C86542.kcd
After a successful transfer, close the FTP session...

See CS File Transfer Protocol for more information on Call Server FTP commands.

➤ Using PDT:

If FTP is not an option, eg, via modem, log into the Call Server, and access PDT (ctrl-PDT)
Change to the RMD keycode directory: cd /cf2, ls, mkdir keycode (if not exist), cd keycode
Enter rx C86542.kcd, and at the same time, 'Xmodem send' the .kcd file from the terminal

The commands are very similar to FTP, but be more careful in the PDT shell!

Apply the new keycode:

Login to the Call Server (or exit from PDT), and access LD 143
Enter knew rmd and select the newly uploaded keycode file
Observe the TTY output, a PBX restart maybe required
Don't forget to always LD 43: EDD after any changes!

Notes:

Newer (7.5) systems use SFTP, and the UCM single sign-on username/password (admin).
If you use a GUI program (WinSCP, etc), manually goto directory cf2, as it's not shown in the directory tree.
Xmodem in PDT: rx <filename> receives a file from the terminal, sx <filename> sends a file to the terminal.
Always update the sites installation media with the new KCD file to avoid a "downgrade" if the system is re-loaded.

Responses:

If the system instantly activates the New Keycode, the following message is output:

CCBR020 New Keycode accepted and activated successfully. Sysload is NOT needed!

If the New Keycode cannot be activated instantly, the following message is output:

CCBR009 New Keycode accepted. It will be activated during the next restart.

In this case, it will be necessary to co-ordinate a PBX restart, an INI is not sufficient.

Example:

The following Call Server output shows the LD 143 knew rmd command:

>ld 143

CCBR000

.knew rmd
                                                                              
/cf2/  - Volume is OK Change volume Id from 0x0 to 0x617ae38e
 The following keycode files are available on the removable media:

                 Name                     Size       Date        Time
               --------------------      ------    -----------  -------
 <CR> -> <1> - C86542.KCD                  1114    Jun-14-2011   08:19
         <q> - Quit

         Enter choice> 1


SRPT4612 KC: file /u/direct.tmp has been copied to /p/sl1/direct.new

SRPT4612 KC: file /cf2/keycode/C86542.KCD has been copied to /p/install/keycode.new
OK
CCBR009 New Keycode accepted. It will be activated during the next restart
.

The output indicates the new keycode was fine, and it will be activated during the next restart. An INI is not enough, you must hit the reset button on the Call Server. But, don't forget to LD 43: EDD before you do! A restart will incure a few minutes of downtime.

After the restart, goto LD 22, enter slt at the REQ prompt to print "system limits", and confirm the keycode changes are applied.

Use LD 143: ksho rec to show contents of the currently used keycode file, and the differences with the rest of keycode files:

.ksho
Please use: KSHO <param>
   NEW  - accepted  new keycode
   REC  - currently used keycode
   OLD  - previously used keycode
   RMD  - candidate keycode on Removable Media Device CF
   FMD  - candidate keycode which was uploaded to Fix Media Device
.ksho rec
 Validating Keycode File /p/install/keycode.rec ... OK