XPS file concatenation

This documentation describes the function to concatenate all XPS files in a directory into one or more XPS files.

Interface description

To access the initial XPS interface, double-click on the command in question, choose "XPS Toolbox", select "Concatenate folder".

Onglet standard

Input directory: Root directory where the files to concatenate are located, with or without support for subdirectories depending on the value of Recursive mode.

Output file: Path + name of the XPS file(s) generated

Maximum number of original files in one output file: Allows you to create batches of XPS files. See example below.s.

Remove original files: Allows you to delete the source files

Recursive mode: Disabled, Normal, or Advanced. See example below.

Filters tab

Filters allow you to take into account only certain XPS files in the input directory

Filter on the files name: based on the name with meta-character * (example: DOCXPS*)

Filter on date From (yyyy/mm/dd): start date of XPS file selection (file creation date)

Filter on date To (yyyy/mm/dd): end date of XPS file selection (file creation date)

Output action tab

This tab allows you to send the result of the concatenation to an entry point.

Entry name: The value of this parameter is the name of an entry point defined in Mapping. Each time the concat folder is executed, the result(s) of the concatenation will be sent to the specified entry point

Hold document: This parameter defines the state of the job upon arriving in the “Entry name” queue. Either in “Ready to print” (unchecked) or in “Suspended” (checked)

Keep document: This parameter defines the state of the job once printed. Either the job disappears (unchecked), or we keep it in “saved” state (checked)

Keep current userdata: If checked, this parameter allows you to keep the userdata initialized in a previous workflow so that they are sent to the job on the “Entry point”

Add current parameter: If checked, this parameter allows you to add the userdata initialized in the current workflow so that they are sent in the job to the “Entry point”

