SafeQ 5 Client Configuration Options

ServerDeliveryMode

Following options are supported:

0 - statically defined IP address list.

1 - use IP address of workstation the user uses to connect via Terminal Services to server, identify its subnet according server_subnet.csv file and subsequently choose correct target SafeQ server according server_subnet.csv file. If the method fails, 0 - statically defined IP address list is used instead.

2 - use IP address of local workstation, identify its subnet according server_subnet.csv file and subsequently choose correct target YSoft SafeQ server according server_subnet.csv file. If the method fails, 0 - statically defined IP address list is used instead.

3 - use IP address of workstation where the print job has been created, identify its subnet according server_subnet.csv file and subsequently choose correct target SafeQ server according server_subnet.csv file. If the method fails, 0 - statically defined IP address list is used instead.

4 - use IP addresses obtained by DHCP: LPR server option. If the method fails, 0 - statically defined IP address list is used instead.

5 - use IP address taken from user's environment, identify its subnet according server_subnet.csv file and subsequently choose correct target SafeQ server according server_subnet.csv file. Option "EnvironmentVariableIP" contains the name of environment variable cointaining IP address.

0

ServerIP

IP Address of SafeQ Server (CML or ORS). When used on SafeQ Cluster (or ORS roaming group), input the address of the first SafeQ node (in the case of Roaming group, imput the first Roaming ORS IP address).
Use of DNS names is allowed. This option must always be filled in.

ServerIP2, ServerIP3, ...

IP Address for other nodes of SafeQ cluster (or another ORS in roaming group).

ServerPort

The TCP port of SafeQ Server, where the SafeQ Client will try to connect for job delivery.

9100

Queue

The queue name has to exactly match the queue name created on SafeQ server.
For default general secure queue use the name "secure".

secure

AuthType

How SafeQ Client will identify the job owner to SafeQ server.

SafeQ Client for YSoft SafeQ 5 uses protocol version 4 by default. In case protocol version 1, 2 or 3 is configured and AuthType options 3,4,5,6,8,9 are used make sure that parameters useSSLProxy and sslProxyPort are configured.

Following options are supported:
1 - user login (actually logged user on a workstation; username format depends on "CurrentUserNameFormat")
3 - user defined text (provides value of parameter "AuthText" as a username)
4 - dialog with password (SafeQ Client displays an authentication dialog to a user upon job submission)
NOT AVAILABLE IN SAFEQ CLIENT FOR MS WINDOWS CLUSTER (formerly SafeQ Port Enterprise)
5 - novell user login
6 - novell user with context
8 - dialog without password (SafeQ Client displays dialog with a text field and user input is used as username; similar to dialog with password but without password verification)
NOT AVAILABLE IN SAFEQ CLIENT FOR MS WINDOWS CLUSTER (formerly SafeQ Port Enterprise)
9 - keyboard reader (it is expected that a card number is entered via a keyboard or swipe on a USB reader in a keyboard mode connected to the workstation)
NOT AVAILABLE IN SAFEQ CLIENT FOR MS WINDOWS CLUSTER (formerly SafeQ Port Enterprise)
Card numbers received from SafeQ Client to authenticate user are not converted in any way before SafeQ searches them in its database/cache.

AuthText

This text will be reported as a user name in case of AuthType=3, otherwise leave empty.

SavePassword

Allows saving of user password in SafeQ Client application when AuthType is set to 4.
0 = disable
1 = enable

Saved password is used only for the same job owner.
Saved password is removed when the user logs off.

0

SaveUsername

Allows saving of username in SafeQ Client application when AuthType is set to 8.
0 = disable
1 = enable

Saved username is used only for the same job owner, i.e. currently logged in user.
Saved username is removed when the user logs off.

0

LoadBalancing

Allows load balancing among nodes in SafeQ Cluster.
0 = disable
1 = enable

1

IPLoadBalancing, IPLoadBalancing2, IPLoadBalancing3, ...

Load balancing per server IP address. If enabled for any IP address, this option disables LoadBalancing option.
0 = disable
1 = enable

0

EnvironmentVariableIP

Defines environment variable containing IP address for option ServerDeliveryMode 5.

Default value "ViewClient_IP_Address" is suitable to get IP address of user using VMware View.

ViewClient_IP_Address

Compression

Compress job data on port (SafeQ server will automatically decompress it).
0 = disable
1 = enable

0

Encryption

