Konfigurations-Toolstatic.sws.bfh.ch/download/MAS-07-01-15-spec.pdf · Pflichtenheft Konfigurations-Tool SOHARD AG MAS-07-01.15-SRS-V1.1-Konfigurations-Tool.doc Seite 5 von 24 1 Einleitung

Konfigurations-Tool Pflichtenheft

MAS-07-01.15 Juni 2009, Version 1.1

Abstract

Das zu erstellende Konfigurations-Tool unterstützt die graphische Verwaltung von DABiS800-Einstellungen. Die DABiS800 Module sollen dieses neue Konfigurations-Tool einbinden können. Die programm- und benutzerspezifischen DABiS800-Einstellungen werden neu über diese Bibliothek zentral gespeichert.

Keywords

Konfiguration, Einstellungen, DABiS800, C#, .NET, GUI, Datenbank, XML

Student: Marcel Portner Seedorfweg 88 3053 Münchenbuchsee Tel: 031 33 99 157

Betreuer: Manfred Rothenbühler Bätterkindenstrasse 9 3317 Limpach Tel: 031 33 99 160

Andreas Völlmin Sonnenrain 11 3063 Ittigen Tel: 031 33 99 165

Experte: Rolf Lanz Wankdorffeldstrasse 102 3014 Bern Tel: 031 84 83 273

Pflichtenheft Konfigurations-Tool SOHARD AG

MAS-07-01.15-SRS-V1.1-Konfigurations-Tool.doc Seite 2 von 24

Versionskontrolle

Ausgabe Erstellt Geprüft Freigegeben Kommentar / Änderungen

Datum Visum Datum Visum Datum Visum

MAS-07-01.15-SRS-V0.1 26.03.09 MPO Erster Entwurf des Dokumentes

MAS-07-01.15-SRS-V0.2 02.04.09 MPO 02.04.09 MRO Review mit Betreuern

MAS-07-01.15-SRS-V0.3 03.04.09 MPO Inhalt ergänzt

MAS-07-01.15-SRS-V0.5 16.04.09 MPO 20.04.09 MRO Review mit Betreuern

MAS-07-01.15-SRS-V0.6 21.04.09 MPO Anpassungen nach dem Review

MAS-07-01.15-SRS-V0.8 22.04.09 MPO 30.04.09 Lanz Review mit Experte

MAS-07-01.15-SRS-V0.9 01.05.09 MPO Anpassungen nach dem Review

MAS-07-01.15-SRS-V1.0 08.05.09 MPO 08.05.09 Lanz 08.05.09 Lanz Dokument wurde freigegeben

MAS-07-01.15-SRS-V1.1 11.06.09 MPO Hierarchie der Einstellungen überarbeitet (3.1.1) und das Konzept mit einer Konfigurations-Datenbank dazwischen, damit auf mehrere DABiS800 Datenbanken zugegriffen werden kann, ist erst für die nächste Version geplant (2.1, 2.1.1, 2.6, 3.2.1.1 und 3.2.1.2).



Inhaltsverzeichnis

1 Einleitung ................................................................................................................... 5

1.1 Zweck ............................................................................................................................................. 5 1.2 Produktumfang ............................................................................................................................... 5 1.3 Definitionen, Begriffe und Abkürzungen ........................................................................................ 6 1.4 Referenzen..................................................................................................................................... 7 1.5 Übersicht ........................................................................................................................................ 7

2 Gesamt-Übersicht ..................................................................................................... 8

2.1 Produkt-Umfeld .............................................................................................................................. 8 2.1.1 System-Schnittstelle .......................................................................................................... 9 2.1.2 Benutzer-Schnittstelle ....................................................................................................... 9 2.1.3 Hardware-Schnittstelle ...................................................................................................... 9 2.1.4 Software-Schnittstelle ..................................................................................................... 10 2.1.5 Kommunikations-Schnittstelle ......................................................................................... 10 2.1.6 Speicher-Beschränkungen .............................................................................................. 10 2.1.7 Operationen .................................................................................................................... 10 2.1.8 Standortspezifische Anforderungen ................................................................................ 10

2.2 Produkt-Funktionalität .................................................................................................................. 11 2.3 Benutzer-Charakteristika ............................................................................................................. 11 2.4 Randbedingungen ........................................................................................................................ 11 2.5 Annahmen und Abhängigkeiten ................................................................................................... 11 2.6 Realisierungs-Verschiebung ........................................................................................................ 12

3 Spezifische Anforderungen.................................................................................... 13

3.1 Externe Schnittstellen-Anforderungen ......................................................................................... 13 3.1.1 Benutzer-Schnittstelle ..................................................................................................... 13 3.1.2 Hardware-Schnittstelle .................................................................................................... 13 3.1.3 Software-Schnittstelle ..................................................................................................... 13 3.1.4 Kommunikations-Schnittstelle ......................................................................................... 13 3.1.5 Daten Attribute ................................................................................................................ 14

3.2 Funktionale Anforderungen .......................................................................................................... 15 3.2.1 Einstellungen nutzen ....................................................................................................... 15

3.2.1.1 Einstellungen auslesen ................................................................................. 15 3.2.1.2 Einstellungen speichern ................................................................................ 15 3.2.1.3 Einstellungen laden ....................................................................................... 16 3.2.1.4 Einstellungen exportieren ............................................................................. 16

3.2.2 Einstellungen verwalten .................................................................................................. 17 3.2.2.1 Einstellungen anzeigen ................................................................................. 17 3.2.2.2 Einstellungen ändern .................................................................................... 17 3.2.2.3 Einstellungen löschen ................................................................................... 18 3.2.2.4 Einstellungen neu erstellen ........................................................................... 18 3.2.2.5 Einstellungen kopieren .................................................................................. 19 3.2.2.6 Einstellungen als Platzhalter definieren ........................................................ 19

3.2.3 In Delphi Module integrieren ........................................................................................... 20 3.2.3.1 Delphi Schnittstelle ........................................................................................ 20

3.2.4 Mit Hilfe verknüpfen ........................................................................................................ 21 3.2.4.1 Hilfe erzeugen ............................................................................................... 21 3.2.4.2 Hilfe anzeigen ............................................................................................... 21 3.2.4.3 Bemerkungsfeld ............................................................................................ 21

3.3 Performanz-Anforderungen ......................................................................................................... 22 3.4 Datenbasis-Anforderungen .......................................................................................................... 22 3.5 Design-Einschränkungen ............................................................................................................. 22

3.5.1 Regulierungs-Anforderungen .......................................................................................... 22 3.6 Software-System Attribute ........................................................................................................... 22

3.6.1 Zuverlässigkeit ................................................................................................................ 22 3.6.2 Verfügbarkeit ................................................................................................................... 22 3.6.3 Sicherheit ........................................................................................................................ 22 3.6.4 Wartbarkeit ...................................................................................................................... 22 3.6.5 Portabilität ....................................................................................................................... 22



4 Prioritäten ................................................................................................................ 23

5 Testen ...................................................................................................................... 24

5.1 Teststrategien .............................................................................................................................. 24 5.2 Testausführung ............................................................................................................................ 24

5.2.1 Reviews ........................................................................................................................... 24 5.2.2 Usability-Tests ................................................................................................................. 24 5.2.3 Unit-Tests ........................................................................................................................ 24 5.2.4 System- und Abnahme-Tests ......................................................................................... 24

Abbildungsverzeichnis Abbildung 1: Produkt-Umfeld bisher ................................................................................................................... 8

Abbildung 2: Produkt-Umfeld neu ...................................................................................................................... 9

Abbildung 3: Produkt-Funktionalität Mind Map................................................................................................. 11

Tabellenverzeichnis Tabelle 1 : Definitionen, Begriffe und Abkürzungen ........................................................................................... 6

Tabelle 2 : Referenzen ....................................................................................................................................... 7

Tabelle 3 : Einstellungen auslesen ................................................................................................................... 15

Tabelle 4 : Einstellungen speichern ................................................................................................................. 15

Tabelle 5 : Einstellungen laden ........................................................................................................................ 16

Tabelle 6 : Einstellungen exportieren ............................................................................................................... 16

Tabelle 7 : Einstellungen anzeigen .................................................................................................................. 17

Tabelle 8 : Einstellungen ändern ...................................................................................................................... 18

Tabelle 9 : Einstellungen löschen ..................................................................................................................... 18

Tabelle 10 : Einstellungen neu erstellen .......................................................................................................... 19

Tabelle 11 : Einstellungen kopieren ................................................................................................................. 19

Tabelle 12 : Einstellungen als Platzhalter definieren ....................................................................................... 19

Tabelle 13 : Delphi Schnittstelle ....................................................................................................................... 20

Tabelle 14 : Hilfe erzeugen............................................................................................................................... 21

Tabelle 15 : Hilfe anzeigen ............................................................................................................................... 21

Tabelle 16 : Bemerkungsfeld ............................................................................................................................ 21

Tabelle 17 : Prioritäten ..................................................................................................................................... 23

Tabelle 18 : Anwendungsfall Szenario ............................................................................................................. 24



1 Einleitung

1.1 Zweck

Das vorliegende Pflichtenheft hat zum Ziel, die Anforderungen an das zu erstellende Konfigurations-Tool zu beschreiben. Die Realisierung erfolgt im Rahmen der Master-Thesis im Studiengang MAS-IT. Der Umfang der Arbeit sollte einen Umfang von ca. 360h entsprechen und innerhalb von 6 Monaten geleistet werden.

1.2 Produktumfang

Das Produkt DABiS800 ist eine Sendeautomations-Plattform für die Verarbeitung von Content in Radio- und Fernsehstationen. Es wird zurzeit in der Schweiz und Deutschland bei über 40 Privaten Radiostationen eingesetzt. Das DABiS800 besteht aus diversen Modulen, welche den ganzen redaktionellen Arbeitsablauf eines Radiosenders umfassen. Neben dem Hauptmodul Studio Controller, welches im Sendestudio läuft und den Moderator beim Moderieren und Sendungsfahren hilft, gibt es noch diverse andere DABiS800 Module.

Dies ist eine nicht vollständige Aufzählung aus über 50 DABiS800 Modulen (mehr unter www.dabis.ch):

Planning Base Planen und bearbeiten von Sendestunden und das Verwalten von Content

Voice Tracking Übergänge zwischen zwei Musikstücken bearbeiten

Newsroom Importiert Agenturmeldungen

IM Importiert Musik anhand von Planungslisten

IW Importiert Werbung (welche z.T. über E-Mail kommen) Zum bestehenden DABiS800 Produkt soll nun ein Konfigurations-Tool zum Verwalten von programm- und benutzerspezifischen Einstellungen entwickelt werden. Diese Einstellungen können z.B. benutzerbezogene Schriftarten sein. Oder aber auch ein spezielles Verhalten in einem DABiS800 Modul je nach Einstellung bewirken.

Ausgangslage

Das Produkt DABiS800 verwendet INI-Dateien, Umgebungsvariablen und zum Teil auch noch die Registry für Einstellungen. Die INI-Dateien liegen zusammen mit den Programm-Dateien auf dem Server. Dies ist für den Administrator ein Vorteil da die INI-Datei zentral liegt, doch leider muss in gewissen Fällen für jede Arbeitsgruppe eine eigene INI-Datei erstellt werden die meist nur wenige Unterschiede haben. Dies macht das ganze wieder unübersichtlich. Und leider gelten die Registry Einstellungen immer nur pro Rechner. Darum soll ein durchgängiges Konzept der Einstellungen realisiert werden.

Die DABiS800 Module sind bisher in Object Pascal mit Delphi entwickelt worden. Nun ist das Ziel die neuen Module mit Microsoft Visual Studio C# zu realisieren.

Aufgabenstellung

Konzept und Realisierung eines Konfigurations-Tools zum Verwalten von programm- und benutzerspezifischen Einstellungen. Das neue Konfigurations-Tool soll als eigenständiges Modul in C# entwickelt und von DABiS800-Modulen eingebunden werden können.

Das Modul besteht grob aus zwei Teilen:

Das GUI, welches generisch je nach Typ der Eigenschaft (analog Eigenschaftenfenster in C#) die Einstellungen darstellt und diese auch bearbeitet werden können.

Datenschnittstelle zur Persistenz-Schicht (Datenbank, XML, …). Wobei im ersten Schritt die Daten in einer Datenbank abgelegt werden sollen.

Das GUI soll im wesentlichen Name-Wert Paare repräsentieren, wobei der Wert je nach Typ der Eigenschaft unterschiedlich eingegeben werden muss (z.B. Textfeld, DropDown-Liste, Checkbox, …). Die Art und Anzahl der Eigenschaften wird im Interface definiert. Die neuen Tabellen der Datenbank müssen so designt werden, dass jede Möglichkeit darin abgebildet werden kann. Dass heisst Rechner-, Programminstanz-, Gruppen- oder benutzerspezifische Einstellungen.

Zudem muss das neue Konzept die Vererbungshierarchie der Einstellungen auch berücksichtigen.

Bemerkungen

Dieses neue GUI soll auch in bestehende Delphi Module eingebunden und wenn möglich mit der bestehenden HTML Hilfe verknüpft werden können.

http://www.dabis.ch/



1.3 Definitionen, Begriffe und Abkürzungen

Begriff, Abkürzung Definition

.NET Ein Framework welches den Entwickler beim Erstellen von Software mit bestehenden Funktionen und Elementen unterstützt. http://de.wikipedia.org/wiki/.NET-Framework

Administrator Definiert einen Anwender mit voller Berechtigung.

ADO.NET Eine Sammlung von Klassen, die den Zugriff auf relationale Datenbanken gewährleisten. http://de.wikipedia.org/wiki/ADO.NET

Benutzer Alle übrigen Anwender des Konfigurations-Tools.

C# Eine Programmiersprache http://de.wikipedia.org/wiki/C-Sharp

Content Medieninhalte http://de.wikipedia.org/wiki/Medieninhalte

COM Component Object Model Interface von Microsoft http://de.wikipedia.org/wiki/Component_Object_Model

DABiS800 Digital Audio Broadcasting integrated Solutions, Produkt der Sohard AG www.dabis.ch

Default Damit ist ein Standardwert gemeint http://de.wikipedia.org/wiki/Voreinstellung

Delphi Entwicklungsumgebung von Borland für die Programmiersprache Object Pascal http://de.wikipedia.org/wiki/Borland_Delphi

Exception Ausnahmebehandlung bei der Programmierung http://de.wikipedia.org/wiki/Ausnahmebehandlung

Flag Kennzeichnung eines bestimmten Zustand http://de.wikipedia.org/wiki/Flag_(Informatik)

GUI Abkürzung für: Graphical User Interface, englisch für grafische Benutzeroberfläche. Erlaubt dem Anwender die Interaktion mit der Applikation über grafische Elemente.

HTML Abkürzung für „Hypertext Markup Language“ http://de.wikipedia.org/wiki/Html

HTTP Abkürzung für „Hypertext Transfer Protocol” http://de.wikipedia.org/wiki/Http

INI-Datei Abkürzung für Initialisierungsdatei http://de.wikipedia.org/wiki/Initialisierungsdatei

Konfigurations-Bibliothek

Damit ist das neue Modul ohne das GUI gemeint.

Konfigurations-Tool Das Konfigurations-Tool beschreibt das Ganze. Die Konfigurations-Bibliothek mit dem GUI und auch noch die neue Konfigurations-Datenbank.

Modul Ist ein Software-Programm

Mono Mono Projekt um .NET auf Linux zu ermöglichen http://de.wikipedia.org/wiki/Mono-Projekt

MPO Kürzel für Marcel Portner

Registry Windows-Registrierungsdatenbank für Einstellungen http://de.wikipedia.org/wiki/Windows-Registrierungsdatenbank

Umgebungsvariable Damit werden unter Windows globale Einstellungen bezeichnet http://de.wikipedia.org/wiki/Umgebungsvariable

UML Abkürzung für „Unified Modeling Language“ http://de.wikipedia.org/wiki/Unified_Modeling_Language

Visual Studio Microsoft Visual Studio Entwicklungsumgebung http://de.wikipedia.org/wiki/Visual_Studio

VSS Microsoft Visual SourceSafe http://de.wikipedia.org/wiki/Visual_SourceSafe

Wrapper Übersetzung einer Schnittstelle http://de.wikipedia.org/wiki/Adapter_(Entwurfsmuster)

XML Abkürzung für „Extensible Markup Language“ http://de.wikipedia.org/wiki/Extensible_Markup_Language

Tabelle 1 : Definitionen, Begriffe und Abkürzungen

http://de.wikipedia.org/wiki/.NET-Framework

http://de.wikipedia.org/wiki/ADO.NET

http://de.wikipedia.org/wiki/C-Sharp

http://de.wikipedia.org/wiki/Medieninhalte

http://de.wikipedia.org/wiki/Component_Object_Model

http://www.dabis.ch/

http://de.wikipedia.org/wiki/Voreinstellung

http://de.wikipedia.org/wiki/Borland_Delphi

http://de.wikipedia.org/wiki/Ausnahmebehandlung

http://de.wikipedia.org/wiki/Flag_(Informatik)

http://de.wikipedia.org/wiki/Html

http://de.wikipedia.org/wiki/Http

http://de.wikipedia.org/wiki/Initialisierungsdatei

http://de.wikipedia.org/wiki/Mono-Projekt

http://de.wikipedia.org/wiki/Windows-Registrierungsdatenbank

http://de.wikipedia.org/wiki/Umgebungsvariable

http://de.wikipedia.org/wiki/Unified_Modeling_Language

http://de.wikipedia.org/wiki/Visual_Studio

http://de.wikipedia.org/wiki/Visual_SourceSafe

http://de.wikipedia.org/wiki/Adapter_(Entwurfsmuster)

http://de.wikipedia.org/wiki/Extensible_Markup_Language



1.4 Referenzen

Nr. Dokument Autor Version, Datum

Kommentar

[01] Master Thesis Thema: Konfigurations-Tool

MPO 1.0, 24.11.08

Freigegebene Version

[02] DABiS800 Betriebshandbuch C. Zubler 4.0, 02.04.09

Freigegebene Version

Tabelle 2 : Referenzen

1.5 Übersicht

Dieses Dokument ist gemäss dem Standard1 «Software Requirements Specification (SRS)» gegliedert.

Das Kapitel „2 Gesamt-Übersicht“ dient als Übersicht der Funktionen und Schnittstellen der Software. Die Anforderungen befinden sich im Kapitel „3 Spezifische Anforderungen“. Die Schnittstellen des Systems sind im Abschnitt „3.1 Externe Schnittstellen-Anforderungen“ beschrieben.

Das Kapitel 3.2 enthält die Funktionalen-Anforderungen. Die Anforderungsabschnitte sind mit einer Priorität versehen. Eins (1) ist die höchste verwendete Priorität, drei (3) die tiefste verwendete Priorität. Die Anforderungen mit der Priorität 1 werden während der Master Thesis umgesetzt und dokumentiert. Teile der Anforderungen mit Priorität 2 können noch umgesetzt werden sofern die Zeit reicht. Anforderungen mit der Priorität 3 werden später realisiert. Für die Architektur sind grundsätzlich alle Anforderungen zu berücksichtigen. Die Nummer der Funktionalen-Anforderungen (Requirement-ID„s) leitet sich aus der Kapitel-Nummer ab. Die Anforderungen sind nach der Anforderungsschablone der Sophisten

2 konstruiert.

Die Nichtfunktionalen-Anforderungen sind im Abschnitt „3.3 Design-Einschränkungen“ und folgende beschrieben.

1 IEEE Recommended Practice for Software Requirements Specification (IEEE Std 830-1998) ISBN 0-7381-0332-2

2 Aus dem Buch „Requirements-Engineering und Management“ ISBN: 978-3-40509-7



2 Gesamt-Übersicht

2.1 Produkt-Umfeld

Im Kapitel 1.2 Produktumfang ist das Produkt-Umfeld schon beschrieben worden. Damit dies verständlicher wird, ist diese Beschreibung hier nun noch graphisch dargestellt.

Bisher hat das Produkt-Umfeld so ausgesehen:

Datenbank

Datenbank

Modul XModul X

Modul YModul Y

Modul ZModul Z

DABiS800 Module

(Programme / Dienste) DABiS800 Datenbanken

INI-Datei

INI-Datei

INI-Datei

Konfigurationen

(INI-Datei, Registry,

Umgebungsvariablen)

INI-Datei

Registry

Abbildung 1: Produkt-Umfeld bisher

Zu jedem DABiS800 Modul gibt es mindestens eine INI-Datei. Aber meistens sind diverse INI-Dateien zu einem DABiS800 Modul mit nur geringen Änderungen vorhanden. Auch die Registry wurde bei ein paar DABiS800 Modulen für Einstellungen verwendet.

Ein DABiS800 Modul greift normalerweise nur auf eine DABiS800 Datenbank zu. Manche DABiS800 Kunden haben zum Teil aber pro Radiosender eine DABiS800 Datenbank. Nun können ein paar DABiS800 Module sich bei Bedarf auch auf die verschiedenen DABiS800 Datenbanken gleichzeitig verbinden. Dies ist in der Graphik mit den zwei Datenbanken und den weiteren gepunkteten Linien so angedeutet.



Neu soll das Produkt-Umfeld so aussehen:

Datenbank

Modul XModul X

Modul YModul Y

Modul ZModul Z

DABiS800 Module

(Programme / Dienste)

Bestehende

DABiS800 Datenbank mit

Konfigurations-Tabellen

oder XML-Datei

Konfigurations-Tool

Konfigurations-

Bibliothek

für X, Y oder Z

XML

Konfigurations-

Bibliothek

mit GUI und DB

Zugriff

Abbildung 2: Produkt-Umfeld neu

Die diversen INI-Dateien wird es nicht mehr geben und dafür wird die ganze Konfiguration der diversen DABiS800 Module nun zentral in der DABiS800 Datenbank in neuen Konfigurations-Tabellen auf dem Datenbank-Server (oder einer XML-Datei) verwaltet.

2.1.1 System-Schnittstelle

Wie auf der „Abbildung 2: Produkt-Umfeld neu“ ersichtlich ist, wird die entsprechende Konfigurations-Bibliothek in das jeweilige DABiS800 Modul eingebunden. Diese Bibliothek greift dann auf die allgemeine Konfigurations-Bibliothek zu um die diversen Einstellungen zu laden oder speichern.

Die eventuell vorhandene Konfiguration XML-Datei kann je nach Anwendungszweck entweder gerade im Arbeitsverzeichnis des DABiS800 Moduls liegen oder irgendwo zentral auf einem Server.

2.1.2 Benutzer-Schnittstelle

Die geladenen Einstellungen können vom Benutzer über ein GUI auch angepasst werden. Das GUI soll die Einstellungen wie beim Eigenschaftfenster von Visual Studio darstellen. Je nach Typ der Eigenschaft wird die Einstellung entsprechend dargestellt. Zudem wird zu jeder Einstellung auch noch der dazugehörende Hilfe-Text angezeigt.

Ungenügende oder falsche Angaben werden nach der Eingabe durch eine Fehlermeldung abgefangen.

2.1.3 Hardware-Schnittstelle

Es sind keine Hardware-Schnittstellen vorhanden.



2.1.4 Software-Schnittstelle

Im DABiS800 Betriebshandbuch [02] sind folgende minimale Systemanforderungen aufgeführt:

Client-Betriebssystem: ab Windows XP SP3

Datenbank: Interbase 7.x oder Firebird 2.0

Zudem wird nun für das neue Konfigurations-Tool das .NET Framework 2.0 verwendet.

2.1.5 Kommunikations-Schnittstelle

Die Kommunikation zwischen der Konfigurations-Tool Bibliothek und der Datenbank oder XML-Datei soll über ADO.NET geschehen.

Die Hilfe der Einstellungen zu den entsprechenden DABiS800 Modulen sind als HTML Seiten vorhanden und daher wird auch das HTTP Protokoll verwendet.

2.1.6 Speicher-Beschränkungen

Es werden im Zusammenhang des Konfigurations-Tools keine Speicher-Beschränkungen definiert.

2.1.7 Operationen

Die Konfigurations-Tool Bibliothek soll auch als eigenständiges Administrations-Tool für alle DABiS800 Einstellungen gestartet werden können. Dies damit die Grundeinstellungen (z.B. Angabe zu einer DABiS800 Datenbank) schon konfiguriert werden können, bevor ein DABiS800 Modul gestartet wird.

Ansonsten sind die Standard Operationen das Laden-, Speichern und Exportieren der Konfigurationen.

2.1.8 Standortspezifische Anforderungen

Das Konfigurations-Tool soll in der Version 1.0 nur in deutscher Sprache realisiert werden.



2.2 Produkt-Funktionalität

Die Produkt-Funktionalität mit den wichtigsten Features ist hier als Mind Map dargestellt.

Abbildung 3: Produkt-Funktionalität Mind Map

2.3 Benutzer-Charakteristika

Die Benutzer des Konfigurations-Tool GUI sind Personen, welche beim Radio arbeiten. Sie arbeiten täglich mit den DABiS800 Modulen und werden nun einfach noch die Möglichkeit haben, die Einstellungen neu im GUI anzusehen und je nach Berechtigung auch anzupassen. Meistens werden es aber DABiS800-Administratoren sein, welche dieses Konfigurations-Tool dann brauchen.

2.4 Randbedingungen

Die Software ist mit C# zu realisieren. Es soll das .NET Framework 2.0 verwendet werden.

2.5 Annahmen und Abhängigkeiten

Das Betriebssystem für die Entwicklung ist Windows XP SP3 mit Microsoft Visual Studio 2008. Und für die Versionsverwaltung des Source Code wird Microsoft VSS verwendet.



2.6 Realisierungs-Verschiebung

Um die Realisierung des Konfigurations-Tool im zeitlich vorgegebenen Rahmen zu halten, sind ein paar Bestandteile der Software in einen späteren Release (V 2.0 und folgende) verschoben worden.

Hot und Standby Umschaltung (A und B Umgebung)

Automatisches Auffinden der Konfigurations-Datenbank

Direktes senden der Einstellungen an den Support

Zugriff zu den Einstellungen auf mehrere DABiS800 Datenbanken

Diese Punkte müssen aber im Design berücksichtigt werden.



3 Spezifische Anforderungen

3.1 Externe Schnittstellen-Anforderungen

3.1.1 Benutzer-Schnittstelle

Zum Kapitel 2.1.2 Benutzer-Schnittstelle gibt es noch folgende Ergänzungen.

Es soll folgende Einstellungsabstufungen geben:

Hierarchie Ablage Ort Einstellungstyp DABiS800 Administratoren

DABiS800 Benutzer

↓ Bibliothek Default

DABiS800 Datenbank

Global X

Programminstanz X

Anwendergruppen X

Benutzer X X

Rechner X

Der Einstellungstyp „Rechner“ passt nicht so ganz in die Hierarchie und muss darum speziell behandelt werden. Dass heisst, diese Einstellung darf nicht überschrieben werden.

Ein Benutzer gehört immer zu einer „Haupt“-Anwendergruppe, obschon er je nach DABiS800 Datenbank stand mehreren Anwendergruppen zugeordnet werden kann.

Diese verschiedenen Einstellungsabstufungen werden separat im GUI dargestellt. Zudem soll es dann noch eine Gesamtübersicht geben, was der Benutzer auf diesem Rechner nun alles eingestellt hat.

Der Administrator kann alle Einstellungen ändern und der Benutzer nur seine eigenen Einstellungen. Dies muss mit einem Flag gekennzeichnet werden, welche Einstellungen von den Benutzern überschrieben werden dürfen.

Neben dem Hilfe-Text sollte es noch ein Bemerkungsfeld geben, wo der Administrator und bei persönlichen Einstellungen auch der Benutzer seinen eigenen Kommentar zu jeder Einstellung notieren kann.

3.1.2 Hardware-Schnittstelle

Es sind keine Hardware-Schnittstellen vorhanden.

3.1.3 Software-Schnittstelle

Die Angaben der Software-Schnittstelle im Kapitel 2.1.4 werden noch mit folgendem ergänzt:

Es soll eine Schnittstelle geben um die bestehenden DABiS800 Module, welche in Delphi implementiert sind, an diese neue Konfigurations-Bibliothek anbinden zu können.

Wenn die Konfigurations-Bibliothek keine Verbindung zur Konfigurations-Datenbank herstellen kann, dann soll eine Exception geworfen werden, damit das DABiS800 Modul selber entscheiden kann was es in diesem Fall machen soll.

3.1.4 Kommunikations-Schnittstelle

Im Kapitel 2.1.5 Kommunikations-Schnittstelle wurde ADO.NET als Kommunikations-Schnittstelle erwähnt. Diese stellt Microsoft in der .NET-Plattform zur Verfügung. Es handelt sich um eine Sammlung von Klassen, die den Zugriff auf relationale Datenbanken gewährleisten. Da die Datenbank entweder von Interbase oder Firebird ist, muss während der Entwicklung noch der richtige Datenbank Client eruiert werden. Dies ist in ADO.NET aber recht gut gekapselt, so dass man diesen nachträglich einfach über einen anderen ADO.NET Provider austauschen kann.

Hier eine Aufzählung möglicher ADO.NET Provider:

www.firebirdsql.org/dotnetfirebird, www.interbase.com, www.ibprovider.com

http://www.firebirdsql.org/dotnetfirebird

http://www.interbase.com/

http://www.ibprovider.com/



3.1.5 Daten Attribute

Die Einstellungen können aus folgenden Attributen bestehen (dies muss dann bei der Analyse & Design noch genauer abgeklärt werden):

Computer - Name - Beschreibung

Modul - Name - Konfigurationsbezeichnung / Programminstanz - Beschreibung

Sektion - Name - Index - Beschreibung

Eigenschaft - Name - Wert - Position - Typ (Global, Programminstanz oder Rechner Einstellung) - Berechtigung (Benutzer oder Anwendergruppen ID) - Beschreibung

Zudem gibt es in der DABiS800 Datenbank noch folgende Tabellen, welche mit diesen Einstellungen dann verknüpft werden:

- Benutzer - Anwendergruppen - Benutzer_Anwendergruppen



3.2 Funktionale Anforderungen

3.2.1 Einstellungen nutzen

Mit „Einstellungen nutzen“ ist gemeint, dass die Konfigurations-Bibliothek dem DABiS800 Modul beim Starten die gespeicherten Einstellungen zur Verfügung stellt. Dies kann entweder aus der Konfigurations-Datenbank und den DABiS800 Datenbank(en) sein oder aus einer Konfiguration XML-Datei. Die Konfiguration XML-Datei wird es in den folgenden zwei Fällen geben:

Für den Support um Einstellungen des Kunden zum Testen zu übernehmen.

Für den Fall eines Netzwerkunterbruch (mindestens ein DABiS800 Modul wird dies unterstützen).

Auch muss die Konfigurations-Bibliothek ein speichern der aktuellen Einstellungen aus einem DABiS800 Modul heraus ermöglichen.

Dieser Modus funktioniert ohne GUI und stellt eigentlich die Grundfunktion des Konfigurations-Tools dar. Darum hat die „Einstellungen nutzen“ die höchste (1) Priorität.

3.2.1.1 Einstellungen auslesen

History V 0.1 02.04.09 MPO Requirement erstellt

V 0.2 16.04.09 MPO Requirement [a] mit der DABiS800 Datenbank ergänzt

V 0.5 20.04.09 MPO Reviewed durch die Betreuer

V 0.8 21.04.09 MPO Requirement [b] hinzugefügt

V 1.0 01.05.09 MPO Released

V 1.1 11.06.09 MPO Requirement [a] nur noch mit der DABiS800 Datenbank

ID Beschreibung

3.2.1.1 a Das System MUSS

fähig sein,

die Einstellungen aus der DABiS800 Datenbanken auszulesen.

3.2.1.1 b Das System MUSS

fähig sein,

die Einstellungen anhand der Vererbungshierarchie richtig auszulesen.

Tabelle 3 : Einstellungen auslesen

3.2.1.2 Einstellungen speichern


V 0.2 16.04.09 MPO Requirement [a] mit der DABiS800 Datenbank ergänzt


V 0.8 21.04.09 MPO Requirement [b] hinzugefügt


V 1.1 11.06.09 MPO Requirement [a] nur noch mit der DABiS800 Datenbank

ID Beschreibung


fähig sein,

die aktuellen Einstellungen in die DABiS800 Datenbanken zu speichern.


fähig sein,

die Einstellungen anhand der Vererbungshierarchie richtig zu speichern.

Tabelle 4 : Einstellungen speichern



3.2.1.3 Einstellungen laden



V 0.8 21.04.09 MPO Requirement ins Einstellungen nutzen Kapitel verschoben und

Priorität angepasst


ID Beschreibung

3.2.1.3 a Das System SOLL

fähig sein,

Einstellungen aus einer XML-Datei laden zu können.

3.2.1.3 b Das System SOLL

fähig sein,

die geladenen Einstellungen in die Datenbank zu importieren.

Tabelle 5 : Einstellungen laden

3.2.1.4 Einstellungen exportieren



V 0.8 21.04.09 MPO Requirement ins Einstellungen nutzen Kapitel verschoben und

Priorität angepasst


ID Beschreibung


fähig sein,

Einstellungen als XML-Datei zu exportieren.

Tabelle 6 : Einstellungen exportieren



3.2.2 Einstellungen verwalten

Mit „Einstellungen verwalten“ kommt nun das GUI hinzu womit der Benutzer die Möglichkeit erhält zum entsprechenden DABiS800 Modul die Einstellungen anzuzeigen und zu ändern. Dazu bietet das GUI Masken an, damit der Benutzer die Einstellungen je nach Typ entsprechend bearbeiten kann. Zudem werden noch weitere Funktionen auf dem GUI zur Verfügung stehen, welche in diesem Kapitel beschrieben sind.

Auch die „Einstellungen verwalten“ Anforderung hat die höchste (1) Priorität.

3.2.2.1 Einstellungen anzeigen


V 0.2 03.04.09 MPO Administrator Modul hinzugefügt [c]

V 0.3 16.04.09 MPO Sortierreihenfolge hinzugefügt [d]



ID Beschreibung


dem Benutzer die Möglichkeit bieten,

die vorhandenen Einstellungen zum aktuellen Modul darzustellen.


dem Administrator die Möglichkeit bieten,

die vorhandenen Einstellungen zu aktuellen Modul darzustellen. Der

Administrator kann zudem aus einer Liste jeden registrierten Benutzer

auswählen um auch dem seine persönlichen Einstellungen darzustellen.

3.2.2.1 c Wenn das Konfigurations-Tool als Administrator Modul gestartet wird,

MUSS das System fähig sein,

die verschiedenen DABiS800 Module auszuwählen um diese Einstellungen

darzustellen zu können.

3.2.2.1 d Das System MUSS

die Einstellungen von Listen in der richtigen Sortierreihenfolge darstellen.

Tabelle 7 : Einstellungen anzeigen

3.2.2.2 Einstellungen ändern


V 0.2 16.04.09 MPO Sortierreihenfolge hinzugefügt [e]



ID Beschreibung



alle möglichen Einstellungen zu ändern.



seine persönlichen Einstellungen, welche vom System über ein Flag

gekennzeichnet sind, zu ändern.

3.2.2.2 c Das System MUSS


Einstellungen nach einer Bestätigung für jede Vererbungshierarchie mit dem

neuen Wert überschreiben zu lassen.




Änderungen an den Einstellungen über einen Event den anderen Modulen

mitteilen.

3.2.2.2 e Das System MUSS


die Reihenfolge der Einstellungen von Listen zu ändern.

Tabelle 8 : Einstellungen ändern

3.2.2.3 Einstellungen löschen


V 0.2 16.04.09 MPO Requirement [c] und [d] hinzugefügt


V 0.8 21.04.09 MPO Requirement [e] hinzugefügt


ID Beschreibung



Einstellungen zu löschen. Es wird danach in Grau die Einstellung der nächst

höheren Vererbungshierarchie angezeigt.



seine persönlichen Einstellungen zu löschen.

3.2.2.3 c Falls ein Benutzer im DABiS800 gelöscht wird,


die persönlichen Einstellungen zu diesem Benutzer auch mit zu löschen.

3.2.2.3 d Falls eine Anwendergruppe im DABiS800 gelöscht wird,


die Einstellungen zu dieser Anwendergruppe auch mit zu löschen.

3.2.2.3 e Das System MUSS


alle Programminstanzen zum aktuellen DABiS800 Modul anzuzeigen um eine

nicht mehr gebrauchte Programminstanz löschen zu können.

Tabelle 9 : Einstellungen löschen

3.2.2.4 Einstellungen neu erstellen



V 0.8 22.04.09 MPO Requirement [b] und [c] hinzugefügt


ID Beschreibung



bei Einstellungen, die als Liste abgebildet sind, weitere neue Einstellungen zu

erfassen.



eine neue Programminstanz zu erstellen.





einen neuen Rechner zu erfassen.

Tabelle 10 : Einstellungen neu erstellen

3.2.2.5 Einstellungen kopieren



V 0.8 22.04.09 MPO Requirement [a] in mehrere aufgeteilt


ID Beschreibung



Einstellungen für eine neue Programminstanz zu kopieren.



Einstellungen für einen neuen Rechner zu kopieren.



Einstellungen von einer Anwendergruppe zu einer anderen Anwendergruppe

zu kopieren.



Einstellungen von einem Benutzer zu einem anderen Benutzer zu kopieren.

Tabelle 11 : Einstellungen kopieren

3.2.2.6 Einstellungen als Platzhalter definieren



V 0.8 21.04.09 MPO Requirement [b] und [c] hinzugefügt und Priorität angepasst


ID Beschreibung



Einstellungen als Platzhalter zu definieren.

3.2.2.6 b Das System SOLL


definierte Platzhalter in Einstellungen zu verwenden.

3.2.2.6 c Das System SOLL


Umgebungsvariabel in Einstellungen zu verwenden.

Tabelle 12 : Einstellungen als Platzhalter definieren



3.2.3 In Delphi Module integrieren

Da die DABiS800 Module bis jetzt in Delphi implementiert wurden, soll es eine Schnittstelle zu dieser neuen Konfigurations-Bibliothek geben. Es soll die Microsoft COM - Schnittstelle verwendet werden. Die entsprechenden Schnittstellenmethoden müssen in der Analyse & Design Phase gekennzeichnet werden. Bei den Parameter Typen muss aufgepasst werden, dass es diese Typen in beiden Programmiersprachen gibt.

In den bestehenden DABiS800 Modulen, welche mit Delphi geschrieben sind, muss ein Wrapper implementiert werden um auf die neue COM – Schnittstelle zugreifen zu können.

Die Konfigurations-Bibliothek in Delphi Module integrieren hat eine mittlere (2) Priorität.

3.2.3.1 Delphi Schnittstelle



V 0.8 21.04.09 MPO Priorität angepasst


ID Beschreibung


eine COM - Schnittstelle anbieten,

womit die bestehenden Delphi Module darauf zugreifen können.

Tabelle 13 : Delphi Schnittstelle



3.2.4 Mit Hilfe verknüpfen

So sah bis jetzt der Ablauf der Dokumentation von DABiS800 Modulen zu einer neuen Einstellung aus:

Als erstes wurde im Code eine neue Einstellung implementiert. Dazu wurde aber im Code nichts Beschrieben. Danach wurde diese neue Einstellung in einer Version Datei mit einer Beschreibung festgehalten. Und irgendwann mal wurde diese neue Einstellung dann auch noch in der Hilfe mit der gleichen Beschreibung aus der Versions-Datei hinzugefügt (wenn es zu diesem DABiS800 Modul überhaupt eine Hilfe gab).

Dieser Ablauf ist nicht optimal. Darum wird nach einer Lösung gesucht, bei der man den Beschreibungstext direkt im Code erfasst und daraus dann eine HTML Hilfe aller Einstellungen erstellen kann. Diese generierte HTML Hilfe soll dann gerade vom Konfigurations-Tool im GUI verwendet werden.

Konfigurations-Tool GUI mit der generierten Hilfe verknüpfen hat eine niedrige (3) Priorität.

3.2.4.1 Hilfe erzeugen





ID Beschreibung

3.2.4.1 a Die Beschreibung zu den Einstellungen WIRD

im Code gemacht. Daraus wird dann eine HTML Hilfe generiert.

Tabelle 14 : Hilfe erzeugen

3.2.4.2 Hilfe anzeigen





ID Beschreibung

3.2.4.2 a Das System WIRD


zur selektierten Einstellung den entsprechenden Hilfe-Text darzustellen.

Tabelle 15 : Hilfe anzeigen

3.2.4.3 Bemerkungsfeld





ID Beschreibung

3.2.4.3 a Das System WIRD


zu jeder Einstellung seinen eigenen Bemerkungstext zu erfassen.

Tabelle 16 : Bemerkungsfeld



3.3 Performanz-Anforderungen

Die Konfigurations-Bibliothek wird beim Starten eines DABiS800 Modul einen Performanz-Einfluss haben. Das Auslesen der Einstellungen darf nicht mehr als 40% langsamer sein als aus einer heute bestehenden INI-Datei. Da aber in der Konfigurations-Datenbank für jedes DABiS800 Modul Einstellungen in der gleichen Tabelle drin stehen, kann diese Tabelle recht gross werden. Mit den richtigen Indexe in der Datenbank sollte dieses Problem aber abgefangen werden.

Da das Arbeiten im GUI, mit Ändern, Speichern und Exportieren als XML – Datei sehr seltene Benutzer Aktionen sein werden, spielt die Performanz in diesem Bereich nur eine untergeordnete Rolle.

3.4 Datenbasis-Anforderungen

Die Einstellungen sind in der Datenbank und XML - Datei immer als String vorhanden. Diese können aber einen beliebigen Typ repräsentieren.

3.5 Design-Einschränkungen

Das Software-Design wird mittels UML erstellt und die Konfigurations-Tool wird objektorientiert mit C# .NET entwickelt.

3.5.1 Regulierungs-Anforderungen

Jede Änderung einer Einstellung soll in einer Log-Datei festgehalten werden.

3.6 Software-System Attribute

3.6.1 Zuverlässigkeit

Das Konfigurations-Tool liefert bei fehlerhaften Eingabedaten plausible Meldungen und stürzt nicht ab.

3.6.2 Verfügbarkeit

Da ein DABiS800 Modul so aufgebaut ist, dass es auch noch bei einem Netzwerkunterbruch (keine Verbindung mehr zum Datenbank-Server) funktionieren muss, ist die Anforderung mit dem Auslesen aus einer Konfigurations XML-Datei dazu gekommen. Immer beim Starten dieses DABiS800 Modul soll eine Konfigurations XML-Datei bei einer vorhandenen Datenbankverbindung neu geschrieben werden. Ansonsten soll mit der zuletzt gespeicherten XML-Datei gestartet werden. Somit kann die Verfügbarkeit in diesem Fall immer gewährleistet werden.

3.6.3 Sicherheit

Das Konfigurations-Tool kennt zwei Gruppen. Die Administratoren und die Benutzer. Dem Benutzer wird nicht alles ermöglicht. Ansonsten besitzt die Bibliothek keinen weiteren Schutz.

3.6.4 Wartbarkeit

Der Code soll angemessen kommentiert sein. Weiter muss das UML-Design und der implementierte Code bei der Auslieferung miteinander übereinstimmen.

3.6.5 Portabilität

Die DABiS800 Module laufen alle auf Windows und daher ist nicht geplant diese Konfigurations-Tool Bibliothek auf einer anderen Plattform zu portieren. Da diese Bibliothek mit C# auf .NET implementiert wird, könnte man es zu einem späteren Zeitpunkt auch mal unter Mono auf einem Linux Betriebssystem testen. Darauf wird aber keine Rücksicht genommen und dies wird auch explizit in dieser Arbeit ausgeschlossen.



4 Prioritäten Nachfolgend sind die zu realisierenden Anforderungen aufgelistet und priorisiert. Dabei sollen die Anforderungen mit der Priorität 1 zwingend implementiert werden, da nur so die Funktionalität des Konfigurations-Tools gewährleistet ist. Darauf aufbauend sollen die Anforderungen der Priorität 2 und anschliessend der Priorität 3 umgesetzt werden.

Req. Nr. Anforderungsbezeichnung Priorität

3.2.1.1 Einstellungen auslesen 1

3.2.1.2 Einstellungen speichern 1

3.2.1.3 Einstellungen laden 2

3.2.1.4 Einstellungen exportieren 2

3.2.2.1 Einstellungen anzeigen 1

3.2.2.2 Einstellungen ändern 1

3.2.2.3 Einstellungen löschen 1

3.2.2.4 Einstellungen neu erstellen 1

3.2.2.5 Einstellungen kopieren 2

3.2.2.6 Einstellungen als Platzhalter definieren 2

3.2.3.1 Delphi Schnittstelle 2

3.2.4.1 Hilfe erzeugen 3

3.2.4.2 Hilfe anzeigen 3

3.2.4.3 Bemerkungsfeld 3

3.3 Performanz beim auslesen der Einstellungen 2

3.4 Einstellungen als String gespeichert 1

3.5.1 Änderungen der Einstellung in Log-Datei schreiben 1

3.6.1 Bei fehlerhaften Eingabedaten plausible Meldungen 1

3.6.2 Verfügbarkeit auch bei Netzwerkunterbruch 2

3.6.3 Sicherheit bei der nur DABiS800 Administratoren alles ändern können 1

3.6.4 Wartbarkeit durch kommentierten Source Code und vollständige Dokumentation 1

Tabelle 17 : Prioritäten



5 Testen

5.1 Teststrategien

Folgende Testarten bzw. Teststrategien kommen im vorliegenden Projekt zum Einsatz:

Reviews

Usability-Tests

Unit-Tests

System- und Abnahme-Tests

5.2 Testausführung

5.2.1 Reviews

Die Dokument-Reviews werden auf Papierausdruck durchgeführt. Jede Anpassung des Dokuments erfordert einen Eintrag ins Versionskontrolle Kapitel.

Ist ein Dokument-Review abgeschlossen, d.h. es sind keine Korrekturen durch Testpersonen mehr pendent, so gilt das Dokument als genehmigt. Dies wird auch in der Versionskontrolle Tabelle bei der Freigegeben Spalte durch das Eintragen des Datums und Visum gekennzeichnet.

5.2.2 Usability-Tests

Es soll einen GUI-Prototyp erstellt werden, welcher mit den Betreuern im direkten Gespräch beurteilt wird.

5.2.3 Unit-Tests

Die Delphi Schnittstelle soll mit einem Test Projekt im Visual Studio realisiert und getestet werden.

5.2.4 System- und Abnahme-Tests

Die verschiedenen Tests werden gemäss noch zu erstellendem Testplan durchgeführt und das Ergebnis im Testplan rapportiert. Zur Durchführung der Tests werden für jeden Anwendungsfall (Use Case) gemäss Kapitel 4 ein oder mehrere so genannte Szenarien definiert.

Die Szenarien werden pro Anwendungsfall in einer Tabelle gemäss nachfolgender Vorlage beschrieben:

Anwendungsfall:

Nr. Szenario Beschreibung Ausgangslage Erwartetes Resultat Erfolg

Tabelle 18 : Anwendungsfall Szenario

Documents

Konfigurations-Toolstatic.sws.bfh.ch/download/MAS-07-01-15-spec.pdf · Pflichtenheft Konfigurations-Tool SOHARD AG MAS-07-01.15-SRS-V1.1-Konfigurations-Tool.doc Seite 5 von 24 1 Einleitung