Skip to main content

FieldLogs

Creating A Usage Event

A Usage Event is a code to describe a predefined Event on Fieldlogs. It tracks user interaction on a Task. Usage Events are raised by the operators when a Task is in Execution.

Create Usage Event

To create a Usage Event:

  1. On the main menu go to Enterprise > Flagging & More > Usage Events

    ue_mainpage.png

    The Usage Events page opens. All Usage Events already created in the system are displayed.

    all_UE_display.png

  2. Click Create Usage Event / Group

    create_UE.png

    The Create a Usage Event / Group dialog box opens.

    image_4_UE_updated.png

  3. Select Usage Event from the Create a Usage Event / Group dropdown list.

    uehighlight.png

    The dialog about Usage Events appears.

    refilldetails.png

  4. Enter a Name for the Usage Event. This is a mandatory field.

  5. [Optional] Enter a Description for the Usage Event.

  6. [Optional] Enter a Custom ID.

    This allows a custom string to be associated with the Usage Event. This is useful where the same Usage Event might be referred to differently outside FieldLogs.

  7. [Optional]Select an Icon and a Color for the Usage Event

    Resource_refill_icon.png

    .

  8. Click Manage Attributes to add Attributes to the Usage Event.

    manageattributes.png

    The Attributes dialog appears. Click Add new Attribute.

    Select a type from the list displayed.

    Usage_event_add_attribute.png

  9. Enter the details of the Attributes.

    1. Enter the Attribute Name.

    2. [Optional] Enter the Attribute Label.

      UE_ATTRIBUTE_TYPES.png

    3. [Optional] Click the + icon as shown below, to categorize the Attributes based on a Group.

      Click_Group_flag_attribute.png

    4. [Optional] Select an existing Group from the dropdown or create a new Group.

      Group.png

    5. [Optional] Check Required as shown below to make an Attribute mandatory.

      required_attribute_UE.png

    6. [Optional] Click Delete_icon.png as shown below to delete the Attribute.

      DELETE_attribute_UE.png

    7. Click Confirm to save the Attributes added.

      confirm_attribute_UE.png

      The Attributes are saved.

      UE_saved_attribute.png

  10. Enter the details for Data Display. Data Display appears only for Attributes of type DataSet.

    DD_TEXT_PROPERTY.png

    Notice

    It is mandatory to fill the Data Display section for Attributes with the type Data Set. Fill in the Text part and the Property part.

    ddtext.png
    DDProperty.png
    refilldatadisplay.png

  11. Click Create.

    refillcreateue.png

    The Usage Event created is displayed on the main page as shown below.

    UE_REFILL_MAINPAGE.png

    Note

    Deprecate an attribute after creating a Usage Event.

    After creating the Usage Event, any of its attributes can be deprecated, using the toggle button as shown in the image.

    deprecate_UE_new.png

    Warning

    Deleting the Data Display format issues the error message as shown.

    DD_error.png

    Leaving the Text and Property empty issues the error message as shown.

    DD_error_empty.png
Deleting a Usage Event

To Delete a Usage Event:

On the Usage Events main page, select the Usage Event to be deleted. Click Delete.

DeleteUE.png

Important

If the Usage Event is added to a Usage Event Group, it must be removed from the group before deleting it.

delete_warning.png
remove_from_group.png
Creating a Usage Event Group

A Usage Event Group logically groups related Usage Events.

To create a Usage Event Group:

  1. On the main menu, go to Enterprise > Flagging & More > Usage Events

    ue_mainpage.png

    The All Usage Events page opens.

    UE_page.png

  2. Click Create a Usage Event / Group.

    create_UE.png

  3. The Create a Usage Event / Group dialog opens. Select Group from the dropdown list.

    groupselection.png

    The dialog about the Usage Event group appears.

    refillgroup.png

  4. Enter a Name for the Usage Event Group. This is a mandatory field.

  5. [Optional] Enter Description.

  6. [Optional] Enter Custom ID. This ID associates the current Usage Event Group in FieldLogs to a string that is used to refer to the same Usage Event outside FieldLogs.

  7. Check Enabled. The Usage Event Group will not be visible at runtime if this is not checked.

  8. Click Add Usage Event to add Usage Events to this particular Group.

    addusageevent.png

  9. The list of available Usage Events appears. Select the Usage Events to add to the group and click Confirm.

    Note

    Any number of Usage Events can be added to a Group.

    addtogroup.png

  10. The selected Usage Events have been added to the Group.

    addedtogroup.png

  11. Click Create.

    creategroup.png

    The Usage Event group is created as seen below.

    createrefillgroup.png
    refillgroupmainpage.png
Deleting a Usage Event Group

To delete a Usage Event Group :

Select the Usage Events Group to be deleted on the Usage Events main page. Click Delete.

deleteUEGROUP.png
In this section: