Reference › Keywords and Properties of the Prototype File › Keywords

Keywords

All keywords that can be used in the different sections of the prototype file for a PIF product are listed in alphabetical order.

#admininstall: flag ;

Specifies whether the product should be installed with root user privileges (flag value = True (1)) or with non-root user privileges (flag value = False (0)).

#build:[ buildinformation] ;

Contains information about the product build for user purposes only, for example, to identify different packages of the same product version. This information is not checked by the Installer.

#button: row , column , ctrlname , textID , action , [icon] , [nextdialog] , [paramset] , [fontname] , [resultpane] ;

Specifies a button and its position within the input area of an installation dialog. The textID option specifies the text that is displayed. Nextdialog is the name of the next dialog or the name of a script that performs an action, for example, dynamically detects the dialog name. An icon can be specified for the button. The paramset option specifies a list of parameters that are set when the button is pressed. The action is a number that specifies an action to be initiated when the button is selected (for example, 2 = Show next dialog. The complete list of values of action can be found in the Prototype File Properties section under the action property.) The result of a script execution (action = 9) can be displayed in a result pane; the resultpane parameter can specify a progress area or a text area.

#chead: compname[ , version] ;

Specifies the name and version of a component of the PIF product.

#checkbox: row , column , ctrlname , paramname , [actparamset] , [deactparamset] , [textID1] , [textID2] , [dependencylist] , [actionscript][ , fontname] ;

Specifies a check box and its position within the input area of an installation dialog. The environment variable paramname contains the state of the check box. If the check box is checked (True), the value of the environment variable is set to one (1); otherwise (False), the variable is set to zero (0). Two lists of comma-separated parameter=value assignments can be specified that are activated when the check box is checked (actparamset) or cleared (deactparamset). The textID1 option specifies label text that is displayed on the right side of the check box. The textID2, dependencylist, and actionscript options are for use in check box trees only. The textID2 option specifies additional descriptive text for an item selected in the tree, dependencylist specifies a comma-separated list of check box ctrlnames, and actionscript specifies a script that changes field attributes or contents in the installation dialog immediately.

#cinstall: cinstparam ;

Specifies whether the component should be installed with the product or only on demand (that is, by selecting the component from an installation dialog.) In the latter case the component is called optional.

#combobox: row , column , ctrlname , flag , listparam , resultparam , [dialogvalidationscript] , [actionscript][ , fontname] ;

Presents a combo box or a list box, depending on the flag value. When the flag value is False (0), a List box is presented; when the flag value is True (1), a Combo box is presented. Both types of boxes provide a list of possible values and allow selecting one of them. In the combo box, the user can alternatively enter another value. A shell script can be specified that validates the input, and another script (actionscript) that changes field attributes or contents in the installation dialog immediately.

#comment: textstring ;

Specifies any comment, for example, to describe the product in detail. The first 127 bytes of the text string are displayed as a comment in the DSM Explorer.

#cpath: comppath ;

Specifies the installation path of a component of the PIF product.

#desktopicon: textID1 , targetpath , argument , iconpath , textID2[ , userinstall][ , allinstall] ;

Specifies a desktop icon for the PIF Packager. textID1 is the number of a text that is displayed with the icon, textID2 is the number of a text containing localized comment. The parameters userinstall and all install indicate whether the icon should be installed for the current user or for all users.

#desktopmenu: textID1 , targetpath , argument , iconpath , textID2[ , userinstall][ , allinstall] ;

Specifies a desktop menu for the PIF Packager. textID1 is the number of a text that is displayed with the menu, textID2 is the number of a text containing localized comment. The parameters userinstall and all install indicate whether the menu should be installed for the current user or for all users.

#dhead: width , height , ctrlname , textID[ , dialogvalidationscript][ , fieldwithfocus] ;

Specifies the name, position, and headline of an installation dialog. A shell script can be specified that validates the input. You can also define a dialog element (field) that gains the focus when the installation dialog is started.

#dir: target , ownerID , groupID , access ;

Specifies the directories that relate to the current component.

#dis:[ prodname , version[ , operator]] ;

Specifies an incompatible dependency. Enter all those products, together with their versions, which must not be installed on the target computer when this product is installed. You must use one #dis: entry for each dependent software product. If there is no incompatible dependency, leave this entry blank, or omit the entry.

#dlgcancel: dlgref ;

Specifies the dialog that is shown whenever the installation of the PIF product is canceled by the user.

