Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version 4

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

name

Name

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


Y

label

Label

A user friendly display name for the event, to be displayed within the client.

The Label must be unique.

Y

description

Description

An option description of the Universal Event.


N

TTL

Time To Live

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

non-negative Integer

N

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

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
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

Property

UI Field Name

Description

Specifications

Required

name

Name

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


Y

label

Label

A user friendly display name for the attribute, to be displayed within the client.

The Attribute Label must be unique.

Y

type

Type

The 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

...

Anchor
Create a Universal Event Template
Create a Universal Event Template
Create a Universal Event Template


Description

URI

http://host_name/uc/resources/universaleventtemplate

HTTP Method

POST

Description

Creates a new Universal Event Template.

Example URI

http://localhost:8080/uc/resources/universaleventtemplate

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Create, Modify, and Read a Universal Template: XML and JSON Examples, below.

Universal Template Properties

See Universal Template Properties.

Field Properties

See Field Properties.

Choice Properties

See Choice Properties.

Example Response

  • Status 200 /OK
    Successfully created the universal template with sysId {sysId}.
  • Status 400 /Bad Request
    Create universal template failed. (message).