Family Field Descriptions
GE Connection Records
GE Connection records establish the connection to the GE Fleet message broker. To establish the connection to the message broker, certain fields on the GE Connection record must be completed.
This topic provides an alphabetical list and description of the fields that exist for the GE Connection family and appear on the GE Connection datasheet. The information in the table reflects the baseline state and behavior of these fields.
This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
Heartbeat |
Number |
The interval, in seconds, at which messages are sent to the GE Fleet message broker to ensure that the connection is kept open. |
The value in this field is 60 seconds by default. This value should not be changed unless advised by GE Digital APM. |
Login |
Character |
The user name that can be used to log in. |
The user for the default login account for the GE message broker server is agent2. You should use this account unless advised differently by GE. |
Port |
Number |
The port number of the GE Fleet message broker server. |
This value is set automatically when using the GE Connection workspace to configure the connection. If you are using Record Manager, the default value in this field is 5672, which is a non-SSL connection. For a SSL connection, you will need to change the value to 5671. |
Security Token | Character | The security token. |
The security token is populated by uploading a security token file into GE Digital APM. A default security token file is created during the GE Fleet installation. |
Server |
Character |
The name of the GE Fleet message broker server. |
The default value in this field is localhost. |
SSL Certificate |
Character |
The SSL Certificate name. |
The SSL certificate is not supplied by GE Digital APM. It should be obtained from a third-party certificate authority. |
SSL Passphrase |
Character |
The SSL passphrase. |
This is a default setting provided by a third-party certificate authority. |
SSL Server |
Character |
The SSL Server name. |
This is a default setting provided by a third-party certificate authority. |
Use SSL | Boolean | Indicated whether or not and SSL certificate will be used. |
If the check box is selected, the following SSL fields will be enabled, and should be configured:
|
GE Enterprise Records
GE Enterprise records represent the Enterprises imported from GE System 1 or GE SmartSignal. These records must be configured correctly in order to import GE Tag records.
This topic provides an alphabetical list and description of the fields that exist for the GE Connection family and appear on the GE Enterprise datasheet. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
Active |
Logical |
Indicates whether the system is active. |
Selecting this check box indicates that the Enterprise is active. |
Enable Integration |
Logical |
Indicates whether the system is enabled. |
Selecting this check box enables the automatic import of GE Tags belonging to the corresponding Enterprise in GE Digital APM database. |
Minimum Severity |
Number |
Minimum severity of Events to be imported. |
Only Events with the selected Severity or higher will be imported in GE Digital APM database. The default value in this field is Info (0). Note: Minimum Severity filtering does not apply to start up and shutdown Events, as these always have a Severity of Info (0).
|
The following fields in GE Enterprise records are read-only and are populated automatically by the GE Service:
- Customer ID
- ID
- Last Event
- Last Ping
- Name
- Number of Nodes
- Source System
GE Filter Records
GE Filter records are used to filter the type of events that are imported into the GE Digital APM. These records must be configured correctly in order to import GE Tag records.
This topic provides an alphabetical list and description of the fields that exist for the GE Filter family and appear on the GE Filter datasheet. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
Event Type |
Character |
A regular expression that defines the type of events that you want to import. |
Only the GE Tag Event records with a matching value in the Type field will be imported. You can use the regular expression .* to display all events. |
GE Tag Records
GE Tag records are created and updated automatically by the GE Service with the information from GE System 1 or GE SmartSignal.
This topic provides an alphabetical list and description of the fields that exist for the GE Tag family. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field |
Data Type |
Description |
Behavior and Usage |
Character Lower Level 1 Character Lower Level 2 Character Lower Level 3 Character Upper Level 1 Character Upper Level 2 Character Upper Level 3 | Character | Determines the health indicator status of readings associated with this GE Tag record. | N/A |
Numeric Lower Level 1 Numeric Lower Level 2 Numeric Lower Level 3 Numeric Upper Level 1 Numeric Upper Level 2 Numeric Upper Level 3 | Numeric |
Determines the health indicator status of readings associated with this GE Tag record. | N/A |
The following fields in GE Tag records are read-only and are populated automatically by the GE Service:
- Description
- Enterprise ID
- ID
- Name
- Node Type
- Node Subtype
- Subunits
- Units
GE Tag Event Records
GE Tag Event records are created automatically by the GE Service with the information from GE System 1. This topic provides an alphabetical list and description of the fields that exist for the GE Tag Event family. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Disposition Reason | Character | The reason that the event is being closed. | You must select a value in this field in order to transition the state of the event to closed. You can select one of the following values:
The values you can select are defined by the system code table EVENT_DISPOSITION_REASON. |
Severity | Numeric | The severity associated with the event. |
This field is read-only and populated automatically by the GE Service. When a GE Tag Event record is created for a GE System 1 event, this field is populated automatically with the severity level of the event. When a GE Tag Event record is created for a SmartSignal event, this field is populated automatically with the severity level that corresponds to the SmartSignal Priority as follows:
|
SmartSignal Priority | Character | The priority of a SmartSignal event. | This field is read-only and populated automatically by the GE Service. This field uses the system code table SMARTSIGNAL_PRIORITY to display the priority of the event from 1 (very high) to 5 (very low). |
The following fields in GE Tag Event records are read-only and are populated automatically by the GE Service:
- Acknowledged
- Acknowledged By
- Acknowledged Date/Time
- Comment
- Count
- DAQ ID
- Density
- Description
- End Time
- Enterprise ID
- Event State
- Fleet Category
- ID
- Recommended Actions
- Severity
- Source ID
- Start Time
- Tag ID
- Type
- Updated Date/Time