DocuShare Connect Administration Guide - Fuji Xeroxonlinesupport.fujixerox.com/driver_downloads/DocuShare Connect... · Page v About this Guide This guide provides details regarding

DocuShare® Connect

Administration Guide

Page ii

Fuji Xerox Australia 101 Waterloo Road North Ryde NSW 2113 Copyright 2010 by Fuji Xerox Australia Pty. Limited, A.C.N. 000 341 819. All Rights Reserved. Copyright protection claimed includes all forms and matters of copyrighted material and information now allowed by statutory or judicial law or hereinafter granted, including without limitation, material generated from the software programs that are displayed on the screen such as styles, templates, icons, screen displays, looks, etc. This document is and shall remain the exclusive property of Fuji Xerox Australia and its use is governed by the terms of the applicable license agreement. Xerox

®, the sphere of connectivity design, and DocuShare are registered trademarks or trademarks of Xerox

Corporation in the U.S. and/or other countries. Other company trademarks are also acknowledged. For technical queries please contact the Fuji Xerox Australia Customer Support Centre on 1800 028 962.

Note: By using this document you acknowledge that you have read and agree to the terms and conditions in the DocuShare® Connect Software License Agreement.

Updates This document is subject to continual updating and improvement. You are strongly advised to check the Fuji Xerox website to ensure that you have the most recent version.

Page iii

SOFTWARE LICENCE AGREEMENT THIS AGREEMENT IS PROVIDED TO YOU, THE END USER, IN THE FORM OF AN ELECTRONIC “CLICK-ON” LICENCE, OR A SHRINKWRAP LICENCE. READ THIS ENTIRE AGREEMENT BEFORE YOU EITHER, IN THE CASE OF CLICK ON LICENCE, PROCEED USING THIS PRODUCT, OR IN THE CASE OF A SHRINKWRAP LICENCE, OPEN THIS PACKAGE CONTAINING THE SOFTWARE MEDIA. IF YOU DO NOT AGREE WITH ANY OF THE TERMS AND CONDITIONS SET OUT HEREIN, YOU MUST: IN THE CASE OF A CLICK-ON LICENCE, RETURN THE UNOPENED PACKAGE CONTAINING THE LICENSED SOFTWARE; OR IN THE CASE OF A SHRINKWRAP LICENCE, RETURN THE PRODUCT IN WHICH THE LICENSED SOFTWARE RESIDES, TO THE FUJI XEROX OPERATING COMPANY FROM WHICH YOU WERE ORIGINALLY SUPPLIED WITH THE PRODUCT (“FXOC”). YOUR ACCEPTANCE OF THE TERMS OF THIS AGREEMENT WILL OCCUR UPON EITHER: IN THE CASE OF CLICK ON LICENCE PROCEED YOUR CHOOSING TO ELECTRONICALLY CLICK ON THE OPTION TO ACCEPT THESE TERMS; OR IN THE CASE OF A SHRINKWRAP LICENCE, YOUR OPENING OF THE PACKAGE CONTAINING THE LICENSED SOFTWARE. ACCEPTANCE WILL BE DEEMED TO HAVE OCCURRED IF YOU LOAD OR INSTALL THE PRODUCT AND SHALL BIND YOU AND ALL OF YOUR EMPLOYEES AND AGENTS. 1. LICENSE GRANT (SINGLE USE LICENSE) If you have paid for a single use license, FXOC grants to you a nonexclusive license to Load the machine readable software included in this package ("Licensed Software") onto a single host computer or server operating and used only on the single licensed unit of equipment. 2. LICENSE GRANT (CONCURRENT USE LICENSE) - if you have paid for a concurrent use license, FXOC grants to you a nonexclusive license to: A. Load Licensed Software onto a single host computer or server directly accessing a single local area network. B. Access copies of the Licensed Software from the single host computer or server(s) controlled by said single host computer through a single local area network onto one or more items of equipment connected to that local area network. C. Use the Licensed Software on the single host computer or server, and on any of the items of equipment onto which copies of the Licensed Software are downloaded under 2B above, provided that you may not concurrently access and use the Licensed Software on more than the maximum number of equipment items permitted by the license fee you have paid. 3. LICENSE GRANT (LOCAL AREA NETWORK LICENSE) - If you have paid for a local area network license, FXOC grants to you a nonexclusive license to: A. Load the Licensed Software onto a single host computer or server directly accessing a single local area network. B. Download and use copies of the Licensed Software from the host computer(s) or server(s) through the single local area network on to one or more items of equipment provided all are accessing only to that local area network and provided that you may not concurrently use the Licensed Software on more than the maximum number of equipment items permitted by the license fee you have paid. 4. LICENSE GRANT (SITE LICENSE) - if you have paid for a site license, FXOC grants to you a nonexclusive license to: A. Make copies of Licensed Software for access and use solely on items of equipment located in a single building or group of buildings comprising a common mailing address. Other definitions of site must be either recited in a site license agreement of otherwise mutually agreed in writing between the parties. 5. PROVISIONS APPLICABLE TO ALL LICENSE GRANTS - The following provisions shall apply to whichever of the above license grants are applicable: A. Each authorised copy of the Licensed Software must include all confidential, proprietary, patent, copyright and/or trademark notices contained on the original. B. Title to the Licensed Software and all copies will at all times reside exclusively with FXOC and/or its licensors. C. If the Licensed Software includes software developed by a third party, the third party shall not be liable to you for any breach by FXOC of its obligations under this Agreement. The third party shall, however, be considered a third party beneficiary of your obligations to this Agreement. D. You have no other rights to the Licensed Software. This means that you may not create derivative works of the Licensed Software, or attempt to decompile or reverse engineer the Licensed Software unless and only to the extent the law allows you to do so Notwithstanding this prohibition. E. You may retain one copy of the Licensed Software but only for backup purposes in the event loaded materials are lost or damaged. F. You must not transfer the License or assign the benefit of this Agreement without our prior written consent. G. When the Licensed Software contains fonts, you may not alter the digital configuration of the Licensed Software, such as changing the visual appearance of the Licensed Software's output from the item of equipment on which it is used. H. When the Licensed Software is provided in more than one media format, you may use only the media appropriate for the single host computer or server on which the Licensed Software is to be loaded. You may not use the other media on other items of equipment, or