#dlgend: dlgref ;

Specifies the dialog that is shown after the product installation has successfully finished.

#dlgendrm: dlgref ;

Specifies the dialog that is shown when the product removal has been completed.

#dlgerror: dlgref ;

Specifies the dialog that is shown when an error occurs during installation of the PIF product.

#dlgerrordisk: dlgref ;

(Multiple disk support only) Specifies the dialog that is shown when the next inserted disk does not match.

#dlgerrorpath: dlgref ;

(Multiple disk support only) Specifies the dialog that is shown when the next inserted path does not match.

#dlgnextdisk: dlgref ;

(Multiple disk support only) Specifies the dialog that is shown to request insertion of a new disk.

#dlgnextpath: dlgref ;

(Multiple disk support only) Specifies the dialog that is shown to request a new path.

#dlgpreinit: firstinstalldialog ;

Specifies the starting dialog used when a PIF product is being initially installed.

#dlgpreupd: firstupdatedialog ;

Specifies the starting dialog used when a PIF product is being updated.

#dlgprogress: dlgref ;

Specifies the dialog that is presented to visualize the installation progress during the PIF product installation.

#extpostinit: externalpostinstallprocedure ;

Specifies an external procedure executed after PIF product installation.

#extpreinit: externalpreinstallprocedure ;

Specifies an external procedure executed prior to PIF product installation.

#extrmpostinit: externalpostuninstallprocedure ;

Specifies an external procedure executed after PIF product removal.

#extrmpreinit: externalpreuninstallprocedure ;

Specifies an external procedure executed prior to PIF product removal.

#file: target , source , ownerID , groupID , access , filetype ;

Specifies a file contained in the current component. One #file: entry is required for each file contained in the component.

#filearea: row , column , ctrlname , filename[ , fontname] ;

Specifies an area on the installation dialog where the contents of the referenced file are displayed. Supported file extensions are: .htm, .html, .rtf, .txt for Java, and .txt for VT100 user interfaces. The contents of the file are wrapped within the file area, and scrolling is supported. Parameters can be used to dynamically set the file name. Parameters of special use are: PIF_RESPONSE_FILE, PIF_ERROR_FILE, and PIF_LOG_FILE. For example, when you specify the internal variable $PIF_RESPONSE_FILE as file name, the contents of the internally used response file can be displayed.

#fileselection: row , column , ctrlname , paramname[ , validationscript][ , fontname] ;

Specifies name and position of a file name input field, and the environment variable to store the file name in. A shell script can be specified that validates the input.

#font: fontname[ , fontlogical][ , fontsize][ , fontbold][ , fontitalic][ , fontcolor] ;

Specifies a font and font properties to be used in Java installation dialogs.

#frameheader: textID ;

Specifies the window frame header in the Java installation dialogs. The textID is the number of a text string specified in the Resource section. Default value is: CA Software Management Installer.

#graphic: [GIFfilewest] , [GIFfilenorth] , [GIFfilecenter] , [GIFfilesouth][ , GIFfileeast] ;

For Java dialogs only. Specifies one or more graphics that are displayed in the according graphics area on the installation dialog. The graphics files specified must be in the GIF format.

#image: row , column , ctrlname , imagefilename[ , scalablewidth , scalableheight] ;

Specifies an image (picture) that is displayed in an installation dialog. The parameters scalablewidth and scalableheight are optional; if they are specified, the image is scaled to the defined size.

#instdir: row , column , ctrlname , paramname[ , validationscript][ , fontname] ;

Specifies name and position of the installation directory input field, and the environment variable to store the directory in. A shell script can be specified that validates the input.

#inputorder: ctrlname ;

Specifies the order in which the input fields of an installation dialog should be processed during the installation of the PIF package.

#label: row , column , ctrlname , textID[ , fontname] ;

Specifies descriptive text that leads input fields, check boxes, or installation directories. The referred text string can consist of a maximum of 1024 characters, but when the label is displayed on the dialog it does not exceed one line. That means the text of the label is not wrapped within the dialog window.

#locale: localeID ;

Specifies the default language of the PIF product. The language specified by localeID is used when starting installation dialogs with their default language. (Refer to the description of the language identifiers).

#multiinst: flag ;

Specifies whether the product is enabled or disabled for multiple installations on the target computer. When the flag value is False (0), which is the default, no further instances of this product version can be created on the target computer. When the flag value is True (1), the PIF product can be installed multiple times (multiple instances) on the target computer.

