Segment Properties

The table below lists all properties for the particular element. Not all properties might be visible when an element is added, or an existing element is selected. Some properties only become visible when a dependent property is set to a specific value.

Property

Function

(Name)

Specifies the logical name of the selected element. The following are reserved words and cannot be used to name an element: SUPER, COMPONENT, THIS and OWNER.

Alias

An automatically generated unique name for the selected element. You can change this name, but if it clashes with an existing alias, you are prompted for another name or to cancel the name change.

AlphaClearWhenCharacter

Specifies the default clear-when character for alphanumeric attributes.

The AlphaClearWhenCharacter property is used with a persistent ispec that has a key attribute. It is used when you are changing an existing record using the UserMAINT update action of CHG.

This character needs to be a single character e.g. ‘@’. This character is used when you want to clear the value in a field of Alphanumeric type.

For example, if you want to clear the City field with Length set to 13 and the AlphaClearWhenCharacter property is set to ‘@’ then you must enter “@@@@@@@@@@@@@” into the City field during a CHG transaction.

Note: If you set the AlphaClearWhenCharacter to ‘<Space>’, then entering ‘<Space>’ during a CHG transaction will clear the value in the updated record.If you do this, it means that the functionality of a CHG action in which you only have to enter the field values you want to change will not really work, because a ‘<Space>’ value in other fields will clear them.

Author

Read-only. The identifier of the person who created the selected element.

AutomaticTab

Cursor automatically tabs to next field.

Note: This option is applicable only to the Presentation and Winform Client.

BaseYear

Specifies the year upon which the DateConvert command bases relative day numbers.

CenturyStartYear

Specifies a secondary base year to define which century a date belongs to. This is independent of the value of the Base Year.

ConvertToUpperCase

Specifies that all input are converted into upper case characters.

Created

Read-only. The date on which the selected element was created.

DateConvertSetsGLB.CENTURY

Specifies whether Glb.Century is reset by a complex DateConvert command.

DateFormat

Specifies the format of the date throughout the segment and its element. Options are UK, International, or US.

DecimalCharacter

Specifies the character to be used as a decimal place.

DefaultCursorField

Specifies the Default cursor field position, otherwise cursor positioning might be random.

DefaultFixedSettings

Specifies the default settings for background color, foreground color and font for Fixed Presentation types in Painter at the segment level. These settings can be changed for each child element individually in Painter. Expand each sub property to select your chosen setting. Refer to PresentationType Property under Defining User Interface for more information.

DefaultGraphicalSettings

Specifies the default settings for background color,foreground color, font, ScrollBars, ShowActmth, ShowHeader, and TransmitToCursor for Graphical Presentation types in Painter at the segment level. These settings can be changed for each child element individually in Painter. Expand each sub property to select your chosen setting. Refer to PresentationType Property under Defining User Interface for more information.

DefaultPrintSettings

Specifies the default settings for background color, foreground color and font for Print Presentation types in Painter at the segment level. These settings can be changed for each child element individually in Painter. Expand each sub property to select your chosen setting. Refer to PresentationType Property under Defining User Interface for more information.

Description

Specifies a short description of the selected element.

FullSuppression

Display a zero numeric value as spaces

IsResolved

Specifies whether the element exists in the model or whether it has been created during the import of an element that refers to it.

Note: This property becomes visible only when an element is unresolved, that is when it is set to false. This property can only be changed from False to True. Once an element has been resolved it cannot be made unresolved again.

IsPersistent

If IsPersistent is set to True, only Primitive or Group that is a member of the Segment is session persistent, that is, saved as session data.

Kind

Read-only. Identifies the kind of element selected.

MemberVisibility

Specifies the default visibility for new member elements. This can be overridden for individual elements.

Modified

Read-only. The date the element was last modified.

MultiByteClearWhenCharacter

Specifies the clear-when character to be used with MultiByte strings.

Note: This property becomes visible only if Internationalization Support is set to Multibyte String Support.

MultiByteStringValidation

Specifies the type of validation to be applied to MultiByte strings.

Notes:

  • This property becomes visible only if Internationalization Support is set to Multibyte String Support. When Internationalization Support is set to some other value, this property must be set to spaces.

  • To enable Debugger to emulate the MCP Kanji runtime behavior, set this property to SOK/EOK. The SOK/EOK characters in a string primitive is represented by a dummy SOK/EOK character (0xA0) for the following:

    • Extract file field

    • Screen field

    • Watch Window item

NationalString

Specifies the type of internationalization support for Single Byte and MultiByte Coded Character Sets.

The runtime subsystem allows users to make use of different collating sequences on the same single-byte Character Code Set. The national strings in a segment could use one collating sequence when a system is generated from one configure set and a different collating sequence in a system generated from another configure set.

The following options are available for this property:

  • None – Indicates that there is no international support.

  • SingleByte string support – No support for Unicode or Multibyte character sets.

  • MultiByte string support – Support for the Kanji Shift-JIS character set on Windows. Attributes defined with a Primitive setting of "NationalString" are implemented and stored in the database as Kanji (only) text coded in the Shift-JIS multibyte character set. Kanji text can also be stored within attributes defined with a Primitive setting of “String”. Note that there is currently no support for any multibyte character sets other than the Kanji Shift-JIS character set.

  • Unicode – Support for Unicode text. Attributes defined with a Primitive setting of NationalString are implemented and stored in the database as Unicode strings. Any MCP generate fails if Unicode is selected.

NumericClearWhenCharacter

Specifies the default clear-when character for numeric attributes.

The NumericClearWhenCharacter property is used with a persistent ispec that has a key attribute. It is used when you are changing an existing record using the UserMAINT update action of CHG.

This character needs to be a single digit e.g. ‘9’. This digit is used when you want to clear the value in a field of Numeric type.

For example, if you want to clear the Phone field with Length set to 10 and the NumericClearWhenCharacter property is set to ‘9’, then you must enter "999999999999" into the Phone field during a CHG transaction.

Note: If you set the NumericClearWhenCharacter to ‘0’ then entering, ‘0’ during a CHG transaction will clear the value in the updated record.If you do this, it means that the functionality of a CHG action in which you only have to enter the field values you want to change will not really work, because a ‘0’ value in other fields will clear them.

Owner

The namespace to which the element belongs.

Note: When namespace is changed, system modeler prompts for a confirmation based on the System Modeler Policies settings. Refer to System Modeler Policies for more information on System Modeler Policy settings.

ReservedBy

Read-only. The identifier of the user that currently has the selected element reserved.

An element can be reserved in two ways: Explicitly by the user or implicitly by the model when any of the documentation windows are edited.

Security

Specifies the security level for an element for this user. The AccessControlled property of the model must be set to True to provide this option.

SeparatorCharacter

Specifies the character to be used to delimit groups of three digits.

Stereotype

Specifies the stereotype which identifies how the class operates and is interpreted in the system.

SuppressZeros

Suppresses the leading zeros.

SynchronizedField

Specifies whether a control in a presentation has its height and width adjusted when the length of the contents are changed. Fixed Width indicates that only controls with fixed width fonts are synchronized.

VersionFile