Skip to content

RuleEngine

Analytics (RuleEngine) service implementation.

RuleEngine

Bases: ONVIFService

0.0.1 2.4

Analytics (RuleEngine) service client.

Property Details
First introduced ONVIF 2.4 (August 2013)
Binding name RuleEngineBinding (ver20/analytics/wsdl/analytics.wsdl)
Operations analytics.wsdl
Spec Analytics

GetSupportedRules 

GetSupportedRules(ConfigurationToken)

List all rules that are supported by the given VideoAnalyticsConfiguration.

Input
  • ConfigurationToken [ReferenceToken]
    References an existing Video Analytics configuration. The list of available tokens can be obtained via the Media service GetVideoAnalyticsConfigurations method.
    Maximum length: 64
Output
  • SupportedRules [SupportedRules]
    • Limit - optional; [int]
      Maximum number of concurrent instances.
    • RuleContentSchemaLocation - optional, unbounded; [anyURI]
      Lists the location of all schemas that are referenced in the rules.
    • RuleDescription - optional, unbounded; [ConfigDescription]
      List of rules supported by the Video Analytics configuration..
      • Name - required; [QName]
        The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema.
      • fixed - optional; [boolean]
        The fixed attribute signals that it is not allowed to add or remove this type of configuration.
      • maxInstances - optional; [integer]
        The maxInstances attribute signals the maximum number of instances per configuration.
      • Parameters [ItemListDescription]
        List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems should be used to transport the information to ease parsing of dynamically defined messages by a client application.
        • Name - required; [string]
          Item name. Must be unique within a list.
        • Type - required; [QName]
        • Name - required; [string]
          Item name. Must be unique within a list.
        • Type - required; [QName]
          The type of the item. The Type must reference a defined type.
        • SimpleItemDescription - optional, unbounded; [complexType]
          Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...).
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
        • ElementItemDescription - optional, unbounded; [complexType]
          Description of a complex type. The Type must reference a defined type.
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
            The type of the item. The Type must reference a defined type.
        • Extension - optional; [ItemListDescriptionExtension]
      • Messages - optional, unbounded; [complexType]
        The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. The name of all Items must be unique within all Items contained in any group of this Message. Depending on the component multiple parameters or none may be needed to identify the component uniquely.
        • Source - optional; [ItemListDescription]
          Set of tokens producing this message. The list may only contain SimpleItemDescription items. The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message.
          For analytics events the token set shall include the VideoSourceConfigurationToken, the VideoAnalyticsConfigurationToken and the name of the analytics module or rule.
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
            The type of the item. The Type must reference a defined type.
          • SimpleItemDescription - optional, unbounded; [complexType]
            Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...).
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
          • ElementItemDescription - optional, unbounded; [complexType]
            Description of a complex type. The Type must reference a defined type.
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
              The type of the item. The Type must reference a defined type.
          • Extension - optional; [ItemListDescriptionExtension]
        • Key - optional; [ItemListDescription]
          Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key.
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
            The type of the item. The Type must reference a defined type.
          • SimpleItemDescription - optional, unbounded; [complexType]
            Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...).
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
          • ElementItemDescription - optional, unbounded; [complexType]
            Description of a complex type. The Type must reference a defined type.
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
              The type of the item. The Type must reference a defined type.
          • Extension - optional; [ItemListDescriptionExtension]
        • Data - optional; [ItemListDescription]
          Describes the payload of the message.
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
          • Name - required; [string]
            Item name. Must be unique within a list.
          • Type - required; [QName]
            The type of the item. The Type must reference a defined type.
          • SimpleItemDescription - optional, unbounded; [complexType]
            Description of a simple item. The type must be of category simpleType (xs:string, xs:integer, xs:float, ...).
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
          • ElementItemDescription - optional, unbounded; [complexType]
            Description of a complex type. The Type must reference a defined type.
            • Name - required; [string]
              Item name. Must be unique within a list.
            • Type - required; [QName]
              The type of the item. The Type must reference a defined type.
          • Extension - optional; [ItemListDescriptionExtension]
        • Extension - optional; [MessageDescriptionExtension]
        • ParentTopic [string]
          The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected.
      • Extension - optional; [ConfigDescriptionExtension]
    • Extension - optional; [SupportedRulesExtension]

CreateRules 

CreateRules(ConfigurationToken, Rule)

Add one or more rules to an existing VideoAnalyticsConfiguration.

The available supported types can be retrieved via GetSupportedRules, where the Name of the supported rule correspond to the type of an rule instance.

