IBM
Shop Support Downloads
Home Products Consulting Industries News About IBM Search
IBM > Software > Transaction Systems > CICS > Library > Manuals >
 

 

Administration


[Return to Library] [Contents] [Previous Topic] [Bottom of Topic] [Next Topic] [Index] [Help]


Distributing CICS clients in a network

This topic discusses

CICS Client for OS/2 and CICS Client for Windows Family are CID-enabled products, that is, they conform to IBM's configuration, installation, and distribution (CID) architecture. Such products can be automatically installed and maintained. Indeed, CICS Client for OS/2 can be tailored and automatically distributed to workstations on a LAN, without any action being required at those workstations.


Configuration, distribution, installation

     

The CID architecture is a set of standards that allows installation of software on workstations from code residing at a LAN server. This saves you the bothersome tasks of inserting diskettes and responding to prompts and messages at each client workstation. Installation can be lightly attended, meaning that entering the install command is all that is required at the workstation. The lightly attended installation process is described in this topic.

For CICS Client for OS/2 only, installation can also be unattended, meaning that you can automatically install CICS clients on many workstations without any end user action being required. This makes installation and maintenance of CICS clients much easier. Unattended CID is performed under the control of a software distribution manager (SDM), which remotely installs the CID-enabled product.     Examples of SDMs are NetView Distribution Manager (NVDM/2), Start/2, and SystemView for OS/2. Unattended CID is beyond the scope of this book; refer to the documentation for your SDM-providing product for a full description of unattended CID.

For both lightly attended and unattended CID, the installation and maintenance options are supplied in a response file.   You invoke the installation program with parameters that identify the source and target directories, and the response file. The progress of the installation is recorded in an error log and history log. Return codes are notified to the software distribution manager.


Performing installation and maintenance

The procedure for lightly attended CID is as follows:

  1. Copy the contents of the CICS clients diskettes to a local or LAN drive, for example:
    
    XCOPY a:\*.* /s /e
    
    

  2. Edit the supplied response file CICSCLI.RSP or create a new response file. The supplied file CICSCLI.RSP can handle only install and delete actions.

  3. Start the installation, 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, the CICS client 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 the client. 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 the CICS client is installed using the INSTALL command, while corrective service software is installed using the EPFINSTS command.

  4. The installation proceeds automatically.

The installation and maintenance parameters

 

The installation and maintenance parameters are as follows:


INSTALL /A:action

        /G:include-path

        /L1:error-log

        /L2:history-log

        /P:product-name

        /R:response-file

        /S:source-location

        /T:install-target-directory

        /TU:update CONFIG.SYS directory

        /X

Note: You can enter the parameters in any order. Equals signs (=) can be used instead of colons (:) in the parameters. Values can be uppercase or lowercase.

/A:action

Specifies the action to be performed by the installation program. If you specify this parameter, the main window of the installation program is not displayed. Valid values for action are:

D

Delete an installed CICS client system

I

Install a new CICS client system

R

Restore a backed-up CICS client system

U

Update an installed CICS client system

These actions are the same as those provided by the installation utility (see for example, "Updating your CICS Client for OS/2 system").

Note: The installation program is not supplied with corrective service diskettes. Therefore, if you are updating, restoring, or deleting a CICS client, you must have access to the installation program used to install the CICS client.

/G:include-path

Specifies the drive and path of a general response file to be included by the specific response file. For more information about response files, see "Response files".

/L1:error-log

Specifies the drive, path, and file name of the error log file. The error log contains messages associated with installation, including confirmations and error messages. Messages are written to the error log even if you specify the /X parameter.

You should specify the drive and path where the installation program is running. If you do not specify the /L1 parameter, no error log is maintained. If you specify an error log that already exists, it is appended to.

Example:


/L1:F:\CICSCLI\CICSCLI.LOG

/L2:history-log

Specifies the drive, path, and file name of the history log file.     The history log contains an entry for each file transferred, each workplace shell object (OS/2) or Program Manager icon (Windows) created, and each Installation Exit run.

You should specify the drive and path where the installation program is running. If you do not specify the /L2 parameter, no history log is maintained. If you specify a history log that already exists, it is appended to.

Example:


/L2:F:\CICSCLI\CICSCLI.HIS

/P:product-name

Specifies the catalog name of the product to perform the action on.

/R:response-file

Specifies the drive, path, and file name of a response file, (see "Response files").

Example:.


/R:L:\CICSINS\CICSCLI.RSP

/S:source location

Specifies the drive and path containing the source files to be installed or updated.

/T:install-target-directory

Specifies the drive and path that CICS client files are installed into. If you specify this parameter, it overrides the FILE path specified in the response files.

/TU:update target CONFIG.SYS directory

