Cascade DataHub™

Version 5.4

January 05, 2006

A memory resident real-time database that acts as a hub, providing fast and efficient concentration and distribution of data for Windows applications.

Go to the Cogent Web Site.
Copyright, trademark, and software license information.

Table of Contents


1. Getting Started
1.1. Overview and Installation
1.1.1. Install
1.1.2. Run
1.1.3. Pop-up Help
1.1.4. Exit
1.1.5. Uninstall
1.2. Test with simulated data
1.3. Connecting to Excel
1.3.1. Receive data in Excel
1.3.2. Send data from Excel
1.4. Connecting over the Internet

2. Working With Data
2.1. Data Points
2.1.1. Creating New Points
2.1.2. Deleting Points
2.1.3. Viewing Data Points
2.1.4. Point Size Limits
2.2. Data Communication Concepts
2.2.1. Send and Receive Data
2.2.2. Client - Server
2.2.3. Synchronous and Asynchronous Communication
2.3. Data Exchange Protocols
2.3.1. DDE Protocol
2.3.2. OPC Protocol
2.3.3. TCP and Mirroring
2.3.4. The DataHub API
2.4. Data Organization
2.4.1. Domains
2.4.2. Assemblies, Subassemblies, Attributes, and Properties
2.4.3. Attributes and Types
2.4.4. Example

3. Making Connections
3.1. Mirroring Connections
3.1.1. Configure the master DataHub
3.1.2. Configure the slave DataHub
3.2. DDE Connections
3.2.1. DDE Poke and DDE Request
3.2.2. DDE Advise
3.3. OPC Connections
3.3.1. Connecting an OPC Server
3.3.2. Connecting an OPC Client

4. Scripting
4.1. Tools
4.2. DataHub ODBC (Open Database Connectivity) Scripting
4.3. DataHub Windows Scripting
4.4. DataHub MATLAB Support

5. Connecting Microsoft Excel
5.1. Getting Data into Excel
5.1.1. Method 1 - Drag and Drop using DDEAdvise
5.1.2. Method 2 - Excel Macros using DDERequest
5.2. Getting Data out of Excel
5.2.1. Method 1 - Cascade DataHub as a Client, with DDEAdvise
5.2.2. Method 2 - Excel Macros using DDEPoke
5.3. Example
5.4. Working with Ranges
5.4.1. Getting a Range out of Excel
5.4.2. Getting a Range into Excel
5.4.3. Sample Excel Macros for Arrays

6. Connecting Microsoft Word
6.1. Getting Data into Word

7. Connecting InTouch
7.1. Defining a DDE Access Name
7.2. Defining Variable Types

8. Properties Window
8.1. General
8.2. DDE
8.3. OPC
8.4. Mirroring
8.5. Licenses
8.5.1. Working with Licenses
8.5.2. License Information
8.6. Scripting

9. Other Windows and Programs
9.1. Data Browser
9.2. Event Log
9.3. Script Editor
9.4. Script Log
9.5. DataSim - a data simulation program
9.6. DataPid - a PID loop data simulation program

10. Troubleshooting

A. Command Line Options
B. Configuration Files
C. Installing the DataHub to Run as a Service
D. Excel Macro Library
D.1. Configure Excel to receive data from the Cascade DataHub (using DDEAdvise)
D.2. Write data from Excel - User initiated (using DDEPoke)
D.3. Write data from Excel - Automatically on value change (using DDEPoke)
D.4. Other Useful Macros
E. Windows Services File
F. DDE Overview
G. Error Messages
G.1. Windows Error Numbers
G.2. Windows TCP Error Numbers
G.3. Windows DDE Error Numbers

I. Cascade DataHub Command Set
acksuccess - tells the DataHub to return success messages.
add - adds a value to a point.
alias - creates an alias point for an existing point.
alive - tells the Cascade DataHub that the client is running.
append - appends a string to the value of a point.
assembly - creates an assembly.
asyncsocket - sets up asynchronous communication on a socket.
attribute - creates an attribute.
auto_create_domains - automatically adds domains requested by clients.
auto_timestamp - adds timestamps to unstamped changes.
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.
DDEInit - initializes the DataHub to act as a DDE server.
DDEService - assigns a DDE service name.
DDEUnadvise - removes an item or point from a DDE connection.
debug - sets the debug level.
defaultprop - sets a default type for a property.
delete - deletes a point—use with caution.
deleted - checks if a point has been deleted.
div - does division on the value of a point.
domain - identifies the client domain name.
dump - writes the entire content of the DataHub to a file.
enable_dde_client - enables or disables DDE client capabilities.
enable_dde_server - enables or disables DDE server capabilities.
enable_mirror_master - enables or disables mirror master capabilities.
enable_mirror_slave - enables or disables mirror slave 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
enable_tcp_server - enables or disables TCP server capabilities.
error - sends an error with an error string.
exit - shuts down the DataHub.
flush - flushes output to a terminal (Linux).
format - is an efficiency enhancement for Linux.
heartbeat - establishes a heartbeat message.
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_scripts - loads scripts.
lock - locks and unlocks points.
log_file - sets up a log file.
log_to_file - starts or stops logging to a file.
mirror_master - sets up a mirroring master.
mult - multiplies the value of a point.
OPCAttach - sets up an OPC connection.
OPCDetach - removes an OPC connection.
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.
secure - adjusts the security level of a point.
set - sets the value 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 tranmission of insignificant changes.
type - creates a type.
unreport - allows a client to stop receiving data value changes to a point.
version - returns the current version number.
write - writes information to a point.

II. Obsolete and Unused Commands
echo - is for internal use.
enable_connect_server - is deprecated.
EnableDDEServer - is for internal use only.
exception_buffer - is deprecated.
master_host - is deprecated in favor of mirror_master.
master_service - is deprecated in favor of mirror_master.
OPCAdditem - is not functional yet.
OPCInit - is deprecated.
point - is used internally.
qnx_name_attach - does nothing.
qnx_receiver - does nothing.
readid - should not be used.
register_datahub - replaced by report_domain.
report_all - replaced by report_domain.
report_datahubs - does nothing.
request - replaced by report_domain.
run - does nothing.
slave - is for internal use only.
taskdied - is for internal use.
taskstarted - is for internal use.
warn_of_license_expiry - is deprecated.
Index