Skip to main content

FieldLogs

Setting up Event Triggers

The Counter in an Operation Plan is Trigger-based. It has an Event Trigger that executes an Action when the specified Event occurs in the system.

An Event Trigger provides a method to initiate a Task creation. It enables users to establish a logical process for generating Tasks based on their requirements.

Select the Type of Event Trigger from the Type dropdown list as shown below:

dropdown_options_of_event_trigger.png

There are ten different types of Event Triggers:

  1. Task Started

  2. Task Done

  3. Time Based

  4. Measurement Point

  5. Counter Activated

  6. Operation Plan Activated

  7. Data Object Saved

  8. Data Object Deleted

  9. Multiple Task Done

  10. Task Progress

Based on the Type of Event Trigger chosen, the fields relevant to the chosen Type appear.

Task Started

An Event Trigger of Type Task Started triggers the Action when a Task of the selected Template is started.

To add an Event Trigger of Type Task Started:

  1. Select Task Started from the Type dropdown list.

    EventTrigger-TaskStarted1.png

  2. Select the Template associated with this Trigger.

    In the example below, this Event Trigger is set to be triggered when a Task assigned from the Template Battery Inspection Procedure is started.

    EventTrigger-TaskStarted2.png

    You can customize the name and description of the Event Trigger as shown in the example.

  3. Click Save.

    TaskStarted2_Save.png
Task Done

An Event Trigger of Type Task Done triggers the Action when a Task for the selected Template is completed.

To add an Event Trigger of Type Task Done:

  1. Select Task Done from the Type dropdown list.

    EventTriggers-TaskDone1.png

  2. Select the Template associated with this Trigger.

    In the example below, this Event Trigger is set to be triggered when a Task assigned from the Template Battery Inspection Procedure is completed.

    EventTrigger-TaskDone2.png

    You can customize the name and description of the Event Trigger as shown in the example.

  3. Click Save.

    TaskDone2_Save.png
Time Based

An Event Trigger of Type Time Based can be set to trigger at a specified time. It can also be set to recur at a specified frequency.

The scheduling options also allow a detailed weekly schedule to be set for an Event Trigger.

To add an Event Trigger of Type Time Based:

  1. Select Time Based from the Type dropdown list.

    EventTrigger-TimeBased1.png

  2. Choose the appropriate schedule for your Event Trigger by editing the Scheduling Options shown below.

    EventTrigger-TimeBased2.png

    You can customize the name and description of the Event Trigger as shown in the example.

Scheduling Options

You can schedule your Event Trigger to recur at a desired frequency. The following options are available to customize the Event Trigger.

1. Start on Project Dates

If the Activate Trigger on Project Dates option is checked, then the Trigger will only execute if the project start date has been reached. By default, this option is checked.

EventTrigger-TimeBasedOptions1.png

If this option is checked, the Event Triggers will not be activated in a Project that has not yet started or already finished, even if the Operation Plan is active and the trigger events occur in the system.

This allows you to set up all the Operation Plans for a Project in advance. You can create Operation Plan Executions from the corresponding Operation Plan Definitions and activate them well before the Project start date. If the Event Triggers have this option checked, they will be activated only when the Project starts.

Sample Scenario:

Create a Project that starts in two weeks. Create an Operation Plan Definition where a Time-Based Event Trigger executes every day and performs a Task. Set the Trigger to be activated on Project dates. Create an Operation Plan Execution from the Operation Plan Definition and activate it. Although the Operation Plan is active, the Event Triggers will not be activated until the Project start date. Once the Project is finished, the Event Triggers will stop being activated.

2. Recurring Schedule

Click the Frequency dropdown list to specify a frequency.

EventTrigger-TimeBasedOptions2.png

Select the desired frequency from the list of options available.

EventTrigger-TimeBasedOptions3.png

You can choose to schedule the Trigger to run once every 'n' minutes, hours, days, months or years. This can be done by using the arrows indicated to increment or decrement the number.

EventTriggers-TimeBasedOption4.png

3. Schedule Time Zone

You can set a Time Zone which the Event Trigger must use. By default, it uses the Operation Plan Time Zone. This is indicated by the Use Operation Plan Time Zone option being checked.

EventTrigger-TimeBasedOption5.png

Uncheck the Use Operation Plan Time Zone option and click the Select a time zone dropdown list to select a Time Zone different from that of the Operation Plan.

EventTrigger-TimeBasedOption6.png

4. Weekly Schedule:

You can schedule your Event Trigger to run on specific days of the week or can also add multiple ranges on the same day. By default, all the days are checked as seen below. You can uncheck the days on which you do not want the Action to be executed.

EventTrigger-TimeBasedOption7.png

Click Add range to set the time at which the Trigger should execute.

EventTrigger-TimeBasedAddRange.png

A 24 hour slider appears as shown below.

EventTrigger-TimeBasedSlider.png

You can select a window of your choice to the nearest minute as highlighted below. Click Confirm to set a range.

EventTrigger-TimeBasedRange1.png

The range is set as shown below.

EventTrigger-TimeBasedRangeSet.png

The range set can be copied and pasted to another day using the Copy and Paste options available.

EventTrigger-TimeBasedCopyPaste.png

For example, the range from Monday has been copied to Wednesday in the example below.

EventTrigger-TimeBasedCopiedPasted.png
Measurement Point

An Event Trigger of Type Measurement Point executes the Action when the JS Script associated with the Measurement Point computation returns the Boolean value of true.

