Sharp — CPA 2.0

Follow these steps to install the second-generation Control Panel Application on Sharp printers.

Supported Devices

Printer Support: — For a list of the known supported Sharp printers, see our PrinterLogic CPA page.

Card Reader Support: — PrinterLogic supports Elatec and RFIDeas card readers.

Ports Used

The following ports are used with Sharp devices. See the note following the list for more specific information:

  • TCP 80
  • TCP 443
  • TCP 515
  • TCP 9100
  • TCP 10080
  • TCP 10443
  • TCP 31988

CPA installation and uninstallation occur from the Service Client object to the printer over TCP 443/10080/10443.

CPA operation requires two main communication paths:

  • From the printer to the Service Client object over TCP 31988
  • From the printer to the PrinterLogic instance (cpa-api.app.printercloud.com, adjusted to your region) over TCP 80/443.

Normal printing communication occurs from the workstation to the printer over TCP 9100 (or TCP 515 for LPR queues).

Prerequisite

Ensure all prerequisites are completed and functional prior to CPA setup.

  • It is highly recommended that your printer be running the latest firmware version as some settings may only be available in the latest version.

  • OSA level 5.0 or higher is required.

  • Badge readers must be uniformly configured on the MFP prior to installing the Control Panel Application.

  • TLS 1.2 is required to be enabled on the MFP.
  • Create a Service Client ensuring that on the Printer Apps tab, that Printer Apps is enabled and that the HTTPS certificate matches the hostname.
    • Ensure that the PrinterLogicServicePrinterApp.exe service is running on your Service Client machine.
  • If your Service Client is using Windows OS, check to ensure Visual C++ Redistributable for Visual Studio 2015 (64-bit) or newer is installed on the Service Client. This is generally installed by default.
  • All devices, to include Service Client, printers, etc., must be allowed to reach DNS server and resolve names.
  • Ensure TCP Port 31988 is open in all firewalls such as the Service Client machine, routers, etc.
  • Configure your Identity Provider properly. (LDAP/IdP)
  • If wanting to use Pull Printing, create a pull printer. Reference Pull Printing for steps.
  • If using self-signed certificates, ensure root CA is installed on the printer(s).

Configure Authentication Options

The authentication options on the TCP/IP Printer object are what determines what is presented to an end-user when accessing the Control Panel Application at the printer. The default settings are beneficial if you are using the same authentication options for all printers. The printer specific options allow you to control these options further for each printer. The default options selected control what is available for you as the administrator to enable on the individual printer.

Default Settings

It's important to note that default authentication settings vary depending on the chosen identity provider. The LDAP settings differ from configuring settings for an IdP such as Okta or Azure AD.

  1. Open your Admin Console and click Tools then Settings then General.

  2. In the Identity Provider Settings section, ensure that LDAP is selected and that your LDAP credentials are configured correctly.

    Identity Provider Settings section of the Admin Console's General tab with the LDAP option selected.

  3. Scroll down to the CPA Specific Settings section and select the options that you want available to set on the Printer Apps tab.

    General tab's CPA Specific Settings section showing the different authentication methods that can be selected/enabled.

    Although settings are generally shown here, not all options may be available for all printer manufacturers and models. Supported options for the manufacturer will be displayed on the printer object's Apps tab.

  4. Configure the settings that correspond with the authentication options selected.

    1. Pin Settings: Can be set to store them in the PrinterLogic database or your Active Directory database. Depending on the option selected there may be additional fields to identify where to place the UserID Attribute. For Active Directory you also need to provide the field name that contains the PIN attribute.

      If the Database option is selected, the PIN must be set by the end-user within the Self-service Portal. This is done by opening the Self-service Portal, clicking on Menu, selecting Authentication, and selecting Manage PIN.

    2. Badge Settings: Can be set to store them in the PrinterLogic database or your Active Directory database. If Active Directory is selected you also need to provide the field name that contains the badge ID attribute for badge authentication on the CPA.

      General tab's CPA Specific Settings section with arrows pointing to the Pin Settings and the Badge Settings sections.

      When opting for the Database option, badge registration is mandatory. Administrators have the flexibility to manage badges individually through the badge management screen or in bulk by CSV. End-users also have the ability to set up their badge within the Self-service Portal. This is done by opening the Self-service Portal, clicking on Menu, selecting Authentication, and selecting Manage Badge. If the end-user is aware of their badge number, they can directly enter it. If the badge number is unknown, they can obtain a registration code on the screen, scan their badge and enter the provided registration code for successful registration.

  5. Scroll down to the Control Panel Application section.

  6. (Optional) If you use the same Username and Password to access the printers web interface on all printers, you can set a default Username and Password.

    General tab's Control Panel Application section with the username and password fields for default authentication to the printer highlighted.

  7. (Optional) Enable Single Sign-on. These settings allow you to lock down the printer so a user must authenticate who they are first, before getting access to the printers control panel.

    General tab's Control Panel Application section with an arrow pointing to the Default Single sign-on enable/disable setting.

    • When enabled, additional SSO options display on the printer object's App tab, and when adding printers to the CPA Manager. Those options include:
      • SSO Provider mode will display the PrinterLogic screen on the printer until the user authenticates.
      • SSO Listener mode runs behind the scene and listens for when another application acting as the SSO provider authenticates a user and will pass that user info to our CPA.
  8. Scroll back to the top and click Save.
  1. Open your Admin Console and click Tools then Settings then General.

  2. In the Identity Provider Settings section, ensure that IdP is selected and that the credentials are configured correctly for your IdP.

    General tab's Identity Provider Settings section with the IdP option on the left enabled.

  3. Scroll down to the CPA Specific Settings section.

    General Tab's CPA specific settings section showing the IdP authentication methods, self-registration options, and badge management options.

    While we aim to display settings comprehensively, please note that not all options may be available for every printer manufacturer and model. The supported options for a particular manufacturer will be presented on the printer object's Apps tab. Therefore, please refer to the Apps tab of the specific printer object to view the available options supported by the manufacturer.

  4. Select the options that you want available to set on the Printer Apps tab.
    1. Enable PIN Authentication - If this option is enabled there are two options:
      1. If ONLY Enable PIN Authentication is selected, the PIN is stored in the IdP database. In this case, mapping to a PIN attribute must be completed within the IdPs admin console.

      2. If both Enable PIN Authentication and the sub-option of Enable self registration of PIN for IdPs is enabled the PIN is stored in the PrinterLogic database. The PIN must be set by the end-user within the Self-service Portal. This is done by opening the Self-service Portal, clicking on Menu, selecting Authentication, and selecting Manage PIN.

        If you Enable self registration of PIN for IdPs, AND have a PIN attribute mapped in the IdP Admin Console, this will create conflicts. To mitigate this, only one option or the other should be configured.

    2. Enable Badge Scan Authentication - If this is enabled there are two options:
      1. If ONLY Enable Badge Scan Authentication is selected, the badge number and associated user ID is stored in the IdP database. In this case, mapping to a badge attribute and user ID attribute must be completed within the IdPs Admin Console.

      2. If both Enable Badge Scan Authentication and the sub-option of Enable managing of badges in PrinterLogic instead of in IdP is enabled the badge number is managed in the PrinterLogic database. In this case, each badge must be registered by the administrator on the badge management page or in bulk by CSV. It can also be configured by the end-user within the Self-service Portal. Reference Badge Self-Registration Options for steps.

        General Tab's CPA specific settings section showing the IdP authentication methods, self-registration options, and badge management options.

        If you Enable managing of badges in PrinterLogic instead of in IdP, any badge mapping that has been configured in the IdP Admin Console is ignored by PrinterLogic.

  5. Scroll down to the Control Panel Application section.

  6. (Optional) If you use the same Username and Password to access the printers web interface on all printers, you can set a default Username and Password.

    General tab's Control Panel Application section with the username and password fields for default authentication to the printer highlighted.

    The username MUST be admin for this manufacturers printers.

  7. (Optional) Enable Single Sign-on. These settings allow you to lock down the printer so a user must authenticate who they are first, before getting access to the printers control panel.

    General tab's Control Panel Application section with an arrow pointing to the Default Single sign-on enable/disable setting.

    • When enabled, additional SSO options display on the printer object's App tab, and when adding printers to the CPA Manager. Those options include:
      • SSO Provider mode will display the PrinterLogic screen on the printer until the user authenticates.
      • SSO Listener mode runs behind the scene and listens for when another application acting as the SSO provider authenticates a user and will pass that user info to our CPA.
  8. Scroll back to the top and click Save.

Install the CPA

