Xerox® Extensible Interface Platform™ (EIP) Device Client v1.1 Readme

Product: AccuRoute 3.01
Release date: September2010
Version: 09282010 1019
©2010 by Omtool, Ltd. All rights reserved

Introduction

Embedded AccuRoute for Xerox Extensible Interface Platform (EIP) Device Client v1.1 contains new features as well as updates to existing features. For a list of all new features and enhancements, see Release Notes section.

The Embedded AccuRoute for Xerox EIP Device Client is a powerful integration platform that enables device users to access AccuRoute’s advanced routing and distribution features through buttons displayed on the touch screen control panel of the Xerox Multifunction Printer devices. It is engineered by Omtool, a leading provider of document routing products and services.

The Embedded AccuRoute for Xerox EIPDevice Client v1.1 is available as a separate download for purchase. When you purchase the software, you are given a special login which you can use to download the software from the Omtool website. Contact Omtool sales for more information.

Topics:

Xerox Device Requirements

Current supported devices are:

Web Service Requirements

The Xerox device where you will install Xerox Extensible Interface Platform (EIP) Device Client v1.1 should have the following Web Services started and running:

To verify and enable the required webservices:

  1. Open a web browser and go to the device administration url: http://deviceipaddress/

  2. Login to the device.

  3. Click the Properties tab.

  4. Click General Setup > Extensible Service Setup.

  5. Click HTTP Web Services.

  6. Verify all required service are enabled. If not, check the box beside the required services to enable them.

  7. Click Close.

Note: The General Setup >> Extensible service setup location can be different depending on the device model. Consult the device documentation on where it is located in the device you are configuring.

AccuRoute 2.3 Installation and Requirements

Server Requirements

Embedded AccuRoute for Xerox EIP Device Client v1.1 requires:

Note: .NET 2.0 is automatically installed on your machine if it is not found during the Embedded AccuRoute for  Xerox EIP Device Client installation.  

Installation Requirements

To use the FTP protocol for routing documents, configure FTP as part of IIS 6.0- The Windows Server 2003 Standard Edition CD is needed for this setup.

To configure FTP as part of IIS 6.0 follow these steps:

  1. Go to Start > Control Panel > Add Remove Programs.

  2. Select Add Remove Windows Components > Application Server and click Details.

  3. Select Internet Information Services (IIS) and click Details.

  4. Enable File Transfer Protocol (FTP) Service.

  5. Click OK, OK, Next . Browse to the Windows 2003 CD location if needed.

Note about using 64 bit machines:

For 64 bit systems, configure the following.

Configure IIS to run 32-bit applications

To configure IIS to run 32 bit applications:

  1. Open a command prompt, and enter:

cscript.exe C:\InetPub\adminscripts\adsutil.vbs set W3SVC/AppPools/Enable32bitAppOnWin64 1

  1. Press Enter.

  2. Perform an iisreset.

For information on related command to switch modes, see http://support.microsoft.com/kb/894435.

Configure Microsoft.Net

To register asp.net in 32 bit mode:

  1. Open a command prompt, and enter:

C:\Windows\Microsoft.net\Framework\v2.0.50727\aspnet_regiis.exe -i

  1. Press Enter.

This is necessary to make sure the scripts are updated.

Configuring File Transfer and File Postings

  1. Now to go Web Sites > Default Web Site > OmtoolWebAPI.

  2. Select FileTransfer, right click and select Properties from the drop down menu.

  3. Verify that the Write checkbox is enabled.

  4. Similarly, select FilePostings, right click and select Properties.

  5. Verify that the Write checkbox is enabled.

  6. In the Web Service Extensions, verify you can see "ASP.Net V2.0.50727" and "ASP.Net v2.0.50727(32 bit)" entries and that both are enabled.

Note: If you do not see it you can create it, by "Add a new webservice extension.." and in file name browse to "C:\windows\microsoft.net\framework64\v2.0.50727\aspnet_isapi.dll" and allow it.

  1. Reboot your system.

Installation

This section includes:

Note about upgrade

If you have Xerox Extensible Interface Platform (EIP) Device Client v1.0, follow the instructions below and install Xerox Extensible Interface Platform (EIP) Device Client v1.1. This will automatically uninstall v1.0.

If you want to retain the previous configuration settings, you can manually copy the configuration.xml file to a different location. When installing v1.1, refer to the xml file and manually enter the configuration values in the setup screens.

Instructions for downloading Embedded AccuRoute for Xerox EIP v1.1 update

Xerox Extensible Interface Platform (EIP) Device Client v1.1 is available to Omtool customers as a separate purchase for an additional fee. For more information on how to purchase this application, contact Omtool sales.

