convergenc etp, llc ctp dsx driver · page 4 v2.5.7.6.8.9 pre‐install procedure: (licensed...

www.c2p

p.com

Convergenc

CTPInstalland

ceTP,LLC

PDSUseGuide,V

SXDVersion2.5.7.

Driv.6.8.9

ver

PPage0

www.c2p.com Page1 V2.5.7.6.8.9

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, aswellasNetDVMSandRC‐Crecordingservers, 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 theOnSSIvideomanagementsystemsmentionedabove.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:.NetframeworkrequirementThe 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:CTPseedgeneratorprogramusedtolicensetheCTPDSXDriverBy 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:InstallfolderrequirementThe 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:

http://www.c2p.com/dsx.html


TableofContentsPreface: ......................................................................................................................................................... 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............................................................................................................................ 3

3 possible install scenarios ........................................................................................................................ 3

1) 30‐Day full featured demo install ................................................................................................. 3

2) 30‐Day full demo upgrade to licensed copy ................................................................................. 3

3) Licensed copy install ..................................................................................................................... 3

Pre‐Install procedure: (licensed installs only, not needed for demos) ........................................................ 4

Pre‐install seed key generation ................................................................................................................. 5

Figure 1 ..................................................................................................................................................... 5

CTP DSX Driver Install Wizard ....................................................................................................................... 6

Begin OnSSI SDK Install Process .................................................................................................................... 9

Final step for installer ................................................................................................................................. 10

Camera Setup in WinDSX ............................................................................................................................ 11

Single camera setup ................................................................................................................................ 12

Miltiple camera setup (up to 4) .............................................................................................................. 13

Pan Tilt Zoom (PTZ) preset ...................................................................................................................... 14

Commonissues: ....................................................................................................................................... 15

Appendix A: Sample DSX Camera configuration forms.............................................................................. 19

Appendix B: Cameras.cfg ............................................................................................................................ 20

Appendix C: Settings.cfg............................................................................................................................. 21

Sample setting.cfg file: Ocularis mode = default ................................................................................ 21

Sample settings.cfg file: NetDVMS or RC‐C mode ............................................................................. 21

Appendix D: Troubleshooting License Server issues .................................................................................. 22

Appendix E: output.log .............................................................................................................................. 23

Appendix F: CTP Driver revision number ................................................................................................... 24

Appendix G: Known Anomoly .................................................................................................................... 24

For more information about CTP DSX Driver visit: ..................................................................................... 25

About ConvergenceTP ................................................................................................................................ 25


SoftwareInstallProcedure

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.

3possibleinstallscenarios

1) 30‐Dayfullfeatureddemoinstall

Submit a request for the 30-day demo software using the form in the Download section of the ConvergenceTP (CTP) website:

http://www.c2p.com/dsx-download-contact-form.html Once the demo request is received, CTP will respond to the email 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. http://www.onssi.com/hardware‐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‐Dayfulldemoupgradetolicensedcopy a) Purchase a licensed copy of the CTP DSX Driver. Email 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 email 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) LicensedcopyinstallTo install a licensed copy of the CTP DSX Driver follow the same instructions as described in scenario 1 then 2 above.


Pre‐Installprocedure:(licensedinstallsonly,notneededfordemos) 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 emailed 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 email. Send the

seed value back to ConvergenceTP using the email address [email protected] 7. Once the seed value was received by ConvergenceTP, a license file will be emailed 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

www.c2p

Pre‐ins Note: Not The Seed “Master”sDriver to Note: Onl Simply clisales@c2

p.com

stallseedk

t needed to ru

key is used toserver, along a fully license

ly one license

ck on the CTPp.com.

keygenera

un the 30‐day

o create a licewith the CTPed copy.

server per lic

P Generator ic

ation

y demo softwa

ense file whicP License Serv

censed DSX in

con then cut

Figure

Page5

are.

ch when loadever module, c

stallation is n

and paste the

e1

ed on the Oconverts a 30‐

needed.

e resultant se

ularis Base or‐day demo co

eed key and e

V2.5.7

r NetDVMS/Ropy of the CTP

email it back t

7.6.8.9

RC‐C P DSX

to

www.c2p

CTPD Place thisexecute tNote: Thestreams. The CTP

p.com

DSXDrive

s CTP DSX Dthe installere CTP DSX D

application

erInstal

river x.x.x.ex.

Driver must b

is installed f

llWizard

xe executab

be installed o

irst and then

Page6

d

le that was e

on all DSX cli

n the OnSSI

emailed to y

