Skip to main content

Configuring the Jenkins project

Suggest edit Updated on February 4, 2021

Configure your build environment to call the prpcServiceUtils.bat or prpcServiceUtils.sh script and pass parameters to import or export the RAP:

  1. Complete one of the following actions:
    • Create a project if you have not already done so.
    • Open an existing project.
  2. Click Configure.
  3. Select This build is parameterized.
  4. 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 nameTypeDefault value
      productNameStringThe name of the RAP rule used to generate the archive
      productVersionStringThe version number of the RAP rule
    • To import or export an application, create the following parameters:

      Application parameters

      Parameter nameTypeDefault value
      applicationNameStringThe name of the application
      applicationVersionStringThe version number of the application.
  5. Select Prepare an environment for the run.
  6. 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
  7. 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.

  8. 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.
    Note: You can also set the directory later by specifying -artifactsDir when you run the batch file.
  9. In the Properties Content section, enter the static properties in the format ParameterName=Value.
    • Source properties for export:

      Source properties for export

      Parameter nameDefault value
      SourceHostThe host name and port number of the Pega Platform server from which to export the archive file.
      SourceUserThe operator name. This operator must have export privileges.
      SourcePasswordThe operator password.
    • Target properties for import:

      Target properties for import

      Parameter nameDefault value
      TargetHostThe host name and port number of the Pega Platform server that contains the archive file to import.
      TargetUserThe operator name. This operator must have import privileges.
      TargetPasswordThe operator password.
  10. Click Save.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us