Digital

NAME

WORKSPACE FIELD - identifies a subdivision within a workspace or the entire workspace

SYNOPSIS

 
 [ <workspace-name> |
 [ <unique-qualifier> ] { .<field-name-1> |
                          .<field-name-2>({<s1>}[ ,... ])
                        }
 ] {.<simple-field-name> |
    .<record-field-name> |
    .<array-field-name>[({<s1>} [ ,... ])]
   }

PARAMETERS

       •workspace-name
 
An unqualified unique identifier giving the name of the workspace in which the workspace field occurs. The scope of the identifier depends on the workspace declaration, as follows:

oFor a private workspace, the identifier is internal to the task definition in which it is defined. 

oFor a private workspace, the identifier is external but the shared workspace name follows the rules of an internal identifier. 

A workspace name can be used as the first or only element in a workspace field reference. 

       •unique-qualifier
 
A field name that depends on the scope of the simple field name, record field name, or array field name. If the unique qualifier is specified, the field name must be unique within the scope specified by the unique qualifier. If the unique qualifier is not specified, the field name must be unique within the scope of the task.

       •field-name-1
 
A qualified internal identifier giving the name of a field within record layout. The field name is qualified by the record field name or the workspace name in which the field name appears. The scope of the field name is the data type definition in which it is defined. A field that is not the last field in the workspace field must have the data type of RECORD or a data type identifier. If a field is the first or only field in a workspace, its name must be unique within the scope of the task. If the name refers to other than the first field in a workspace field, the name must be unique within the scope of either the previous workspace name or the field name in the workspace field that precedes it.

       •field-name-2
 
A qualified internal identifier giving the name of an element of a workspace field that must have the data type ARRAY. If the name is not the last element in the workspace field specification, the workspace field must have the data type of ARRAY of RECORD or a data type. A field can have a data type of ARRAY only if the field is used in the last element in the workspace field. If it is the first or only field name in a workspace field, it must be unique within the scope of the task. If the name refers to other than the first field in a workspace field, the name must be unique within the scope of either the workspace name or field name in the workspace field that precedes it.

       •s1
 
An integer literal or an integer workspace field giving a subscript to refer to a specific element of an ARRAY data type. Multiple subscripts are separated by comma (,) characters. The number of subscripts for an array field must match the array nesting of the corresponding field in the data type definition associated with the workspace. Array elements are stored as rows. The rightmost subscript varies fastest as elements are accessed in storage order.

       •simple-field-name
 
A qualified internal identifier giving the name of the last element in the workspace field reference. The field name to which the simple field name refers in the data type definition associated with the workspace can either have a data type of:
 
  DECIMAL STRING
  INTEGER
  OCTET
  RECORD
  TEXT
  UUID
 
or be a data type identifier. The scope is determined by the unique qualifier.

       •record-field-name
 
A qualified internal identifier giving the name of a field that can have a data type of RECORD.

       •array-field-name
 
A qualified internal identifier giving the name of a field that  must have a data type of ARRAY.
 
For an array field without a subscript, the data type is ARRAY of the level of nesting, the same size for each level and the same array element data type of the corresponding field in the data type definition associated with the workspace.
 
For an array field with a  subscript, the data type is the data type of the element of the corresponding field in the data type definition of the array.
 

DESCRIPTION

 
The specification of a workspace field is a name or sequence of names, each element in the sequence preceded by a dot (.) character indicating its level in a record hierarchy determined in the data type definition.
 
In STDL, syntax references to a workspace field can be restricted to a specific data type. When the data type is restricted, the documentation refers to the workspace field using a data-type specific term. The terms for the workspace fields and their data types are:
 
  array-workspace field       ARRAY
 
  decimal workspace           DECIMAL STRING
 
  id-workspace field          ARRAY SIZE 16 OF OCTET
 
  integer-workspace field     INTEGER
 
  octet-workspace field       OCTET
 
  record-workspace field      RECORD
 
  s-text-workspace field      TEXT CHARACTER SET SIMPLE-LATIN
 
  text-workspace field        TEXT
 
  uuid-workspace field        UUID
 
The id-workspace field, or identifier field, can contain an identifier for either a submit task request (a queued request entry within system management) or a record queue element. See the submit_task and enqueue_record man pages. 
 
For data type definitions, see the data_type_definition man pages. The data type of the last or only field-name-1 or field-name-2 determines the data type of the workspace field. 
 

RELATED INFORMATION

 
Syntax: assignment(1), call_presentation(1), call_procedure(1), call_task(1), data_type_definition(1), dequeue_record(1), enqueue_record(1), get_message(1), read_queue(1), submit_task(1), task_definition(1), workspace(1)

acmsxp_introduction