Book a Demo

Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Prev Next

GetDefaultFieldMapping

Return a list of how the External Item fields and properties map to the Enterprise Architect element fields, properties and Tagged Values.

Inputs

Parameter

Details

parameters

  • C++: const char*
  • C#: string

A JSON string of parameters. Reserved for future use.

Outputs via Callbacks

AddProperty - 2-3 values per field to map. Use a unique index value for each mapping:

  • AddProperty(index, "externalField", "name");
  • AddProperty(index, "internalField", "name");
  • [Optional] AddProperty(index, "taggedValue", "My External Name");

[Optional] LogMessage or SetError - to provide user feedback.

Details

The values returned by this method are used to populate the Field Mapping in External Data Configuration.

The method defines the default values for how an External Item's fields/properties map to an Enterprise Architect element fields/properties/Tagged Values when linking an External Item.

The 'externalField' value should match the field ID as specified in GetFields, as well as the field names returned by, for example, GetItems.

The 'internalField' value should match an Enterprise Architect field name.

The options for internalField name are:

  • 'Name'
  • 'Alias'
  • 'Author'
  • 'Notes'
  • 'Tagged Value' - This is a special case and requires AddProperty(index, "taggedValue", "tagged value name") to specify the name of the Tagged Value to use
  • 'Status'
  • 'Version'
  • 'Phase'
  • 'Keywords'
  • 'Complexity'
  • 'Scope'
  • 'Multiplicity'
  • 'Classifier'
  • 'Abstract'
  • 'Is Leaf'
  • 'Language'
  • 'Filename'
  • 'Is Root'
  • 'Is Specification'
  • 'Persistence

Example:

  • AddProperty(index, "externalField", "modifiedDate");
  • AddProperty(index, "internalField", "Tagged Value");
  • AddProperty(index, "taggedValue", "Modified Date");