Loading

The command line interface

You can print a job via the command line interface (CLI). If you don't define any parameters in the CLI and the job is page programmed:

  • The job is printed with the print settings that are saved in the job.

    And

  • The job is printed on the printer that is saved in the job.

If you don't define any parameters in the CLI and the job is not page programmed:

  • The job is printed on the default printer with the default print parameters.

The syntax of the CLI

[cmd /C] PRISMAprepare.exe "<path\file name>" parameters

You can use the parameters in any order. The available parameters are as specified in the table below.

Table 1. The command line interface

Setting

Description

cmd /C

Use parameter 'cmd /C' to launch 'PRISMAprepare.exe' synchronously with the command shell. By default, 'PRISMAprepare.exe' runs asynchronously.

  • With parameter "cmd /C":

    The "PRISMAprepare.exe" command is executed with the defined parameters. Any preflight messages and automation messages are displayed in the [Command Prompt]. When the "PRISMAprepare.exe" command terminates, the command line becomes available again.

  • Without parameter "cmd /C":

    The "PRISMAprepare.exe" command is executed in the background with the defined parameters. No messages are displayed in the [Command Prompt]. The command line is available immediately.

NOTE

When you use this parameter, exit codes are returned.

PRISMAprepare.exe

You must execute the command 'PRISMAprepare.exe' in the installation directory of this application.

<path\file name>

The path and the name of the job. The path and the name must be enclosed between double quotes. For example: "C:\My Folder\My file.pdf".

See : Supported file formats

NOTE

This setting is mandatory.

/F

  • With parameter "/F":

    Preflight is applied when opening the document. The rules configured for automatic preflight are used.

  • Without parameter "/F":

    No preflight is applied when opening the document, even if automatic preflight is enabled in the application.

Parameter "/F" can be overruled by parameter "/T".

  • If only parameter "/T" is specified but one of the automation templates contains an operation with preflight:

    Preflight is applied when opening the document in the template. The rules configured for automatic preflight are used.

  • If parameter "/T" and parameter "/F" are specified but none of the automation templates contain an operation with preflight:

    No preflight is applied when opening the document in the template, even if automatic preflight is enabled in the application.

/VDPS <VDPSourceFile>

Use parameter '/VDPS' to define the path and the name of the data source file for variable data documents. The path and the name must be enclosed between double quotes. For example: "C:\My Folder\My data source.xls".

The parameter '/VDPS' can overrule the data source file that is saved in the master document.

If parameter '/T' and parameter '/VDPS' are used, the variable data is added to the document before the template(s) are applied.

NOTE

Data source of type *.xlsx, *.xls or *.csv: the first sheet is used if multiple sheets are available in the data source file.

Data source of type *.accdb or *.mdb: the first table or view is used if multiple tables or views are available in the data source file.

See the log file for more information.

/VDPP <Password>

Use parameter '/VDPP' to provide the password for a password-protected data source of type *.accdb or *.mdb. Password-protected data sources of type *.xlsx, *.xls and *.csv are not supported.

The password must be enclosed between double quotes.

/VDPL <VDPDataFile>

Use parameter '/VDPL' to define the path and the name of the [VDP] data file for variable data documents. The path and the name must be enclosed between double quotes. For example: "C:\My Folder\My VDP data file.xml".

  • With parameter '/VDPS':

    The data source file defined with parameter '/VDPS' is used instead of the data source file defined in the [VDP] data.

  • With parameter '/T':

    The [VDP] data is applied to the document before the template(s) are applied.

/VDPV

Use parameter '/VDPV' to validate the [VDP] data. Parameter '/VDPV' is applied only after the other [VDP] parameters have been applied.

/VDPSD <VDPSourceDetail>

Use parameter '/VDPSD' to define which Excel sheet, Microsoft Access table, or Microsoft Access view must be used from the data source. The name must be enclosed between double quotes. For example: "name".

Use parameter '/VDPSD' in combination with parameter '/VDPS'. When you do not use parameter '/VDPSD', the first - in alphabetical order - Excel sheet, Microsoft Access table, or Microsoft Access view from the data source is used.

This parameter is ignored when the data source is of type *.csv or when parameter '/VDPS' is not used.

/T

Use parameter '/T' to apply one or more automation templates to the job. The templates are applied in the defined order. The templates must be separated by a "|". The template names are case sensitive.

For example: /T "<Template1>|<Template2>|<Template3>".

The following limitations to parameter '/T' apply:

  • Parameter '/T' is used and none of the template(s) contain a print action:

    The job is not printed, not even when the parameters '/C' and/or '/P' are used.

  • Parameter '/T' is used and one or more template(s) contain a print action:

    The parameter '/C' overrules the number of copies that is defined in the template(s).

    The parameter '/P' overrules the printer that is defined in the template(s).

