RightFax Connector for IBM Filenet Administrator Guide

OpenText RightFax CE 21.2Connector for IBM FileNet

Administrator Guide

Edition

OpenText RightFax CE 21.2 Connector for IBM FileNet

June 25, 2021

Copyright © 2021 Open Text. All Rights Reserved. Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit, https://www.opentext.com/patents.

Open Text Corporation275 Frank Tompa DriveWaterloo, Ontario, CanadaN2L 0A1(519) 888-7111http://www.opentext.com

Copyright Statement

Portions of this product Copyright © 2002-2006 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.

Disclaimer

NoWarranties and Limitation of Liability. Every effort has been made to ensure the accuracy of the features and techniques presented in thispublication. However, Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for theaccuracy of this publication.

OpenText RightFax CE 21.2 2 Connector for IBM FileNet Administrator Guide

https://www.opentext.com/patents

http://www.opentext.com/

Contents

Chapter 1: Installing the Connector for IBM FileNet 4

Overview of the Connector for IBM FileNet 4

Overview of installation 4

Configuring the RightFax server 4

Installing the inbound client 7

Chapter 2: Installing and configuring the RightFax inboundclient 9

Overview of the RightFax inbound client and FileNet CaptureProfessional 9

Creating a capture path 9

Configuring the RightFax inbound client 10

Enabling fax document indexing in FileNet 12

Customizing the RightFax inbound client 14

Chapter 3: Installing and configuring the RightFaxoutbound client 17

Installing and configuring the RightFax outbound client 17

Installing the RightFax outbound client on the FileNet Printserver 18

Creating the fax printer 18

Starting the FileNet Print Service 20

Starting FileNet Fax Manager 21

Sending a Fax via RightFax from the IDM Viewer 21

Appendix A: RightFax document data fields 23

OpenText RightFax 3 Connector for IBM FileNet Administrator Guide

Chapter 1: Installing the Connector for IBM FileNet


Overview of the Connector for IBM FileNetWith the RightFax Connector for IBM FileNet you can:

l Send documents from your FileNet data repositories as faxes viathe RightFax server.

l Automatically or manually index fax documents received via theRightFax server.

l Use capture paths to commit RightFax documents to a documentdata repository.

l Use FileNe tFax Entry to commit RightFax documents to adocument repository.

l Print archived RightFax documents based on document data, suchas the RightFax user ID, billing information, or job type (received,sent, or print job).

l Configure archiving for specific RightFax users and groups. Youcan choose to archive sent, received, forwarded, routed, anddeleted faxes.

Overview of installationBefore you install the Connector for IBM FileNet, verify that yourRightFax server and IBM FileNet systems meet the followingrequirements:

l RightFax server version CE 21.2.

l FileNet Capture Professional version 5.2, with all available patchesapplied.

To install and configure the Connector for IBM FileNet, complete thefollowing steps:

1. Activate the Connector for IBM FileNet through the ProductLicensing Utility. See the RightFax Installation Guide forspecific information on server requirements and instructions foractivating optional modules.

2. Configure the RightFax server. See Configuring the RightFaxserver below.

3. Install the RightFax inbound client on the Capture Professionalworkstation. See Installing the inbound client on page 7.

4. Optionally install and configure the RightFax outbound client.See Installing and configuring the RightFax outbound client onpage 17.

Configuring the RightFax serverAs soon as the Connector for IBM FileNet is activated on the RightFaxserver, it will begin queuing fax documents for delivery to theConnector for IBM FileNet. These fax documents will remain queuedbut unprocessed while you install and configure all of the connectorcomponents.



The following faxes can be archived:

l Faxes sent by the RightFax server or forwarded to a fax numberoutside the RightFax system.

l Faxes received by the RightFax server.

l Faxes forwarded to users within the RightFax system.

l Faxes routed to users within the RightFax system.

l Deleted faxes, including faxes deleted as part of the fax agingprocess.

To configure the RightFax server1. In RightFax Web Admin, in the left pane, click System.

2. In the right pane click Integrations. Under Post FaxProcessing, click Configure Connector for IBM FileNet. TheConfigure Connector for IBM FileNet dialog box opens.

3. In the Default repository path box, enter the location on thenetwork to save the fax images where Connector for IBM

