Data dictionary for a BIX extract

[AsifN213 (Asif Nazir Ali)]

Hi,

Would like to know if there is an option to export the data model for BIX extract with the following information.

The output format is XML. Attached screenshot of an extract rule.

-Property name

• Data Type

• NULL / NOT NULL

• Description

Thanks.

[MarijeSchillern]

@AsifN213

This is a GenAI-powered tool. All generated answers require validation against the provided references.

. Based on my research, I can provide you with some insights, though there are some limitations to what’s currently documented.

When working with BIX extracts in XML format, there are a few approaches you might consider:

1. Standard XML Export:
   BIX allows you to export data in XML format, which you’ve already configured as shown in your screenshot. While this primarily exports the actual data, some metadata might be included in the structure.
2. XSD Generation:
   There appears to be a configuration parameter called “BIX/generateXSDForAllProperties” that might be relevant to your needs. This parameter, when enabled, generates an XSD (XML Schema Definition) file when “Get all properties” is selected for XML output. By default, this parameter is set to false.
3. Manual Property Selection:
   According to one support document I found, “You won’t see an option for the schema generation if you select ‘get all properties’.” This suggests that to get schema information, you might need to manually select properties rather than using the “Get all properties” checkbox that’s currently selected in your screenshot.

However, I couldn’t find definitive documentation confirming that BIX can export a complete data dictionary with all the specific metadata fields you’re looking for (property name, data type, NULL/NOT NULL constraints, and descriptions) in the format you need.

Since this appears to be a specialized technical question, you might consider:

1. Creating a support case with Pega Support for a definitive answer
2. Checking if there are any custom approaches or workarounds used by other teams within Pega
3. Exploring if there are alternative tools within the Pega ecosystem that might provide this metadata export capability

References:

• Creating an extract rule
• Data extraction

Optimizing BIX data extraction performance

[AsifN213 (Asif Nazir Ali)]

@MarijeSchillern - Thanks for the information.

A query on this dynamic system setting - BIX/generateXSDForAllProperties".

While processing a case or multiple cases PL-XXX’(s), a user decides not to enter a value for an optional field. When BIX extract executes for this case type, the XML file does not have this tag/field for these case(s) as it does not have a value. If the above DSS is set to true, will the XSD file list this optional field?

A support ticket was raised recently on this topic - INC-C17966 and feedback was provided stating that ‘Currently BIX doesn’t support Data Dictionary Feature’.