Administration

Installing CICS clients

This topic describes the following:

"Methods of installing CICS clients" "Installing CICS Client for DOS" "Installing CICS Client for OS/2" "Installing CICS Client for Windows and CICS Client for Windows 95" "Installing CICS Client for Windows NT" "Installing CICS Client for Macintosh" "CICS clients directory structure" "Other actions required in setting up a CICS client" This contains a section for each CICS client: "CICS Client for DOS" "CICS Client for OS/2" "CICS Client for Windows" "CICS Client for Windows 95" "CICS Client for Windows NT" "CICS Client for Macintosh"

This topic describes how to install CICS clients. The components of CICS clients that you can choose to install are:

• CICS Client runtime system
• CICS Client programming samples
• CICS Client documentation

The following components are also available with CICS Client for OS/2 and CICS Client for Windows NT:

• CICS gateway for Lotus Notes
• CICS Internet gateway.

You can install the CICS client system code as a minimum, and install the other components later.

The installation processes allow you to select the language in which end-user messages are displayed.

Methods of installing CICS clients

The Transaction Server CD-ROM contains a \CLIENTS\I86_CLNT\CLIENTS directory with subdirectories of \DOS, \OS2, \WIN, \W95, and \WNT.

You can install CICS clients from the CD-ROM by:

1. "Installing directly from the CD-ROM"

2. "Installing from the CD-ROM drive on a server"

3. "Installing from the hard disk of a remote machine"

4. "Installing from diskette".

Installing directly from the CD-ROM

For CICS Client for OS/2, and CICS Client for Windows Family, you can use the following method:

1. Insert the CD-ROM in the CD-ROM drive in the client machine.

2. Change to the CD-ROM drive, and appropriate client subdirectory, for example, E:\CLIENTS\I86_CLNT\CLIENTS\OS2, and enter INSTALL. (For CICS Client for Windows Family, enter the equivalent Run command.)

For CICS Client for DOS, you must use the following method:

1. Insert the CD-ROM in the CD-ROM drive in the client machine.

2. Issue a SUBST command like the following:

   
   SUBST F: E:\CLIENTS\I86_CLNT\CLIENTS\DOS
   
   

3. Change to F: and enter INSTALL.

Installing from the CD-ROM drive on a server

For CICS Client for DOS, CICS Client for OS/2, and CICS Client for Windows Family, you can use the following method:

1. Connect to the CD-ROM drive of a server machine, for example by issuing a NET USE command:

   
           NET USE F: \\CICSCLI\INSTALL
   
   

   
   where F: is the CD-ROM drive containing the CD-ROM, and CICSCLI\INSTALL are the servername and netname assigned by your network administrator.

2. Change to the redirected drive and the appropriate directory, for example, F:\CLIENTS\OS2, and enter INSTALL. (For CICS Client for Windows Family, enter the equivalent Run command.)

Installing from the hard disk of a remote machine

You can use this method for CICS Client for DOS, CICS Client for OS/2, and CICS Client for Windows Family. The client directories from the CD-ROM can be copied to the hard disk of a remote machine. In this case:

1. Connect to the appropriate drive of the remote machine, for example, by issuing a NET USE command:

   
           NET USE F:  \\CICSCLI\INSTALL
   
   

   
   where F: is the drive containing the client directories and CICSCLI\INSTALL is the servername and netname assigned by your network administrator.

2. Change to the redirected drive and the appropriate directory, for example, F:\CLIENTS\OS2, and enter INSTALL. (For CICS Client for Windows Family, enter the equivalent Run command.)

Installing from diskette

You can create installation diskettes from diskette images supplied in the \CLIENTS\I86_CLNT\DISKS directory on the CD-ROM. Images are supplied for all IBM CICS Clients, and this is the only way to install CICS Client for Macintosh.

To create installation diskettes:

1. Insert a diskette in a diskette drive in the machine, (usually A:).

2. Change to the \DISKS directory on the CD-ROM drive.

3. Issue LOADDSKF commands to create the installation diskettes:

   
   LOADDSKF CCLclinn.DSK A:
   
   

   
   where cli identifies the type of client and nn identifies the number of the diskette. For example:

   
   LOADDSKF CCLOS2_1.DSK A:
   
   

   
   would create the first installation diskette for CICS Client for OS/2.

   For help information on the LOADDSKF command enter LOADDSKF on its own.

4. Insert the installation diskette in the diskette drive in the client machine and install as described in the relevant section in this topic:

   • "Installing CICS Client for DOS"

   • "Installing CICS Client for OS/2"

   • "Installing CICS Client for Windows and CICS Client for Windows 95"

   • "Installing CICS Client for Windows NT"

   • "Installing CICS Client for Macintosh".

Installing CICS Client for DOS

You can install CICS Client for DOS from diskette, over a LAN, or from CD-ROM (see "Methods of installing CICS clients".) (Refer to the documentation for your network operating system if you need to know how to connect to network drives).

If you want to install over a LAN, you can either:

• First install the CICS Client for DOS diskette onto the network drive, and allow the users to copy the directories and files to their workstation, or

• Copy the CICS Client for DOS diskette or CD-ROM directory contents to the root directory of the network drive, and allow the users to install from the network drive.

The installation procedure

To install CICS Client for DOS:

1. Change to the drive containing the diskette (or CD-ROM), or the appropriate network drive if you are installing over the LAN.

2. If installing from CD-ROM, issue a SUBST command like the following:

   
   SUBST F: E:\CLIENTS\I86_CLNT\CLIENTS\DOS
   
   

   
   Now change to F:

3. At the command prompt, type INSTALL, then press the Enter key. An introductory CICS clients panel is displayed. Press any key other than Esc to continue. (During the installation process, you can press the Esc key at any time to terminate the installation.)

4. A welcome panel is displayed. Press any key other than Esc to continue.

