CTP. ver. Page 0

Transcription

1 ConvergenceTP, LLC CTP DSX Driv ver Install and Use Guide, Version Page 0

2 DSX_OnSSI Integration Install and Use Guide Preface: As part of the ConvergenceTP (CTP) family of Bridge products the CTP DSX Driver provides the interface between the OnSSI Ocularis CS platform, as well as NetDVMS and RC C recording servers, and the DSX Access Control system. This interface between, or bridge, enables the DSX system to call in both live and recorded camera streams from the OnSSI video management systems mentioned above. Individual camera streams, as well as multiple camera streams (up to 4) on a single camera view request, can easily be called into the DSX Access Control application using the standard camera interface component provided by the DSX application. The CTP DSX Driver meets the complete DSX camera interface specification including user support for PTZ preset selection. Note1 :.Net framework requirement The CTP DSX Driver require requires Microsoft.Net framework 4.0 on both the clients where the CTP DSX driver is loaded as well as the server running Ocularis Base. Note2: CTP seed generator program used to license the CTP DSX Driver By default the CTP DSX Driver client program runs without any registration requirement needed but will expire in 30 days from first use and cannot be reloaded. In order to license the client for use after the 30 day period a seed generation program suppllied by CTP needs to be run on the Ocualris base server, or NetDVMS/RC C Master recording server, and the resultant seed then needs to be sent to CTP. Unpon receipt of the seed key CTP will then issue a CTPLicenseServer.lic file to be loaded in the root C:\ folder of the Ocularis, or NetDVMS/RC C server. Once the OnSSI video server is licensed the user is free to run as many copies of the CTP DSX Driver in their enterpise as they wish. If the install is for a NetDVMS or RC C recording server without Ocularis then the seed generator program must be run on the recording server designated as the Master in the master/slave chain. See also: Pre Install procedure: (licensed installs only, not needed for demos) Note3: Install folder requirement The CTP DSX Driver.exe MUST be installed in the same directoy as the DSX application. Specifically the same folder as the the DSXDVR.exe file. Typically c:\windsx For more information about the CTP DSX Driver visit: Page 1

3 Table of Contents Preface:... 1 Note1 :.Net framework requirement... 1 Note2: CTP seed generator program used to license the CTP DSX Driver... 1 Note3: Install folder requirement... 1 Software Install Procedure possible install scenarios ) 30 Day full featured demo install ) 30 Day full demo upgrade to licensed copy ) Licensed copy install... 3 Pre Install procedure: (licensed installs only, not needed for demos)... 4 Pre install seed key generation... 5 Figure CTP DSX Driver Install Wizard... 6 Begin OnSSI SDK Install Process... 9 Final step for installer Camera Setup in WinDSX Single camera setup Miltiple camera setup (up to 4) Pan Tilt Zoom (PTZ) preset Common issues: Appendix A: Sample DSX Camera configuration forms Appendix B: Cameras.cfg Appendix C: Settings.cfg Sample setting.cfg file: Ocularis mode = default Sample settings.cfg file: NetDVMS or RC C mode Appendix D: Troubleshooting License Server issues Appendix E: output.log Appendix F: CTP Driver revision number Appendix G: Known Anomoly For more information about CTP DSX Driver visit: About ConvergenceTP Page 2

4 Software Install Procedure Install notes: The CTP DSX Driver needs to be installed on any DSX client requiring access to OnSSI camera streams The License Server is not needed for the 30-day demo. The License Server is only installed on the Ocularis Base server or NetDVMS/RC-C Master recording server. 3 possible install scenarios 1) 30 Day full featured demo install Submit a request for the 30-day demo software using the form in the Download section of the ConvergenceTP (CTP) website: Once the demo request is received, CTP will respond to the address listed on the form with a link to the 30-day demo software to be downloaded. The 30-Day demo software is a full featured copy which is ready to be installed and run on as many DSX clients as needed provided the PC/Server that hosts the CTP DSX Driver meets the OnSSI Ocularis Client minimum requirements set by OnSSI. recommendations Note: The CTP DSX Driver needs to be installed on any DSX client requiring access to OnSSI camera streams. See also: CTP DSX Driver Install Wizard 2) 30 Day full demo upgrade to licensed copy a) Purchase a licensed copy of the CTP DSX Driver. Sales@c2p for a quote. b) With the quote you will also receive the CTP Seed generator program to be run on the Ocularis base server, or NetDVMS/RC-C Master recording server. See also: Pre-Install procedure: (licensed installs only, not needed for demos) c) Cut-n-paste the resultant Seed key generated to the quote and return it to CTP. d) You will then receive a License Server Setup.exe file and a CTPLicenseServer.lic file. e) Copy the CTPLicenseServer.lic to the C:\ root folder of the PC/server that the seed generator was run on in step b above. f) Run the License Server Setup.exe install on the same PC/server used in step e. Note1: The CTP License Server setup.exe can be run from any folder on that PC Note2: The CTP License Server setup.exe must be run as an administrator. g) That s it. Your demo software has just been upgraded to a licensed copy. 3) Licensed copy install To install a licensed copy of the CTP DSX Driver follow the same instructions as described in scenario 1 then 2 above. Page 3

5 Pre Install procedure: (licensed installs only, not needed for demos) Note: If this install is for demo use only the Pre Install procedure is not needed. Once the 30 day demo expires you will need to purchase a license to reactivate the software and the Pre install procedure will be needed at that time. For Demo users proceed directly to: CTP DSX Driver Install Wizard Installing and running the ConvergenceTP seed Generator procedure: 1. Load the seed generator program (.zipp) that was ed to you onto the Ocularis Base, or RC-C/NetDVMS master that will be hosting the CTP DSX Driver program. Note: The CTP DSX Driver supports both Ocularis Base connected cameras as well as supporting directly connected RC-C and NetDVMS systems in Master/Slave mode. 2. Rename the extension from zipp to.zip 3. Unzip the file. 4. Run CTP seed generator program by clicking on the Generate button. (See Figure 1) 5. The program will calculate the seed value and place it in the window 6. Copy the calculated value from the Generate window and paste it into an . Send the seed value back to ConvergenceTP using the address Sales@c2p.com 7. Once the seed value was received by ConvergenceTP, a license file will be ed to you that can enter when prompted the next time the CTP DSX drive is run. 8. Note: minimum requirements for the PC/Server should meet those set by OnSSI for the OnSSI client Page 4

6 Pre install seed key generation Note: Not needed to run the 30 day demo software. The Seed key is used to create a license file which when loaded on the Ocularis Base or NetDVMS/RC C Master server, along with the CTP License Server module, converts a 30 day demo copy of the CTP DSX Driver to a fully licensed copy. Note: Only one license server per licensed DSX installation is needed. Simply click on the CTP Generator icon then cut and paste thee resultant seed key and it back to sales@c2p.com. Figure 1 Page 5

7 CTP DSX Driver Install Wizard Place this CTP DSX Driver x.x.x.exe executable that was ed to you in the WinDSX folder and execute the installer. Note: The CTP DSX Driver must be installed on all DSX clients expecting to view OnSSI camera streams. The CTP application is installed first and then the OnSSI SDK is installed Page 6

8 Note the install directory below. The CTP DSX Driver MUST be installed in the same directoy as the DSX application. Specifically the same folder as the the DSXDVR.exe file. Typically c:\ \WinDSX\ Page 7

9 Page 8

10 Begin OnSSI SDK Install Process Note if a previous version of the OnSSI SDK is detected the install will prompt you for permission to remove it prior to installing the the version of the SDK included with the CTP DSX Driver. Page 9

11 Final step for installer After the installer finishes edit the settings.cfg file located in the folder used for this install. For details on setting.cfg see Appendix C: Settings.cfg Page 10

