The Camio C-Cure Gateway communicates with C-Cure server v2.9 and above using the Victor Web Service.

This Camio User Guide covers:

1. Overview of Camio with C-Cure
2. Mapping cameras to C-Cure readers
3. Camio Setup for C-Cure

Overview of Camio with C-Cure

Fast visual verification and tailgating detection

Camio enables fast search and alerts on events like tailgating and entry unlocked.  Read more at https://camio.com/tailgating.

(NOTE: temporarily, only tailgating and entry unlocked are supported in this C-Cure integration)

Camio counts the number of people that pass through the door to compare that number to the actual number of C-Cure access granted events. If those counts don't match, then the video is annotated with "tailgating" unauthorized access. This video illustrates tailgating detection as the floor plane tiles turn red when the second person enters after only one access granted event:

Works with existing cameras

Setup takes less than 15 minutes. Each camera is mapped to the C-Cure reader so that events from those readers annotate the video from that camera. You configure the on-premise C-Cure Gateway with the credentials required to subscribe to C-Cure access control events.

Mapping cameras to C-Cure readers

The first step is to associate your C-Cure readers with any cameras that can see the doors controlled by those readers.

1. Generate your Camio Authorization token to be used by the C-Cure Gateway to annotate video with incoming access control events.
1. Sign-in as the Camio account manager and press the Generate button at https://camio.com/settings/integrations/pacs
2. Copy the token immediately after you generate it, since you will not be able to retrieve it again later.
3. Paste the token into your camio_config.yaml as camio_auth_token: {{CAMIO_AUTH_TOKEN_HERE}} value.
2. Find your C-Cure server, database, and user credentials and place them in the associated fields within the ccure_config.yaml and the ccure_user.yaml files.
3. Select the C-Cure Reader from the dropdown list next to each camera that has a view of the people entering the door associated with that reader and press Save.
   
   

Camio Setup for C-Cure

The C-Cure Gateway subscribes to C-Cure access control events in order to annotate the video associated with each event.

C-Cure Gateway Installation

The C-Cure Gateway runs as Docker containers on any host machine that can access the C-Cure server. If your firewall restricts the sites contacted, then please see Firewall Rules.

C-Cure Gateway Configuration Files (yaml files)

The C-Cure Gateway's configuration is determined by yaml files. Upon first startup of the C-Cure Gateway, these yaml files are encrypted and deleted so that secret credentials are never stored in the clear. To supply new option values, you must stop the containers, add the yaml files to the res directory, and restart the Docker Containers so that they read and encrypt the yaml files once again. See Updating Configuration Files.

CAMIO_CONFIG:
    stats_report_time_interval: 60
    camio_endpoint_events: "https://camio.com/api/integrations/pacs/webhooks"
    camio_endpoint_stats: "https://camio.com/api/integrations/pacs/stats”
    camio_endpoint_devices: "https://camio.com/api/integrations/pacs/devices"
    camio_endpoint_logs: "https://camio.com/api/integrations/pacs/logs"
    camio_auth_token: "{{CAMIO_AUTH_TOKEN_HERE}}"
    camio_max_retries: 100
    camio_send_queue_data_interval: 20   

---
 CCURE_CONFIG:
    server_name_or_ip: "{{C-Cure.server.domain or ip}}"
    version: "2.90"

CCURE__USER:
    username: "{{CCURE_USERNAME_HERE}}"
    password: "{{CCURE_PASSWORD_HERE}}"

---
 ADVANCED_CONFIG:
    query_filter: '["SoftwareHouse.NextGen.Common.LogMessageFormats.CardAdmitted"]'
    # Uncomment any settings where default values shown need to be modified
    #   (default values should work for most deployments, except where the OpenAccess port number was changed)
    log_level: DEBUG
    # stats_report_time_interval: 3600
    stats_report_time_interval: 60
    send_chunk_time_interval: 10
    total_session_time_interval: 150
    request_attempts_before_timeout: 4
    poll_readers_interval: 120

C-Cure Event Filter

Descriptions:

• Entry Unlocked
  • CardAdmitted
• Entry Ajar
  • (None Currently)
• Entry Forced
  • ObjectChangedState
• Unmapped But Still Labeled:
  • Doubleswipe 
  • OperatorLogin
  • DeviceError 
  • CardRejected 
  • ManualAction
  • TemporaryCredential 
  • IntrusionZoneActivity
  • SystemError
  • KeypadCommandActivity
  • Allowed
  • Accessed
  • Pre Held
  • Access Denied
  • Wrong PIN
  • Unknown Event
  • IP Camera Offline
  • IP Camera Online
  • Camera Restarted
  • Tailgating