If parameter '/T' and parameter '/I' are used, the application opens. The automation templates are executed in the application. You must close the application to continue with the "PRISMAprepare.exe" command.

/TP <path\file name>

The path and the name of the parameter file for the automation template(s) . The path and the name must be enclosed between double quotes. For example: "C:\My Folder\Parameter file.mrparam".

The parameter file is applied to the list of automation templates specified by parameter '/T'. If parameter '/T' is not used, the parameter file is ignored.

/O <OutputFile>

Use parameter '/O' to define the path and the name for the output file. The output file is created after the template(s) are applied to the document. The path and the name must be enclosed between double quotes.

The parameter '/O' must be used in combination with parameter '/T'.

/L <LogFile>

Use parameter '/L' to define the path and the name for the log file. Any error, warning and information messages are logged in the log file. The path and the name must be enclosed between double quotes.

The name of the log file cannot be the same as the name of the document file or the output file.

The parameter '/L' cannot be used in combination with parameter '/I'.

/P <printer name>

Define the printer that must be used to print.

The printer name must be enclosed between double quotes. For example: /P "Oce 970C v2.1". The defined printer overrules the printer which is saved in the job. If /P is not defined, the printer which is saved in the job is used.

If parameter '/T' and parameter '/P' are used, the parameter '/P' overrules the printer that is defined in the template(s).

If parameter '/I' and parameter '/P' are used, the [Production] workspace of the application opens. The printer that is defined by parameter '/P' is selected in the [Production] workspace. You can define the print settings. Click button [Print] to continue with the "PRISMAprepare.exe" command.

NOTE

When you define a printer, part of the print settings can be reset to the default values. This depends on the capabilities of the printer.

/C <no of copies>

The number of copies between 1 and 65535. The defined number of copies overrules the number fo copies which is saved in the job. If /C is not defined, the number of copies which is saved in the job is used. Otherwise, one single copy is printed.

If parameter '/T' and parameter '/C' are used, the parameter '/C' overrules the number of copies that is defined in the template(s).

When combined with '/T' and '/TP', the number of copies recorded in any template or specified in '/C' are overruled by the number of copies specified in the parameter file (/TP) .

If parameter '/I' and parameter '/C' are used, the [Production] workspace of the application opens. The number of copies that is defined by parameter '/C' is used in the [Production] workspace. You can define the print settings. Click button [Print] to continue with the "PRISMAprepare.exe" command.

/SP

Use parameter '/SP' to generate a Proof PDF.

The default path and the name of the proof PDF is: <Document folder>\<Document name>_ProofPDF.pdf.

Use the /SPO parameter to change the Proof PDF file name.

When /SP is used, the proof PDF is not printed. An exception is when an automation templates requests printing of the proof PDF.

A printer specified in the command line influences the result of the Proof PDF. The following impacts are possible: BW or color content, representation of the finishing processed inline, mapped media.

The number of copies specified in the command line (/C parameter) appears in the Proof PDF banner note.

The /SP parameter is ignored when combined with /T (a Proof PDF is generated only if requested in an automation template).

/SPO <soft proof file name>

Use parameter '/SPO' to specify the Proof PDF file name.

The file name can contain the following special characters

  • a date stamp (%d)

  • a timestamp (%t).

The path optionally specified in the /O parameter has no impact on this default.

The file name must be enclosed between double quotes. For example: "name".

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the Proof PDF file name(s) defined in the template(s).

When combined with /I the parameter is proposed in the Save Proof PDF dialog opened as a result of the CLI command.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPM <Metric | Imperial>

Use parameter '/SPM' to specify the metric system used during the Proof PDF generation.

The parameter is followed by one of the values Metric or Imperial. The strings are case-insensitive. If not specified, the default Proof PDF metric system is used.

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the metric system defined in the template(s).

When combined with /I the parameter is used exclusively for the Proof PDF requested via the current command line.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPR <DPI72 | DPI300>

Use parameter '/SPR' to specify the resolution used during the Proof PDF generation.

The parameter is followed by one of the values DPI72 | DPI300. The strings are case-insensitive. If not specified, the default Proof PDF resolution is used.

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the resolution defined in the template(s).

When combined with /I the parameter is used exclusively for the Proof PDF requested via the current command line.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPL <CZ | DK | DE | GB | US | ES | FI | FR | HU | IT | JP | NO | NL | PL | PT | RU | SE | CHZ>

Use parameter '/SPL' to specify the language used during the Proof PDF generation.

The parameter is followed by one of the values CZ, DK, DE, GB, US, ES, FI, FR, HU, IT, JP, NO, NL, PL, PT, RU, SE, CHZ (Czech, Danish, German, English, English, Spanish, Finish, French, Hungarian, Italian, Japanese, Norwegian, Dutch, Polish, Portuguese, Russian, Swedish, Chinese). The strings are case-insensitive. If not specified, the default soft proof language is used.

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the language defined in the template(s).