Page iv

loan, lease, rent or transfer them to another user, except as part of a transfer or use expressly authorized by FXOC in writing. I. This Software License extends to your use of any enclosed or related user documentation for your internal business use. The documentation may not be copied, modified or used in any way not contemplated or expressly authorized by this Agreement. J. You will supervise and control the use of the program in accordance with the terms of this License. 6. WARRANTY A. For a period of ninety (90) days from the date the Licensed Software is delivered to you. the Licensed Software will substantially conform to the functionality described in the accompanying documentation. B. The Licensed Software is not warranted to be free from error, or to operate uninterruptedly. C. If, during the 90-day warranty period, you notify FXOC that the Licensed Software does not substantially conform to the functionality described in the accompanying documentation, FXOC will, at its option, either replace the Licensed Software or fully refund the purchase price you paid for the Licensed Software package. If a refund is made, you will deliver to FXOC the media containing the original Licensed Software, and certify to FXOC that you have removed the Licensed Software and erased or destroyed all copies. D. The express warranty set forth in paragraph 6.A is in lieu of all other express warranties. In the event any statute implies terms into this Agreement which cannot be lawfully excluded, such terms will apply to this Agreement, save that the liability of FXOC for breach of any such implied term will be limited, at the option of FXOC, to replacement of the Licensed Software or fully refunding the purchase price you paid for either the product in which the Licensed Software resides. E. All warranties and representations made by persons other than FXOC, including, but not limited to, distributors, dealers and other resellers of FXOC, are also disclaimed. F. The express warranty set forth in paragraph 6 A will be void and you may be responsible for additional fees if you fail to property use the Licensed Software in the appropriate environment, as specified in the accompanying documentation. 7. GENERAL PROVISIONS A. Limitation of Liability. To the maximum extent permitted by law: (A), in no event will FXOC be liable to you for any special, indirect, incidental or consequential damages in any way arising out of or relating to this Agreement; and (B) FXOC's liability to you for direct damages is limited in the aggregate to the total amount of money you actually paid for the Licensed Software. B. Severability. Each provision of this Agreement will be read as separate and severable so that if any provision of this Agreement is held invalid by any law, rule, order or regulation of any government, or by the final determination of any court in any government, such invalidity will not affect the enforceability of any other provisions not held to be invalid. C. Entire Agreement and Precedence. If you and FXOC sign a written agreement in respect of the Licensed Software (“Negotiated Contract”), the Negotiated Contract prevails over this Agreement from effective date of the Negotiated Contract to the extent of any conflict. Otherwise this Agreement constitutes the entire agreement of the parties as to the subject matter hereof, and supersedes any and all prior oral and written understandings and agreements as to that subject matter. D. Expiration or Termination of License. This Agreement commences upon the date you accept the terms and unless otherwise stated is granted in perpetuity, but may be terminated by FXOC immediately upon notice to you in the following circumstances:

(a) if you breach of any term of this Agreement; (b) if you, being a corporation, becomes the subject of insolvency proceedings; (c) if you, being a firm or partnership, are dissolved; or (d) if you destroy the program and documentation for any reason.

Upon termination, you shall destroy any remaining copies of the Licensed Software and documentation or otherwise return or dispose of such material in a manner directed by FXOC. Termination pursuance to this clause shall not affect any rights or remedies, which FXOC may have otherwise under this license or at law. E. Waiver. Failure or neglect by either party to enforce at any time any of the provision of this Agreement shall not be construed or deemed to be a waiver of that party’s rights under this license. F. Governing Law. This license shall be governed and construed according to the law of the location in which the Products were originally supplied to you, and you agree to submit to the jurisdiction of the courts there (including any appellant courts thereof)

Page v

About this Guide

This guide provides details regarding the administration and configuration of DocuShare® Connect.

This document forms a part of a series of documents that also includes:

Installation Guide for DocuShare®

Connect

User Guide for DocuShare®

Connect

Intended Audience

This guide is intended for the personnel responsible for administering and configuring DocuShare® Connect.

Prerequisites

Following are the prerequisites to perform the tasks presented in this guide:

DocuShare® Connect should be installed

You must have Administrator privileges for the DocuShare® Connect Windows server.

Organisation of the Guide

Information in this guide has been organised as follows:

Organisation of the Guide

Section Description

Section 1 – Introduction This section provides information about DocuShare® Connect.

Section 2 – Configuring the License

This section provides information about configuring and activating the license file for DocuShare® Connect.

Section 3 – Setting Up and Configuring the Scan

This section provides information about setting up and configuring the Scan option in DocuShare® Connect.

Section 4 – Managing the Common Settings

This section provides information about managing the common settings for DocuShare® Connect. The settings are required for the receipt and processing of the scanned images from ApeosPort Multi Function Device (MFD) for Optical Character Recognition (OCR).

Section 5 – Managing the File Icons

This section provides information about adding, modifying and deleting the icons for different file types. While viewing the files on the DocuShare® Connect user interface, the icons are displayed against the files.

Section 6 – Managing the DocuShare Express Server Details

This section provides information about setting up and controlling the DocuShare Express Server Details.

Section 7 – Verifying the Status of the Jobs

This section provides information about checking the status of the jobs that have been submitted for processing to DocuShare® Connect.

Appendix A – Troubleshooting

This section describes how to deal with any problem that you might encounter while maintaining the DocuShare

® Connect Server through the

DocuShare® Connect Admin interface.

Appendix B – Helpdesk and Support

This section provides details of customer support.

Page vi

Section Description

Appendix C – Log Samples This section provides samples from log files.

Typographical Conventions

The following table gives the details of the typographical conventions used in the document:

Typographical Conventions

Formatting Convention Type of Information

Reference to sections References to sections are in italics. Example, Getting Started with DocuShare® Connect Admin

Command and Screen element names

Buttons, check boxes, etc. Commands that you choose from the menus or dialog boxes appear in title case and in bold font.

Example: Click APPLY to save the product key.

System response The system response is mentioned in the next line after the respective action step.

DocuShare® Connect Administration Guide

Page 7

