MUSTANG-Profile

Ein MUSTANG-Profil enthält alle Informationen zur Konfiguration einer MUSTANG-Instanz. Beispielsweise enthält ein Profil, die Verbindungsinformationen zum OLAP-Server und zur Arbeitsmappendatenbank, die Konfiguration der Geodaten für die Karte, aktivierte Module und Visualisierungen und deren Konfiguration. Ein MUSTANG-Profil hat einen eindeutigen Namen, über das es identifiziert wird. MUSTANG, und das MUSTANG-Tooling verwenden Profile, um eine umständliche Konfiguration jeder einzelnen Anwendung zu umgehen. Stattdessen reicht es aus, beim Start der Anwendung, das gewünschte MUSTANG-Profil anhand des Namens auszuwählen, um sich so mit der jeweiligen MUSTANG-Instanz zu verbinden.

Struktur

MUSTANG-Profile können unter folgenden Orten gespeichert werden:

Speicherort	Beschreibung
`%PROGRAMDATA%\OFFIS\MUSTANG\Profiles`	Speicherort für systemweit verfügbare Profile.
`%APPDATA%\OFFIS\MUSTANG\Profiles`	Speicherort für Profile, die nur der angemeldete Windows-Benutzer verwenden kann.

In diesen Ordnern wird für jedes Profil ein eigener Ordner angelegt. Der Name dieses Ordners kann frei gewählt werden. In dem Ordner befinden sich immer die Datei profile.json, die die ID und den Namen des MUSTANG-Profils enthält sowie die Datei Configuration.Storage.json, die die Verbindung zu einer Konfigurationsdatenbank enthält. Oftmals enthält dieser Ordner auch eine Settings.json-Datei in der Clienteinstellungen, wie beispielsweise das eingestellte Theme gespeichert werden. Diese Datei muss allerdings nicht händisch erzeugt werden, MUSTANG erstellt sie selber, wenn sie benötigt wird.

Hinweis

Sämtliche Konfigurationsdateien müssen in der Zeichensatzkodierung UTF-8 (ohne BOM (Byteordermark)) gespeichert werden.

Profil-Datei

Die profiles.json-Datei hat folgende Struktur:

{
  "Id": "<Eindeutige ID des Profils>",
  "Caption": "<Profilname>",
  "Description": "<Beschreibung>"
}

Der Wert von Id legt die ID des Profils fest. Die ID wird benötigt, um ein Profil eindeutig zu identifizieren und darf daher nicht mehrfach vergeben werden. Sie wird zum Beispiel beim Aufruf von Tools wie der MUSTANG Migration App verwendet. Der Wert von Caption legt den Profilnamen fest, mit dem Parameter Description kann eine Beschreibung definiert werden, die in der Profilauswahl angezeigt wird.

Tipp

MUSTANG legt beim Laden eines Profils die Umgebungsvariable %MUSTANG_PROFILE% an, die den Pfad zum aktiven MUSTANG-Profil enthält. Diese Variable kann in den Konfigurationsdateien verwendet werden, um beispielsweise Dateien relativ zum jeweiligen MUSTANG-Profil zu referenzieren.

Arbeitsmappen-DB

Die Konfiguration der Konfigurations- und Arbeitsmappen-Datenbank wird in der Datei Configuration.Storage.json vorgenommen. Da hier die Konfigurationsdatenbank definiert wird, kann diese Einstellung nicht aus der Konfigurationsdatenbank geladen werden. Die Datei hat folgende Struktur:

{
  "ConnectionString": "server=<Server>; Database=<Datenbank>; Integrated Security=SSPI; MultipleActiveResultSets=true",
  "StorageType": "SqlServer"
}

Die Eigenschaft StorageType enthält den Typ der Datenbank und darf folgende Werte enthalten:

Datenbanktyp	Beschreibung
`SqlServer`	Microsoft SQL Server
`Postgre`	PostgreSQL Server
`Oracle`	Oracle Database
`Disabled`	keine Datenbank zum Speichern von Arbeitsmappen verwenden

Die Eigenschaft ConnectionString enthält die Verbindungszeichenfolge zur Arbeitsmappendatenbank. Die folgende Tabelle enthält beispielhafte Verbindungszeichenfolgen für die von MUSTANG unterstützten Datenbank-Typen:

server=srvtest; Database=TEST_WORKBOOKS; Integrated Security=SSPI; MultipleActiveResultSets=true

