Add an Application Event to Aternity in the Monitors Tree

Add a custom activity to Aternity to monitor the performance of any key user actions in an enterprise app by uploading its signature file, which contains the core definition of that activity. This requires the role of Edit Configuration or View Configuration.

To upload a custom activity (not an application event), see Upload a Custom Activity to Aternity.

Create your custom application events in the Aternity Activity Designer to count the number of times something happened in your application, like the number of errors, or the number of times people used a specific feature, or to measure the response time of a non-standard activity.

Define any non-standard activity as an application event, to ensure that other activity response times are not distorted by application events which may have massive response times if the activity includes user interactions, or zero response times if you are counting error messages.

Count a custom application event

There are three types of application events (displayed in the Event_Type field):

  • Application Usage Duration is for measuring the time to complete a non-typical complex business activity, like one which includes application response times mixed with time waiting for the user. For example, use this to measure the time required for a user to identify a customer at the beginning of a call.

    The returned Event_Duration field displays the time for the event to complete.

  • Application Usage Event is for counting the times when an event occurred, or when it is not easy to identify the end event of an activity. For example, if you want to track the number of times when people shared their desktop in Skype for Business, track this as an application usage event, and assign a Category to different types of usage events.

  • Application Error Events are for tracking the occurrence of errors. Each error has a Category, or type of error, and a Details field, which contains details of the event or error.

Create an application event in the Aternity Activity Designer as you would any regular activity, but Application Usage Events and Application Error Events do not have a start event. For example, to view an error message, you only capture the event of the error, without measuring any times.

Create an activity signature to upload to Aternity

Before you begin

Before you upload a custom application event to Aternity, ensure you have done the following:

  • Add the application to be managed in Aternity by selecting the Gear Icon > Managed Applications.

    Important

    Do NOT add a new application in the Monitors Settings screen. You must add it only in the Monitored Application screen, because there Aternity adds the required default settings, which are essential to the smooth running of the dashboards.

Procedure

  1. Step 1 Design your application event in Aternity Activity Designer and export it as an XML signature file.

    If your application event does not measure duration, place the event hexagon in the Complete box only.

    Define the Complete section of the activity

    Ensure you enable the application event's contextual fields (Info1 and Info2), and for Application Usage Duration events, use the activity response.

    Provide design details for your new custom activity
    Field Description
    Activity Response

    (Application Usage Duration events only) Use this field to store the length of time for an application usage duration, which maps to the Duration field of the event.

    Info1

    Displays as the Category field of an application event in Aternity dashboards. Use to categorize an application usage event, or to store the type of error in an application error event, or for other custom data.

    Info2

    Displays as the Details field of an application event in Aternity dashboards. Use to store the details of the event or error or other custom data.

    Incomplete Events

    Remove any automatically-generated incomplete events, which do not apply to application events.

  2. Step 2 Generate the signature (XML) file.
  3. Step 3 For application events which do not measure the response time (Application Usage Events and Application Error Events), you must manually remove the start event.
    1. a Open the file in a plain text editor.
    2. b Search for <States> and replace it with <States><act:State id="idle" type="start"/>.
    3. c Search for <act:Transition from="Start" id="Start-Complete" to="Complete"> and replace it with <act:Transition from="idle" id="idle-Complete" to="Complete">.
    4. d Save the file.
  4. Step 4 Open a browser and sign in to Aternity.
  5. Step 5 Select the Gear Icon > Monitors to view the Monitors Settings screen.
    Important

    Do NOT change settings here unless you are an expert in Aternity, as it could easily ruin the data and dashboards of Aternity. Even then, only change the settings as prescribed in the official Aternity documentation.

    Configure advanced settings for managed applications in the monitors settings screen
  6. Step 6 Select the managed application to which you want to add your custom activities.
    Important

    Do not open, edit or remove any default monitors. They are essential for the proper monitoring of this application, and require their settings to remain untouched.

  7. Step 7 Create a new monitor for this application by selecting + at the top of the window.

    Select the type of application event from the left panel.

    Create a new application event monitor for your custom activity
    Field Description
    Type

    Application Usage Duration is for measuring the time to complete a non-typical complex business activity, like one which includes application response times mixed with time waiting for the user. For example, use this to measure the time required for a user to identify a customer at the beginning of a call.

    Application Usage Event is for counting the times when an event occurred, or when it is not easy to identify the end event of an activity. For example, if you want to track the number of times when people shared their desktop in Skype for Business, track this as an application usage event, and assign a Category to different types of usage events.

    Application Error Events are for tracking the occurrence of errors. Each error has a Category, or type of error, and a Details field, which contains details of the event or error.

    Name

    Enter the name of the monitor, for example, MyApp (AppEvent).

  8. Step 8 Upload the signature file by selecting the newly created monitor in the tree in the left pane, and selecting + Create a New Activity.

    Browse to the the XML signature file of the application event, and select Create to create a custom activity from your signature.

    Upload the XML signature file and then create the activity
  9. Step 9 Select Publish in the top right corner of the page to commit the changes to Aternity and send them to the Agent for End User Devicess on devices in the group you chose.
    Commit changes by publishing them

    Selecting Publish releases the editing lock on this screen and allows any other Power User of Aternity to edit Aternity's monitors.

    Tip

    We recommend that after you change the Monitors Settings, validate your change by running the Monitors Tester.