OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide

Transcription

1 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide

2 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide ii Edition OpenText RightFax 10.5 Connector for HP OXPd MFP. This document was last updated June 20, Trademarks OpenText is a registered trademark of OpenText Corporation. All other company names, brand names, and product names are the property and/or trademarks of their respective companies. Copyright Notice 2012 OpenText, Inc. All rights reserved. OpenText Corporation 275 Frank Tompa Drive Watterloo, Ontario, Canada N2L 0A1 (519) Portions of this product Copyright Glyph & Cog, LLC. Portions Copyright 2001 artofcode LLC. This software is based in part on the work of the Independent JPEG Group. This software is based in part on the work of the Freetype Team. Portions Copyright 1998 Soft Horizons. Portions Copyright 2001 URW++. All Rights Reserved. Includes Adobe PDF Library technology. Adobe, Acrobat and the Acrobat logo are trademarks of Adobe Systems Incorporated. Portions Copyright TMS, Inc All rights reserved.

3 Contents Chapter 1 Configuring the OpenText RightFax Connector for HP OXPd MFP... 5 Overview of the Connector for HP OXPd MFP...5 RightFax Server Support and Requirements...6 HP MFP Support and Requirements...6 Configuring Connector Settings on the RightFax Server...7 Installing the OpenText RightFax Connector for HP OXPd MFP on HP MFP Devices...7 Uninstalling the OpenText RightFax Connector for HP OXPd MFP from HP MFP Devices...9 Enabling NT Authentication...9 Securing Communication Channels...9 Troubleshooting the Connector for HP OXPd MFP Appendix A Understanding the RightFax External Document Connector...11 Overview of the RightFax External Document Connector...11 EDC Monitor Overview...11 Using EDC Monitor...11 Viewing and Clearing Processor Events...13 Working with Processor Services...14 Monitoring Remote EDC Processes...16 Advanced Configuration Overview...16 Adjusting the Advanced Configuration Settings...16 iii

4 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide iv

5 Chapter 1 Configuring the OpenText RightFax Connector for HP OXPd MFP Overview of the Connector for HP OXPd MFP With the Connector for HP OXPd MFP, you can link one or more of several supported HP Multifunction Products (MFPs) on your network to a RightFax server. Users can scan documents on the HP MFP and transmit them as fax or messages through the RightFax server. The Connector for HP OXPd MFP connects the RightFax server and HP MFPs by using a software module called the External Document Connector (EDC). The EDC monitors folders on your network called repositories for HP documents to process and transmit. All HP MFPs that will submit fax jobs to the RightFax server must be configured to store scanned documents in the same network folder that EDC will use as a repository. See your HP documentation for instructions on setting this folder location. Using the Connector for HP OXPd MFP, users scan and transmit faxes by following this basic process: 1. The user enters fax transmission information on the HP MFP and scans the document. The HP MFP saves the document as an image file, creates an associated job file and then saves the files in the repository folder on the network. 2. EDC picks up the files from the repository, converts the image file to a file format appropriate for use by the RightFax server, and then places it in the RightFax send queue for transmission. 3. The RightFax server transmits the file as a fax or message to the destination specified by the user. Localization support The following languages are supported by the Connector for HP OXPd MFP: English French French-Canadian Japanese Chinese Italian Spanish German Portuguese (Brazil) By default, the application appears in the language of the device. If the device language is not supported, English is used. 5

