Home arrow Reference
Reference

Script commands, alphabetically listed

In addition to this listing, you can enter any of the following commands into the search box and press the enter key to give you a list of all the examples and tutorials that use it.



AddAggregates

Creates a new page of popular aggregations (Sum, Minimum, Maximum, Average, Median, StdDev, NumericRange, First, Last) of rows, columns or the current page.  

Read more...
 
AddBaseline
This function assigns a row to be a baseline which makes it available for use with the Test function.  Baselines can be derived from a page, or loaded independently using the AddData, AddPage, AddQueryPage or Query-RunSave command. Once a baseline has been added, it is independent of the page which created them and the baseline can be used as a comparison against any page of data.
Read more...
 
AddData
AddData reads data from an input file, either a CSV file with a formatted header row, or a Nextanalytics Optimized Disk (NOD) cache file.
Read more...
 
AddPage

This function adds data from a CSV formatted file. Just prior to reading the data, it reads a separate text file that contains a description of the CSV file so that the engine can run more optimally.

Read more...
 
AssignCellFormat
Assigns numeric format to selected numeric columns.
Read more...
 
AssignColumnCSS
This function assigns a new CSS Style to specific columns for use in the authoring interface. It does not affect the underlying data.
Read more...
 
AssignWordsToValues
This function changes a cell value from a numeric into a textual equivalent. This function is specifically tailored to the HTML authoring interface, so programmers would find the function AssignWordstoValuesSelectedColumns to be more useful.
Read more...
 
AssignWordsToValuesSelectedColumns
This function changes a cell value from a numeric into a textual equivalent. This is the same as AssignWordsToValues, except that it only applies to selected columns. If you don’t want an entire page converted to their text, then selecting columns and applying this function is what you would use.
Read more...
 
AutoPopulateBaselines
This function creates a series of useful baselines, which are subsequently used by the Test function.
Read more...
 
ChangeAlertTo, Axis
Changes the alerts on the current page to be based on an aggregation of an axis of this or another page.
Read more...
 
ChangeAlertTo, CellValue
Bases alerting to a specified page, using the corresponding column caption and row caption to obtain a cell value to use for the alert.
Read more...
 
ChangeAlertTo, None
Turns Alerts off or resets them to the default.
Read more...
 
ChangeAlertTo, RelativeCell
Changes the alerts on the current page to be based on another row or column on a specific page, either relative or absolutely positioned.
Read more...
 
ChangeLabelCaption
Changes the caption (label) of a row or column to a new value.
Read more...
 
ChangePageProperties2
This function changes how the business report author sees the report in the interactive user interface.  It has no effect on how the exports operate.
Read more...
 
ChangeTextInTextColumn

Change the text in the values of a specified text column from one character sequence to another.

Read more...
 
ChangeValuesAboveBelowAggregation
This function calculates the aggregate value of the designated axis, and then alters the cell value to indicate if it was below, or equal-or-above the aggregate.
Read more...
 
ChangeValuesPercents
This function calculates the minimum and maximum values for the designated axis, then divides that into a set of range buckets as per the set of ratios you provide (80% = 0.8). Then it alters the cell values to indicate which range the original value was in.
Read more...
 
ChangeValuesToNTile
This function converts cell values into a number that represents which “bucket” of N buckets, where you specify the value for N.  It’s calculated by examining the minimum and the maximum values of the designated axis, and then divided into N equal sized “buckets.”
Read more...
 
ChangeValuesToRank
This function converts cell values (along a designated axis) to their respective rank position numbers.  It does not re-order, it merely changes the cell values.
Read more...
 
ChangeValuesValues
This function accepts a set of numeric values that define the boundaries of custom groups. It looks at each cell to see if it is less than the value or equal-or-higher-than the value and replaces the cell value with the respective group number.
Read more...
 
ClearOldPages

Clears the contents of all but the current page from memory, but retains the page indexes.

Read more...
 
ClearSelection
This function clears all outstanding selection of the designated axis.
Read more...
 
Combine
This is a means to perform an aggregation on a set of rows or columns. Usually it is preceded by a selection operation, or the default of all is used.
Read more...
 
CombineDuplicates
This function combines (aggregates) records which are identical in the row label and all text columns. 
Read more...
 
CombineSimilar / ByIndex
This combines records which share the same value in a text column, aggregating the values of similar rows. A new column labelled ‘Count’ is added in the first column position with the number of original rows that were combined.
Read more...
 
Compare
This function converts cell values to a value which is a comparison of another value.  There is a broad range of comparisons available.  It can compared to an aggregate value of an axis, against the current or another page.  It can be a specific or relative cell, row, or column, again on the same page or another page.
Read more...
 
CompareSimilar
This function converts cell values to a percentage of an aggregate of other rows with the same text columnor row label value.
Read more...
 
ConcatenatePagesWith

Merges pages with similar page captions by concatenating the rows together. It creates a new text column 'From' that contains the text of the original page captions.

Read more...
 
ConcatenateTextColumns

