Skip to main content
Person using the computer happily.

How do I… Create a source and View using the Pega connector?

Martin Cook, 6 minute read
Welcome to the fifth entry in our "How do I…?" series on Pega Process Mining. Join us as we explore the fundamentals of becoming a world-class Pega Process Miner, from prepping your case types to identifying opportunities for improvement! To learn more or catch up on the series, please visit the Pega Process Mining discussion on Support Center

Welcome to another entry in our monthly series on how to get the best out of Pega Process Mining. This month we're talking about Source and View creation. Specifically creating sources and views based on your Pega Platform™ data! 

Getting started 

Assuming you're an avid reader of this series, I'm sure you already read our entries about selecting a Case Type for analysis and configuring a Case Type for analysis. So you've obviously done all that already. Now what?  

Well, now we need to: 

  • Set up a connector to that application
  • Create a source based on that connector
  • Create a view based on that source
  • Start analyzing data

Setting up a connector to your Pega application 

Before diving in, ensure that your Pega Platform application is at least on version 8.7.6 or 8.8.3. The connector is compatible only with these versions and later. 

Setting up 

To authorize the Pega Process Mining application as a client in your Pega setup, follow these steps: 

  1. In the navigation pane of Dev Studio, click Records > Security > OAuth 2.0 Client Registration
  2. In the upper-right corner, click Create
  3. Enter a short description and name for your OAuth 2.0 client. Make sure to begin with a letter and use alphanumeric characters. 
  4. Click Create and Open
  5. Complete the registration fields. For more information, see Creating and configuring an OAuth 2.0 client registration
  6. In the Supported grant types section, select Client credentials
  7. Select the operator context, and then enter a valid Operator ID or Access Group. Using Access Groups is beneficial beacuse they tie to roles and offer read-only data access. 
Supported grant types
If you select Access Group as the operator context, the system displays an Access group field.

 

Securing credentials 

View and save the client secret: 

  1. In the Client Credentials section, click View and download
  2. Download the credentials file, and then store it securely for later use. 
  3. In the upper-right corner, click Save
View and download credentials.
In the View and download pop-up box, click Download credentials to save a .txt file that you need to reference later in this procedure.

 

Creating the connector 

Now that you have a set of credentials that can access your platform data, you must set them up in a connector in Process Mining: 

  1. In the header of the Pega Process Mining application, click Control panel, then click Connectors
  2. Select Add New Connector
  3. Enter a name and description for easy identification. 
  4. In the Connector type list, select Pega API Adapter, and then proceed. 
  5. Open the credentials file you saved earlier and enter the necessary details such as the domain URL, Client ID, and Client Secret. 
  6. For API root, use the default value of prweb unless specified otherwise in your Pega application URL (the text that immediately precedes "/api.") 
  7. In the Service Package field, choose one of the following: 
    • If you kept the default application service package with OAuth 2.0, leave the value as application
    • If you created a custom service package for OAuth 2.0, enter its name.
       
      Connector fields.
      Fill in the selected connector fields.

       

  8. Test the connection to ensure that the set up is correct. A successful test displays an Available status. 
  9. Save your new connector setup. 

Creating a source based on the Pega Connector 

So, you have a connector that can pull data, now you just need to pull it! To do that, set up a source based on the connector. 

  1. In the navigation pane of Process Mining, click Sources, and then click Add New Source
  2. Provide a name and description for your source: 
    • On the Info tab, enter a name in the Name field. 
    • Optional: Add a brief description of what the process in this source is for. 
  3. Click Next
    Name field.
    On the Info tab, the Name field is required.

     

  4. On the Connection tab, click the Pega logo, and then from the list, select the connector you just created.
    Connections tab.
    On the left side of the Connection tab, the Pega subtab lists Pega connectors.

     

  5. In the Case Type field, select the Case Type that you want to import. Optional: To exclude certain events, clear the Include 'Status' and 'Stage' checkbox. 
    Case type field list.
    The Case Type field lists all of the available Case Types, based on the Pega connector.

     

  6. Click the Expand icon next to Fields.
     
    Expand icon.
    Click the Expand icon next to the Fields field to access the Pega Connector fields.

     

  7. In the Pega Connector Fields dialog, select the fields you want to use. Note: Depending on your Pega Platform version, available fields might vary. 
    Pega Connector fields.
    Clicking fields in the Available Fields list moves the fields to the Selected Fields list.

     

  8. Click Save
  9. In the Min Creation Date field, select the starting date for importing Case data by using the calendar. 
  10. Optional: Select an end date in the Max Creation Date field. 
    Pop-up calendar.
    A pop-up calendar provides a way to select a minimum creation date.

     

  11. Click Next, and then on the Preview tab, verify the data. 
    Preview tab.
    The Preview tab provides a sample of the imported fields and values.

     

  12. On the Columns Transformation tab, modify or create any columns as needed. 
  13. On the Advanced Properties tab, click Save
  14. Optional: Set an update schedule to ensure that your Case Type data is always up to date. 

Creating a View from your Pega Connector-based source

  1. In the navigation pane of Process Mining, click Views and select Add New View
  2. On the Info tab, name your View, and then select the source created from the Pega connector. 
  3. Follow the View setup wizard. 
  4. Complete the Key Columns tab: 
    • Ensure that caseID is assigned as the Case ID. 
    • Ensure that start_Timestamp is assigned as the Timestamp. 
    • Ensure that activity is assigned as the Activity. 
    • Optional: Confirm that you can assign end_timestamp as End Timestamp to enable the analysis of activity durations. 
Key Columns tab.
In the Key Columns tab, verify the placement of the mandatory labels of Case ID, Timestamp, and Activity.


Start Analyzing! 

Now that you have a view connected to data coming from your Pega Case Type, you can get started analyzing your data and finding opportunities for improvement! 

 

Related Resources

Don't Forget

About the Author

As a product manager, Martin works to capture client and market needs to drive the direction of Process and Task Mining development at Pega.

Share this page Share via X Share via LinkedIn Copying...

Did you find this content helpful?

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

Pega Community 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