SafeQ 5 Client Configuration Options
This page is a copy from YSoft SafeQ 5 documentation. See YSoft SafeQ 5 Client Support for supported feature set and limitations.
The following configuration options are available:
Name of configuration option | Description | Default value |
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). | |
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. | 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.
| |
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. Saved password is used only for the same job owner. | 0 |
SaveUsername | Allows saving of username in SafeQ Client application when AuthType is set to 8. Saved username is used only for the same job owner, i.e. currently logged in user. | 0 |
LoadBalancing | Allows load balancing among nodes in SafeQ Cluster. | 1 |
IPLoadBalancing, IPLoadBalancing2, IPLoadBalancing3, ... | Load balancing per server IP address. If enabled for any IP address, this option disables LoadBalancing option. | 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 |
Encryption | Encrypts data between SafeQ port and SafeQ server – also the transmitted job is encrypted. | 0 |
SSLCertificateVerification | In case any SSL session is established during job delivery, perform verification of server certificate. | 0 |
CurrentUserNameFormat | How the SafeQ Client should report the user name. If no input is given, than just standalone user name is reported. 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 |
ProtocolLevel | Setup communication protocol. Following options are available: | 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 |
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. | 20 |
LogFileCount | Rotated log count. | 3 |
WebBasedApplications | Enables web based YSoft SafeQ applications | 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. | |
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) | |
UserNameRegExReplace | Replacement string which is used for user name modification. It can refer to arguments from UserNameRegExMatch. |
Client application compares the current job owner (user logged to the computer) to the last job owner (saved in registry). If these two match, the saved credentials are used. Otherwise, the user is asked to fill in login and password.
User logs in and the application has currently no password saved. When the user prints and inserts the correct credentials, the username and password are saved and it is not necessary to fill them in next time. In case the user logs out, the application is terminated and the password is forgotten.
If another user logs in, the login window appears automatically, because the job in queue is owned by this another user. If the computer is used only by one user, he/she still has to fill the credentials in after login to the computer. After every logout (or client application termination), the password is forgotten.
All settings are usually stored in subkeys of the following registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\SafeQ\Ports\
or, in the case of SafeQ Client Enterprise:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\SafeQE\Ports\
However, note that this location is system-dependent and may differ, for example in the case of a Windows Failover Cluster. This information is provided without guarantee.