...
Introduction
In general, a an r_keeper document for printing in RK7 consists of 2 components: 1) a
- A set of
...
- OLAP cubes (
...
- datasets)
- A document layout
...
- .
A set of cubes (datasets) defines cubes determines which data sets of variables will be used in the document, i.e. sets of variables that can be used in the check layout. The layout itself allows you to determine the appearance You may edit the layout to change the design 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.
...
The Documents and Layouts menu contains preset layouts. Preset check layouts cannot be edited, but their copies can be.
The layout used for printing is called the document view. The set of document views used in the work is called the Printing Scheme. Printing schemes can be created and edited.
Layout editor
Let's consider editing a layout using an example of a regular receipt.
To open the layout editor:
- In the manager station, go to Options > Printing > Documents and Layouts.
In our example, we will edit the receipt layout, but you may edit any other layout. - Go to the Client payment section. Right-click on the Receipt layout and select New (as copy) Printing Layout.
- Name the new layout and change the status to Active. Save the changes.
- In the Basic section, click on the Layout line, then on three dots
- The layout editor will open.
Let's take a closer look at what the check layout consists of:- A Sheet is a page on which all the receipt elements are located. Elements are shown in different colours only in the editor, the receipt is printed in black and white.
- A Band is a section with a specific dataset. Inside the band, you can operate only with data from the dataset.
- A Memo is an active element where various data can be added. You can add a simple text or a variable from a dataset. Variables areenclosed in square brackets. A memo is placed inside a band.
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 describe the properties of each element in more detail below.
There are two tabs on the right side of the layout editor:- Assistant — displays available datasets
- Properties — displays the properties of the selected layout element.
- Now you can go directly to editing the layout:
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
| Anchor | ||||
|---|---|---|---|---|
|
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.
...
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 -(it affects the code response time depends - first triggering time): the sheet is executed first, then the band, and then the memo in of this band. An example of using a script in memo is shown in Figure 4.
Fig. 4.
1. Items common properties
- Visible (Visible)
...
.
Properties Common for All Elements
- Visible
To show object or not. The script is executed regardless of whether the object is visible or not. - Name (Name)
The name of the object. This name is used to access the object in scripts.Tag ( - Tag)
...
This property has no predefined purpose. Used at the discretion of layout developers in scripts.- Script
The script text
...
- . It is written in a
...
- Pascal-like language, the syntax is
...
- that of Pascal. It has no access to arrays and pointers. The script can contain local variables,
...
- which
...
- are declared at the beginning of the script using the var
...
- construction.
...
- The script has access to all layout objects — pages, bands,
...
- and memos. 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 the layout preliminary calculation
...
- , the second at the stage of generation.
...
- You can find out at what stage
...
- you 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. The 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, and Report summary.
Sheet
...
Properties
- Fix. Fixed Height
...
- A fixed paper height.
...
- Specifies the maximum number of lines on the printed page.
...
- After reaching this number of
...
- lines, a new page will be started. In the case of a slip-on printer,
...
- a message
...
- about inserting a new sheet of paper
...
- will appear. In the case of a roller printer, the paper will be cut
...
- .
- Variables
...
- A list of variables
...
- common
...
- for all layout sheets. 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
...
- for all layout sheets. Datasets initially contain data for all stations, waiters, cashiers, etc.
...
- Parameters are used in order to build a report only for a specific employee
...
- . Before printing the report at the
...
- cash station, the user
...
- 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 — the name of the field for by which the filter will be placedset. 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 — a reference list from which the values for for the parameter will be selected.
Value – A — a fixed value for the parameter. The values are are selected from the reference set specified by the Collection. The parameters with the specified value are not changed when the report is printed.
- Union Tables
...
- A list of
...
- associations common
...
- for all layout sheets.
...
- It is possible to create a table that is
...
- the union of two other tables. The resulting table
...
- has the same set of fields as the first table, and consists of rows from both the first and second tables.
...
- In one layout, you can define
...
- several unions, each of which is described by the following properties:
Name – The — the name that of the resulting table will get.
Table 1 – Name — the name of the first table.
Table 2 – Name — the name of the second table.
- New Page
If true, then
...
- after the printing of all the page
...
- bends is completed, the paper
...
- cut command will be inserted (for roller printers
...
- only; for slip printers, this command is ignored).
- Two Passes
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 for the script to make
...
- such report changes
...
- that will require the report
...
- regeneration. For example,
...
- when you change the grouping or sorting of the band from this band script.
Band
As mentioned above, each band has its own dataset. After creating a band, using a double click, you can bind the required dataset to it, with which you can later work within this band.
of the same band from the band script.
3. Band
Bands are placed on sheets or embedded nested in other bands. Bands are divided into bands with data sources and bands without data sources (service bands). Service bands include the following types:
| Report Title | Report heading | |
| Displayed once at the very beginning of the report | ||
| Report Summary | Report summary | It is displayed Displayed once at the very end of the report |
| Page Header Header and footer | Displayed at the beginning of each every printed page | |
| Page Footer Footer | Displayed at the end of each every printed page |
The order of bands processing and printing bands: on each printed page, the a Header is displayed at the top of the page, and the a Footer is displayed at the bottom of the page. Once, on the first page, after the Header, the report Report Title is printed , on the last after the Header. On the final page, before the Footer, the Report Summary 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 onone, etc. If there are multiple several sheets in a the layout, then each sheet of them is processed and printed as a separate layout and can contain a the Title, Report SummaryTotal, Headers, and FooterFooters.
All bands, except for service bands, can contain up to 3 sections: Body, Header, and Footer. None of the sections is requiredare obligatory, but at least one of the sections must be present. The order of printing the band printing: first, the contents content of the header are Header is printed, then the body is printed, and the body Body is printed as many times as how much there are rows lines in the data source, after which the contents of the footer are Footer content is printed.
A band can change 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 properties processing properties: first, a filter is applied to the data source (the — a band filter and the a filter obtained from based on the report parameters ), then — and after that the resulting data source is grouped , and then sorted.
...
Band Properties
- DataSet Name
...
- The data source
...
- linked with the band
- Filter
The
...
- script text, 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
...
- linked with the band is
...
- performed
- Grouping
Grouping specifies the set of fields by which the original data source is grouped.
...
- Summation is performed for the rest of the fields, i.e. aggregates are counted.
Example: Letlet's say we have a Payment data source:
| Currency Group | Currency | Order | Guests | Sum | |
| Nat. Sum | |||||
| Cash | rub.Rubles | 1/2 | 2 | 300 | 300 |
| Cash | Euro | 1/3 | 3 | 20 | 700 |
| Credit Cardscards | Master card | 1/4 | 5 | 100 | 100 |
| Cash | rub.Rubles | 1/5 | 2 | 500 | 500 |
| Cash | rub.Rubles | 1/2 | 2 | 200 | 200 |
If we group it by the Currency Group field, we getthe result will be as follows:
| Cash | Rubles, | ||||
| Euro | 1/2,1/3,1/5,1/2 | 9 | 1020 | 1700 | |
| Credit Cardscards | Master card | 1/4 | 5 | 100 | 100 |
If we group by the fields Currency Group, Currency, we get fields, the result will be as follows:
| Cash | |||||
| Rubles | 1/2,1/5,1/2 | 6 | 1000 | 1000 | |
| Cash | Euro | 1/3 | 3 | 20 | 700 |
| Credit Cardscards | 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 row fields were connectedjoined. In this example, we have calculated the national amounts by currency group groups and by currencycurrencies. Note that the total for the Number of guests was calculated incorrectly , because there are because the source data contains several records for one order in the source data. For the rest of the fields, the total does not make senseis meaningless.
You can also calculate the total using aggregate (sum) fields. There are three types of aggregate fields:AMOUNT
- SUM(Field)
...
- — Analogue of SUM(Field) in SQL. Allows
...
- calculating 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.
...
- COUNT(Field)
...
- — Analogue of COUNT(DISTINCT Field) in SQL. Allows
...
- counting the number of unique values
...
- for the6 field
...
- . For example, [
...
- COUNT(Currency)]
...
- will return 3
...
- because there are three currencies in the Payment data source
...
- .
- SUM(Field1, Field2)
...
- — has no
...
- analogue in SQL. Combines grouping
...
- and 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
...
- number of guests for all orders,
...
- then [
...
- SUM (Order, Guests)]
...
- will return
...
- the correctly calculated total = 12, while
...
- a simple summation of the
...
- Guests column will
...
- give 14
...
- .
The same aggregates can be calculated with the specified a given condition:SUMMAUSL
- SUMIF(Field; Condition)
...
- — Analogue of SUMIF in Excel. Allows
...
- calculating the total for the Field
...
- field for those
...
- lines where the Condition condition is met.
...
- A condition is an expression of the FieldName = Value form
...
- . Instead of the = (equal) operator, you can use any comparison operator: >,
...
- <, <=,> =,
...
- <>. In our example, the
...
- [
...
- SUMIF(Nat.Sum; Currency Group = Cash)] aggregate is calculated as 1600,
...
- the [
...
- SUMIF(Sum;
...
- Currency Group = Cash)]
...
- aggregate is calculated as 920.
...
- COUNTIF(Field; Condition)
...
- — the same as
...
- COUNT(
...
- Field1), but only for those
...
- dataset lines for which the Condition, which looks like FieldName = Value, is met. For example, [
...
- COUNTIF(Currency;
...
- Currency Group = Cash)]
...
- will return 2
...
- because the Payment data source uses two cash currencies.
...
- SUMIF(
...
- Field1,
...
- Field2; Condition)
...
- — the same as
...
- SUM(Field1, Field2), but only for those
...
- dataset lines for which the Condition
...
- having the form
...
- FieldName = Value is met. For example, you need to calculate the
...
- number of guests for all orders with cash payment,
...
- then [
...
- SUMIF(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
...
applied to 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
100
100
Cash
...
Rubles
1/2
2
300
300
Euro
1/3
3
20
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:
Expression – The — an expression itself. At the moment, attributes can be used as expressions (, for example, Employee.Code , or a submenu elementMenuElement.Weight).
Field name – Name — the system name of the added field to add. Set in English, you need to use needed for using this field in scripts.Header
– the Title — a custom name of the added field to add.
Header
...
A band header.
...
Is printed first. It is characterized by the following properties:
...
Colored
...
Printing the header and footer contents with color highlighting. Works if the printer supports inversion printing
...
Double Height
Double
...
print height of
...
header and footer content
Double Width
Double
...
print width of
...
the header and footer content
...
Show Empty Lines
The flag determines whether to print empty lines or not
Size
...
Size
...
Header/footer height in lines. If 0,
...
no section is
...
printed
- Body
...
- A band body, displayed after printing the Header
...
- . The
...
- content of the band body
...
- is printed as many times as
...
- how many records
...
- the dataset contains.
...
- Band body properties are the same as
...
- header properties
...
- .
- Footer
...
- A 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
...
- linked 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
Individual In the memo, separate 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.
Properties of the memo field
- Alignment
Sets the text alignment method: left, center, or right
text can be 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 this band. Variables from the dataset are inserted inside these memo, so the required dataset will be printed in the report.
It is important to understand that variables from a dataset can only be used within its own band.
Memo Properties
- Alignment
Specifies whether the text is aligned left, right, or centered. - ContentContents
Contains the 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
...
- linked to the band in which the memo is
...
- placed, 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 variable format
...
- (number, date, time, other).
- Hide zeros
- Alternative language
- Word Wrapwrap
Enable auto-
...
- wrap.
- XML attributesAttributes
XML class
XML Tagtag
...
Filter
...
Setting Example
Let's assume that you need to set up filtering of the dish band Dish in the precheck bill by category. It should look something like this:
| Code Block |
|---|
[Classification] |
...
[Category1] |
...
...
Dish1
Dish2
Dish3
Total by category: [pricesum]
[Category2]
Dish4
Dish5
Dish6
Total by category: [pricesum]
...
Dish1 Dish2 Dish3 Total for category: [priceamount] [Категория2] Dish4 Dish5 Dish6 Total for category: [priceamount] Total for classification |
Solution:
- Add a calculated field with the desired required classification to the food dish band (for examplef.ex., the Category field);
- Set the band's Category = Category ;for the band
- Group the band by the Category field;
- Add another band of dishes to the band;
- Add the same calculation calculated field for to the nested band and set the same grouping;
- The field for displaying the dish name of the dish should must be added to the nested band, the field for the name of the category name — to the external one.
Debugging parameters Editing the receipt layout
...