Follow the instructions in the procedure below to download the update from the Omtool website.

To download the Embedded AccuRoute for Xerox EIP v1.1 update:

  1. Open Internet Explorer browser and go to http://www.omtool.com/support.

  2. Log in using the login credentials sent to you by customer support when you purchased Xerox Extensible Interface Platform (EIP) Device Client v1.1.

  3. Download the module and save it to a local drive.

  4. Extract the files to a location on your AccuRoute server.

Installing Embedded AccuRoute for Xerox EIP v1.1 update on the AccuRoute server

To install the Xerox EIP v1.1 update:

  1. Go to the location where you saved ARS2.3-XeroxEIP1.1.exe file.

  2. Double click the executable.

The Embedded AccuRoute for Xerox EIP 1.1 page opens prompting you to extract and install the update.

  1. Click Continue to extract the files to a temporary location on your system.

When extraction is complete, the Copy Embedded AccuRoute for Xerox EIP 1.1 page opens.

  1. Click Next.

 The Detect Components page opens listing the components that will be updated.

  1. Click Next to install the update.

 A progress bar shows the status of the installation. When the installation is complete, you see the Installation Completed page.

  1. Click Finish to exit the wizard.

The XeroxEIP directory containing the setup files for Xerox Extensible Interface Platform (EIP) Device Client v1.1 is created in \Program Files\Omtool\Omtool Server\Clients directory.

Installing Embedded AccuRoute for Xerox Extensible Interface Platform (EIP) Device Client v1.1

To install Xerox Extensible Interface Platform (EIP) Device Client v1.1:

  1. On the AccuRoute server system, navigate  to \Program Files\Omtool\Omtool Server\Clients\XeroxEIP directory.

  2. Click setup.exe. The InstallShield Wizard configures your system and shows the Welcome message.

  3. Click Next. The Embedded AccuRoute for Xerox EIP Configuration page opens.

  4. In the AccuRoute text box, enter the name or the IP Address of the AccuRoute server.

  5. In the Authentication text box, enter the Active Directory or the LDAP Server name or its IP Address.

  6. Select the Authentication Type. The options are:

  7. Device - Select this option if you want users to use authentication configured for the device.
    Before users can use device authentication, the device should be modified to prompt for a username password.

  8. Non-Authenticated Email - Select this option if you want the device user to provide a valid email address as login credential. This email must be configured in Active Directory. No password is required for credential verification.

  9. PIN - Select this option if you want the device user to provide a User PIN. This PIN must be configured in Active Directory, no password is required for credential verification.

  10. PIN with Password - Select this option if you want the device user to provide a User PIN. The user must also provide the password associated with the PIN for successful login. This PIN and the password must be configured in Active Directory.

  11. Login with Password - Select this option if you want the device user to use a Windows login name along with the password as login credentials.

Note: If a device user selects Device authentication on the device, that selection will take precedence over whatever selection you make here.  

  1. In the Default Domain text box, enter the full domain name of the system.

  2. In the Filing Protocol section, select a protocol. The options are:

  3. FTP

  4. HTTP

  5. HTTPS

  6. SMB

  1. Click Next. You are prompted for information depending on your protocol selection. Use the information in the table below and fill out the required information.

Protocol

Required Information

FTP

FTP Login credentials:

Username - The name of the person with access to the FTP folder.
Password - Password associated with the user name.

FTP details:

Server - The name of the FTP server.
Folder - The name of the folder where the scan jobs will be routed.

See also, Configuring FTP credentials in the configuration file for information and examples for various FTP scenarios like FTP to root , FTP to a folder and Anonymous user versus Network user.

HTTP

HTTP details:

Click Select Folder and browse and select the folder where the scan jobs will be routed when using HTTP.

HTTPS

HTTPS details:

Click Select Folder and browse and select the folder where the scan jobs will be routed when using HTTPs.

SMB

SMB Login credentials:

Username - The name of the person with access to the SMB server. This should be in the format: Domain\Username.
Password - Password associated with the user name.

SMB details:

Server - The name of the SMB server.
Folder - The name of the folder where the scan job will be routed to when using SMB protocol.

  1. Click Next. The Product Options page opens.

  2. Select the AccuRoute scanning features you want to use.
    If you choose the Public Distributions feature, you must specify an email address. All Embedded Directives for this user that are published as public will be listed under Public Distribution options. If you do not specify the email address, the Next button will not become active.

  1. Click Next. The Ready to Install page opens.

  1. Click Install to begin installation. .

 A progress bar shows the status of the installation. When the installation is complete you see the Installation Completed page.

  1. Click Finish to exit the wizard.

  2. Continue to Registering Omtool EIP client to roll out the buttons to the device.