Contents

1 Introduction.................................................................................................................................................................. 12

1.1 Getting Started with DocuShare®

Connect Admin................................................................................. 12

1.2 DocuShare®

Connect Admin Interface....................................................................................................... 13

1.3 Viewing the Information for DocuShare®

Connect Service ................................................................. 13

2 Configuring the License ............................................................................................................................................ 14

2.1 Maintaining the Site Information ............................................................................................................... 14

2.2 Generating the License File............................................................................................................................ 15

2.3 Activating the License File.............................................................................................................................. 16

2.4 Loading the License File .................................................................................................................................. 16

3 Setting Up and Configuring the Scan ................................................................................................................... 18

3.1 Defining the Default Settings for Scan ...................................................................................................... 18

3.1.1 Field References ...................................................................................................................................... 19

3.2 Setting the DocuShare® Connect Scan Service ....................................................................................... 21


4 Managing the Common Settings ........................................................................................................................... 23

4.1 Setting the Folders and User Details .......................................................................................................... 23

4.2 Setting the MFD User Details ........................................................................................................................ 25

4.3 Changing the Application Name.................................................................................................................. 25

4.4 Setting the Connection Time ........................................................................................................................ 25

4.5 Adding Log Files and Log Path ..................................................................................................................... 26

4.6 Field References ................................................................................................................................................ 27

4.7 Creating FTP Sites in Windows 2008 Server ............................................................................................. 28

4.8 Creating FTP Sites in Windows 2003 Server ............................................................................................. 32

5 Managing the File Icons ........................................................................................................................................... 35

5.1 Adding a New File Icon ................................................................................................................................... 36

5.2 Deleting an Existing File Icon ........................................................................................................................ 36

5.3 Managing the Preview Details ...................................................................................................................... 36


6 Managing the DocuShare Express Server Details ............................................................................................. 38

6.1 Specifying the Default Settings of the DocuShare Express Server .................................................... 38


6.2 Configuring the Custom Properties ............................................................................................................. 40

7 Verifying the Status of the Jobs ............................................................................................................................. 42


A Troubleshooting .......................................................................................................................................................... 44

B Helpdesk and Support ............................................................................................................................................... 45

C Log Samples.................................................................................................................................................................. 46


Page 8

The total number of pages in this document, including the cover page, is 48.


Page 9

List of Figures

Figure 1: DocuShare®

Connect Admin Interface ......................................................................................................... 12 Figure 2: Site Information Page ....................................................................................................................................... 14 Figure 3: Licensing Page before License Generation .................................................................................................. 15 Figure 4: Licensing Page after License Generation ..................................................................................................... 17 Figure 5: Scan Defaults Page ............................................................................................................................................. 18 Figure 6: OCR Server Details Page .................................................................................................................................... 21 Figure 7: Common Settings Page ..................................................................................................................................... 23 Figure 8: Log page ................................................................................................................................................................ 26 Figure 9: Add FTP Site .......................................................................................................................................................... 28 Figure 10: Site Information ................................................................................................................................................ 29 Figure 11: Binding and SSL Settings ................................................................................................................................ 29 Figure 12: Authentication and Authorization Information ...................................................................................... 30 Figure 13: Adding Virtual Directory ................................................................................................................................. 30 Figure 14: Add Virtual Directory ....................................................................................................................................... 31 Figure 15: Enter Alias and Physical Path ........................................................................................................................ 31 Figure 16: Virtual Directory ................................................................................................................................................ 32 Figure 17: Welcome to the Virtual Directory Creation Wizard ................................................................................ 32 Figure 18: Virtual Directory Alias ...................................................................................................................................... 33 Figure 19: FTP Site Content Directory............................................................................................................................. 33 Figure 20: Access Permissions ........................................................................................................................................... 34 Figure 21: Virtual Directory Creation Wizard - Creation Successful ....................................................................... 34 Figure 22: Preview Page ...................................................................................................................................................... 35 Figure 23: DocuShare Defaults Page .............................................................................................................................. 38 Figure 24: Custom Objects Page....................................................................................................................................... 40 Figure 25: Custom Objects Page with the Properties ................................................................................................. 40 Figure 26: Job Status Page ................................................................................................................................................. 42 Figure 27: Command Window - TCP Handshake Successful .................................................................................... 44 Figure 28: Command Window - TCP Handshake Unsuccessful............................................................................... 44


Page 10

List of Tables

Table 1: DocuShare® Connect Interface Tabs ............................................................................................................. 13 Table 2: Field References for the Scan Defaults Page ............................................................................................... 19 Table 3: Field References for the Server Details Page ................................................................................................ 22 Table 4: Field References for the Common Settings Page ....................................................................................... 27 Table 5: Field References for the Preview Page ........................................................................................................... 37 Table 6: Field References for the DocuShare Defaults Page.................................................................................... 39 Table 7: Field References for the Job Status Page ...................................................................................................... 43


Page 11

List of Abbreviations

Abbreviation/ Acronym

Description

MFD Multi Function Device

NTFS New Technology File System

OCR Optical Character Recognition

PDF Portable Document Format

TCP Transmission Control Protocol

FTP File Transfer Protocol

SSL Secured Socket Layer


Page 12

1 Introduction

DocuShare® Connect is developed as an enhancement to Fuji Xerox Multi Function Device (MFD) to provide better office equipment with the MFD applications. MFD is a machine that is used for multiple functions and has a browser display. MFD is used to access the DocuShare® Connect Uniform Resource Locator (URL) deployed in the network.

DocuShare®

Connect provides you a customised user interface, enabling you to scan documents to and print documents present in DocuShare® Express. After the DocuShare® Connect setup has been installed, the DocuShare

® Connect Admin interface is available to configure the system prior to use.

Note: For information about installing DocuShare®

Connect, see the DocuShare® Connect Installation

Guide.

1.1 Getting Started with DocuShare® Connect Admin

This section describes the DocuShare® Connect Admin interface. Access to DocuShare® Connect Admin interface is limited to administrators.

To access the DocuShare® Connect Admin interface:

1. Open web browser (Internet Explorer or Mozilla) on the DocuShare® Connect Server.

2. In the address bar, type http://localhost/DocuShareConnectAdmin.