The title (MAP_TITLE) of the jobs sent is equal to either the name of the generated (specified in the “Standard / Output file” parameter, or the entire path (depending on configuration in the mapping.conf. See note No. 6)

Examples

The examples below are based on the following directory structure:

Variant 1: Basic settings

Let's take the following function for example:

In each directory (TestConcatFolder, REPx and REPxSOUSx), there are 3 XPS files:

FileXPS1.xps, FileXPS2.xps, FileXPS3.xps

• Input directory:

C:\wrkf\TestConcatFolder

• Output file name:

C:\wrkf\TestConcatFolder_sortie\fileXPS.xps

• Recursive mode:

There are 3 different recursion modes:

• Disabled

- 1 seul fichier XPS généré par la concaténation des fichiers XPS contenus dans le répertoire d’entrée « TestConcatFolder » uniquement

• Normal

- 1 seul fichier XPS généré par la concaténation de tous les fichier XPS contenus dans le répertoire « TestConcatFolder » ainsi que les fichiers XPS des sous-répertoires

- Les fichiers concaténés sont triés par ordre croissant en fonction de leurs noms suivant cet ordre : 0123456789ABCDEFGHI…

->Ex : Prenons 2 fichiers XPS dans le répertoire TestConcatFolder : 0BONJOUR.xps et ABONJOUR.xps

->La concaténation sera 0BONJOUR.xps et ensuite ABONJOUR.xps (car si on trie les noms de fichiers par ordre croissant, le 0 est avant le A,

donc le fichier XPS dont le nom commence par « 0 » sera concaténé avant le fichier XPS dont le nom commence par « A »)

• Advanced

- 1 fichier XPS est généré par répertoire ou sous-répertoire ayant pour nom NOMREPERTOIRE_NOMFICHIERXPS. Dans cet exemple, il y a 9 fichiers XPS (car 9 répertoires ou sous-répertoires) - Noms des 9 fichiers XPS créés dans le répertoire C:\trash\TestConcatFolder :

1. fichierXPS.xps
2. REP1_fichierXPS.xps
3. REP1SOUS1_fichierXPS.xps
4. REP2_fichierXPS.xps
5. REP2SOUS2_fichierXPS.xps
6. REP3_fichierXPS.xps
7. REP3SOUS3_fichierXPS.xps
8. REP4_fichierXPS.xps
9. REP4SOUS4_fichierXPS.xps

Chacun de ces fichiers comprend la concaténation des fichiers XPS situés dans leur répertoires respectifs.

Supprimer les fichiers d’origine :

La case n’est pas cochée donc les fichiers sont conservés.

Variante 2 : Lotissement

Cette fonctionnalité permet de créer des lots de fichiers concaténés.

Prenons pour exemple 3 fichiers différents situés dans le répertoire C:\wrkf\TestConcatFolder FichierXPS1.xps, FichierXPS2.xps et FichierXPS3.xps

Nombre maximum de fichiers d’origine dans un fichier en sortie : « 2 »

Le résultat de cette concaténation est la création d’un fichier XPS contenant deux fichiers XPS différents et un autre fichier XPS concernant le troisième fichier.

• FichierXPS_1 contenant la concaténation de fichierXPS1.xps et fichierXPS2.xps

• FichierXPS_2 contenant la concaténation du fichierXPS3.xps

Variante 3 : Ajout des filtres

L’onglet Filters permet d’ajouter des filtres de sélection des fichiers en fonction de leur nom ou de la date.

Remarque : Il n’est pas possible de préciser plusieurs valeurs pour le même filtre.

Filtre sur le nom des fichiers

Cette fonctionnalité permet de sélectionner les fichiers XPS à concaténer en fonction de leur nom.

Exemple :

Valeur du filtre : DOC*

• Cette valeur prend tous les fichiers XPS commençant par « DOC », « DOC1.xps » par exemple

Valeur du filtre : *DOC*

• Cette valeur prend tous les fichiers XPS contenant « DOC » dans leur nom, « MYDOC1.xps » par exemple

Filtre sur la date de création des fichiers

Cette fonctionnalité permet de sélectionner les fichiers XPS à concaténer en fonction de leur date de création.

Exemple 1 :

• Ce paramétrage prend en compte uniquement les fichiers XPS créés entre le 02 avril et le 31 décembre 2019.

Remarque : Si une des deux dates n’est pas spécifiée, sa valeur implicite est * (infinie)

Exemple 2 :

• Ce paramétrage prend en compte uniquement les fichiers XPS créés à partir du 02/04/2019 (inclus).

Exemple 3 :

• Ce paramétrage prend en compte tous les fichiers XPS ayant une date de création antérieure ou égale au 15/04/2019.

Variante 4 : Envoi vers un point d'entrée

Après concaténation, les fichiers générés peuvent être envoyés vers un point d’entrée de Onyx Server. Dans l’exemple ci-dessous, le ou les fichiers concaténés seront envoyés vers le point d’entrée Mapping MY_ENTRY_POINT et ces spool seront sauvegardés après traitement (Case « Keep document » coché)

Remarques

Remarque 1 – Fichier de type autre qu'XPS

Dans le cas où un fichier de type autre qu’XPS est présent dans le répertoire à concaténer, un message d’erreur apparait, sans toutefois mettre la queue en erreur :

USER	DB	01/04/2019-15:10:38	5956	Do Render...
USER	EE	01/04/2019-15:10:38	5956	No _rel/.rels, document C:\wrkf\TestConcatFolder\formation4.pdf is not an XPS file
USER	DB	01/04/2019-15:10:38	5956	Done.

Remarque 2 – Pas de fichier XPS

S’il n’y a aucun fichier XPS dans le répertoire, il n’y a pas de message d’erreur et aucun fichier XPS n’est créé.

Remarque 3 – Fichier XPS sans extension

S’il y a un fichier XPS sans extension (« doc1.xps » nommé « doc1 »), aucun fichier n’est créé car le concat folder se base sur l’extension des fichiers pour déterminer s’il s’agit d’un fichier XPS ou non.

Remarque 4 – Ordre de concaténation

Les fichiers XPS sont concaténés par ordre croissant en fonction de leur nom (0123456789ABCDE…). La même logique s’applique aux fichiers placés dans des sous-répertoires pour le mode de récursivité « Normal » ou « Advanced ».

Remarque 5 – Nom du fichier de sortie

Par défaut, lorsqu’un point d’entrée est défini dans l’onglet « Output action », le « Nom du fichier de sortie » est égal au nom du fichier sans le chemin ni l’extension (variable MAP_TITLE), ci-dessous « concatroot ».

Par contre, il est également possible d’obtenir le chemin complet et l’extension en mettant la variable d’environnement CONCATFOLDER_TITLE_FULLPATH à « ON », ci-dessous D:\MCO\00002414\concatroot.xps

Remarque 6 – Pas de valeur d'index dans le nom du fichier

Il n’est pas prévu de générer un nom dynamique utilisant la valeur des index présents dans les fichiers à concaténer dans le nom du ou des fichiers de sortie :

 USER	DB	19/04/2018-18:36:18	9676	Used parameters : directory=C:\wrkf\TestConcatFolder, 
 outfilename=C:\wrkf   \TestConcatFolder_Sortie\fichierXPS1_[[IND_PAGE]].xps, recursivemode=Disabled                               
 SYST	EE	19/04/2018-18:36:20	13292	Process 9676 stopped with return code 255
 SYST	WW	19/04/2018-18:36:20	13292	Device devTEST_DUPLEX on error: default

Remarque 7 - Variable d'environnement dans le nom du fichier

Il est possible d’inclure des valeurs de variables d’environnement dans les noms des fichiers générés. Pour cela, il faut appeler le nom des variables avec [%...%], par exemple [%MAP_JOBNUM%] pour la variable MAP_JOBNUM (numéro du job).

Répertoire d'entrée c:\wrkf\TestConcatFolder

Nom du fichier de sortie c:\wrkf\TestConcatFolder_S\fileXPS1[%MAP_JOBNUM%].xps