eCopy Connector for Open Text Fax Server, RightFax Edition

The eCopy Connector for Open Text Fax Server, RightFax Edition enables users to scan and fax documents from the eCopy-enabled device through an existing Open Text Fax Server.

When configured appropriately, users can send files from their personal RightFax account and access their personal RightFax phone book for recipient selection. Delegation, cover pages, and billing codes are also supported when configured on the Open Text Fax Server.

To be able to use this connector with the Email and folder watching service, you need to create a profile in such a way that it does not require user interaction (express). To ensure that your connector profile is such, when you create a new profile or edit an existing one, select the Express tab, select the Enable check box and specify the required settings.

For the generic connector configuration options, see Configure connector profile.

Configuration settings

The following tables describe the settings on the Configure tab.

RightFax Server configuration settings

Field Name	Description
Protocol	This list lets you select: COM API - specify server via name or IP address; or WEB API - this is a REST-based API supported only in RightFax 16.4 or above configurations. Specify root URL in the format shown by the watermark text. COM API works only if secure TCP/IP communication is not enabled on RightFax server. (Enable Secure TCP/IP Communication option is cleared on the General tab of the Server configuration dialog for the RightFax Server Module on RightFax server.)
Server	The name of your RightFax server. Only available if you select COM API as your protocol.
Root URL	The Root URL of the REST-based API of your RightFax server. Only available if you select WEB API as your protocol.
User	The name of the user account used by the connector to log on to RightFax. The user account information is always used to log on to the RightFax server and retrieve the user list. If you plan to use Windows NT authentication, enter the user name for a Windows NT domain account.
Password	The account password.
Test	After you configure the settings in the fields of the RightFax server section, click to test the connection to the RightFax server. If the test fails, resolve the connection issue before proceeding. Verify that your spelling is correct and that the name of the RightFax server is accurate.
Send from personal account	Allows the user to log on to the RightFax server and then sends the fax from that user’s personal RightFax account (or from a delegate account). If you do not select this option, the connector always sends the faxes from the user account specified in the User field.
Use delegation	If enabled, and an authenticated user is set up to send as someone else, the Send As button is shown on the UI.
Use Windows NT authentication	If selected, all users must log on to the RightFax server using their Windows NT credentials. Windows NT and RightFax UID authentication are mutually exclusive.

Phone books configuration settings

Field Name	Description
Enable	Allows the user's personal phone book to be available for recipient selection.
Add new recipients	Allows users to add new recipients to their personal phone book using the Save Recipient option on the Send > Details screen at the device.
Limit to phone book recipients	Allows users to send faxes only to recipients already in the phone book.

Cover sheet configuration settings

Field Name	Description
Yes/No	Specifies the default setting.
Hide buttons	If you select this option, the connector profile hides the cover sheet buttons from the user and uses your selected default setting (Yes or No) to determine whether to attach a cover sheet. In all cases, if the authenticated user’s RightFax account has not been configured to send cover sheets, an error message appears when the user presses the Send button.

Field Name

Description

Yes/No

Specifies the default setting.

Hide buttons

If you select this option, the connector profile hides the cover sheet buttons from the user and uses your selected default setting (Yes or No) to determine whether to attach a cover sheet.

In all cases, if the authenticated user’s RightFax account has not been configured to send cover sheets, an error message appears when the user presses the Send button.

A cover sheet can only be sent with a fax if the Use cover sheet option is enabled in the RightFax FaxUtil client for the authenticated user (see your RightFax documentation).

Billing codes settings

Field Name	Description
Fields 1, 2, and 3	Available billing codes are defined on the RightFax server and displayed in these fields. You can enable the fields for use with scanned documents. Each enabled field appears on the Billing Codes form at the device. (If you do not enable any fields, the Billing Codes form does not appear.) For each field, select the appropriate options.
Enable	Prompts the user to select or enter a billing code. If the field is defined as required on the RightFax server, it is highlighted in yellow on the Billing Codes form and the user must enter a value in the field. You must enable the first field to enable the second field, and the second field to enable the third field.
Verify	Validates the information entered by the user at the device against the list of billing codes defined on the RightFax server. You must enable verification for the first field in order to enable verification for the second field. There is no Verify option for the third field (the Description field).
Read billing codes from Cost Recovery	If your company uses the Cost Recovery Service, you can choose to obtain the billing codes directly from the service through eCopy Data Publishing. For a practical example of configuring the Data Publishing with a connector, click here. When the Read billing codes from Cost Recovery option is selected, the Verify option is disabled for all billing codes. For more information on Cost Recovery, see the relevant sections of the Help.
Billing codes form display options	Enables you to control the display of the Billing Codes form at the device: Hide Billing Codes form: The form does not appear at the device. Show Billing Codes form: The form at the device displays the fields that you enable on the Billing codes tab. Users can modify the contents of the fields. Show Billing Codes form read-only: The form at the device displays the fields that you enable on the Billing codes tab. Users cannot modify the contents of the fields.

Content settings

The Cover sheet notes section on the Content tab enables you to create notes that the user at the device can add to the fax cover sheet.

When you add a new note to the list of notes available to the user at the device, you can use the following variables:

Variable	Description
$$USER_NAME$$	Replaces the variable with the sender name.
$$RECIPIENTS$$	Replaces the variable with the recipient name(s).
$$FILESIZE$$	Replaces the variable with the size of the file (in KB).
$$FILENAME$$	Replaces the variable with the name of the file.
$$PAGECOUNT$$	Replaces the variable with the number of pages in the document.

Fax format

This tab allows you to specify valid characters for the Fax number. If the fax number contains characters other than these, the fax cannot be sent on the Send form or the recipient entry cannot be saved into the phone book on the Details dialog at the client side and an error message appears. If no character is specified as valid (the textbox is empty), then all characters are valid for fax number and there will be no validation on the client side.

Variable	Description
Valid characters in fax number	Enter the valid fax number characters here.

Express Settings

A RightFax Express connector profile allows you to scan and fax the document by simply pressing the button on the main screen.

Field Name	Description
Enable	Enabling the Express function designates the profile you are creating as an Express profile. The information that you configure on this tab will be used for every document that you fax using this profile.
Billing codes 1 and 2 description	Enter the codes that you want to use for documents sent using this connector profile. When this information is pre-configured, the user at the device does not see the Billing codes screen.
Name	The name of the fax recipient.
Fax number	The fax number to which the scanned document is sent.
Note	The text included in the body of the fax to which the scanned document is attached.
Attach cover sheet	Send a cover sheet containing the Name, Fax number, and Note to the recipient with each faxed document. A cover sheet can only be sent with a fax if the Use cover sheet option is enabled in the RightFax FaxUtil client for the authenticated user (see your RightFax documentation).

If you use Express with a RightFax connector profile, you must save the connector profile with the RightFax server information before you test your Express configuration.

If you select the Send from personal account option on the Configure tab and then configure the connector profile to use Express, the connector will prompt the user at the device to enter authentication information.

Send screen settings

Field/Option	Description
From	A read-only field populated with the name of the sender.
Search	Specifies the user ID of a recipient to search for in your RightFax phone book. When you move to the next field, the connector will fill in the recipient and fax number information from the RightFax phone book.
Recipient	The name of the recipient of the fax. If the recipient is in the RightFax phone book, this field is populated automatically when the user ID is selected in the Search field. If the recipient is not in the RightFax phone book, enter the recipient name and fax number or, click Details and use the Details window to enter the user information.
Fax number	The recipient's fax number (required).
Notes	Notes to include in the message body (optional). Useful if you attach a cover sheet. The arrow button next to the text box displays a list of available, preconfigured messages.
Attach cover page	Specifies whether to attach a cover page to the fax. If you select Yes and your RightFax account is not configured to use a cover sheet, the connector ignores your selection. The connector profile can be configured to hide the cover page buttons.
Details	Displays information about the specified recipient. If the user exists in the RightFax phone book, you cannot change any of the information. Phone book entries can only be changed on the RightFax server. To add a new recipient to the RightFax phone book, click Details and then enter the recipient’s name, user ID and any other user information in the blank fields in the Details window. Under Save recipient, select Yes and then press OK.
Send as	Allows the user to impersonate another RightFax user via the Delegation feature available in RightFax. The feature is only available if you have rights on the RightFax server to send faxes from another user’s account and the feature is enabled for the connector. Press Send as. Select the RightFax user ID of the other user and then press OK.