Canon - CPA 2.0

Complete the requirements and follow the steps below to install the second-generation Control Panel Application (CPA) on a Canon printer. For a list of supported devices, see PrinterLogic CPA.

Installation Requirements

Ensure all of the universal requirements are completed and functional prior to CPA setup. In addition, Canon also requires the following.

  • The Canon Web Access Software on the printer. This software is included in the Web Connection Kit and is available from any authorized Canon dealer.
  • The Auth JAR file, Web JAR file, and license file. You can email canonlicensefile@printerlogic.com for this and provide the following:
    • Model and serial number(s) of the printer(s) for the installation.
    • The printer's geographical location (EMEA, APAC, etc.).
  • Ensure the Canon printer is in Production Mode for JAR files will work correctly (this is generally the default).
  • Enable Transport Layer Security (TLS) 1.2 on the Multifunction Printer (MFP).
  • If you are using a USB card reader for the release of print jobs, some Canon models require the Use MEAP Driver for USB Input Device setting enabled in the the USB Settings section.

Additional Port Information

CPA installation and uninstallation occur from the Service Client to the printer over TCP 8000 and TCP 8443.

CPA operation requires two main communication paths:

  • From the printer to the Service Client object over TCP 31988.
  • From the printer to the Virtual Appliance instance (cpp-ui.FQDN_of_Virtual Appliance and cpa-api.FQDN_of_Virtual Appliance) over TCP 443.

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

By default, Certificate Revocation List (CRL) checks occur over TCP 80 from the Service Client.

Certificates

The Virtual Appliance Certificate Authority (CA) must be downloaded and installed on the printer. The following steps guide you through that process.

Download / Install CA Cert

Download the Certificate

In the Virtual Appliance Admin Console, perform the following steps:

  1. From the tree structure, select the Canon printer where you want to install the CPA.
  2. Select the Apps tab.
  3. Scroll down to the Certificates section and select Download certificate for CA. You'll reference the location where you save the certificate later.

Install the Certificate

Go to the administration page for the printer and perform the following steps:

The placement of the configuration options outlined here may vary depending on the printer.

  1. On the right-hand menu near the top, select Settings/Registration.
  2. Under the Management Settings section in the left side menu, select Security Settings.
  3. On the Security Settings page, select the Encryption/Key Settings menu.
  4. Above the list of installed SSL certicates, select Edit, then select Register CA certificate
  5. Select Install.
  6. Select Choose File.
  7. Navigate to the certificate you previously downloaded from the Admin Console and select Open.
  8. Ensure the file's name shows beside the Choose File button and select Start Installation.
  9. Once the CA certificate is uploaded and installed, it should return to the Register CA Certificate page.
  10. Select the printerlogic-ca-cert.pem certificate from the list, then select the Register button.

The newly installed and registered PL certificate should show in the Settings/Registration then Security Settings then Encryption/Key Settings then CA Certificate Settings list.

General Authentication Options

What the CPA displays to the end user at the printer is determined by the authentication options on the TCP / IP printer. If you are using the same authentication options for all printers you can use the default settings. If you want to be able to set specific methods on a per-printer basis, you can choose which printer-specific options you want available to set up on individual printers.

Default Settings

Be aware that default authentication settings vary depending on the identity provider. The LDAP settings differ from settings available for an IdP such as Okta or Entra ID (Azure AD).

Once you're identity provider is configured, you can set the CPA Specific settings. Opening your Admin Console and navigate to Tools then Settings then General and scroll down to the Identity Provider Settings. Use the appropriate provider's settings below.