#navbutton: column , ctrlname , textID , action[ , icon][ , dlgref][ , fontname] ;

Specifies the next installation dialog dlgref to appear when this navigation button is selected. You can specify a shell script that determines the next installation dialog. Through textID you specify text that appears in the navigation button and visualizes its function. Additionally, you can specify an icon (as a GIF file) that appears in the navigation button. The action is a number that specifies an action to be initiated when this navigation button is selected (for example, 2 = Show next dialog). In an installation dialog, you can define up to four navigation buttons in the navigation area.

#parameter: paramname , paramvalue , paramcomment , paramtype ;

Defines a parameter and its default value that is used to configure the product installation. The parameter value assigned can contain previously defined parameters.

Example:

#parameter: $installdir , /opt/CA/installpath ;
#parameter: $my_install_path , $installdir/myproduct1 ;

The paramcomment property is used to describe the parameter. The value of paramtype controls whether the parameter is published (value = 0), private (value = 1), or global (value = 2).

#passwordfield: row , column , ctrlname , paramname[ , validationscript] ;

Specifies the name and position of the password input field, and the environment variable to store the password in. A shell script can be specified that validates the input.

#patchproduct: prodname ;

Specifies the name of the product that this current patch is going to change.

Example: #patchproduct: common_utilities ;

#pdep:[ prodname , version[ , operator][ , instparam]] ;

Specifies a product dependency. Specify the product and its version, which must be installed on the target computer, before the current PIF product is installed. You must use one #pdep: entry for each product the current product is dependent on. If there is no product dependency, leave this entry blank or omit the entry.

#phead: prodname , version ;

Specifies the name and version of the PIF product.

#postinit:[ postinstallprocedure[ , interpreter]] ;

Specifies an internal procedure executed after PIF product installation. An interpreter other than the shell can be specified for the procedure.

#postinterview: script ;

Specifies the name of a script that is executed after the interview phase, that is, after all dialogs have run. The script must be added to the pre-install component.

#ppath: prodpath ;

Specifies the installation path of the PIF product.

#preinit:[ preinstallprocedure[ , interpreter]] ;

Specifies an internal procedure executed prior to PIF product installation. An interpreter other than the shell can be specified for the procedure.

#preinitcomp:[ preinstallcomponent] ;

Specifies a component that is installed prior to the PIF product.

#prepif:[ migrationscript[ , interpreter]] ;

Specifies a procedure, that is, a user-written script to migrate a non-PIF product into a PIF product. You can arrange the PIF product installation path and the PIF product install mode (UPDATE, INSTALL). The prepif procedure is executed only prior to a new installation of the PIF product; it is not executed during an update install or reinstall. An interpreter other than the shell can be specified for the script.

#prestart:[ prestartprocedure[ , interpreter]] ;

Specifies an internal procedure executed directly after a prepif procedure before the product installation or any installation dialog starts. This procedure is executed each time before the first installation dialog starts to define pre-settings needed by the installation dialogs. The prestart procedure is also started when no installation dialog is defined. An interpreter other than the shell can be specified for the procedure.

#preventdowngrade: flag ;

Specifies whether a downgrade to a lower product version is forbidden. If the flag value is 1 (True) the product cannot be downgraded, if the flag value is 0 (False), a product downgrade is enabled. In a transaction with product dependencies only the main product is checked, all other installed required products remain with their highest versions.

#productfamily: prodfamilyname ;

Specifies the name of the product family the PIF package belongs to. This keyword lets you update in sync all packages with the same product family name to the latest available product version. Any package can belong to a single product family.

#progressarea: row , column , dlgref[ , fontname] ;

Displays the progress of script execution using output texts from the script. Long text lines are not wrapped within the dialog window. The progress area is reset whenever a new script is invoked. This function is not available for RPM packages.

#progressbar: row , column , dlgref , progbartype , flag[ , fontname] ;

Displays the progress of the installation of a product or a component or the overall installation progress (specified through the value of progbartype). In Java dialogs, Java standard elements are used to visualize the installation progress. In VT100 mode dialogs, the progress bar has a length of 40 characters; the installation progress is visualized using the pipe character (|) and a percentage value. The dialog containing the progress bar is specified by the option dlgref. The flag value switches the percentage string in the progress bar off (value = 0 (False)) or on (value = 1 (True)).

