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>
        <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>
    <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>
    <TTLttl>11</TTLttl>
</eventTemplate>
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",
    "TTLttl": 11
}

Anchor
Delete a Universal Event Template
Delete a Universal Event Template
Delete a Universal Event Template

...

XML

JSON

Expand
titleXML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<unversialEventTemplates>
    <eventTemplate>
        <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>
        <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>
        <TTLttl>11</TTLttl>
    </eventTemplate>
    <eventTemplate>
        <attributes>
            <attribute>
                <label>attribute_label1</label>
                <name>attribute_name1</name>
                <type>Integer</type>
            </attribute>
            <attribute>
                <label>attribute_label4</label>
                <name>attribute_name4</name>
                <type>Float</type>
            </attribute>
        </attributes>
        <attributesPolicy>Prohibit Universal Event</attributesPolicy>
        <description>description.</description>
        <label>Universal Event - Label2</label>
        <name>universal_event_template2</name>
        <sysId>982a434746fc4618aa55d7928ba1f3e4</sysId>
        <TTL ttl />
    </eventTemplate>
    <eventTemplate>
        <attributes>
            <attribute>
                <label>attribute_label1</label>
                <name>attribute_name1</name>
                <type>Integer</type>
            </attribute>
            <attribute>
                <label>attribute_label4</label>
                <name>attribute_name4</name>
                <type>Float</type>
            </attribute>
        </attributes>
        <attributesPolicy>Prohibit Universal Event</attributesPolicy>
        <description>description.</description>
        <label>Universal Event - Label2 - Copy</label>
        <name>universal_event_template2_copy</name>
        <sysId>814b1b35ea844407b6cd378f149d61a3</sysId>
        <TTL ttl />
    </eventTemplate>
</unversialEventTemplates>



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",
        "sysId": "66c6e90f5a334378809884a11cb12ac0",
        "TTLttl": 11
    },
    {
        "attributes": [
            {
                "label": "attribute_label1",
                "name": "attribute_name1",
                "type": "Integer"
            },
            {
                "label": "attribute_label4",
                "name": "attribute_name4",
                "type": "Float"
            }
        ],
        "attributesPolicy": "Prohibit Universal Event",
        "description": "description.",
        "label": "Universal Event - Label2",
        "name": "universal_event_template2",
        "sysId": "982a434746fc4618aa55d7928ba1f3e4",
        "TTLttl": null
    },
    {
        "attributes": [
            {
                "label": "attribute_label1",
                "name": "attribute_name1",
                "type": "Integer"
            },
            {
                "label": "attribute_label4",
                "name": "attribute_name4",
                "type": "Float"
            }
        ],
        "attributesPolicy": "Prohibit Universal Event",
        "description": "description.",
        "label": "Universal Event - Label2 - Copy",
        "name": "universal_event_template2_copy",
        "sysId": "814b1b35ea844407b6cd378f149d61a3",
        "TTLttl": null


Anchor
Modify a Universal Event Template
Modify a Universal Event Template
Modify a Universal Event Template

...

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 - TTLttl
UET - TTLttl
TTLttl

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

...