FileNet will pick up inbound faxes for processing. This pathmust match the path that is specified for the Job Directory inConfiguring the RightFax inbound client on page 10.

4. ClickOK.5. Under Post Fax Processing, click Faxes to Process. The

Faxes to Process dialog box opens.

6. In the Sends, Receives, Forwards, Routes, and Deletes lists,select the files that will be processed by Connector for IBMFileNet.l Disabled. To not save faxes of this type.

Note Use this option for Deletes if you control deletedfaxes using the PurgeImagesOnPurge registry key.

l By user. To save faxes of this type for RightFax users whohave the corresponding external processing enabled.

l By group. To save faxes of this type for user groups thathave this feature enabled.



l All. To save all faxes of this type regardless of userpermissions and group settings.

7. To route faxes from InterConnect to Connector for IBM FileNet,under Include InterConnet select Enabled. For informationabout InterConnect, see RightFax Administrator Guide.

8. In FaxUtil and FaxUtil Web, users can submit faxes for externalprocessing. To provide this option for users, then under UserSubmitted, click Enabled.

9. ClickOK.

10. If you selected By User or By Group, specify the users andgroups for whom to archive faxes. See Configuring archivingfor users or groups below.

Configuring archiving for users or groupsIf you specified in the server configuration to archive faxes by user orby group, then you must configure the RightFax users or groups.

RightFax users do not have an option to override these settings in theRightFax client applications.

To configure users1. In Web Admin, in the left pane click Users. The list of RightFax

users appear in the right pane.

2. Select the user in the list, and then click Edit. The Edit Userwindow opens.

3. Click the Post Fax Processing tab.

4. To specify the type of fax to process for this user, then underFaxes to process click By action. Select any of the following:l Sent. Faxes sent by the RightFax server or forwarded to afax number outside the RightFax system.

l Received. Faxes received by the RightFax server.

l Forwarded. Faxes forwarded to users within the RightFaxsystem.

l Routed. Faxes routed to users within the RightFax system.

l Deleted. Deleted faxes, including faxes deleted as part ofthe fax aging process.

5. To specify a user's RightFax mailbox folder that will bemonitored for processing, then under Faxes to process clickBy folder. Enter the name of the folder.



l If a user has multiple folders with the same name, then usea different folder that is unique.

l If the folder does not already exist, the system will create it.

l If the user deletes the folder from their mailbox, then postfax processing will not occur.

6. Select Connector for IBM FileNet.

1. ClickOK.

To configure groups1. In Web Admin, in the left pane clickGroups. The list of

RightFax groups appear in the right pane.

2. Select the group in the list, and then click Edit. The Edit Groupwindow opens.

3. Click the Post Fax Processing tab.

4. Select Connector for IBM FileNet.

5. ClickOK.

Installing the inbound clientAfter the Connector for IBM FileNet has been activated andconfigured, install the inbound client for the Connector for IBM FileNeton the Capture Professional workstation.

The RightFax inbound client organizes the fax documents intobatches (including the fax images and document data that can beused for indexing purposes) and imports them into FileNet CaptureProfessional. The RightFax inbound client passes files into FileNetCapture Professional or to FileNet Fax Entry, which moves them intothe FileNet repository.

Caution Do not install the RightFax inbound client on the RightFaxserver, even if the RightFax server has FileNet Capture Professionalinstalled.

To install the install the inbound client for the Connector forIBM FileNet

1. Download the RightFax Connector for IBM FileNet clientsoftware from https://mysupport.opentext.com. The .zip filecontains two setup files: RightFax Connector for IBM FileNetInbound Client and RightFax Connector for IBM FileNetOutbound Client.

2. Log on to the Capture Professional workstation.

3. Run RightFax Connector for IBM FileNet InboundClient.exe on the Capture Professional workstation.

4. Click Next on the opening page to view the license agreement.Accept the license agreement to continue the installation. ClickNext.

5. Click Install. When the installation is complete, click Finish.



To add the RightFax.ocx Capture Professional component1. On the same Capture Professional workstation where you

installed the RightFax inbound client, open Capture Manager.

2. Click Add next to the Components list. The Add CaptureComponent dialog box opens.

3. Navigate to the RightFax folder under the Capture\Programsfolder and click the component file RightFax.ocx.

4. Click Close to close Capture Manager.


Chapter 2: Installing and configuring the RightFax inbound client


Overview of the RightFax inbound client andFileNet Capture ProfessionalThe RightFax inbound client supports the Capture Professional FaxEntry feature. With a few exceptions, the instructions in this section forconfiguring the client to work with Fax Entry are the same as those forthe FileNet product.

Fax Entry commits three types of data to a repository or to a specificlocal or network directory. Each type of data is described in thefollowing table.

Data DescriptionInbound faxes Fax Entry accepts faxes from a remote location

through a RightFax server.Imported files Fax Entry processes all files it finds in a specified

directory.Journal entries createdby Fax Entry

Fax Entry creates a journal log, recording events thatoccur as inbound faxes or imported files areprocessed.

Creating a capture pathCapture paths automate the process of committing documents into aFileNet data repository after they have been received by Capture

Professional. They are not required if you use Fax Entry to commit faxdocuments to the FileNet data repository.

The following instructions show creating a capture path that commitsall available RightFax documents to a FileNet data repository. Othercapture path configurations can be created to meet the needs of yourorganization.

Using a new repositoryThe capture path can commit fax documents to a new or existingrepository. If you want to use a new repository, create it beforebeginning this procedure. For information on creating a newrepository, see the FileNet documentation.

To create a capture path for RightFax documents1. Run Capture Professional and click the repository where you

are storing fax documents.

2. On the Filemenu, click New, and then click Capture Path. TheIBM FileNet Capture Path wizard opens. Click Next on theintroduction page.

3. Click the repository where you want inbound fax documents tobe stored. Click Next.

4. In the Name box under Define New Capture Path, type aname for the new capture path, and then click Next. Leave theremaining options unchanged.



5. Move the following capture path components from theComponents list into the list under the name of your newcapture path in the order they are listed here:l RightFax Fax

l Assembly

l Index

l Commit

Note When using the Document/Page processing mode,assembly is unnecessary (See Customizing the RightFaxinbound client on page 14).

6. After moving the capture path components, click Next. Thisopens the Capture Path Layout window (a flow chartillustrating the data flow through your capture path).

7. Select theMaximize option.

8. Verify that the added components are laid out in this order:Begin > Fax > Assembly > Index > Commit > End

Note Only Begin and Fax are required components of a pathfor RightFax documents. This capture path commits allavailable RightFax documents to the data repository.

9. Click Save/Stop to add a new Save/Stop object between theCommit and End objects.

10. On the Assembly object, locate the box labeled Empty.Position the cursor over this box. The cursor changes to adouble arrow. Drag the box from the Assembly object to theSave/Stop object.

11. Click Save/Cont. to add a new Save/Cont. object between theSave/Stop and End objects.

12. On the Save/Cont. object, locate the box labeled Empty.Position the cursor over this box. The cursor changes to adouble-arrow. Drag the box from the Save/Cont. object to theRightFax Fax object.

The final diagram should look like this:

13. Click Next.

14. Click Finish to close the IBM FileNet Capture Path wizard.

Configuring the RightFax inbound clientTo configure the RightFax inbound client, create and configure a newsettings collection and template for RightFax documents.

To create a new settings collection1. Under the Config container in the repository where you want

inbound fax documents to be stored, click Settings.

2. On the Filemenu, click New, and then click Settings.

3. On the introduction page of the IBM FileNet Capture SettingsWizard, click Next.




5. Under Define new Settings Collection, in the Name box, typea name for the new settings collection, and then click Next.Leave the remaining options unchanged.

6. If you created a new document class for indexing (described onEnabling fax document indexing in FileNet on the next page),click the document class name, and then click Next.

7. On the Component Configuration page, click RightFax Faxand click Configure. The RightFax Connector for FileNetCapture Professional Properties dialog box appears.

8. In the Connector Name box, enter the name for this connectorin this settings collection. You can define unique connectors forsettings collections.

9. If you are configuring the RightFax client to work with FaxEntry, in the Polling Interval in Minutes box, enter the intervalthat Fax Entry will poll the connector for documents. Enter anumber of minutes.

10. In the Job Directory box, type the path to the FileNet folder onthe source RightFax server. Type the UNC path to a folder onthe server or the absolute path to the folder on the local