6 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 6 RightFax Server Support and Requirements The OpenText RightFax Connector for HP OXPd MFP is installed as part of RightFax 10.5 but must be purchased separately and activated through the Product Licensing Utility. Refer to the RightFax Installation Guide for specific information on server requirements and instructions for installing and activating optional modules. Note If you have upgraded a system that did not previously include EDC, you may need to add EDC separately. Run the RightFax Product Suite installer from the Windows control panel (Programs and Features or Add/Remove Programs). On the Select Features page of the installation wizard, select External Document Connector and follow the on-screen prompts. Also required: IIS 7.0 or later with File Transfer Protocol (FTP) Services enabled ASP.net The Repository Folder Outbound faxes originating from the HP device will be placed in a virtual folder called HPConnector Receiver in IIS on the server where RightFax is installed. This folder is created automatically when the Connector is added with the EDC Configuration Wizard. The location of the virtual folder is \RightFax\EDC\Modules\HPOXPd\FileStore Configuring a Walkup Account for Guest Users When RightFax 10.5 is installed, a user called Walkup is automatically created. The OpenText RightFax Connector for HP OXPd MFP is designed to use the Walkup account so users can create and send faxes from the HP OXPd MFP device even if they don t have a RightFax user account. The features that are available to these users depend upon how the Walkup user is configured. If you want to provide a general phonebook for guest users, you must create a phonebook for the Walkup account. If you want to allow users to send documents as , you must configure the Walkup account to use . For information about creating a user and configuring user profiles, refer to the OpenText RightFax Administrator s Guide. Users with accounts on the RightFax Server may log in at the HP OXPd MFP device using their RightFax user name and password. Features for sending faxes that are available to the user in the account are also made available on the HP OXPd MFP device. The following lists RightFax requirements and recommendations for users, including the Walkup user, to use the HP OXPd MFP to send faxes. Refer the OpenText RightFax Administrator s Guide for information about creating and configuring users. Create or import a personal phonebook (Recommended. The phone book option will not appear in the HP OXPd MFP interface if the user account does not have a phone book.) Configure the account to send (Recommended. The user will not have the option to send documents attached to if the user account is not configured to send .) Set up a default cover page for the account (All cover pages available to the user are also available for use with the HP OXPd MFP device.) HP MFP Support and Requirements In general, the Connector for HP OXPd MFP supports HP MFPs with OXPd 1.6 or later installed. For a list of supported HP MFP devices, see faxsolutions.opentext.com/hp-integration.aspx on the OpenText Web site.

7 Configuring Connector Settings on the RightFax Server To configure the Connector for HP OXPd MFP, use the EDC Configuration Wizard that is included as part of the RightFax server installation. To run the EDC Configuration Wizard: 1. On the Start menu of the RightFax server, click All Programs and then click OpenText. Click RightFax EDC Monitor. 2. If you are running EDC Monitor for the first time, you will be prompted to initialize EDC. Click Yes. The EDC Configuration Wizard appears. If EDC has already been initialized, EDC Monitor will open in its default Activity view. On the Tools menu, click EDC Configuration. 3. On the first page of the configuration wizard: If you are installing the connector for the first time, select Add/Remove modules and then click Next. If you want to make changes to an existing connector, select Modify a module and then click Next. 4. On the Add/Remove Modules page, select the HP OXPd MFP check box. If a Module Dependencies dialog box appears, click OK to continue; the additional modules will be installed automatically. Click Next. 5. On the Wizard Summary page, verify that the information is correct and click Next to configure the connector. 6. On the Select Module page, select HP OXPd MFP in the list of modules and then click Next. 7. On the Print Notifications? page, select Print Notification if you want a transmission status message to be automatically printed on the HP MFP each time it is used. Click Next. 8. On the Notifications? page, select Notifications if you want a transmission status message to be automatically ed to the sender for each fax sent. If you select this option, specify an SMTP server name, the address from which notification s should be sent, and a name that will appear as the sender of notifications. Click Next. 9. On the Wizard Summary page, review the information. Click Back to make changes, or click Finish if you are done. When you add this module, the following sites are created in IIS on the RightFax server: HPOXPd HPOXPddib HPConnectorReceiver After installation, ensure the the authentication mode is set to Anonymous for all of the above sites. You may need to start the services if they are not running. If the services are not running, perform the following steps: 1. On the Start menu of the RightFax server, click All Programs and then click OpenText. Click RightFax EDC Monitor. 2. On the EDC Monitor Tools menu, click Services. 3. Click Start All Services. 4. Click Close to close the window. Installing the OpenText RightFax Connector for HP OXPd MFP on HP MFP Devices To install the OpenText RightFax Connector for HP OXPd MFP on a HP OXPd MFP device, do the following: Configuring the OpenText RightFax Connector for HP OXPd MFP 7

8 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 8 1. Open a Web browser on the RightFax server. 2. In the address field, enter The Installation page appears. Figure 1.1 Installation Page To Install the connector on a single device 1. Select the Single Device option. 2. In the Device IP box, enter the IP address of the HP MFP. 3. In the Admin Password box, enter the administrator password of the device. 4. Click Install. To install the connector on multiple devices at once If you have a number of HP OXPd MFPs you d like to use with RightFax, you can create a CSV file of IP addresses and passwords, and use it to install the connector on multiple devices at once. The CSV file includes two required fields plus an optional field on each line. The required fields are the device IP and the administrator password. You can also include a third field that determines whether or not to include the device on this line when processing the CSV. Name the column header for the optional field Register. If the optional field is blank, Y, or Yes, the specified device will be included in the installation process. If not, this line will be skipped. Example: IPAddress,AdminPassword,Register <IP Address>,<Admin Password>,<Y or N> After the CSV file has been created, you can upload it by using the browser-based Installation page: 1. Select the Multiple Devices option. 2. For CSV File Path, click the Browse button and navigate to the location where the CSV file is located. 3. Map the columns of the CSV to the appropriate fields. In the CSV Columns area, enter the Device IP Column header label and the Admin Password Column header. If you are using the optional column, the header must be called Register.

