Business Process Automation

Event Group Manager

This page is accessed via Business Process Automation > Power Data > Status > Event Groups.

Event groups categorize status codes into events. For example, if a shipment event arrives stating that a shipment is late, the shipment event group defines whether the message affects arrival or departure at a stop. Use this page to create an event group and add status codes, reason codes, and attributes to it.

Adding an Event Group

  1. Enter an Event Group ID.
  2. Enter a Name for the event group.
  3. To determine the business object for which you are creating event groups, choose an object type in the Data Query Type field.

    Note: When setting up event groups for sell side shipments, you should use the data query type SHIPMENT instead of SELL SIDE SHIPMENT.

  4. Enter an Image File.
  5. Select a Domain Name from the drop-down list.
  6. Enter a Description for the event group.
  7. Select a Status Type. Choose a status type that is associated with the Status Value field. By creating this relationship on the event group you can set objects to the status value when an event occurs with the defined status code. Whenever an event occurs with the status/reason code that appears on an event group, the object that was affected by the event will have it's status value changed to match the one on the event group. In order for this to automatically occur you must use the Update Status for External Event agent action.
  8. Select a Statue Value. Status values are set on an object as described above.
  9. Use the Status Code and the Reason Code fields if you want to associate statuses with the event group. One status code may be part of multiple event groups. You can use the status and reason codes on an event group to change the status type and values on the associated object, as described above.
  10. Select a Domain Name for the status code.
  11. Click Save for each status code you want to associate with the event group.
  12. Enter an Attribute Name. If you add attributes to your event group, you can create more powerful agents. Attributes describe the event group. For example, you can create an attribute to say that the event group requires contact with the customer before proceeding. Also, some attributes control how Oracle Transportation Management handles the event group.

    Note: Do not use the attribute names IS_LATE or IS_FEASIBLE since they are set by the Recalc Estimated Stop Times agent action. Also do not use the attribute name IS_LAST_STOP.

  13. Enter an Attribute Description.
  14. Enter an Attribute Value.
  15. Select a Domain Name.
  16. Click Save for ever attribute you define.

These attributes are used by Oracle Transportation Management out-of-the-box:

Attribute Name

Values

Description

APPOINTMENT_TIME_TYPE

DELIVERY/PICKUP

Use APPOINTMENT_TIME_TYPE to indicate which appointment time of a stop to update.

DELIVERY - update the delivery appointment time of the stop.

PICKUP - update the pickup appointment time of the stop.

IS_APPOINTMENT_TIME

Y/N

Use IS_APPOINTMENT_TIME to indicate if  the event is to update the appointment time of a stop.

Y - update the appointment time of the stop.

N - do not update the appointment time of the stop.

IS_IN_HISTORY_LOG

Y/N

Use IS_IN_HISTORY_LOG to indicate events that you want to display in the GIIV event status history.

Y - adds the event to the GIIV event status history.

N - does not add the event to the GIIV event status history.

IS_TRACKING

Y/N

The Shipment Event Tracker agent only handles event groups marked with IS_TRACKING=Y. A status code may belong to multiple event groups, but out of those event groups only one may be marked IS_TRACKING=Y. The reason is that, if two event groups both were marked IS_TRACKING=Y, the agent wouldn't know which set of these attributes to use.

IS_DELAYED

Y/N

Set IS_DELAYED=Y for an event that you want to indicate that the shipment is delayed.

Y - Oracle Transportation Management treats the shipment as arriving late regardless of the reported times. Oracle Transportation Management updates the shipment process status Delayed.

N - encourages you to view the date and times estimate to determine if the shipment is delayed.

IS_ERROR

Y/N

Use IS_ERROR to rate the severity of a particular event.

Y - indicates an informational event or worse. No action is required for the shipment to continue.

N - everything is fine.

SEVERITY

FATAL/ERROR/WARNING/INFO

Use this parameter to rate the severity of a particular event. The following are valid values:

FATAL - Indicates an event that stops shipment progress. When you enter FATAL the event stops shipment progress and the planner must take action before the shipment can resume.

INFO - Indicates an informational event. A message displays that defines the event but no action is required for the shipment to continue.

This attribute provides a rating of the event, not the impact that the event may have when other factors are taken into account for the shipment. For example you may define an informational event called Arrived  but if the arrival is two days later than scheduled, the event becomes much more important.

IS_BLOCKED

Y/N

Use IS_BLOCKED to rate the severity of a particular event.

Y -  indicates an event that stops shipment progress and the planner must take action before the shipment can resume.

N - everything is fine.

IS_WMS_LOADED

Y/N

Use the IS_WMS_LOADED to indicate when goods are staged in the warehouse or in containers, but are not yet loaded onto the service provider's delivery equipment. Typically a warehouse management system transmits this message, to inform Oracle Transportation Management that the materials are ready for shipping.

Y indicates all shipment goods have been staged at the warehouse or in Containers. Oracle Transportation Management updates the shipment process status to Loaded.

 N indicates null or no indicator provided. Entering N does not mean the goods have not been staged, it just means that this particular event does not convey the WMS Loaded status.

IS_AT_SHIPMENT_LOC

Y/N

Use the Shipment Location parameter to indicate that the event occurred at a location associated with the shipment. Enter Y for events that occur at a location; otherwise enter N.

IS_AT_SHIPMENT_POSITION

Y/N

Use the Shipment Position parameter to indicate that the event occurred at a non-location, interim position along the shipment route. Enter Y for events that occur at a position; otherwise enter N.

ESTIMATE_OR_ACTUAL

E/A/D

Use the Estimate or Actual parameter to define a particular event group as an estimation or actual event. An estimated event is one that is planned but has not yet occurred. An actual event has occurred to a shipment in transit. When a status event gets reported as an estimate, Oracle Transportation Management populates the appropriate planned fields in Shipment Manager. For example, planned arrival dates may be populated. When a status event gets reported as an actual, Oracle Transportation Management populates the appropriate actual fields in Shipment Manager. For example, the actual arrival field may be populated.

The original action provided the above two options to update estimate or actual time on the stop. There is now a third option, Driver CAT/CAL. This is set up in the event group for attributes estimate or actual. The new option, D, instructs the action to update estimate or stop or variance based on the parameter.

USE_IN_MAP

Y/N

Use this parameter to let an event group track the location of a shipment when it is mapped on either the Advanced Layout or the Workbench. Enter Y to let the event group be used for mapping the location of a shipment; otherwise enter N. This parameter is also used for the Map (Related) Shipments action.

Note: The use of advanced layouts has been deprecated as of the 6.4.3 release and will be removed in a later release. You should start using workbench layouts instead.

ARRIVAL_OR_DEPARTURE

A/D

Use the Arrival or Departure flag to indicate whether an event is associated with arrival or departure at a stop. There are two date/times associated with a stop: arrival time and departure time. For delivery events, you typically use departure time. For pickup events, you typically use arrival time. Arrival time fields are populated automatically. Departure time fields are populated automatically. Leaving the flag blank indicates to not associate this event with an arrival or a departure time.

IS_LML_EVENT

Y/N

Use IS_LML_EVENT to enable tracking events for machine learning.

 

Related Topics