ients expecti

SDK is instal

you in the W

ing to view O

lled

V2.5.7

WinDSX folde

OnSSI camer

7.6.8.9

r and

ra

www.c2p

Note the

The CTP the same

p.com

install directo

DSX Driver Me folder as th

ory below.

MUST be inshe the DSXD

talled in theVR.exe file.

Page7

e same direcTypically c:\

toy as the D\WinDSX\

DSX applicati

V2.5.7

on. Specifica

7.6.8.9

ally

www.c2p

p.com

Page8

V2.5.77.6.8.9

www.c2p

BeginNote if a premove it

p.com

OnSSISprevious verst prior to insta

DKInstasion of the Onalling the the

allProcenSSI SDK is deversion of th

Page9

essetected the inhe SDK include

stall will promed with the C

mpt you for pCTP DSX Drive

V2.5.7

permission toer.

7.6.8.9

www.c2p

FinalsAfter the For detail

p.com

stepforinstaller finiss on setting.c

installerhes edit the scfg see Appen

rsettings.cfg findix C: Settin

Page10

le located in tgs.cfg

the folder us

ed for this ins

V2.5.7

stall.

7.6.8.9

www.c2p

Camer Note: Thisdetail on s

Selecting

p.com

raSetup

s DSX camerasetting up cam

g the camera

pinWinD

a setup matermeras from w

a to configur

DSX

rial below is fowithin the DSX

re

Page11

or reference oX application.

only. See DSX.

X documentat

V2.5.7

tion for more

7.6.8.9

www.c2p

S Note1: DSNote2: Th

p.com

inglecam

SX limits the the DVR Server

erasetup

total number r Name is spe

of charactersecified as an I

Page12

s in the “AssigP adr in Appe

gn Cameras” endix C: Setti

dialog to appings.cfg

V2.5.7

prox. 45.

7.6.8.9

www.c2p

Miltiple Note DSX Note2: Th

p.com

ecameras

limits the tothe DVR Server

setup(upt

tal number ofr Name is spe

to4)

f characters iecified as an I

Page13

n the “AssignP adr in Appe

n Cameras” diendix C: Setti

ialog to approings.cfg

V2.5.7

ox. 45.

7.6.8.9

www.c2p

PanTil Note the fchecked.

SuggestFor best psubstantia

p.com

tZoom(P

first camera i

tion: performance al Ocularis Lo

TZ)prese

in the Assign

leave the CTPogin delay tim

t

Cameras list

P Client up anme to reopen a

Page14

will be set to

nd just minima connection

“Preset 1” if

ize it after vieto Ocularis

the PTZ Cam

ewing a came

V2.5.7

mera check bo

era. This save

7.6.8.9

ox is

s the

www.c2p

Comm Aside fromresult of w Issue: DSXDVR.eapplicatio ResolutioDVR.exe ilocated. During thdirectory In the screoccurs it n

p.com

monissue

m the wrong wrong or miss

exe crashes oon.

on: n not installe

e initial instalcontaining theen shot beloneeds to be re

es:

path being ussing data ente

r nothing hap

ed or was inst

ll of the “CTP he DSXDVR.exow you can seemoved so th

sed during thered in the D

ppens at all w

alled into a d

DSX Driver” xe program. ee that the inhat the correc

Page15

e installationSX camera co

when you try t

directory othe

make sure th

staller insertect path for th

n of the CTP Donfiguration f

to view a cam

er than the di

he installer is

ed a “New Foe install can b

DSX Driver moform.

mera stream w

rectory wher

pointing the

older” in the ibe used.

V2.5.7

ost issues are

within the DSX

re DSXDVR.ex

correct DSX

nstall path. If

7.6.8.9

a

X

xe is

f this

www.c2p

Issue: CTP Clien Entering the “LoggSee also:

Note: If the wrooutput.log

p.com

nt stops at th

a wrong Ocging in pleas: Appendix C

ong credentialg. Cameras.cf

he “Logging

cularis Base se wait…” sC: Settings.c

ls are used in fg and output

in, please w

IP adr in setscreen cfg

the DSX camt.log will not b

Page16

wait…” messa

ttings.cfg file

mera form no ebe updated u

age

e will result

entries will beuntil a valid lo

in the CTP c

e made to camogin process c

V2.5.7

client to sto

meras.cfg ancompletes.

7.6.8.9

p at

d

www.c2p

Issue: Screen st

Entering the” Una

Check thFor more See also:

p.com

tops at the “

the wrong uable to log in

e cameras.ce details on t

Appendix A

“Unable to lo

username orn” screen.

fg file to seethe cameras

A: Sample DS

og in” screen

r wrong pass

e the last ress.cfg file see:

SX Camera c

Page17

n.

sword in the

sult of the la: Appendix B

configuration

e DSX camer

ast login atteB: Cameras.c

n forms.

a configurat

empt. cfg

V2.5.7

tion form giv

7.6.8.9

ves

www.c2p

Issue: Adding a Adding a cwait” scre Note: Cam

Hint: Wheand cut‐nSee Appen

p.com

camera to th

camera in theeen being disp

mera names u

en troublesho‐paste the candix B: Camer

he DSX form r

e DSX cameraplayed briefly

used in the D

ooting suspecamera name inras.cfg

results in a bl

a configuationy and then a b

DSX camera fo

ted camera nn question dir

Page18

lank screen w

n form that dblack CTP clie

orm are case

name syntax orectly to the D

when viewed

oesn’t exist rent screen as

sensitive. Ex

or spelling issDSX camera f

.

results in the seen below.

xample: Cam

sues open theform.

V2.5.7

”logging in pl

era1 ≠ camer

e cameras.cfg

7.6.8.9

lease

ra 1

file

www.c2p

Appen Note for mdocument

Ocularis loNote1: Dsee Appen

p.com

ndixA:S

more informatation.

ogin credentiVR Server Nandix C: Settin

SampleD

ation on the D

als used me and port ngs.cfg

DSXCam

DSX camera fo

are not neede

Page19

meracon

orm please ref

ed here. They

nfiguratio

efer to the app

y are specified

onform

propriate Win

d in settings.c

V2.5.7

s.

nDSX

cfg

7.6.8.9

www.c2p

Appen

As part ocredentiacameras Note: Ca Importan

Tca

In the ex

1234

Note: Camattempt. For exampwill not be

p.com

ndixB:C

of the login pals used. Thare listed in

ameras.cfg is

nt troubleshoTo avoid mistameras.cfg d

ample below) Lab entry) CTP C1 ) Lab entry) Lab entry

meras.cfg is aThe keyword ple: If the usee updated be

Cameras

process OnSis list can beXML forma

s only genera

ooting tip: typing camerdirectly into

w there are 4y C19

y C17 y C18

report file ofhere is succeer enters the wcause the log

.cfg

SI provides e found in that. ated if there

ra names yothe DSX cam

cameras list

f the camerasssful. wrong login cgin attempt fa

Page20

the camerashe WinDSX d

is a successf

ou can cut-n-mera form.

ted:

s listed by OnS

credentials in ailed. See belo

s that are avadirectory in

sful login.

-paste the ca

SSI based on

the DSX camow

ailable basedthe Cameras

amera names

the last SUCC

era form the

V2.5.7

d on the logins.cfg file. Th

s from the

CESSFUL login

cameras.cfg f

7.6.8.9

n he

n

file

www.c2p

Appen The settinuser to seThe CTP DTo run thea “Setting As shippe

Samples useNDVM Ocularis B Ocularis B To run thein the Win

Samples useNDVM NetDVMS NetDVMS

p.com

ndixC:S

ngs.cfg file is fet the IP addreDSX Driver shie CTP DSX Drgs.txt” file in t

d the Setting

setting.cfgfi

MS = 0

Base IP adr

Base Port

e CTP DSX drinDSX folder u

settings.cfgf

MS = 1

S Master IP ad

S Master Port

Settings.

found in the sess of the Ocips in Ocularisiver in NetDVthe WinDSX fo

s.txt file look

ile:Ocularis

iver in RC‐C ousing notepad

file:NetDVM

dr

cfg

same folder wularis base ors Mode. VMS or RC‐C older on each

s as follows:

smode=def

r NetDVMS md and save the

MSorRC‐Cm

Page21

where WinDSr NetDVMS/R

master/slaveh DSX client.

(Ocularis Mod

fault

mode simply ae file.

mode

SK resides. ThRC‐C master r

e mode you ne

de by default

add the follow

e settings.cfgecording serv

eed to make

t)

wing line to t

V2.5.7

g folder allowver.

a modificatio

he setting.cfg

7.6.8.9

ws the

on to

g file

www.c2p

Appen Note: the The CTP D

OW

The LicenPC/ServerServer Seinstalled. The best wtask mana If the CTP

Key playe

1)2)3)4)5)

6) Possible p

1) Lise

p.com

ndixD:T

e License Serv

