General Registry Entries

Administrator

Registry entries for the Pharos Administrator are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Administrator.

Name	Type	Meaning	Default
Service Status Check Interval	REG_DWORD	This value specifies the interval (in seconds) of the service check (checking the status of services on all server machines) performed by the Administrator. By default, service check occurs once every 300 seconds. This entry is not created during install. If not present, the service check will occur as per the default mentioned above. If you want to change the interval of the service check, you can manually add this registry entry.	300
InactiveServerColor	REG_DWORD	This value specifies the font color used to indicate an inactive server on the column grid view of the following contexts in Pharos Administrator. Queues Release Stations Alerts Transactions By default, inactive servers are displayed in red orange. This registry entry must be manually created. Enter the hexadecimal value (e.g. #3355ff) of your preferred color.
InactiveServerBold	REG_DWORD	This value specifies whether the font used to indicate an inactive server on the column grid view is displayed in bold. This value must be manually created and must be set to 1 to set the font style of inactive servers to boldface.
InactiveServerItalic	REG_DWORD	This value specifies whether the font used to indicate an inactive server on the column grid view is displayed in italics. This value must be manually created and must be set to 1 to set the font style of inactive servers to italic.
InactiveServerStrikeout	REG_DWORD	This value specifies whether the font used to indicate an inactive server on the column grid view is displayed with a strikeout. This value must be manually created and must be set to 1 to set the font style of inactive servers to strikeout.
InactiveServerUnderline	REG_DWORD	This value specifies whether the font used to indicate an inactive server on the column grid view is displayed underlined. This value must be manually created and must be set to 1 to set the font style of inactive servers to underlined.

Billing Plug-in

Registry entries for the Pharos Billing Plug-in (which is used with Pharos Billing Gateways) are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Billing Plug-in.

Name	Type	Meaning	Default
Port	REG_SZ	The port that the billing service listens on.	2111
Servers	REG_SZ	A space separated list of IP addresses of machines that have billing services installed.
ConnectionTimeOut	REG_DWORD	The timeout for connections to gateways.
TermCodes	REG_SZ	A space separated list of extra terminal codes that should be sent when a balance is requested from the billing service, after the first call that is made using the Pharos Station name passed to the Plug-in on the command line.

Database Server

A registry containing information on the operation of the Pharos Database Service is installed with the Database Service. This key is located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Database Server.

Name	Type	Meaning	Default
AutoPurgeTime	REG_DWORD	This value specifies the number of minutes after midnight that transactions , visitor accounts, and expired user print activity should be purged. This value must be created manually - if it is not present, purges occur one minute after midnight.	1
Inactivity Timeout	REG_DWORD	This value specifies the period of time, in seconds, after which a client connection will be closed by the server if the client has ceased all activity. This value must be manually created.	1800
LastAutoPurge	REG_DWORD	This value is used by the automatic transaction purging function, and should not be altered.
Maximum Connections	REG_DWORD	This value specifies how many connections from clients the server can have open at one time. Connections in excess of this number will be rejected. This value must be manually created.	2000
Max Buffer Size	REG_DWORD	This value specifies the maximum buffer size. If not present, the default buffer size is 25MB, which should be sufficient in most conditions. If you encounter an error message on your log file similar to “Writing to buffer of 31663696 bytes would exceed 26214400, maximum buffer limit (already with 0 bytes)”, you can manually create this registry key to increase the buffer size limit up to 1024 MB. In the error message given above, 31663696 bytes represents the actual size of the failed request, and 26214400 (25 MB) is the current max buffer size.
NoChangeControl	REG_DWORD	If this value is manually created and set to 1, change control requests are ignored. This may be necessary where change controls interfere with the operation of other Pharos services. If this value is set to 1, Pharos services must be manually restarted to propagate a configuration change.
New Connection Timeout	REG_DWORD	This value specifies the period of time, in seconds, after which a newly opened connection will be closed by the server if the client simply opens the connection and never does anything with it. This value must be manually created.	20

A registry containing information on the location of the Pharos Database Service is installed with all Pharos components. This key is also located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Database Server.

Some values must be manually created - this is indicated in the value's description.

Name	Type	Meaning	Default
Host Address	REG_SZ	Hostname of the local PC. (Requests to the Database Server are routed through the Proxy Service.)
Port Name	REG_SZ	The name (stored in the Services file) of the port on which the Database Service listens	psdbserver
Timeout	REG_DWORD	The timeout (in seconds) for connecting to the Database Server, after which the client atempting to connect to it gives up if it gets no response	120

Database

A registry containing information on how the Database Server accesses the Microsoft SQL Server and the database is installed with the Database Server itself. This key is located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Database Server\Database.

Name	Type	Meaning	Default
Backup Device Name	EG_SZ		pharos_bak
Database Name	REG_SZ	ODBC data source name.	pharos
Failover Server Name	REG_SZ	The host name of the SQL Server hosting the mirrored copy of the database. If this value is present, the Database Server connects to the failover SQL Server when it cannot connect to the primary SQL Server. This registry is used to support mirrored SQL Server Mirroring for Pharos Database Server. It has to be manually entered.
Max Buffer Size(MB)	REG_DWORD	This value specifies the maximum write buffer size (in MB) used for communication between Pharos components. If not present, the default buffer size is set to 25 MB, which should be sufficient under most conditions. If you encounter an error message on your log file similar to “Writing to buffer of 31663696 bytes would exceed 26214400, maximum buffer limit (already with 0 bytes)”, you can manually create this registry key to increase the buffer size limit up to 1024 MB. In the error message given above, 31663696 bytes represents the actual size of the failed request, and 26214400 (25 MB) is the current max buffer size.
Maximum Connections	REG_DWORD	Number of connections that the Database Server will make to the SQL Server.	4
Encrypted Password	REG_SZ	The database logon password in encrypted format. If for any reason you want to make the Pharos Database Server use a new password to connect to the Pharos Database, follow these steps: Manually create a Password registry entry(string value) and enter the new password in plaintext. Delete the Encrypted Password registry key. Restart the Database Service. The system will automatically encrypt the password, store the encrypted value, and delete the plaintext value. If both Password and Encrypted Password values are present in the registry, the Password value will be ignored.
Server Name	REG_SZ	SQL Server host name for cost center import and export. For SQL 2000, the Server Name should be the name of the instance of SQL Server that is running the Pharos Database - either the name of the Server (if the default instance of SQL Server is being used), or the name of the Server followed by the instance name, i.e. computer_name\instance_name.
Timeout	REG_DWORD	The timeout (in seconds) for queries to the database.	60
User Name	REG_SZ	Database logon user ID.	pharos

EDI Server

Registry entries for the Pharos EDI Server are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Edi.

Some values must be manually created - this is indicated in the value's description.

Name	Type	Meaning
BackupServer	REG_SZ	The host name of the Pharos Server that the EDI will use if the main server is unavailable. This value must be manually created.
BackupServerType	REG_SZ	The server type ("Uniprint" or "SignUp") of the Pharos Server that the EDI will use if the main server is unavailable. This value must be manually created.
Server	REG_SZ	The host name of the Pharos server that the EDI communicates with.
ServerType	REG_SZ	The server type (either "Uniprint" or "SignUp") of the Pharos server that the EDI communicates with.

License Server

A registry containing information on the operation of the Pharos License Service is installed with the License Service. This key is located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\License Server.

When Pharos Remote (or Administrator) must connect to the License Server, it asks the DBServer for the License Server information. The DBServer collects the information from its own local registry, which it cached when the DBServer service started. Pharos Remote or Administrator tries to connect using the License Server hostname string, provided by the DBServer

Name	Type	Meaning	Default
Inactivity Timeout	REG_DWORD	This value specifies the period of time, in seconds, after which a client connection will be closed by the server if the client has ceased all activity. This value must be manually created.	1800
Max Buffer Size(MB)	REG_DWORD	This value specifies the maximum write buffer size (in MB) used for communication between Pharos components. If not present, the default buffer size is set to 25 MB, which should be sufficient under most conditions. If you encounter an error message on your log file similar to “Writing to buffer of 31663696 bytes would exceed 26214400, maximum buffer limit (already with 0 bytes)”, you can manually create this registry key to increase the buffer size limit up to 1024 MB. In the error message given above, 31663696 bytes represents the actual size of the failed request, and 26214400 (25 MB) is the current max buffer size.
New Connection Timeout	REG_DWORD	This value specifies the period of time, in seconds, after which a newly opened connection will be closed by the server if the client simply opens the connection and never does anything with it. This value must be manually created.	20
Maximum Connections	REG_DWORD	This value specifies how many connections from clients the server can have open at one time. Connections in excess of this number will be rejected. This value must be manually created.	1000

A registry containing information on the Pharos License Service is installed with all Pharos components. This key is also located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\License Server.

Name	Type	Meaning	Default
Host Address	REG_DWORD	Hostname or IP address of the computer running the License Service To make Remote or Administrator use the fully qualified domain name (FQDN) when contacting the License Server, change the value of the Host Address to the FQDN and then restart the 'Pharos Database Server' Service. The next time you launch Remote, it will use the FQDN for contacting the License Server.
Port Name	REG_SZ	The name (stored in the Services file) of the port on which the License Service listens	pslserver
Timeout	REG_SZ	The timeout (in seconds) for connecting to the License Server	120

Name

Type

Meaning

Default

Host Address

REG_DWORD

Hostname or IP address of the computer running the License Service

To make Remote or Administrator use the fully qualified domain name (FQDN) when contacting the License Server, change the value of the Host Address to the FQDN and then restart the 'Pharos Database Server' Service. The next time you launch Remote, it will use the FQDN for contacting the License Server.

Port Name

REG_SZ

The name (stored in the Services file) of the port on which the License Service listens

pslserver

Timeout

REG_SZ

The timeout (in seconds) for connecting to the License Server

120

The License Key sub-key is located underneath the License Service key. This sub-key contains site licensing information in an encrypted format. This information should not be altered - doing do will most likely corrupt your license information and stop the Pharos services from working.

Pharos Online Services

Registry entries for the customer data collection feature of Pharos Online Services are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Online Services\Client.

Name	Type	Meaning	Default
Log Directory	REG_SZ	The directory the log files will be written to.
Plugin Directory	REG_SZ	The location of Pharos Online Services plug-in files.
Retry Interval	REG_DWORD	The time to wait (in seconds) before retrying to send information to Pharos, when an attempt to upload information fails due to a network or server error.	3600 (1 hour)
Retry Limit	REG_DWORD	The maximum number of retries to attempt before giving up.	5
Status	REG_DWORD	Whether or not the customer data collection is active. Setting this value to zero disables data collection; any other value enables it.	1
Survey Interval	REG_DWORD	The period of time (in seconds) between collections.	2592000 (30 days)

Pharos Remote

Registry entries for the Pharos Remote application are located at HKEY_CURRENT_user\SOFTWARE\Pharos\Remote.

Name	Type	Meaning	Default
Last Login	REG_SZ	The last user to log on to Pharos Remote.
Last Logon Server	REG_SZ	The most recent Uniprint Print Server to which Pharos Remote successfully connected to. Pharos Remote remembers which Uniprint Print Server it last connected to, so that subsequent connection attempts could try this server (if no local Print Server exists) before trying other servers. This key is automatically created when Pharos Remote connects to a Uniprint Print Server (even a local one). This value can be changed manually if required. Pharos Remote connects to a Uniprint Print Server to log the user on and to get a list of print jobs. The following lists the order in which Pharos Remote selects which Uniprint Print Server to connect to. First, it tries the Uniprint Print Server on the local machine if one exists. If there is no Print Server on the local machine, or if the attempt to use the local Print Server fails, it checks the server as indicated by the Last Logon Server registry (if there is one). If both of the previous attempts fail, it then checks other Uniprint Print Servers and selects the server with the best ping response time.

Name

Type

Meaning

Default

Last Login

REG_SZ

The last user to log on to Pharos Remote.

Last Logon Server

REG_SZ

The most recent Uniprint Print Server to which Pharos Remote successfully connected to. Pharos Remote remembers which Uniprint Print Server it last connected to, so that subsequent connection attempts could try this server (if no local Print Server exists) before trying other servers.

This key is automatically created when Pharos Remote connects to a Uniprint Print Server (even a local one). This value can be changed manually if required.

Pharos Remote connects to a Uniprint Print Server to log the user on and to get a list of print jobs. The following lists the order in which Pharos Remote selects which Uniprint Print Server to connect to.

First, it tries the Uniprint Print Server on the local machine if one exists.
If there is no Print Server on the local machine, or if the attempt to use the local Print Server fails, it checks the server as indicated by the Last Logon Server registry (if there is one).
If both of the previous attempts fail, it then checks other Uniprint Print Servers and selects the server with the best ping response time.

Pharos Reports

Registry entries for the Pharos Reports application are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Reports.

Name	Type	Meaning	Default
DSName	REG_SZ	Name of the Pharos Database Server that Reports uses.	PHAROSReports
ReportsLocation	REG_SZ	The full path to the directories where Report files are kept.

Pharos Station

Registry entries for the Pharos Station are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Station.

With the exception of the GatewayUnitVendSupport value, all values must be created manually.

Name	Type	Meaning	Default
CacheJobCost	REG_DWORD	Once the Pharos Station has obtained the cost of a job from the Print Server, it stores this cost locally and will not attempt to re-get the cost the next time a user clicks on the job (this is the default behavior). When this option is disabled (i.e. set to 0), the Pharos Station will ask the Print Server for the job cost every time a user clicks on a job. The CostJob plug-in will be invoked every time this happens.	1
CostPerUnit	REG_DWORD	If this key is not present then unit cards are charged at 1 Unit per page. If the key is present then the charge for unit cards is: Job cost divided by CostPerUnit. The CostPerUnit is stored as 1/1000 of the whole currency value, i.e. $0.10 is stored as 100, 1 cent is stored as 10. This value is related to the Unit Card Display Format Prompt.
GatewayUnitVendSupport	REG_DWORD	If this value is set to 1, the Pharos Station will only display the sheet count of selected print jobs, not the cost. This for use with gateways that support unit vending (where the job cost is determined by the gateway).	0
MultiSelectJob	REG_DWORD	Allows users to select multiple jobs at the Pharos Station and print them all (this is the default behavior). When this option is disabled (i.e. set to 0), a user has to click on each job and print them individually.	1
Screen Saver Period	REG_DWORD	The approximate time (in seconds) waited after the Welcome screen is shown before the screen saver is shown.	300
ShowBalance	REG_DWORD	If the value for this key = 0, the Printing screen does not display the user's balance value. If the value for this key = 1, the Printing screen displays the user's balance value.	1
ShowPrintJobCost	REG_DWORD	If the value for this key = 0, the Printing screen does not display the print job cost value. If the value for this key = 1, the Printing screen displays the print job cost value.	1
Balance Format	REG_SZ	Add this key to change the balance units from currency to a different unit. Value examples: %g tokens %f grams of gold Text will be clipped if the length exceeds the available space.

Color Scheme

Information on the color schemes available for the Pharos Station are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Station\Color Scheme.

This key contains one entry:

Name	Type	Meaning	Default
Current Scheme	REG_SZ	The name of the color scheme currently applied to the Pharos Station.

Underneath the Color Scheme key is a sub-key for every color scheme installed on the machine. Each color scheme sub-key contains configuration information for the scheme, which is configured with the Pharos Station Color Scheme tool.

EFTPOS

If EFTPOS is used at the Pharos Station, configuration information is stored at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Station\Pharos - Csd Eftpos.

Name	Type	Meaning	Default
CHeaderEnable	REG_DWORD	If the value for this key = 0, no header is printed on the clients receipt. If the value = 1, a header is printed.	0
CReceiptHeader	REG_SZ	Optional client receipt header text.
CutReceipt	REG_DWORD	If the value for this key = 0, the Receipt Printer does not cut the receipts automatically. If the value = 1, receipts are automatically cut.	0
MHeaderEnable	REG_DWORD	If the value for this key = 0, no header is printed on the merchants receipt. If the value = 1, a header is printed.	0
MReceiptHeader	REG_SZ	Optional merchant receipt header text.
PinPadInstalled	REG_DWORD	If the value for this key = 1, a PIN PAD is installed on the client PC. If the value = 0, no PIN PAD is installed, simulator mode.	1
ShowDialogs	REG_DWORD	If the value for this key = 1, the operators dialogs are displayed. If the value = 0, the operators dialogs are hidden.	1
PrinterName	REG_SZ	The name of the receipt print queue.
PrintReceipt	REG_DWORD	If the value for this key = 1, a receipt prints automatically. If the value = 0, no receipt prints automatically.	1
ReceiptTrailer	REG_SZ	Optional receipt trailer text.
Timeout	REG_DWORD	EFTPOS transaction timeout: the maximum amount of time that the PIN Pad will wait for a reply from the EFTPOS system. This must be a value between 10-99 seconds.	30
TrailerEnable	REG_DWORD	If the value for this key = 0, no trailer is printed on the receipt. If the value = 1, a trailer is printed.	0

After a power failure, a sub-key called LastRecoveredTxnFromPinpad appears if a transaction was uncommitted at the time of the failure. Check the 'TxnReferenceNo' value with the same value of another sub-key, 'LastTxnState'. If these two values are the same, handle the uncommitted transaction by either refunding the user or manually inputting the transaction amount into the users account.

ID Card Keyboard Wedge

If the Bank associated with a Pharos Station is set to use ID Card Keyboard Wedge, the following registry entries are created by default during Pharos Station installation. These registry settings are located at HKEY_LOCAL_MACHINE \SOFTWARE\ PHAROS\Station\Pharos - ID Card Keyboard.

Name	Type	Meaning
Ask For Password	REG_DWORD	If the value for this key is set to 0, the PHAROS Station does not prompt for a password. If the value is 1, the PHAROS Station prompts for a password.
Received Time Out	REG_DWORD	Time interval, in milliseconds, in which the characters from the swipe card reader must be received. The IDKeyWdg Card Reader Logon DLL is used to read swipe card readers connected to the keyboard port. The Receive timeout value is 1500ms (1.5 seconds) by default. This should be kept low to prevent users 'cheating' the system by entering the card ID of another user instead of swiping their own card. The DLL assumes that the swipe card reader returns the ID string with a Char(13) = carriage return appended to it.	1500

Name

Type

Meaning

Ask For Password

REG_DWORD

If the value for this key is set to 0, the PHAROS Station does not prompt for a password. If the value is 1, the PHAROS Station prompts for a password.

Received Time Out

REG_DWORD

Time interval, in milliseconds, in which the characters from the swipe card reader must be received.

The IDKeyWdg Card Reader Logon DLL is used to read swipe card readers connected to the keyboard port. The Receive timeout value is 1500ms (1.5 seconds) by default. This should be kept low to prevent users 'cheating' the system by entering the card ID of another user instead of swiping their own card. The DLL assumes that the swipe card reader returns the ID string with a Char(13) = carriage return appended to it.

1500

Proxy Service

Registry entries for the Proxy Service, which relays communication between Pharos components and the Pharos Database, are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Proxy.

Name	Type	Meaning	Default
Attempt Ping	REG_DWORD	Whether or not connection attempts should be preceded with a ping. 1 = yes, 0 = no.	1
Cache Type	REG_DWORD	Whether or not caching is enabled, as specified on the System Settings context. 1 = yes, 0 = no.	1
ChangeControl Port	REG_DWORD	The Change Control services listening port.	28205
Connection Pool	REG_SZ	All connections to the Database Server are managed by the Proxy Service using a connection pool (a cache of database connections that can be reused). This ensures the Database Service is not overloaded by connections from servers, allowing a greater number of servers to be connected to the Uniprint system. This registry specifies the maximum number of connections in the pool. The default maximum number of connections is 10, but can be altered between 1 and 50. Requests for new connections to the Database Server are queued until a connection becomes free for reuse. Each connection is closed after 2 minutes of inactivity.	10
Database Server	REG_SZ	The host name of the Pharos Database Server.
License Port	REG_SZ	The License Servers listening port.	2352
License Server	REG_SZ	The host name of the Pharos License Server.
Offline Category Name	REG_SZ	The name of the default Cost Center Category that offline transactions will be charged to.	Offline Category
Offline Category Number	REG_DWORD	The internal ID number of the default Cost Center Category that offline transactions will be charged to.	1
Offline Cost Center Description	REG_SZ	The description of the default Cost Center that offline transactions will be charged to.
Offline Cost Center ID	REG_DWORD	The internal ID number of the default Cost Center that offline transactions will be charged to.	1
Offline Cost Center Name	REG_SZ	The description of the default Cost Center that offline transactions will be charged to.	Offline Cost Center
Offline User	REG_SZ	The default user account that offline transactions will be charged to.	offline
Path	REG_SZ	The path to the Proxy Service's working folder.
Server Transaction Limit	REG_SZ	The Server Transaction Limit, as specified on the System Settings context.	1000
User Transaction Limit	REG_SZ	The User Transaction Limit, as specified on the System Settings context.	10

Values affecting the purging of cached data are stored in a sub-key at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Proxy\Reaper.

This sub-key and the values under it must be created manually.

Name	Type	Meaning	Default
Check Interval	REG_SZ	The time interval that specifies how often the Proxy should check cached data to see if it needs to be purged.	1.00
Delete Age	REG_SZ	The maximum age cached data may reach before it is purged.	7.00:00:00

Updater Module

Registry entries for the Updater Module, which is optionally included in install packages, are located at HKEY_LOCAL_MACHINE\SOFTWARE\Pharos\Updater.

Name	Type	Meaning
Last time for update manifest	REG_BINARY	The last time that the updater ran.
Manifest Location	REG_SZ	The URL of the manifest file that the updater checks to see if new updates are available.
Update Interval	REG_DWORD	The number of seconds that must have elapsed before the Updater Module will look for updates. Determined by the Update Frequency property on the Package Global Settings screen.