Software

Die auswählbare Software im Schnittstellen-Tab kann hier definiert werden. Einige Parameter sind essentiell für die Benutzung des Configurator-Moduls.

Über den Button neu kann ein neuer Eintrag angelegt werden. Die vorhandene Beispielkonfiguration muss angepasst und im Feld Bezeichnung ein Softwarename vergeben werden. Zum Abschluss muss Speichern betätigt werden.

Name	Pflichtfeld	Datentyp	Beschreibung
dev	ja	dev-Parameter	Object mit Parametern die umgebungsspezifisch sind
stage	ja	stage-Parameter	Object mit Parametern die umgebungsspezifisch sind
prod	ja	prod-Parameter	Object mit Parametern die umgebungsspezifisch sind
seperateDevWorkspace	ja	Boolean	wenn true, werden configs im Status dev auch in einen Workspace im Status dev zusammengestellt
internalExternalWorkspace	nein	Object	mit dem keys internal und external können zwei getrennte Workspaces definiert werden, in denen je nach Freigabeebene des Datensatzes (internet/intranet) die verknüpften Schnittstellen nur im internal oder auch im external Workspace zusammen gestellt werden
supportedApiTypes	ja	Object	Jeder Schlüssel dieses Objektes steht für einen unterstützen Schnittstellen-Typ. Pro Schnittstelle kann unter availableProjections ein String[] mit einer Liste von EPSG Codes hinterlegt werden
dataTypeMap	ja	Object	Mapping von Datenbank-Datentypen auf von der Software unterstütze Datentypen
inspireSettings	nein	Object	In diesem Objekt können INSPIRE spezifische Parameter konfiguriert werden. Aktuell wird nur für WMS und WFS der Parameter languageCode benötigt
softwareSpecificParameter	ja	softwareSpecificParameter	Softwarespezifische Parameter

Beispiel

{
    "dev": {
        "instances": [
            "fachdaten_dev"
        ],
        "urlIntTemplate": "{{protocol}}://{{server}}{{domain}}/{{folder}}/services/{{service_name}}",
        "urlExtTemplate": "https://qs-host.de/{{service_name}}",
        "defaultServer": "default-server-name"
    },
    "stage": {
        "instances": [
            "fachdaten_a_b"
        ],
        "urlIntTemplate": "{{protocol}}://{{server}}{{domain}}/{{folder}}/services/{{service_name}}",
        "urlExtTemplate": "https://qs-host.de/{{service_name}}",
        "defaultServer": "default-server-name"
    },
    "prod": {
        "instances": [
            "fachdaten_a_b"
        ],
        "urlIntTemplate": "{{protocol}}://{{server}}{{domain}}/{{folder}}/services/{{service_name}}",
        "urlExtTemplate": "https:/host.de/{{service_name}}",
        "defaultServer": "default-server-name"
    },
    "seperateDevWorkspace": true,
    "supportedApiTypes": {
        "wms": {
            "availableProjections": [
                "CRS:84",
                "EPSG:25832",
                "EPSG:25833",
                "EPSG:4326",
                "EPSG:4258",
                "EPSG:31467",
                "EPSG:3857",
                "EPSG:3044",
                "EPSG:3034",
                "EPSG:3035"
            ]
        },
        "wmstime": {
            "availableProjections": [
                "CRS:84",
                "EPSG:25832",
                "EPSG:25833",
                "EPSG:4326",
                "EPSG:4258",
                "EPSG:31467",
                "EPSG:3857",
                "EPSG:3044",
                "EPSG:3034",
                "EPSG:3035"
            ]
        },
        "wfs": {},
        "wfst": {},
        "wps": {},
        "wmts": {}
    },
    "dataTypeMap": {
        "smallint": "number",
        "integer": "number",
        "int": "number",
        "int2": "number",
        "int4": "number",
        "int8": "number",
        "float": "number",
        "float2": "number",
        "float4": "number",
        "float8": "number",
        "varchar": "text",
        "char": "text",
        "string": "text",
        "time": "date",
        "timestamp": "date",
        "timestampz": "date",
        "interval": "date",
        "bool": "boolean",
        "geometry_point": "geometry [point]",
        "geometry_line": "geometry [line]",
        "geometry_multiline": "geometry [line]",
        "geometry_polygon": "geometry [polygon]",
        "geometry_multipolygon": "geometry [polygon]",
        "text": "text",
        "MULTIPOLYGON": "geometry [polygon]",
        "LINESTRING": "geometry [line]",
        "timestamptz": "date",
        "bpchar": "text",
        "POINT": "geometry [point]",
        "POLYGON": "geometry [polygon]",
        "MULTILINESTRING": "geometry [line]",
        "MULTIPOINT": "geometry [point]",
        "uuid": "text",
        "date": "date",
        "numeric": "number"
    },
    "inspireSettings": {
        "languageCode": "ger"
    },
    "softwareSpecificParameter": {
        "apiKey": null,
        "workspaceReloadAllowed": true,
        "additionalOutputFormats": [
            "csv",
            "geojson"
        ]
    }
}

