Understanding the Publi PDF Queue Installer
QueueInstaller offer a Graphical User Interface for easy installation/removal of Grafikhuset Publi PDF queues.
Besides the GUI QueueInstaller offer a simple command line interface that lets you install and uninstall queues via installation scripts or batch files.
Finally, QueueInstaller can install, reinstall and remove queues specified via a special configuration file.
Command line interface
General syntax
The following general rules apply to the command line interface:
- All parameters are pre-fixed with the »/« character.
- Paths may not use the »/« character as separator between folder and file names.
- Paths and file names may not be encapsulated by quotation marks even though such names include space characters.
- All parameters use the »=« character as separator between the parameter (the key) and its corresponding function, action or file name (the value), e.g. /RM=InstallSilent.
- Commands may not include break or tab characters.
- Commands can be written in any order unless otherwise noted.
The syntax can therefore be stated as:
<program>.exe /<Key1>=<Value1> /<Key2>=<Value2> ... /<KeyN>=<ValueN>
Hence, an example of a valid command could be:
QueueInstaller.exe /RM=Install /QN=My Publi PDF /QL=The company shared folder on drive Z
This is also a valid command provided the file OurQueues.ini contain the required information as described in The configuration file format section of this document:
QueueInstaller.exe /FN=OurQueues.ini
| Key | Value/action | Usage |
|---|---|---|
| RunMode or RM |
Default | Opens the UI for 100% manual operation. |
| Install | Opens the UI and automatically add the queue specified via the QueueName parameter to the list of queues to install. | |
| InstallSilent | Installs the specified queue without displaying the UI. If the queue
already exists nothing will happen. If one or more of the QueueName, QueueComment or QueueLocation parameters are omitted their default values will be used. |
|
| Uninstall | Opens the UI and automatically pre-select the queue specified by the QueueName parameter. | |
| UninstallSilent | Uninstalls the specified queue without displaying the UI. If the queue
doesn't exist nothing will happen. If the QueueName parameter is omitted its default value will be used. |
|
| SetupFile | Reserved for future use. |
The default value is /RM=Default.
| Key | Value/action | Usage |
|---|---|---|
| QueueName or QN |
String | Specifies the name of the Publi PDF queue to install. This name also represent the name of the corresponding Windows printer instance. |
The default value is /QN=Publi PDF
| Key | Value/action | Usage |
|---|---|---|
| QueueComment or QC |
String | Specifies the Comment property that appear in most Windows print dialogs for a Publi PDF queue. |
The default value is /QC=Creates PDF documents (or a similar localized string value).
| Key | Value/action | Usage |
|---|---|---|
| QueueLocation or QL |
String | Specifies the Location property that appear in the Windows Printers folder for Publi PDF queues. |
The default value is /QL=A folder on the disk (or a similar localized string value).
| Key | Value/action | Usage |
|---|---|---|
| FileName or FN |
FileName with or without path |
Specifies the file name for a file formatted as described by
The configuration file format. If the file name is specified without full path QueueInstaller.exe assume the file to be in the same folder as QueueInstaller.exe. |
The default value is an empty string.
Note: Enabling the /FN command will effectively disable all other command line parameters.
The configuration file format
QueueInstaller.exe reads information about queue deployment from file when the FileName command line switch is set. The file format is standard Windows INI file format as for Publi PDF, i.e. a simple text file that can be edited with any ASCII editor such as Windows Notepad.
This section set out which INI groups and keys that form a valid configuration.
Configuration entries
The configuration file may contain the following group entries:
The QueueInstaller group
The [QueueInstaller] group maintain a dictionary of different variables that control how the QueueInstaller.exe user interface behave.
The [QueueInstaller] group may currently contain the following optional key:
| Type | Value | Meaning |
|---|---|---|
| Number | 0 | Displays the QueueInstaller.exe user interface. This setting is for debugging purposes only and should never be used in runtime situations. |
| 1 (default) | Runs QueueInstaller.exe in unattended mode and performs the actions defined by the [QueuesToManage] group for each queue. |
The QueuesToManage group
The [QueuesToManage] group define a list of queues and setup an install action for each. The syntax is:
[QueuesToManage]
<Queue Name 1>=<Install Action>
... more queues ...
<Queue Name N>=<Install Action>
Possible actions are:
| Type | Value | Meaning |
|---|---|---|
| String | Install | Installs the queue, i.e. creates the Windows printer instance for the
queue. If the queue already exists nothing will happen for the queue. |
| Uninstall | Uninstalls the queue, i.e. deletes the Windows printer instance for the
queue. If the queue doesn't exist nothing will happen. |
|
| Reinstall | Forces execution of Uninstall before Install is executed. |
The Queue Name groups
When QueueInstaller.exe have read the contents of the [QueuesToManage] group it will search for a group entry in the configuration file that match the instance name for each queue. For example, if you have defined two Publi PDF printer instances called »Publi PDF« and »Publi PDF with Letterhead« respectively, the configuration file should contain two [<Queue Name>] groups, namely [Publi PDF] and [Publi PDF with Letterhead].
Each [<Queue Name>] group may contain the following keys:
| Type | Value | Meaning |
|---|---|---|
| String | Text of your choice | Sets up the Comment entry for the Windows printer instance. |
It's highly recommended to enter a descriptive text in this field, since the vast majority of programs display this information in the print dialog.
| Type | Value | Meaning |
|---|---|---|
| String | Text of your choice | Sets up the Location entry for the Windows printer instance. |
It's highly recommended to enter a descriptive text in this field, for example the path defined by the JobFolder entry for the queue, since this information is displayed for each queue in the Windows Printers folder.
A sample configuration file
The following configuration file will remove one and install two Windows printer instances regarding Publi PDF queues:
[QueueInstaller]
HideUI=1
[QueuesToManage]
Publi PDF=Uninstall
PDF for IFU manuals=Reinstall
PDF for Datasheets=Install
[PDF for IFU manuals]
Comment=Creates IFU's as print-ready PDF documents
Location=S:\OurWorkgroup\Final\IFUs\
[PDF for Datasheets]
Comment=Creates Datasheets as press-ready PDF documents
Location=S:\OurWorkgroup\Final\Datasheets\
If this sample is saved to a file called »OurQueues.INI« into the <PubliPDFInstallationFolder> (the same folder as QueueInstaller.exe is installed), you can execute the following command:
<PubliPDFInstallationFolder>\QueueInstaller.exe /FN=OurQueues.INI
Known problems
Some of the special Scandinavian characters may not transfer properly from the command line to Windows UI dialogs. Currently the resolution is to use standard ASCII characters only. However, this problem is not present with information entered via the configuration file pointed to by the /FN command line switch.
Last revised: 19-12-2007.