Configure the Main tab of the Pump record
- Last UpdatedApr 24, 2025
- 5 minute read
The Main tab allows you to configure basic information about the pump. Assigning basic details to the Group, Dataset, and Base Message fields defines the information available for selection.

|
Item |
Description |
|---|---|
|
Name |
The name of the pump within the database. This value must conform to basic AVEVA Enterprise SCADA naming conventions and be unique for all pump records. For more information, refer to Volume 1 of the RealTime Administrator documentation. |
|
Description |
This field shows information about the record. This field is read-only and is not editable from the pump Row Edit dialog. It will display the value stored with the underlying multistate or status record and can be edited from the multistate or status Row Edit dialog. |
|
Safety Related |
Check this box to mark this pump as being safety related. Safety related points can be quickly searched for by a Controller. This field is read-only. It will display the value stored with the underlying multistate or status record and can be edited from the multistate or status Row Edit dialog. For additional information, refer to the AVEVA Pipeline Operations for Liquids Controller documentation. |
|
Commissioning Required |
Select the Commissioning Required checkbox when the point is ready to be commissioned. When this checkbox is selected, the point will appear in the Point Verification Summary. This checkbox will be cleared after the point has been commissioned. |
|
Group |
Click (...) to select the group assignment to which the pump record belongs. The group Select dialog appears. For more information about groups, refer to the Tools Administrator documentation. |
|
Station |
This field contains the station record which defines the location of the pump. This field is read-only and will contain the Station value of the multistate or status path configured in the Path field and can be modified from the multistate or status Row Edit dialog. |
|
Point Class |
This is the point class categorization for the pump record. This field is read-only and will contain the point class value of the multistate or status path configured in the Path field and can be modified from the multistate or status Row Edit dialog. The Point Class field is used to allow the Administrator to configure alarm severity. For more information about the Point Class field, refer to Volume 1 of the RealTime Administrator documentation. |
|
Point SubClass |
This is the point subclass categorization for the pump record. This field is read-only and will contain the point subclass value of the multistate or status path configured in the Path field and can be modified from the multistate or status Row Edit dialog. For more information about the Point SubClass field, refer to Volume 1 of the RealTime Administrator documentation. |
|
Dataset |
Click (...) to define the dataset associated with the pump. Once a record is assigned to a data
set value, the data set can only be changed to a value for which the system has a
privilege record. A record's data set cannot be changed in such a way that the system
can no longer access the record. |
|
Base Message |
Click (...) and select the message associated with the record from the Message Select dialog. |
|
Short Description of the pump |
This field is not editable from the pump Row Edit dialog. It will display the value stored with the underlying multistate or status record and can be edited from the multistate or status Row Edit dialog. This field has a 32 character limit. Note: The Short Description of the pump field cannot be modified through a Microsoft Excel import because the field pulls its value from the underlying multistate or status point. If you attempt to modify the field, a warning will indicate that the field cannot be updated. For more information on importing a Microsoft Excel file, refer to the Advanced Database Editor (ADE) Administrator documentation. |
|
Well Unit |
This field contains the well unit description for the pump record. This field is read-only and will contain the well unit value of the multistate or status path configured in the Path field and can be modified from the multistate or status Row Edit dialog. For more information, refer to Volume 1 of the RealTime Administrator documentation. |
|
Priority Display |
Specify the ezXOS display you want to be associated with the Priority Display icon on the Pump Control dialog. This field is read-only and will contain the priority display value of the multistate or status path configured in the Path field and can be modified from the status or multistate Row Edit dialog. |
|
Display Order |
This field contains the display order for the pump record. This field is read-only and will contain the display order value of the multistate or status path configured in the Path field and can be modified by the multistate or status Row Edit dialog. For more information, refer to Volume 1 of the RealTime Administrator documentation. |
|
Path |
This is the path to the status or multistate point that contains the telemetered state for the pump in the field. Click (...) to display the Path Selector dialog. Until a table and record are selected, you will not be able to click Accept. For more information about how to select a pathway, refer to Volume 1 of the RealTime Administrator documentation. |
|
State Configuration |
Select State Configuration to display the State Configuration dialog. For more information, see Select the Pump record State Configuration. |
|
Command Run |
The command string that will be issued to the point in the Path field when a run command is executed on this pump. For more information, see Select the Pump record command state. |
|
Command Stop |
The command string that will be sent to the point in the Path field when a stop command is executed on this pump. For more information, see Select the Pump record command state. |
|
Logic Excluded Mode Time Out |
This field specifies the desired number of minutes at which you would like the pump to return to In Service when configured to an Out of Logic mode by the Controller. |
Note: The description on pumps is read-only. If a Path is specified, the description of the underlying status or multistate field will be automatically used as a description on the pump.