About parameters
There are two types of parameters: predefined parameters and links to specific rows, columns, or individual report cells.
Predefined parameters
The predefined parameters are application-specific and refer to the report parameters that you specify in other ARM windows, such as the Report definitions (CS206000) window or the Row sets (CS206010 window. For example, the @StartPeriod parameter refers to the value specified in the Start period field in the Report definitions (CS206000) window, or the @BaseRowCode parameter refers to the value specified in the Base row field in the Row sets (CS206010 window. All available predefined parameters are listed in the Data source editor dialog box.
The table below provides the list of the predefined parameters with their descriptions.
| Parameter | Description |
|---|---|
| @AccountCode | The code of the current account (if the Account option is selected in the Expand field in the Data source editor). The code of the current subaccount (if the Sub option is selected in the Expand field in the Data source editor). |
| @AccountDescr | The description of the current account (if the Account option is selected in the Expand field in the Data source editor). The description of the current subaccount (if the Sub option is selected in the Expand field in the Data source editor). |
| @BaseRowCode | The row code specified in the selected row in the Base row column in the Row sets (CS206010 window. This row code is referred to by the @BaseRowCode parameter, which you use in the formula in the Value field in the Column sets (CS206020) window to retrieve the value specified in this row for computing another value in the report. |
| @BookCode | The code of the ledger whose data is used in the report. Refers to the value in the Ledger field in the Default data source section section. |
| @BranchName | The name of the branch that is used in the report. |
| @ColumnCode | The code of the current column in the report. |
| @ColumnIndex | The index of the current column in the report. |
| @ColumnSetCode | The code of the current column set in the report. |
| @ColumnText | The description of the current column in the report. |
| @EndAccount | The last account in the range of accounts used in the report. Refers to the value in the Start account field in the Default data source section section. |
| @EndAccountGroup | The last account group in the range of account groups used in the report. Refers to the value in the End account field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @EndBranch | The last branch in the range of branches used in the report. Refers to the value in the End branch field in the Default data source section section. |
| @EndPeriod | The end period of the report. Refers to the value in the End period field in the Default data source section section. |
| @EndProject | The last project in the range of projects used in the report. Refers to the value in the End project field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @EndProjectTask | The last project tasks in the range of the project tasks used in the report. Refers to the value in the End task field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @EndSub | The last subaccount in the range of subaccounts used in the report. Refers to the value in the End sub field in the Default data source section section. |
| @StartAccount | The first account in the range of accounts used in the report. Refers to the value in the Start account field in the Default data source section section. |
| @StartAccountGroup | The first account group in the range of account groups used in the report. Refers to the value in the Start account field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @StartBranch | The first branch in the range of branches used in the report. Refers to the value in the Start branch field in the Default data source section section. |
| @StartPeriod | The start period of the report. Refers to the value in the Start period field in the Default data source section section. |
| @StartProject | The first project in the range of projects used in the report. Refers to the value in the Start project field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @StartProjectTask | The first project tasks in the range of the project tasks used in the report. Refers to the value in the Start task field in the Default data source section section. Note: This parameter is valid only in the reports of the PM type. |
| @StartSub | The first subaccount in the range of subaccounts used in the report. Refers to the value in the Start sub field in the Default data source section section. |
| @ReportDescr | Report description that the system prints in the column set header. |
| @RowCode | The code of the current row in the report. |
| @RowIndex | The index of the current row in the report. |
| @RowSetCode | The code of the current row set in the report. |
| @RowText | The description of the current row in the report. |
| @UnitCode | The code of the current unit in the report. |
| @UnitSetCode | The code of the current unit set in the report. |
| @UnitText | The description of the current unit in the report. |
Links to rows
You can use the links to the rows in the formulas to define the parameters. The links to the rows are used when a formula is defined for the row to calculate its values, and the referenced rows are the parameters used in these calculations. For example, when a row is a summarised value of the other two rows, the formula includes the references to the rows to be summarised.
You can use the links to the rows in the formulas designed for the calculation of row and column values. However, we do not recommend that you reference the rows in the formulas defined for columns because of the self-references in such formulas. Self-references can be the source of circular reference errors in the formulas.
The links to the rows have the following format: row_code, where row_code is the code of the referenced row (for example, 00112 ).
Links to columns
You can use the links to the columns in the formulas to define the parameters. Use the links to the columns when a formula is defined for the column to calculate its values, and the referenced columns are the parameters used in these calculations. For example, when a column is a summarised value of the other two columns, the formula includes the references to the columns to be summarised. You can use the links to the columns in the formulas designed for calculation of column and row values. Again, avoid referencing the columns in the formulas defined for rows because self-references in such formula can cause circular reference errors.
To reference a column, replace its code into the formula as a parameter.
Links to cells
You can use the links to the report cells in the formulas to define the parameters. You use these links when a formula is defined for the column or row to calculate its values, and the referenced cells are the parameters used in these calculations.
To reference a cell, substitute its code into the formula as a parameter.
Self-links in formula parameters
The self-links in the formulas can be used in very few cases; they typically are avoided to escape the situations when a self-link results in circular reference error. An example of a useful self-link is the case when some operations must be performed with the values selected directly from the data source, such as calculations of charges for a certain period. To use a self-link in a formula, insert a link to the row or column in the formula defined for this row or column.
Parent topic
Related concepts