Configuring External Event Types

External Event Types will need to be configured so that it is possible to manage which events cause CAP messages to be sent to the Message Broker.

Also, Code table items need to be added for each External Event Type so each Event Type will have a code table value associated with it.

For more details on Code Tables, refer to the Application Configuration section of the System Configuration guide.

Adding Event Type Code Table Items with CTX

CTX data files can be used to add External Event Types, as illustrated in the following example.

Figure 1. Adding Event Type Code Table Items with CTX data

<codetables package="curam.codetable">
  <codetable
    java_identifier="EXTERNALEVENTTYPE"
    name="ExternalEventType"
  >
    <displaynames>
      <locale language="en">External Event Type</locale>
    </displaynames>
    <code
      default="false"
      java_identifier="EVENTADAPTOR_SAMPLE"
      status="ENABLED"
      value="ET2000"
    >
      <locale
        language="en"
        sort_order="0"
      >
        <description>Sample External Event</description>
        <annotation/>
      </locale>
    </code>
  </codetable>
</codetables>

Adding Event Type Code Table Items

Alternatively, another mechanism for providing the external event information is via the admin application UI.

Login to the application as a user with system administrative privileges and navigate to the "Code Tables" section.
Search for "ExternalEventType". This should return the "External Event Type" code table.
Click "New Item..." in the list row menu.
On the "New Code Table Item" modal, enter the Item name and the code table value and click "Save". Repeat as necessary.
Then click "Publish..." on the "Code Tables" tab menu to make the changes available.

The External Event Type code table item has been added and is now available to be configured.

Configuring External Event Types with DMX

Alternatively, DMX data can be used to configure External Event Types, as illustrated in the following example.

Figure 2. Configuring External Event Types using DMX Data

<table name="EXTERNALEVENTTYPE">
  <column name="externalEventType" type="text" />
  <column name="externalEventEnabled" type="bool" />
  <column name="externalEventTypeID" type="id" />
  <column name="versionNo" type="number" />
  <row>
    <attribute name="externalEventType">
      <value>ET2000</value>
    </attribute>
    <attribute name="externalEventEnabled">
      <value>1</value>
    </attribute>
    <attribute name="externalEventTypeID">
      <value>8897986963777257472</value>
    </attribute>
    <attribute name="versionNo">
      <value>2</value>
    </attribute>
  </row>
</table>

Configuring External Event Types through the Application

Another mechanism for providing the external event information is via the admin application UI. For details on enabling / disabling, please see the administration section.

To access the External Event Type admin page, login as a user with administrative privileges and navigate to the "Administration Workspace". Select "Event Adaptor" from the shortcuts panel. This will open the Event Adaptor tab.

Adding External Event Types

An External Event Type will need to be added to the list so that it can be managed.

Select "Add..." from the page level menu to open the "Add External Event Type" modal.
Check the boxes on the events that you would like to add on this modal page, and then click "Yes".

The selected External Event Types will be added to the list.

Deleting External Event Types

An External Event Type may need to be deleted.

Select "Delete" from the list row menu of the External Event to be deleted.
Clicking on the "Yes" button on the "Delete External Event Type" modal will delete the External Event Type.