CompleteView Axis One Click Connection Manual. CompleteView Version 4.2

Size: px

Start display at page:

Download "CompleteView Axis One Click Connection Manual. CompleteView Version 4.2"

Bernard Porter
6 years ago
Views:

1 CompleteView Axis One Click Connection Manual CompleteView Version 4.2

2 Table of Contents Contents One Click Process Overview...3 Axis One Click Connection Component Setup & Configuration...5 Configuring One Click Connection Settings in CompleteView Setting up a Camera using One Click Connection in CompleteView Appendix A: Feature Descriptions Appendix B: Troubleshooting Appendix C: Manually Editing the OCCC Configuration Additional Resources CompleteView Axis One Click Connection Manual Page 2

3 CompleteView supports Axis One Click Connection feature built into most Axis Communications cameras and encoders. Axis One Click Connection simplifies installation by reducing the IP configuration necessary to connect the camera to the CompleteView Video Management System. Once the installer has mounted the camera and plugged it in, he/she can then push a button on the camera without further configuration at the installation site. One Click Process Overview Step 1: The CompleteView Administrator enters the necessary connection information into the CompleteView Server Configuration interface. The information is passed to the One Click Connection Component (OCCC), then to the Axis Dispatch Server. Step 2: The installer presses the button on the camera. This step initiates the final installation step of the One Click Connection Process. Step 3: The camera then connects to a Dispatch Server from a list of servers stored in memory. The Dispatch Server is hosted by Axis Communications and exists in the cloud. The camera successfully connects to the Dispatch Server and maintains the connection. The camera waits to be 'claimed', at which time it will be reprogrammed to connect directly to the One Click Connection Component & CompleteView server. CompleteView Axis One Click Connection Manual Page 3

4 Step 4: The Axis Dispatch server verifies ownership of the camera using the MAC address of the camera and the Owner Authentication Key (OAK) provided by CompleteView & the OCCC, and then reprograms the camera to connect directly to the OCCC. Step 5 & 6: The camera connects to the OCCC and its live video is delivered to CompleteView. Note: The Axis Dispatch Servers exists 'in the cloud' and are managed by Axis Communications. The Axis One Click Connection Component is installed by the user (often a VSaaS/hosted video service provider) of CompleteView. The OCCC runs as a Windows Service and can run on the same computer as CompleteView or it can be installed on a separate PC. A single One Click Connection Component can be used to support cameras streaming to multiple CompleteView servers. CompleteView Axis One Click Connection Manual Page 4

Axis One Click Connection Component Setup & Configuration The Axis One Click Connection Component (OCCC), is software developed by Axis Communications (and obtained from Salient Systems) which allows

5 Axis One Click Connection Component Setup & Configuration The Axis One Click Connection Component (OCCC), is software developed by Axis Communications (and obtained from Salient Systems) which allows for the connection between One Click Connection capable cameras and Salient CompleteView. The computer designated to run the OCCC software needs to be accessible from the Internet. This means it will either need to be installed on a computer with a direct Internet connection and a publically accessible IP address, or port forwarding will need to be setup on the router providing the Internet connection to allow communication from cameras to the One Click Connection Component over the Internet. The One Click Connection Component can be setup on a dedicated computer and be used to connect cameras to several CompleteView recording servers, or the One Click Connection Component can be setup on the same computer as the CompleteView recording server it is intended to service. 1. Locate the o3c_2.05_setup.exe file to begin setup. 2. Click Next on the Welcome screen. CompleteView Axis One Click Connection Manual Page 5

6 3. Review the license agreement and choose I accept the agreement then click Next to proceed. 4. In the first field, specify the external IP address and port number to be used for incoming camera connections. If the One Click Server is located behind a firewall on a private network, the IP address cameras use to send video to the One Click Server may be different than the server s assigned address. In the second field enter the IP address of the One Click Server that video from cameras will be sent to. This should be the IP address assigned to the One Click Server computer. The third field specified the IP addresses of the One Click Server which will be used to send video to CompleteView from. This may be the same address as specified in the second field, or it may be a different address if the One Click Server is multihomed and a different NIC adaptor will be used to send video to CompleteView than is used to receive video from cameras. In either case the port number used will be different than what is specified in the second field. CompleteView Axis One Click Connection Manual Page 6

7 5. On the next screen, leave the notification URL blank. CompleteView Axis One Click Connection Manual Page 7

8 6. Leave both field at their default settings (Proxy and admin credentials should be black and authentication mode should be 1 ) and click Next. 7. For users upgrading an existing installation of the One Click Connection Component click Browse and specify the location of the certificates. If this is a new deployment leave both fields black and certificates will be generated. CompleteView Axis One Click Connection Manual Page 8

