BRP Environment Parameters

BRP parameter values are split into two groups. Ones prefixed with "BRP_" are for BRP specific values. Those prefixed with "EXT_" are for source file extension definitions. The tables below list all variables that are set by BRP for use by user exits along with a short description. Any path value will be fully qualified unless otherwise noted.

The following parameter uniquely identifies a BRP run.
Name Description
BRP_TIMESTAMP Timestamp value that uniquely identifies a BRP run and the logs that are generated during that run.
The following parameters are the paths to log files from BRP runs. Note that all the references to specific jobs are default settings only. There are very few cases where these exact jobs will not be used, but they do exist.
Name Description
BRP_APPLYOBSOLETEPCFLOGFILE     Log from ApplyPCF.bj job for applying the BRP_OBSOLETEPCF file.
BRP_BWGLOGFILE Log from BWG.exe (Batch WebGen).
BRP_CREATEBEGINPCFLOGFILE Log from CreatePCF.bj job. This is run at the beginning of the BRP run and creates the file BRP_BEGINPCF.
BRP_CREATEENDPCFLOGFILE Log from CreatePCF.bj job. This is run just before verification and creates the file BRP_ENDPCF.
BRP_EXECREPORTLOGFILE Log for the ExecutiveReport.bj job.
BRP_GETEXTLOGFILE Log for the GetExtensions2.mbu job. This is run at the beginning of the BRP and creates the file BRP_FILEEXTFILE. See the section below on extension values for more information.
BRP_IMSANALYSISLOGFILE Log for the IMS Analysis.bj job.
BRP_UPDATELOGFILE Log for the UpdateOnly.bj job.
BRP_VERIFYLOGFILE Log for the VerifyOnly2.bj job.
The following parameters are for the various PCF files that are generated and used during a BRP run.
Name Description
BRP_BEGINPCF Generated at the beginning of a BRP run. Used for many purposes in BRP including determining obsolete sources.
BRP_ENDPCF Generated toward the end of a BRP run, after the BRP_OBSOLETEPCF is applied and before verification.
BRP_OBSOLETEPCF Generated during a Master BRP run if BRP_OBSOLETEPROCESSING is set to 1. This will shift sources missing from the current incoming set of files to the project specified in BRP_OBSOLETEPROJECT.
The following parameters are data files that BRP uses, flags that turn certain processing on or off, BRP install folders, and other various values.
Name Description
BRP_DROPIND Flag (1/0) that drops database indexes to improve verification and IMS Analysis performance.
BRP_LAUNCHHCC Flag (1/0) that launches the Queue Processor to improve verification performance.
BRP_WAITHCC Time in minutes to wait for Queue Processor to respond.
BRP_BRPLOGFILE Main log file for a BRP run.
BRP_BRPINSTALLPATH Path where BRP is installed. This is specified in the BRP initialization file. BRP will derive the path values for the six BRP folders (PreparedSources, Reports, Staging, Utilities, and Working) based off this path if they are not specified in the initialization file.
BRP_PREPAREDSOURCESDIR Path where sources coming into BRP start off. In cases where a utility is in place to handle getting the sources off a server or mainframe this is the location where those sources are copied to.
BRP_REPORTDIR Path to the folder where all log files are written to. Other resource files created during a BRP run are also written here including all PCF files, file extension data file and all generated user exit batch files.
BRP_RMWINSTALLPATH Path to the install folder for CA.
BRP_STAGINGDIR Folder where sources reside for updating to the workspace. Sources will actually be in a subfolder that is named with the BRP timestamp and not the Staging folder directly. This is also where the majority of source pre-processing utilities will look for inputs and write outputs.
BRP_UTILITIESDIR Path to directory that contains all the executables the BRP will need along with extra resource files and the static user exit batch files.
BRP_WORKINGDIR Folder user exit utilities should use for any work they need to perform.
BRP_WORKSPACEDIR Path to the target workspace.
BRP_FILEEXTFILE File containing the file extension definitions for the target workspace.
BRP_LASTRUNFILE Text file containing the timestamp of the last BRP run that completed execution.
BRP_OBSOLETEEXCLUSIONSFILE File that lists any files that should be excluded from obsolete processing. Typically this includes files generated by CA (ex. DASDL copybooks), but is often used for client-specific sources as well.
BRP_BRPRUNTYPE Must be set to "Master".
BRP_DEBUG Flag (1/0) that will increase the amount of messaging written to the main BRP log. Typically this is always set to 1.
BRP_LASTRUNTIMESTAMP The timestamp value of the last BRP run that completed execution.
BRP_OBSOLETEPROCESSING Flag (1/0) that turns obsolete processing on or off. When it is turned on the incoming set of files will be compared against the set of file currently in the target workspace. Any files currently in the workspace, but not in the incoming set of files will be moved to an obsolete project (named in the BRP_OBSOLETEPROJECT parameter).
BRP_OBSOLETEPROJECT Name of a project where obsolete sources will be moved to.
BRP_SITE Documentation parameter that is set in the BRP initialization file. The value here will be written to the beginning of the main BRP log file. It is used mainly for support purposes to ensure that initialization and log files produced by a client match up.
The following parameters contain the command that will be executed by BRP. Typically this will specify a static DOS batch file (as opposed to the generated batch file BRP generates for each user exit). The static batch file is used so that multiple commands can be executed in a single user exit. These parameters will only exist if the user exit is being used. Below is a complete list of all user exit parameters, but it will be rare to see them all at once. They are listed in the order they would be executed in a BRP run. There is one user exit for each major step of the BRP. They always are the first task that is done in each step.
Name Description
BRP_USEREXIT_SETUP
BRP_USEREXIT_INIT
BRP_USEREXIT_STAGING
BRP_USEREXIT_UPDATE
BRP_USEREXIT_VERIFICATION
BRP_USEREXIT_GENERATION
BRP_USEREXIT_END
The following parameters contain information on the source file extensions that are valid for each legacy file type for the target workspace. The exact parameters that will be here depend upon what options are activated for the target workspace.
Name Description
  Parameter Names The general format of the parameter names is EXT_type, where type is the name of the corresponding directory in the workspace Sources folder. Note that in the past this name is not necessarily the same as the type name found in a PCF file. For example, PL/I included sources are contained in the Sources folder PLIInclude, but that source type is named "PLINC" in PCF files.
  Parameter Values The extension values are separated by a single space and will be in the same order they appear in the workspace options window.

Example: EXT_COBOL = cbl cob ccp C74

Parent topic: Guidelines for BRP Utilities