docmain.css" />

# configureEvents

Updates an existing definition; or, if there is not a definition with the same key, a new definition is added to the user's database. Event definitions can be added at any time, but are not active until the enabled tag on the events element is set TRUE (1).

## Request

    <configureEventsRequest>
       <enabled>
          <events enabled="">
          <key>
               <persistence>
               <ipAddress>
               <port>
               <event>
                    <event>
                 <event>
             . . .
                 <type>
               </event>
             <containers>
             <container>
          </key>
       </events>
    </configureEventsRequest>

## Elements

enabled

  Enables/disables event processing. If set to FALSE (0), event processing is disabled for that event configuration only. Other event configurations are not affected.

key

  Uniquely identifies the application instance. It is up to the application to control the uniqueness of the application key. GroupWise Events uses any key that it is passed. If two applications or two instances of an application pass the same key, GroupWise Events maps them both to one event configuration structure in the user's database.

persistence

  Controls removal of old event records in the user's database. Any event records an application has not removed are cleaned up during nightly maintenance according to the persistence element associated with that record. Persistence is defined in days, between 0 and 20 inclusive. If persistence is not defined, GroupWise Events defaults to seven days.

ipAddress

  Identifies the IP address, or HTTP URL, that should be used for event notification.

port

  Specifies the IP port on which the application is listening for event notifications.

http

  Specifies whether event notification should occur through TCP/IP or HTTP. If set to FALSE (0), the value in ipAddress is treated as an IP address and a TCP/IP stream is used to provide notification. If set to TRUE (1), the value in ipAddress is treated as an HTTP URL (for example, http://www.acme.com/events).

event

  Identifies a GroupWise event that has occurred. Event item types are stored in a <space> separated list. Event modified fields are also stored in a <space> separated list.

containers

  Specifies the containers in which the application wants to track the specified events. Each container element, if present in containers, maps to one of the following events: FolderItemAdd, FolderItemDelete, ItemDelete, ItemUndelete. If no container is specified, events are reported system-wide.

## Remarks

configureEventsRequest uses the Events structure, which defines the event configuration for one application.

This method does not affect other definitions that are already defined.

## Example

Following is an example of an event configuration request:

    <configureEventsRequest>
       <enabled>1</enabled>
      <events enabled="1">
             <key>Acme</key>
         <persistence>0</persistence>
               <ipAddress>app1.widgets.com</ipAddress>
               <port>5221</port>
               <event>
                 <event>FolderItemAdd</event>
                 <event>FolderItemMove</event>
                 <event>FolderItemRemove</event>
                 <event>ItemAccept</event>
                 <event>ItemComplete</event>
                 <event>ItemDecline</event>
                 <event>ItemDelete</event>
                 <event>ItemMarkRead</event>
                 <event>ItemMarkUnread</event>
                 <event>ItemPurge</event>
                 <event>ItemUndelete</event>
                 <type>Appointment Mail Note Task</type>
               </event>
             <containers>
                <container>
                <container>7.AutoDomain.AutoPO1.100.0.1.0.1@16</container>
                <container>A.AutoDomain.AutoPO1.100.0.1.0.1@19</container>
          </containers>
       </events>
    </configureEventsRequest>