| 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. |
| Operator | Description and examples |
|---|---|
| + (addition) | Adds the value of one numeric expression to another or concatenates two strings. Example: Here, A10 and B10 are cell references. If the values in the cells are 12.85 and 2.25, the result of the expression would be 12.85 + 2.25 = 15.1. |
| + (subtraction) | Subtracts the value of one numeric expression from another. Example: Here, A20 and B30 are cell references. If the values in the cells are 12.85 and 2.25, the result of the expression would be 12.85 - 2.25 = 10.6. |
| * (multiplication) | Multiplies the value of two expressions. Example: Here, A20 and B30 are cell references. Assuming that the parameters have the values C10 = 2.25 and D10 = 2, the example would evaluate to 2.25 * 2 = 4.5. |
| / (division) | Divides the values of two expressions. Example: Here, A10 and C10 are cell references. If the values in the cells are 4.0 and 2.0, the result of the expression would be 4.0 / 2.0 = 2.0. |
| % (Mod) | Divides two numbers and returns only the remainder. Example: Here, B15 and C15 are cell references. If the values in the cells are 15.0 and 6.0, the result of the expression would be 3.0. |
| Operator | Description and examples |
|---|---|
| And | Performs logical conjunction on two Boolean expressions. If both expressions evaluate to True, then the operator returns True; if either or both expressions evaluate to False, And returns False. Example: In this example, A10 and C10 are cell references. If A10 = 10 and C10 = 20, then the expression would evaluate to True. Alternatively, f A10 = -10 and C10 = 20, the expression would evaluate to False. |
| Or | Performs logical disjunction on two Boolean expressions. If either expression evaluates to True, the operation returns True; if neither expression evaluates to True, Or returns False. Example: In this example, A10 and C10 are cell references. If A10 = 10 and C10 = 20, then the expression would evaluate to True. Alternatively, f A10 = -10 and C10 = -20, the expression would evaluate to False. |
| Not | Performs logical negation on a Boolean expression, yielding the opposite of the expression it evaluates. If the expression evaluates to True, the operator yields False; alternatively, if the expression evaluates to False, Not yields True. Example: In this example, A10 and C10 are cell references. If A10 is larger than C10, then the expression would evaluate to False. Alternatively, if A10 is smaller than C10, the expression would evaluate to True. |
| Operator | Description and examples |
|---|---|
| = | Equality operator. Example: In this example, A10 and B10 are cell references. If the value in the A10 cell is equal to the value in C10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| <> | Inequality operator. Example: (where A10 and C10 are the links used as a formula parameters) In this example, A10 and C10 are cell references. If the value in the A10 cell is not equal to the value in B10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| < | The less than operator. Example: In this example, @10 and @12 are the links to cells in the current column. If the value in the A10 cell is not equal to the value in B10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| > | Greater than operator. Example: In this example, A10 and C10 are cell references. If the value in the A10 cell is not equal to the value in B10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| <= | The less than or equal to operator. Example: In this example, A10 and C10 are cell references. If the value in the A10 cell is not equal to the value in B10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| >= | The greater than or equal to operator. Example: In this example, A10 and C10 are cell references. If the value in the A10 cell is not equal to the value in B10, then the expression evaluates to True, otherwise the expression evaluates to False. |
| Operator | Description and examples |
|---|---|
| In (a binary operator) | This operator is used in an elementary logical expression that evaluates the search results and returns True when the parameter matches one of the elements from the set of values. Example: |
| True (a binary constant) | This operator is used as a parameter in logical expressions. Example: |
| False (a binary constant) | This operator is used as a parameter in logical expressions. Example: |
| Null (a value) | This operator is used as a parameter in logical expressions. Example: |
| Function | Description and examples |
|---|---|
| CBool(x) | Converts an expression defined in a function argument into the Boolean expression. If the expression is zero, False is returned; otherwise, True is returned. Example: |
| CDate(x) | Converts an expression defined in a function argument to a value of the Date type. The CDate function argument should be a valid date expression. CDate recognises date formats according to the locale setting of the system. Example: |
| CStr(x) | Converts an expression defined in a function argument to a string. If the CStr function argument equals null, CStr returns a run-time error; otherwise, it returns a string of characters. Example: |
| CDbl(x) | Converts an expression defined in a function argument to a value of the Double type. Example: |
| CSng(x) | Converts an expression defined in a function argument to a value of the Single type. If the expression defined in the function argument lies outside the acceptable range for the Single type, an error occurs. Example: |
| CDec(x) | Converts an expression defined in a function argument to a value of the Decimal type. Example: |
| CInt(x) | Converts an expression defined in a function argument to a value of the Integer type. Example: |
| CShort(x) | Converts a numeric value to a value of the Short type. Example: |
| CLong(x) | Converts a numeric value to a value of the Long type. Example: |
| Function | Description and Examples |
|---|---|
| LTrim(string) | Removes all leading spaces or parsing characters from the specified character expression, or all leading zero bytes from the specified binary expression. Example: |
| RTrim(string) | Removes all trailing spaces or parsing characters from the specified character expression, or all trailing zero bytes from the specified binary expression. Example: |
| Trim(string) | Removes all trailing spaces or parsing characters from the specified character expression, or all trailing zero bytes from the specified binary expression. Example: |
| Format(format, argument(s) ) | Replaces the format item in a specified formatting string ( format ) with the text equivalent of the arguments ( arguments ). Example: |
| UCase(string) | Returns a string that has been converted to upper case. The string argument is any valid string expression. If string contains a null value, the null value is returned. Example: |
| LCase(string) | Returns a string that has been converted to lower case. The string argument is any valid string expression. If string contains a null value, the null value is returned. Example: |
| InStr(string, findString) | Returns the position of the first occurrence of one string ( findString ) within another ( string ). Example: |
| InStrRev(string, findString ) | Returns the position of the last occurrence of one string ( findString ) within another ( string ), starting from the right side of the string. Example: |
| Len(string ) | Returns an integer containing either the number of characters in a string or the nominal number of bytes required to store a variable. Example: |
| Left(string, length ) | Returns a string containing a specified number of characters from the left side of a string. If string contains the null value, the null value is returned. Example: |
| Right(string, length ) | Returns a string containing a specified number of characters from the right side of a string. If string contains a null value, the null value is returned. Example: |
| Replace(string, oldValue, newValue ) | Returns a string in which a specified sub string ( oldValue ) has been replaced with another sub string ( newValue ). Example: |
| PadLeft(string, width, paddingChar ) | Right-aligns the characters in a specified string ( string ), padding with the specified characters ( paddingChar ) on the left for a specified total width ( width ). Example: |
| PadRight(string, width, paddingChar ) | Left-aligns the characters in a specified string ( string ), padding with the specified characters ( paddingChar ) on the right for a specified total width ( width ). Example: |
| Function | Description and Examples |
|---|---|
| Abs(x) | Returns the absolute value of a number. Example: Here A10 and B10 are the links used in a function argument. |
| Floor(x) | Returns the largest integer that is not greater than the argument. Example: Here A10 and A12 are the links used in a function argument. |
| Ceiling(x) | Returns the smallest integer that is not less than the argument. Example: Here A10 and C11 are the links used in a function argument. |
| Round(x, decimals ) | Returns a numeric expression, rounded to the specified precision ( decimals ). Example: Here A10 and B12 are the links used in a function argument, and 5 is the number of digits after the decimal separator. |
| Min(x, y) | Returns the smaller of the two values. Example: Here A10 and A12 are the links used as function arguments) |
| Max(x, y) | Returns the greater of the two values. Example: Here A12 and A14 are the links used as function arguments. |
| Pow(x, power ) | Computes the value of x raised to the specified power ( power ). Example: Here A12 is the link used as a function argument, and 2 is the power index. |
| Function | Description and Examples |
|---|---|
| Now() | Returns the current date and time according to the system date and time on the local computer. Example: |
| Today() | Returns the current date according to the system date and time on the local computer. Example: |
| NowUTC() | Returns the current date and time according to the user’s time zone. The system gets the user’s time zone from the following sources, which are ordered by the priority from the highest to the lowest:
Example: |
| TodayUTC() | Returns the current date according to the user’s time zone. The system gets the user’s time zone from the following sources, which are ordered by the priority from the highest to the lowest:
Example: |
| DateAdd(date, interval, number ) | Returns the new date calculated as a date parameter to which the specified time interval has been added. The interval argument is a string expression that is the interval to be added. This argument can have the following values:
The number is the numeric expression that is the number of intervals to be added. The numeric expression can either be positive, for dates in the future, or negative, for dates in the past. The date argument is the date to which interval is added. Example: |
| Year(date ) | Returns the year component of the date. Example: |
| Month(date ) | Returns the month component of the date. Example: |
| Day(date ) | Returns the day component of the date. Example: |
| DayOfWeek(date ) | Returns the day of week for a date. Example: |
| DayOfYear(date ) | Returns the day of the year for a date. Example: |
| Minute(date ) | Returns the minutes for a date. Example: |
| Second(date>) | Returns the second component of the date. Example: |
| Function | Description and examples |
|---|---|
| IIf(expression, truePart, falsePart ) | Returns one of two values, depending on the evaluation of an expression. If the expression evaluates to True, the function returns the truePart value; otherwise, it returns falsePart value. Example: |
| Switch(expression_1, value_1, expression_2, value_2,…) | Returns one of the values, depending on the evaluation of the expressions in the parameter. The function returns the value_n, which corresponds to the first expression in the enumeration that evaluates to True. Example: |
| IsNull(value, nullValue ) | Returns nullValue, if value is NULL; otherwise, returns value. Example: |
| Sum(from, to) | Returns the sum of the values in the specified interval. Example: |
| Sort(from, to, column ) | Returns the values in the specified range of rows in the specified column sorted in ascending order. Example: |
| SortD(from, to, column ) | Returns the values in the specified range of rows in the specified column sorted in descending order. Example: |
| Function | Description and Examples |
|---|---|
| ExtToInt(object field, object value ) | Converts the external format of the object field parameter into the internal object presentation (for example, converts AccountCD to AccountID ). Both arguments of the ExtToInt function must have the same data type. |
| ExtToUI(object field, object value ) | Converts the external format of the object field parameter into the UI format. Both arguments of the ExtToUI function must have the same data type. |
| GetDefExt(object field) | Gets the default value of the object field parameter in the external format. |
| GetDefInt(object field) | Gets the default value of the object field parameter in the internal format. |
| GetDefUI(object field) | Gets the default value of the object field parameter in the UI format. |
| GetDescription(object field, object value )> | Returns the description of the object field parameter as it is defined in the PXSelectorAttribute. Both arguments of the GetDescription function must have the same data type. Note: If you use this function for subaccounts, the subaccount description is not available if the On-the-fly entry option is specified for subaccounts in the Segment keys (CS202000) window. |
| GetDisplayName(object field) | Returns the localised name of the object field parameter. |
| GetFormat(object field) | Returns the data type of the object field parameter. |
| GetMask(object field) | Returns the mask of the object field parameter. |
| IntToExt(object field, object value ) | Converts the external format of the object field parameter into the internal object presentation (for example, converts AccountID to AccountCD ). Both arguments of the IntToExt function must have the same data type. |
| IntToUI(object field, object value ) | Converts the internal format of the object field parameter into the UI format. Both arguments of the IntToUI function must have the same data type. |
| UIToExt(object field, object value ) | Converts the UI format of the object field parameter into the external object format. Both arguments of the UIToExt function must have the same data type. |
| UIToInt(object field, object value ) | Converts the UI format of the object field parameter into the internal object format. Both arguments of the UIToInt function must have the same data type. |
| FormatPeriod(object period ) | Performs ExtToUI data conversion for the object period parameter. This function is used to get the period defined by the report @StartPeriod and @EndPeriod dates. |
| FormatPeriod(object period, object period shift ) | Performs ExtToUI data conversion for the object period parameter with a time shift defined by object period shift argument. This function is used to get the period defined by the report @StartPeriod and @EndPeriod dates. |
| FormatYear(object period ) | Performs ExtToUI data conversion for the object period parameter year part. This function is used to get the period defined by the report @StartPeriod and @EndPeriod dates. |
| FormatYear(object period, object period shift ) | Performs ExtToUI data conversion for the object period parameter year part with a time shift defined by object period shift argument. This function is used to get the period defined by the report @StartPeriod and @EndPeriod dates. |