Installing on Linux

1. Download and install Docker by following the steps for your Linux distribution from: https://docs.docker.com/engine/install/

2. Download and install docker-compose by following the steps from: https://docs.docker.com/engine/install/

3. Download the C-Cure Gateway package from:

4. Unzip the package

unzip camio_ccure_proxy.zip
cd camio_ccure_proxy
cd res
ls -l

5. Update the configuration files with Camio and C-Cure information

6. Once the config files have been updated, from the dist directory run the Camio container

docker-compose -f docker-compose.yaml up -d

If you want to run the container in foreground, then remove `-d`

docker-compose -f docker-compose.yaml up

7. The C-Cure Gateway containers are now running. You can use Docker commands to watch stats and logs whenever required.

8. Once you have confirmed the C-Cure Gateway is running and connected. move the docker-compose-app.service file to your /etc/systemd/system/ directory and edit the path of the "WorkingDirectory" to be the location of the camio_ccure_proxy.

WorkingDirectory=/home/user/camio_ccure_proxy

9. Then use the following command to enable the C-Cure Gateway on startup:

systemctl enable docker-compose-app

If you run into a permission denied error on the last few steps, try running with sudo

sudo systemctl enable docker-compose-app

Installing on Windows

1. Download and install Docker Desktop (which also contains docker-compose) by following the steps from:
   https://docs.docker.com/docker-for-windows/install/
2. Download the C-Cure Gateway package from:
   https://storage.googleapis.com/camio-test-pacs-proxy-dist/camio_ccure_proxy.zip
3. Unzip the package, and enter into the camio_ccure_proxy directory
4. Update the configuration files with Camio and C-Cure information
5. Once the config files have been updated,  from the dist folder run the Camio container

• docker-compose -f docker-compose.yaml up -d
  

• If you want to run the container in foreground, then remove `-d`

• docker-compose -f docker-compose.yaml up
  

6. The C-Cure Gateway containers are now running. You can use Docker commands to watch stats and logs whenever required.

Updating configuration files

1. When you need to update the configuration files, you first need to stop the containers by running

   • cd camio_ccure_proxy/dist
     docker-compose down

2. Wait for the containers to stop, and then add the new configuration files in the res directory.
   • Note that due to encryption and security, all of the existing configuration files in clear text will not be present in the res directory, so you will need to add fresh new configuration files in the res directory.
3. After adding the new configuration files, restart the containers by running:

   • cd camio_ccure_proxy/dist
     docker-compose -f docker-compose.yaml up
     

4. The C-Cure Gateway containers are now running with the updated configuration files. You can use Docker commands to watch stats and logs whenever required.

C-Cure Gateway Host Hardware Requirements

The CPU and RAM required of the host machine that runs the C-Cure Gateway Docker containers varies with the maximum throughput of access control events. This guide covers common volumes:

Firewall Rules

During the initial docker setup (docker-compose up -d) will need access to these servers:

• gcr.io
• storage.googleapis.com
• dockerhub.io

During operation, the Camio C-Cure Gateway will need access to these servers:

• https://camio.com/api/integrations/pacs/webhooks
• https://camio.com/api/integrations/pacs/devices
• https://camio.com/api/integrations/pacs/stats
• https://camio.com/api/integrations/pacs/logs
• https://us-central1-camio-test.cloudfunctions.net/test_callback_integration 

Ports

The Camio C-Cure Gateway uses ports:

• 443 to talk to the Internet servers above
• Whichever port specified in the C-Cure server domain or IP to talk to the C-Cure server 

During the initial docker setup (docker-compose up -d) the Camio C-Cure Gateway will retrieve the docker images using port 443.

During operation, the Camio C-Cure Gateway uses two docker containers that talk to each other on a docker bridged network using ports 6379 and 8080. But those ports aren't open on the Local Area Network.

The port used to make requests of the C-Cure server will vary based on your network settings of your C-Cure system, but the default port found in C-Cure_config.yaml is 22.

----

For more information on PACS integrations see https://help.camio.com/hc/en-us/articles/4409969059732-How-do-I-set-up-a-Physical-Access-Control-System-integration-User-s-Guide- and https://help.camio.com/hc/en-us/articles/4409631039892-How-do-I-create-a-Physical-Access-Control-System-integration-Developer-s-Guide-