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

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

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

Parameter	Value	Data type	Explanation
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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Product Signal	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en An enriched telemetry signal from a product, service or device.	entity	a 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

Name	Value
displayName	Signal Timestamp
description	DateTime signal was sent from device. DateTime value stored as UTC. Field is required.
dataFormat	dateTime

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Signal Timestamp	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en DateTime signal was sent from device. DateTime value stored as UTC. Field is required.	entity	a 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

Name	Value
displayName	Timezone
description	Timezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Timezone	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Timezone as captured from signal during ingestion. Server stores timezone as specified on signal.timestamp, unless device directly specifies this value.	entity	a 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

Name	Value
displayName	Signal Name
description	Name of signal
dataFormat	string

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Signal Name	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Name of signal	entity	a 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

Name	Value
displayName	Signal Version
description	Version of signal, as defined by device
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Signal Version	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Version of signal, as defined by device	entity	a 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

Name	Value
displayName	Server Timestamp
description	DateTime signal was received ingested by server
dataFormat	dateTime

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Server Timestamp	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en DateTime signal was received ingested by server	entity	a 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

Name	Value
displayName	Product
description	Reference to Product entity identifier within CDS.
dataFormat	guid

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Product	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Reference to Product entity identifier within CDS.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/foundationCommon/Product.cdm.json/Product productId	entity	a 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

Name	Value
displayName	Part Number
description	This is the 'friendly' product name as referred to in CDS.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Part Number	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en This is the 'friendly' product name as referred to in CDS.	entity	a 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

Name	Value
displayName	Device Id
description	Unique device ID as referred to within IoT and CDS platforms
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Device Id	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique device ID as referred to within IoT and CDS platforms	entity	a 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

Name	Value
displayName	Serial Number
description	A unique end-user friendly reference ID generally found within most devices.
dataFormat	string

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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Serial Number	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A unique end-user friendly reference ID generally found within most devices.	entity	a 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

Name	Value
displayName	Asset
description	Reference to Asset entity identifier within CDS.
dataFormat	guid

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Asset	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Reference to Asset entity identifier within CDS.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/foundationCommon/productInsights/Asset.cdm.json/Asset assetId	entity	a reference to the constant entity holding the list of entity references

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