Fonctionnement des groupes/en

<languages/>
=Introduction=

This documentation describes how groups of the Designer module work.
Understanding these processes is necessary to then understand the documentation on creating dynamic tables on Designer Onyx 9.x or Opale 10.x.

=General information=

==Definition of a group==
In Designer, a group is a block which '''processes''' several lines in a sequential way. 

There are 2 types of input data in Designer:

#Paginated text
#:In paginated text mode, a group '''processes''' the content of a paginated text from one line number to another. (or from one line respecting a specific condition to the next one respecting said condition).
#XML
#:In XML mode, the group '''processes''' all the lines (line type '''<line name="XX"></line>''') which it will own.


<u>note</u>: '''To process''' is the verb used, to display or to print are incorrect because the group parses all the lines it will own. For each of them and in a sequential way, it searches for their line condition (or line type) and executes all the objects linked to that condition. If it is the case, all the objects are executed so that they can be displayed. (Line, text zone, zone displaying input file data, etc)<br><br>

If the group is configured as exclusive condition, then the first condition found executes the objects while other conditions will not be executed.<br>

Otherwise, if the group is configured as non exclusive condition, then all conditions applied are executed with their associated objects.

==Vocabulary==

'''Baseline'''        : Line which acts as reference to position the objects of the group.<br>
<u>note</u>: This reference line moves towards the bottom each time a new line is executed, it follows this order:	

#"Front spacing" shift
#Each object of the line is processed
#"After spacing" shift<br><br>

'''Front spacing''': Space dedicated to the line written above the baseline<br><br>
'''After spacing''': Space dedicated to the line written below the baseline<br><br>
'''Work space''': Space dedicated to the entire line: i.e Front spacing + After spacing <br>

==Content of a group==
===In paginated text mode===
Here is an example of the content of a group. The group processes the content of the page from line 1 to line 10.

[[Fichier:OX D GRP 1.jpg|néant|vignette|521x521px]]

Concerning line conditions or line types, if you wish to process the first line "MAPPING SUITE" differently, then create a line type which only applies to the first line. (For example: there is the term "MAPPING SUITE" on the line or use the "first line" operator)

===In XML mode===

Here is an example of an XML group.

 <group name="MyGroup">
 <line name="MyLine1">
 <field name="MyField">MAPPING SUITE</field>
 </line>
 <line name="MyLine2">
 <field name="MyField">SAS (simplified joint-stock company) with a capital of 1 000 000 €</field>
 </line>
 <line name="MyLine3">
 <field name="MyField">18 Allée du Chateau blanc</field>
 </line>
 <line name="MyLige4">
 <field name="MyField">59290 WASQUEHAL</field>
 </line>
 </group>

In this case, if you want to process the "MAPPING SUITE" line differently, create a line condition "If the name of the line is MyLine1"

=Group mechanisms=
==General information==
As seen previously, the lines of a group are parsed sequentially and their associated objects are executed.
Once a group has been executed, the result is usually a series of lines. (with their associated objects as content: Line, text, rectangle for example)

There needs to be spacing between the lines of the group. If this spacing is higher than 0, than all the lines of the group are overlaid on each over.

This spacing can be configured and is related to the line type (condition) associated with this object. 

Which is why we talk about '''Front spacing''' and '''After spacing'''.

==Detailed diagram==
<br />

The diagram below illustrates the concept of baseline, lines and workspace.

[[Fichier:OX D GRP 22.jpg|alt=|néant|vignette|1099x1099px]]
<br />

The spacing between two new lines of the group is defined by: Front spacing + After spacing (which corresponds with the workspace).

==Position of the different objects in comparison to the baseline==

The different objects are not always positioned in the same place in comparison to the baseline. <br>
It is important to understand it to fully master template designing. This concept is useful to understand when creating dynamic tables.

===Designer blue zone===
[[Fichier:OX_D_GRP_6.jpg|alt=|néant|vignette|1099x1099px]]

Text is positioned on the baseline of the zone.

===Horizontal line===
[[Fichier:OX_D_GRP_3.jpg|alt=|néant|vignette|1099x1099px]]

The horizontal line is positioned on top of the baseline.

===Verticale line===
[[Fichier:OX_D_GRP_4.jpg|alt=|néant|vignette|1099x1099px]]

The top of the vertical line is positioned underneath the baseline.

===Rectangle===

[[Fichier:OX_D_GRP_5.jpg|alt=|néant|vignette|1099x1099px]]

