getEventConfiguration

Requests one or more configuration definitions. The getEventConfigurationRequest response returns the specified configuration definition, or, if the key element is not specified, all event definitions system-wide.

Request

<getEventConfigurationRequest/>
   <key>

Response

<getEventConfigurationResponse>
   <enabled>
     <events>
           <event enabled="">
             <key>
             <persistence>
             <ipAddress>
             <port>
             <http>
             <event>
               <event>
                   <event>
               . . .
                   </event>
                   <type>
          </event>
          <event enabled="">
                <key>
                <persistence>
                <ipAddress>
                <port>
                <http>
                <event>
                     <event>
                  <event>
                  . . .
                   </event>
             </event>
         <containers>
         <container>
     </events>
     <status>
          <code>
     </status>
</getEventConfigurationResponse>

Elements

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.

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.

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. 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.

Example

Following is a sample response to the self-terminating and the associated response:

<getEventConfigurationResponse>
   <enabled>1</enabled>
     <events>
           <event enabled="1">
             <key>Acme</key>
             <persistence>0</persistence>
             <ipAddress>app1.widgets.com</ipAddress>
             <port>5221</port>
             <http>1</http>
             <event>
               <event>ItemAccept</event>
               <event>ItemComplete</event>
                   <event>ItemDecline</event>
                   <event>ItemDelete</event>
                   <event>ItemPurge</event>
                   <event>ItemMarkRead</event>
                   <event>ItemUndelete</event>
                   <event>ItemMarkUnread</event>
                   <event>FolderItemAdd</event>
                   <event>FolderItemMove</event>
                   <event>FolderItemRemove</event>
             </event>
             <type>Appointment Mail Note Task</type>
           </event>
           <event enabled="1">
             <key>AB</key>
             <persistence>0</persistence>
             <ipAddress>http://prestons/</ipAddress>
             <port>5221</port>
             <http>1</http>
             <event>
               <event>AddressBookDelete</event>
                   <event>AddressBookAdd</event>
                   <event>AddressBookItemDelete</event>
                   <event>AddressBookItemAdd</event>
             </event>
           </event>
         <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>
   <status>
      <code>0</code>
   </status>
</getEventConfigurationResponse>