Pass unique module names which can be later used as reference. The Parameters of the rules must match those of the corresponding description.

Although this method is mandatory a device implementation must not support adding rules. Instead it can provide a fixed set of predefined configurations via the media service function GetCompatibleVideoAnalyticsConfigurations.

Input
  • ConfigurationToken [ReferenceToken]
    Reference to an existing VideoAnalyticsConfiguration.
    Maximum length: 64
  • Rule - unbounded; [Config]
    • Name - required; [string]
      Name of the configuration.
    • Type - required; [QName]
      The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
    • Parameters [ItemList]
      List of configuration parameters as defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • Value - required; [anySimpleType]
        Item value. The type is defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • SimpleItem - optional, unbounded; [complexType]
        Value name pair as defined by the corresponding description.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
      • ElementItem - optional, unbounded; [complexType]
        Complex value structure.
        • Name - required; [string]
          Item name.
      • Extension - optional; [ItemListExtension]

DeleteRules 

DeleteRules(ConfigurationToken, RuleName)

Remove one or more rules from a VideoAnalyticsConfiguration.

Input
  • ConfigurationToken [ReferenceToken]
    Reference to an existing VideoAnalyticsConfiguration.
    Maximum length: 64
  • RuleName - unbounded; [string]
    References the specific rule to be deleted (e.g. "MyLineDetector").

GetRules 

GetRules(ConfigurationToken)

List the currently assigned set of rules of a VideoAnalyticsConfiguration.

Input
  • ConfigurationToken [ReferenceToken]
    Reference to an existing VideoAnalyticsConfiguration.
    Maximum length: 64
Output
  • Rule - optional, unbounded; [Config]
    • Name - required; [string]
      Name of the configuration.
    • Type - required; [QName]
      The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
    • Parameters [ItemList]
      List of configuration parameters as defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • Value - required; [anySimpleType]
        Item value. The type is defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • SimpleItem - optional, unbounded; [complexType]
        Value name pair as defined by the corresponding description.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
      • ElementItem - optional, unbounded; [complexType]
        Complex value structure.
        • Name - required; [string]
          Item name.
      • Extension - optional; [ItemListExtension]

GetRuleOptions 

GetRuleOptions(ConfigurationToken, RuleType=None)

Return the options for the supported rules that specify an Option attribute.

Input
  • RuleType - optional; [QName]
    Reference to an SupportedRule Type returned from GetSupportedRules.
  • ConfigurationToken [ReferenceToken]
    Reference to an existing analytics configuration.
    Maximum length: 64
Output
  • RuleOptions - optional, unbounded; [ConfigOptions]
    A device shall provide respective ConfigOptions.RuleType for each RuleOption if the request does not specify RuleType. The response Options shall not contain any AnalyticsModule attribute.
    • RuleType - optional; [QName]
      The RuleType the ConfigOptions applies to if the Name attribute is ambiguous.
    • Name - required; [string]
      The Name of the SimpleItemDescription/ElementItemDescription the ConfigOptions applies to.
    • Type - optional; [QName]
      Type of the Rule Options represented by a unique QName. The Type defines the element contained in this structure. This attribute is deprecated since its value must be identical to the embedded element.
    • AnalyticsModule - optional; [QName]
      Optional name of the analytics module this constraint applies to. This option is only necessary in cases where different constraints for elements with the same Name exist.
    • minOccurs - optional; [int]
      Minimal number of occurrences. Defaults to one.
    • maxOccurs - optional; [int]
      Maximum number of occurrences. Defaults to one.

ModifyRules 

ModifyRules(ConfigurationToken, Rule)

Modify one or more rules of a VideoAnalyticsConfiguration.

The rules are referenced by their names.

Input
  • ConfigurationToken [ReferenceToken]
    Reference to an existing VideoAnalyticsConfiguration.
    Maximum length: 64
  • Rule - unbounded; [Config]
    • Name - required; [string]
      Name of the configuration.
    • Type - required; [QName]
      The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command.
    • Parameters [ItemList]
      List of configuration parameters as defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • Value - required; [anySimpleType]
        Item value. The type is defined in the corresponding description.
      • Name - required; [string]
        Item name.
      • SimpleItem - optional, unbounded; [complexType]
        Value name pair as defined by the corresponding description.
        • Name - required; [string]
          Item name.
        • Value - required; [anySimpleType]
          Item value. The type is defined in the corresponding description.
      • ElementItem - optional, unbounded; [complexType]
        Complex value structure.
        • Name - required; [string]
          Item name.
      • Extension - optional; [ItemListExtension]