9 Figure 1.2 Installation Page - Multiple Devices 3. Click Get Installed Connectors. A list of the installed connectors appears in the Installed Connectors area. Each connector is listed by IP address and has an Uninstall button. 4. Do one of the following: To uninstall the connector from an individual device, click its associated Uninstall button. To uninstall the connector from all devices, click Uninstall All. Enabling NT Authentication By default, users sign in to the connector with their RightFax credentials. You can enable NT Authentication so users can sign in with their Windows credentials. 1. Open a Web browser on the RightFax server. 2. In the address field, enter Figure 1.1 Uninstalling the OpenText RightFax Connector for HP OXPd MFP from HP MFP Devices To remove the OpenText RightFax Connector for HP OXPd MFP from an HP OXPd MFP device, do the following: 1. Open a Web browser on the RightFax server. 2. In the address field, enter The Installation page appears. The Installation page appears. 3. Click Configuration. 4. On the Configuration page, select the NTAuthentication check box 5. Enter the Domain Name on which users are authenticated. 6. Click Save. IIS will be restarted. Securing Communication Channels For increased security, you can use HTTPS instead of HTTP for: transferring scanned images to the repository folder communication with the web application user interface Configuring the OpenText RightFax Connector for HP OXPd MFP 9

10 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 10 Securing Scanned Image Transfer The Connector for HP OXPd MFP uses a scan receiver web site called HPConnectorReceiver to transfer scanned images to the repository folder. This site is created in IIS when the Connector is installed. To secure the HPConnectorReceiver site: 1. In IIS, configure the HPConnectorReceiver site with an HTTPS certificate. See your IIS documentation for more information. 2. In a text editor, open the the web.config file (RightFax\EDC\Modules\HPOXPd\webapp\web.config) and change the DestinationType value from http to https. 3. Save the configuration file. 4. Open a Web browser on the RightFax server. 5. In the address field, enter The Installation page appears. 6. Click Configuration. 7. Deselect the Use Anonymous check box. 8. In the Credentials area, enter the Domain Name, User Name, and Password to use for secure FTP. 9. Click Save. Securing the Web Application The Connector for HP OXPd MFP interface is a web application in IIS called HPOXPd. In IIS, configure the site with an HTTPS certificate. See your IIS documentation for more information. Troubleshooting the Connector for HP OXPd MFP Event Logging The connector application logs are saved to RightFax\EDC\Modules\HOPXPd\WebApp\logs\RightFax4HPOX Pd.txt The default logging level is Error. You can change the logging level to Warning, Information, or Verbose. To change the logging level, edit the configuration file. 1. In a text editor, open the the web.config file (RightFax\EDC\Modules\HPOXPd\webapp\web.config). 2. Edit the <switches> section to reflect the desired logging level: Example: <switches> <add name="rfswitch4hp" value="warning" /> </switches> 3. Save the configuration file. Application Timeout The application may time out while transmitting scanned image files of lengthy documents. If you are scanning unusually long documents, extend the application timeout period on the MFP. For more information, see the MFP documentation.

11 Appendix A Understanding the RightFax External Document Connector Overview of the RightFax External Document Connector The RightFax External Document Connector (EDC) is a module for RightFax that monitors repository folders for documents to process and transmit. The EDC processes jobs using a set of steps called a DataFlow. The DataFlow is comprised of several distinct processes called FlowPoints. Each FlowPoint acts on the job, and then passes it on to the next FlowPoint. Using EDC Monitor 1. On the RightFax server, click the Start menu, and then click Programs or All Programs. Click Open Text, and then click RightFax EDC Monitor. The EDC Monitor program window opens in its default Activity view. See Figure A.3. EDC Monitor Overview You can use the EDC Monitor program to: Monitor the status of the connectors and processors that EDC controls. Add and delete processor services. Configure EDC components with the configuration wizard. 11

