Overview

Following administrative tasks are required to be performed in order to configure Copy Tracking

Initial deployment

1

Make sure the SafeQ server is currently installed and running. (see YSoft SafeQ 5 installation procedure for more information).

2

It is also necessary to properly configure Identity management. SafeQ rejects all prints initiated by unknown user by default. (Unknown user is user which is not defined in the SafeQ Identity Database)

3

Install and configure YSoft SafeQ Terminals.

- Make sure that every device which should be monitored by SafeQ is equiped by some type of terminal.
- External Terminals: device panel of copy function must be blocked by smart cable (see Hardware Compatibility List (HCL) and Installing and configuring YSoft SafeQ Terminals), device is available only after user authenticates.
- Embedded Terminals: device must be properly configured and the terminal must be deployed to the MFP (see Install Embedded Terminals). Embedded Terminal cannot be installed, unless the device is registered in SafeQ.

Configuration

1	Log in to the SafeQ Web Interface with sufficient rights to administer printers (for example, "admin") Go to System > System settings and set billing-codes-enabled property to enabled. If enabled, billing codes feature is activated in SafeQ.
2	If you are using Billing codes on devices which are connected to ORS servers, s et also *billingCodesSyncCronRule* property to choosen time. Cron rules for periodic check of billing codes update default value: 0 _/15 * * * ? (every 15 mins)
3	Import projects list to SafeQ (see Billing Code Import CSV Format Specification) or Create Projects manualy (see Managing billing codes). NOTE: You can restrict projects visibility to user by Access Rights settings at Managing billing codes page.
4	Use Adding and editing printers in Web Administration. Section Using the Printers list to add device you wish to monitor. Make sure that IP address and Accounting Mechanism is correctly specified. (see Print tracking methods for more information).
5	Use Defining access rights to ensure that users are allowed to copy at the defined device.

Other properties

You can configure advanced behavior of billing codes in web interface System Settings (Expert mode).

When user search for billing codes result is ehnanced by path.
Behavior is configured by following variables, which should be added to YBoxConfig:

billing-codes-search-path-format - String - default: "%code%"

it contains string which is used during building path
formatting string could contain: %code%, %description% or any other character
example: %code%-%description%

billing-codes-search-result-format - String - default: "%description% (%path%)"

it contains string which is used during building path with description
formatting string could contain: %code%, %description%, %path%, or any other character
format of %path% could be specified by billing-codes-search-path-format

billing-codes-search-max-length - Int - default: 42

when path is longer then max length then it is trimmed to specified size

billing-codes-search-delimiter - String - default: " > "

delimiter between path elements
e.g.: One > Two > Three

billing-codes-search-trim - Int - default: 2

trim strategy
0 - trim from start: ...abc
1 - trim from end: abc...
2 - trim from middle: ab..c

billing-codes-search-shortener - String - default: "..."

String which is placed into result string where it was shortened

billing-codes-search-limit – Integer – default: 100

maximum amount of billing codes returned by one search

It is possible to define search strategy.e
It could be specified by configuration option:

billing-codes-search-strategy - Int - default value: 5

Meaning of values:

0 - contains - Wildcard match '*ree*'
1 - prefix - Wildcard match 'gree*'
2 - suffix - Wildcard match '*een'
3 - exact - Wildcard match 'green'
4 - non-exact - Wildcard match '*green*' without 'green'
5 - exact_first - Composed strategy: Wildcard match 'green' append non_exact('*green*')