TRX Parameters in Parameter(TMSParameters)

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	TMSParameters/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	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 TRX Parameters	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Parameter/TMSParameters
AutoCreateLoadPO		Parameter/TMSParameters
AutoCreateLoadSO		Parameter/TMSParameters
AutoCreateLoadTO		Parameter/TMSParameters
BOLCarrierRoleRecId		Parameter/TMSParameters
DefaultDuration		Parameter/TMSParameters
DefaultNoteName		Parameter/TMSParameters
DefaultNoteType		Parameter/TMSParameters
DirectDeliveryCustomerCharge		Parameter/TMSParameters
DriverCheckOutInterval		Parameter/TMSParameters
EnableInvoiceWorkflow		Parameter/TMSParameters
FBGLJourLineTransTxt		Parameter/TMSParameters
InTransitPlanning		Parameter/TMSParameters
LoadNoteType		Parameter/TMSParameters
MatchAndPay		Parameter/TMSParameters
MatchInterval		Parameter/TMSParameters
OverrideShipConfirmDate		Parameter/TMSParameters
ParametersKey		Parameter/TMSParameters
PlanByShipment		Parameter/TMSParameters
PortHubType		Parameter/TMSParameters
PostJournal		Parameter/TMSParameters
VendJournalName		Parameter/TMSParameters
VendOffAcct		Parameter/TMSParameters
WorkflowUser		Parameter/TMSParameters
WriteInvoiceJournal		Parameter/TMSParameters
EnableFreightReconcile		Parameter/TMSParameters
CreateMasterBOL		Parameter/TMSParameters
SeparateShipConfirmationForMixedLoads		Parameter/TMSParameters
DataAreaId		Parameter/TMSParameters
Relationship_DefaultNoteTypeRelationshipId		Parameter/TMSParameters
Relationship_DocuTypeRelationshipId		Parameter/TMSParameters
Relationship_LedgerJournalNameRelationshipId		Parameter/TMSParameters
Relationship_LogisticsLocationRoleRelationshipId		Parameter/TMSParameters
Relationship_TMSHubTypeRelationshipId		Parameter/TMSParameters
Relationship_CompanyRelationshipId		Parameter/TMSParameters

RecId

First included in: Parameter/TMSParameters (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	TMSParameters/(resolvedAttributes)/RecId	attribute

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

AutoCreateLoadPO

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the AutoCreateLoadPO attribute are listed below.

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

is.dataFormat.integer

AutoCreateLoadSO

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the AutoCreateLoadSO attribute are listed below.

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

is.dataFormat.integer

AutoCreateLoadTO

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the AutoCreateLoadTO attribute are listed below.

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

is.dataFormat.integer

BOLCarrierRoleRecId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

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

DefaultDuration

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
displayName	Default duration
dataFormat	int32
isNullable	true

Traits

List of traits for the DefaultDuration 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 Default duration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DefaultNoteName

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DefaultNoteType

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DirectDeliveryCustomerCharge

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DirectDeliveryCustomerCharge attribute are listed below.

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

is.dataFormat.integer

DriverCheckOutInterval

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DriverCheckOutInterval attribute are listed below.

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

is.dataFormat.integer

EnableInvoiceWorkflow

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the EnableInvoiceWorkflow attribute are listed below.

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

is.dataFormat.integer

FBGLJourLineTransTxt

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

InTransitPlanning

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the InTransitPlanning attribute are listed below.

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

is.dataFormat.integer

LoadNoteType

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

MatchAndPay

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MatchAndPay attribute are listed below.

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

is.dataFormat.integer

MatchInterval

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MatchInterval attribute are listed below.

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

is.dataFormat.integer

OverrideShipConfirmDate

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the OverrideShipConfirmDate attribute are listed below.

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

is.dataFormat.integer

ParametersKey

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the ParametersKey attribute are listed below.

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

is.dataFormat.integer

PlanByShipment

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PlanByShipment attribute are listed below.

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

is.dataFormat.integer

PortHubType

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

PostJournal

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PostJournal attribute are listed below.

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

is.dataFormat.integer

VendJournalName

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendOffAcct

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

WorkflowUser

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

WriteInvoiceJournal

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the WriteInvoiceJournal attribute are listed below.

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

is.dataFormat.integer

EnableFreightReconcile

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the EnableFreightReconcile attribute are listed below.

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

is.dataFormat.integer

CreateMasterBOL

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the CreateMasterBOL attribute are listed below.

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

is.dataFormat.integer

SeparateShipConfirmationForMixedLoads

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the SeparateShipConfirmationForMixedLoads attribute are listed below.

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

is.dataFormat.integer

DataAreaId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

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_DefaultNoteTypeRelationshipId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Group/DocuType.cdm.json/DocuType RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_DocuTypeRelationshipId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Group/DocuType.cdm.json/DocuType RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_LedgerJournalNameRelationshipId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/AccountingFoundation/Group/LedgerJournalName.cdm.json/LedgerJournalName RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_LogisticsLocationRoleRelationshipId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Common/GAB/Reference/LogisticsLocationRole.cdm.json/LogisticsLocationRole RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_TMSHubTypeRelationshipId

First included in: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/SupplyChain/Transportation/Group/TMSHubType.cdm.json/TMSHubType RecId	entity	a 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: Parameter/TMSParameters (this entity)

Properties

Name	Value
dataFormat	guid

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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo RecId	entity	a reference to the constant entity holding the list of entity references

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