9 8. Select the folder you would like the One Click Connection Component files installed to. Click Next to proceed. 9. Select the Start menu folder for program icons to be accessible from. Click Next to proceed. CompleteView Axis One Click Connection Manual Page 9

10 10. Review the installation parameters, and then click Next to proceed. CompleteView Axis One Click Connection Manual Page 10

11 11. Once the installer has finished, click Finish to exit the setup program. Note: The Axis OCCC installer includes a program that generates the new certificate files. This program relies on a Microsoft re-distributable file that is not installed by the OCCC installation program. Most Windows desktop computers will have this file, but some Windows server computers may not have this file present. If the OCCC installer did not generate the certificate files, this could be a reason why. The files can be downloaded here: Note: If upgrading from the OCCC v1.4.3 or earlier to v2.0 the OCCC server may not start when installation has finished. It may be necessary to manually copy the certificate files referenced in step 7 to the installation folder of the OCCC v2 specified in step 8. CompleteView Axis One Click Connection Manual Page 11

Configuring One Click Connection Settings in CompleteView Before you begin Before setting up CompleteView with the One Click Connection Component you will need an Axis Dispatch Server account.

12 Configuring One Click Connection Settings in CompleteView Before you begin Before setting up CompleteView with the One Click Connection Component you will need an Axis Dispatch Server account. Each instance of an OCCC server requires its own Axis Dispatch Server account. Please contact Salient Systems to obtain the Axis Dispatch Server Account. Configuring general settings Setup of CompleteView to communicate with the One Click Connection Component is performed on the general server settings for the CompleteView Server. 1. Open CompleteView Server Configuration. 2. Click the server being configured on the Tree View. The Axis One-Click tab will be shown to the right. CompleteView Axis One Click Connection Manual Page 12

13 3. Enter the Axis Dispatch server account information (obtained from Salient Systems) in the User Name and Password fields. 4. Enter the external IP address & port number of the One Click Proxy in the External Address field. This will be either the ListenCamera address and port number configured in the One Click Connection Component app.config file, or the ListCameraPublic address & port number. 5. Enter the Axis One Click Connection Component internal IP address and the associated port number in the Internal Address field. This is the same IP address & port number configured as the ListenUser address in the app.config files used for the One Click Proxy 6. Specify the name of the certificate file for the OCCC. The default file name of stserver_ca.crt should be used. If the default file was moved from its original location specify the file name and location with its fully qualified path. For reference the default location is: C:\Program Files\Axis Communications\AXIS One-Click Connection Component\stserver_ca.crt NOTE: Using CompleteView Server Configuration you will be able to specify the location of the certificate file only if it is located on the local computer. Please note this step will not work is using CompleteView Server Configuration from a remote computer. It is recommended remote desktop or similar tool be used to remotely run Server Configuration from the local computer. CompleteView Axis One Click Connection Manual Page 13

14 Setting up a Camera using One Click Connection in CompleteView Once the general settings are configured (reference Configuring One Click Connection Settings in CompleteView) individual cameras can be registered. To setup a camera the camera s MAC address and Owner Authentication Key (OAK number) are required. Note: The camera s MAC Address is the camera s Serial Number. The MAC Address/Serial Number can be found on a label attached to the camera. The camera s OAK number is located on a certificate shipped with the camera. The certificate is located in the camera s original box. If the OAK number has been lost, a new OAK can be generated by Axis Communications. Contact Axis technical Support for a new OAK number and have the camera s MAC Address (Serial Number) available. To setup a camera in CompleteView using the One Click technology: 1. Add a camera in CompleteView. Please refer to the CompleteView Administrator Manual for details setup instructions. 2. Ensure an Axis camera driver is chosen in the Camera Model list. 3. Under Axis One-Click Component check Use Axis One-Click. 4. The Address (Hostname/IP): field will change to Camera s MAC Address:. Enter the camera s MAC Address (Serial Number) in this field. The MAC Address will be a 12 character hexadecimal number which starts with 00408C. 5. Enter the camera s default username and password (Username is root and the password is pass ) in the Username and Password fields respectively. The default username and password can be changed only after the camera is configured initially. 6. Under Axis One-Click Component click Configure CompleteView Axis One Click Connection Manual Page 14

15 7. The Axis One-Click Configuration screen will be displayed. 8. Enter the camera s Owner Authentication Key in the OAK field. 9. Click Register NOTE: After registering the camera with this tool, do not forget to save the CompleteView server configuration so that CompleteView can start recording the stream as soon as it is available. NOTE: Multi channel Axis encoders only need to be registered one time for each 4 channels, not once for each video channel. Using a 16 channel encoder, 4 separate registrations would be required (one for each MAC). Using a 4 channels only one registration is required. CompleteView Axis One Click Connection Manual Page 15

