Adding aliases for usernames

KB Home   |   Adding aliases for usernames

Main.UserNameAliasing History

Hide minor edits - Show changes to output

June 30, 2017, at 10:57 PM by brian - Added Youtube video
Added lines 18-19:

(:youtube 2I2OKOP_pe0:)
Changed line 24 from:
# Updated via the web services API or server-command utility.
to:
# Update and read aliases via the web services API or server-command utility.
January 02, 2017, at 11:50 PM by Alec - Added info about using API or server-command.
Changed line 21 from:
There are two options available:
to:
There are three options available:
Changed lines 23-24 from:
# Set up aliases using a text file.
to:
# Set up aliases using a text file.
# Updated via the web services API or server-command utility.
Added lines 73-78:
!!! Update aliases using web services API or the server-command utility
 
The [[https://www.papercut.com/products/ng/manual/common/topics/tools-web-services.html|API]] allows you to update the @@ username-alias@@ property using the @@ setUserProperties()@@ and  @@ setUserProperty()@@ methods, or @@set-user-property@@ subcommand when using the [[https://www.papercut.com/products/ng/manual/common/topics/tools-server-command.html|@@server-command@@]] utility.

You can also obtain the value of the user alias using the corresponding @@get@@ methods or subcommand
 
October 17, 2014, at 05:32 PM by Rick - corrected "username alias" to username in the txt file example.
Changed line 41 from:
So John O'Hare can have username aliases of "john_o_hare", "johnohare", and "johare".
to:
So John O'Hare (username "john_o_hare") can have username aliases of "johnohare", and "johare".
Deleted line 22:
Changed lines 27-37 from:
To set up automatic syncing of aliasing using AD/LDAP, you will need to enable
Username aliasing via @@Options -> Advanced@@


Once username aliasing has been
enabled, you will see a new text field on the User Details page.
This information can be automatically imported from Active Directory or LDAP during an overnight sync. Once username aliasing is enabled, an option to enter an AD/LDAP field name appears under Options → User/Group sync. Any valid Active Directory user field can be chosen to import this information. For example: employeeNumber, employeeID, otherLoginWorkstations.


Once this has been set, information from this Active Directory field will be imported every night as username aliases. For more information on user group synchronization see the section called “User and Group Synchronization”.

to:
To set up the automatic sync of aliases using AD/LDAP, you will need to enable
@@Username Aliasing@@ via @@Options -> Advanced@@


Once Username Aliasing has been
enabled, you will see a new text field on the User Details page.

This information can be automatically imported from Active Directory or LDAP during an overnight sync. Once Username Aliasing is enabled, an option to enter an AD/LDAP field name appears under Options → User/Group sync. Any valid Active Directory or LDAP user field can be chosen to import this information e.g. employeeNumber, employeeID, otherLoginWorkstations.


Once this has been set, information from the Active Directory or LDAP field will be imported every night as username aliases. For more information on user group synchronization see the section called “User and Group Synchronization”.

Changed lines 26-27 from:
to:
!!! Sync aliases using AD/LDAP
Changed lines 39-40 from:
 '' Text file option'''
to:
!!! Text file option
Changed lines 20-38 from:
To workaround this problem PaperCut allows users to have a list of aliases for their username.
to:
To workaround this problem PaperCut allows users to have a list of aliases for their username. 
There are two options available:
# Automatically sync via AD/LDAP

# Set up aliases using a text file.


To set up automatic syncing of aliasing using AD/LDAP, you will need to enable
Username aliasing via @@Options -> Advanced@@


Once username aliasing has been enabled, you will see a new text field on the User Details page.
This information can be automatically imported from Active Directory or LDAP during an overnight sync. Once username aliasing is enabled, an option to enter an AD/LDAP field name appears under Options → User/Group sync. Any valid Active Directory user field can be chosen to import this information. For example: employeeNumber, employeeID, otherLoginWorkstations.


Once this has been set, information from this Active Directory field will be imported every night as username aliases. For more information on user group synchronization see the section called “User and Group Synchronization”.


 '' Text file option'''
December 01, 2013, at 11:13 PM by Jason - Warning about aliasing "admin"
Added lines 57-58:
'''Note:''' If you add "admin" as an aliased user, you may not be able to access the PaperCut Administration Console.
Added lines 57-59:
!! What happens if the username does not exist in the alias file?
If a username does not match in the alias file it's assumed the user is a standard username.  If the user is new to the entire system it will be managed as a new user account and automatically created in PaperCut as per your new user rules defined under the groups section (group level initial user creation rules).  For this reason you should take care to ensure your alias list is current and up-to-date.

Changed line 60 from:
[-keywords: ERP, mainframe, SAP, map, translate, unix -]
to:
[-keywords: ERP, mainframe, SAP, lookup, look-up, map, translate, unix -]
Added line 15:
* Print jobs are coming from a ERP or mainframe system where their usernames are different than in their other network.
Changed line 60 from:
[-keywords: SAP, map, translate, unix -]
to:
[-keywords: ERP, mainframe, SAP, map, translate, unix -]
Changed lines 56-58 from:
to:
----
''Categories:'' [[Category.Users|+]]
----
Changed lines 15-17 from:
to:
* Print jobs coming from some software packages may use the "application username" and not the users'
  network username used by PaperCut.  e.g. this can occur in some SAP configurations.

Changed lines 52-55 from:
* Print jobs arriving in the print queues under the alias name.
to:
* Print jobs arriving in the print queues under the alias name.


[-keywords: SAP, map, translate, unix -]
Changed lines 36-37 from:
* Restart the Application server
to:
Changed lines 28-36 from:
# Go to the directory of @@C:\Programs\PaperCut NG\server\data\conf@@
# Run Notepad or your favorite text editor on the file @@username-aliases.txt.tmpl@@
# Add the following lines to the end
** johno'hare: john_o_hare
** johare:    john_o_hare
# Save file as @@username-aliases.txt@@
# Restart the Application server

The format of the alias file is
:
to:
* Go to the directory of @@C:\Programs\PaperCut NG\server\data\conf@@
* Run Notepad or your favorite text editor on the file @@username-aliases.txt.tmpl@@
* Add the following lines to the end:
Changed lines 32-34 from:
aliasname1: username1
aliasnameA: username2
aliasnameB: username2
to:
       johno'hare: john_o_hare
        johare:    john_o_hare
Changed lines 35-44 from:
to:
* Save file as @@username-aliases.txt@@
* Restart the Application server

The format of the alias file is:
[@
aliasname1: username1
aliasnameA: username2
aliasnameB: username2
@]

Added line 37:
[@
Changed lines 41-44 from:

where aliasname is mapped to <username> in the system database.
A user may have multiple aliases. In this example, username2 is known
both as aliasenameA and aliasnameB.
to:
@]

where ''aliasname'' is mapped to ''username'' in the system database.
A user may have multiple aliases. In this example, ''username2'' is known
both as ''aliasenameA'' and ''aliasnameB''.
Changed lines 48-51 from:
!! At what level is the alias applied?
to:
!! At what level is the alias applied?
The username aliases are applied at the following levels:
* User login to the web interface, client popup authentication, or release station login.
* Print jobs arriving in the print queues under the alias name.
October 14, 2010, at 12:48 AM by Tim - add info about username aliases - work-in-progress
Changed line 7 from:
  network uses the convention "j.smith" while the other uses "jsmtih"
to:
  network uses the convention "j.smith" while the other uses "jsmith"
Changed lines 23-24 from:
and can be created based on a template file,
to:
and can be created based on the provided template file,
Changed line 29 from:
# Run Notepad on the file @@username-aliases.txt.tmpl@@
to:
# Run Notepad or your favorite text editor on the file @@username-aliases.txt.tmpl@@
Changed line 33 from:
# Save as @@username-aliases.txt@@
to:
# Save file as @@username-aliases.txt@@
October 14, 2010, at 12:45 AM by Tim - add info about username aliases - work-in-progress
Changed lines 20-22 from:
@@[app-path]\server\data\conf\username-aliases.txt@@,
and can be created based on a template file
@@[app-path]\server\data\conf\username-aliases.txt.tmpl@@.
to:

  [app-path]\server\data\conf\username-aliases.txt,

and can be created based on a template file,

 
[app-path]\server\data\conf\username-aliases.txt.tmpl.
Changed lines 28-29 from:
# Go to the directory of C:\Programs\PaperCut NG\server\data\conf\
# Run Notepad on the username-aliases.txt.tmpl file
to:
# Go to the directory of @@C:\Programs\PaperCut NG\server\data\conf@@
# Run Notepad on the file @@username-aliases.txt.tmpl@@
Changed line 33 from:
# Save as "username-aliases.txt"
to:
# Save as @@username-aliases.txt@@
October 14, 2010, at 12:41 AM by Tim - add info about username aliases - work-in-progress
Changed line 20 from:
[app-path]\server\data\conf\username-aliases.txt,
to:
@@[app-path]\server\data\conf\username-aliases.txt@@,
Changed line 22 from:
[app-path]\server\data\conf\username-aliases.txt.tmpl.
to:
@@[app-path]\server\data\conf\username-aliases.txt.tmpl@@.
October 14, 2010, at 12:38 AM by Tim - add info about username aliases - work-in-progress
Added lines 1-42:
(:title Adding aliases for usernames :)

In some scenarios, a particular user wants to print a job but his/her username has been changed
for various reasons and it is reflected in PaperCut now as a different username.
Examples of why the username may have changed:
* two networks/domains/servers have different naming conventions. e.g. for user, John Smith, one
  network uses the convention "j.smith" while the other uses "jsmtih"
* for some policy reasons, the format of usernames has changed and you want to allow forgetful
  users to log in with their old name.
* Unix has strict requirements for usernames, (IEEE Std 1003.1-2001), where the only valid characters
  are letters, digits, underscores, full stops, at-signs, dashes (but not start with a dash) and
  having $ at the end. So when printing on a Unix server, it can sanitize the username, such as converting an
  apostrophe into an underscore, and then recording in PaperCut as a different user when one really
  wants it to be the same user.

!! What can one do?
To workaround this problem PaperCut allows users to have a list of aliases for their username.
So John O'Hare can have username aliases of "john_o_hare", "johnohare", and "johare".
The aliases information is kept in a file,
[app-path]\server\data\conf\username-aliases.txt,
and can be created based on a template file
[app-path]\server\data\conf\username-aliases.txt.tmpl.
For example on Windows:
# Go to the directory of C:\Programs\PaperCut NG\server\data\conf\
# Run Notepad on the username-aliases.txt.tmpl file
# Add the following lines to the end
** johno'hare: john_o_hare
** johare:    john_o_hare
# Save as "username-aliases.txt"
# Restart the Application server

The format of the alias file is:
aliasname1: username1
aliasnameA: username2
aliasnameB: username2

where aliasname is mapped to <username> in the system database.
A user may have multiple aliases. In this example, username2 is known
both as aliasenameA and aliasnameB.
The separator between aliasname and username can be ":", "=" or tab.

!! At what level is the alias applied?

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.

Article last modified on June 30, 2017, at 10:57 PM
Printable View   |   Article History   |   Edit Article