CRESTRON e-control™ Database Manager (SW-DBM) version 1.4 © 1999 Crestron Electronics, Inc.
Crestron e-control Database Manager SW-DBM Contents How to Use This Manual 3 A Note on Printing This Document ................................................................................................... 3 Quick Start ........................................................................................................................................ 3 Section Summary ..............................................................................................................................
Crestron e-control Database Manager SW-DBM Crestron e-control Database Manager How to Use This Manual A Note on Printing This Document Adobe and Acrobat are trademarks of Adobe Systems Incorporated. This Portable Document File (PDF) can be printed with Adobe Acrobat Reader. Printing from a Windows 95 platform, version 4.0 or later, is strongly recommended because the figures print poorly with earlier versions. The latest version is freely available from Adobe at http://www.adobe.com/acrobat/.
Crestron e-control Database Manager SW-DBM 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. 4 • How to Use This Manual Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Quick Start Guide: Address Book (demo1) 1 Install this package on your PC Presumably, since you are reading this PDF file, you have already done this. 2 Connect a CNMSX-PRO (with touchscreen) Connect a programming cable (a standard modem cable) from any COM port on your PC to the COMPUTER port on the front or back of the CNMSX-PRO control system. Connect a touchscreen to the control system set up for CRESNET ID 03.
Crestron e-control Database Manager SW-DBM Introduction What is Crestron e-control™ Database Manager? Crestron e-control Database Manager (SW-DBM) empowers any Crestron control system with database capability. Simply by asserting specific signals, your control systems can send arbitrary text, whole text files, canned messages, alerts, status updates, etc., to any e-mail address. Messages can be sent to a control system for display and to assert specific signals.
Crestron e-control Database Manager SW-DBM In the illustration that follows, the communication pathways are represented by the arrows. The physical network is not represented, however.
Crestron e-control Database Manager SW-DBM Leading Specifications Specifications Table SPECIFICATIONS DETAILS SWSERVER.EXE (included with this package) Version 1.4 CNMS/RACK Operating System Version 3.18.12 or later CNMSX/RACKX Operating System Version 5.09.25 or later CNMSX/RACKX Monitor Version 5.09.25 or later CNMSX/RACKX TCP/IP Stack Version 5.09.10 or later CNX Gateway Version 2.08.04 or later SIMPL™ Windows® Version 1.4 or later; or Version 1.
Crestron e-control Database Manager SW-DBM Auxiliary software CNX Gateway Required for TCP/IP (EtherNet) connections between the server and the control systems. Not required for serial connections. SMTP Express Recommended to reduce server overhead and improve server responsiveness while e-mail is being sent. Installation As of this writing, the Crestron Downloads page can be found at: http://ftp.crestron.
Crestron e-control Database Manager SW-DBM Obtaining a License e-control Software Server – Upgrade/Transfer License window showing “unlimited” database license — shown activated (checked) You must use the Copy button to copy the SITE CODE to the clipboard. (Copying with Ctrl+C does not work from this field.) Open the server application. Select Server | License to open the e-control Software Server – Upgrade/Transfer License window, shown above. The license can be obtained over the phone or via e-mail.
Crestron e-control Database Manager SW-DBM Upgrade/Transfer License window (shown above). Make sure this window is active on both computers. Step 1. On the destination computer, create a preparation file on a diskette in the A: drive by inserting a blank, formatted diskette and selecting Prepare Diskette. This creates a file on the diskette which indicates who is receiving the license. A second, backup copy of the file is also created.
Crestron e-control Database Manager SW-DBM The installer registers demoDBM.ini as the currently selected Configuration Settings file. (If the server’s title bar does not read “e-control Database Manager Demos,” use the File | Configuration file… command to reset it.) This file configures the server for all three demos. Each demo folder contains the following files: Demo?COM.smw Demo?TCP.smw demo?COM.bin demo?TCP.bin RS-232 is featured in the Quick Setup Guide because it is easy to set up.
Crestron e-control Database Manager SW-DBM Control System Side, RS-232 Serial communication requires wiring the server directly to the control system. NOTE: Serial communications requires neither the CNX Gateway software nor the use of an Ethernet network. 1. Connect PC for programming purposes.
Crestron e-control Database Manager SW-DBM Control System Side, TCP/IP For more information on control system TCP/IP setup, consult the e-control Overview document, overview.pdf, installed with the CNX Gateway software; or the SIMPL Windows release notes, installed with SIMPL Windows. TCP/IP communications requires a control system with a LAN/Internet port. Therefore, a CNX generation control system is required (CNMSX-AV, CNMSX-PRO, CNRACKX, or CNRACKX-DP).
Crestron e-control Database Manager SW-DBM from Control System button to display the current listing. Verify that the IP address for the PC running the CNX Gateway (often but not necessarily the server itself) appears with an IP ID of 03. If it does not appear, use the Add… button to add an entry for IP ID 03. Then click the Send IP Table to Control System button. 8. Switch to TCP/IP.
Crestron e-control Database Manager Reply Reply Reply Reply from from from from 132.149.2.2: 132.149.2.2: 132.149.2.2: 132.149.2.2: SW-DBM bytes=32 bytes=32 bytes=32 bytes=32 time=8ms time=5ms time=5ms time=5ms TTL=60 TTL=60 TTL=60 TTL=60 Once a reliable connection is established, test that the CNX control system is listening and responding properly. Reconfigure Viewport communications to use TCP/IP by selecting Setup | Communications Settings.
Crestron e-control Database Manager SW-DBM 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. Entering anything else displays the General tab only.
Crestron e-control Database Manager SW-DBM 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 | Notepad).
Crestron e-control Database Manager SW-DBM 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.
Crestron e-control Database Manager SW-DBM … and if TCP/IP communications were selected, it would look like this (fictitious IP address shown): Definition name Each COM Settings definition requires a unique name. A field for this data can be found at the top left of the COM Settings window. We recommend choosing a name that reflects either the location of the control system (such as SUITE3) or its function (such as PHONEBOOK).
Crestron e-control Database Manager A “signal block” is a software construct defined in the server which communicates with Intersystem Communications (XSIG) symbols in the SIMPL program running in your control system. SW-DBM The Signal Blocks tab (see below) displays a list of defined signal blocks. Two types of signal blocks are available with an SW-DBM license: Custom Scroller Standard Scroller for interactive display and maintenance of an arbitrary database table.
Crestron e-control Database Manager SW-DBM 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” suffixed to it.
Crestron e-control Database Manager SW-DBM server-signal block interface; i.e., information that all signal blocks must have to be handled by the server as signal blocks.) • Optional signal definitions. Words shown in the Signal Block Definition window in bold case are names of optional signals implemented by the signal block.
Crestron e-control Database Manager SW-DBM Standard Scroller Signal Block Definition NOTE: The reader is urged to refer to the Signal Reference for more information about the signals discussed in these sections. A “standard” scroller is a very simplified form of the full-featured “custom” scroller (described in the following section). The Standard Scroller features the following: • A static signal block definition.
Crestron e-control Database Manager SW-DBM 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”). Sort Each scroller table must have an ID field.
Crestron e-control Database Manager SW-DBM 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 SW-DBM Special Modes Check the Auto-Pick box to send a Pick1 signal automatically on each scroll action. Data Fields The Data Fields Defined textbox defines the number of Datad signals. The Data Fields Filter textbox defines the initial value of the data filter bit pattern. See page 54 for a discussion of “Bit Patterns.’ The control system can change the data filter bit pattern at run-time using the DataFilter signal.
Crestron e-control Database Manager SW-DBM The Message Log Frame When the server protocol is running, the Message Log frame shows status and error messages; for example, it lists each time the protocol is started and halted. The System Connection Status Frame This frame contains a colorful legend above a series of small numbered rectangles, representing each of the defined systems. The color of a control system’s rectangle indicates its connection status, according to the legend.
Crestron e-control Database Manager • SW-DBM Server | Log | Timestamps. Selecting this option puts a checkmark next to it and henceforth all log items will contain a timestamp of the form hh:mm:ss (24-hour clock) at the beginning of each line. Selecting the command again removes the checkmark and timestamps will no longer be included in the log. NOTES: 1. This option affects the server log and the signal log in the Signal Analyzer window as well. 2.
Crestron e-control Database Manager SW-DBM 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). To simulate an incoming or outgoing signal, you must first select an item from this list.
Crestron e-control Database Manager SW-DBM 2. The present release does not dump the log to a disk file. 3. Signals are only logged when the Signal Analyzer window is opened. However, in general, do not keep the window opened unnecessarily as the logging routines can cause a noticeable degradation of server responsiveness when the server is running on a slower PC.
Crestron e-control Database Manager SW-DBM Debug Info is checked, the buttons each contain additional information of the form m=n where m is the absolute signal number (included only when different from n). Selecting the command again removes the checkmark and the additional information is excluded. This option is also “sticky” like the Timestamps command. • Log | Find… brings up the following modal window which helps locate a specific signal. Signal log search window.
Crestron e-control Database Manager SW-DBM The control system accesses a database table using a scroller signal block. More than one touchscreen can browse a table at the same time; one user’s view does not affect any other user’s view of the table rows displayed in the scroller. However, if the application allows editing of the database from the touchscreen (as shown in demo1), one user can conceivably change a row while another user is viewing the old version of the row.
Crestron e-control Database Manager SW-DBM • The Albums table contains a row for each album available to the application. The columns of the Albums table include the artist, and the genre, the name of the album, and a unique Album ID. • The Tracks table contains a row for each track of each album from the Albums table. The columns of the Tracks table include the track number, track name, and playing time of the track, and the Album ID of the album in the Albums table where the track is found.
Crestron e-control Database Manager SW-DBM T.Minutes AS ["], T.Seconds AS ['] FROM Albums A INNER JOIN Tracks T ON A.CDJID = T.CDJID Note the following syntax features of SQL, all illustrated in the above example: • Dot syntax. When the same field name is used in more than one table, you must use the syntax table.field to eliminate ambiguity. In the above example, this syntax was used throughout, although in fact the fields Artist and Track did not actually appear in both tables. • Table name aliases.
Crestron e-control Database Manager SW-DBM Fields The following sections describe each column (field) in the Queries table. The Queries table, viewed from the server using its Database | Queries Table command. The Queries table tell scroller signal blocks how to access the other tables. ID The ID column is a unique index number assigned to the query. A matching number is supplied by the scroller signal block to locate a particular record in the table.
Crestron e-control Database Manager SW-DBM 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. Examples are addition (+), subtraction (-), multiplication (*), and division (/). They operate on numbers and on columns that contain numbers.
Crestron e-control Database Manager SW-DBM 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.
Crestron e-control Database Manager SW-DBM 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. (See “Picking a Record” on page 40 for more information on scroller picks.) However, in a successive query with v levels, the first v-1 levels, called successive levels, behave differently.
Crestron e-control Database Manager SW-DBM 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). If the description string is "($ Selection Screen)" then on level 1, the server sends the string "(Genre Selection Screen)" in the QueryDescription signal. On level 2, it resends the signal with "(Artist Selection Screen)", and so on.
Crestron e-control Database Manager SW-DBM 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 Datad signals. The order in which the fields are sent is as listed in the dataFields field of the Queries table. Certain listed fields may be omitted based on the current value of the data filter bit pattern.
Crestron e-control Database Manager SW-DBM • A compiled control system program file which uses serial RS-232 communications (demo?COM.bin file); derived from the above by commenting off the Virtual COM port; ready to upload to such a control system. • A compiled control system program file which uses EtherNet communications (demo?TCP.bin file); derived from the above by commenting off the serial COM port; ready to upload to such a control system.
Crestron e-control Database Manager SW-DBM NOTE: Before proceeding to the actual demo page, start the server protocol by issuing the Server | Start command. 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. Selecting a datafield opens page 3, which is the keyboard.
Crestron e-control Database Manager SW-DBM Demo 2 Block Diagram Com Port Intersystem Communication Com1_OUT [tx$] [rx$] Com1_IN rx$ Enable First Prev Next Last (refresh) (requery) (blank) GoLevel1 GoLevel2 GoLevel3 GoLevel4 dig_in1 dig_in2 dig_in3 dig_in4 dig_in5 dig_in6 dig_in7 dig_in8 dig_in9 dig_in10 dig_in11 dig_in12 Touchpanel A First-fb Prev-fb Next-fb Last-fb GoLevel1-fb GoLevel2-fb GoLevel3-fb GoLevel4-fb B C fb1 fb2 fb3 fb4 fb6 fb7 fb8 fb9 Pick1-fb Pick2-fb Pick3-fb Pick4-fb Pick
Crestron e-control Database Manager SW-DBM 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. NOTE: Before proceeding to the actual demo page, start the server protocol by issuing the Server | Start command. The second page of demo 2 displays the names of eight genres from the Albums table. The arrow buttons are used to scroll forward or backward or go to the first or last eight records in the list of genres in the Albums table.
Crestron e-control Database Manager SW-DBM Demo 3 Block Diagram Com Port [tx$] Com1_OUT Intersystem Communications [rx$] Com1_IN rx$ Touchpanel A First-fb Prev-fb Next-fb Last-fb press1 press2 press3 press4 press5 fb1 fb2 fb3 fb4 First Prev Next Last WaitMsg fb9 B C List1$ Data1 Data2 Data3 Data4 Data5 Data6 Data7 Data8 Data9 ErrString Scrollbar dig_in1 First Prev Next Last dig_in2 dig_in3 dig_in4 dig_in5 Interlock text1 text2 text3 text4 text5 text6 text7 text8 text9 text10 Done [clea
Crestron e-control Database Manager SW-DBM On page 3, the album cover is again displayed with the message Now playing …. Touch the album image to return to page 2. 47 • Demos Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Appendix A: Theory of Operation This section describes the operation of the e-mailer signal block as it processes signals from the control system. Signal names are shown as conjoined words with initial caps set in bold type, such as SendNow. Refer to the “Signal Reference” beginning on page 58 for in-depth information on these signals. Server Protocol Run the Crestron Software Server application, swserver.
Crestron e-control Database Manager SW-DBM 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. 49 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Appendix B: Intersystem Communications and Signal Space Considerations The Send e-Mail SIMPL Windows symbol is available from the Crestron FTP site. Under SIMPLWIN, look for “Library update” (version equal to or greater than that specified in “Leading Specifications” on page 7). The DBMScroller SIMPL macro is installed with SIMPL Windows 1.4. It is also installed into the Modules folder. For use with 1.3, move the file to your currently set user macros folder.
Crestron e-control Database Manager SW-DBM 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). This data stream is connected to the input side of the serial driver symbol, also labeled tx$, and is sent out the COM port to the server.
Crestron e-control Database Manager SW-DBM 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. Normally, the signals in an Intersystem Communication symbol’s input list and its output list are internally enumerated starting at the top of each list with zero (0).
Crestron e-control Database Manager SW-DBM NOTES: 1. Always suffix a d (for decimal) to values typed into the Offset textbox. 2. Always enter 1d into the Option textbox for all Intersystem Communications symbols. 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.
Crestron e-control Database Manager SW-DBM Appendix C: Signal Reference Definition of Terms Data fields The indirect text fields which receive the data that is echoed when a record is opened (“picked”). Connection A connection to a system which can be either serial (RS-232) or EtherNet (TCP/IP). List fields The indirect text fields in scrollers. There can be more than one field (column) per row in the scroller.
Crestron e-control Database Manager SW-DBM 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. Hexadecimal (base 16) notation is used to conveniently specify the bit patterns for the signals that use them (i.e., the Config and SignalAn signals).
Crestron e-control Database Manager SW-DBM 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. If the signal is also undefined in the COM Settings signal block, the signal is lost (not sent).
Crestron e-control Database Manager Signal Block SW-DBM Direction Type NewRec system-to-server D All Scrollers Next system-to-server D All Scrollers Pickr system-to-server D All Scrollers Prev system-to-server D All Scrollers Custom Scroller Signal Name QueryDescription server-to-system S Custom Scroller Refresh system-to-server D Custom Scroller Requery system-to-server D All Scrollers ScrollBar system-to-server A Custom Scroller UpLevel system-to-server D Scroller S
Crestron e-control Database Manager Signal Block SW-DBM Signal Name Direction Type Custom Scroller Requery system-to-server D Custom Scroller UpLevel system-to-server D Note that Pick, of course, immediately opens a new record.
Crestron e-control Database Manager SW-DBM Blank Description Direction Causes the server to respond by clearing the scroller list. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal 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. List fields which are already null are not updated. (See “String Proxies,” page 54.
Crestron e-control Database Manager SW-DBM BlankAll Description Direction Causes the server to respond by clearing all scroller lists. System to Server Type Digital Value Pulse Expected Reply Comments system signal 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.
Crestron e-control Database Manager SW-DBM ClearRec Description Direction Causes the server to nullify every field in the opened record. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal Possible Data signals (all with null strings); followed by pulse of Done signal This signal is only effective when a record is opened. This would normally be the most recent record “picked.
Crestron e-control Database Manager SW-DBM CloseRec Description Direction Causes the server to “deselect” the chosen record. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal 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. This signal is only effective when a record is opened. This would normally be the most recent record “picked.
Crestron e-control Database Manager SW-DBM Cols Description Direction Type Value Expected Reply Comments scroller signal 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. Not implemented in the present release. See Also 63 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Datan Description Direction Type Value scroller signal Sends “picked” record to control system Server to System Serial Contents of fields of the opened record Expected Reply Comments The order of fields is as listed in the datafields field of the Queries table. Example 1: Three fields are listed in datafields. When a record is picked from the list, the three fields are echoed back to the system using the Data1, Data2, and Data3 signals.
Crestron e-control Database Manager DataFilter SW-DBM scroller signal Description Direction Type Value System to Server Analog A bit pattern Expected Reply Comments 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. Bit 0 corresponds to the first field listed, bit 1 to the second, etc. When a bit is set, the field is transmitted.
Crestron e-control Database Manager SW-DBM DeleteAllRecs Description Direction Removes all qualifying records from the referenced tables. System-to-Server Type Digital Value Pulse Expected Reply Comments scroller signal Done signal Obviously a dangerous signal. “Qualifying records” means records that qualified for inclusion in the query that created the recordset. “Referenced table(s)” means the table(s) referenced by the recordset associated with the scroller signal block.
Crestron e-control Database Manager SW-DBM DeleteRec Description Direction Deletes the currently opened record. System-to-Server Type Digital Value Pulse Expected Reply Comments scroller signal Done signal The current record is deleted from the recordset (and hence from the table or tables upon which the recordset is based). The data fields are all blanked. The record is removed from the scroller. This signal is only effective when a record is opened.
Crestron e-control Database Manager SW-DBM Done Description Direction Indicates requested operation complete Server to System Type Digital Value Pulse Expected Reply None Comments system signal; scroller signal Sent to System in response to most System-to-Server signals, indicating that the requested operation has been completed. Typically, there is a 0.2-sec. delay between the leading and trailing edge of the pulse. See Also 68 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Enable Description Direction Type Value scroller signal This signal enables/disables the signal block. System to Server Digital Assert to enable the signal block De-assert to disable the signal block Expected Reply Comments None The signal block must be enabled prior to use. If not, all signals which operate on scrollers (which does not include scroller config signals) produces the following error: Query not opened.
Crestron e-control Database Manager SW-DBM Enabled Description Direction Type Value scroller signal “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.
Crestron e-control Database Manager SW-DBM ErrNumber Description Direction Type Value Expected Reply Comments system signal; scroller signal 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 New error number None This signal works in conjunction with the ErrString and ErrTrigger signals which always follow immediately. For an e-mail scroller, this and the other Err signals are always defined.
Crestron e-control Database Manager SW-DBM ErrString Description Direction Type Value Expected Reply Comments system signal; scroller signal 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.
Crestron e-control Database Manager SW-DBM ErrTrigger Description Direction Trigger for ErrNumber and ErrString Server to System Type Digital Value Pulse Expected Reply None Comments system signal; scroller signal This signal is sent after the ErrNumber and ErrString to indicate that an error condition has occurred. For an e-mail scroller, this and the other Err signals are always defined.
Crestron e-control Database Manager SW-DBM First Description Direction System to Server Digital Value Pulse Comments See Also 74 • Appendices Displays the scroller’s first page. Type Expected Reply scroller signal List signals ScrollBar signal pulse of Done signal Automatically effected when scroller signal block is enabled. Enable, Prev, Next, Last signals Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM GoLevelv Description Direction Return to an earlier level of a successive query. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal Scroller blanking (as per configuration options); GoLevelEcho signal pulse; Scroller refresh with new data; Done signal pulse The number of GoLevel signals, v, is the number of successive query levels defined in the Configuration Options window.
Crestron e-control Database Manager SW-DBM GoLevelEchov+1 Description Direction Level navigation occurred. Server to System Type Digital Value Pulse Expected Reply None Comments scroller signal Successive query scrollers only. This signal is sent when navigating to a narrower query or back to wider query.
Crestron e-control Database Manager SW-DBM Last Description Direction Displays the scroller’s last page. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal 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. See Also 77 • Appendices First, Prev, Next signals Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Listr - or - Listr,c Description Direction Type Value Expected Reply Comments See Also 78 • Appendices scroller signal 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. None. Not all List signals are always sent; see “String Proxies,” page 54. The following signals each have the potential to alter the scroller contents.
Crestron e-control Database Manager SW-DBM NewRec Description Direction Creates and “opens” a new record in the referenced table(s) System-to-server Type Digital Value Pulse Expected Reply Comments scroller signal Done signal, possible blank strings to various Datan signals “Qualifying records” means records that qualified for inclusion in the query that created the recordset. “Referenced table(s)” means the table(s) referenced by the recordset associated with the scroller signal block.
Crestron e-control Database Manager Next Description Direction Value Pulse See Also 80 • Appendices System to Server Digital Comments scroller signal Displays next scroller page. Type Expected Reply SW-DBM List signals ScrollBar signal pulse of Done signal No effect if currently on last page. First, Prev, Last signals Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Pickr Description Direction User has chosen a certain record currently visible in scroller System to Server Type Digital Value Pulse Expected Reply Comments scroller signal 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. The server knows what scroll page the user is seeing and opens the indicated record.
Crestron e-control Database Manager SW-DBM PingSvr, PingSys, PongSvr, PongSys Description Direction Request for acknowledgement PingSvr: System to Server PingSys: Server to System Type Digital Value Pulse Expected Reply Comments system signals PongSvr: Server to System to Server PongSys: System PongSvror PongSys When the Server receives a PingSvr signal, it immediately responds with a PongSvr signal pulse. This is useful during System installation to test communications with the Server.
Crestron e-control Database Manager Prev Description Direction Value Pulse See Also 83 • Appendices System to Server Digital Comments scroller signal Displays previous scroller page. Type Expected Reply SW-DBM List signals ScrollBar signal pulse of Done signal No effect if currently on first page. Prev, Next, Last signals Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM QueryDescription Description Direction Type Value Expected Reply Comments scroller signal 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); or after enable, upon initiation of a new query (by the NewQuery signal). Typically displayed on touchscreen above scroller.
Crestron e-control Database Manager SW-DBM Refresh Description Direction Resends all scroller string proxies which causes server to respond. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal List, Data, and QueryDescription serial signals Normally used to re-establish the contents of all scroller-related indirect text fields. See “String Proxies,” page 54. This signal cannot be defined in an emailer scroller.
Crestron e-control Database Manager SW-DBM Requery Description Direction Causes server to respond by going back to the database to rebuild the current scroller page, resends all scroller strings.
Crestron e-control Database Manager SW-DBM Requery All system signal Description Direction Type Value Expected Reply Comments Not implemented in the present release. See Also 87 • Appendices Enable signal Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM Rows Description Direction Type Value Expected Reply Comments scroller signal 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. Not implemented in the present release. See Also 88 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Database Manager SW-DBM ScrollBar Description Direction Type Value scroller signal 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 Expected Reply Comments None. This signal should be hooked directly to an analog gauge.
Crestron e-control Database Manager SW-DBM UpdateRec Description Direction Update record in database file with field edits. System to Server Type Digital Value Pulse Expected Reply Comments scroller signal 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. Not implemented in the present version.
Crestron e-control Database Manager SW-DBM UpLevel Description Direction System to Server Digital Value Pulse Comments See Also 91 • Appendices Return to the preceding level of a successive query. Type Expected Reply scroller signal Scroller blanking (as per configuration options); GoLevelEcho signal pulse; Scroller refresh with new data; Done signal pulse Ignored if received when on the top level (level 1). However, valid when received after data display (final scroller pick).
Crestron e-control Database Manager SW-DBM WriteFieldd Description Direction Type Value Expected Reply Comments scroller signal 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.
Crestron e-control Database Manager 93 • Appendices SW-DBM Installation & Reference Guide — DOC.
Crestron e-control Database Manager 94 • Appendices SW-DBM Installation & Reference Guide — DOC.
