Table of Contents
List of Figures
Figure 1: Security Realms, Principals and Subjects after Initial Setup 11
Figure 2: Segment Administration 12
Figure 3: Role Drop Down with list of available Segment Login Principals 12
Figure 4: openCRX UML Model – Class Diagram SecureObject 13
Figure 5: System attributes of an openCRX object as shown in the GUI 14
Figure 6: Table OOCKE1_SEGMENT after default installation 17
Figure 7: Table OOCKE1_SEGMENT after modification 17
Figure 8: Result of Check Permissions 19
Figure 9: Role Drop Down with list of available Segment Login Principals 20
Figure 10: New user guest – step 1 23
Figure 11: New user guest – step 2 23
Figure 12: New user guest – step 3 23
Figure 13: New user guest – step 4 24
Figure 14: New user guest – step 4 24
Figure 15: New user guest – step 5 24
Figure 16: New user guest – step 6 25
Figure 17: Operation Actions > Import Login Principals (admin-Root) 26
Figure 18: Operation Actions > Import Users (admin-Standard) 27
Figure 19: Disabling of Segment Login Principal guest by admin-Standard 28
Figure 20: 3-Tier with Apache Tomcat / OpenEJB 29
Figure 21: 4-Tier with multiple Tomcat / OpenEJB instances 29
Figure 22: 3-Tier with J2EE-compliant Application Server 29
Figure 23: 4-Tier with Clustered Application and DB Servers 30
Figure 24: Multiple Data Segments in a single DB 31
Figure 25: Dedicated DB for each Entity 32
Figure 26: Accessing the openCRX Workflow Controller 33
Figure 27: openCRX 2.4 Workflow Controller 33
Figure 28: Default Configuration of WorkflowController 34
Figure 29: openCRX Administration – WorkflowController 35
Figure 30: Workflow Controller Configuration – serverURL 36
Figure 31: Workflow Controller Configuration – pingrate and autostart 36
Figure 32: Default Workflow Processes created by WorkflowHandler 38
Figure 33: Event and Notification Service 40
Figure 34: Standard Topics included in the openCRX distribution 41
Figure 35: Create a new Subscription 42
Figure 36: Create a Subscription with Filters 43
Figure 37: Flow of e-mail messages between openCRX, MTA and mail client 45
Figure 38: Create a new E-Mail Account – step 1 48
Figure 39: Create a new E-Mail Account – step 2 48
Figure 40: Create a new E-Mail Account – step 3 49
Figure 41: E-mail subject prefix and Web access URL 49
Figure 42: Example of outbound E-mail Action Log Entries 50
Figure 43: Send E-Mail from openCRX – Overview 51
Figure 44: Send E-Mail from openCRX with Actions > Follow Up 51
Figure 45: Send E-Mail as Attachment from openCRX – Overview 52
Figure 46: Export E-Mail from openCRX with Actions > Follow Up 52
Figure 47: Thunderbird LDAP Configuration 56
Figure 48: MS Outlook LDAP Configuration 57
Figure 49: openCRX Activity Groups 59
Figure 50: openCRX Activity Filters 60
Figure 51: An openCRX activity's iCal representation 61
Figure 52: An openCRX activity in the standard GUI 62
Figure 53: An openCRX activity filtered to a user's homepage 62
Figure 54: iCalendar conversion between VEVENT and VTODO 67
Figure 55: Timeline visualizes time-based events 68
Figure 56: E-Mail Address UNASSIGNED 70
Figure 57: Thunderbird IMAP Configuration 72
Figure 58: MS Outlook IMAP Configuration 73
Figure 59: XML import from 3rd party system – overview 77
Figure 60: Interactive import of XML Files 77
Figure 61: Interactive import of XML Files 78
Figure 62: Operation vCard Import 79
Figure 63: Exporting SalesOrder as XML File 80
Figure 64: XML Exporter provides XML data file and code tables as ZIP file 80
Figure 65: Exporting SalesOrder as Spreadsheet File 81
Figure 66: Exported Spreadsheet File 82
Figure 67: Export Contact as vCard 82
Figure 68: Exporting Meeting / Sales Visit as iCalendar File 83
Figure 69: Launch Wizard User Settings 86
Figure 70: Wizard User Settings – enable/disable Root Menu Entries 86
Figure 71: RTF Document generated by merging live data with template 88
Figure 72: Contacts Export Dialog 89
List of Listings
Listing 1: File Format Subjects and Application Login Principals 26
Listing 2: Example File Subjects and Application Login Principals 26
Listing 3: File Format Users 27
Listing 4: Example File Users 27
Listing 5: web.xml – auto startup of the Workflow Controller 35
Listing 6: Servlets managed by Workflow Controller log to server.log 39
Listing 7: File openejb.xml 47
Listing 8: Uncomment mail resource definition in web.xml 47
Listing 9: Importing certificate into keystore cacerts 47
Listing 10: Importing Certificate 54
Listing 11: Set org.opencrx.maildir for Apache Tomcat 71
Listing 12: Locales in web.xml 84
Listing 13: Activating/Deactivating Locales in web.xml 84
Listing 14: Packages in web.xml 85
Listing 15: Activating/Deactivating Packages in web.xml 85
This book describes various configuration settings and tasks that make an openCRX administrator's life easier.
openCRX is the leading enterprise-class open source CRM suite. openCRX is based on openMDX, an open source MDA framework based on the OMG's model driven architecture (MDA) standards. This guarantees total openness, standards compliance, a state-of-the-art component-based architecture, and virtually unlimited scalability.
The intended audience are openCRX administrators.
This book describes some of the settings and configurations an openCRX administrator can use to control the behavior of openCRX.
We make use the following pictograms:
This guide assumes that you have access to a
properly installed instance of openCRX
In this chapter we will present a high-level overview of openCRX security and discuss a few important issues.
Figure 1: Security Realms, Principals and Subjects after Initial Setup
Summarizing the above:
The segment administrator (e.g. admin-Standard) creates principals and User home pages with the operation createUser():
Figure 2: Segment Administration
While each “real user” (typically) has 1 application login principal only, “real users” may have multiple segment login principals (e.g. because a “real user” is allowed to access multiple segments or because a “real user” is allowed to access a particular segment in different roles like Head of Sales or CFO).
Available segment login principals are listed in the so-called Role Drop Down:
The openCRX security framework makes a clear distinction between Ownership Permissions (permissions granted on a particular object) and Model Permissions (permissions granted on a particular model element). As the latter are not implemented (yet) we only talk about Ownership Permissions in this guide.
Ownership permissions are used to control browse/delete/update access to openCRX objects by Users and UserGroups (i.e. Ownership access control). Every openCRX object is a SecureObject. The following figure shows an extract from the UML model (if you are interested in all the details and the formally correct and complete specifications you should refer to the latest openCRX UML models):
Figure 4: openCRX UML Model – Class Diagram SecureObject
The most important security attributes of an object X are discussed below:
Figure 5: System attributes of an openCRX object as shown in the GUI
The following access levels are available to control which users/user groups are granted permission to browse/delete/update a particular object X:
If you are familiar with SQL, the following approach to understanding security might be helpful. Let's put ourselves into the role of the AccessControl Plugin; accessing an object (read mode) results in a SELECT statement as follows:
SELECT * FROM T WHERE owner IN (p1, p2, ....)
Security (including Access Control) is not just a fancy add-on, rather it is an integral part of openCRX; openCRX Access Control is always activated.
The openCRX security provider manages all security data and provides access control services for all requests through the openCRX API. Hence, you can rely on openCRX access control even if you write you own clients or adapters for openCRX.
Default access level settings for non-Root segments (e.g. segment Standard) after a clean install are as follows:
Figure 6: Table OOCKE1_SEGMENT after default installation
Due to the setting access_level_browse = 4 (global) any user with access to a particular segment is allowed to browse top level objects (i.e. any user can browse all accounts, all activities, all documents, etc.).
These default settings are suitable for test environments and deployments in smaller companies/teams with a generous access policy; for most real-world applications, however, it is more appropriate to set access_level_browse = 3 (deep) for non-Root segments. You can do this by changing the values in the column access_level_browse from 4 to 3 (table OOCKE1_SEGMENT). After this change, the table OOCKE1_SEGMENT will look as shown in the following figure:
Figure 7: Table OOCKE1_SEGMENT after modification
New objects are by default created with the following security settings:
You can check security permissions on any SecureObject with the operation Security > Check Permissions. Provide the principal name as a parameter. The following figure shows the result of the operation on a user's homeage:
Figure 8: Result of Check Permissions
The meaning of the above result is as follows:
The openCRX login procedure consists of 2 levels:
The Apache Tomcat / application server login procedure depends on various parameters:
Please note that even though openCRX might be involved in managing some of the above-mentioned realms (e.g. DB-based realm) the login procedure is not really under control of openCRX. Many login problems are related to incomplete/faulty configuration settings of the servlet container.
Access to segments is managed/controlled by the ObjectInspectorServlet. The included DefaultRoleMapper identifies all Segment Login Principals of a given Subject and grants access to the respective segments through the Role Drop Down:
Figure 9: Role Drop Down with list of available Segment Login Principals
It is possible to deploy user-specific implementations of the DefaultRoleMapper so that you can adapt the segment login procedure to your requirements.
Please refer to the chapter “Disable/Deactivate Users”.
If you (or one of your users) managed to screw up the security settings in a major way you might be forced to reset all security settings to a well-defined state. Not an easy task – and it typically involves a lot of manual work.
Even though you can create users with a variety of methods, “behind the scenes” the following steps are always required to create a new openCRX user:
Depending on how you create a new user, some of the above steps might be taken care of by a wizard. If you want to have full control over the user creation process, however, then you can certainly create new users following the above instructions step by step.
Have a look at Figure 1: Security Realms, Principals and Subjects after Initial Setup and Figure 2: Segment Administration to see how this all fits together.
The Segment administrator can create new users with the following steps:
Figure 10: New user guest – step 1
Figure 11: New user guest – step 2
Figure 12: New user guest – step 3
Figure 13: New user guest – step 4
Figure 14: New user guest – step 4
Figure 15: New user guest – step 5
Figure 16: New user guest – step 6
Creating large numbers of subjects/principals by hand can be quite a tedious job. If you prepare a text file containing the appropriate information in the file format as outlined below, the Root administrator (admin-Root) can use the operation Actions > Import Login Principals to create Subjects and Application Login Principals automatically.
Figure 17: Operation Actions > Import Login Principals (admin-Root)
Listing 1: File Format Subjects and Application Login Principals
Listing 2: Example File Subjects and Application Login Principals
Similarly to importing Subjects and Application Login Principals from a file you can also import Users from a file. If you prepare a text file containing the appropriate information in the file format as outlined below, the Segment administrator (admin-<SegmentName>) can use the operation Actions > Import Users to create Users automatically.
Figure 18: Operation Actions > Import Users (admin-Standard)
Listing 3: File Format Users
User;<principal>;<account alias>;<account full name>;<primary group>;<password>[;group [, group] ]
Please note that <password> is a clear-text value. The optional parameter group can be used to make the Segment Login Principal member of the respective Principal Groups of that segment.
Listing 4: Example File Users
There are various ways of disabling/deactivating users. To fully understand your options it is helpful if you are familiar with the openCRX Login Procedure.
Depending on the configuration of your application server you can disable users at that level. For example, if you rely on file-based realms, you can simply remove users from the file tomcat-users.xml (with Apache Tomcat) or users.properties (with JBoss) to prevent access to openCRX. If you block access at the level Tomcat / application server such users are locked out from accessing any application and any openCRX segment. However, as the Tomcat/ application server Login procedure is not entirely controlled by openCRX you might have to consult the documentation of your respective application server or ask your application server administrator for details.
The segment administrator (e.g. admin-Standard) can prevent a user from accessing a particular openCRX segment by either disabling the respective Segment Login Principal or by deleting it altogether. Disabling is the preferred option to prevent access temporarily. If a user has multiple Segment Login Principals you must disable all of them to prevent access to the openCRX application.
openCRX supports a multitude of deployment scenarios.
The following table lists some of the pros and cons of the most common openCRX deployment scenarios. Please note that the list is by no means complete:
The open source MDA platform openMDX supports a multitude of deployment scenarios and persistency configurations. The most common multi entity deployment scenarios are discussed in the following sections.
The setup “Multiple Data Segments in a single DB” provides adequate security for many use cases and is relatively easy to manage. As all the data is stored in a single database, however, security configuration mistakes (e.g. principals linked to the wrong subject, etc.) might lead to situations where a user is granted access to the data of a particular company/client that should not be accessible (please note that human error is the real root cause here, not a malfunction of openCRX). Furthermore, this setup is not recommended if users can get direct access to the database, e.g. with third party reporting tools as those tools typically bypass the openCRX API.
Figure 24: Multiple Data Segments in a single DB
Detailed instructions on how you can create and configure new segments are provided in the installation guide for Tomat 6.
The highest level of security is provided by setting up a dedicated database for each entity so that data sets of the various entities are physically separated:
Figure 25: Dedicated DB for each Entity
Information about openCRX custom projects is available from the openCRX wiki, e.g. http://sourceforge.net/apps/trac/opencrx/wiki/Sdk24.CustomProject.
With the Workflow Controller the openCRX Root administrator (admin-Root) can enable/disable various servlets (configured in web.xml) included in the openCRX distribution. This chapter gives an overview over the currently available servlets and explains how to start/stop them.
You can access the Workflow Controller by navigating to the URL
or starting the Workflow Controller Wizard as shown in the figure below:
Figure 26: Accessing the openCRX Workflow Controller
figure shows the Workflow Controller of openCRX
You can manually start (stop) servlets that are managed by the Workflow Controller by clicking on “Turn On” (“Turn Off”). Please note that you can control servlets on a segment by segment basis. For example, if you created a segment “OtherSegment” in addition to the segment “Standard” you can start/stop servlets of the segment “OtherSegment” without interfering with the servlets of the segment “Standard”.
In addition to configuring the Startup option of the Workflow Controller you can also configure various options related to the servlets managed by the Workflow Controller. The configuration of the Workflow Controller is available to the openCRX Root administrator (admin-Root) by navigating to Administration and then clicking on the icon of the WorkflowController:
Figure 29: openCRX Administration – WorkflowController
You can start the Workflow Controller manually by navigating to the URL
or starting the Workflow Controller Wizard. However, it is also possible to start the Workflow Controller automatically by activating the corresponding option in the file web.xml:
Listing 5: web.xml – auto startup of the Workflow Controller
Adapt the value of serverURL to your environment (e.g. http://127.0.0.1:8080/opencrx-core-CRX):
Figure 30: Workflow Controller Configuration – serverURL
Use pingrate to define the interval (in minutes) between successive calls of the respective handler and autostart (true/false) to start the respective handler automatically:
Figure 31: Workflow Controller Configuration – pingrate and autostart
The openCRX IndexerServlet updates index entries (used for keyword/index based search introduced with openCRX v2) by indexing all objects which do not have an IndexEntry newer than the modification date of the object. The IndexerServlet creates an index by invoking the operation updateIndex() on the object to be indexed.
The openCRX SubscriptionHandler is the backbone of the openCRX Subscribe / Notify Services. The Subscription Handler does not require any configuration by the openCRX administrator other than setting the pingrate and autostart options, i.e. it is designed to work “out of the box”.
Turning on the SubscriptionHandler of a particular segment is required if you want that segment to provide Alerts and E-mail Notifications to its Users. The polling frequency can be set by the Root administrator (see Figure 31: Workflow Controller Configuration – pingrate and autostart).
The SubscriptionHandler checks openCRX audit entries on a regular basis and – if matching Subscriptions exist – executes the Workflow Process referenced by the Subscription using Userhome.executeWorkflow().
Userhome.executeWorkflow() – implemented by the openCRX plugin – creates an entry in Userhome.wfProcessInstance (accessible through the grid Workflow Process Instances). Synchronous workflows are executed immediately, asynchronous workflows are left alone (the Servlet WorkflowHandler is specialized in dealing with asynchronous workflows – see below for details).
The openCRX WorkflowHandler is responsible for executing WfProcessInstances based on asynchronous WfProcesses like:
The execution frequency can be set by the Root administrator (see Figure 31: Workflow Controller Configuration – pingrate and autostart).
The WorkflowHandler executes Workflow Process Instances that have not been executed yet.
All the openCRX servlets controlled by the Workflow Controller log their actions to the server log file (e.g. TOMCAT_HOME\log\catalina.<date>.log). The following log file extract shows, for example, that the three Servlets IndexerServlet, SubscriptionHandler, and WorkflowHandler seem to be working fine:
Listing 6: Servlets managed by Workflow Controller log to server.log
INFO [STDOUT] Tue Mar 04 20:25:18 CET 2008: Indexer
openCRX Exceptions (like NullPointers, etc.), however, are still logged to the application log file as configured during the installation.
It is always worth checking whether the Workflow Handlers actually are active; they must be started by the Root administrator. You can find out by connecting to the Workflow Controller (see Figure 27: openCRX 2.4 Workflow Controller).
openCRX features a powerful event subscription and notification service:
Figure 33: Event and Notification Service
Once a topic is created, openCRX users can subscribe to it. Users manage their subscriptions individually on their UserHomes (with the Wizard UserSettings or by editing their subscriptions manually). If a topic has subscribed users and a monitored event occurs then the predefined actions are performed. If the action is set to – for example – creating an alert for subscribed users, then each subscribed user will receive an alert on the UserHome.
The openCRX distribution includes quite a few default topics (see Figure 34: Standard Topics included in the openCRX distribution) to get you started:
Figure 34: Standard Topics included in the openCRX distribution
Users can easily custom-tailor their subscriptions with filters and by selecting event types like Object Creation, Object Replacement, and Object Removal.
In this example we will create a subscription to the standard Topic Account Modifications for the user “guest”.
Figure 35: Create a new Subscription
In combination with openCRX security the subscription filter feature enables you to provide highly specific subscriptions. Imagine the following situation: there are 2 Activity Trackers DivisionA:ProjectX and DivisionA:ProjectY and some of your users are interested in receiving notifications related to activities of ProjectX only, whereas some users want to receive notifications related to activities of ProjectY only. A third group of users wants to receive notifications from both projects. Such a situation could be handled as follows:
Figure 36: Create a Subscription with Filters
Enter the name of the attribute (owner in our example) into the name field and then enter the value(s) to match into the value field (in our case Standard:DivisionA.ProjectX and Standard:DivisionA.ProjectY)
New alerts are also available as RSS feeds. Users can subscribe to their news feed directly from their homepage:
The following table lists some of the common issues and how to fix them:
Please note that we have no intention to duplicate mail server (MTA) or mail client functionality in openCRX as there are lots of excellent products available (Open Source and commercial). It is our goal, however, that openCRX integrates with all the major products that adhere to the major standards and support standard protocols like SMTP, POP3, IMAP, etc. This ensures that you can continue to use your favorite mail server (qmail, postfix, etc.) and your favorite mail client (Thunderbird, Outlook, etc.).
The following figure shows the flow of mail
messages between openCRX, mail server, and mail client as it is
supported with openCRX
Figure 37: Flow of e-mail messages between openCRX, MTA and mail client
In this chapter we will first guide you through the required installation and configuration steps before we discuss various important use cases.
The following chapters explain how to install JavaMail and how to configure the Java mail service and various in- and outbound E mail services.
Detailed installation instructions are provided at the JavaMail home:
And here is the short version:
The following instructions are dependent on your deployment scenario as the steps for creating mail resources vary from application server to application server. We provide instructions for Apache Tomcat.
Open the file TOMCAT_HOME\conf\openejb.xml and add (or modify) the mail resource definition. In the sample file below you must at least adapt the highlighted strings to your own environment:
Listing 7: File openejb.xml
Additional information about configuration options of JavaMail is available from the JavaMail home:
In the file web.xml in the directory <Tomcat Install Dir>\apps\opencrx-core-CRX\opencrx-core-CRX\WEB-INF you must uncomment the following section:
Listing 8: Uncomment mail resource definition in web.xml
Restart Tomcat for these changes to become active.
openCRX users can configure e-mail accounts on their homepage indicating where they would like to receive e-mail notifications (e.g. generated by subscriptions):
Figure 38: Create a new E-Mail Account – step 1
Figure 39: Create a new E-Mail Account – step 2
The various fields have the following meanings:
Figure 40: Create a new E-Mail Account – step 3
Figure 41: E-mail subject prefix and Web access URL
The meaning of the two fields is as follows:
You can easily test your e-mail settings if you create a subscription for Account Modifications (see Example Subscription – Account Modifications) and then work through the following steps:
Figure 42: Example of outbound E-mail Action Log Entries
Please refer to chapter 9.4 Mailstore / IMAP.
Any openCRX E-Mail Activity can be sent as e-mail directly from openCRX:
Figure 43: Send E-Mail from openCRX – Overview
The idea behind this functionality is less that you will use openCRX as a mail client, rather the SendMailWorkflow is an important element of the openCRX campaign management functionality. E-Mail Activities of type “E-Mails” are controlled by the Activity Process E-mail Process. Send E-Mail Activities to all recipients by executing the operation Actions > Follow Up and then selecting the Transition Send as mail as shown below:
Figure 44: Send E-Mail from openCRX with Actions > Follow Up
Any openCRX E-Mail Activity can be sent to your mail client as an attachment. The idea behind this functionality is that you might want to put some finishing touches on an e-mail before you actually send it from your mail client:
Figure 45: Send E-Mail as Attachment from openCRX – Overview
E-Mail Activities of type “E-Mails” are managed by the standard Activity Process E mail Process, i.e. they can be exported to the user's default mail account by executing the operation Actions > Follow Up and then selecting the Transition Export as mail attachment:
Figure 46: Export E-Mail from openCRX with Actions > Follow Up
The SendMailWorkflow supports mail gateways if you set the attribute gateway of the respective e-mail activity. The gateway address is used for addresses which are not of type EmailAddress. For example, in the case of a phone number, the address is converted to an e-mail address as follows:
Example: if the domain address of an e-mail activity is set to the email address firstname.lastname@example.org, the the phone number +41 (44) 111-2233 is converted to the email address email@example.com.
This conversion feature allows you to mix e-mail addresses and phone numbers in member lists of address groups. Depending on the recipient's type of addresss the SendMailWorkflow will either send an e-mail to the listed e mail address as is (e-mail address) or first convert the recipient's phone number to an e-mail address so that the resulting e-mail can be handled by your fax-/sms-gateway.
Please refer to chapter 9.4 Mailstore / IMAP.
Please refer to chapter 9.4 Mailstore / IMAP.
The following table lists some of the common issues and how to fix them:
openCRX features the following groupware services:
Based on Sun's OpenDS, an Open Source Directory Service, openCRX provides LDAP Server functionality (get more information about LDAP or read what Wikipedia has to say about LDAP). In a nutshell this means that you can use any LDAP client to connect to openCRX and view openCRX accounts. Furthermore, openCRX LDAP service supports SSL. The following information is required to connect to openCRX with an LDAP client:
The openCRX LDAP port is by default set to 1389
(to avoid conflicts with other LDAP daemons listening on the LDAP
standard port 389). You can change this configuration in the file
Look for the entry ds-cfg-listen-port.
If you build your own EARs you can change the openCRX LDAP port in your project's file build.properties (ldap.listenPort) or directly in your build.xml.
The following steps are required to configure MS Outlook 2007 for LDAP:
Figure 48: MS Outlook LDAP Configuration
The openCRX vcard servlet does for accounts what the openCRX ical servlet does for activities: it makes them available to third-party clients who access the openCRX server with the http protocol.
othing more and nothing less.
openCRX can map sets of accounts to a vcard file (a sequence of vcards). The resulting vcard file can be imported and/or processed by vcard-enabled clients like Outlook, Thunderbird, etc. At this time, global account filters are the only supported account selectors. Global account filters support reading, updating, and creating of accounts (R=read, U=update, C=create)
Detailed instructions on how to connect MS Outlook are available from http://www.opencrx.org/opencrx/2.4/Outlook_ICS_VCF_adapter.htm
A Thunderbird add-on is in the works:
openCRX supports a wide range of types of activities, including Tasks, Meetings, E Mails, Phone Calls, etc. Even though all activities are kept in a single location (think of a box containing activities), openCRX offers a multitude of mechanisms to structure, filter, and group activities:
To fully understand the power of this approach, consider a large project X (e.g. building a power plant) with millions of activities. With openCRX, a project is typically mapped to an activity tracker (e.g. all activities of project X are assigned to the activity tracker Project X). As a large project is often times structured (i.e. broken down) into milestones, let us assume that the respective subset of activities related to Project X is assigned to an activity group Milestone 2. With openCRX, it's a single click and you can browse all the activities assigned to milestone 2, or you can view all these activities in a calendar application like Sunbird or MS Outlook:
Figure 49: openCRX Activity Groups
It goes without saying that different users have different needs. It is also quite natural that the needs change over time. With openCRX, it is trivial to deliver as there are virtually unlimited possibilities to slice and dice the universe of activities. For example, instead of pulling a set of activities based on their assignment to activity groups, there are many use cases where one would like to define a filter to define a subset of activities. On the one hand, openCRX features lots of default filters, on the other hand, there are powerful tools to define custom filters virtually any way you like. For example: an auditor might be interested in all activities involving a particular subcontractor, another user could be interested in browsing through all the meetings related to Project X:
Figure 50: openCRX Activity Filters
So, in the context of calendaring it helps if you think of a calendar as a set of activities, nothing more and nothing less.
openCRX can map each of the above-mentioned set of activities to a calendar. Depending on the mapping, the resulting calendar can be presented in various formats, e.g. ICS calendar, Free Busy calendar, XML file, etc. Some typical calendar selectors are listed below (R=read, U=update, C=create):
For the purpose of this guide we will work with a tracker called “shared”.
openCRX activities correspond to calendar events (or tasks). An event's iCal representation is stored in the corresponding activity's iCal attribute:
Figure 51: An openCRX activity's iCal representation
In the openCRX standard GUI the same activity is presented as follows:
Figure 52: An openCRX activity in the standard GUI
As the above activity is assigned to “guest” it is automatically filtered to the homepage of the user guest:
Figure 53: An openCRX activity filtered to a user's homepage
For the purpose of this guide this activity is also assigned to the tracker “shared”. In various of this guide's examples we will make use of these facts by using the Calendar Selectors CRX/Standard/userhome/guest and CRX/Standard/tracker/shared.
Free Busy is part of the iCalendar standard (RFC 2445) for calendar data exchange (see also Wikipedia). Many calendar clients rely on this information for group scheduling. openCRX can derive free busy information on-the-fly from the respective activities; two methods are supported, one without authentication (supported by most clients) and one with authentication:
Free Busy URL (without authentication, requires openCRX principal guest):
Free Busy URL (with authentication):
Please note that free busy information is provided by the openCRX server in a read-only fashion (i.e. free busy clients cannot update such information).
Thunderbird 2.0 supports free busy if the following add-ons are installed:
Once the SOGo Connector is installed, Contact Cards of the Thunderbird Address Book will feature a tab CalDAV. This is where you can enter the URL:
See http://support.microsoft.com/kb/291621. Please note that Outlook does not support SSL with free busy.
iCalendar is implemented/supported by a large number of products (see RFC 2445 or Wikipedia for information about the iCalendar standard, sometimes referred to as “iCal”). openCRX can derive iCalendar information on-the-fly from the respective activities. iCal clients must authenticate to read and/or write iCalendar data.
ICS URL (with authentication):
While the mapping of most of openCRX's activity attributes to iCal attributes is obvious, the following hints might still be helpful:
Please note that Activity.percentComplete cannot be changed upon import of a vCard as openCRX activities are managed by activity processes. Hence, changing the status of an activity outside of openCRX does not change the status of this activity in openCRX (even if it is reimported).
Thunderbird 2.0 with the Lightning add-on (at least version 0.8) is a fully-fledged calendar client and offers virtually the same calendaring functionality as the stand-alone calendar client Sunbird (at least version 0.8). Creating a remote calendar (hosted on your openCRX server) is rather straightforward:
Version 0.8 of Thunderbird/Lightning and Sunbird requires a life connection to openCRX (i.e. no support for offline viewing/editing) unless you enable the experimental Cache of Ligthning/Sunbird.
Out of the box Redmond's flagship MS Outlook 2007 does not offer you much choice with ICS calendars. You are stuck with one of the following 2 options:
Not to leave you out in the rain, we put together a bunch of VBA scripts that teach your Outlook a few new tricks. The scripts and detailed instructions for both MS Outlook 2003 and MS Outlook 2007 are available from http://www.opencrx.org/opencrx/2.4/Outlook_ICS_VCF_adapter.htm
Zimbra (v5.0.14 GA Release) does not offer you much choice with remote ICS calendars. It is possible to subscribe to a remote calendar, but in read-only mode; furthermore, only a minimal set of iCal attributes is actually visible in the Zimbra calendar. Nevertheless, here is how to subscribe:
The openCRX ICS Adapter does not support deleting events (because deleting objects is typically not an acceptable operation in an enterprise environment). openCRX does support disabling of objects, however. If there is a need to disable events directly from your ICS Client, here is how to do it:
If you retrieve an iCalender from the openCRX ICS Adapter, the very first event is a so-called Guard Event:
The openCRX ICS Adapter supports the creation of new events/tasks as long as a calendar's Guard Event is posted to the adapter together with the new event/task. The openCRX ICS Adapter also verifies the UID of the Guard Event.
Many calendar applications differentiate between events (entries in a calendar with well-defined start and end date) and tasks or to-dos (entries in a task list with a well-defined due date). openCRX also supports this distinction. openCRX can even convert activities from VEVENT to VTODO and vice versa without loss of information. To convert an openCRX activity from one type to the other, simply edit the activity and change the iCal type in the respective drop down as shown below:
Figure 54: iCalendar conversion between VEVENT and VTODO
Timeline is an extremely interesting DHTML-based AJAX widget for visualizing time-based events. It is like Google Maps for time-based information. A live example is available at http://simile.mit.edu/timeline/
Figure 55: Timeline visualizes time-based events
CrxObjects with sets of activities typically feature the wizard Timeline. Simply call that wizard to construct a timeline to visualize activities right in your browser:
Instead of offering platform specific plugins for a multitude of mail clients like MS Outlook, MS Outlook Express, Thunderbird, Evolution, Eudora, Elm, etc. openCRX features a platform neutral IMAP adapter (get more information about IMAP or read what Wikipedia is saying about IMAP). The advantages of such a standardized IMAP adapter are:
In a nutshell this means that you can use any IMAP client to connect to openCRX and view openCRX EMailActivities. openCRX activity groups are mapped to IMAP folders. The folders contain openCRX EMailActivities.
Viewing/exporting of EmailActivities is always possible, creating/updating of EmailActivities requires that an E-Mail Activity Creator is defined for the respective Activity Group, and deleting of EmailActivities is not supported.
The following information is required to connect an IMAP client to openCRX:
The openCRX IMAP port is by default set to 1143
(to avoid conflicts with other IMAP daemons listening on the IMAP
standard port 143). You can change this configuration in the file
Look for the the param-name port.
If you build your own EARs you can change the openCRX LDAP port in your project's file build.properties (imap.listenPort) or directly in your build.xml.
For increased performance the openCRX IMAP Adapter works with a cache. The location of this cache, the so-called Maildir, can be set as a JAVA_OPTS.
Add the following line to your JAVA_OPTS in your Tomcat start batch file (e.g. tomcat.bat, run.bat, run.sh, etc.):
Listing 11: Set org.opencrx.maildir for Apache Tomcat
The following information is required to configure an IMAP account:
Figure 57: Thunderbird IMAP Configuration
The following steps are required to configure MS Outlook 2007 for LDAP:
Figure 58: MS Outlook IMAP Configuration
The openCRX REST servlet allows easy 3rd party integration with openCRX. The full functionality of the openCRX API can be accessed via REST requests, i.e. you can use openCRX as a REST Service.
See http://code.google.com/p/rest-client/ for a REST client.
Sample REST requests are available
There are many ways of importing data (from other systems into openCRX) and exporting data (from openCRX to other systems). Generally speaking, there is no best way of doing imports/exports because depending on how much weight you put on the pros and cons of the various methods you may come to a different conclusion. Some issues to consider are:
In this chapter we will cover some of the basic options you can choose from, but there are obviously other (and sometimes better) options to consider.
The task of importing data is handled by importers. In principle, you can import almost anything into openCRX, it’s really only a matter of writing an appropriate importer.
The Open Source distribution of openCRX includes importers for vCard (see Importing vCard Files)and iCalendar files (see Error: Reference source not found) in addition to the XML importer.
You can import virtually any data into openCRX as long as you provide it in the form of schema-compliant XML files. The openCRX schema files can be found in the file opencrx-kernel.jar (unzip and look for xmi subdirectories). Alternatively, you can export example objects as XML files and look at the produced XML files (although the generated XML file also contains all the derived and optional attributes; hence, you will have to prune the generated XML file before you can use it as a template).
Some of the configuration information and data provided with openCRX are also provided in the form of XML files and imported during system setup (e.g. units of measurement are loaded from opencrx-core-CRX.ear\opencrx-core-CRX.war\WEB-INF\config\data\ Root\uom_SI_and_Paper.xml).
An XML import from a third party system might typically involve the following steps:
Figure 59: XML import from 3rd party system – overview
You can import schema-compliant XML files with the following methods:
vCard is file format standard for personal data interchange, specifically electronic business cards (additional information is for example available from http://en.wikipedia.org/wiki/VCard).
These are the steps to import a vCard file:
Figure 62: Operation vCard Import
Please refer to the Chapter 8 E-mail Services, in particular chapter 8.3.1 Import E-mails.
There are various other options to consider. You could for example develop a custom-tailored JSP Wizard to import data on demand or on a regular basis (e.g. controlled by the openCRX WorkflowController).
Sometimes it is more appropriate to develop a specific openCRX client to handle imports, and in a typical enterprise class environment you will probably consider developing adapters to connect/integrate openCRX with 3rd party systems on a real-time basis.
The task of exporting data is handled by exporters. The Open Source distribution of openCRX includes exporters for vCard and iCalendar files in addition to the XML exporter.
This allows you to export contacts and meetings/sales visits or any other object from openCRX. vCard and iCalendar files can be imported by a large variety of other applications, including Microsoft Outlook. This chapter shows how to export data.
Navigate to the object to be exported as XML file and execute the operation File > Export Advanced as shown below:
Figure 63: Exporting SalesOrder as XML File
In order to better control which additional objects (composites, referenced objects, ...) the XLM exporter should export together with the object loaded in the Inspector, you can (optionally) provide a reference filter. By default, only the current object will be exported. If you provide – for example when exporting a sales order – customer;address as a reference filter, the customer and all referenced addresses will be exported together with the main object.
Figure 64: XML Exporter provides XML data file and code tables as ZIP file
The openCRX ICS Adapter can also export iCalendars in XML format:
ICS URL (to get XML file with authentication):
Navigate to the object to be exported as spreadsheet file and execute the operation File > Export Advanced as shown below:
Figure 65: Exporting SalesOrder as Spreadsheet File
In order to better control which additional objects (composites, referenced objects, ...) the XLM exporter should export together with the object loaded in the Inspector, you can (optionally) provide a reference filter. By default, only the current object will be exported. If you provide – for example – :*/:* as a reference filter, all composites up to 2 levels deep will be exported together with the main object (this should be sufficient for most use cases). You can also provide a reference filter to dereference and export referenced objects like the customer or the salesRep of a sales order.
If the export is successful the exporter will terminate with status OK and you will be provided with a link to the file Export.xls containing the raw data:
Figure 66: Exported Spreadsheet File
Based on such spreadsheet files end-users can easily create reports or do some ad-hoc data analysis without the need to know anything about Java or writing JSPs. The standard distribution of openCRX includes various example reports based on this technology.
These are the steps to manually export a contact to a vCard file:
Figure 67: Export Contact as vCard
Starting with openCRX v2.4 there is also a wizard available which allows you to export individual contacts of multiple contacts (File > Save as vCard).
These are the steps to export an individual activity (e.g. a meeting or a sales visit) to an iCalendar file:
Figure 68: Exporting Meeting / Sales Visit as iCalendar File
Starting with openCRX v2.4 there is also a wizard available which allows you to export individual activities of multiple activities (File > Save as iCal).
Please refer to the Chapter 8 E-mail Services, in particular chapter 8.2.2 Export E-mails.
There are various other options to consider. You could for example develop a custom-tailored JSP Wizard to export data on demand or on a regular basis (e.g. controlled by the openCRX WorkflowController).
Sometimes it is more appropriate to develop a specific openCRX client to handle exports, and in a typical enterprise class environment you will probably consider developing adapters to connect/integrate openCRX with 3rd party systems on a real-time basis.
Please refer to the guides available at http://www.opencrx.org/documents.htm for detailed information regarding UI customization and localization.
The default installation of openCRX activates all locales that are included in the Open Source distribution. The openCRX administrator may wish to deactivate certain locales from the locale list. This chapter shows how you can achieve this.
The locale list is contained in the file
Look for the section <!-- locales --> to find a list of available locales:
Listing 12: Locales in web.xml
You can deactivate locales by simply commenting them out. The following example shows how to deactivate the locale de_CH.
Listing 13: Activating/Deactivating Locales in web.xml
The default installation of openCRX activates all packages that are included in the Open Source distribution. The openCRX administrator may wish to deactivate certain packages if they are not used. This chapter shows how you can achieve this.
The package list is contained in the file
Look for the section <!-- Admin --> to find a list of available packages:
Listing 14: Packages in web.xml
You can deactivate packages by simply commenting them out. The following example shows how to deactivate the package depot1:
Listing 15: Activating/Deactivating Packages in web.xml
Individual user can enable/disable root menu entries with the wizard User Settings (available on a user's Homage):
Figure 69: Launch Wizard User Settings
Once the wizard has loaded, uncheck entries you don't need:
Figure 70: Wizard User Settings – enable/disable Root Menu Entries
Requires Model Permissions (which are not implemented yet). The same goal can easily be achieved with multiple web applications, however.
Model permissions are not implemented yet.
openCRX is distributed with 2 default layout JSPs located in the directory opencrx-core-CRX.ear\opencrx-core-CRX.war\WEB-INF\config\layout\en_US:
This layout JSP renders all pages that show information (typically an Inspector containing information about the current object and all the grids containing associated information). This layout JSP is generic (it is provided by openMDX/portal) and it can handle any object.
Similarly, this layout JSP renders all pages that are used to edit objects.
If you have a need for specialized screens for a particular object in edit and/or show mode, you can write your own layout JSP and deploy it to the above-mentioned directory. The file name of your custom layout JSP determines which objects (or rather: objects of which class) will be handled by your custom layout JSP.
Let's assume you want to replace the default edit screen for openCRX Contacts (i.e. class org.opencrx.kernel.account1.Contact) with a custom layout JSP. Name your file
and deploy it to the directory ...\WEB-INF\config\layout\en_US. After restarting Tomcat or your application server your new layout JSP will be active.
openCRX provides various technologies that enable you to easily integrate common office suites like Open Office or Microsoft Office.
openCRX supports the JSP-wizard-based generation of RTF documents. You can generate RTF documents from scratch or merge data with existing RTF templates. The RTF documents are generated on the fly and can be opened with any RTF-compatible word processor including OpenOffice Writer and MS Word.
Figure 71: RTF Document generated by merging live data with template
If you installed the openCRX SDK you will find the templates and the JSP wizard in the following locations:
With this approach it is quite easy to generate all kinds of documents, including letters, invoices, purchase orders, etc.
openCRX supports both a raw spreadsheet export of data and the JSP-wizard-based generation of XLS documents. You can generate XLS documents from scratch or merge data with existing XLS templates. The XLS documents are generated on the fly and can be opened with any XLS-compatible spreadsheet program including OpenOffice Calc and MS Excel.
Figure 72: Contacts Export Dialog
You might also want to look at the information provided in the chapters
See chapter 9 Groupware Services.
openCRX provides various technologies that enable you to create reports of a wide variety, anything from simple ad-hoc reports to large scale bulk reports.
Included in the openCRX standard distribution are the following reports:
You can install these standard reports into any openCRX Segment with the wizard Segment Setup. The reports are based on spreadsheet templates. If you installed the openCRX SDK you will find the templates in the following location:
You can test – for example – the Report Account List with the following steps:
See chapter 11.3.2 Exporting Data to MS Excel / OO Calc Files.
Standard office suite know how (and maybe a bit of macro programming) should get you a long way. Once you're ready to “institutionalize” a report you can prepare a template and an openCRX Export Profile. Consult the templates and the Export Profiles provided by the opeCRX distribution for examples.
If your task is to produce a large number of reports (e.g. monthly reporting for all your clients) or reports based on large amounts of data, spreadsheet-based reporting is probably not the way to go. Maybe you want to generate reports in a format other than XLS. On the one hand, openCRX already includes libraries to generate reports and documents in various formats, on the other hand you can easily add additional libraries to openCRX.
Obviously, there are many more possibilities, like for example exporting data in XML format and then doing some kind of fancy transformation. One such example is available from http://www.koalix.org/
In terms of how to generate your reports, there are also various options available depending on your preferences:
The SNMP agent for the Sun JVM can be enabled as described at http://java.sun.com/j2se/1.5.0/docs/guide/management/SNMP.html and http://www.ilikespam.com/blog/monitoring-the-jvm-with-snmp.
#The communities public and private
are allowed access from the local host.
A simple cron-based monitoring environment can invoke snmpwalk periodically and send mail if a monitored parameter violates a predefined constraint. Use gkrellm with the snmp extension (see http://triq.net/gkrellm_snmp.html) or OpenNMS (see http://www.opennms.org/) for more advanced monitoring solutions.
This approach only works for the Sun JVM. JRockit does not seem to support the options -Dcom.sun.management.snmp.*
You can connect Tomcat w/ openCRX with OpenLDAP as follows:
You might want to have a look at some of the additional documentation published at http://www.opencrx.org/documents.htm.