Choose your language

Choose your login

Contact us

PaperCut Pocket and Hive deployment with ManageEngine Endpoint Central (Windows)

This page applies to:

When deploying the PaperCut Pocket or Hive edge node and print client with ManageEngine Endpoint Central Device Management, we split the deployment into two parts: first the edge node, and then the print client.

The edge node

  • The computer app is run with elevated privileges, so it doesn’t require the user to be logged in.
  • The computer app creates the PaperCut Pocket or Hive edge node Windows service, and PaperCut Printer object.
  • The edge node can be deployed without a print client. For example, you can install a super node on a Windows Server.
  • The edge node must be deployed before installing the print client.

The print client

  • The computer app creates the print client processes for print job submission.
  • It installs files and processes in the Users Context.
  • The install runs as “Install as: Target User”.
  • After successful execution, it requires the user to perform the linking process via their email invite.

Prerequisites

  • You have already rolled out the ManageEngine UEMS agent to your Windows computers.

Deploy the PaperCut Pocket or Hive software to end user devices

You need to create separate software deployment packages for the PaperCut Pocket or Hive edge node and print client.

1. Create a software deployment package for the edge node
  1. Go to PaperCut Pocket or Hive Admin console > Manage > Edge Mesh and click Add edge nodes.

    PaperCut Pocket/PaperCut Hive admin interface - Add an edge node

    PaperCut Pocket/PaperCut Hive admin interface - Add an edge node

  2. Select Manually deploy edge nodes.

  3. Click Download for Windows to download the PaperCut Pocket or PaperCut Hive computer app (papercut-pocket.exe or papercut-hive.exe). This will be uploaded into Endpoint Central.

  4. Under Step 2, click the Copy button to copy the command line, and then paste it into a text editor. You’ll need the /systemkey value later.

    PaperCut Pocket/PaperCut Hive admin interface - Manually deploy edge nodes

    PaperCut Pocket/PaperCut Hive admin interface - Manually deploy edge nodes

  5. Log in to the Endpoint Central admin portal and navigate to Software Deployment.

  6. In the left-hand menu, under Package Creation, click on Packages and then select Add Package > Windows.

    Endpoint Central - create new deployment package

    Endpoint Central - create new deployment package

  7. Enter a package name, for example, PaperCut Hive edge node

    Endpoint Central - create new deployment package

    Endpoint Central - create new deployment package

  8. Choose an EXE package type and choose Commercial as the license type.

  9. Under Locate installable, select From Local Computer and upload the papercut-hive.exe installer we downloaded earlier.

  10. On the Installation tab > Installation details > Installation Command with Switches/Arguments, paste the installation command we copied from the PaperCut Pocket or Hive admin interface.

  11. Select Pre-Deployment Activities > Check File/Folder

  12. Create a check for the file/folder path: C:\Program Files\PaperCut Hive\pc-edgenode-service.exe

  13. Set the Define Action to Skip Installation.

  14. Select Save & Continue.

  15. Switch to the Uninstallation tab.

  16. For the Uninstallation Command with Switches/Arguments enter: "C:\Program Files\PaperCut Hive\unins000.exe" /VERYSILENT

  17. Select Add Package.

Once complete, you should have a new package listed similar to the below:

Endpoint Central - List of installation packages in Endpoint Central (edge node only).

Endpoint Central - List of installation packages in Endpoint Central (edge node only).

2. Create a Computer Configuration deployment to install the edge node to target machines

Once the edge node installation package has been created, we can then set up the deployment to your end user devices.

  1. Log in to the Endpoint Central admin portal and navigate to Software Deployment.
  2. In the left-hand menu, under the Deployment sub-section, navigate to Install/Uninstall Software > Windows - Computer Configuration.
  3. Name your configuration, for example, PaperCut Hive - edge node
  4. Choose the package you configured in the previous step.
  5. Expand the Configured Install/Uninstall options section, ensure the Install as option is set to System User.
  6. Under Apply Deployment Policy, choose the Deploy at any anytime at the earliest option.
  7. Set the remaining options and target computers as desired.
  8. Once complete, select Deploy

The successful installation of the edge node can be validated by checking the following location on an end user computer. ..\Program Files\PaperCut Hive\ or confirming PaperCut Hive <release version> is listed in the Windows Programs & Features settings menu.

3. Create a software deployment package for the print client