When combined with /I the parameter is used exclusively for the Proof PDF requested via the current command line.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPB <Background image>

Use parameter '/SPB' to specify the background image used during the Proof PDF generation.

The parameter is followed by the complete path to the file containing the background image. The supported file types are tif, tiff, jpg, jpeg, bmp, gif and png. If not specified, the default background image is used.

The path must be enclosed between double quotes. For example: "C:\My Folder\images".

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the background defined in the template(s).

When combined with /I the parameter is used exclusively for the Proof PDF requested via the current command line.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPN <Note text>

Use parameter '/SPN' to specify the soft proof note used during the Proof PDF generation.

The parameter is followed by a string corresponding to the note text. If not specified, the note is empty. The text must be enclosed between double quotes. For example: "text".

The parameter is ignored if the command line contains no Proof PDF request be it via the /SP parameter or via a template (/T).

When combined with /T the parameter overrules the note defined in the template(s).

When combined with /I the parameter is used exclusively for the Proof PDF requested via the current command line.

The parameter has no impact on the user settings or on further manual Proof PDF requests.

/SPVDP

Use parameter '/SPVDP' to generate the Proof PDF for all variable data documents. If the parameter is not specified, the Proof PDF is generated only for the first variable data document.

/I

Use parameter '/I' to open this application. You can edit the job in the application.

Parameter '/I' can be used in combination with other parameters. See the descriptions of the parameters for detailed information.

/Finishing

Use parameter '/Finishing' to create a JDF finishing ticket for a near-line finisher.

The parameter can be followed by the name of a finishing flow. The name must be enclosed between double quotes. For example: "name". If this parameter is used without the name of a finishing flow, then the finisher as defined in the document is used. The finisher as defined in the document is used even if a finishing flow name is defined in the print settings or in an automation template.

This parameter must be used in combination with a print command, either '/P' or a print command recorded in an automation template. This parameter is ignored if no print command is used.

The finishing flow name used in combination with this parameter overwrites the finishing flow in the print settings and the automation templates.

Examples

  • PRISMAprepare.exe "C:\Temp\10pages.pdf" /I

    The application opens. You can edit the job.

  • PRISMAprepare.exe "C:\Temp\10pages.pdf" /C 5 /I

    The application opens. The [Production] workspace opens. The printer which is saved in the job is selected. The number of copies is 5. Define the print settings and print the job.

  • PRISMAprepare.exe "C:\Temp\10pages.pdf" /P "Oce 970C v2.1" /C 50

    Print 50 copies of the document on the defined printer. Use the other print settings which are saved in the PDF file.

  • PRISMAprepare.exe "C:\Temp\10pages.pdf" /T "MonthlyReport|CiceroPrint" /P "Oce VP6250" /C 50

    Apply the template "MonthlyReport" to the document. Then apply template "CiceroPrint" to the document. Print 50 copies and use the defined printer. Do not use the printer and number of copies defined in the templates.

  • PRISMAprepare.exe "C:\Temp\10pages.pdf" /VDPL "C:\My Folder\My VDP data file.xml" /VDPV /I

    The application opens. The [VDP] data stored in file "My VDP data file.xml" is applied to document "10pages.pdf". The [VDP] data is validated. You can edit the job in the application.

The exit codes

Setting

Description

0

Operation succeeded.

1

Execution error.

2

The file cannot be found.

3

The path cannot be found.

4

The file cannot be opened.

5

Access is denied.

111

The file name is too long.

1056

The application is already running.

30000

The license is invalid.

30001

The license server contains an invalid floating license.

30002

Connection error for the license server. Cannot retrieve a floating license.

30003

The license server encountered an error. Cannot retrieve a floating license.

30004

The license is expired.

30005

The maximum number of users is reached for this floating license.

30009

The version is incorrect.

40000

The automation template is executed. One or more warnings are reported.

50000

No file available to save.

50001

The file does not exist

50002

You have insufficient rights to execute this operation.

50003

Syntax error in the script.

50004

The automation license feature is not available.

50005

Generic error.

50010

Unknown template file.

50011

A parameter is used more than once in the command line interface.

50020

One of the parameters is not supported.

50021

The value of one of the parameter is incorrect.

50022

Unknown finisher.

50023

A page programme setting cannot be applied.

50030

Syntax error in the parameter file for the automation template.

50031

The parameter file for the automation template contains an invalid instruction.

50032

An instruction in the parameter file for the automation template contains an invalid parameter.

50033

An instruction in the parameter file for the automation template contains an invalid parameter value.

50034

The parameter file for the automation template uses an invalid encoding. The encoding must be UTF-8.

50035

The parameter file for the automation template cannot be found.

50036

The parameter file for the automation template cannot be read.

50037

The extention of the parameter file for the automation template must be '*.mrparam'.

50080

The output file is not accessible.

50099

Unrecoverable error. The script cannot be recorded or replayed.