Ap11 600
Ap11 600
Control Language
Advanced Process Manager
Data Entry
AP11-600
Release 640
12/02
Notices and Trademarks
Copyright 2002 by Honeywell International Inc.
Revision 5 December 6, 2002
While this information is presented in good faith and believed to be accurate, Honeywell
disclaims the implied warranties of merchantability and fitness for a particular purpose and
makes no express warranties except as may be stated in its written agreement with and for its
customers.
In no event is Honeywell liable to anyone for any indirect, special or consequential damages.
The information and specifications in this document are subject to change without notice.
Contacts
Corporate http://www.honeywell.com
Industry Solutions http://www.acs.honeywell.com
International http://content.honeywell.com/global/
Telephone
Contact us by telephone at the numbers listed below.
Honeywell International
Industry Solutions
16404 North Black Canyon Highway
Phoenix, AZ 85053 – 3095
1-800 343-0228
This publication supports TotalPlant Solution (TPS) System network Release 640.
TPS is the evolution of TDC 3000X.
Creating CL/APM source files, and entering and editing data in the source files
Using the Engineering Personality's Utilities to manage and manipulate files related to
CL/APM
Using the CL/APM Compiler commands and options that are part of the COMMAND
PROCESSOR activity on the Engineering Main Menu
1 INTRODUCTION .......................................................................................................... 1
1.1 WHO THIS PUBLICATION IS INTENDED FOR ...............................................................................1
1.2 HOW TO USE THIS PUBLICATION .................................................................................................1
1.3 RELATED PUBLICATIONS ...............................................................................................................2
5 COMMANDS .............................................................................................................. 19
5.1 USING UTILITY COMMANDS IN CL/APM DATA ENTRY ...............................................................19
5.2 USING TEXT EDITOR COMMANDS IN CL/APM DATA ENTRY.....................................................21
5.2.1 How to Create a CL/APM Source (.CL) File...............................................................................21
5.2.2 How to Copy a File, Edit it, and Store it in a New File................................................................21
5.3 CL/APM COMPILER COMMANDS...................................................................................................22
5.3.1 Compiler Command Descriptions ..............................................................................................22
5.3.2 How to Invoke Compiler Commands .........................................................................................27
5.4 HOW TO USE COMMAND FILES....................................................................................................30
Before using the procedures in Sections 3 through 5 of this publication, you should review the
publications mentioned under 1.3.
The following are publications that contain reference information related to CL/APM data entry,
or provide procedures that are related to CL/APM data entry.
Control Functions—This is a set of two publications, one that covers data acquisition
and control functions that are independent of the nodes that participate in the functions,
and one for APMs.
Use this section to determine what must be available to install or to change CL/APM programs, and what
startup tasks must be completed.
You can create CL/APM source files, enter data in them, and edit them at any time the Universal
Station's Universal Personality or Engineering Personality is loaded. CL/APM programs can be
compiled and loaded ONLY after configuration and loading of APMs (System Startup Task 32)
is complete. See the Tasks shown in the System Startup Guide for further information.
CL/APM data entry consists of creating source files, compiling them, and loading them into
APMs, where they will be executed.
A sequence program (the .NO object file, which must be on Volume &Enn—refer to heading
3.2.2) is loaded into an APM Process Module Data Point (a sequence slot in the APM) from the
Process Module Detail display in the Universal Station's Process Operator Personality. To load a
CL/APM program, at least one US must be running the Operator Personality, so System Startup
Task 30 must be completed.
With R640, the SEQCMD command can be used to load the sequence program into an APM
Process Module point using the Command Processor. For a detailed description of this
command, refer to the Command Processor Operation Manual.
You will store your CL/APM source files on user-volume removable media (floppies or cartridge
disks) or in user volumes on a HM. The CL Compiler creates listing files, error-listing files, and
object files on the volume that contains the source file (Table 2-1 lists all of the volumes used in
CL/APM data entry). You will find it easier to use the HM.
Whether you use removable media or the HM, you must configure one or more user volumes
with sufficient capacity to store all of your source files and the Compiler-generated files.
Unless you create an unusually large number of CL programs, the CL user volumes will be much
smaller than those that contain IDFs with DEB-built entities. Guidelines for estimating the size
of CL-user volumes are provided under 7.2 in the Engineer's Reference Manual.
All of the activities described in this publication take place at a Universal Station with the
Engineering Personality running. To begin any of these activities, the Engineering Main Menu
must be on the screen. To load the Engineering Personality and to get the Main Menu on the
screen, you can use Task 2 of the System Startup Guide, or refer to the Engineer’s Digest (pocket
guide).
Table 2-1 lists all of the volumes and files involved in installing and changing CL/APM
programs. These volumes should be available on a HM or on removable media, as needed. It is
easier to have them on a HM, so mounting and dismounting disks isn't necessary.
Table 2-1 — Volumes and Files Used in Installing and Changing CL/APM Programs
File Name
Volume and Suffix Use
Note: CL is a user volume that can have any user-defined name. "CL" is the default name
that appears on the Modify Default Volume Path Names display. You can change the
name on that display to the name of your user volume.
CL data entry requires a Universal Station that has an Engineer's Keyboard. It's useful to have a
printer connected to the US so that you can make printed records of your work. If you are using
removable media, the US should have two drives connected to it, so that the transfers will be
faster than if they have to go over the LCN.
Execution of any command that can change the system database or the process database requires
the key switch on the Operator Keyboard to be in the ENGR position. It is simpler to check the
switch when you start a session and leave it in ENGR until you are finished.
It is very helpful to have another Universal Station in the same console with the Operator
Personality running. You can then look at the detail displays for the points associated with your
CL/APM programs, to verify that parameter values mentioned in this publication are as
described, and to see the effects of your work.
It is better to have one or more user volumes for your CL/APM files (see Table 2-1) on a HM
(Startup Task 10) and to have the complete software complement on a HM (Startup Task 16). If
you use removable media, use one user volume for all CL/APM files, and mount and dismount
disks, as needed. For example,
When using the Text Editor or Utilities, &OV1 should be in one drive and your user
volume in the other.
When you enter CL from the COMMAND PROCESSOR to use the CL Compiler,
&OV2 should be in one drive and your user volume in the other.
Before you begin any activity on the Engineering Main Menu, you should select SUPPORT
UTILITIES and check the Modify Default Volume Path Name display to see that the correct
sources ($Fn or NET) and the correct volume names are entered. If not, change and then press
ENTER.
A. The APM Node Configuration must be built and loaded (System Startup Task 32). This
entity must specify a nonzero number of process module slots to be able to run sequences.
B. Because the CL/APM program will add the sequence name to the NIM Library, there
must be enough space left in the first 1000 names.
C. The Process Module Data Point, to which the sequence will be loaded, plus any other data
points that the sequence references by entity name, must be built and loaded.
A. The APM that will receive the CL/APM program must be loaded and running with the
Process Module state of OFF. Any APMs that contain Data Points that are referred to by
the CL/APM program should be in OK state in order to avoid run time errors.
B. There must be sufficient sequence memory in the slot to accept the CL/APM program.
C. The preparations described under 3.2.2 must be completed; this includes ensuring that the
.NO (object file) is in volume &Enn, where nn = UCN number the APM is on (UCN
number of the bound data point).
Typical CL/APM data entry sessions are described in this section for these two reasons:
To define the order in which we recommend you accomplish the major steps.
Use the following major steps to install a CL/APM sequence program or to change one.
HM/AM/CM GDF CL SOURCE/OBJ PICTURE EDITOR LBC OVERLAY FIND NAMES OVLY
Path Names Display, check that NET>&AMG>
AREA DB GDF
NET>CL>
CL PARAM LIST
NET>&OP2>
FFL OVERLAY
NET>&OP1> NET>&OP4>
CL CUSTOM GDF
NET>CL> NET>&OP1> NET>&OP4> NET>&OP4>
USER DEFLT PATH BUTTN DFG OVRLY CONFIGURE OVRLY GENERIC OVRLAYS
NET>CDSG> NET>TEST> NET>&OP1> NET>&OP1> NET>&OVG>
volumes are correct NIM GDF KEY FILE VOLUME SMCC OVERLAY TAC SUPPORT OVL
NET>&NMG> NET>&KFO> NET>&OP2> NET>&OP5>
(see Table 2-1): NIM GDF
NET>&NM2>
EXT LOAD MODULE
NET>&CUS>
DOC CTL DIR
NET>&DOC>
TEMP FILE DIR NCF BACKUP PATH
NET>&TFIL>
CL OVERLAY
examples; $F1>&OV2>
or NET>&OV2>
If necessary, correct the pathnames and press ENTER. The display reappears with all
pathnames in blue.
If you are using removable media, just before you enter CL from the COMMAND PROCESSOR
display, mount &OV2 in the drive indicated by its pathname. Once the compiler overlay is read in, you
no longer need the &OV2 disk/diskette.
CL Source
File
2982
(filename).LS NIM
Process Module
Data Point
(uppssiii).NO PMM
Sequence
Where (filename) is the name of your Memory
source file and (uppssiii) is the object 6277
u is the UCN number of the bound data point (because only one digit is provided,
UCNs 10 through 20 are represented by the alphabetic characters A through K)
pp is the APM number of the bound data point (1-64)
ss is the sequence slot number (1-160, where A0 = 100, B0 = 110, . . .and G0 = 160)
iii is the sequence name index (2-999) in the NIM library
Printer 2984
uppssiii.NO
Process
7. Prepare to load the .NO object Process Operator
Load Personality
file according to 3.2.2 (the .NO file Module
Detail Display
must be in volume &Enn), then
load the program through the
Process Module display in the NIM
Process
US On Process Personality. Module
Data Point APM
Sequence
Memory
6279
The NIM maintains one sequence library for all sequences on its UCN. The library consists of
1000 entries of 8-character strings. All process modules in a NIM use the same library. The
library is initialized to all blanks at initial NIM startup.
For CL/APM, the strings listed in the following table must be defined in the NIM library of the
APM of the bound data point:
Entry 1 always contains blanks (used in displays as the step name for any phase, subroutine or handler
without a step).
Let the CL Compiler do it automatically by selecting the –UL compile command option.
If you compile without the –UL option, a .LE file is generated that lists needed words not
found in the NIM library. Note that the –UL switch enters names into the library only on
a clean compile. If there are compilation errors, names are not added.
CAUTION
Once a compilation that uses the NIM library has been run, it is best to use caution if changing entries in
the library by the second method (using the DEB). Changing entries could cause the display of wrong
sequence names. If you must make changes, you should repeat all compilations that use the library, to
ensure that all names are correct.
• Use the DEB to key words into the NIM Library entity. You reconstitute the library by
specifying $NuuLIBn, where uu = UCN number and n = 1 (for first 1000 entries). Once the
library is reconstituted, you can key in new words or change words, and then reload; or you
can build a fresh version, initializing all words to all blanks as follows:
The CL/APM object file(s) (.NO) must be available on a volume whose name is &Enn, where nn
is the UCN number. There are two ways to make such a volume available:
• Use the Engineering Personality's Command Processor's Create Directory command to create
the directory &Enn on the user volume that has your .NO file, on another user volume, or on
a disk/diskette.
• In System Startup Task 10, configure a "CL/APM UCN" volume for each UCN needing a
download volume.
End of Slot
Slot n + 1
Start of Slot n+1
Slot n
Start of Slot n
Slot 2
Start of Slot 2
Slot 1
Use the Engineering Personality's Command Processor's Copy or Move command to copy/move
your .NO file to the &Enn volume or directory. This volume/directory could be used to store
your tested (debugged) CL/APM programs, keeping them separate from untested CL/APM
programs on your user volume.
The size of each sequence slot is stored in parameter SEQSLTSZ in the Process Module
data point. The total of all the sequence-slot sizes in the APM cannot exceed the
available sequence memory. If a sequence program is larger than its configured slot size,
it cannot be loaded.
The location in memory where a sequence begins is determined by the sum of all of the
preceding slot sizes.
You can increase or decrease a sequence slot size on-line without affecting other already
loaded (or running) sequences as long as the total memory for the box is not exceeded.
CL/APM structures can be moved from one LCN-based TotalPlant Solution (TPS) system to
another, only in CL/APM source file form. Object files and IDFs contain internal representations
of names that apply to only the system they were created on; specifically,
Data points in the destination system must be built using the DEB's Exception Build
command.
CL/APM source files must be recompiled on the destination system, with the associated
Process Module data points and NIM Sequence Library entities (see 3.2.1) loaded in the
NIM(s) in the destination system.
It is likely that before you do any of these activities you will need to edit the CL/APM source
files on the destination system, to change point names and to tailor the source file for the
destination system.
Use this section when you don't know or are not sure of the effect of pressing a key on the Engineer's
Keyboard.
The Engineer's Keyboard is required for interaction with the Engineering Personality's Utilities,
Text Editor, and CL/APM Programs activities. Most of the keys function as you would expect.
Figure 4-1 clarifies the functions of several of the keys.
Several keys have dual functions and dual markings—symbols on the top of the key and other
symbols on the front edge of the key. The secondary function, indicated on the front edge of
these keys, is obtained when one of the two CTL keys is held down while the function key is
pressed.
The generic-function keys, F1 through F12, are used to execute Text Editor commands, as
described in Section 3 of the Text Editor Operation manual. These keys are not used in the
Utilities and CL/APM Programs activities.
The color and behavior keys (BKGND, BLINK, INTEN, WHT, BLK, CYAN, BLUE, MAGN,
RED, YEL, GRN) don't operate with the Utilities, Text Editor, and CL/APM Programs activities.
Go to the previous
page of this display
Go to the next page
of this display
Clear this port
Go to the next Parameter Entry Display in this set
Clear support display or Help display for
F1 thru F12 are generic temporary info on display this pick or port,
function keys (see 4.1) or Parameter
PAGE ! " # $ % & ' ( ) = Entry Display help
PAGE 0 DEL ERASE 7 8 9
BACK 1 3 4 5 6 7 9 — HELP
FWD 2 8
DISP DISP F1 F2 F3 F4 F5
F5 F6
F6 F7 F8
F8 F9 F10 F11 F12 MENU BKGND BLINK Engineering
DEL ` {
LINE
INS CAPS
Q W E R T Y U I O P
@ [ ESC CANCEL 4 5 6 Personality
LINE LOCK
CENT WHT BLK Main Menu
DEL INS SHIFT + * }
A S D F G H J K L RETURN CLR-ENT 1 2 3
CHAR CHAR LOCK ; : ]
HOME PRT SCN CYAN BLUE MAGN
SHIFT Z C V N SHIFT LF 0 —
X B M . COMND
\ , /
GRN
Entry Display
CUR BREAK RED YEL
data or execute
TAB TAB TAB
CTL CTL SELECT ENTER this command
CUR CUR CUR
An overview of Text Editor and Utilities commands that are related to CL/APM data entry (see 5.1
and 5.2).
Section 3 describes how these commands are used to install and to modify CL/APM programs. Section 6
provides guidelines for recovering from errors indicated as the Compile commands are executed.
The default-volume pathnames and utilities are used in CL/APM data entry. The Modify Default
Volume Pathnames display is called up by selecting the SUPPORT UTILITIES pick on the
Engineering Main Menu and then selecting MODIFY VOLUME PATHS on the Support Utility
Menu. Alternatively, you can select the COMMAND PROCESSOR pick on the Engineering Main
Menu, and then type SP and press ENTER. The utilities are called up by selecting the
COMMAND PROCESSOR pick on the Engineering Main Menu.
The following are the functions that you will probably use most in CL/APM data entry
(command-file utilities Execute Command, Prompt Out, Pause, and End are described under
5.4):
Instructions for calling up the Modify Volume Pathnames Display are in the Command
Processor Operation manual. Instructions for changing the default pathnames are in
Section 6 of that publication.
Copy—Used to copy a file or files from one volume to another, or on the same volume.
We recommend that you copy all of your files to removable media, in case a file is lost or
damaged. The Copy and Copy Volume commands are described in the Command
Processor Operation manual.
List Names—Used to list the attributes of a volume and its files. You can use this
command to determine if specific files are in a volume, the time and date they were
created, their size, and other information. For your records, you might want to use the
Data Out command to direct the list to a printer as well as to the screen. The List Names
command is described in the Command Processor Operation manual.
DO $Pn
and press ENTER. In this command, n is the printer number (which is available on the
Console Status Display). To direct that the output is to go to only the screen (this is the
default situation), key in DO and press ENTER.
Print—Used to display or to print the content of a file. Use this command to look at
your listing (.LS) and error (.LE) files. This command is executed directly from the
COMMAND PROCESSOR. Key in a command as in this example:
PR NET>CL>VLR_CALC.LE
and press ENTER. When the whole content of the requested file has been displayed,
"Print Complete" appears at the bottom of the display area. If a Data Out command has
also directed the output to a printer, the content of the file is simultaneously displayed and
printed.
Delete—Deletes a file from a volume. If you make changes to CL/APM source files, you
may want to copy the original file to a file with a slightly different name, make the
changes in the new file, install those changes, test them, and when the modified structure
is operating properly, delete the original file. For example, you might name your original
file CALC1 and the new file CALC2. When CALC2 is compiled, installed, and
successfully running, you could delete CALC1. The delete command is described in the
Command Processor Operation manual.
The following procedures describe the Text Editor functions you will probably use most
frequently in CL/APM data entry. For more detailed descriptions of Text Editor functions, refer
to the Text Editor Operation manual.
1. You access the Text Editor by the COMMAND PROCESSOR pick on the Engineering Main
Menu display.
2. Key in "ED" followed by the pathname for the file to be created. Be sure to include the .CL
suffix. For example,
ED NET>CL>CALC1.CL
3. Press ENTER. A blank Text Editor display appears, ready for you to key in your source-file
information.
4. Key in your source file. The form and content of source files for all CL structures are in the
Control Language/Advanced Process Manager Reference Manual.
5. After you have keyed in and visually checked your entire source file, end the Text Editor
session by pressing LF, then E, and RETURN (or CTL F1 followed by CTL F2). The source
file is transferred from the Text Editor's temporary file to the user volume that you named in
step 2, and your source (.CL) file is now ready to compile.
5.2.2 How to Copy a File, Edit it, and Store it in a New File
Often, you will use several similar CL/APM structures, and you can save time by copying a
source file, editing the copy, and storing the result in a new file.
1. You access the Text Editor by the COMMAND PROCESSOR pick on the Engineering Main
Menu display.
2. Key in ED followed by the pathname for the file to be copied. Be sure to include the .CL
suffix. For example,
ED NET>CL>CALC1.CL
4. Edit the copy of the file that is now on the Text Editor display to make the changes that are
needed in the new file. When you finish, leave the cursor on the first character you want in
the new file.
6. Hold CTL and press F1. A prompter appears that asks for the pathname for the new file.
7. Key in the pathname of the new file and press ENTER. Here is an example of the pathname:
CALC2.CL
8. Hold CTL and press F3. A prompter appears that asks how many lines to output. If you want
to store the whole file, key in 9999 (this is more lines than the largest file); otherwise, key in
the number of lines you want to store in the new file.
9. Press ENTER. You now have two copies of the file, the original one that you copied and the
new one that you named in step 7. In this example, they are both on the same volume. If a
different volume is needed, precede the filename in step 7 with the entire name of the
required path.
The CL Compiler commands are available through the COMMAND PROCESSOR pick on the
Engineering Main Menu. The Compiler reads CL/APM source (.CL) files and creates object
files from them. Object files contain the CL/APM structures in the form that is executed by the
destination node. The object files are loaded into the Advanced Process Manager Module in
which the bound data point resides.
2989
For CL/APM, only the Compile command can be executed from this display. Execution is
requested by keying in the command line with any options and pressing ENTER.
Compile—Compiles CL/APM source files, creating object and listing files, or if errors
are detected, an error file. Form:
CL (filename) -(options)
The source file must have a .CL suffix, but use of the suffix in the compile command is optional.
NOTE
The remaining three commands shown on the screen (Link, Unlink, and Compile and Link) apply only
to CL/AM programs. CL/APM programs are not linked by the Link command. They are loaded from
the Process Module Detail display in the Universal Station's Operator personality. See the Process
Operations Manual and section 3.2.2 of this document.
The following options are available for the Compile command. The options are requested by
keying in "–" followed by the option name for each option. More than one option can be
included, and each is separated by a space. For example, a command line that requests several
CL/APM options would have this form:
NOTE
The CL compiler will accept multiple instances of any option in a single command line. The only
cases where this matters is with the -UI and -OPT options since these are the only options with
modifiers. For these options, if multiple instances occur, the final instance is used.
-D (or -DEBUG)
No Warnings—Do not list notes and warnings in .LE or .LS files. Form:
No Listing—Do not generate a full listing file (.LS); list only error lines. Form:
The -NL option automatically causes the -NX option to be selected; therefore, the
CL/APM cross reference is omitted from the listing and both -NL and -NX are displayed
as selected options at the bottom of the listing.
No Cross Reference—Omit printing the CL cross reference (symbol table) at the end of
the listing. Form:
Override Equipment List Name—Overrides the device name and volume name
specified in an %INCLUDE_EQUIPMENT_LIST statement and/or the User Default
Path. Form:
Unit Instance Only—Only the one specified unit instance of an included Equipment List
will be compiled. Form:
Optimize Object Generation—For any unit instance in an included Equipment List for
which compatibility is maintained, no new object file is created. Compatibility is
maintained when there has been no change to alias names or their data types for a unit
instance since the previous compilation (established by a comparison of the time stamps
in the source and existing object files). If the -UI option also is used, only the selected
unit instance can be affected. Thus, if compatibility of that unit instance is maintained,
an object is not created. Form:
-UPGAPM
The heap expansion option requires software release R410 or later, Universal Personality, and a
Universal Station with a minimum of 5 Megawords of memory. (Without the heap expansion option,
the minimum memory size for a Universal Station with Universal Personality and R410 software is 4
megawords.)
If the requirements in the caution box above are met, you can use the heap expansion switch
(option) to provide more heap memory for CL compilations. This option can be especially
useful in compiling large CL programs that use the Equipment List function. CL programs
that use Equipment List require more heap memory than programs that do not use Equipment
List, and this reduces the number of blocks of object code that the CL Compiler can generate.
The following table shows the number of blocks of object code that the compiler can generate
with and without the heap expansion option for programs that use Equipment List and
programs that do not use Equipment List:
The maximum amount of heap memory available in the Engineering and Universal
Personalities without expanded memory is 320,000 words. The maximum amount of heap
memory available in the Universal Personality (with 5 Mw memory) is 700,000 words if the
heap expansion option is used.
NOTE
To terminate a compilation in progress, press the combination of the "CTL" and "BREAK" keys on the
engineering keyboard. The CL compiler recognizes the Break key during any of its three passes or
during the listing generation.
After a successful compilation, the status of the object file is reported both on the screen and in
the listing (.LS) file. No files are modified on an unsuccessful compilation.
The following are examples of the messages that report compilation status:
The Command Processor display doesn't provide prompters to request that required volumes be
mounted in a disk/diskette drive for a CL compilation. If you don't make a needed volume
available, an error message appears, indicating that the required volume or file could not be
found. After you mount the required volume, retype your command line and press ENTER.
The pathnames used in executing Compiler commands are the default pathnames on the Utilities'
Modify Default Volume Pathnames display.
1. If you are using some Engineering Personality activity other than the COMMAND
PROCESSOR, hold CTL and press MENU to return to the Engineering Main Menu.
2. To invoke CL:
CL
Loading Overlay
Control Language Compiler/Linker V21.54 usage:
: CL filename (options) - - Compile only
: CLK filename pointname (options) - - Compile/Link
: LK filename pointname - - Link only
: UNLK blockname pointname - - Unlink
options = ( -d: -debug) ( -nl: -nolist) ( -nw: -nowarn)
( -ul: -updatelib) ( -nx: -noxref) ( -ocd: -ovrwrtcds)
( -ex: -extend) ( -upgapm) ( -etd: -exptimdsp)
( -opt: -optimize)
( -oep dev>vol: -ovrwrtelp dev>vol)
( -ui instance_name: -unitinst instance_name)
2989
2991
CL and Command Processor commands can be included in command files to cause them to be
executed without human interaction. The command processor commands that facilitate the
execution of command files are available through the Command Processor.
See Section 5.1 for a description of the Data Out and Print commands.
The EC command directs the Universal Station to take commands from the specified file, rather
than from the keyboard. The commands are displayed on the screen as they are read from the
file. The responses to the commands also go to the screen, just as if they were being executed
through interaction with an operator. Command execution continues until an End command is
encountered or the end of the file is reached, and you are returned to the Command Processor.
You can abort EC file execution by holding CTL and pressing COMND. When the command
being executed is complete, execution stops, and you are returned to the Command Processor.
"&P" can be included in a command file to indicate comments that are not considered as
commands. "&P" and the text that follows it appear on the screen as they are encountered, and if
so specified by a PO command, they are also printed or appended to a file.
The PO command directs the US to copy the commands and responses as they appear on the
screen, to the specified printer, or to append them to the specified file. This continues until an
End command or the end of the file terminates execution, or until a PO command with no
pathname is executed.
The PAUSE command causes command execution to cease. Command execution continues
when the ENTER button is pressed. The primary purpose of the PAUSE command is to allow
you to mount a disk/diskette during the execution of an Execute file.
We recommend that you use a .EC suffix on your command files to identify their purpose. The
EC and PROMPTOUT commands don't require this specific suffix, but you will find a .EC suffix
a help in remembering the purpose of the file.
PO NET>CL>SESSION.EC
&P This command file compiles two CL blocks
CL PUMP1
CL PUMP2
END
EC NET>EC>ECFILE.EC
and press ENTER. The PO command directs the commands, the &P line, and all responses to
file SESSION.EC. The two CL commands are then executed, and the End command terminates
the session and returns you to the Command Processor.
If you wanted to review the commands and responses that were stored in SESSION.EC, you
could key in
PR NET>CL>SESSION.EC
Then press ENTER. The content of the file appears on the display.
Use parts 6.1 and 6.2 of this section to recover from errors detected by the Compiler commands. Part 6.3
provides information that will help you to recover from errors that are detected as a CL/APM program is
running in a Process Manager Module.
In error listing (.LE) files that the Compiler generates when it detects errors.
An alphabetical list of all of the error messages generated by the compile command is provided
below. The information in the Source/Severity column has the following meaning:
Source
Pass 1—CL syntax checking. Note: The compiler lists only the first syntax error it finds in
each source code statement.
Fatal—An error that prevents further command execution or that prevents the CL
Compiler from executing beyond the point where the error occurred
The following are the steps used to correct an actual, but simple, CL/APM source file error. A
similar process can be used to correct all CL/APM source file errors.
6298
2. We keyed in
"PR SAMPLE1.LE" followed by
17 Aug 88 16:49:53 4
COMMAND PROCESSOR VER. 21.50 USER PATH : NET>MM>
pr sample1.1e
2994
messages. 19
20
21
wait 2 mins
step p2s2
if !box.fl(1) = off then set numarr(4) = numarr(5)
22 - -
23 end sample1
Print Complete
2995
just below the line with the error. The Line Loc Text
"^" points to the beginning of the field 1 sequence sample1 (apm; point pm02)
2 - - This is a sample process module manager program
instead of
REPEAT L2
2996
page.
2997
We keyed in L1 instead of L2 to
correct the error. Then we pressed
LF, followed by E, and RETURN, to
transfer the corrected file to the
volume it came from.
6298
In the example of steps 1 through 7, an error was detected on the second Compiler pass, and pass
3 did not take place. For each pass to complete, the preceding pass must be error free. Once you
have corrected an error in an early pass, you may still have more errors to correct in subsequent
passes.
The CL listing (.LS) file includes program-code location information. This information is in the
"Loc" column in the example below.
For CL/APM programs, the number that appears in the "Loc" column for each executable
statement is the number that will appear in the statement field of the Process Module Detail
Display for the bound data point, when the statement is executed.
The syntax of the IF statement can result in "hidden" statements for which no "Loc" number can
be displayed. The statements in the consequent of IF statements can be written on the same line
as the rest of the IF statement. This results in more than one executable statement for each
CL/APM source code statement. In this case, the number in the "Loc" column is the number for
the IF statement. The numbers for the statements in the consequent are not displayed. If it is
important to know the "Loc" numbers for such statements, we suggest that each IF statement be
written on a separate line, using the continuation character in column one. Here is a program that
has two versions of the same IF statement, one containing hidden statements and the other with
no hidden statements.
Note that the END statement is counted as an executable statement even though a statement
number is not printed on the listing.
Example:
In this example, the pvsource of the digital input latched data point D173J03 is auto, so the
CL/APM program cannot store to the PVFL. The program fails with an F171 error, but the
statement "Loc" number will be 4, not 2.
& K
&Enn Volume and CL/APM .NO File(s), 14 Key Functions, CL Data Entry, 17
Keyboard, Engineer's, 17
.
.NO Object File, Preparing to Load, 14
M
Message Libraries, NIM, 12
Moving CL/APM Applications, 15
C
CL/APM Sequence Program, Installing, 9
CL/APM Source (.CL) File, How to Create, 21
N
CL/APM Source File Errors, Correcting, 46 NIM Message Libraries, 12
Command Files, How to Use, 30
Command Options, 23
Commands, 19 O
Compilation Precautions, 27 -OCD Option, 23
Compiler Commands, 22 Options, Command, 23
Compiler Commands, Invoking, 27 Overwrite Custom GDFs (-OCD), 23
Copy All or Part of a Source File, 21
Correcting CL/APM Source File Errors, 46
Create a CL/APM Source (.CL) File, 21 P
Custom GDF Compilation Results, 27
Pathnames and Volume Handling, 27
Precautions for Compilations, 27
D Preceding System Startup Tasks Completed, 5
Prerequisites, CL/APM Compile and Load Session, 7
Data Entry Error Messages, 34 Prerequisites, CL/APM Data Entry Session, 5
Data Entry Key Functions, 17 PROMPTOUT Command, 30
Data Entry Publications, 2 Publications, Related, 2
Data Entry Sessions, typical, 9
E R
Results of Custom GDF (.GD) Compilation, 27
EC Command, 30
Engineering Personality Running, Needed Volumes
Available, 6 S
Engineer's Keyboard, 17
Error Indications and Recovery, 33 Sequence Program, CL/APM, Installing, 9
Error Location, How to Determine, 49 Source File Errors, Correcting, 46
Error Messages, 34 Startup Tasks Preceding, 5
Errors, How Indicated, 33
Execute Command, 30 T
Text Editor Commands, 21
G
GDF Compilation Results, 27 U
Universal Station and Volume Handling Guidelines, 7
I User Volumes Established with Sufficient Capacity, 5
Install CL/APM Sequence Program, 9 Utility Commands in CL/APM Data Entry, 19
Invoking a Compile Command, 28
V
Volume Handling and Pathnames, 27
READER COMMENTS
Title of Document: CL/APM Data Entry Issue Date: 12/02
Document Number: AP11-600 R640
Comments:
Recommendations:
FROM:
Name: Date:
Title:
Company:
Address:
City: State: ZIP:
Telephone: FAX: