Glossary and Abbreviations

This page defines the terms and abbreviations used in the Forge documentation.

Terms

API pillar

The configuration pillar that affects the generated embedded code APIs. Changing API configuration may require rebuilding user code. See also pillar.

Basic Workflow

The low-level configuration level. You write declarative JSON files, and a JSON Schema validates them. Use it to produce configuration without a Python environment. See also Comfort Workflow.

Comfort Workflow

The high-level configuration level. You write imperative Python code that uses Pydantic models and facades to generate, transform, and validate configuration. See also Basic Workflow.

Configurable Unit

One piece of VES that you configure, such as the ComDaemon or the client libraries inside a user application. Each Configurable Unit maps to exactly one subcomponent, but not every subcomponent is a Configurable Unit.

configuration domain

An abstract grouping of Configurable Units by functional area, such as Communication and Diagnostics. A domain has no package of its own and can span several Integration Components.

configuration schema

A class that backs one configuration pillar of a Configurable Unit. When exported, each configuration schema produces one JSON file.

converter

A module in an Integration Component package that translates external file formats, such as ARXML or Franca IDL, into Forge Python objects or JSON files. Use converters to migrate existing configurations.

data model

The Python representation of the configuration structure of one Configurable Unit, implemented as a Pydantic model (ConfigUnitDataModel). A data model bundles all three configuration pillars and is also available as a JSON schema.

facade

A class (ConfigUnitFacade) that wraps a Configurable Unit data model and provides a higher-level API. Facades construct Configurable Units with sensible defaults, apply opinionated settings, and export the result to JSON. They’re the primary entry point for configuring VES in Python.

Foundation

The base package fsp-config-foundation that every other Forge package depends on. It provides base classes for data models and facades, import and export tooling, the validation framework, and the plugin system.

Implementation pillar

The configuration pillar that affects generated implementation details. Changes require a rebuild. See also pillar.

Integration Component

The top-level deliverable item of VES, for example, ves-aracom. Forge provides one Python package per Integration Component.

pillar

One of the three parts of every Configurable Unit’s configuration. The pillar depends on when the configuration takes effect: API pillar, Implementation pillar, or Runtime pillar.

Runtime pillar

The configuration pillar that controls behavior at runtime without recompilation. See also pillar.

subcomponent

A part of an Integration Component that combines BSW libraries, for example, the ComDaemon. See also Configurable Unit.

validation rule

A plain Python function, registered by a domain package, that checks the in-memory data model. A validation rule returns findings with a severity level of error or warning.

Abbreviations

Abbreviation Description

API

Application Programming Interface

ARXML

AUTOSAR XML

BSW

Basic Software

CI/CD

Continuous Integration and Continuous Delivery

CLI

Command Line Interface

IDL

Interface Definition Language

JSON

JavaScript Object Notation

VES

Vector Embedded Software