a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# Standard Razor data file rules apply. Empty lines and those beginning
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# with a hash ('#') are ignored.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# All other lines must contain at least three (3) TAB SEPARATED fields.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# If there are fewer than 3 fields, the program errors out. Some attribute
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# types allow/require a 4th TAB SEPARATED field. The first field denotes
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# the type of attribute as follows:
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# LABEL (issues only)
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# ONE_OF_MANY_LIST
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# ONE_OF_MANY_STACK
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# TEXT_PANE (issues only)
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# TIME_STAMP (issues only)
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# X_OF_MANY_LIST
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# The second field is the label to be associated with the item. Since
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# this is a tab delimited file, it is possible for the label to contain
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# embedded spaces, however, we STRONGLY discourage this. The Razor programs
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# will append a colon (':') to the text when displaying it on the screen.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# The third field is required, however, the syntax differs for each of the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# possible attribute types. Please refer to the manual, Chapter 8,
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# "The Attributes file" for details.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# For ONE_OF_MANY, ONE_OF_MANY_LIST, ONE_OF_MANY_STACK, X_OF_MANY and
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# X_OF_MANY_LIST, an optional 4th field defines the number of rows to
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# display the attributes.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# The TEXT_PANE attribute is used to label the two scrolling text areas
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# at the bottom of the issue form. The attribute name MUST be of the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# format 'TEXTn' where 'n' is 1 for the first text area, 2 for the second.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# The third field in the TEXT_PANE definition is the string used to
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# label the text area.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# For TIME_STAMP, the third field is the time format and may be in a
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# form as specified in the man pages for strftime. An example of a time
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# format is the string %m/%d/%Y. This format will display the date in
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# the format MM/DD/CCYY. Please note that conversion characters
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# (i.e. "%m") must be separated by white space or a non-alphanumeric
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# character (i.e. "/").
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# The fourth field of the TIME_STAMP attribute is a comma-separated list
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# of flags of the following format:
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# I=<nn> -Defines an increment in days to be added to the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# current date.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# P=[Y|N] -Defines if this field should automatically be
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# loaded when a new Issue is created. The default
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# R=[Y|N] -Defines if entry of the field is required. The
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# default is N.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# U=[Y|N] -Defines if the field should automatically be
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# updated when an Issue is transitioned to the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# modify state. The default is N.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# W=[Y|N] -Defines if the field is writable. The default
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# NOTE: For the issues program, the first field MUST be a TEXT_FIELD.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# This text field is shown on the main display as the title for the
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# CHANGING ATTRIBUTES: After you have created some issues, you may
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# find that you would like to change or add attributes. To ADD an
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# attribute or add a value (including a state) to an existing attribute,
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# take the database server down ("razor down") and edit this file.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# To RENAME or REMOVE an existing attribute and/or an attribute value
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# (including a state), take the database server down and use one of
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# the following scripts that may be found in $RAZOR_HOME/scripts:
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# rz_rename_attr, rz_rename_attr_val
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# rz_remove_attr, rz_remove_attr_val
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# These scripts will update the Attributes file and the existing
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders Hatlen# database. Refer to the manual for details.
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenTEXT_FIELD Title 120
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenONE_OF_MANY_STACK Type BugReport, EnhancementRequest, ProcessRequest, Other
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenONE_OF_MANY_STACK Priority Informational, Low, Medium, High, Urgent
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenX_OF_MANY Spacecraft file:SpacecraftList 1
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenSTATE State Submitted, Approved, Open, Completed, Built, Verified, Accepted, Released, Closed, Rejected, Failed
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenONE_OF_MANY_STACK Responsibility file:SpecialUserList, file:LocalUserList 40
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenTEXT_FIELD CrossReferences 120
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenTEXT_FIELD ReleaseInfo 120
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenTEXT_PANE TEXT1 Description
a336a7912ecb62fb9310c4f3e50dc622aea4951cKnut Anders HatlenTEXT_PANE TEXT2 Actions Taken