For the PaperCut Pocket or PaperCut Hive print client, you need to copy the installation command syntax from the InTune Add-on instructions. This contains the /userkey switch that signals the papercut-pocket.exe or papercut-hive.exe to create the user directories and processes.

  1. From the PaperCut Pocket or PaperCut Hive Admin console, under Manage select Add-ons > All Add-ons > Desktop App Deployment with Microsoft Intune.

  2. Click Learn More and Add. The Intune Add-on is now part of your “Added” Add-ons.

    PaperCut Pocket/PaperCut Hive - InTune Add-on

    PaperCut Pocket/PaperCut Hive - InTune Add-on

  3. On the Intune Add-on, select Manage and Follow these instructions.

    PaperCut Pocket/PaperCut Hive - InTune Add-on

    PaperCut Pocket/PaperCut Hive - InTune Add-on

  4. Select View set up process and scroll down to Install the user component.

  5. Go to step 7, copy the Install command string, and paste it into a text editor.

    PaperCut Pocket/PaperCut Hive - print client /userkey

    PaperCut Pocket/PaperCut Hive - print client /userkey

  6. Log in to the Endpoint Central admin portal and navigate to Software Deployment.

  7. Select Add Package > Windows.

    Endpoint Central - create new deployment package

    Endpoint Central - create new deployment package

  8. Enter a package name, for example, PaperCut Hive print client

    Endpoint Central - create new deployment package

    Endpoint Central - create new deployment package

  9. Choose an EXE package type.

  10. Under Locate installable, select From Local Computer and upload the papercut-hive.exe installer we downloaded earlier.

  11. On the Installation tab > Installation details > Installation Command with Switches/Arguments, paste the installation command we copied from the Intune add-on instructions.

  12. Select Pre-Deployment Activities > Check File/Folder

  13. Create a check for the file/folder path: %localappdata%\Programs\PaperCut Hive\pc-print-client-service.exe

  14. Set the Define Action to Skip Installation.

  15. Select Save & Continue.

  16. Switch to the Uninstallation tab.

  17. For the Uninstallation Command with Switches/Arguments enter: "%localappdata%\Programs\PaperCut Hive\unins000.exe" /VERYSILENT

  18. Select Add Package.

Once complete, you should have a new package listed similar to the below:

Endpoint Central - List of both installation packages in Endpoint Central.

Endpoint Central - List of both installation packages in Endpoint Central.

4. Create a User Configuration deployment to install the print client to target machines

Once the print client installation package has been created, we can then set up the deployment to your end user profiles.

  1. Log in to the Endpoint Central admin portal and navigate to Software Deployment.
  2. In the left-hand menu, under the Deployment sub-section, navigate to Install/Uninstall Software > Windows - User Configuration.
  3. Name your configuration, for example, PaperCut Hive - print client
  4. Choose the package you configured in the previous step.
  5. Under the Configured Install/Uninstall options section, ensure the Install as option is set to Target User.
  6. Under Execution Settings check the option Apply this configuration at every Logon.
  7. Ensure the retry option is enabled and configured for a minimum of 2 retries.
  8. Set the remaining options and target computers as desired.
  9. Once complete, select Deploy.

The successful installation of the edge node can be validated by checking the following location on an end user computer. %localappdata%\Programs\PaperCut Hive\ or confirming PaperCut Pocket/Hive Print Client <release version> is listed in the Windows Programs & Features settings menu.

Post-deployment

After both components are deployed, spot-check your test computer to ensure the following:

  1. In Task Manager, check the pc-edgenode-service is running.
    The Windows PC requires this service to perform Edge Mesh activities such as receiving, replicating, or printing jobs if the PaperCut Cloud Service calls upon it.
  2. In Task Manager, check that pc-print-client-service.exe is running.
    This is the print client needed to link the end-user to PaperCut Pocket or PaperCut Hive and submit jobs via the PaperCut Printer. This process must be running in memory. It provides the functions the user needs to print jobs via the PaperCut Printer.

If either of these are not running, please contact your PaperCut reseller and provide copies of the logs.

Locations of logs

  • Edge node service and setup logs:
    C:\Program Files\PaperCut Hive\data\logs or C:\Program Files\PaperCut Pocket\data\logs
  • User print client logs:
    %AppData%\Local\Programs\PaperCut Hive\data\logs or %AppData%\Local\Programs\PaperCut Pocket\data\logs
  • User client set up logs:
    • %AppData%\Local\Programs\PaperCut Hive\data\logs or %AppData%\Local\Programs\PaperCut Pocket\data\logs
    • %AppData%\Local\Temp

Comments