5. Select the drive onto which you would like CICS Client for DOS installed (the default is C:). Move the bar to your selection, and then press the Enter key.

6. Select the path that you want CICS Client for DOS to be installed under. The default is \CICSCLI. If you select a path that already exists, you are asked whether you want to select another path, terminate the installation, or continue installing into the existing path. If you install into the existing path, files will be overwritten.

7. Select the components of CICS Client for DOS that you want to install. Move the highlight to each required component in turn, and press the spacebar to toggle the component from "NO" to "YES". When you have selected all the components that you want to install, press Enter. (You are informed if you do not have enough disk space to install the selected components.)

8. Select the language in which the CICS Client for DOS messages are to be displayed. Move the highlight to the language of choice, and then press Enter to complete the selection.

9. An installation progress panel is displayed. If the CICS Client for DOS initialization (.INI) files already exist in the \BIN subdirectory of the directory you selected for installation, the original files are renamed to:
   • CICSCLI.BAK,
   • CICSCOL.BAK, and
   • CICSKEY.BAK

   in the \BIN subdirectory of the directory selected for installation.

10. You are asked whether you want the installation process to update the AUTOEXEC.BAT file. If you select this option, your original AUTOEXEC.BAT file, is renamed AUTOEXEC.BAK and is stored in the same directory.

11. If your AUTOEXEC.BAT file has been updated, remove any diskette, shut down the system and restart. If the AUTOEXEC.BAT file was not updated, before shutting down the system, update the PATH statement with:

    
           x:\path\BIN
    
    

    
    where x is the drive, and path is the path you selected.

It is important to read the README.TXT file supplied with CICS Client for DOS.

Updating your CICS Client for DOS system

To update your CICS clients system with new service levels, you use corrective service software.     Corrective service software allows you to service an installed CICS clients system with the latest level of software.

To install corrective service, proceed in the same way as for installing CICS Client for DOS. Remember to read the README file supplied with the corrective service software.

Updating an installed CICS client system causes the client initialization file, keyboard mapping file, and color mapping file, to be overwritten. Although these files are backed up, it is recommended that you keep your own customized versions of these files with different names to those supplied. You should then reference these customized files by environment variables see "Renaming the client initialization and mapping files".

Deleting your CICS Client for DOS system

To delete your system, you should delete all of the CICS Client for DOS directories and all files contained in those directories. You must also delete all entries for CICS Client for DOS from the AUTOEXEC.BAT file.

Installing CICS Client for OS/2

You can install from diskette, over a LAN, or from CD-ROM (see "Methods of installing CICS clients")

The installation procedure

This section describes the process of installing CICS Client for OS/2 interactively. It is also possible to install CICS Client for OS/2 using a response file, see "Automatic installation of CICS Client for OS/2".

Online help is available throughout the installation process, by selecting the Help push button or by pressing PF1.

It is important to browse through the README.TXT file provided on the installation diskette before you start the installation; use the system editor.

Note: If you have a previous version of CICS Client for OS/2 installed, you should either install CICS Client for OS/2 Version 2.0.1 to the same directory as the older version, or uninstall the older version first. If you do not want to remove or replace the older version of CICS Client for OS/2 you must ensure that the correct dynamic link libraries (DLL) are used for each version. If CICS Client for OS/2 loads a DLL from an older version, traps will occur.

Before you start, make sure that you have at least 150 KB of free space on the drive containing the operating system. This is required by the installation program.

1. CD-ROM installation: Insert the CD-ROM and change to the \CLIENTS\I86_CLNT\CLIENTS\OS2 directory of the CD-ROM.

   Diskette installation: Insert the first installation diskette into the disk drive you are using for installation and change to this drive (usually the A: drive) by entering A:

   LAN installation: Change to the network drive and directory containing the files copied from the diskettes.

2. At the command prompt, type INSTALL, then press the Enter key. After the files are loaded, an introductory CICS clients panel is displayed.

3. To proceed, click on the Continue push button, or press the Enter key.

   The Install panel is displayed.    

4. If you select the check box to update the CONFIG.SYS file, the file is updated automatically as part of the installation process. Your original CONFIG.SYS file is renamed to CONFIG.BAK and is stored in the same directory. If you do not select this check box, a CONFIG.ADD file is generated, containing the necessary updates to the LIBPATH or PATH statements in CONFIG.SYS.

5. Select the OK push button to continue. The Install--directories panel is displayed.  

6. The list box shows the installation options that you can select. When you select one or more of these options, the Bytes needed field shows the amount of disk space required for installation. If there is too little space on your hard disk for the CICS client installation, an action message appears before the Install--directories panel. In this case, cancel the installation by selecting the OK push button. Find out which of your existing files you can archive or delete to make more space before proceeding further.

   Use the push buttons as necessary:

   • To display descriptions of the selected options, select Descriptions.
   • To select all of the options, select Select all.
   • To deselect all of the options, select Deselect all.

   The High-Level Directory entry field allows you to specify a drive and directory other than the default (C:\CICSCLI) for installation.

7. To show how much disk space is available on each drive, select the Disk space push button. The Disk space panel is displayed.  

   The list box shows the amount of available disk space for each drive, and whether installation is possible. Select a drive from the list box if required. When you return to the Install--directories panel, your selected drive is shown in the High-Level Directory field.

8. Select the Install push button to continue. An Installation progress panel is displayed. The panel shows:

   • The file currently being installed (source) and the drive and directory to which it is being installed (target)

   • A progress bar, indicating the percentage of files already unpacked and installed

   • The elapsed time

   • The status, for example, unpacking, processing, or transferring

   If you select the Stop push button, you are asked whether you want to delete the partial system you have installed. Select Yes to delete the files already installed and return to the introductory CICS Client for OS/2 panel. Then, select Start install from the File menu to start the installation again.

