Creating a User Record Definition File

Either of the following two methods can be used to create a 'User Record Definition' file. With versions prior to 10.0 only the second method can be used. Both types of 'User Record Definition' files are text files that can be edited with Notepad or any other text editor tool.

When creating a new file or updating an existing file it is important that the same file is added to all other Monitoring Servers in the environment so that consistent records are available on each machine.

Method 1 (Available with Version 10.0 and later)

New record definitions can be added to an existing .udefsrec file or, if required, a new user record definition file can be created and placed into the appropriate product sub-folder in the <Prognosis_Home>\Server\Configuration\Solutions\CustomSolutions folder. When a new record definitions file is created, it can have any user-defined name. However, it must have the file extension .udefsrec. All .udefsrec files in this folder and any subfolders will be processed as User Records.

Create a new .udefsrec file in the Server\Configuration\Solutions\CustomSolutions\<product_name> folder path.

For example:

If there is a custom extractor called mylog.ext, the udefsrec file for it would go into <Prognosis_Home>\Server\Configuration\Solutions\CustomSolutions\MyLog\Mylog.udefsrec

.udefsrec files should not be placed in the root of the solutions directory or within any of the existing pre-packaged Prognosis solution directories.

Add one or more new Record Definitions. Record numbering is no longer required.

Add all the Fields (Data) to collect in the Record using Defining a Field for a User Record.

When finished save the text file.

With this method, there is no requirement to update the PROGNOSIS Configuration file.

To have any new or modified .udefsrec files processed, the Monitoring Server must be stopped and restarted. After this has been done the records will be available to select in any new document that is created, such as a Display or Database.

Method 2 (Available for all Versions)

New record definitions can be added to the supplied UDEFSREC file, or a new user record definition file can be created. If a new file is created it will replace the default UDEFSREC as only one instance of this file is allowed.

When a new record definition file is created, it can have any file name. However, the three-character suffix REC must be included, for example, MYDEFREC.

To use a new record file, it must first be included in the PROGNOSIS Configuration in the USERRECORDS statement. The file name is entered with only the characters before the three-character REC suffix, for example, MYDEF (i.e. exclude the REC).

SUBSYS PROGNOSIS
...
USERRECORDS (MYDEF)

These record definition files do not have a filename extension.

Using a text editor open the default UDEFSREC file, this is located in the <Prognosis_Home>/Server/Configuration folder.

This file contains the definitions of all records that have been user-defined in this instance of Prognosis.

The first record in the default UDEFSREC file is called ALLFIELD. It provides an example of every possible type of field that can be defined in a record definition.

Save the UDEFSREC file with your new file name, for example, MYDEFREC (It is much safer to work on a copy of the file).

Add one or more new Record Definitions.

Add all the Fields (Data) to collect in the Record using Defining a Field for a User Record.

When finished save the text file. This can be saved back as UDEFSREC and will copy over the old file or it can be saved with the new name.

If the file has been saved with a new name, ensure that the USERRECORDS statement in the PROGNOSIS Configuration has been updated to read the new records definition file.

USERRECORDS (MYDEF)

To have any new or modified .udefsrec files processed, the Monitoring Server must be stopped and restarted. After this has been done the records will be available to select in any new document that is created, such as a Display or Database.

Backwards Compatibility

UDEFSREC files from versions earlier than 10.0 are compatible with all later versions. The UDEFSREC file from the earlier version should be placed into the <Prognosis_Home>\Server\Configuration folder of the later version replacing the supplied UDESFREC file and will continue to work.

Provide feedback on this article