computer. Click Apply, and then clickOK.

Note This step is required to enable communication betweenthe RightFax source server and the Capture module. Thereare several additional options in this dialog box that let youcustomize the operation of the connector. For a completedescription of all of the options in this dialog box, seeCustomizing the RightFax inbound client on page 14.

11. Click Next, and click Finish to close the IBM FileNet CaptureSettings Wizard.

To create a new template1. In Capture Professional, under the Config container, click

Templates.

2. On the Filemenu, click New, and then click Template.

3. On the introduction page of the IBM FileNet Capture TemplateWizard, click Next.


5. Under Define new Template, in the Name box, type a namefor the new template, and then click Next. Leave the remainingoptions unchanged.

6. On the Available Settings Collections page, click the name ofthe settings collection you created in the previous section, andthen click Next.

7. Click one of the following options:l If you are configuring a template for Fax Entry, click Next toskip this step.

l If you have configured a capture path for RightFax Faxdocuments (described on Creating a capture path on



page 9) click the capture path in the Capture Path box, andthen click Next

8. Click Finish to close the IBM FileNet Capture TemplateWizard.

To create a new batch1. In Capture Professional, right-click the Test container, and then

click New Batch.

2. In the Batch name box, type a name for the new batch.

3. Under Create based upon the following Template, click thetemplate you created previously from the list.

4. ClickOK.

Enabling fax document indexing in FileNetTo automatically index fax documents when they are committed to adata repository, specify the data fields you want indexed and linkthose fields to the data that is included with RightFax documents.

Important These instructions are specific to FileNet ImageServices. If you are using the RightFax inbound client to commitdocuments to a data repository in a different product, review theseinstructions and apply the principles for document indexing to yourspecific product.

Manual indexing also is available in Capture Professional. Refer to theCapture Professional documentation for more information.

The following instructions assume that you have access to and arefamiliar with the FileNet Image Services server. If you need furtherinformation on any of the dialog boxes or options described in thissection, refer to the FileNet documentation.

To enable fax document indexing1. On the Image Services server, run Application Executive.

2. On the Applicationsmenu, click Database Maintenance.

3. Click Define/Update Family.

4. Complete the Define/Update Media Families dialog boxaccording to your organizational requirements. The family youconfigure here will contain a new document class for RightFaxdocuments. You can either create a new family or select anexisting one.

5. On the Filemenu, click Save to save the settings, and thenclick Exit to return to the Database Maintenance dialog box.

6. Click Define/Update Index.

7. For each data field that you want to index, complete the entriesin the Define User Indexes dialog box according to yourorganizational requirements.

The index fields you add here must correspond to (but do notneed to have the same names as) the data fields that areincluded with RightFax documents. For a list of the RightFaxdocument data fields, see RightFax document data fields onpage 23.

8. On the Filemenu, click Save to save the settings, and thenclick Exit to return to the Database Maintenance dialog box.

9. Click Define/Update Class.

10. Complete the Define/Update Document Classes dialog boxaccording to your organizational requirements. The documentclass will be used for all RightFax documents archived in yourImage Services system.

11. On the Filemenu, click Save.

12. On the Indexmenu, click Edit.



13. On the User Defined Index dialog box, add each of the indexfields you created in step 7.

14. When all of the index fields have been added, click Cancel, andclick Close to return to the Database Maintenance dialog box.

15. On the Filemenu, click Save to save the settings, and thenclick Exit to close the Database Maintenance dialog box.

16. To ensure that the changes take effect, stop and restart theImage Services server.

Mapping RightFax document dataIf you set up your Image Services server to index archived RightFaxdocuments (see Enabling fax document indexing in FileNet on theprevious page), follow these steps to enable indexing.

Note These instructions provide information on options required toenable indexing of RightFax document data only. For moreinformation about indexing options, refer to the FileNetdocumentation.

To map RightFax data to your index1. On the Capture Professional workstation, run Capture

Professional.

2. Click the new setting you created in the previous step. On theToolsmenu, click Start, and then click RightFax Fax. You canalso click the fax button on the toolbar.

3. Click the RightFax settings collection you created. On theToolsmenu, click Configure, and then click Index. The IBMFileNet Capture Index Control Properties dialog boxappears.

