Home arrow Reference arrow Extract
Extract
For the selected page, extract according to a list of filter conditions and return the results starting at a specific row for a specified number of rows.

Syntax:

Extract, delimitedFilterCommands, start, rowCount

Parameters:

delimitedFilterCommands - delimited-list of filter commands {see below}

start - from the results, extract the rows starting at this row (0 is the first row)

rowCount - from the reuslts, extract this number of rows

Delimited Filter Commands:

The filter commands can be a list, in any combination, of the following commands. The list should be delimited with the vertical bar or pipe character '|'.

byValue

Extract rows by the value in a numeric column

Syntax:

byValue^columnCaption^criteria^value

Parameters:

columnCaption – the label of the column to be used

criteria – the criteria to be used when filtering { LessThan, LessThanOrEqualTo, NotEqual, Equal, GreaterThanOrEqualTo, GreaterThan }

value - a numeric value

 

byAxisValue

Extract rows by comparing a data column to an aggregation of that column

Syntax:

byAxisValue^columnCaption^aggregation^criteria

Parameters:

columnCaption - the label of the column to be used

aggregation – the function to be used to aggregate the column ( Average, Sum, Maximum, Minimum, First, Last, Median)

criteria – the criteria to be used when comparing the aggregation { LessThan, LessThanOrEqualTo, NotEqual, Equal, GreaterThanOrEqualTo, GreaterThan }

 

byTextColumn

Extract rows based on the contents of a text column

Syntax:

byTextColumn^columnCaption^operator^string

Parameters:

columnCaption -  the label of the column to be used

operator – the test operator to use { ExactMatch, Contains, StartsWith, EndsWith }

string - the string to be used in the test

 

byRowCaption

Extract rows based on the contents of the row label / caption.

Syntax:

byRowCaption^operator^string

Parameters:

operator – the test operator to use { ExactMatch, Contains, StartsWith, EndsWith }

string - the string to be used in the test

 

Examples:

Extract, "byValue^Count^GreaterThan^5 | byAxisValue^Amount^GreaterThan^Average | byTextColumn^Region^ExactMatch^South | byRowCaption^Contains^Button",0,250

This command returns the first 250 rows from a query where the Count is great than 5, the Amount is greater than average, the Region is South and the row contains 'Button'.

 

 

Reference

Installation - Java