Umgebungsparameter

Name	Pflichtfeld	Datentyp	Beschreibung
instances	ja	String[]	Liste an in dieser Umgebung verfügbaren Workspaces / Instanzen
urlIntTemplate	ja	String	Template um automatisch die interne URL generieren zu können
urlExtTemplate	ja	String	Template um automatisch die externe URL generieren zu können
defaultServer	ja	String	Server, der standardmäßig für diese Umgebung gesetzt werden soll

Beispiel Deegree

{
    "instances": [
        "fachdaten_dev"
    ],
    "urlIntTemplate": "{{protocol}}://{{server}}{{domain}}/{{folder}}/services/{{service_name}}",
    "urlExtTemplate": "https://qs-host.de/{{service_name}}",
    "defaultServer": "default-server-name"
}

Beispiel Geoserver

{
    "instances": [],
    "urlIntTemplate": "{{protocol}}://{{server}}{{domain}}/geoserver/{{service_name}}",
    "urlExtTemplate": "{{protocol}}://{{server}}{{domain}}/geoserver/{{service_name}}",
    "defaultServer": "server1"
}

Softwarespezifische-Parameter

Name	Pflichtfeld	Datentyp	Software	Beschreibung
apiKey	nein	String	deegree	Bietet die Software eine API an, kann hier der API-Key definiert werden.
additionalOutputFormats	nein	String[]	deegree	Liste an Output-Formaten die zusätzlich angeboten werden sollen. Hier kann csv und geojson hinzugefügt werden.
gfiFooter	nein	String	deegree	Individuell einstellbarer Footer für das Template eines GetFeatureInfo Request im HTML Format
servicesSubdirectory	nein	Boolean	deegree	Falls true, wird dem Endpoint-Name der Kurzname des Datensatzes vorangestellt. Dies pflanzt sich auf die interne URL und ggf. geschützte URL fort. Außerdem wird die Service- und Service-Metadaten-Konfigurationsdatei in einem Unterverzeichnis abgelegt.
prefixes	nein	Object	deegree	In diesem Objekt können Präfixe für die Konfigurationsdateien konfiguriert werden.
workspaceReloadAllowed	nein	Boolean	deegree, ldproxy, GeoServer	Wenn true, kann in dieser Umgebung einer Workspace Reload ausgeführt werden.
basicAuth	nein	Object	GeoServer	Bietet die Software eine API an, können hier die Credentials angegeben werden.
webappContext	nein	String	GeoServer	Wenn die API nicht über den Standard-Context erreichbar ist kann hier der Context angegeben werden.
shapePath	nein	String	MapServer	Pfad, auf die Shape-Indexdatei.

Präfixe (deegree Konfiguration)

Name	Pflichtfeld	Datentyp	Software	Beschreibung
datasource	nein	String	deegree	Präfix für die datasource XML-Konfigurationsdatei.
layer	nein	String	deegree	Präfix für die layer XML-Konfigurationsdatei.
style	nein	String	deegree	Präfix für die style XML-Konfigurationsdatei.
theme	nein	String	deegree	Präfix für die theme XML-Konfigurationsdatei. Falls gesetzt, wird ein Unterverzeichnis (Kurzname des Datensatzes) pro Theme-Datei angelegt.

BasicAuth (GeoServer Konfiguration)

Name	Pflichtfeld	Datentyp	Software	Beschreibung
username	ja	String	GeoServer	Username, der für die Benutzung der API berechtigt ist.
password	ja	String	GeoServer	Passwort des angegebenen Usernamens.

Beispiel Deegree

{
    "softwareSpecificParameter": {
        "apiKey": null,
        "workspaceReloadAllowed": true,
        "additionalOutputFormats": [
            "csv",
            "geojson"
        ],
        "gfiFooter": "Bereitgestellt von ...",
        "servicesSubdirectory": true,
        "prefixes": {
            "datasource": "datasource_",
            "layer": "layer_",
            "style": "style_",
            "theme": "theme_"
        }
    }
}

Beispiel Geoserver

{
    "softwareSpecificParameter": {
        "basicAuth" : {
            "username": "admin",
            "password": "goserver"
        },
        "webappContext": "geoserver_123",
        "workspaceReloadAllowed": true
    }
}