Defining Flex Python alert types - HxGN EAM - 12.0.1 - Feature Briefs - Hexagon

HxGN EAM Alert Management

Language
English
Product
HxGN EAM
Search by Category
Feature Briefs
HxGN EAM Version
12.0.1

The Flex Python Alerts tab allows the administrator to configure how flex python event records will be created from the alert user defined grid. The alert user defined grid should contain records that meet the intended criteria for which a python script should be executed. The fields provided on the Flex Python Alerts tab provide a means to map data into the fields in the flex python events table.

The Flex Python Alerts tab has the following fields:

  1. Delay Between – See Creating work order alerts section for details.

  2. Python Executable Document – Specify the EAM document code that defines the python executable script that should be run for each alert grid record (i.e. the administrator might do this if they intend to create a separate alert for each python script that they wish to execute). The lookup will display all ‘in-service’ documents where Python Script Type = Executable and the user has the document’s organization in their organization list. This field and Python Executable Document Grid Field cannot be populated together. However, one of them should be populated for python scripts to be executed. There is no controlling organization for this lookup.

  3. Python Executable Document Grid Field – Select the alert user defined grid field that contains the EAM document code that defines the python executable script that should be run for each alert grid record (i.e. the administrator might do this if they intend to create 1 flex python alert that can execute a different python script for each record in the alert grid). The lookup will contain all the alert grid fields. Of course, the administrator must create the user defined grid query to contain the appropriate python script document.

  4. Parameter 1 – Parameter 10 – Select the alert grid field that contains data you wish to pass into the flex python executable framework API that will be used during the execution of the python script. For example, if the purpose of the python script is to take equipment data and create a work order, you will want to select the equipment code and equipment org. from the alert user defined grid into Parameter 1 and Parameter 2, respectively, because these values are necessary to create the work order. Of course, you could also map the remaining equipment related data for creating a work order in this way (i.e. description, department, etc), or the python script itself can query this information from database.

  • This tab is only used to set up data if the alert type is Flex Python on the Record View.

  • Records in the flex python events table are processed into the flex python execution framework API by the Flex Python job within EAM.

  • Parameter 1 – Parameter 10:

    • The administrator can manually enter a value that is not in the lookup. This will essentially be a hardcoded value that will be used to create all python event records from the alert.

    • These fields are 4000 characters in the database and can pass this number of characters to the python event records.

    • See the HxGN EAM Python Studio and Flex Python Scripting feature brief for more details on configuring and using this functionality.