4. On theGeneral tab, select the Set fields by priority option,and then click Auto Index, Default, Stored in the list.

5. If you set up a capture path to automate moving fax documentsinto the repository (See Creating a capture path on page 9),select the Process documents using initial values abovecheck box.

6. Click the Field tab.

7. Click the first index field in the list and click Configure. TheField Properties dialog box opens.

8. Click the Input Masks tab.

9. In the Default field value box, type a value that will populatethis index field if the data is unavailable in the RightFaxdocument.



10. Click the Auto-Index tab.

11. In the Source Group box, click FAX.

12. In the Source Name box, click the RightFax field thatcorresponds to the index field you are mapping. For a list ofRightFax fields, see RightFax document data fields on page 23

13. Click Append Auto Index String. An index string appears inthe Auto Index string box.

14. ClickOK.

15. Repeat these steps for each index field listed in the IBMFileNet Capture Index Control Properties dialog box.

16. When each index field in the IBM FileNet Capture IndexControl Properties dialog has been configured, click Apply,and then clickOK to close the dialog box.

Customizing the RightFax inbound clientYou can customize the RightFax inbound client by configuring batchesof documents and specifying criteria for which documents to import.

Specifying the volume of documents to processFileNet Capture Professional requires that all documents be archivedin the form of batches.

Batches are distinct groups of documents and document data thathave been formatted for FileNet Capture Professional. You canspecify the format of batches to process and number of RightFaxdocuments in each batch.

To configure batches of documents1. In FileNet Capture Professional, choose your settings

collection for RightFax documents (to set the defaultconfiguration for all batches) or choose an individual batch (toconfigure that batch only).

2. On the Toolsmenu, click Configure and click RightFax Fax.

3. On the RightFax Connector for FileNet CaptureProfessional Properties dialog box, click the DocumentOptions tab.

4. Select a Processing Mode from the list:

Pages Only with Batch Breaks. This option creates a batchfor each fax and requires assembly before documents can bepassed to the repository.



Pages Only with Document Breaks. This option createsmultiple fax documents under the batch where they werereceived and requires assembly before documents can bepassed to the repository.

Document/Page. This option creates multiple fax documentsunder the batch where they were received, and does notrequire assembly before documents can be passed to therepository.

Note Because the Document/Page processing mode isdemanding on system resources, use this option only if youare unable to use the other two processing modes.

5. In theMaximum Faxes box, enter the maximum number of faxdocuments that will be pulled from the job folder at one time.Enter a number from 1 to 20.

Tip If the batch already contains faxes, the number of faxesyou enter in this box will be added to the existing faxes in thebatch.

6. Enter the maximum number of individual fax pages that will bepulled from the job folder at one time. Enter a number from 1 to999.

7. Click Apply, and then clickOK.

Defining which documents to importThe RightFax inbound client organizes RightFax documents intobatches and imports them into FileNet Capture Professional. You cancreate a filter that limits the documents to import based on RightFaxdocument data filters, such as a RightFax user ID or billing code.

To specify criteria for documents to import1. In Capture Professional, choose your settings collection for

RightFax fax documents (to set the default configuration for all

batches) or choose an individual batch (to configure that batchonly).

2. On the Toolsmenu, click Configure and click RightFax Fax.The RightFax Connector for FileNet Capture ProfessionalProperties dialog box appears.

3. Click the Connector Options tab.

4. To specify documents that should be imported from this clientbased on RightFax document characteristics, in the FilterMode list, select a filter mode.l All Filtering. All documents are imported.

l Cooperative Filtering.Multiple capture paths monitor onejob directory for documents. With cooperative filtering, jobsremain stored in the job directory and one of the RightFaxConnectors for Capture Professional imports them. Criteriafor importing documents are based on keywords youspecify in the Include Filter and Exclude Filter boxes.

Use cooperative filtering when you want to use multiplefilters. If a job doesn't meet one filter's criteria, the job stays



in the job directory until it is picked up by the appropriatefilter.

l Exclusive Filtering. A single client evaluates and importsfiles from this job directory. Criteria for importing documentsare based on keywords you specify in the Include Filterand Exclude Filter boxes. The client evaluates the filtercriteria and imports the documents that meet the criteria. Ifthe filter criteria are not met by the document, the clientpasses the document to the Print processor.

