HELPLIB.HLB  —  PRODUCT  REGISTER
    Either records product information in the product database
    (REGISTER PRODUCT) or records a volume label change of the volume
    containing the installed products (REGISTER VOLUME).

1  –  PRODUCT

    Records information in the product database about one or more
    installed products that are not yet registered in the database.

    Format

      PRODUCT REGISTER PRODUCT  product-name[,...] [/qualifiers]

1.1  –  Description

    The PRODUCT REGISTER PRODUCT command only updates the product
    database; it does not copy any files ' to your system.

    You can use this command to add information to the product
    database about products that have been installed by a mechanism
    other than PCSI, such as VMSINSTAL. You can also use this command
    to store information about products previously installed by the
    PCSI utility if the product database needs to be rebuilt due to
    file corruption or deleted database files.

    To register a product, you need to have a file in the source
    directory to supply details about the product being registered.
    This file can be one of the following:

    o  A complete product kit

    o  The product description file (PDF) extracted from the product
       kit or database

    o  A special transition kit that identifies files installed by a
       mechanism other than the PCSI utility.

    If you do not have a kit available to provide detailed
    information about a product, you can use the command procedure
    SYS$UPDATE:PCSI$REGISTER_PRODUCT.COM to register the name of
    the product and its version, producer, and base system in the
    product database. After you register a product using the command
    procedure, other products can reference it, and the PRODUCT SHOW
    PRODUCT command displays it as an installed product.

1.2  –  Parameter

 product-name

    Names the product, or list of products, to register.

1.3  –  Qualifiers

1.3.1    /BASE_SYSTEM

       /BASE_SYSTEM=base-system-name

    Selects software products whose base system matches the one
    specified. The base system name identifies both a hardware
    platform and an operating system. Standard names are:

    Name          Description

    AXPVMS        Denotes an OpenVMS Alpha product.
    I64VMS        Denotes an OpenVMS I64 product.
    VAXVMS        Denotes an OpenVMS VAX product.
    VMS           Indicates a product that can be installed on more
                  than one OpenVMS platform.

1.3.2    /CHECK_ONLY

    Concludes the action of the command after performing file
    conflict detection, searching the destination device for all
    files listed in the product description file, and displaying file
    lookup summary data. This option allows you to perform a "dry
    run" of the registration operation without modifying the product
    database.

1.3.3    /DESTINATION

       /DESTINATION=device-name:[directory-name]

    Specifies the top-level directory where the product to be
    registered resides. If you omit the device name, the utility uses
    your current default device. If you omit the directory name, the
    utility uses [VMS$COMMON] as the default directory.

    If you do not use this qualifier to specify a destination,
    the utility uses the location defined by logical name
    PCSI$DESTINATION. If this logical name is not defined, the
    utility registers the software in SYS$SYSDEVICE:[VMS$COMMON], the
    default top-level directory for software product files.

1.3.4    /KIT_ATTRIBUTES

       /KIT_ATTRIBUTES=keyword([,...])

    Selects kits by kit type or kit format, or both. Keywords are:

    FORMAT=      Designates the format of the product kit as follows:
    format-type
                 COMPRESSED  Compressed format in which a data
                             compression technique has been applied
                             to a sequential kit. A compressed kit
                             has a .PCSI$COMPRESSED file type.

                 REFERENCE   Reference format in which product
                             files exist in a directory tree. A
                             .PCSI$DESCRIPTION file in the top
                             level of the directory tree denotes a
                             reference kit.

                 SEQUENTIAL  Sequential format in which product files
                             are placed in a container file. A file
                             type of .PCSI indicates a sequential
                             kit.

    TYPE=        Specifies the type of product kit as follows:
    kit-type
                 FULL        Layered product (application) software.

                 OPERATING_  Operating system software.
                 SYSTEM

                 PARTIAL     An upgrade to currently installed
                             software. Installation of this kit
                             changes the version of the product.

                 PLATFORM    An integrated set of software products
                             (also called a product suite).

                 TRANSITION  Used to register information about
                             a product that is installed but not
                             recorded in the product database
                             (for example, a product installed by
                             VMSINSTAL). This kit does not provide
                             product material.

1.3.5    /LOG

       /LOG
       /NOLOG (default)

    Displays the file specifications of the product files and
    directories that are registered in the product database.

1.3.6    /OPTIONS

       /OPTIONS=keyword
       /NOOPTIONS (default)

    Specifies PRODUCT command options. The keywords are:

    NOCONFIRM        Omits the confirmation dialog that asks the user
                     to verify the products that have been selected
                     for the operation.

                     The NOCONFIRM and NODEFAULT_KIT keywords are
                     mutually exclusive.

    NODEFAULT_KIT    Directs the utility to query the user instead
                     of choosing a default kit when more than one
                     kit that matches the selection criteria for the
                     product is found in the source directory path.
                     The selection criteria include the producer,
                     base system, product name, and product version
                     strings that are embedded in the file name of a
                     kit.

                     If multiple kits are found for a selected
                     product, and NODEFAULT_KIT is not specified,
                     the utility determines the default kit to use by
                     applying the following rules:

                     1. The last character of the kit's file name
                        (1-7) is used to order the kits by kit type.
                        In descending order, the precedence is as
                        follows: full, operating system, partial,
                        patch, platform, transition, and mandatory
                        update.

                     2. The file type is used to order the kits
                        by format. In descending order, the
                        precedence is as follows: compressed
                        (.PCSI$COMPRESSED), sequential (.PCSI), and
                        reference (.PCSI$DESCRIPTION).

                     3. If multiple kits are found with the same
                        file name and file type, but differ in their
                        directory path names, the case of their file
                        specifications, or their file versions, then
                        the first file found by RMS search rules
                        takes precedence.

                     The NODEFAULT_KIT and NOCONFIRM keywords are
                     mutually exclusive.

    NOVALIDATE_KIT   Disables validation of software product kits
                     that are signed and have a manifest file in the
                     source directory.

                     The NOVALIDATE_KIT and SIGNED_KIT keywords are
                     mutually exclusive.

    REGISTER_ALL_    Registers all files listed in the product
    FILES            description file of the kit, even if they are
                     not currently present on the destination device.

    SIGNED_KIT       Requires all software product kits selected for
                     the operation to be signed kits that have passed
                     validation; otherwise, the operation is not
                     performed.

                     The SIGNED_KIT and NOVALIDATE_KIT keywords are
                     mutually exclusive.

