Upload a Custom Activity to Aternity

A Power User of Aternity can add a custom activity to Aternity on-premise, by uploading a signature file which contains the details of that activity in XML. A custom activity is an activity created specifically for your business application to measure the activity response time, usually created in the Aternity Activity Designer.

You can upload custom activities for a desktop application, web application or mobile app only if it appears in the list of managed applications in Aternity.

For example, to monitor an important action in your business application (like viewing a customer's history), you must define this activity very precisely using the Designer, including when it starts (like a mouse click on an icon) and when it ends (like the display of content in a window). Then you can export the custom activity as a signature file to upload it to Aternity.

Uploading a custom activity (signature file) to Aternity

Before you begin

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

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

    Important

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

  • Design your custom activity in Aternity Activity Designer and export it as an XML signature file.

  • Verify the access rights and privileges for your user includes Edit Monitors Tree privileges.

Procedure

  1. Step 1 Open a browser and log in to Aternity.
  2. Step 2 Select the Gear Icon > Monitors to view the Monitors Settings tree.
    Important

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

  3. Step 3 Select the application where you want to add your custom activities.

    When you add an application to be monitored in the Monitored Applications screen, the system automatically adds two default types of monitors under your application:

    Default monitors for an application which you added
    Important

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

    Field Description
    <Application> Built-in Launch

    Monitors the launch times of this application.

    <Application> Built-in Process Resources

    Monitors the resource usage (like CPU and memory) of this application.

  4. Step 4 Create a new monitor for this application, called <Application> (UX).

    Select + at the top of the window, and with WinUI selected on the left hand side (default) enter the name <Application> (UX). For example, Notepad++ (UX).

    You should only create a WinUI monitor for your custom activities. Do not try to create other types of monitors unless directed to do so by customer services.

    Tip

    Place all your custom activities for add-ins or plugins to an application inside its own monitor under the host application folder.

    Add a new monitor for user interaction (UI) custom activities
  5. Step 5 Assign the custom activities for this application to a group of devices in the Group Assignment section.

    For example, if you added new activities to an application, you can test their behavior on a small test group before monitoring them across the entire organization.

    Assign the custom activity to a group of devices

    By default, the system has two groups: All and Test Group. Select the device group to monitor the custom activities on those devices, and select the right arrow > to add them to the Included Groups list.

    To edit the test group, see Defining a Test Group to Roll Out Monitored Applications. To define more than these two groups, use the legacy endpoint groups screen.

  6. Step 6 Upload each new custom activity inside the new UX monitor. Select the <Application> (UX) monitor then select + (Create a New Activity) at the top of the screen.
    Uploading the signature file of a custom activity
    Field Description
    Activity Name

    Enter the name of the custom activity as it should be displayed in the dashboards.

    Description

    (Optional) Enter an internal description for your reference only.

    Activity XML

    Select Browse to upload the signature file to Aternity.

  7. Step 7 Select Create to add the custom activity.

    The system does not yet push your custom activities to Aternity Agents on devices. When you have completed adding the custom activities to the system, select Publish in the top corner to deploy the changes to monitored devices.

  8. Step 8 Add all your custom activities for this application by creating entries under the <Application> (UX) monitor.

    A signature file contains only one custom activity. Upload each signature file in turn for this application under the same monitor.

  9. Step 9 Select Publish in the top right corner of the page to commit the changes to the system and send them to the Aternity Agents 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 the system's monitors.

    Tip

    We recommend after changing the Monitors Settings, validate it by running the Monitors Tester.