Fonctionnalités avancées de ONYX Designer/en

<languages/>
=Advanced features=

==Barcodes==

===Creating barcodes===

To create a barcode in Designer, create a zone type '''Barcode''' and select the barcode sub-type you want.

====Types of barcodes====

*'''EAN 8'''  This barcode is used to track logistics units and identify stock keeping units. The eight characters version is used for small sized packages. The data must contain '''seven digits'''. The eighth character is a control character which is calculated by the computer.

*'''EAN 13'''  This barcode is used to track logistics units and identify stock keeping units. In an EAN 13 code, the first two characters indicate the country of origin, the other 10 are data and the last is the control character which is calculated by the computer. The data characters must contain '''12 digits'''.

<ul>
<li><p>'''Code 39'''</p><p>This barcode is used to encode alphanumeric data. It is used in almost every industry except the retail sector. Data may be of variable length and may contain letters and digits.</p><p>The information can be of '''any length''' and contain digits, uppercase letters and the "space", "plus sign", "minus sign", "division", "dot", "percentage" and "dollar" characters.</p></li></ul>

*'''Code 128''' allows general alphanumerical data and ASCII data to be encoded. These codebars are used in numerous industries for stock management purposes. Data is of variable length. The Code 128 C must contain an even number of characters (otherwise a zero is added at the beginning of the barcode) and may only contain digits. The Code 128 B accepts all ASCII characters, whereas the Code 128 A accepts only some of them.  The information to encode can be of '''any length''' and composed of:
**'''''Optimised''''': digits, uppercase letters, lowercase letters, printing or non-printing ASCII characters (0 - 128), and all the function signs and characters provided by the Code 128 in the A, B and C code sets, with systematic length optimisation
**'''''N/optimised''''': digits, uppercase letters, lowercase letters, printing or non-printing ASCII characters (0 - 128), and all the function signs and characters provided by the Code 128 in the B code set, without length optimisation
**'''''Digital''''': digits and control character provided by the Code 128 in the C code set, with systematic length optimisation
*'''Code 2/5 interleaved'''  This encoding of numbers uses density to meet precise characteristics.  The security of this symbology is weak, except when using optional security measures (control character, messages of fixed length that are checked when scanning).
**Although the '''length of the barcode is unlimited''' in terms of the number of characters, the principle of interleaving requires the following:
**An even number of digits when the optional control character is not used
**An odd number of digits when the optional control character is used
*'''Code 2/5 industrial'''  This old symbology was frequently used in industry, particularly the automotive industry. The security of this symbology is weak, unless it is used with messages of fixed-length and checked when scanning.
The data must contain '''1 to 32 digits'''
**The digital information encoding is designed with regards to ease of use
**Development or modification of pre-existing applications

*'''EAN128 Alpha n/optimised'''  Code GS1-128  Used to identify dispatch units (pallets or cardboard boxes).
**Encoding of alphanumeric information,
**Variable length,
**Continuous bidirectional self-controlled.

*'''EAN128 digital''' Code GS1-128  Used to identify dispatch units (pallets or cardboard boxes)..
**Encoding of digital information,
**Variable length,
**Continuous bidirectional self-controlled.

*'''PDF 417'''  Used in every business sector. The PDF417 code is the only two-dimensional barcode that can be scanned using a simple linear scan (1D) due to the fact that, as stacked linear symbology, it has the features of linear barcodes as well as those of  two-dimensional ones.
**Two-dimensional,
**Alphanumeric 2000 length,
**Eight levels of security.

*'''Data Matrix''' This code can encode up to 2335 characters. Various types of encoding are available (ASCII, C40, text and Base 256). The default mode is the automatic mode which can be used to optimise the encoding by switching from one mode to the other depending on the data. It also has an error detection/correction system to repair any damage.
*'''Postnet'''  The '''Postnet''' barcode is used by the United States postal service. It has been replaced by the USPS or Intelligent Mail barcode.
*'''Planet'''  The '''Planet''' barcode is used by the United States postal service. It has been replaced by the USPS or Intelligent Mail barcode.
*'''QR Code'''  It has the particular feature of being able to encode a very large number of characters (7336 in numeric mode). This type of barcode is very widespread in Japan. There are four types of encoding (alphanumeric, numeric, bytes, Kanji) to compress data depending on the type of data. By default, an automatic mode is used to choose the encoding method that will give the best compression rate (switch of mode while processing). Error detection/correction codes are added to the data, which are used to prevent the loss of data in the event of damage. There are four levels of error detection/correction.'''<br />'''