Use Exclusive filtering if you want to process only certainjobs and reject anything that does not meet the filter criteria.You can have more than one workstation running in thismode only if they have identical filters.

5. Under Filters, specify filter keywords.l To process only certain documents, enter keywords fordocuments that you want to process in the Include Filterbox.

l To process most jobs, but exclude jobs that meet your filtercriteria, enter keywords in the Exclude Filter box.

The client evaluates criteria in the Exclude Filter box first,overriding criteria in the Include Filter box.

Example To capture Sales faxes on one workstation, Marketing faxeson another workstation, and all other faxes, excluding Sales andMarketing faxes, on a third workstation, set up the filters as follows:

l Sales workstation: In the Include Filters box, enter{UserID}=Sales. Leave the Exclude Filters box empty.

l Marketing workstation: In the Include Filters box, enter{UserID}=Marketing. Leave the Exclude Filters box empty.

l Third workstation: Leave the Include Filters box empty. In theExclude Filters box, enter {UserID}=Sales;{UserID}=Marketing.


Chapter 3: Installing and configuring the RightFax outbound client


Use the RightFax outbound client for Connector for IBM FileNet tosend images from a FileNet data repository as faxes via the RightFaxserver.

With the RightFax outbound client for FileNet, the RightFax server isconfigured as a generic fax printer on a FileNet Print server. When auser prints to this fax printer from the FileNet IDM desktop client, theuser is prompted for fax addressing information. The image andaddressing information are sent to the RightFax server fortransmission.

The following diagram illustrates the process of faxing a documentfrom FileNet via a RightFax server.

Installing and configuring the RightFaxoutbound clientTo upgrade to the RightFax outbound client for RightFax Connectorfor IBM FileNet from any previous version, you must first uninstall theold version in the Windows Control Panel.

Note When you uninstall the RightFax outbound client for RightFaxConnector for IBM FileNet, all of the module settings andconfigurations are removed. Make a note of the settings before youuninstall it.

Before you begin, verify that your RightFax server and FileNetsystems meet the following requirements:

l The RightFax server is version CE 21.2 with the most recentfeature packs and service releases installed.

l Install the Microsoft Visual C++ Redistributable for Visual StudioVS2019_vcredist_x86.exe on the FileNet Print server where youwill install the RightFax outbound client for RightFaxConnector forIBM FileNet.

l Install and configure FileNet Print version 4.4 on a FileNet Printserver on your network. The FileNet Print server must be aseparate computer from the RightFax server.

To install and configure the RightFax outbound client forFileNet

1. Install the RightFax outbound client on the FileNet Print server.See Installing the RightFax outbound client on the FileNet Printserver on the next page.

2. Create the fax printer. See Creating the fax printer on the nextpage.



3. Start the FileNet Print Service. See Starting the FileNet PrintService on page 20.

4. Start FileNet Fax Manager. See Starting FileNet Fax Manageron page 21.

Installing the RightFax outbound client on theFileNet Print serverInstall the RightFax outbound client for RightFax Connector for IBMFileNet on each FileNet Print server that will support faxing viaRightFax.

To install the outbound client1. Download the RightFax Connector for IBM FileNet client

software from https://mysupport.opentext.com. The .zip filecontains two setup files: RightFaxConnector for IBM FileNetInbound Client and RightFax Connector for IBM FileNetOutbound Client.

2. On the FileNet Print server run RightFax Connector for IBMFileNet Outbound Client.exe, following the on-screeninstructions.

Creating the fax printerAfter you install the RightFax outbound client on the FileNet Printserver, create a fax printer, and then configure the fax print queue onthe print server.

Documents printed to the fax printer will be routed to the RightFaxserver for transmission.

Creating the fax printer on the FileNet serverThese instructions are specific to FileNet Image Services. To create afax printer in a different FileNet product, review these instructions and

apply the principles to creating the fax printer in the other FileNetproduct.

To create the fax printer1. On the Image Services server, run the IBM FileNet

Configuration Editor. On the Startmenu, click Programs, andthen click FileNet Image Services - System Configuration.

2. Click Configuration Editor.

3. In theOpen Configuration Database dialog box, enter thedatabase and domain name of the Image Services server toconfigure. Verify that the Read-only option is not selected, andthen clickOK.

