Skip to content
CA Datacom Tools - 15.1
Documentation powered by DocOps

CA Ideal for CA Datacom Commands

Last update March 9, 2017

This documentation describes the commands used in the CA Ideal™ for CA Datacom® environment. It includes the syntax and a description of each command. The commands are divided into two sections:

  • Primary commands, such as OFF and DISPLAY, are entered on the command line or executed from a member.
  • Editing commands, such as MOVE and CHANGE, are entered on the command line of a display being edited. Editing line commands, such as CC and MM, are entered in the sequence number area of a display being edited.

More information:


This page contains the following topics:

Notation Conventions

This documentation uses the following rules and special characters in syntax illustrations.

Enter exactly as shown in command syntax:

Notation Description of use
UPPERCASE Identifies commands, keywords, and keyword values that you must enter exactly as shown or replace it with an authorized abbreviation.
symbols You must enter all special characters, such as parentheses and quotation marks (but not ellipses, brackets, and braces) as shown.

Do not enter the following as shown; notations clarify command syntax:

Notation Description of use
lower case italics Represent a value you must supply.
Brackets [ ] Identifies optional keywords or clauses, or a group of options from which, if included at all, you must make a choice.
Braces { } Enter one of the keywords or clauses.
Underlining Indicates a CA Ideal default that you cannot change with a SET command and, therefore, you do not need to specify.
Ellipses ... You can repeat the preceding word or clause.

Example

This example shows syntax format of CA Ideal™ for CA Datacom® commands.

COMmand keyword1={AAA} [keyword2] [keyword3={CCC     }]     

                 {BBB}            [         {xxxxxxxx}]

  • COM
    Initiates the command. COM is an abbreviation.
  • keyword1=
    Designates a required keyword followed by a choice of required values. You must specify one and only one of these values.
  • keyword2
    Specifies an optional keyword.
  • keyword3=
    Designates an optional keyword followed by a choice of values, one of which is required if you specify the parameter.
  • CCC
    Designates a default value for keyword 3. If you do not specify the keyword, the product uses this value.
  • xxxxxxxx
    Indicates that you can specify a value according to the instructions in the keyword description following the syntax diagram.

Using Abbreviations for Commands

This section lists abbreviations for commands used in CA-Ideal.

Standard Abbreviations

The standard abbreviation for a command or command option is the first three characters of the word. For example, the standard abbreviation for the COMPILE command is COM. All SCF commands (SET CMD xxx) check only the first three characters of the operand following the SET CMD. Anything entered beyond that point is ignored.

Alternate Abbreviations

For some commands and options, CA Ideal™ for CA Datacom® also accepts alternate abbreviations. For example, in addition to BAC, the abbreviations BACK and BWD are accepted for BACKWARD.

Command/Option Exception Alternate
BACKWARD (none) BACK, BWD
HEADER HDR  
POSTMSG MSG  
TRAILER TRL TRLR

Abbreviation Exceptions

There are a number of exceptions to the standard first three-character abbreviation. These exceptions are abbreviations for command words whose first three characters are not unique and, therefore, would conflict with an abbreviation for another command. Other abbreviations (or no abbreviation at all) are used.

For example, the COMBINE command does not have a three-character abbreviation. The COMMAND option accepts the abbreviation CMD only:

Command/Option Exception Alternate
COMBINE COMBINE (none)
COMMAND CMD (none)

Allowable Abbreviations

CA Ideal™ for CA Datacom® keywords are only validated to the point where it can be determined that they are unique. Anything entered beyond that point is ignored.

For example, the command SET SITE ASYNCMSG recognizes the values N for NONE and U for USER. However, values such as NO, NON, NOOOO... are also accepted for NONE, since it was already determined from just entering “N” what the value really is. Everything entered beyond that point is disregarded. The same holds true for USER. Since “U” was already identified as USER, values such as US, USE, USEEEE... are also acceptable.

Summary of Command Abbreviations

Because most abbreviations are standard, they are not shown in the syntax illustrations. The following list shows command abbreviations that are either exceptions to the standard abbreviation or are alternatives available in addition to the standard abbreviation.

