| Parameter | Description |
|---|---|
| Column set | Identifies the columns to be included in the analytical report. This is a mandatory attribute for the analytical report. For more information about the column sets, see Column sets - overview. |
| Row set | Identifies the columns to be included in the analytical report. This is a mandatory attribute. For details about the row sets, see About row sets. |
| Unit set | Identifies the units used to compose the analytical report. Use units to describe the structure of complex reports, such as the reports composed from several sections or including different views of data. Units present the dimensions of data in the analytical report. For more information about the unit sets, see Unit sets - overview. |
| Report header | Specifies the text describing the content analytical report. Depending on the report structure, a row header or a column header can be used to specify the header for analytical report. The report header can be defined as a header for the column set selected for the report, or as the row header having the appropriate style. |
| Row headers | Are used to insert the descriptive text into the report. Depending on the report structure, a row header specifies the header text for a single row or a group of rows in the report. |
| Column headers | Are used to insert the descriptive text into the report. Depending on the report structure, a column header specifies the header text for a single column or a group of columns in the report. |
| Printing control attributes | Include the row and column attributes used to insert the page breaks and line breaks in the reports, display or hide the rows or columns from printing, and set the column groups and printing groups to print data from the specific rows in the specific columns. |
| The Printing control parameter can be specified for the columns and rows in the report. It manages the line breaks for the rows, page breaks for the rows and columns, includes or excludes the rows or columns from the printed report, and switches the rows and columns merging on or off. | |
| The Column group and Printing group parameters identify that the specific rows will be printed in the specific columns of the report. |
| Parameter | Description |
|---|---|
| Data source selected for the report | Specifies the data filtering criteria on the report level. The data can be filtered using various criteria including groups of accounts and subaccounts, specific periods, and totals calculation method. For information about the data filtering criteria, see About data filtering criteria. |
| Data source selected for the row | Specifies the data filtering criteria on the row level. You can define the filtering rules separately for each row or set the rules for the groups of rows included in the report. The data can be filtered using various criteria, including groups of accounts and subaccounts, specific periods, and total calculation method. |
| Data source selected for the column | Specifies the data filtering criteria on the column level. You can define the filtering rules separately for each column or set the rules for the groups of rows included in the report. The data can be filtered using various criteria, including groups of accounts and subaccounts, specific periods, and total calculation method. |
| Type | Description |
|---|---|
| Formulas defined for the units | Specify the data transformation and calculation rules on the unit level. The operations specified by the formula defined for a unit can be performed with the data related to the other units, or the data from the columns, rows, and cells in the report table. |
| Formulas defined for the rows | Specify the data transformation and calculation rules on the row level. The operations specified by the formula defined for a row can be performed with the data related to the other rows, columns, and cells in the report table. |
| Formulas defined for the columns | The formulas designed for the columns specify the data transformation and calculation rules on the column level. The operations specified by the formula defined for a row can be performed with the data related to the other rows, columns, and cells in the report table. |
| Type | Description |
|---|---|
| Formatting parameters defined on the report level | Allow for setting up the page layout including the report page and margins sizes, selecting the font attributes (the font name, size, style, and colour), and setting the text align and background colour attributes for the text lines in the report. The formatting parameters defined for the whole report include setting the report attributes for the page formatting, and defining the printing style for the report text. For more information about the printing style, see Printing styles. |
| Formatting parameters defined on the row level | Can be set for any particular row in the report to visually emphasise it. These parameters include text align, font name, size, style and colour, and background colour attributes. Additionally, the separation lines can be included in the report by adding the rows having an underline type. The formatting parameters defined on the row level include setting the row attributes for the row formatting, and defining the printing style for the text in the row. For more information about the row attributes, see About row attributes. |
| Formatting parameters defined on the column level | Can be set for any particular column in the report to visually emphasise it. These parameters include text align, font name, size, style and colour, and background colour attributes. The formatting parameters defined on the column level include setting the column attributes for the column formatting, and defining the printing style for the text in the column. For more information about the column attributes, see Column attributes. |
| Type | Description |
|---|---|
| General ledger | A row type that you select when the data to be displayed in the row does not include some calculated values like yearly or quarterly totals and can be used as a source in the summarised data calculations. This row type can be selected when no formulas are used to calculate the values in the row. |
| Caption | A row type that you select to set the caption for a row or a group of rows. The row caption can be printed on a separate line in the report or merged with the data in the next row of the row set and displayed in the specified column on the next report line. To print the caption on a separate line, you should select Caption in the Type field, then specify the Style attribute to define the caption printing style, and specify the default settings for the other attributes in the row. To display the caption on the same line, specify the Column group attribute for the row, which defines a caption, and select the Merge next option for the Printing control attribute. |
| Line | A row type that you select to insert a row separating line in the report. The separating lines are used to improve the report readability and visually segregate the groups of data displayed in the report lines. You can specify the line style for the separating lines by setting the Line style attribute for the row. |
| Total | A row type that you select when the data displayed in the row includes some calculated values like yearly or quarterly totals and should be excluded from the volume of data that can be selected as a source for summarised values calculation. This row type is commonly used when the row includes a formula which calculates the sums or total values. |
| Header | A row type that you select to print the specific header in this row in the report. You should specify the header in the Headers section of the Column sets (CS206020) window. To display the header in the report, specify the Column group attribute for the row, which defines a header. This attribute specifies the reference to the appropriate header defined for the column set included in this report. |
| Parameter | Description |
|---|---|
| Line break | The option you select to insert a line break after each row. In this case, each row will be printed on a separate line. |
| Merge next | The option you select to merge the row data with the data in the next row. When two rows are merged, the values from the merged row are inserted in the free cells of the next row. To merge the rows, you should define in which columns of the next row the data will be inserted, by setting the Column group attributes for the merged rows. You can merge the rows, for example, when some report line must include data from various rows selected from the database by using different selection criteria. |
| Start box and End box | The option you select to visually group a certain number of sequential rows by adding a frame box to these rows in the printed report. Use the Start box option for the first row in the group of rows to be included in the frame, and use the End box option for the last row in this group. |
| Attribute | Description |
|---|---|
| Page break | This attribute allows you to insert a page break in the printed report after the current row. |
| Height | This attribute allows you to set the row height in the printed report (in pixels). |
| Indent | This attribute allows you to set the row indent in the printed report (in pixels). |
| Line style | This attribute is used to set the line style for the row having the Underline type. |
| Suppress empty | This attribute is used when the empty lines must not be printed in the report. |
| Hide zero | This attribute is used to print blank spaces instead of zero values in the row. |
| Linked row | This attribute enables inheriting the printing control properties of a row in the row set from the printing control properties of another row. The printing control properties of a row are defined by the values of Printing control, Suppress empty, and Hide zero attributes. Linked rows are used when the two rows should be printed or not printed in the report simultaneously, and the printing control properties of the first row are used to set the printing control properties for the second row. To define the row whose printing control properties should be used to set the same properties for the current row, you should enter the code of this row in Linked row for the current row attributes set. |
| Type | Description |
|---|---|
| General ledger | A column type you select when the data to be displayed in the column does not include the values calculated on the column level. This column type can be selected when no formulas are used to calculate the values in the column. If some cells from the rows to be displayed in the report use formulas to calculate the values to be inserted in the row, these formulas will be applied to calculate the values in this column. |
| Calc | A column type you select when a formula is used to calculate the values to be inserted in this cell (for example, when a column cell summarises the values from the other columns). |
| Descr | A column type you select if a test description must be displayed in this column of the printed report. |
| Column type | Description |
|---|---|
| Width | The column width in the printed report (in pixels). |
| Auto height | An attribute that automatically adjusts (if selected) the height of the selected cell in a column. You can select this check box to move a long string of text to the next line inside the cell. |
| Extra space | The indentation for the entire column. |
| Suppress empty | An attribute that is used when the empty columns must not be printed in the report. |
| Suppress line | An attribute that is used to control the underline printing in the column. This parameter switches printing the underlines in the report if some rows in the report have the Underline type; the underlines will not be printed in the column when the Suppress line option is selected for it. |
| Page break | An attribute that you use to split the printed report into the pages and insert a page break in the printed report after the current column. If this option is selected, the next columns in the column set will be printed on the next page. |
| Printing control parameter | Description |
|---|---|
| The option you select to print the column in the report. | |
| Hidden | The option you select to prevent the column from appearing in the printed report. If you select it, the column will not be printed in the report. You can use this option when some columns are used only as a source of data to calculate other report values and must not be included in the printed report. |
| Merge next | The option you select to merge the data in the current column with the data in the next column. When the two columns are merged, the values from the merged column are inserted in the free cells of the next column. To merge the columns, you should define in which rows of the next row the data will be inserted, by setting the Printing group values for the merged rows. Rows merging is used, for example, when a single report line must include data from various rows selected from the database by using different selection criteria or calculated values. |
| Format specifier | Description |
|---|---|
| d | Displays the current day of the month, measured as a number between 1 and 31. If the day is a single digit only (1 to 9), then it is displayed as a single digit. Note that if the d format specifier is used without other custom format strings, it is interpreted as the standard format specifier for the short date pattern. If the d format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| ddd | Displays the abbreviated name of the day for the specified DateTime. |
| dddd (plus any number of additional “d” characters) | Displays the full name of the day for the specified DateTime. |
| dddd (plus any number of additional “d” characters) | Displays the full name of the day for the specified DateTime. |
| f | Displays the most significant digit of the seconds fraction. Note that if the f format specifier is used alone, without other custom format strings, it is interpreted as the full (long date + short time) format specifier. If the f format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| ff | Displays the two most significant digits of the seconds fraction. |
| fff | Displays the three most significant digits of the seconds fraction. |
| ffff | Displays the four most significant digits of the seconds fraction. |
| fffff | Displays the five most significant digits of the seconds fraction. |
| ffffff | Displays the six most significant digits of the seconds fraction. |
| fffffff | Displays the seven most significant digits of the seconds fraction. |
| F | Displays the most significant digit of the seconds fraction. Nothing is displayed if the digit is zero. |
| FF | Displays the two most significant digits of the seconds fraction. However, trailing zeros, or two zero digits, are not displayed. |
| FFF | Displays the three most significant digits of the seconds fraction. However, trailing zeros, or three zero digits, are not displayed. |
| FFFF | Displays the four most significant digits of the seconds fraction. However, trailing zeros, or four zero digits, are not displayed. |
| FFFFF | Displays the five most significant digits of the seconds fraction. However, trailing zeros, or five zero digits, are not displayed. |
| FFFFFF | Displays the six most significant digits of the seconds fraction. However, trailing zeros, or six zero digits, are not displayed. |
| FFFFFFF | Displays the seven most significant digits of the seconds fraction. However, trailing zeros, or seven zero digits, are not displayed. |
| g or gg (plus any number of additional “g” characters) | Displays the era (A.D. for example) for the specified DateTime value. Note that if the g format specifier is used alone, without other custom format strings, it is interpreted as the standard general format specifier. If the g format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| h | Displays the hour for the specified DateTime value in the range 1 to 12. The hour represents whole hours passed since either midnight (displayed as 12) or noon (also displayed as 12). If this format is used alone, then the same hour before or after noon is indistinguishable. If the hour is a single digit (1 to 9), it is displayed as a single digit. No rounding occurs when the hour is displayed. For example, a DateTime of 5:43 returns 5. |
| hh, hh (plus any number of additional “h” characters) | Displays the hour for the specified DateTime value in the range 1 to 12. The hour represents whole hours passed since either midnight (displayed as 12) or noon (also displayed as 12). If this format is used alone, then the same hour before or after noon is indistinguishable. If the hour is a single digit (1 to 9), it is formatted with a preceding 0 (01-09). |
| H | Displays the hour for the specified DateTime value in the range 0 to 23. The hour represents whole hours passed since midnight (displayed as 0). If the hour is a single digit (0 to 9), it is displayed as a single digit. |
| HH, HH (plus any number of additional “H” characters) | Displays the hour for the specified DateTime value in the range 0 to 23. The hour represents whole hours passed since midnight (displayed as 0). If the hour is a single digit (0 to 9), it is formatted with a preceding 0 (01 to 09). |
| m | Displays the minute for the specified DateTime value in the range 0 to 59. The minute represents whole minutes passed since the last hour. If the minute is a single digit (0 to 9), it is displayed as a single digit. Note that if the m format specifier is used alone, without other custom format strings, it is interpreted as the standard format specifier for the month-day pattern. If the m format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| mm, mm (plus any number of additional “m” characters) | Displays the minute for the specified DateTime in the range 0 to 59. The minute represents whole minutes passed since the last hour. If the minute is a single digit (0 to 9), it is formatted with a preceding 0 (01 to 09). |
| M | Displays the month, expressed as a number between 1 and 12. If the month is a single digit (1 to 9), it is displayed as a single digit. Note that if the M format specifier is used alone, without other custom format strings, it is interpreted as the standard format specifier for the month-day pattern. If the M format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| MM | Displays the month, measured as a number between 1 and 12. If the month is a single digit (1 to 9), it is formatted with a preceding 0 (01 to 09). |
| MMM | Displays the abbreviated name of the month for the specified DateTime value. |
| MMMM | Displays the full name of the month for the specified DateTime value. |
| s | Displays the seconds for the specified DateTime value in the range 0 to 59. The second represents whole seconds passed since the last minute. If the second is a single digit (0 to 9), it is displayed as a single digit only. Note that if the s format specifier is used alone, without other custom format strings, it is interpreted as the standard sortable format specifier for the date-time pattern. If the s format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| ss, ss (plus any number of additional “s” characters) | Displays the seconds for the specified DateTime value in the range 0 to 59. The second represents whole seconds passed since the last minute. If the second is a single digit (0 to 9), it is displayed as a single digit only. Note that if the s format specifier is used alone, without other custom format strings, it is interpreted as the standard sortable format specifier for the date-time pattern. If the s format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| ss, ss (plus any number of additional “s” characters) | Displays the seconds for the specified DateTime in the range 0 to 59. The second represents whole seconds passed since the last minute. If the second is a single digit (0 to 9), it is formatted with a preceding 0 (01 to 09). |
| t | Displays the first character of the a.m./p.m. designator for the specified DateTime value. Note that if the t format specifier is used alone, without other custom format strings, it is interpreted as the standard format specifier for the long time pattern. If the t format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| tt, tt (plus any number of additional “t” characters) | Displays the a.m./p.m. designator for the specified DateTime value. |
| y | Displays the year for the specified DateTime value as a maximum two-digit number. The first two digits of the year are omitted. If the year is a single digit (1 to 9), it is displayed as a single digit. Note that if the y format specifier is used alone, without other custom format strings, it is interpreted as the standard format specifier for the short date pattern. If the y format specifier is passed with other custom format specifiers or the % character, it is interpreted as a custom format specifier. |
| yy | Displays the year for the specified DateTime value as a maximum two-digit number. The first two digits of the year are omitted. If the year is a single digit (1 to 9), it is formatted with a preceding 0 (01 to 09). |
| yyyy | Displays the year for the specified DateTime value, including the century. If the year is fewer than four digits in length, then preceding zeros are appended as necessary to make the displayed year four digits long. |
| z | Displays the time zone offset for the system’s current time zone in whole hours only. The offset is always displayed with a leading sign (zero is displayed as +0 ), indicating hours ahead of Greenwich mean time (+) or hours behind Greenwich mean time (–). The range of values is –12 to +13. If the offset is a single digit (0 to 9), it is displayed as a single digit with the appropriate leading sign. The setting for the time zone is specified as +X or –X where X is the offset in hours from GMT. The displayed offset is affected by daylight saving time. |
| zz | Displays the time zone offset for the system’s current time zone in whole hours only. The offset is always displayed with a leading or trailing sign (zero is displayed as +00 ), indicating hours ahead of Greenwich mean time (+) or hours behind Greenwich mean time (–). The range of values is –12 to +13. If the offset is a single digit (0 to 9), it is formatted with a preceding 0 (01 to 09) with the appropriate leading sign. The setting for the time zone is specified as +X or –X where X is the offset in hours from GMT. The displayed offset is affected by daylight saving time. |
| zzz, zzz (plus any number of additional “z” characters) | Displays the time zone offset for the system’s current time zone in whole hours only. The offset is always displayed with a leading or trailing sign (zero is displayed as +00 ), indicating hours ahead of Greenwich mean time (+) or hours behind Greenwich mean time (–). The range of values is –12 to +13. If the offset is a single digit (0 to 9), it is formatted with a preceding 0 (01 to 09) with the appropriate leading sign. The setting for the time zone is specified as +X or –X where X is the offset in hours from GMT. The displayed offset is affected by daylight saving time. |
| : | Serves as a time separator. |
| / | Functions as a date separator. |
| " | Indicates a quoted string. Displays the literal value of any string between two quotation marks preceded by the escape character (/). |
| ' | Indicates a quoted string. Displays the literal value of any string between two single quotation marks. |
| %c | Where c is both a standard format specifier and a custom format specifier, displays the custom format pattern associated with the format specifier. Note that if a format specifier is used alone as a single character, it is interpreted as a standard format specifier. Only format specifiers consisting of two or more characters are interpreted as custom format specifiers. In order to display the custom format for a specifier defined as both a standard and a custom format specifier, precede the specifier with a % symbol. |
| \c | Where c is any character, displays the next character as a literal. The escape character cannot be used to create an escape sequence (like \n for new line) in this context. |
| 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. |
| Report layout parameter | Description |
|---|---|
| Margins | Specifies the margin size settings for the report page, which can be set in pixels, points, picas, centimetres, millimetres, or inches.
|
| Size | Determines the size of the report page, which can be set in pixels, points, picas, centimetres, millimetres, or inches.
|
| Style | Sets the style parameters, including font formatting, background colour, and text align options, for the report. These parameters are the same as the settings specified for the row and column Style parameters used to define the printing style for the rows and columns. |
| Row formatting parameter | Description |
|---|---|
| Height | Specifies the row height (in pixels). |
| Indent | Specifies the row indentation (in pixels). |
| Style | Sets the style parameters, including font formatting, background colour, and text align options, for the row. |
| Column formatting parameter | Description |
|---|---|
| Width | Specifies the column width (in pixels). |
| Extra space | Specifies the indent defined for a column (in pixels). |
| Style | Sets the style parameters, including font formatting, background colour, and text align options for the column. |
| Formatting parameter | Description |
|---|---|
| Text align | The alignment for the text in the report lines. |
| Colour | The text colour. |
| Back colour | The background colour. |
| Font | The font name. |
| Font size | The font size. |
| Font style | The font style (the following options are available: Regular, Bold, Italic, Underline, or Strikeout). |