Adding a New Event Map
You can add a new event map by clicking the Add Event Map button on the KPIs > Business Data page or the KPIs > System Data page. There are two ways to create an event map in Optimize. The first is to build an event map from scratch by specifying a new event type and manually adding each event field. The second approach is to select a known event type which will automatically add the event fields.
Note:
Note that it is not recommended that you create an event map using fields which generate a unique value with every transaction. If you use such a field in your event map, Optimize creates a new KPI instance every time a new event of this type is received. This results in database tables with extremely large size and makes any further data processing cumbersome.
To create an event map from scratch, click the Add Event Map button and enter a new event type on the Event Map page. You must ensure that the event type matches the incoming event type name exactly.
To create an event map from a known event type, you can either select the event type from a listing of unmapped event types, which will open the Event Map page, or you can click the Add Event Map button and select an event type from the drop-down list. Both methods will pre-populate the mapped fields table from the fields in the event type.
Note that unmapped event types are events that have been sent to the Analytic Engine prior to event mapping. To view all unmapped event types for your system, you can search for “unassociated” from the Business Data or System Data pages, and the unmapped event types will be displayed under an Unmapped Event Types heading in the KPIs region on the lower part of the page.
When you add an event map, you must configure some or all of the following information:
Name the event map.
Specify the event type.
Associate a business process to the event.
Map fields to the event.
When you map fields to an event, you might add new fields, remove existing fields, and choose or remove intrinsic fields (for intrinsic metrics). In addition, working with fields for events can involve specifying the data type for the field, associating an intelligent link with a dimension, and specifying a calculation type and a unit of measure for a measure data type. Note that fields cannot be added or removed from a map that is based on a subscribed event type.
Also, when working with event maps, you can add intrinsic process metrics to define KPIs that combine business data with process and step metrics (such as Process Cycle Time by Customer).
The following procedure describes the specific steps to create a basic event map.
To add a basic event map
1. In My webMethods navigate the following path: Navigate > Applications > Administration > Analytics > KPIs > Business Data (Optimize for Process only) or Navigate > Applications > Administration > Analytics > KPIs > System Data
2. Click Add Event Map. Alternatively, you can search for unassociated to display Unmapped Event Types and then click on the desired event type.
The Add Event Map page is displayed.
3. In the Event Information panel, complete the following steps:
a. In the Name text box, type a name for the event map.
b. Select or enter an event type for this event map:
If the system has already collected data for an event type, then an event type will already exist. From the
Event Type list, select an existing event type for this event map.
If the system has not collected data for this event type, then you must create a new event type. Click
Other, and then enter the name of the new event type in the
Other value pop-up field.
If you want to create an event map based on a subscribed event type, you must first use the Event Subscription page to subscribe to the desired event type. After you subscribe to events, they are available for use in Optimize.
c. If you are working with Business Data, select a business process with which you want to associate business data for this event map from the Business Process list. If the data is not associated with a process, leave None in the Business Process list.
Associate an event map with a business process if the business data that is sent to Optimize for that event map is sent as part of process instance control operations (step control operations). Associating an event map with a business process allows for process and step metrics to be associated with business data that is stored against that event map.
Note:
The Business Process list is not displayed if you click Add Event Map on the System Data page.
4. If you selected an existing event type, each field known to that event type is automatically added to the Field Mapping panel. You can edit each field as needed, and you delete any fields that are not needed by selecting them and clicking the Delete button. Remember that fields cannot be added for subscribed event types.
5. To assign more field mappings (for example, if you are using the Web Service Data Collector and you start collecting new types of data), click Add Field and complete the fields in the Field Mapping dialog box as many times as necessary.
For each field, you must configure the mapping by assigning the field type and various related information that will be used by the Analytic Engine. To configure a field click either the field name or the Edit icon. Either action activates a dialog with configuration options.
6. In the Field Mapping dialog box, complete the following steps for each new field you want to map:
a. Enter a name for the field in the Field text box. (Fields automatically imported from an existing event type cannot be renamed.)
b. In the Display Name field, enter a user-friendly name to display for the field on Optimize pages. If the field name is user friendly, you can also use it as the display name.
c. From the Type list, select a data type. Depending on your selection in the Type list, the following lists or text boxes appear in the bottom half of the dialog box. Select from these lists or enter text as appropriate.
The following table describes the data types.
Data Type | Description |
Dimension | A dimension represents data that you can categorize, query, and associate with a KPI (such as region or host name). Choose between an Existing Dimension or a New Dimension. Select Existing Dimension to link the event map to a dimension that already exists. Select the name of the existing dimension from the Dimension list, and select a value for the dimension in the Attribute list. Select New Dimension to link the event map to a dimension that does not yet exist. Enter a name for the dimension in the Dimension text box, and enter a value for the dimension in the Attribute text box. |
Transaction | A transaction is an attribute that you do not want to measure but that you would like to store in the database to use in a rule expression or to associate with a fact that arrives with the same event. Select the Transaction type to specify additional fields in a document, such as document identifiers, order numbers, or error messages. Optimize displays these fields on the KPI Instance Detail page and in alerts from rules defined for the event. To link the transaction data to a URL specified in an intelligent link (see
Defining Intelligent Links), select the name of the link from the Intelligent Link list, and select an optional parameter for the link from the Parameter list. Position the mouse pointer over a parameter name to display a description of the parameter. |
Measure | A measure (formerly known as a fact) is a measurable value (such as revenue or queue length) that the Analytic Engine can use for calculation or analysis. Select a calculation type and enter a unit of measure for the value: Calculation Type: Select Sum to total the data collected during the collection interval. Select Average to average the data collected during the collection interval. Select Last Value to use only the last data point collected. Select State to aggregate the binary state of the data point (such as online or offline). Select Max to collect the maximum value from the collection interval. Select Min to collect the minimum value from the collection interval. Select Count to count the data points during the collection interval. In the UOM text box, type a unit of measure (such as Dollars or Bytes). If you want the unit of measure to be automatically formatted when the KPI results are displayed, use one of the keywords described in the following step (keywords are not case sensitive). |
Date | |
7. In the Field Mapping dialog box, if you chose Measure as the data type, you can use one of the keywords in the UOM field so the unit of measure is automatically formatted when the KPI results are displayed.
The following table lists the unit of measure description, the keyword(s) for UOM field and how the unit of measure is displayed in the KPI Results.
Unit of Measure Description | Keyword(s) for UOM Field | Display in KPI Results |
Dollars | “dollars” or “$” | <value to two decimals>$ |
Thousands of dollars | “$1000” Multiplies the result by 1000. | <value>,000.00 $ |
Percentage | “%” or “percent” Using “%” multiplies the result by 100. | <value to two decimals>% |
Size in bytes | bytes | <value to two decimals>bytes |
Size in kilobytes | k kbytes kilobytes | <value to two decimals>k |
Size in megabytes | mb megabytes | <value to two decimals>MB |
clients | clients | <value to one decimal> |
connection count | connection count | <value to one decimal> |
connections | connections | <value to one decimal> |
Item count | count | <value to one decimal> |
number of documents | documents | <value to one decimal> |
number of errors | errors | <value to one decimal> |
number of files | files | <value to one decimal> |
insert row count | insert row count | <value to one decimal> |
number of instances | instances | <value to one decimal> |
number of items | items | <value to one decimal> |
monitor count | monitor count | <value to one decimal> |
number of records | records | <value to one decimal> |
row count | row count | <value to one decimal> |
threads | threads | <value to one decimal> |
thread count | thread count | <value to one decimal> |
traces | traces | <value to one decimal> |
time in milliseconds | ms millis milliseconds | <hh:mm:ss> Hours <mm:ss> Minutes <ss:mm> Seconds <mmm> Milliseconds |
time in seconds | sec seconds | <hh:mm:ss> |
Online/offline | state | 0 = offline 1 = online |
8. To assign more field mappings (for example, if you are using the Web Service Data Collector and you start collecting new types of data), click Add Field again and complete the fields in the Field Mapping dialog box as many times as necessary.
9. To delete a field mapping, select the check box beside the field name and then click Delete.
10. If you are ready for Optimize to create a database table and begin collecting event-map data, click Save.
When you click Save, Optimize allocates database tables to store the event map in the database and also begins to process incoming data for the event map. When you save an event map, any changes to the event map will cause previously collected data to be discarded.