Versions Compared

Old Version 13

changes.mady.by.user Former user

Saved on

compared with

New Version 14

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate> element of XML web services.

Property

UI Field Name

Description

Specifications

Required

Anchor
UET - attributesPolicy
UET - attributesPolicy
attributesPolicy

Unmapped Attributes Policy

Defines how unmapped/unknown attributes that are in the published event are handled.

Valid values:

  • As String = Prohibit Universal Event, As Value = 1

  • As String = Include Attributes, As Value = 2

  • As String = Exclude Attributes, As Value = 3

Default is Prohibit Universal Event (1).

N

Anchor
UET - attributes
UET - attributes
attributes

Attributes

Zero or more attributes, specifying their Name, Label, and Type.

Expand
titleXML
Code Block
languagetext
    <attributes>
        <attribute>
            <label>attribute_label1</label>
            <name>attribute_name1</name>
            <type>Text</type>
        </attribute>
        <attribute>
            <label>attribute_label2</label>
            <name>attribute_name2</name>
            <type>Integer</type>
        </attribute>
    </attributes>
Expand
titleJSON
Code Block
languagetext
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }
    ]
N

Anchor
UET - description
UET - description
description

Description

Description of the Universal Event.


N

Anchor
UET - label
UET - label
label

Label

User-friendly display name for the event, to be displayed within the client.

The Label must be unique.

Y

Anchor
UET - name
UET - name
name

Name

Unique event name, adhering to the same naming convention as a Universal Template field name.


Y

Anchor
UET - ttl
UET - ttl
ttl

Time To Live

Default value for Time to live; how long, in minutes, the Universal Event data is valid.

non-negative Integer

N

Anchor
UET - sysId
UET - sysId
sysId

n/asys_id used within the Controller to identify this record.Persisted only if retainSysIds is set to true.N

Anchor
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

Property

UI Field Name

Description

Specifications

Required

Anchor
UETA - label
UETA - label
label

Label

User-friendly display name for the attribute, to be displayed within the client.

Attribute Label must be unique.

Y

Anchor
UETA - name
UETA - name
name

Name

Unique attribute name, adhering to the same naming convention as a Universal Template field name.


Y

Anchor
UETA - type
UETA - type
type

Type

Attribute type.

Valid values:

  • As String = Text, As Value = 1

  • As String = Integer, As Value = 2

  • As String = Boolean, As Value = 3

  • As String = Float, As Value = 4

Y


Anchor
Restore Default Universal Template Icon
Restore Default Universal Template Icon
Restore Default Universal Template Icon

...