Previous Topic: Update StatusNext Topic: Add Text


Update Text

You can enter free-form, unedited text as descriptive documentation when you create or add an occurrence or when you update an existing occurrence. This text can supplement the information you store in an occurrence's attribute-values. You can use the text in displays or reports as documentation for the occurrence.

Restrictions

The occurrence must be in TEST or PROD status before you can add or modify the text. If you create a new version of an occurrence, both the original and all new versions of the occurrence can share the same text. However, to modify the text, you must access the occurrence which is the original owner of the text.

If you delete the original occurrence, the next new version of the occurrence becomes the owner of the text. If different versions of the same occurrence do not share text, you must modify the text for each occurrence separately.

Format

CA Datacom Datadictionary displays and prints text in the same format as you enter it on the panel. Each line can have a maximum of either 72 characters of text with line numbers or 79 characters of text without line numbers. Enter the SET MODE NONUM command to change the space allowance to 79 characters. However, eliminating the line number prevents you from using the line command area. To reset the panel display to include line numbers, enter the SET MODE NUM command.

When adding text in batch, up to 80 columns of information are available. If you intend to use both batch and online facilities to maintain text created in batch, we recommend you use the maximum line length of 72 characters to prevent truncation of data when viewed online.

Classifications

You can add and maintain groupings of text using named classifications. This allows you to separate your text into specific categories. The default classification is STANDARD. When you upgrade from a CA Datacom Datadictionary version prior to 8.0, all text associated with occurrences is classified as STANDARD. You can change this classification after the upgrade by following the procedures described in this section.

When you delete the last line of text, CA Datacom Datadictionary deletes the text classification also.

You can also update text when you copy occurrences using the Model function online or in batch using the 1200 TEXT transactions. For more information, see the CA Datacom Datadictionary Batch Reference Guide.

When you select the UPDATE TEXT option in ENTMAINT Mode, CA Datacom Datadictionary presents a Selection Criteria Fill-in panel similar to the following:

=> => => 1-DDOL000196A - CMPP - PLEASE COMPLETE REQUIRED INFORMATION FOR COMMAND ----------------------------------------------------------------------------- DDOL Entity Maintenance Selection Criteria Fill-in T01F ...................optional........................... UPDATE TEXT : using _ ____________________________ : UPD TEX : using (A-alias) (alias name) : : (D-descr) (descriptor name) : : (P-path) (STANDARD) (S-Sqlname) : :....................................................: / ________________________________ , ________________________________ . (entity-type) (parent occurrence-name) ________________________________ ( ____ , ____, ____ ) / (occurrence-name) (stat, pswd, ovrd) (vers, pswd, ovrd) CLASS ________________________________ (text class) PF1=HELP PF2=END PF3=CLARIFY PF4=PROCESS PF5=MENU PF6=STATUS PF7=SCB PF8=SCF PF9=APPLY PF10=PATH PF11=NEXT PF12=INPUT

Fill in your specifications on the Selection Criteria Fill-in panel according to the following descriptions. Use the optional criteria box with the DISPLAY function only.

(entity-type)

Specify the entity of the occurrence you are updating. You cannot use abbreviations in this field.

Valid Entries:

An existing entity-type

Default Value:

(No default)

(parent occurrence-name)

When the entity you are selecting is FIELD, KEY, or ELEMENT, you can enter the name of a TABLE or RECORD occurrence in this field to limit your selection to the occurrences contained in a single table or record.

You can enter ALL to select all occurrences or use a generic selection of one or more of the initial characters of the name with an asterisk (*) to select several occurrences. For example, PAY* processes all occurrences of this entity-type with PAY as the first three characters in the name.

When you leave this field blank, CA Datacom Datadictionary uses the occurrence that meets the other selection criteria you enter on this panel. For more information about how CA Datacom Datadictionary returns occurrences, see the CA Datacom Datadictionary User Guide.

Valid Entries:

1- to 32-character RECORD or TABLE occurrence name

Generic selection

ALL

Default Value:

The name of the first RECORD or TABLE occurrence that meets the other selection criteria

(occurrence-name)

Specify the name of the occurrence you are updating.

Valid Entries:

1- to 32-character occurrence name

Default Value:

(No default)

(stat, or vers,)

Specify the status or version of the occurrence you are updating.

Valid Entries:

TEST
T001—T999
PROD
001—999

Default Value:

(No default)

pswd,

Supply the password for this occurrence if this occurrence has password protection against unauthorized maintenance.

Valid Entries:

1- to 4-character password

Default Value:

(No default)

(ovrd)

Supply the override code if this occurrence is restricted from unauthorized maintenance or retrieval with a lock level assignment.

Valid Entries:

1- to 4-character override code

Default Value:

(No default)

(text class)

Specify the name for the group of text to display or accept the default classification name. The system default classification is STANDARD. You can establish a session default name with the SET TEXT class-name command, where class-name is up to 32 characters. For more information, see Setting Session Default Values.

Valid Entries:

1 to 32 characters

Default Value:

STANDARD

Text Maintenance Panel

After completing your entries, press Enter. If there are no errors, CA Datacom Datadictionary displays a Text Maintenance panel similar to the following:

=> => => ----------------------------------------------------------------------------- DDOL: ANCHORED OCCURRENCE FOR TEXT MAINTENANCE TYPE OCCURRENCE STA VER BAS ORDER-ENTRY P 003 -------------------------------------------------------------------------T05U Text Maintenance Class STANDARD ====== ========================== T O P ======================================= 000001 The Application Demonstration System is a generic representation 000002 of a customer order-entry system as it may appear in the business 000003 world. 000004 The overall system is designed modularly so that it may be enhanced 000005 without adversely affecting the basic design of the system. Modularity 000006 allows the system to be expanded or enhanced for demonstration purposes 000007 or for the actual use of the system in a production environment. The 000008 ORDER-ENTRY database consists of nine tables, each of which has 000009 minimally a primary key. The database, as it is conceptualized, is 000010 fully normalized. The actual physical database is a one-for-one PF1=HELP PF2=END PF3=CLARIFY PF4=PROCESS PF5=MENU PF6=STATUS PF7=SCB PF8=SCF PF9=APPLY PF10=PATH PF11=NEXT PF12=INPUT

When the display is longer than the screen, you can use the scroll commands or PF keys to move backward and forward through the display.

The panel displays the text and the text classification previously requested for the occurrence. If no text has been defined for the anchored occurrence, you see the message OCCURRENCE HAS NO ASSOCIATED TEXT and one blank line to add text. For more information and a complete list of the commands you can use on Text Maintenance panels, see Line Commands.

The panel also illustrates the session status of SET MODE = NUM which lists line numbers to the left of text.