Database Schema
Oracle Utilities Network Management System Switching Adapter uses two databases tables to store data going in and out of the adapter.
This section includes the following topics:
SWMAN_INTERFACE_UPDATES
This is the main table that the adapter periodically polls for updates. This table is also used to submit updates to an external system. When polling, the query searches for all records where the interface_update_status value is equal to “NEW” and processes the values ordered by their unique ID values.
Field
Data Type
Comments
ID
Number
The unique ID for the record.
INSERT_USER
Varchar2(100)
The user/system that inserted or caused the record to be inserted.
INSERT_TIME
Date
The time the record was inserted or when the change occurred (in the UTC time zone).
UPDATE_USER
Varchar2(100)
The user/system that updated the record to be inserted.
UPDATE_TIME
Date
The time the record was updated (in the UTC time zone).
SEQ_SHEET_ID
Number
The unique ID of the sheet this entry pertains to. This is used to identify the sheet when an entry is sent to an external system when we do not yet have an external_id.
EXTERNAL_ID
Varchar2(4000)
The unique external ID associated with a single switching sheet in NMS. We use this to look up the sheet when a request comes in from an external system.
INTERFACE_UPDATE_STATUS
Varchar2(1024)
This is the status of this record. It is not the status of the sheet. This is used to define when the entry is new, in error, or complete. It is not limited to those specific status values. These status values are only used by the interface to determine how to process the record.
ERROR_MESSAGE
Varchar2(4000)
The error that occurred processing the last request. This may be populeted by the NMS interface or the interface that processed the update from NMS. The distinction will be identified by the interface_update_status value.
STATUS
Varchar2(1024)
The status of the sheet. This may be the status of the NMS sheet or the external sheet. It depends on the value specified in the interface_update_status field.
STATUS_DETAILS
Varchar2(4000)
Some details about the status. For instance, if it was rejected, then a rejection reason would be found in this field.
START_TIME
Date
The Start Time of the sheet this request pertains to (in the UTC time zone). This is normally only specified when creating a new sheet.
FINISH_TIME
Date
The Finish Time of the sheet this request pertains to (in the UTC time zone). This is normally only specified when creating a new sheet.
DEVICE_ALIAS
Varchar2(4000)
The Device of the sheet this request pertains to. This is normally only specified when creating a new sheet.
DESCRIPTION
Varchar2(4000)
The Description of the sheet this request pertains to. This is normally only specified when creating a new sheet.
LOCATION
Varchar2(4000)
The Location of the sheet this request pertains to. This is normally only specified when creating a new sheet.
SAFETY_DOC_ID
Varchar2(4000)
The Safety Document ID of a specific safety document that is linked to the sheet. This is only a textual reference to the safety document and does not include any details about the safety document.
SWMAN_INTERFACE_DOCUMENTS
This is a support table for the SWMAN_INTERFACE_UPDATES table. This table stores one or more file attachments related to a record in SWMAN_INTERFACE_UPDATES. These documents can be either passed to an external system or passed into NMS. When being passed into NMS, the documents are attached to the switching sheet and an External Document. If the external system updates the document with new content and the name of the file remains the same, then that file will replace the previous file that is attached to the switching sheet. This allows for constant updates to occur from an external system without a constant buildup of file attachments.
Field
Data Type
Comments
DOCUMENT_ID
Number
The unique ID for the record.
FILE_NAME
Varchar2(256)
The name of the file.
DESCRIPTION
Varchar2(4000)
A description for the file.
LENGTH
Number
When populated, the size of the file in bytes.
DATA
BLOB
The raw file data. Before the file is stored in this field, the file needs to be compressed using gzip.
FILE_MODIFIED_DATE
Timestamp
The date the file was last modified (in the UTC time zone).
UPDATE_ID
Number
The unique ID number of the SWMAN_INTERFACE_UPDATES record this entry pertains to.