You are here: Reference > Activity methods > Apply-Parse-Structured

  Apply-Parse-Structured method

Methods and instructions by function

Use this method to locate and execute a Parse Structured rule (Rule-Parse-Structured rule type). Parse Structured rules parse structured text string into property values added to the clipboard. The source of the input data depends on which rule type calls this method:

Parameters

This method has two parameters:

Parameter

Description

RecordType

Enter a literal value that is the second key part of a Parse Structured rule.

SourceProperty

Optional; required for activities. Identify a property reference that contains as its value the input to the Structured Parse rule.

If the property is on the step page, precede the property name with a period.

If this property is on a different page, include the page name in the reference and ensure that this page appears on the Pages & Classes tab of the Activity form or Parse Structured form.

Results

Parse Structured rules have two key parts: an Applies To class and a Record Type.

First, the system assembles a key for the desired Parse Structured rule. It uses the class of the step page as the Applies To class of the key, and the value of the RecordType parameter as the second key part. (If the Step Page field is blank, it uses the class that is the Applies To key part of the activity or Parse Structured rule.)

Next, the system uses rule resolution to locate the Parse Structured rule.

Finally, it applies the Parse Structured rule in the current context:

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Definitions About Parse Structured rules

UpMethods and instructions by function