Integration guide

Prerequisites

  • Correctly installed Dispatcher Suite (see Dispatcher Suite installation)

  • Valid Dispatcher Paragon license (with Konica Minolta OEM integration feature)

Step by step guide

Create a service account in your directory service

For the purpose of the integration of Dispatcher Paragon and Dispatcher Phoenix, you need to have a service account created in your directory service (e.g. Active Directory). This account must be of user type in the directory service.

Password expiration of the service account

It is recommended not to set a password expiration to the service account.

Setup Dispatcher Phoenix

1. LDAP integration

Set up the LDAP integration in Dispatcher Phoenix. Use this Dispatcher Phoenix documentation Workflow Services Manager for more info.

2. API integration

  1. Log in to the Dispatcher Phoenix web interface.

  2. Navigate to the System Settings page.

  3. Check the Enable Dispatcher Paragon Integration checkbox.

  4. Fill in the following fields

    1. Base URL: Dispatcher Paragon API URL (for example https://local.domain/api/v1).

      1. If Dispatcher Phoenix and Dispatcher Paragon are installed on the same server, then just change the http to https.

      2. If Dispatcher Phoenix and Dispatcher Paragon are installed separately (each one on a different server), then update the IP address of the URL to match the IP address of the server where Dispatcher Paragon is installed and also change the http to https.

      3. If the Dispatcher Paragon server is listening to HTTPS requests on other port than default (443), make sure to add the correct port value to the Base URL (for example https://local.domain:8443/api/v1). Using HTTP instead of HTTPS in the Base URL entry will not work.

    2. Username: Dispatcher Paragon user login (User logon name of the created service account in the directory service).

    3. Password: Dispatcher Paragon user password (Password of the created service account in the directory service).

    4. Domain: Tenant domain (default: tenant_1). Leave the default value as is.

    5. External Device Template ID: Write it down, and use this value later when creating a device template (see section Device template). This Unique ID must be the same in Dispatcher Phoenix and Dispatcher Paragon.

    6. Access URL: Dispatcher Paragon Web URL (for example http://local.domain).

      1. If Dispatcher Phoenix and Dispatcher Paragon are installed on the same server, then you can leave the default value as is.

      2. If Dispatcher Phoenix and Dispatcher Paragon are installed separately (each on a different server), then update the IP address of the URL to match the IP address of the server where Dispatcher Paragon is installed.

    7. Authentication Secret: Write it down, and use this value later when configuring the API authentication in Dispatcher Paragon. Do not modify this field. This value must be the same in Dispatcher Phoenix and Dispatcher Paragon.

  5. Save changes.

images/download/attachments/284926734/dipa_settings_template.png

Copy & paste values

When configuring Dispatcher Phoenix, write down the values of parameters External Device Template ID and Authentication Secret. Both will be used later in the Dispatcher Paragon configuration.

Setup Dispatcher Paragon

1. LDAP Integration

  1. Log in to the Dispatcher Paragon Management interface as a privileged user (admin).

  2. Go to System > LDAP integration page.

  3. Set LDAP settings. See LDAP Integration for more details.

  4. Run LDAP synchronization.

2. Configure service account user

  1. Log in to the Dispatcher Paragon Management interface as a privileged user (admin).

  2. Go to Users > Users page.

  3. Select a service account for the integration (created in the previous section of this guide) and go to the Access Rights page.

    images/download/attachments/284926734/users-permissions-btn.png
  4. Set the following permissions:

    • Remote access via the Management Server REST API

    • List of printers and queues

    • Printers and queues administration

    • System settings - expert options

  5. Save changes.

The API service account used for the integration must not be the super administrator (username admin). This user account is disallowed for integration.

3. Device template

  1. Log in to the Dispatcher Paragon Management interface as a privileged user (admin).

  2. Go to Devices > Printer templates page.

  3. Add a new template to be used when a device is created from Dispatcher Phoenix.

    • For "Unique ID" use the value from Dispatcher Phoenix captured earlier (External Device Template ID).

    • If you filled " global-authentication-km " parameter in System > Configuration > Terminal administration section you can keep the username and password parameters from the template tab empty, otherwise, use fill fleet login and password.

    • The template should contain an embedded terminal type and expected default configuration. The type or other single device specifications could be later changed individually.

  4. Save the template.

images/download/attachments/284926734/SQ_device_template.png
Snippet showing device template

3. API integration

  1. Log in to the Dispatcher Paragon Management interface as a privileged user (admin).

  2. Go to System > Configuration page.

  3. Set the values in the Integration API settings in Basic mode:

    • Konica Minolta Dispatcher Phoenix integration: Enabled.

    • Konica Minolta Dispatcher Phoenix API Secret: use the value from Dispatcher Phoenix captured earlier (Authentication Secret)

  4. Set the values in the Integration API settings in Expert mode:

    • Konica Minolta Dispatcher Phoenix API URL: URL of the Konica Minolta Dispatcher Phoenix API (for example http://dispatcher-phoenix.local.domain:44350).

      • If Dispatcher Paragon and Dispatcher Phoenix are installed on the same server, then you can leave the default value as is.

      • If Dispatcher Paragon and Dispatcher Phoenix are installed separately (each on a different server), then update the IP address of the URL to match the PI address of the server where Dispatcher Phoenix is installed.

    • Konica Minolta Dispatcher Phoenix Web URL: URL of the Konica Minolta Dispatcher Phoenix web interface (for example http://dispatcher-phoenix.local.domain:44350).

      • If Dispatcher Paragon and Dispatcher Phoenix are installed on the same server, then you can leave the default value as is.

      • If Dispatcher Paragon and Dispatcher Phoenix are installed separately (each on a different server), then update the IP address of the URL to match the IP address of the server where Dispatcher Phoenix is installed.

  5. Save settings.

Verification of successful integration

Verify the integration from both sides

It is important to verify the integration from both sides (from Dispatcher Phoenix to Dispatcher Paragon and from Dispatcher Paragon to Dispatcher Phoenix).

Verifying the correct integration from Dispatcher Phoenix to Dispatcher Paragon

  1. Create a device in Dispatcher Phoenix.

  2. Check that the device from step 1 is present in Dispatcher Paragon.

Verifying the correct integration from Dispatcher Paragon to Dispatcher Phoenix

  1. Log in to the Dispatcher Paragon Management interface.

  2. On the Dashboard see the System services widget. There should be a row with "Dispatcher Phoenix" and status "Running". See Management Interface - Dashboard for more details.

    images/download/attachments/284926734/image2018-1-16_14-13-49.png
  3. If you entered a value for the Konica Minolta Dispatcher Phoenix Web URL field in System Configuration, the new menu item "Dispatcher Phoenix" (under the section Integration) will be shown in Dispatcher Paragon main menu
    images/download/thumbnails/284926734/image2018-5-16_14-56-26.png

Verifying terminal applications

  1. Create a device in Dispatcher Paragon. Make sure to choose Dispatcher Paragon Terminal Application - 2nd Gen. with Konica Minolta theme as the terminal mode.

    1. Save the changes and wait for the terminal to install.

  2. Check that the device from step 1 is present in Dispatcher Phoenix.

  3. Edit the device in Dispatcher Phoenix and in the Authentication tab choose the option Use MFD provided username to log in. As a value of the Windows Domain field, fill in the directory service domain. The directory service domain must be the same that was used for the LDAP integration in Dispatcher Paragon.

    1. Save the changes.

  4. In Dispatcher Phoenix, register the MFD (install the Scan application on the terminal).

  5. Access the MFD and log in to the terminal application (using the Dispatcher Paragon authentication application installed on the MFD with the user present in Dispatcher Paragon).

    1. On the MFD, open the Dispatcher Paragon print application.

    2. Tap the button to switch to the Dispatcher Phoenix scan application (see Dispatcher Paragon - Print Application for more details).

    3. Switching application should be achievable also from Dispatcher Phoenix to Dispatcher Paragon.

About authentication application

When Dispatcher Paragon and Dispatcher Phoenix are integrated together, there is always a Dispatcher Paragon authentication application used on the terminal. In case the terminal is not installed from Dispatcher Paragon on the MFD, some other type of authentication mechanism should be chosen in Dispatcher Phoenix (e.g. Prompt for username and password authentication).

Expert settings

There are additional configuration options in Dispatcher Paragon that can be done, but these do not affect the basic integration.

  1. Log in to Dispatcher Paragon Management Interface as a privileged user (admin).

  2. Go to System > Configuration page, in Expert mode:

    1. Integration API > Difference between Dispatcher Paragon and Dispatcher Phoenix system times: Threshold in seconds of the acceptable time difference before the status of the Dispatcher Phoenix service is shown as Warning (for more information about the feature see Management Interface - Dashboard, section System Services).

    2. Integration API > Setting up an interval for LDAP settings synchronization with Konica Minolta Dispatcher Phoenix : this CRON rule defines an interval between periodic LDAP settings fetch requests done by Dispatcher Phoenix.

    3. Terminal UI > Dispatcher Paragon application name has to be set to value APP.