Product Signal in productInsights(Signal)

An enriched telemetry signal from a product, service or device.

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

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/applicationCommon/foundationCommon
/productInsights/Signal.cdm.json/Signal
/hasAttributes/attributesAddedAtThisScope
entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProduct Signal
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn enriched telemetry signal from a product, service or device.
entitya reference to the constant entity holding the list of localized text

Attributes

Name Description First Included in Instance
signalTime DateTime signal was sent from device. DateTime value stored as UTC. Field is required. productInsights/Signal
timezone Timezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value. productInsights/Signal
name Name of signal productInsights/Signal
version Version of signal, as defined by device productInsights/Signal
serverTime DateTime signal was received ingested by server productInsights/Signal
productId Reference to Product entity identifier within CDS. productInsights/Signal
partNumber This is the 'friendly' product name as referred to in CDS. productInsights/Signal
deviceId Unique device ID as referred to within IoT and CDS platforms productInsights/Signal
serialNumber A unique end-user friendly reference ID generally found within most devices. productInsights/Signal
assetId Reference to Asset entity identifier within CDS. productInsights/Signal

signalTime

DateTime signal was sent from device. DateTime value stored as UTC. Field is required.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameSignal Timestamp
descriptionDateTime signal was sent from device. DateTime value stored as UTC. Field is required.
dataFormatdateTime

Traits

List of traits for the signalTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.occurrence
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSignal Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDateTime signal was sent from device. DateTime value stored as UTC. Field is required.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

timezone

Timezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameTimezone
descriptionTimezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value.
dataFormatstring

Traits

List of traits for the timezone attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.location.timezone
is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTimezone
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTimezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

name

Name of signal
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameSignal Name
descriptionName of signal
dataFormatstring

Traits

List of traits for the name attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSignal Name
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enName of signal
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

version

Version of signal, as defined by device
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameSignal Version
descriptionVersion of signal, as defined by device
dataFormatstring

Traits

List of traits for the version attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.measurement.version
is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSignal Version
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion of signal, as defined by device
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

serverTime

DateTime signal was received ingested by server
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameServer Timestamp
descriptionDateTime signal was received ingested by server
dataFormatdateTime

Traits

List of traits for the serverTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enServer Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDateTime signal was received ingested by server
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

productId

Reference to Product entity identifier within CDS.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameProduct
descriptionReference to Product entity identifier within CDS.
dataFormatguid

Traits

List of traits for the productId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProduct
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReference to Product entity identifier within CDS.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/Product.cdm.json/ProductproductId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

partNumber

This is the 'friendly' product name as referred to in CDS.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNamePart Number
descriptionThis is the 'friendly' product name as referred to in CDS.
dataFormatstring

Traits

List of traits for the partNumber attribute are listed below.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPart Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThis is the 'friendly' product name as referred to in CDS.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

deviceId

Unique device ID as referred to within IoT and CDS platforms
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameDevice Id
descriptionUnique device ID as referred to within IoT and CDS platforms
dataFormatstring

Traits

List of traits for the deviceId attribute are listed below.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDevice Id
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique device ID as referred to within IoT and CDS platforms
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

serialNumber

A unique end-user friendly reference ID generally found within most devices.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameSerial Number
descriptionA unique end-user friendly reference ID generally found within most devices.
dataFormatstring

Traits

List of traits for the serialNumber attribute are listed below.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSerial Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA unique end-user friendly reference ID generally found within most devices.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

assetId

Reference to Asset entity identifier within CDS.
First included in: productInsights/Signal (this entity)

Properties

NameValue
displayNameAsset
descriptionReference to Asset entity identifier within CDS.
dataFormatguid

Traits

List of traits for the assetId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAsset
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReference to Asset entity identifier within CDS.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/productInsights/Asset.cdm.json/AssetassetId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array