Glossary · Automation software engineering and architecture
Provided interface
Also known as: Offered interface
German: Bereitgestellte Schnittstelle
In component-based software and system modeling, a provided interface is an interface that a component implements and offers to other components, defining the operations or services they can use.
- Software engineering
In one sentence
A provided interface is an interface a component implements and offers to others, defining the services they can use.
Example
The recipe management component provides an interface with LoadRecipe and SaveRecipe, which the HMI and the MES connector both use.
How it applies
- Engineering: Architecture models show provided interfaces (a ball symbol in UML component diagrams) and connect them to matching required interfaces. A component can be replaced if the replacement provides the same interface.
- Change control: Changes to a provided interface affect every consumer; they need versioning and Impact analysis.
- Documentation: Provided interfaces are what integrators program against, so they need complete reference documentation: operations, parameters, units, errors and version. An Interface specification or ICD is the formal home for this.
Provided vs. required interface
A provided interface is what a component offers. A Required interface is what a component needs from others to work. Wiring an architecture means connecting each required interface to a compatible provided interface.