Cogent DataHub Command Set
Prev Cogent DataHub™ software Next

Cogent DataHub Command Set

This is the internal command set for the DataHub program and related software. For general information on how to use these commands, please refer to Chapter 23, Using DataHub Commands.

Table of Contents
acksuccess — tells the DataHub instance to return success messages.
add — adds a value to a point.
alias — creates an alias point for an existing point.
alive — tells a DataHub instance that the client is running.
append — appends a string to the value of a point.
assembly — creates an assembly.
attribute — creates an attribute.
auth — requests authentication for a client.
authreload — is new, not yet documented.
auto_create_domains — automatically adds domains requested by clients.
auto_timestamp — adds timestamps to unstamped changes.
bridge — creates a bridge between two points.
bridge_remove — deletes a bridge.
bridge_remove_pattern — deletes all bridges that match a pattern.
bridge_transform — modifies an existing bridge.
cforce — creates a point and forces a value to be written to it.
cread — creates and reads a point.
create — creates a new point.
create_domain — creates a new domain.
creport — creates a point and requests notification of changes.
cset — creates a point and assigns it a value.
cwrite — creates a point and writes information to it.
DDEAdvise — sets up the item for a DDEAdvise connection.
DDEConnect — makes a connection to a DDE service and topic.
DDEDisconnect — disconnects and discards a DDE connection.
DDEExcelUnicode — accepts Unicode characters in strings in Excel.
DDEInit — initializes the a DataHub instance to act as a DDE server.
DDEService — assigns a DDE service name.
DDEUnadvise — removes an item from a DDE connection.
DDEUnadvisePattern — removes multiple items from a DDE connection.
DDEUnadvisePoint — removes an item from a DDE connection, by its point name.
debug — sets the debug level.
defaultprop — sets a default type for a property.
delete — deletes a point—use with caution.
div — does division on the value of a point.
domain — identifies the client domain name.
domain_bridge — configures a redundancy set.
domain_bridge_enable — enables or disables the Redundancy feature.
domain_bridge_prefer — specifies a preferred source for a Redundancy connection.
domain_bridge_refresh — refreshes a Redundancy connection.
domain_bridge_remove — removes a Redundancy connection.
domains — lists all domains in a DataHub instance.
dump — writes the entire content of a DataHub instance to a file.
enable_bridging — enables or disables bridging capabilities.
enable_dde_client — enables or disables DDE client capabilities.
enable_dde_server — enables or disables DDE server capabilities.
enable_domain_bridging — enables or disables domain bridging capabilities.
enable_opc_client — enables or disables OPC client capabilities.
enable_opc_server — enables or disables OPC server capabilities.
enable_scripting — enables or disables scripting capabilities
error — sends an error with an error string.
execute_plugin — executes a plugin. (experimental)
exit — shuts down a DataHub instance.
ExternalHistorianAddPoint — adds a data point for this historian connection.
ExternalHistorianApplyEdit — applies edits made to the temporary copy of the configuration.
ExternalHistorianBeginEdit — creates a temporary copy of the configuration for editing.
ExternalHistorianCancelEdit — deletes the temporary configuration and all edits made to it.
ExternalHistorianEnable — enables or disables external historian connections.
ExternalHistorianGet — gets the value of a historian configuration option.
ExternalHistorianRemovePoint — removes a data point from a historian connection.
ExternalHistorianSet — sets the value of a historian configuration option.
force — forces a write to a point.
format — is an efficiency enhancement for Linux.
get_client_stats — provides statistics for all clients.
heartbeat — establishes a heartbeat message.
HistorianAdd — adds a point to a Historian group.
HistorianFlags — is new, not yet documented.
HistorianRemove — removes points.
HistorianSaveConfig — saves the configuration of the Historian.
HistorianSetConfiguring — sets the Historian status to "Configuring".
HistoryGroupAdd — adds a new history group.
HistoryGroupAddPoint — adds a point to a Historian group.
HistoryGroupDeadband — sets a deadband for a Historian group.
HistoryGroupDefault — sets a default group.
HistoryGroupFileTimes — sets a frequency for changing history files.
HistoryGroupFlushTimes — specifies how frequently to flush history data to disk.
HistoryGroupRemove — removes a group and all of its histories.
HistoryGroupStorageTimes — specifies how long to keep data in a history.
ignore — ignores a given point.
ignore_old_data — ignores changes with an old timestamp.
include — includes a file in with configuration files.
instance — creates an instance of a data organization model.
load_config_files — loads configuration files.
load_plugin — loads a specified plugin. (experimental)
load_scripts — loads scripts.
lock — locks and unlocks points.
log_file — sets up a log file.
log_file_max — sets a size limit for log files.
log_to_file — starts or stops logging to a file.
mirror_master — sets up a mirroring master.
mirror_master_2 — sets up a secure mirroring master.
ModbusApplySettings — applies all scripted changes.
ModbusCancelSettings — cancels all scripted changes.
ModbusCreateSlave — creates a slave connection.
ModbusDeleteSlave — deletes a slave connection.
ModbusEnableMaster — enables and disables Modbus master functionality.
ModbusEnableSlave — enables and disables Modbus slave connections.
ModbusQuerySlave — checks for the existence of a slave connection.
ModbusReloadSettings — loads all Modbus configuration.
ModbusSlaveAddPoint — configures a Modbus point.
ModbusSlaveAddRange — configures a range of Modbus points.
ModbusSlaveDeletePoint — deletes point connections.
mult — multiplies the value of a point.
OPCActivate — activates or deactivates an OPC group.
OPCAddItem2 — adds OPC items to a connection.
OPCAEAttach — creates an OPC A&E connection.
OPCAEDetach — deletes an OPC A&E connection.
OPCAEEnable — enables an OPC A&E connection.
OPCAEEnableClient — enables OPC A&E client behavior.
OPCAEEnableServer — enables OPC A&E server behavior.
OPCAEFilter — selects alarms and events by filtering criteria.
OPCAEServerInit — configures the OPC A&E server.
OPCApply — applies changes to an outgoing connection.
OPCAttach2 — sets up an OPC connection.
OPCConnect — connects or disconnects from the OPC server.
OPCDetach — removes an outgoing OPC connection.
OPCEnable — enables or disables outgoing OPC connections.
OPCEnableClient — enables or disables all OPC clients.
OPCEnableServer — enables or disables DataHub OPC server behavior.
OPCMinimumSecurity — overrides DCOM security settings.
OPCModify — modifies an existing OPC connection.
OPCQueryConnection — provides information related to an OPC server connection.
OPCQueryConnections — lists OPC server connections.
OPCQueryPoint — provides data about an OPC point.
OPCQueryPointPattern — provides data about multiple OPC points.
OPCQueryPoints — provides a list of explicitly configured OPC tags in a connection.
OPCRefresh — sends a Refresh2 command to the OPC server.
OPCReload — reloads the data set from an OPC server.
OPCRemoveItem — removes an item based on its DataHub point name.
private_attribute — creates a private attribute.
property — creates a property for an assembly.
quality — assigns a quality to a point.
read — reads a complete point definition.
report — requests notification of changes to a data point.
report_domain — registers points and requests information on a whole domain.
report_errors — controls the reporting of errors.
request_initial_data — gets current data when client connection is made.
save_config — forces a DataHub instance to save its configuration.
secure — adjusts the security level of a point.
set — sets the value of a point.
set_access — is new, not yet documented.
set_authoritative — sets the type of a point.
set_canonical — sets the type of a point.
show_data — displays the Data Browser.
show_debug_messages — show or hide debugging messages in the Data Browser.
show_event_log — displays the Event Log.
show_icon — displays the system tray icon.
show_properties — displays the Properties window.
show_script_log — displays the Script Log.
subassembly — creates a subassembly.
success — sets up a success message.
tcp_service — sets a TCP service name or port number for incoming slave connections.
timeout — suspends data flow.
transmit_insignificant — permits transmission of insignificant changes.
TunnelDelete — deletes specified tunnel/mirror Slave connections.
TunnelEnable — enables specified tunnel/mirror Slave connections.
TunnelEnablePlain — enables plain-text tunnel/mirror Master connections.
TunnelEnableSlave — enables all tunnel/mirror Slave connections.
TunnelEnableSSL — enables SSL tunnel/mirror Master connections.
TunnelPlainPort — specifies the port for incoming plain-text tunnels.
TunnelSaveConfig — saves the tunnel configuration.
TunnelSlaveStatus — provides status information on tunnel/mirror Slave connections.
TunnelSSLCert — specifies the certificate for incoming SSL-enabled tunnels.
TunnelSSLPort — specifies the port for incoming SSL-enabled tunnels.
type — creates a type.
UAApplyEdit — applies edits to OPC UA configuration.
UABeginEdit — creates a temporary copy of the OPC UA configuration for editing.
UACancelEdit — cancels edits to the OPC UA configuration.
UAEnable — enables or disables an individual OPC UA client connection.
UAEnableClient — enables or disables OPC UA client functionality.
UAEnableServer — enables or disables OPC UA server functionality.
unload_plugin — unloads a plugin. (experimental)
unreport — allows a client to stop receiving data value changes to a point.
unreport_domain — allows a client to stop receiving data value changes in a whole domain.
version — returns the current version number.
write — writes information to a point.
Prev Up Next
23.3. Sending Commands by TCP Home  acksuccess