Server=srvtest; Port=5432; Database=test_workbook; User Id=user; Password=password;

User ID=user; Password=password; Persist Security Info=True; Data Source=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP)(HOST = srvtest)(PORT = 1521))) (CONNECT_DATA =(SERVICE_NAME = service)))

Tipp

Unter www.connectionstrings.com finden sich detaillierte Beschreibungen zum Aufbau der Verbindungszeichenfolgen aller gängigen Datenbanksysteme.

Tipp

Wenn Microsoft SQL Server als Arbeitsmappendatenbank verwendet wird, empfiehlt es sich Multiple Active Result Sets (MARS) zu aktivieren, um das Speichern von Arbeitsmappen zu beschleunigen. Dies geschieht, wie im Beispiel gezeigt, durch Anhängen der MultipleActiveResultSets-Eigenschaft an die Verbindungszeichenfolge.

Zweistufige Konfiguration

Ein MUSTANG-Profil kann zweistufig konfiguriert werden. Organisations-weite Einstellungen können in der zentralen Konfigurationsdatenbank gespeichert werden, benutzerspezifische Einstellungen können in Konfigurationsdateien gespeichert werden, die im selben Ordner wie die profile.json liegen. Beim Laden eines Profils werden zuerst die Einstellungen der zentralen Konfigurationsdatenbank gesetzt. Danach werden die lokalen Konfigurationsdateien eingelesen und damit gegebenenfalls aus der Konfigurationsdatenbank stammende Einstellungen überschrieben. Somit ist es möglich, ein MUSTANG-Profil komplett in der Datenbank, komplett datei-basiert oder als Mischform von beiden zu definieren.

Die Definition eines Profils in der Datenbank erfolgt in der Tabelle configuration. Diese enthält zwei Spalten: key und value. In der key-Spalte wird der Pfad zu einer Konfigurationseinstellung eingetragen, in der value-Spalte wird der Wert der Einstellung eingetragen.

Der Pfad zu einer Konfigurationseinstellung ist eine durch Doppelpunkte getrennte Zeichenkette. Das erste Element dieser Zeichenkette enthält immer den Schlüssel des zu konfigurierenden Abschnitts. In der folgenden Tabelle werden sämtliche Konfigurations-Abschnitte mit den dazugehörigen Schlüsseln und den Dateinamen zum Überschreiben der Konfiguration aus der Datenbank gelistet.

Neben der profile.json befinden sich noch typischerweise folgende Konfigurationsdateien im Profilordner:

Abschnitt	Schlüssel	Dateiname	Beschreibung
Farbschemata	`ColorThemeConfiguration`	`ColorThemes.json`	Konfigurationsdatei mit benutzerdefinierten Farbschemata
OLAP Server	`OlapServerConfiguration`	`Configuration.OlapServer.json`	Globale Konfiguration des OLAP-Servers, der von den Modulen verwendet wird
R	`RProcessConfiguration`	`Configuration.R.json`	Globale Konfiguration der von MUSTANG zu verwendenden R-Instanz
Geo-Daten	`FeatureProviderConfiguration`	`Configuration.FeatureProvider.json`	Globale Konfiguration der Geo-Daten, die von den Karten genutzt werden
OLAP-Modul	`OlapConfiguration`	`Configuration.Olap.json`	Konfiguration des OLAP-Moduls
Visualisierungen	`VisualisationConfiguration`	`Configuration.Visualisations.json`	Konfiguration der Visualisierungen, die im OLAP-Modul zur Verfügung stehen
Kaplan-Meier ÜZA	`KaplanMeierOlapConfiguration`	`Configuration.KaplanMeier.json`	Konfiguration des Kaplan-Meier-Überlebenszeitanalysemoduls
Periodenanalyse	`PeriodAnalysisOlapConfiguration`	`Configuration.PeriodAnalysis.json`	Konfiguration des Periodenanalyse-Überlebenszeitanalysemoduls
Sterbetafeln	`LifetableConfigurationProviderConfiguration`	`Configuration.Lifetables.json`	Konfiguration des Sterbetafeln für das Periodenanalyse-Überlebenszeitanalysemodul

Folgende Tabelle zeigt Beispieleinträge für die configuration-Tabelle zum Festlegen von Standardwerten für ein MUSTANG-Profil:

`key`	`value`	Beschreibung
`VisualisationConfiguration:DisabledPlugins:0`	`OlapMapVisualisationPlugin`	Diese und die nächsten drei Zeilen definieren eine Liste von zu deaktivierenden OLAP-Visualisierungen
`VisualisationConfiguration:DisabledPlugins:1`	`OlapBarChartVisualisationPlugin`
`VisualisationConfiguration:DisabledPlugins:2`	`OlapColumnChartVisualisationPlugin`
`VisualisationConfiguration:DisabledPlugins:3`	`OlapPieChartVisualisationPlugin`
`VisualisationConfiguration:RVisualisationsFolder`	`%MUSTANG_PROFILE%\RVisualisations`	Legt den Ordner fest, in dem sich die R-Visualisierungen befinden.

Farbschemata

MUSTANG wird standardmäßig mit acht fest vorgegebenen Farbschemata ausgeliefert. Diese Liste lässt einfach erweitern, indem weitere Farbschemata in der Konfigurationsdatei ColorThemes.json eingetragen werden. Sollte diese Datei in Ihrem MUSTANG-Profil noch nicht vorhanden, kann hierfür eine leere Text-Datei mit diesem Namen erstellt werden.

Die Datei enthält ein JSON-Objekt, das folgende Eigenschaften enthält

Eigenschaft	Beschreibung
`DefaultDivergingColorTheme`	ID eines vorgegebenen oder benutzerdefinierten Farbschemas, das standardmäßig von Visualisierungen, die divergierende Farben präferieren (z.B. Thematische Karte), genutzt wird.
`DefaultGradientColorTheme`	ID eines vorgegebenen oder benutzerdefinierten Farbschemas, das standardmäßig von Visualisierungen, die gradiente Farbverläufe präferieren (z.B. Diagramme), genutzt wird.
`DefaultColorTheme`	ID eines vorgegebenen oder benutzerdefinierten Farbschemas, das standardmäßig von Visualisierungen genutzt wird, die keinen bestimmten Farbschematyp präferieren.
`ColorThemes`	Liste der Farbschemata.

Ein Farbschema enthält folgende Eigenschaften:

Eigenschaft	Beschreibung
`Id`	Eindeutige ID, die ein Farbschema identifiziert. Diese wird zum Beispiel in der Arbeitsmappe gespeichert und beim Laden der Arbeitsmappe verwendet, um das korrekte Farbschema für eine Analyse zu laden.
`Caption`	Der Name des Farbschemas. Der Name wird in der Farbschemaauswahlliste angezeigt.
`Description`	Die Beschreibung des Farbschemas. Diese wird in der Farbschemaauswahlliste als Tooltip zum jeweiligen Farbschema angezeigt.
`Colors`	Liste von Farben, definiert als RGB-Codes (#RRGGBB) oder ARGB-Codes (#AARRGGBB), die das Farbschema definieren.

Die folgende Auflistung enthält eine Beispiel-Konfigurationsdatei, die zwei Farbschemata enthält

{
    "DefaultColorTheme": "Theme1",
    "DefaultDivergingColorTheme": "Theme6",
    "DefaultGradientColorTheme": "my-color-theme-1",
    "ColorThemes": [{
        "Id": "my-color-theme-1",
        "Caption": "Farbschema 1",
        "Description": "Ein Farbschema zu Demonstrationszwecken",
        "Colors": ["#ff00ff", "#af4354", "#000000"]
    }, {
        "Id": "my-color-theme-2",
        "Caption": "Farbschema 2",
        "Description": "Ein weiteres Farbschema zu Demonstrationszwecken",
        "Colors": ["#ff00ff", "#af4354", "#000000", "#4456af"]
    }]
}

OLAP Server

Die Konfiguration des OLAP-Servers wird global in der Datei Configuration.OlapServer.json vorgenommen. Der hier konfigurierte OLAP-Server wird sowohl vom OLAP-Modul, wie auch von den Überlebenszeitanalyse-Modulen verwendet. Die Datei hat folgende Struktur:

{
  "OlapServerType": "AnalysisServices",
  "ConnectionString": "Data Source=<Server>;Catalog=<Datenbank>",
  "LogMdx": false,
  "LogXmlaResult": false
}

OlapServerType kann entweder AnalysisServices oder Mondrian sein. Die ConnectionString-Eigenschaft enthält die Verbindungszeichenfolge zum OLAP-Server. Die folgende Tabelle enthält beispielhafte Verbindungszeichenfolgen für die beiden OLAP-Server Typen:

OLAP-Server Typ	Verbindungszeichenfolge
`AnalysisServices`	`Data Source=srvtest;Catalog=DWH_TEST`
`AnalysisServices`	`Data Source=srvtest\instancename;Catalog=DWH_TEST`
`AnalysisServices` (mit lokaler Cube-Datei)	`DataSource=Modules\Resources\Data\MUSTANG.cub;Catalog=MUSTANG`
`Mondrian`	`Uri=http://srvtest:8080/mondrian/xmla;Catalog=DWH_TEST; DataSourceInfo='Provider=Mondrian;DataSource=Test;`
`Mondrian` (mit Authentifizierung)	`Uri=http://srvtest:8080/pentaho/Xmla;Catalog=DWH_TEST; UserName=user; Password=password`

LogMdx protokolliert sämtliche gestellten MDX-Anfragen in der Log-Datei. LogXmlaResult protokolliert sämtliche Antworten des OLAP-Servers in der Log-Datei. Standardmäßig sind beide Optionen deaktiviert.

Warnung

Da sowohl Anfragen als auch Antworten sehr groß sein können, empfiehlt es sich, die beiden Optionen LogMdx und LogXmlaResultnur bei Bedarf zur Fehlersuche zu aktivieren. Im Regelbetrieb kann andernfalls die Leistung beeinträchtigt sein.

R

Die Konfiguration der von MUSTANG zu verwendenden R-Instanz wird global in der Datei Configuration.R.json vorgenommen. MUSTANG verwendet R zur Berechnung der Überlebenszeitanalysen, sowie zur Anzeige von R-Visualisierungen. Sofern diese Funktionen nicht benötigt werden, kann die Konfiguration von R ausgelassen werden.

Warnung

MUSTANG ist nicht kompatibel zu älteren Versionen von R. Die benötigte Mindestversion von R findet sich in den Systemanforderungen.

Die Konfigurationsdatei hat folgende Struktur:

{
  "RScriptExePath": "C:\\Programme\\R\\R 3.2.3\\bin\\RScript.exe",
  "Timeout": 300000,
  "Debug": false,
  "CleanUp": true
}

Die Eigenschaft RScriptExePath enthält den Pfad zur Datei rscript.exe der R-Instanz die ausgeführt werden soll. Wenn dieser Wert in der Konfigurationsdatei nicht definiert ist, ermittelt MUSTANG die Standard-R-Instanz anhand der Windows-Registry. Falls sich nur eine R-Installation auf dem PC befindet, muss die RScriptExePath-Eigenschaft in der Regel nicht gesetzt werden.

Die Timeout-Eigenschaft definiert, wie lange MUSTANG auf die Beendigung eines R-Skriptes warten soll, bevor es abgebrochen wird. Der Wert wird in Millisekunden definiert. Wird diese Eigenschaft nicht gesetzt wird als Standard 300.000ms (5 Minuten) genommen.

Wenn Debug auf true gestellt wird, werden sämtliche R-Statements, die in MUSTANG ausgeführt werden, in der Log-Datei protokolliert.

Die CleanUp-Eigenschaft steuert, ob die temporäre R-Umgebung eines R-Statements nach Ausführung wieder gelöscht wird. Dies kann in Zusammenhang mit der Debug-Eigenschaft verwendet werden, um die eingeflossenen Daten eines R-Skripts zu untersuchen. Generell sollte diese Eigenschaft jedoch auf true stehen, um zu verhindern, dass die Festplatte mit R-Umgebungen gefüllt wird.

Tipp

Wenn sich nur eine R-Installation auf Ihrem Rechner befindet, kann diese Datei in der Regel leergelassen werden, da MUSTANG dann die Standard-R Installation zur Ausführung verwendet.

Geo-Daten

Die Konfiguration der Geo-Daten wird in der Datei Configuration.FeatureProvider.json vorgenommen. Die Konfiguration muss nur vorgenommen werden, wenn die Visualisierung Thematische Karte oder die Überlebenszeitanalysen verwendet werden. Es können ESRI-Shapefiles und GeoJSON-Dateien verwendet werden. Um ein ESRI-Shapefile zu nutzen, benötigt die Datei folgende Struktur:

{
  "GeoIdResolverType": "FromPropertyResolver",
  "GeoIdProperty": "geo_id",
  "FileFormat": "ShapeFile",
  "FilePath": "%MUSTANG_PROFILE%\\Resources\\Shapes\\region.shp",
  "ShapeFileGeoIdColumn": "name"
}

Eine GeoJSON-Datei wird folgendermaßen konfiguriert:

{
  "GeoIdResolverType": "FromPropertyResolver",
  "GeoIdProperty": "geo_id",
  "FileFormat": "GeoJson",
  "FilePath": "%MUSTANG_PROFILE%\\Resources\\Shapes\\region.geojson",
  "GeoJsonIdProperty": "geo_id"
}

In dieser Datei wird die Quelle der Geo-Daten konfiguriert und die Art und Weise, wie die Geo-Daten mit den Knoten der OLAP-Datenbank verknüpft werden sollen.

Die Eigenschaft FilePath enthält den Pfad zu einer Datei, die die zu rendernden Polygone (Gebiete) enthält. Die Datei muss im ESRI-Shape- oder GeoJSON-Format vorliegen. Die Daten sollten im Koordinatensystem ETRS89 / UTM zone 32n (EPSG Code 3044) vorliegen, um korrekt gerendert zu werden.

Die Eigenschaft FileFormat gibt an, um was für einen Dateityp es sich bei der mit FilePath referenzierten Datei handelt. Wird diese Eigenschaft nicht gesetzt, wird davon ausgegangen, dass es sich um eine Datei im ESRI-Shape-Format handelt. Zulässig sind die Werte ShapeFile und GeoJson.

Die Eigenschaft ShapeFileGeoIdColumn enthält den Spaltennamen der Shape-Datei, in dem sich eine ID befindet, die genutzt wird, um ein Polygon mit einem Knoten der OLAP-Datenbank zu verknüpfen. Diese Eigenschaft wird nur genutzt, wenn die Eigenschaft FileFormat auf ShapeFile gesetzt ist.

Die Eigenschaft GeoJsonIdProperty enthält den Eigenschaftenname der GeoJSON-Datei, die die ID enthält, die genutzt wird, um ein Polygon mit einem Knoten der OLAP-Datenbank zu verknüpfen. Diese Eigenschaft wird nur genutzt, wenn die Eigenschaft FileFormat auf GeoJson gesetzt ist.

Die Eigenschaft GeoIdResolverType legt fest, auf welche Art die ID der Knoten aus der OLAP-Datenbank ermittelt werden soll. Folgende Ausprägungen sind erlaubt:

FromPropertyResolver: Die ID wird aus einer Knoteneigenschaft ausgelesen, die mit Hilfe der GeoIdProperty festgelegt wird
FromShortnameResolver Die Kurzbezeichnung des jeweiligen Knotens wird als ID verwendet

Die Eigenschaft GeoIdProperty muss nur festgelegt werden, wenn GeoIdResolverType auf FromPropertyResolver festgelegt ist. In diesem Fall wird hier der Name der Eigenschaft, die die Geo-ID enthält, festgelegt.

OLAP-Modul

Die Konfiguration des OLAP-Moduls wird in der Datei Configuration.Olap.json vorgenommen. Die Datei hat folgende Struktur

{
  "IsEnabled": true
}

Die Eigenschaft IsEnabled legt fest, ob das Modul im MUSTANG-Profil aktiviert werden soll. Gültige Werte sind true um das Modul zu aktivieren und false um das Modul zu deaktivieren.

Visualisierungen

Die Konfiguration der Visualisierungen, die dem OLAP-Modul zur Verfügung stehen, wird in der Datei Configuration.Visualisations.json vorgenommen. Die Visualisierungskonfiguration muss nur vorgenommen werden, wenn auch das OLAP-Modul aktiviert ist. Die Datei hat folgende Struktur:

{
  "DisabledPlugins": [
    "OlapMapVisualisationPlugin",
    "OlapBarChartVisualisationPlugin",
    "OlapColumnChartVisualisationPlugin",
    "OlapPieChartVisualisationPlugin"
  ],
  "RVisualisationsFolder": "%MUSTANG_PROFILE%\\RVisualisations"
}

Die Eigenschaft DisabledPlugins enthält eine Liste von Standardvisualisierungen, die MUSTANG NICHT verwenden soll. Ist diese Liste leer, so stehen dem Anwender sämtliche MUSTANG-Standardvisualisierungen zur Verfügung. Folgende Visualisierungen werden derzeit unterstützt und können deaktiviert werden:

Visualisierung	Beschreibung
`OlapTableVisualisationPlugin`	Hierarchische Tabelle
`OlapFlatTableVisualisationPlugin`	Flache Tabelle
`OlapBarChartVisualisationPlugin`	Balkendiagramm
`OlapHeatMapVisualisationPlugin`	HeatMap
`OlapColumnChartVisualisationPlugin`	Säulendiagramm
`OlapStackedBarChartVisualisationPlugin`	Gestapeltes Balkendiagramm
`OlapStackedColumnChartVisualisationPlugin`	Gestapeltes Säulendiagramm
`OlapPieChartVisualisationPlugin`	Kreisdiagramm
`OlapScatterChartVisualisationPlugin`	Punktdiagramm
`OlapLineChartVisualisationPlugin`	Liniendiagramm
`OlapStairStepChartVisualisationPlugin`	Stufendiagramm
`OlapBoxPlotChartVisualisationPlugin`	Box-Plot-Diagramm
`OlapMapVisualisationPlugin`	Thematische Karte

Die Eigenschaft RVisualisationsFolder enthält einen Pfad, in dem sich R-Visualisierungen befinden. Sämtliche R-Visualisierungen, die sich in diesem Pfad befinden, werden ebenfalls für das OLAP-Modul aktiviert. Falls keine R-Visualisierungen verwendet werden, kann diese Eigenschaft ausgelassen werden. Weitere Informationen zum Erstellen eigener R-Visualisierungen finden sich in Artikel R-Visualisierungen.

Kaplan-Meier ÜZA

Das Kaplan-Meier-Überlebenszeitanalysemodul wird in der Datei Configuration.KaplanMeier.json konfiguriert. Die Datei hat folgende Struktur:

{
  "IsEnabled": true,
  "CubeName": "KaplanMeierSurvivalAnalysis",
  "StartTimeHierarchyConfiguration": {
    "LevelUniqueName": "[Startzeitpunkt].[Zeit].[Monate]",
    "CultureInfo": "de-DE",
    "YearPropertyName": "year",
    "MonthPropertyName": "month"
  },
  "EndTimeHierarchyConfiguration": {
    "LevelUniqueName": "[Endzeitpunkt].[Zeit].[Monate]",
    "CultureInfo": "de-DE",
    "UnknownMemberUniqueName": "[Endzeitpunkt].[Jahre].&[Unbekannt]",
    "YearPropertyName": "year",
    "MonthPropertyName": "month"
  },
  "EventMemberUniqueName": "[Verstorben].[Verstorben].[Verstorben].&[Verstorben]"
}

Die Eigenschaft IsEnabled legt fest, ob das Modul im MUSTANG-Profil aktiviert werden soll. Gültige Werte sind true um das Modul zu aktivieren und false um das Modul zu deaktivieren.

Die Eigenschaft CubeName legt den Cube fest, auf dem die Überlebenszeitanalyse berechnet wird.

Die Eigenschaft MeasureUniqueName legt den Namen der Kennzahl fest, die zur Berechnung der Überlebenszeitanalyse verwendet wird. Enthält der Cube lediglich eine sichtbare Kennzahl, kann diese Eigenschaft auch leer gelassen werden.

Die EventMemberUniqueName-Eigenschaft definiert die Eigenschaft die ein Member hat, wenn das Event of Interest eingetreten ist. Alle weiteren Member aus der Hierarchie des EventMemberUniqueName werden interpretiert als Event of Interest-ist-nicht-eingetreten. Diese Eigenschaft ist optional. Ist sie nicht gesetzt, wird das Event of Interest anhand des Endzeitpunktes gesetzt. Fälle mit unbekanntem Endzeitpunkt werden als Event of Interest nicht eingetreten, Fälle mit definiertem Endzeitpunkt als Event of Interest eingetreten behandelt.

Der Abschnitt [StartTimeHierarchyConfiguration] definiert die Startzeitdimension, die verwendet wird, um den Kohortenbeginn festzulegen. Hierin befinden sich folgende Eigenschaften:

Eigenschaft	Beschreibung
`LevelUniqueName`	Der Uniquename der Ebene, auf der die Fälle definiert sind
`YearPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich das Jahr des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`MonthPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich der Monat des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`UnknownMemberUniqueName`	Der Uniquename des Knotens, den die Fälle, bei denen das Event of Interest noch nicht eingetreten ist, zugewiesen bekommen. Diese Eigenschaft wird nur in der `EndTimeHierarchyConfiguration` benötigt, und dort nur, wenn die Zeitdaten über Eigenschaften und nicht die Beschriftung erfasst werden.
`CultureInfo`	Die Culture, die verwendet wird, um aus der Beschriftung eines Knotens ein Datum zu parsen. Wenn diese Eigenschaft nicht angegeben wird, wird eine `Invariant`-Culture verwendet. Diese Eigenschaft wird nur verwendet, wenn das Datum aus der Knotenbeschriftung geparst werden sollen.

Der Abschnitt [EndTimeHierarchyConfiguration] definiert die Dimension des Endzeitpunkts, die verwendet wird, um das Kohortenende festzulegen. Hierin befinden sich folgende Eigenschaften:

Eigenschaft	Beschreibung
`LevelUniqueName`	Der Uniquename der Ebene, auf der die Fälle definiert sind
`YearPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich das Jahr des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`MonthPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich der Monat des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`UnknownMemberUniqueName`	Der Uniquename des Knotens, den die Fälle, bei denen das Event of Interest noch nicht eingetreten ist, zugewiesen bekommen. Diese Eigenschaft wird nur in der `EndTimeHierarchyConfiguration` benötigt, und dort nur, wenn die Zeitdaten über Eigenschaften und nicht die Beschriftung erfasst werden.
`CultureInfo`	Die Culture, die verwendet wird, um aus der Beschriftung eines Knotens ein Datum zu parsen. Wenn diese Eigenschaft nicht angegeben wird, wird eine `Invariant`-Culture verwendet. Diese Eigenschaft wird nur verwendet, wenn das Datum aus der Knotenbeschriftung geparst werden sollen.

Hinweis

Die Kaplan-Meier-Überlebenszeitanalyse basiert auf dem R-Paket survival. Das Paket ist Bestandteil der meisten R-Distributionen, kann aber bei Bedarf auch vom CRAN heruntergeladen werden. Wenn die Kaplan-Meier-Überlebenszeitanalyse verwendet werden soll, muss sichergestellt sein, dass dieses Paket in der R-Instanz des Benutzers installiert ist.

Periodenanalyse

Das Perioden-Überlebenszeitanalysemodul wird in der Datei Configuration.PeriodAnalysis.json konfiguriert. Die Datei hat folgende Struktur:

{
  "IsEnabled": true,
  "CubeName": "PeriodSurvivalAnalysis",
  "StartTimeHierarchyConfiguration": {
    "LevelUniqueName": "[Startzeitpunkt].[Zeit].[Monate]",
    "CultureInfo": "de-DE",
    "YearPropertyName": "jahr",
    "MonthPropertyName": "monat"
  },
  "EndTimeHierarchyConfiguration": {
    "LevelUniqueName": "[Endzeitpunkt].[Zeit].[Monate]",
    "UnknownMemberUniqueName": "[Endzeitpunkt].[Jahre].&[Unbekannt]",
    "CultureInfo": "de-DE",
    "YearPropertyName": "jahr",
    "MonthPropertyName": "monat"
  },
  "GenderMaleMemberUniqueName": "[Geschlecht].[Geschlecht].[Geschlecht].&[M]",
  "GenderFemaleMemberUniqueName": "[Geschlecht].[Geschlecht].[Geschlecht].&[W]",
  "AgeLevelUniqueName": "[Alter].[Alter].[15 bis 99]",
  "AgePropertyName": "age",
  "EventMemberUniqueName": "[Verstorben].[Verstorben].[Verstorben].&[Verstorben]"
}

Die Eigenschaft IsEnabled legt fest, ob das Modul im MUSTANG-Profil aktiviert werden soll. Gültige Werte sind true um das Modul zu aktivieren und false um das Modul zu deaktivieren.

Die Eigenschaft CubeName legt den Cube fest, auf dem die Überlebenszeitanalyse berechnet wird.

Die Gender...- und Age...-Eigenschaften definieren die Geschlechts-, bzw. Altersdimensionen die verwendet werden, um das relative Überleben zu berechnen.

Der Abschnitt [StartTimeHierarchyConfiguration] definiert die Startzeitdimension, die verwendet wird, um den Kohortenbeginn festzulegen. Hierin befinden sich folgende Eigenschaften:

Eigenschaft	Beschreibung
`LevelUniqueName`	Der Uniquename der Ebene, auf der die Fälle definiert sind
`YearPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich das Jahr des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`MonthPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich der Monat des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`UnknownMemberUniqueName`	Der Uniquename des Knotens, den die Fälle, bei denen das Event of Interest noch nicht eingetreten ist, zugewiesen bekommen. Diese Eigenschaft wird nur in der `EndTimeHierarchyConfiguration` benötigt, und dort nur, wenn die Zeitdaten über Eigenschaften und nicht die Beschriftung erfasst werden.
`CultureInfo`	Die Culture, die verwendet wird, um aus der Beschriftung eines Knotens ein Datum zu parsen. Wenn diese Eigenschaft nicht angegeben wird, wird eine `Invariant`-Culture verwendet. Diese Eigenschaft wird nur verwendet, wenn das Datum aus der Knotenbeschriftung geparst werden sollen.

Der Abschnitt [EndTimeHierarchyConfiguration] definiert die Dimension des Endzeitpunkts, die verwendet wird, um das Kohortenende festzulegen. Hierin befinden sich folgende Eigenschaften:

Eigenschaft	Beschreibung
`LevelUniqueName`	Der Uniquename der Ebene, auf der die Fälle definiert sind
`YearPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich das Jahr des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`MonthPropertyName`	Der Name der Ebenen-Eigenschaft, in der sich der Monat des jeweiligen Knotens befindet. Diese Eigenschaft wird nur benötigt, wenn die Zeitdaten über Eigenschaften eingelesen werden sollen.
`UnknownMemberUniqueName`	Der Uniquename des Knotens, den die Fälle, bei denen das Event of Interest noch nicht eingetreten ist, zugewiesen bekommen. Diese Eigenschaft wird nur in der `EndTimeHierarchyConfiguration` benötigt, und dort nur, wenn die Zeitdaten über Eigenschaften und nicht die Beschriftung erfasst werden.
`CultureInfo`	Die Culture, die verwendet wird, um aus der Beschriftung eines Knotens ein Datum zu parsen. Wenn diese Eigenschaft nicht angegeben wird, wird eine `Invariant`-Culture verwendet. Diese Eigenschaft wird nur verwendet, wenn das Datum aus der Knotenbeschriftung geparst werden sollen.

Hinweis

Die Perioden-Überlebenszeitanalyse basiert auf dem R-Paket periodR in Version 1.0.6, das auf der Website des Krebsregisters Saarland heruntergeladen werden kann. Wenn die Perioden-Überlebenszeitanalyse verwendet werden soll, muss sichergestellt sein, dass dieses Paket in der R-Instanz des Benutzers installiert ist.

Sterbetafeln

Die Konfiguration der Sterbetafeln wird in der Datei Configuration.Lifetables.json vorgenommen. Die Konfiguration ist nur notwendig, wenn auch das Periodenanalyse-Modul verwendet wird. Die Datei hat folgende Struktur:

{
  "LifetableConfigurationProviderConfigurationInfos": [
    {
      "Id": "germany-1993-2016",
      "Name": "Deutschland 1993 - 2016",
      "PathToMaleLifetable": "%MUSTANG_PROFILE%\\Lifetables\\germany_1993-2016-m.csv",
      "PathToFemaleLifetable": "%MUSTANG_PROFILE%\\Lifetables\\germany_1993-2016-f.csv"
    },
    {
      "Id": "west-germany-1993-2016",
      "Name": "Westdeutschland 1993 - 2016",
      "PathToMaleLifetable": "%MUSTANG_PROFILE%\\Lifetables\\west_germany_1993-2016-m.csv",
      "PathToFemaleLifetable": "%MUSTANG_PROFILE%\\Lifetables\\west_germany_1993-2016-f.csv"
    }
  ]
}

Die Datei enthält eine Liste mit Sterbetafel-Konfigurationen. Jede Konfiguration besteht aus folgenden Eigenschaften:

Eigenschaft	Beschreibung
`Id`	Die eindeutige ID der Sterbetafel. Diese wird unter anderem zum Speichern einer Überlebenszeitanalyse in der Arbeitsmappendatenbank verwendet, und sollte daher nicht mehr nachträglich verändert werden.
`Name`	Der Anzeigename für die Sterbetafel, zum Beispiel zur Auswahl in MUSTANG
`PathToMaleLifetable`	Der Pfad zu der Sterbetafeldatei für die männlichen Fälle. Der genaue Aufbau dieser Datei ist in Artikel Sterbetafeln beschrieben
`PathToFemaleLifetable`	Der Pfad zu der Sterbetafeldatei für die weiblichen Fälle. Der genaue Aufbau dieser Datei ist in Artikel Sterbetafeln beschrieben