Managing user access codes and access cards

• If you change the user’s access code in Google Workspace, it will be updated in PaperCut Hive. However, you’ll need to let the user know that their code has been changed.

• If you delete a user’s access code in Google Workspace, it will be deleted in PaperCut Hive. Because users must have an access code,
  PaperCut Hive will automatically:

  • generate a new access code
  • email the new access code to the affected user.

Start by setting up the access card numbers and/or individual access codes in Google Workspace.

1. Log in to admin.google.com as an admin.
2. Navigate to Directory > Users.
3. In the list header, click the More options dropdown.
4. Select Manage custom attributes.
5. At the top right, click ADD CUSTOM ATTRIBUTE. The Add custom fields modal is displayed.

6. In the Add custom fields section, in  Category field type: PaperCut
7. Set up the cardNumber field. In the first row under Custom fields:
   1. In the Name field, type cardNumber
   2. In the Info type dropdown, select: Text
   3. In the Visibility dropdown, select: Visible to user and admin
   4. In the No. of values dropdown, select: Single value
8. Set up the accessCode field. In the second row under Custom fields:
   1. In the Name field type: accessCode
   2. In the Info type dropdown, select: Text
   3. In the Visibility dropdown, select: Visible to user and admin
   4. In the No. of values dropdown, select: Single value
9. Click Add. The user accounts now have and addition attribute, PaperCut, with two fields, cardNumber and accessCode, that you can populate with your values.

You can populate one or both of the fields, either manually or in bulk.

• Manually - see Google’s Create custom attributes for user profiles page and scroll down to Add values to custom attributes.
• In bulk - see Google’s Add or update multiple users from a CSV file page.

1. Log in to the PaperCut Hive admin console.
2. Click the Add-ons tab and select Google Workplace User Sync.
3. Click Add and follow the setup guidance to add the add-on.

You can set up automatic or manual syncing.

Automatic syncing

Each time the Google Workspace User Sync Add-on syncs with PaperCut Hive, the values set for cardNumber and accessCode will show up in the matching user’s profile in PaperCut Hive. If the user has already set up printing with PaperCut Hive, they can simply start releasing print jobs with their access card (swipe card) straight away. 

1. In the Add-ons page, on the Google Worskspace User Sync card click Manage.

2. Click the Configuration tab.

3. For Sync mode, select Automatic.

4. In the Sync source dropdown, select All Users or Selected Organizational Units (depending on how your Google Workspace is set up).

5. (Optional) If you’re only syncing specific Organizational Units, in the Org Units dropdown select the relevant units.

6. (Optional) If you’d like to automatically delete users in PaperCut Hive when they’ve been deleted in your Google Workspace, select the Automatically delete users who are removed from the sync source checkbox.

   

7. Click Save and sync to start syncing. You can see new users and details in the Users page.

Manual syncing

1. In the Add-ons page, on the Google Worskspace User Sync card click Manage.
2. Select the Manual tab and click Save and sync.

1. In the PaperCut Hive admin interface, click Add-ons. Locate the Microsoft Entra ID User Sync add-on and click Add.
2. Agree to the terms. The instructions panel displayed.
3. Make a note your Tenant URL and Secret Token. You’ll need these details later to connect your custom Microsoft Entra ID Enterprise Application.
   
   Ignore the other information, including the step-by-step tutorial.

1. Navigate to the Microsoft Entra admin center.

2. If you have an existing Enterprise Application configuration to synchronize users with PaperCut Hive or Pocket, switch off provisioning for this application.
   a. Go to Enterprise Applications and select the application.
   b. In the Provisioning section, toggle Provisioning Status to Off.

3. On the Microsoft Entra ID admin center homepage, click Add > Enterprise Application.
   

   

4. Click Create your own application.
   

   

5. Name your application, for example, PaperCut-Hive-User-Sync.

6. Make sure that Integrate any other application you don’t find in the gallery (Non-gallery) is selected.

7. Click Create.
   

   

1. From the left-hand menu, select the Provisioning tab.
   

   

