Configuration files

Most of these files apply to all Razor programs (unless specifically identified). Unless otherwise noted, each of the following configuration files supports the presence of internal comments, denoted by having a `#' (hash) as the first character on the line. Blank lines are ignored, and may be used to provide nice visual breakage. We actively encourage the use of comments in whatever files you edit.

Some of these files are located at the universe level, and others at the group level. Files located at the universe level will exist in the directory...

$RAZOR_UNIVERSE_DIR/Tables

...and group-related files are found in the directory...

$RAZOR_UNIVERSE_DIR/DOMAIN_01/<group>/Tables

Where appropriate, environment variables (such as $RAZOR_HOME) and the `~' (tilde) may be used to identify directories and/or file names.

Each line of the file is terminated with a carriage return, and is independent of how the local screen wrap may be presenting the text to you.

Universe-level files

Files located at the universe level will exist in the directory...

$RAZOR_UNIVERSE_DIR/Tables

Files at the universe level may also appear at the group level. Files at the group level will take precedence.

Access_list

Access_list controls who may perform operations within the Razor tools. This file may be used to provide global access. The format of the entries are:

<operation><who>

See "Access controls" on page 199. for a complete description of controlling user access.

Options

Each line consists of the following fields...

<option><value>

This file can be used to gain more control over the version check-in process and the appearance of text panes. See "Options" on page 202 for details. Changes take effect on the next invocation of the related tool.

Roles

This allows administrators to define role names and reference these role names in the Permissions file by prefixing the role name with a '%'. Role definitions can be any combination of user id, group id (preceded by a '+') or other roles (preceded by a '%'); Role definitions in the Permissions file may be used for either the state transition 'who' or the e-mail column. For e-mail, group names defined for the role will be ignored.

If you have a large number of users to define for a role you can use two or more lines. example:

CM     mark, joel, deb, +cmteam
CM     kathy, john,  george, al

Razor will concatenate both lists so that CM will contain mark, joel, deb, +cmteam, kathy, john, george, al

NOTE: A role called RAZOR_ADMIN can be defined that has `special' privileges. Users in RAZOR_ADMIN are allowed to check another person's file back in or uncheck another person's checked-out file.

Group-level files

Files located at the group level will exist in the directory...

$RAZOR_UNIVERSE_DIR/DOMAIN_01/<group>/Tables

Files at the group level, if the same as files found at the universe-level, will take precedence. Group-level files may include all of those files listed previously under the universe-level files, as well as the following:

Actions

Each line consists of the following fields...

<label><before script><after script>

The <before script> and <after script> may contain either the name of the script to be executed or the string "n/a" if no script is applicable. To avoid ambiguities, it is recommended that the fullpath to the script be specified. Environment parameters and the use of special symbols such as "~" are allowed.

Changes to the Actions file are honored on the next invocation of the related issues, versions, or threads program.

Attributes

The Attributes file is the mechanism used to control the layout of forms. A full description of this file is provided in the chapter on "Customization & Personalization" on page 183.

Changes to attributes require that the related Razor database server be stopped, then restarted. Note also that changes to this file may have repercussions, requiring coordinated edits to other Razor configuration files, or scripts you may have written.¹

Bitmaps

Each line consists of the following fields...

<label><value><bitmap_file>

The <bitmap file> can be specified using environment parameters and/or special symbols such as "~".

Changes to the Bitmaps file are honored on the next invocation of the issues, versions, or threads program.

Commands

Each line consists of the following fields...

<label><command>

The <command> can be specified using environment parameters and/or special symbols such as "~". A separator line can be inserted with a line containing the word "SEPARATOR".

The script is passed the name of a file containing the list of items selected from the GUI. The file will be empty if no items were selected. Changes to the Commands file are honored on the next invocation of the issues, versions, or threads program.

Insensitive (issues only)

Each line consists of the following fields...

<attribute><value><who><insensitive>

Each line specifies which field should be made insensitive, (grayed out), when the <attribute><value><who> value matches. The <who> field can be any combination of users, user groups, and roles. User group entries (UNIX and WindowsNT) must be preceded by a `+' and role names by a `%'. To match users who are not a member of an entry, precede the entry with an `!', (the `not' symbol). Changes to the Insensitive file are honored on the next invocation of issues.

Permissions (issues only)

Each line consists of the following fields...

<state1><state2><userid_list>[<addr_list>]

Changes to the Permissions file take effect on the next invocation of the issues program.

Prefix (issues only)

This file contains a single line with an alphabetic character in the first position. The character is used in the issue name of subsequently created issues. As an example, if the Prefix file contains the character `X' and then issue 35 is created, the issue will appear in the main display list as `X...-.35'. It is a nice way to visually differentiate between various issues groups.

Problem_template,
Solution_template (issues only)

These are free format text files. Whatever you place in these files (including Razor style comments and blank lines) will be used to pre-load the text sections of new issues.

Changes to the problem or solution template files take effect on the next invocation of the issues program.

Promoters (versions & threads only)

Aside from comments, each line consists of either a single userid, a user group (preceded by a `+'), or a defined role (preceded by a `%'). These should be in lower case. Changes to the Promoters file take effect on the next invocation of the related versions or threads program.

NOTE: The Promoters file is superseded by the Access_list file but is left for backward compatibility. Users should switch to Access_list, described on page 267, as subsequent versions of Razor may not support Promoters.

Reports (issues only)

Each line consists of the following tab-separated fields...

<label><script_name> [  options ]

Label is the report label that will appear in the Reports pull-down menu. Script_name is the script used to generate the report. Options consist of a comma-separated list of any combination of the following: name, print. If the field options contains the string "name", the first argument passed to the script will be the name of a temporary file containing the list of selected issues.² If options contains the string "print", the output of the script will be automatically printed as defined via the user's print command.³

A separator line can be inserted with a line containing the word "SEPARATOR".

Changes to the Reports file take effect on the next invocation of the issues program.

Vcs

This file contains a single word and tells Razor which archive engine is being used for the group, e.g. SCCS or RCS. DO NOT EDIT THIS FILE! It is created and maintained by Razor.

¹ See "Customizing the Attributes file" on page 197.
² Refer to "Writing report scripts for issues" on page 232 (Batch method).
³ Refer to "Printing issues" on page 71.