 |
POLYCENTER Software Installation Utility Developer's
Guide
execute login
The execute login statement displays a message when the
product is installed or reconfigured, informing the installer that the
specified commands need to be added to the login command procedure of
every user of this product.
Syntax
execute login (command,...) ;
Parameter
(command,...)
Indicates the commands that the utility displays in a message to the
user.
Description
The execute login statement displays a message when the
product is installed or reconfigured, advising the installer that the
specified commands need to be added to the login command procedure of
every user of this product. The specified commands are not run during
the installation or reconfiguration operation. The message is displayed
after the operation has completed successfully.
The execute login statement is a utility directive and does
not specify a managed object.
See Also Section 6.1
Example
|
execute login "$ @USER_START" ;
|
In this example, the execute login statement displays the
following message to users:
|
Users of this product require the following lines in their login procedure:
$ @USER_START
|
execute postinstall
The execute postinstall statement specifies commands to
execute when the product is installed or reconfigured. These commands
are run after any commands from execute install... and
execute start... statements are run.
Syntax
execute postinstall (command,...) [
interactive ] [ uses
(file,...) ] ;
Parameter
(command,...)
Indicates the command that the utility passes to the command
interpreter in the execution environment.
Option
interactive
Allows communication between the user and the specified command or
command procedure executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Use a separate file statement
to specify required files that are permanently placed in the user's
destination directory tree; use the uses option to
specify required files that are placed in a temporary directory and
deleted after use. By default, this statement does not require files.
Description
The execute postinstall statement specifies commands to
execute when the product is installed or reconfigured. These commands
are run after any commands from execute install... and
execute start... statements are run.
You specify actions to perform by including one or more DCL command
lines in the execute postinstall statement. These commands are
passed for execution to the DCL interpreter running in a subprocess.
Enclose each action, whether specified as a single DCL command or a
command procedure, in double
quotes (" "). If more than one action is given, use parentheses to
enclose the list.
If you want your commands to prompt the user and accept the user's
input, specify the execute postinstall statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute postinstall statement,
specify them in the uses option or in separate
file statements. Each file you specify with the
uses option must be present in the product material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted. For this reason, you must use
the file statement for this execute operation, and any other
operation, in which you want your execute command procedures placed
permanently in your file system.
The execute postinstall statement causes the POLYCENTER
Software Installation utility to define logical names for use by the
subprocess that executes the specified commands. The commands should
use these logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
- PCSI$DESTINATION is a root directory specification that points to
the root directory for the current scope where product material will be
placed.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that can be used by commands for temporary working space. This
directory and any files placed in it are automatically deleted at the
end of the operation.
The execute postinstall statement is a utility directive and
does not specify a managed object.
See Also Section 6.1
file
Example
|
execute
postinstall "@pcsi$source:[sysupd]product_cleanup.com"
uses [sysupd]product_cleanup.com ;
|
In this example, the execute postinstall statement sets up a
command procedure to run after the product is installed. The
uses option specifies the file name of the command
procedure that is deleted after use.
execute post_undo
The execute post_undo statement specifies commands to execute
when one or more patch kits are uninstalled by executing the PRODUCT
UNDO PATCH command. These commands are run after all directories,
files, and modules are processed.
Syntax
execute post_undo (command,...) [ interactive
] [ uses (file,...) ] ;
Parameter
(command,...)
Indicates the commands that the utility passes to the command
interpreter after uninstalling patch kits indicated in the recovery
data set being processed.
Options
interactive
Allows communication between the user and the specified command or
commands executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. The files listed with the
uses option are placed in a temporary directory only
when they are needed for the execution and are deleted after use. Note
that all of the files needed to execute the commands you specified in
the command parameter must also be listed with a separate
file statement.
Description
The execute post_undo statement specifies commands to execute
when one or more patch kits are uninstalled by executing the PRODUCT
UNDO PATCH command. These commands are run near the end of operation,
after all directories, files, and modules are processed. This statement
is useful for automatically running a command procedure to perform
cleanup or restore the system environment after one or more patch or
mandatory product updates have been removed.
You specify actions to perform by including one or more DCL command
lines in the execute post_undo statement. These commands are
passed for execution to the DCL interpreter running in a subprocess.
Enclose each action, whether specified as a single DCL command or a
command procedure, in double quotes. If more than one action is given,
use parentheses to enclose the list.
Enclosing the execute post_undo statement in a scope group
(consisting of scope and end scope statements) has no
effect on the way execute post_undo commands are processed.
If you want your commands to prompt the user and accept the user's
input, specify the execute post_undo statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages; that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute post_undo statement, you
must specify each one of them with the file statement. In
addition, if you want to place files needed for the execute
post_undo statement in a temporary directory and delete them
immediately after use, specify them with the uses
option.
There are certain restrictions on the use of the execute
post_undo statements:
- They can be packaged in a product kit only if the product is of a
patch or mandatory update type.
- Only one execute post_undo statement is allowed per
product.
The DCL commands supplied with the execute post_undo statement
are not executed during the product installation; they are merely
registered in the patch recovery data set description file for use in
the PRODUCT UNDO PATCH operation.
The execute post_undo statement causes the POLYCENTER Software
Installation utility to define logical names for use by the subprocess
that executes the specified commands. The commands should use these
logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute.
- PCSI$DESTINATION is a root directory specification that points to
the root directory where the patch or mandatory update product material
was placed in the installation operation.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that commands can use for temporary working space. The utility
automatically deletes this directory and any files placed in it at the
end of the operation.
The execute post_undo statement is a utility directive and
does not specify a managed object.
See Also Section 6.1
file
Example
|
file [SYSUPD]EXEC_POST_UNDO.COM ;
execute post_undo "@PCSI$SOURCE:[SYSUPD]EXEC_POST_UNDO.COM"
uses [SYSUPD]EXEC_POST_UNDO.COM ;
|
In this example, the execute post_undo statement sets up a
command procedure to run after the patch kit files are removed from the
system as a result of the PRODUCT UNDO PATCH command execution. The
uses option specifies the file name of the command
procedure that is deleted after use.
execute preconfigure
The execute preconfigure statement specifies commands to
execute after the user has selected the product for installation or
reconfiguration, but before the user is asked to select options for the
product.
Syntax
execute preconfigure (command,...) [
interactive ] [ uses
(file,...) ] ;
Parameter
(command,...)
Indicates the commands that the utility passes to the command
interpreter in the preconfiguration environment.
Option
interactive
Allows communication between the user and the specified command or
commands executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Files for the execute
preconfigure statement cannot be supplied by a separate
file statement because execute preconfigure is
processed before files are copied to the target disk.
Description
The execute preconfigure statement specifies commands to
execute after the user has selected the product for installation or
reconfiguration, but before the user is asked to select options for the
product. This statement is useful for automatically running a command
procedure in preparation for installing your product. This command
procedure is packaged in the kit and is run before the standard
configuration dialog with the user begins. The execute
preconfigure statement gives you the ability to do such things as
probe the system environment, ask the user questions, and define
logical names for use later in the processing of logical name
functions. The ability to conditionally provide product material, or to
perform other actions based on decisions made at the very start of the
operation, is a powerful and flexible mechanism.
Note
If you want to use logical name functions, the logical names
must be either defined by the action of execute preconfigure
statements, or by the user before the installation or reconfiguration
operation is initiated.
|
You specify actions to perform by including one or more DCL command
lines in the execute preconfigure statement. These commands
are passed for execution to the DCL interpreter running in a
subprocess. Enclose each action, whether specified as a single DCL
command or a command procedure, in double quotes. If more than one
action is given, use parentheses to enclose the list.
Enclosing the execute preconfigure statement in a scope group
(consisting of scope and end scope statements) has no
effect on the way execute preconfigure commands are processed.
If you want your commands to prompt the user and accept the user's
input, specify the execute preconfigure statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute preconfigure statement,
specify them in the uses option. Each file you specify
with the uses option must be present in the product
material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted.
The execute preconfigure statement causes the POLYCENTER
Software Installation utility to define logical names for use by the
subprocess that executes the specified commands. The commands should
use these logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
Note
The utility does not define the PCSI$DESTINATION logical name for use
by the execute preconfigure commands because the destination
is not finalized when the execute preconfigure statement is
processed. In certain situations, such as installing a patch kit or
re-installing the same version of a product, the actual destination is
determined later during the configuration phase.
|
- PCSI$SCRATCH is a subdirectory under the user's login directory
that commands can use for temporary working space. The utility
automatically deletes this directory and any files placed in it at the
end of the operation.
The execute preconfigure statement is a utility directive and
does not specify a managed object.
See Also Section 6.1
file
Example
|
execute preconfigure "@PCSI$SOURCE:[SYSUPD]EXEC_PREC.COM"
uses [SYSUPD]EXEC_PREC.COM ;
|
In this example, the execute preconfigure statement sets up a
command procedure to run before the product configuration begins. The
uses option specifies the file name of the command
procedure that is deleted after use.
execute pre_undo
The execute pre_undo statement specifies commands to execute
when one or more patch kits are uninstalled by executing the PRODUCT
UNDO PATCH command. These commands are run before any directories,
files, and modules are processed.
Syntax
execute pre_undo (command,...) [ interactive
] [ uses (file,...) ] ;
Parameter
(command,...)
Indicates the commands that the utility passes to the command
interpreter prior to uninstalling patch kits indicated in the recovery
data set being processed.
Options
interactive
Allows communication between the user and the specified command or
commands executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. The files listed with the
uses option are placed in a temporary directory only
when they are needed for the execution and are deleted after use. Note
that all of the files needed to execute the commands you specified in
the command parameter must also be listed with a separate
file statement.
Description
The execute pre_undo statement specifies commands to execute
when one or more patch kits are uninstalled by executing the PRODUCT
UNDO PATCH command. These commands are run before any directories,
files, and modules are processed. This statement is useful for
automatically running a command procedure in preparation for
uninstalling one or more patch or mandatory product updates. The
execute pre_undo statement gives you the ability to do such
things as ask the user questions, probe, or set the system environment
before a patch kit is uninstalled.
You specify actions to perform by including one or more DCL command
lines in the execute pre_undo statement. These commands are
passed for execution to the DCL interpreter running in a subprocess.
Enclose each action, whether specified as a single DCL command or a
command procedure, in double quotes (" "). If more than one action is
given, use parentheses to enclose the list.
Enclosing the execute pre_undo statement in a scope group
(consisting of scope and end scope statements) has no
effect on the way execute pre_undo commands are processed.
If you want your commands to prompt the user and accept the user's
input, specify the execute pre_undo statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages; that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute pre_undo statement, you must
specify each one of them with the file statement. In addition,
if you want to place files needed for the execute pre_undo
statement in a temporary directory and delete them immediately after
use, specify them with the uses option.
There are certain restrictions on the use of the execute
pre_undo statements:
- They can be packaged in a product kit only if the product is a
patch or mandatory update type.
- Only one execute pre_undo statement is allowed per product.
The DCL commands supplied with the execute pre_undo statement
are not executed during the product installation; they are merely
registered in the patch recovery data set description file for use in
the PRODUCT UNDO PATCH operation.
The execute pre_undo statement causes the POLYCENTER Software
Installation utility to define logical names for use by the subprocess
that executes the specified commands. The commands should use these
logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute.
- PCSI$DESTINATION is a root directory specification that points to
the root directory where the patch or mandatory update product material
was placed in the installation operation.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that commands can use for temporary working space. The utility
automatically deletes this directory and any files placed in it at the
end of the operation.
The execute pre_undo statement is a utility directive and does
not specify a managed object.
See Also Section 6.1
file
Example
|
file [SYSUPD]EXEC_PRE_UNDO.COM ;
execute pre_undo "@PCSI$SOURCE:[SYSUPD]EXEC_PRE_UNDO.COM"
uses [SYSUPD]EXEC_PRE_UNDO.COM
interactive ;
|
In this example, the execute pre_undo statement sets up a
command procedure to run before patch kit files are removed from the
system as a result of the PRODUCT UNDO PATCH command execution. The
uses option specifies the file name of the command
procedure that is deleted after use. The interactive
option allows dialog between the user and the command procedure.
|