Skip to main content

Importing a Pega Blueprint into Pega Platform

When users generate a workflow with Pega Blueprint™, they can download a Blueprint file for import into Pega Platform™ to build a new application, drive further client engagement, and jumpstart demo and project build-out.

Note: Pega GenAI PremBridge™ is not required to import Pega Blueprints into a new or existing application.

Building from a Blueprint

U+ Bank, a financial services company, created a Blueprint to design a retail loan origination application. The company wants to import the Blueprint into Pega Platform to build a new application.

After creating and reviewing a Blueprint for an application, a Blueprint file is downloaded for import into Pega Platform. As a best practice, download the PDF of the Blueprint file for reference during the import process.

To begin the import process, create a new application in App Studio. Click Build from a Blueprint to build an application based on the Blueprint, as shown in the following figure:

Highlighting Build from a Blueprint button.

Select the Blueprint file for upload into Pega Platform. The following figure shows the Select a Blueprint step of building from a Blueprint:

The Select a Blueprint import screen in Pega Platform.

The application will be built on the Pega Platform (with Constellation UI). The application stack is displayed in the lower right in the previous figure.

Caution: To use an existing application in the New Application wizard, you must save your application as a template for other users to build from that sample. For more information, see Extending your existing Pega Platform application with Blueprint.

Verify the application settings and the Blueprint details. 

Note:  The Blueprint Details tab (not shown here) contains metadata about the imported Blueprint, such as its name, industry, and purpose. This helps validate the context of your application.

In Pega Platform, the Build from a Blueprint process guides developers through a review of Case Types, data objects, Personas, and application configurations.

Case Types

In the Case Types step, the Case Types match those listed in the Blueprint PDF file. The following figure displays the Case Types associated with the Retail Loan Organization Blueprint:

Case Types associated with the Retail Loan Organization Blueprint.

Here, you can build the Case Type as mapped in the Blueprint, inherit from an existing Case Type, or opt not to build a selected Case Type that is part of the Blueprint. In the example, each Case Type has the selection to build from the Blueprint file.

If you decide to inherit from an existing Case Type, the system creates a new Case Type that inherits assets from an existing Case Type in the built-on application.

On the Case Types step, you can view each Case Lifecycle and make edits if required.

Data Objects

In the Data Objects step, the Data Objects match those listed in the Blueprint PDF file. The following figure displays the Data Objects associated with the Retail Loan Origination Blueprint:

Data Objects associated with the Retail Loan Origination Blueprint.

Like the Case Types, you can build the data object from the Blueprint, inherit from an existing data object, reuse an existing data object, or skip building a selected Data Object that is part of the Blueprint. In this example, you build the Data Objects from the Blueprint file without modifications.

If you inherit from an existing data object, the system creates a new Data Object that inherits assets from a data object in the built-on application. Reusing an existing data object creates a data object that is linked to the built-on application and reuses assets from a Data Object in that application, but does not have its own class in your new application. Optionally, you can add Data Objects from the built-on application to your new application.

Personas

In the Personas step, the Personas match those listed in the Blueprint PDF file. The following figure displays the Personas associated with the Retail Loan Organization Blueprint:

Personas associated with the Retail Loan Organization Blueprint.

Here, you can build the Persona as described in the Blueprint or opt not to build the Persona in Pega Platform.

Configurations

Finally, review the basic configuration options and structure of your new application and ensure that they are correct for your intended business use case. Ensure that the class layers, Case classes, and data classes are correct. The following figure displays the Configurations step of building from a Blueprint:

Configurations step of building from a Blueprint for a retail loan application.
Note: For more information about Case and data classes, see Understanding class layers and Managing application Cases and data.

After reviewing all parts of the imported Blueprint file, click Submit to begin creating the application in Pega Platform. The following figure displays the progress indicator for building an application from a Blueprint:

Blueprint creation in progress

The system creates a new application from the Blueprint that you uploaded. All the assets of the new application, except for Access Roles, are created in a Branch. By default, all base Rulesets in the new application are locked. If you want to merge any changes to the Rulesets, you must use the appropriate password provided.

Be sure to store the user password securely.

Note: For more information about managing branches, see Branch operations.

After the application is successfully built, you can add users with assigned Personas to the application. The following figure displays the window that allows you to add users to your new application:

Successful import of a Blueprint in Pega Platform.
 

After adding users, go to the new application to view the Case Types, data objects, and Personas that you built in App Studio or navigate to Dev Studio to review the Rules created during the import process.

Note: For more information on creating an application with Blueprint, see Creating a new application from a Blueprint.

 

Check your knowledge with the following interaction:


This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

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

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice