Defining Additional Attributes of Fields

If you choose Open from the context menu of a field, a window appears in which you can define additional attributes.

Only those types of additional attributes appear in the window that apply to the type of field. For example: the option Adabas security & Edit mask is not contained in the list when a DB2 index field is processed.

The additional attributes are described in the following sections:

3GL Specification
Conditions
Field Name Synonyms
Adabas Security and Edit mask
DBMS Extensions
Field Procedure
Derived Field Expression
Index Definition - DB2
Index Definition - Oracle
Default value
Constraint name
Identity definition / Change log
Platform Compatibilities
Base Extensions

3GL Specification

Specifications for 3GL

Attributes

Gr.structure

The field attribute Gr.structure is used to change the record layout generated from a PE/PC field.

If Gr.structure is set to N, all fields within a PE group are treated as multiple value fields. Setting Gr.structure to N prevents the format buffer for Adabas from becoming very large.

Gr.structure = N can only be specified for real fields in the deepest PE group (highest level number). For example: if there are 3 PE groups in the file on level 1, 4 and 6, only the PE groups on level 6 can be marked with Gr.structure = N.

If Gr.structure is set to blank, PE/PC groups are to be generated as groups which occur n times as a whole.

Justify

R	When COBOL copy code is generated, the statement JUSTIFIED RIGHT is added for this field. Any data written to this field is then right-justified.
L	Data will be left-justified. Default.

Synchronized

Applicable to fields of format I, F or B and length 1, 2, 4 or 8.

When Assembler, COBOL or PL/I copy/include code or a record layout is generated, this field can be aligned on a half-word, word, or double-word boundary (speeding up arithmetic operations). This affects format buffer generation and the offsets of the fields in the record buffer. Slack-bytes are inserted into the record buffer by the assembler or compiler but they are built into any format buffer by Predict using space characters X.

Initialize with

Determines the initial value for generation. To be used instead of the standard value (zeros for a numeric field, blanks for an alphanumeric field).
S	blank
L	low value
H	high value
Z	zero
Q	quote
F	Fill with string specified in the parameter Init. value (mandatory). For example: if X is specified and the field length is 4, XXXX will be used for initialization.
blank	Field will be initialized with the string specified in the field Init. value. If no Init. value is specified, no initialization is performed.

Init. value

If Initialize with is either F or blank a value used for initialization of a field must/can be specified.

Length and format of the Init value must be valid for the field. For binary fields hexadecimal constants such as FB0A are valid. Hexadecimal values can be specified in two ways:

if Format=B, hexadecimal values can be specified directly. Example: F0
if Format=A, hexadecimal values must be preceded by uppercase X or H and be enclosed in single quotes. Example: X'F0' or H'F0'

Conditions

Attributes

Condition name

A value to be used when generating either equate data in Assembler copy code or a level 88 entry in COBOL copy code.

Up to 29,970 condition names can be entered. Each name needs at least one corresponding condition value. Using condition names can make logical conditions and assignments easier to handle.

Figurative constant. Valid values:
S	blank
L	low value
H	high value
Z	zero
Q	quote
F	Fill with string specified in the parameter Condition. value. For example: if X is specified an the field length is 4, XXXX is used as condition value.
blank	The string specified in the field Condition value is used.

Condition value

The length and format of this value must be valid for this field. This value must have a corresponding condition name.

Up to 29,970 condition values can be entered. If several values correspond to the same name, put the name before the first value and leave the name field blank before later values. THRU in the name field indicates a range of values ending with the value on that line and beginning with the value on the previous line.

Field Name Synonyms

graphics/one-el-synonyms.png

Attributes
Field name synonyms	Synonyms to be assigned to the field when definitions in the following programing languages are generated: Natural, COBOL, PL/I, BAL (Assembler), FORTRAN, PASCAL, ADA or C.

Adabas Security and Edit mask

Adabas security

Attributes

Adabas Edit mask