Specifies the drive and path of the target CONFIG.SYS (OS/2) or AUTOEXEC.BAT (Windows and Windows 95) to be updated.

/X

Specifies that the installation is fully automatic.

When you specify this parameter, no progress indicator panel is shown and error messages are logged in the error log file. (You specify the path name of the error log file using the /L1 parameter.) If you do not specify all of the information required for the action to complete, an error occurs.

If you do not specify the /X parameter, the user is prompted for any information that the installation program needs to complete the action. In this interactive mode of operation, progress indication is shown and error messages are displayed in secondary windows.

Response files

 

A response file is an ASCII text file containing answers to the options that you select when you install or maintain a CICS client system. This allows installation and maintenance to be performed automatically, without interaction.

In a response file you can specify:

  • Whether environment information should be updated automatically
  • The CICS clients components to be installed
  • The path for installation or maintenance
  • Whether existing files should be overwritten
  • Whether only backup versions of CICS clients should be deleted

The response file supplied with CICS Client for OS/2 is shown in Figure 38. You can use such a response file to install or delete CICS clients. To perform other actions you must prepare your own response files using a suitable editor.

Normally, you will have only one response file, specified by the /R parameter of the installation program. However, you may sometimes need to install or update a CICS client on a workstation with different options. In this case you can use one response file as a general response file to be included in a specific response file. The specific response file would contain options specific to a particular workstation, and the general response file would contain options common to all workstations. For example, you might use a general response file and a specific response file to install a particular component on only certain workstations. You use the /R parameter to specify the specific response file, and the /G parameter to specify the location of the general response file.

Response file keywords

   

The following keywords are supported in response files for CICS clients:

CFGUPDATE

Specifies whether the installation program automatically updates the environment information in CONFIG.SYS (CICS Client for OS/2), or AUTOEXEC.BAT (CICS Client for Windows and CICS Client for Windows 95) or the Windows NT registry. Valid values for this keyword are:

AUTO

Automatically updates the environment information

MANUAL

Does not update the environment information

Actions: INSTALL, UPDATE, DELETE.

COMP

Specifies the name of a component to perform an action on. Valid values are:

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

In addition, the following are valid for CICS Client for OS/2 and CICS Client for Windows NT:

  • CICS Gateway for Lotus Notes
  • CICS Internet Gateway

You do not need to enclose the component names within quotes. The name is not case-sensitive.

Actions: ALL actions.

DELETEBACKUP

Specifies whether to delete only the backup version of CICS client or the entire product. Valid values for this keyword are YES (delete backup version only) and NO (delete current version).

Actions: DELETE.

FILE

Specifies the drive and directory in which to install CICS client; for example, the C:\CICSCLI directory. This keyword applies to the installation action only.

Actions: INSTALL.

INCLUDE

Specifies which general response files to include with a specific response file. The format of this keyword is:


INCLUDE = filespec

where filespec specifies the general response file to be included. If the file specification contains any global characters (* or ?), the first file found that matches the specification is included. If the specification is not valid, no general response file is included.

Note: You should not have more than five levels of included response files.

Actions: All actions.

OVERWRITE

Specifies whether to overwrite files automatically during installation. Valid values for this keyword are YES and NO.

Actions: INSTALL, UPDATE.

SAVEBACKUP

Specifies whether to save a backup version of the CICS client when it is updated. Valid values for this keyword are YES and NO.

Actions: UPDATE.

CICSCLIINI

Specifies the name of a customized CICSCLI client initialization file. If no customized initialization file is to be provided, the value of the parameter must be set to an asterisk (*).

Before the installation is started, the customized .INI file must be placed in (or below) the source directory from which the installation is taking place. The value of the parameter must specify the path relative to this source directory. The .INI file is copied to the \BIN subdirectory on the target, and the CICSCLI environment variable set in CONFIG.SYS (or AUTOEXEC.BAT or the Windows NT registry). Thus, if the customized file (MYCLI.INI) is placed in the subdirectory \MYFILES under the source directory, the value of the parameter would be CICSCLIINI = MYFILES\MYCLI.INI.

Actions: INSTALL.

CICSCOLINI

Specifies the name of a customized CICSCOL color mapping file used to tailor the colors for the CICSTERM terminal emulator. If no customized mapping file is to be provided, the value of the parameter must be set to an asterisk (*).

The customized file is copied into the \BIN subdirectory on the target system, and the CICSCOL environment variable set.

See the CICSCLIINI keyword description for details of how to specify the file name, and where the customized file should be placed before installation.

Actions: INSTALL.

CICSKEYINI

Specifies the name of a customized CICSKEY keyboard mapping file used to tailor the keys for the CICSTERM terminal emulator. If no customized mapping file is to be provided, the value of the parameter must be set to an asterisk (*).

