Skip to main content

Events

Overview​

This screen allows users to define User Events to fire when a rule raises a flag. A user event is basically an event code combined with a message text. The message text can contain placeholders for context-specific values and can be supplied in multiple languages. If the message text includes placeholders, you can specify the values to merge into the message when the event is raised.

Whenever a rule is used in Studio, for instance, to provide the value for a field, the user is presented with a panel to define which value to provide for each of the parameters for the rule. The user can provide a literal value, reference a Constant or provide other value types depending on the exact context.

The panel also presents the user with all the possible flags that can be raised by the rule. At this point, the user decides how the framework should react to each flag:

Ignore
The flag is ignored; no event is fired, and no action is taken.
User Event
The user can identify a User Event as described above. The severity defined on the event will decide how the framework reacts.
System Event
The user decides that the nature of the flag in this context does not merit a user event. In this case, the framework will generate a standard message text in case the flag is raised. In this case, the user must also specify the severity of the System Event.

Events (User and System) fired in this manner that are collected by the Director Runtime, shown in real-time when monitoring the migration and shown in the Tracking Web Application.

Events are discussed further Flags and Events Discussion.

List View​

Clicking on the Event folder in the Project Explorer opens the Event list.

List view

This screen provides a summary of the User Events.

Event Screen​

Event screen

An Event consists of these parts:

  • It has a number. When you create a new Event, Studio will assign the next vacant number to the Event.
  • Disposition defines the consequence if this Event is fired:
    • Full discard: The entire Business Object will be discarded, and no Target data will be produced.**
    • Partial discard: Only relevant on a child Business Object. Will discard the current Child Business Object and descendants, but let the rest of the Business Object through.
    • Retain: No consequence.
  • Impact signifies how important this event is to the migration. Impact can have these values - with these suggested meanings:
    • Critical: This is a critical problem that must be fixed before the migration goes live.
    • Advisory: This is a problem that may be resolved in the Target System after go-live.
    • Information: This is a purely informational event and does not signify any problem.
  • Receiver suggests who initially should be assigned the responsibility to trace and fix the Event:
    • Source: Users of the Source System, typically need some data cleansing or likewise
    • Migration: The migration team handles the Event.
    • Target: Users of the Target System, typically to update some missing code values or similar in the Target System.
  • It has a Text that will ultimately be shown in the Portal:
    • The Text can have placeholders in the form of {0}, {1}, {2} and so on. The placeholders will be replaced by the value of the Parameters of the Event.
    • If the project supports multiple languages, you can supply the text for each language.
  • It has Parameters to be substituted for the placeholders described above.
  • Finally, you can add some text to help with the resolution of the event, should it occur in the migration:
    • User Guidance will show up in the Portal, and you can use it to assist your testers.
    • Internal Description is only visible in Studio itself. Use it to provide assistance to your team members that you not want your testers to see.
info

Disposition, Impact and Receiver are defaults - when the Event is connected to a Flag, it is possible to override them in that specific context.