eCopy Connector for Fax via SMTP

The eCopy Connector for Fax via SMTP enables users to scan and fax documents from an eCopy-enabled device through an SMTP email-to-fax gateway. To use this connector, you must have a network fax server and the appropriate SMTP server plug-in.

The scanned document along with the sender and recipient information is sent to the SMTP server as a MIME-formatted mail message.

The recipient's fax number is included in the To field (on the ShareScan Client) in the format required by the fax server. The server plug-in recognizes the recipient address as a fax number and hands the request off to the network fax server for delivery as a fax.

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:

  1. In the Properties dialog, select the Logon/SMTP tab and in the Logon options group either choose None: Send from generic email or None: Send from generic email address specified by Data Publishing as the Authentication method.
  2. In the same tab, go to the SMTP Server group and specify Authentication as either None or Login as (latter with the proper credentials supplied).
  3. In the Sending options tab choose Express to default recipients as the Display option.

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

Connector properties

The Properties window enables administrators more familiar with LDAP to fine-tune the settings, without relying on the Wizard. The following tabs are available for configuration:

  • Logon/SMTP
  • LDAP settings
  • Sending options
  • Fax format
  • Address book

Logon / SMTP

Select the protocol combination to be used via this tab.

Field Name

Description

Logon options

Authentication

Select the authentication type from the list:

  • Runtime: LDAP
  • None: Send from generic e-mail
  • None: Send from generic e-mail address specified by Data Publishing
  • Use Runtime user's LDAP e-mail address

For a practical example of configuring the Data Publishing with a connector, click here.

Allow user to modify

If checked, the user is able to customize the e-mail field on each scan. Only available if either None: Send from generic e-mail or None: Send from generic e-mail address specified by Data Publishing authentication option is selected in the Authentication list.

Generic e-mail

Allows the administrator to provide a generic email address to specify as the sender. Only available if None: Send from generic e-mail option is selected in the Authentication list.

Default generic e-mail

Allows the administrator to provide a default generic email address to specify as the sender. Only available if None: Send from generic e-mail address specified by Data Publishing option is selected in the Authentication list.

SMTP Server

Server

The IP address or DNS name of the SMTP server to use for outgoing messages. If the server supports anonymous access, it must be disabled if you want to use SMTP authentication.

Port

Port address of the SMTP server. Default is 25.

Test

Clicking the Test button tests the connector with the current settings.

Server requires SSL

Enables Secure Socket Layer (SSL) to be used for SMTP communication. If you select this option, you must install a valid SSL certificate on the same device as the connector.

Authentication

Define the type of authentication behavior for the SMTP server:

  • None: When selected, the user is not prompted for a username and password. The connector does not attempt any authentication with the SMTP server. The email send process may fail if the server requires authentication.
  • Use senders LDAP userID attribute and runtime password: When this option is selected, the connector utilizes the LDAP userID attribute and password provided at the User Logon form to authenticate them against the SMTP server. If the LDAP address book is not enabled at the time of closing the properties dialog we will show an error to the user and tell them LDAP must be enabled or a different SMTP authentication type must be chosen. To use this option, you must enable the LDAP address book on the LDAP settings tab.
  • Login as: When selected, the fields User name and Password are displayed below the Authentication combo in admin. Here the administrator can specify a set of credentials that will always be used when sending an email from the connector.
  • Runtime: Prompt sender for a username and password:

    Prompts the user at the device to enter a user name and password when the user presses the Send button on the Send screen.

    Available only if SMTP Basic Authentication is enabled on the server.

    If Session Logon is enabled and SSL is not enabled, eCopy recommends that you select None or Login as.

Use specified domain if secure SMTP is enabled

If selected, the domain box is enabled and the user can input a domain. During the send process, the connector provides this domain along with username and password to the SMTP server. This check box does not appear if the None SMTP Server authentication option is selected.

User name

User name for the selected authentication option. This field does not appear if the None SMTP Server authentication option is selected. (for testing only) is displayed next to this field if the either the Use senders LDAP userID attribute and runtime password or the Runtime: Prompt sender for a username and password SMTP Server authentication option is selected.

Password

Password for the selected authentication option. This field does not appear if the None SMTP Server authentication option is selected. (for testing only) is displayed next to this field if the either the Use senders LDAP userID attribute and runtime password or the Runtime: Prompt sender for a username and password SMTP Server authentication option is selected.