12 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 12 Figure A.3 The EDC Monitor Activity View Table A1 explains each of the status columns. Table A1 EDC Monitor Activity Status Columns Installed modules are listed in the top left pane, and their DataFlows and individual FlowPoints are displayed in the bottom left pane. In the top right pane, all of the processors that are required by the FlowPoints are listed, and the separate instances of each processor are listed in the bottom right pane. Current status information is displayed for all objects listed in the EDC Monitor. Column heading Status Done Pending Errors Warnings Bad Jobs Activity Definition The EDC component s status. Possible values are: Failed - The component has shut down. Hung - The component is no longer responding. Job Errors - Errors prevented the image from processing. OK - The image was processed successfully. The total number of fax images that have been completed by this component. The total number of jobs currently queued for processing by this component. The total number of processing errors that have been logged by this component. The total number of processing warnings that have been logged by this component. The total number of jobs that could not be processed and have been abandoned by this component. The current active state of the component. Possible values are: Idle - The component is currently inactive. Processing Job - The component is currently processing a job. Paused - The component has been paused. No jobs will be processed. Shut Down - The component service is stopped.

13 Viewing and Clearing Processor Events Figure A.4 EDC Monitor Event Log EDC Monitor does not display errors that occur with individual processors. It will only report specific job files that have encountered errors. To check for errors in EDC processors, review the Event Log. Viewing Processor Events To view processor events in the Event Log: 1. In EDC Monitor, click the View menu, then click Event Log. A list of processors for which you can view events appears. See Figure A To view the event log for a processor, click its name in the Processor list. 3. To return to the EDC Monitor Activity view, click the View menu, and then click Activity. Tip You can update the Activity view or the Event Log by clicking the View menu and then clicking Refresh. Clearing the Event Log By default, events remain in the event log for 30 days. To clear the event log: 1. With EDC Monitor open, click the Edit menu and then click Clear All Events. 2. Click Yes to confirm that you want to clear all events. 13

14 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 14 Working with Processor Services EDC Manager and all of the individual processors that are managed by EDC are installed as services. You can use EDC Monitor to view the status of these services and to add and remove services. Viewing the Status of Services To view the status of services: 1. In EDC Monitor, click the Tools menu, and then click Services. Figure A.5 The Services Dialog Box Starting and Stopping Services To start or stop an individual service, select the service name and click Start Service or Stop Service. To start or stop all of the services, select the computer name at the top of the list and click Start All Services or Stop All Services. Adding Processors You can run a maximum of 16 of each type of processor. Processors can be run on the RightFax server or on remote computers. Note Although it is possible to install and configure more than 16 of each type of processor, only 16 of each will actually function at one time. To add new instances of a processor, do the following: 1. In EDC Monitor click the Tools menu, and then click Services. 2. If you want to add the service to a remote computer that is not listed, click Add Computer and enter the name of the remote computer. For additional requirements for remote processors, see About Adding Processors to a Remote Computer. 3. Select the computer to which you want to add the service and click Add Service. This opens the Add a Service dialog box. See Figure A.6. The Services dialog box displays the status of the EDC Manager service (which controls all of the processors) as well as the status of the individual processors.

15 Figure A.6 The Add a Service Dialog Box About Adding Processors to a Remote Computer Remote computers running EDC processor services must have access to certain folders on the RightFax server. To specify the location of the required shared folders: 1. In EDC Monitor, click the Tools menu and then click Advanced EDC Configuration. 2. Click the System tab and click the Core button. The EDC System Settings dialog box appears. 3. In the Remote Paths section of the dialog box, in the Root Directory box, enter the UNC path to the share name of the RightFax\EDC folder on the RightFax server. Example \\FaxServer\Program Files\RightFax\EDC 4. In the Shared Directory box, enter the UNC path to the share name of the RightFax\Shared Files folder on the RightFax server on which EDC is installed. Example \\FaxServer\Program Files\RightFax\Shared Files Removing Processors 4. In the Services list, select the service that you want to add. 5. In the Startup Type list, select the method that you want to use for starting the service. 6. In the Account box, enter the user name that the service will use to start up. This user account should have full administrative rights to the computer you selected in Step In the Password box, enter the password for the user account. 8. In the Confirm Password box, enter the password again. 9. Click OK. Warning At least one service must be present for each process type for the system to function. To remove processors: 1. In EDC Monitor click the Tools menu, and then click Services. 2. Select the name of the service you want to remove. 3. Click Stop Service. 4. After the service has stopped, click Remove Service. 15

