Custom Event Type

A Custom Event Type allows administrators to use method code to add events to the publishing queue. This capability enables publishing for events that fall outside the scope of the Event Handling Framework’s standard Item Event Types.

The following steps outline the process of creating a Custom Event Type:

1. On the Subscription form, click Edit.

2. From the Subscription form, scroll down to the Event Types tab and click New Event Type.

   

   The Select Item Type dialog box appears.

   

3. Select Custom Event Type and click OK.

   

   A new row appears on EventTypes tab.

   

4. Right-click on the newly added row and click Open.

   

   The Custom Event Type form appears.

   

5. Add the Event Name and Description.
   The Event Name is required to map the event in the publishing queue to the type of event.
   

6. Click Done to save.

   The Handled By tab shows all the Event Handlers that process this Custom Event Type grouped by Subscriptions. Make sure to save the Subscription otherwise the Subscription will not be visible.

   The Administrators need to develop the method to generate the Server Events that triggers to add events in the publishing queue.

   Note

   The Execution allowed to field should be set to ehf_EventPublishers when creating a Server Events method.

The following steps outline the process of creating the Custom Event Methods:

1. From the Table of Contents, expand Administration and select Methods. The Methods Table of content appears.

   

2. Click Create New Method.

   

   The Method form appears.

   

3. Add the Method Name and the following properties:

   • Method Location: Server-Side
   • Method Type: C#
   • Execution Allowed To: ehf_EventPublishers

4. Write the method code that will add a custom event to the publishing queue.

   The following sample code demonstrates how to use the ehf_PublishEvent action to add a Custom Event to the queue. Replace the highlighted text with the data that will be processed by an Event Handler Method (see section “Create Event Handler Method”):

   Item publishEvent = this.newItem(“Method”, “ehf_PublishEvent”);

   Item eventItem = this.newItem();

   eventItem.setProperty(“type”, “Custom Event Type Name”);

   eventItem.setProperty(“subject”, “context item id or subject string”);

   eventItem.setProperty(“data”, “context item data”);

   publishEvent.setPropertyItem(“event”, eventItem);

   Item result = publishEvent.apply();

   return this;
   

5. Click Done to save.

To publish a Custom Event, the Custom Event Method created in section “Create Custom Event Method” must be executed as an ItemType Server Event, an Action, or some other process.

The following steps outline the process of adding the Custom Event Method as a Server Event on an ItemType:

1. From the Table of Contents, expand Administration and select ItemTypes. The ItemTypes Table of Contents appears.

   

2. Click Search ItemTypes.

   

   The ItemTypes grid appears.

   

3. In the Name field, enter the required ItemType whose data should be published and click Search.

   

4. Right click the ItemType in the grid and click Open.

   

5. Click Edit.

6. Click the Server Events tab.

   

7. Click Add Methods.

   

8. In the Select Items dialog box, search for the method created in the Create Custom Events Method section and click OK.

   

9. In the newly created Server Event row, choose the Event that should trigger the execution of the Method.

   

10. Click Done to save.

    For more information on configuring Server Methods, please see the Developing Solutions Training Guide or the Aras Innovator Programmer’s Guide.

The ehf_EventPublishers Identity is a group Identity used to grant permissions for adding event

to the publishing queue. Any users who may cause an event to be added to the publishing queue

should be added to this Identity.

The following steps outline the process of adding one or more Users (or group Identities) to the

ehf_EventPublishers Identity:

1. From the Table of Contents, expand Administration and select Identities. The Identities Table of Contents appear:

   

2. Click Search Identities.

   

   The Identities Search grid appears.

   

3. In the Name field, enter ehf_EventPublishers and click Search.

4. Right-click on the ehf_EventPublishers and click Open.

   

5. Click Edit.

6. In the Member tab, click Add Identities.

   

7. In the Select Items dialog box, select one or more Identities to include in the event publishing group and click OK.

   

8. Click Done to save.