Skip to main content

Modeling an Interface

Using Txture's default Structure model, there is a separate Asset-Type for depicting and modeling an interface between two or more application instances, databases or other technical components. For the sake of simplicity, we will only describe the modeling of interfaces between application instances. The procedure is the same for the other asset types.

Properties & Links​

All information about the interface and the data transferred by the interface is managed on the interface asset as properties. Examples from the default structure model are:

  • Personal Data is processed (yes/no)
  • Used Ports
  • Protocol Types
  • Traffic

In addition to the interface asset type, two types of links between the application and the interface exist:

  1. An application instance provides an interface.
  2. An application instance communicates with an interface.

Important

Each interface asset is provided by exactly one single application instance (provides-link is single-valued) but one or more application instances can communicate with the interface (communicates with-link can be multi-valued).

Naming​

It is recommended to ensure a unique and transparent naming of interfaces. We recommend to name the interface after what will be handled via the interface. If nothing specific exists, name it after the application instance providing it. If an application instance provides a generic interface via several protocols, it is recommended to create a separate interface asset for each single protocol, e.g.

  • Asset 1: "BRM LDAP"
  • Asset 2: "BRM Http"

Examples​

The following screenshots show examples, one for modeling a "1-to-1 interface", the second one shows how to model a "1-to-n interface". The last one shows an example where separate interface assets have been modeled for multiple protocol-types: