PDF file generation

Autres langues :

English • ‎français

Sommaire

1 Interface description
2 Examples

Interface description

To access the PDF generation interface, double-click on the command in question, choose "XPS to Web format", choose "Vers PDF".

Standard tab

Input filename: XPS file to convert to PDF (path + file name entered in hard text or MAP_FILE_IN)

Output file: Path + name of the PDF file(s) to generate (hardcoded or MAP_FILE_OUT)

Profile: Conversion profile to use (OPTIONAL)

Pages tab

These parameters allow you to specify the start page number and the end page number of the PDF to be generated.

Output start page: Start page number (hardcoded value or MAP_STARTPAGE parameter including the page numbers of the input XPS file)

Output end page: End page number (hardcoded value or MAP_STOPPAGE parameter including the page numbers of the input XPS file)

Indexes tab

This tab allows you to generate an index file (XML, TXT or CMOD) with the PDF file(s) (Index Files) Index export type: This parameter allows you to specify the type of index files generated

Output index file name: This parameter allows you to specify the path and name of the index file to generate

Export all indexes values on all pages: This setting defines how to export the values.

Either the index file contains the indexes of all pages (checked), or the index file only contains the index once. (Pages with the same index are not repeated)

Export indexes with no value: If checked, this parameter also allows you to export indexes with an empty value, otherwise (unchecked), only indexes with a non-zero value will be exported.

Signature tab

All of the following parameters allow you to affix an electronic signature to PDF documents output from Onyx Server:

<signclass>3</signclass>
<signmode>FILENAME</signmode>
<signpassword>test</signpassword>
<signdriver>OPENSSL</signdriver>
<signsha1hash>3eb783643e522c81d1e34c1943e6f4163e9ad439</signsha1hash>
<signpemfile>C:\tmp\test.pem</signpemfile>
<signcerfile>C:\tmp\test.cer</signcerfile>
<signpfxfile>C:\tmp\valid.pfx</signpfxfile>
<timestampurl>http://servertemp.domain/tsp</timestampurl>

By default, PDF documents produced by Onyx Server are not signed.

If signmode is empty then Signing is disabled and none of the other settings will have any effect

Encrypt tab

This tab allows you to protect the PDF file with a password (obligatory when managing special rights for PDFs, see “Encrypt advanced” tab).

Encrypt mode: This parameter allows you to activate or deactivate the setting of a password on the PDF:

Default: Encryption is disabled
No: Encryption is disabled
Yes: Encryption is enabled

Encrypt user password: This parameter allows you to enter a password which will be requested each time the PDF is opened. Access via user password does not give access to blocked features.

Encrypt owner password: This parameter allows you to enter a password that will be requested to be able to modify permissions (printing, modification, copying, etc.) once the PDF is created.

Notes:

If the user password and owner password are the same, the user will have full permissions when opening the file.
Adobe Reader asks for the password when opening only if there is a user password. If there is only one owner password, you can only switch to owner mode with the paid version of Adobe Reader.
The “Encrypt mode” parameter at default = no.
If the “Encrypt mode” parameter is no = no management of passwords and file rights is taken into account.

Encrypt advanced tab

This tab allows the management of special rights applied to the generated PDF file. The rights in question are:

Printing rights: Gives the option to print the PDF or not
Right to modify: Gives the possibility or not to modify the PDF (via Acrobat Reader Pro for example)
Page extraction right: Gives the possibility or not to extract pages (via PDF Fill for example):
https://www.pdfill.com/document_pages_extract.html
Right to comment: Gives the possibility or not to add comments
Right of signature: Gives the possibility or not to affix a signature
Accessibility right: Gives the possibility or not to copy the content of the PDF file
Right of assembly: Gives the possibility or not to modify the order of the pages, to delete or to insert them
Page height right: Changes the printing resolution If No = Low resolution (150pp), if Yes = High resolution

Notes:

To play with the different rights, you must set a user password and owner password. (Encrypt tab) and open the PDF with the user's password. :
- The owner still has all rights to the PDF (so the rights specified in the “Encrypt advanced” tab are not taken into account).
- The user has the rights specified in the “Encrypt advanced” tab
The “default” value is set to YES.
If “Encrypt allow all” = YES or DEFAULT then the user has all rights
If “Encrypt allow all” = NO then the user has the rights specified in the following drop-down lists