The Adabas edit mask to be used for the field. Determines how numeric fields are to be edited.
Valid values for Edit mask rules used in the COBOL programming language:
E1...E15. Edit mask is supported for compatibility reasons and for documentation purposes only. See the section Format Buffer Syntax in the Adabas Command Reference documentation for more information.
Valid values for Date-Time Edit masks:
D	Date.
T	Time.
DT	Datetime.
TS	Timestamp.
NT	Natural time.
ND	Natural date.
UT	Unix time.
XTS	Unix timestamp.
blank	None.
In Predict, fields with format D by default use Natural date (NATDATE) and fields with format T by default use Natural time (NATTIME) Edit masks. The different Date-Time Edit masks require different minimum numeric field lengths. Detailed information is given in section Date-Time Edit Mask Reference of the Adabas Mainframe documentation.

Time zone

The time zone in which a timestamp is applied. Only available for fields using one of the following Adabas edit masks described above: DT, NT, TS, UT or XTS.

Daylight saving

The daylight savings indicator can only be specified for date-time fields defined with the TZ option. Indicates whether daylight saving applies (Y) or not (N).

Security access level

The Adabas access security level of the field.

Security update level

The Adabas update security level of the field.

System field

Type of the system-generated field in Adabas. Only available for Adabas fields of type A.
Valid values:
JN	Job name. For alphanumeric fields only. Length must be 8 or greater.
OU	Open command user. For alphanumeric fields only. Length must be 8 or greater.
SI	Session ID. For alphanumeric fields only. Length must be 28 or greater.
SU	Session user. For alphanumeric fields only. Length must be 8 or greater.
T	Time. For numeric fields only.

DBMS Extensions

Applicable only to DB2 fields of type D or MT, Oracle fields of type OT and to Adabas fields of type A.

The following screen shows the options for DB2 fields of type D and MT.

graphics/one-el-baseextensions-hidden.png

The following screen shows the options for Oracle fields of type OT.

graphics/one-el-dbmsextensions_ora.png

Attributes
Use as security label	Specifies that the table column will contain security label values. A table can have only one security label column. To define a table with a security label column, the primary authorization ID of the statement must have a valid security label, and the RACF SECLABEL class must be active. In addition, the following conditions are also required: The data type of the column must be CHAR(8). The subtype of the column must be SBCS. The column must be defined with the NOT NULL and WITH DEFAULT clauses. No field procedures, check constraints, or referential constraints are defined on the column. An edit procedure is not defined on the table. Refer to your DB2 documentation for further details.
Partitioning	Indicates for each implementation of a table in an SQL server, which field controls the partitioning. Valid values:
	blank	Non-partitioning. The current field is not a partitioning key and has no index.
	T	Table partitioning key. The table is data partitioned and the current field is the partitioning key. Additionally, it may have a non-partitioned index.
	I	Index controlled key. The table partitioning is controlled by a partitioning index. The current field must have an index defined; this is indicated by descriptor type D (index), P (primary key) or F (foreign index).
	N	Non-partitioned secondary index. The field has a non-partitioned index, but it is not the partitioning key.
	P	Data partitioned secondary index (DPSI). The field has a partitioned index, but it is not the partitioning key. Within the file a different field must be defined as partitioning key.
	Q	Table partitioning key and DPSI. The table is data partitioned and the current field is the partitioning key. In addition, a partitioned index is defined for the field.
Cluster index	Only available for descriptor type D (index), P (primary key) or F (foreign index).
Cluster index	Y	The records (rows) in the DB2 table are stored in the sequence of this index. Valid for max. one index per table. A table contained in a partitioned tablespace must have one index marked as a clustered index, if the partitioning option Index controlled key is to be used.
Exclude NULL keys	Only available for DB2 fields of type D and MT. Indicates whether NULL keys are excluded.
	blank	Not specified.
	Y	Yes.
	N	No.
Partitioning key	Only available for Oracle fields of type OT. Indicates how the partitioning key is organized:
	R	Range partitioned.
	H	Hash partitioned.
	blank	None.
Partitioned index	Only available for Oracle fields of type OT. Indicates how the partitioned index is organized:
	A	Global range.
	B	Global hash.
	C	Local range.
	D	Local hash.
	blank	None.