4. In the FileNet Image Services -System Configuration Editor,click the Procedures tab.

5. Click Add a Printer, and then click Run.

6. On the Add a Printer dialog box, click Fax as the printer type,and then click Next.

7. Type a name for the new fax printer, and then click Next.

You cannot include spaces in the name of the printer.Substitute underscores or other characters for spaces in theprinter name (for example, OpenText_Fax_Printer).

8. Enter the IP address of the FileNet Print server, and then clickNext.

9. Select the paper sizes to support, and then click Next.

10. Select the fax resolutions to support, and then click Next.

11. Specify if you want to set the printer as the default printer, andthen click Next.

12. When you see the message Edit procedure completedsuccessfully, clickOK.



13. To confirm the new printer has been successfully added, clickthe Printing tab, and then the Printers tab. The new printershould appear in the list of available printers.

14. Close the FileNet Image Services - System ConfigurationEditor. Click Yes to save the changes.

15. Restart the Image Services server.

Configuring the fax print queue on the FileNet PrintserverThis step configures the fax print queue on the FileNet Print server tocommunicate with the RightFax server.

All documents sent to the RightFax server via this fax print queue willbe associated with a single RightFax user ID.

The properties and permissions of this user ID will be used for alloutbound faxes sent from the Image Services repository.

You can use any existing user ID. You can also create a specialRightFax user ID dedicated to faxes originating from IBM FileNetusers.

To configure the Fax print queue1. On the Startmenu of the FileNet Print server, click Programs,

and then click FileNet Print.

2. Click FileNet Service Control.

3. In the FileNet Print Service Control dialog box, clickConfigure.

4. In the FileNet Print Configuration dialog box, under ImageServices Selection, click the domain name for the Print serveryou are configuring.

The name of the fax printer you created on the Image Servicesserver appears in the FileNet Queues to Configure list.



5. Click the fax printer name, and then click Configure.

6. In theGENERIC_FAX Printer Configuration dialog box, inthe Server Name box, enter the name of the RightFax server.

7. In the Server Type box, click RightFax Server.

8. In the Logon Name box, type the name of a RightFax user ID.

This is the user ID on the RightFax server that all outboundfaxes will be assigned to.

9. In the Password box, type the password for the RightFax userID you entered in the Logon Name box.

10. Under PostScript, clear the Send “Exitserver” Commandscheck box.

11. Complete the remaining entries in this dialog box according toyour requirements, and then clickOK.

12. In the FileNet Print Configuration dialog box, click Fonts.

13. In the Fonts and Character Sets dialog box, complete theentries in this dialog box according to your requirements, andthen clickOK.

Starting the FileNet Print ServiceIn FileNet Print, the FileNet Print Service monitors the server andpicks up print requests for the printers configured on the Print server.

The FileNet Print Service must remain running on the Print server tocontinually monitor the server.

To start the FileNet Print Service1. On the Startmenu, click Programs, and then click FileNet

Print.

2. Click FileNet Print Service Control.

3. In the FileNet Print Service Control dialog box, click Start.

4. To show or hide a log of print service activity, click Show/HidePrint Administrator.



5. After you start the FileNet Print Service, you can minimize thewindow, but do not close the application.

Starting FileNet Fax ManagerFileNet Fax Manager requests and processes fax addressinginformation for print jobs sent to fax printers.

It must remain running on the Print server to process print jobs sent tofax printers.

Tip To update the status of faxes from RightFax, refresh the FileNetFax Manager screen.

To start FileNet Fax Manager1. On the Startmenu, click Programs, and then click FileNet

Print.

2. Click FileNet Fax Manager.

3. After you start FileNet Fax Manager, you can minimize thewindow, but do not close the application.

Sending a Fax via RightFax from the IDMViewerAfter the fax printer is created and properly configured, you are readyto send faxes from the IDM Viewer.

To send a fax from the IDM Viewer1. On any IBM FileNet client computer, run FileNet IDM Viewer.

2. Load an image from the data repository.

3. On the Filemenu, click FileNet Print/Fax.

4. In the Name box, click the name of your fax printer.

5. Click Properties. The FileNet Printer/Fax dialog box appears.