The customized file is copied into the \BIN subdirectory on the target system, and the CICSKEY environment variable set. See the CICSCLIINI keyword description for details of how to specify the file name, and where the customized file should be placed before installation.

Actions: INSTALL.

MESSAGELANG

Specifies the language of messages sent to the CICS clients. Valid values are:
AA Arabic
CN Simplified Chinese
TW Traditional Chinese
CZ Czech
DK Danish
FI Finnish
FR French
FR Canadian French
DE German
HU Hungarian
IT Italian
JP Japanese
KR Korean
NO Norwegian
PL Polish
BR Brazilian Portuguese
PT Portuguese
RU Russian
ES Spanish
SE Swedish
TR Turkish
US US English

Actions: INSTALL.

INSTALLTYPE

Specifies whether CICS Client for Windows NT is to be installed as a common application (the program group is visible to all users and the client defaults to a common set of .INI and message files) or as a personal application (the program group is visible and available only to the installing user). If the installing user is not a member of the Administrators user group this option is ignored and CICS Client for Windows NT installed as a personal application. Valid values for this keyword are:

C

Installs CICS Client for Windows NT as a common application

P

Installs CICS Client for Windows NT as a personal application

Actions: INSTALL

REGISTERSERVICE

Specifies whether CICS Client for Windows NT should be registered as a Windows NT service during installation. Valid values for this keyword are:

YES

Registers CICS Client for Windows NT as a Windows NT service

NO

Does not register CICS Client for Windows NT as a Windows NT service

Response file structure

   

There are two kinds of line in a response file:

  • Comment lines

    Comment lines are either blank or start with an asterisk (*) or a semicolon (;).

  • Response lines

    Response lines are used to determine the options and configurations to install on the target system.

    Response lines have the following syntax:

    
    keyword = value
    
    

    Keyword-value pairs can be in any order. However, there can be only one pair per line.

    You can enter keywords in uppercase or lowercase letters. You cannot include spaces within keywords.

The maximum line length in a response file is 255 characters.

Response file sample

Figure 38. Sample CICS clients response file - CICS Client for OS/2


*********************************************************************

*                                                                   *

* Customer Information Control System (CICS) Client for OS/2        *

*                                                                   *

*       33H2411 (C) COPYRIGHT IBM CORP 1994, 1995                   *

* ALL RIGHTS RESERVED. LICENSED MATERIALS - PROPERTY OF IBM         *

*                                                                   *

*********************************************************************

*

* This response file can be used to install or delete CICS Client for OS/2.

* Values supplied here over-ride values supplied in the .PKG files,

* (it is recommended you DO NOT alter the values in the .PKG files).

* Values supplied on the INSTALL command over-ride values supplied in

* this response file.

*

* CFGUPDATE specifies whether CONFIG.SYS is updated automatically,

* valid values are AUTO - automatically updates CONFIG.SYS

*                  MANUAL - does not update CONFIG.SYS.

CFGUPDATE = AUTO

*

* COMP identifies the components of CICS Client for OS/2 that this

* Response file applies to.

COMP = CICS Client runtime system

COMP = CICS Client programming samples

COMP = CICS Gateway for Lotus Notes

COMP = CICS Internet Gateway

COMP = CICS Client documentation

*

* for Install only FILE provides the default path that CICS Client for OS/2 will be

* installed into.

FILE = C:\CICSCLI

*

* OVERWRITE specifies whether to automatically overwrite files during

* installation, valid values are YES - overwrite files

*                                NO - do not overwrite files.

OVERWRITE = YES

*

* DELETEBACKUP specifies during delete whether to delete only backup

* versions of CICS Client for OS/2. Valid values are:-

*                               YES - delete backup version only

*                               NO - delete current version

DELETEBACKUP = NO

*



*

* CICSCLIINI specifies the name of a customized CICSCLI initialization

* file. This value is only applicable during installation. If no customized

* initialization file is to be provided, then the value of the

* parameter must be set to an asterisk (*).

*

* Before the installation is started, the customized .INI file must be placed

* in (or below) the source directory from which the installation is taking

* place. The value of the parameter should specify the path relative to this

* source directory. The .INI file will be copied to the BIN subdirectory on

* the target, and the CICSCLI environment variable set in CONFIG.SYS.

* Thus if the customized file (mycli.ini) has been placed in directory

* myfiles under the source directory, then the value of the parameter would

* be CICSCLIINI = myfiles\mycli.ini.

*

CICSCLIINI = *

*

*

* CICSCOLINI specifies the name of a customized CICSCOL initialization

* file used to tailor the colors for the CICSTERM terminal emulator.

* This value is only applicable during installation. If no customized

* initialization file is to be provided, then the value of the

* parameter must be set to an asterisk (*).

*

* The customized file is copied into the BIN subdirectory on the target

