Kyocera WES - Create and configure the WES profile

Create the WES profile

On a clean Watchdoc installation, a first WES profile is automatically created with default parameters at the end of the wizard procedure, but you can, at any time, edit existing profiles to modify them or create a new profile.

 

1. From the Main menu in the administration interface;

2. in the Configuration section, click on Web, WES & Scan destinations:
   
   
   
   

3. in the Web, WES & Scan Destinations - Client Interface Management interface, click on Create a new WES profile;

4. in the list, select the profile you want to create:
   
   

è you will access the Create a WES profile form, which contains a number of sections in which you can configure your WES.

Configure the WES profile

Configure the Properties section

Use this section to state the main WES properties:

• Identifier: Enter the single identifier for the WES profile. It can comprise letters, numbers and the '_' character with a maximum of 64 characters. This identifier is only displayed in the administration interfaces.

• Name: enter the WES profile name. This explicit name is only displayed in the administration interfaces.

• Global : in the case of a master/slave configuration, tick this box to replicate this profile on the slave servers.

• Language: Select the WES display language configured from the list. If you select Automatic detection, the WES adopts the language it finds by default in the device configuration.

• Version: select the version of WES. For v3, you can customise the interface by choosing the colour of the buttons and images to match your graphic identity:

  • Colour: enter the Hexadecimal color value corresponding to the WES button's colour. By default, the buttons are Watchdoc^® orange customized (#FF901). Once the value is entered, the colour is displayed in the field.

  • Images: if you want to customize the WES images, enter the folder path in which are recorded images you want to display instead of the default images (stored in C:\Program Files\Doxense\Watchdoc\Images\Embedded\Doxense\[Manufacturer_Name] by default).
    

For more details, see How to customize the WES.

Configure the Keyboard authentication mode

• Keyboard authentication: tick the box (at the section level) to enable user authentication from a physical keyboard or the touch screen one, then set out how this authentication works:
  

  • Directory: From the list, select the directory to query during keyboard authentication. If no directory is set, Watchdoc will query the default directory.

  • PUK (Print User Key). In Watchdoc, this is a code associated with a user account to allow the user to authenticate in a WES. The PUK code is generated thanks to an algorithm. The user can consult it in the "My account" page of Watchdoc. For security reasons, we advise against using the PUK code and recommend using a login (user account)/PIN code. Code: the PUK code is automatically generated by Watchdoc according to the parameters defined in the directory and communicated to the user on the "My account" page.

  • Login and PIN Code: consisting of 4 or 5 digits, the user PIN code (1234, for example) is registered as anLDAP attribute or in a CSV file. It is associated to the user login (available with the Watchdoc 5.1 version).

  • Login and password: users will use their LDAP credentials. We do not recommend using this mode :
    
    

We do not recommend authentication by login and password. Nevertheless, if you opt for this mode, make sure that the device's screen and keyboard are configured in the user's language and that they allow all characters to be entered, even diacritics (accents, cedilla, tilde).

Configure the Card authentication section

Card authentication: tick the box (at the section level) to enable user authentication from a card, then set out how this authentication works:

• Directory: From the list, select the directory to query during cards authentication. If no directory is set, Watchdoc will query the default directory.

• Self registration : If you enable the self-registration An action in which a user account is associated with its own card code. Registration is carried out the first time a card is used. The registration can be carried out by the IT manager when he issues the card to a user or by the user himself who enters his identifier (PIN code, PUK code or username and password) which is then associated with his card code. Once the registration is completed, the card code is permanently associated with its owner. from the WES, state how the user assigns their card to their account:

  • Disabled: the self-registration is not allowed: if the user is unknown, an error message is displayed;

  • with PUK code: the embedded solution will ask the user for its PUK code. If the PUK code is correct, Watchdoc stores the card number with the user's login in its database;

  • with login and PIN code: the embedded solution will ask the user for his login and his PIN cpde.

  • with login and password: the embedded solution will ask the user for his login and his password. If the data keyed in are correct, Watchdoc^® stores the card number with the user's login in its database.

  • Notify the user on self-registration: check this box to send a notification to the user when his badge has been enrolled.
    