Examples

Variant 1: Creation of a simple PDF

Let's take the following workflow as an example:

A) “Parameter” action: FILE_NAME

This action initializes a variable with part of another variable.

Here we:

Let's create a variable: FILE_NAME
Let's initialize this variable with the basename of the MAP_TITLE variable

(ex : MAP_TITLE : C:\Repertoire\monfichier.txt -> Le basename est : monfichier.txt)

Cette variable est utilisée dans le nommage du PDF. Voir documentation : Workflow String

B)Action « Parameter » : FILE_NAME

Cette action convertit un fichier XPS en PDF. Le nom du PDF sera fonction de la variable créée précédemment.

Variante 2 : Création d'un fichier PDF avec un fichier d'index

Cette variante permet en plus de créer un fichier PDF, la création d’un fichier XML listant les indexes du fichier XPS d’origine.

Exemples de génération de fichier d’index :

“Exporter toutes les valeurs d'index sur toutes les pages” non cochée

“Écrire les index même s'ils n'ont pas de valeur” non cochée

Exporte les indexes une seule fois (uniquement sur la 1ere page trouvée)

“Exporter toutes les valeurs d'index sur toutes les pages” Non cochée

“Écrire les index même s'ils n'ont pas de valeure” Cochée

Export les indexes une seule fois (uniquement sur la 1ere page trouvée)
Export des indexes sans valeur ex : IDX_DESCRL

“Exporter toutes les valeurs d'index sur toutes les pages” Cochée

“Écrire les index même s'ils n'ont pas de valeur” Cochée

Exporte les indexes de toutes les pages, même si ayant les mêmes valeurs que la page précédente.

Variante 3 : Eclatement par valeur d'index

Dans l’exemple ci-dessus (Variante 2), nous avons vu que le fichier XPS d’origine comporte des indexes sur certaines pages. Cette variante montre comment nous pouvons utiliser ces indexes pour créer un fichier PDF par valeur d’index. Prenons pour exemple un fichier XPS de 3 pages, 1 page par client différent. Nous voulons éclater le PDF par numéro de client (Index IDX_CUSTOMER).

Remarque 1: La syntaxe [[NOM_INDEX]]dans le nom du PDF génère 1 PDF par valeur différente d’index [[NOM_INDEX]]
Remarque 2: Si dans le nom, nous avons 2 valeurs d’index : C:\TEST_AUTO\TOPDF\OUT\DOCUMENT_[[IDX_DOCNUM]]_CUST_[[IDX_CUSTOMER]].pdf

Il y aura autant de fichiers PDF créés que de combinaisons de valeurs différentes des 2 indexes.

Dans cet exemple :

3 PDF d’une page ayant comme nom DOCUMENT_CUST_00001.pdf, DOCUMENT_CUST_00002.pdf, DOCUMENT_CUST_00003.pdf

Variante 4 :Gestion des droits

Cette variante permet de créer un fichier PDF avec des droits spécifiques.

1) Tout d’abord, il faut spécifier un mot de passe pour le propriétaire et un mot de passe pour l’utilisateur :

Le « encrypt mode » doit être à YES. Sinon l’encryptage ne sera pas activé et les mots de passe renseignés n’auront aucun effet. Ici, le mot de passe utilisateur est « user » et le mot de passe propriétaire est « owner ».

2) Ensuite, il faut renseigner les droits spécifiques :

« Encrypt allow all » doit être à NO (si YES alors l’utilisateur aura tous les droits, peu importe les droits renseignés). L’utilisateur aura uniquement les droits d’impression sur le PDF généré. L’utilisateur est la personne qui ouvre le PDF avec le mot de passe utilisateur : « user ».

Si le PDF est ouvert grâce au mot de passe propriétaire « owner », alors tous les droits seront autorisés.

Remarque : Sur Acrobat Reader, les droits « Assemblage du document » et « Extraction de pages » sont toujours « Non autorisé(e) ». Acrobat Reader désactive automatiquement ces deux autorisations, même si le PDF d’origine les possède.