#progresslabel: row , column , dlgref , proglabeltype[ , fontname] ;

Informs about the current install action (for example, install, backup, remove) and optionally the installation phase, the name of the file or component currently being installed, or the elapsed installation time (specified by the value of proglabeltype). The dialog containing the progress label is specified by dlgref.

#radiobutton: row , column , ctrlname , textID , buttongroup , resultparamlist , flag[ , actionscript][ , fontname] ;

Enables switching between two or more values. The option textID specifies the text to be shown with the button, and button group is the name of the group that organizes the radio buttons. Resultparamlist is list of parameter=value assignments that are activated when the radio button is selected. The flag value controls whether the radio button is selected (value = 1 (True)) or not selected (value = 0 (False)) by default. The option actionscript specifies a script that changes attributes or contents of fields in the installation dialog immediately.

#replacepatches: prodlist ;

Specifies a comma-separated list of patch packages that are replaced with the current patch. No spaces must be around the commas in this list.

Example: #replacepatches: common_utilities_patch1,network_patch7 ;

#reservedspace: virtualfilename , diskspace ;

Reserves disk space for the virtual file specified. The required disk space of the virtual file is specified through the diskspace option in bytes.

#rmpostinit:[ postuninstallprocedure[ , interpreter]] ;

Specifies an internal procedure executed after PIF product removal. An interpreter other than the standard shell can be specified for the procedure.

#rmpreinit:[ preuninstallprocedure[ , interpreter]] ;

Specifies an internal procedure executed prior to PIF product removal. An interpreter other than the standard shell can be specified for the procedure.

#scrollarea_begin: row , column , ctrlname , [textarea][ , scrollmode] ;

Specifies the beginning position of a scroll area within a check box tree on the installation dialog. The end of the scroll area is defined by the keyword #scrollarea_end. You can define a text area in the current installation dialog that provides additional information about the items in the scroll area. The scroll mode specification is used for VT100 only.

#scrollarea_end: ;

Specifies the end of the scroll area.

#slink: symboliclink , linksource[ , ownerID , groupID] ;

Specifies whether a file is linked to other files.

#splashscreen: GIFfile[ , textID] ;

Specifies a graphic in GIF format and an optional text that appear as first screen when the product installation is started in attended mode, that is, prior to any dialog of the interview phase. The graphic with the name GIFfile must be in the GIF format; textID is the number of a text string specified in the Resource section.

#supplier:[ vendorname] ;

Specifies the name of the product vendor.

#sys: platform ;

Specifies the operating environment where the PIF product can be executed.

#text: textID , textstring ;

Specifies a text resource, for example, to appear in an installation dialog. In the prototype file, the text string is referred to by means of the textID number only.

#textarea: row , column , ctrlname , textID[ , fontname] ;

Specifies an area on the installation dialog where the referenced text is displayed. The text is wrapped within the text area, and scrolling is supported.

#textfield: row , column , ctrlname , paramname[ , validationscript][ , fontname] ;

Specifies the name and position of a user-specific input field, and the environment variable to store the entered text in. The input data is written into a temporary response file, which is passed to the product installation. Optionally, a shell script can be specified that validates the input.

#timer: timeout ;

Specifies a time-out value for the product installation. In case you have long running scripts that may exceed the default value of the timer (10 minutes), it may be useful to specify a greater time-out value that fits the requirements of the installation script.

#tree_begin: ctrlname , flag ;

Specifies the beginning of a tree within a scroll area. The end of the tree is defined by the #tree_end keyword. You can specify a text area that provides additional information about the items in the scroll area. In this case the text area must be defined in the current installation dialog. The flag specifies the initial shape of the tree and has the values: False = 0 meaning Tree is initially collapsed, and True = 1 meaning Tree is initially expanded. Default value is False (0).

#tree_end: ;

Specifies the end of the tree within a scroll area.

#utf8encoded: 1 ;

Specifies that text strings have to be entered in UTF-8 encoded format. If the keyword is not specified, the text strings are entered in MBCS code.

#vname: prodname , version , flag ;

Specifies a virtual package prodname that will be substituted by this current package. The specified version is the lowest version of the virtual package. During installation the version number is verified using the >= (greater than or equal to) operator. The flag indicates if the original package (or another virtual package) should be removed after installation. Flag value 0 specifies "Do not remove", flag value 1 specifies "Remove". Default is 1.