Note about uninstalling Xerox Extensible Interface Platform (EIP) Device Client

Before uninstalling Xerox Extensible Interface Platform (EIP) Device Client, you must unregister the devices where the AccuRoute buttons were pushed out to.

When you register a Xerox device (see Registering Omtool EIP client to roll out the buttons to the device) configuration values are written to an xml file in the configuration directory. During unregistration, this file must be accessible so that the AccuRoute buttons can be removed from the device. In case the Xerox Extensible Interface Platform (EIP) Device Client was removed from the web server before unregistering the device, the only way to remove the AccuRoute software from the device is to use a Xerox utility tool that is provided by Xerox.

Required Configuration

This section includes:

Allowing ASP.NET for IIS 6.0

ASP.NET is prohibited by default. You must allow ASP.NET in order to view .asp pages.

To allow ASP.NET:

  1. Click Start > Administrative Tools > Internet Information Services (IIS) Manager.

  2. In the left pane, expand the local computer.

  3. Click on Web Service Extensions.
    The Web Service Extensions page opens listing all web service extensions, including ASP.NET. By default the status of ASP.NET is Prohibited.

  4. Select ASP.NET v2.0.50727

  5. Click Allow.

Allowing "Everyone” full access permission to configuration directory

To allow “Everyone” full access permission, follow these steps:

  1. Navigate to C:\Program Files\omtool\XeorxEIP\Configuration.

  2. Right click on the Configuration folder. Select Properties.

  3. In the Properties page, click on the Security tab.

  4. Enter Everyone. Click Check Names if you need to resolve the name. Click OK to add the user.

  5. Go to Permissions for Everyone section and allow Everyone full permission.

  6. Click OK to close Configuration Properties page.

Registering Omtool EIP client to roll out the buttons to the device

To register Xerox Extensible Interface Platform (EIP) Device Client, follow these steps:

  1. In a browser open the following link: http://localhost/OmtoolXeroxEIP/RegistrationClient.aspx.
    The AccuRoute Xerox EIP Device Loader page opens.

  2. Click New. The Add Device page opens.

  3. Enter the following:

  4. Name – Friendly name of the device.

  5. Device Address – The IP address of the device

  6. Device User Name – Name assigned to the Xerox device admin.

  7. Device Password – Password assigned to the Xerox device administrator.

  8. Group – Any property group assigned to the device

  9. SNMP Community String – Value is public unless a specific string needs to be specified.

  10. Check the Use SSL checkbox.

  11.  Click OK.

Note: To register Omtool EIP client for additional devices, follow the steps outlined above for each device.

Creating Routing Rules on the AccuRoute Server

Create the following outbound rules for Xerox Extensible Interface Platform (EIP) Device Client:

  1. If destination email address is routingsheet, then route to the Embedded Directives manager and use the default “Scan documents for Embedded Directives”.

  2. If destination email address is myaccuroute, then route to the Embedded Directives manager and use the “Use originator” option listed under “My AccuRoute”.  

  3. If destination email address is accuroute, then route to Embedded Directives manager and use sender specified Embedded Directives.

  4.  If Embedded Directive is *, use sender specified directive.

For instructions on how to create routing rules, click here.

Required configuration for AccuRoute v2.3 server

If you are using AccuRoute server v2.3, you must apply patch 12340 to the Embedded AccuRoute for Intelligent Devices (Omtool ISAPI web server extension).

To download patch 12340:

  1. Go to the same location from where you downloaded the Embedded AccuRoute for Xerox EIP v1.1 device client.

  2. Log in using your customer number issued by Omtool.

  3. Locate the Patch 12340 in the Additional Components section.

  4. Download the patch and save it to a location on the system running the Embedded AccuRoute for Intelligent Devices (Omtool ISAPI web server extension).

To apply the patch:

  1. Log in to the system running the AccuRoute for Intelligent Devices (Omtool ISAPI web server extension).

  2. Stop the World Wide Publishing Service.

  3. Make a back up of the existing OmISAPIU.dll file located in C:\Program Files\Omtool\Omtool Server\WebAPI\OmtoolWebAPI\Scripts directory.

  4. Copy the patch file OmISAPIU.dll to the following location: C:\Program Files\Omtool\Omtool Server\WebAPI\OmtoolWebAPI\Scripts directory.

  5. Restart  the World Wide Publishing Service.

Configuring FTP credentials in the configuration file

This section includes:

Check the type of FTP configuration you should be using in your setup and go to one of the procedures listed below.

Anonymous access to FTP Server root

  1. Navigate to C:\ProgramFiles\OmtoolXeroxEIP\Configuration folder and open Default.txt file.

  2. Verify contents of the file.

  3. UserNetworkFilingLoginName should be anonymous

  4. Document Path should be “/”

  5. Repository Volume and other entries should be blank.

  6. Repository Name contains the FTP server IP followed by the FTP Port.

Here is an example:

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "anonymous";

      string UserNetworkFilingLoginID = "";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.00.0.000:21";

      string DocumentPath = "/";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

Domain \\username access to FTP Server root

  1. Navigate to C:\ProgramFiles\OmtoolXeroxEIP\Configuration folder and open Default.txt file.

  2. Verify contents of the file.

  3. UserNetworkFilingLoginName should be the user name selected

  4. Document Path should be “/”

  5. Repository Volume and other entries should be blank.

  6. Repository Name contains the FTP server IP followed by the FTP Port

Note: The username should have two back slashes (\\) and should be of the format DomainName\\UserName.

Here is an example:

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "DomainName\\jsmith";

      string UserNetworkFilingLoginID = "system";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.00.0.000:21";

      string DocumentPath = "/";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

Domain \\username access to FTP folder under FTP Server root

If you have created your own FTP Folder under FTP Root then the name of the folder should be given in the Document Path node. In the following example, “DemoScans” is a FTP Folder created under FTP Root so the document path = “/DemoScans”.

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "Engineering\\jsmith";

      string UserNetworkFilingLoginID = "system";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.16.5.127:21";

      string DocumentPath = "/DemoScans";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

 

AccuRoute 3.01 Installation and Requirements

Server Requirements

Embedded AccuRoute for Xerox EIP Device Client v1.1 requires:

Note: .NET 2.0 is automatically installed on your machine if it is not found during the Embedded AccuRoute for  Xerox EIP Device Client installation.  

Installation Requirements

To use the FTP protocol for routing documents, configure FTP as part of IIS

To configure FTP as part of IIS 6.0  follow these steps:

  1. Go to Start > Control Panel > Add Remove Programs.

  2. Select Add Remove Windows Components > Application Server and click Details.

  3. Select Internet Information Services (IIS) and click Details.

  4. Enable File Transfer Protocol (FTP) Service.

  5. Click OK, OK, Next . Browse to the Windows 2003 CD location if needed.

To configure FTP as part of IIS 7.0  follow these steps:

Note about using 64 bit machines:

For 64 bit systems, configure the following.

Configure IIS to run 32-bit applications

To configure IIS to run 32 bit applications:

  1. Open a command prompt, and enter:

cscript.exe C:\InetPub\adminscripts\adsutil.vbs set W3SVC/AppPools/Enable32bitAppOnWin64 1

  1. Press Enter.

  2. Perform an iisreset.

For information on related command to switch modes, see http://support.microsoft.com/kb/894435.

Configure Microsoft.Net

To register asp.net in 32 bit mode:

  1. Open a command prompt, and enter:

C:\Windows\Microsoft.net\Framework\v2.0.50727\aspnet_regiis.exe -i

  1. Press Enter.

This is necessary to make sure the scripts are updated.

Configuring File Transfer and File Postings

  1. Now to go Web Sites > Default Web Site > OmtoolWebAPI.

  2. Select FileTransfer, right click and select Properties from the drop down menu.

  3. Verify that the Write checkbox is enabled.

  4. Similarly, select FilePostings, right click and select Properties.

  5. Verify that the Write checkbox is enabled.

  6. In the Web Service Extensions, verify you can see "ASP.Net V2.0.50727" and "ASP.Net v2.0.50727(32 bit)" entries and that both are enabled.

Note: If you do not see it you can create it, by "Add a new webservice extension.." and in file name browse to "C:\windows\microsoft.net\framework64\v2.0.50727\aspnet_isapi.dll" and allow it.

  1. Reboot your system.

Installation

This section includes:

Note about upgrade

If you have Xerox Extensible Interface Platform (EIP) Device Client v1.0, follow the instructions below and install Xerox Extensible Interface Platform (EIP) Device Client v1.1. This will automatically uninstall v1.0.

If you want to retain the previous configuration settings, you can manually copy the configuration.xml file to a different location. When installing v1.1, refer to the xml file and manually enter the configuration values in the setup screens.

Instructions for downloading Embedded AccuRoute for Xerox EIP v1.1 update

Xerox Extensible Interface Platform (EIP) Device Client v1.1 is available to Omtool customers as a separate purchase for an additional fee. For more information on how to purchase this application, contact Omtool sales.