LDAP settings

Controls the various LDAP settings of the connector.

Field Name

Description

Enable LDAP address book

Click the Find button to locate the LDAP server during runtime. Select the check box to enable configuration options for the LDAP server and the LDAP additional settings groups.

Connection type

Specifies how to connect to the LDAP server:

  • Use credentials: The connector connects to the LDAP server with a user specified in UserDN and Password.
  • Anonymous: The connector connects to the LDAP server anonymously. Not all LDAP servers allow anonymous connections.
  • Use ShareScan Manager service credentials: The connector always connects to the LDAP server with the actual ShareScan Manager service user credentials. User ID and Password are required only for testing the LDAP server configuration.

LDAP Server

Server

IP or DNS name of the LDAP server.

Port

Port number of the LDAP server for communication purposes. The default is 389.

Server requires SSL

Select this check box if the server requires SSL connection.

User DN

User DN of the logged in user.

Password

Password of the logged in user.

Test

Clicking the Test button tests the connector with the current settings.

LDAP additional settings

LDAP search...

Click this button to launch the LDAP Search window; it allows you to specify the attributes of the LDAP searches.

The available settings are:

Sender

  • Base DN: Determines the LDAP search when typing in the LDAP authentication form or the Send form. Empty or invalid base DN displays a warning dialog.
  • Search scope: Can be set to All levels below starting point or One level below starting point.
  • Search on: Allows defining the attributes to be searched on
    • First Name
    • Last Name
    • Common Name
    • User ID
  • Search while typing
  • Max results: Sets the amount of results returned. The default value is 200.

Recipient

  • Base DN: Determines the LDAP search when typing in the LDAP authentication form or the Send form. Empty or invalid base DN displays a warning dialog.
  • Search scope: Can be set to All levels below starting point or One level below starting point.
  • Search on: Allows defining the attributes to be searched on
    • First Name
    • Last Name
    • Common Name
    • User ID
  • Search while typing
  • Max results: Sets the amount of results returned. The default value is 200.

LDAP Advanced...

Allows you to define what the actual attribute is called on the LDAP server itself and allows customization of LDAP attributes to return during your searches.

The available settings are:

LDAP object classes

  • Person: Allows defining the actual ObjectClass to represent the “person” class during a recipient and sender search.
    • Person
    • DominoPerson
    • User
  • Group: Allows defining a second ObjectClass to represent the “Group” class during a recipient search only.
    • Group
    • DominoGroup

LDAP attributes

  • First name: Allows defining the actual attribute name to search for.
    • sn
    • givenName
    • uid
    • SAMAccountName
  • Last name: Allows defining the actual attribute name to search for.
    • sn
    • givenName
    • uid
    • SAMAccountName
  • Common name: Allows defining the actual attribute name to search for.
    • sn
    • givenName
    • uid
    • SAMAccountName
    • cn
  • User ID: Allows defining the actual attribute name to search for.
    • uid
    • SAMAccountName
  • e-mail: Allows defining the actual attribute name to search for.
    • mail
    • email
  • Fax: Allows defining the actual attribute name to search for.
    • provide fax number

Custom LDAP attributes

  • Sender: Specifies custom attributes belonging to the class. Note that anything outside the square brackets is displayed as plain text.
  • Recipient: Specifies custom attributes belonging to the class. Note that anything outside the square brackets is displayed as plain text.

Sending options

You can set up the Express mode using the Sending options tab.

Section/Field Name

Description

Display options

Allows you to set the send form options:

  • Display form
  • Express to default recipients

Default cover sheet (allows you to set a default cover sheet)

Enable cover sheet

Select this check box to make Default Subject, Default Note lists and Manage content... button active.

Default Subject

Specify a default subject template.

Default Note

Specify a default note template.

Manage content...

Opens the Manage content window. It allows you to set the action taken.

Select Subjects or Notes in the Message section depending on which one you want to modify.

