Actions: Report

clear report

Clears the data displayed in a report.

Argument Description
Element The report element to be cleared.

refresh report

Refreshes the data displayed in a report.

Argument Description
Element The report element to be refreshed.

report current page

Returns the page number of the current page of a report.

Argument Description
Element The report element to have its current page number retrieved.
Output The location where the page number will go (variable or text/field element)

report first page

Display the first page of a report.

Argument Description
Element The report element to display its first page.

report go to page

Display the specified page of a report.

Argument Description
Element The report element to display the specified page.
PageNumber The page number corresponding to the page to display (input, variable, text/field element)

report last page

Display the last page of a report.

Argument Description
Element The report element to display its last page.

report next page

Display the next page of a report.

Argument Description
Element The report element to display its next page.

report number of pages

Returns the number of pages in a report.

Argument Description
Element The report element to have its number of pages retrieved.
Output The location where the number of pages will go (variable or text/field element)

report previous page

Display the previous page of a report.

Argument Description
Element The report element to display its previous page.

reset report

Removes the database connections associated with the report and clears the data displayed.

Argument Description
Element The report element to be reset.

set report column names

Sets the display name for each column.

Argument Description
Element The report element to have its column name(s) set.
ColumnNames A comma-delimited list of the name corresponding to each column.

set report column sizing

Specify how column(s) in a report should be sized.

Argument Description
Element The report element to have its column sizing set.
ColumnSizing A selection from the available sizing options.

set report group key

Specify which key to group the report by.

Argument Description
Element The report element to have its group key set.
Key The key to group the report by.

set report keys

Sets the key(s) that a report is connected to.

Argument Description
Element The report element to have its key(s) set.
Keys The key(s) to be connect to.

set report linked keys

Sets the key(s) that a report is linked to for relational data.

Argument Description
Element The report element to have its linked key(s) set.
LinkedKeys The key(s) to be linked to.

set report linked table

Sets the table that a report is linked to for relational data.

Argument Description
Element The report element to have its linked table set.
LinkedTable The table to be linked to.

set report linking key

Sets the key used for relational data.

Argument Description
Element The report element to have its linking key set.
LinkingKey The key used to link data between tables.

set report recordIDs

Sets the recordID(s) that a report is connected to.

Argument Description
Element The report element to have its recordID(s) set.
RecordIDs A line delimited list where each line is the cdbRecordID of a record to be displayed in the report. Can use “*” to specify all records.

set report sort direction

Specify which direction a report should be sorted.

Argument Description
Element The report element to have its sort direction set.
SortDirection The direction to sort the report (ascending or descending).

set report sort key

Specify which key to sort the report by.

Argument Description
Element The report element to have its sort key set.
Key The key to sort the report by.

set report sort type

Specify the data type used to sort the report.

Argument Description
Element The report element to have its sort type set.
SortType The data type of the sort key (binary, dateTime, international, numeric, text).

set report table

Sets the table that a report is connected to.

Argument Description
Element The report element to have its table set.
TableName The table to be connect to.

set report target

Specify where to access the data connected to the report.

Argument Description
Element The report element to have its target set.
Target The place to access the data (local or cloud).

setup report

Complete setup for a report element.

Argument Description
Target The place to access the data (local or cloud).
LinkedTable A table containing the LinkingKey.
LinkingKey A key used to link data between tables.
GroupKey The key to group the report by.
SortKey The key to sort the report by.
SortType The data type of the sort key (binary, dateTime, international, numeric, text).
SortDirection The direction to sort the report (ascending or descending).
LinkedKeys The key(s) to display from the LinkedTable.
TableName The table to be connect to.
ColumnNames A comma-delimited list of the name corresponding to each column.
Keys The key(s) to be connect to.
ColumnSizing A selection from the available sizing options.
RecordIDs A line delimited list where each line is the cdbRecordID of a record to be displayed in the report. Can use “*” to specify all records.
Element The report element to be set up.

This chapter was last updated on Mon 1 Apr 2024 19:18:17 BST