1.3.7    /PRODUCER

       /PRODUCER=producer-name

    Selects software products that the specified manufacturer
    produces.

1.3.8    /REMARK

       /REMARK=string

    Records a comment in the product database about the task you
    are performing. The PRODUCT SHOW HISTORY command displays the
    recorded comments. For each product, PCSI stores a chronological
    list of tasks you perform and the associated remarks. The default
    behavior is that no remark is recorded.

1.3.9    /REMOTE

       /REMOTE
       /NOREMOTE (default)

    Selects the product database located on a privately mounted
    system disk. By default, PCSI searches the currently booted
    system disk for the product database.

    When you use /REMOTE, the following logical names must be
    defined:

    o  PCSI$SYSDEVICE must specify the physical disk name of the
       target system disk. This disk must be mounted and allocated to
       the process executing the PRODUCT command.

    o  PCSI$SPECIFIC must point to a system root on PCSI$SYSDEVICE.
       It must be defined in the following form, where x is a valid
       system root:

       PCSI$SYSDEVICE:[SYSx.]

1.3.10    /SOURCE

       /SOURCE=device-name:[directory-name]

    Specifies the disk and directory where the utility searches for
    the software product kit or kits. If /SOURCE is not specified,
    the utility searches in the location defined by the logical
    name PCSI$SOURCE. If PCSI$SOURCE is not defined, and the /SOURCE
    qualifier is not specified, PCSI searches the current default
    directory.

1.3.11    /SPAN_VERSIONS

       /SPAN_VERSIONS=keyword([,...])

    Selects software products whose versions match the specified
    version criteria. The keywords are:

    ABOVE=version    Selects versions greater than the version
                     specified

    BELOW=version    Selects versions less than the version specified

    MINIMUM=version  Selects versions greater than or equal to the
                     version specified

    MAXIMUM=version  Selects versions less than or equal to the
                     version specified

    The ABOVE, BELOW, MINIMUM, and MAXIMUM keywords can be
    used alone or in combination. For example, /SPAN_VERSIONS=
    (MINIMUM=V2.1,BELOW=V3.0) selects versions greater than or equal
    to V2.1 and less than (but not including) V3.0. Using the MAXIMUM
    keyword instead of BELOW would select versions that include V3.0.

1.3.12    /VERSION

       /VERSION=version-number

    Selects software products that have the specified version.

1.4  –  Example

  $ PRODUCT REGISTER PRODUCT TOOLCHEST /SOURCE=DKB500:[TOOLCHEST.KIT]

      The command in this example registers the product TOOLCHEST in
      the product database. TOOLCHEST was installed by VMSINSTAL, and
      a special transition kit is in the source directory to supply
      details about the product.

2  –  VOLUME

    For a volume containing installed products, records a change in
    volume label in the product database.

    For device independence, the product database identifies the
    destination device of an installed product by its logical volume
    name, not by its physical device name. The logical volume name
    (usually in the form DISK$labelname) is defined by the MOUNT
    command and associated with the device.

    Format

      PRODUCT REGISTER VOLUME  old-volume-label device-name

                               [/qualifiers]

2.1  –  Description

    You can check the logical volume name of a mounted device by
    issuing a command in the following format:

     $ WRITE SYS$OUTPUT F$GETDVI("device","LOGVOLNAM")

    When you use the SET VOLUME command to change the volume label
    of a nonsystem device that contains installed products, you
    must also use the PRODUCT REGISTER VOLUME command to update the
    product database with this information. Register the new volume
    label after you dismount and remount the volume so that the new
    logical volume name (DISK$labelname) is defined.

    If you change the volume label of the system device, you do not
    need to use the PRODUCT REGISTER VOLUME command because PCSI
    automatically detects the change after the volume is remounted
    following a system reboot.

2.2  –  Parameters

 old-volume-label

    Names the old (existing) volume label.

 device-name

    Names the device for which the volume label is to be changed in
    the product database.

2.3  –  Qualifiers

2.3.1    /LOG

       /LOG
       /NOLOG (default)

    Displays the file specifications of the product database files
    that are created or modified.

2.3.2    /REMOTE

       /REMOTE
       /NOREMOTE (default)

    Selects the product database located on a privately mounted
    system disk. By default, PCSI searches the currently booted
    system disk for the product database.

    When you use /REMOTE, the following logical names must be
    defined:

    o  PCSI$SYSDEVICE must specify the physical disk name of the
       target system disk. This disk must be mounted and allocated to
       the process executing the PRODUCT command.

    o  PCSI$SPECIFIC must point to a system root on PCSI$SYSDEVICE.
       It must be defined in the following form, where x is a valid
       system root:

       PCSI$SYSDEVICE:[SYSx.]

2.4  –  Example

  $ PRODUCT REGISTER VOLUME AXPVMSV62 DKA0:

      The command in this example replaces all occurrences of the old
      volume label in the PCSI database with the current volume label
      of the specified disk.
Close Help