• Format : State, where necessary, how the character string for the badge number string is to be transformed. E.g. raw;cut(0,8);swap.

• Display timeout: indicate, in seconds, the time to wait before a second badge swipe is taken into account (5s < Time < 15s)
  
  

Specificity of the Format parameter: typically, when the code PUK is stored in an attribute of the LDAP directory, it is encoded for security reasons. Obtaining the code corresponding to that of the badge therefore requires a transformation of the format read by the badge reader. If you have a problem setting this parameter, contact Doxense Support.

 

Configure the Anonymous connection section

Tick this section to activate the Anonymous connection in order to allow an unauthenticated user to access to the device by clicking a button. 

It is possible to restrict the features that the anonymous user can access by applying a privilege policy to the queue, group, or server, and using the Anonymous User filter.

• Button Label: Enter in this field the label displayed on the access button to the device features. By default, the text is Anonymous;

• Redirection: From the list, choose the application to which the anonymous user must access after clicking the Anonymous:

  • Home: The user accesses to the device homepage;

  • Copy Application: The user accesses to the copy application;

  • Scan Application: The user accesses to the scan feature;

  • Fax application: The user accesses to the scan feature;
    
    

Configure the Accounting section

• Device > Uses the prints accounting information from the device : tick this box if you want accounting to be supported by the device instead of the Watchdoc parser. This only applies to print jobs. Results are more reliable especially when the job is not fully printed (canceled).
  
  

Configure the Quota section

• Enable: tick the box to enable the WES to manage print quotas.
   
  

If you tick the box, complete the configuration:
- by adding at least one quota;
- by applying the VMS and rates to the print queues associated with the WES (see Configuring quotas article).

Configure the Pull-print section

In this section, you can change options about the Watchdoc^® release application: sort order of the document, tariff information and optional pages.

You can bypass this application by enabling the automatic release mode. When the user is authenticated on the device, all its documents are released.

• Inactivity time out: Set the inactivity duration allowed before time out;

• Sort Order: Set the documents order on the device screen:

  • Reverse chronological: More recent documents will top the list ;

  • Chronological: Older documents will top the list.

• Release all documents at login: When the user logs on, Watchdoc releases all user documents on the device where he logs on. In this case, the user cannot access the list of pending jobs to delete or print them.

• All documents are checked by default: tick the box to ensure that all pending jobs are automatically ticked in the list of pending jobs when the user authenticates.

• Optional pages: Tick the box o enable user adding more pages previews:

  • Enable Page Zoom: User can have a page by page preview (PCL 6 driver required)

  • Enable spool edition: User carn modify the initial printing criteria;

• Display Options: This section allows you to choose which pricing information will be displayed to the user: either the price, either the cost, or none.

  • Force the monetary display to 2 decimal digits: Tick the box to limit the number of decimal digits displayed to the user in the tariff information.

Configure the Scan section

This section is used to configure the WEScan function. It can only be activated with a WES V3.

• Display preferences- Use the last values chosen by users: allows the user to be offered the most used scanning profiles (predefined settings), which offers a time saving when scanning uses are often the same. Then specify whether the classification should be done using:

  • the type of profile: (the most frequently chosen profile);

  • the date of use (profile chosen the last time it was used).

• Open default profile bar: provides an interface in which the user can choose between all the scanning parameters, which is useful when the scanning uses are very varied. Then specify whether you want to display the settings or the (pre-set) profiles.

  • the scan settings ;

  • the scan profiles (pre-configured).

• Allow users to switch display modes: tick this box to allow the user to customize their interface by choosing their preferred display mode.

• Scan profiles: for each profile listed, you can check:

  • activation: to make it active in the embedded interface;

  • inheritance: to allow the user to create a new profile inheriting the parameters of the existing profile. The user will then be free to modify one or more parameters of the original profile;

  • destinations : the destination is the place where the scanned document is sent. For each profile, you can activate, deactivate and define one or more destinations by default:

    • E-mail: Send the scan to the e-mail of a recipient entered in the interface;

    • My e-mail: send the scan to the user's email (always known if the user has an AD account);

    • Folder: send the scan to a predefined folder in the workspace accessible to the user.
      
      
      