The rectangle is positioned on the baseline.

===Image===
[[Fichier:OX_D_GRP_7.jpg|alt=|néant|vignette|1099x1099px]]

The image is positioned underneath the baseline (i.e underneath the blue zone).

===1D Barcodes===
[[Fichier:OX_D_GRP_8.jpg|alt=|néant|vignette|1099x1099px]]

1D barcodes are positioned on top of the baseline (they act in the same way text does).

==Line processing==

The list of all the objects in the template is found among the list of Designer objects (MAP or DRAW tab).
Groups and line types (conditions) are executed following the order laid out by this list. The line types (conditions) which are the lowest in the group are executed after the line types (conditions) which are the highest.
In the following example, the line type (condition) '''RED''' is checked before the line type '''NOT_BLANK'''

<u>Note</u>:

Objects outside groups are executed in the following order:
#Zone (outside of groups)
#Groups
#Text zones
#Graphs

If we consider the following list of objects:

[[Fichier:OX D GRP 9.jpg|néant|vignette|521x521px]]

There are 4 zones which are outside of a group (FAC#, DATEFAC, PAGE# and COM#).
There is also a group (Ma) which has 2 conditions (RED and NOT_BLANK) each with an associated object (a zone which displays the content of the line).
For the purpose of this documentation, we will focus on this group (Ma)

The group processes the lines as such:
#<span style="color:green">The group parses the current line as it checks if it corresponds to the conditions of the first line type. (Condition RED)
#: YES --> '''Checks point 2'''
#: NO --> The group checks if the next line corresponds to the line type (condition)  (Line type NOT_BLANK)
#:: YES --> '''Checks point 2'''
#::NO --> The group checks if the next line corresponds to the line type (condition) etc </span>
#::: If there are more types of lines (condition) which are customised, then the NONE line type is executed (Line type which is always present and true). Checks point 2
#<span style="color:green">Checks the presences of an object in the line type (condition)
#: YES --> Checks point 3
#: NO --> '''Checks point 6'''</span>
#<span style="color:green">The cursor is moved to the bottom of the FRONT SPACING of the line type (condition) found</span>
#<span style="color:green">The group either executes all the objects positioned underneath it (In this example, ADRMAPROUG for the RED condition OR ADRMAPPING for the NOT_BLANK condition) or no objects for the line type NONE</span>
#<span style="color:green">The cursor is moved to the AFTER SPACING of this line type (condition).</span>
#<span style="color:green">The group switches to the next line so as to process it. '''Checks point 1'''</span>

<u>Note</u>: This process is repeated for each line of the group.

<u>There are two types of groups</u>:
#'''Exclusive Condition''': In the process described below, the first line type (condition) which is true, is executed. Designer does not check the other line types (conditions). (Therefore, the order of the conditions in the object list is very important. In this example, the line type RED is checked before NOT_BLANK)
#'''Non Exclusive Condition''': In non exclusive condition groups, Designer checks all line types in the group and executes them if they are true. (including the NONE line type)

<u>Note</u>: The order in which the line types are executed can be changed. To do so, select the line type to change and move it higher or lower in the objects list using the '''up and down arrows''' in the window.

=Examples=
==Simple multi-line display==
Adding a group and a zone inside this group allows you to display several lines

<u>Configuration of the group</u>: Exclusive condition, Front spacing of the line type NONE: 0.60cm, After spacing of the line type NONE: 0cm

[[Fichier:OX D GRP 10.jpg|néant|vignette|950x800px]]

Following the process described previously, the ADRMAPPING zone which has the line type NONE is executed on all the lines of the group. Because the Front spacing of the line type none is 0.60cm, the group then:
# Checks for the current line that the line type (condition) NONE corresponds --> YES
# Checks that there is an object in the line type (condition) NONE --> YES there is ADRMAPPING
#Move the cursor 0.60cm down (Front spacing of the line type NONE)
#Executes objects associated with the line type NONE (the ADRMAPPING zone prints the content of the input datastream)
#Move the cursor 0cm down (after spacing)

Repeat this process for all the other lines in the group.

==Deleting white lines==


Combining a group and a zone inside of this group allows you to display several lines. If this zone does not belong to a line type which rejects empty content lines then this combination only prints filled lines. The result will be a print out without white lines.

<u>Configuring a group</u> : 
- Exclusive condition
- Front spacing of the line type NONE: 0.60cm
- After spacing of the line type NONE: 0cm
- Front spacing of the line type NOT_BLANK : 0.60cm
- After spacing of the line type NONE: 0cm

<u>Configuring a NOT_BLANK line type</u>: 

NOT (there is the value "       " on the current line between column 6 and 12)

[[Fichier:OX D GRP 11.jpg|néant|vignette|1200x1000px]]

Following the process described previously, the ADRMAPPING zone which has the line type NOT_BLANK is executed on the lines which do not have empty lines. Because the front spacing of the line type none is 0.60cm, the group then:
# Processes the current line (if the line is <u>not empty</u>): 
#: Checks for the current line that the line type (condition) NOT_BLANK corresponds --> YES
#: Checks that there is an object associated to the line type (condition) NOT_BLANK --> YES there is ADRMAPPING
#: Move the cursor 0.60cm down (front spacing of the line type NOT_BLANK)
#: Executes the objects associated with the line type NOT_BLANK (the ADRMAPPING zone prints the content of the input datastream)
#: Move the cursor 0cm down (after spacing of the line type NOT_BLANK)
#Processes the current line (if the line is <u>empty</u>) :
#: Checks for the current line that the line type (condition) NOT_BLANK corresponds --> NO
#: Checks for the current line that the line type (condition) NONE corresponds --> YES
#: Checks that there is an object associated with the line type (condition) NONE --> NONE (there is not any object)
# Processes the next line of the group: Line 3, '''Checks point 1'''

(Et répéter ce traitement pour toutes les autres lignes du groupe)

==Formatage particulier sur la première ligne==

La combinaison d'un groupe et de deux zones à l'intérieur de ce groupe permet un affichage particulier pour la première ligne du groupe et un autre pour les autres lignes. 

Dans cet exemple, nous allons créer un type de ligne vrai pour la première ligne du groupe (contenu : Mapping entre les colonnes 6 et 12) et laisser le type de ligne AUCUNE afficher le reste du groupe.


<u>Paramétrage du groupe</u> : 
- Condition exclusive
- Espacement avant du type de ligne AUCUNE : 0.60cm
- Espacement après du type de ligne AUCUNE : 0cm
- Espacement avant du type de ligne FIRSTLINE : 0.60cm
- Espacement après du type de ligne FIRSTLINE : 0cm

<u>Paramétrage du type de ligne FIRSTLINE</u> : 

Il y a sur la ligne en cours de la colonne 6 à la colonne 12 la valeur "Mapping")