3. The DocuShare® Connect Admin interface appears as shown in Figure 1.

Figure 1: DocuShare®

Connect Admin Interface

http://localhost/DocuShareConnectAdmin


Page 13

1.2 DocuShare® Connect Admin Interface

The DocuShare® Connect Admin interface allows you to configure the license, configure the DocuShare® Connect User interface and monitor it from any network connected device.

The DocuShare® Connect Admin interface comprises several tabs as shown in Figure 1. The tabs are described in Table 1.

Table 1: DocuShare® Connect Interface Tabs

Tab Name Description

SCAN This tab is used to configure the default scan settings and to specify the OCR server(s) details.

COMMON This tab is used to define the common settings for the DocuShare® Connect system. The settings are required for the receipt and processing of scanned images from the MFDs for optical character recognition (OCR).

PREVIEW This tab is used to add and delete the file icon for different file types. It is also used to manage preview details of the document.

DOCUSHARE This tab is used to enter DocuShare Express server details and setting up the custom properties for custom objects for scan and search options.

JOB STATUS This tab displays a list of submitted jobs which have been logged in DocuShare® Connect for example: completed, pending and so on.

LICENSING This tab is used to view the license details for the DocuShare® Connect Server, generate a license request and load license activation files, so that the purchased services can be enabled for use.

SITE INFO This tab is used to enter customer details that needs to be registered in DocuShare® Connect.

ABOUT This tab is used to view version number and other information on DocuShare® Connect and links related to Fuji Xerox

1.3 Viewing the Information for DocuShare® Connect Service

To view the information and links for the DocuShare®

Connect service:

1. Access the DocuShare® Connect Admin interface. For information about accessing the

DocuShare® Connect Admin interface, see Getting Started with DocuShare® Connect Admin.

2. Click the ABOUT tab.

3. The About page appears as shown in Figure 1. This page provides information about the

current version of DocuShare® Connect and links to the Fuji Xerox Australia website.


Page 14

2 Configuring the License

This section provides information about configuring and activating the license file for DocuShare® Connect.

2.1 Maintaining the Site Information

Before Configuring the license file, add the customer site information and customer contact

information.

To add/update and maintain the customer site information:



2. Click the SITE INFO tab.

3. The Site Information page appears as shown in Figure 2.

4. In the Customer Information section, update the customer address.

5. In the Contact Information section, update the customer and contact details.

6. Click APPLY to save the information.

Figure 2: Site Information Page


Page 15

You can configure the license for DocuShare® Connect through the LICENSING tab on the DocuShare® Connect Admin interface. To configure the license for DocuShare

® Connect:

1. Generate the license file

2. Activate the license file

3. Load the license activation file

2.2 Generating the License File

Before you generate the license file, connect the Windows Server in which DocuShare®

Connect is installed to the domain.

Note: The domain to which the Windows Server having DocuShare® Connect is connected appears under the Product Key box. Ensure that the machine is connected to the Windows domain environment.

To generate a license file:



2. Click the LICENSING tab.

The Licensing page appears as shown in Figure 3.

Figure 3: Licensing Page before License Generation


Page 16

3. In the Product Key box, type the product key. A valid product key is required to generate

the license file.

Note: The product key is on your DocuShare®

Connect installation CD.

4. Click GENERATE to generate the license file.

The Save window appears.

5. In the Save window, the name of the license file appears and navigate to the location

where you want to save the license file.

6. Click Save to save the license file at the specified location.

The license file is saved.

2.3 Activating the License File

To activate the license file:

Email the generated license file to Fuji Xerox Australia ([email protected]). When you email the license file, Fuji Xerox Australia will activate the purchased services and device licenses and return the activated license file to you.

Note: The generated license file should not be modified.

2.4 Loading the License File

To start using the license file, you need to save the license activation file that you receive from Fuji Xerox Australia on the local disk of the Windows server having DocuShare® Connect.

To load the license file:


DocuShare®

Connect Admin interface, see Getting Started with DocuShare® Connect Admin.

2. Click the LICENSING tab.

3. The Licensing page appears as shown in Figure 4.

4. Click the Browse button that appears next to the Install box.

5. The Open window appears.

6. Navigate to the location where the license activation file is saved.

7. Select the license activation file and click Open.

8. Click APPLY to install or load the license file.

9. The license details appears on the Licensing page as shown in Figure 4 and the status of

the purchased services appears as Active along with the number of device connections that

have been purchased.

mailto:[email protected]


Page 17

Figure 4: Licensing Page after License Generation


Page 18

3 Setting Up and Configuring the Scan

This section provides information about setting up and configuring the scan option in DocuShare® Connect .

You can configure the default setting for scan and specify the OCR Server details for scanning using the SCAN tab on the DocuShare® Connect Admin interface.

The SCAN tab comprises two sub tabs:

Scan Defaults - This tab allows you to specify the default settings for the scan functionality of DocuShare

® Connect.

Server Details - This tab is used to define the server settings for DocuShare® Connect.

3.1 Defining the Default Settings for Scan

To define the default environment settings for Scan:

1. Access the DocuShare®

Connect Admin interface. For information about accessing the


2. Click the SCAN tab.

3. Click the Scan Defaults sub tab.

4. The Scan Defaults page appears as shown in Figure 5.

Figure 5: Scan Defaults Page


Page 19

5. Choose the appropriate options in the Page Defaults section. For more information on the

options, see Field References.

6. Select the Lock box that appears against the various fields to freeze the selected setting in

the DocuShare® Connect User interface.

Note: When you choose to freeze an option, the user will have to use the default option for scanning in DocuShare® Connect User Interface. Multiple options to choose from will not be provided to the user.

7. Click Apply to save the settings.

3.1.1 Field References

This section describes the fields available on the Scan Defaults page.

Table 2: Field References for the Scan Defaults Page

Field Name Description Notes

Format Allows you to set the default output format.

Choose from the available list of options . If you select the Lock box that appears against Format, users are forced to use the specified output format.

Language Allows you to set the default language.

English is the only available language.

Deskew Allows you to enable Deskew. Select the box to enable Deskew. When you select the Lock box that appears against Deskew, users will not be able to disable Deskew.

Rotation Allows you to set the default rotation.

Choose from the available list of options . If you select the Lock box that appears against Rotation, users are forced to use the specified rotation option.

Sides Allows you to set the default input scan plex

Choose from the available list of options . If you select the Lock box that appears against it, users are forced to use the specified option.

Colour Allows you to set the default output colour.

Choose from the available list of options . If you select the Lock box that appears against Colour, users are forced to use the specified colour.

Type Allows you to set the default document type.

Choose from the available list of options . If you select the Lock box that appears against Type, users are forced to use the specified document type.

Resolution Allows you to set the default resolution.

Choose from the available list of options . If you select the Lock box that appears against Resolution, users are forced to the specified resolution.

Head Position Allows you to set the default document head position for two sided tumbles.

Choose from the available list of options . If you select the Lock box that appears against Head Position, users are forced to use the specified head position.

Blank Pages Allows you to set the default blank pages.

Choose from the available list of options . If you select the Lock box that appears against Blank Pages, users are forced to use the specified value.


Page 20

High Compression PDF

Allows you to set the high compression Portable Document Format (PDF). You can choose to either enable or disable the compression of PDFs.

Choose On to enable the compression of PDFs.

Choose Off to disable the compression of PDFs.

PDF Archive Allows you to set the PDF archive. Select the box to enable PDF archive.

Paper In Allows you to set the Paper In Choose from the available list of options . If you select the Lock box that appears against Paper In, users are forced to use the specified value.

Paper Out Allows you to set Paper Out Choose from the available list of options. If you select the Lock box that appears against Paper Out, users are forced to use the specified value.

Magnification Allows you to set magnification Choose from the available list of options . If you select the Lock box that appears against Maginification, users are forced to use the specified value.

Manual Magnification

Allows you to manually set the magnification

Enter any value between 25 and 400, to enter the magnification scale manually.

Note:

If any option above is already locked, de-select the Lock box to unlock the respective option.

Refer User Guide section 3, for more information on the above mentioned field references.


Page 21

3.2 Setting the DocuShare® Connect Scan Service

To set the DocuShare® Connect Scan service:




2. Click the SCAN tab.

3. Click the Server Details tab.

4. The Servers Details page appears as shown in Figure 6.

Figure 6: OCR Server Details Page

5. In the Server IP box, type the IP address of the OCR server.

6. In the Port Number box, type the port number of the OCR server.

Note: The port number is editable and default port number for the OCR service is 9932.

7. Click ADD.

The IP address and the port number are updated in the Servers box.

Note: To remove a server from being used for OCR, select the server entry in the Servers box and click REMOVE.

7. Click APPLY to save the changes.


Page 22


This section describes the fields that are present on the OCR Server Details page.

Table 3: Field References for the Server Details Page


Server IP Allows you to specify the IP address of the OCR server

The default IP is Windows Server IP on which the DocuShare® Connect is installed.

Port Number Allows you to specify the port number of the OCR server

The default port number is 9932.

Servers Displays the IP address and the port number of the OCR server

This field is automatically updated when you click the Add button.


Page 23

4 Managing the Common Settings

This section provides information about managing the common settings for DocuShare® Connect. The settings are required for the receipt and processing of the scanned images from MFDs for scanning.

The COMMON tab on the DocuShare® Connect Admin interface allows you to:

Set the MFD scan and transfer workflow

Change user name and password

Change MFD user name and password

Adding Log files

Change the DocuShare®

Connect application name

Set the connection time for the release of device connection

The Common page comprises several fields as shown in Figure 7. For information about these fields, see Adding Log Files and Log Path.

Figure 7: Common Settings Page

4.1 Setting the Folders and User Details


Page 24

To ensure correct operation of the MFD Scan and Transfer Workflow, the application needs to create a new user and two shared folders for Inbox and Outbox on the server where DocuShare® Connect is installed.

The folders are created by DocuShare®

Connect. You are only required to specify the location where the shared folders are to be created.

To set the MFD scan and transfer workflow:



2. Click the COMMON tab.

3. The Common page appears as shown in Figure 7.

4. In the Inbox Folder box, type the path where the Inbox shared folder needs to be created.

The folder is automatically created in the path that has been specified.

5. In the Outbox Folder box, type the path where the Outbox shared folder needs to be

created.

6. The folder is automatically created at the path that has been specified.

7. In the User Name box, type the user name.

8. In the Password box, type the password for the user.

9. In the Confirm Password box, retype the password for the user.

10. Click APPLY to save.

11. The new user and folders are created required and permissions on these folders are set

appropriately. A confirmation is displayed once the folders are set successfully.

Note:

The User Name and Password mentioned above are the login details for that Windows server where DocuShare® Connect is installed.

The User Name and Password mentioned above are used to access the Inbox and Outbox folders.

Password should be complex and should meet windows password policy requirements.

You can change the User Name/Password for an existing user by selecting the Change User/Password checkbox.


Page 25

4.2 Setting the MFD User Details

To set the MFD user details:





4. Select the Change MFD User/Password checkbox.

The MFD User Name and MFD Password boxes are enabled.

5. In the MFD User Name box, type the user name.

6. In the MFD Password box, type the password for the user.


The MFD User details are set successfully.

4.3 Changing the Application Name

You can change the application name. This name appears on the main page when users login to DocuShare® Connect.

To set the application name :





4. In the Application Name box, type the name that should appear on the main page when

the users login to DocuShare®

Connect.


4.4 Setting the Connection Time

You can set a maximum time for which the device connection can be idle. After the specified time, the server releases the device connection.

To set the connection time:


DocuShare®




4. In the Connection Time box, type the number of seconds after which the server can release

a device that is not active.



Page 26

4.5 Adding Log Files and Log Path

You can enable or disable logging for the respective application. You can enter the log path for storing these log files.

Note: For more details on log samples in log files, refer Log Samples.

To add the log files:



DocuShare®




4. Click Logging.

The Log page appears as shown in Figure 8.

Figure 8: Log page

5. In the Enter Log Path box, type the log path.

Note: The Log path is the location where all the log files are created.

6. Select the respective checkbox of the application to add the log file.

Note: Select the Select All box to select all the log files.

7. Click Apply to save.


Page 27

4.6 Field References

The Common page comprises several fields as shown in Figure 7. This section describes the fields available on the Common page.

Table 4: Field References for the Common Settings Page


Inbox Folder Allows you to specify the location where the Inbox folder is to be created. It is the local file path on the server where scanned documents from MFD will be transferred to, prior to OCR processing.

The Inbox Folder is automatically created by DocuShare

® Connect

Admin at the specified location.

The folder is shared with New Technology File System (NTFS) and share permissions for the specified user.

Outbox Folder Allows you to specify the location where the Outbox folder is to be created. It is the local file path on the server where documents will be transferred to, after OCR processing.

Once a document is copied into this folder, DocuShare Express service collects the file and uploads it to DocuShare Express.

The Outbox Folder is automatically created by DocuShare® Connect Admin at the specified location.

Method Allows you to specify the protocol used to transfer the scanned image from the MFD to the DocuShare® Connect server.

You can either choose the SMB protocol or the FTP protocol.

If you select FTP, refer Section 4.7 to create FTP sites in Windows 2008 server and refer Section 4.8 to create FTP sites in Windows 2003 server.

Change User/Password Allows you to indicate that you wish to change the password for a specified user.

User Name Allows you to specify the user who can use the MFD file transfer and the OCR file copy processes.

Password Allows you to specify the password for a user.

Confirm Password Allows you to reenter and confirm the password entered earlier in the Password field.

The password entered in this field must match the password that specified in the Password field.

Change MFD User/Password

Allows you to indicate that you wish to change the MFD user details.

MFD User Name Allows you to specify the MFD Administrator’s user name.

The default value is 11111.


Page 28

MFD Password Allows you to specify the MFD Administrator’s password.

