Global address book parameters in Parameter(DirParameters)

Article
02/22/2022

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	DirParameters/(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	Global address book parameters

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Parameter/DirParameters
AutoDeleteParty		Parameter/DirParameters
DunsCheckUnique		Parameter/DirParameters
DunsDisplayOnAddress		Parameter/DirParameters
Key		Parameter/DirParameters
NameSequence		Parameter/DirParameters
NumSeqCompanyId		Parameter/DirParameters
PartyDefaultPartyType		Parameter/DirParameters
UseDuplicateCheck		Parameter/DirParameters
BusRelDefaultPartyType		Parameter/DirParameters
CompetitorDefaultPartyType		Parameter/DirParameters
CustDefaultPartyType		Parameter/DirParameters
VendDefaultPartyType		Parameter/DirParameters
EnableEditForExternallyMaintainedFields		Parameter/DirParameters
Relationship_DirNameSequence_FKRelationshipId		Parameter/DirParameters

RecId

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

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

AutoDeleteParty

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the AutoDeleteParty attribute are listed below.

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

is.dataFormat.integer

DunsCheckUnique

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Check for unique DUNS number
dataFormat	int32
isNullable	true

Traits

List of traits for the DunsCheckUnique 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	Check for unique DUNS number

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DunsDisplayOnAddress

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Display DUNS number on addresses
dataFormat	int32
isNullable	true

Traits

List of traits for the DunsDisplayOnAddress 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	Display DUNS number on addresses

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Key

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Key attribute are listed below.

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

is.dataFormat.integer

NameSequence

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the NameSequence attribute are listed below.

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

NumSeqCompanyId

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the NumSeqCompanyId attribute are listed below.

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

PartyDefaultPartyType

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Party
dataFormat	int32

Traits

List of traits for the PartyDefaultPartyType attribute are listed below.

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Party

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UseDuplicateCheck

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Use duplicate check
dataFormat	int32
isNullable	true

Traits

List of traits for the UseDuplicateCheck 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	Use duplicate check

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

BusRelDefaultPartyType

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Prospect
dataFormat	int32
isNullable	true

Traits

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

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CompetitorDefaultPartyType

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Competitor
dataFormat	int32
isNullable	true

Traits

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

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CustDefaultPartyType

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Customer
dataFormat	int32
isNullable	true

Traits

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

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

VendDefaultPartyType

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Vendor
dataFormat	int32
isNullable	true

Traits

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

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

EnableEditForExternallyMaintainedFields

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
displayName	Enable edit for externally maintained fields
dataFormat	int32
isNullable	true

Traits

List of traits for the EnableEditForExternallyMaintainedFields 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	Enable edit for externally maintained fields

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Relationship_DirNameSequence_FKRelationshipId

First included in: Parameter/DirParameters (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_DirNameSequence_FKRelationshipId 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/DirNameSequence.cdm.json/DirNameSequence	RecId

entity

a reference to the constant entity holding the list of entity references

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

Share via

Global address book parameters in Parameter(DirParameters)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources