Introduction
In general, a document for printing in r_keeper consists of 2 components:
A set of OLAP cash cubes (datasets)
Directly the layout of the document itself.
A set of cubes (datasets) determines which datasets will be used in a document, i.e. sets of variables that can be used in the layout, i.e. check template. The layout itself allows you to determine the appearance of the future document.
The Documents & Layouts menu contains predefined layouts. Preset check layouts cannot be edited, but their copies can be edited.
The layout that is used for printing is called the presentation of the document. The set of document views used in the work is called the Print Scheme. Print schemes can be edited and created.
Layout editor
Let's consider editing a layout using an example of a regular check.
To open the layout editor:
- In the manager station, go to Settings> Print> Documents and Layouts.
In our example, we will edit the check layout, but any other can be edited in the system. - Select the section Settlement with a customer. Right-click on the check layout and select New layout (copy).
- Name the new layout and change the status to Active. Save your changes.
- In the General section, click on the Layout line, then three dots
- The layout editor will open.
Let's take a closer look at what the check layout consists of:- A sheet is the page on which all the elements of the check are located. Different colors of elements are available only in the editor - they are not visible on the check.
- A bend is a section with a specific data set called a dataset. Inside the band, you can operate only with data from the dataset.
- Memo is an active element to which you can add various data. You can add simple text or a variable from a dataset. Variables are added in square brackets. Memo is invested in bands.
The sizes of bends and memos can be changed by dragging and dropping their borders. Also, you can move the band by holding it down with the left mouse button and dragging it to the desired location.
We will consider the properties of each element in more detail below.
There are two tabs on the right side of the layout editor:- Helper - displays available datasets
- Properties - Displays the properties of the selected layout element.
- Now you can go directly to editing the layout:
Layout Editing Script
- Let's try to display the table name on a separate line in the check. To create a band, right-click on a free area and select Create band
- When adding a band to a sheet, you can create an object of 5 types. What each of them is for, you can guess by the name. The main band type, into which data is displayed directly, is virtual.
Select Virtual band from the offered types and click OK.
By holding down the left mouse button on the edge of the band, you can stretch it in height. - Now add two memos.
Right click on the bend and select Create Memo. Resize it to your desired size. Repeat the same steps for the second memo. - Now tell the system what data should be displayed in the memo.
Switch to the content editor by double-clicking the left mouse button on the memo window. Then enter the text you want, for example: Table number. Click Ok.
The written phrase is a constant, it will be printed on every receipt, regardless of the table name. - Add the variable to the second memo. Double-clicking the left mouse button on the memo window, go to the editor. Select the button on the top bar. A window will open with a list of available attributes.
Go to Orders> Table> Main and click once on the Name field, then the OK button.
A variable with the table name will appear in the window. Click OK again to exit the memo editor.
We have created a variable, and now the name of the table for which the check is being made will be printed on the check in these lines. - Click Ok in the lower right corner to close the layout editor.
- Editing the layout is complete. Now we need to apply the layout, i.e. tell the system what layout to print. How to do this, see the article on editing and using a check layout.
Element properties
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), sheet, bend, depending on where the script is placed - the time the code is triggered depends - the sheet is executed first, then the bend, then the memo in this bend.
Common properties for all elements
- Visible
Show object or not. The script is executed regardless of whether the object is visible or not. - Name
The name of the object. This name is used to access the object in scripts. - Tag
Has no predefined purpose. Used at the discretion of layout developers in scripts. - Script
Script text. It is 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 construction. The script has access to all layout objects - pages, bands, memo. The script can change the properties of layout objects. The data source fields are accessed by means of the [DateSet.FieldName] construction. Each script is executed twice: the first time at the stage of preliminary calculation of the layout, the second at the stage of generation. You can find out at what stage we are now using the Report.Stage variable, which takes the following values: stPrecalc (preliminary calculation), stShowing (generation).
Sheet (Document)
The report layout consists of one or more sheets. 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.
Sheet properties
Fix. Height (Fixed Height)
Fixed paper height. Specifies how many lines fit on the printed page. Upon reaching this number of lines, a new page will be started. In the case of a slip-on printer, this will result in a message prompting you to insert a new sheet of paper. In the case of roller, the paper will be cut.
Variables
List of variables common to all sheets of the layout. This editor describes the global variables of the layout. Global variables can be accessed from any layout script, in contrast to local variables, which are available only within the script where they are declared.
Parameters
A list of parameters common to all layout sheets. Data sources (datasets) initially contain data for all stations, waiters, cashiers, etc. In order to build a report only for a specific employee, parameters are used. Before printing the report at the user's checkout
Anyone is asked to set values for parameters, and the report is built taking into account these restrictions. Report parameters work like 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 by 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, then the dataset is not filtered.
Collection - a directory from which values for the parameter will be selected.
Value is a fixed value for the parameter. The values are selected from the lookup given by the Collection. The parameters with the specified value are not changed when the report is printed.
Union Tables
A list of associations common to all sheets in the layout. With a join, you can create a table that is the union of two other tables. The resulting table by the set of fields corresponds to the structure of the first table. The result of the join is a table consisting of rows from both the first and second tables. In one layout, you can define several unions, each of which is described by properties:
Name - the name that the resulting table will receive.
Table 1 is the name of the first table.
Table 2 is the name of the second table.
New Page
If true, then after the printing of all bends of the page is completed, the paper cut command will be inserted (for roller printers, slip printers, this command is ignored).
Two Passes
If true, then when building the layout, the scripts are executed two times: the first time with Report.Stage = stPrecalc, the second with Report.Stage = stShowing. Two passes are needed for the script to make such changes in the report that will require regeneration of the report. For example, if you change the grouping or sorting of the same band from the band script.
Bend (Band)
As mentioned earlier, there is a dataset for each bend. After creating a band, using a double click, you can bind the required data set to it, with which you can later work within this band.
Bends are placed on sheets or nested in other bends. Bends are divided into bends with data sources and bends without data sources (service). Service bands include the following types:
Report Title
Report title
Displayed once at the very beginning of the report
Report Summary
Total for the report
Displayed once at the very end of the report
Page Header
Page header
Displayed at the beginning of every printed page
Page Footer
footer
Displayed at the end of every printed page
The order of processing and printing bands: on each printed page, a Header is displayed at the top of the page, and a Footer at the bottom of the page. Once, on the first page, the Report Title is printed after the Header. The final page, before the Footer, prints the Total for the report. The rest of the bands are displayed in top-down order, i.e. the topmost band will be printed first, then the second by location, etc. If there are several sheets in the layout, then each of the sheets is processed and printed as a separate layout and can contain the Title, Report Total and Headers and Footers.
All bands, except for service bands, can contain up to 3 sections: Body, Header and Footer. None of the sections are required, but at least one of the sections must be present. The order of printing a band: first, the content of the header is printed, then the body is printed, with the body printed as many times as there are lines in the data source, after which the content of the footer is printed.
A bend can modify 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 - a band filter and a filter obtained from the report parameters - then the resulting data source is grouped and then sorted.
Band properties
Data source (DataSet Name)
The data source associated with the band
Filter
The text of the script used to apply the filter to the data source. It is written in a pascal-like language. The script is applied to every line 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: = ([Exclude Income] = 1). Only those rows will remain in the data source where the Excl.Income field was 1.
Sort Order
The set of fields by which the sorting of the data source associated with the band is performed
Grouping
Grouping specifies the set of fields by which the original data source is grouped. Summation is performed over the rest of the fields, i.e. aggregates are counted.
Example: let's say we have a Payment data source:
Group of Currencies
Currency
Order
Guests
Sum
Nat. Sum
Cash
Rubles
1/2
2
300
300
Cash
Euro
1/3
3
twenty
700
Credit cards
Master card
1/4
5
one hundred
one hundred
Cash
Rubles
1/5
2
500
500
Cash
Rubles
1/2
2
200
200
If we group it by the Currency Group field, we get:
Cash
Rubles, Euro
1 / 2.1 / 3.1 / 5.1 / 2
9
1020
1700
Credit cards
Master card
1/4
5
one hundred
one hundred
If we group by the Currency Group, Currency fields, we get:
Cash
Rubles
1 / 2.1 / 5.1 / 2
6
1000
1000
Cash
Euro
1/3
3
twenty
700
Credit cards
Master card
1/4
5
one hundred
one hundred
As you can see from the example, the totals were calculated for the numeric fields, the row fields were connected. In this example, we have calculated national amounts by currency groups and by currencies. Note that the total for the number of guests was calculated incorrectly, because the source data contains several records for one order. For the rest of the fields, the total is meaningless.
You can also calculate the total using aggregate (sum) fields. There are three types of aggregate fields:
SUM (Field) - Analogue of SUM (Field) in SQL. Allows you to calculate the total for the Field field. The total is calculated from the original dataset, which was before the grouping, but using all filters. In our example, the [SUM (Nat sum)] aggregate will be calculated as 1700, the [SUM (Sum)] aggregate will be calculated as 1020.
NUMBER (Field) - Analogue of COUNT (DISTINCT Field) in SQL. Allows to count the number of unique values for the Field field. For example, [NUMBER (Currency)] will return 3 because there are three currencies in the Payment data source.
SUM (Field1, Field2) - has no analogue in SQL. Combines grouping with counting totals. It works in the following way: the source dataset is grouped by the fields Field1, Field2, after which the total is calculated by Field2. For example, you need to calculate the amount of guests for all orders, then [SUM (Order, Guests)] will return the correctly calculated total = 12, while simple summation of the Guests column will give 14.
The same aggregates can be calculated with a given condition:
SUMIF (Field; Condition) - Analogue of SUMIF in Excel. Allows to calculate the total for the Field field for those lines where the Condition condition is met. A condition is an expression of the form FieldName = Value. Instead of the operator = (equal), you can use any comparison operator:>, <, <=,> =, <>. In our example, the [TOTAL (Amount; Currency Group = Cash)] aggregate is calculated as 1600, the [TOTAL (Amount; Currency Group = Cash)] aggregate is calculated as 920.
NUMBER (Field; Condition) - the same as NUMBER (Field1), but only for those rows of the dataset for which the Condition, which looks like FieldName = Value, is fulfilled. For example, [NUMBER (Currency; Currency Group = Cash)] will return 2 because The Payment data source uses two cash currencies.
SUMAUSL (Field1, Field2; Condition) - the same as SUM (Field1, Field2), but only for those dataset rows for which the Condition having the form FieldName = Value is met. For example, you need to calculate the amount of guests for all orders with cash payment, then [TOTAL (Order, Guests; Currency Group = Cash)] will return 7.
Category
Any field of the data source can act 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 a band is printed, a filter of the type Category = Value is placed on the data source. For example, if you specify Currency Group as the category, then the Payment data source will be printed as follows:
Currency
Order
Guests
Sum
Nat. Sum
Credit cards
Master card
1/4
5
one hundred
one hundred
Cash
Rubles
1/2
2
300
300
Euro
1/3
3
twenty
700
Rubles
1/5
2
500
500
Rubles
1/2
2
200
200
Calculated Fields
Using this property, you can add calculated fields to the band dataset. You need to add calculated fields in order to group or sort by fields that are not present in the dataset, but can be calculated based on its fields. Each calculated field is described by the following properties:
An expression is an expression itself. At the moment, attributes can be used as expressions, for example, Employee.Code or MenuElement.Weight.
Field Name - the system name of the added field. Set in English, you need to use this field in scripts.
Title - a custom name for the added field.
Header
Band header. When the band is displayed, it is printed first. It is characterized by the following properties:
Color
Colored
Prints the contents of the header and footer with color highlighting. Works if the printer supports inversion printing
Double Height
Double height
Double print height of header and footer content
Double Width
Double Width
Double the print width of the header and footer content
Hide Blank Lines
Show Empty Lines
The flag determines whether to print blank lines or not
The size
Size
Header / footer height in lines. If 0, no section is printed
Body
Bend body. Displayed after printing the Header. The content of the band body is printed as many times as there are records in the datasheet
those. Band body properties are the same as header properties.
Footer
Band footer. Displayed after the Header and Body of the band. The properties of the footer are the same as those of the header.
Behavior - Show Empty
A flag indicating whether to display a band if there are no records in the data source associated with the band. By default, such bands are not displayed, even if they have a Header or Footer set.
Before Start
A script that is executed before starting band processing.
After Finish
A script that is executed after the end of band processing.
Script
A script that is executed for each line of the data source, just before printing it
XML Section
Used to export a printed document to XML. When exporting, the lines generated by this band will go to the section with the specified name. By default, the section name is the same as the data source name.
Memo
With the help of a memo, individual fields of the data source or any text are displayed. Data source field names (variables) are enclosed in square brackets.
After the dataset is tied to the band, a memo can be placed inside. Variables from the dataset are inserted inside these memo, so the required dataset will be printed in the report.
image2021-5-8_10-56-19.png
It is important to understand that variables from a dataset can only be used within your own band.
Memo properties
Alignment
Specifies whether the text is aligned left, centered, or right.
Content
Contains text to be printed. To print fields from a data source, the field names must be enclosed in square brackets: [FieldName]. To print a field from another data source that is not related to the band in which the memo is attached, you need to use the [DataSourceName.FieldName] construction. To print escape sequences, you need to use the <EscapeCommand> construct. The list of escape commands will be given below. The number of fields that can be displayed using one memo is not limited.
Format
Specifies the format of the variable (number, date, time, other).
Hide zeros
Alternative language
Word wrap
Enable auto-wrap.
XML Attributes
XML class
XML tag
Filter setting example
Let's assume that you need to set up filtering of the Dish in the bill by category. It should look something like this:
[Classification]
[Category1]
Dish1
Dish2
Dish3
Total for category: [price sum]
[Category2]
Dish4
Dish5
Dish6
Total for category: [price sum]
Total by classification
Solution:
Add a calculated field with the required classification to the dish bend (say, the Category field)
Set at the band Category = Category
Group a band by the Category field
Add another bend of dishes to the bend
Add the same calculated field to the nested band and set the same grouping
The field for displaying the dish name must be added to the nested band, for the category name to the external one.