12 Camera Setup in WinDSX Note: This DSX cameraa setup material below is for reference only. See DSX documentation for more detail on setting up cameras from within the DSX application.. Selecting the cameraa to configure Page 11

13 Single camera setup Note1: DSX limits the total number of characters in the Assign Cameras dialog to approx. 45. Note2: The DVR Serverr Name is specified as an IP adr in Appendix C: Settings.cfg Page 12

14 Miltiple camera setup (up to 4) Note DSX limits the total number of characters in the Assignn Cameras dialog to approx. 45. Note2: The DVR Serverr Name is specified as an IP adr in Appendix C: Settings.cfg Page 13

15 Pan Tilt Zoom (PTZ) preset Note the first camera in the Assign Cameras list will be set to Preset 1 if the PTZ Camera check box is checked. Suggestion: For best performance leave the CTP Client up and just minimize it after viewing a camera. This saves the substantial Ocularis Login delay time to reopen a connection to Ocularis Page 14

16 Common issues: Aside from the wrong path being used during the installationn of the CTP DSX Driver most issues are a result of wrong or missing data entered in the DSX camera configuration form. Issue: DSXDVR.exe crashes or nothing happens at all when you try to view a camera stream within the DSX application. Resolution: DVR.exe in not installed or was installed into a directory other than the directory where DSXDVR.exe is located. During the initial install of the CTP DSX Driver make sure the installer is pointing the correct DSX directory containing the DSXDVR.exe program. In the screen shot below you can see that the installer inserted a New Folder in the install path. If this occurs it needs to be removed so that the correct path for the install can be used. Page 15

17 Issue: CTP Client stops at the Logging in, please wait message Entering a wrong Ocularis Base IP adr in settings.cfg filee will result in the CTP client to stop at the Logging in please wait screen See also: Appendix C: Settings.cfg Note: If the wrong credentials are used in the DSX camera form no entries will be made to cameras.cfg and output.log. Cameras.cfg and output.log will not be updated until a valid login process completes. Page 16

18 Issue: Screen stops at the Unable to log in screen. Entering the wrong username or wrong password in thee DSX camera configuration form gives the Unable to log in screen. Check the cameras.cfg file to seee the last result of the last login attempt. For more details on the cameras.cfg file see: Appendix B: Cameras.cfg See also: Appendix A: Sample DSX Camera configuration n forms. Page 17

19 Issue: Adding a camera to the DSX form results in a blank screen when viewed. Adding a camera in the DSX cameraa configuationn form that doesn t exist results in the logging in please wait screen being displayed briefly and then a black CTP client screen as seen below. Note: Camera names used in the DSX camera form are case sensitive. Example: Camera1 camera 1 Hint: When troubleshooting suspected camera name syntax or spelling issues open the cameras.cfg file and cut n paste the camera name in question directly to the DSX camera form. See Appendix B: Cameras.cfg Page 18

20 Appendix A: Sample DSX Camera configuration forms. Note for more information on the DSX camera form please refer to the appropriate WinDSX documentation. Ocularis login credentials used Note1: DVR Server Name and port are not needed here. Theyy are specified in settings.cfg see Appendix C: Settings.cfg Page 19

21 Appendix B: Cameras.cfg As part of the login process OnSSI provides the camerass that are available based on the login credentials used. This list can be found in the WinDSX directory in the Cameras.cfg file. The cameras are listed in XML format. Note: Cameras.cfg is only generated if there is a successful login. Important troubleshooting tip: To avoid mistyping camera names you can cut-n-paste form. the camera names from the cameras.cfg directly into the DSX camera In the example below there are 4 cameras listed: 1) Lab entry C19 2) CTP C1 3) Lab entry C17 4) Lab entry C18 Note: Cameras.cfg is a report file of the cameras listed by OnSSI based on the last SUCCESSFUL login attempt. The keyword here is successful. For example: If the user enters the wrong login credentials in the DSX camera form the cameras.cfg file will not be updated because the login attempt failed. See below Page 20

