Instances overview
Instances overview
The first screen you see after logging on to the ELOxc Console is the overview screen. If you have not yet configured any instances, create a new instance by clicking [+]
. The following dialog box opens:
Name: Enter a name for the new instance.
XC Service URL: Enter the URL and port number of the ELOxc EWS service. You must activate the ELOxc service separately.
Indexserver user name: Enter the account name of an ELO account with administrator rights.
Indexserver password: Enter the password for this account.
Click Add to save the new instance. All instances for a repository are listed on the overview page.
Click an instance to open it.
An opened instance page contains four tabs. Above the main area of the instance, you have the option to Publish new or updated instances.
The Status tab shows the URL and port on which the ELOxc service listens, the last time it was started, and other instance processing statistics.
Here you can restore a backup of the instance from a previous configuration saved in the repository, or delete the instance entirely.
The second tab contains the instance settings. After creating a new instance, you must enter the remaining required data for the instance as a whole to the fields here.
Frequency: This field controls when and how the instance runs.
Interval: The instance runs in regular time intervals. For example, if you enter a setting of 08:00:00
here, the instance will run every eight hours.
Please note: The Daily setting works differently in ELOxc EWS depending on the program version number. If you are using a version of ELOxc EWS before 9.00.010, you must use a regular expression for the time trigger. You can use the ELOxcTools
program to create this expression.
Daily: The instance runs every day at the specified time. For example, if you enter a setting of 08:00:00
here, the instance will run at 8 a.m. every day.
Information: You can enter multiple daily triggers for the instance by clicking Advanced at the bottom of this area. This means that the instance will run several times a day at the specified times.
By event: The instance runs without stopping and the action trees within the instance wait for an event within them to detect an event that requires action by the tree. For example, if an action tree within this type of instance performs a certain action on e-mail attachments with [Confidential]
in the subject line, the instance waits for a message to arrive that fulfills this requirement and then performs that action immediately.
Idle: The instance does not run automatically when the service starts, unlike in Once mode.
Once: The instance runs only once.
Domain: Enter your domain name here, such as contelo.com.
Log on: Enter the account name of the Microsoft Exchange account here that has the required rights.
Password: Enter the account's password here.
Information: This Exchange account's password is initially stored in plaintext with the attribute clear. This can be observed by looking at the raw XML for the configuration. As soon as the instance is activated, ELOxc automatically encrypts the password.
Trusts: Click the plus icon to add domain trusts to the configuration. Only enter a domain trust if your domain requires it.
The buttons below the configuration allow you to perform fundamental actions in regard to the instance configuration.
Click Save to save your entries to the configuration. This does not make the changes active.
Edit XML: Shows the current instance configuration as pure XML text in a dialog box. You can edit and save changes to the configuration directly here.
Advanced opens all available configuration options in a dialog box. The titles of each box in the advanced configuration correspond to the names of the options in the ELOxc Technical Reference.
Static login
It is possible to use ELOxc EWS with an SMTP e-mail account that is not on a Microsoft Exchange server. To do so, you must enter information about each e-mail account within the instance definition within static login blocks.
SMTP account setupStatic login, SMTPNon-Exchange serverPlease note: The Indexserver account mapping option cannot be used if static mode is active.
To use this option, enter the general settings for the instance and then click All options. Navigate to the Domain section and select the StaticMode option.
Next, click Add StaticLogin for each account you wish to process and enter the required information.
SMTP: Enter the full e-mail address to this field, e.g. brad.johnson@contelo.com
.
Login: Enter the account name used to connect to the e-mail server to this field. This may either be a user name like brad.johnson
, or the full e-mail address again.
Password: Enter the password used to connect to the e-mail address to this field in plaintext. This will be encrypted when you connect to the account for the first time.
Globals option
One aspect of the Globals
instance configuration option will be mentioned here: Threads
.
The Threads
variable lets you set multi-threaded operation for the instance. If you have a sufficiently powerful server, you can increase the number of threads in order to speed up ELOxc processing. By default, ELOxc uses one thread per instance.
Please note: Setting too many parallel processing threads may cause errors on the Exchange server. In practice, more than three threads can result in system instability. See the Troubleshooting chapter for more information on this issue.
The number of ELOxc threads is also limited at runtime by the Exchange throttling properties. Each account may only log on to the Exchange server a certain number of times in parallel (the default is 20).
Ix option
The Ix
instance configuration option will be described in a little more detail here because it controls how ELO users are associated to domain accounts, and how new users are created in ELO. The first several options deal with general Indexserver and ELO object options.
The Account Mapping options deal with how ELOxc EWS assigns domain accounts to ELO users.
Warning: The account mapping option cannot be used in combination with the ELO LDAP connection.
Active: This option activates or deactivates account mapping from Active Directory to ELO. If the option is deactivated, the other options are ignored and ELOxc EWS will not create any new users.
Please note: If mapping is not active and an item is filed to ELO that cannot be assigned to an ELO user, only the ELO service user will have permissions to that entry as its owner (creator).
EloAccountType: This option selects the property on the Active Directory that corresponds to the user name in ELO. If no corresponding ELO user is found when an object is filed to the repository, the user is created. The default selection is SAM_ACCOUNT_NAME
. If a user is named Bill Johnson, the sAMAccountName property in Active Directory might be johnson
.
DomainAccountType: This option selects the Active Directory property used to determine the account name on the Active Directory. The default selection is USER_PRINCIPAL_NAME
. The sample user's Principal Name would have a format like johnson@domain.local
.
Both EloAccountType and DomainAccountType contain two additional options: NTLM
(format: domain\johnson
)and DISPLAY_NAME
(format: Bill Johnson
).
Acl: The setting selected here defines the permissions given to the mapped user to a specific ELO entry created by ELOxc. The default setting is RWDEL, but ELOxc allows any combination of these letters. The permissions for all child entries underneath that item are defined by the Indexserver and the general keywording form settings (usually to inherit the permissions of the parent entry).
This setting takes effect under the following circumstances:
- 1: Mapping is active (see above).
- 2: An Archive Path action is added to an action tree and the
Root=ARCHIVE
option is selected. - 3: A user-account-based variable is added to the Archive Path action, such as Mailbox account, Mailbox UPN, Mailbox e-mail, or Mailbox name.
Information: See the Archive Path section of this manual for more information about this node type.
If all three of these conditions are fulfilled, the setting applied here takes effect for the first component in the path that fulfills them.
Group: Any new ELO users created by ELOxc are assigned to the group specified here. The default group name is ELOxc_USERS
.
Password: Use this option to define a default fixed password for new ELO users that ELOxc creates. If you leave the field empty, ELOxc generates a random password for each new user.
NotifyUser: Select this option to send an e-mail automatically to new users when ELOxc creates their account in ELO. This e-mail contains the ELO user name and the password.
This notification e-mail is sent in English with the following text:
Your ELO account has been created.Login: <the new user name>Password: <the new user's password>Please note: It is recommended to keep the NotifyUser option active, especially if the random password option is used.
The third tab shows a list of action trees that have been defined for the instance.
The Order column displays the order in which the trees are processed when the instance runs. Any integer can be used as a number in the order, but all numbers in this column can occur only once in an instance.
The Status column shows you whether an action tree is active, inactive, or has been defined as a subtree.
The Name column shows you the names of the various action trees. Click an action tree name to view or edit the tree.
Click the pencil (edit) button to the right of an action tree name in order to edit the values for these columns. Click the X (delete) button to delete an action tree.
Click Add to create a new action tree.
When you create a new action tree, you have the ability to import a predefined action tree rather than creating one completely from scratch. To do so, an action tree must be saved in the repository to the following filing path:
Examples, importImport action trees¶ Administration ¶ ELOxc Base ¶ EXAMPLES ¶The fourth tab, Templates, is new in ELOxc Console 10. Here you can define reusable templates for mailboxes, entry points, folder filters, keywording forms, and message stubbing.
Example
For example, you may have a large list of mailboxes that you want to be processed by several action trees. You can define this list of accounts as a template and add the template to the action tree, instead of adding each account to each action tree individually.
TemplatesThis approach has several advantages over the older method: it is quicker and easier to set up, less prone to errors or discrepancies, and easier to manage or edit.
To create a template, first switch to the type of template:
Mailboxes: A list of AD accounts or groups.
Entry points: A mailbox path on the Exchange server (such as \Inbox
).
Several variables can be used for the entry points (such as {%INBOX}
). See the appendix for a list of these variables.
Folder filters: A folder filter is a way to exclude Exchange folders from action tree processing, such as the {%DELITEMS}
folder.
Please note: A folder filter must be entered without a backslash. If a folder is filtered out in this way, it is ignored regardless of the rest of the path. For example, if a folder filter of Customer is active, both \Inbox\Customer
and \Sent Items\Customer
will be filtered out.
Ext masks: This template type allows you to associate a specific file extension (such as PDF
) with a specific keywording form. Enter the file extension without a leading period.
Stubbing: Use Stubbing templates to create message stubs. "Stubbing" replaces the original contents of an e-mail message with the contents of the stub.
Please note: Earlier versions of ELOxc EWS stored and used stubs differently than in ELO ECM Suite 10. Please convert these templates while updating ELOxc to version 10.
When creating a stub, you have the option of using either a text- or HTML-based template. See the Stubbing action section of this manual for more information on creating this type of template.
Classes: Class templates are also available.
After selecting the type of template you want to create, click Add. A dialog box opens, where you must enter a name for the template. Click OK to create the template.
When the name of the new template appears in the list, click the name to edit it.