Follow the instructions in the procedure below to download the update from the Omtool website.

To download the Embedded AccuRoute for Xerox EIP v1.1 update:

  1. Open Internet Explorer browser and go to http://www.omtool.com/support.

  2. Log in using the login credentials sent to you by customer support when you purchased Xerox Extensible Interface Platform (EIP) Device Client v1.1.

  3. Download the module and save it to a local drive.

  4. Extract the files to a location on your AccuRoute server.

Installing Embedded AccuRoute for Xerox EIP v1.1 update on the AccuRoute server

To install the Xerox EIP v1.1 update:

  1. Go to the location where you saved ARS2.3-XeroxEIP1.1.exe file.

  2. Double click the executable.

The Embedded AccuRoute for Xerox EIP 1.1 page opens prompting you to extract and install the update.

  1. Click Continue to extract the files to a temporary location on your system.

When extraction is complete, the Copy Embedded AccuRoute for Xerox EIP 1.1 page opens.

  1. Click Next.

 The Detect Components page opens listing the components that will be updated.

  1. Click Next to install the update.

 A progress bar shows the status of the installation. When installation is complete, you see the Installation Completed page.

  1. Click Finish to exit the wizard.

The XeroxEIP directory containing the setup files for Xerox Extensible Interface Platform (EIP) Device Client v1.1 is created in \Program Files\Omtool\Omtool Server\Clients directory.

Installing Xerox Extensible Interface Platform (EIP) Device Client v1.1

To install Xerox Extensible Interface Platform (EIP) Device Client v1.1:

  1. On the AccuRoute server system, navigate  to \Program Files\Omtool\Omtool Server\Clients\XeroxEIP directory.

  2. Click setup.exe. The InstallShield Wizard configures your system and shows the Welcome message.

  3. Click Next. The Embedded AccuRoute for Xerox EIP Configuration page opens.

  4. In the AccuRoute text box, enter the name or the IP Address of the AccuRoute server.

  5. In the Authentication text box, enter the Active Directory or the LDAP Server name or its IP Address.

  6. Select the Authentication Type. The options are:

  7. Device - Select this option if you want users to use authentication configured for the device.
    Before users can use device authentication, the device should be modified to prompt for a username password.

  8. Non-Authenticated Email - Select this option if you want the device user to provide a valid email address as login credential. This email must be configured in Active Directory. No password is required for credential verification.

  9. PIN - Select this option if you want the device user to provide a User PIN. This PIN must be configured in Active Directory, no password is required for credential verification.

  10. PIN with Password - Select this option if you want the device user to provide a User PIN. The user must also provide the password associated with the PIN for successful login. This PIN and the password must be configured in Active Directory.

  11. Login with Password - Select this option if you want the device user to use a Windows login name along with the password as login credentials.

Note: If a device user selects Device authentication on the device, that selection will take precedence over whatever selection you make here.  

  1. In the Default Domain text box, enter the full domain name of the system.

  2. In the Filing Protocol section, select a protocol. The options are:

  3. FTP

  4. HTTP

  5. HTTPS

  6. SMB

  1. Click Next. You are prompted for information depending on your protocol selection. Use the information in the table below and fill out the required information.

Protocol

Required Information

FTP

FTP Login credentials:

Username - The name of the person with access to the FTP folder.
Password - Password associated with the user name.

FTP details:

Server - The name of the FTP server.
Folder - The name of the folder where the scan jobs will be routed.

See also, Configuring FTP credentials in the configuration file for information and examples for various FTP scenarios like FTP to root , FTP to a folder and Anonymous user versus Network user.

HTTP

HTTP details:

Click Select Folder and browse and select the folder where the scan jobs will be routed when using HTTP.

HTTPS

HTTPS details:

Click Select Folder and browse and select the folder where the scan jobs will be routed when using HTTPs.

SMB

SMB Login credentials:

Username - The name of the person with access to the SMB server. This should be in the format: Domain\Username.
Password - Password associated with the user name.

SMB details:

Server - The name of the SMB server.
Folder - The name of the folder where the scan job will be routed to when using SMB protocol.

  1. Click Next. The Product Options page opens.

  2. Select the AccuRoute scanning features you want to use.
    If you choose the Public Distributions feature, you must specify an email address. All Embedded Directives for this user that are published as public will be listed under Public Distribution options. If you do not specify the email address, the Next button will not become active.

  1. Click Next. The Ready to Install page opens.

  1. Click Install to begin installation. .

 A progress bar shows the status of the installation. When installation is complete you see the Installation Completed page.

  1. Click Finish to exit the wizard.

  2. Continue to Registering Omtool EIP client to roll out the buttons to the device.