22 Appendix C: Settings. cfg The settings.cfg file is found in the same folder where WinDSK resides. The settings.cfgg folder allows the user to set the IP address of the Ocularis base or NetDVMS/RC C master recording server. The CTP DSX Driver ships in Ocularis Mode. To run the CTP DSX Driver in NetDVMS or RC C master/slavee mode you need to make a modification to a Settings.txt file in the WinDSX folder on each DSX client. As shipped the Settings.txt file looks as follows: (Ocularis Mode by default) Sample setting.cfg file: Ocularis mode = default usendvms = 0 Ocularis Base IP adr Ocularis Base Port To run the CTP DSX driver in RC C or NetDVMS mode simply add the following line to the setting.cfgg file in the WinDSX folder using notepad and save the file. Sample settings.cfg file: NetDVMS or RC C mode usendvms = 1 NetDVMS Master IP adr NetDVMS Master Port Page 21

23 Appendix D: Troubles shooting Licensee Serverr issues Note: the License Server ONLY applies to licensed copies of the CTP DSX Driver The CTP DSX Driver license is locked to the head end of the recording server chain. On Ocularis, the CTP License server goes on the Ocularis Base server With NetDVMS or RC C the CTP License Server goes on the Master recording server The License Server must be installed AFTER the LicenseServer.lic file is placed in the C: dir of the PC/Serverr that will be hosting it. This is because before the License Serverr Installer Installs the License Server Service it first checks the.lic file in the C: dir. If it isn t there or not valid the service is not installed. The best way to check if the Licensee server is installed properly is to look at Services in the Windows task manager. It should be listed as running. If the CTP License Service isn t running then your trouble shooting begins here. Key players in the licensing scheme 1) Windows Task manager to verify the License Server Service is running 2) LincenseServer.Lic in in the C: dir 3) Firewalls are down 4) Output.log in the WinDSK folder indicates last license failure 5) Ensure the License Server and.lic are installed onn the same server the Seed generator was run on to create the.lic file 6) Ensure the License Server and.lic are on the Head end recording server. Possible problems: 1) LicenseServer service is not running, indicated by thee message Unable to contact license server in the Output.log file or by viewing the service status in Windows Task Manager. a. Check the LicenseServer.lic file is in the C: folder on the correct server. b. Check that firewalls are down between the DSX client and the LicenseServer especially ports 9993 and (see Appendix C: Settings.cfg for details) c. If all else fails go to Start>All Programs>CTP License Server>Uninstall Then ensure the LicenseServer.lic filee is in the C: folder and reinstall the License Server Page 22

24 Appendix E: output.lo og Output.log is updated any time a licensing error occurs after the demo license period expires. The output.log file is located in the WinDSX folder on the DSXX client being used. Licensing errors occur for 2 reasons: 1) 30 day demo license expires 2) The CTP License Server is either not running or not accessible by the DSX client Invalid license screen Output.log reports the status of the license process. (only created after demo license expires) If wrong IP adr for license server is used or license server is not running then output.log can take SEVERAL seconds too update with message below The CTP client screen just says: Please Log in as shown above If the license server is running then you get the message below: Page 23

25 Appendix F: CTP Driver revision number Double click CTP Video Browser.exee in the WinDSX folder to get the rev level of the DSX integration. The revision is displayed in the upper left cornerr Appendix G: Known Anomoly Clicking on a video during playback stops the playback. The only way to restart playback is to resubmit the camera request in the DSX app. Page 24

26 For more information about CTP DSX Driver visit: //dsx.html About ConvergenceTP ConvergenceTP, LLC has developed the patentt pending Event Streaming Engine (ESE ) which is the backbone for all of the ESE software applications allowing user defined information to be seamlessly integrated into the video display. Contactt Information: 250 State Street, Unit G 1 North Haven, CT USA Phone x402 sales Page 25