Follow the instructions in the guides precisely in the order given and you should be up and running in a matter of minutes. You do not need to license the software to try the demos provided you are still within the 15-day free trial period.
Page 4
Crestron e-control Database Manager Detailed setup and configuration instructions and follow “Introduction”. Then comes information about the database file format. After that, the examples (demos) are described and illustrated in detail. Appendices include Theory of Operation, along with a complete Signal Reference.
Open a database record! Make a selection on the touchscreen to open a record. A sample address book containing Crestron offices around the world appears. When you select an office, its address information is displayed. You can browse the database, add and delete records, and modify information in a record.
The actual database access is not carried out by the control systems themselves, but a need for specialized hardware. by the freely distributed Crestron e-control Software Server. SW-DBM is a Any PC meeting the minimum licensable component of this “server” application (swserver.exe) which is...
Page 7
IP address of the other. This kind of connection also requires the use of the CNX Gateway which is separately licensed software that facilitates communication between the server and the control system. The CNX Gateway is typically installed on the server (when sufficient TCP/IP sockets are available) or it can be installed on any computer visible (i.e., pingable) on...
CNX Gateway (see below) requires one socket + one additional socket per server–control system connection Null modem cable, Crestron model CNSP-532 or equivalent Required for serial control system connections only. Warning: Do not use a generic null modem cable.
To install the Software Server, first download the installer package from the Downloads page can be found at: Crestron FTP site. To do this, first go to the Crestron website and select the Downloads page. New users must register. Proceed to the ECONTROL Library.
Server – Upgrade/Transfer License window, shown above. The license can be clipboard. (Copying with Ctrl+C obtained over the phone or via e-mail. Call Crestron Customer Support with the does not work from this field.) “Site Code” shown in the Site Code field. However, it is easier and far more reliable to copy the “Site Code”...
Basic Server Setup This product requires a proper physical connection between both “sides” of the system — the server and the control system. Furthermore, the software on both sides must be properly configured. As previously discussed, the connection can be either serial via RS-232 cable or Ethernet via Local Area Network (LAN).
Run server application by selecting Database Manager from the Crestron folder of your Start menu. Select config file. Specify a Configuration Settings file (.ini file) by selecting File | Configuration File….
Page 13
Serial communication requires wiring the server directly to the control system. Basic Server Setup : Serial communications requires neither the CNX Gateway software nor the use of an Ethernet network. Connect PC for programming purposes. For each control system to be...
Page 14
Leading Specifications (page 7). To upgrade any of these files, retrieve a copy of the latest upgrade package from the Crestron website (OPSYS Library). These files have an extension of .upz which contains all three system components in one compacted file.
Crestron e-control Database Manager Test Communications At this point, test your connections. RS-232 Control Systems Use the Viewport to verify communications between the server and the CNX control system. Select Diagnostics | Establish Communications. If properly connected, the PC responds with the COM port and baud rate.
Crestron e-control Database Manager Reply from 132.149.2.2: bytes=32 time=8ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60 Once a reliable connection is established, test that the CNX control system is listening and responding properly.
Crestron e-control Database Manager Password Access Access to the server’s Configuration Options window is password-protected. This is to prevent end-user meddling with the configuration options, which can very possibly disable the server’s proper operation. Select Server | Configure. The server prompts the user for a password. Enter crestron2 which displays all tabs.
Crestron e-control Database Manager Deleting the file means that all configuration variables revert to their default values the next time the server is run. The problem with this approach, of course, is that you lose any settings already made. To reset the password only (without affecting the rest of the configuration), edit the .ini file using the Notepad application (Start | Programs | Accessories |...
Page 19
Crestron e-control Database Manager The Configuration Options window, COM Settings tab, showing the only connection defined in the demo configuration (selected). COM Settings definitions (connections) can be active or inactive. A check in the box next to the definition name indicates that the connection is activated. If not activated, it is ignored when the server protocol is started.
Control system generation Here you specify the type of control system. The server uses this information to take into account minor differences in the way the older generation of Crestron control systems functioned in terms of timing and data capacity.
Page 21
With an SW-DBM license, a Standard Scroller can be enabled directly, and so can be used on its own whenever the full functionality of a Custom Scroller is not called for.
Page 22
Crestron e-control Database Manager To duplicate an existing definition, select it and click the Duplicate button. The new definition differs from the original in that it is given a unique name which is derived from the name of the original, incremented by one. (If the original did not end in a number, the name of the duplicate is the name of the original with a “1”...
Crestron e-control Database Manager The highest numbered signal in the signal block’s input or output signal lists is shown in the box in the upper-right corner. This is based on the signal offset entered in the adjacent box and the current signal block definition. This value is updated synchronously as the user interacts with the window.
Page 24
Scroller display is limited to 8 (rows) x 2 (columns), maximum. Does not require an SW-DBM license. If licensed for any other component that can make use of interactive database table displays (such as example), access is automatically conferred for creation and use of Standard Scroller signal blocks.
Page 25
Crestron e-control Database Manager Default Query This textbox contains the number of the query from the Queries table ID field that this signal block performs when it is enabled. List Rows and List Columns In Use Sets the number of rows and columns in use by the scroller. These values must be within the range of the number of rows and columns defined (see below, under “Custom Scroller Options”).
Page 26
Crestron e-control Database Manager The Custom Scroller Signal Block Definition window, showing the defintiion of the ADDRBOOK scroller from demo1. This window allows the user to customize a scroller signal block to fit his needs. For example, to set up a touchscreen scroller with 16 rows and 4 columns using list fields and displaying 24 data fields, as described in Query 17, just enter the numbers here.
Crestron e-control Database Manager Special Modes Check the Auto-Pick box to send a Pick Data Fields The Data Fields Defined textbox defines the number of Data Fields Filter textbox defines the initial value of the data filter bit pattern. See page 54 for a discussion of “Bit Patterns.’...
Page 28
Exit terminates the server application. If the server protocol is running, a warning message appears. Server | License… opens the e-control Software Server – Upgrade/Transfer License window for licensing and activating the various server components. Server | Configure… opens the Configuration Options window (described beginning on page 16).
Page 29
Crestron e-control Database Manager The Database Menu This menu contains a single command, Database | Queries Table, which opens the Queries Table window. This window provides display and edit access to this essential table in the database file named in Configuration Options window. See “Editing the Table”...
Page 30
Crestron e-control Database Manager Signal Simulator The top part of the window is for simulating receipt of incoming signals and transmission of outgoing signals. Signal Blocks & Connections This list contains all active signal blocks as well as all active connections that have signals defined (and hence can behave as signal blocks too).
Page 31
Crestron e-control Database Manager The File Menu The only currently implemented commands in this menu print the input and output signal lists for the currently selected signal block (File | Print Signal List | Selected), or for all active signal blocks (File | Print Signal List | All). This printout can be used to create matching Intersystem Communication symbols in SIMPL Windows.
Crestron e-control Database Manager The Database File Database Fundamentals For the reader unfamiliar with database concepts, this section will serve as a primer. Tables A relational database is composed of tables of information. Each table consists of rows and columns. Each row represents one database record; the columns in the row describe all of the attributes for that record.
Page 33
For example, consider the Addresses table shown above, which contains names, addresses, and phone numbers for Crestron offices. Assume that you want to display the names and address columns for all offices in the USA. In SQL, the query would be: This query retrieves the following answer set: The SELECT clause of the query lists the columns to be retrieved.
Page 34
Crestron e-control Database Manager The objective is to make all the album information available when querying for a track. Because each album can have a different number of tracks, you would not try to put all the track information in the album record. An alternative is to create separate records in the Albums table for each track.
You do not need to know SQL or Microsoft Access to construct a query for use by the scroller signal blocks in the Crestron Software Server. In the server application, you construct queries using a special database table named Queries.
Page 36
The condition determines which rows from the table are selected for display on the touchscreen. For example, if you want to select only addresses for Crestron offices in the USA, you can enter the following logical condition in the condition column:...
Page 37
Crestron e-control Database Manager A logical condition is an expression. An expression is a combination of column names, operators, and values. There are several types of operators that you can use to define the expression you need. Arithmetic operators form new numeric values by operating on numbers or columns that contain numbers.
Crestron e-control Database Manager Editing the Table It is not necessary to have Microsoft Access to edit the Queries table; it can be edited directly from within the server application. Open the server and select Database | Queries Table. The Queries Table window opens to display the contents of the Queries table of the database file named in the COM Settings tab of the Configuration Options window.
Page 39
Crestron e-control Database Manager In general, successive queries work like this: Recall that picking an item from a touchscreen scroller sends a Pick signal to the server which normally sends a series of Data signals in response, containing field values from the associated record in the database table.
Crestron e-control Database Manager The QueryDescription signal is sent upon arrival at each level, with the caption of the first list field in the scroller display optionally inserted into the description in place of a special flag character (a dollar sign).
Crestron e-control Database Manager If the scroller is an orphan (not owned), the scroller’s current pick action setting determines what action to take. The default action (value = 0) is to “open” the record and transmit its contents using the Data sent is as listed in the dataFields field of the Queries table.
Scroller Signal Block Definition window. The scroller in the demo has six rows, and lists Crestron offices around the world. When the user picks row n, a Pickn signal is sent to the server, which sends the corresponding datafields to the touchscreen.
Crestron e-control Database Manager The second page of demo 1 displays the names of six offices from the Addresses table. The arrow buttons are used to scroll forward or backward or go to the first or last six records in the list of offices in the Addresses table. Selecting an office populates the data fields of the scroller.
Crestron e-control Database Manager Demo 2 VT Pro-e Program The first page of demo 2 gives you the choice of starting the demo or returning to the main menu. The second page of demo 2 displays the names of eight genres from the Albums table.
Page 46
Crestron e-control Database Manager Demo 3 Block Diagram Demo 3 SIMPL Windows Program Two items need to be added to the control system in the Configuration Manager in SIMPL Windows. From the Control Systems folder in the Device Library select CNMSX-AV;...
Page 47
Crestron e-control Database Manager On page 3, the album cover is again displayed with the message Now playing …. Touch the album image to return to page 2. Demos SW-DBM Installation & Reference Guide — DOC. 5823...
58 for in-depth information on these signals. Server Protocol Run the Crestron Software Server application, swserver.exe, to license (Server | License…) and configure (Server | Configure…) server operation. Although the server application is now running, the server protocol must be manually started (Server | Start) t o establish the communications link.
Page 49
Crestron e-control Database Manager COM Settings definition which contains a similar set of error reporting signals.. These signals include ErrNumber, ErrString, and ErrTrigger. See the “Signal Reference,” beginning on page 58, for details. Appendices SW-DBM Installation & Reference Guide — DOC. 5823...
Appendix B: Intersystem Communications and Signal Space Considerations The Send e-Mail SIMPL Windows The following discussion applies in general to all Crestron Software Server symbol is available from the components. Keep in mind while reading this section that use of the Intersystem Crestron FTP site.
Page 51
Crestron e-control Database Manager Encoding and Decoding the Serial Data Stream Analog, serial, and digital signals to be sent from the control to the server are fed into the input (left) side of an Intersystem Communications symbol which encodes the signals into a serial data stream, available as an output labeled tx$ (for transmitter).
Page 52
Crestron e-control Database Manager to the control system. All the symbols’ rx$ and tx$ streams are tied to the same serial driver symbol. The set of signals intended for a particular Intersystem Communications symbol are distinguished from the other sets by their offset and/or their channel number.
Crestron e-control Database Manager Multiple channels Multiple channels apply to connections made through Virtual COM Ports only (i.e., TCP/IP connections only). Each Virtual COM Port can have up to 128 channels, where each channel can be thought of as a separate COM port. If a separate channel is used for each Intersystem Communications symbol, then all Intersystem Communications symbols can use an offset of zero (i.e., no offset).
(b) transport buttons, and (c) an optional analog gauge object serving as a scrollbar. Also (2) the signal block which services such a construct. Server The Crestron Software Server. That is, swserver.exe running on a Windows PC. Signal Block Active component within the Server, which listens for and responds to signals from connected control systems.
Crestron e-control Database Manager Base 16 used for notational purposes Straight base 2 notation (a long string of 0s and 1s) is considered to be too unwieldy to be useful to the human eye as it is too easily prone to misrepresentation and misinterpretation.
Page 56
Crestron e-control Database Manager When these signals are defined in the scroller signal block, the server uses them. When not defined, however, the server sends the signal via the “owning” signal block. If the signal is not defined there either, or the scroller has no owner, the signal is sent to the COM Settings signal block.
Page 57
Crestron e-control Database Manager Scroller Signals Grouped by Secondary Functionality The following lists aid the reader in understanding how scroller signals interact. Initiating a Query The following scroller signals all initiate a query: Opening a record The following scroller signals open a record for display and marks it for editing:...
Crestron e-control Database Manager Note that Pick, of course, immediately opens a new record. List Signals The following scroller signals affect scroller contents: Signal Reference The alphabetical reference proper begins on the next page. Appendices Signal Block Signal Name Custom Scroller...
Page 59
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Blank Causes the server to respond by clearing the scroller list. System to Server Digital Pulse Possible List signals (all with null strings); followed by pulse of Done signal The server sends a null string to each column in each row using List signals.
Page 60
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices BlankAll Causes the server to respond by clearing all scroller lists. System to Server Digital Pulse Possible List signals (all with null strings); followed by pulse of Done signal The server responds as if a Blank signal had been received from each scroller defined for the system from which the signal was received.
Page 61
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices ClearRec Causes the server to nullify every field in the opened record. System to Server Digital Pulse Possible Data signals (all with null strings); followed by pulse of Done signal This signal is only effective when a record is opened.
Page 62
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices CloseRec Causes the server to “deselect” the chosen record. System to Server Digital Pulse Done signal pulse The opened record is closed, meaning that all data fields are blanked, and signals that operate on opened records (including this one) is henceforth ineffectual.
Page 63
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Cols Sets number of columns displayed in the scroller. System to Server Analog 1 through the number of columns defined Possible List signals (all with null strings); pulse of the Done signal If the new number of columns is less than the old number, the extra columns are blanked.
Page 64
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Data Sends “picked” record to control system Server to System Serial Contents of fields of the opened record The order of fields is as listed in the datafields field of the Queries table.
Page 65
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices DataFilter System to Server Analog A bit pattern The bits in the pattern refer to the fields listed in the datafields field of the Queries table. There is a one-to-one correspondence between the bits in the pattern and the fields in the opened record.
Page 66
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices DeleteAllRecs Removes all qualifying records from the referenced tables. System-to-Server Digital Pulse Done signal Obviously a dangerous signal. “Qualifying records” means records that qualified for inclusion in the query that created the recordset.
Page 67
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices DeleteRec Deletes the currently opened record. System-to-Server Digital Pulse Done signal The current record is deleted from the recordset (and hence from the table or tables upon which the recordset is based).
Page 68
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Done Indicates requested operation complete Server to System Digital Pulse None Sent to System in response to most System-to-Server signals, indicating that the requested operation has been completed.
Page 69
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Enable This signal enables/disables the signal block. System to Server Digital Assert to enable the signal block De-assert to disable the signal block None The signal block must be enabled prior to use. If not, all signals which operate on...
Page 70
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Enabled “Handshake” response to the Enable signal. Server to System Digital Asserted in response to assert of Enable signal. De-asserted in response to de-assertion of Enable signal.
Page 71
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices ErrNumber When the server encounters an error processing a request from the System, it uses this signal to send an error number. Server to System Analog...
Page 72
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices ErrString Description of error Server to System Serial Error message for display None Although this signal can be safely ignored, it is easily hooked to indirect text fields on a touchscreen and/or on the CNMSX-PRO front panel, etc.
Page 73
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices ErrTrigger Trigger for ErrNumber and ErrString Server to System Digital Pulse None This signal is sent after the ErrNumber and ErrString to indicate that an error condition has occurred.
Page 74
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices First Displays the scroller’s first page. System to Server Digital Pulse List signals ScrollBar signal pulse of Done signal Automatically effected when scroller signal block is enabled.
Page 75
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices GoLevel Return to an earlier level of a successive query. System to Server Digital Pulse Scroller blanking (as per configuration options); GoLevelEcho signal pulse; Scroller refresh with new data;...
Page 76
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices GoLevelEcho Level navigation occurred. Server to System Digital Pulse None Successive query scrollers only. This signal is sent when navigating to a narrower query or back to wider query. The...
Page 77
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Last Displays the scroller’s last page. System to Server Digital Pulse List signals ScrollBar signal pulse of Done signal There may be empty rows at the bottom of the last page. Picking one of these produces the error: Pickn error: No such record.
Page 78
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices List - or - List Contents of scroller Server to System Serial Each List signal transmits the contents of one indirect text field representing a cell (each column within each row) in the scroller.
Page 79
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices NewRec Creates and “opens” a new record in the referenced table(s) System-to-server Digital Pulse Done signal, possible blank strings to various Data “Qualifying records” means records that qualified for inclusion in the query that created the recordset.
Page 80
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Next Displays next scroller page. System to Server Digital Pulse List signals ScrollBar signal pulse of Done signal No effect if currently on last page. First, Prev, Last signals...
Page 81
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Pick User has chosen a certain record currently visible in scroller System to Server Digital Pulse Data signals (default pick action) There is one Pick signal per row in the scroller. When the user touches a row in the scroller, the corresponding Pick signal is sent to the server.
Page 82
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices PingSvr, PingSys, PongSvr, PongSys Request for acknowledgement PingSvr: System to Server PongSvr: Server to System to Server PingSys: Server to System PongSys: System Digital Pulse PongSvror PongSys When the Server receives a PingSvr signal, it immediately responds with a PongSvr signal pulse.
Page 83
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Prev Displays previous scroller page. System to Server Digital Pulse List signals ScrollBar signal pulse of Done signal No effect if currently on first page. Prev, Next, Last signals...
Page 84
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices QueryDescription Text describing query Server to System Serial String from description field of query record. None. Sent when query is made, either when the signal block is enabled (by the Enable signal);...
Page 85
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Refresh Resends all scroller string proxies which causes server to respond. System to Server Digital Pulse List, Data, and QueryDescription serial signals Normally used to re-establish the contents of all scroller-related indirect text fields.
Page 86
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Requery Causes server to respond by going back to the database to rebuild the current scroller page, resends all scroller strings. System to Server Digital Pulse Possible Data signals (all with null values);...
Page 87
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Requery All Not implemented in the present release. Enable signal SW-DBM system signal Installation & Reference Guide — DOC. 5823...
Page 88
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices Rows Sets number of rows displayed in the scroller. System to Server Analog 1 through the number of rows defined Possible List signals (all with null strings); pulse of the Done signal If the new number of rows is less than the old number, the extra rows are blanked.
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices ScrollBar Maintains “scroll bar” (actually an analog gauge) displayed on touchscreen adjacent to scroller. System to Server Analog Bar mode: (65535 / pps) to 65535 (where pps is number of pages in the table) Line mode: 0 to 65535 None.
Page 90
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices UpdateRec Update record in database file with field edits. System to Server Digital Pulse Done signal Any changes made to any field(s) in the opened record (including, possibly, a new record) made with the WriteField signals are output when the UpdateRec signal is pulsed.
Page 91
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices UpLevel Return to the preceding level of a successive query. System to Server Digital Pulse Scroller blanking (as per configuration options); GoLevelEcho signal pulse; Scroller refresh with new data;...
Page 92
Crestron e-control Database Manager Description Direction Type Value Expected Reply Comments See Also Appendices WriteField String data to replace contents of data fields in opened record. System to Server Serial A string to use to modify the field in question None.
Need help?
Do you have a question about the SW-DBM and is the answer not in the manual?
Questions and answers