Creating the KiwiVision Analyzer role in KiwiVision™ - KiwiVision™ 3.1

KiwiVision Video Analytics Plugin Guide 3.1

Applies to
KiwiVision™ 3.1
Last updated
Content type
Guides > Plugin and extension guides
English (United States)

Before you can configure and use the plugin, you must create the plugin role in Config Tool.

Before you begin

Ensure that the plugin is activated.

What you should know

The KiwiVision Analyzer is the role that performs video analytics processing for assigned cameras. When an intrusion is detected, an intrusion event is created in the KiwiVision Manager database. The intrusion event includes camera, time, intrusion snapshot, and metadata. These intrusion events can then be monitored in Security Desk.
IMPORTANT: Ensure that you do not run KiwiVision Analyzer roles on a machine that has a steady CPU usage higher than 70 %. Running KiwiVision Analyzer roles on a machine with CPU higher than 70 % can cause video decoding issues.


  1. From the home page in Config Tool, open the Plugins task.
  2. At the bottom of the Plugins task, click Add an entity (), and select Plugin.
  3. On the Specific info page, select the plugin type, the server to host the plugin role, the database for the plugin role, and then click Next.
    If you are not using an expansion server, the option to select a server is not displayed.
  4. On the Basic information page, do the following:
    1. Enter the name in the Entity name field.
    2. Enter the description in the Entity description field.
    3. (Optional) Select a Partition for the plugin role.
      Partitions are logical groupings used to control the visibility of entities. Only users who are members of that partition can view or modify the role.
    4. Click Next.
  5. On the Creation summary page, review the information, and then click Create, or Back to make changes.
    After the plugin is created, the following message appears: The operation was successful.
  6. Click Close.


The KiwiVision™ plugin KiwiVision Analyzer role is displayed in the entity browser.
NOTE: The KiwiVision Analyzer role is red, and a Role is currently offline message is displayed, because the KiwiVision Analyzer role has not been configured.