Features/Mass Deployment/Setting Files/XML/XmlSubTags/NotifyParsingRules

From Snom User Wiki

Jump to: navigation, search

NotifyParsingRules enclose a set of ParsingRules that are to be matched against received notifies.

NotifyParsingRules have these attributes:

  • type: defines what to use the rules for. Its value may be one of the following:
    • applies:
      • when it's parse-result is anything other than an empty string the received notify-xml is identified to be used for the described xml-entity (i.e. for the setting that has this xml description). In this case parsing continues instead of being aborted. Other NotifyParsingRules will only be used when this apply-rule returns a non-empty string.
      • must occur only once
      • mandatory
      • this rule is evaluated before all others
    • state:
      • determines the state (arbitrary string).
        • When used for key descriptions the state will be shown in PUI whenever showing the text representation of the state of the key (8xx virtual key view and 820 side screen). It also defines the LED associated with the key in conjunction with the led-settings (e.g. stk_led_on);
        • The state is also usefull to determine which other NotifyParsingRules (type = "array" or "variable") to use and which actions may apply.
      • must occur only once
      • optional
      • this is the 2nd rule being evaluated (right after apply-rule matches)
    • variable:
      • creates a variable within the context of this xml-entity - variable name is defined by the attribute "id".
      • may occur multiple times
      • optional
      • these rules get evaluated after apply- and optional state-rule, evaluating order is defined by order in the xml
    • array:
      • creates an array within the context of this xml-entity - array name is defined by the attribute "id".
      • the array size is determined by however many element-nodes (xml-tags) the Xpath of the matching ParsingRules points to.
      • may occur multiple times
      • optional
      • these rules get evaluated after apply- and optional state-rule, evaluating order is defined by order in the xml
  • id: defines the name/id of an array or variable.
    • value may be any alphanumeric string, except for these special tokens: state, type, index, value
    • an xml-entity should never have an array and variable of with the same id/name
    • only valid in NotifyParsingRules of type variable and array
  • states: contains multiple states in a coma-separated list-> The NotifyParsingRule will only be parsed when the current state of this xml-entity matches one of those in this list.
    • only valid in NotifyParsingRules of type variable and array
Personal tools
Interoperability