All properties that can be specified in connection with keywords in the prototype file for PIF products are listed in alphabetical order.
Specifies a 10-byte access rights string, for example, –rwxr–xr–x.
Indicates the type of action that is performed when the button is clicked. This property can have one of the values mentioned in the following table:
|
Numerical value |
Descriptive Text / Action performed |
|---|---|
|
0 |
Cancel installation. |
|
1 |
Install product. |
|
2 |
Next dialog. Show the next dialog. |
|
3 |
Remove product. |
|
4 |
Show previous dialog. |
|
5 |
Dynamic dialog. Determine next installation dialog dynamically by evaluating a script. |
|
6 |
End installation and start a user script. |
|
7 |
Go to another installation dialog and take origin of that dialog. |
|
8 |
Start script and continue. The current dialog is closed, the specified script is executed, and the initial dialog is started again. |
|
9 |
Execute script. The specified script is executed and the result is shown in the specified result pane, which can be a progress area or text area. |
Specifies the name of a script that changes attributes or contents of fields in an installation dialog, for example, activate or deactivate a field.
Is a comma-separated list of parameter=value assignments that are activated when the check box is checked.
Is a text string consisting of a maximum of 1024 alphanumeric characters, for example, FINAL BUILD. The text string must not contain any control characters like carriage return (CR) and line feed (LF).
Specifies the name of the group that organizes the radio buttons.
Specifies the name of the parameter that specifies whether the component should be installed with the product or only on demand (optional component). If the value of the parameter is 0, the component is not installed with the product. By default, the component will be installed. (See the property paramname for information about the syntax of a parameter name.)
Specifies the column number of the dialog element within the virtual grid of 4 columns and 10 rows. The value range is 1 – 4.
Specifies the name of a component, which is a small installable unit within the PIF product. The name can consist of a maximum of 128 characters.
Specifies the installation path under which the files for the current component are stored. You can enter an absolute path name or an environment variable. The first character of the environment variable must always be the dollar sign ($). The second character must neither be a dollar sign ($) nor a number. The path name must match the operating system conventions.
Specifies the name of a dialog element, for example a button or a label. The name can consist of 1 – 32 characters.
Is a comma-separated list of parameter=value assignments that are activated when the check box is cleared.
(Used for check box trees only) Is a comma-separated list of check box ctrlnames. No spaces are allowed in this list.
Specifies the name of a shell script (provided by the user) that can be used to validate the input of the current dialog. All values entered are passed as a shell parameter to the dialog validation script. If each entered value and the combination of all values are correct, the script must return 0. If the entered values are wrong, the script must return the number of a matching error text in the resource section in the prototype file. This error text number must be in the range of 1 – 255.
Specifies the name of the next dialog in the product installation process. The name can consist of 1 – 32 characters maximum. In a special manner it is possible to specify a shell script as the dialog reference. This shell script must print the name of the dialog to standard output.
Specifies the name of a post-install procedure that is not part of the current PIF product file. Be careful using external procedures, because a particular procedure may be missing on a target computer.
Specifies the name of post-uninstall procedure that is not part of the current PIF product file. Be careful using external procedures, because a particular procedure may be missing on a target computer.
Specifies the name of a pre-install procedure that is not part of the current PIF product file. Be careful using external procedures, because a particular procedure may be missing on a target computer.
Specifies the name of a pre-uninstall procedure that is not part of the current PIF product file. Be careful using external procedures, because a particular procedure may be missing on a target computer.
Specifies the name of a dialog element (field) that gains the focus when a new installation dialog is started.
Specifies the name of a file to display on the installation dialog. The name is a character string that consists of a maximum of 255 characters.
Specifies the file type. The value 1 references a standard file (file type 1). The value 2 references a configuration file (file type 2), which is not changed during a PIF product update. The value 3 references a temporary file (file type 3).
Specifies the name of the starting dialog for an initial PIF product installation. The name can consist of 1 – 32 characters.
Specifies the name of the starting dialog for a PIF product update installation. The name can consist of 1 – 32 characters.
Is a boolean indicator. The values of flag can be False, represented by 0, or True, represented by 1.
Is a flag that indicates if the font appears bolded or not in the installation dialog. Flag value = 1 specifies bold, flag value = 0 specifies normal font presentation.
Specifies the color (RGB) of the font. The format is R,G,B; for example, 255,0,0 specifies red color.
Is a flag that indicates if the font appears italicized or not in the installation dialog. Flg value = 1 specifies italic, flag value = 0 specifies standard font presentation.
Specifies the Java-specific name of the logical font.
Specifies the specific name of the font in the PIF product.
Is a boolean indicator. The values of flag can be False, represented by 0, or True, represented by 1.
Specifies the file name of a graphic in the GIF graphics format. This graphic is displayed in the graphics area of the installation dialog. The GIF file name can consist of 1 – 255 characters.
Since the size of the graphic influences the overall size of the dialog, we recommend that the graphic does not exceed 400 x 200 pixels (approximately) to support screen resolutions of 800 x 600 pixels.
Identifies the group, for example, sys. The value of groupID can consist of a maximum of 32 bytes.
Specifies the height of the dialog window in number of pixels.
Note: The overall height of the dialog is controlled by the height of the graphic specified in the #graphic entry in the dialog section.
Specifies the name of a file that contains an icon that appears on the button. The icon must be provided in the GIF graphics format. The GIF file containing the icon must be added to the pre-install component. The name of the GIF file can consist of 1 – 255 characters.
Specifies the time when the external component is installed. Value 0 specifies that the external component is installed prior to PIF product installation. If the value is 1, the external component is installed after PIF product installation.
Specifies the name of the parameter that specifies whether the dependent product should be installed with the PIF product or only on demand (optional). If the value of the parameter instparam is 0, the dependent product is not installed; if the value is 1, the dependent product is installed with the PIF product. By default, the dependent product will be installed. (See the property paramname for information about the syntax of a parameter name.)
Specifies the name of an interpreter other than the standard shell.
Specifies the name of a link source file. The name must match with the value of the target parameter of a preceding #file: entry.
Specifies the name of a parameter that contains the list of values for selection in the list box or combo box.
Identifies the language to be used as a three-character text string, for example, ENU (English (U.S.)). Enter one of the supported language identifiers.
Specifies the name of a script (provided by the user) to migrate a non-PIF product to a PIF product. The script is started only when a PIF product is being new installed on a computer. This script is not executed when updating or re-installing a PIF product. The script should be located in the pre-install component. If a non-PIF installation is detected on the computer, we recommend that you set the following PIF parameters: PIF_INSTALL_JOB=UPDATE and PIF_INSTALL_PATH=existing installation path.
Specifies the name of the next dialog in the product installation process. The name of the dialog can consist of 1 – 32 characters.
Indicates the operator defining the relationship to the specified product version. Operator can be one of the following characters: =, >, >=
For example, = 2.1.0.3 means exactly product Version 2.1.0.3; >= 2.1.0.3 means Version 2.1.0.3 and all newer versions of the product, such as 2.1.1.0 or 2.2.0.0.
Identifies the user, for example, root. The ownerID can consist of a maximum of 32 bytes.
Is a text describing the parameter.
Specifies the name of an environment variable. The name starts with a dollar sign ($), and consists of a maximum of 64 characters, including the dollar sign. The following characters are not allowed within a parameter name:
. ; : \t \n \\ \" / , $ ( ) - { } white space
Is a comma-separated list of assignments in the format parameter=value, for example:
$PARAM1=Yes,$PARAM2=x,$INSTALLDIR=/dev/null
The commas in the list must not be separated by spaces! When the according button is clicked, the values are assigned to the parameters.
Specifies the type of the parameter. The following values are accepted: 0 (= published), 1 (= private), and 2 (= global).
Specifies the default value for a parameter. Paramvalue is a character string and consists of a maximum of 255 characters. The parameter value can be a combination of static values and previously defined parameters. Within a combined parameter, the end of a static value is marked by one of the following characters:
. ; : \t \n \\ \" / , $ ( ) - { } white space
Specifies the operating environment of the target computer. Enter one of the valid platform identifiers.
Specifies the name of a procedure to execute after installation of the PIF product. This procedure must be provided by the user as a script or executable. Enter the path name (0 – 255 characters) relative to the path specified in the #ppath: entry. The file must be stored in the product installation directory, or a subordinate directory. If there is no such procedure leave this entry blank or omit it.
Specifies the name of a procedure to be executed after the removal of the PIF product. The user must provide this procedure as a script or executable. Enter the path name (0 – 255 characters) relative to the path specified in the #ppath: entry. If there is no such procedure leave this entry blank or omit it.
Specifies the name of a component, which contains all text, script, and resource files used prior to PIF product installation. Typically, pre-install components contain dialog resource files like GIF files, license agreement documents, and pre-install scripts. The pre-install component is not installed within the PIF product installation.
Specifies the name of a procedure to execute prior to installation of the PIF product. The user must provide this procedure as a script or executable. Enter the path name (0 – 255 characters) relative to the path specified in the #ppath: entry. The file must be stored in the product installation directory or a subordinate directory. If there is no such procedure leave this entry blank or omit it.
Specifies the name of a procedure to execute before the product installation or any installation dialog starts, for example, to define pre-settings needed by the installation dialogs. The user must provide this procedure as a script or executable, as part of the pre-install component. Enter the path name (0 – 255 characters) relative to the path specified in the #ppath: entry. If there is no such procedure leave this entry blank or omit it.
Specifies the name of a procedure to execute prior to the removal of the PIF product. This procedure must be provided by the user as a script or executable. Enter the path name (0 – 255 characters) relative to the path specified in the #ppath: entry. If there is no such procedure leave this entry blank or omit it.
Specifies the name of a family of PIF products, for example, CCS. The name can consist of a maximum of 128 characters, but must not contain any spaces or slashes. The product family name is not case-sensitive.
Is a comma-separated list of product names. The list must not contain spaces around the commas.
Specifies the name of a PIF product. The name can consist of a maximum of 128 characters.
Specifies the installation path for the PIF product on the target computer. Enter the absolute path name on the target computer, where you want to install the product. Enter the path name starting from the root directory (/). Instead of a path name, you can enter the name of an environment variable that indicates the path name on the target computer. The first character of the environment variable name must always be the dollar sign ($). The second character must be neither a dollar sign ($) nor a number. The path name must match the operating system conventions.
Is an environment variable which describes the installation progress of the current product or component. The appropriate values are as follows:
$PIF_PROGRESSBAR_PRODUCT $PIF_PROGRESSBAR_COMPONENT $PIF_PROGRESSBAR_COUNT
Is an environment variable which describes the currently running install action, the file being installed, or the component name. The appropriate values are as follows:
$PIF_PROGRESSLABEL_ACTION $PIF_PROGRESSLABEL_FILE $PIF_PROGRESSLABEL_COMPONENT $PIF_PROGRESSLABEL_ELAPSEDTIME $PIF_PROGRESSLABEL_PHASE
Specifies the name of a parameter that contains the value selected from the list box or combo box.
Is a list of parameter=value assignments that are activated when the radio button is selected.
Indicates the row number of the dialog element within the virtual grid of 4 columns and 10 rows. The value range is 1 – 10.
Specifies the name of a script file.
(Used for VT100 only) Specifies scroll mode, using the values: 0 = Do not show a frame (box) and 3 = Show a frame (box).
Specifies the name of the source file you want to package into a PIF product. The source file name (0 – 255 characters) can be relative. In this case, the source file path can be lead by an environment variable. This variable must be set prior to creation of the PIF product.
Specifies the file name (0 – 255 characters) of a symbolic link. A symbolic link is a file that contains a path name. When the shell encounters a file name that represents a symbolic link, it replaces its name with the specified path name. Thus, what you access is not the symbolic link, but the file to which the path name points. You can set up symbolic links to any files or directories, even to those on different file systems on the computer.
You can also create symbolic links that are relative to the target file (if possible). The target link is not referenced with a fully qualified path, but with a path that is determined relatively to the symbolic link. The advantage is that the installed folders containing symbolic links can be moved without breaking the link.
Enter the symbolic link in accordance with one of the following checks:
Specifies the target path name (0 – 255 characters) in accordance with one of the following checks:
Specifies the name of a text area dialog element that contains additional information of the items within the scroll area. The text area must be defined in the current dialog.
Indicates the reference number of a text string defined in the Resource section in the prototype file. The value range of the reference number is 0 to 9999.
Specifies the text to be used, for example, in an installation dialog. You can enter 1 – 1024 characters, but the text must not contain any control characters like carriage return (CR) and line feed (LF).
Indicates a time-out value used for long executing scripts. Enter the value in seconds. Default value is 600 (ten minutes).
Specifies the name of a shell script (provided by the user) that validates the input from a text field. The value entered in the text field is passed as first argument ($1) to the validation script. If the entered value is valid, the script must return 0. If the entered value is wrong, the script must return the number of a matching error text in the Resource section in the prototype file. This error text number must be in the range of 1 – 255.
The property validationscript is a character string that consists of a maximum of 255 characters.
Specifies the name of the product vendor.
Indicates the version of the PIF product, or version of a component of the PIF product. The version has the format M.m.b.r, where M (major), m (minor), b (build), and r (revision) are numeric values in the range of 0 – 99,999. Each of the values for M, m, b, and r can consist of a maximum of five digits, for example, 10 or 00010 are allowed values.
Specifies the width of the installation dialog window in number of pixels.
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|