LDAP

  1. 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.

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

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

    Not all the options seen here may be available. The printer's Apps tab displays the manufacturer supported options.

  3. To set PIN Settings do the following:
    1. Set PINs to store in either the Virtual Appliance or Active Directory databases. Depending on your selection, enter the field names for the following:
    2. The field name containing User ID

    3. The field name containing PIN.

      If the Database option is selected, the end-user must set the PIN within the Self-service Portal. See User ID and Pin

  4. To set the Badge Settings do the following:
    1. Set badges to store in the Virtual Appliance or Active Directory databases.

    2. For Active Directory provide the field name that contains the badge ID attribute.

      The Database option makes badge registration mandatory. Administrators can manage badges individually through the badge management screen or in bulk by CSV. End-users also can set up their badge within the Self-service Portal. See Badge Self Registration Options.

  5. Scroll down to the Control Panel Application section. The configuration of these settings is optional.

    1. You can set a default Username and Password to access the printer's web interface on all printers where you're installing the CPA.

      General tab's Control Panel Application section showing the Default Single sign-on enable/disable setting.

      The credentials used MUST have administrative rights for the printer.

    2. Default Single Sign On settings — select from the following options:

      1. Enabled — the default option. This option requires users authenticate to gain access to the printer's control panel.

      2. Disabled — with this option selected, the users are only asked to authenticate when they select the PrinterLogic from the device's control panel.
  6. Scroll back to the top and select Save.

IdP

  1. 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.

  2. 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.

    Not all the options seen here may be available. The printer's Apps tab displays the manufacturer supported options.

  3. Select the options you want available on the Printer Apps tab. 

    If you use an IdP, the Control Panel Application (CPA) only supports badge and PIN authentication.

    1. Enable PIN Authentication — use this option to enable the PIN authentication at the printer level. the PIN gets stored in the IdP database and mapping to a PIN attribute gets completed within the IdPs admin console. If you do not use your IdP to manage PINs, you can select the following option.

      1. Enable self registration of PIN for IdPs — enable this option to allow end users to register their PIN using the Self-service Portal. The PIN is stored in the Virtual Appliance database. See User ID and Pin for end user instructions.

        Do not enable Enable self registration of PIN for IdPs, if you have a PIN attribute mapped through your IdP.

    2. Enable Badge Scan Authentication — use this option to enable badge authentication at the printer level. The badge number and associated user ID get stored in the IdP database. In this case, mapping to a badge attribute and user ID attribute is completed within the IdPs admin console. If you do not use your IdP to manage PINs, you can select the following option.

      1. Enable managing of badges in Virtual Appliance instead of in IdP — enable this option to manage the badge numbers in the Virtual Appliance database. You can register each badge on the badge management page or in bulk by CSV. End users can also register their badge within the Self-service Portal. Reference Badge Self-Registration Options for steps.

        If you Enable managing of badges in PrinterLogic instead of in IdP,Virtual Appliance ignores any badge mapping configured in the IdP admin console.

  4. Scroll down to the Control Panel Application section. The configuration of these settings is optional.

    1. You can set a default Username and Password to access the printer's web interface on all printers where you're installing the CPA.

      General tab's Control Panel Application section showing the Default Single sign-on enable/disable setting.

      The credentials used MUST have administrative rights for the printer.

  5. Default Single Sign On settings — select from the following options:

    1. Enabled — selected by default, this option requires users authenticate to gain access to the printer's control panel.

    2. Disabled — with this option selected, the users are only asked to authenticate when they select the PrinterLogic from the device's control panel.
  6. Scroll back to the top and select Save.

Configure Web Management Portal

You need the location of the JAR and license files you obtained to continue to the next steps.

Sign in to the printer's Web Management Portal by opening a browser window and entering the printer's IP address in the Address Bar.

Install the Web JAR File

  1. On the right-side panel, under Management Tools, select Service Management Service.

    The Management Tools section of the printer's portal

  2. Select Install MEAP Application from the left navigation.
  3. In the Install Enhanced System Application/Username section, select the Choose File button for the Application File Path option.
  4. Locate the PrinterLogic web JAR file, then select Open.
  5. Select the Choose File button for the License File Path option.
  6. Locate the license file for the current printer's serial number, then select Open.
  7. For the Operation to Perform option, select Install and Start.
  8. Select the Install button on the top-right.

Install MEAP Application/License window with the Application and License file path options, both with a Choose File button to the right.

Install the Auth JAR File

  1. Select Service Management Service in the right panel.

    The Management Tools section of the printer's portal

  2. Select Enhanced System Application Management from the left navigation.

  3. In the Install Enhanced System Application/License section, select the Choose File button for the Enhanced System Application File Path option.

  4. Locate the PrinterLogic auth JAR file, then select Open.

  5. Select the Choose File button for the License File Path option.

  6. Locate the license for the current printer's serial number and select Open.

  7. Select Install and Start or Enable, then select the Install button on the bottom-right.

  8. Select Yes.
  9. Select the To Portal link on the page header.
  10. On the Portal page, select Settings/Registration from the right panel.
  11. Select Restart Device on the top left panel.

