Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Map Structured rules

Updated on April 6, 2022

Use a map structured rule to define a two-way mapping between clipboard properties and a fixed-format record structure or text property value.

Note: As a best practice, upload CSV and XLSX files in your application by using the Integration Designer in App Studio. For more information, see Creating a data model from a spreadsheet.

The following tabs are available on this form:

At run time, when mapping from clipboard properties to an output file, the rule can convert the characters from the default representation to another character set.

When both sides of the mapping are properties, the map can be performed in either direction.

For fixed-format structures, map structured rules provide a simpler alternative to Parse Structured rules, which are needed when the data structure is complex or varying, or conditional parsing is required. Use Parse Structured rules to parse record structures that contain variable elements, or packed decimal characters, or unusual data representations. For more information, see Parse Structured rules.

For an example that uses Map Structured rules, see the Pega Community article How to process structured streams using the Map Structured rule.

Where referenced

In an activity, you can use either two methods to reference and execute a map structured rule:

  • The Connect-File method, when data from the clipboard is to be mapped into a fixed structure and output into a file.
  • The Map-Structured method, used to break down one property value into one or more other property values, or to assemble the structured value from property values.


Use the Records Explorer to list all Map Structured rules available to you.


Map Structured rules are instances of the Rule-Map-Structured class. They are part of the Integration-Mapping category.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us