Command/Option Exception Alternate
AUTHORIZATION   AUTH, ATZ
BACKWARD   BACK, BWD
BLANKFILL   BLK, BLANK, BLANKS
BOTTOM   BOT
CATALOG   CATLG
CHANGE   C
COLUMNS   COLUMN
COLVIEW   COL
COMBINE COMBINE  
COMMAND CMD  
COMMENT COMMENT  
CURSOR-STABILITY CS  
DATAQUERY DQ DQRY
DATAVIEW   DVW
DATEFORM DATE  
DEBUG   DBUG
DELIMITER DLM DELIM
DESCRIPTION DESC  
DESTINATION DEST  
DISPLAY   D
DISPOSITION DISP  
EDIT   E
EXCLUDE   EXCL, EXCLUDING
EXECUTE   EXEC
EXECTIME EXEC  
EXPORT    
FIELD   FLD
FIND   F
FORWARD   FWD
FULL   F
HEADER HDR  
HELP HELP  
HISTORY   HIST
HORIZONTAL   HOR
IDENTIFICATION   IDENT
IMPORT   IMP
INCLUDE   INCL, INCLUDING
ISOLATION-LEVEL   ISOLATION
LEFT (in SET EDIT)   L
LINES   LINE
MAIL MAIL  
MESSAGE   MSG
NAMES   NAME
NO   N
NOHEADING   NO
NOVALIDATION   NOVAL, NOVALID
NULLFILL   NUL, NULLS, NULLFIL
OFF OFF N, NO
ON ON Y, YES
OPTIONS   OPTION
PACKAGE PACKAGE, PKG  
PACKLIST PACKLIST, PKL  
PAGE   PAGES
PANEL   PNL
PARAMETERS   PARAMETER, PARM, PARMS
PASSWORD   PSW
POSTMSG MSG  
PREPTIME PREP  
PREVIOUS   PREV
PROCEDURE PROC  
PROCESS PROCESS  
PRODUCTION PROD  
PROGRAM PROG PGM
REPEAT REPEAT  
REPORT   RPT
RESHOW RESHOW  
RIGHT (in SET EDIT)   R
ROLLBACK   ROLL
SCREEN SCREEN  
SHORT   S
SIDEVIEW   SIDE
TRAILER TRL TRLR
USER   U, USR
VALIDATION   VALID
VERIFICATION   VERIFY
VERSION   V
VERTICAL   VER
WAITTIME WAIT  
WIDEOPTION WIDE  

Using Version Clauses in Commands

There are some rules that apply when specifying version clauses in CA Ideal™ for CA Datacom® commands. Following is a description on version clauses and how to use them.

For SQL Dataviews

Only one version is assigned; version 1 in production status. CA Ideal™ for CA Datacom® generally does not display this version number or status or require that the user specify it.

For All Entity Types Except Modeled and SQL Dataviews

Each named definition of a given type can exist in one or more forms, called versions, each of which is identified by a number assigned by CA Ideal™ for CA Datacom®. There can be as many as 999 versions with the same name. CA Ideal™ for CA Datacom® assigns numbers to versions sequentially as they are created, starting with number 1. The application developer cannot modify version numbers.

For CA Datacom®/DB Dataviews and Sequential File Dataviews Modeled in the Dictionary

CA Ideal™ for CA Datacom® assigns numbers to test versions separately from production and history versions. Test versions are identified as T1 through T999. Production and history versions are identified as 1 through 999.

Editing a definition has no effect on the version number. No matter how many changes are made, the version number remains the same. You can only create new versions with the same name by using the DUPLICATE...NEXT VERSION command. This command makes a copy of an existing version. CA Ideal™ for CA Datacom® assigns each new version of a definition the next higher number than the highest previously assigned number. When a version is deleted from the system, unless it was the highest, its number is never reassigned to another version with the same name.

Each definition is uniquely identified by the combination of its type, name, and version number, and can always be referenced by this combination.

