Alerts - rule in Main(EventRule)

Article
02/22/2022

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	EventRule/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Alerts - rule

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Main/EventRule
ActionNames		Main/EventRule
AlertFieldId		Main/EventRule
AlertFieldLabel		Main/EventRule
AlertInstanceRelationType		Main/EventRule
AlertQbdsNo		Main/EventRule
AlertTableId		Main/EventRule
CompanyId		Main/EventRule
DeleteRefRecId		Main/EventRule
Enabled		Main/EventRule
FormName		Main/EventRule
GlobalRule		Main/EventRule
IsAggregated		Main/EventRule
Message		Main/EventRule
PrimInstanceRelationType		Main/EventRule
PrimTableId		Main/EventRule
RuleCondition		Main/EventRule
RuleId		Main/EventRule
Subject		Main/EventRule
TypeId		Main/EventRule
TypeTrigger		Main/EventRule
Until		Main/EventRule
UntilDate		Main/EventRule
UserId		Main/EventRule
MenuItemType		Main/EventRule
MenuItemName		Main/EventRule
EmailRecipients		Main/EventRule
SendAlertEmail		Main/EventRule
EnabledForExternal		Main/EventRule

RecId

First included in: Main/EventRule (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	EventRule/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

ActionNames

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Event actions
dataFormat	binary
isNullable	true

Traits

List of traits for the ActionNames attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Event actions

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array

AlertFieldId

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Alert field ID
dataFormat	int32
isNullable	true

Traits

List of traits for the AlertFieldId attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Alert field ID

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

AlertFieldLabel

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AlertFieldLabel attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AlertInstanceRelationType

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the AlertInstanceRelationType attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

AlertQbdsNo

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the AlertQbdsNo attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

AlertTableId

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Alert table ID
dataFormat	int32
isNullable	true

Traits

List of traits for the AlertTableId attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Alert table ID

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CompanyId

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CompanyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeleteRefRecId

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Record delete
dataFormat	int64
isNullable	true

Traits

List of traits for the DeleteRefRecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Record delete

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

Enabled

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Enabled
dataFormat	int32
isNullable	true

Traits

List of traits for the Enabled attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Enabled

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

FormName

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the FormName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

GlobalRule

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the GlobalRule attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

IsAggregated

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IsAggregated attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Message

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Message attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimInstanceRelationType

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the PrimInstanceRelationType attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

PrimTableId

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Primary table ID
dataFormat	int32

Traits

List of traits for the PrimTableId attribute are listed below.

is.dataFormat.integer
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Primary table ID

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RuleCondition

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the RuleCondition attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

RuleId

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the RuleId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

Subject

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Subject attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TypeId

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the TypeId attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

TypeTrigger

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TypeTrigger attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Until

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Until attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

UntilDate

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the UntilDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

UserId

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the UserId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

MenuItemType

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the MenuItemType attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

MenuItemName

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the MenuItemName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmailRecipients

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmailRecipients attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SendAlertEmail

First included in: Main/EventRule (this entity)

Properties

Name	Value
displayName	Send email
dataFormat	int32
isNullable	true

Traits

List of traits for the SendAlertEmail attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Send email

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

EnabledForExternal

First included in: Main/EventRule (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the EnabledForExternal attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Share via

Alerts - rule in Main(EventRule)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources