System description conventions

System description

For all information within the System description area to be properly displayed at least one model of the Access diagram type must exist. This diagram must be stored in the same database group in which the IT system is defined as an application system type (System). The IT system must have an occurrence in the diagram.

This area is subdivided in the areas General, Documents, Persons responsible, and Projects involved.

General

This area contains general information on the IT system.

For the information to be displayed all attributes listed in the allocation diagram for the IT system must be specified.

General table

Entry

Prerequisite

Name

The default attribute Name of the IT system is specified.

Short description

The default attribute Short description of the IT system is specified.

System description

The default attribute Description/Definition of the IT system is specified.

Manufacturer

The default attribute Manufacturer of the IT system is specified.

Version

The default attribute Release of the IT system is specified.

Individual development

The default attribute Individual development of the IT system is specified.

Guarantee/Warranty

The default attribute Guarantee/Warranty of the IT system is specified.

Usage table

Entry

Prerequisite

Number of internal users

The default attribute Number of internal users of the IT system is specified.

Number of external users

The default attribute Number of external users of the IT system is specified.

Criticality

The default attribute Criticality of the IT system is specified.

Service level agreement table

Entry

Prerequisite

Availability

The default attribute Availability of the IT system is specified.

Maximum downtime

The default attribute Maximum downtime of the IT system is specified.

Documents

This area lists links to all relevant documents.

Each entry in the table can be assigned a document. In the allocation diagram this document is assigned to the IT system by an object of the Information carrier type (Document symbol). For this information carrier, the system attributes Link 1 and Title 1 must be specified. This link is displayed for each table entry. For each of the various documents, the attribute Identifier must be specified by default. The attribute and the values to be specified are defined in the configuration file mappings.xml.

Entry

Prerequisite

Requirements specification

For the information carrier, the attribute Identifier has the value requirementsSpecification.

Technical specification

For the information carrier, the attribute Identifier has the value technicalSpecification.

User guide

For the information carrier, the attribute Identifier has the value userGuide.

Backup plan

For the information carrier, the attribute Identifier has the value backupPlan.

Emergency plan

For the information carrier, the attribute Identifier has the value emergencyPlan.

More documents

For the information carrier, the attribute Identifier has the value additionalDocuments.

Owners

This area contains information on persons responsible and organizational units. The corresponding roles and contact details are also displayed. A user must have been created in the database for all persons.

Contacts and persons responsible table

Entry

Prerequisite

Responsible

The IT system is assigned an object of the Person type using the connection is responsible for.

For the person, the attributes Name, E-mail address, and Telephone number are specified. The attribute Identifier has the user name of the person for which a user has been created in the database.

For the connection is responsible for, the attribute Responsibility type has the value System responsibility.

Substitute

The IT system is assigned an object of the Person type using the connection is responsible for.

For the person, the attributes Name, E-mail address, and Telephone number are specified.

For the connection is responsible for, the attribute Responsibility type has the value System responsibility (substitute).

Organizational unit

The IT system is assigned an object of the Organizational unit type using the connection is responsible for.

The attribute Name is specified for the organizational unit.

For the connection is responsible for, the attribute Responsibility type has the value System responsibility.

Additional contacts

The IT system is assigned additional objects of the Person type using the connection is responsible for.

For the persons, the attributes Name, E-mail address, and Telephone number are specified.

For the connection is responsible for, the attribute Responsibility type is not specified.