Installation and configuration
Please note: The first time you set up ELOxc EWS, it is highly recommended to do so in a testing environment before applying it to a productive server. ELOxc EWS is designed to process large numbers of records automatically. An incorrectly configured action tree can result in irretrievable data loss.
Step:
The following steps describe how to install and configure ELOxc EWS.
1. Extract the contents of the ELOxc for Microsoft EWS installation package to a local directory on the server.
2. Run setup.exe in this local directory as an administrator.
The welcome screen for ELOxc for Microsoft EWS opens.
3. Click Next.
4. Select an installation directory for ELOxc EWS. Further instructions in this installation guide will refer to this directory as <ELOxc>
.
5. Select a directory where ELOxc stores its log files. Click Next to continue.
6. Select a port for ELOxc. The ELOxc program will send and receive instructions over this port. This port must not already be in use on the system.
7. Click Next to continue.
8. Click Install to install ELOxc for Microsoft EWS. When it has finished installing, click Finish to close the installer.
The ELOxc EWS program directory contains three programs: ELOxc, ELOxcLogViewer, andELOxcTools. ELOxc.exe is the core of the system. ELOxcTools.exe is a support program that helps you set up and run the main program. ELOxcLogViewer provides a GUI to help you manage the log files in ELOxc.
See the ELOxc applications in detail chapter for more information about these programs.
The directory also contains xc-console.war. This is a web application that is used to administer ELOxc via a browser interface. See the ELOxc Console chapter for more information on this option.
ELOxc Windows service
Finally, the setup installed a Windows service named ELOxcSrv. The service manages how the ELOxc program runs.
When you run the installer, the ELOxc Windows service is installed but not automatically started.
1. Right-click the Windows taskbar and select Task Manager from the context menu.
2. In the Task Manager, click the Services tab and then the Name column to sort the services alphabetically.
3. Look for a service named ELOxcSrv. If it has the status Stopped, right-click the service and click Start. You can close the Task Manager afterwards.
Make sure that the firewall settings on the computer are set up in such a way that the ELOxc service can be reached from the local computer and from the computer on which the Indexserver is running.
4. Start ELOxc Tools from the ELOxc installation directory. In this step, you should review the ELOxc service settings and change them as needed.
The screenshot above shows some possible settings for the ELOxc service.
5. Review the service settings for ELOxc. These are located in the upper part of the dialog box.
6. Click Save if you change the settings here. Click Unregister to remove ELOxcSrv
from the list of registered Windows services. If you want to add the ELOxc service again, enter the required information and click Register.
Defining an instance
1. Now define an instance. Stay in ELOxc Tools and enter the following data.
Name: Enter a name for the ELOxc instance.
Index Server URL: Enter the HTTP address of the ELO Indexserver, including port.
ELO Account: Enter the name of the ELOxc service user.
Password and Password Confirmation: Enter the password for the user entered above.
Do not enter anything to Serial or Information.
2. Click Save to register the new ELOxc instance.
If you see an error message, it is probably because your ELOxc service is not running. Check your service settings in the upper part of the dialog box and try to start the service from the Task Manager again.
3. Now you must set your ELOxc serial number. Start ELOxc Tools and navigate to the Instance section. Your new instance should now be selectable.
4. Select your instance and go to the Serial field. Enter your ELOxc EWS license here, then press the TAB key. Click Set Serial to activate your copy of ELOxc.
Close ELOxc Tools.
Information: You can also set the serial number from the command line with eloxc.exe -config -serial "<serial>"
. Make sure you place the serial number in quote numbers, as the complete serial number will probably contain spaces.
ELOxc Console installation
Now you can install the ELOxc Console.
Please note: Depending on your ELO server version, you may have already installed the ELOxc Console via the ELO Server Setup. If the Console is already installed, this step is optional.
If you install the ELOxc Console from the installation files, you can be sure that the Console is compatible with the current version of the software. You can also check the Console's compatibility from the logon screen:
1. Copy xc-console.war to the ELO server webapps directory (for example, C:\ELOprofessional\servers\ELO-Server-1\webapps
).
The application should install automatically. Check this directory to see if the application extracts into its own child directory:
2. Open the ELOxc Console. You can reach it from the list of installed applications in the ELO Application Server Manager or by navigating to the following URL in the browser:
http://<computer>:<port>/xc-console3. Replace <computer>
and <port>
above with the corresponding computer name and ELO server port.
4. After the page opens in the browser, you can drag the address line to your desktop to save it as a link.
The ELOxc Console logon screen opens.
5. Enter the account name and password for an account with Main administrator rights. Then enter the Indexserver URL and click Log on.
The first time you log on to the ELOxc Console, you may see an empty Overview screen.
6. Click [+]
to create a new instance.
If you already defined an instance in a previous step, click it and move on to the next step.
Name: Choose a display name for the instance.
XC Service URL: Enter the URL (including port) to the ELOxc service here.
Indexserver user name: Enter the account name of the ELOxc service account here, such as ELOxc Service.
Indexserver password: Enter the password for the service account entered to the previous field.
7. Click Add to create the instance.
Now return to the ELOxc Console. After adding the instance, it appears on the instance overview screen with not yet published under its name.
8. Click the instance to open it.
9. Switch to the Settings tab. Enter information here for Frequency, Domain, Login, and Password. Click Advanced if you wish to enter advanced settings to the instance.
- Frequency: When you are first installing ELOxc EWS, it is best to select Once to test the program functions. Afterwards, you can select processing times based on intervals, times of day, or events. See the ELOxc Console chapter for more information on this option.
- Domain: Enter your domain name here, such as contelo.com or mycompany.local.
- Login: Enter the domain account name with Exchange rights here.
- Password: Enter the password for the account entered to the Login field.
10. After you have entered valid information to the fields listed above, click Save to save the data. The entries are then saved to ELO:
Creating an action tree
Now you must create at least one action tree.
1. Click Add on the Trees tab in the ELOxc Console. A dialog box opens in which you can create a new action tree:
Name: Select a name for the action tree.
Order: You can usually use the preset order ID for this field. Each order ID must be an integer unique within the instance. When an instance runs, each active action tree is run through in sequence according to this number.
Status: Select Active, Inactive, or Template. These options are described in the ELOxc Console chapter. Only active trees run automatically with an instance, but all action trees must pass a validation check in order for the instance to run.
Import example: If you have sample action trees stored in the repository under ¶ELOxc Base¶EXAMPLES
, they are listed here. You can select one of these examples for testing purposes, or to use them as templates to construct custom action trees.
2. Click Add to add the new action tree to the list.
3. Click the name of the new action tree to edit it. If you imported a sample tree in the previous step, the tree already contains several nodes:
4. Click each of the nodes in the tree to familiarize yourself with the actions performed in each step. Click Advanced on the right to adjust the nodes for your Exchange environment.
5. Please use the information in the Sample action trees chapter and the included documentation in the ELOxc technical reference to ensure the required information is entered for each node. If you are unsure what kind of node you are editing, click XML to see the node type at the start of the code (such as KeywordingDef, ArcDef, etc.).
6. Click Save once you have edited a node in order to save the changes.
7. Click Validate in the upper left to run an automated plausibility check on the action tree. If any errors appear, correct them before proceeding.
8. After you have adjusted an action tree to your specific system environment, click the ELOxc Console link in the upper left to return to the instance settings.
9. After you have created a valid instance and wish to turn on e-mail processing, click Publish. When you click this button, a backup of the last valid instance configuration is saved to the ELOxc Base¶BACKUPS
folder in ELO and the current configuration is saved to the SERVICE
folder.
10. Click Start to start the instance. If the instance is set to Triggered or By event, it will continue to run at the selected intervals until you click Stop.
11. If you wish to update the configuration of your ELOxc instance or the action trees within it, you must restart the service (click Stop in the Console, then click Start).