There are three cases when you can reference a particular definition without using the version number:

  • You can reference the production status version of a definition by replacing the version number with the term PROD (since there can be only one production version at a time).
  • For any type of definition except for an SQL dataview definition, you can reference the most recently created version of a definition by replacing the version number with the term LAST.
  • The version clause is optional when specifying PROD or LAST. For example, if the production version of a report definition named SALARIES is version 5, you can reference it as REPORT SALARIES VERSION 5 or as REPORT SALARIES VERSION PROD. If there are seven versions of a program named UPDATE (numbered 1 through 7), you can reference the most recently created version as PROGRAM UPDATE VERSION 7 or as PROGRAM UPDATE VERSION LAST.

The following is a description about usage of version clauses:

  • Status
    Each version is assigned to a category that is based on the stage it reached in the production process. This category is called the status of the version. A version can be in test status, production status, or history status. Except for dataview entity types, you can only change the status of a version with the MARK STATUS command.
    The following rules apply to each type of status:
    • Test
    • For all entity types except modeled and SQL dataviews: When a version is created in CA Ideal™ for CA Datacom® by either the CREATE or DUPLICATE command, the version is in test status. You can modify a version as long as it remains in test status. There can be many versions in test status at one time. If a dataview is edited, you must recatalog it before it can be reused.
    • For CA Ideal™ for CA Datacom® dataviews and sequential file dataviews modeled in the dictionary: Test versions are created and maintained in the dictionary. There can be up to 999 test versions at one time.
    • SQL dataviews can not be in test status.
    • Production
      When a version is created, edited, and tested, and is ready for use in an application, it is marked to production and becomes the production version. Only one version of a definition can be in production status at a time. 
      A production application must consist of components that are also in production status. This protects its integrity.
    • For all entity types except modeled and SQL dataviews: You cannot edit or delete the production version. If a production version of a program is compiled, a compilation listing is produced; a new object program is not created.
    • For SQL dataviews: There can be only one version of a definition at a time, version 1 in production status. SQL dataviews are created through the CA Ideal™ for CA Datacom® CATALOG command. You can delete them if they are resources of production programs. You cannot edit them.
    • History
      History versions of a definition are former production versions of that definition.
    • For all entity types except SQL dataviews: Marking a test version to production automatically retires the existing production version, if any, to history status.
    • SQL dataviews can not be in history status.
      The maximum number of history status versions that you can save is recorded in the dictionary (as the ENTY-HIST-VERS attribute of the TABLE entity in the DATA-DICT database). When this number is exceeded, the oldest history versions are automatically deleted. You can modify the installed default of three history versions.

Using String Delimiters in Commands

The character used to delimit strings in CA Ideal™ for CA Datacom® commands is shown as either an apostrophe (') or slash (/). You can use any special character as a string delimiter in a command except:

  • The currently defined command delimiter; semicolon (;) is the installed default.
  • The currently defined comment character; colon (:) is the installed default.
  • Asterisk (*).

National characters - In the USA, these are:

  • At sign (@).
  • Pound sign (#).
  • Dollar sign ($).

You must use the same character consistently to delimit strings in a command.

To display the currently defined command delimiter character and comment character, use the DISPLAY SESSION OPTIONS command.

Using an Asterisk to Represent the Current Entity

Many CA Ideal™ for CA Datacom® commands allow the use of an asterisk (*) to represent the current entity. For example, after editing a program, the command

COMPILE *

will compile the same program.

The current entity is shown at the top of the panel.

=>                                                                            
=>                                                                            
=>                                                                            
                                                                              
-------------------------------------------------------------------------------
DIDA : PROCEDURE DEFINITION  PGM SCROLLER (003) PROD         SYS: $ID   DISPLAY
                                                                              
Command....+....1....+....2....+....3....+....4....+....5....+....6....+....7..
====== ================================ T O P =================================
000010 <<SCROLLER>> PROC                                                      
000020 :======================================================================:
000030 :                                                                      :
000040 :  Display all ITEM records and allow their update.                   :
000050 :                                                                      :
000060 :       This sample program is designed to show how to scroll data     :

Command Reference

Following are the CA Ideal™ for CA Datacom® commands:

Was this helpful?

Please log in to post comments.