Configure the Device section

This section is used to define the connection mode between the server and the print devices.

• Server Address type: The device needs to contact the Watchdoc® server when the user tries to connect or wants to release his documents. You can specify the Watchdoc® server address in three different ways: IP Address, DNS Address and Custom Address ;

• Connection Mode: Enables you to enable or disable SSL for the communications between the MFP and the server:

  • Mixed: the application uses SSL for sensitive data (PUK code, login/mdp, etc.) and not SSL for non-sensitive data;

  • No SSL: Select this item if the WES does not ever use SSL to communicate with the server.

• Network: the two values can be used to set :

  • connection timeout: the maximum waiting time for the connection between the copier and Watchdoc during a request (server off or service stopped);

  • request timeout: the waiting time for processing the request: retrieving information about a user, sending and processing accounting requests.

• Session Timeout (sec.): Kyocera MFP natively manage the automatic closing of the user session after a time configured in its options. To facilitate configuration, it is possible to specify this time in the form. The duration is taken into account when the embedded application is installed or when its configuration is updated.

  Please note that the countdown starts on the copier's home screen. Each embedded application has its own countdown before closing and returning to the home screen (30s for the Watchdoc application).

• Device security: indicate the device administrator login and password which Watchdoc needs to communicate with it during certain operations (automatic installation, SOAP requests, etc.).

Configure the Failover options section

In this section, you configure the behaviour of the print devices in the event that the Watchdoc server does not respond.

• Ping delay: specify, in seconds, the frequency with which the device polls the server to check its configuration and inform it that it is operating correctly;

• Number of attempts: specify the number of connections the device should attempt to the main server before switching to the standby server.

• Offline mode: activate or deactivate off-line mode Mode enabling the print device to operate in a degraded manner in the event of the print servers (main and backup) failing. In offline mode, printing is impossible, but the device's other functions can be offered: photocopying, faxing and scanning. If offline mode is disabled, in the event of a server failure, all device functions are blocked until the server is repaired. This mode is configured in the WES profile applied to the device. and complete the list by indicating the authorised functions:

  • Copy access: Tick this box to enable the user to copy;

  • Scan access: Tick this box to enable the user to scan;

  • Color access: Tick this box to enable the user to print in color;

  • Fax access: Tick this box to enable the user to send documents by fax;

  • Print access: Tick this box to enable the user to print documents.

  • Device administration right: tick the box to authorize the user to access device administration.

• Then check the functions provided by the backup server:

  • Disable user authentication: tick this box if the rescue server does not authenticate users. For each request, it returns the details of an anonymous user with the rights defined for an anonymous user on the main server. The work carried out is then recorded under the "anonymous" account;

  • Disable accounting: If this is checked the accounting elements will be held on the device until it reconnects to the primary server. This is useful if you wish the accounting to be all sent to the same sever (if the databases are not common for example)

  • Disable pull print: With this option, the print on demand application will be disabled. This is useful because if the backup server has no access to the jobs of the user.

  • Disable self-registration: With this option, the self-registration will not be available on the backup server. This is useful if the cards database are not the same for both servers.
    
    

To set up a single server configuration or Main server in the case of a multi-server configuration:
1. tick the This server is the main server button;
2. Other servers: in a multi-server configuration, complete this parameter by providing information about all the servers to which the WESs can send their jobs, in order of priority;
3. Ping delay: specify, in seconds, the delay between 2 pings from the WES to the server;
4. Number of attempts: indicate the number of unsuccessful ping commands before going offline or moving on to the next server;
5. Offline mode: if you enable this mode, the user will be able to access the WES in "anonymous" mode if the WES is unable to communicate with any server;
6. Rights in offline mode: tick the boxes for the rights you grant to the user connected anonymously.

Configure the Misc. section

• Messages: In this field, enter two help messages displayed on the device's screen to assist users in using the interface and asking for help if they need it:
  
  
  

Configure the History section

This section displays information on the configured WES and on modifications made to it :

Validate the profile

1. Click on the button to validate the WES profile configuration.

→ Once validated, the WES profile can be applied to a print queue.