Skip to content

Configure Device Settings

Alec Clews edited this page Aug 10, 2020 · 3 revisions

The get/set printer properties feature can also be used to manage the properties associated with multi function devices in PaperCut MF.

NOTE: In that case instead of providing the print server name the text device is used. For example

server-command set-printer-property device dev-test-device  advanced-config.ext-device.card-no-regex '^(?:;0)?(\d{8})'

IMPORTANT:

  1. Not all values are valid on every device type
  2. There is little validation when using these commands that correct values are supplied. Generally you are expected to only supply valid values.

IMPORTANT:

Applying Device Settings

Currently, the set operation only updates the database of the configuration changes. Therefore the device isn't aware of the changes until the apply button is triggered in the Admin UI or the Application server is restarted.

As of PaperCut MF/NG 19.1, there is a server-command applies these changes on the device:

server-command apply-device-settings <device name>

Configuring miscellaneous advanced attributes

server-command set-printer-property device <device-name> advanced-config.<key-name> <value>

You can get the key Advanced Config key name under the Advanced Config tab on the device page. Example:

server-command set-printer-property device LibraryCopier advanced-config.ext-device-msg.welcome-text “WELCOME”

You can set the device groups using the following command:

set-printer-groups device <device-name> <group_names>

The attributes can be grouped under the following headings:

Authentication

Boolean indicating if username/password authentication is enabled. (Y/N)

advanced-config.ext-device.auth-mode.username-password

NOTE: You must set the value of ext-device.auth-mode.username-password before you can set the value of ext-device.auth-mode.card or ext-device.auth-mode.identity-no.

Boolean indicating if card authentication is enabled. (Y/N)

advanced-config.ext-device.auth-mode.card

The pin is required for card. (Y/N)

advanced-config.ext-device.auth.pin-required-for-card

NOTE: Set the value of ext-device.auth-mode.card before setting the value of advanced-config.ext-device.auth.pin-required-for-card

Boolean indicating if identity number authentication is enabled. (Y/N)

advanced-config.ext-device.auth-mode.identity-no

The pin is required for ID. (Y/N)

advanced-config.ext-device.auth.pin-required-for-id

NOTE: Set the value of ext-device.auth-mode.identity-no before setting the value of ext-device.auth.pin-required-for-id

The auto login username for the device.

advanced-config.ext-device.auth.auto-login-username

Determines if the device has self-registration enabled. (Y/N)

advanced-config.ext-device.self-registration-enabled

Determines if the device has self-association with card enabled. (Y/N)

advanced-config.ext-device.self-association-with-card-enabled

Determine if the card number should be used for the username (if no username is supplied). (Y/N)

advanced-config.ext-device.self-registration-use-card-as-username
* Determines whether we request the PIN for self-registration. NOTE: this pin is also used as the user's password.
* This is enabled by default. (Y/N)
  ext-device.self-registration-request-pin

If defined, only cards matching this regex are allowed to be registered.(String with REGEX)

advanced-config.ext-device.self-registration-allowed-card-regex

If defined, only cards matching this regex are allowed to be associated with existing accounts. (String with REGEX)

advanced-config.ext-device.self-association-allowed-card-regex

Determine if card swipe logout is allowed. (Y/N)

advanced-config.ext-device.swipe-logout-allowed

Additional release options

Indicates if all users should be released on login (if in secure mode and they have the credit).

advanced-config.ext-device.release-all-on-login

Specifies the mode for releasing jobs to the device when its in error (ALLOW/DISALLOW)

advanced-config.ext-device.allow-release-on-error

Specifies the list of SNMP errors treated as release error when release on error is not allowed. More info here https://www.papercut.com/kb/Main/PreventJobReleasePrinterError

advanced-config.ext-device.block-release-on-error.snmp-error-list

Other

Self-associate a card with the secondary ID field, as described here

advanced-config.ext-device.card-self-association.use-secondary-card-number

Determine if offline mode is allowed. (Y/N)

advanced-config.ext-device.offline-allowed

The delay (in seconds) between detecting a connection failure and starting offline. (integer)

advanced-config.ext-device.offline-delay-seconds

Determine if a code must be entered to unlock offline operation. (Y/N)

advanced-config.ext-device.offline-unlock-required

The code to unlock offline operation when required. (string)

advanced-config.ext-device.offline-unlock-code

You should also review the following global setting: ext-device.allow-new-pin-for-id-num

Integrated Scanning

Indicates whether integrated scanning feature is enabled for the device (Y/N)

WARNING: Setting this prior to the device advertising it’s capabilities to the Application Server can result in a warning to be displayed on the screen.

advanced-config.ext-device.integrated-scanning.enabled
Clone this wiki locally