DSX Driver liceOn Ocularis, thWith NetDVMS

se Server mur that will be rvice it first c

way to check ager. It should

P License Serv

rs in the licen

) Windows T) LincenseSe) Firewalls a) Output.log) Ensure the

run on to c) Ensure the

problems:

icenseServer erver” in the

a. Check b. Check

ports 9c. If all e

Troubles

ver ONLY app

ense is lockedhe CTP LicensS or RC‐C the

st be installehosting it. Thhecks the .lic

if the Licensed be listed as

vice isn’t runn

nsing scheme

Task manageerver.Lic in inare down g in the WinDe License Servcreate the .lice License Serv

service is notOutput.log filthe LicenseSthat firewalls9993 and 123lse fails go toThen ensurServer

shooting

lies to license

d to the heade server goes CTP License

d AFTER the is is becausefile in the C:

e server is ins “running”.

ning then you

r to verify the the C: dir

DSK folder indver and .lic arc file ver and .lic ar

t running, indle or by viewierver.lic file is are down be345 (see Appe Start>All Prore the License

Page22

gLicense

ed copies of t

end of the res on the OculaServer goes o

LicenseServebefore the Lidir. If it isn’t

stalled proper

r trouble sho

e License Serv

icates last licee installed on

e on the Hea

icated by theing the servics in the C: foletween the Dendix C: Settiograms>CTP LeServer.lic file

eServer

the CTP DSX D

ecording servaris Base servon the “Maste

r.lic file is plaicense Serverthere or not v

rly is to look a

oting begins

ver Service is

ense failuren the same se

d end record

e message “ Uce status in Wlder on the coDSX client andings.cfg for deLicense Servee is in the C: f

rissues

Driver

ver chain. ver er” recording

aced in the C: r Installer Instvalid the serv

at “Services”

here.

running

erver the Seed

ing server.

Unable to conWindows Task orrect server.d the LicenseSetails) r>Uninstall folder and rei

V2.5.7

g server

dir of the talls the Licenvice is not

in the Windo

d generator w

ntact license Manager. . Server especi

nstall the Lice

7.6.8.9

nse

ows

was

ally

ense

www.c2p

AppenOutput.lo The outpu Licensing

1) 302) Th

Invalid lic

Output.lo

If

If

p.com

ndixE:oog is updated

ut.log file is lo

errors occur

0‐day demo lhe CTP Licens

ense screen

og reports the

wrong IP adrthen o

the license s

output.loany time a lic

ocated in the

for 2 reasons

icense expirese Server is ei

e status of the

r for license soutput.log can

The CTP clie

erver is runni

ogcensing error

WinDSX folde

s:

es ither not runn

e license proc

erver is used n take SEVERAent screen ju

ing then you

Page23

occurs after

er on the DSX

ning or not ac

cess. (only cre

or license seAL seconds tost says: “Plea

get the mess

the demo lice

X client being

ccessible by t

eated after de

rver is not ruo update withase Log in” as

age below:

ense period e

g used.

the DSX client

emo license e

nning h message beshown above

V2.5.7

expires.

t

expires)

elow e

7.6.8.9

www.c2p

Appen

Double cl

The revisi

Appen Clicking oThe only

p.com

ndixF:C

ick CTP Video

on is displaye

ndixG:K

on a video dway to resta

CTPDriv

o Browser.exe

ed in the upp

KnownA

uring playbaart playback

verrevis

e in the WinD

er left corner

Anomoly

ack stops thek is to resubm

Page24

ionnum

DSX folder to g

r

y

e playback. mit the came

mber

get the rev le

era request

evel of the DS

in the DSX a

V2.5.7

X integration

app.

7.6.8.9

.

www.c2p

Formhttp://

About

Converg(ESE™) user de

Contact250 StaNorth HPhone 8www.c2

p.com

oreinfo/www.c2p

tConverg

genceTP, Lwhich is tfined infor

t Informatte Street, UHaven, CT 0800‐252‐682p.com

rmationp.com/ds

genceTP

LLC has dehe backbormation to

ion: Unit G‐1 06473 USA840 x402 s

naboutCsx.html

P

eveloped tone for all be seamle

A sales

Page25

CTPDSX

the patentof the ESessly integ

Driverv

t pending E™ softwarated into

visit:

Event Streare applicathe video

V2.5.7

eaming Enations allowdisplay.

7.6.8.9

ngine wing

convergenc etp, llc ctp dsx driver · page 4 v2.5.7.6.8.9 pre‐install procedure: (licensed...

Documents