9. A panel allowing you to select the language in which CICS client messages are displayed appears. Choose the required language and select OK.

10. Diskette installation only: Insert the second installation diskette when you are prompted.

11. When installation is complete, the Installation and Maintenance panel is displayed. Select OK.

12. When the installation process is complete, an OS/2 desktop folder is created (see Figure 26). In a fully installed system, the folder contains icons for:
    • The README.TXT file
    • Starting the client
    • Stopping the client
    • Showing the client status
    • Starting the terminal emulator
    • Starting the printer emulator
    • The installation and maintenance program
    • The CICS clients online documentation (optional)

13. If your CONFIG.SYS file has been updated, remove any diskette, shut down the system and restart. If the file was not updated rename the CONFIG.ADD file to CONFIG.SYS before shutting down the system. (CONFIG.ADD will be in the same directory as CONFIG.SYS.)

Caution:
Be very careful if you are installing CICS Client for OS/2 onto a workstation that already has a CICS for OS/2 server installed. Both products have some files of the same name, therefore you must ensure that the installation of the client does not affect the server. This is particularly important with respect to the LIBPATH setting. It is not recommended that you install both CICS client and CICS for OS/2 server on the same workstation, unless you are a software developer familiar with problems of this sort.

Updating your CICS Client for OS/2 system

This section describes how you update your CICS client system with new service levels. This is done using corrective service software,     which allows you to service an installed CICS client system with the latest level of software. You can install the corrective service software:

• Interactively, by running the installation and maintenance program from the icon in the CICS client folder

• Automatically, using a response file (see "Automatic installation of CICS Client for OS/2")

The installation and maintenance program

When a CICS client is installed, the installation and maintenance program is installed along with the product software.

The icon for the installation and maintenance program is displayed in the CICS client folder. From this icon you can run the program to maintain all installed CICS client systems. The installation and maintenance program allows you to:

• Install new CICS client systems, and additional CICS client components
• Update installed CICS client systems
• Restore backed up CICS client systems
• Delete installed CICS client systems

You can update from diskette or from a redirected LAN drive.

The update process

The installation and maintenance program works with catalogs of products. A catalog contains a list of products; when you open a catalog, the installation and maintenance program lists the products that it contains. Before you update CICS Client for OS/2, you must open the catalog for CICS Client for OS/2 and select the required product.

The process is as follows:

1. Click on the Installation Utility icon in the CICS Client for OS/2 folder. The installation and maintenance program starts, and displays the main panel.

2. Select the File action, followed by the Open catalog option from the pulldown menu.

3. Now, select the Drive option. The Open drive catalog panel is displayed and this allows you to select the drive containing the corrective service software. When you select the drive, the catalog file (for example, CCLCLNT.ICF) is listed under Filename. Select the appropriate drive and open the catalog. The products in the catalog are listed.

4. Make sure that the correct service level of CICS Client for OS/2 is selected in the list of products.

   Make sure that you will have enough disk space for the product components you want to update, and any that you want to back up.

5. Select the Update action from the Action menu. The Update panel is displayed.    

6. If you select the check box to update the CONFIG.SYS file, the file is updated automatically as part of the installation process. Your original CONFIG.SYS file is renamed to CONFIG.BAK and is stored in the same directory. If you do not select this check box, a CONFIG.ADD file is generated containing the necessary updates to the LIBPATH statement in the CONFIG.SYS file.  

7. If you select the Save a backup version check box, the system being replaced by the application of the corrective service software is backed up. The backed up system can later be restored to the previous service level by selecting the Restore option from the Action menu. This gives you the chance to check that the updated system works correctly before you delete the old system.

8. Select the Update push button. The installation and maintenance program unpacks and copies the modules from the corrective service software to the installed system.

Updating an installed CICS client system causes the client initialization file, keyboard mapping file, and color mapping file, to be overwritten. Although these files are backed up, it is recommended that you keep your own customized versions of these files with different names to those supplied. You should then reference these customized files by environment variables see "Renaming the client initialization and mapping files".

Deleting a CICS Client for OS/2 system

To delete a CICS client system, make sure it is not running and perform the following:

1. Use the Installation Utility to open the catalog used to install the system. If you use the catalog you used for updating, only the files transferred from the corrective service software are deleted.

2. Select the Delete option from the Actions menu. The Delete panel is displayed.  

3. Select the components you want to delete. To select or deselect all of the components, click on Select or Deselect respectively. If you want to delete only the backup versions, select the Delete only the backup versions check box.

4. Select the Delete push button. A progress panel is displayed, showing the proportion of files already deleted. You can select the Stop push button to stop the deletion.

Attention: When you mark components for deletion it is not possible to delete some files immediately, because they are in use. You must therefore shut down and restart the system. The files are then deleted when the system is restarted.

Automatic installation of CICS Client for OS/2

You can perform automatic installation and maintenance of CICS Client for OS/2 by supplying the required options in a response file. It is therefore possible to install CICS clients on workstations without user interaction being required at the workstation.

This kind of automatic installation is particularly useful for installing CICS clients over a network because installation can be performed from a redirected drive on a LAN server. (Refer to the documentation for your network operating system if you need to know how to connect to network drives.)

To start the installation, call the installation program by entering INSTALL together with the required parameters. For example:

       INSTALL /A:I /R:F:\INSTCICS\CICSCLI.RSP

       /S:F:\INSTCICS

       /L1:F:\INSTCICS\CICSCLI.OUT

       /L2:F:\INSTCICS\CICSCLI.HIS /X

In this example, CICS Client for OS/2 is installed from the redirected drive F: on the server, according to the options supplied in the response file CICSCLI.RSP. The response file specifies the drive and directory in which to install CICS Client for OS/2. Errors are logged in CICSCLI.OUT and the history log is contained in CICSCLI.HIS.   The /X parameter specifies that the installation is noninteractive.

