The DDM editor screen is organized in a table where the field definitions data is contained in rows and columns. All attributes that belong to a field defined for a DDM are contained in one row (that is, source-code line), separated by tabs.
This section describes the columns contained on the DDM Editor screen and the commands provided to create or modify a DDM field, navigate in the screen, or catalog a DDM source, for example.
This section describes the fields contained in the header at the top of the DDM editor screen and how to modify them. In addition, you can display read-only Tamino specific doctype information.
The fields contained in the DDM header are described in the following table. For the Tamino-specific doctype fields, see also Introducing Tamino XML Schema Language in the Programming Guide.
Header Field | Description |
---|---|
DBID |
The database ID (DBID) as specified in the global configuration file. DBID contains the database file referenced by the DDM. Valid range: See also: DBMS Assignment and Database Management in the Configuration Utility documentation. If To modify the field contents, see Modifying DDM Header Fields. |
FNR | The number of the file being referenced in the database
The file number of a DDM from Tamino is always
Valid range: To modify the field contents, see Modifying DDM Header Fields. |
DDM | The name of the DDM currently contained in the work area of the DDM editor. |
Line | The number of the source-code line where the cursor is currently positioned. |
DEF. SEQ. | Not applicable to Tamino.
The default sequence by which the file is read when it is accessed
with a The default sequence is specified with the two-character field short name. The system validates the short name based on the selected file number. If the database is accessible, the short name is checked against the corresponding field in the database file. If such a field does not exist in the database, a selection list of valid short names is displayed. If the database cannot be accessed, no selection list is generated. To modify the field contents, see Modifying DDM Header Fields. |
TYPE | Displays the type XML for a DDM created from a
Tamino database.
|
Collection | Read-only Tamino-specific doctype information.
The name of the collection which is used within the Tamino database. To view doctype information, see Displaying Tamino Doctype Information. |
Schema | Read-only Tamino-specific doctype information.
The name of the Tamino XML schema which is used within the Tamino database. To view doctype information, see Displaying Tamino Doctype Information. |
Doctype | Read-only Tamino-specific doctype information.
The name of the doctype within the collection. To view doctype information, see Displaying Tamino Doctype Information. |
Namespace URI |
Read-only Tamino-specific doctype information.
The list of namespace URI/prefix pairs which corresponds to the doctype. To view doctype information, see Displaying Tamino Doctype Information. |
To switch Tamino-specific doctype information on or off
Press F12 (toggle switch).
Or:
From the menu, choose .
If switched on (the default setting is off), the Doctype Information section is displayed in the bottom half of the DDM editor screen as shown in the example below:
01/10/2004 DDM Services 11:05:45 V 6.1.1 Pl 9 Software AG 2004 Line: 1 DBID: 175 FNR: 1 DDM: DDM_TEST TYPE: XML C T L Name F Length D G 1 EMPLOYEE G 2 GROUP$1 3 PERSONNEL-ID A 8 D G 2 GROUP$2 G 3 FULL-NAME G 4 GROUP$3 5 FIRST-NAME A 20 D 5 MIDDLE-NAME A 20 D ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Doctype Information ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Collection: NATDemoData1 Schema : Employee Doctype : Employee Namespace URI Prefix ------------------------------------------------------------------------------ http://www.w3.org/2001/XMLSchema xs F1 HELP F2 CHOICE F3 STOW+EXIT F10 STOW F11 CHECK F12 DOCTYPE INFO F13 MODIFY HEADER F14 SHOW EXT FIELD F15 |
To modify the contents of DDM header fields (Tamino-specific information is read-only)
Press F13.
Or:
From the MISC menu, choose .
The cursor is positioned in the first header field (DBID) that can be modified.
Press TAB to go to the next header field to be modified.
This section describes the field attributes that can be defined in the rows and columns of the DDM editor screen.
Column Heading | Field Attribute | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
T |
|
||||||||||||||||||||||||||||
L | The level number assigned to the field.
Levels are used to indicate the structure and grouping of the field definitions. This is relevant with view definitions, redefinitions and field groups (see the relevant sections in the Programming Guide). Valid level numbers are For Tamino: valid level numbers are Level numbers must be specified in consecutive ascending order. |
||||||||||||||||||||||||||||
DB |
Not applicable to Tamino. The display of the DB column is switched off by default. To switch the display on or off, press F12 (toggle switch). The DB column displays the two-character short name of the corresponding field in the database file (see also Example of a DB Column). Creating Fields:
If you create a new DDM field and the display of the
DB column is switched off, the DDM editor assigns to the
new field a short name that has not yet been used for another field. This means
that for the new field there is no correlation between the database file and
the DDM. To guarantee that the short name of a new field is checked against the
database, create a field by using the
line command
|
||||||||||||||||||||||||||||
Name | The name of the field.
It can be 3 - 32 characters long for Adabas fields and 1 - 32 characters for SQL columns and Tamino doctypes. The rules to create a name comply with the
naming
conventions for user-defined variables (see the
Using Natural documentation),
except that the first character of the name must always be a Latin capital
letter (A - Z). In addition, the name must not start with The field name is the name used in other Natural objects (for example, in a program) to reference the field. The field name is unique across the whole DDM. For Tamino, the field name is not necessarily the same name as Tag Name (see Tamino-Specific Extended Field Attributes). |
||||||||||||||||||||||||||||
F | The Natural data format of an elementary field, such as
A (alphanumeric), P (packed numeric) or
L (logical).
For valid Natural data formats, refer to Format and Length of User-Defined Variables in the Programming Guide. |
||||||||||||||||||||||||||||
Length |
|
||||||||||||||||||||||||||||
S |
|
||||||||||||||||||||||||||||
D |
|
01/10/2004 DDM Services 19:02:57 V 6.1.1 Pl 9 Software AG 2004 Line: 1 DBID: 20 FNR: 14 DDM: EMPLOYEES DEF.SEQ.: C T DB L Name F Length S D AA 1 PERSONNEL-ID A 8 D * CNNNNNNN G AB 1 FULL-NAME AC 2 FIRST-NAME A 20 N AD 2 MIDDLE-I A 1 N AE 2 NAME A 20 D AD 1 MIDDLE-NAME A 20 N AF 1 MAR-STAT A 1 F * M=MARRIED AG 1 SEX A 1 F AH 1 BIRTH N 06.0 D AH 1 N@BIRTH I 2 D G A1 1 FULL-ADDRESS M AI 2 ADDRESS-LINE A 20 N |
An indicator field is used to retrieve the length of a variable length
field or information about the data significance (NULL
value
indicator) of a database field. An indicator field does not provide
the contents of a database field.
A database field name starting with L@
or
N@
is interpreted as an indicator field, according to the indicator specified in the
NATCONV.INI configuration file (see also
IDENTIFIER-VALIDATION
in
How to Use
Different Character Sets in the
Operations documentation. Therefore, a database
field name must not start with any of these character strings unless it
represents an indicator field.
The following happens when a DDM is initially generated.
An L@xxxxx
field is
automatically added for every variable length field, where
xxxxx
is the name of the related field.
This applies to long alpha (LA) and large object (LB) fields in an Adabas file.
If the length indicator relates to an LA, LB or LOB field, the Natural data format/length must be I4. For a VARCHAR field, the format/length must be I2.
An N@xxxxx
field is
automatically added for a field that may contain a NULL
value,
where xxxxx
is the name of the related
field.
This applies to Adabas fields defined with the SQL Null Value
Option. The Natural data format/length of a NULL
indicator field must be I2.
The following section describes how to invoke the help function for the columns of fields provided on the DDM editor screen.
To display help information on field columns
Position the cursor at a field and press F1 once for instructions on entering a valid input value in this field.
Or:
Position the cursor at a field and press F2 to select a
valid input value for this field from a list.
This section provides information on the positioning commands, line commands, editor commands and Natural system commands provided with the DDM editor.
Positioning commands are used to navigate in the DDM editor screen and line commands manipulate one or more lines of DDM source code. Editor commands, for example, are used to change the display mode of the editor screen and system commands, for example, are used to save the source and the cataloged object of the DDM.
You can use the following keys to navigate in the DDM editor screen:
Key | Explanation |
---|---|
DOWN-ARROW | Scrolls down one line. |
LEFT-ARROW | Moves left on the screen. |
RIGHT-ARROW | Moves right on the screen. |
UP-ARROW | Scrolls up one line. |
TAB | Moves from one input field to the next. |
The line commands available in the DDM editor are used to copy, delete, insert or move single or multiple DDM source-code lines. As an alternative to entering line commands in the DDM source as described below, you can use the equivalent function (F) keys described in Function-Key Assignments.
To execute a line command
On the DDM editor screen, in the column C, position the cursor in the source-code line(s) to which the command applies, and enter any of the line commands listed below:
Line Command | Explanation | |
---|---|---|
C |
Copies a marked block of lines:
Delimit the block of lines with an |
|
D |
Deletes the line in which the line command was entered or
deletes a marked block of lines:
Delimit the block of lines with an |
|
H |
Removes the marks from a block of lines. | |
I |
Inserts a blank line above the line in which the line
command was entered.
If the database is available, the Select Database Field window appears from which you can choose the field short name:
See also DB in the section Columns of Field Attributes. |
|
M |
Moves a marked block of lines:
Delimit the block of lines with an |
|
X |
Marks the first line of a block of lines to be copied, deleted or moved. | |
Y |
Marks the last line of a block of lines to be copied, deleted or moved. |
The editor commands or Natural system commands available in the DDM editor are executed by choosing either a command from the DDM editor menu
, or , or a function (F) key.To execute an editor or a system command from a menu
On the DDM editor screen, press ESC.
The DDM editor menus
, and appear at the top of the DDM editor screen.(See also the example screen in Terminating the DDM Editor.)
Select a menu and press ENTER.
A list of valid commands appears. The commands and their equivalent F keys (if available) are explained later in this section.
Choose the command to be executed for the current DDM source and press ENTER.
The following section describes the editor or system commands provided with DDM editor menus and the standard F-key assignments.
The commands available with the
menu correspond to the Natural system commands with the same name. They are used to check or scan the DDM source currently contained in the editing area of the DDM editor, and save the source as a source and/or cataloged object in the current Natural library and/or system file.The
menu options and equivalent F keys (if available) are explained in the following table:Menu Option | F Key | Explanation |
---|---|---|
Saves the DDM source as a cataloged object as described for
the system command CATALOG in
the System Commands documentation.
|
||
F11 | Checks the syntax of the DDM source as described for the
system command CHECK in the
System Commands documentation.
|
|
Saves the DDM source as a source object as described for the
system command SAVE in the
System Commands documentation.
|
||
Searches for a string of characters within the DDM source,
with the option to replace the string with another string as described for the
system command SCAN in the
System Commands documentation.
|
||
F10 | Checks the syntax of the DDM source and saves both the source
and the cataloged object as described for the system command
STOW
in the System Commands documentation.
|
The
menu options and equivalent F keys (if available) are explained in the following table:Menu Option | F Key | Function |
---|---|---|
F12 | Not applicable to Tamino.
Switches the display of the attribute column DB on the DDM editor screen on or off. See also DB in the section Columns of Field Attributes. |
|
F12 | Only applies to Tamino.
Switches the display of the Doctype Information section on the DDM editor screen on or off: see Displaying Tamino Doctype Information. |
|
F13 | Displays in edit mode the DDM editor header fields
DBID, FNR and
DEF.SEQ.
See also the section DDM Header Information. |
|
F14 | Switches the display of the Extended Field Information section on the DDM editor screen on or off: see Specifying Extended Field Attributes. | |
F15 | Displays in edit mode the fields contained in the Extended Field Information section on the DDM editor screen: see Specifying Extended Field Attributes. | |
Only applies to DDMs that refer to Adabas files.
Specifies that a file is physically coupled to this DDM. Files are coupled by using Adabas descriptors. For further information on file coupling, refer to the Adabas documentation. |
The
menu options and equivalent F keys (if available) are explained in the following table:Menu Option | F Key | Explanation |
---|---|---|
F3 | Executes the STOW
command (see COMMANDS
Menu) and leaves the DDM editor.
|
|
Leaves the DDM editor without saving any modifications and
without executing the STOW
command (see COMMANDS
Menu).
|
The commands available with F keys are used as an alternative to the commands provided with DDM editor menus or line commands. In addition, the F keys provide help information on the commands and fields available in the DDM editor.
To list all current F-key assignments
On the DDM editor screen, press F1 twice.
The following table lists all standard F-key assignments and equivalent menu options or line commands:
Function Key | Explanation | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
F1 | HELP
If pressed once, displays help information for the field at which the cursor is positioned. If pressed twice, displays help information on the current F-key settings. |
||||||||||||||||||||
F2 | CHOICE
Displays a selection window (if relevant) for the field at which the cursor is positioned. From this window, you can choose a value. If no selection option is available, the help information window appears instead. |
||||||||||||||||||||
F3 | STOW + EXIT | ||||||||||||||||||||
F4 - F9 |
|
||||||||||||||||||||
F10 | STOW | ||||||||||||||||||||
F11 | CHECK | ||||||||||||||||||||
F12 | DB-SHORT-NAMES or
DOCTYPE INFO
Toggle switch. |
||||||||||||||||||||
F13 | Corresponds to in the menu. | ||||||||||||||||||||
F14 | SHOW EXT FIELD or HIDE EXT
FIELD
Toggle switch. |
||||||||||||||||||||
F15 | EDIT EXT FIELD |
To copy or move a block of lines with F keys
Position the cursor in the first line of the block of lines to be copied, deleted or moved and press F6.
The line is marked.
Move down or up to the next or previous line by pressing DOWN-ARROW or UP-ARROW.
Each additional line is marked.
In the last line of the block of lines to be marked, press F6 to stop marking further lines.
Position the cursor in the line above which you want to copy or move the block of lines and press F8 or F9.
The extended field editing function provides the option to specify default field attributes for headers and edit masks as well as remarks to be applied when the field is used in another Natural object (for example, in a program).
The header attribute specifies the default column header to be displayed
above the field when it is output, for example, with a
DISPLAY
statement.
If no header
is specified, the field name is used as column header.
The edit mask attribute specifies the default edit mask to be used when
the field is output, for example, with a DISPLAY
statement. The edit
mask must conform with Natural syntax rules and be valid for the Natural data
format and length of the field.
The remark attribute specifies a comment about the field.
For Tamino, the extended field editing function also provides additional Tamino-specific information.
EM - Edit Mask in the Parameter Reference documentation
The section below covers the following topics:
This section describes how to switch extended field attributes on or off.
To switch extended field attributes on or off
Press F14.
Or:
From the menu, choose .
If switched on (the default setting is off), the Extended Field Information section is displayed in the bottom half of the DDM editor screen as shown in the examples below.
Example of Extended Field Attributes from Adabas:
23/09/2004 DDM Services 15:16:36 V 6.1.1 Pl 9 Software AG 2004 Line: 8 DBID: 20 FNR: 14 DDM: EMPLOYEES DEF.SEQ.: C T L Name F Length S D 1 PERSONNEL-ID A 8 D * CNNNNNNN G 1 FULL-NAME 2 FIRST-NAME A 20 N 2 MIDDLE-I A 1 N 2 NAME A 20 D 1 MIDDLE-NAME A 20 N 1 MAR-STAT A 1 F * M=MARRIED 1 SEX A 1 F 1 BIRTH N 06.0 D 1 N@BIRTH I 2 D G 1 FULL-ADDRESS M 2 ADDRESS-LINE A 20 N ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Extended Field Information ~~~~~~~~~~~~~~~~~~~~~~~~~ Header : MARITAL/STATUS Edit Mask: Remark : NC F1 HELP F2 CHOICE F3 STOW+EXIT F10 STOW F11 CHECK F12 DB-SHORT-NAMES F13 MODIFY HEADER F14 HIDE EXT FIELD F15 EDIT EXT FIELD |
Example of Extended Field Attributes from Tamino:
01/10/2004 DDM Services 13:52:41 V 6.1.1 Pl 9 Software AG 2004 Line: 11 DBID: 102 FNR: 1 DDM: EMPLOYEES-TAMINO TYPE: XML C T L Name F Length D G 4 GROUP$3 5 FIRST-NAME A 20 D 5 MIDDLE-NAME A 20 D 5 MIDDLE-I A 20 D 5 NAME A 20 D 3 MAR-STAT A 1 D 3 SEX A 1 D 3 BIRTH A 10 D ~~~~~~~~~~~~~~~~~~~~~~~~~~ Extended Field Information ~~~~~~~~~~~~~~~~~~~~~~~~~ Header : Marital/Status Edit Mask : Remark : xs:string Tag Name : Mar-Stat XPath : /Employee/Mar-Stat Occurrence : Flags : MULT_OPTIONAL Default Value: Fixed Value : F1 HELP F2 CHOICE F3 STOW+EXIT F10 STOW F11 CHECK F12 DOCTYPE INFO F13 MODIFY HEADER F14 HIDE EXT FIELD F15 EDIT EXT FIELD |
The contents of the fields in the Extended Field
Information section are triggered by the field at which the cursor
is positioned. In the examples above, the cursor is
positioned at MAR-STAT
.
The section below describes how to edit the field attributes contained in the Extended Field Information section of the DDM editor screen. Note that Tamino-specific extended field attributes (see the relevant section) cannot be edited.
To edit the fields in the Extended Field Information section
Press F15.
The cursor is positioned in the Extended Field
Information section in the Header
input field, which is
now highlighted and can be modified.
To move down to the next input field, press DOWN-ARROW or TAB.
To move to up to the previous field, press UP-ARROW.
To terminate editing with or without field modification
Press ENTER.
The cursor is positioned outside the Extended Field Information section.
Tamino-specific extended field attributes are extracted from Tamino XML schema definitions.
In addition to the fields Header, Edit Mask and Remark, the following read-only Tamino-specific attributes are displayed in the Extended Field Information section:
In addition to the fields Header, Edit Mask and Remark, the following read-only SQL-specific attribute is displayed in the Extended Field Information section:
Attribute | Function |
---|---|
SQLTYPE | Information generated from the data types BLOB (Binary Large Object) or CLOB (Character Large Object) if contained in an Oracle database. |
The F4 to F9, and the display mode of the DB column.
menu of DDM Services is used to display or change the DDM editor profile settings for the function (F) keysTo invoke Services Profile
On the DDM Services screen, choose .
The following menu options are displayed:
22/09/2004 DDM Services Library: SYSTEM 14:21:44 V 6.1.1 Pl 9 Software AG 2004 DBID : User: SAG FNR : +------------------------------------------------------------------------------+ ¦ Library DDM Maintenance Services Profile Quit ¦ +---------------------------------------------+-------------------+------------+ ¦ Function Keys ¦ ¦ Other Definitions ¦ +-------------------+ Show Other Definitions |
This section contains information on the
menu options.With the F4 to F9. These F keys are used to execute line commands (see the relevant section) in the DDM editor.
option, you can reassign the keysTo reassign an F key
From the
menu, choose .The Profile settings window appears with the current F-key assignments:
+--- Profile settings ----+- ¦ Delete F4 ¦ ¦ Insert F5 ¦ ¦ Mark Block F6 ¦ ¦ Unmark Block F7 ¦ ¦ Copy F8 ¦ ¦ Move F9 ¦ +-------------------------+ |
In the Profile settings window, position the cursor in the line of the function you want to reassign and press the F key to which you want to assign this function. You can only assign an F key that is not already assigned to any other DDM Services function.
The new F key setting is displayed in the Profile settings window as shown in the example below:
+--- Profile settings ----+ ¦ Delete F21 ¦ ¦ Insert F5 ¦ ¦ Mark Block F6 ¦ ¦ Unmark Block F7 ¦ ¦ Copy F8 ¦ ¦ Move F9 ¦ +-------------------------+ |
With the DB column as described in Columns of Field Attributes.
option, you can determine whether or not to display theTo change the display mode of the DB column
From the
menu, choose .The Profile settings window appears:
+------- Profile settings -------+ ¦ Display Database short names N ¦ +--------------------------------+ |
Replace the current value by Y
(Yes) to display the
DB column permanently, and N
(No) to hide the
column permanently.