Encrypts data between SafeQ port and SafeQ server – also the transmitted job is encrypted.
This setting requires to setup of SSL certificates on SafeQ Server and can have significant influence on the system performance.
Ensure that option ProtocolLevel is set to 1 or 4
0 = disable
1 = enable

0

SSLCertificateVerification

In case any SSL session is established during job delivery, perform verification of server certificate.
In case certificate is not valid or is not trusted, connection is aborted and print job is not delivered to SafeQ server.
0 = disable
1 = enable

0

CurrentUserNameFormat

How the SafeQ Client should report the user name. If no input is given, than just standalone user name is reported.
Following options are available:
DS_FQDN_1779_NAME CN=someone,OU=Users,DC=Engineering,DC=Fabrikam,DC=Com
DS_NT4_ACCOUNT_NAME Engineering\someone
DS_DISPLAY_NAME Jeff Smith
DS_UNIQUE_ID_NAME 4fa050f0-f561-11cf-bdd9-00aa003a77b6
DS_CANONICAL_NAME engineering.fabrikam.com/software/someone
DS_USER_PRINCIPAL_NAME [email protected]
DS_CANONICAL_NAME_EX engineering.fabrikam.com/software\nsomeone
DS_SID_OR_SID_HISTORY_NAME S-1-5-21-397955417-626881126-188441444-501
SAFEQ_SID_FORMAT 01:05:00:00:00:00:00:05:15:00:00:00:23:2e:93:00:5e:fc:94:30:e5:fd:ce:87:63:04:00:00

Note that options other than DS_NT4_ACCOUNT_NAME, DS_SID_OR_SID_HISTORY_NAME, and SAFEQ_SID_FORMAT require both computer and user to be members of Microsoft Active Directory. The computer must have permissions in Microsoft Active Directory to format the user name. Formatting a user name in a trusted domain outside of the computer's Active Directory forest is only supported for DS_NT4_ACCOUNT_NAME, DS_SID_OR_SID_HISTORY_NAME, and SAFEQ_SID_FORMAT.

To support multiple trusted domains set configuration option "CurrentUserNameFormat=SAFEQ_SID_FORMAT". Set LDAP replication setting "Attribute containing aliases" to include attribute "objectSid".

For shared printers set configuration option "JobOwnerMethod=1" so the user name can be formatted.

JobOwnerMethod

Identification of job owner.
0 = default behavior (single user on workstation)
1 = identification is based on owner of printing thread (shared printer)

0

ProtocolLevel

Setup communication protocol. Following options are available:
4 = default behavior
3 = reserved
2 = set to 2 for backward compatibility
1 = set to 1 for backward compatibility or in case the encryption support is required

4

LogToFile

Records a log file on SafeQ Port operations. Logging when using shared queues requires Everyone group to have Modify permissions on the file.
0 = disable
1 = enable

0

LogFilePath

Path for SafeQ Client log file - SQClientEnt.log . If empty, path is defined by configuration of system environment variable "TEMP" (e.g. C:\Windows\TEMP).

LogFileSizeLimit

Maximum limit of log file in MB before its rotation occurs.
0 = no limit

20

LogFileCount

Rotated log count.

3

WebBasedApplications

Enables web based YSoft SafeQ applications
1 = client will display window with YSoft SafeQ web applications after delivering job. YSoft SafeQ provides several applications: Selection of billing code, VIP shared queues or price estimation
0 = client just delivers job to SafeQ. User will not be prompted to select billing code, VIP shared queues or price estimation

1

NetworkTimeout

Timeout in seconds when communicating with SafeQ server over TCP/IP.

60

ParserDPI

DPI for page rendering if PriceEstimation mode is enabled.

150

Note

Note which will be sent with job to SafeQ server.

RedirectToIP

IP address of printer to which the print job will be redirected in case SafeQ server unavailability.
The job will be sent to printer by LPR protocol.
If empty, the job will not be redirected.

AssignPrinter, AssignPrinter2, AssignPrinter3, ...

Search for given name in installed printers during installation, and bind the one which matches with the created port.

UserNameRegExMatch

Regular expression which is used for matching of user name. This option is available only when AuthType is set to 1 (user login)
Example: for matching of "username" from "username (ip)", expression should be set to "^([^ ]*).*$"

UserNameRegExReplace

Replacement string which is used for user name modification. It can refer to arguments from UserNameRegExMatch.
$0 is the full user name string, $1 refers to the first match, $2 to the second match, ...
Example: for replacing user name with first match (specified by expression UserNameRegExMatch), string should be set to "$1"