*'''MaxiCode''' The '''MaxiCode''' barcodes, developed by UPS - United Parcel Service, are defined by the ISO 16023-2000 standard. Unlike the others, its size is fixed, which limits the number of characters to be encoded. Indeed, the maximum number of characters is 93 alphanumeric characters or 138 numeric characters. There are two types of encoding. The first only encodes a string of characters, containing data, according to a conventional type of encoding and a standard type of error detection/correction. The second type encodes the following three fields in addition to the string of data: the country which is encoded using 3 digits according to the ISO 3166 standard, the postal code which is encoded using 6 characters and finally a type of service using 3 digits. These three fields are encoded using an extended error correction mode contrary to the string of data whose correction mode is standard.
*'''Japan Postal''' The '''Japan Postal''' barcode is used by the Japanese postal service.
*'''Codabar (NW7)'''  In Japan, the Codabar Monarch is also called NW-7. Because of its relatively simple composition, the Codabar Monarch is frequently used to encode serial numbers in blood bank transfusion services, home deliveries, libraries, etc.
*'''USPS''' '''USPS''' = '''U'''nited '''S'''tates '''P'''ostal '''S'''ervice. The more commonly used official name is the '''Intelligent Mail Barcode'''. It is the new American postal barcode, which is to replace the Planet and the Postnet. The Intelligent Mail barcode is a 4-state barcode composed of 65 bars.
*'''UPC-A'''  The '''UPC-A''' barcode is an american counterpart of the EAN13 barcode, with a 0 as its first number. It is used primarily to identify products in store. The UPC-A barcode can encode 11 digits, a number system with five digits for the Manufacturing Code and five digits for the product code. A 12th digit is calculated using the first eleven in order to act as a control character.
*'''UPC-E'''  The '''UPC-E''' barcode is a short version of the UPC-A barcode, in which the ten digits of the UPC-A barcode (manufacturing and product code) are reduced to six digits by removing unnecessary zeros. With the Number System and the control character, a UPC-E barcode is therefore composed of eight digits. Designer can be used to include UPC-A (11 digits) barcodes in the UPC-E format as well as a code reduced to 6, 7 or 8 digits.

*'''MSI'''  The '''MSI''' barcode is used primarily for stock management, marking storage containers and shelving in warehouse environments. An MSI barcode uses one or two control keys calculated using the Modulo 10 or Modulo 11 and is used to encode numeric values with non fixed sizes. Designer can encode using either a Modulo 10 control key, a Modulo 11 control key, two Modulo 10 control keys, or a Modulo 11 control key followed by a Modulo 10 control key.

====Size of the barcode====

The size of the barcode can be defined in the following two ways:

*The first involves choosing the ''Fit the area'' option in the ''Properties view'', in which case the barcode will adjust as well as possible to the size of the zone, according to its standard
*If the Fit the area option is unticked, the size of the barcode can be set by the size of the font of the zone. This size affects the width and the height of the code. The height can be reduced by reducing the percentage of the height setting of the zone.

===Combined data===

It is possible to combine data found in different places in the spooled file within a single barcode. In order to achieve this, it is necessary to create as many memory zones as there are elements of data to be retrieved from the spooled file and then all these zones must be combined in the label of the barcode zone.

*In the ''Map F'' tab:

[[File:onyxdesigner-image70.png|cid:image002.png@01D170A6.CBD745A0]]

*In the ''Properties'' view:

[[File:OX_D_47.PNG]]

*In this example, the Memory zones have the values:
**MEM_FACT: 0012601
**MEM_DTFACT: 14/10/99

*<span class="underline">Outcome</span>:

[[File:onyxdesigner-image72.png|cid:image004.png@01D170A7.20EEB820]]