[[Fichier:OX D GRP 12.jpg|néant|vignette|1200x1000px]]

En suivant la procédure de traitement expliquée précédemment, la zone ADRMAPPING ayant pour type de ligne FIRSTLINE va être exécuté sur les lignes  ayant '''Mapping''' pour valeur entre leurs colonnes 6 et 12. 
L'espacement avant du type de ligne aucune étant de 0.60cm, le groupe va alors :

# Traitement de la ligne en cours (cas d'une ligne <u>Mapping</u>) : 
#: Vérification pour la ligne en cours que le type de ligne (condition) FIRSTLINE corresponde bien --> OUI
#: Vérification qu'il y ait bien un objet dans le type de ligne (condition) FIRSTLINE --> OUI il y a ADRMAPROUG
#: Descendre le curseur de 0.60cm (espacement avant du type de ligne FIRSTLINE)
#: Exécuter les objets appartenant au type de ligne FIRSTLINE (la zone ADRMAPROUG imprimant le contenu du flux d'entrée)
#: Descendre le curseur de 0cm (espacement après du type de ligne NOT_BLANK)
#Traitement de la ligne en cours (cas d'une ligne <u>autre que Mapping</u>) :
#: Vérification pour la ligne en cours que le type de ligne (condition) FIRSTLINE corresponde bien --> NON
#: Vérification pour la ligne en cours que le type de ligne (condition) AUCUNE corresponde bien --> OUI
#: Vérification qu'il y ait bien un objet dans le type de ligne (condition) AUCUNE --> OUI il y a ADRMAPPING
#: Exécuter les objets appartenant au type de ligne AUCUNE (la zone ADRMAPPING imprimant le contenu du flux d'entrée)
#: Descendre le curseur de 0cm (espacement après du type de ligne AUCUNE)
# Traitement de la prochaine ligne du groupe : Ligne 3, '''passage au point 2'''

(Et répéter ce traitement pour toutes les autres lignes du groupe)

==Allowing more space for the first line==
FORTHCOMING

==Creating a simple dynamic table==
FORTHCOMING