Configure the Reflex (reflex) record for external applications

A Reflex (reflex) record is configured using the reflex Row Edit dialog.

Note: If the reflex record has been configured as an External Command, all the fields on the Alarming tab of the reflex Row Edit dialog will be disabled.

To configure the reflex record for external applications

1. Expand the reflex Table Edit from the Advanced Database Editor (ADE), and double-click the desired record to open.

   The reflex Row Edit dialog appears.

   

   The record name will be displayed in the Name field.

   (Optional) A description for the record will be displayed in the Description field.

2. To designate the reflex record as safety related, select the Safety Related check.

3. (Optional) In the Group field, click (...) and select the name of the Group record from the Group Select dialog.

4. (Optional) In the Dataset field, click (...) and select the name of the Dataset record from the Dataset Select dialog.

5. In the Base Message field, click (...) and select the message associated with the record from the Message Select dialog.

6. (Optional) Select the Inhibit checkbox to indicate the Reflex Monitor is disabled (non-functional) for the record.

   Note: If the Inhibit checkbox has been selected, the configured command will not execute, even if the value of the Trigger path changes.

7. In the Reflex Type dropdown, select Executable Command.

   Note: When a Reflex Type is selected, fields that are relevant to the specified Reflex Type will become enabled and available for editing. Other fields will be disabled and ignored by the Reflex Monitor even if they contain values.

8. In the Trigger field, select (...).

   The Input Trigger Path Selector dialog appears.

   Note: This field specifies the AVEVA Pipeline Operations for Liquids RealTime point used to trigger execution of the command. It uses a path format and can refer to any table, record, or field in the RealTime database (RTDB).

   If the selected Trigger Path is deleted after the reflex record has been saved, a configuration error is introduced and the reflex Data Quality will transition from Fresh to Error.

   

   1. Make a selection from the Table dropdown.

   2. Make a selection from the Record dropdown.

   3. Make a selection from the Field dropdown.

   4. Click Accept.

9. In the External Command field, enter the path to the external command to execute when the value of the Trigger path changes.

   Note: This can be any Windows executable, script, or batch file that resides on the server where the application is running. The specified External Command should refer to an application that will run, take some sort of action, and exit. The application will have no interaction with the desktop and will not be visible to any users on the server.

10. (Optional) In the Command Arguments field, specify the command line arguments to use when invoking the configured External Command.

    Note: This field may be left blank if the External Command does not require any arguments.

11. (Optional) In the Command Timeout field, specify the maximum time (in seconds) that an External Command has to execute before the process will be terminated by the Reflex Monitor application.

    Notes: In the Command Timeout field, a non-zero value is recommended. A zero value indicates that the Reflex Monitor application should wait indefinitely for the application to exit. This can be dangerous if the command has the potential to hang or fail to exit. In this event, the Reflex Monitor application slowly consumes system resources, which may result in a system failure.

    The Command Timeout field should not contain any negative values.

12. (Optional) In the Maximum Command Frequency field, specify the time (in seconds) that must elapse between subsequent executions of the External Command.

    Notes: If the Trigger value is set, but the configured time has not elapsed, the External Command will not be run. A value of 0 (zero) indicates that the Reflex Monitor application should launch the external application on any change to the Trigger value.

    If a field in the RTDB is chosen that changes frequently (for example, the current value of an analog record), the external application will be triggered on every change to the value. Depending on the actions performed by the external application, the results could be undesirable.

13. From the Target System dropdown, select which system environment should execute the external application. Select from the following options:

    • All Systems — Any Hot RealTime server that observes the change in the Trigger value will execute the external application. You should select this option for installations that do not have multiple systems.

    • Owning System — Only the Hot RealTime system which is the owner of the Trigger point will execute the External Command.

    • Delegate System — Only Hot RealTime systems configured as a delegate for the owning system will execute the External Command.