In general, a document for printing in RK7 consists of 2 components: 1) a set of cash register OLAB-cubes (data sets) 2) the document layout itself. A set of cubes (datasets) defines which data sets will be used in the document, i.e. sets of variables that can be used in the layout. The layout itself allows you to determine the appearance of the future document.
It is worth mentioning at once that printed documents in RK7 are of 2 types: system and user. The main difference between the first and the second is that you cannot change the set of cubes(datasets) in the system document, and you can't change the cubes themselves. For custom documents, you can change both the set of cubes and the cubes themselves (for example, add and remove new variables).
Figure 1 shows the main elements of the layout editor:
Fig. 1
1) Band; 2) Memo; 3) Sheet; 4) Assistant with an index of available datasets.
The layout can consist of one or more sheets, these sheets contain bands (sections), other bands can be nested in the bands, or memo fields can be placed. The properties of sheets, bands, and memo fields are changed via the object inspector. Band and field sizes can be changed by dragging their borders.
Each band corresponds to a data source(dataset), which is a set of records (a list of variables) that can be operated on within this band. Individual fields of the data source or any texts are displayed with the help of memo fields. Data source field names are enclosed in square brackets.
When adding a band to a sheet, you can create an object of 5 types (for which each of them is used - you can guess by the name), the main type of the band in which the data is output directly is virtual. After creation, you can bind the desired data set to the band with a double click, and you can later work with this data set inside the band (Fig. 2).
Fig. 2
After the data set is linked to the band - you can place memos inside - we insert variables from the data set inside these memos. This way the desired data set will be displayed in the report (Fig. 3).
Fig. 3
Variables are framed by square brackets, and there is also syntax highlighting. When sending the layout to print, the elements on the sheet are executed sequentially (from top to bottom), i.e. if we make a new layout of the bill and put on the sheet, for example, a band with the "Dishes" data set, then during the execution of this band, all the records from the bill will be processed: one pass - one dish, i.e. in the general sense, in the band, we will run a cycle with the size of the number of dishes in the bill, after this cycle, the next band (cycle) will be executed, and so on. It is allowed to use nested bands, then we get a loop nested in a loop.
It is important to understand that variables from the data set can only be used within their own band.
The layout editor is equipped with a built-in script editor, which has a syntax similar to Pascal (with some limitations). Scripts can be applied to a memo (the lower part of the memo editor), a sheet, or a band, depending on where the script is placed-the code response time depends - first the sheet is executed, then the band, then the memo in this band. An example of using a script in memo is shown in Figure 4.
Fig. 4.
Show the object or not. The script is executed regardless of whether the object is visible or not.
The name of the object. This name is used to access the object in scripts
It does not have a preset destination. Used at the discretion of layout developers in scripts
The text of the script. Written in a pascal-like language, the syntax is pascal. No access to arrays and pointers. The script can contain local variables, for which they are declared at the beginning of the script using the var construct. From the script, you can access all the layout objects (pages, bands, memo fields). The script can change the properties of layout objects. The data source fields are accessed via the [DataSet.Field name]. Each script is executed twice: the first time at the stage of preliminary calculation of the layout, the second at the stage of generation. To find out what stage we are currently at, use the Report.Stage variable, which takes the following values: stPrecalc (preliminary calculation), stShowing (generation).
The report layout consists of one or more sheets. The sheets are processed and printed sequentially, independently of each other; the order of output is from left to right. Each sheet contains its own set of service bands: Report title, Header and Footer, Report summary.
Fixed paper height. Sets how many lines are placed on a printed page. When this number of rows is reached, a new page will be started. In the case of a slip printer, this will result in a message asking you to insert a new sheet of paper, and in the case of a roller printer, the paper will be cut off.
The list of variables is common to all layout sheets. This editor describes the global layout variables. Global variables can be accessed from any layout script, unlike local variables, which are only available within the script where they were declared.
The list of parameters is common to all layout sheets. Datasets initially contain data for all stations, waiters, cashiers, etc. In order to build a report only for a specific employee, the parameters are used. Before printing the report at the checkout, the user is asked to set values for the parameters and the report is built taking into account these restrictions. Report parameters work as filters for datasets. When developing a layout, a list of its parameters is set. Each parameter is described by the following properties:
Field name – The name of the field for which the filter will be placed. All datasets will be filtered by this field. If there is no field with this name in the dataset, the dataset is not filtered.
Collection – A reference list from which the values for the parameter will be selected.
Value – A fixed value for the parameter. The values are selected from the reference set by the Collection. The parameters with the specified value are not changed when the report is printed.
The list of joins is common to all layout sheets. You can use a join to create a table that is a union of two other tables. The resulting table for a set of fields corresponds to the structure of the first table. The result of the merge is a table consisting of rows of both the first and second tables. You can define multiple joins in a single layout, each of which is described by properties:
Name – The name that the resulting table will get
Table 1 – Name of the first table
Table 2 – Name of the second table
If true, then, after printing all the page bands, the paper cutting command will be inserted (for roller printers, slip printers, this command is ignored)
If true, then when building the layout, the scripts are executed twice: the first time with Report. Stage = stPrecalc, the second with Report.Stage = stShowing. Two passes are needed to make script changes to the report that will require the report to be regenerated. For example, if you change the grouping or sorting of the same band from the band script.
3. Band
Bands are placed on sheets or embedded in other bands. Bands are divided into bands with data sources and bands without data sources (service). Service bands include the following types:
Report Title | Report heading | Output once at the very beginning of the report |
Report Summary | Report summary | It is displayed once at the very end of the report |
Page Header | Header and footer | Displayed at the beginning of each printed page |
Page Footer | Footer | Displayed at the end of each printed page |
The order of processing and printing bands: on each printed page, the Header is displayed at the top of the page, and the Footer is displayed at the bottom of the page. Once, on the first page, after the Header, the report Title is printed, on the last page, before the Footer, the Report Summary is printed. The rest of the bands are displayed in top-down order, i.e. the topmost band will be printed first, then the second in order, and so on. If there are multiple sheets in a layout, each sheet is processed and printed as a separate layout and can contain a Title, Report Summary, and Footer.
All bands, except for service bands, can contain up to 3 sections: Body, Header and Footer. None of the sections is required, but at least one of the sections must be present. The order of printing the band: first the contents of the header are printed, then the body is printed, and the body is printed as many times as there are rows in the data source, after which the contents of the footer are printed.
A band can change the content of its data source by sorting, filtering, and rearranging it. This is done by using the Filter, Group, and Sort properties. The order of processing properties: first, a filter is applied to the data source (the band filter and the filter obtained from the report parameters), then the resulting data source is grouped, and then sorted.
Data source associated with the band
The text of the script that applies the filter to the data source. It is written in a pascal-like language. The script is applied to each row of the data source. The essence of the script is to set the Filter variable to true for those rows of the data source that should remain in the final dataset. Example: Filter := ([ExclFromIncome]=1). In the data source, only those rows will remain in which the field iscredits was equal to 1.
A set of fields by which the data source associated with the band is sorted
Grouping specifies the set of fields by which the original data source is grouped. For the remaining fields, summation is performed (aggregates are considered).
Example: Let's say we have a Payment data source:
Currency Group | Currency | Order | Guests | Sum total | Nat. Sum total |
Cash | rub. | 1/2 | 2 | 300 | 300 |
Cash | Euro | 1/3 | 3 | 20 | 700 |
Credit Cards | Master card | 1/4 | 5 | 100 | 100 |
Cash | rub. | 1/5 | 2 | 500 | 500 |
Cash | rub. | 1/2 | 2 | 200 | 200 |
If we group it by the Currency Group field, we get:
Cash | Rubles, Euros | 1/2,1/3,1/5,1/2 | 9 | 1020 | 1700 |
Credit Cards | Master card | 1/4 | 5 | 100 | 100 |
If we group by the fields Currency Group, Currency, we get:
Cash | rub. | 1/2,1/5,1/2 | 6 | 1000 | 1000 |
Cash | Euro | 1/3 | 3 | 20 | 700 |
Credit Cards | Master card | 1/4 | 5 | 100 | 100 |
As you can see from the example, the totals were calculated for the numeric fields, and the lowercase fields were connected. In this example, we calculated the national amounts by currency group and by currency. Note that the total for the Number of guests was calculated incorrectly, because there are several records for one order in the source data. For the rest of the fields, the total does not make sense.
You can also calculate the total using aggregate (sum) fields. There are three types of aggregate fields:
AMOUNT(Field) - Analog of SUM (Field) in SQL. Allows you to calculate the total for the field Field. The total is calculated based on the original dataset that was before the grouping but using all the filters. In our example, the aggregate [SUM(Nat sum)] is calculated as 1700, aggregate [SUM(Sum)] is calculated as 1020.
NUMBER(Field) - Analogous to the COUNT (DISTINCT Field) in SQL. Allows you to count the number of unique values for a fieldField. For example, [NUMBER (Currency)] returns 3, because the Payment data source uses three currencies.
SUM(Field1, Field2) - It has no analog in SQL. Combines grouping with counting totals. It works in the following way: the source dataset is grouped by fieldsField 1, Field 2, then byP2 is considered the total. For example, you need to calculate the amount of guests for all orders, then [AMOUNT(Order, Guests)] will return a correctly calculated total = 12, while with a simple summation of the columnWe will get 14 guests.
The same aggregates can be calculated with the specified condition:
SUMMAUSL (Field; Condition) - Similar to SUMIF in Excel. Allows you to calculate the total for the Field Field for those rows where the Condition is met. The condition is an expression of the form fieldname = Value. You can use any comparison operator instead of the = (equal) operator: >,><,<=,>=,<=,><>. In our example, the aggregate [SUMMAUSL (National sum; groupcurrency=Cash)] is calculated as 1600, aggregate [SUMMAUSL (Sum; groupcurrency=Cash)] will be counted as 920.
NUMBERSL (Field; Condition) – the same as the NUMBER (Field 1), but only for those rows of the dataset that are being executedA conditionthat looks likeFieldname=Value. For example, [NUMBERSL (Currency; groupcurrency=Cash )] returns 2, because the Payment data source uses two cash currencies.
SUMMAUSL(Field 1, Field 2; Condition) – the same as the SUM(Field1, Field2), but only for those rows of the dataset for which the Condition is met, which has the form fieldname=Value. For example, you need to calculate the amount of guests for all orders with cash payment, then [SUMMAUSL (Order, Guests; groupcurrency=Cash payments)] returns 7
Any field of the data source can be used as a category. The category is processed as follows: first, unique values are determined for the specified field, then a band is printed for each received value. Each time the band is printed, a filter of the Category = Value type is placed on the data source. For example, if you specify a Currency Group as a category, the Payment data source is printed as follows:
Currency | Order | Guests | Sum total | Nat. Sum total |
Credit Cards | ||||
Master card | 1/4 | 5 | 100 | 100 |
Cash | ||||
rub. | 1/2 | 2 | 300 | 300 |
Euro | 1/3 | 3 | 20 | 700 |
rub. | 1/5 | 2 | 500 | 500 |
rub. | 1/2 | 2 | 200 | 200 |
You can use this property to add calculated fields to the band dataset. You need to add calculated fields in order to make grouping or sorting by fields that are not present in the dataset but can be calculated based on its fields. Each computable field is described by the following properties:
Expression – The expression itself. At the moment, attributes can be used as expressions (for example, Employee.Code, or a submenu element.Weight)
Field name – the system name of the field to add. Set in English, you need to use this field in scripts.
Header – the custom name of the field to add
The band header. When the band is output, it is printed first. It is characterized by the following properties:
Color | Colored | Prints the content of the footer with color highlighting. Works if the printer supports inversion printing |
Double Height | Double Height | Double the print height of the footer content |
Double Width | Double Width | Double the width of printing the footer content |
Hide Empty Lines | Show Empty Lines | The flag determines whether to print empty lines or not |
Size | Size | The height of the footer in lines. If 0, the section is not printed |
Band's body. Output after the Header is printed. The contents of the band body are printed as many times as there are records in the dataset. The properties of the band body are the same as the properties of the header.
The footer of the band. Output after the Header and the Body of the band. The properties of the footer are the same as the properties of the header.
A flag indicating whether to output a band if there are no records in the data source associated with the band. By default, such bands are not output, even if they have a Header or Footer set
The script that is executed before processing the band
The script that is executed after the end of processing the band
The script that is executed for each row of the data source, just before it is printed
Used for exporting a printed document to XML. When exporting, the strings generated by this band will fall into the section with the specified name. By default, the name of the section is the same as the name of the data source.
Individual fields of the data source or any texts are displayed with the help of memo fields. Data source field names are enclosed in square brackets. Memo fields are nested in bands.
Sets the text alignment method: left, center, or right
Contains the text to be printed. To print fields from the data source, they (field names) must be enclosed in square brackets: [FieldName]. To print a field from another data source that is not associated with the band in which the memo is nested, use the construction [DataSourceName.FieldName]. To print escape sequences, use the <EscapeCommand> construction. The list of escape commands will be given below. The number of fields that can be output with a single memo is unlimited.
Sets the format of the variable (number, date, time, other)
Enable auto-transfer
Let's assume that you need to set up filtering of the dish band in the precheck by category. It should look something like this:
[Classification]
[Category1]
Dish1
Dish2
Dish3
Total by category: [pricesum]
[Category2]
Dish4
Dish5
Dish6
Total by category: [pricesum]
Total by classification
Solution:
Debugging parameters Editing the receipt layout