To add an Event Trigger of Type Measurement Point:

  1. Select Measurement Point from the Type dropdown list.

    EventTriggers-MP1.png

    You can customize the name and description of the Event Trigger as shown in the example.

  2. Select the Template which has the Measurement Point to be associated with this Trigger.

    EventTriggers-MP2.png

    Note

    Measurement Points configured on Components within a Template can also be selected as Triggers. These will be triggered when the parent Template is executed.

    ComponentWithMP.png
    OPPlanComponent.png

  3. Select the Measurement Point to be associated.

    EventTriggers-MP3.png

  4. Enter the JS Script to be executed when the Measurement Point is computed.

    EventTrigger-MP5.png

    Note

    The JS Script needs to return the Boolean value of true for the Action to be executed.

  5. Click Save.

    MP5_Save.png
Counter Activated

An Event Trigger of Type Counter Activated triggers the Action when the current Counter is activated.

To add an Event Trigger of Type  Counter Activated:

  1. Select Counter Activated from the Type dropdown list.

    EventTrigger-CA1.png

  2. Enter the Name and Description of the Event Trigger to customize it and click Save to save the changes.

    EventTrigger-CA2.png
Operation Plan Activated

An Event Trigger of Type Operation Plan Activated triggers the Action when the current Operation Plan is activated.

To add an Event Trigger of Type  Operation Plan Activated:

  1. Select Operation Plan Activated from the Type dropdown list.

    EventTrigger-OPA1.png

  2. Enter the Name and Description of the Event Trigger to customize it and click Save to save the changes.

    EventTrigger-OPA2.png
Data Object Saved

An Event Trigger of Type Data Object Saved triggers the Action when Data Object is saved.

To add an Event Trigger of Type Data Object Saved.

  1. Select Data Object Saved from the Type dropdown list.

    Data_Object_saved_option.png

  2. Enter the Name and Description of the Event Trigger to customize it.

    Name_and_Description.png

  3. Select the required Object Definition from the dropdown list as shown below.

    Object_definition.png

    By Enabling the Add Attachment to notification Email, the format of the .csv file will be sent to an email.

    Add_attachment_to_email.png

  4. Click Save.

    Save_button.png

    The Event trigger has been successfully set up.

Data Object Deleted

An Event Trigger of Type Data Object Deleted triggers the Action when the Data Object is deleted.

To add an Event Trigger of Type Data Object Deleted.

  1. Select Data Object Deleted from the Type dropdown list.

    Data_Object_deleted.png

  2. Enter the Name and Description of the Event Trigger to customize it.

    Name_and_description_of_deleted.png

  3. Select the required Object Definition from the dropdown list as shown below.

    dropdown_list_of_data_deleted.png

    By Enabling the Add Attachment to notification Email, the format of the .csv file will be sent to an email.

    Add_attachment_for_data_deleted.png

  4. Click Save.

    Save_of_deleted.png

    The Event trigger has been successfully set up.

Task Progress

An Event Trigger of Type Task Progress triggers the Action when the selected Task advances to the configured percentage.

To add an Event Trigger of Type Task Progress:

  1. Select Task Progress from the Type dropdown list.

    TaskProgress_Type.png

  2. Enter a value for the Percentage of task progress required. You can also link the field to a Variable.

    TaskProgress_PercentageSet.png

    Note

    The default value is set to 100%.

  3. Select a Template associated with this Trigger.

    In the example below, this Event Trigger is triggered when the Task Aircraft Maintenance reaches 50% completion.

    TaskProgress_TemplateSelected.png

    You can customize the name and description of the Event Trigger as shown in the example.

Multiple Task Done

An Event Trigger of Type Multiple Task Done triggers the Action when a specified percentage of the selected Tasks are complete and marked as Done.

To add an Event Trigger of Type Multiple Task Done:

  1. Select Multiple Task Done from the Type dropdown list.

    MultipleTaskDone.png

  2. Enter a value for the Percentage of task progress required. You can also link the field to a variable.

    MultipleTaskDone_Percentage.png

    Note

    The default value is set to 100 %.

  3. Select the Templates associated with this Trigger.

    In the example below, this Event Trigger is triggered when 50% of the selected Tasks are complete and marked as Done.

    MultipleTaskDone_TemplatesSelected.png

    When a Task Queue is selected for the Multiple Task Done Event Trigger as shown below, the number of Tasks considered is the total number of existing Tasks in the selected Task Queue when the Operation Plan is instantiated.

    TaskQueueList.png
    July2024-MultiTaskDoneQueue.png

    You can customize the name and description of the Event Trigger as shown in the example.

Modifying the List of Tasks After Instantiation

After the Instantiation of an Operation Plan, you can modify the list of Tasks linked to a Multiple Task Done Event Trigger.

Note

Only the list of Tasks of Multiple Task Done Event Triggers can be modified after Instantiation.

To modify the list of Tasks:

  1. From the main menu, navigate to Planning > Operation Plans > Operation Plans Execution as shown.

    MultipleTaskDone_OPplan.png

    The page Operation Plan Execution opens as shown below.

    MultipleTaskDone_Execution.png

  2. Select an Instantiated Counter with a Multiple Task Done Event Trigger in an Operation Plan.

    MultipleTaskDone_SelectOPplan.png

  3. Select the tab Trigger Definition.

    MultipleTaskDone_Trigger_Definition.png

  4. Select the required Multiple Task Done Event Trigger.

    MultiTaskDone_Counter.png

    Note

    Only the list of Tasks of Multiple Task Done Event Triggers can be modified after Instantiation.

  5. Select additional, or deselect existing Templates to modify the list of Tasks.

    The example below shows the list of Tasks selected during the Operation Plan Definition and the modified list after the Instantiation of an Operation Plan.

    MultipleTaskDone_TemplatesSelected.png
    MultiTaskDone_SelectorDeselect.png

  6. Click Save.

    MultipleTaskDone_ClickSave.png

    The list of Tasks linked to the Multiple Task Done Event Trigger in a Counter is modified.

In this section: