Creating a Custom Action

NOTE: A corresponding Custom Mobile Action must be created for use within AVEVA Mobile Operator.

Creating a Database Entry

To create a Custom Action, refer to the list of variables given below and edit the relevant database script as desired. Then, execute it on the AVEVA Mobile Operator database to insert a record in the SAT_CUSTOM_ACTIONS table:

INSERT INTO SAT_CUSTOM_ACTIONS (CustomActionName,PropertyBagDefinition)

VALUES('Test Custom Action','<PropertyBag><Item Label="UserName" ControlType="TextBox" MaxLength="25" PropertyBagAttributeName="CustomTagHostName"/></PropertyBag>')

 

A new icon is displayed in the toolbox under the Actions menu as shown below:

[CustomActionID]: The primary key. The table creates a CustomActionID for a custom action, by default.

[CustomActionName]: The name of the custom action. This appears in the Actions section of the tool tray.

[PropertyBagDefinition]: The .xml file that determines the display items and input controls of the Detail Panel.

Property Bag Settings

The property bag definition determines what the detail panel will display and what controls to use for input. The available attributes for the item element that is used to define each input item are as follows:

Label - Label to be displayed next to the input field. This is a mandatory field.

PropertyBagAttributeName - The name of the attribute used to store the input value in the property bag of the Custom Action. This is a mandatory field.

ControlType - The type of control used to request for information. This is a mandatory field.

• TextBox - A standard text box control.
• Max Length - The maximum length of input data.
• ComboBox - A drop-down list that allows you to select from a displayed list of items.
• Each data item element under ComboBox includes a “Value” attribute in the drop-down list.
• Data item elements must be included in the drop down list.
• Password - The text box that encrypts the data entered.
• MaxLength - The maximum length of input data.
• Numeric
• MinValue - The minimum value accepted.
• MaxValue - The maximum value accepted.
• Mask - The input mask.

The Property bag definition is as follows:

<PropertyBag>

<ItemLabel="UserName" ControlType="TextBox" MaxLength="25" PropertyBagAttributeName="CustomTagHostName"/>

<ItemLabel="TrueFalse" ControlType="ComboBox" PropertyBagAttributeName="truefalse">

<DataItemValue="True"/>

<DataItemValue="False"/>

</Item>

<ItemLabel="YesNo" ControlType="ComboBox" PropertyBagAttributeName="yesno">

<DataItemValue="Yes"/>

<DataItemValue="No"/>

</Item>

<ItemLabel="Password" ControlType="Password" MaxLength="25" PropertyBagAttributeName="Password"/>

<ItemLabel="General" ControlType="TextBox"  PropertyBagAttributeName="CustomTagGeneral" MaxLength="200"/>

<ItemLabel="Amount" ControlType="Numeric"  PropertyBagAttributeName="CustomTagNumeric" MinValue="5" MaxValue="20" Mask="nnnn.nn"/>

</PropertyBag>

An illustration of the Detail Panel created using the above property bag definition is given below: