Go to the bottom.
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name: NPTRNSLATION.SDDL
!
! Purpose: This SDDL file defines the nptrnslation relation.
!
! Modification History:
!
! Date OPR Who Reason
! -------- ------- --- -------------------------------------------------
! 10/28/94 27329 MRB Original implementation
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
!
LANGUAGE FORTRAN, SQL
INCLUDE ZSPSS_USER_TYPES.SDDL
RECORD NPTRN_TYPE
!------------------------------------------------------------------------------
!
! RECORD INFORMATION
!
!------------------------------------------------------------------------------
DESCRIPTION "This relation forms the link between the SMS
and the defined systems in SMS Precedence Checking.
Each statement of an SMS (command, event, data block,
etc.) that causes the Precedence Checker to perform
actions, must have a corresponding Translation Table
record identifying the action to be performed. A
Translation Table record specifies the statement
causing the translation and the action resulting
from the translation.
The statement name and type identify translating
statements. Specifying a parameter name results in
the translation occurring only if a parameter
accompanies the statement in the SMS. Translations
may also be defined such that they occur only if the
parameter has a specific value. Value checking is
initiated by specifying the type of value checking in
the value check field. The Precedence Checker performs
discrete value checks for strings and range checks for
numeric values.
When a statement is to result in a translation based on
the values of two or more parameters, the statement
name, type, parameter name, and value checking are
specified in a separate record for each parameter. Each
record should have the same action specified. The
records are linked together by giving all Translation
Table records involved the same value for the
multi-parameter code. The translation then occurs only
for statements which pass all of the checking done for
every record with the same multi-parameter code. The
multi-parameter code links all of the translations
together such that one record translates only if all
of the others in the chain translate. Thus, two records
may be defined for different parameters of a statement,
each record having different value checking requirements.
Specifying the same multi-parameter code for the two
records prevents the translation from occurring unless
both parameters are present and both pass their
respective value checks.
The second aspect to creating a translation for a
statement is defining the action to occur as a result
of the translation. Specifying a system, action, and
optionally an element causes the specified action to
occur for the system or element. When the translation
occurs, the Precedence Checker uses the current state
of the system or element to locate a State Transition
Table record having the same action ID specified in the
Translation Table record. State Transition Table record
processing then begins.
If a translation is to result in another action at a
later time, the timer fields of the translation record
may be used. The timer fields provide a capability for
a timed translation to occur when the timer expires. A
timer may be saved and/or started as a result of the
translation. When the timer expires, the translation
specified in the timer occurs.
A translation may also be designed to execute an
algorithm. The algorithm may be used, among other
things, to return a timer value. For more information
concerning timer operations, see the chapter on backend
precedence checking.
See NPNAMES_TABLE to understand where this data comes
from and how it is used. The description for
NPNAMES_TABLE also has a complete list of the related
precedence checker relations. Also refer to Chapters 22
through 33 of the SCS User's Guide for more information
on the precedence checker."
!------------------------------------------------------------------------------
!
! FIELD INFORMATION
!
!------------------------------------------------------------------------------
FIELD statemnt
TYPE C12
DESCRIPTION "This field is the command, command set, or any
mnemonic which may have secondary mnemonics
associated with it."
END_FIELD
FIELD type
TYPE C3
DESCRIPTION "This field is the type associated with the primary
mnemonic. If the primary mnemonic is a command set,
the type will be the command set type: grp...etc."
END_FIELD
FIELD trn_ord
TYPE I2
DESCRIPTION "This field allows different translations having
the same primary mnemonic to be carried out in a
particular order. The concatenation of the primary
mnemonic, translation order and translation
mnemonic form the key used to sort the translation
table."
END_FIELD
FIELD paramter
TYPE C12
DESCRIPTION "This field is usually the name of a parameter when
the primary mnemonic is a command, command set or
data block. The translation mnemonic provides the
least significant part of the key into the relation.
a typical lsms statement will specify a single
primary mnemonic and several translation mnemonics
as well as translation mnemonic values."
END_FIELD
FIELD msg_id
TYPE C12
DESCRIPTION "This file is the message ID to be output in the error
summary file and precedence checker trace file as
a result of this translation. If the field is
blank, no message will be output. Messages are
kept in a separate relation accessed by message ID."
END_FIELD
FIELD par_code
TYPE C12
DESCRIPTION "This field is a code used to define a multi parameter
action. A multi parameter action is defined as an
action involving more than one parameter. The action
code consists of a single repeated character, the
number of repetitions being equal to the number of
parameters involved in the action. The character
must be unique for actions associated with the
same primary mnemonic. A blank entry corresponds
to a single parameter action."
END_FIELD
FIELD val_chk
TYPE C1
DESCRIPTION "This field is a code that indicates if a value check
is needed for this translation.
V - a value check is needed.
N - a value check is not needed.
D - this is the default translation for this
combination of primary and secondary mnemonic
the default translation for a specific key will
be used only after all value check translations
are processed."
DISCRETE "N", "n", "D", "d", "V", "v"
END_FIELD
FIELD val_type
TYPE C1
DESCRIPTION "This field is the type of the value to be checked.
N - numeric value.
S - string value."
DISCRETE "N", "n", "S", "s", " "
END_FIELD
FIELD strg_val
TYPE C12
DESCRIPTION "This field is the string value if the value_type is
's'."
END_FIELD
FIELD min_val
TYPE R4
DESCRIPTION "This field is the minimum for the range check if
value_type is 'n'."
END_FIELD
FIELD max_val
TYPE R4
DESCRIPTION "This field is the maximum for the range check if
value_type is 'n'."
END_FIELD
FIELD alg_code
TYPE C1
DESCRIPTION "This field is a code that indicates when an algorithm
associated with an action is to be executed.
I - execute algorithm immediately.
E - execute algorithm after the statement is
checked.
: - no algorithm (default)."
DISCRETE "I", "E", ":", " "
END_FIELD
FIELD algorthm
TYPE C12
DESCRIPTION "This field is the identifier of algorithm to access."
END_FIELD
FIELD system
TYPE C12
DESCRIPTION "This field is the name of the system to which this
translation applies."
END_FIELD
FIELD element
TYPE C12
DESCRIPTION "This field is the name of the element to which this
translation applies. If this field is blank then this
translation applies to the whole system."
END_FIELD
FIELD action
TYPE C12
DESCRIPTION "This field is the identifier of an internal action
implied by the translation."
END_FIELD
FIELD act_val
TYPE R4
DESCRIPTION "This field is a value associated with this translation
action. Its present use is limited to providing a timer
value for a system or element state transition.
The data type may change if other uses are identified."
END_FIELD
FIELD tim_src
TYPE C1
DESCRIPTION "This field, timer source, tells where to get the
timer value if a timer ID is saved as a result of this
translation.
P - get the value from the SMS (i.e. in the value field
of the translation mnemonic.
V - get the value from the timer value field."
DISCRETE "P", "V", " "
END_FIELD
FIELD save_tim
TYPE C12
DESCRIPTION "This field is the identifier of a timer to be saved."
END_FIELD
FIELD strt_tim
TYPE C12
DESCRIPTION "This field is the identifier of a timer to be started
now as a result of this translation."
END_FIELD
FIELD tim_val
TYPE R4
DESCRIPTION "This field is the value in seconds of the timer
identified by timer save ID. Time value is used
when timer source is set to 'v'."
END_FIELD
FIELD tim_mix
TYPE C3
DESCRIPTION "This field is a flag set to indicate for multiple
path cases whether the maximum (max) or minimum (min)
value of any delta time delays shall be used for
processing the transition at the end of the paths.
The default shall be the maximum value."
DISCRETE "MAX", "MIN"
END_FIELD
FIELD trc_flg
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "This field a flag set to 'y' to indicate output to
the trace file should be enabled and set to 'n' if
output to the trace file is to be inhibited. Output
to the trace file may also be controlled through
the command line or by precedence checker directive."
END_FIELD
FIELD cnstrnt_id
TYPE C12
DESCRIPTION "This field is an identifier which associates this
translation with a constraint. A record with the
constraint ID specified here should be present in
the constraint text relation."
RELATED_FIELDS "npconstraint.cnstrnt_id"
END_FIELD
FIELD comment
TYPE C72
DESCRIPTION "This field is commentary text."
END_FIELD
END_RECORD
!------------------------------------------------------------------------------
!
! RELATION DECLARATION
!
!------------------------------------------------------------------------------
RELATION nptrnslation
TYPE NPTRN_TYPE
DESCRIPTION "Precedence Checker Translation Table Relation"
SUBSYSTEM_USING "SCS"
RELATED_FIELDS "npvflags.actlst_flg" "npname_table.*" "npalgorithms.*"
INDEX nptrnslation_1
TYPE unique, clustered
FIELDS statemnt, type, trn_ord
END_INDEX
END_RELATION
!------------------------------------------------------------------------------
!
! INSTANCE DECLARATION
!
!------------------------------------------------------------------------------
INSTANCE nptrnslation
GLOBAL
TYPE NPTRN_TYPE
END_INSTANCE
Go to the top.