Configuring the Jenkins project
Configure your build environment to call the prpcServiceUtils.bat or prpcServiceUtils.sh script and pass parameters to import or export the RAP:
Complete one of the following actions:
- Create a project if you have not already done so.
- Open an existing project.
Click Configure.
Select This build is parameterized.
Click Add Parameter and create the parameters that Jenkins passes to the prpcServiceUtils tool:
- To import or export a RAP, create the following parameters:
Product parameters
Parameter name Type Default value productName String The name of the RAP rule used to generate the archive productVersion String The version number of the RAP rule - To import or export an application, create the following
parameters:
Application parameters
Parameter name Type Default value applicationName String The name of the application applicationVersion String The version number of the application.
- To import or export a RAP, create the following parameters:
Select Prepare an environment for the run.
In the Properties Content section, set the following properties:
SystemName=$BUILD_TAG
Source Code Management=None
Inject environment variables to the build process=Properties Content
In the Properties Content section, set the ImportExistingInstances property to one of the following values. The default is unset:
- override
For rules - If a rule with the same key exists in the system, but the rule resolution properties differ (for example, ruleset or version), replace the existing rule with the imported rule.
For work - If a work object with the same key exists but belongs to a different application (for example, it has a different class hierarchy but same classgroup name and same ID prefix), replace the existing work object with the imported work object.
- skip
For rules - If a rule with the same key exists in the system, and the rule resolution properties differ, do not replace the existing rule.
For work - If a work object with the same key exists but belongs to a different application, do not replace the existing work object.
unset: The import will fail if keys already exist either for rule instances that have different rule resolution properties or for work objects that belong to a different applications that use the same classgroup name.
- override
Set the artifact directory where exported logs and files are downloaded In the following format:
ARTIFACTS_DIR=<var>path to artifact directory</var>
The default is the logs directory.
In the Properties Content section, enter the static properties in the format
ParameterName=Value
.- Source properties for export:
Source properties for export
Parameter name Default value SourceHost The host name and port number of the Pega Platform server from which to export the archive file. SourceUser The operator name. This operator must have export privileges. SourcePassword The operator password. - Target properties for import:
Target properties for import
Parameter name Default value TargetHost The host name and port number of the Pega Platform server that contains the archive file to import. TargetUser The operator name. This operator must have import privileges. TargetPassword The operator password.
- Source properties for export:
Click Save.
Related Content
Previous topic Configuring the Jenkins build environment Next topic Adding build steps to import or export the archive