Note about uninstalling Xerox Extensible Interface Platform (EIP) Device Client

Before uninstalling Xerox Extensible Interface Platform (EIP) Device Client, you must unregister the devices where the AccuRoute buttons were pushed out to.

When you register a Xerox device (see Registering Omtool EIP client to roll out the buttons to the device) configuration values are written to an xml file in the configuration directory. During unregistration, this file must be accessible so that the AccuRoute buttons can be removed from the device. In case the Xerox Extensible Interface Platform (EIP) Device Client was removed from the web server before unregistering the device, the only way to remove the AccuRoute software from the device is to use a Xerox utility tool that is provided by Xerox.

Required Configuration

This section includes:

Allowing ASP.NET in IIS 6.0

ASP.NET is prohibited by default. You must allow ASP.NET in order to view .asp pages.

To allow ASP.NET:

  1. Click Start > Administrative Tools > Internet Information Services (IIS) Manager.

  2. In the left pane, expand the local computer.

  3. Click on Web Service Extensions.
    The Web Service Extensions page opens listing all web service extensions, including ASP.NET. By default the status of ASP.NET is Prohibited.

  4. Select ASP.NET v2.0.50727

  5. Click Allow.

Allowing ASP.NET in IIS 7.0

To allow ASP.NET:

  1. Click Start > Administrative Tools > Internet Information Services (IIS) Manager.

  2. In the Connections pane, expand the local computer.

  3. In the Features view, select "ISAPI and CGI Restrictions".

  4. In the Actions view, select "Open Feature"
    The Web Service Extensions page opens listing all web service extensions, including ASP.NET.

  5. Select ASP.NET v2.0.50727

  6. Click Allow.

 

Allowing "Everyone” full access permission to configuration directory

To allow “Everyone” full access permission, follow these steps:

  1. Navigate to C:\Program Files\omtool\XeorxEIP\Configuration.

  2. Right click on the Configuration folder. Select Properties.

  3. In the Properties page, click on the Security tab.

  4. Enter Everyone. Click Check Names if you need to resolve the name. Click OK to add the user.

  5. Go to Permissions for Everyone section and allow Everyone full permission.

  6. Click OK to close Configuration Properties page.

Registering Omtool EIP client to roll out the buttons to the device

To register Xerox Extensible Interface Platform (EIP) Device Client, follow these steps:

  1. In a browser open the following link: http://localhost/OmtoolXeroxEIP/RegistrationClient.aspx.
    The AccuRoute Xerox EIP Device Loader page opens.

  2. Click New. The Add Device page opens.

  3. Enter the following:

  4. Name – Friendly name of the device.

  5. Device Address – The IP address of the device

  6. Device User Name – Name assigned to the Xerox device admin.

  7. Device Password – Password assigned to the Xerox device administrator.

  8. Group – Any property group assigned to the device

  9. SNMP Community String – Value is public unless a specific string needs to be specified.

  10. Check the Use SSL checkbox.

  11.  Click OK.

Note: To register Omtool EIP client for additional devices, follow the steps outlined above for each device.

Required configuration for AccuRoute v3.01 server installed in Windows 2008 system

If your AccuRoute server is v3.01 and is installed on a Windows 2008 system, configure the Configuration.xml file and change all instances of "FilePostings" with "FileTransfer".

To modify the configuration.xml file:

  1. Navigate to C:\Program Files\omtool\XeorxEIP\Configuration folder and open the Configuration.xml file in this folder using an xml editor like Notepad.

  2. Find all instances of <FileTransferURL> node.

  3. Replace instances of FilePostings with FileTransfer under each <FileTransferURL> node.

  4. Save your changes to the configuration.xml file. .

 

Configuring FTP credentials in the configuration file

This section includes:

Check the type of FTP configuration you should be using in your setup and go to one of the procedures listed below.

Anonymous access to FTP Server root

  1. Navigate to C:\ProgramFiles\OmtoolXeroxEIP\Configuration folder and open Default.txt file.

  2. Verify contents of the file.

  3. UserNetworkFilingLoginName should be anonymous

  4. Document Path should be “/”

  5. Repository Volume and other entries should be blank.

  6. Repository Name contains the FTP server IP followed by the FTP Port.

Here is an example:

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "anonymous";

      string UserNetworkFilingLoginID = "";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.00.0.000:21";

      string DocumentPath = "/";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

Domain \\username access to FTP Server root

  1. Navigate to C:\ProgramFiles\OmtoolXeroxEIP\Configuration folder and open Default.txt file.

  2. Verify contents of the file.

  3. UserNetworkFilingLoginName should be the user name selected

  4. Document Path should be “/”

  5. Repository Volume and other entries should be blank.

  6. Repository Name contains the FTP server IP followed by the FTP Port

Note: The username should have two back slashes (\\) and should be of the format DomainName\\UserName.

Here is an example:

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "DomainName\\jsmith";

      string UserNetworkFilingLoginID = "system";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.00.0.000:21";

      string DocumentPath = "/";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

Domain \\username access to FTP folder under FTP Server root

If you have created your own FTP Folder under FTP Root then the name of the folder should be given in the Document Path node. In the following example, “DemoScans” is a FTP Folder created under FTP Root so the document path = “/DemoScans”.

[service xrx_svc_file]

 {

enum_filingpolicy DocumentFilingPolicy = NEW_AUTO_GENERATE;

      string UserNetworkFilingLoginName = "Engineering\\jsmith";

      string UserNetworkFilingLoginID = "system";

      enum_filingprotocol FilingProtocol = FTP;

      string RepositoryName = "172.16.5.127:21";

      string DocumentPath = "/DemoScans";

      string RepositoryVolume = "";

      string NDSTree = "";

      string NDSNameContext = "";

......string xrxHTTPServerLocation = "/omtoolXeroxEIP/Xerox.ashx"; boolean ServerValidationReq = FALSE;

 }(XRX_STATUS_COMPLETED)

end

Configuring Windows 2008 system to overcome IIS v7.0 permissions issue

If the AccuRoute server is installed on a Windows 2008 system, you will need to modify the applicationhost.config file to allow scanning of large files from the Xerox  device. Windows 2008 systems have IIS v7.0 which has many additional levels of configuration requiring this additional change. Failure to configure will give you the error from the device that HTTP404-Script not found.

To configure the applicationhost.config file:

  1. On the Windows 2008 system, navigate to C:\Windows\System32\inetsrv\config\ directory and open the applicationHost.config file.

  2. Search for

<requestFiltering>

  1. Add the following code:

<requestLimits maxAllowedContentLength="1000000000" />

  1. Restart the Default Web Site.

  2. Retest by scanning a large file from the Xerox device and sending it to the AccuRoute server running on the Windows 2008 system.

Optional Configuration

This section includes:

Configuring use of AddressBook service for LDAP lookups

To configure use of AddressBook service:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Search for the <Search UseABService> node.

  4. Verify the value is set as true.

  5. Save your changes to the configuration file.

  6. Open a command prompt and click Start > Run.

  7. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

During authentication at the device, authentication is done by the AddressBook service.

Configuring prompts

You can configure prompts for Personal and Public Distributions, Routing Sheet, Fax and MyAccuRoute features using the configuration.xml file. For the Public and Personal Distributions features, prompts must be configured in the xml file or on the Omtool Server. The prompts that are configured on the server are also known as Embedded Directive Prompts. For more information in AccuRoute v2.3, see Embedded Directive Prompts.  For more information in AccuRoute v3.01, see the Release Notes, Creating Prompts section.

To configure prompts:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Search for the <Prompts> node.

  4. Enter the following code using the following example as a guideline. In this example, the DMSDocumentName prompt is being set up.

<Prompts>

<DMSDocumentName>

<Display>Settings</Display>

<Label>DMS Document Name:</Label>

<Type MinLength="5" MaxLength="15">Text</Type>

<Instructions>Enter the dms document name</Instructions>

<Values>

<Value internal="" default="true">dmsdocument</Value>

</Values>

<Properties>

<Property override="true" templatetag="false" mapTypeDMS="true">prDMSDocName</Property>

</Properties>

</DMSDocumentName>

  1. Search for the AccuRoute feature that should use this prompt. Only the Routing Sheet, Fax and MyAccuRoute features can use prompts configured in the xml file.

  2. Go to the <Prompts> node under the feature node.

  3. Enter the following code:

<Prompts>

<Prompt>DMSDocumentName</Prompt>

</Prompts>

  1. Save your changes.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

Now when a user goes to the device and scans a document using the AccuRoute feature for which the prompt was configured. a Wizard opens asking for the DMS Document Name. Configuring prompts is useful in environments with multiple child domain under one parent where you need to configure both the child domains by configuring multiple domains and multiple search nodes.

Configuring multiple domains

To configure multiple domains:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Search for the <Domain> node.

  4. Enter the following code:

<Values>

<Value>domain1.yourcompany.com</Value>