It is also possible to add text that is not found in the spooled file using the '''Memory''' zones (detailed in [[#type-de-zones|''<span class="underline">6.4.a.3 Types of zones</span>'']]) : '''[[MEM1|<nowiki>[[MEM1]]</nowiki>]]TEXT[[[[MEM2|<nowiki>MEM2]]</nowiki>]]'''.

If you use replacement zones in a '''Barcode''' zone, the '''length of the barcode''' must be equal to 0.

===Special case: EAN128===

The encoding of the '''EAN128''' is identical to the encoding of the Code128. That is why we use the same fonts. The difference is that the EAN128 is structured in order to standardize the information that it contains. To achieve this, an '''AI''' ('''A'''pplication '''I'''dentify) is inserted between each piece of information, which is used to identify the data encoded.

<span class="underline">Structure of the EAN128</span>: START FNC1 AI DATA (FNC1) AI DATA .... (FNC1) AI DATA CRC END

'''FNC1''': Separator character of the EAN128.

'''AI''': an Application Identifier, is used to encode several standardized elements of information in one code (date+time+etc.).

The first '''FNC1''' is automatically added by Designer. It is required as it is used to differentiate an EAN128 barcode from a CODE128 barcode.

However, the following FNC1 are optional. Indeed, they are only required when the previous element of data does not have a fixed length, in which case they are used to separate each element of data.

If you want to insert the FNC1 character, you have to put the {FNC1} character sequence in your spooled file. These characters will automatically be replaced with FCN1 characters by MAPPING.

<span class="underline">E.g.</span> SPOOL ----&gt; MAPPING

AI DATA ----&gt; START FNC1 AI DATA CRC END

AI DATA {FNC1} AI DATA ----&gt; START FNC1 AI DATA FNC1 AI DATA CRC END

If you cannot change your spooled file to add the "'''{FNC1}"''' characters or if you want to combine several elements of data that are located in different places in the spooled file (see previous paragraph: [[#cumul-de-données|''<span class="underline">8.1.b. Combined data</span>'']]), use memory zones.

===Special case: code 128===

There are three encoding modes for 128 barcodes:

*mode A (alphanumerical),
*mode B (alphanumerical). The code 128 Alphanumeric encodes in B mode,
*mode C (numerical). The code 128 Alphanumeric encodes in C mode.

The code 128 Alphanumeric Optimized switches from B mode to C mode automatically in order to optimize the size of the barcode.

However, your barcode may have to respect a specific type of formatting, i.e. a certain number of characters in A, B or C mode.

For example, the barcode that corresponds to the mail tracking ID of "La Poste" contains 13 characters. The first three must be encoded in B mode and the last ten in C mode.

In order to create this barcode using Designer, you must create a "'''Code 128 N/Optimised'''" type zone and then enter a formatting screen in the '''Advanced''' options of the zone.

<span class="underline">Example</span>:

''For the following data'': 1J45034500751

''You want to encode:''

''- the first three characters (1J4) in B mode''

''- the last ten characters (5034500751) in C mode''

''Your formatting mask must therefore be BBBCCCCC.''

''You will notice that although there are ten digits to be encoded in C mode, there are only five 'C's in the formatting mask. This is due to the fact that one character in C mode encodes two digits.''

===Special case: 2D Codebars===

Currently, MAPPING manages four types of 2D barcodes: '''PDF417''', '''DATA MATRIX''', '''QR CODE''' and '''MAXICODE'''.

If "'''Fit the zone'''" is checked, the "'''Barcode width'''" setting is used to change the size of the barcode. In this case it should be noted that the size of the barcodes can vary in height and width depending on the content to be encoded.

The benefit of 2D barcodes is being able to encode a number of important pieces of information. If the data that you need to encode is located in different places in the spool, go to section [[#cumul-de-données|''<span class="underline">8.1.b. Combined data</span>'']] to combine them in a single barcode.

====QR code====

The '''QR CODE''' barcode was developed according to the International ISO/IEC 18004 standard. It has the particular feature of being able to encode a very large number of characters (7336 in numeric mode).

This type of barcode is very widespread in Japan. It is already used in the industry, but has also been adopted by the general public eversince mobile phones know how to decode it.

There are four types of encoding (alphanumeric, numeric, bytes, Kanji) to compress the data depending on the type of data. By default, the automatic mode is used to choose the encoding method that will give the best compression rate (switch of mode while processing). For example, let us assume that the beginning of the string contains alphanumeric type data. As soon as the program detects a string of at least 13 numeric characters, it changes encoding mode.

Error detection/correction codes are added to the data. These codes prevent the loss of data in the event of damage. There are four levels of error detection/correction. By default, level three is used, its codes use approximately 25% of the final barcode.

[[File:onyxdesigner-image75.png]]

<span class="underline">Advanced options available</span>:

*Barcode width: Value between 1 and 15 specifying the size of the barcode.
*Error Level: (7%, 15%, 25% and 30%).
*FCN1:
**ECI protocol not implemented.
**ECI protocol not implemented, FNC1 implied in first position.
**ECI protocol not implemented, FNC1 implied in second position, in this case, a separator character (Application identifier) must be specified.
*'''A'''pplication '''I'''dentifier: Separator character, used only with the implicit FCN1 in second position.
*<span class="underline">Type of encoding</span>:
**'''AUTO''': Automatic encoding of the data with a switch in mode depending on the data.
**'''ALPHA''': Alphanumeric encoding.
**'''NUMERIC''': Numerical encoding.
**'''BYTE''': Encoding in bytes.

====DATAMATRIX====

The '''Datamatrix''' barcode is defined by the International ISO/IEC 16022 (ECC200) standard. This code can encode up to 2335 characters.

Various types of encoding are available (ASCII, C40, text and Base 256) and the default mode is the automatic mode that can be used to optimize the encoding by swapping from one mode to the other depending on the data.

It also has an error detection/correction system to repair any damage.

[[File:onyxdesigner-image76.png]]

<span class="underline">Advanced options</span>:

*Barcode width: Value between 1 and 15 specifying the size of the barcode.
*<span class="underline">Type of encoding</span>:
**'''AUTO''': Automatic encoding of the data with a switch in mode depending on the data
**'''ASCII''': The ASCII encoding is a tacit plan for encoding the ASCII data.
**'''C40''': C40 encoding transforms 3 alphanumeric characters into two code words.
**'''TEXT''': The Text encoding is used to encode the lowercase characters.

====PDF 417====

The PDF 417 is defined by the International ISO/IEC 15438 standard. This type of barcode can encode up to 2700 numeric characters.

There are three types of data encoding (alphanumeric, numeric and bytes). The automatic mode chooses the best compression rate and changes the mode while encoding.

There are also eight levels of error detection/correction mode. In automatic mode, the level is chosen according to the number of characters to be encoded.

[[File:onyxdesigner-image77.png]]

<span class="underline">Advanced options</span>:

*Barcode width: Value between 1 and 15 specifying the size of the barcode
*Error Level:
**AUTO: automatic choice.
**0 - 8
*Compact mode: Activation of the compact mode or not.
*Ratio: Used to determine the height/width ratio of the barcode.
*Fixed columns: Used to define the number of columns.
*Fixed rows: Used to define the number of rows.

The selection of a ratio prevents you from specifying the number of rows and columns.

====UPS MAXICODE====

This type of barcode, developed by UPS - United Parcel Service, is defined by the ISO 16023-2000 standard. Unlike the others, its size is fixed, which limits the number of characters to be encoded. Indeed, the maximum number of characters is 93 alphanumeric characters or 138 numeric characters.

There are two types of encoding:

*The first only encodes a string of characters containing data according to a conventional type of encoding and a standard type of error detection/correction.
*The second type encodes three other fields stored in three of Designer's memory spaces, in addition to the string of data. These fields are: the country encoded using 3 digits in accordance with the ISO 3166 standard (called MAP_countr), the postal code encoded using 6 characters (MAP_zipcod) and finally a type of service using 3 digits (MAP_servic). These three fields are encoded using an extended error correction mode contrary to the string of data whose correction mode is standard.

[[File:onyxdesigner-image78.png]]

<span class="underline">Advanced options available</span>:

*Barcode width: Value between 1 and 15 specifying the size of the barcode.

==Automating==

Automating Designer processes allows you to create image files corresponding to the preview of a project as well as generate a project or an association of projects. All this can be done in command line, in hidden mode or not.

The aim is to set the command with a .BAT or a remote order, for example.

*'''-InFile''': .PAG or .XML file to map.
*'''-OutFile''': Output image file.
*'''-ProjectFile''': Project to open (.MPP).
*'''-ProjectAsso''': Project association to generate (.MPA).
*'''-MPIFile''': .MPI file to open (MAP tab).
*'''-MPWFile''': .MPW file to open (DRAW tab).
*'''-Hide''': To launch Designer in hidden mode.
*'''-Color''': Use of colour or not to create the image.
*'''-Rotation''': rotation angle of the image (default: 0).
*'''-Resolution''': Image resolution (default: 300).
*'''-Specimen''': Adding a text above the image (text to specify in the argument).
*'''-Mode''': Choice of the SPOOL or XML mode (default SPOOL).
*'''-Generate''': To start generating the project indicated in the argument.
*'''-FtpUse''': 0 = does not use FTP; 1 = uses FTP.
*'''-FtpFolder''': FTP folder.
*'''-FtpLogin''': FTP login.
*'''-FtpPassword''': FTP password.
*'''-FtpIPAddress'': IP address of the server.
*'''-ShareFolder''': Shared folder.
*'''-ServerName''': Name of the server (description).
*'''-Rename''': changes the FORMAT and SEQUENCE of the project using its name. Ex: Invoice00010.mpp.

<span class="underline">Example 1</span>: Project generated in PCL, in color and 300 dpi

<code>C:\Mapping\M-Designer\M-Designer.exe &quot;-Hide&quot; &quot;-ProjectFile:C:\Mapping\M-Processing_Server \Import\docpc\test.mpp&quot; &quot;-Generate&quot;</code>  

When using the "'''-Generate'''" setting (indicating a project generation), the "'''-ProjectFile :'''" or "'''-ProjectAsso :'''" setting must be present to identify the project to be generated.

If both settings "'''-ProjectFile :'''" and "'''-ProjectAsso :'''" are present, the project will take priority for the generation and the association of projects will be ignored.

<span class="underline">Example 2</span>: creating a colour BMP image, with a 90° rotation, in 203 dpi and with the word SPECIMEN overlaid

<code>C:\Mapping\M-Designer\M-Designer.exe &quot;-InFile:c:\test.xml&quot; &quot;- OutFile:c:\image.bmp&quot; &quot;-ProjectFile:C:\ Mapping\M-Processing_Server \Import\docpc\test.mpp&quot; &quot;-Hide&quot; &quot;-Rotation:90&quot; &quot;- Resolution:203&quot; “-Color” &quot;-Mode:XML&quot; &quot;-Specimen:SPECIMEN&quot;</code>

The "'''-InFile'''" and "'''-ProjectFile'''" settings are required to create an image.

If "'''-OutFile'''" is missing, the output file takes the name of the input file with the .BMP extension.

The default mode is SPOOL. If the input file is an XML file, you have to specify the mode.

'''Caution''': The quotation marks around each parameter are '''<span class="underline">required</span>'''.

<span id="_Remplacement_de_caractère" class="anchor"></span>

==Replacing characters==

The objective is to explain how to replace a string of characters in the input file with another string of characters.

The operating principle involves using a text file as a conversion chart between the value to be replaced and the new value.

The following is required in order to use the conversion chart:

*Define the zone using the Type mode = '''Text''' / Sub-type = '''Substitution'''.

[[File:onyxdesigner-image79.png]]

*Finish and generate the template.
*Open the ''ReplaceValue.txt'' file in a text editor (like Notepad, but not Word). The syntax of the file is:

Value to be replaced ''Tab'' New Value

[[File:onyxdesigner-image80.png]]

In this case, the &quot;''']'''&quot; character is replaced with the &quot;'''&gt;'''&quot; character and the &quot;'''Nom'''&quot; character is replaced with the &quot;'''Name'''&quot; character (if the value to replace is located in a Text\Substitution type zone).

*Save the ''ReplaceValue.txt'' file in the '''lgobitmap''' Mapping sub-folder (by default /apps/mapping/import/lgobitmap on Unix)

==Drawing a table==

===Drawing a static table===

To create a perfectly drawn and aligned table without using the ''Static Table'' tool of the ''Overlay view'':

*first, draw the rectangle that will act as the borders of the table,
*draw the vertical lines to create columns,
*draw horizontal lines to create lines if necessary (column headers for example),
*finally select all elements of your table and press the lowercase "'''a'''" on your keyboard:

[[File:onyxdesigner-image83.png]]

[[File:onyxdesigner-image84.png]]

'''Note:'''

This tip also applies to designing the Dynamic part of a project. You can draw a table inside a group in dynamic view, and place an execution condition on a horizontal line for instance, to draw a line dynamically for every new data row.

===Drawing a dynamic table===

As mentioned in ([[#créer-un-groupe-fixe|''<span class="underline">6.4.b.2. Creating a fixed group</span>'']]), the table mode allows the zones of the group to act as cells of a table. The zones of one line are automatically linked.

'''Note:'''

Resizing or moving a zone impacts the size and position of the adjacent zones.

The lines of the group (or conditions) are represented visually in the designing window. The zones are vertically distributed according to their line.

[[File:onyxdesigner-image85.png]]

==Drawing a graph==

In the Map tab:

*Create a graph in the Graph tab:

[[File:onyxdesigner-image86.png]]

*Name it (here, "'''''GRAPH1'''''"):

[[File:onyxdesigner-image87.png]]

From there, the '''complex graph''' can be built in two different ways, detailed below.

===By selecting zones one by one===

*In the spooled file, select the zones which will be used in the graph,
*In the '''Properties''' for each defined zone:
**Name them <span class="underline">all</span> with the same name as the graph (which is "'''GRAPH1'''" here)
**Enter the '''Type''' = "'''''Graph'''''":

[[File:onyxdesigner-image88.png]]

*Depending on the use made of the zone in the graph, select the corresponding Sub-type in the list:

[[File:onyxdesigner-image89.png]]

*Go to the Graph '''Properties''' and click on '''Edition''':

[[File:onyxdesigner-image90.png]]

*Set your graph by choosing from the tabs:
**'''Type''':
***'''Name of the graph''': which will be included in the name of the zones,
***'''Number of zones''' which will lay out the graph,
***'''Graph type''': ''Pie'', ''Bar'' or ''Line'' chart

[[File:onyxdesigner-image91.png]]

'''<span class="underline">NB</span>''': For the graph type = '''''Bar chart''''', it is possible to define the spacing between the bars on the right and on the left (in %). This option can be used, for example, to add spacing between the bars so that a second graph can be overlaid on top of the first one.

[[File:onyxdesigner-image92.png]]

*'''Properties''': allows you to choose the filling, the border, the width of the outline, the filling type, …

[[File:onyxdesigner-image93.png]]

'''<br />'''

*'''Positioning''': allows you to place the ''titles'' (X, Y, of the graph) as well as the ''legend'', to resize the graph according to the preferences of the user.

'''<span class="underline">N.B.</span>''' The print area of the graph is delimited by the large rectangle, so everything outside this area will not be visible when printing (<span class="underline">e.g.</span> the "'''''Legend'''''" area is outside the rectangle in the first image below while it is inside it in the second).

[[File:onyxdesigner-image94.png]]

[[File:onyxdesigner-image95.png]]

*The '''Legend''' is built by selecting zones in the spooled file which will act as legend for the chosen attributes. As with any other data, the zone must be named (e.g. give a name to the graph) and the properties of the zones must be specified with '''Type''' = "'''''Graph'''''" and '''Sub-type''' = "'''''legend data'''''".

'''<span class="underline">N.B.</span>''' Be careful to respect the same order as that of the attributes when selecting the zones that will be used for the legend because they will follow the same order as that of the attributes.

===By creating a group===

The principle is the same as that described above except that the data is assembled into a group. This is possible if the data used in the chart is arranged in continuous in the spooled file.

*Create a group that will define the data to be taken into account for the construction of the graph and add the selected zones that contain data, titles, legend …
*Name the zone(s) with the same name as the graph and enter its properties with '''Type''' = "'''''Graph'''''" and '''Sub-type''' according to the role of the zone (title, data, legend…).

The remainder of the graph construction is done in the same way as that described above.

==Calculations in a group==

To simplify calculations in group and especially the management of "'''total'''" and "'''sub-total'''", a tool has been integrated within Designer. It allows you to process an input XML file using scripts. These scripts are executed before the application of the template.

[[File:onyxdesigner-image96.png]]

[[File:onyxdesigner-image97.png]]

Adding calculations into a group through this tool is done using the "'''addline'''" script function. This function adds a line to a group specifying a sequence of pairs "'''field name'''/'''value'''" to add.

In addition, the "'''character string'''" type parameters must be framed by '''<span class="underline">double quotes</span>''' and field names in formulas by '''<span class="underline">single quotes</span>'''.

<span class="underline">Syntax</span>:

addline(name of the group, name of the line, page break type line, name of the first field, value of the first field, pre-calculation of the first field, name of the second field, value of the second field, pre-calculation of the second field, etc…);

The '''addline''' function starts by the following arguments:

*'''Group name''': contains the name of the group where the line should be added.
*'''Line name''': Name of the line to add.

Then, it consists of an unlimited sequence of field / value pairs:

*'''Field name''': field name of the line.
*'''Field value''': field value of the line.
*'''Pre-calculation''': Boolean value (0 or 1, yes or no). If the field has a calculation then this defines when the calculation should be:
**'''Yes''': The calculation is resolved during the script execution, taking into account all the XML values.
**'''No''': The calculation is solved when using the value in a template and therefore only takes into account the values in the current page.

For example, the following script adds a line to the group named &quot;group&quot;:

<code>addline(&quot;group&quot;,&quot;line&quot;,yes,&quot;field1&quot;,&quot;value1&quot;,no,&quot;field2&quot;,&quot;value2&quot;,no);</code>

<code>&lt;group name=&quot;group&quot;&gt;<br />…<br />'''&lt;line name=&quot;line&quot; pagebreak=”1”&gt;<br />'''&lt;field name=&quot;field1&quot;&gt;value1&lt;/field&gt;<br />&lt;field name=&quot;field2&quot;&gt;value2&lt;/field&gt;<br />&lt;/line&gt;'''<br />'''&lt;/group&gt;</code>

If the '''field value''' contains a calculation then the syntax is:

'''[[SUM('''''operation''''')]]''' to calculate a sum over all the groups of lines.

'''[[AVG('''''operation''''')]]''' to calculate an average over all the groups of lines.

''In this example, "operation'' is a mathematical calculation using field names in lines of the group. Field names must be framed by '''<span class="underline">single quotes</span>'''.

For example:

<code>&lt;group name=&quot;invoice&quot;&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 1&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;10&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;2&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 2&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;5&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;3&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 3&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;12&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;4&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 4&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;5.5&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;3&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;/group&gt;</code>

To add a total line to this group, this script must be used:

<code>addline(&quot;invoice&quot;, &quot;LigneTotal&quot;,no</code>

<code>&quot;total&quot;, &quot;total = [[SUM('price'*'quantity')]]&quot;, yes</code>

<code>&quot;moyenne&quot;, &quot;moyenne = [[AVG('price'*'quantity')]]&quot;, yes</code>

<code>);</code>

This script adds a '''total''' line at the end of the group:

<code>&lt;group name=&quot;invoice&quot;&gt;<br />…<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 4&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;5.5&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;3&lt;/field&gt;<br />&lt;/line&gt;<br />'''&lt;line name=&quot;LigneTotal&quot;&gt;'''<br />'''&lt;field name=&quot;total&quot;&gt;total = 99.5&lt;/field&gt;'''<br />'''&lt;field name=&quot;moyenne&quot;&gt;moyenne = 24.875&lt;/field&gt;'''<br />'''&lt;/line&gt;'''<br />&lt;/group&gt;</code>

Using the '''Pre-calculation option''' set to '''"no"''' allows you to not execute calculations when adding the line to the group but when executed by the template. The advantage of this option is to perform calculations only with the written data on the current page, thus allowing the writing of subtotals.

To add a '''sub-total''' line to the previous group, use this script:

<code>addline(&quot;invoice&quot;,&quot;LineSubtotal&quot;,yes, &quot;subtotal&quot;,&quot;sub-total = [[SUM('price'*'quantity')]]&quot;,no);</code>

This script adds a total line at the end of the group:

<code>&lt;group name=&quot;invoice&quot;&gt;<br />…<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 4&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;5.5&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;3&lt;/field&gt;<br />&lt;/line&gt;<br />'''&lt;line name=&quot;LineSubtotal&quot; pagebreak=”1”&gt;'''<br />'''&lt;field name=&quot;subtotal&quot;&gt;sub-total = [[SUM('price'*'quantity')]]&lt;/field&gt;'''<br />'''&lt;/line&gt;'''<br />&lt;/group&gt;</code>

==Pagination management==

Managing information writing of pagination such as the total number of pages, the number of the batch and the number of pages in the batch is possible in Designer through the following two options:

===Batch breaking===

The '''Batch breaking''' option can be found in the '''Properties''' of the  template (see [[#création-dun-projet-1|''<span class="underline">4.2. Creating a project</span>'']]). It defines a Metadata type zone which will be used to group the pages of the final document in batch.

[[File:onyxdesigner-image98.png]]

During page processing:

*If the '''Metadata''' type zone retrieves a new value then a new batch is created. The current page will belong to this new batch.
*If the '''Metadata''' type zone retrieves a value which was already previously recovered, the current page is moved to the batch corresponding to that value.
*If no value is recovered by the '''Metadata''' type zone, the page remains in the same batch as the previous page.

The multi-document system of XPS is used to represent the batch, the output file is sorted by sequence (first pages of the first batch and the second pages, etc ...).

===Replacement variables===

There are "''post-treatment''" type variables to enable information writing of pagination, that is to say they will be replaced by their real value at the printing time.

'''These variables can be used into zones or in text blocks:'''

'''MAP_TOTAL_PAGE''' = total number of pages.

'''MAP_TOTAL_DOC''' = total number of batches.

'''MAP_TOTAL_PAGE_IN_DOC''' = number of pages in the current batch.

The syntax used is the following:

'''[[PST:'''''name of the variable''''';'''''default value''''']]'''

The "'''''default value'''''" is mandatory and allows you to have a text in the page. This temporary text will then be replaced by its real value. It is important because it is through this text that the positioning calculations will be done. This text must therefore have a number of character at least equal to the maximum value expected by the used variable.

For example:

'''[[PST:MAP_TOTAL_PAGE;000]]'''

Displays '''&quot;000&quot;''' in the page, but at the printing time this value will be replaced by:

*'''&quot; 5&quot;''' if there are 5 pages in total.
*'''&quot; 10&quot;''' if there are 10 pages in total.
*'''&quot;150&quot;''' if there are 150 pages in total.

Other syntaxes also exist, and are accessible during page processing:

'''[[VAR:MAP_CURRENT_PAGE]]''' = number of the current page.

'''[[VAR:MAP_CURRENT_DOC]]''' = number of the current batch (the '''Metadata''' zone managing the batch breaking must be defined before using this variable).

'''[[VAR:MAP_CURRENT_PAGE_IN_DOC]]''' = number of the current page in the current batch.

And in general:

'''[[VAR:variable d’env]]''' = retrieve the contents of the environment variable.

==Managing widows-and-orphans==

Complex management of widows and orphans is possible through two features: '''Entire group''' and '''Repeat''' an XML group.

===Entire group===

When using a '''Limit''' type of page break generation, a new option appears in the group '''Properties''': '''Entire group'''. This option specifies that the group cannot be cut and it must be printed in full on a single page. If the limit triggers a page break, no line from the group will be printed, the group will be fully processed on the next page.

[[File:onyxdesigner-image99.png]]

===XML group repetition===

The XML group repetition assumes that the group appears several times in the input XML file. This feature is enabled with the parameter "'''Repeat'''" in the group properties.

[[File:onyxdesigner-image100.png]]

<span class="underline">Example</span>:

In the example below, the group “'''''invoice'''''” appears three times in the XML. By default, the group of the template retrieves the information from the first appearance of the group in the XML. But if the "'''Repeat'''" option is checked, the execution of the group will continue on all occurrences.

<code>&lt;group name=&quot;'''invoice'''&quot;&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 1&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;10&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;2&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;description&quot;&gt;<br />&lt;field name=&quot;description&quot;&gt;Description item 1&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;/group&gt;<br />&lt;group name=&quot;'''invoice'''&quot;&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 2&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;5&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;3&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;description&quot;&gt;<br />&lt;field name=&quot;description&quot;&gt;Description item 2&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;/group&gt;<br />&lt;group name=&quot;'''invoice'''&quot;&gt;<br />&lt;line name=&quot;item&quot;&gt;<br />&lt;field name=&quot;name&quot;&gt;item 3&lt;/field&gt;<br />&lt;field name=&quot;price&quot;&gt;12&lt;/field&gt;<br />&lt;field name=&quot;quantity&quot;&gt;4&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;line name=&quot;description&quot;&gt;<br />&lt;field name=&quot;description&quot;&gt;Description item 3&lt;/field&gt;<br />&lt;/line&gt;<br />&lt;/group&gt;</code>

The cumulative use of a boundary generating page breaks with the “'''Entire group'''” option and the active repetition allows you to manage a complex system of widows and orphans.

In our example, the "'''''item'''''" lines and the "'''''description'''''" lines cannot be separated by a page break.