› Output Manager › User Interface Reference › @Parse dialog box

@Parse dialog box

Use this dialog to configure the @parse function. This function is used to extract data from a document property (for example, Document Name). You can extract data using character offset (specifying a beginning position and length), single delimiters (specify just the starting delimiter, it will be used as the only delimiter, field number, and length), and double delimiters (specifying a starting delimiter, ending delimiter, field number, and length). When you create a business rule action to set document properties, the parsing command should be entered in the appropriate Value cell on the Document Properties dialog box.

Once created, the function command syntax is as follows,

For character offset: @parse ( [ FieldSource ] , position , length )

For single delimiter: @parse ( [ FieldSource ] , " delimiter " , field number, length )

For double delimiters: @parse ( [ FieldSource ] , " starting delimiter " , " ending delimiter " , field number , length )

Fieldsource

Specifies the document property from which data will be extracted. Right-click in the box, click Insert Document Property, and select the document property from the list. The document property will appear in brackets in the field source box.

Field

Specifies that you are going to extract data using character offset. To do this you will need to specify a beginning position and length.

  • Position — Specifies the first position of the string to be extracted. The first character of source data is indicated by specifying a 1.
  • Length — Specifies the length of the string to be extracted. If the length specified is zero (0) or if the length is greater than the remaining data, then all data to the last character will be used.

Delimited List

Specifies that you are going to extract data using single delimiters or double delimiters. If you are using a single delimiter you will specify just the starting delimiter, it will be used as the only delimiter, field number, and length. If you are using double delimiters you will specify a starting delimiter, ending delimiter, field number, and length.

  • Starting delimiter — Specifies the character that marks the beginning of the string. If a comma or backslash is used as the first character of the delimiter, then a backslash must precede the delimiter in the command. For example, a backslash delimiter will be shown in the command as \\.
  • Ending delimiter — Specifies the character that marks the end of the string. If a comma or backslash is used as the first character of the delimiter, then a backslash must precede the delimiter in the command. For example, a backslash delimiter will be shown in the command as \\. If you are using a single delimiter, this field can be left blank.
  • Field number — Specifies the position of the field that will be extracted. (1 refers to the first field, 2 to the second, and so on.)
  • Length — Specifies the length of the string to be extracted. If the length specified is zero (0) or if the length is greater than the remaining data, then all data to the last character will be used.