* system, and the CICSCOL environment variable set.

*

* See CICSCLIINI for details of how to specify the filename, and where the

* customized file should be placed prior to installation.

*

CICSCOLINI = *

*

*

* CICSKEYINI specifies the name of a customized CICSKEY initialization

* file used to tailor the keys for the CICSTERM terminal emulator.

* This value is only applicable during installation. If no customized

* initialization file is to be provided, then the value of the

* parameter must be set to an asterisk (*).

*

* The customized file is copied into the BIN subdirectory on the target

* system, and the CICSKEY environment variable set.

*

* See CICSCLIINI for details of how to specify the filename, and where the

* customized file should be placed prior to installation.

*

CICSKEYINI = *



*

*

* MESSAGELANG specifies the language in which messages sent to the user

* by the CICS Client will be in. The value is only applicable during

* installation. Valid values are:-

*

*                     MESSAGELANG = US     - US English

*                                   AA     - Arabic

*                                   CN     - Simplified Chinese

*                                   TW     - Traditional Chinese

*                                   CZ     - Czechoslovakian

*                                   DK     - Danish

*                                   FI     - Finnish

*                                   FR     - French

*                                   FR     - Canadian French

*                                   DE     - German

*                                   HU     - Hungarian

*                                   IT     - Italian

*                                   JP     - Japanese

*                                   KR     - Korean

*                                   NO     - Norwegian

*                                   PL     - Polish

*                                   BR     - Brazilian Portuguese

*                                   PT     - Portuguese

*                                   RU     - Russian

*                                   ES     - Spanish

*                                   SE     - Swedish

*                                   TR     - Turkish

*

*

MESSAGELANG = US

*

*


Return codes

 

All return codes are two-byte hexadecimal values as follows:

00 00

Successful termination. No messages were logged.

00 04

Successful termination. Warning messages were logged. Restarting the workstation operating system is not required.

00 08

Successful termination. Error messages were logged. Restarting the workstation operating system is not required.

00 12

Successful termination. Severe error messages were logged. Restarting the workstation operating system is not required.

FE 00

Successful termination. Restarting the workstation operating system is required. Do not invoke the installation and maintenance program again.

FE 04

Successful termination. Warning messages were logged. Restarting the workstation operating system is required. Do not invoke the installation and maintenance program again.

FE 12

Successful termination. Severe error messages were logged. Restarting the workstation operating system is required. Do not invoke the installation and maintenance program again.

FE yy

Successful termination. yy can vary within the range 00 to FF. Restarting the workstation operating system is required. Do not invoke the installation and maintenance program again.

Messages are logged only when the /X parameter is used.


Using SystemView for OS/2 to install CICS clients

           

You can use SystemView for OS/2 to install CICS Client for OS/2 on unattended workstations using the statements included in a file called a software profile and a response file. A software profile is used by SystemView for OS/2 to invoke an application installation program. A response file is used by the installation program to get all of the data it needs during the installation process.

Using SystemView for OS/2, you specify the information for the software profiles and response files when you customize the application definition file (.ADF), which defines how to install and configure CICS clients.   This file is shipped with CICS Client for OS/2 as CICSCLI.ADF.

For a complete description of software profiles and response files, refer to the SystemView for OS/2 online help or the SystemView for OS/2 Up and Running!, SH19-4184.

Overview of SystemView for OS/2 installation

To install CICS clients on workstations using SystemView for OS/2, you need to:

  1. Copy CICS clients files to the code server, that is, the workstation from which you will install CICS clients

  2. Add CICS clients information to the SystemView for OS/2 software library

  3. Configure CICS clients in the SystemView for OS/2 software library

  4. Distribute and install the resulting software object on target server workstations using SystemView for OS/2.

The first step is described in this book. For information on the other steps, refer to the SystemView for OS/2 online help or to the SystemView for OS/2 documentation.

Copying CICS clients to the code server

To set up the code server so that you can install CICS clients using SystemView for OS/2, use the XCOPY command.

For example, to copy the files for CICS Client for OS/2 from the CD-ROM in the E: drive to the D: drive, you would enter this command:


XCOPY E:\CLIENTS\I86_CLNT\CLIENTS\OS2\ D:\CID\IMG\CLIENTS\OS2 /S

This command would copy the files from the \CLIENTS\OS2 subdirectory on the CD-ROM in the E: drive to the D:drive, putting the files under the directory \CID\IMG\CLIENTS\OS2.

The /S indicates that all of the subdirectories and their contents, and the contents of the root directory should be copied.


[Return to Library] [Contents] [Previous Topic] [Top of Topic] [Next Topic] [Index] [Help]


[ IBM home page | (C) | (TM) ]
© IBM Corporation 1994, 1997. All Rights Reserved
 
Privacy Legal Contact