Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Operations Management Interface

Write a named script for the AlarmApp

  • Last UpdatedOct 10, 2024
  • 2 minute read

You write scripts for the from the Layout editor while the AlarmApp has been placed onto a layout pane. The Layout script editor supports the MyContent namespace, which is intended for all content items placed on a layout pane that can implement named scripts.

The Layout script editor includes the AutoComplete feature, which shows a positional drop-down list of namespaces, content types, and the methods or public properties associated with AlarmApp content. Although all public properties will appear in the autocomplete list, not all of them can be used in scripts. See

Write an AlarmApp named or predefined script

  1. Open the layout and show the items listed in the Toolbox tab.

  2. Select the AlarmApp from the Toolbox list to show its preview thumbnail.

    The Toolbox pathway to the AlarmApp is:

    _Default Content > 4. Apps > AVEVA OMI Apps > AlarmApp

  3. Drag and drop the preview thumbnail onto a layout pane.

  4. Select Script from the menu bar of the Layout editor to open the script editor.

  5. Create a Named script.

    1. Select the plus circle to show the Add NewScript dialog box.

    2. Select Named Script, assign a name to the script, and select Add to close the dialog.

      The new script appears beneath the Named Scripts area at the left of the editor and the window focus is set to the script edit area to begin writing script code

  6. Enter your script code.

    Embedded Image (65% Scaling) (LIVE)

    A script intended for an AlarmApp placed on a layout pane uses the MyContent namespace and its content name is the name assigned to it from the Name property of the Layout editor. Place a period immediately after the item you selected from the AutoComplete list. AutoComplete shows the next positional list of items based on your previous selections in the script statement.

    AutoComplete provides a list of properties and methods that can be included in the script based on the MyContent.AlarmControll prefix of the script statement.

    • For .NET methods and properties, refer to .NET documentation on the Microsoft web site.

    • For descriptions of legacy AlarmApp methods and properties, refer to the Alarm Client Control help. The document is a PDF file located on the computer hosting the System Platform IDE.

      C:\Program Files (x86)\ArchestrA\Framework\Docs\1033\AlarmClientControl.pdf

  7. Validate your script code by selecting the validation button at the right on the menu bar above the script edit area.

  8. After making any script corrections, save and exit from the Layout script editor.

TitleResults for “How to create a CRG?”Also Available in