Enhanced System Application Management window with the Operation to Perform Install and Start selected

Install the CPA

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

  1. In the Admin Console tree structure, select the printer where you want to install the CPA.
  2. Select the Apps tab.

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

  4. Select the Service Client you want to use to install the CPA.
  5. Check the box for Install Application.
  6. Check the boxes for any additional apps you wish to install.
    1. Copy/Scan Tracking.
    2. QR Code Display.

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

CPA Authentication Options

The options presented in this section are based on what was selected in the identity provider settings above. Please note that authentication features may vary depending on the printer manufacturer.

Installation Credentials

  1. For the Credentials to use when installing PrinterLogic applications on this printer options select from the following:
    1. Use default printer administration credentials — with this option you can use the default name and password to access the printer's web interface for all printers See the identity provider instructions above for more details.

    2. Use printer-specific administrator credentials — with this option you can use the administrator credentials set on each printer.

      The credentials used MUST have administrative rights for the printer.

Credentials to use when installing application on this printer section of the Apps tab showing the bubbles where you select to use the default credentials or printer specific credentials.

End User Credentials

If you use an IdP, the Control Panel Application (CPA) only supports badge and PIN authentication.

  1. Single Sign On — use this option to lock down the printer so that end users must authenticate before accessing the device's control panel. Select from the following options:
    1. Disabled — the device does not require authentication.
    2. Enabled as a Provider — the device displays the default Virtual Appliance CPA screen requiring users to authenticate to use the device.
    3. Enabled as a Listener — the CPA runs in the background and when users authenticate using another device application, they can select the PrinterLogic option from the devices application panel.

  2. In the CPA Authentication section, select from the following:

    1. Enable User ID with PIN Authentication — with this option enabled, users enter their User Id and PIN.

    2. Enable Badge Scan Authentication — with this option enabled, users must scan their badge, card, or dongle.

      The user is prompted for their network credentials upon first scan to validate the badge.

      1. Require PIN (beta) — with this option enabled, end users are prompted to enter their PIN after scanning a badge.

        This feature is incompatible if the SSO option enabled.

  3. Extended debug — this is an optional setting. When enabled, the following options become available:

    1. Certificates — link to download the Virtual Appliance certificate for CA.
    2. PrinterLogic Control Panel Application manual install URL

  4. Select 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.

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.

Uninstall the CPA

  1. In the Virtual Appliance Admin Console, open the Apps tab on the printer where you want to remove the CPA.
  2. Uncheck the Install Application box and select Save.

  3. Once the uninstallation is complete, log in to Canon printers' web interface and select Service Management Service from the left side.

    The Management Tools section of the Canon portal page

  4. On the Service Management Service page on the left, select Install MEAP Application.
  5. On the MEAP Management page, select Stop for the PrinterLogic application.

  6. Select the PrinterLogic application link.

    MEAP Application Management tab showing the Stop button to the right of the PrinterLogic entry.

  7. In the License Information section of the page, select License Management.

    Application/License information tab showing the License Management button in the lower left.

  8. In the Disable License File section, select Disable and confirm you want to disable the license.

  9. Select the Delete button on the bottom-right and confirm you want to remove the license file.

    License Management tab showing the Delete button in the lower right.

  10. Navigate back to MEAP Application Management, and on the PrinterLogic application, select Uninstall and confirm you want to uninstall.

    MEAP Application Management window showing the Uninstall button to the right of the PrinterLogic entry.

  11. Under System Management on the left navigation, select Enhanced System Application Management.

  12. In the Login Service section, expand the User Authentication option, and for PrinterLogic Auth select Uninstall.

    Enhanced System Application Management tab showing the Uninstall button to the right of the PrinterLogic Auth entry.

  13. Select the To Portal link on the page header.

  14. On the Portal page, select Settings/Registration from the right panel.
  15. Select the Restart Device button in the left panel.

Once the reboot is complete, all references of Virtual Appliance CPA will be removed from the printer.

Troubleshooting Help