Available options are:

  • New: opens the Add a new subject / Add a new note window, depending on whether Subjects or Notes is selected in the Message section; specify the new item and click OK to confirm or Cancel to discard.
  • Edit: opens the Edit an existing subject / Edit an existing note window, depending on whether Subjects or Notes is selected in the Message section; edit the existing item and click OK to confirm or Cancel to discard.
  • Remove: pops up the Remove item dialog; click Yes to remove and No to retain the item.
  • Move up: moves selected item up in the list.
  • Move down: moves selected item down in the list.

Default recipients

Data publishing

Allows you to set the data publishing action; select one from the following ones in the list:

  • None: Default recipients
  • Data publishing
  • Default recipients and Data publishing

For a practical example of configuring the Data Publishing with a connector, click here.

You can add, edit and remove items in this section; the following options are available:

Add: opens the Add entry window; you can specify new First name, Last name and Fax number. Click OK to confirm or Cancel to discard.

Edit: opens the Edit entry window; you can modify the First name, Last name and Fax number. Click OK to confirm or Cancel to discard.

Remove: removes the selected item; no confirmation is required.

Fax Format

Section/Field Name

Description

Fax address format

Cover Page

Displays the fax format you define in the Cover Page field of the Fax Address Format window.

No Cover Page

Displays the fax format you define in the No Cover Page field of the Fax Address Format window.

Format...

Opens the Fax Address Format window where you define the fax address format required by your fax server application or Internet fax service.

Refer to the documentation for your fax application to obtain the correct format for the fax address.

Because fax application vendors change these formatting schemes frequently, make sure you obtain the current format.

  • No Cover Page:
  • Cover Page:
  • Add: adds an item from the left item box to the Name /Value box; only active if an item is selected. If the item is added to the Name /Value box, it is removed from the left item box.
  • Remove: removes an item from the Name /Value box; only active, if an item in this box is selected.

    Each item can be expanded to have one or two modifiable values when moved to the Name /Value box. When you click a value, the Modify button becomes active and you can specify a custom value for the selected item.

  • Modify: click this button to modify the value of an expanded item in the Modify Value box.
  • Move Up: moves the selected item up in the Name /Value box.
  • Move Down: moves the selected item down in the Name /Value box.

Click OK to save your changes or Cancel to discard them.

Embedded Tags

 

Allows for embedding tags into the fax address.

Valid characters in FAX number

 

Displays all the valid character that can be included in the FAX number.

Address book

Section/Field Name

Description

Enable eCopy address book

Enables the Settings and Manage sections of the eCopy address book.

Settings

Database

Enables you to Create or Choose a database.

Click Create in the Database list to open the Create address book database dialog; you must provide the following data:

  • SQL server name: a valid SQL server name and instance.
  • Database: the database name for the eCopy address book.
  • User ID: the identification of the user.
  • Password: the password required to access the database.

Click Choose in the Database list to open the Data Link Properties dialog. Provide all necessary settings in the three steps in Specify the following to connect to SQL Server data.

User

Displays the name of the selected user.

Address book

Shows the name of the selected address book.

Search on

Set the search parameters you want to use. Select from the following options:

  • Fax Number
  • First Name
  • Last Name

Manage

Add

Opens the Add entry dialog. Specify First name, Last name and Fax number.

Delete

Deletes the selected entry without confirmation request.

Import

Opens a Windows Open dialog box to specify a .csv file for importing.

Export

Opens a Windows Save As dialog box to specify a .csv file name and type for exporting.

Refresh

Refreshes the item list.

Connector Wizard settings

The Wizard enables administrators to initially configure the connector. Many windows contain a Test button that enables you to validate the logon information or test the server connection.

Wizard window Field Description

LDAP server type

Server type

The available server types:

  • None (disable LDAP address book)
  • Generic LDAP server
  • Windows Active Directory
  • Windows Active Directory (Untrusted)
  • Novell eDirectory
  • Netscape LDAP server
  • Open LDAP server
  • IBM Domino server

If your server type is not on the list, select the Generic LDAP server option.

LDAP object classes

  • Person
    • Person
    • DominoPerson
    • User
  • Group
    • Group
    • DominoGroup

LDAP attributes

Enables you to set the attributes for the LDAP classes used by your server or to accept the defaults shown here.

  • First name:
    • sn
    • givenName
    • uid
    • SAMAccountName
  • Last name:
    • sn
    • givenName
    • uid
    • SAMAccountName
  • Common name:
    • sn
    • givenName
    • uid
    • SAMAccountName
    • cn
  • User ID:
    • uid
    • SAMAccountName
  • e-mail:
    • mail
    • email
  • Fax:
    • provide fax number

