Identity management

Overview

YSoft SafeQ has its own identity database in order to provide authentication, authorization and accounting features. The data can be populated from different sources - manually via web interface, or automatically replicated from LDAP or imported using CSV file format from a third-party system. Each user must have a unique record in YSoft SafeQ, data are stored in the main database (CML server).

Each user record includes the following information:

Attribute

Status

Note

Unique username(s) 

Mandatory

At least one username or alias must be defined in order to identify print job owner. Case sensitive.

Alias

Optional

At least one username or alias must be defined in order to identify print job owner. Case sensitive.

First and last name

Mandatory

 

Password

Optional

NOTE: The password is NOT synchronized from LDAP sources to the YSoft SafeQ database.

Unique user ID

Mandatory

Mandatory only for LDAP replication.

Card number(s), PIN code(s)

Optional

 

Email address

Optional

 

Home directory

Optional

Mandatory for use with Scan to home folder feature.

Department number

Mandatory

 

Default billing code

Optional

 

User role(s)

Optional

LDAP (scheduled replication) as record attribute.
Active Directory (scheduled replication) as LDAP group.

 

Some of the steps can be carried out automatically during user workflow. For example users can assign cards to their account using Card self-assignment at the terminal.

 

Adding identities (users) to YSoft SafeQ

YSoft SafeQ offers multiple ways of adding identities (users) for use in print environment. Information are stored in the main YSoft SafeQ database (table "users"). Tools that can be used for adding identity (user) information are: YSoft SafeQ Web administration, LDAP User Replicator, CSV File User Replicator, CSV import and (customization required) third-party systems.

 

Add users with Web administration

One of the most common methods for adding users via YSoft SafeQ Web administration. Since all users are created manually, this process can be lengthy, depending on the amount of users that will be using YSoft SafeQ for printing services.

The administrator can add, edit or remove users from the internal database (see Web Interface - Users).

Import users with LDAP User Replicator

The LDAP User Replicator downloads users and their attributes from an LDAP server. When you run the LDAP User Replicator, all user attributes are automatically replicated into the YSoft SafeQ database. The only exception is the password attribute, which is not replicated.

This import process is mostly used in companies with higher volume of users and company having Active Directory identity management.

More information about the LDAP User Replicator, including configuration tips, can be found at Tools - LDAP Integration.

  • This process requires connection to an LDAP server.

  • Multiple LDAP domains and domain forests are supported.

  • The administrator can schedule either complete or differential data synchronization.

  • See LDAP Integration Security overview for security information.

  • YSoft SafeQ can verify user credentials using LDAPS or Kerberos v5 (Windows, MIT) authentication.

  • The connected data source must contain all information as described in Available attributes in User Database.

  • The GUID attribute and the User ID attribute for individual user records must be unchangeable and unique across all connected domains.

Import users via the CSV File User Replicator

The CSV File User Replicator imports users, roles, and cost centers from specially formatted CSV file to the YSoft SafeQ database. This enables you to use any source of data with YSoft SafeQ. The only requirement is that the source must allow data export to CSV file or through custom developed scripts.

This import can be performed periodically; the operating system scheduler can be set to periodically run the CSV File User Replicator.

More information about the CSV File User Replicator, including examples of the CSV file structure, can be found at Using the CSV File User Replicator.

Import users from a CSV file

Importing information from a CSV file is similar to using the CSV File Use Replicator, except for two differences: you can import the CSV file information directly from the YSoft SafeQ Web Interface, and the import cannot be set to run periodically. To import data from a CSV file:

1. Prepare the CSV file.

The structure of a CSV file is almost identical to the CSV file used by the CSV File User Replicator, as shown here:

images/download/attachments/21955272/csv_structure.png
2. In the YSoft SafeQ Web Interface, select the CSV file.

Select the Users tab; then the Actions option and the file to import. NOTE: Select the correct type of CSV file encoding to avoid issues with special characters.

3. Import data.

Click Import data. The import proceeds immediately.

images/download/attachments/21955272/10.PNG

All user attributes from the CSV file are saved to the internal YSoft SafeQ database.

Import users from third-party systems

Import from other systems is not directly supported by YSoft SafeQ. However, Y Soft offers additional, separately priced option to develop custom integration with third-party systems. Please consult with your Y Soft representative the necessary details prior installing YSoft SafeQ.