Note: The base level of CICS Client for OS/2 is installed using the INSTALL command, while corrective service software is installed using the EPFINSTS command.

The installation and maintenance parameters are described in "The installation and maintenance parameters".

Installing CICS Client for Windows and CICS Client for Windows 95

You can install from diskette, over a LAN, or from CD-ROM (see "Methods of installing CICS clients".)

The installation procedure

This section describes the process of installing CICS Client for Windows and CICS Client for Windows 95 interactively. It is also possible to install CICS Client for Windows and CICS Client for Windows 95 using a response file, see "Automatic installation of CICS Client for Windows and CICS Client for Windows 95".

Online help is available throughout the process, by selecting the Help push button or by pressing PF1. It is important to browse through the README.TXT file provided on the installation diskette before you start the installation.

Note: During installation CICS Client for Windows creates a Windows Program Manager group to contain the CICS Client for Windows icons. However, If you are using an alternative Windows shell, the group may not be created correctly. In such cases you must ensure that the standard Windows Program Manager (PROGMAN.EXE) is running before starting installation.

Before you start, make sure that you have at least 150 KB of free space on the drive containing the operating system. This is required by the installation program.

1. For CICS Client for Windows, select the Run option of the File pulldown menu. For CICS Client for Windows 95, select Run from the Start menu.

2. Enter one of the following:

   CD-ROM Installation: d:\CLIENTS\I86_CLNT\CLIENTS\WIN\INSTALL (for CICS Client for Windows) or d:\CLIENTS\I86_CLNT\CLIENTS\W95\INSTALL (for CICS Client for Windows 95)

   Diskette installation: d:INSTALL

   LAN installation: d:INSTALL

   where d: is a CD-ROM, diskette, or network drive.

   After the files are loaded, an introductory CICS clients panel is displayed.

3. To proceed, click on the Continue push button, or press the Enter key.

   The Install panel is displayed.    

4. If you select the check box to update the AUTOEXEC.BAT file, the file is updated automatically as part of the installation process. Your original AUTOEXEC.BAT file is renamed to AUTOEXEC.BAK and is stored in the same directory. If you do not select this check box, an AUTOEXEC.ADD file is generated, containing the necessary updates to the PATH statement in the AUTOEXEC.BAT file.

5. Select the Overwrite files check box to automatically replace all workstation files that have the same name and location as the product files being installed. If you do not select this check box, the installation and maintenance utility programs will warn you before overwriting an existing workstation file.

6. Select the OK push button to continue. The Install--directories panel is displayed.  

7. The list box shows the installation options that you can select. When you select one or more of these options, the Bytes needed field shows the amount of disk space required for installation. If there is too little space on your hard disk for the installation, an action message appears before the Install--directories panel. In this case, cancel the installation by selecting the OK push button. Find out which of your existing files you can archive or delete to make more space before proceeding further.

   Use the push buttons as necessary:

   • To display descriptions of the selected options, select Descriptions.
   • To select all of the options, select Select all.
   • To deselect all of the options, select Deselect all.

   The High-Level Directory entry field allows you to specify a drive and directory other than the default (C:\CICSCLI) for installation.(1)

8. To show how much disk space is available on each drive, select the Disk space push bu tton. The Disk space panel is displayed.  

   The list box shows the amount of available disk space for each drive, and whether installation is possible. Select a drive from the list box if required. If you also select the Change directories to selected drive check box, when you return to the Install--directories panel, your selected drive is shown in the High-Level Directory field.

9. Select the Install push button to continue. An Installation progress panel is displayed. The panel shows:

   • The file currently being installed (source) and the drive and directory to which it is being installed (target)

   • A progress bar, indicating the number of files already unpacked and installed

   • The elapsed time

   • The status, for example, unpacking, processing, or transferring
   If you select the Stop push button, you are asked whether you want to delete the partial system you have installed. Select Yes to delete the files already installed and return to the introductory CICS clients panel. Then, select Start install from the File menu to start the installation again.

10. A panel allowing you to select the language in which CICS clients messages are displayed is shown. Choose the required language and select OK.

11. Diskette installation only: Insert the next installation diskette when you are prompted.

12. When installation is complete, the Installation and Maintenance panel is displayed. Select OK.

13. When the installation process is complete, a Windows Program Manager group (see Figure 27) or Windows 95 folder is created. In a fully installed system, the group window or folder contains icons for:
    • The README.TXT file
    • Starting the client
    • Stopping the client
    • Showing the client status
    • Starting the terminal emulator
    • Starting the printer emulator
    • The installation and maintenance program
    • The CICS clients online documentation (optional)

14. If your AUTOEXEC.BAT file has been updated, remove any diskette, shut down the system, and restart. If the file was not updated, rename AUTOEXEC.ADD to AUTOEXEC.BAT before shutting down the system. (AUTOEXEC.ADD will be in the same directory as AUTOEXEC.BAT.)

Updating your CICS Client for Windows and CICS Client for Windows 95 system

This section describes how you update your CICS Client for Windows or CICS Client for Windows 95 system with new service levels. This is done using corrective service software     which allows you to service an installed CICS clients system with the latest level of software. You can install the corrective service software:

• Interactively, by running the installation and maintenance program from the icon in the CICS client group or folder.

• Automatically, using a response file (see "Automatic installation of CICS Client for Windows and CICS Client for Windows 95").

The installation and maintenance program

When a CICS client is installed, the installation and maintenance program is installed along with the product software.

The icon for the installation and maintenance program is displayed in the CICS Client for Windows group or CICS Client for Windows 95 folder. From this icon you can run the program to maintain all installed CICS clients systems. The installation and maintenance program allows you to:

• Install new CICS client systems, and additional CICS client components
• Update installed CICS client systems
• Restore backed up CICS client systems
• Delete installed CICS client systems

You can update from diskette or from a redirected LAN drive.

The update process