6. Under Fax Options, in the Phone number box, type thedestination fax number. This is a required entry. All otherentries are optional:l Text in the From, To, Subject, andMemo boxes willappear on the fax cover sheet.

l Text in the Subject andMemo boxes will appear in theNotes section of the fax cover sheet.

7. Complete the fax addressing information, and then click SavePrint/Fax Settings.

8. ClickOK to send the fax.


Appendix A: RightFax document data fields

Appendix A: RightFax document data fieldsThe following table lists the data fields that are included with each RightFax document that can be used to index fax documents that have beenarchived in an Image Services repository.

l The data field column lists each RightFax document data field. The corresponding index fields on the Image Services server need not be identicalto these.

l Use the data in the field type and maximum length columns when configuring data fields in the FileNet Image Services system.

l The fax type column indicates whether the data is included with sent or received faxes. Some data is included with sent faxes only, some data isincluded with received faxes only, and some data is included with both sent and received faxes.

Data field Fieldtype

Max. length Fax type Description

BillingInfo1 String 15 Sent Billing code 1, if defined on the RightFax server.BillingInfo2 String 15 Sent Billing code 2, if defined on the RightFax server.CallerID String 21 Received The RightFax user ID of the mailbox where the fax was received. This data is available

if the fax board supports it.Caller Station ID String 21 Received The caller subscriber ID (CSID) of the recipient fax machine.Date Date N/A Sent/Received The date that the fax was sent or received. The date is stored in the format

YYYY/MM/DD.DateTime Special N/A Sent/Received The date and time that the fax was sent or received. The data is stored in the format

YYYY/MM/DD HH:MM:SS.DID/DTMF/ANI String 21 Received The DID or DTMF code or the ANI routing data for the RightFax user who received the

fax (if defined on the RightFax server).





FaxAttributes String Variable Sent/Received A custom string showing key attributes of the fax in the format “FaxAttributes (Attribute,Attribute, ...)”. Available attributes are:

l Broadcast

l Gateway

l Production

l InternetLink

l WinFax

Fax Channel Integer N/A Received The channel number on the RightFax server that received the fax.Fax Server String 31 Received The name of the RightFax server where the fax was received.FromCompanyFaxNumber String 31 Sent The fax number of the sender’s organization.FromCompanyVoiceNumber String 31 Sent The voice number of the sender’s organization.FromFaxNumber String 31 Sent The sender’s personal fax number.FromName String 99 Sent The sender’s name.FromVoiceNumber String 31 Sent The sender’s personal voice number.Job ID Unsigned long 15 Received The ID of the fax assigned by the RightFax server.JobType String Variable Sent/Received The type of fax:

l Send

l Receive

l Print

l Unknown

NumberOfImages Integer N/A Sent/Received The total number of pages in the fax (including the cover page).PageNum Integer N/A Sent/Received The page number of the fax. The first fax page is page 1. For sent faxes, the cover

page (if any) is assigned page number 0.





Receive Time COleDateTime N/A Received The time that the fax was received. The format of the date and time is based on thelocal machine settings.

Receive Time String String N/A Received The date and time that the fax was received. The data is stored in the formatMM/DD/YYYY HH:MM:SS. The time is stored in 24-hour format.

RemoteCSID String 21 Sent/Received The caller subscriber ID (CSID) of the remote fax machine.SendDuration Integer N/A Sent/Received The number of seconds required to transmit the fax.Time Special N/A Sent/Received The time that the fax was sent or received. The time is stored in 24-hour format as

HH:MM:SS.ToCityState String 59 Sent The city and state of the fax recipient.ToCompany String 59 Sent The name of the recipient’s organization.ToFaxNumber String 31 Sent The destination fax number.ToName String 59 Sent The fax recipient’s name.ToVoiceNumber String 31 Sent The fax recipient’s voice number.Transmission Status String 35 Received Status of the transmission (success or error).Transmission Type Integer

enumerated5 Received Fax image resolution (normal or fine).

UniqueID String 15 Sent/Received The unique ID of the fax assigned by the RightFax server.UserID String 21 Sent/Received For sent faxes, the RightFax user ID of the sender.

For received faxes, the RightFax user ID of the recipient.


RightFax Connector for IBM Filenet Administrator Guide

Documents

Transcript of RightFax Connector for IBM Filenet Administrator Guide