CA Client Automation - 14.0

PDF
English

Internal Parameters

Contents
cla140
Contents
Internal parameters are reserved and cannot be re-defined as client parameters. The internal parameters are calculated with API functions or determined from the program or SXP archive files. All internal parameters have the prefix Sxp.
The internal parameters can be grouped into the following categories:
Software Delivery-specific Parameters
The following is an overview of Software Delivery (SD)-specific parameters used in SXP products:
  • $(SxpLocRelDir)
    Specifies the directory where the Installer records information on the installed product (Local version directory).
  • $(SxpSrvRelDir)
    Specifies the directory where the Installer finds the archive files for an install order (Server version directory). This directory is required, for example, if the setup call must be specified in order to install a product using the original setup function (original.sxp, Actions section, Install=...).
  • $(SxpEngineDir)
    Specifies the directory in which the Installer was installed.
  • $(SxpProduct)
    Specifies the archive name of the SXP product.
  • $(SxpVersion)
    Specifies the version of the SXP product.
  • $(SxpOutputFile)
    Specifies a file containing information that is copied to the result file of the job. It can be used to report output of actions executed by the Installer.
  • $(SxpAsmRootDir)
    Specifies the root directory of the SD agent.
Package-specific Parameters
The following is an overview of package-specific parameters used in SXP products:
  • $(SxpRootDir
    n
    )
    n
    th root directory. Specifies the parameter supplied by the reference system in the automatic method, which is assigned in the info.sxp file. It is used in all SXP archive files, in which the product files and directories are described (files.sxp, dirs.sxp, files.cmp).
    You can change the installation paths, if you intend to parameterize. For example, replace the hardcoded path name in the first line following with the parameter, as shown in the second line:
    SxpRootDir1=C:\APP
SxpRootDir1=$(Product_a_InsPath)
  • $(SxpRootDirShortn)
    Specifies the abbreviated form of the SxpRootDir
    n
     directory (8.3 format).
  • $(SxpRFile
    n
    )
    nth response file. Specifies the parameter used in the original.sxp archive file. The value of the parameter is set by the Rfilen=value statement in the original.sxp file.
Common System-specific Parameters
The following is an overview of common system-specific parameters used in SXP products:
  • $(SxpWinDir)
    Specifies the Windows directory (on the target computer).
  • $(SxpWinSysDir)
    Specifies the Windows system directory for 32-bit programs (on the target computer).
  • $(SxpWinSysDir64)
    Specifies the Windows system directory for 64-bit programs (on the target computer).
  • $(SxpWinProgDir)
    Specifies the Windows program directory for 32-bit programs (on the target computer, for example, C:\Program Files).
  • $(SxpWinProgDir64)
    Specifies the Windows program directory for 64-bit programs (on the target computer, for example, C:\Program Files).
  • $(SxpWinComFilesDir)
    Reserved Microsoft directory for reused files for 32-bit programs (Common Files under Program Files).
  • $(SxpWinComFilesDir64)
    Reserved Microsoft directory for reused files for 64-bit programs (Common Files under Program Files).
  • $(SxpWinDirShort)
    Specifies the abbreviated form of the Windows directory (on the target computer) (8.3 format).
  • $(SxpWinSysDirShort)
    Specifies the abbreviated form of the Windows system directory (8.3 format).
  • $(SxpWinProgDirShort)
    Specifies the abbreviated form of the Windows program directory (8.3 format).
  • $(SxpWinComFilesDirShort)
    Specifies the abbreviated form of the Reserved Microsoft directory for reused files (8.3 format).
  • $(SxpFontsDir)
    Specifies the Windows fonts directory.
Parameters for Environment Variables
In the SXP package, system-specific environment variables %ENVVAR% can be used as SXP variables $(%ENVVAR%).
Example:
%PATH% is used as $(%PATH%).
Parameters for System-specific Special Folders
The following table lists the names of the SXP parameters in the left column and the identifiers of the Special Folders in the right column. The identifiers are also found in the Special Folder Selection dialog of the Packager; except the last four entries in the table (marked with an asterisk (*)), which are not available for selection in the Special Folder Selection dialog.
SXP parameter
Special Folder
SxpBitBucketDir
BITBUCKET
SxpCommonAdminToolsDir
COMMON_ADMINTOOLS
SxpCommonAltStartupDir
COMMON_ALTSTARTUP
SxpCommonProfileAppsDir
COMMON_APPDATA
SxpDesktopDir
COMMON_DESKTOPDIRECTORY
SxpCommonDocumentsDir
COMMON_DOCUMENTS
SxpCommonFavoritesDir
COMMON_FAVORITES
SxpProgramsDir
COMMON_PROGRAMS
SxpStartMenuDir
COMMON_STARTMENU
SxpStartupDir
COMMON_STARTUP
SxpCommonTemplatesDir
COMMON_TEMPLATES
SxpControlsDir
CONTROLS
SxpDrivesDir
DRIVES
SxpFontsDir
FONTS
SxpInternetDir
INTERNET
SxpNetworkDir
NETWORK
SxpPrintersDir
PRINTERS
SxpProgramFilesDir
*
SxpProgramFilesCommonDir
*
SxpSystemDir
*
SxpWindowsDir
*
Additionally, all short path versions of the above SXP parameters in the format:
Sxp
xxxxx
DirShort
NA
User-specific Parameters
User-specific SXP parameters are for use in user-specific SXP files only (that is, files with names structured like u
xxxxx
.sxp).
  • $(SxpHomeDir)
    Specifies the user's home directory.
  • $(SxpHomeDirShort)
    Specifies the abbreviated form of the user's home directory (8.3 format).
SXP Parameters for User-specific Special Folders
User-specific SXP parameters are for use in user-specific SXP files only, that is, files with names structured like u
xxxxx
.sxp.
The following table lists the names of the SXP parameters in the left column and the identifiers of the Special Folders in the right column. The identifiers are also found in the Special Folder Selection dialog of the Packager.
SXP parameter
Special Folder
SxpAdminToolsDir
ADMINTOOLS
SxpAltStartupDir
ALTSTARTUP
SxpProfileAppsDir
APPDATA
SxpCookiesDir
COOKIES
SxpUsrDesktopDir
DESKTOPDIRECTORY
SxpFavoritesDir
FAVORITES
SxpHistoryDir
HISTORY
SxpInternetCacheDir
INTERNET_CACHE
SxpLocalAppDataDir
LOCAL_APPDATA
SxpMyPicturesDir
MYPICTURES
SxpNetDir
NETHOOD
SxpPersonalDir
PERSONAL
SxpPrintDir
PRINTHOOD
SxpProfileDir
PROFILE
SxpUsrProgramsDir
PROGRAMS
SxpRecentDir
RECENT
SxpSendToDir
SENDTO
SxpUsrStartMenuDir
STARTMENU
SxpUsrStartupDir
STARTUP
SxpTemplatesDir
TEMPLATES
SxpHomeDir
USER_DIRECTORY
Additionally, all short path versions of the above SXP parameters in the format:
Sxp
xxxxx
DirShort
NA