The installation and maintenance program works with catalogs of products. A catalog contains a list of products; when you open a catalog, the installation and maintenance program lists the products that it contains. Before you update CICS Client for Windows or CICS Client for Windows 95, you must open the catalog for CICS Client for Windows or CICS Client for Windows 95 and select the required product.

The process is as follows:

1. Click on the Installation Utility icon in the CICS Client for Windows group or CICS Client for Windows 95 folder. The installation and maintenance program starts, and displays the main panel.

2. Select the File action, followed by the Open catalog option from the pulldown menu.

3. Now, select the Drive option. The Open drive catalog panel is displayed and this allows you to select the drive containing the corrective service software. When you select the drive, the catalog file (for example, CCLCLNT.ICF) is listed under Filename. Select the appropriate drive and open the catalog. The products in the catalog are listed.

4. Make sure that the correct service level of CICS client is selected in the list of products.

   Make sure that you will have enough disk space for the product components you want to update, and any that you want to back up.

5. Select the Update action from the Action menu. The Update panel is displayed.    

6. If you select the check box to update the AUTOEXEC.BAT file, the file is updated automatically as part of the installation process. Your original AUTOEXEC.BAT file is renamed to AUTOEXEC.BAK and is stored in the same directory. If you do not select this check box, an AUTOEXEC.ADD file is generated, containing the necessary updates to the PATH statement in the AUTOEXEC.BAT file.  

7. If you select the Save a backup version check box, the system being replaced by the application of the corrective service software is backed up. The backed up system can later be restored to the previous service level by selecting the Restore option from the Action menu. This gives you the chance to check that the updated system works correctly before you delete the old system.

8. Select the Update push button. The installation and maintenance program unpacks and copies the modules from the corrective service software to the installed system.

Updating an installed CICS client system causes the client initialization file, keyboard mapping file, and color mapping file, to be overwritten. Although these files are backed up, it is recommended that you keep your own customized versions of these files with different names to those supplied. You should then reference these customized files by environment variables see "Renaming the client initialization and mapping files".

Deleting a CICS Client for Windows or CICS Client for Windows 95 system

Before deleting a CICS Client for Windows or CICS Client for Windows 95 system, make sure that the client itself is not running. (If a file to be deleted is in use, the delete process stops.)

To delete a CICS Client for Windows or CICS Client for Windows 95 system:

1. Use the Installation utility to open the catalog used to install the system. If you use the catalog you used for updating, only the files transferred from the corrective service software are deleted.

2. Select the Delete option from the Actions menu. The Delete panel is displayed.  

3. Select the components you want to delete. To select or deselect all of the components, click on Select or Deselect respectively. If you want to delete only the backup versions, select the Delete only the backup versions check box.

4. Select the Delete push button. A progress panel is displayed, showing the proportion of files already deleted. You can select the Stop push button to stop the deletion.

Attention: When you mark components for deletion it is not possible to delete some files immediately, because they are in use. The files that cannot be deleted are removed by running the EPFIDEFI.BAT file, which is placed in the root directory of the drive containing the operating system.

Automatic installation of CICS Client for Windows and CICS Client for Windows 95

You can perform automatic installation and maintenance of CICS Client for Windows and CICS Client for Windows 95 by supplying the required options in a response file. It is therefore possible to install CICS Client for Windows and CICS Client for Windows 95 on workstations without user interaction being required at the workstation.

This kind of automatic installation is particularly useful for installing CICS Client for Windows and CICS Client for Windows 95 over a network because installation can be performed from a redirected LAN drive. (Refer to the documentation for your network operating system if you need to know how to connect to network drives.)

To start the installation, call the installation program by entering INSTALL together with the required parameters. For example:

       INSTALL /A:I /R:F:\INSTCICS\CICSCLI.RSP

       /S:F:\INSTCICS

       /L1:F:\INSTCICS\CICSCLI.OUT

       /L2:F:\INSTCICS\CICSCLI.HIS /X

In this example, CICS Client for Windows is installed from the redirected drive F: on the server, according to the options supplied in the response file CICSCLI.RSP. The response file specifies the drive and directory in which to install CICS Client for Windows or CICS Client for Windows 95. Errors are logged in CICSCLI.OUT and the history log is contained in CICSCLI.HIS.   The /X parameter specifies that the installation is noninteractive.

Note: The base level of CICS Client for Windows or CICS Client for Windows 95 is installed using the INSTALL command, while corrective service software is installed using the EPFINSTS command.

The installation and maintenance parameters are described in "The installation and maintenance parameters".

Installing CICS Client for Windows NT

You can install from diskette, over a LAN, or from CD-ROM (see "Methods of installing CICS clients".)

The installation procedure

This section describes the process of installing CICS Client for Windows NT interactively. It is also possible to install CICS Client for Windows NT using a response file, see "Automatic installation of CICS Client for Windows NT".

Online help is available throughout the process, by selecting the Help push button or by pressing PF1. It is important to browse through the README.TXT file provided on the installation diskette before you start the installation.

Note: During installation CICS Client for Windows NT creates a Windows Program Manager group to contain the CICS Client for Windows NT icons. However, If you are using an alternative Windows shell, the group may not be created correctly. In such cases you must ensure that the standard Windows Program Manager (PROGMAN.EXE) is running before starting installation.

Before you start, make sure that you have at least 150 KB of free space on the drive containing the operating system. This is required by the installation program.

1. Enter one of the following Run commands:

   CD-ROM Installation: d:\CLIENTS\I86_CLNT\CLIENTS\WNT\INSTALL

   Diskette installation: d:INSTALL

   LAN installation: d:INSTALL

   where d: is a CD-ROM, diskette, or network drive. After the files are loaded, an introductory CICS clients panel is displayed.

2. To proceed, click on the Continue push button, or press the Enter key.

   The Install panel is displayed.  

