Page History

...

Introduction

In general, a document for printing in RK7 r_keeper consists of 2 components:

A 1) a set of OLAP cash register OLAB- cubes (data sets) 2) datasets)
Directly the layout of the document layout itself.
A set of cubes (datasets) defines determines which data sets datasets will be used in the 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.

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 & 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:

1. 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.
2. Select the section Settlement with a customer. Right-click on the check layout and select New layout (copy).
3. Name the new layout and change the status to Active. Save your changes.
4. In the General section, click on the Layout line, then three dots
5. The layout editor will open.
   Let's take a closer look at what the check layout consists of:
   1. 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.
   2. 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.
   3. 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.
6. Now you can go directly to editing the layout:

Layout Editing Script

1. 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
2. When adding a band to a sheet, you can create an object of 5 types

...

1. . What each of them is

...

1. for, you can guess by the name

...

1. . The main

...

1. 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.
2. 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.
3. 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.
4. 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.
5. Click Ok in the lower right corner to close the layout editor.
6. 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

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 bandbend, depending on where the script is placed - the time the code response time is triggered depends - first the sheet is executed first, then the bandbend, then the memo in this band. An example of using a script in memo is shown in Figure 4.

Fig. 4.

1. Items common properties

• Visible (Visible)

...

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 (Name)
  The name of the object. This name is used to access the object in scripts.Tag (
• 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. 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, Report summary.

Sheet

...

properties

Fix. Height (Fixed Height)
Fixed paper height. Sets Specifies how many lines are placed fit on a the printed page. When Upon reaching this number of rows is reachedlines, a new page will be started. In the case of a slip-on printer, this will result in a message asking prompting you to insert a new sheet of paper, and in . In the case of a roller printer, the paper will be cut off.

Variables
The list List of variables is common to all sheets of the layout sheets. This editor describes the global variables of the layout variables. Global variables can be accessed from any layout script, unlike in contrast to local variables, which are available only available within the script where they were are declared.

Parameters
The A list of parameters is common to all layout sheets. Datasets Data sources (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's checkout 

Anyone is asked to set values for the ​​for parameters, and the report is built taking into account these restrictions. Report parameters work as 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 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 reference list - a directory from which the values for ​​for the parameter will be selected.

Value  – A is a fixed value for the parameter. The values are ​​are selected from the reference set lookup given by the Collection. The parameters with the specified value are not changed when the report is printed.

Union Tables
The A list of joins is associations common to all sheets in the layout sheets. You can use a join to With a join, you can create a table that is a the union of two other tables. The resulting table for a by the set of fields corresponds to the structure of the first table. The result of the merge join is a table consisting of rows of from both the first and second tables. You In one layout, you can define multiple joins in a single layoutseveral unions, each of which is described by properties:

Name  – The - the name that the resulting table will getreceive.

Table 1  – Name is the name of the first table.

Table 2  – Name is the name of the second table.

New Page
If true, then , after the printing of all bends of the page bandsis completed, the paper cutting 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 twicetwo times: the first time with Report.Stage = stPrecalc, the second with Report.Stage = stShowing. Two passes are needed needed for the script to make script such changes to in the report that will require regeneration of the report to be regenerated. For example, if you change the grouping or sorting of the same band from the band script.
3. Band

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 Bands are placed on sheets or embedded nested in other bandsbends. Bands Bends are divided into bands bends with data sources and bands 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

...

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, 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. The final page, before the Footer, the Report Summary is printedprints 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 in order, and so onby location, etc. If there are multiple several sheets in a the layout, then each sheet of the sheets is processed and printed as a separate layout and can contain a the Title, Report Summary, and FooterTotal and Headers and Footers.

All bands, except for service bands, can contain up to 3 sections: Body, Header and Footer. None of the sections is are required, but at least one of the sections must be present. The order of printing the a band: first, the contents content of the header are is printed, then the body is printed, and with the body is printed as many times as there are rows lines in the data source, after which the contents content of the footer are is printed.

A band bend 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 processing properties: first, a filter is applied to the data source (the - a band filter and the a filter obtained from the report parameters ), - then the resulting data source is grouped , and then sorted.

Bend Properties

Band properties

Data source (DataSet Name)
Data The data source associated with the band

Filter
The text of the script that applies used to apply the filter to the data source. It is written in a pascal-like language. The script is applied to each row 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: = ([ExclFromIncomeExclude Income] = 1). In the data source, only Only those rows will remain in which the field iscredits was equal to the data source where the Excl.Income field was 1.

Sort Order
A The set of fields by which the sorting of the data source associated with the band is sortedperformed

Grouping
Grouping specifies the set of fields by which the original data source is grouped. For the remaining fields, summation is performed (aggregates are considered)Summation is performed over the rest of the fields, i.e. aggregates are counted.

Example: Letlet'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 fields 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, and the lowercase row fields were connected. In this example, we have calculated the national amounts by currency group groups and by currencycurrencies. Note that the total for the Number number of guests was calculated incorrectly, because there are 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:

AMOUNTSUM (Field)   - Analog Analogue of SUM (Field) in SQL. Allows you to calculate the total for the Field field Field. The total is calculated based on from the original dataset that , which was before the grouping, but using all the filters. In our example, the aggregate  [SUM (Nat sum)]  is aggregate will be calculated as 1700, aggregate the [SUM (Sum)]  is aggregate will be calculated as 1020.
NUMBER (Field)   - Analogous to the Analogue of COUNT (DISTINCT Field) in SQL. Allows you to count the number of unique values for a ​​for the Field fieldField. For example, [NUMBER (Currency)]  returns will return 3 , because there are three currencies in the Payment data source uses three currencies.
SUM (Field1, Field2)   - It has no analog analogue in SQL. Combines grouping with counting totals. It works in the following way: the source dataset is grouped by the fields Field 1, Field 2, then byP2 is considered the totalField1, Field2, after which the total is calculated by Field2. For example, you need to calculate the amount of guests for all orders, then then [AMOUNTSUM (Order, Guests)]  will will return a the correctly calculated total = 12, while with a simple summation of the columnWe Guests column will get give 14 guests.
The same aggregates can be calculated with the specified a given condition:

SUMMAUSL SUMIF (Field; Condition)   - Similar to Analogue of SUMIF in Excel. Allows you to calculate the total for the Field Field field for those rows lines where the Condition condition is met. The A condition is an expression of the form fieldname FieldName = Value. You can use any comparison operator instead Instead of the operator = (equal), you can use any comparison operator:>, ><<, <=,> =, <=,><><>. In our example, the aggregate [SUMMAUSL TOTAL (National sumAmount; groupcurrencyCurrency Group = Cash)] aggregate is calculated as 1600, aggregate the [SUMMAUSL TOTAL (SumAmount; groupcurrencyCurrency Group = Cash)]  will be counted aggregate is calculated as 920.
NUMBERSL NUMBER (Field; Condition)  – - the same as the NUMBER (Field 1Field1), but only for those rows of the dataset that are being executedA conditionthat for which the Condition, which looks like FieldnameFieldName = Value, is fulfilled. For example, [NUMBERSL NUMBER (Currency; groupcurrencyCurrency Group = Cash)]  returns will return 2 , because the The Payment data source uses two cash currencies.
SUMMAUSLSUMAUSL (Field 1Field1, Field 2Field2; Condition)  – - the same as the SUM (Field1, Field2), but only for those dataset rows of the dataset for which the Condition is met, which has having the form fieldnameFieldName = Value is met. For example, you need to calculate the amount of guests for all orders with cash payment, then then [SUMMAUSL TOTAL (Order, Guests; groupcurrencyCurrency Group = Cash payments)]  returns will return 7.
Category
Any field of the data source can be used act as a category. The category is processed as follows: first, unique values are ​​are determined for the specified field, then a band is printed for each received value. Each time the a band is printed, a filter of the type Category = Value type is placed on the data source. For example, if you specify a Currency Group as a the category, then the Payment data source is 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
You can use Using this property to , you can add calculated fields to the band dataset. You need to add calculated fields in order to make grouping group or sorting sort by fields that are not present in the dataset, but can be calculated based on its fields. Each computable calculated field is described by the following properties:

Expression – The An expression is 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 this field in scripts.Header – the

Title - a custom name of for the added field to add.

Header
The band Band header. When the band is outputdisplayed, 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
Band's Bend body. Output Displayed after printing the Header is printed. The contents content of the band body are is printed as many times as there are records in the dataset. The properties of the band body datasheet 

those. Band body properties are the same as the header properties of the header.

Footer
The Band footer of the band. Output Displayed after the Header and the Body of the band. The properties of the footer are the same as the properties those of the header.

Behavior - Show Empty
A flag indicating whether to output display a band if there are no records in the data source associated with the band. By default, such bands are not outputdisplayed, even if they have a Header or Footer set.

Before Start
The A script that is executed before starting band processing the band.

After Finish
The A script that is executed after the end of band processing the band.

Script
The A script that is executed for each row line of the data source, just before printing it is printed

XML Section
Used for exporting to export a printed document to XML. When exporting, the strings lines generated by this band will fall into go to the section with the specified name. By default, the section name of the section is the same as the name of the data source name.

...

Memo

Individual With the help of a memo, 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.

Properties of the memo field

• Alignment

Sets the text alignment method: left, center, or right

• Contents

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 Contains the text to be printed. To print fields from the a data source, they (the field names ) must be enclosed in square brackets: [FieldName]. To print a field from another data source that is not associated with related to the band in which the memo is nestedattached, you need to use the construction [DataSourceName.FieldName] construction. To print escape sequences, you need to use the <EscapeCommand> constructionconstruct. The list of escape commands will be given below. The number of fields that can be output with a single displayed using one memo is unlimitednot limited.

Format
Sets Specifies the format of the variable (number, date, time, other).

Hide zeros
Alternative language
Word

...

wrap
Enable auto-transferwrap.

XML

...

Attributes
XML class
XML

...

tag

...

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:

[Classification]

[Category1]                                             

Dish1
Dish2
Dish3

Total by for category: [pricesumprice sum]

[Category2]

Dish4
Dish5
Dish6

Total by for category: [pricesumprice 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.

...

 Debugging parameters    Editing the receipt layout