16 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 16 Monitoring Remote EDC Processes You can use EDC Monitor to view the monitoring statistics of a remote EDC processor. To view remote processes in EDC Monitor: 1. On the File menu, select Close to close the current connection. 2. On the File menu, select Remote Connection. 3. In the Connect to Which Computer? box, enter the name of a remote computer on which the EDC services are running. The Activity view will display the statistics for the remote server. 4. To switch back to the local computer, select Local Connection on the File menu. Note Even though you can monitor remote EDC services, you can only configure services on the local computer. To configure remote services, log on to the computer that is running the services, run EDC Monitor locally, and then use the Configuration Wizard or Advanced Configuration. Advanced Configuration Overview The External Document Connector and its individual modules usually only require the configuration options available in the EDC Configuration Wizard. A number of advanced configuration options are also available, many of which were designed for use in troubleshooting in conjunction with OpenText Customer Support and do not apply to the normal operation of EDC or its connectors. Advanced configuration is typically only necessary for: Setting the logging level for an individual process for troubleshooting purposes Adjusting the delay between processes - anywhere from 5 minutes to 24 hours Pausing processing to troubleshoot a job file with the help of an OpenText Customer Support representative Debugging a process with the help of a OpenText Customer Support representative Warning: Always use caution when performing advanced configuration in EDC Monitor. If you are not certain about the changes you are making, contact OpenText Customer Support for assistance. Adjusting the Advanced Configuration Settings 1. In EDC Monitor, click Tools, and then click Advanced EDC Configuration. 2. In the Module list, click the module you want to edit and then click Edit. The Module Configuration window can be used for: Setting Advanced Repository Options Setting DataFlow Options and Filtering FlowPoints

17 Setting Advanced Repository Options In the Module Configuration window, click the Scanning Options button. To Change the interval at which the RightFax server checks the repository directory for jobs Stop the RightFax server from checking the repository for new jobs Save copies of repository job files Do this Click a time interval in the Scan Interval list. Select the Pause scanning for new jobs check box. Click Save copies of new job files and specify a directory in which to save them. Setting DataFlow Options Each EDC module processes documents through a series of steps called a DataFlow. The DataFlow consists of individual processes called FlowPoints. Some FlowPoints have configurable options. Warning: Always use caution when editing DataFlows in EDC Monitor. If you are not certain about the changes you are making, contact OpenText Customer Support for assistance. 1. To configure DataFlow options, click the name of the connector you want to edit in the DataFlows list and then click Advanced Options. 2. In the FlowPoints list, click a FlowPoint. Some FlowPoints have configurable tasks. 3. In the Options for Individual Tasks list, click the task, and then click Edit Task. Only some tasks are editable. Filtering FlowPoints Some FlowPoints have a filter option that defines which jobs will be processed by that FlowPoint. By default all FlowPoints process all jobs. For each configurable FlowPoint, you can specify which jobs to process with keyword and value pairs in the format of this example: {userid}=sales. You can create filters based on any keyword in the job file. Filters can either include or exclude jobs. Jobs are then passed on to the next FlowPoint. In some cases, including print and notification FlowPoints, the same filter must be added in several related FlowPoints in order to function as expected. Keywords and data are not case-sensitive. Type a semicolon between each keyword/value pair. The semicolon acts as a logical OR statement; Jobs that meet any one of the criteria will be 17

18 OpenText RightFax 10.5 Connector for HP OXPd MFP Administrator s Guide 18 considered a match for the filter. The data in the job file must match the value in the filter exactly to be filtered. For example, the filter {userid}=sales will not match a userid of sales23. Warning: Always use caution when filtering FlowPoints in EDC Monitor. If you are not certain about the changes you are making, contact OpenText Customer Support for assistance. 1. To set up filters for a FlowPoint, click its name in the FlowPoints list. 2. In the Overall Options for this Flowpoint section, click the Jobs to Process button. 3. Click Process only the jobs that meet the filter conditions. 4. To include jobs, enter keyword/value pairs in the Include box. To exclude jobs from the FlowPoint and pass them to the next FlowPoint, enter keyword/value pairs in the Exclude box. 5. Click OK. When you are finished configuring options and filters, click the Close button to close the DataFlow window. Click Close to close the Module Configuration window, and click OK to close the EDC Configuration window.