Dela via


Transportation Requirement in ESG data model

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

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

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all Industry Data Model entities are derived.
enThe requirement that mandates the use of the associated transportation.

Example:

  • Commute to work
  • Personal Transportation
  • Transportation to work
entitya reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeTransportationRequirement/(resolvedAttributes)/TransportationRequirementIdattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"1.6.0"string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{1FE0E94F-BC59-4D2B-8D18-51ED4AD6C749}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Party"string

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

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

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
TransportationRequirementId The unique identifier of a Transportation Requirement. TransportationRequirement
TransportationRequirementName The name of a Transportation Requirement. TransportationRequirement
TransportationRequirementDescription The description of a Transportation Requirement. TransportationRequirement

TransportationRequirementId

The unique identifier of a Transportation Requirement.
First included in: TransportationRequirement (this entity)

Properties

NameValue
displayNameTransportation Requirement ID
descriptionThe unique identifier of a Transportation Requirement.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the TransportationRequirementId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeTransportationRequirement/(resolvedAttributes)/TransportationRequirementIdattribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{11750339-83BF-4DCF-ADD0-A0297C41A976}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransportation Requirement 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
enThe unique identifier of a Transportation Requirement.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

TransportationRequirementName

The name of a Transportation Requirement.
First included in: TransportationRequirement (this entity)

Properties

NameValue
displayNameTransportation Requirement Name
descriptionThe name of a Transportation Requirement.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the TransportationRequirementName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{3F77DF16-D17A-4B85-B00D-CEEFEE54FB39}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransportation Requirement 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
enThe name of a Transportation Requirement.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"256"integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

TransportationRequirementDescription

The description of a Transportation Requirement.
First included in: TransportationRequirement (this entity)

Properties

NameValue
displayNameTransportation Requirement Description
descriptionThe description of a Transportation Requirement.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the TransportationRequirementDescription attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{012A8858-ACEE-49B4-B5F2-F98D1D869309}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransportation Requirement Description
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
enThe description of a Transportation Requirement.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.