Prev Next

GetFields

Return a list of known fields and properties in the External Provider.

Inputs

Parameter

Details

parameters

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

A JSON string of parameters. Reserved for future use.

Outputs via Callbacks

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

  • AddProperty(index, "id", "type");
  • AddProperty(index, "name", "Type");

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

Details

Most systems have an ID or non user-friendly name, as well as a user-friendly display name. Only Fields that are returned here will be recognized by Enterprise Architect.

The values returned here will be matched against the Type returned in DefaultFieldMapping and GetItem.

If possible, this list of fields should be dynamically created by querying the External Provider for a list of its known fields. The list of fields can be hard-coded for providers that do not provide a list of fields.