LDAP server settings

LDAP Server

This wizard window is not available if you select Active Directory as the server type on the LDAP server type wizard window.
  • Connection type: Specifies how to connect to the LDAP server:
    • Choose Use credentials to connect to the LDAP Server with a user specified in UserDN and Password.
    • Anonymous allows to anonymous connection to the LDAP server, if the server supports anonymous authentication.
    • Choose Use ShareScan Manager service credentials to connect to the LDAP server with the actual ShareScan Manager service user credentials. This case User DN and Password are required only for testing the LDAP server configuration.
  • Server: IP or DNS name of the LDAP server.
  • Port: Port number of the LDAP server for communication purposes. The Wizard assumes that the server is using the default port number (389).
  • Server requires SSL: Check if the server requires SSL connection.
  • User DN: User DN of the logged in user. You must provide the full user DN if the server requires it.
  • Password: Password of the logged in user.
  • Test: Click this button to check your settings.

Windows Active Directory server account

Account settings

Active Directory Server Account settings:

  • User name
  • Password
  • Domain
  • Port
  • Server requires SSL
  • Test

The Wizard uses this information to set the user DN and server name.

Available only if you select Active Directory as the server type.

Search settings

Defines how the LDAP server searches the address book. Enables you to select a user from the LDAP tree in the Select LDAP User window.

Not available if you select Active Directory as the server type.

Base DN

The node on the LDAP tree from which all searches should begin. If you do not know the node, click the Browse (...) button and select the node from the tree structure in the Browse for LDAP directory window.

Search scope

Select a search level:

  • All levels below search starting point: Allows expanded searching.
  • One level below search starting point: Optimizes LDAP queries and improves performance.

Search on

The search criterion that the server uses to find the sender:

  • First Name
  • Last Name
  • Common Name
  • User ID (default)

The setting defines the information the user sees on the Logon screen at the device.

Search while typing

Enables or disables the Search while typing functionality for the related field at the device.

Max results

The limit on the number of results to be returned by the LDAP search. The default value is 200.

SMTP settings

Select your SMTP server and the type of authentication that will be required of the user at the device.

Server

The SMTP server name.

Port

The SMTP port number.

Authentication

The type of authentication to use on the SMTP server. Available only if SMTP Basic Authentication is enabled on the server.

  • None
  • Use sender's LDAP UserID attribute and runtime password
  • Login as
  • Runtime: prompt sender for a user name and password

The following settings are displayed, if you select any of the above authentication options, except None:

  • Use specified domain if secure SMTP is enabled
  • User name
  • Password

In case of Use sender's LDAP UserID attribute and runtime password and Runtime: prompt sender for a user name and password options, the User name and Password are for testing only.

Server requires SSL

Select this check box if the server requires SSL connection.

Test

Click this button to check your settings.

User logon settings

Runtime: LDAP

None: send from generic e-mail

A generic email address that is used as the sender account for all email.

None: send from generic e-mail address specified by Data Publishing

A generic email address that is specified by Data Publishing.

Use Runtime user's LDAP e-mail address

Requires the user at the device to enter the user name and password specified for the LDAP server.

Allow user to modify

The user at the device can modify the sender’s email address.

Only available if None: send from generic e-mail or None: send from generic e-mail address specified by Data Publishing options are selected.

Generic e-mail

You can specify the generic email address for the sender.

Only available if None: send from generic e-mail option is selected.

Default generic e-mail

You can specify the default generic email address for the sender.

Only available if None: send from generic e-mail address specified by Data Publishing option is selected.

Fax address format

Cover page / No cover page

Displays the fax format you define in the Fax Address Format window.

Format

Opens the Fax Address Format window where you define the fax address format required by your fax server application or Internet fax service.

Refer to the documentation for your fax application to obtain the correct format for the fax address.

Since fax application vendors change these formatting schemes frequently, make sure you obtain the current format.

Embedded Tags

Allows for embedding tags into the fax address.

Settings summary

Enables you to review your settings. Click the Back button if you need to change any settings or the Finish button to apply your settings to the connector profile. Click Cancel to discard your modifications.