<Value>domain2.yourcompany.com</Value>

<Value>domain3.yourcompany.com</Value>

<Value>domain4.yourcompany.com</Value>

</Values>

  1. Save your changes to the configuration file.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

During authentication, the device displays the "Select Domain button. When the user clicks the button, the user is directed to the Domain list page. Once the user selects a domain, authentication proceeds.

Configuring multiple search nodes

To configure multiple search nodes:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Search for the <Search UseABService> node.

  4. Enter the following code just below the line <Search UseABService>

<Server>[IP Address]</Server>

 <Port>389</Port>

 <SearchBase/>

 <Filter/>

 <Username>jsmith@yourcompany.com

 </Username>

 <Password>[password value]</Password>

 <Attributes></Attributes>

 <AttributeName></AttributeName>

</Search>

<Search UseABService="false">

 <Server>[IP Address]</Server>

 <Port>389</Port>

 <SearchBase/>

 <Filter/>

<Username>jsmith1@yourcompany.com

</Username>

 <Password>[password value]</Password>

 <Attributes></Attributes>

 <AttributeName></AttributeName>

</Search>

<Search UseABService="false">

 <Server>[IP Address]</Server>

 <Port>389</Port>

 <SearchBase/>

 <Filter/>

<Username>jsmith2@yourcompany.com

</Username>

 <Password>[password value]</Password>

 <Attributes></Attributes>

 <AttributeName></AttributeName>

</Search>

  1. Configure the values of <Server>, <Username>, and <Password> nodes.

  2. Save your changes to the configuration file.

  3. Open a command prompt and click Start > Run.

  4. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

Now authentication is done by the search nodes that were defined. Authentication is done as soon as the first match is found.

Configuring User PIN

To configure user PIN:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Go to the <Type> node.

  4. Change the value of the node to PIN:

<Type>PIN</Type>

  1. Go to the <User> node.

  2. Change the value of the <Label> node to PIN:

<Label>PIN:</Label>

  1. Save your changes.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

During authentication, the user is prompted to provide the PIN id.

Configuring PIN with Password (for any Active Directory field other than employeeID)

By default, the PIN authentication is validated against the employeeID in the Active Directory. To configure validation against any other Active Directory field, follow the instructions in the procedure below.

To configure Pin with Password (for any Active Directory field other than employeeID):

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Go to the <Filter> node under <Search UseABService="true"> node.

  4. Change the value of the <Filter> node as needed. For example:

<Filter>telephoneNumber</Filter>

  1. Save your changes.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

Configuring device authentication

To configure device authentication:

  1. On the device hard keyboard panel click Access A key.

  2. Enter the default device password. If it does not log you in, contact your system administrator for the new password.

  3. Click Tools then More button till you see the Access Control option.

  4. Click Access Control, then Service Access Control.

  5. Click and select Network authenticated Access.

  6. Click Next and then click Save.

Configuring Auto-logout option

To configure Auto-logout option:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

  3. Go to the <AutomaticLogOut> node. The default value is 0.

  4. Change the default value to30 for example or any other value as required.

  5. Add multiple value tags as shown below:

<AutomaticLogOut>30</AutomaticLogOut>

  1. Save your changes.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

  4. Reboot the device.

Now when a user completes a scan job at the device and the user is at the Scan Completed page , the device will show a count down at the bottom right footer starting at 30 and going down to 1. When the count down reaches 1, the user will be logged out automatically and the display panel will show either the Custom Services page or home page.

Note: This option will log out users only if they are on the Scan Completed page. It does not apply to any other pages.

Configuring one top level button

To configure top level button:

  1. Navigate to Program Files\Omtool\XeroxEIP\Configuration.

  2. Open Configuration.xml for editing.

Go to the <RegistrationType> under <DeviceSpecificSettings> node. The default value is Individual (which will show all the AccuRoute features).

  1. Change the default value to Group:

<RegistrationType>Group</RegistrationType>

  1. Save your changes.

  2. Open a command prompt and click Start > Run.

  3. Enter cmd and then perform an iisreset.
    This is necessary to stop all the website and application pools and restart them. Without this reset, the changes to configuration.xml are not reflected.

 

Release Notes

Enhancements

The release has the following enhancements:

Resolved issues

The release contains the following resolved issues.

Limitations

Additional Information  

Technical articles in the Omtool Knowledge Base provide valuable troubleshooting information and describe issues reported after a release.

To access the Omtool Knowledgebase:

  1. Go to http://www.omtool.com/support.

  2. Log in using your customer number.

  3. Click Knowledge Base.

  4. Search by keyword or article ID, or browse by product.