3. Select the Overwrite files check box to automatically replace all workstation files that have the same name and location as the product files being installed. If you do not select this check box, the installation and maintenance utility programs will warn you before overwriting an existing workstation file.

4. Select the OK push button to continue. The Install--directories panel is displayed.  

5. The list box shows the installation options that you can select. When you select one or more of these options, the Bytes needed field shows the amount of disk space required for installation. If there is too little space on your hard disk for the installation, an action message appears before the Install--directories panel. In this case, cancel the installation by selecting the OK push button. Find out which of your existing files you can archive or delete to make more space before proceeding further.

   Use the push buttons as necessary:

   • To display descriptions of the selected options, select Descriptions.
   • To select all of the options, select Select all.
   • To deselect all of the options, select Deselect all.

   The High-Level Directory entry field allows you to specify a drive and directory other than the default (C:\CICSCLI)

6. To show how much disk space is available on each drive, select the Disk space push button. The Disk space panel is displayed.  

   The list box shows the amount of available disk space for each drive, and whether installation is possible. Select a drive from the list box if required. If you also select the Change directories to selected drive check box, when you return to the Install--directories panel, your selected drive is shown in the High-Level Directory field.

7. Select the Install push button to continue. An Installation progress panel is displayed. The panel shows:

   • The file currently being installed (source) and the drive and directory to which it is being installed (target)

   • A progress bar, indicating the number of files already unpacked and installed

   • The elapsed time

   • The status, for example, unpacking, processing, or transferring
   If you select the Stop push button, you are asked whether you want to delete the partial system you have installed. Select Yes to delete the files already installed and return to the introductory CICS clients panel. Then, select Start install from the File menu to start the installation again.

8. If you have Administrator privileges, a panel is displayed asking you whether you want to install CICS Client for Windows NT as a common program group, or as a personal program group.

   The panel also allows you to select:

   • Whether the PATH environment variable is updated with the CICS Client for Windows NT path

   • Whether CICS Client for Windows NT is registered as a Windows NT service, see "Running CICS Client for Windows NT as a Windows NT service".

9. A panel allowing you to select the language in which CICS clients messages are displayed is shown. Choose the required language and select OK.

10. Diskette installation only: Insert the next installation diskette when you are prompted.

11. When installation is complete, the Installation and Maintenance panel is displayed. Select OK, then exit from the introductory panel.

12. When the installation process is complete, a Windows NT Program Manager group is created (see Figure 28). In a fully installed system, the group window contains icons for:
    • The README.TXT file
    • Starting the client
    • Stopping the client
    • Showing the client status
    • Starting the terminal emulator
    • Starting the printer emulator
    • The installation and maintenance program
    • The CICS clients online documentation (optional)

13. Remove any diskette, shut down the system, and restart.

Updating your CICS Client for Windows NT system

This section describes how you update your CICS Client for Windows NT system with new service levels. This is done using corrective service software,     which allows you to service an installed CICS Client for Windows NT system with the latest level of software. You can install the corrective service software:

• Interactively, by running the installation and maintenance program from the icon in the CICS client group.

• Automatically, using a response file (see "Automatic installation of CICS Client for Windows NT").

The installation and maintenance program

When a CICS client is installed, the installation and maintenance program is installed along with the product software.

The icon for the installation and maintenance program is displayed in the CICS Client for Windows NT group. From this icon you can run the program to maintain all installed CICS Client for Windows NT systems. The installation and maintenance program allows you to:

• Install new CICS client systems, and additional CICS client components
• Update installed CICS client systems
• Restore backed up CICS client systems
• Delete installed CICS client systems

You can update from diskette or from a redirected LAN drive.

The update process

The installation and maintenance program works with catalogs of products. A catalog contains a list of products; when you open a catalog, the installation and maintenance program lists the products that it contains. Before you update CICS Client for Windows NT, you must open the catalog for CICS Client for Windows NT and select the required product.

The process is as follows:

1. Click on the Installation Utility icon in the CICS Client for Windows NT group. The installation and maintenance program starts, and displays the main panel.

2. Select the File action, followed by the Open catalog option from the pulldown menu.

3. Now, select the Drive option. The Open drive catalog panel is displayed and this allows you to select the drive containing the corrective service software. When you select the drive, the catalog file (for example, CCLCLNT.ICF) is listed under Filename. Select the appropriate drive and open the catalog. The products in the catalog are listed.

4. Make sure that the correct service level of CICS client is selected in the list of products.

   Make sure that you will have enough disk space for the product components you want to update, and any that you want to back up.

5. Select the Update action from the Action menu. The Update panel is displayed.    

6. If you select the Save a backup version check box, the system being replaced by the application of the corrective service software is backed up. The backed up system can later be restored to the previous service level by selecting the Restore option from the Action menu. This gives you the chance to check that the updated system works correctly before you delete the old system.

7. Select the Update push button. The installation and maintenance program unpacks and copies the modules from the corrective service software to the installed system.

Updating an installed CICS client system causes the client initialization file, keyboard mapping file, and color mapping file, to be overwritten. Although these files are backed up, it is recommended that you keep your own customized versions of these files with different names to those supplied. You should then reference these customized files by environment variables see "Renaming the client initialization and mapping files".

Deleting a CICS Client for Windows NT system

Before deleting a CICS Client for Windows NT system, make sure that the client itself is not running. (If a file to be deleted is in use, the delete process stops.)

To delete a CICS Client for Windows NT system:

1. Use the Installation utility to open the catalog used to install the system. If you use the catalog you used for updating, only the files transferred from the corrective service software are deleted.

2. Select the Delete option from the Actions menu. The Delete panel is displayed.  

3. Select the components you want to delete. To select or deselect all of the components, click on Select or Deselect respectively. If you want to delete only the backup versions, select the Delete only the backup versions check box.