Creates a new text column that combines text from two other columns separated by a specified character.

Read more...
 
ConvertAlertsToData

Replaces the current page data with the alert information. CAUTION: This currently only works for a limited number of alert types.

Read more...
 
CopyDataToTextColumns

Copies the selected data column to a text column of the same name.

Read more...
 
CreateTextColumnFromDateColumn
Create a text column made of date/time elements from a date column.
Read more...
 
DeleteTextColumn
Removes the designated text column from the page.
Read more...
 
DistributeCellCollection
This function provides a technique to group column values into a smaller number of columns, or spread a value out over a larger number of columns.
Read more...
 
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.
Read more...
 
FilterByValue
This function examines cell values in a data column relative to an aggregation of that column.  If it passes a test, then the requested action is taken on the rows.
Read more...
 
FilterGlobally

During an AddPage operation, filter the data as it is being loaded. Multiple filter criteria may be specified and data rows must pass all critreria to be loaded into memory.

Read more...
 
GetCaption
Get the caption for the selected page, row, column or cell.
Read more...
 
GetCountsOfValues
Swaps columns to the rows and sets the columns to the unique values in the data, then shows the counts / number of times each unique value occurred. 
Read more...
 
HidePage
This function hides a page from the HTML output interface. The page can still be referenced by other pages and consumes system resources.
Read more...
 
HidePagesExcept
This function hides all pages except for the ones identified, default being the current page.
Read more...
 
ImportData
This function is used to import comma-separated data files that have a header row that contains the column captions.
Read more...
 
ImportDataNoHeader
This function is used to import comma-separated data files that have a header row that contains the column captions.
Read more...
 
InvertSelection
This function reverses the selection state of the designated axis.
Read more...
 
JoinTwoPagesByMatchingRowLabel
This function copies selected text columns from another page to the current page, matching row labels between the pages.
Read more...
 
KeepSelected
After selecting one or more rows, columns, or both, keep the selected items and remove any that were not selected.
Read more...
 
MathOperation
This function performs math operations to the current page, or selected columns.
Read more...
 
MathOperationOnTwoPositions
Performs a math operation on two columns of data.
Read more...
 
MoveColumns
This function moves columns to a new position on the same page, to a different page, or to a new page.
Read more...
 
MoveColumnValuesToPages
For each unique value of a designated column, this function creates a new page with all the rows that have that column value. This feature will be most useful following one of the normalization metric operations (ChangeValues).
Read more...
 
MoveRowLabelsToPages
For each unique value of the row labels, this function creates a new page with all the rows that have that row label.
Read more...
 
MoveRows
This function moves rows to a new position on the same page, to a different page, or to a new page.
Read more...
 
MoveTextColumnValuesToPages
For each unique value of a designated text column, this function creates a new page with all the rows that have that text column value.
Read more...
 
NewRowLabel
Sets the row label caption to a new value.
Read more...
 
NewStartingPoint
Use this function to reset a project starting point after it has run once. It is typically used in projects that start with an external query, resetting the starting point after the query is completed. Subsequent actions in the user interface will not re-execute the query.
Read more...
 
NewTextColumnName
Changes a text column caption to a new value.
Read more...
 
PageCaption / PageDescription / PageDescriptionAppend
A page caption, or title, is used by the author to help document the contents of a page as well as to provide a label for use in scripting. It may not appear in an end user’s view of the data. A page description is used by the author to help document the contents of a page. 
Read more...
 
PageNumericFormat
This assigns a numeric format for the current page or resets the default for the project. Any data column which does not have a specifically assigned format will use this format.
Read more...
 
ProjectProperties
This command is used to set a text string that is available to programmers from the object model.
Read more...
 
Prompt
This function sets up a string-substitution action for subsequent script commands. It is commonly used to to pass parameters to other scripts and projects. See the Caution below.
Read more...
 
PromptForPage
Establishes a prompt for a specific page in the project. Usually used to pass parameters to display applications like a dashboard.
Read more...
 
Query, Captions
This function assigns the column captions for each of the data columns loaded from the query.
Read more...
 
Query, Command / CommandAppend
This function accepts the SQL command statements. Query,CommandAppend is used to append to the command string over multiple lines.
Read more...
 
Query, CommandTimeout
This function sets the SQL command timeout value (default is 30 seconds) so that large, complex or slow-responding queries do not timeout.
Read more...
 
Query, Roles
This function is used to define how the fields returned from the query are to be accepted into the program, which are row labels, which are text columns, which are numeric columns, and which to ignore.
Read more...
 
Query, RowLabel

This function assigns the row label caption for the query result.

Read more...
 
Query, Run, ODBC / Oracle / SQL / JDBC
This function executes the query that has been specified through the other Query functions. The result is a new page.
Read more...
 
Query, RunSave, ODBC / Oracle / SQL / JDBC
This function executes the query that has been specified through the other Query functions. The result is a new page, but the bulk of the data is cached to a NOD file which conserves memory and expedites access.
Read more...
 
Query, TextColumnNames
This function assigns the text column captions for each of the text columns loaded from the query.
Read more...
 
RemoveDate

Filter out (removes) rows that meet a specified date criteria.

Read more...
 
RemovePage
Removes a specified page from memory.
Read more...
 
RemoveSelected
After selecting one or more rows, columns, or both, remove them from the current page..
Read more...
 
RemoveTextColumnsAndDataColumns

Remove specified text and/or data columns from the source page.

Read more...
 
RepeatDataColumnNames

This command repeats the specified script command for each data column, and is typically used with a RunScript command to execute a series of commands from a script file.

Read more...
 
RepeatingCalculation
This function performs the same calculation over and over again, across a row.
Read more...
 
RepeatTextColumnNames

This command repeats the specified script command for each text column, and is typically used with a RunScript command to execute a series of commands from a script file.

Read more...
 
RepeatTextColumnValues

This command repeats the specified script command for each unique text column value, and is typically used with a RunScript command to execute a series of commands from a script file.

Read more...
 
Reverse
This function reverses the order of the rows or the columns.
Read more...
 
RollingPeriods
This function performs a rolling calculation from column to column with the specified aggregation.
Read more...
 
RunScript
This function invokes another script from within the current one.
Read more...
 
SaveAsProject
This function converts the interactive operations of a report author into a text file which can be edited. Since it supports interactive operations, it is not expected to be used very often with scripting. Thus, it is only included in the documentation for completeness.
Read more...
 
SavePageToCSV
This creates a data file in the popular CSV (comma-separated) format.
Read more...
 
SavePageToCSVPivot
This creates a data file in the CSV (comma-separated) format which has one row per cell, sometimes referred to as a ‘tupple’.
Read more...
 
SavePageToNOD
This creates a file optimized for data retrieval by NextAnalytics.
Read more...
 
SavePageToXMLCrosstab
This creates a data file in XML format.
Read more...
 
SearchAndSelect
Search for and select rows with a specific text sequences in the row label or particular text column.
Read more...
 
Select, Cell / Unselect, Cell
This function selects a cell. This is not used very often in scripting but is included for completeness of the documentation because the interactive usage can generate this script item and, as such, can show up in a saved project.
Read more...
 
Select, Page
This function selects a page to be the active page upon which subsequent script commands would operate.
Read more...
 
Select,Row/Column Unselect,Row/Column
These functions selects or unselects a row or column.
Read more...
 
SelectByCaptions
This function locates row labels or text columns that have a matching text pattern and selects the rows.
Read more...
 
SelectBySpecificPositions
This function selects a group of specific row or columns by their index numbers.
Read more...
 
SelectRange / UnselectRange
This function selects or unselects a range of rows or columns. Selection is often a prelude to another operation such as compare, combine, filter, or others.
Read more...
 
SetCultureString
Sets the culture to be used for displaying numbers and dates.
Read more...
 
SetMath
This function accepts two pages and returns a new page which includes only rows which were on the second but not the first page (Joiners), on the first but not the second page (Leavers), or on both (Both).
Read more...
 
SetTupleValue

Get the selected row / column / page aggregate or value into a prompt variable.

Read more...
 
ShowAsNumberStandardDeviations
This function calculates the average for the designated axis, then calculates the number of standard deviations from average for each cell.
Read more...
 
ShowPage
This function unhides a page from the HTML output interface, reversing the HidePage function.
Read more...
 
Sort
This function sorts the page numerically according to the designated data column.
Read more...
 
SortByDate
Sort a date column ascending or descending.
Read more...
 
SortColumnLabel

Sorts column labels by their captions/values

Read more...
 
SortCustom

Creates a new page where the columns specified are created in the order asked for.

Read more...
 
SortRowLabel
This function sorts the page alphabetically or numerically according to its row label.
Read more...
 
SortSelected
This function sorts the selected data column.
Read more...
 
SortTextColumn
This function sorts the page alphabetically or numerically according to the designated text column.
Read more...
 
SplitTextColumn

Splits a text column into multiple text columns using specified character delimiters.

Read more...
 
Swap
This function exchanges the rows and columns.
Read more...
 
SwapCellValues
This function exchanges the cell values with either the row labels or the column labels. This results in a rather unique crosstab where by there are lists of labels in the cells. This feature will be most useful following one of the normalization metric operations (ChangeValues).
Read more...
 
SwapTextColumnWithColumn / ByIndex
This function is effectively a pivot operation, swapping the unique values from the selected text column to the columns, then summing the remaining rows to unique sets of row labels and text columns.  Each or the previous data columns becomes a new page. 
Read more...
 
SwapTextColumnWithRowLabel / ByIndex
This function converts the designated text column to being the new row label.  The prior row label is converted to a text column.
Read more...
 
Test
The test function compares each row cell by cell to a baseline row. For each cell, it compares the cell to a corresponding baseline cell according to the boolean conditions supplied as parameters. 
Read more...
 

Reference