Skip to main content
Version: 1.x

Interface: VocabularyTerm

A single vocabulary term with its synonyms and selector information.

Remarks​

Represents one named concept in a SAP business domain. The name is the canonical identifier; synonyms are alternative human-readable names that also resolve to this term. The selector (if present) enables direct UI5 control discovery.

Example​

const term: VocabularyTerm = {
name: 'supplier',
synonyms: ['vendor', 'vendorId', 'supplierId'],
domain: 'procurement',
sapField: 'LIFNR',
selector: { controlType: 'sap.m.Input', properties: { labelFor: 'Supplier' } },
};

Properties​

domain​

readonly domain: SAPDomain

The SAP domain this term belongs to.


name​

readonly name: string

Canonical term name.


sapField?​

readonly optional sapField?: string

The underlying SAP ABAP field name (e.g. 'LIFNR').


selector?​

readonly optional selector?: UI5Selector

UI5 selector for direct control discovery.


synonyms​

readonly synonyms: readonly string[]

Alternative names that also resolve to this term.