| Restrictions | Communication Setup Considerations | |
The CICS Server provides several facilities which are used to configure and control its processing and execution. Among these are:
The FADM transaction is started from a terminal connected to mainframe CICS. This transaction invokes the FSADMN program which is used to start, stop, and monitor the CICS servers. Using FSADMN for CICS, you can:
The FADM transaction accepts an optional parameter: the transaction ID of the CICS server. The default transaction ID is BETF. This optional parameter is entered immediately following the FADM transaction name (e.g. FADM xxxF, where xxxF is the transaction ID of your CICS server).
While in the FADM transaction, you can press the CLEAR key to log off the FSADMN session and exit.
When FSADMN is invoked, the Logo Screen is displayed (Figure 7-1).
Figure 7-1: FSADMN Logo Screen
The screen displayed after you press ENTER on the logo screen is the FSADMN Main Menu.
The main menu is displayed after the logo screen. From here, you can select options to start, change, and stop a CICS server. You can also select option 3 to view the Runtime Information Menu from which you can view information about a server.
Figure 7-2: FSADMN Main Menu
The main menu displays the current status of the CICS server. If the CICS server has not been started, UNAVAILABLE is displayed instead of the start-ups time. You can change the name of the CICS server by changing the CICS server tranid before selecting an option. The following options are available:
Important: There is currently no way to alter this password.
When option 1 is selected from the FSADMN Main Menu, the FSADMN Start/Change Server menu is displayed.
Figure 7-3: FSADMN Start/Change Server Menu
The Start Server or Change Options menu is used to start a CICS server. It can also be used to change some of the runtime characteristics of an active server. The fields on this menu are described below.
| CICS Server Tranid | This field displays the CICS transaction ID for the CICS server you wish to start or change. | |
| Start-up Time | This field displays the date and time the active server was started. If the server is not running the word UNAVAILABLE is shown. | |
| When starting or changing a CICS server, you can specify several runtime characteristics including the trace options. | ||
| Trace Options | For each of the trace options fields, enter Y or N to indicate whether the corresponding trace records are to be written. | |
| All Requests | All requests to the CICS server are traced. | |
| File Activity | Only file activity is traced. | |
| FCD Capture | All File Control Descriptions (FCDs) are written to an FCD trace queue. The FCD describes the file being processed and the results of the last I/O request. The FCD is described in detail in your Programmer's Guide to File Handling. This information can be useful during debugging. The information in the FCD trace queue can be displayed using the FSDS transaction or printed using the FSPR transaction. See the section FSDS: Display FCD Contents for additional information. | |
| Maximum
Message Size |
Displays the maximum message size that the CICS server
can process. This value represents the number of kilobytes of data that
can fit in a single message sent between the server and the requesting
client. This value defaults to 32K.
The transmitted message includes the record and communications control data. The communications control data is approximately 450 characters long. Therefore, the largest record that can be sent in any message is equal to the maximum message size minus 450. |
|
| Options | Specify option by number and press ENTER | |
| 1 | Start server | Starts a CICS server. The server name is displayed in the CICS server tranid field. The server is started with the runtime attributes that you specify in the other fields. |
| 2 | Change server options | Changes the runtime characteristics of a CICS server. The server name is displayed in the CICS server tranid field. The server is changed to the runtime attributes that you specify in the other fields. |
| F3/9 | Exit | Select this option or press F3 to exit the FSADMN Main Menu (Figure 7-2). |
When option 3 is selected from the FSADMN Main Menu, the FSADMN Runtime Information menu is displayed (Figure 7-4).
Figure 7-4: FSADMN Runtime Information Menu
The Runtime Information menu displays a list of options which you can select to display or alter information about the CICS server.
| CICS Server Tranid | This field displays the CICS transaction ID for the CICS server. | |
| Start-up Time | This field displays the date and time the active server was started. If the server is not running the word UNAVAILABLE is shown. | |
| Options | Specify option by number and press ENTER | |
| 1 | Edit Database Reference File | Select this option to view or edit the Database Reference File associated with the server. The Database Reference file is loaded when a CICS server is started. It contains information used to associate a CICS file with the filename used by a client program. When editing an entry in the Database Reference File, you can also update the Key Definition File. |
| 5 | View CICS Server Messages | The server generates messages during start-up processing, as exceptions are detected, and when selected information is traced. Select this option to view the messages in the on-line queue. Messages may also be written to a transient data file which can be allocated to a SYSOUT data set. |
| 6 | View CICS Server Traces | When a server is started with or is changed with trace options selected, the trace records are written to a trace queue. This option enables you to view the trace queue entries. |
| F3/9 | Exit | Select this option or press F3 to exit the FSADMN Main Menu (Figure 7-2). |
When option 1 is selected from the FSADMN Runtime Information Menu (Figure 7-4), the FSADMN Database Reference File Maintenance Screen is displayed (Figure 7-5).
Figure 7-5: FSADMN Database Reference File Maintenance Display
The Database Reference File contains records that associate CICS filenames with the filenames used by client programs. An entry is required for each filename that either does not conform to CICS VSAM filename syntax requirements or for which a dynamic association of PC filename to VSAM filename is desired. You can edit the entries in the Database Reference File, but these changes are not available to an active CICS server; you must re-start a server to have it recognize the changes.
The ACT field is used for entry selection and is discussed below. While the DATABASE FILE = field displays the name of the current Database Reference file.
Each Database Reference File entry contains two filenames: the filename as specified by the client program, and the corresponding CICS VSAM filename. The client program filename always appears first. The format of a Database Reference File entry is: /F pc-filename /AF cics-filename, where pc-filename is the client program filename and cics-filename is the VSAM filename.
To add a new entry to the Database Reference File, position the cursor on any existing or empty entry, type A and press the ENTER key. When an existing entry is selected it can be used as a model for the new entry. An empty entry presents a Key Definition screen with no information supplied. To edit an existing entry, position the cursor to the left of the entry, type S, and press the ENTER key. When either the select (S) or add (A) actions are processed, the FSADMN Key Definition File Maintenance screen (Figure 7-6) is displayed with the information in the Database Reference File entry. You can edit the information and write the record, causing both the Database Reference File and the Key Definition File to be updated. Multiple Database Reference File records can be selected before pressing the ENTER key.
The Database Reference File Maintenance screen displays up to 15 records from the Database Reference File. The entries can be scrolled using either the traditional scroll keys (F7/F19 to scroll up, F8/F20 to scroll down) or the scroll options displayed at the bottom of the screen.
| The option entries and corresponding scroll key commands are: | ||
| 1 | Up | (F7/F19) |
| 2 | Down | (F8/F20) |
| 3 | Top | (F7/F19 with M in the option field) |
| 4 | Bottom | (F8/F20 with M in the option field) |
| The control entries and corresponding control key commands are: | ||
| 9 | Exit | (F3) |
Multiple Database Reference File entries can refer to the same VSAM filename. Associated with each VSAM filename is a Key Definition File entry that describes the key information of that VSAM file and any related VSAM files that are alternate indexes of the base filename. It is important that you properly define the VSAM Key Definition File entries as they can be referred to by multiple Database Reference File entries.
When adding a new entry to the Database Reference File, you should:
When an Action of 'S' or 'A' is used on the Database Reference File Maintenance screen (Figure 7-5), the FSADMN Key Definition File Maintenance Screen is displayed (Figure 7-6).
Figure 7-6: FSADMN Key Definition File Maintenance
The Key Definition File Maintenance screen serves two purposes: to associate a client program filename with a VSAM filename, and to specify a list of VSAM files that are alternate indexes of a base filename. Unlike the Database Reference File entries, changes to the Key Definition entries are available to all active CICS servers.
It is important to understand the relationship between Key Definition File entries and Database Reference File entries. A Database Reference File entry associates a client's filename with a CICS filename. Many Database Reference File entries can refer to the same CICS filename. For each unique CICS filename referred to by a Database Reference File entry there is a single Key Definition File entry to describe the key information for that CICS file and, if the file is a VSAM KSDS (Key Sequenced) data set, the key information of the alternate indexes defined for the base KSDS file. Since many Database Reference Files can refer to the same CICS file, any change made to the Key Definition entry for one of these references affects all other Database Reference File entries for that CICS file.
The FILENAME field at the top of the screen is used to enter the filename as specified by the client program. The filename entered here must match exactly that used by the requesting program.
The CICS filenames to be associated with the requesting client filename are entered in the window beneath the filename field and to the right of the screen. Each entry consists of a CICS filename, key offset, key length, (the key offset and key length fields are edit protected, FSADMN obtains the proper values through the CICS INQUIRE FILE command), and a field used to indicate whether the file contains records with duplicate keys. For ESDS (Entry Sequenced) and RRDS (Relative Record) CICS data sets, the key values are 0 and the duplicate key field should be 'N'. The first entry in this window is the name of the file that is associated with the requesting client's filename.
If the VSAM file has alternate indexes defined for it, you must also enter additional information for each alternate index; this information is required to support alternate index processing for COBOL programs having the 'ALTERNATE KEY' parameter specified in the file-control section. If the OFFSET and LENGTH fields contain asterisks (******), the VSAM file is defined but disabled. If these fields contain "***NOT" and "FOUND", then the file is not defined to CICS.
The options available from the Key Definition File Maintenance menu are:
| Options | Specify option by number and press ENTER | |
| 1 | Reread | All the fields are refreshed from the original Database Reference and Key Definition file records. Use this option when changes have been made, but not written, and the original information is desired. |
| 2 | Write | The Database Reference and Key Definition Files are updated with the information displayed on the screen. After successfully updating these files, the next selected entry in the Database Reference File is processed, continuing in like manner until no further entries are selected at which time the Key Definition File maintenance facility is terminated and the Database Reference File screen (Figure 7-5) is re-displayed. |
| 3 | Delete | Deletes an existing entry from the Database Reference File. When
the delete option is selected, the original Database Reference File
record is read and the results displayed on the screen with a message
requesting confirmation. You must re-enter the delete option to confirm
the delete request; all other entries cancel the delete operation.
Deleting an entry from the Database Reference File does not remove the corresponding Key Definition File entry because the entry may be referenced by other entries. After successfully deleting this entry, the next selected entry in the Database Reference File is processed, continuing in like manner until no further entries are selected at which time the Key Definition File maintenance facility is terminated and the Database Reference File screen (Figure 7-5) is re-displayed. |
| F3/9 | Exit | Cancels the select/add operation for the record displayed and either causes the next selected Database Reference File entry to be displayed or terminates Key Definition File maintenance and returns to the Database Reference File display screen (Figure 7-5) if no other Database Reference File records were selected. |
When option 5 is selected from the FSADMN Runtime Information Menu (Figure 7-4), the Message Display screen (Figure 7-7) is displayed.
Figure 7-7: FSADMN Message Display Screen
The Message Display screen displays up to 15 messages from the message queue. The messages can be scrolled using either the traditional scroll keys (F7/F19 to scroll up, F8/F20 to scroll down) or the scroll options displayed at the bottom of the screen.
The option entries and corresponding scroll key commands are:
| 1 | Up | (F7/F19) |
| 2 | Down | (F8/F20) |
| 3 | Top | (F7/F19 with M in the option field) |
| 4 | Bottom | (F8/F20 with M in the option field) |
The control entries and corresponding control key commands are:
| 5 | Clear the Message Queue | (none) |
| 9 | Exit | (F3) |
When option 6 is selected from the FSADMN Runtime Information Menu (Figure 7-4), the Trace Entry Display screen (Figure 7-8) is displayed.
Figure 7-8: FSADMN Trace Entry Display Screen
The Trace Entry Display screen displays up to 15 messages from the trace message queue. The messages can be scrolled using either the traditional scroll keys (F7/F19 to scroll up, F8/F20 to scroll down) or the scroll options displayed at the bottom of the screen
The option entries and corresponding scroll key commands are:
| 1 | Up | (F7/F19) |
| 2 | Down | (F8/F20) |
| 3 | Top | (F7/F19 with M in the option field) |
| 4 | Bottom | (F8/F20 with M in the option field) |
The control entries and corresponding control key commands are:
| 5 | Clear the Message Queue | (none) |
| 9 | Exit | (F3) |
Trace Messages have a similar format to the Micro Focus Fileshare Version 2 product, details of which can be found in your Programmer's Guide to File Handling.
Special operating considerations exist when using TCP/IP in a CICS environment. The CICS TCP/IP Sockets Interface from IBM must be installed in the CICS region. Before an application can use TCP/IP, the IBM supplied listener must be started. A CICS application that will be contacted by an external application must register its own listener with TCP/IP and the IBM listener. This section discusses the CICS server support for TCP/IP. The topics covered include:
To start the IBM CICS TCP/IP support run the CSKE transaction (see Figure 7-9) from a blank 3270 screen. This transaction is supplied as part of the CICS TCP/IP Socket Interface from IBM.
Figure 7-9: CSKE Input Screen
| TCPIPJOBNAME | This is the name specified when TCP/IP support for the mainframe is started. This name must match the name specified on the Specify TCP/IP Registration Parameters and Vendors screen during the CICS server installation. |
| PORT | This is the TCP/IP port number for this CICS region. |
The results of successfully running the CSKE transaction are shown in Figure 7-10.
Figure 7-10: CSKE Output Screen
After the CICS TCP/IP Sockets Interface has been started, the CICS server TCP/IP listener must be started.
To start the CICS server with TCP/IP support run the FSHC transaction with the Open option. This transaction is supplied as part of the CICS Mainframe Access server. Figure 7-11 shows the results of this transaction. This transaction will start the MFA CICS Server TCP/IP Listener. The Listener will register itself with the CCITCP2 daemon.
If you have not installed the Automatic Ping feature with your MFA CICS TCP/IP support, this transaction can be issued at any time to re-register the CICS Server with CCITCP2.
Figure 7-11: FSHC OPEN Transaction Results
When the CICS server TCP/IP listener has been started, the CICS server Administration transaction FADM (described earlier in this chapter) is used to start the server.
The CICS server TCP/IP listener status can be viewed using the FSHC transaction with the STATUS option (see Figure 7-12).
Figure 7-12: FSHC STATUS Transaction Results
| F/S LISTENER STATUS IS | This line indicates the current status of the CICS Server listener. The possible values are ACTIVE, INACTIVE, and PENDING. ACTIVE indicates that the listener has started and registered itself with the CCITCP2 daemon. PENDING indicates that the listener has started and is attempting to register itself with CCITCP2. INACTIVE indicates that the listener is not running. |
| TRANSACTIONS PROCESSED | This is the total number of connections established with remote workstations. |
| LAST TIME STAMP | This is the time of day when the latest workstation successfully connected to the listener. |
| SERVER NAME | This is the name assigned to the MFA CICS TCP/IP support. This name is established during installation. See job $MFATCP in the INSTLIB installation library for more details. |
| LAST NODE INPUT | This is the TCP/IP address of the latest workstation to contact the listener. This address is displayed as 8 hexadecimal digits. Each pair represents one segment of the TCP/IP address. This form of presentation was chosen because CCITCP2, the name registration daemon, uses this format. |
| PORT | The TCP/IP port number assigned to the MFA CICS TCP/IP Listener by the IBM Listener |
| LISTENER STARTED | This is the time of day when the listener started. |
After using the CICS server Administration transaction FADM to shutdown the server, it is necessary to close the CICS server TCP/IP listener. This is accomplished from a blank screen using the FSHC transaction with the CLOSE option. Figure 7-13 shows the results of this transaction.
Figure 7-13: FSHC CLOSE Transaction Results
To stop the CICS TCP/IP Sockets Interface, use the IBM supplied transaction CSKD.
If the CCITCP2 daemon becomes available after an outage, the following steps will re-register the CICS server with the daemon.
FSHC CLOSE
FSHC OPEN
These steps will cause the CICS server TCP/IP support to attempt to register itself with the CCITCP2 daemon. Use the FSHC transaction with the STATUS option to determine if this attempt was successful.
Copyright © 1999 MERANT International Limited. All rights reserved.
This document and the proprietary marks and names
used herein are protected by international law.
| Restrictions | Communication Setup Considerations | |