Sort	Only available for Oracle fields of type OT. Specifies whether the rows of the cluster on this column are sorted after applying the hash function
Cluster column	Only available for Oracle fields of type OT. Specifies whether or not this field (or combination of fields in case of an SP field) is used as cluster column
Encryption	Only available for Oracle fields of type OT. Specifies the encryption method to be used:
	1	AES256
	2	AES192
	3	AES128
	4	3DES168
	blank	None.
Integrity algorithm	Only available for Oracle fields of type OT. Specifies the integrity algorithm to be used:
	S	SHA1
	N	NOMAC
	blank	None.
Salt	Only available for Oracle fields of type OT. Specify SALT to instruct the database to append a random string to the clear text of the column before encrypting it.
Include column	Only available for Oracle fields of type OT. If this column is part of the primary key, this column determines where to divide an index-organized table row into index and overflow portions.

Field Procedure

Attributes
Procedure name	Name of a field procedure (DB2 parameter FIELDPROC). See the Natural for DB2 documentation for more details.
Procedure parameter	Parameters passed to the field procedure. See the Natural for DB2 documentation for more details.

Derived Field Expression

Field expression

Applicable only to fields of type DV in files of the following types:

B	Adabas SQL views
E	DB2 views
IV	Intermediate view
JV	Ingres view
OV	Oracle view
X	General SQL
XV	Informix view
YV	Sybase view

The subquery of the file that contains the current field can specify a correlation name for any file whose fields it uses. The name of each field referenced in the expression must be qualified (preceded) by the correlation name of the file from which the field is taken, if a correlation namehas been specified for that file, or the ID of the file from which the field is taken, if no correlation name has been specified for it. The expression can include both comment lines (with /*, * or ** in the first two columns) and line comments (preceded by /*).

Example: A field which contains the annual salary:

   *
   * Field expression of a derived field
   *
   USER-TABLE1-SALARY * 12     /* SALARY FOR 12 MONTHS
   + CORRELATOR2-BONUS

Index Definition - DB2

Index fields (descriptor type D, F or P) in a file of type D (DB2 table), are defined in the tabs below.

Definition of Index / Defaults of Using-/Free-Block
Partition definitions

Definition of Index / Defaults of Using-/Free-Block

Definition of index

Defaults of using/free block

Attributes

Definition of Index

Index name

The name of the DB2 index. See Key or Index Fields in SQL Files - Superfields.

Cluster index

Y	The records (rows) in the DB2 table are stored in the sequence of this index. Valid for max. one index per table. A table contained in a partitioned tablespace must have one index marked as a clustered index, if the partitioning option Index controlled key is to be used..

Bufferpool

The buffer pool associated with the index.

Close option

Y	The data sets supporting this index are closed when nobody uses the index.

Copy

Indicates whether the copy utility is allowed for the index.
Y	Full image or concurrent copies allowed.
N	Full image or concurrent copies not allowed.

Piece size

The maximum piece size for a non-partitioned index. Valid values:

0, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304.

Reverse scans

Specifies whether an index supports forward scans only or reverse scans of the index also.
Y	Reverse scans allowed.
N	Reverse scans not allowed. This is the default.

Padded

Specifies how varying-length string columns are to be stored in the index.
Y	Padded.
N	Not padded.
blank	Not specified.

Unique where not null

Null value option. Specifies whether a null value is allowed for a unique index. Valid values:
U	Null allowed. Any two null values are taken to be unequal. If the key is a single column, that column can contain any number of null values, though its other values must be unique.
R	Not null. Any two null values are taken to be equal. For example, if the key is a single column, that column can contain no more than one null value.
blank	Determined by gener. Null value option is set via default server settings in Predict.

Compression

Specifies whether compression for index data will be used.
Y	Compression is used.
N	No compression is used. This is the default.

DSSIZE

Specifies the maximum size (in Gbyte) for each partition of a partitioned index.

Defaults of Using- and Free-Block

VSAM catalog name

Name of the VSAM catalog for the index. The parameter VSAM catalog name must be specified if data sets are already defined for the index.

Storagespace

Storagespace where DB2 defines the data sets for the index (optional). If no storagespace is specified, DB2 uses the default storagespace.

Primary allocation

Minimum primary space allocation (in Kbyte) for DB2-defined index data sets. A value specified in this field is stored only if the attribute storage group has been specified.

Secondary allocation

Minimum secondary space allocation (in Kbyte) for DB2-defined index data sets. A value specified in this field is stored only if the attribute storage group has been specified.

Erase option

Y	The DB2-defined data sets are to be erased (filled with nulls) when the index is dropped.
A value specified in this field is stored only if the attribute Storage group has been specified.

Free pages

A number from 0 to 255 which indicates that one page is to be left free each time this number of pages is used when the load operation creates index entries or when the index is reorganized.
Zero indicates that no pages are to be left free.

Percentage free

A number from 0 to 99: the percentage of each page to be left as free space when index entries are created by a load operation or when the index is reorganized.

GBPCACHE

Only relevant in a data sharing environment. Specifies what pages of the table space or partition are written to the group buffer pool. Leave this field blank or enter:
C	Changed. Only pages that have been changed are written to the group buffer pool.
A	All pages are written.
N	No pages are written to the group buffer pool.

Partition definitions

For a partitioned index (a cluster index for a table in a partitioned table space), the following tab is displayed. Each partition can then be defined in accordance with the Default values of using- and free-block (see description above).

Note:
The data displayed in this screen depend on the values selected in the Partitioning field of the DBMS extensions screen.

To define a new partition, use the New button. When you have defined more than one partition, a scroll bar is available. To go to a specific partition, use the scroll bar. To delete the currently displayed partition, choose the Delete button.

Partition definitions

Attributes
Limit value	The highest value of the index key in this partition. At least one constant must be used and as many constants as there are columns in the key can be specified. The concatenation of all the constants is the highest value of the key in this partition of the index. Note: No checking is performed here.
DSSIZE	The value of DSSIZE given in the PARTITION clause for that partition.

Attributes

Limit value

The highest value of the index key in this partition.

At least one constant must be used and as many constants as there are columns in the key can be specified.

The concatenation of all the constants is the highest value of the key in this partition of the index.

Note:
No checking is performed here.

DSSIZE

The value of DSSIZE given in the PARTITION clause for that partition.

All other attributes are described above.

Index Definition - Oracle

Index fields (descriptor type D, F or P) in a file of type OT (Oracle table), are defined in the tabs below.

Index Attributes
Index Segment
Index Storage
Partitioning Key and Partitioned Index

Index Attributes

graphics/one-el-indexattributes-ora.png

Parameters
Index attributes
REVERSE	Specifies whether the index is a reverse key index.
	Y	Yes.
	N	No.
VISIBLE	Specifies whether the index is visible.
	Y	Yes.
	N	No.
PARTIAL	Specifies whether the index is a partial index in a partitioned table.
	Y	Yes.
	N	No.
SORT	Specifies whether the index is sorted in ascending order.
	Y	Yes.
	N	No.
COMPRESSION	Specify whether or not to use compression.
	Y	Yes.
	N	No.
	A	Advanced.
	blank	Not specified. This is the default.
Compression length	Specify the compression length.

Index Segment

graphics/one-el-indexsegment-ora.png

Index segment
PCTFREE	If an integer from 1 - 99 is specified here, the clause `PCTFREE` `n` is generated in the `CREATE TABLE` statement. `PCTFREE` reserves a set amount of room in every block allocated to a table for future updates to that table's data.
PCTUSED	If an integer from 1 - 99 is specified here, the clause `PCTUSED` `n` is generated in the `CREATE TABLE` statement. `PCTUSED` specifies the minimum level of space usage that Oracle will maintain for each block of the table.
INITRANS	If a value from 1 - 255 is entered here, the clause `INITRANS` `n` is generated in the `CREATE TABLE` statement. `INITRANS` is the initial number of transaction entries that are allocated within each block.
Tablespace	If a tablespace name is entered here, the clause `TABLESPACE` name is generated in the `CREATE TABLE` statement. This name represents the tablespace in which the table will be created.
LOGGING	Specify whether or not to use the `LOGGING` clause in a `CREATE TABLE` or `ALTER TABLE` statement.
	Y	Yes.
	N	No.
	F	File system like.
	blank	Not specified. This is the default.

Index Storage

graphics/one-el-indexstorage-ora.png

Index storage
If specified, the values below are used in the `STORAGE` clause generated with the `CREATE TABLE` statement. All of the values below must be specified as integers.
INITIAL	The size of the first extent allocated when the object is created - the original amount of space allocated to the object. A value for Unit has to be applied in addition:
	K	Kilobyte.
	M	Megabyte.
	G	Gigabyte.
	T	Terabyte.
	P	Petabyte.
	E	Exabyte.
NEXT	The size of every subsequent extent to be allocated. A value for Unit has to be applied in addition. Possible values for Unit are described under INITIAL.
MAXSIZE	The `MAXSIZE` clause lets you specify the maximum size of the storage element.
OPTIMAL	Specifies an optimal size in bytes for a rollback segment.
MINEXTENTS	The total number of extents to be allocated when the segment is created.
MAXEXTENTS	The total number of extents, including the first, which can ever be allocated.
PCTINCREASE	The percent by which each NEXT extent will grow over the last extent allocated.
FREELISTS	The number of process free lists used to administer the free data blocks.
FREELISTS GROUPS	Magnitude of the set of free lists.
BUFFERPOOL	Determines the configuration of the buffer cache.
	D	Default
	K	Keep
	R	Recycle
	blank	not specified
FLASH_CACHE	Defines the configuration of a second tier of buffer cache on flash disks.
	D	Default
	K	Keep
	N	None
	blank	not specified

Partitioning Key and Partitioned Index

For a partitioning key and partitioned index, the following can be defined depending on whether they are hash- or range-partitioned.

Range-Partitioning Key Definitions
Hash-Partitioning Key Definitions

Range-Partitioning Key Definitions

Attributes
Name	The partition name.
Literal	The literal name.
Segment	Specifies the Segment attributes of the partition.
Storage	Specifies the Storage attributes of the partition.

Hash-Partitioning Key Definitions

Parameter	Description
Name	The partition name.
Tablespace	The tablespace name.
COMPRESSION	Specify whether or not to use compression.
	Y	Yes.
	N	No.
	A	Advanced.
	blank	Not specified. This is the default.
Compression length	Specify the compression length.

Default value

This additional attribute is only applicable for fields in

Sybase tables with Null value option set to R and Null default option set to Y.
Adabas D tables, DB2 tables, Informix and Oracle tables with Null value option set to R or U and Null default option set to Y.

Attribute
Default name	The default specified here is used in the CREATE TABLE statement. Sybase naming conventions apply. See Naming Conventions for SQL Objects. Note: For Sybase, a default is an object in its own right. For other SQL systems, a default value is specified in the CREATE TABLE statement (not null with default default_expression). For Informix no default name is allowed.
Default expression	An SQL expression can be specified between the angled brackets. This expression determines the default value, for example a constant or function. If specified, this value is always used by the function Generate CREATE statement.

Constraint name

Depending on the field definition, up to four constraint names can be specified.

graphics/one-el-baseextensions-hidden.png

Attributes
Check constraint	Constraint name in the respective SQL system for the fact that a linked verification of status S exists.
Primary key	Constraint name for the fact that the field is a primary key.
Unique	Constraint name for the fact that a unique constraint exists (indicated with U in column Unique option of the field object in Predict).
Null/Not null	Constraint name for the fact that the Null or Not null default option is set to Y.

Identity definition / Change log

These additional attributes are only applicable for fields in DB2 or Oracle tables.

Identity definition

The following additional attributes are only applicable for fields of type

QN (Row ID) or
a numeric field.

Identity definition

Attributes
Identity	Specifies whether the column is an identity column for the table.
As transaction ID
Generated
	Indicates whether DB2 or Oracle generates values for the column. Valid values:
	A	Always
	D	By default
	blank	None
Start with limit	The first generated value will be the highest/lowest existing value +/- increment value
Start value	Specifies the first value for the identity column.
Increment value	Specifies the interval between consecutive values of the identity column.
Cache	Specifies whether to keep preallocated values in memory.
Cycle	Specifies that values continue to be generated for this column after the maximum or minimum value has been reached.
Min value	Specifies the numeric constant that is the minimum value that is generated for this identity column.
No minvalue	Specifies for DB2 tables whether or not a minimum end point of the range of values for the identity column has been set.
Max value	Specifies the numeric constant that is the maximum value that is generated for this identity column.
No maxvalue	Specifies for DB2 tables whether or not a maximum end point of the range of values for the identity column has been set.
Order	Specifies whether the sequence numbers must be generated in order of request. Valid values:
	Y	Order
	N	No order
	blank	Not specified

Change log

The following additional attributes are only applicable for fields of type

TS (Timestamp)

Attributes

Change log

Specifies whether the column is a change log column for the table.

Generated

Indicates whether DB2 generates values for the column. Valid values:
A	Always
D	By default
blank	None

Platform Compatibilities

The following topics are covered:

No Blank Compression

No Blank Compression

This additional attribute is only applicable for Adabas fields with format A, AV or LO. The option No Blank Compression controls that trailing blanks are suppressed when a value is stored.

Identity definition

Base Extensions

The following topics are covered:

Fractional of Seconds and Time Zone
Inline Length
Generated Expression
Period

Fractional of Seconds and Time Zone

These additional attributes are applicable for DB2 and Oracle table fields with format TS.

Fractional of seconds

Attributes
Fractional of seconds	A timestamp value can include a precision of fractional seconds in the range from 0 to 12 (Oracle 0-9). For DB2, if no value is entered, the default value 6 is taken.
Time zone	Provides information on the time difference in hours and minutes between the local time and Coordinated Universal Time (UTC). Adds an additional time zone offset value to the local timestamp value in the format +HH:MM (ahead of UTC) or -HH:MM (behind UTC).

Inline Length

This additional attribute is applicable for DB2 LOB fields.

Attributes
Inline length	For BLOB, CLOB and DBCLOB columns. Specifies the maximum number of bytes that are stored in the base table space for the column. Must be between 0 and 32680 for a BLOB or CLOB column and between 0 and 16340 for a DBCLOB column..

Generated Expression

These additional attributes are applicable for DB2 table fields with formats A, AL and AV.

Generated expression

Attributes

Generated expression

For fields of DB2 tables (field types A, AL and AV) you can specify an `as-generated-expression-clause`. The value provided in Generated expression is the expression that is evaluated by DB2 when generating the value of the field. Valid values:
DC	Data change operation. Equivalent DB2 expression: `DATA CHANGE OPERATION`
CC	Client accounting. Equivalent DB2 expression: `CURRENT CLIENT_ACCTNG`
CN	Client application name. Equivalent DB2 expression: `CURRENT CLIENT_APPLNAM`
CT	Client correlation token. Equivalent DB2 expression: `CURRENT CLIENT_CORR_TOKEN`
CU	Client user ID. Equivalent DB2 expression: `CURRENT CLIENT_USERID`
CW	Client workstation name. Equivalent DB2 expression: `CURRENT CLIENT_WRKSTNNAME`
CS	Client server. Equivalent DB2 expression: `CURRENT SERVER`
CI	SQL ID. Equivalent DB2 expression: `CURRENT SQLID`
SU	Session user. Equivalent DB2 expression: `SESSION_USER`
PN	Package name. Equivalent DB2 expression: `SYSIBM.PACKAGE_NAME`
PS	Package schema. Equivalent DB2 expression: `SYSIBM.PACKAGE_SCHEMA`
PV	Package version. Equivalent DB2 expression: `SYSIBM.PACKAGE_VERSION`
blank	None.

Period

The field option Period specifies whether the value of the end column is included or excluded in the period BUSINESS_TIME.

This option can be used only for fields named BUSINESS_TIME in files of type D and MT.

graphics/one-el-period.png

Attributes
Period	Specifies whether the value of the end column is included or excluded in the period BUSINESS_TIME.
	I	Inclusive
	E	Exclusive