DataMiner element control protocol
Parameters
In addition to the parameters defined by a protocol developer, a number of general internal parameters are defined for each element. These general parameters are all defined in the 65 000 range.
The configuration of these parameters for an element are displayed on the GENERAL PARAMETERS page of the element:
There are four groups of general parameters: communication, DCF, replication and verification.
General parameters can be loaded dynamically, and the following defaults apply:
- Communication: General parameters belonging to this group are not loaded for protocols of type http, websocket, opc, gpib, virtual, sla, and service.
- DCF: Only loaded if there is at least one parameter group defined in the protocol.
- Verification: General parameters belonging to this group are not loaded when MaintenanceSettings.xml has been configured to enable Command Execution Verification. (With the ProtocolSettings.ExecutionVerification tag.)
- Replication: By default, general parameters belonging to this group are always loaded (because it is always possible that an element will be replicated).
This default configuration can be overruled in a protocol via the ProtocolGroups tag.
In addition to the General Parameters page, it is also possible to show an additional Data Display page called General Parameters DEBUG. This page contains general parameters that are only used for debug purposes and that are not usually displayed. (For more information, refer to Debug settings.)
General Parameters (DataMiner Element Control Protocol):
| ID | Name | Description and/or possible values |
|---|---|---|
| 64501 | TIMEOUT | Communication state (0 = Responding, 1 = Not Responding) |
| 64502 | STATE | Element state |
| 64503 | New client registered | New client registered |
| 64504 | New Element connection | New element connection |
| 64505 | Client disconnected | Client disconnected |
| 64506 | Element disconnection | Element disconnection |
| 64507 | Parameter descriptions | Parameter descriptions |
| 64508 | Link file | Link file |
| 64509 | Edited | Edited |
| 64510 | Element created | Element created |
| 64511 | Deleted | Deleted |
| 64514 | Alarm Template Assigned | Alarm template assigned |
| 64516 | Database optimization | Database optimization |
| 64517 | Database stack | Database stack |
| 64518 | Mobile gateway | Mobile Gateway |
| 64519 | Service path changed | Service path changed |
| 64520 | Startup DataMiner Agent | Startup DataMiner Agent |
| 64521 | Protocol Added | Protocol added |
| 64522 | Protocol Deleted | Protocol deleted |
| 64523 | Protocol Replaced | Protocol replaced |
| 64524 | Alarm Template Added | Alarm template added |
| 64525 | Alarm Template Deleted | Alarm template deleted |
| 64526 | Alarm Template Edited | Alarm template edited |
| 64527 | Script Added | Script added |
| 64528 | Script Deleted | Script deleted |
| 64529 | Script Edited | Script edited |
| 64530 | Information Added | Information added |
| 64531 | Information Deleted | Information deleted |
| 64532 | Information Edited | Information edited |
| 64533 | SMS Received | SMS received |
| 64534 | SMS Sent | SMS sent |
| 64535 | GSM Signal Strength | GSM signal strength |
| 64536 | GSM General Information | GSM general information |
| 64537 | Trending Template Edited | Trending template edited |
| 64538 | Trending Template Added | Trending template added |
| 64539 | Trending Template Deleted | Trending template deleted |
| 64540 | VDX Deleted | VDX deleted |
| 64541 | VDX Added | VDX added |
| 64542 | VDX Edited | VDX edited |
| 64543 | Trending Template Assigned | Trend template assigned |
| 64544 | Element Connections Edited | Element connections edited |
| 64545 | Security Edited | Security edited |
| 64546 | Views Edited | Views edited |
| 64547 | Database settings edited | Database settings edited |
| 64548 | SNMP-Managers edited | SNMP managers edited |
| 64549 | Start Element Failed | Start element failed |
| 64550 | Load Element Failed | Load element failed |
| 64551 | Table Repair | Table repair |
| 64552 | Set Parameter | Set parameter |
| 64553 | Import elements | Import elements |
| 64554 | Information.xml assigned | Information.xml assigned |
| 64555 | Start synchronization | Start synchronization |
| 64556 | Synchronization finished | Synchronization finished |
| 64557 | DataMiner Agent found | DataMiner Agent found |
| 64558 | DataMiner Agent lost | DataMiner Agent lost |
| 64559 | Error during synchronization | Error during synchronization |
| 64560 | No connection with DMA | Connection lost with DMA |
| 64561 | Connection established with DMA | Connection re-established with DMA |
| 64562 | Automation info | Automation info |
| 64563 | Scheduler info | Scheduler info |
| 64564 | Script execution failure | Script execution failure |
| 64565 | Load Protocol Failed | Load protocol failed |
| 64566 | Startup error | Startup error |
| 64567 | Scheduled Task Created | Scheduled task created |
| 64568 | Scheduled Task Updated | Scheduled task updated |
| 64569 | Scheduled Task Deleted | Scheduled task deleted |
| 64570 | Notification | Notification |
| 64571 | Stop DataMiner | Stop DataMiner |
| 64572 | DataMiner run-time | DataMiner run-time |
| 64573 | Task started | Task started |
| 64574 | Client notification | Client notification |
| 64575 | Set as production protocol | Set as production protocol |
| 64576 | Element masked | Element masked |
| 64577 | Element unmasked | Element unmasked |
| 64578 | DMS Revisioned | DMS revisioned |
| 64579 | Backup status | Backup status |
| 64580 | SNMPAgent | SNMP agent |
| 64581 | File changed | File changed |
| 64582 | Filter added | Filter added |
| 64583 | Filter edited | Filter edited |
| 64584 | Filter deleted | Filter deleted |
| 64585 | User settings | User settings |
| 64586 | Document added | Document added |
| 64587 | Document edited | Document edited |
| 64588 | Document removed | Document removed |
| 64589 | Script started | Script started |
| 64590 | Linked to | Linked to |
| 64591 | State change | State change |
| 64592 | Service added | Service added |
| 64593 | Redundancy Group added | Redundancy group added |
| 64594 | Preset Created | Preset created |
| 64595 | Preset Edited | Preset edited |
| 64596 | Preset Renamed | Preset renamed |
| 64597 | Preset Deleted | Preset deleted |
| 64598 | Real-time TCP Socket | Real-time TCP socket |
| 64599 | Database | Database |
| 64600 | Correlation engine | Correlation engine |
| 64601 | Alarm colors edited | Alarm colors edited |
| 64602 | IP Settings | IP settings |
| 64603 | Spectrum Script Edited | Spectrum script edited |
| 64604 | Spectrum Script Deleted | Spectrum script deleted |
| 64605 | Spectrum Monitor Edited | Spectrum monitor edited |
| 64606 | Spectrum Monitor Deleted | Spectrum monitor deleted |
| 64607 | Entered Prioritized Mode | Entered prioritized mode |
| 64608 | Left Prioritized Mode | Left prioritized mode |
| 64609 | Spectrum Script Added | Spectrum script added |
| 64610 | Spectrum Monitor Created | Spectrum monitor created |
| 64611 | Mobile Gateway lost contact with DataMiner | Mobile Gateway lost contact with DataMiner |
| 64612 | Spectrum Monitor Failure | Spectrum monitor failure |
| 64613 | Collaboration Message | Collaboration message |
| 64614 | DataMiner Failover Status | DataMiner Failover status |
| 64615 | Service Templates | Service templates |
| 64616 | Client Eventing | Client eventing |
| 64617 | Latch reset info | Latch reset info |
| 64619 | Annotations Edited | Annotations edited |
| 64620 | Asset Manager Configuration | Asset Manager configuration |
| 64621 | Map Configuration | Map configuration |
| 64622 | SNMP Manager | SNMP manager |
| 64623 | Redundancy Group State | Redundancy group state |
| 64624 | VDX Assigned | VDX assigned |
| 64625 | Export Progress | Export progress |
| 64626 | Import Progress | Import progress |
| 64627 | Connectivity Engine | Connectivity engine |
| 64628 | Resource Manager info | Resource Manager info |
| 64629 | Tickets | Tickets |
| 64630 | Notes | Notes |
| 64631 | Profile Manager info | Profile Manager info |
| 64632 | Spectrum trace recording started | Spectrum trace recording started |
| 64633 | Spectrum trace recording stopped | Spectrum trace recording stopped |
| 64636 | DataMiner Connectivity Framework | DataMiner Connectivity Framework |
| 64637 | Authentication Failure | Authentication failure |
| 64638 | Sounds | Sounds |
| 64639 | Disk Watcher | Disk Watcher |
| 64640 | Licensing | Licensing |
| 64641 | Protocol Function Manager info | Protocol Function Manager info |
| 64642 | Topology engine | Topology engine |
| 64643 | Failed Southbound SNMP Communication | Failed southbound SNMP communication |
| 64644 | Service Manager info | Service Manager info |
| 64645 | Property Configuration | Property configuration |
| 64646 | DOM Manager info | DOM Manager info |
| 64647 | Clearable Alarm Storm Protection | Clearable alarm storm protection |
| 64648 | Redundancy switch | Redundancy switch |
| 64649 | Azure Active Directory | Azure Active Directory |
| 65000 | [Lock status] | 0/empty = unlocked, 1 = locked, 2 = unlocked with force |
| 65002 | [Lock owner] | Username of the user who is locking the element |
| 65003 | [Number of active Alarms] | |
| 65004 | [Number of active Critical Alarms] | |
| 65005 | [Number of active Major Alarms] | |
| 65006 | [Number of active Minor Alarms] | |
| 65007 | [Number of active Warning Alarms] | |
| 65008 | [Element Alarm state] | 0 = Not monitored, 1 = Normal, 2 = Warning, 3 = Minor, 4 = Major, 5 = Critical, 7 = Timeout, 9 = Masked, 10 = Error |
| 65009 | [Number of masked Alarms] | |
| 65010 | [Nbr of alarms] | Number of alarms table |
| 65011 | [PID] | Parameter ID column (Number of alarms table) |
| 65012 | [Number of alarms] | Number of alarms column (Number of alarms table) |
| 65013 | [Start time first alarm] | Start time first alarm column (Number of alarms table) |
| 65014 | [Start time last alarm] | Start time last alarm column (Number of alarms table) |
| 65017 | [Timer base] | Used for dynamic interval modification. |
| 65018 | [Timer base] | Write parameter |
| 65019 | [Properties] | Properties table parameter |
| 65020 | [Property name] | Property name column of the Properties table |
| 65021 | [Property type] | Property type column of the Properties table |
| 65022 | [Property Value] | Property value column of the Properties table |
| 65026 | [Element id] | |
| 65027 | [RCA Level] | |
| 65028 | [Reset time alarms] | Reset time alarms column (Number of alarms table) |
| 65029 | [Clients connected] | 0 = No, 1 = Yes |
| 65030 | [Priority level] | |
| 65031 | [Priority level] | Write parameter |
| 65032 | [Latch state] | |
| 65033 | [Reset element latch] | |
| 65034 | [Communication info] | Communication info table |
| 65035 | [Connection ID] | Connection ID column Communication info table |
| 65036 | [Device RTT] | Device RTT column Communication info table |
| 65037 | [Device Iterations] | Device Iterations column Communication info table |
| 65038 | [DataMiner TX] | DataMiner TX column Communication info table |
| 65039 | [DataMiner RX] | DataMiner RX column Communication info table |
| 65040 | [Session DataMiner TX] | Session DataMiner TX column Communication info table |
| 65041 | [Session DataMiner RX] | Session DataMiner RX column Communication info table |
| 65042 | [Device Message Drops] | Device Message Drops column Communication info table |
| 65043 | [Communication info state] | |
| 65044 | [Communication info state] | Write parameter |
| 65045 | [Connection State] | Connection State column Communication info table |
| 65046 | Execution Verification | |
| 65047 | [Connection Name] | Connection Name column Communication info table |
| 65048 | [Connection Type] | Connection Type column Communication info table |
| 65049 | [Interfaces] | Interfaces table (DCF) |
| 65050 | [Interface ID] | Interface ID column Interfaces table |
| 65051 | [Interface Name] | Interface Name column Interfaces table |
| 65052 | [Interface Type] | Interface Type column Interfaces table |
| 65053 | [Interface Alarm State] | Interface Alarm State column Interfaces table |
| 65054 | [Interface Properties] | Interface Properties table (DCF) |
| 65055 | [Interface Property name] | Interface Property name column Interface Properties table |
| 65056 | [Interface Property type] | Interface Property type column Interface Properties table |
| 65057 | [Interface Property value] | Interface Property value column Interface Properties table |
| 65058 | [Interface Property value] | Interface Property value column Interface Properties table |
| 65059 | [Interface Property link] | Interface Property link column Interface Properties table |
| 65060 | [Connections] | Connection table (DCF) |
| 65061 | [Connections ID] | Connections ID column Connections table |
| 65062 | [Source Interface] | Source Interface column Connections table |
| 65064 | [Destination Interface] | Destination Interface column Connections table |
| 65065 | [Source Interface] | Source Interface column Connections table |
| 65067 | [Destination Interface] | Destination Interface column Connections table |
| 65068 | [Connection Properties] | Connection Properties table (DCF) |
| 65069 | [Connection Property Name] | Connection Property Name column Connection Properties table |
| 65070 | [Connection Property Type] | Connection Property Type column Connection Properties table |
| 65071 | [Connection Property value] | Connection Property value column Connection Properties table |
| 65072 | [Connection Property value] | Connection Property value column Connection Properties table |
| 65073 | [Connection Property link] | Connection Property link column Connection Properties table |
| 65074 | [Add Connection] | Add Connection button (DCF) |
| 65075 | [Add Interface Property] | Add Interface Property button (DCF) |
| 65076 | [Add Connection Property] | Add Connection Property button (DCF) |
| 65077 | [Interface Property to delete] | |
| 65078 | [Connection to delete] | |
| 65079 | [Connection to delete] | Write parameter |
| 65080 | [Connection Property to delete] | |
| 65081 | [Connection Property to delete] | Write parameter |
| 65082 | [Interface Property ID] | Interface Property ID column Interface Properties table |
| 65083 | [Connection Property ID] | Connection Property ID column Connection Properties table |
| 65084 | [Interface Property to delete] | Write parameter |
| 65085 | [Interface Property name] | Interface Property name column Interface Properties table (write parameter) |
| 65086 | [Interface Property type] | Interface Property type column Interface Properties table |
| 65087 | [Connection Property Name] | Connection Property Name column Connection Properties table |
| 65088 | [Connection Property type] | Connection Property type column Connection Properties table |
| 65089 | [Destination DataMiner/Element] | Destination DataMiner/Element column Connections table |
| 65090 | [Destination DataMiner/Element] | Destination DataMiner/Element column Connections table |
| 65091 | [Interface Property link] | Interface Property link column Interface Properties table |
| 65092 | [Connection Property link] | |
| 65093 | [Custom Name] | Custom Name column Interfaces table |
| 65094 | [Custom Name] | Custom Name column Interfaces table |
| 65095 | [Interface Dynamic Link] | Interface Dynamic Link column Interfaces table |
| 65096 | [Connections Name] | Connections Name column Connections table |
| 65098 | [Interface Properties Input] | |
| 65099 | [Connections Input] | |
| 65100 | [Connections Properties Input] | |
| 65101 | [Connections Filter] | Connections Filter column Connections table |
| 65102 | [Connections Filter] | Connections Filter column Connections table (write parameter) |
| 65103 | DataMiner Connectivity Framework | DataMiner Connectivity Framework page button |
| 65104 | DataMiner Availability | DataMiner Availability page button |
| 65105 | [DataMiner Availability] | DataMiner Availability table |
| 65106 | [DataMiner Availability ID] | DataMiner Availability ID column DataMiner Availability table |
| 65107 | [DataMiner Availability From] | DataMiner Availability From column DataMiner Availability table |
| 65108 | [DataMiner Availability To] | DataMiner Availability To column DataMiner Availability table |
| 65109 | [DataMiner Availability Reason] | DataMiner Availability Reason column DataMiner Availability table |
| 65110 | [DataMiner Availability Reference] | DataMiner Availability Reference column DataMiner Availability table |
| 65111 | [DataMiner Availability From] | |
| 65112 | [DataMiner Availability To] | |
| 65113 | [DataMiner Availability Reason] | |
| 65114 | [DataMiner Availability Reference] | |
| 65117 | Replication Info | Replication Info page button |
| 65118 | [Replicated Element] | |
| 65119 | [Remote DMA IP] | |
| 65120 | [Remote Element Name] | |
| 65121 | [Connected Replication DMAs Count] | |
| 65122 | [Connected Replication DMAs] | Connected Replication DMAs table |
| 65123 | [ID] | ID column Connected Replication DMAs table |
| 65124 | [DMA IP] | DMA IP column Connected Replication DMAs table |
| 65125 | [Replication State] | Replication State column Connected Replication DMAs table |
| 65126 | [Last Change] | Last Change column Connected Replication DMAs table |
| 65127 | [Replicated Element Name] | Replicated Element Name column Connected Replication DMAs table |
| 65130 | [Internal Lock owner] | |
| 65131 | Resource Info | Resource info page button |
| 65132 | [Generic DVE Table] | |
| 65133 | [DVE IDX] | DVE index column Generic DVE table |
| 65134 | DVE Name | DVE Name column Generic DVE table |
| 65135 | DVE Element | DVE Element column Generic DVE table |
| 65136 | DVE State | DVE State column Generic DVE table |
| 65137 | [DVE function GUID] | DVE function GUID column Generic DVE table |
| 65138 | DVE Link to Resource Manager | DVE Link to Resource Manager column Generic DVE table |
| 65139 | [Generic Interfaces] | Generic interfaces table |
| 65140 | [Interface IDX] | Interface IDX column Generic interfaces table |
| 65141 | Interface Name | Interface Name column Generic interfaces table |
| 65142 | Interface Type | Interface Type column Generic interfaces table |
| 65143 | Interface FK | Interface FK Generic interfaces table |
| 65144 | Interface Link to Resource Manager | Interface Link to Resource Manager column Generic interfaces table |
| 65145 | Interface ID | Interface ID column Generic interfaces table |
| 65146 | [Generic DVE Linker Table] | |
| 65147 | [Linker Index] | Linker Index column Generic DVE Linker table |
| 65148 | [Linker Generic DVE FK] | Linker Generic DVE FK column Generic DVE Linker table |
| 65149 | [FK Data] | FK Data column Generic DVE Linker table |
| 65150 | [FK Table] | FK Table column Generic DVE Linker table |
| 65157 | [Interface delete/add] | |
| 65158 | [DVE index to delete] | |
| 65159 | [Interface Index to Delete] | |
| 66147 | DVE State | Write DVE State column Generic DVE table |
| 66148 | [DVE function GUID] | Write DVE function GUID column Generic DVE table |
| 66149 | DVE Link to Resource Manager | Write DVE Link to Resource Manager column Generic DVE table |
| 66150 | Interface Name | Interface Name (write parameter) |
| 66151 | Interface Type | Interface Type (write parameter) |
| 66152 | Interface FK | Interface FK (write parameter) |
| 66153 | Interface Link to Resource Manager | Interface Link to Resource Manager (write parameter) |
| 66154 | [DVE index to delete] | |
| 66155 | [DVE delete/add] | |
| 66156 | [Interface Index to Delete] | |
| 66157 | [Interface delete/add] | Add delete interface button |
| 66158 | [DVE index to delete] | DVE index to delete |
| 66159 | [Interface Index to Delete] | interface index to delete |
| 66160 | DVE Name | Write DVE Name column Generic DVE table |
| 66161 | [FK Table] | FK table (write parameter) |
| 66162 | [FK Data] | FK data (write parameter) |
| 66163 | [New Generic DVE Link] | |
| 66164 | [New Generic DVE Link] | |
| 66165 | [Generic DVE Link delete/add] | |
| 66167 | [Alarm System Type] | If no topology cell is defined for a monitored parameter, the value of the alarm property "System Type" will be set to the value found in this parameter. |
| 66168 | [Alarm System Type] | Write parameter. |
| 66169 | [Alarm System Name] | If no topology cell is defined for a monitored parameter, the value of the alarm property "System Name" will be set to the value found in this parameter. |
| 66170 | [Alarm System Name] | Write parameter. |
Note
Regarding the [Alarm System Type] and [Alarm System Name] parameters:
- If the System Name and System Type properties do not exist in the system, they will not be created. Only creating an element that has a topology cell definition will automatically create these properties.
- Setting these parameters will trigger a Property Changed update on the active alarms of the element. Even if the alarm in question is relying on the topology cell definition in the protocol rather than these newly added general parameters.
- DVEs will not follow the values of the main element. Alarms on values that are exported to a DVE will only use that DVE's general parameter values. This is both for alarm templates set on the DVE and the main element.
- Setting these general parameters will not overwrite the values defined by the topology cell definition.
- Creating alarms when using virtual functions causes the alarms to be linked to the main element rather than the virtual function (virtual element). This means that the [Alarm System Type] and [Alarm System Name] parameters of the main element will be applicable for all the alarms. These parameters on the virtual functions do not have any function at the moment. However, if in the future these alarms are linked to the virtual functions instead, these parameter values will be applied.