Skip to content

Keywords - SEAL APW REST Server

General

The configuration of SEAL APW REST server is specified in the following file:

  • Windows:

    C:\ProgramData\SEAL Systems\config\apw-rest.yml

  • Linux:

    /opt/seal/etc/apw-rest.yml

autoUpdateInterval

autoUpdateInterval specifies the time interval after which SEAL APW Client checks for new printer data on the server.

Available values: string

  • 30m

    Data update after 30 minutes

  • 1h

    Data update after one hour

  • 1d

    Data update after one day

  • 1w

    Data update after one week

  • never

    No data update

Default: 1d

columnNamesForFilter

columnNamesForFilter specifies filter options that may be used for searching printers. Each filter is shown as a drop down menu in the first tab of SEAL APW Client.

Available values: string

  • <queue_parameters>

    List of selected queue parameters, separated by space character

Default: city room zipcode trays street printertype building duplex floor color

columnNamesForInstalledPrinterList

columnNamesForInstalledPrinterList specifies the column names that are shown in the table of installed printers.

Available values: string

  • <queue_parameters>

    List of queue parameters, separated by space character

Default: name comment location model jobcount

columnNamesForPrinterList

columnNamesForPrinterList specifies the column names that are shown in the list of available printers.

  • <queue_parameters>

    List of selected queue parameters, separated by space character

Default: name comment city zipcode street building floor room trays printertype duplex color

connectAsNetworkPrinter

connectAsNetworkPrinter specifies whether the printer is installed as a network printer or a local printer. In a terminal server environment printers are always installed as network printers.

Available values: Boolean

  • 0

    The printer is installed as local printer.

  • 1

    The printer is installed as network printer.

Default: 0

connectTimeoutMilliseconds

connectTimeoutMilliseconds specifies the time interval in milliseconds after which an attempt to connect to the server is aborted.

Available values: integer

  • <time_interval>

Default: 30000

createDriver

createDriver specifies the printer driver that is used to add new local printers.

Available values: string

  • <driver_name>

Default: SEAL Systems PS OMS Generic

createPort

createPort specifies the preferred printer port type if a printer is available on PLOSSYS 4 and PLOSSYS Output Engine.

Available values: string

  • IPP

    Windows IPP port to send print jobs to PLOSSYS Output Engine systems (to come)

  • LPR

    Windows LPR port to send print jobs to PLOSSYS Output Engine systems

  • SEAL

    SEAL port monitor to send print jobs to PLOSSYS 4 systems.

Default: The port type is automatically selected by the first PLOSSYS system in the list of connections.

createPortCmdAfterSpool

This key is used for PLOSSYS 4 only.

createPortCmdAfterSpool specifies the command that is to be executed after spooling the job data.

Available values: string

  • <command>

Default: "$SEALAPWDIR\send2pls.exe" -plotter $OMQUEUE -nomsg -lbrandom -serverlist "$QUEUESERVERS" -failoverhost "$QUEUEFAILOVERSERVERS" -file

createPortLogDir

This key is used for PLOSSYS 4 only.

createPortLogDir specifies the directory in which the log file is stored while printing.

Available values: string

  • <directory_name>

Default: %TEMP%

createPortLprByteCounting

This key is used for PLOSSYS Output Engine only.

createPortLprByteCounting specifies whether the Windows LPR port determines the size of the spool file before sending the print data.

Available values: Boolean

  • 0

    Send the printing data immediately.

  • 1

    Determine the correct size of the spool file before sending the print data.

Default: 1

createPortLprPortNumber

PLOSSYS Output Engine requires LPR.

createPortLprPortNumber specifies the port number of the LPR port.

Available values: integer

  • <port_number>

Default: 515

createPortLprQueue

createPortLprQueue specifies the LPR queue name. A queue name different from the one transmitted by easyPRIMA replaces the latter.

Available values: string

  • <queue_name>

Default: queue name defined in easyPRIMA

createPortLprServer

createPortLprServer specifies the LPR server name or IP address. A value different from the one transmitted by easyPRIMA replaces the latter.

Available values: string

  • <server_name>

Default: first server in the queueservers list

createPortName

createPortName specifies the port name of the local printer.

Available values: string

  • <port_name>

Default: PLS_$QUEUE:

createPortRunAsLSA

This Parameter is used for PLOSSYS 4 only.

createPortRunAsLSA specifies the port with special privileges (LSA = Local Security Authority).

Available values: Boolean

  • 0

    Port without LSA privileges

  • 1

    Port with LSA privileges

Default: 0

createPortSpoolDir

This Parameter is used for PLOSSYS 4 only.

createPortSpoolDir specifies the directory in which the spool files are stored.

Available values: string

  • <directory_name>

Default: %TEMP%

createPrintProcessor

createPrintProcessor specifies the Windows print processor that is used for printing.

Available values: string

  • <directory_name>

Default: WinPrint

deleteMethodForMultiUserEnv

deleteMethodForMultiUserEnv specifies the method of handling a printer in a multi-user environment when a user logs out.

Available values: string

  • RemoveACL

    Only the user is removed from the Access Control List for the printer. The printer itself remains untouched and is not deleted.

  • RemovePrinterAndJobsIfUnused

    The user is removed from the Access Control List for the printer. If the last user has been removed from the Access Control List, also the printer is deleted from the multi-user environment. Possibly existing active jobs for this printer are deleted too.

  • RemovePrinterIfUnused

    The user is removed from the Access Control List for the printer. If the last user has been removed from the Access Control List, the printer is tried to be deleted the multi-user environment. If there are still active jobs for this printer, the printer is not deleted.

Default: RemoveACL

deleteOnlyAPWPrinter

deleteOnlyAPWPrinter specifies which printers SEAL Add Printer Wizard is allowed to delete.

Available values: Boolean

  • 0

    SEAL Add Printer Wizard is allowed to delete any installed printer.

  • 1

    SEAL Add Printer Wizard is only allowed to delete printers installed by SEAL Add Printer Wizard.

Default: 1

downloadDriverFromPrintServer

downloadDriverFromPrintServer specifies whether SEAL Add Printer Wizard downloads missing printer drivers from the print server.

Available values: Boolean

  • 0

    Missing printer drivers have to be installed manually.

  • 1

    Missing printer drivers are installed automatically by SEAL Add Printer Wizard.

Default: 0

forceUpdateTranslations

forceUpdateTranslations specifies whether the translation texts of the user interface are to be updated when starting.

Available values: Boolean

  • 0

    Do not update translations when starting.

  • 1

    Update translations when starting.

Default: 1

forceUserName

This key is for demonstration purposes only and needs be set to 0 for productive environments.

forceUserName specifies whether the user has to specifiy his credentials for authentication.

Available values: Boolean

  • 0

    The user needs to enter his credentials for authentication.

  • 1

    SEAL APW Client uses the currently logged on user for authentication.

Default: 0

omsHost

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

omsHost specifies the server on which the solution server (easyPRIMA server) is installed.

Available values: string

  • <host_name>

Default: $SEALAPWRESTHOST

omsPort

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

omsPort specifies the port number of the solution server (easyPRIMA server).

Available values: string

  • <port_number>

Default: 7225

omsRestType

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

omsRestType specifies the type of the output management system by using REST interface.

Available values: string

  • <system_type>

Default: RESTV1

omsRestUri

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

omsRestUri specifies the route on which the SEAL APW REST service is installed.

Available values: string

  • <URI>

Default: https://$SEALAPWRESTHOST:8085/apw-rest/omsconfig

omsType

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

omsType specifies the type of the output management system.

Available values: string

  • <system_type>

Default: PLOSSYS

pollingIntervalAfterErrorMilliseconds

pollingIntervalAfterErrorMilliseconds specifies the time interval in milliseconds after which SEAL APW Client retries to retrieve current settings from the SEAL APW REST service after a failed attempt.

Available values: integer

  • <time_interval>

Default: 15000

pollingIntervalMilliseconds

pollingIntervalMilliseconds specifies the time interval in milliseconds in which the current settings are requested by the SEAL APW REST service.

Available values: integer

  • <time_interval>

Default: 3000

printAfterSpooled

printAfterSpooled specifies whether the print job is to be spooled completely before printing.

Available values: Boolean

  • 0

    Send the spool data immediately to the Windows printer.

  • 1

    Start printing after the spooling of the file has been finished.

Default: 1

removeLocalPrinterCache

This Parameter is only used for enhanced print job settings of SEAL Master Driver, e. g. stamps, folder, etc.

removeLocalPrinterCache specifies whether the locally cached settings for SEAL Master Driver are to be deleted when updating the local printer.

Available values: Boolean

  • 0

    The cache on the client is not deleted after the queue data have been updated.

  • 1

    The cache on the client is deleted after the queue data have been updated.

Default: 0

SealAPWServerURL

SealAPWServerURL specifies the URL path under which SEAL APW REST service is available.

SEAL APW REST service listens on port 8085. MSI installer shows the sample URL http://server_name:8085. MSI properties are not part of apw-rest.yml.

Available values: string

  • <http>:\\server_name:<port_number>

Default: none

serviceReadOnly

serviceReadOnly defines whether SEAL APW Service is to be operated in read-only mode. In this case SEAL APW Client does not send any information to SEAL APW Service.

Available values: Boolean

  • 0

    SEAL APW Service does not run in read-only mode.

  • 1

    SEAL APW Service runs in read-only mode.

Default: 0

setDevModeDefaults

setDevModeDefaults specifies whether duplex and color default settings are allowed to be overwritten during an update or automatic update of a local printer.

Available values: Boolean

  • 0

    The user settings for duplex and color are not allowed to be overwritten during an update.

  • 1

    The user settings for duplex and color are overwritten with the values from the server during an update.

Default: 0

showAboutButton

showAboutButton specifies whether an "About" button is to be displayed in the client application.

The "About" button opens a Window with information about SEAL Add Printer Wizard, e. g. the version number.

Available values: Boolean

  • 0

    Hide the "About" button in the client application.

  • 1

    Show the "About" button in the client application.

Default: 0

showNetworkPrinterAsWindows

showNetworkPrinterAsWindows specifies how the printers are displayed.

Available values: Boolean

  • 0

    Network printers are displayed as URL: \\server\printer

  • 1

    Network printers are displayed as in Windows: printer on server

Default: 1

showTrays

showTrays specifies whether the number of trays are entered in the Windows registry.

Available values: Boolean

  • 0

    Number of trays is not entered in the Windows registry. The value of the TrayCount key is 0.

  • 1

    The number of trays is entered in the Windows registry in the PrinterDriverData section of the TrayCount key.

Default: 1

startFirstAutoUpdateCheck

startFirstAutoUpdateCheck specifies the time interval after which SEAL APW Client checks for new data on the server for the first time after starting.

Available values: string

  • 60s

    First update after 60 seconds

  • 30m

    First update after 30 minutes

  • 1h

    First update after one hour

  • 1d

    First update after one day

  • 1w

First update after one week

  • never

    No automatic update

Default: 60s

startNextAutoUpdateCheck

startNextAutoUpdateCheck specifies the time interval after which the SEAL APW Client checks for new data on the server.

Available values: string

  • 60s

    Next update after 60 seconds

  • 30m

    Next update after 30 minutes

  • 1h

    Next update after one hour

  • 1d

    Next update after one day

  • 1w

    Next update after one week

  • never

    No automatic update

Default: 60s

templateForMappedNameInMultiUserEnv

templateForMappedNameInMultiUserEnv specifies the template for the naming of a printer, if the printer is to be created in a multi-user environment.

Available values: string

  • <template>

Default: $OMQUEUE

useLocalPrinterForMultiUserEnv

useLocalPrinterForMultiUserEnv defines, whether SEAL APW Client is to create a printer in a multi-user environment, e. g. Citrix.

Available values: Boolean

  • 0

    Creating a printer in a multi-user environment is disabled.

  • 1

    Creating a printer in a multi-user environment is enabled.

Default: 0

urlPathAllPrinters

urlPathAllPrinters specifies the URL path for the list of available printers. This is used at the start when the main window is opened or the user presses the F5 key.

Available values: string

  • <URL_path>

Default: /apw-rest/printers/all

urlPathDefaultFilter

urlPathDefaultFilter specifies the URL path under which the default settings for the filters are queried. This key is used when SEAL APW Client is restarted after an offline time.

Available values: string

  • <URL_path>

Default: none

urlPathDefaultPrinter

urlPathDefaultPrinter specifies the URL path to store the default printer name in the SEAL APW REST service for this user.

Available values: string

  • <URL_path>

Default: /apw-rest/printers/default

urlPathHelp

urlPathHelp specifies the URL to an optional online help for the users of SEAL APW Client. If the URL is specified, a "Help" button is shown in the client application.

Available values: string

  • <URL_path>

Default: none

urlPathMyPrinters

urlPathMyPrinters specifies the URL to the list of already installed printers.

Available values: string

  • <URL_path>

Default: /apw-rest/printers/my

urlPathSettings

urlPathSettings specifies the URL path under which the settings for SEAL Add Printer Wizard are retrieved. This key is used when SEAL Add Printer Wizard is restarted after an offline time.

Available values: string

  • <URL_path>

Default: /apw-rest/settings/sealapw

urlPathTranslations

urlPathTranslations specifies the URL path under which the translations for the user interface are stored.

Available values: string

  • <URL_path>

Default: /apw-rest/translations/sealapw

windows8/createPortLogDir

windows8/createPortLogDir specifies the directory in which the log file is saved while printing.

Available values: string

  • <directory_name>

Default: C:\Windows\temp

Hint - Windows 8

This key is required if you print from Windows 8 or 10 applications.

Note: PLOSSYS 4 only.

windows8/createPortRunAsLSA

This key is used for PLOSSYS 4, if you print from Windows 8 or 10 applications.

windows8/createPortRunAsLSA specifies the port with LSA privileges (LSA = Local Security Authority).

Available values: Boolean

  • 0

    Port without LSA privileges

  • 1

    Port with LSA privileges

Default: 1

windows8/createPortSpoolDir

This key is used for PLOSSYS 4, if you print from Windows 8 or 10 applications.

windows8/createPortSpoolDir specifies the directory in which the spool files are stored.

Available values: string

  • <directory_name>

Default: C:\Windows\temp

Back to top