Server Configuration Manual C1553M-B (4/05) C1553M (5/04)
Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17 Configuring a New System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Set Up the Minimal Configuration . . . . . . . . . . . . . . . .
Autodiscover Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Delete a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Add a Fixed Camera Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure the Logical Mapping Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91 Add a CM9760-ALM Alarm Interface Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93 Configure the General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PelcoNet Device Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 External Monitor Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 DX8000 Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add a Vertex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173 Delete a Vertex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173 Delete a Hotlink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211 Add a New Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212 Edit a Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restore a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251 System Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252 View System Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C1553M-B (4/05)
List of Illustrations 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 Windows Task Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Session Manager Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 12 NVR300 Recording Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Add NVR Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 C1553M-B (4/05) Edit Point Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 DIP Switches Tab for CM9760-REL . . . . .
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 14 ASCII Camera Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147 CM9760-REL Permissions . . . . . . . . . . . . . . . . . . .
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 C1553M-B (4/05) Edit Label Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226 Synchronizing DVR with Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Tables A B C D E F G H I J K L M N O P Q R S T U V W X Y Z AA AB AC AD AE AF AG AH AI AJ AK AL AM AN AO AP AQ 16 Options for Run Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Digital Video Stream Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction The Pelco VMX300(-E) Video Management System uses a Windows®-based interface to control any combination of analog and IP devices in a single integrated video security system. With a mouse, you can click a camera icon on a system map and then drag it to a video display window.
Configuring a New System When configuring a new VMX300(-E) system, it is recommended that you start with a minimal configuration that allows you to test core system functionality, such as viewing video and controlling devices. Once this is working, build on the minimal configuration by adding users and user groups, workspaces, maps, archive servers, automation, and whatever other customization you want.
TEST THE MINIMAL CONFIGURATION Testing the minimal configuration ensures that the devices in your system are connected and configured correctly and custom windows are configured correctly. To test the minimal configuration: 1. Start client: Start the client on any workstation that you added as a client. Select the VMX300(-E) client from the Windows Start menu, or double-click the VMX300(-E) client icon on the desktop, it there is one. 2.
Log On and Configure Operating System Settings CAUTION: Contact your network administrator to assist you in configuring the network features of the VMX300(-E) workstation. 1. Connect the VMX300(-E) workstation power cord to the workstation power input and then to an uninterruptible power supply (UPS). 2. On the front panel of the workstation, press the power button to power on the unit. 3. The VMX300(-E) boots, and then the Microsoft® Windows log on dialog box appears. 4.
Figure 3. Opening the Local Area Connection Properties Dialog Box 3. In the Local Area Connection Properties dialog box, double-click the Internet Protocol (TCP/IP) listing. The Internet Protocol (TCP/IP) Properties dialog box appears. Figure 4. Internet Protocol (TCP/IP) Properties Dialog Box By default, the properties are set to “Obtain an IP address automatically” and “Obtain DNS server address automatically.” 4. Click “Use the following IP address,” and then complete the following steps: a.
IDENTIFY THE VMX300(-E) WORKSTATION ON THE NETWORK This procedure includes assigning a unique computer name to the VMX300(-E) workstation and then assigning the VMX300(-E) workstation to a workgroup or a domain. If these steps are not applicable in your system, skip this procedure. Note that if you are using a DX9000 Series DVR in your system, you must assign the VMX300(-E) to the appropriate DX9000 workgroup. To identify the VMX300(-E) on the network, complete the following steps: 1.
DISABLE NETBIOS A workstation running the NetBIOS service on a network can be vulnerable to attack from outside sources. If you are not using a DX9000 Series DVR, you should complete the following steps to disable the NetBIOS service in the Windows operating system. Note, however, that you should contact your network administrator before changing any NetBIOS settings. CAUTION: The NetBIOS service is required for the DX9000.
Disable the NetBIOS Helper Service 1. Click the Windows Start button, and then select Settings > Control Panel > Administrative Tools > Services. The Services window appears. Figure 7. Windows Operating System Services Window 2. Right-click the service named TCP/IP NetBIOS Helper, and then click Properties. The TCP/IP NetBIOS Helper Properties dialog box appears. Figure 8. TCP/IP NetBIOS Helper Properties Dialog Box 3. Click the down arrow in the “Startup type” drop-down box, and then click Disabled. 4.
Starting and Stopping the Server The VMX300(-E) server can be launched in run mode or configuration mode. Configuration mode has a user interface that allows you to configure any type of object, including the following objects: • Users • Maps • Devices • Scripts • Alarms and events To launch the VMX300(-E) server in configuration mode, a user must have permission to configure the software. Refer to User Groups - Group Permissions for more information. Run mode has no user interface.
LAUNCH THE SERVER NOTES: • If this is the first time you have launched the server, or if your base license has expired, you must enter a base license before proceeding with the configuration. Click Yes when asked whether you want to enter a base license. The License Manager will open. Follow the instructions in License Manager - Add a License.
CONFIGURE THE SERVER WHILE IT IS RUNNING You can log in and out of configuration mode while the server is running. This allows you to perform administrative tasks without preventing operators from working in the VMX300(-E) client. When the server is in run mode, perform the following steps: 1. Double-click the VMX300(-E) icon in the Windows system tray, or right-click the icon and select Configure from the pop-up menu. The Server Login dialog box opens. Figure 10. Server Login Dialog Box 2.
SHUT DOWN THE SERVER SHUTTING DOWN WHILE IN RUN MODE 1. Right-click the VMX300 icon in the Windows system tray, and then select Exit from the pop-up menu. Figure 11. Run Mode Pop-up Menu 2. The shutdown prompt appears. 3. Click Yes. The server shuts down. SHUTTING DOWN WHILE IN CONFIGURATION MODE ONLY NOTE: If the server is in both Run mode and Configuration mode, you must shut it down through Run mode. You cannot shut down the server from Configuration mode when the server is running.
License Manager License Manager provides a convenient means of managing your software licenses. Each server in your system must have a valid base license to run VMX300(-E). If no valid base license is registered, you will not be able to launch the server without first adding a license. ADD A LICENSE 1. If the server has prompted you to enter a license, click Yes. Otherwise, open the License Manager by clicking Tools > License Manager. Then click Add in the License Manager dialog box.
4. Enter your activation code in the Add License dialog box. Figure 15. Activation Code 5. Click Apply. If you purchased additional license IDs, repeat steps 1-4 for each license ID.
Starting and Stopping Device Drivers START A DEVICE DRIVER Start each device driver needed to control the devices in your system. You can start the drivers before you start the VMX300(-E) server, or after. When you start a device driver, you have the choice of running it as an executable or as a service. If you ever have to restart a driver that is run as an executable, you will have to follow the steps outlined here.
5. Mode: a. Executable: To run the device driver as an executable, click “Start the driver as an executable.” b. Service: To run the device driver as a service, click “Install the driver as a service.” DX8000 NOTE: The option to run the DX8000 driver as a service is not available at this time. When starting the DX8000 driver, you must click “Start the driver as an executable.” 6. Some device drivers support additional options.
Clients, Custom Windows, and Canvases VMX300(-E) provides tools to define custom windows that are viewable through the client.
ADD A NEW CLIENT 1. Navigate the Object Browser to [project name] > Clients. Double-click in the right pane, or right-click Clients in the left pane and select Add New from the pop-up menu. The Add New Client dialog box opens. Figure 18. Add New Client Dialog Box 2. Computer name: Type in the name of the computer you want to add as a client of the VMX300(-E) server, or click Browse to select from a list of computers visible on the network.
DELETE A CLIENT NOTES: • Deleting a client is irreversible. If you delete a client and then change your mind, you must add it back as described in Add a New Client. • Deleting a client does not affect workspace files. 1. Navigate the Object Browser to [project name] > Clients. In either pane, right-click the client you want to delete and select Delete from the pop-up menu. The Confirm dialog box opens. 2. If you are sure you want to delete the client, click Yes.
ADD A NEW CUSTOM WINDOW NOTE: If the same custom window will be viewed by more than one client, it must have the same name and script tag for every client. To add a new custom window to a particular client: 1. Navigate the Object Browser to [project name] > Clients > [client name] > Windows. Double-click in the right pane, or right-click Windows in the left pane and select Add New from the pop-up menu. The Add New Window dialog box opens. Figure 20. Add New Window Dialog Box 2.
DELETE A CUSTOM WINDOW Deleting a custom window is irreversible. If you delete a custom window and then change your mind, you must add a new custom window. Also note that if you delete a custom window, any script that refers to the custom window will contain an error. 1. Navigate the Object Browser to [project name] > Clients > [client name] > Windows. In either pane, right-click the window you want to delete and select Delete from the pop-up menu. The Confirm dialog box opens. 2.
b. Video input number (Quad Video Display cards only): Select the video input number for the canvas you are configuring from the drop-down list. Click OK to close the dialog box. Figure 23. General Setting for Quad Video Display 5. Advanced tab: For all types of canvas, the canvas settings Advanced tab allows you to configure the image quality for image capture files, including both automatic FTP image capture and image capture initiated by an operator using the Capture button.
ADD A NEW CANVAS (PELCONET) Any custom window that is used to display video encoded by a PelcoNet encoder or encoder/decoder must have a PelcoNet MPEG Series canvas defined for it. Windows used to display analog video that is decoded by a PelcoNet device do not require a PelcoNet MPEG Series canvas. 1.
Change the List of Selected Signal Types To change the list of selected signal types, you can do any of the following operations: • Click the signal type, and then click remove; the signal type appears in the Available Compatibilities list. • To select multiple signal types, press the Ctrl key while clicking signal types. • To remove all signal types, click Remove All.
ADD A NEW CANVAS (DX8000 OR DX9000 DVR) Any custom window that is used to display video from a DX8000 or DX9000 DVR must have a DVR canvas defined for it. 1. Navigate the Object Browser tree to [project name] > Clients > [client name] > Windows > [window name] > Canvases for the window that will be used to display video from a DVR. 2. Double-click . The Add New Canvas dialog box appears. Figure 28. Add a DVR Canvas 3.
Device Drivers VMX300(-E) uses device drivers to control and manage devices. Each device driver controls a particular type of equipment, such as surveillance camera, video recorder, or any other type of device. There are several steps involved in configuring device drivers on the VMX300(-E) server: 1. Launch the device driver. Refer to Starting and Stopping Device Drivers - Start a Device Driver. 2. Add the device driver to the server configuration as described in Add a New Device Driver.
b. Browse all: To browse the network for running drivers, click Browse All. The Browse Drivers dialog box opens. Figure 32. Browse All Drivers Dialog Box The Browse Drivers dialog box lists all device drivers running at network locations visible to the server you are configuring. Select the driver you want to add and click OK to close the Browse Drivers dialog box. The driver name, IP address, and listening port will appear in their respective boxes. c.
Figure 33. Autodiscover Warning 2. If you are sure you want to proceed, click Yes. The server adds the drivers it finds to the server configuration. The drivers appear in the Object Browser. EDIT A DEVICE DRIVER’S PROPERTIES You can change the IP address and port number of a device driver, but not the driver’s name. NOTE: Changes to device drivers, such as autodiscovering drivers, come into effect immediately. You cannot discard your changes by exiting configuration mode without saving.
CONFIGURE A PELCONET MPEG TIME SERVER The PelcoNet MPEG driver allows you to configure a time server for the driver to periodically synchronize its clock to. To ensure that synchronization works properly, set the time zone on the PelcoNet device to the time zone where the device is installed. Refer to the appropriate PelcoNet manual for instructions on setting the device’s time zone. NOTE: Be sure that the time zone settings are synchronized appropriately on all devices in the VMX300(-E) configuration.
6. Optional: repeat steps 3-5 to add time servers as necessary. 7. Optional: Each time server that you add to the list is checked by default. If you do not want to use a particular time server click it to uncheck the server. If more than one time server is selected, the driver will attempt to synchronize to the first selected server in the list.
Devices Changes to devices, such as adding a new device to the server configuration or deleting a device, come into effect immediately. You cannot discard your changes by exiting configuration mode without saving. Before you can add a device to the server configuration, you must first start the device driver—either on the server workstation or on the network —and then add the driver to the server configuration. Refer to the Device Drivers section for instructions.
DELETE A DEVICE 1. Navigate the Object Browser to [project name] > Device Drivers > [device driver name] > Devices. 2. In either pane, right-click the device you want to delete and then select Delete from the pop-up menu. The Confirm dialog box opens. 3. If you are sure you want to delete the device, click Yes. The selected device is deleted and the Confirm dialog box closes. The deleted device disappears from the Object Browser and its device icons are removed from maps.
CONFIGURE THE PROPERTIES TAB Figure 40. Properties Tab for Fixed Camera Use the Properties tab to configure the animation settings of fixed camera icons viewed on maps in the VMX300(-E) client. Click Choose next to each condition to select the color settings for that condition. Note that you can configure a different color setting for each camera. Normal state: When the device’s Alarm property equals False, device icons in the client are the color specified here.
CONFIGURE THE GENERAL TAB Figure 41. General Tab for PTZ Camera Use the General tab to enter a location name and an optional description. The location name is used to identify the device. The location name can be a maximum of 50 characters and can include any letter, digit, or special character, with the exception of single and double quotation marks. Location names are not case sensitive. CONFIGURE THE PROPERTIES TAB Figure 42.
CONFIGURE THE COMMUNICATIONS TAB 1. Connection Type: Specify the type of connection between the device driver and the camera. • DIRECT SERIAL: The camera is connected using an RS-232 to RS-422 converter or using an RS-422 PC serial port. • INTERNET PROTOCOL: The camera is connected to the serial port on a networked device. • MODEM: This feature is reserved for future development. 2. Settings: Complete the instructions provided below for the appropriate connection type specified in Step 1.
b. Local Port: The local port is the port the Pelco PTZ device driver uses to transmit commands. If your system is secured behind a firewall, enter one of the ports made available by the firewall. Otherwise, enter 0 to have the driver randomly assign an available port. Tip: To find out what port the driver assigned, switch or control the device in the VMX300(-E) client, and then use the netstat command at the DOS prompt to view assigned ports. c.
CONFIGURE THE CAMERA MODEL TAB Figure 46. Camera Model Tab Select the camera model and protocol from the drop-down box. Refer to the appropriate camera installation/operation manual for the recommended protocol. CONFIGURE THE AUXILIARIES TAB Figure 47. Auxiliaries Tab The Auxiliaries tab allows you to give the camera’s auxiliaries meaningful names. By default, auxiliaries are named Auxiliaryi, where i is the auxiliary’s number.
ADD A PELCONET MPEG DEVICE The PelcoNet MPEG device driver currently supports the following devices: • PelcoNet NET300 Series and NET350 Series decoders (denoted “3xx” in this document) • PelcoNet NET300 Series and NET350 Series encoders (denoted “3xx” in this document) • PelcoNet NET4001A encoder/decoder • NVR300 Series network video recorders The PelcoNet MPEG driver allows you to configure a time server for the driver to periodically synchronize its clock to.
Figure 49. Browse Units Dialog Box 2. Optional: Type a description of the device. CONFIGURE THE PROPERTIES TAB Figure 50. Properties Tab for PelcoNet Device Icon Animation Use this portion of the Properties tab to configure the animation settings of PelcoNet device icons viewed on maps in the VMX300(-E) client. Click Choose next to each condition to select the color settings for that condition. Note that you can configure a different color setting for each device.
Recording This portion of the Properties tab applies to PelcoNet NET350 encoders only. If the PelcoNet device has built-in ability to record audio and video, click “This unit has an integral recording capability.” To use the recording feature you must set the PelcoNet device’s time zone and clock to ensure that you can locate video archived using the integral recording capability.
CONFIGURE THE ENCODING TAB This tab is available only on encoder units. Figure 52. Encoding Tab for PelcoNet Device PelcoNet 3xx encoders support dual MPEG-4 streams that can be configured to different quality settings. Typically, one stream is configured for viewing video, the other for recording. For information on configuring the streams, refer to the appropriate PelcoNet manual.
If the encoder is connected when you configure the settings in VMX300(-E), the settings are updated in the encoder immediately. Otherwise, updating occurs once the encoder is connected. To configure multicast settings through the encoder, complete the following steps: 1. Configure the encoder’s internal multicast settings; refer to the appropriate PelcoNet manual for instructions. 2. In VMX300(-E) click Upload Settings on the Communications tab. Refer to the Configure the Communications Tab section.
HOW TO CHOOSE THE VIDEO STREAM SETTINGS FOR YOUR CONFIGURATION VMX300(-E) can combine analog and digital video streams for viewing on the VMX300(-E) client. The total number of digital streams that can be displayed is limited by the size and type of images selected for viewing. Table B identifies the CPU workload and bandwidth amounts used for each type of video stream. Table B includes the recommended PelcoNet setting, identified by the gray row.
CONFIGURE THE ENCODING/DECODING TAB (PELCONET 4001A ONLY) Figure 55. Encoding/Decoding Tab for PelcoNet 4001A The PelcoNet 4001A supports MPEG-2 and MPEG-4 streaming. Number of Simultaneous Streams VMX300(-E) can display multiple digital video windows for viewing the area under surveillance. However, the number of digital windows that can be displayed at one time is limited by the size and type of images selected for viewing.
4. If the encoder/decoder is configured to multicast MPEG-4 streams, configure the following settings: • Enter the IP multicast group MPEG-4 port in the MPEG-4 Port field. • Enter the IP multicast group audio port in the Audio Port field. If the encoder/decoder is connected, these port numbers are automatically uploaded from the encoder/decoder when you select the mode.
CONFIGURE THE COMMUNICATIONS TAB Figure 58. Communications Tab for PelcoNet Device Unit Address To add a PelcoNet device, complete the following steps: 1. You can either enter the IP address of the PelcoNet device you are configuring or click Browse. The address in VMX300(-E) is synchronized with the address in the PelcoNet device. Changing the address in VMX300(-E) also changes the address in the device.
Security The upload features only work on a password-protected device if the password is entered here. You only need to enter the password once in VMX300(-E). Once the password is entered, the upload features can be used freely during the current and future sessions. Note the following password parameters: • If a Live or User password is configured in the PelcoNet device-internal settings, enter a password of your choice on the Communications tab.
Figure 61. Add NVR Dialog Box 2. You can either enter the IP address of the NVR you want to add or click Browse. If you click Browse to automatically locate the NVR300s that are visible over the network the Browse Units dialog box appears. Click the desired NVR, and then click OK. Note that the Browse function will not locate NVRs running on the same computer as any VMX300(-E) software (server, client, or device drivers). 3. Click Add.
ADD AN EXTERNAL MONITOR DEVICE The external monitor device driver supports any noncontrollable video destination, such as a noncontrollable monitor. Before you can add a device to the server configuration, you must first start the device driver—either on the server workstation or on the network—and then add the driver to the server configuration. Refer to the Device Drivers section for instructions. 1. Navigate the Object Browser tree to [project name] > Device Drivers > External Monitor > Devices. 2.
Looping output on an external monitor device allows the device to function as a source device. Refer to Devices - Switching a Device in the VMX300(-E) Client Manual for information on source and destination devices. To enable looping output complete the following steps: 1. Click Looping Output. 2. Add an analog video connection to the server configuration for this device. Refer to the Connections section for information on analog video connections.
1. Navigate the Object Browser tree to [project name] > Device Drivers > Pelco DX8000 Driver > Recorders. 2. Double-click . The Add New DX8000 dialog box appears. You can also configure DX8000 settings after you have added the DVR to the server configuration. Right-click the DX8000 recorder, and then select Edit from the pop-up menu. The Edit Properties dialog box appears, which contains the same tabs and fields as the Add New DX8000 dialog box. 3.
Use the Properties tab to configure the animation settings of DX8000 icons viewed on maps in the VMX300(-E) client. Click Choose next to each condition to select the color settings for that condition. Note that you can configure a different color setting for each recorder. Unknown state: When the recorder’s CommStatus property equals Offline, device icons in the client are the color specified here.
1. Select the recorder model from the drop-down box. 2. (Optional) Click “Looping Inputs” to make the recorder’s looping inputs appear as sources for connections. ADD A DX8000 CAMERA If you will be controlling cameras through the DVR, add each camera to the VMX300(-E) server configuration and configure the camera settings within VMX300(-E), as described in this section.
CONFIGURE THE PROPERTIES TAB Figure 70. Properties Tab for DX8000 Camera Use the Properties tab to configure the animation settings of the DX8000 camera icon viewed on maps in the VMX300(-E) client. Click Choose next to each condition to select the color settings for that condition. Note that you can configure a different color setting for each camera. Unknown state: When the camera is not communicating normally with the recorder, the icon is the color specified here.
Note that the VMX300(-E) supports up to eight auxiliaries. The actual number of auxiliaries available to you depends on the number of auxiliaries the camera supports. If the camera has fewer than eight auxiliaries, for example six auxiliaries, then only the first six auxiliaries on the Auxiliaries tab will work. If the camera supports more than eight auxiliaries, then you can only access the first eight auxiliaries through the Auxiliaries tab.
3. Navigate to Local Users and Groups > Users. Figure 73. Users Folder 4. Click Action > New User. The New User dialog box appears. Figure 74. New User Dialog Box 5. Click the “User must change password at next logon” field to clear the checkmark. 6. Click the “User cannot change password” and “Password never expires” fields to select these options. 7. In the User name box, type the Windows user name of the user you want add. 8. Optional: Type the user’s full name and a description, if desired. 9.
Figure 75. Groups Folder 12. Click Action > Add to Group. The Avusers Properties dialog box appears. Figure 76. Avusers Properties Dialog Box 13. Click Add. The Select Users or Groups dialog box appears.
Figure 77. Select Users or Groups Dialog Box 14. Click the user you just added from the list, and then click Add. 15. Click OK. The Select Users or Groups dialog box closes and the new user appears in the Avusers group. Figure 78. New User Added to Avusers Group WARNING: Do not proceed with configuring the user’s computer if the user does not appear in the Avusers group. 16. Click OK. The Avusers Properties dialog box closes. 17.
Configuring Computers and Users Once you have added the users who will be accessing the DVR to the Avusers group, you must configure the computers from which users will access or manage the DVR, including the VMX300(-E) server, the computer the DX9000 driver is installed on, and every VMX300(-E) client. You must configure each computer for each user who will access the DVR from that computer. For example, suppose two operators, bsmith and rdarcy, will access a DX9000 DVR from the same computer.
5. Click Build a list of local servers, and then click Custom naming. 6. Type the name of the DX9000 DVR in the Custom naming field. If you do not know the name of the DVR, you can find it out by right-clicking the My Computer icon on the Windows desktop and selecting Properties from the pop-up menu. Click the Network Identification tab. The DVR name is the first part of the full computer name. For example, if the full computer name is pelco1.admin1.corwayfacility, then the DX9000 DVR name is pelco1.
Figure 83. Success or Failure Indication 10. Repeat steps 6 - 8 for each DX9000 DVR you want to be accessible to this user from this computer. If you are configuring the VMX300(-E) server computer, make sure you add each DX9000 in the system. In a multipleserver system, add each DVR to exactly one server. Never add a DVR to more than one server. 11. Click Close. The DX9000 Client Configuration Utility dialog box closes.
ADD A DX9000 DVR TO THE SERVER CONFIGURATION Before you can add a device to the server configuration, you must first start the device driver—either on the server workstation or on the network—and then add the driver to the server configuration. Refer to the Device Drivers section for instructions. 1. Navigate the Object Browser tree to [project name] > Device Drivers > DX9000 Driver > Devices. 2. Double-click . The Add New DX9000 dialog box appears.
CONFIGURE THE ALARMS AND EVENTS TAB This feature is reserved for future development. DVR TROUBLESHOOTING: IF YOU CHANGE THE VMX300(-E) OPERATING SYSTEM PASSWORD If you change the VMX300(-E) operating system password (user name: AvUser; password: 1234), system operators must complete the following steps to connect to the DVR server. 1. Click the Windows Start button, and then select Run. 2.
CONFIGURE THE GENERAL TAB Figure 87. General Tab for an ASCII Switcher 1. Enter a location name and an optional description. The location name is used to identify the device. The location name can be a maximum of 50 characters and can include any letter, digit, or special character, with the exception of single and double quotation marks. Location names are not case sensitive. 2.
CONFIGURE THE COMMUNICATIONS TAB 1. Connection Type: Specify the type of connection between the device driver and the switcher. • DIRECT SERIAL: The switcher or data translator is connected directly to the VMX300(-E) workstation using an RS-232 null modem cable. • INTERNET PROTOCOL: The switcher or data translator is connected to the serial port on a networked device, such as a PelcoNet device. • MODEM: This feature is reserved for future development. 2.
a. Local IP: The local IP is the IP address of the computer that the Pelco ASCII device driver runs on. Select the local IP from the dropdown box. b. Local Port: The local port is the port the Pelco ASCII driver uses to transmit commands. If your system is secured behind a firewall, enter one of the ports made available by the firewall. Otherwise, enter 0 to have the driver randomly assign an available port.
CONFIGURE THE I/O TAB Figure 92. I/O Tab for ASCII Switcher Use the I/O tab to specify how many physical inputs and outputs are available for switching cameras and to specify logical number ranges. 1. Enter the number of physical inputs available for switching cameras. To prevent VMX300(-E) from using some of the switcher’s physical inputs, exclude them from the count of available inputs.
CONFIGURE THE MODEL TAB Figure 94. Model Tab for ASCII Switcher Select the switcher model from the drop-down box. ADD AN ASCII CAMERA The Pelco ASCII device driver controls cameras routed through a Pelco matrix switcher using the Pelco ASCII protocol.
CONFIGURE THE GENERAL TAB Figure 95. General Tab for ASCII Camera 1. Enter a location name and an optional description. The location name is used to identify the device. The location name can be a maximum of 50 characters and can include any letter, digit, or special character, with the exception of single and double quotation marks. Location names are not case sensitive. 2. If the camera can be panned, tilted, zoomed, focused or the iris adjusted, click “This camera supports Pan/Tilt/Zoom functionality.
CONFIGURE THE AUXILIARIES TAB Figure 97. Auxiliaries Tab for ASCII Camera Auxiliary names appear in the VMX300(-E) client, where auxiliaries are controlled, and also appear in scripts, where they are used to refer to the auxiliary. When you rename an auxiliary, the write property for that auxiliary is changed to the name you have specified. Example: You might rename an auxiliary that controls a camera’s wiper to Wiper, then use it in a script as follows: SET Camera1.Wiper = On FOR 3.
CONFIGURE THE GENERAL TAB Figure 98. General Tab for KBD300 Use the General tab to enter a location name and an optional description. The location name is used to identify the device. The location name can be a maximum of 50 characters and can include any letter, digit, or special character, with the exception of single and double quotation marks. Location names are not case sensitive. CONFIGURE THE COMMUNICATIONS TAB 1.
Internet Protocol Settings Figure 100. Communications Tab for KBD300 Internet Settings a. Protocol: If the keyboard is connected to a PelcoNet device, follow the instructions in step (1). If the keyboard is connected to some other kind of device, follow the instructions in step (2). (1) Select the PelcoNet protocol from the Protocol drop-down list.
Figure 101. Misc Section of KBD300 Communications Tab Address: Enter the keyboard address. The address must match the address specified by the keyboard DIP switch settings. Idle Disconnect (sec): (Optional) Enter the number of seconds of inactivity you want to elapse before VMX300(-E) closes the COM port (direct serial connection) or the local port (IP connection). The port will open again automatically when a new connection is established with the relay unit.
Figure 102. Sample Logical Mapping To use the KBD300A logical mapping feature you must complete the following tasks: • Enable a unique device number for each VMX300(-E) device that you want to map to the keyboard. This task is done in the Edit Local Settings dialog box for the specific device. Instructions are provided in the Enable Camera and Monitor Device Numbers section. • Map the device numbers to a keyboard number for the specific keyboard.
2. Click “Enable the device number,” and then type the desired device number. Each device must have a unique device number in its local settings, no matter what type of device it is. For example, you cannot have a monitor with device number 20 and a camera with device number 20. However, these two devices can be mapped to the same keyboard number, so the operator enters the same number on the keyboard for the two devices. Refer to the Configure the Logical Mapping Tab section for more information. 3.
Export Logical Mapping Settings If you want to assign the same logical mappings to more than one keyboard, you can save the logical mapping settings to a file by completing the following steps: 1. Configure the logical mappings as described in the previous section. 2. Click Export. The Save As dialog box appears. 3. Browse to the desired folder and type a file name for the logical mappings. 4. Click Save. The Save As dialog box closes and the logical mappings are saved. 5. Click OK.
Figure 106. Logical Mapping Range 4. Release the mouse button. VMX300(-E) automatically numbers the selected devices consecutively, starting from the number of the first device in the range. Figure 107. Consecutive Logical Numbers ADD A CM9760-ALM ALARM INTERFACE UNIT The Pelco ALM driver supports the CM9760-ALM alarm interface unit, which can be used to bring contact information into the VMX300(-E) system. Examples of contacts that can be connected are motion sensors, door switches, and pushbuttons.
CONFIGURE THE GENERAL TAB Figure 108. General Tab for CM9760-ALM Use the General tab to name and describe the alarm unit. The device name can be a maximum of 50 characters. You cannot use single or double quotation marks in a name, but you can use any other letter, digit, or special character. Device names are not case sensitive. The optional description appears in the Object Browser beside the device name. CONFIGURE THE PROPERTIES TAB Figure 109.
CONFIGURE THE COMMUNICATIONS TAB 1. Connection Type: Specify the type of connection between the device driver and the alarm unit. • DIRECT SERIAL: The alarm unit is connected using an RS-232 to RS-422 converter or using an RS-422 PC serial port. • INTERNET PROTOCOL: The alarm unit is connected to the serial port on a networked device. • MODEM: This feature is reserved for future development. 2. Settings: Complete the instructions provided below for the appropriate connection type specified in Step 1.
a. Local IP: The local IP is the IP address of the computer that the Pelco ALM driver runs on. Select the local IP from the drop-down box. b. Local Port: The local port is the port the Pelco ALM driver uses to transmit commands. Enter the local port. c. Protocol, Remote IP, Remote Port: The remote device is the device the alarm unit is physically connected to. If the alarm unit is connected to a PelcoNet device, follow the instructions in step (1).
CONFIGURE THE ALM POINTS TAB Figure 113. ALM Points Tab for CM9760-ALM The ALM Points tab lists each alarm point in the device and the name and script tag used within VMX300(-E) to refer to the point. The device address entered on the Communications tab determines how the points are numbered. If the device address is set to 1, the points are numbered 1 - 64. If the address is set to 2, the points are numbered 65 - 128, and so on. The ALM Points tab allows you to rename points to give them meaningful names.
CONFIGURE THE MODEL TAB Figure 115. Model Tab for CM9760-ALM The Model tab displays the model of alarm unit supported by the Pelco ALM Driver. Only one model is currently supported. ADD A CM9760-REL RELAY INTERFACE UNIT The Pelco Relay driver supports the CM9760-REL relay interface unit, which can be used to control peripheral equipment through single-pole, single-throw (SPST) contact outputs. Each relay unit provides 64 contact outputs.
CONFIGURE THE GENERAL TAB Figure 116. General Tab for CM9760-REL Use the General tab to name and describe the relay unit. The device name can be a maximum of 50 characters. You cannot use single or double quotation marks in a name, but you can use any other letter, digit, or special character. Device names are not case sensitive. The optional description appears in the Object Browser beside the device name. CONFIGURE THE PROPERTIES TAB Figure 117.
CONFIGURE THE COMMUNICATIONS TAB 1. Connection Type: Specify the type of connection between the device driver and the relay unit. • DIRECT SERIAL: The relay unit is connected using an RS-232 to RS-422 converter or using an RS-422 PC serial port. • INTERNET PROTOCOL: The relay unit is connected to the serial port on a networked device. • MODEM: This feature is reserved for future development. 2. Settings: Complete the instructions provided below for the appropriate connection type specified in Step 1.
a. Local IP: The local IP is the IP address of the computer that the Pelco Relay driver runs on. Select the local IP from the drop-down box. b. Local Port: The local port is the port the Pelco Relay driver uses to transmit commands. Enter the local port. c. Remote IP, Remote Port, Protocol: The remote device is the device the relay unit is physically connected to. If the relay unit is connected to a PelcoNet device, follow the instructions in step (1).
CONFIGURE THE RELAY POINTS TAB Figure 121. Relay Points Tab for CM9760-REL The Relay Points tab lists each relay point in the device and the name and script tag used within VMX300(-E) to refer to the point. The list of relay points also appears in the Device Control dialog box in the VMX300(-E) client. The Relay Points tab allows you to rename points to give them meaningful names. Rename a Relay Point 1. Double-click the point you want to rename. The Edit Point dialog box appears.
CONFIGURE THE DIP SWITCHES TAB Figure 123. DIP Switches Tab for CM9760-REL The DIP Switches tab provides a schematic of the DIP switches located under the front panel of the relay unit. Set the DIP switches in the schematic to match the DIP switch settings on the relay unit. CONFIGURE THE MODEL TAB Figure 124. Model Tab for CM9760-REL The Model tab displays the model of relay unit supported by the Pelco Relay Driver. Only one model is currently supported.
ADD A SERIAL OUTPUT DEVICE The serial output driver can be used to send ASCII commands to an external serial (RS-232) device. For example, you could send ASCII commands to report alarms to an access control system, start a VCR in play mode, or control a camera. Note that the particular device-control commands that are available and the ASCII strings that represent them depend on what is available in the specific device.
CONFIGURE THE PROPERTIES TAB Figure 126. Properties Tab for a Serial Output Device Use the Properties tab to configure the animation settings of the device icon viewed on maps in the VMX300(-E) client. Click Choose next to each condition to select the color settings for that condition. Note that you can configure a different color setting for each serial output device. Unknown state: If the Serial Output Driver cannot open the port on the serial output device, the device icon is the color specified here.
a. Select the VMX300(-E) COM port the serial output device is connected to from the drop-down box. This is the COM port on the workstation that the Serial Output driver runs on. b. The remaining settings should specify 9600 baud, no parity, 8 data bits, 1 stop bit, and no flow control. Internet Protocol Settings Figure 128. Communications Tab for Serial Output Device IP Settings a. Local IP: The local IP is the IP address of the computer that the Serial Output Device driver runs on.
CONFIGURE THE CUSTOM BUTTONS TAB Figure 129. Custom Buttons Tab for Serial Output Device Each custom button that you define for a serial output device appears in the device’s Device Control dialog box in the VMX300(-E) client. The operator can then click the button to send the command(s) associated with the button to the serial output device. Each custom button can have up to two strings associated with it. The mouse down string defines the command that is sent when the custom button is pressed.
Figure 131. Sample Mouse Down String 4. (Optional) Type a Mouse Up string. This is the command that is sent to the serial output device when an operator releases the custom button. Leave this field blank if you do not want a command sent when the button is released. 5. Click OK. The Edit Button dialog box closes. ASCII COMMAND SPECIAL CHARACTERS If a command contains unprintable characters, replace each unprintable character with its three-digit ASCII code between angle brackets.
ADD AN IP DEVICE STATUS MONITOR The IP device status monitor allows you to monitor the status of a networked device. Since almost every other VMX300(-E) device driver allows you to monitor the status of that device, you would only need to use the IP device status monitor to keep track of an IP device that is not in the VMX300(-E) system. When you add an IP device status monitor to the VMX300(-E) system, it acts as a placeholder for the IP device.
CONFIGURE THE PROPERTIES TAB Figure 133. Properties Tab for an IP Device Status Monitor 1. Unit IP Address: Type the IP address of the device you want to monitor. 2. Browse: If the device you are monitoring has an embedded web server, click “Browse to this device” to open the embedded web server in a new window. This provides access to the device’s internal configuration. 3.
ADD AN ACCESS CONTROL DEVICE The access control driver can be used to receive ASCII commands from an external serial (RS-232) device. For example, you could receive ASCII strings from a building access control system, an external alarm system, or an elevator control system. Any device controlled by the Access Control driver is referred to in this document as an access control device.
CONFIGURE THE GENERAL TAB Figure 135. General Tab for an Access Control Device Use the General tab to enter a location name and an optional description. The location name can be a maximum of 31 characters. You cannot use single or double quotation marks in a name, but you can use any other letter, digit, or special character. Location names are not case sensitive. The description appears in the Object Browser beside the device name. CONFIGURE THE PROPERTIES TAB Figure 136.
CONFIGURE THE COMMUNICATIONS TAB 1. Connection Type: Specify the type of connection between the device driver and the access control device. • Direct Serial: The device is connected using an RS-232 to RS-422 converter or using an RS-422 PC serial port. • Internet Protocol: The device is connected to the serial port on a networked device. • Modem: This feature is reserved for future development. 2.
c. Protocol, Remote IP, Remote Port: The remote device is the device the access control device is physically connected to. If the access control device is connected to a PelcoNet device, follow the instructions in step (1). If the access control device is connected to some other kind of device, follow the instructions in step (2). (1) PelcoNet: Select the PelcoNet protocol from the Protocol drop-down box.
Figure 141. Adding Access Control Points For each point that you add, one new read property and one new write property are added to the access control device when you exit the dialog box. Figure 142. Access Control Device Read and Write Properties 2. To customize the number, name, or script tag of a specific point, double-click the point to open the Edit Point dialog box. Refer to Edit an Access Control Point for instructions.
Edit an Access Control Point Edit each access control point so that the point’s number is the same as the point number sent out in the string for that type of alarm. You can also change a point’s name and script tag, or use the generic name and tag assigned by VMX300(-E). 1. Double-click the desired access control point. The Edit Point dialog box opens. Figure 143. Edit Point Dialog Box 2. Type a new point number.
Figure 144. Edited Access Control Points Delete an Access Control Point Click the point that you want to delete, and then click Delete. To select multiple points, hold the Ctrl key down while clicking each point that you want to delete. CONFIGURE PATTERN MATCHING FOR INCOMING ALARM STRINGS Figure 145. Pattern Matching Tab The Pattern Matching tab is used to configure the pattern(s) that incoming alarm strings must match as the first step in identifying alarms to be handled by VMX300(-E).
The Pattern Matching tab allows you to define the following patterns: • Pattern To Match: Use this section to configure the pattern that matches the string that will be sent when an alarm has been tripped. Every access control device must have a Pattern To Match defined for it. When an incoming string matches the Pattern To Match and the point number in the string matches a point number on the Access Control Points tab, VMX300(-E) sets the read property for that point to True.
Create a Custom Pattern as the Pattern to Match Figure 147. Create a Custom Pattern to Match 1. Click the Pattern To Match tab. 2. Click Custom. 3. Type a description of the pattern in the Description field. If you save the pattern to the Predefined Patterns list (step 5), the description will appear beside the pattern in the list. 4. Type the pattern. Refer to Pattern Syntax for information on creating patterns. 5. (Optional) Click Make Pre-defined to the pattern to the Predefined Patterns list.
Create a Custom Pattern as the Reset Pattern to Match Note that you only need to complete these steps if the access control device sends a reset string to indicate that the alarm condition is no longer in place. Figure 149. Create a Custom Reset Pattern to Match 1. Click the Supports Reset Pattern field. 2. Click the Reset Pattern To Match tab. 3. Click Custom. 4. Type a description of the pattern. 5. Type the pattern. Refer to Pattern Syntax for information on creating patterns. 6.
Table C. Symbols Used to Build Patterns SYMBOL MATCHES EXAMPLE \ Marks the following character as a special character or a literal. Special character: \w is a special character that matches any letter, number, or the underscore (see below). Literal: \$ means to ignore the special value of $ and match the literal $. Similarly, \\ matches \ and \( matches (. \w Matches any letter, number, or the underscore. Equivalent to [a-zA-Z0-9_]. ALARM\w matches ALARMx and ALARM9 and ALARM_, etc.
DEFINE ALARMS BASED ON ACCESS CONTROL POINTS The Access Control driver sets a read property to True when it identifies an alarm from an access control device. Any further action by VMX300(-E) depends on alarms and events created by you to detect the change in the read property’s value. Depending on the nature of the alarm, you might want to simply archive a record of the alarm, or you might want to write scripts that perform complex tasks in response to the alarm.
Action: Click Alarm Event Action to open the Alarm/Event Action dialog box. Create scripts to respond to the alarm. One of the scripts must set the point back to False, since the device does not send a reset string. Figure 151. Associate Scripts with the Alarm Refer to Add a New Alarm or Event in the Alarms and Events section for instructions on creating alarms.
Connections Connections map out the analog connections between devices. You must define a connection for every analog connection in the system. This includes analog connections from IP devices. MANAGING CONNECTIONS Source devices and destination devices: Devices that transmit a signal are called source devices. For example, any device with video out, such as a camera, is a source device. Devices that receive signals are destination devices.
Figure 155. Making Connection 3. Add multiple connections: a. Select the source devices you want to connect. To select consecutive devices, select the first device, press and hold the Shift key down, then select the last device. To select nonconsecutive devices, hold the Ctrl key down while selecting. Now select the destination devices you want to connect to the sources. b. Click the Connect button pop-up menu.
b. Move down: To move a destination device down in the list, select the connection and select Tools > Move Down or click the Move Down button . Alternatively, right-click the connection and select Move Down from the pop-up menu. The destination device moves down to connect to the next available source device below it in the list, leaving the source device it was originally connected to unconnected.
Encode video from switcher’s looping inputs: The PelcoNet device encodes video that is from a switcher’s looping inputs. The PelcoNet device’s input is connected to the appropriate looping input on the switcher: NETWORK CAMERA NET4001A MATRIX SWITCHER Figure 158. Encoding Looped Video Decode video to output device: The PelcoNet device decodes video directly from an output device, such as an external monitor.
DVR CONNECTIONS You must define connections that reflect how each DVR is physically connected within the system. If a camera is connected directly to the recorder, define a connection from the camera’s output to the appropriate input on the recorder. The following graphic illustrates a camera connected to Input 1 on a DX8000. Figure 161.
ASCII CONNECTIONS You must define connections that reflect how cameras and output devices are physically connected to the switcher. In addition, if a switcher has looping inputs, you must define connections for the looping inputs. Specifically, you must: • Connect camera output to switcher input. • Connect switcher output to output device input. • Connect looping input to output device input.
Archive Servers Archive servers are used to permanently store information about alarms and events.
Figure 165. Archive Server Options Dialog Box a. MICROSOFT ACCESS: To store archived alarms and events in Microsoft Access files, select Microsoft Access. Select the folder where the archive files will be stored from the drop-down list. You can change the folder at any time without shutting down the archive server. Refer to View Archive Server Status for instructions on selecting a folder once the archive server is running. b.
The bottom pane of the window lists the date range of any queries being made against the archives from the Session Manager. Queries include searches on a particular date or filters being applied. The information on queries is used for diagnostic purposes. 2. Options: To change the folder where the archive files are stored, click Tools > Options. The Options dialog box will open. Navigate to the desired folder and click OK. 3.
Project Properties As part of the server configuration process, you must use the Project Properties dialog box to configure the following conditions: • Which ports are used for clients, drivers, and FTP traffic • How you want the server to select switch paths • Whether archive servers and time servers will be configured • Whether the server will be used as a primary server or as a backup server Note that archive servers and backup servers are available only with VMX300-E systems.
To configure a primary server: 1. Server type: The Server Type option is only available under software licenses that support backup servers. Select Primary from the dropdown list. 2. Project name: Type a descriptive name for the project. The project name is at least one character and at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks. By default, the computer name is used as the project name.
2. Project name: Type a descriptive name for the project. The project name is at least one character and at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks. By default, the computer name is used as the project name. The project name for the backup server can be the same as the project name for the primary server. The project name appears at the top of the backup server’s Object Browser.
SWITCHING TAB Figure 170. Switching Tab The Switching tab allows you to specify how you want the server to select the switch path when a user or script accesses a video or audio device. The server uses free paths (paths that are not in use) whenever possible. If there is only one free path, the server uses it automatically.
ARCHIVING TAB Figure 171. Archiving Tab The Archiving tab allows you to define archive servers for recording alarms and events. Note that archive servers are available only with VMX300-E systems. Only alarms and events that belong to an alarm/event category that has archiving turned on are recorded. Refer to Alarms and Events - Alarm/ Event Categories - Add a New Alarm/Event Category for instructions on turning archiving on.
DATE/TIME TAB Figure 173. Date/Time Tab The Date/Time tab allows you to configure a time server for the VMX300(-E) server to synchronize to. 1. Add: To add a time server, click Add. The Add Time Server dialog box opens. Figure 174. Add Time Server Dialog Box Type the time server’s host name or IP address, and port number. Click OK. 2. Select time servers: The VMX300(-E) server will not attempt to synchronize to any time server whose check box is not checked.
E-MAIL TAB Figure 175. E-mail Tab The E-mail tab allows you to specify an e-mail server so that alarm/event recipients can be notified of alarms and events by email. In order to notify recipients via e-mail the following criteria must be met: • Recipients must have an e-mail address configured in their user settings. Refer to the Users section for information on configuring user accounts.
CONFIGURE FIREWALL SETTINGS (1) Click Firewall. The Firewall Settings dialog box appears. (2) Select the type of firewall from the Type of Firewall drop-down box. (3) Type the address of the firewall host; type either a web address, such as “www.fwallhost.com” or an IP address. (4) Type the firewall host’s listening port in the Port field. (5) If the firewall host requires a user name and password, complete the Username and Password fields. (6) Click OK. The Firewall Settings dialog box closes.
User Groups User groups are a security feature. A user group embodies a set of privileges, called group permissions, that are granted to every member of the group. These permissions delineate which parts of the VMX300(-E) software group members can access. To limit a user’s access to the software, restrict the user’s permissions. Setting up user groups requires forethought about what tasks you want different users to do.
Figure 176. Group Permissions FIXED CAMERA PERMISSION Figure 177. Fixed Camera Permission Each Fixed Camera device that you configure appears in the Group Permissions list under Devices. Table E. Fixed Camera Permission 142 PERMISSION ENABLES USER TO Can view device icons on client Make Fixed Camera device icons visible in the client and list the device in the Device List.
PTZ PERMISSIONS Each Pelco PTZ camera that you configure appears in the Group Permissions list under Devices. Figure 178. PTZ Permissions Table F. PTZ Camera Permissions PERMISSION ENABLES USER TO Can access device control dialog Access the camera’s Device Control dialog box in the VMX300(-E) client. This permission includes the ability to control the camera’s auxiliaries. Can lock device Lock the camera in the client, preventing users and scripts with lower priority from controlling the camera.
PELCONET DEVICE PERMISSIONS Figure 179. PelcoNet Device Permissions Each PelcoNet device you configure appears in the Group Permissions list under Devices. Table G. PelcoNet Device Permissions PERMISSION ENABLES USER TO Can access device manager dialog Access device properties in the VMX300(-E) server. Can access device control dialog Access device controls in the VMX300(-E) client.
DX8000 PERMISSIONS Each DX8000 device that you configure appears in the Group Permissions list under Devices. DX8000 Recorder Permissions Table I. DX8000 Recorder Permissions PERMISSION ENABLES USER TO Can access device control dialog Access the recorder’s Device Control dialog box in the VMX300(-E) client. Can lock device Do not use this permission; it is reserved for future use. Can control device Do not use this permission; it is reserved for future use.
DX9000 PERMISSION Each DX9000 device that you configure appears in the Group Permissions list under Devices. Figure 182. DX9000 Permission Table K. DX9000 Permission PERMISSION ENABLES USER TO Can view device icons on client Make DX9000 icons visible in the client and list the DVR in the Device List. ASCII DEVICE PERMISSIONS Each ASCII device that you configure appears in the Group Permissions list under Devices. ASCII Switcher Permissions Figure 183. ASCII Switcher Permissions Table L.
ASCII Camera Permissions Figure 184. ASCII Camera Permissions Table M. ASCII Camera Permissions PERMISSION ENABLES USER TO Can access device control dialog Access the camera’s Device Control dialog box in the VMX300(-E) client. This permission includes the ability to control the camera’s auxiliaries. Can lock device Lock the camera in the client, preventing users and scripts with lower priority from controlling the camera.
CM9760-REL PERMISSIONS Each CM9760-REL relay interface unit that you configure appears in the Group Permissions list under Devices. Figure 185. CM9760-REL Permissions Table P. CM9760-REL Permissions PERMISSION ENABLES USER TO Can access device control dialog Access the relay unit’s Device Control dialog box in the VMX300(-E) client. This permission alone allows the user to view, but not use, the controls available through the Device Control dialog box.
Table Q. Serial Output Device Permissions PERMISSION ENABLES USER TO Can access device control dialog Access the serial output device’s Device Control dialog box in the VMX300(-E) client. This permission alone allows the user to view, but not use, the controls available through the Device Control dialog box. In combination with the “Can control device” permission, this permission allows the user not only to view the controls, but also to use them.
ADD A NEW USER GROUP Once you have created a new user group, you can then make any new or existing user a member of the group. There is one exception: groups that grant the “Can configure software” permission are not available to users who can manage users but cannot configure software. This prevents users who can manage users but cannot configure software from giving themselves software configuration privileges. You can create a new user group from scratch or you can base new groups on an existing group.
EDIT A USER GROUP To change the properties of an existing user group: 1. Navigate the Object Browser to [project name] > User Groups. In the right pane, double-click the user group you want to change, or rightclick the group and select Edit from the pop-up menu. The Edit Group Properties dialog box opens. Figure 188. Edit Group Properties Dialog Box 2. Change the properties of the user group as desired. Refer to Add a New User Group for more information. 3. Click OK.
Users The parts of the VMX300(-E) software a particular user has access to are determined by which user groups the user belongs to. Refer to User Groups - Group Permissions for more information. PREDEFINED USER ACCOUNTS THE PREDEFINED ADMINISTRATOR ACCOUNT VMX300(-E) provides a predefined administrator account that allows you to configure the server.
ADD A NEW USER You can create new users from scratch or you can base new users on an existing user. To create a new user based on an existing user, make a copy of the existing user and then edit the copy. Refer to Pop-Up Menus in the Appendix for information on using Copy and Paste or Paste Many to make copies of objects. To create a new user from scratch: 1. Navigate the Object Browser to [project name] > Users.
10. Import: The Import option is only available with VMX300-E Systems. The Import option allows you to import user accounts from other servers. If you have configured a server tie to share video with a remote server, import the accounts of remote users who will be viewing your video. Refer to Server Ties for more information. Only the user name, password, full name, and description are imported. Membership in user groups and priority are left for you to fill in.
EDIT A USER To change the properties of an existing user: 1. Navigate the Object Browser to [project name] > Users. In the right pane, double-click the user you want to change, or right-click the user and select Edit from the pop-up menu. The Edit User Properties dialog box opens. Figure 191. Edit User Properties Dialog Box 2. Change properties of the user as desired. Refer to Add a New User for information on specific properties. 3. Click OK. The Edit User Properties dialog box closes.
Maps Maps provide VMX300(-E) operators with a graphical representation of the site they are monitoring, complete with installed devices such as cameras and video recorders. VMX300(-E) provides tools to create links between maps and to customize maps with icons that represent installed equipment and alarms. The first time you start the server, no maps are listed in the Object Browser. You must individually add each map you want to make available to VMX300(-E) operators.
ADD A NEW MAP 1. Navigate the Object Browser to [project name] > Maps. Double-click in the right pane, or right-click Maps in the left pane and select Add New from the pop-up menu. The Add New Map dialog box opens. Figure 192. Add New Map Dialog Box 2. Name: Type a unique, descriptive name for the map you want to add. Map names are at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks.
NOTE: To have a named view as the client map loading default: 1. Add the map. 2. Create the named view. 3. Edit the map and change the Client Map Loading setting to “Load map to a named view.” TIP: If you want to use the name of the map file as the map name, browse for the map file before typing in the name. The server will automatically fill in the name box with the file name and generate a tag based on the name.
CUSTOMIZE YOUR MAPS VMX300(-E) provides a number of tools that allow you to customize your maps: • Place device icons on maps: Place icons representing installed devices on maps, allowing operators to control the devices by clicking the icons. Refer to Device Icons for more information. • Store different views of a map: Create named views that allow operators to quickly focus on a particular view of a map. Refer to Named Views for more information.
Device Settings EDIT A DEVICE’S PROPERTIES A device has certain properties in virtue of being a device of a particular type. These properties are inherited from the device driver. When you add a device, you specify values for these inherited properties. You can also change them after the device has been added by editing the device. In addition to the inherited properties, a device has properties that pertain to how the device is represented within VMX300(-E).
EDIT A DEVICE’S LOCAL SETTINGS A device has certain properties in virtue of being a device of a particular type. These properties are inherited from the device driver and configured when you add the device. You can also change them after the device has been added as described in Edit a Device’s Properties. In addition to the inherited properties, a device has properties that have to do with how the device is represented within VMX300(-E).
c. Background: Select the background you want for the label you are creating. A transparent background allows the underlying map to show through. An opaque background makes the label appear as a colored rectangle. Click Select Color to choose the fill color for an opaque label. d. Border: Specify whether you want the label to have a border around it by selecting None or Single Line. e. Click OK. The Edit Device Label Properties dialog box closes. 3.
VIEW A DEVICE’S READ AND WRITE PROPERTIES Devices have read and write properties that can act as variables in VMX300(-E) scripts and expressions. Read properties: Read properties indicate the state the device is in at a particular time. You can use the device’s read properties in any context that reads the value of a property, but does not change it, such as an alarm/event expression or an IF-THEN command.
Device Icons VMX300(-E) allows you to customize maps by placing icons on them that represent physical devices installed in the field. Judicious placement of device icons provides operators with an easy-to-use visual representation of the installation they are monitoring. Operators can control devices by clicking the icons. Before you can place a device icon for a particular device on a map, you must add the device itself as described in Add a New Device.
SCALE AND ROTATE A DEVICE ICON NOTE: To minimize the CPU workload, device icons should be as small as possible. Changing the size and orientation of a device icon does not affect its position. For information on changing an icon’s position, refer to Move a Device Icon. To change the size or orientation of a device icon: 1. With the desired map loaded, right-click the device icon you want to resize or reorient and select Scale and Rotate from the pop-up menu.
MOVE A DEVICE LABEL You can move a device label independently of the icon itself. To adjust the position of a device label: 1. With the desired map loaded, right-click the device label you want to move and select Move from the pop-up menu. Make sure you position the pointer over the label, not the icon, before right-clicking. 2. Move the pointer to the label’s new location. The label follows the pointer as you move it. The icon does not move. 3.
EDIT A DEVICE LABEL To change the text and formatting of an existing device label: 1. Right-click the label and select Edit Label from the pop-up menu. Make sure you position the pointer over the label, not the icon, before right-clicking. Alternatively, navigate the Object Browser to [project name] > Device Drivers > [device driver name] > Devices. In the right pane, doubleclick Local Settings, then click Edit Label. The Edit Label Properties dialog box opens. Figure 200.
Named Views Named views allow you to save a particular view of a map so an operator can reload it at any time without having to zoom and scroll. You can create as many named views as you want for a map. ADD A NEW NAMED VIEW 1. With the desired map loaded, isolate the view you want to name by zooming and scrolling. 2. Navigate the Object Browser to [project name] > Maps > [map] > Named Views.
LOAD A NAMED VIEW 1. Navigate the Object Browser to [project name] > Maps > [map] > Named Views. In the right pane, click the named view you want to load and hold the mouse button down. If you move the pointer slightly, it changes to a representation of the Earth. 2. Drag the pointer to the map viewport and release the mouse button. The selected view appears in the viewport. UPDATE A NAMED VIEW You can change the view called up by a named view using the Update View option: 1.
Hotlinks A hotlink is an area of a map that, when clicked, runs a script. Hotlinks are generally used to run a script that loads another map, effectively linking the maps. If you want, you can omit the script when creating a hotlink. In this case, the hotlink is for information only, to define an area on a map. ADD A NEW HOTLINK TIPS: • To create a hotlink that is perfectly rectangular, apply a grid to the map. The corner points of the hotlink will snap to the closest grid point.
4. Name: Type a unique, descriptive name for the hotlink you want to add. Hotlink names are at most 50 characters long. They can include any letter, digit or special character, with the exception of single and double quotation marks. Hotlink names are not case sensitive. A tag resembling the hotlink name appears in the Script Tag box. If the hotlink name contains special characters, they are omitted from the tag. Leading digits are removed. Spaces are replaced with underscores. 5.
EDIT A HOTLINK’S PROPERTIES NOTE: If you change the script tag for a hotlink, any script that refers to the hotlink will contain an error. To correct the error, update the scripts so they use the hotlink’s new script tag. Refer to Scripts and Expressions for more information. To change the properties of an existing hotlink: 1. Navigate the Object Browser to [project name] > Maps > [map] > Hotlinks.
MOVE A VERTEX TIP: To make a hotlink perfectly rectangular, apply a grid to the map, then move the vertices to grid points. A vertex will snap to the closest grid point. If you want, turn the grid off after you’ve finished. To move a hotlink’s vertex: 1. Load the map the hotlink is on and click the hotlink. A small circle appears at each of the hotlink’s vertices. 2. Position the pointer over the vertex you want to move. A four-headed arrow appears beside the pointer. 3. Click and hold the mouse key down.
Labels Labels are free-standing descriptive phrases that are placed on maps. You can associate a script with a label, so that when you click the label, the script runs. If you omit the script the label is for information only. For example, you might use a label to identify an item on a map. TIP: Device icons and alarm/event icons have built-in labels associated with them. Built-in labels are for information only; you cannot associate a script with them.
Figure 206. New Label Properties Dialog Box 5. Text: Type up to three lines of text as the label contents. When you place the label on a map, this text will display in the label. Each line of text can be at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks. 6. Text properties: Select the justification you want for the label’s text. All the lines of text will be justified the same.
EDIT A LABEL NOTES: • A label’s properties apply to all instances of the label. When you edit one instance of a label, it changes all other instances of the label. • If you change the script tag for a label, any script that refers to the label will contain an error. To correct the error, update the scripts so they use the label’s new script tag. Refer to Scripts and Expressions for more information. To change the properties of an existing label: 1. Navigate the Object Browser to [project name] > Labels.
SCALE A LABEL To change the size of a label: 1. With the desired map loaded, right-click the label you want to scale and select Scale from the pop-up menu. 2. Scale: Move the pointer closer to the label to make is smaller. Move the pointer away from the label to make it larger. 3. When the label is scaled the way you want it, press the left mouse button. The label’s size freezes.
Scripts and Expressions Use scripts and expressions as tools to automate your system. Scripts and expressions are defined as follows: • Scripts: A script is a custom program written within VMX300(-E). Scripts are used to automate common tasks and to ensure that the correct conditions exist before a particular action takes place. • Expressions: Expressions are used to detect a condition that triggers an action. For example, when the expression associated with a timer becomes true, the timer starts.
VARIABLES AND VALUES Scripts and expressions are made up of variables and values, which are defined as follows: Variables: Object properties act as variables. They are written as follows: [object tag name].[property name] where [object tag name] is an object’s script tag, and [property name] is a property of that particular type of object. For example, the following are all valid variables: Door_Alarm.Value DVR2.CommStatus Alarm_Timer.
PROPERTIES OF OBJECTS Object properties perform the role of variables in VMX300(-E) scripts and expressions. Table T lists the properties different types of objects have and the values each property can take. Since device properties are device-dependent, the specific properties of each device are listed in the tables following Table T. Refer to View a Device’s Read and Write Properties in the Device Settings section for more information on viewing read and write properties. Table T.
FIXED CAMERA PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following table lists Fixed Camera device properties that can be used in scripts and expressions. Table U. Fixed Camera Properties and Values TYPE OF PROPERTY PROPERTY VALUE INDICATES Write Alarm True (1) Set Alarm to True to indicate the device is in an alarm state. Device icons flash in the alarm colors when Alarm is True. False (0) Set Alarm to False to indicate the device is not in an alarm state.
Table V. PTZ Cameras Properties and Values (Continued) TYPE OF PROPERTY Write PROPERTY VALUE INDICATES Preset DontCare When a SET statement with a FOR clause causes a camera to go to a preset, the camera is locked in the preset view for the duration specified in the FOR clause. The lock is automatically released once the specified duration has elapsed. Setting the Preset write property to DontCare releases the lock prior to the specified time, allowing the camera view to be changed immediately.
Table W. PelcoNet Device Properties and Values (Continued) TYPE OF PROPERTY PROPERTY Write RelayOutput Signal source VALUE INDICATES True (1) Close the device’s relay. False (0) Open the device’s relay. PelcoNet_HDD n/a Applies to PelcoNet 350 encoders only. Use in SET statements to assign the source for archived video. Example: SET window1.ArchivedSource = encoder1.PelcoNet_HDD.
DX8000 PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following tables list DX8000 properties that can be used in scripts and expressions. For instructions on creating user-defined presets and patterns for DX8000 cameras, refer to Scripts in the Client Operation Manual. To see newly created presets and patterns in the DX8000 camera’s read and write properties in the Object Browser, you must force the server to update its read/write property lists for that device.
Table AA. DX8000 Camera Properties and Values TYPE OF PROPERTY PROPERTY VALUE INDICATES Read Preset NoPreset The camera’s current view is not the result of a preset. The camera’s current view results from going to this user-defined preset. This value is created when you create the preset. Note that “i” equals the preset number, which can range from 1 to the maximum number available in the camera. Pattern Write Preset NoPattern The camera is not currently running a pattern.
ASCII DEVICE PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following tables list Pelco ASCII device properties that can be used in scripts and expressions. For instructions on creating user-defined presets and patterns for ASCII cameras, refer to Scripts in the Client Operation Manual. To see newly created presets and patterns in the ASCII camera’s read and write properties in the Object Browser, you must force the server to update its read/ write property lists for that device.
KBD300A PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following table lists Pelco KBD300A device properties that can be used in scripts and expressions. Table AD. KBD300A Properties and Values TYPE OF PROPERTY PROPERTY Read Username INDICATES Reserved for internal use by system. Password Reserved for internal use by system. Camera Reserved for internal use by system. Monitor Reserved for internal use by system. Preset Reserved for internal use by system.
CM9760-ALM PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following table lists CM9760-ALM alarm unit properties that can be used in scripts and expressions. Table AE. CM9760-ALM Properties and Values TYPE OF PROPERTY PROPERTY Read Status Alarm Point_iii VALUE INDICATES CommLoss The device driver cannot communicate with the device. Normal The device is in its normal state. Unknown The communications status between the device driver and the device cannot be determined.
CM9760-REL PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS The following table lists CM9760-REL relay interface unit properties that can be used in scripts and expressions. Table AG. CM9760-REL Properties and Values TYPE OF PROPERTY PROPERTY Read Status Alarm Point_iii Write Alarm Point_iii VALUE INDICATES CommLoss The device driver cannot communicate with the device. Normal The device is in its normal state.
SERIAL OUTPUT DEVICE PROPERTY EXPOSED FOR SCRIPTS AND EXPRESSIONS The following table lists the serial output device property that can be used in scripts and expressions. NOTES ON USING SPECIAL ASCII CHARACTERS IN SCRIPTS AND EXPRESSIONS: If a command contains unprintable characters, replace each unprintable character with its three-digit ASCII code between angle brackets. For example, the command BLACK-HOT is represented in VMX300(-E) as BLACK-HOT<013>.
CURRENT STATUS: VIEW RUN-TIME VALUES OF VARIABLES When the server is running, you can check the value of read property variables using the Current Status option. 1. Right-click the VMX300(-E) icon in the Windows server tray and select Current Status from the pop-up menu. The Current Status window opens. Variable names are listed alphabetically. Scroll to find the variables whose value you want to find out. Figure 208. Current Status Window 2. Click Close. The Current Status window closes.
Table AM. Logical Operators OPERATOR MEANING ~ unary not & or AND and | or OR or EXAMPLE ~ (Date.DayOfWeek = Date.Friday) (Date.DayOfWeek = Date.Monday) & (Date.IsHoliday = False) (Camera1.CommStatus = Camera1.OffLine) OR (Camera2.CommStatus = Camera2.OffLine) STATEMENTS A script is made up of one or more statements. A statement is made up of a command and possibly some arguments. Each statement occupies one line in a script, with the exception of the IF statement, which spans two or more lines.
Table AN. Script Commands (Continued) Optional arguments are in parentheses. Refer to Properties of Objects for valid properties and values of different types of objects. COMMAND ACTION Load LOAD
MECHANICS OF EDITING SCRIPTS AND EXPRESSIONS You can create and edit scripts and expressions by directly typing the code or by using the script wizard and expression wizard. In either case, context-sensitive help is available to help you create error-free code. KEYSTROKE EDITING Use the keystrokes listed in Table AO to edit your scripts. These are also available from a pop-up menu by right-clicking the line of code you want to edit. Figure 209. Keystroke Editing Table AO.
CONTEXT-SENSITIVE HELP FOR SCRIPTS To help you write error-free scripts, VMX300(-E) provides context-sensitive help in the form of pop-up lists. Select an item in the pop-up list and press Enter to enter the item into the current line. Use pop-up lists as follows: • At the beginning of a new line, press Ctrl-Space Bar to open a pop-up list of commands. Figure 210. Opening a List of Commands • After a command, press the space bar once to open a pop-up list of items that can occur as an argument.
CONTEXT-SENSITIVE HELP FOR EXPRESSIONS To help you write error-free expressions, VMX300(-E) provides context-sensitive help in the form of pop-up lists. To use pop-up lists, complete the following steps: 1. Click the expression editor button next to the Expression field (in either the Add New Timer dialog box or the Add New Alarm or Event dialog box). Figure 213. Clicking the Expression Editor Button The Expression Editor dialog box appears, as shown in Figure 214. 2.
Figure 215. Context-Sensitive Help for Object Properties • After a condition operator, press Space Bar to open a pop-up list of valid property values. Figure 216.
THE EXPRESSION WIZARD The expression wizard helps you write an expression for a timer or alarm by stepping you through its creation, providing you with valid options for each part of the expression as needed. To use the expression wizard, complete the following steps: 1. Click the wizard button. This button is located next to the Expression field in either the Add New Timer dialog box or the Add New Alarm or Event dialog box, and it is also available from the Expression Editor dialog box. Figure 217.
THE SCRIPT WIZARD The script wizard helps you write a script statement by stepping you through its creation, providing you with valid options for each part of the statement as needed. Since the script wizard creates a single statement, you must re-invoke the wizard for every statement you want help with. To write a statement using the script wizard: 1. Add or edit the object whose script you want to write. 2. Click the line where you want the new statement to be placed.
SYNTAX ERROR-CHECKING VMX300(-E) checks the syntax of each line of a script as you enter it. If an error is detected in a line, the text for the line is displayed in red. For help in identifying the error, position the pointer over the line with the error. This opens hover help containing an error message and information on command syntax. Figure 221.
EXAMPLE SCRIPTS EXAMPLE 1: INITIALIZATION SCRIPT The following script loads a map into the map viewport and sets the video source for each of three custom windows. Since this is a global script, any operator with permission to run the script can run it from the client. The script affects only the client it is run on. Figure 223. Initialization Script EXAMPLE 2: CAMERA SEQUENCE The following script implements a sequence that sends cameras to presets.
EXAMPLE 3: ALARM LOCATION SCRIPT The following alarm scripts highlight an area on a map when the alarm is triggered, then return the area to its normal appearance once the alarm has been acknowledged. The scripts use a hotlink called Area51 to do this. The On Event script changes the hotlink’s normal and mouse hover colors to red and makes the hotlink background visible by giving it a transparency of 10%.
Global Scripts Global scripts are scripts that can be run from other scripts using the RUN or CALL command. This distinguishes them from the scripts associated with labels, hotlinks, timers, prompts, and alarms and events, which cannot be run from other scripts. If there is an action you want performed by more than one script, define the action in a global script and call it from the other scripts as needed.
EDIT A GLOBAL SCRIPT NOTE: If you change the script tag for a global script, all the scripts that run the global script will contain an error. To correct the error, update the scripts so they use the global script’s new script tag. 1. Navigate the Object Browser to [project name] > Global Scripts. In the right pane, double-click the global script you want to change, or right-click the global script and select Edit from the pop-up menu. The Edit Global Script Properties dialog box opens. Figure 227.
Global Tags A global tag is a Boolean variable that can be used in any script or expression, including both local scripts, such as those defined in hotlinks, labels, schedules, and alarms and events, as well as global scripts. Global tags are used in the same way other Boolean variables are. They can be assigned a value using the SET statement, and compared to a value in an IF statement. Refer to Scripts and Expressions for more information. TIP: Use global tags to implement script return values.
DELETE A GLOBAL TAG Deleting a global tag is irreversible. If you delete a global tag and then change your mind, you must add a new global tag. Also note that if you delete a global tag, any script that refers to the global tag will contain an error. 1. Navigate the Object Browser to [project name] > Global Tags. In the right pane, right-click the global tag you want to delete and select Delete from the pop-up menu. The Confirm dialog box opens. 2.
Prompts Prompts are custom dialog boxes used to elicit input from the operator or to inform the operator of something. When you create a prompt, you specify the text of the prompt and up to five buttons for the operator to click in response to the prompt text. If you want, you can define scripts for one or more of the buttons. You can also set a timer to automatically click one of the buttons if the operator does not respond within a certain amount of time. You must configure at least one button.
5. Prompt text: Type the text of the prompt. Prompt text can include any letter, digit or special character, with the exception of single and double quotation marks. Press Shift-Enter or Ctrl-Enter to go to a new line, or let the text wrap automatically. The text appears in the main part of the dialog box when the prompt is displayed on the VMX300(-E) client. It is often phrased as a question, with possible answers to the question appearing on the buttons the operator clicks in response.
11. Preview: To see what the dialog box you have defined looks like, click Preview. The dialog box opens. To close the dialog box, click one of its buttons. Figure 233. Preview of Dialog Box 12. Click OK. The Add New Prompt dialog box closes and the new prompt is created. The name and script tag of the new prompt appear in the right pane of the Object Browser. NOTE: When you edit a prompt’s script, make it available in its updated form by saving the server configuration before attempting to run the script.
DELETE A PROMPT Deleting a prompt is irreversible. If you delete a prompt and then change your mind, you must add a new prompt. Also note that if you delete a prompt, any script that refers to it will contain an error. 1. Navigate the Object Browser to [project name] > Prompts. In the right pane, right-click the prompt you want to delete and select Delete from the pop-up menu. The Confirm dialog box opens. 2. If you are sure you want to delete the prompt, click Yes.
Timers Timers are used to delay an action by a predetermined length of time. Timers themselves cannot run scripts, but you can use a timer to trigger a script to run. Expression: Every timer has an expression associated with it. Whenever something happens that could affect the value of the expression, the expression is evaluated. If the expression becomes true as a result of the event, the timer starts counting down.
ADD A NEW TIMER 1. Navigate the Object Browser to [project name] > Timers. Double-click in the right pane, or right-click Timers in the left pane and select Add New from the pop-up menu. The Add New Timer dialog box opens. Figure 235. Add New Timer Dialog Box 2. Name: Type a unique name for the timer you want to add. Timer names are at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks.
EDIT A TIMER NOTE: If you change the script tag for a timer, any script that refers to the timer will contain an error. To correct the error, update the scripts so they use the timer’s new script tag. Refer to Scripts and Expressions for more information. 1. Navigate the Object Browser to [project name] > Timers. In the right pane, double-click the timer you want to change, or right-click the timer and select Edit from the pop-up menu. The Edit Timer Properties dialog box opens. Figure 236.
Schedules Schedules allow you to define scripts that execute at a scheduled time. If you want, you can specify a recipient group to be notified when the scheduled action executes. Refer to Recipient Groups for instructions on creating a recipient group. ADD A NEW SCHEDULE 1. Navigate the Object Browser to [project name] > Schedules. Double-click in the right pane, or right-click Schedules in the left pane and select Add New from the pop-up menu. The Add New Schedule dialog box opens.
c. Daily: To have the scheduled action execute certain days of the week, click Daily. Click Which Days to specify which days of the week you want the action to execute. The Daily Schedule dialog box opens. Figure 238. Daily Schedule Dialog Box Select days individually or use the buttons to select and deselect multiple days at once. All selects all seven days of the week. Clear clears all seven days of the week. Weekday selects Monday through Friday only. Weekend selects Saturday and Sunday only.
g. By seconds: If you want the scheduled action to execute every few seconds, click By Seconds. In the Every area, type in the number of seconds you want to elapse before the action next executes, up to a maximum of 59 seconds. Fractional amounts will automatically be rounded. h. Once: If you want the scheduled action to execute once only on a predetermined day at a predetermined time, click Once. Type the date in directly, or select it from the drop-down calendar.
a. Recipient group: Select the recipient group from the drop-down list. If you have not created the recipient group yet, finish adding the new schedule, create the recipient group, then edit the schedule to assign the recipient group. Refer to Recipient Groups for information on creating recipient groups. To send notification simultaneously to every operator configured on that server who is logged in, select the predefined recipient group All Users. Select if you do not want anyone to be notified.
EDIT A SCHEDULE 1. Navigate the Object Browser to [project name] > Schedules. In the right pane, double-click the schedule you want to change, or right-click the schedule and select Edit from the pop-up menu. The Edit Scheduled Action Properties dialog box opens. Figure 241. Edit Scheduled Action Dialog Box 2. Change properties of the schedule as desired. Refer to Add a New Schedule for information on specific properties. 3. Click OK. The Edit Scheduled Action Properties dialog box closes.
Alarms and Events TIP: Refer to Alarms and Events and Session Manager in the VMX300(-E) Client Operation Manual for additional information on how alarms and events behave in the client. Alarms and events are actions that are executed when specific conditions occur within the system. As system administrator, you define the condition that triggers an alarm or event.
If an alarm or event is triggered more than once in quick succession, a new entry appears in the recipient’s Session Manager each time the alarm or event is triggered. If the alarm or event has a sound, the sound will play each time the alarm or event is triggered, unless you have selected “Silence subsequent events.
ACCESS ALARMS AND EVENTS DEFINED ON ANOTHER SERVER You can access alarms and events defined on another server using the remote server driver feature. Remote server drivers appear as device drivers in the Object Browser, and are added, edited, and deleted the same way device drivers are. There is a remote server driver for every server that is running. Refer to Device Drivers for instructions on adding a remote server driver.
ALARM/EVENT CATEGORIES ADD A NEW ALARM/EVENT CATEGORY 1. Navigate the Object Browser to [project name] > Alarms and Events. Double-click in the right pane, or right-click Alarms and Events in the left pane and select Add New from the pop-up menu. The Add New Category dialog box opens. Figure 243. Add New Category Dialog Box 2. Name: Type a unique, descriptive name for the alarm/event category you want to create.
d. Send action to all: If you want to send notification simultaneously to every member of the recipient group who is logged in when an alarm or event in this category is triggered, select “Send action to all available user/groups.” In this case, the order of the members in the recipient group’s Members list is irrelevant. e. Notify via E-mail: If you want recipients to be sent an e-mail message notifying them when an alarm or event in this category is triggered, click this field.
To limit the system’s treatment of an alarm or event that is triggered multiple times in quick succession, select “Suppress subsequent alarms.” The first time the alarm or event is triggered, an entry will appear in the Session Manager and the sound will play. No additional entries will appear nor sounds play until the alarm or event has been acknowledged. The next time the alarm or event is triggered, a new entry will appear and the sound will play.
ALARMS, EVENTS, AND NORMAL OCCURRENCES ADD A NEW ALARM OR EVENT 1. Navigate the Object Browser to [project name] > Alarms and Events > [alarm/event category]. Double-click in the right pane, or right-click the desired alarm/event category in the left pane and select Add New from the pop-up menu. The Add New Alarm or Event dialog box opens. Figure 245. Add New Alarm or Event Dialog Box 2. Name: Type a unique, descriptive name for the alarm or event you want to create.
Figure 246. Edit Label Properties Dialog Box a. Text: Type up to three lines of text as the label contents. When you place the alarm/event icon on a map, this text will display in the label. Each line of text can be at most 50 characters long and can include any letter, digit or special character, with the exception of single and double quotation marks. b. Text properties: Select the justification you want for the label’s text. All the lines of text will be justified the same.
Figure 247. Synchronizing DVR with Server b. Run an archive server: This ensures that alarms and events can be recorded. First launch the archive server. Refer to Archive Servers for instructions. Then add the archive server to the server configuration using the Archiving tab of the Project Properties dialog box. Select the archive server. Refer to Project Properties for instructions on adding and selecting archive servers. Figure 248. Running an Archive Server c.
Figure 249. Activating Archiving To associate a source device with an alarm or event complete the following steps: a. Edit the alarm or event: Add or edit the alarm or event you want to associate with a source device. Refer to Alarms, Events, and Normal Occurrences for instructions. b. Associate the source device: Select Associate source with this alarm/event. Select the desired source device from the drop-down box. Figure 250. Associating a Source Device 7.
Figure 251. Entering Expression 8. Action: If you want to associate one or more scripts with the alarm or event, click Alarm Event Action. The Edit Alarm/Event Action dialog box opens. Figure 252. Edit Alarm/Event Action Dialog Box You can define an On Event script that runs when the alarm or event is triggered, an On Operator Replay script that runs when a recipient replays the alarm or event, and/or an On Acknowledge script that runs when a recipient acknowledges the alarm or event.
EDIT AN ALARM OR EVENT NOTE: If you change the script tag for an alarm or event, any script that refers to the alarm or event will contain an error. To correct the error, update the scripts so they use the alarm or event’s new script tag. Refer to Scripts and Expressions for more information. 1. Navigate the Object Browser to [project name] > Alarms and Events > [alarm/event category name]. In either pane, right-click the alarm or event you want to edit and select Edit from the pop-up menu.
ALARM/EVENT ICONS VMX300(-E) allows you to customize your maps by placing icons on them that represent the alarms and events configured on your server. Icons are an effective way to alert a recipient visually that an alarm or event has been triggered, and then acknowledged. • When the alarm or event is triggered, the icon changes to the alarm color. • When the alarm or event is acknowledged, the icon changes back to the default color.
SCALE AN ALARM/EVENT ICON NOTE: To minimize the CPU workload, icons should be as small as possible. Changing the size of an alarm/event icon does not affect its position. For information on changing an icon’s position, refer to Move an Alarm/ Event Icon. 1. With the desired map loaded, right-click the alarm/event icon you want to resize and select Scale from the pop-up menu. Make sure you position the pointer over the icon, not the label. Figure 254. Changing Icon Size 2.
MOVE AN ALARM/EVENT LABEL You can move an alarm/event label independently of the icon itself. 1. With the desired map loaded, right-click the label you want to move and select Move from the pop-up menu. Make sure you position the pointer over the label, not the icon, before right-clicking. 2. Move the pointer to the label’s new location. The label follows the pointer as you move it. The icon does not move. 3. When the label is located where you want it, press the left mouse button.
EDIT AN ALARM/EVENT LABEL 1. Right-click the alarm/event label, and select Edit Label from the pop-up menu. Make sure you position the pointer over the label, not the icon, before right-clicking. Alternatively, navigate the Object Browser to [project name] > Alarms and Events > [alarm/event category name]. In the right pane, doubleclick the desired alarm or event, or right-click the alarm or event and select Edit from the pop-up menu, then click Edit Label. The Edit Label Properties dialog box opens.
Recipient Groups Recipient groups define which operators are notified of scheduled actions and alarms and events. Recipients are notified through the Session Manager. In addition, if you have associated scripts with the scheduled action or alarm or event, the scripts will be run on the recipient’s workstation. To receive notification, an operator who is listed as a recipient must be logged in when the scheduled action or alarm or event occurs.
ADD A NEW RECIPIENT GROUP When you create a new recipient group, the group automatically appears in the Recipients list of every alarm/event category and schedule. You can then select that recipient group for any new or existing schedule or alarm or event. You can create a new recipient group from scratch or you can base new groups on an existing group. To create a new recipient group based on an existing group, make a copy of the existing group and then edit the copy.
EDIT A RECIPIENT GROUP To change the properties of an existing recipient group: 1. Navigate the Object Browser to [project name] > Recipient Groups. In the right pane, double-click the recipient group you want to change, or right-click the group and select Edit from the pop-up menu. The Edit Recipient Group Properties dialog box opens. Figure 259. Edit Recipient Group Properties Dialog Box 2. Change the properties of the recipient group as desired.
Server Ties NOTE: Server ties are available only with VMX300-E systems. Share signals: Server ties enable one server to share signals, such as video or audio, with another server. For example, if you have a camera configured on one server, and you want to view the camera’s video on a destination (for example, external monitor or custom window) configured on a different server, you must define a server tie.
Figure 261. Server A’s Devices By default, a remote device’s script tag ends with “_RS”, to indicate “Remote Server”. To edit the device’s script tag, edit the device’s local settings. Refer to Devices - Edit a Device’s Local Settings for instructions. TIP: Use context-sensitive help or the script wizard to write scripts involving remote servers. VMX300(-E) will provide you with a pop-up list of script tags referring to remote servers and their devices and alarms, in context.
By default, a remote server’s script tag ends with “_Server”. For example, if the remote server is called EMO-3, its script tag is EMO-3_Server. To edit the server’s script tag, edit the server’s local settings. Refer to Devices - Edit a Device’s Local Settings for instructions. Script tags for remote alarms and events appear in the Object Browser. Suppose Server A (EMO-3) has an external door alarm that triggers an alarm, Door Alarm, that directs the camera at the door.
c. Create connection: If you are sharing analog signals, create a connection from the signal source’s output to the server tie. Refer to Connections for instructions. Figure 264. Creating Connection for Server A d. Add clients: Add each client that will access Server A’s video from Server B. Refer to Clients, Custom Windows, and Canvases Clients - Add a New Client for instructions. Do not add custom windows to the clients. e.
VMX300(-E) provides a Browse All function that allows you to select a remote server driver from a list of running drivers. Refer to Device Drivers - Add a New Device Driver for instructions on browsing drivers. Select the desired remote server driver and click OK. Figure 266. Selecting a Remote Server Driver The remote server driver appears in the Object Browser. Expand the list to view the remote server’s devices and alarms and events. Figure 267. Viewing Devices, Alarms, and Events c.
d. Add clients, custom windows, and canvases: If you have not already done so, add each client that will access Server A’s video. If signals from Server A are going to be viewed in a custom window, add the window and configure the appropriate type of canvas for the window. Refer to Clients, Custom Windows, and Canvases for instructions. e. Save configuration: Exit configuration mode and save Server B’s configuration. Refer to Starting and Stopping the Server for instructions. f.
EDIT A SERVER TIE 1. Navigate the Object Browser to [project name] > Server Ties. In the right pane, double-click the server tie you want to change, or right-click the server tie and select Edit from the pop-up menu. The Edit Server Tie Properties dialog box opens. Figure 270. Edit Server Tie Properties Dialog Box 2. Change the properties of the server tie as desired. Refer to Add a New Server Tie for information on specific properties. 3. Click OK. The Edit Server Tie Properties dialog box closes.
FTP Sites FTP (File Transfer Protocol) is a set of communication rules that allow two computers to exchange files over a network. The FTP image capture feature allows you to capture live video in a custom window and upload the image file to an FTP server, such as a Web host. The action of capturing and uploading an image is controlled through the FTP script command.
(1) Address: In the Host name or IP address box, type in the address of the remote host you will be uploading images to. You can type in the remote host’s Web address, such as www.webhost.com, or IP address, or, if the host is on your local network, the computer name. (2) Port: Type the port the remote host opens to FTP traffic. Port 21 is the standard FTP port. (3) User name: Type the user name you enter to upload files to the remote host.
EDIT AN FTP SITE 1. Navigate the Object Browser to [project name] > FTP Sites. In the right pane, double-click the FTP site you want to change, or right-click the FTP site and select Edit from the pop-up menu. The Properties dialog box opens. Figure 273. Edit FTP Site Properties Dialog Box 2. Change the properties of the FTP site as desired. Refer to Add a New FTP Site for information on specific properties. 3. Click OK. The Properties dialog box closes.
The camera is locked during the delay. An operator who is viewing the camera’s gadget or Device Control dialog box when the FTP delay occurs will see the Lock button change to yellow, indicating that the camera is locked by a script. For information on the Lock button, refer to the appropriate camera Driver Notes in the VMX300(-E) Client Operation Manual. File name: FTP image files are JPG files. The file name should end with “.jpg”.
Example: The following example illustrates an FTP sequence defined in a global script that is run from a schedule. The sequence starts with an ON ERROR RESUME NEXT command, to ensure that, in the event that an FTP command fails, the next statement will execute. Every time the global script is run by the schedule, VMX300(-E) executes every statement, including any statement that failed the last time it was run. Image captures in this sequence are taken between 5 AM and 7 AM only.
Database Utilities VMX300(-E) provides the following database utilities: • Backup, which creates a backup of the server database. • Restore, which restores a backup of the server database. BACKUP A DATABASE Use the Backup utility to create a backup of the server database and to save backup databases to alternative media (such as a CD). NOTE: The Backup utility backs up the server database only.
RESTORE A DATABASE NOTE: If you have to restore a database, it is very important to select the correct backup file. VMX300(-E) creates an automatic database backup file every time you launch the server in run mode, but you should be using the Backup utility to make backup files on a regular basis, rather than relying on these backup files. To restore a database from a backup: 1. Click Tools > Database Utilities > Restore. The Restore Database dialog box opens. Figure 276. Restore Database Dialog Box 2.
System Logs VMX300(-E) maintains a log of system activities for diagnostic purposes. Activities fall into three categories: • System: Background activities that are not seen by users, such as opening sockets and compiling scripts. • Administrative: Server configuration mode activities. • Operational: Activities initiated in the client, such as operator-initiated changes to a device’s controls or acknowledgement of an alarm or event.
Appendix ADJUSTING THE DISPLAY ADJUST THE OBJECT BROWSER DISPLAY When the Object Browser is docked, you can adjust its width. Position the pointer over the border that abuts the map viewport. When the pointer changes to a double-headed resizing pointer, drag the border to the right or left. As you change the width of the Object Browser, the map viewport automatically adjusts to fill the available space.
RESIZE WINDOWS Many windows can be resized, including the Configuration window, the Object Browser window, and some dialog boxes. You cannot resize a window when it is maximized, that is, when it fills the entire screen. If you want to resize a window that is maximized, first reduce it by clicking the Restore Down button in the right corner of the title bar, or double-click the title bar. In order to resize the Object Browser, you must undock it first.
USE COPY AND PASTE TO CREATE A NEW OBJECT The Copy and Paste options are useful for creating an object that has similar attributes to an existing object. For example, if you want to create a prompt that has the same button set-up as an existing prompt, you can save yourself from having to re-create the buttons by using Copy and Paste to copy the prompt, then editing the prompt information and text. NOTE: Copy and Paste cannot be used for maps, hotlinks, named views, device drivers, and certain devices. 1.
C1553M-B (4/05)
PRODUCT WARRANTY AND RETURN INFORMATION WARRANTY Pelco will repair or replace, without charge, any merchandise proved defective in material or workmanship for a period of one year after the date of shipment. Exceptions to this warranty are as noted below: • Five years on FT/FR8000 Series fiber optic products. • Three years on Genex ® Series products (multiplexers, server, and keyboard).
Worldwide Headquarters 3500 Pelco Way Clovis, California 93612 USA USA & Canada Tel: 800/289-9100 Fax: 800/289-9150 International Tel: 1-559/292-1981 Fax: 1-559/348-1120 www.pelco.
