|
Creates a new page of popular aggregations (Sum, Minimum, Maximum, Average, Median, StdDev, NumericRange, First, Last) of rows, columns or the current page.
|
|
|
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.
|
|
|
AddData reads data from an input file. After AddData has completed it's task, the data can be used by other commands.
|
|
|
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.
|
|
|
Assigns numeric format to selected numeric columns.
|
|
|
This function assigns a new CSS Style to specific columns for use in the authoring interface. It does not affect the underlying data.
|
|
|
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.
|
|
|
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.
|
|
|
This function creates a series of useful baselines, which are subsequently used by the Test function.
|
|
|
Changes the alerts on the current page to be based on an aggregation of an axis of this or another page.
|
|
|
Bases alerting to a specified page, using the corresponding column caption and row caption to obtain a cell value to use for the alert.
|
|
|
Turns Alerts off or resets them to the default.
|
|
|
Changes the alerts on the current page to be based on another row or column on a specific page, either relative or absolutely positioned.
|
|
|
Changes the caption (label) of a row or column to a new value.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.”
|
|
|
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.
|
|
|
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.
|
|
|
This function clears all outstanding selection of the designated axis.
|
|
|
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.
|
|
|
This function combines (aggregates) records which are identical in the row label and all text columns.
|
|
|
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.
|
|
|
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.
|
|
|
This function converts cell values to a percentage of an aggregate of other rows with the same text columnor row label value.
|
|
|
Creates a new text column that combines text from two other columns separated by a specified character.
|
|
|
Replaces the current page data with the alert information. CAUTION: This currently only works for a limited number of alert types.
|
|
|
Copies the selected data column to a text column of the same name.
|
|
|
Removes the designated text column from the page.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
This function hides a page from the HTML output interface. The page can still be referenced by other pages and consumes system resources.
|
|
|
This function hides all pages except for the ones identified, default being the current page.
|
|
|
This function is used to import comma-separated data files that have a header row that contains the column captions.
|
|
|
This function is used to import comma-separated data files that have a header row that contains the column captions.
|
|
|
This function reverses the selection state of the designated axis. |
|
|
After selecting one or more rows, columns, or both, keep the selected items and remove any that were not selected.
|
|
|
This function performs math operations to the current page, or selected columns.
|
|
|
Performs a math operation on two columns of data.
|
|
|
This function moves columns to a new position on the same page, to a different page, or to a new page.
|
|
|
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). |
|
|
For each unique value of the row labels, this function creates a new page with all the rows that have that row label.
|
|
|
This function moves rows to a new position on the same page, to a different page, or to a new page. |
|
|
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.
|
|
|
Sets the row label caption to a new value.
|
|
|
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. |
|
|
Changes a text column caption to a new value.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
This function assigns the column captions for each of the data columns loaded from the query. |
|
|
This function accepts the SQL command statements. Query,CommandAppend is used to append to the command string over multiple lines.
|
|
|
This function sets the SQL command timeout value (default is 30 seconds) so that large, complex or slow-responding queries do not timeout.
|
|
|
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.
|
|
|
This function assigns the row label caption for the query result.
|
|
|
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.
|
|
|
This function assigns the text column captions for each of the text columns loaded from the query.
|
|
|
After selecting one or more rows, columns, or both, remove them from the current page..
|
|
|
Remove specified text and/or data columns from the source page.
|
|
|
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.
|
|
|
This function performs the same calculation over and over again, across a row.
|
|
|
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.
|
|
|
This command repeats the specified script command for each visible text column, and is typically used with a RunScript command to execute a series of commands from a script file.
|
|
|
This function reverses the order of the rows or the columns. |
|
|
This function performs a rolling calculation from column to column with the specified aggregation.
|
|
|
This function invokes another script from within the current one.
|
|
|
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.
|
|
|
This creates a data file in the popular CSV (comma-separated) format.
|
|
|
This creates a data file in the CSV (comma-separated) format which has one row per cell, sometimes referred to as a ‘tupple’.
|
|
|
This creates a file optimized for data retrieval by NextAnalytics.
|
|
|
This creates a data file in XML format.
|
|
|
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. |
|
|
This function selects a page to be the active page upon which subsequent script commands would operate.
|
|
|
These functions selects or unselects a row or column. |
|
|
This function locates row labels or row properties that have a matching text pattern and selects the rows.
|
|
|
This function selects a group of specific row or columns by their index numbers.
|
|
|
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.
|
|
|
Get the caption for the selected page, row, column or cell.
|
|
|
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).
|
|
|
Get the selected row / column / page aggregate or value into a prompt variable.
|
|
|
This function calculates the average for the designated axis, then calculates the number of standard deviations from average for each cell.
|
|
|
This function unhides a page from the HTML output interface, reversing the HidePage function.
|
|
|
This function sorts the page numerically according to the designated data column.
|
|
|
Sorts column labels by their captions/values
|
|
|
Creates a new page where the columns specified are created in the order asked for.
|
|
|
This function sorts the page alphabetically according to its row label.
|
|
|
This function sorts the selected data column.
|
|
|
This function sorts the page alphabetically according to the designated text column.
|
|
|
This function exchanges the rows and columns.
|
|
|
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).
|
|
|
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.
|
|
|
This function is effectively the same as SwapTextColumnWithColumn except that the text column is identified by its index rather than name.
|
|
|
This function converts the designated text column to being the new row label. The prior row label is converted to a text column.
|
|
|
This function converts the designated text column to being the new row label. The prior row label is converted to a text column.
|
|
|
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.
|
|
|
Change the value of the current user’s configuration, overriding their variables.config file settings.
|
|
|
This function determines which text columns are visible in the authoring interface. It does not affect the underlying data.
|
|