16 Appendix A: Feature Descriptions External Address is the 'public' IP address and port number of the One Click Connection Component. Internal Address is the 'private/internal' IP address and port number of the One Click Connection Component. Status will provide a list of cameras currently registered. Notify Subscribe allows for a subscription to notifications and status messages from the One Click Connection Component. Registers a new camera by sending the MAC Address of the camera and OAK number to the Axis Dispatch server (via the OCCC) CompleteView Axis One Click Connection Manual Page 16

Appendix B: Troubleshooting In some cases there may be a delay between registering the camera and the video stream actually becoming available.

Normally you will receive a 200 OK response on the first attempt, and then possibly some 400 Error responses until the camera registration and connection with the Axis

17 Appendix B: Troubleshooting In some cases there may be a delay between registering the camera and the video stream actually becoming available. CompleteView may report an error as it may fail to dispatch, but typically waiting a few minutes and trying the registration again, resolves the issue. Normally you will receive a 200 OK response on the first attempt, and then possibly some 400 Error responses until the camera registration and connection with the Axis One Click Connection Component completes. You may also see the following message: In this case, simply try registration again. You should see the following response: CompleteView Axis One Click Connection Manual Page 17

18 Once the camera is connected, you can click the [Status] button on the Axis One Click Configuration screen and it should show all cameras connected to that One Click Connection Component: CompleteView Axis One Click Connection Manual Page 18

19 Appendix C: Manually Editing the OCCC Configuration. The Axis OCCC installation program writes the appropriate information to the application configuration file during the install process. Normally there is no need to manually edit the OCCC configuration file. If these settings do need to be modified, please follow the directions below. Locate the app.config file in the One Click Connection Component s installation directory. The default location is: C:\Program Files\Axis Communications\AXIS One Click Connection Component Open the app.config file using Windows Notepad. There are 3 keys that you will need to edit in order for the OCCC to operate correctly: ListenCamera this key tells the One Click Component which IP address and port number the camera s video stream will be coming in through. ListenUser this key tells the One Click Component which IP address and port number the user (in this case CompleteView) will communicate through. ListenCameraPublic this key allows the One Click Component to tell the Dispatch Server, which IP address and port number the camera will communicate through. To edit the app.config file, perform the following steps: 1. Locate the ListenCamera parameter: <add key="listencamera" value=" :8081" /> Change the IP address (shown in red) to the IP address of the computer the One Click Connection Component is installed on. Change the port number (shown in blue) to the desired port number for camera connections. 2. Locate the ListenCameraPublic parameter:  First uncomment the parameter by removing the <! at the beginning of the line, then remove the --> at the end of the line. If the computer you installed the One Click Connection Component on is directly connected to the Internet, and has a publically accessible IP address, change the IP address (shown in red) and port number (shown in blue) to the same values used for ListenCamera. If the computer does not have a publically accessible IP address, change the IP address (shown in red) to the IP address of the router with port forwarding setup to forward requests through to the One Click Proxy. Change the port number (shown in blue) to the desired port number for camera connections (this port should match the port setup on the router s port forwarding configuration and should match the ListenCamera port number). CompleteView Axis One Click Connection Manual Page 19

20 3. Locate the ListenUser parameter: <add key=" ListenUser " value=" :3128" /> Change the IP address (shown in red) to the IP address of the computer the One Click Connection Component is installed on. Change the port number (shown in blue) to the desired port number for CompleteView to connect to when receiving video. This port number must be different than the ListenCamera port number. CompleteView Axis One Click Connection Manual Page 20

21 Additional Resources Visit the Salient website, for additional support and CompleteView training: Manuals & Documentation ( Includes Administrator s Manual, Client User Manuals (including Video, Alarm and Web clients), How To Guides and Tips. Online Tech Support ( Get quick access to online tech support modules that cover the most frequently asked product questions, such as Adding and Moving IP Camera Licenses. Salient University elearning ( A convenient way to get trained on CompleteView. Register online for access to interactive, user training modules covering the Video, Alarm, Mapping and Web clients. Classroom Training ( Traditional, classroom training is available throughout the United States. Please visit the Salient website for training calendar, agenda and registration. Salient Systems N. MoPac Expy. Building 3, Suite 700 Austin, TX Fax Salient Systems Corporation. Company and product names mentioned are registered trademarks of their respective owners. CompleteView Axis One Click Connection Manual Page 21

CompleteView Video Proxy User Manual. CompleteView Version 4.5.1

CompleteView Video Proxy User Manual CompleteView Version 4.5.1 Table of Contents Minimum System Requirements... 4 Installation... 5 Configuring the Video Proxy... 9 Add an Administrator Account... 10