Edit

Share via

Shipment consolidation template in Main(WHSShipConsolidationTemplate)

  • Article

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

ParameterValueData typeExplanation
attributeWHSShipConsolidationTemplate/(resolvedAttributes)/RecIdattribute

is.CDM.entityVersion

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

is.application.releaseVersion

ParameterValueData typeExplanation
releaseVersion"10.0.13.0"stringsemantic version number of the application introducing this entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShipment consolidation template
entitya reference to the constant entity holding the list of localized text

Attributes

Name Description First Included in Instance
RecId Main/WHSShipConsolidationTemplate
CriteriaQuery Main/WHSShipConsolidationTemplate
CustAccount Main/WHSShipConsolidationTemplate
Description Main/WHSShipConsolidationTemplate
DestinationCountryId Main/WHSShipConsolidationTemplate
DestinationFromPostalCode Main/WHSShipConsolidationTemplate
DestinationLocationId Main/WHSShipConsolidationTemplate
DestinationSiteId Main/WHSShipConsolidationTemplate
DestinationToPostalCode Main/WHSShipConsolidationTemplate
FilterCode1 Main/WHSShipConsolidationTemplate
FilterCode2 Main/WHSShipConsolidationTemplate
FilterCode3 Main/WHSShipConsolidationTemplate
FilterCode4 Main/WHSShipConsolidationTemplate
OriginCountryId Main/WHSShipConsolidationTemplate
OriginFromPostalCode Main/WHSShipConsolidationTemplate
OriginLocationId Main/WHSShipConsolidationTemplate
OriginSiteId Main/WHSShipConsolidationTemplate
OriginToPostalCode Main/WHSShipConsolidationTemplate
ShipConsolidationPolicyType Main/WHSShipConsolidationTemplate
ShipConsolidationTemplateName Main/WHSShipConsolidationTemplate
SplitByLoadTemplateMaxValues Main/WHSShipConsolidationTemplate
UpdateScheduledShipDateTime Main/WHSShipConsolidationTemplate
DataAreaId Main/WHSShipConsolidationTemplate
Relationship_DestinationCountryRegionRelationshipId Main/WHSShipConsolidationTemplate
Relationship_DestinationInventLocationRelationshipId Main/WHSShipConsolidationTemplate
Relationship_DestinationInventSiteRelationshipId Main/WHSShipConsolidationTemplate
Relationship_FilterCode1RelationshipId Main/WHSShipConsolidationTemplate
Relationship_FilterCode2RelationshipId Main/WHSShipConsolidationTemplate
Relationship_FilterCode3RelationshipId Main/WHSShipConsolidationTemplate
Relationship_FilterCode4RelationshipId Main/WHSShipConsolidationTemplate
Relationship_OriginCountryRegionRelationshipId Main/WHSShipConsolidationTemplate
Relationship_OriginInventLocationRelationshipId Main/WHSShipConsolidationTemplate
Relationship_OriginInventSiteRelationshipId Main/WHSShipConsolidationTemplate
Relationship_CustTableRelationshipId Main/WHSShipConsolidationTemplate
Relationship_CompanyRelationshipId Main/WHSShipConsolidationTemplate

RecId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
isPrimaryKeytrue
dataFormatint64
isReadOnlytrue

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

ParameterValueData typeExplanation
attributeWHSShipConsolidationTemplate/(resolvedAttributes)/RecIdattribute

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

CriteriaQuery

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatbinary

Traits

List of traits for the CriteriaQuery attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.dataFormat.byte
is.dataFormat.array

CustAccount

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the CustAccount 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

Description

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the Description 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

DestinationCountryId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DestinationCountryId 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

DestinationFromPostalCode

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DestinationFromPostalCode 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

DestinationLocationId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DestinationLocationId 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

DestinationSiteId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DestinationSiteId 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

DestinationToPostalCode

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DestinationToPostalCode 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

FilterCode1

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the FilterCode1 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

FilterCode2

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
displayNameCode 2
dataFormatstring
isNullabletrue

Traits

List of traits for the FilterCode2 attribute are listed below.

is.dataFormat.character
is.dataFormat.big
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.

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

is.dataFormat.character
is.dataFormat.array

FilterCode3

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
displayNameCode 3
dataFormatstring
isNullabletrue

Traits

List of traits for the FilterCode3 attribute are listed below.

is.dataFormat.character
is.dataFormat.big
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.

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

is.dataFormat.character
is.dataFormat.array

FilterCode4

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
displayNameCode 4
dataFormatstring
isNullabletrue

Traits

List of traits for the FilterCode4 attribute are listed below.

is.dataFormat.character
is.dataFormat.big
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.

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

is.dataFormat.character
is.dataFormat.array

OriginCountryId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OriginCountryId 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

OriginFromPostalCode

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OriginFromPostalCode 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

OriginLocationId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OriginLocationId 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

OriginSiteId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OriginSiteId 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

OriginToPostalCode

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OriginToPostalCode 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

ShipConsolidationPolicyType

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatint32

Traits

List of traits for the ShipConsolidationPolicyType attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

ShipConsolidationTemplateName

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring

Traits

List of traits for the ShipConsolidationTemplateName attribute are listed below.

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

SplitByLoadTemplateMaxValues

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
displayNameSplit by load capacity
dataFormatint32
isNullabletrue

Traits

List of traits for the SplitByLoadTemplateMaxValues 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSplit by load capacity
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateScheduledShipDateTime

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
displayNameUpdate scheduled ship date time on load to requested ship date on order
dataFormatint32
isNullabletrue

Traits

List of traits for the UpdateScheduledShipDateTime 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUpdate scheduled ship date time on load to requested ship date on order
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataAreaId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the DataAreaId attribute are listed below.

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

Relationship_DestinationCountryRegionRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_DestinationCountryRegionRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/Common/GAB/Group/LogisticsAddressCountryRegion.cdm.json/LogisticsAddressCountryRegionRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_DestinationInventLocationRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_DestinationInventLocationRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/InventLocation.cdm.json/InventLocationRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_DestinationInventSiteRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_DestinationInventSiteRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/InventSite.cdm.json/InventSiteRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_FilterCode1RelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_FilterCode1RelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/WHSFilters.cdm.json/WHSFiltersRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_FilterCode2RelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_FilterCode2RelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/WHSFilters.cdm.json/WHSFiltersRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_FilterCode3RelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_FilterCode3RelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/WHSFilters.cdm.json/WHSFiltersRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_FilterCode4RelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_FilterCode4RelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/WHSFilters.cdm.json/WHSFiltersRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_OriginCountryRegionRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_OriginCountryRegionRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/Common/GAB/Group/LogisticsAddressCountryRegion.cdm.json/LogisticsAddressCountryRegionRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_OriginInventLocationRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_OriginInventLocationRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/InventLocation.cdm.json/InventLocationRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_OriginInventSiteRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_OriginInventSiteRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/SupplyChain/Inventory/Group/InventSite.cdm.json/InventSiteRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_CustTableRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_CustTableRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/Common/Customer/Main/CustTable.cdm.json/CustTableRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_CompanyRelationshipId

First included in: Main/WHSShipConsolidationTemplate (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
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/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfoRecId
entitya reference to the constant entity holding the list of entity references

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