These are the steps to install the CPA on a single printer using the printer object's Apps tab. To bulk install the CPA on multiple printers, reference CPA Manager for steps.

  1. In the Admin Console tree view, select a printer object.
  2. Click the Apps tab.

  3. In the Manufacturer field, select the printer manufacturer.

    Printer object's Apps tab with the Manufacturer drop-down expanded to show the manufacturers that support the control panel application.

  4. In the Version field, select CPA 2.0.

    Not all manufacturers support both Gen 1 and Gen 2 versions of the Control Panel Application. If a manufacturer does not support the Gen 1 version of the Control Panel Application, the Version field will not appear in the interface. Rather, the Admin Console will automatically select the Gen 2 CPA to install.

  5. Select the Service Client you want to use to install the Control Panel Application on the printer.

  6. In the Install Embedded Application section, select the Secure Release option.

    Install Embedded Application section with an arrow pointing to the Secure Release option.

  7. Check the boxes for any additional apps you wish to install.
    1. Copy/Scan Tracking
    2. QR Code Options

The subsequent steps outline the settings that will be presented based on the default CPA settings you have selected. Only the options you have chosen in the default settings will be visible. Nevertheless, it's important to note that authentication features may vary depending on the printer manufacturer.

  1. Select whether you want to use default admin settings or printer-specific settings to install the application.

    Credentials to use when installing application on this printer section of the Apps tab, with an arrow pointing to the bubbles where you select to use the default credentials or printer specific credentials.

    1. Make the desired printer specific CPA selections for end-user sign in and authentication. These options are:

      • Credentials to use when installing PrinterLogic applications on this printer. You can either set credentials per printer, or use a default set of credentials that can be configured in Tools then Settings then General in the Control Panel Application section.
      • Single Sign On (SSO). Allows you to lock down the printer so a user must authenticate who they are first, before getting access to the printers control panel.
        • SSO Provider mode will display the PrinterLogic screen on the printer until the user authenticates.
        • SSO Listener mode runs behind the scene and listens for when another application acting as the SSO provider authenticates a user and will pass that user info to our CPA.

      • CPA Authentication. Allows setting various authentication methods depending on the printers capabilities. This could be User ID with PIN Authentication, Badge Scan, or Badge Scan with a PIN.

        When utilizing the Control Panel Application (CPA) in conjunction with an Identity Provider (IdP), it's important to note that only Badge and PIN authentication methods are supported at the CPA.

        • With Require Pin (beta) enabled, end-users are prompted to enter their pin after scanning a badge. This feature is currently not compatible if the CPA is installed with an SSO option enabled.

      CPA authentication section of the printer object's Apps tab with the Single Sign-on options, and the authentication options for user ID with pin and enable badge scan authentication showing.

      The Extended Debug option located at the bottom of the Printer Apps screen, along with its associated settings, serve the purpose of troubleshooting and are not necessary for the installation of the CPA.

  2. Click Save to start the installation.

During the installation process, it is normal for the printer to undergo multiple reboots. Rebooting is an expected behavior as part of the installation procedure.

Uninstall the CPA

  1. Select the printer to remove the CPA from in the tree view.
  2. Click on the Apps tab.
  3. Uncheck the Install Application on Printer box.
  4. Click on Save.

FAQs & Troubleshooting

Languages Supported

The Control Panel Application displays text in the following languages. For more information see the Supported Languages topic:

  • French
  • Spanish
  • Portuguese
  • Japanese
  • Chinese
  • German
  • Dutch
  • Thai
  • Italian
  • Turkish

An incorrect admin username and password is a frequent cause of failed CPA installations. To resolve this issue, you can conveniently modify the credentials used for CPA installation through the Modify feature in the CPA Manager. It's important to note that if the same admin name and password are used for multiple manufacturers, you can select several manufacturers simultaneously within the CPA Manager and change the credentials in bulk.

While this may seem evident, it is important to consider that the Service Client machine could be shut down or in an error state.

To easily check the status, you can refer to the Task Manager on the device. Navigate to the Processes tab and ensure that the PrinterLogicServicePrinterApp.exe process is running.

Task manager view of the PrinterLogic Service Printer App .exe service running in the Processes tab..

If neither the PrinterLogicServiceManager.exe or PrinterLogicServicePrinterApp.exe processes are running on the Service Client device, check the following:

  • Verify that the installed client is authorized and configured to connect to the correct instance. You can quickly test this by clicking the system tray icon to open the Self-service Portal. If it opens to the correct URL, and you can sign in, view, and install printers from the portal, then the client is authorized.
    • Refer to Device Authorization if prompted for a code for the Self-service Portal.
    • If the system tray icon opens to an incorrect URL, refer to the instructions to Update Home URL.
  • Navigate to C:\Program Files (x86)\Printer Properties Pro\Printer Installer Client\ServiceHost.
    • If the ServiceHost folder is not present, verify the hostname or IP address of the device and compare it to what you entered in the Admin Console.
    • If the ServiceHost folder exists, check the config folder within it. You should find a JSON token if the Service Client is authorized.
    • If the folder exists but no JSON token is found, it may be necessary to reauthorize the Service Client.
      • Please note that Service Client authorization is different from client authorization.

      • These steps provide the Service Client with a new token if it's missing or the PrinterLogicServiceManager.exe service is crashing.

        Before proceeding with reauthorization, ensure that you have checked the URL, client authorization, and folders as mentioned earlier. Only if those checks have been performed should you proceed with the reauthorization process. It is crucial to complete the following steps within two minutes, as the reauthorization will fail otherwise.

        1. On the machine set up as the Service Client, navigate to C:\Program Files (x86)\Printer Properties Pro\Printer Installer Client\ServiceHost\Config
        2. Verify if there is an existing token. If there is, delete the json token.
        3. Open Task Manager.
        4. Select the Details tab.
        5. Right-click on PrinterInstallerClientLauncher.exe and select End Process Tree.
          • There are three PrinterLogic services running for the client. If the other two services don't close with End Process Tree, they will need to be closed individually.
        6. In the PrinterLogic Admin Console navigate to the Service Client Object.
        7. On the Service Client's General tab, click Reauthorize.
        8. Click Okay in the prompted message.
        9. Back on the Service Client machine, select the Services tab in Task Manager.
        10. Right click on PrinterInstallerLauncher service and select Start.

        When the services start back up the Service Client machine pulls down a fresh token.

It is essential to ensure that at a minimum, a self-signed certificate is applied.

  • If a certificate is not installed the following steps should be followed:

    • Amazon Root CA 1 must be manually loaded in Web Image Monitor: Configuration then Security then Root Certificate.

      1. In the web browser your PrinterLogic Admin Console is open in, click on the "Lock" icon in the URL field.

        Browser bar for a PrinterLogic instance with an arrow pointing to the lock icon next to the URL.

      2. Click on Connection is secure.
      3. Click on Certificate is valid.
      4. Select the Details tab.
      5. Click on the Amazon Root CA 1 in the displayed path.
      6. Click on Export Selected Certificate.
      7. Browse to the location you want to save the file to, name the file, and click Save.

    • PrinterLogic CA must be manually loaded in Web Image Monitor: Configuration then Security then Root Certificate.

      1. In the PrinterLogic Admin Console, select the desired Ricoh printer from your tree structure.
      2. Select the Apps tab.
      3. If not already done, select Ricoh as the manufacturer.
      4. Near the bottom of the screen, select the box to Enable extended debug.
      5. Under the Certificates section, select Download Certificate for CA.

    • By default, the visual C++ Redistributable for Visual Studio 2015 (64-bit) or a newer version is typically already installed. However, it is essential to have this component installed on the Service Client to generate the required items for a successful installation. Without it, the Service Client will be unable to initiate the app service, leading to repeated attempts to start and subsequent failures.

    A quick way to do this is to right-click the Client icon in the system tray of the Service Client machine and select Refresh Configurations.

    The CPA requires that an IdP be created and functioning correctly. This can be LDAP or another IdP such as Azure AD, Okta, etc.

    It is common for printer-specific drivers to potentially cause installation issues with the CPA. To ensure a smooth and successful installation, it is recommended to utilize a universal print driver instead.

    Before proceeding, it is crucial to double-check two key aspects:

    • Verify that the IP address assigned to the printer is accurate within the admin console.
    • Ensure that you can successfully ping the printer from the Service Client machine.

    Confirming these details will help ensure a smooth and error-free process.

    The log file can be found on the Service Client machine at the following path:

    Windows:

    C:\Program Files (x86)\Printer Properties Pro\Printer Installer Client\ServiceClientLogs\PrinterLogicServicePrinterApp.log

    Mac/Linux:

    /opt/printerinstallerclient/log/printerlogicserviceprinterapp.log