Versions Compared

Key

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

...

XML

JSON

Expand
titleXML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventTemplate retainSysIds="true">
    <attributes>    <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>
        <attribute>
            <label>attribute_label3</label>
            <name>attribute_name3</name>
            <type>Boolean</type>
        </attribute>
        <attribute>
            <label>attribute_label4</label>
            <name>attribute_name4</name>
            <type>Float</type>
        </attribute>
    </attributes>attributes>
    <attributesPolicy>Include Attributes</attributesPolicy>
    <description>Global universal event template description.</description>
    <label>Global Universal Event - Label</label>
    <name>global_universal_event_template</name>
    <sysId>66c6e90f5a334378809884a11cb12ac0</sysId>
    <TTL>11</TTL>
</eventTemplate>

attributes

Expand
titleJSON

{
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        },
        {
            "label": "attribute_label3",
            "name": "attribute_name3",
            "type": "Boolean"
        },
        {
            "label": "attribute_label4",
            "name": "attribute_name4",
            "type": "Float"
        }
    ],
    "attributesPolicy": "Include Attributes",
    "description": "Global universal event template description.",
    "label": "Global Universal Event - Label",
    "name": "global_universal_event_template",
    "retainSysIds": true,
    "sysId": "66c6e90f5a334378809884a11cb12ac0",
    "ttl": 11
}

...

labelTTLattributePolicyattributes    "attributes": [         {             "

Attributes

Property

UI Field Name

Description

Specifications

Required

Anchor
UET - nameattributePolicy
UET - nameattributePolicy
nameattributePolicy

Name

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

Y

Anchor
UET - labelUET - label

Label

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

The Label must be unique.

YUnmapped 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 - descriptionattributes
UET - descriptionattributes
descriptionattributes

Description

Description of the Universal Event.

N

Anchor
UET - TTLUET - 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 - attributePolicyUET - attributePolicy

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 - attributesUET - 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

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_label1label2",
            "name": "attribute_name1name2",
            "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
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

...