Verfahren hinzufügen (XPlanverfahren): Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Diese Funktion ermöglicht einen Import von Verfahren im XML-Format und nach dem XöV Standard XPlanverfahren. Der Import kann ein einzelnes Verfahren oder auc…“) |
|||
(8 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | Diese Funktion ermöglicht einen Import von Verfahren im XML-Format und nach dem XöV Standard XPlanverfahren. Der Import kann ein einzelnes Verfahren oder auch mehrere umfassen und je nach Größe des Imports längere Zeit in Anspruch nehmen. | + | '''> Zurück zur Hauptseite [[DiPlan Cockpit Basis für Mandanten-Administratoren (M-A)]]''' |
− | Die maximale Anzahl der | + | |
+ | Diese Funktion ermöglicht einen Import von Verfahren im XML-Format und nach dem XöV Standard XPlanverfahren. Der Import kann ein einzelnes Verfahren oder auch mehrere umfassen und je nach Größe des Imports längere Zeit in Anspruch nehmen. Während dieser Zeit arbeitet das System unter Volllast und ist unter Umständen eingeschränkt verfügbar. Aus technischen Gründen ist die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert. Das Importdokument wird XöV schemavalidiert. | ||
+ | |||
+ | Im Fehlerfall wird der Prozess abgebrochen und das gesamte Importdokument abgewiesen. | ||
+ | Es wird empfohlen einen Import nur in Randzeiten anzustoßen. | ||
+ | |||
+ | Die maximale Anzahl der simultan importierbaren Verfahren wird über den Wert des Systemparameters XPLANVERFAHREN_IMPORT_VERFAHRENSANZAHL gesteuert. Es wird empfohlen den Defaultwert nicht zu überschreiten, um die Systemstabilität nicht zu gefährden (Default: 500 Verfahren). | ||
+ | |||
+ | === Verfahren importieren === | ||
+ | Um ein oder mehrere Planverfahren zu importieren benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. In einem Importdokument können mehrere Verfahren definiert sein. Laden Sie das XML über die entsprechende Schaltfläche hoch, um den Importprozess starten. | ||
+ | [[Datei:Verfahrenimportieren2.jpg|alternativtext=Eingabefeld zum Import von Planverfahren|rechts|rahmenlos|564x564px|Eingabefeld zum Import von Planverfahren]] | ||
+ | |||
+ | * Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen. | ||
+ | * Nach Bestätigung wird der Dateiname zur Bestätigung angezeigt. | ||
+ | * Starten Sie den Importprozess durch Klick auf ''Hochladen'' | ||
+ | |||
+ | ==== Prüfung der Eingabedaten ==== | ||
+ | [[Datei:Import Unerwarteter Fehler.png|alternativtext=Abbruch des Imports|rechts|rahmenlos|Abbruch des Imports]] | ||
+ | Der Importprozess startet mit einer Überprüfung der Eingabedaten. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in der Anwendung hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft. | ||
+ | |||
+ | Der Import bricht im Fehlerfall umgehend mit einer Fehlermeldung ab. Die Fehlermeldung beschreibt die Ursache des Abbruchs. Da die Herangehensweise zur Fehlerbehebung situationsabhängig und uneindeutig ist, verzichtet die Anwendung auf konkrete Handlungsanweisungen. Um Wartezeiten zu minimieren werden Fehlermeldungen jeweils einzeln ausgegeben und nicht gesammelt. | ||
+ | Im Fehlerfall bricht die Anwendung den Import direkt und vollständig ab, sodass keine Inhalte - auch keine Teilmengen - übernommen werden. | ||
+ | |||
+ | ===== Definition XPlanverfahren ===== | ||
+ | XPlanverfahren ist im XRepository unter folgender URL veröffentlicht: https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren. Hier finden Sie ebenso eine XSD zur XML-Schemavalidierung wie auch die Spezifikation mit allen Inhalten als PDF Datei. Bitte beachten Sie, dass XPlanverfahren einer Versionierung unterliegt und sich Inhalte zwischen Versionen semantisch und syntaktisch ändern bzw. neue Inhalte hinzugefügt oder auch alte Inhalte entfernt werden können. | ||
+ | |||
+ | In XPlanverfahren werden obligatorische und optionale Inhalte gelistet. Nur eine kleine Teilmenge der XPlanverfahren-Inhalte sind obligatorisch. Bitte achten Sie jeweils auf die Angabe zur Kardinalität. | ||
+ | |||
+ | ==== Besonderheiten zum Import ==== | ||
+ | Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im XRepository veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise. | ||
+ | |||
+ | ===== <xplanverfahren:geobezug> ===== | ||
+ | In Abhängigkeit des Verfahrensstandes mag Ihnen bereits ein XPlanGML vorliegen oder auch noch nicht. Evtl. liegt Ihnen auch ein XPlanGML vor, welches unmittelbar als Dienst im Internet veröffentlicht werden soll. Ein Import ins DiPlanCockpit setzt lediglich das Vorhandensein eines Geobezugs voraus. Unterhalb dieses Elements können Sie entweder als Geobezug ein <xplanverfahren:xPlan> oder ein <xplanverfahren:flaechenabgrenzung> definieren. Als Fächenabgrenzung genügt eine BoundingBox oder auch der Geltungsbereich als Polygon. | ||
+ | |||
+ | Möchten Sie ein XPlanGML in das DiPlanCockpit importieren, so können Sie unter <xplanverfahren:xPlan> eine '''xPlanURL''' definieren. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein. | ||
+ | Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen. | ||
+ | |||
+ | Es können Netzwerkressourcen verwendet werden. Der Dateiname wird hinter dem "/" der URL erwartet. | ||
+ | Durch das Setzen eines optionalen '''veroeffentlichungsdatum''' können Sie zusätzlich zum Import ins DiPlanCockpit das XPlanGML als Dienst im Internet veröffentlichen. Ist ein Datumswert gesetzt, so wird das XPlanGML zunächst über Standardoptionen validiert und ggf. im Anschluss direkt im Internet veröffentlicht. | ||
+ | Die Validierung umfasst alle Standardprüfungen, wie bspw. der Plannamenabgleich. | ||
+ | |||
+ | ===== <xplanverfahren:infoDokumente> ===== | ||
+ | Mit diesem Datentyp können beliebig viele Verfahrensdokumente ins DiPlanCockpit übernommen werden. Diese werden Ihnen im Planverfahren in der Dokumentenansicht mit allen Optionen angeboten und können sie veröffentlichen, teilen und bearbeiten. Unter '''link''' erfolgt der Verweis auf die zu importierende Datei. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein. | ||
+ | Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen. | ||
+ | |||
+ | Es können Netzwerkressourcen verwendet werden. Der Dateiname wird hinter dem "/" der URL erwartet. | ||
+ | Die Angaben zur '''dokumentart''' und zum '''status''' sind obligatorisch und verweisen jeweils zwingend auf Einträge aus der Codeliste xplanverfahren:Code.Verfahrensunterlagetyp bzw. xplanverfahren:Code.Dokumentstatus. |
Aktuelle Version vom 20. November 2024, 17:18 Uhr
> Zurück zur Hauptseite DiPlan Cockpit Basis für Mandanten-Administratoren (M-A)
Diese Funktion ermöglicht einen Import von Verfahren im XML-Format und nach dem XöV Standard XPlanverfahren. Der Import kann ein einzelnes Verfahren oder auch mehrere umfassen und je nach Größe des Imports längere Zeit in Anspruch nehmen. Während dieser Zeit arbeitet das System unter Volllast und ist unter Umständen eingeschränkt verfügbar. Aus technischen Gründen ist die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert. Das Importdokument wird XöV schemavalidiert.
Im Fehlerfall wird der Prozess abgebrochen und das gesamte Importdokument abgewiesen.
Es wird empfohlen einen Import nur in Randzeiten anzustoßen.
Die maximale Anzahl der simultan importierbaren Verfahren wird über den Wert des Systemparameters XPLANVERFAHREN_IMPORT_VERFAHRENSANZAHL gesteuert. Es wird empfohlen den Defaultwert nicht zu überschreiten, um die Systemstabilität nicht zu gefährden (Default: 500 Verfahren).
Verfahren importieren[Bearbeiten | Quelltext bearbeiten]
Um ein oder mehrere Planverfahren zu importieren benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. In einem Importdokument können mehrere Verfahren definiert sein. Laden Sie das XML über die entsprechende Schaltfläche hoch, um den Importprozess starten.
- Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.
- Nach Bestätigung wird der Dateiname zur Bestätigung angezeigt.
- Starten Sie den Importprozess durch Klick auf Hochladen
Prüfung der Eingabedaten[Bearbeiten | Quelltext bearbeiten]
Der Importprozess startet mit einer Überprüfung der Eingabedaten. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in der Anwendung hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.
Der Import bricht im Fehlerfall umgehend mit einer Fehlermeldung ab. Die Fehlermeldung beschreibt die Ursache des Abbruchs. Da die Herangehensweise zur Fehlerbehebung situationsabhängig und uneindeutig ist, verzichtet die Anwendung auf konkrete Handlungsanweisungen. Um Wartezeiten zu minimieren werden Fehlermeldungen jeweils einzeln ausgegeben und nicht gesammelt.
Im Fehlerfall bricht die Anwendung den Import direkt und vollständig ab, sodass keine Inhalte - auch keine Teilmengen - übernommen werden.
Definition XPlanverfahren[Bearbeiten | Quelltext bearbeiten]
XPlanverfahren ist im XRepository unter folgender URL veröffentlicht: https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren. Hier finden Sie ebenso eine XSD zur XML-Schemavalidierung wie auch die Spezifikation mit allen Inhalten als PDF Datei. Bitte beachten Sie, dass XPlanverfahren einer Versionierung unterliegt und sich Inhalte zwischen Versionen semantisch und syntaktisch ändern bzw. neue Inhalte hinzugefügt oder auch alte Inhalte entfernt werden können.
In XPlanverfahren werden obligatorische und optionale Inhalte gelistet. Nur eine kleine Teilmenge der XPlanverfahren-Inhalte sind obligatorisch. Bitte achten Sie jeweils auf die Angabe zur Kardinalität.
Besonderheiten zum Import[Bearbeiten | Quelltext bearbeiten]
Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im XRepository veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise.
<xplanverfahren:geobezug>[Bearbeiten | Quelltext bearbeiten]
In Abhängigkeit des Verfahrensstandes mag Ihnen bereits ein XPlanGML vorliegen oder auch noch nicht. Evtl. liegt Ihnen auch ein XPlanGML vor, welches unmittelbar als Dienst im Internet veröffentlicht werden soll. Ein Import ins DiPlanCockpit setzt lediglich das Vorhandensein eines Geobezugs voraus. Unterhalb dieses Elements können Sie entweder als Geobezug ein <xplanverfahren:xPlan> oder ein <xplanverfahren:flaechenabgrenzung> definieren. Als Fächenabgrenzung genügt eine BoundingBox oder auch der Geltungsbereich als Polygon.
Möchten Sie ein XPlanGML in das DiPlanCockpit importieren, so können Sie unter <xplanverfahren:xPlan> eine xPlanURL definieren. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein.
Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen.
Es können Netzwerkressourcen verwendet werden. Der Dateiname wird hinter dem "/" der URL erwartet.
Durch das Setzen eines optionalen veroeffentlichungsdatum können Sie zusätzlich zum Import ins DiPlanCockpit das XPlanGML als Dienst im Internet veröffentlichen. Ist ein Datumswert gesetzt, so wird das XPlanGML zunächst über Standardoptionen validiert und ggf. im Anschluss direkt im Internet veröffentlicht.
Die Validierung umfasst alle Standardprüfungen, wie bspw. der Plannamenabgleich.
<xplanverfahren:infoDokumente>[Bearbeiten | Quelltext bearbeiten]
Mit diesem Datentyp können beliebig viele Verfahrensdokumente ins DiPlanCockpit übernommen werden. Diese werden Ihnen im Planverfahren in der Dokumentenansicht mit allen Optionen angeboten und können sie veröffentlichen, teilen und bearbeiten. Unter link erfolgt der Verweis auf die zu importierende Datei. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein.
Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen.
Es können Netzwerkressourcen verwendet werden. Der Dateiname wird hinter dem "/" der URL erwartet.
Die Angaben zur dokumentart und zum status sind obligatorisch und verweisen jeweils zwingend auf Einträge aus der Codeliste xplanverfahren:Code.Verfahrensunterlagetyp bzw. xplanverfahren:Code.Dokumentstatus.