Skip to main content
Kofax

AutoStore and Konica-Minolta Combined Client - Using IIS to Host Web Services

3023471

Information: 

In a default installation configuration, the AutoStore server hosts the Konica Minolta iOption Panel Client web application. To provide a level of isolation from processing and route components, the web application can be separated and run under a separate host process.

The panel client can be hosted under a Windows Service named ‘Nuance.WebHost’ or Internet Information Services (IIS.) It is strongly recommended the client web application be hosted under IIS when using the Konica-Minolta Combined Client in a production environment to take advantage of features such memory management, high availability, tracing and general Microsoft support.

This article outlines the process for hosting the KM iOption panel client under IIS.

IIS Configuration Preparation

Disable the AutoStore Web Server

To prevent the AutoStore application from initializing the web server and consequently locking up port 3348 we must disable the default behavior within the ‘NSi.AutoStore.KonicaCapture.dll.config’ file.

  1. Stop AutoStore Server
  2. Browse to the AutoStore folder, typically ‘C:\Program Files (x86)\Notable Solutions\AutoStore 7.’ (Adjust the path if non-default or for ControlSuite)
  3. Edit ‘NSi.AutoStore.KonicaCapture.dll.config
  4. Find disableWebServer="false" and change it to disableWebServer="true"

Add Role for Web Server (IIS)

·         Launch the Add Roles and Features Wizard

·         Under Server Roles select Web Server (IIS)

·         Click Next.

·         Beyond the default settings, select the following features:

o   Application Initialization

o   ASP.NET 4.5 (or newer, depending on the Server OS version)

o   ISAPI Extensions

o   ISAPI Filters

·         Click Next

·         Under Features select ASP.NET 4.5 (or newer)

·         Click Next until you get to Confirmation and click Install

Use a Windows PowerShell command to verify IIS installed features.

PS> get-windowsfeature

The IIS section should look as follows:

clipboard_e6fce7cf252dd16ab1372d20f174cb607.png

Configure the Kofax Konica Minolta Combined Client (CC) Web Application

  • ·         Launch the IIS manager
  • ·         Right click Application Pools and select Add Application Pool.
  • ·         Add an application pool of ‘Managed pipeline mode’ type of ‘Classic’ and call it “KMiOption”.
  • ·         Right click on the KMiOption application pool and select Advanced Settings.
  • ·         Set the Start Mode to AlwaysRunning
  • ·         Set the Idle Time-out (minutes) to 0 (no timeout)
  • ·         Set the Identity to LocalSystem.
  • o Alternatively give write permission to KonicaPanelClient\Logs folder to IIS AppPool user: IIS AppPool\DefaultAppPool

clipboard_e5281359459f9af630f6e72660d9c8c02.png

clipboard_ec1b2387f6073b1d714eeacd409764df0.png

clipboard_ed088b681d579371c7ac1fc0e0d053747.png

Under the advanced settings for the application pool, scroll down to the “Recycling” section and set “Disable Overlapped Recycle” to “True.”

**WARNING**

Failure to set this configuration will result in a port collision of the OpenAPI application ports 13351 and 13353, causing the service to go down after the default interval of 1740 minutes (29 hours.) If the OpenAPI service goes down, users receive error “Connection timed out. Please wait a moment and then try again” when attempting to login.

clipboard_ed4572d55f3ba327bacfca0f32d399895.png

·         Additional recycling configuration - To reduce the impact of client session termination during a recycle event, we must configure Recycling to occur at a Specific Time, and disable recycling on a regular interval by setting it to 0.

clipboard_efaeb3469237d70c37eb8a2c584d0decb.png

·         Next, right click on Sites and select Add Website - Screenshot

·         Set the name to Kofax KM CC

·         Set the Application Pool to KMiOption

·         Set the Physical path to C:\Program Files (x86)\Notable Solutions\AutoStore 7\KonicaPanelClient (adjust as needed if the path is different)

·         Set IP address to “All Unassigned” and set the port to 3348 (Or the web application port configured in AutoStore component and DRS).

NOTE: If using https, change the protocol from http to https and provide the security certificate when prompted

·         Click OK

·         Click on Advanced Settings - Screenshot

·         Set Preload Enabled to True.

clipboard_e34e6a51ea1a37c5052066430200794b4.png

Remove NSiDSPicker Assembly

