desktop » saveTableRows(var,contains,csv)

Description

This command instructs Nexial to save rows of data from the current table into var for offline (and often, faster) data processing. All the captured data will be treated as text; no data type conversion or formatting will be performed. Use the contains parameter to indicate which row(s) from the current table to capture. Only rows with a column that matches the value specified in the contains parameter will be captured. One may specify multiple values (separated by nexial.textDelim to narrow the filtering criteria. For example:

Capture the rows which has at least 1 column that matches to “Produce”:

Capture the rows which has at least 1 column that matches to “Produce” and at least 1 column that matches to “Local only”:

Note that this command will work only after the useTable(name) has been invoked.

Optionally, one can set the last parameter csv to true to obtain the same data set as a CSV structure. Note that this CSV structure will include column header as well. Often converting grid data to CSV is preferred as one would be able to utilize the various CSV-related facilities within Nexial for additional automation. See saveAllTableRows(var,csv) for examples.

This command supports PolyMatcher, which provides greater flexibility and expressiveness in data filter:

---

PolyMatcher Enabled

PolyMatcher - a flexible way to perform text matching

In addition to extract text matching (or string matching), this command/expression also supports "polymatcher" (as of v3.6). With polymatcher, one can instruct Nexial to match the intended text in a less exact (but more expressiveness) way. Here are the supported matching strategies:

• CONTAIN:: Use this technique to perform partial text matches. For example: use CONTAIN:completed as intent for "matching text that contains the text ‘completed’".
• CONTAIN_ANY_CASE:: Use this technique to perform partial text matches (same as CONTAIN:), except without considering the uppercase/lowercase variants. For example, CONTAIN_ANY_CASE:Successfully would match "Completed successfully", "Completed Successfully", and "COMPLETED SUCCESSFULLY".
• START:: Use this technique to perform "starts with" text matches. For example, START:Greetings matches any text starting with the text "Greetings".
• START_ANY_CASE:: Use this technique to perform "starts with" text matches without considering letter casing. For example, START_ANY_CASE:Greetings matches any text starting with the text "Greetings", "GREETINGS", "greetings", "greeTINGs", etc.
• END:: Use this technique to perform "ends with" text matches. For example, END:Please try again. matches any text that ends with the text "Please try again.".
• END_ANY_CASE:: Use this technique to perform "ends with" text matches without considering letter casing. For example, END_ANY_CASE:Please try again. matches any text that ends with the text "Please try again." in any combination of upper or lower case.
• REGEX:: Use this technique to perform text matching via regular expression. For example: use REGEX:.+[S|s]uccessfully.* as intent for "matching text that contains 1 or more character, then either ‘Successfully’ or ‘successfully’, follow by zero or more characters.".
• EMPTY:[true|false]: Use this technique to perform "is empty?" check. EMPTY:true means that the target value is expected to be empty (no content or length). EMPTY:false means the target value is expected NOT to be empty (with content).
• BLANK:[true|false]: Use this technique to perform "is blank?" check. BLANK:true means that the target value is expected to contain blank(s) or whitespace (space, tab, newline, line feed, etc.) characters or empty (no content or length). BLANK:false means the target value is expected to contain at least 1 non-whitespace character. Note that this matcher includes te EMPTY: check as well.
• LENGTH:: Use this technique to perform text length validation against target value. One may use a numeric comparator for added flexibility/expressiveness. For example: LENGTH:5 means to match the target value to a length of 5. LENGTH: > 5 means to match the target value to a length greater than 5. The available comparators are: >, >=, <, <=, =, !=.
• NUMERIC:: Use this technique to perform numeric comparison/matching against target value. With this technique, 100 considered the same as 100.00 since both value has the same numerical value. One may use a numeric comparator for added flexibility/expressiveness. For example: NUMERIC:5 means to match the target value to the number 5. NUMERIC: <= -15.02 means to match the target value as a number that is less or equal to -15.02. The available comparators are: >, >=, <, <=, =, !=.
• EXACT:: Use this to perform exact text matching, i.e. equality matching. In most cases, this is not required as the absence of any special keyword almost always means the "is this the same as that?" test. However in some special cases such as base » assertMatch(text,regex), one may use this EXACT: syntax to indicate match by equality instead of regular expression.
• And, of course, one can still use the exact matching strategy by specifying the exact text to match.

We will be adding new strategy to polymatcher – Please feel free to request for new ones!

---

As of v3.7, this command supports also “HierTable” (as a “table”). One may use this command for both the traditional “data grid” component as well as the hierachical/collapsible “TreeView” grid.

Parameters

• var - this parameter will store the table row value into variable
• contains - Limit the rows to capture via this parameter
• csv - true if data should be converted into CSV structure

Example

See above

See Also

• saveAllTableRows(var,csv)
• saveRowCount(var)
• saveTableRowsRange(var,beginRow,endRow,csv)
• useHierTable(var,name)
• useTable(var,name)