4. Select the Delete push button. A progress panel is displayed, showing the proportion of files already deleted. You can select the Stop push button to stop the deletion.

Attention: When you mark components for deletion it is not possible to delete some files immediately, because they are in use. The files that cannot be deleted are removed by running the EPFIDEFI.BAT file, which is placed in the root directory of the drive containing the operating system.

Automatic installation of CICS Client for Windows NT

You can perform automatic installation and maintenance of CICS Client for Windows NT by supplying the required options in a response file. It is therefore possible to install CICS Client for Windows NT on workstations without user interaction being required at the workstation.

This kind of automatic installation is particularly useful for installing CICS Client for Windows NT over a network because installation can be performed from a redirected LAN drive. (Refer to the documentation for your network operating system if you need to know how to connect to network drives.)

To start the installation, call the installation program by entering INSTALL together with the required parameters. For example:

       INSTALL /A:I /R:F:\INSTCICS\CICSCLI.RSP

       /S:F:\INSTCICS

       /L1:F:\INSTCICS\CICSCLI.OUT

       /L2:F:\INSTCICS\CICSCLI.HIS /X

In this example, CICS Client for Windows NT is installed from the redirected drive F: on the server, according to the options supplied in the response file CICSCLI.RSP. The response file specifies the drive and directory in which to install CICS Client for Windows NT. Errors are logged in CICSCLI.OUT and the history log is contained in CICSCLI.HIS.   The /X parameter specifies that the installation is noninteractive.

Note: The base level of CICS Client for Windows NT is installed using the INSTALL command, while corrective service software is installed using the EPFINSTS command.

The installation and maintenance parameters are described in "The installation and maintenance parameters".

Installing CICS Client for Macintosh

Note: If you are re-installing CICS Client for Macintosh, you may want to save any modified option files in a separate folder to protect them from being overwritten

To install CICS Client for Macintosh:

1. Insert the installation diskette and double-click on the disk icon. An installation folder containing several icons appears.

2. Double-click the Readme icon to browse through the README file for CICS Client for Macintosh if required.

3. Double-click the CICSInstall icon to start the installation.

4. An introductory panel is displayed. Select Continue to continue with the installation.

5. A CICSInstall panel is displayed.

6. If you want to install CICS Client for Macintosh into a folder other than the default CICSCLI folder, choose Select Folder and enter the folder name.

7. If you want to install all components of CICS Client for Macintosh, simply select Install to start the installation.

8. If you want to select only certain components for installation, select Custom Install from the pull-down. You then have the following menu choices:

   • CICS Client for Macintosh

     After you click on the arrow, you can select individual components of CICS Client for Macintosh

   • Language Selection

     After you click on the arrow, you must select the language in which CICS clients messages are displayed. It is important to select a language, otherwise CICS Client for Macintosh may not be installed properly.

   When you have chosen the required options, return to the CICSInstall panel and select Install.

9. An installation progress panel is displayed while CICS Client for Macintosh is installing.

To exit from the installation process at any time, select Quit. Online help is available.

The installation process creates folders for CICS Client for Macintosh, (see "CICS Client for Macintosh"), and adds the CICS Client preferences file to the Preferences folder. The BIN folder contains icons as shown in Figure 29. The installation process also adds the following to the Extensions folder:

• CCLMAC.LIB
• CCLMACIP
• CCLMACSN

Also, it may leave the following temporary files in the System folder:

• Install cleanup

• Install temp folder, containing:
  • CCLMAC.LIB
  • CCLMACIP
  • CCLMACSN

These objects are not part of the installation itself, and are deleted automatically the next time the system is restarted.

You can use the installation program to remove components of CICS Client for Macintosh. To do this, select the Custom Remove pull-down option from the CICSInstall panel. This only removes the CICS extensions. You can remove the CICS Client for Macintosh folder by dragging it to the Wastebasket.

Updating your CICS Client for Macintosh system

To update your CICS clients system with new service levels, you use corrective service software.     This allows you to service an installed CICS clients system with the latest level of software.

To install a corrective service software, proceed in the same way as for installing CICS Client for Macintosh. Remember to read the README file supplied with the corrective service software.

Deleting your CICS Client for Macintosh system

To delete your CICS Client for Macintosh.

1. Remove the CICSCLI folder from the system

2. Remove CCLMACIP, CCLMACSN, and CCLMAC.LIB from the Extensions folder

3. Remove 'CICS Client Prefs' from the Preferences folder.

CICS clients directory structure

This section describes the directory structure (or in the case of CICS Client for Macintosh, the folder structure) of the CICS clients.

Note: The actual on-screen presentation of this structure may vary from that shown in the diagrams.

CICS Client for DOS

The directory structure for CICS Client for DOS is as shown in Figure 11.

Figure 11. CICS Client for DOS directory structure

CICS Client for OS/2

The directory structure for CICS Client for OS/2 is as shown in Figure 12.

Figure 12. CICS Client for OS/2 directory structure

CICS Client for Windows and CICS Client for Windows 95

The directory structure for CICS Client for Windows and CICS Client for Windows 95 is as shown in Figure 13.

Figure 13. CICS Client for Windows and CICS Client for Windows 95 directory structure

CICS Client for Windows NT

The directory structure for CICS Client for Windows NT is as shown in Figure 14.

Figure 14. CICS Client for Windows NT directory structure

CICS Client for Macintosh

The folders for CICS Client for Macintosh are named to correspond to directory names for the other CICS clients, that is, bin, headers, lib, and samples.

Contents of the CICS clients directories or folders

The directories or folders contain the following files:

CICSCLI