The NSiDSPicker.dll is not used by the website and is a 32-bit assembly. Leaving this assembly in place, will cause an ASP.NET error when it tries to load it within the 64-bit process space.

1.    Right Click on the new web site and select Explore

2.    Browse into the Bin folder.

3.    Look for nsidspicker.dll. If it is there, rename it as nsidspicker.dll.bak.

If the NSIDSPicker is NOT removed, an error like the following may appear.

clipboard_e50bf219e2c93c977dcce2c1ec1f8d360.png

Create a Windows Task to “Ping” the Web Server

Purpose of the “Ping”

The KM iOption web server hosts two sub-services used by the KM panel for OpenAPI requests. A user may swipe their badge to login at the MFP prior to the web server host being initialized. Therefore, a heartbeat “ping” is required to keep the web server active and initialized.

In high availability environments, this can be accomplished by a load balancer when it checks for the availability of the service. Configure it to use this url: http(s)://<server address>:3348/Common/Ping.

Alternatively, this can be accomplished with a Windows task that issues a “ping” command every 60 seconds. 

The ping can be issued via PowerShell using the command:

http:

powershell -command "& {&'Invoke-WebRequest' -Uri 'http://<server address>:3348/Common/Ping'}"

https:

     powershell -command "& {&'Invoke-WebRequest' -Uri 'https://<server address>:3348/Common/Ping'}"
Create a Windows Scheduled “Ping” Task

1.    Launch Windows Task Scheduler.

2.    Create a Basic Task.

3.    Name it “Ping_Kofax_KM_CC.

4.    Keep the defaults until you get to action tab “Start a Program

5.    In the Program/script field enter powershell

6.    In the Add arguments (optional) text box, include a command line switch to invoke the request to the web client. Copy and paste the below command into the text box and subsequently replace with the place holder with the IP address of the AutoStore server.  Use the appropriate line for http or https.


        -command "& {&'Invoke-WebRequest' -Uri 'http://<AutoStoreServerIPaddress>:3348/Common/Ping'}"

OR

-command "& {&'Invoke-WebRequest' -Uri 'https://<AutoStoreServerIPaddress>:3348/Common/Ping'}"

clipboard_ece63a6198d62052027719e972f04d605.png

7.    Complete the creation of the task.

8.    Find your task and bring up its properties, General tab.

9.    Check “Run whether user is logged on or not.”

10. Check “Run with highest privileges.”

11. Go to the Triggers tab

12. Edit the default trigger that was created for this task.

13. Check “Repeat task every:

14. In the drop-down field, manually type in “1 minute”.

15. In the “For a duration of:” field select “Indefinitely”.

16. Click OK until you are prompted for user credentials.

17. Enter the credentials of an administrator on this server.

18. To start it the first time, select your task and click Run

NOTE:

When using https, the ping is required. When using http, the use of IIS Application Initialization has deprecated this. Completing this configuration and leaving the “ping” schedule in place will not have adverse effects.

Configure IIS Logging

Default IIS Logging - Windows Server 2012 R2 (or later)

The default installation of IIS HTTP Logging does not include “Bytes Sent” or “Bytes Received.” We wish to capture these additional fields within the log file.

Configure Additional Log Fields (Bytes sent/received)

Load the Internet Information Services (IIS) Manager by navigating to the “Server Manager.” Alternately, load IIS Manager by typing “inetmgr” from Windows “Run” or “Search.”

clipboard_e89f97089cc5ee35da51673616637803b.png
On the Connections pane on the left, click the appropriate web site hosting the Konica Minolta iOption panel client.

Under IIS configuration in the right-hand pane, double-click “Logging.”

clipboard_e8d90d2288e6d0682c43daabacda94fe0.png

Under the “Log File” section, click “Select Fields…

Ensure that “Bytes Sent (sc-bytes)” and “Bytes Received (cs-bytes)” are selected. Click “OK.”

clipboard_e15c64e55a6046c860a28d4e6c1e76f32.png
Click “Apply” under the “Actions” on the far right-hand side pane.

clipboard_ea57c23f72f9773036f15d8824bcfe00e.png

Validate

Now, start up the AutoStore service, reboot any Konica-Minolta MFPs and test to ensure that everything is working as expected.

 

Applies to:  

Product Version
AutoStore 7
AutoStore 8
ControlSuite 1

 

 

  • Was this article helpful?