2. Under Manage, click Provisioning.

3. Set Provisioning Mode to Automatic.
   

   

4. In the Admin Credentials section, paste your PaperCut Cloud Management Tenant URL and Secret Token you noted earlier.

5. Click Test Connection and ensure Microsoft Entra ID can connect to PaperCut Hive or Pocket. If the connection fails, ensure you’ve entered the correct Tenant URL and Secret Token and try again.
   

   

6. Click Save.

7. Click the Settings dropdown.

8. Select the Send an email notification when a failure occurs checkbox.

9. In the Notification Email field, type the email address of a person or group who should receive the provisioning error notifications.
   

   

10. Click Save.

1. In the Mappings section, select Provision Microsoft Entra ID Users.
   

   

2. In the Attribute Mappings section, the second column shows the user attributes synchronized from Microsft Entra ID into PaperCut Hive or Pocket. Delete all attributes except:
   userName

   displayName

   emails[type eq “work”].value
   

   The attributes selected as matching properties are used to match the user accounts in PaperCut Hive or Pocket for update operations.
   
   If you change the matching target attribute, ensure that the PaperCut Hive or Pocket API supports filtering users based on that attribute.
   

   

TIP: On this page, you can control whether users are created, updated, and most importantly, automatically deleted as part of the sync. The delete option is useful to ensure that when a user is offboarded, they are removed from PaperCut Hive or Pocket automatically. However, this option does not suit all customers, so it can be toggled off here.

A downside of having the Delete option enabled is that users might need to reauthenticate with PaperCut Hive or Pocket if accidental misconfiguration occurs in Microsoft Entra ID. For example, if users are taken out of scope for syncing, they will be deleted from PaperCut Hive or Pocket. This renders their authentication token invalid, so when they are re-added they must relink the software as they are treated as a new user.

1. Under Attribute Mappings select Show advanced options, then click Edit attribute list for customappsso.
   

   

2. At the bottom of the list of attributes, add one or both of the following two new attributes (depending on your requirements). Leave all options as default.
   urn:ietf:params:scim:schemas:extension:papercut:2.0:User:accessCard

   urn:ietf:params:scim:schemas:extension:papercut:2.0:User:accessCode
   

   

3. At the top of the list, click Save. The Attribute Mapping screen is displayed.

4. Under the list of Microsoft Entra ID Mappings, click Add New Mapping. The Edit Attribute screen is displayed.
   

   

5. To sync the Access Card attribute:

   1. In the Source attribute field, select the attribute that will be read from the source object.
   2. In the Target field, select:
      urn:ietf:params:scim:schemas:extension:papercut:2.0:User:accessCard
   3. Leave the remaining fields set to the default.
   4. Click OK.

6. To sync the Access Code attribute:

   1. In the Source attribute field, select the attribute that will be read from the source object.
   2. In the Target field, select:
      urn:ietf:params:scim:schemas:extension:papercut:2.0:User:accessCode
   3. Leave the remaining fields set to the default.
   4. Click OK.

7. Click Save.

Example
This example adds mappings from the employeeId and extensionAttribute10, but these could be any fields where you store the information you want to sync.

Optional

Configure scoping filters according to the instructions in the Scoping Filter tutorial.

1. In the breadcrumbs at the top of the screen, click Provisioning. The Provisioning screen is displayed.

2. In the left-hand menu, click Users and Groups.

3. Click on Add user/group, select who should be assigned this application, and therefore be synced into PaperCut Hive or Pocket.

4. Click Assign. ** ** You will be returned to the Users and Groups view where you can validate your selection.

5. Click Provisioning in the left-hand menu.

6. Scroll to the Settings section at the bottom of the screen and select Sync only assigned users and groups.
   

   

7. Set Provisioning Status to On to enable the Microsoft Entra ID provisioning service for PaperCut Hive or Pocket.
   

   

8. When you are ready to provision, click the Save at the top of the screen.

9. The setup is now complete. To confirm success, check if the users are synced into the PaperCut Hive or Pocket admin console.