You are here: Reference > Rule types > Map Structureds > Map Structured form - Completing the Mapping tab

Map Structured rules
Completing the Mapping tab

  1. About 
  2. New 
  3. Mapping 
  4. Pages & Classes 
  5. History 
  6. More... 

Complete the Mapping tab to define the relationships between a set of properties and a single structured text value.

When used with the Map Structured method, the system uses information on this tab to assemble (From Clipboard) or disassemble (To Clipboard) a structured text value. Information on this tab does not determine the processing direction.

Field

Description

Settings  
Character Encoding

Select to control the character set used in the output structure when this rule is used in the From Clipboard direction to write to an output file.

Select Default to use the character set of your Pega Platform server, or another character set such as ASCII, Windows Latin-1, or UTF-8.

Character conversion from the internal character set of your Pega Platform server to the encoding you specify in this field occurs only when you use this rule with the Connect-File method; this field is ignored by the Map-Structured method.

Character conversion uses standard Java methods; in some cases two-byte characters may be converted to single-byte output characters.

Justification

Select Left or Right to control the justification of data within the field when the field length is longer than the data and this rule is used in the From Clipboard direction to assemble structure.

For example, when you specify Left, padding only in remaining character positions (if any) after the end.

Default Pad Character

Indicate whether data is to be padded with spaces, or with another character, when this rule is used in the From Clipboard direction to assemble a structure. (You can override this choice at the individual field level.)

When a map structured rule is used in the To Clipboard direction to disassemble a structure, no padding occurs.

Specify Pad Character

If you selected Other for the Default Pad Character, type a single character here. You can override this choice at the individual field level. You can't enter an octal, decimal or hex representation of a character here.

Map Format

Identify the size and position of each field in the data structure. When you save the Map Structured form, the system validates that no fields are overlapping, and presents a warning if there are gaps (unmapped character positions) between fields.

Offset

Enter a character offset from the beginning of the structure for the first character position of this field. The first character of the structure starts at offset 0.

Length

Enter a length in characters. At runtime when this rule is used in the From Clipboard direction, the system truncates data values longer than this length, and pads data values shorter than this length.

Property

Enter a property reference. To reference a property on the page corresponding to the Applies To key part, enter a period and the property reference. Use the notation pagename.propertyname to reference a property on another page, and include that page name on the Pages & Classes tab.

As a best practice, enter only properties that have a character-oriented type, such as Text, Date, DateTime, Identifier, Time of Day, or Decimal. Do not use Double, TrueFalse, Integer, or Password properties.

You can also enter a string constant, by surrounding the text with double quote characters, or an expression. String constants and expressions are used to construct a string when the Map From Property to Clipboard direction is selected in the Map-Structured method.

For more information about expressions, see About Expressions.

Pad Character

Leave blank to use the pad character specified as the default, or type a character value to control padding when this rule is used in the From Clipboard direction to assemble a structure. You can't use an octal, decimal or hex representation of a character here.

Justification

Choose Default to use the value in the Justification field, or Left or Right to control justification of the value within the structured value when this rule is used in the From Clipboard direction.

About Map Structured rules