Skip to main content

Extracting Case data using BIX

1 Task

45 mins
Pega Platform '24.2
Visible to: All users
Advanced
Pega Platform '24.2
English

Scenario

MDC currently has business intelligence tools included in its enterprise licenses. Using these external tools, MDC wants to generate and view the partner registration report. To do this, MDC must set up the right Business Intelligence Exchange (BIX) extract Rules. These Rules extract partner registration data in a CSV format, which makes the Rules accessible to the data warehouse team. This process will enable MDC to effectively use their existing tools to analyze the partner registration data.

The following table provides the credentials you need to complete the challenge:

Role User name Password
Admin admin@deliveryservice rules

You must initiate your own Pega instance to complete this Challenge.

Initialization may take up to 5 minutes so please be patient.

Detailed Tasks

1 Implement solution details

  1. In the Pega Platform instance for the challenge, enter the following credentials:
    1. In the User name field, enter admin@deliveryservice.
    2. In the Password field, enter rules.
  2. Search for and open the MDC application Rule.
  3. In the Application rulesets section, click Add ruleset.
  4. In the field, enter Pega-BIX:08-24, and then click Save.
Add BIX ruleset to MDC application.
  1.  In the lower-left corner of Dev Studio, click the user icon, and then click Log off.
  2. Repeat step 1 to log in as admin@deliveryservice.
  3. In the navigation pane of Dev Studio, click App.
  4. In the Application Explorer, click Partner > Create > SysAdmin > Extract to configure the extract Rule.
Navigation to create extract rule.
  1. Create the extract Rule:
    1. In the Label field, enter ExtractPartner.
    2. In the Context list, select Delivery Service.
    3. In the Apply to field, enter MDC-DS-Work-Partner.
    4. Click Create and open.
  2. Configure and map the properties to extract:
    1. In the Output format list, select Comma Separated File (CSV).
    2. Click the Gear icon to select or configure properties of the MDC-DS-Work-Partner class of the Partner Case to extract.
      For example, select the BusinessPartner, BusinessPartnerID, Invoice, InvoiceId, and IsRenewal properties.
Map properties to extract.
  1. On the Filter Criteria tab, define the criteria to extract the Case instances:
    1. In the Label field, enter A.
    2. In the Field list, enter or select.pyStatusWork.
    3. In the Operator list, select Is equal.
    4. In the Value field, enter "Resolved-Completed".
    5. Select the Use null if empty checkbox.
    6. Select the Ignore case checkbox.
Filter criteria of the extract rule.

  1. On the File Specification tab, in the CSV output directory field, enter /opt/tomcat/temp (for example in a VM system).
    This setting defines the output directory to store the extracted files. Ensure that the specified CSV output directory is present on the server file system and is accessible with the required read/write permissions.

File specification tab.
  1. Click Test Connectivity to ensure that the file directory is accessible, and then click Save.
  2. In the navigation pane of Dev Studio, click App.
  3. In the Application Explorer, right-click Partner, and then click Create > SysAdmin > Job Scheduler to configure the job scheduler to extract the data on a periodic basis.
Job Schedule to extract the data on periodic basis.
  1. Complete the Job Scheduler record configuration:
    1. In the Label field, enter ExtractPartner.
    2. In the Context list, select Delivery Service.
    3. Click Create and open.
  2. On the Definition tab, configure the job scheduler details:
    1. In the Runs on list, select Any one associated node.
    2. In the Schedule list, select Daily and accept the default settings.
    3. In the Start time field, enter 12:01:00 AM.
    4. In the Time zone field, enter GMT.
    5. In the Context list, select Use System Runtime Context.
    6. In the Class field, enter or select Rule-Admin-Extract.
    7. In the Activity field, enter or select pxExtractDataWithArgs.
  3. Configure the activity parameters:
    1. In the pyExtractName row, in the Parameter value field, enter ExtractPartner.
    2. In the pyExtractClassName row, in the Parameter value field, enter MDC-DS-Work-Partner.
    3. Click Submit.
Job Scheduler rule configuration.
  1. Click Save. 

Confirm your work

Confirm that the extracted files are displayed in the output directory daily, according to the configuration of the ExtractPartner Rule.

You can also set up BIX by using the command line for client-managed cloud or on-premises installations. On Pega Cloud®, support for extraction is available only through the job scheduler.

For more information, see BIX extraction overview.

Available in the following missions:

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

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

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