Connection Time Allows you to specify the time after which DocuShare® Connect server will release an inactive device co`nnection.

Enter a value between 60 and 9999. The values is in seconds.

Application Name Allows you to specify the application name that appears on the DocuShare

® Connect main

page.

Enable/Disable Logging Allows you to enable/disable the logging process to a list of applications in DocuShare

®

Connect.

Click Logging button to add/remove the logfiles and to enter the log path.

4.7 Creating FTP Sites in Windows 2008 Server

To create FTP sites in Windows 2008 server:

1. Click Start Run, Enter inetmgr, click OK to open Internet Information Services.

2. Open Internet Information Services.

3. Right-Click on Sites.

4. A dropdown list appears as shown in Figure 9.

Figure 9: Add FTP Site

5. Select Add FTP Site.

The Site Information page appears as shown in Figure 10.


Page 29

Figure 10: Site Information

6. Enter FTP site details in FTP site name box.

7. Enter physical path details in Physical path box.

8. Click Next.

The Binding and SSL Settings page appears as shown in Figure 11.

Figure 11: Binding and SSL Settings

8. In Binding, select All Unassigned option for IP Address and 21 for port number.

9. Deselect Enable Virtual Host Names check box, if it is selected in Binding options.

10. Select Start FTP site automatically checkbox.

11. Select No SSL radio button.

12. Click Next.

The Authentication and Authorization Information page appears as shown in Figure 12.


Page 30

Figure 12: Authentication and Authorization Information

13. Select Anonymous checkbox.

14. Select Basic checkbox.

15. Select All users from Allow access to box.

16. Select Read checkbox to enable read permission.

17. Select Write checkbox to enable write permission.

18. Click Finish to complete adding an FTP site.

19. After adding an FTP site, create a new virtual directory for the site as below:

i. Right-Click on newly created FTPSite. A dropdown list appears as shown in Figure 13.

Figure 13: Adding Virtual Directory


Page 31

ii. Select Add Virtual Directory. The Add Virtual Directory page appears as shown in Figure 14.

Figure 14: Add Virtual Directory

iii. Enter IGAInbox in Alias box.

iv. Enter the path in Physical path box, where inbox folder is located as mentioned in Section 4.1.

Figure 15: Enter Alias and Physical Path

v. Click OK. The virtual directory is created.


Page 32

4.8 Creating FTP Sites in Windows 2003 Server

To create FTP sites in Windows 2003 server:

1. Click Start Run, Enter inetmgr, click OK to open Internet Information Services.

2. Right-Click on Sites.

A dropdown list appears.

3. Select New.

The Virtual Directory option appears as shown in Figure 16.

Figure 16: Virtual Directory

4. Click Virtual Directory.

The Welcome to Virtual Directory Creation Wizard page appears as shown in Figure 17.

Figure 17: Welcome to the Virtual Directory Creation Wizard


Page 33

5. Click Next.

The Virtual Directory Alias page appears as shown in Figure 18.

Figure 18: Virtual Directory Alias

6. Enter IGAInbox in Alias box.

7. Click Next.

The FTP Site Content Directory page appears as shown in Figure 19.

Figure 19: FTP Site Content Directory

8. Enter/Select the path where inbox folder is created in Path box.

9. Click Next.

The Access Permissions page appears as shown in Figure 20.


Page 34

Figure 20: Access Permissions

10. Select Read checkbox to set read access.

11. Select Write checkbox to set write access.

12. Click Next.

The Virtual Directory Creating Wizard page appears as shown in Figure 21.

Figure 21: Virtual Directory Creation Wizard - Creation Successful

13. Click Finish.

The Virtual Directory and FTP site are created.


Page 35

5 Managing the File Icons

This section provides information about adding, modifying and removing the icons for different file types. While viewing the files on the DocuShare

® Connect user interface, the icons are displayed against

the files.

The PREVIEW tab on the DocuShare® Connect Admin interface is used to configure the icon list. Use the PREVIEW tab to:

Add a new icon to the list

Delete the icon configured for a file

Specify and control the file preview details

The Preview page comprises several fields as shown in Figure 22. For information about these fields, see Field Reference.

Figure 22: Preview Page


Page 36

5.1 Adding a New File Icon

To add a new icon for a file type:



2. Click the PREVIEW tab.

3. The Preview page appears as shown in Figure 22.

4. In the Extension Filename box, type the file extension for which you are adding the icon.

5. Click Browse to navigate and select the icon.

6. Click ADD to upload the icon.

7. The file extension is added to the File Types box.

5.2 Deleting an Existing File Icon

To modify an existing file icon:






4. Click Browse that appears against the File Name box, navigate and select the icon.

5. Click DELETE to delete the icon.

6. The existing icon for the file type is deleted.

5.3 Managing the Preview Details

To set and control the preview details:





4. In the Max Rendering box, type the maximum rendering that you wish to have.



The Preview page comprises several fields as shown in Figure 22. This section describes the fields that are present on the Preview page.


Page 37

Table 5: Field References for the Preview Page


Advanced Settings

File Types Lists the file extensions for which icons have been specified.

Extension Filename Allows you to specify the file extension for which an icon is to be added or modified.

File Name Allows you to specifiy the name and the location of the icon.

Common Settings

Max Rendering Allows you to specify maximum number of megabytes of the file size to be displayed in preview and print. All files of size greater than the max rendering size specified can neither be previewed nor printed from the preview screen.

The default value is 10.


Page 38

6 Managing the DocuShare Express Server Details

This section provides information about configuring the DocuShare Express server in DocuShare® Connect.

The DOCUSHARE tab on the DocuShare®

Connect Admin interface is used to set and control the DocuShare Express server details. The tab comprises two tabs:

Docushare Defaults – This tab allows you to specify the default settings for the DocuShare Express server.

Custom Objects – This tab is used to cofigure the custom properties for search and scan in DocuShare Express server.

6.1 Specifying the Default Settings of the DocuShare Express Server

To specify the default settings of the DocuShare Express server:



2. Click the DOCUSHARE tab.

3. Click the DocuShare Defaults tab.

4. The DocuShare Defaults page appears as shown in Figure 23.

Figure 23: DocuShare Defaults Page


Page 39

5. In the Default Homepage box, select the page that should appear as the home page when

the user accesses the DocuShare Express server.

6. In the Max Records box, type the maximum number of search results that should be

displayed on the user interface.

7. In the User Name and Password boxes, type the DocuShare express server Administrator

user name and password.

8. In the Host Name box, type the host name of the DocuShare Express server.

9. In the Domain Name box, type the name of the docushare domain.



The DocuShare Defaults page comprises several fields as shown in Figure 23. This section describes the fields that are present on the DocuShare Defaults page.

Table 6: Field References for the DocuShare Defaults Page


Default Homepage Allows you to set the default page of the DocuShare Express server to either Search Option or MyHomePage.

If the default page is set to SearchOption, the Search page is displayed.

If the default page is set to MyHomepage, users personal collection and the DocuShare Root Level collections are displayed.

Max Records Allows you to specify the maximum number of records that can be displayed as search results, on the user interface.

User Name Allows you to specify the user name of the Administrator.

Password Allows you to specify the password of the Administrator.

Host Name Allows you to specify the hostname of the DocuShare Express server.

Enter the host name in the following format:

<docushare servername>:8080/docushare/dsweb/

Domain Name Allows you to specify the name of the docushare domain .

The domain name is case sensitive.


Page 40

6.2 Configuring the Custom Properties

To configure the custom properties for search and scan in the DocuShare Express server:


DocuShare® Connect Admin interface, see Getting Started with DocuShare® Connect Admin interface.

2. Click the DOCUSHARE tab.

3. Click the DocuShare Defaults tab.

4. The Custom Objects page appears as shown in Figure 24.

Figure 24: Custom Objects Page

5. From the Custom Objects box, select an appropriate custom object.

6. All the custom search and scan properties related to the custom object appear as shown in

Figure 25.

Figure 25: Custom Objects Page with the Properties

7. In the Select Properties for Search section, select the properties that you wish to include on

the Search interface.


Page 41

8. In the Select Properties for Scan section, select the properties that you wish to include on

the Scan interface.

Note: You can select a maximum of six (6) properties to appear on the DocuShare® Connect Search. user interface and the DocuShare® Connect Scan user interface respectively.


Note:

To modify the configured custom properties for search and scan, select the custom object from the Custom Objects box. Select or uncheck the properties and click APPLY.

To delete a custom object, select the custom object from the Custom Objects box and click DELETE.


Page 42

7 Verifying the Status of the Jobs

You can use the JOB STATUS tab to check the status of the jobs that have been submitted for processing to DocuShare® Connect.

To check the status:



2. Click the JOB STATUS tab.

3. The Job Status page appears as shown in Figure 26.

Figure 26: Job Status Page

4. Select the search criteria and click SEARCH.

5. The search result appears.

Note: When multiple search criteria are specified, the system displays the results matching all the specified criteria.


Page 43


The Job Status page comprises several fields as shown in Figure 26. This section describes the fields that are present on the Job Status page.

Table 7: Field References for the Job Status Page


DocuShare®

Connect Server

Allows you to select the server for search in a multi DocuShare® Connect server environment.

In a single DocuShare®

Connect server environment, the server name is automatically displayed.

User Name Allows you to search for jobs that have been submitted by a specific user.

Provide the Windows Network ID.

Job Status Allows you to search for jobs of a specified status.

Select any one:

Any – any type of jobs

Pending – for the jobs which are pending

Processing – for the jobs which are under progress

Completed – for the jobs which are completed

Faulted – for the jobs which are faulted

Service Type Allows you to specify the service type of the jobs.

Select any one:

All – for all the jobs

Omni Page– for scan jobs

DocuShare Express– for DocuShare transfer jobs

Date From Allows you to search for jobs that are submitted to the DocuShare

® Connect

server after the specified date.

Calender Button Allows you to Open PopUp Calender Control to select specified date

Last 50 Jobs Allows you to specify listing of the last 50 submitted jobs.


Page 44

A Troubleshooting

This section describes how to deal when OCR Slave or Remote Connector is not responding while maintaining the DocuShare® Connect server through the DocuShare® Connect Admin interface.

A.1 OCR Slave or Remote Connector not Responding

For instances where an OCR slave or a remote connector service does not seem to respond, when all the settings have been verified and the service is running on the DocuShare® Connect core server.

Perform a telnet into the remote port to ensure that the listener service is running.

To perform a telnet:

1. Click Start → Run.

2. In the Run box, type cmd and click OK.

3. The Command window appears.

4. In the Command window, type Telnet, the remote server IP address and the transmission

control protocol (TCP) port number to connect.

5. For example, Telnet 192.168.30.65 9932

6. Press the Enter key on the keyboard.

7. Either one of the two cases can occur:

The Command window turns blank with a flashing cursor as shown in Figure 27. This implies that the TCP handshake has been successful and the listner service is working correctly.

Figure 27: Command Window - TCP Handshake Successful

A Connect failed error appears on the Command window as shown in Figure 28. This could be because of:

8. A problem with the firewall on the remote server.

9. The DocuShareConnect OCR Host Service on the remote server may not have been started.

10. The DocuShareConnect OCR Host Service is configured to a use a different port, other than

the one requested by OCR Service.

Figure 28: Command Window - TCP Handshake Unsuccessful

11. If the connection fails, make the required network connections and test again.


Page 45

B Helpdesk and Support

If you require further assistance, contact the Fuji Xerox Australia Customer Support Center (CSC) on: 1800 028 962.

You will be required to provide the product key which is on the About tab of the DocuShare® Connect Admin interface or on your product CD.


Page 46

C Log Samples

The Log Samples are used to troubleshoot any support issues.

This section provides sample log files.

C.1 OCRScheduler.Log File Sample

This section provides a sample from the OCRScheduler.log file.

Note: To enable/disable logging, refer to Section 4.5.

3/8/2010 11:02:03 AM, Info: server: 192.168.30.65

=====================

3/8/2010 11:02:03 AM, Info: port: 9932

=====================

3/8/2010 11:02:03 AM, Info:MethodName:ProcessOCREntry:tcp://192.168.30.65:9932/IGAOCRInterface,

=====================

3/8/2010 11:02:03 AM, Info: after calling Activator.GetObject:tcp://192.168.30.65:9932/IGAOCRInterface,

=====================

3/8/2010 11:02:03 AM, Info: service is busy

=====================

3/8/2010 11:02:06 AM, Info: AIG_OCR_SERVERS value :< IGA=192.168.30.65, Client=192.168.30.65+Port=9932>;

=====================

3/8/2010 11:02:06 AM, Info: IgaServerIP Value: 192.168.30.65

=====================

3/8/2010 11:02:06 AM, Info: Client Value: 192.168.30.65

=====================

3/8/2010 11:02:06 AM, Info: Portnumber Value: 9932

=====================

3/8/2010 11:02:06 AM, Info: inside while loop

=====================

3/8/2010 11:02:06 AM, Info: jpm id: 8138cf06-fda3-46d0-9194-3e409041862f

=====================

3/8/2010 11:02:15 AM, Info: server: 192.168.30.65

=====================

3/8/2010 11:02:15 AM, Info: port: 9932

=====================


Page 47

3/8/2010 11:02:15 AM, Info:MethodName:ProcessOCREntry:tcp://192.168.30.65:9932/IGAOCRInterface,

=====================

3/8/2010 11:02:15 AM, Info: after calling Activator.GetObject:tcp://192.168.30.65:9932/IGAOCRInterface,

=====================

3/8/2010 11:02:15 AM, Info: service is busy

=====================

3/8/2010 11:02:18 AM, Info: AIG_OCR_SERVERS value :< IGA=192.168.30.65, Client=192.168.30.65+Port=9932>;

=====================

C.2 OCR Engine.Log File Sample

This section provides a sample from the OCR Engine.log file.

3/8/2010 11:03:20 AM, Info: in ConvertByOCREngine

=====================

3/8/2010 11:03:20 AM, Info: checking for local files:

=====================

3/8/2010 11:03:20 AM, Info: Inside Local Files Delete:

=====================

3/8/2010 11:03:20 AM, Info: Deleting files: \Program Files\Fuji Xerox Australia\DocuShare Connect \Connectors\Scan\5de524_3810216.pdf

=====================

3/8/2010 11:03:20 AM, Error: StartIndex cannot be less than zero.

Parameter name: start Index

=====================

3/8/2010 11:03:20 AM, Error: StartIndex cannot be less than zero.

Parameter name: start Index

=====================

3/8/2010 11:03:20 AM, Info:XmlFileData: <Root> <ad:BlobService xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>AIG_OCR</ad:BlobService><ad:ServiceStatusxmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>NULL</ad:ServiceStatus><ad:InputFileName xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>055ab6_3811019.pdf</ad:InputFileName><ad:Inbox xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>in</ad:Inbox><ad:Outboxxmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>out</ad:Outbox><ad:Language xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>EN</ad:Language><ad:OutputFormat xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>pdf</ad:OutputFormat><ad:OutputColourDepthxmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>Auto</ad:OutputColourDepth><ad:OrientationFlag


Page 48

xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>0</ad:OrientationFlag><ad:Deskew xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>True</ad:Deskew><ad:DistributionMethod xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>DocushareExpress</ad:DistributionMethod><ad:DestinationName xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'></ad:DestinationName><ad:DestinationFolderxmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'></ad:DestinationFolder><ad:DestinationOverwrite xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>True</ad:DestinationOverwrite><ad:blankpages xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'>0</ad:blankpages><ad:HighCompressionPDF xmlns:ad='http://www.fujixerox.com.au/Services/ApeosService'></ad:HighCompressionPDF></Root>

=====================

3/8/2010 11:03:20 AM, Info: Into ReadXmlData method.

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: BlobService

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: ServiceStatus

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: InputFileName

=====================

3/8/2010 11:03:20 AM, Info: InputFileName: 055ab6_3811019.pdf

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: Inbox

=====================

3/8/2010 11:03:20 AM, Info: Inbox: in

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: Outbox

=====================

3/8/2010 11:03:20 AM, Info: Outbox: out

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: Language

=====================

3/8/2010 11:03:20 AM, Info: Language: EN

=====================

3/8/2010 11:03:20 AM, Info: strReaderName: ad: OutputFormat

Documents

DocuShare Connect Administration Guide - Fuji Xeroxonlinesupport.fujixerox.com/driver_downloads/DocuShare Connect... · Page v About this Guide This guide provides details regarding