name
|
The name of the attribute to use in the attribute value map. The name
is usually the same as a resource user attribute on the schema map on the
resource adapter, but this is not a requirement.
|
len
|
Indicates the exact length of the expected string. The length can have
the following values:
-
1 or higher captures the specified number of characters, unless
the characters equal the noval attribute.
-
-1 captures all the characters from the current parse position
until the next white-space character, unless the next characters equal the noval attribute. This is the default.
|
term
|
A string that indicates parsing should stop for this str token
when any of the characters in the string are reached. If the len argument
is 1 or higher, then either the str token will end at len,
or the term character, whichever comes first.
|
termToken
|
A string to use as an indicator that the text being searched for is
not present. This string is often the first word or label in the next line
on the screen output.
The parse position will be the character after the termToken string.
The string added to the attribute map will be all the characters before the
termToken was found.
The termToken attribute can only be used if the len attribute is negative
one (-1).
|
trim
|
Optional. A true or false value
that indicates whether the returned value or multiple values (if the multi
attribute is specified) are trimmed before being added to the account attribute
map. The default value is false.
|
noval
|
A label on the screen that indicates the attribute doesn’t have
an string value. Essentially, it is a null value indicator. The parse position
will be advanced to the first character after the noval string.
|
multiLine
|
A true or false value that indicates
whether the string will span multiple screen lines.
This attribute can only be used if a len attribute is supplied and is
assigned a value greater than zero. If multiLine is present, end of line characters
will be skipped until the number of characters specified in the len attribute
have been parsed.
|
multi
|
A true or false value that indicates
that the string captured is a multi-valued attribute that must be further
parsed to find each sub-value. The multiple values can either be appended
together using the appendSeparator or can be turned into
a list of values.
|
delim
|
A delimiter for parsing the multi-valued string. This attribute can
only be used if the multi attribute is specified.
If this is not specified, then the multi str token
is assumed to be delimited by spaces.
|
append
|
A true or false value that indicates
that the multiple values should be appended together into a string using the appendSeparator. If append is not present, the multiple values will
be put into a list for the account attribute value map. This attribute is
used in conjunction with the multi attribute.
|
appendSeparator
|
Indicates the string to separate the multiple values for an append token.
This attribute is only valid if the append attribute is set to true. If the appendSeparator is not present, the append attribute does not use
a separator. Instead, it concatenates the multiple values into the result
string.
|