Help Center menu

PRODUCT MANUALS

PaperCut Pocket and Hive manual

PRODUCTS FEATURED

Microsoft SCCM/MECM and PaperCut Hive Deployment - Best Practices for Windows

Microsoft’s EndPoint Manager (MECM), formerly known as System Center Configuration Manager (SCCM), is a leading tool for Windows EndPoint configuration and software deployment. It provides IT Admins with a single pane of glass for EndPoint Software Deployments, Virus, and Malware Protection and Policy/Compliance control.

The process of inviting users to PaperCut Hive is manual and includes the admin inviting the end-user to join. The user receives an email with 3 simple steps to onboard themselves. The first step they have to do is download and run the PaperCut Hive Installer, which creates and starts the Edge Node Service, the PaperCut Printer, and the User Client processes.

This installation process does require elevated user rights in order for the installer to create the Edge Node Service and other tasks. Given that, there will be cases where the end-user does not have the local rights needed. In cases like these, the end-user will need to run the PaperCut Hive Installer as Administrator.

The benefit of using software deployment tools such as MEMCM is that it removes the tasks to execute a successful install away from your end-users and into the hands of the IT Administrator

Similar to deploying PaperCut Hive on Windows with Microsoft’s InTune product, we split the deployment into two parts on Windows with Microsoft EndPoint Manager as well. These two parts are:

Deploy the Edge Node Service

  • The installer is run with Elevated Privileges, so it doesn’t require the user to be logged in.
  • The installer creates the PaperCut Hive Edge Node Windows Service, and PaperCut Printer Object.
  • The Edge Node Service can be deployed without a User Client. For example, install Super Nodes on Windows Server Collections in MEMCM.
  • It must be deployed before installing the User Client.

Deploy the User Client

  • The installer creates the User Client Processes for print job submission.
  • It installs files and processes in the Users Security Context.
  • The install runs as “Run as logged on User”.  
  • After successful execution, it requires the user to perform the linking process via their email invite.

To set up MEMCM for PaperCut Hive Windows Installation, you need to create two (2) Packages in EndPoint Configuration Manager.

  • The Edge Node installer
  • The User Client.

Create the PaperCut Hive Edge Node Service Package

  1. Go to PaperCut Hive Admin console > Manage > Edge Mesh > Add an edge node.   
    Hive Admin Add Edge Node
  2. Select Automated bulk deployment of nodes (for techies).
  3. Click Download for Windows to download the PaperCut Hive Installer (PaperCut-Hive.exe).
  4. Copy the command line and paste it into a text editor for the time being.
    Hive Admin Automated Bulk Deploy Step 1
  5. In the SCCM/MEMCM Configuration Manager, navigate to Software Library > Application Management, then right-click Packages and select Create Package
    SCCM Create Package Step 2
        
  6. Enter a name for the Package (for example, PaperCut Edge Node), then click Next.
    SCCM Create Package Step 3
  7. Select the default Standard program, then click Next.
    SCCM Create Package Step 4
  8. Create a name for the Standard Program (for example, Hive Edge Node Installer).
    • Paste the command line copied from the PaperCut Hive Edge Node Bulk download section from step 2.
      SCCM Create Package Step 5
    • Leave the Startup folder field blank.
    • In Run, select Normal.
    • In Program can run, select Whether or not a user is logged in. Run Mode will automatically set to Run with administrative rights.
    • In Drive mode, select Run with UNC name, then click Next.
  9. Leave the Requirements Section default and click Next.
  10. Confirm the settings, then click Next.
  11. Verify the Create Package and Program Wizard has completed successfully.

Deploy the PaperCut Hive Edge Node Service Package

After you’ve created the Hive Edge Node Package, you’re ready to deploy it to the collection of your choice. When you’re ready to deploy the Edge Node Service to your Windows users, configure the following settings to schedule the deployment. 

  1. Select your Collection. 
    SCCM Deploy Package Step 1
  2. Add  your distribution point containing the PaperCut-Hive.exe installer. For help setting up Distribution Points, refer to the Microsoft doc here: https://docs.microsoft.com/en-us/mem/configmgr/core/servers/deploy/configure/install-and-configure-distribution-points 
    SCCM Select Deploy Package Step 2
  3. Click Next.
  4. Schedule the Deployment, then click Next.
    SCCM Deploy Package Package Step 3
  5. Leave the defaults for User Experience and click Next.
  6. In Distribution Points, select Download content from distribution point and run locally and leave neighbor boundary groups as Do not run program.
    SCCM Deploy Package Step 5
  7. Review and validate the Deployment Summary, then select Next.
  8. Validate the Deploy Software Wizard completed successfully.

After the PaperCut Hive Edge Node installer has run on the Windows Clients, they will have a PaperCut Hive Service running and a PaperCut Printer. The PaperCut Printer, however, will not function until the PaperCut Hive User Component processes are installed.

The following section details the steps required to install the User Component via EndPoint Manager.

Create the PaperCut Hive User Component Package

For the PaperCut Hive User Component, you need to copy the installation command syntax from the InTune Add-on instructions. This contains the “/userkey” switch that signals the PaperCut-Hive.exe to create the User directories and processes.

  1. From the 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 will now be part of your “Added” Add-ons.
    SCCM Create User Package Step 2
  3. On the Intune Add-on, select Manage and Follow these instructions.
    SCCM Create User Package Step 3
  4. Select View set up Process and scroll down to Install user component. Copy the Install command string from Step 6 and paste it into a text editor.
    SCCM Create User Package Step 4
  5. In the SCCM/MEMCM Configuration Manager, navigate to Software Library > Application Management, then right-click Packages and select Create Package.
    SCCM Create User Package Step 5
  6. Enter a name for the Package (for example, PaperCut Edge Node), then click Next.
    SCCM Create User Package Step 6
  7. Select Standard Program, then click Next.
    SCCM Create User Package Step 7
  8. Specify the details of the standard program. 
          a) Create a name (for example, Hive Edge Node Installer). 
          b) Paste the install command line copied from Install User Component in step 4.
          c) Leave the Startup folder field blank .
          d) In Run, select Normal.
          e) In Program can run, select Only when a user is logged on
          f) In Run mode select, select Run with user’s rights.
          g) In Drive mode, select Run with UNC name, then click Next.
    SCCM Create User Package Step 8
  9. In the Requirements section, leave the defaults and click Next.
  10. Confirm the Settings, then click Next.
  11. Verify the Create Package and Program Wizard has completed successfully.

Deploy the PaperCut Hive User Component Package

After you’ve created the Hive User Component Package, you can deploy  it to the collection of your choice. When ready deployment of the Edge Node Service to your Windows users use the following setting when scheduling the package

  1. In General, browse and select your collection, then click Next.
    SCCM Create User Package Step 1
  2. Add  your distribution point containing the PaperCut-Hive.exe installer. For help setting up Distribution Points refer to the Microsoft Doc here: https://docs.microsoft.com/en-us/mem/configmgr/core/servers/deploy/configure/install-and-configure-distribution-points 
    SCCM Create User Package Step 2
  3. Schedule the deployment, then click Next.
    SCCM Create User Package Step 3
  4. In the User Experience section, leave the defaults and click Next.
  5. In Distribution Points, select Download content from distribution point and run locally and leave neighbor boundary groups as Do not run program.
    SCCM Create User Package Step 5
  6. Verify successful completion of scheduling the deployment, then select Close.
    SCCM Create User Package Step 6
  7. Verify that the deployment is compliant. 
  8. Once the Print Client installation has completed successfully there is a requirement for the linking process for the Print Client to be run. This process is run by the End User via the PaperCut Hive Email Invite as they would if installing themselves. Users will need to click the “Get Started” button in the email invite and the linking process will automatically start in the background. That is the final step and now the PaperCut Printer will be available. Downloading the PaperCut Hive setup will not be necessary.

After both deployments

Once both deployments are complete, you can spot check a few Windows clients to ensure the following:

  1. In Task Manager, check the PaperCut Edge Node Service is running. This Windows Service is required for the Windows PC 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 pc-print-client-service.exe is running. This is the User Client Component that is needed to initially link the end-user to Hive and to submit jobs via the PaperCut Printer. This process is required to be running in memory. It is the process that provides the functions for the user to print jobs via the PaperCut Printer. 

If either of these are not running, open a ticket with your reseller and provide copies of the logs. 

  • Edge Node Logs - The Setup Log for the Edge Node Service are located in the c:\Program Files\PaperCut Hive\data\logs directory

    Edge Node Setup Log - “Setup Log %date% 00X.txt”

  • User Component Client Logs

 

Comments