eCopy Connector for Microsoft Exchange
The eCopy connector for Microsoft Exchange enables a user to send scanned documents from an eCopy-enabled device as email attachments from a generic Microsoft Exchange account or from the user's personal Microsoft Exchange account. eCopy recommends that you create a generic Microsoft Exchange account for use by ShareScan.
While ShareScan always uses the ShareScan user account information to log on to the Exchange server and retrieve the Global Address List, it sends scanned documents from this account only if the Login As authentication option is selected.
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:
- Choose the Login as authentication method for both storage protocols EWS and LDAP (in the Protocols tab of the Properties window).
- In the Sending options tab, choose Express to Default recipients or Hide form and send to self from the Display options list.
- Ensure that the Encryption connector setting has the User Modify parameter set to 'No' (clear the Yes check box).
- Ensure that the
Document Name connector setting is configured as follows:
- It is set to the Default File Name value, or
- Its value is Specify name... with the User Modify option off (clear the Yes check box), or
- Used Advanced File Naming..., where all fields have the User Modify option off (in the Field Editor dialog).
For the generic connector configuration options, see Configure connector profile.
About Exchange Environment connection protocols
The connector supports two combinations of connection protocols that can be used to connect to your Exchange server, depending on your environment. The Wizard automatically selects the protocol based on the Exchange environment information that you supply.
|
Protocol configuration |
Microsoft Outlook required? |
Suggested use |
|---|---|---|
|
LDAP/EWS |
No |
EWS along with LDAP is recommended when your company employs a number of people, uses multiple Exchange servers, and you want to take advantage of the service URL autodiscover feature (administrator do not need to reconfigure ShareScan when the Exchange infrastructure is changed). You can restrict LDAP queries with profile settings for the organizational unit which uses a particular scanning device; queries are executed faster, and result lists are considerably shorter. Our LDAP protocol implementation autodetects the Global Catalog server, and supports SSL communication as well. EWS also supports cross domain setups, so can be used when ShareScan and the target Exchange server exist within separate domains. |
|
EWS/EWS |
No |
Recommended when the ShareScan Manager works outside of Active Directory domains (can be used within the domain as well), and simple firewall setup is a requirement. Also the best choice when your Exchange server is hosted in a Datacenter, and you want to access that via HTTPS. EWS (Exchange Web Services) is based on SOAP/HTTPS, which transfers request and responses via TCP 443 port. EWS supports service URL autodiscovery, making it advantageous in environments where service endpoints change frequently. Limitations: Search while typing during login has limited functionality. Extras: Users can save new contacts into their Personal Contacts folder. |
General settings
Allows you to set the generic settings of the Exchange connector.
|
Field Name |
Description |
|---|---|
|
Search Global Address List |
Allows searching in the Global Address List. |
|
Search Outlook contacts |
Allows searching in the Outlook contacts. |
|
Search recipients while typing |
If checked, the hints appear at the client Send form as the user starts entering the recipient. If unchecked, the hints appear when the user presses the Search button next to the To or Cc field. |
|
Enable user to manually enter email address |
The client is allowed to enter email addresses manually. |
|
Importance |
Set the Importance of the mail message. |
|
Delivery receipt |
Set if you request a delivery receipt. |
|
Sensitivity |
Set the sensitivity of the message. |
|
Read receipt |
Set if you request a read receipt. |
|
Add message to Sent Items folder |
If this feature is enabled, the message sent successfully is copied to the named folder. |
Protocols
Select the protocol combination to be used via this tab.
|
Field Name |
Description |
|---|---|
|
Protocol to search users / send email |
Select the protocol composition you want to use. |
|
Authentication method |
Select the authentication method to be used. Available only when Use Exchange Online with Modern Authentication is selected on Web services tab. In this case you can select between Password and One-time passcode Authentication method. Otherwise, Password Authentication method is automatically selected and this option is hidden. |
|
Username |
Enter the user name to be used. If One-time passcode is selected as Authentication method, Username must be specified in the User Principal Name (UPN) format. |
|
Password |
Enter the password to be used. Available only when Password is selected as Authentication method manually or automatically. |
|
Domain |
Enter the domain to be used. Available only when Password is selected as Authentication method manually or automatically. |
|
One-time passcode |
Specify a valid one-time passcode, which was generated by Token Vault or an authenticator app set up on the Token Vault UI, to be used. Available only for One-time passcode as Authentication method. |
|
Login Mode |
Select the login mode:
|
|
Search user names |
Setting this combo box controls how the client side Authentication form manages the logon information:
The Global Address book provider runs the query for the hints. The method of searching depends on the provider. |
|
Testing the connection |
Clicking the Test button tests the connector with the current settings. |
Protocol properties
The Protocol properties tab varies based on the selected protocol.
|
Field Name |
Description |
|---|---|
|
Locate server at runtime |
Click the Find button to locate the LDAP server during runtime. |
|
Always use the following server |
Specify the LDAP server manually. |
|
Server requires SSL |
Check if the server requires SSL connection. The default SSL port is 636. |
|
LDAP port |
Enter the port number to be used. The default is 389. |
|
Credential type |
Select the credential type:
|
|
User DN |
Only valid if Use User defined credential is specified. |
|
Password |
Only valid if Use User defined credential is specified. |
|
LDAP search |
Allows you to specify the attributes of the LDAP searches. The available settings are:
|
|
Testing the connection |
Clicking the Test button tests the connector with the current settings. |
Web Services
|
Field Name |
Description |
|---|---|
|
Use the following service URL |
Enter a valid full URL. |
|
Use Exchange Online with Modern Authentication |
Select this setting to use Exchange Online web service with modern authentication. When selected and One-time passcode is selected as Authentication method on the Protocols tab, specify the username on the Protocols tab in the User Principal Name (UPN) format. |
|
Autodiscover Service URL with usage of the email address below |
Enter an email address to be used during the Autodiscovery process. |
|
Redirection during discovery to these servers is allowed |
Enter the URLs to which redirection is allowed. |
|
Use EWS Impersonation |
If checked, you can specify an account to be used for sending emails when using this connector. This option is highly recommended when using Bypass Session Logon (no authentication) along with Cost Recovery or ID Services. The EWS Impersonation allows users to simply swipe their card when on the Session Logon screen, and the credentials entered under this option are used. Note that this function is only supported when using EWS protocol. |
|
Testing the connection |
Clicking the Test button tests the connector with the current settings. |
Sending options
This dialog tab provides control for the administrator over the default content of the mail – recipients, subject and note – and allows setting the express mode client workflow.
|
Field Name |
Description |
|---|---|
|
Display options |
Manages the client side workflow.
|
|
Default recipients |
Allows you to specify default email recipients for a connector. Use the Add button to populate the list. Click the Remove button to delete the selected entry. You can use the list to configure the data publishing behavior, selecting from the following options:
For a practical example of configuring the Data Publishing with a connector, click here. |
|
Send copy to sender |
Using this option, the recipient list can be extended with the logged on user dynamically. |
|
Default message |
Allows you to specify the default Subject and default note for the connector, by editing the relevant fields:
You can also define notes and subjects to be received from data publishing by using $$NOTE$$ and $$SUBJECT$$ in the Note and Subject fields. |
Exchange connector profile settings
The Edit Profile window enables administrators who are more familiar with Exchange server environments to fine-tune the settings without relying on the Wizard. eCopy recommends that you use the Wizard to initially configure a connector profile. You can set the following:
- Protocol to be used
- Protocol properties
- Generic settings
- Sending options
Exchange Connector properties
The Properties window enables administrators who are more familiar with Exchange server environments to fine-tune the settings without relying on the Wizard. eCopy recommends that you use the Wizard to initially configure a connector profile. The Properties settings that are available depend on the connection protocols supported by your environment.
Local address book
The Local address book tab enables you to configure the local address books that store Internet email addresses entered at the device, addresses that are not in the Global address list or in the Contacts folder. For information about creating and configuring address books, see Configuring support for Local address books.
When you select the Enable user to manually enter addresses when sending email option on the General settings tab and you enable the Internet address book option on the Local address book tab, the system displays a Save recipient form, where you can save the email address. Saving the email address is not required; you can send the message without that.
Exchange Profile Wizard settings
The Profile wizard helps the administrator to setup a basic protocol composite containing one or two protocols. The additional settings are set up with their defaults; any further tuning of the setting can be done by editing Properties.
Configuring via the Wizard follows the steps below:
- Select protocol composite:
Field Name
Description
Protocol
Select the protocol combination to be used.
User name
Enter the user name.
Password
Enter the password.
Domain
Enter the selected domain name.
Login mode
Select the type of authentication to be used.
Search user names
Turn the Search while typing function on or off.
- Configure selected composite. The components of this page differ according to the selected protocol combination.
Field Name
Description
LDAP settings
The following options can be set via the LDAP settings page:
- Locate server at runtime: allows you to select an LDAP server during runtime.
- Always use the following server: allows you to set an LDAP server to be used.
- LDAP port: set the LDAP port here. The default port number is 389.
- Server requires SSL: check this to enable SSL connection.
Exchange Web Services settings
The following option can be set via the Exchange Web Services settings:
- Use the following service URL: allows you to enter a predefined service URL
- Review Summary.