The default High-level directory name, selected during installation. BIN The .EXE, .DLL and .INI files for the CICS clients. LIB The supplied library files for linking user applications. INCLUDE Header files for C and C++ programs. HEADERS CICS Client for Macintosh only: Header files for C programs. PLIHDR Include files for PL/I programs. Note: CICS Client for OS/2 only. COPYBOOK Copybook files for COBOL programs. SAMPLES All product-supplied samples. C All supplied samples written in C. CPP All supplied samples written in C++ (all CICS clients except CICS Client for DOS and CICS Client for Macintosh) COBOL All supplied samples written in COBOL. Note: CICS Client for DOS and CICS Client for OS/2 only. PL/I All supplied samples written in PL/I. Note: CICS Client for OS/2 only. REXX All supplied samples written in REXX. Note: CICS Client for OS/2 only. LOTUS All samples for CICS gateway for Lotus Notes Note: CICS Client for OS/2 and CICS Client for Windows NT only. VB All samples written in Visual Basic Note: CICS Client for Windows, CICS Client for Windows 95, and CICS Client for Windows NT only. SERVER Sample programs required for CICS servers. OLE Files supporting Object Linking and Embedding (OLE) for Visual Basic Note: CICS Client for Windows, CICS Client for Windows 95, and CICS Client for Windows NT only. BOOKS All manuals shipped with the product. CIG CICS Internet gateway files. Note: CICS Client for OS/2 and CICS Client for Windows NT only. ADMIN CICS Internet gateway files BIN CICS Internet gateway executable files. CGI Common Gateway Interface (CGI) files. HTML HyperText Markup Language (HTML) files. LOTUS CICS gateway for Lotus Notes files. Note: CICS Client for OS/2 and CICS Client for Windows NT only.

Notes:

1. The SAMPLES directory or folder is created only if you install the CICS clients samples component.

2. The subdirectories or folders created under the SAMPLES directory depend on the languages supported for the CICS client installed.

3. The BOOKS directory or folder is created only if you install the CICS client documentation component.

4. The \LOTUS directories are created only if you install the CICS gateway for Lotus Notes components of CICS Client for OS/2 or CICS Client for Windows NT.

5. The \CIG directories are created only if you install the CICS Internet gateway component of CICS Client for OS/2 and CICS Client for Windows NT.

Other actions required in setting up a CICS client

This section describes what you can do after the client software has been installed, and before you edit the client initialization file and start the client.

CICS Client for DOS

Before you can start CICS Client for DOS, you must run CICSCTSR, the terminate and stay resident (TSR) program. The supplied program CICSDOSC.BAT runs CICSCTSR (which starts the client DOS support service) and then starts CICS Client for DOS automatically.

You may, therefore, want to add the following to your AUTOEXEC.BAT file:

CALL CICSDOSC

Reducing memory requirements for CICS Client for DOS

You may need to review and reduce the memory requirements of CICS Client for DOS.

The CICS Client for DOS TSR program is in two pieces: CICSCTSR.EXE, which is loaded once and stays resident, and CCLCLNT.EXE, which may be loaded and unloaded using the CICSCLI command. CICSCTSR.EXE requires approximately 4 KB of memory, while CCLCLNT.EXE requires approximately 79 KB of memory.

Additional memory is then required according to the contents of the client initialization file.   The DOS memory pool must be allocated and the size of this is controlled by the DosMemory parameter in the Client section of the client initialization file, the default being 48 KB. Each device driver listed in a Driver section must also be loaded. The approximate memory requirements of these are:

CCLIBMNB.DLL	14 KB
CCLIBMIP.DLL	48 KB
CCLFTPIP.DLL	49 KB
CCLNOVIP.DLL	44 KB
CCLNOVSN.DLL	20 KB
CCL400SN.DLL	6 KB

The client and any loaded drivers allocate any additional memory they require from the client's DOS memory pool. These requirements vary but are typically based on the MaxServers and MaxBufferSize parameters in the Client section of the client initialization file.

Note: If you are using the trace to memory function, you must increase the DosMemory value.

Therefore, to reduce memory requirements to a minimum, edit the following in the client initialization file:

1. Remove all unwanted Driver sections from the initialization file.

2. Reduce the MaxServers parameter to a minimum (the minimum value is 1).

3. Reduce the MaxBufferSize parameter to a minimum (the minimum value is 4).

4. Reduce the DosMemory parameter to a minimum (the minimum value is MaxBufferSize + 4). However, more may be required if the message CCL2007E Free memory is exhausted is displayed.

For more information on the client initialization file, refer to "Preparing the client initialization file".

CICS Client for OS/2

If you want the CICS terminal emulation to be started automatically when OS/2 starts up, create a shadow of the CICS Terminal icon and place it in the OS/2 startup folder.

CICS Client for Windows

If you want the CICS terminal emulation to be started automatically when Windows starts up, move or copy the CICS Terminal icon to the Startup group.

WIN-OS2 considerations

For Windows clients running under OS/2 Version 2.0, you should select Win-OS2 Window in the Settings notebook for the terminal and control panel icons. Do not set them to separate sessions (that is, do not select the Separate sessions check box in the Settings notebook).

It is useful to have the Windows Program Manager running in a separate session to that used by the client. This ensures that when the Program Manager is closed, the client session is not closed as well.

CICS Client for Windows 95

If you want the CICS terminal emulation to be started automatically when Windows 95 starts up, move or copy the CICS Terminal icon to the Startup folder.

CICS Client for Windows NT

If you want the CICS terminal emulation to be started automatically when Windows NT starts up, move or copy the CICS Terminal icon to the Startup group.

CICS Client for Macintosh

To start CICS Client for Macintosh automatically when you switch on or restart your Apple Macintosh, create an alias of the CICS Client from the bin folder and place it in your Startup Items folder in the System folder. If started this way, the client picks up the initialization file name from the CICS Client Prefs file in your Preferences folder. You can change the initialization file name held in the CICS Client Prefs file via the File menu of the CICS Client Admin (CICSCLI) application.

(1) If installing in WIN-OS2, you cannot specify directory names longer than 8 characters.