Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.
Info

Dieses Dokument beschreibt das Dateiformat "PicXML 3.0". PicXML 3.0 ist ein XML-basiertes Format, das dem Export von Informationsobjekten aus der PICTURE-Prozessplattform zwecks Nachnutzung in Drittsystemen dient (z.B. Zuständigkeitsfinder, Auskunftssysteme) dient.

Das vorliegende Dokument richtet sich an Entwickler solcher Drittsysteme, die die bereitgestellten Daten (als Ganzes oder auszugsweise) in ihren eigenen Anwendungen weiterverwenden möchten.

Inhalt

Das

...

fachliche Domänenmodell der PICTURE-Prozessplattform und dessen Abbildung in PicXML

Um die in PicXML-Dokumenten bereitgestellten Informationen erfolgreich weiterverarbeiten zu können, ist ein Grundverständnis des fachlichen Domänenmodells der PICTURE-Prozessplattform hilfreich. Daher vermittelt dieser Abschnitt zunächst einen Überblick über die zentralen Konzepte des Datenmodells und deren Zusammenhänge. 

Das zentrale Informationsobjekt der PICTURE-Prozessplattform ist ein (Geschäfts-)Prozess. Ein Prozess kann in Form eines Steckbriefs sowie (optional) eines Detailmodells beschrieben werden:

  • Bei einem Steckbrief handelt es sich um eine stichwortartige textuelle Beschreibung des Prozesses. Die Beschreibung verschiedener Prozesse lässt sich dabei anhand von Attributen einheitlich strukturieren. 
  • Ein Detailmodell beschreibt mittels einer grafischen Darstellung (Diagramm) den zeitlich-sachlogischen Ablauf eines Prozesses. Je nach verwendeter Notation (PICTURE-Classic, PICTURE-BPMN) stehen verschiedene Modellelemente zur Beschreibung des Prozessablaufs und , der beteiligten Akteure zur Verfügung. Zu den verwendeten Modellelementen können und der genutzten Ressourcen zur Verfügung. Gemeinsam ist beiden Notationen die Verwendung von typisierten Prozessbausteinen als "kleinste Einheit" zur Beschreibung der Tätigkeiten innerhalb des Prozessablaufs. Zu den verwendeten Modellelementen (z.B. Prozessbausteine) können über Attribute (analog zum Prozess-Steckbrief) auf strukturierte Art und Weise Detail-Informationen hinterlegt werden. 
  • TODO Strukturmodelle zur Beschreibung des organisatorischen und technischen Prozessumfeldes
  • TODO Konfigurierbarkeit der Attribute
  • TODO Datentypsystem (textuelle Attribute, Zahlen, Verweise auf andere Modelle innerhalb der PPP, Hyperlinks auf externe Systeme, Dateianhänge)
  • TODO Unterstützte Aspekte in PicXML 3: Steckbriefe für Prozesse und Strukturmodelle

Grundsätzlicher Aufbau eines PicXML-FactSheet-Dokuments 

 

Neben den Prozessen einer Organisation kann in der PICTURE-Prozessplattform das organisatorische und technische Umfeld beschrieben werden, in welches die Prozesse eingebettet sind. Die Modellierung dieses Umfeldes erfolgt mittels Strukturmodellen. Ein Strukturmodell besteht aus einer hierarchisch strukturierten Menge von Strukturmodell-Elementen eines Typs. Mögliche Typen sind z.B. Organisartionseinheiten (inkl. Stellen), Dokumente und IT-Verfahren. Jedes Strukturmodell-Element kann mittels eines Steckbriefs (s. oben) ausführlich beschrieben werden. 

Das Metamodell, welches der Modellierung von Prozessen und Strukturmodellen in der PICTURE-Prozessplattform zu Grunde liegt, ist in einem gewissen Rahmen konfigurierbar ("PICTURE-Methodenkonfiguration"). So kann zur Laufzeit festgelegt werden, welche Attribute in den einzelnen Modell-Typen (z.B. Prozess-Steckbrief) bzw. Modell-Elementen (z.B. Prozessbausteine, Strukturmodell-Elemente) ausgefüllt werden können. Für die Definition von Attributen stehen verschiedene Datentypen zur Verfügung, die eine passgenaue Abbildung der zu erhebenden Informationen erlauben. Die unterstützten Datentypen reichen von einfachen textuellen und numerischen Attributen über Einfach- und Mehrfachauswahl aus vordefinierten Listen bis hin zu Verweisen auf andere Modelle/Modellelemente (Prozesse, Strukturmodell-Elemente) innerhalb der PICTURE-Prozessplattform sowie Dateianhänge und Verweise auf externe Informationen in Drittsystemen über Hyperlinks. 

PicXML 3.0 unterstützt derzeit den Export von Steckbriefen zu Prozessen und Strukturmodell-Elementen. Falls Sie andere Informationsobjekte aus der PICTURE-Prozessplattform (z.B. Detailmodelle oder Strukturmodell-Hierarchien) zur Weiterverarbeitung in Drittsystemen benötigen, verwenden Sie hierzu das PicJSON-Format. 

Ein PicXML-3.0-Steckbrief-Dokument umfasst immer den Steckbrief von genau einem Informationsobjekt (z.B. Prozess, Strukturmodell-Element). Der genaue Aufbau eines solchen Dokuments ist in den folgenden Abschnitten erläutert.

Grundsätzlicher Aufbau eines PicXML-Steckbrief-Dokuments 

Ein Steckbrief-Dokument besteht prinzipiell aus einem Metadaten-Abschnitt zur Beschreibung des Dokuments (z.B. verwendete XML-Schema-Version, Name und Herkunft des exportierten Informationsobjekts, verfügbare Notationen) sowie aus einem Abschnitt über die in der Prozessplattform hinterlegten ausgefüllten Attribute des Informationsobjekts. Der Abschnitt mit den Attributen ist nach thematisch zusammenhängenden Attributgruppen gegliedert. 

Im Folgenden finden Sie zunächst ein konkretes Beispiel für die Grobstruktur eines PicXML-Steckbrief-Dokuments sowie eine ausführliche Erklärung aller darin verwendeten XML-Tags und deren Attribute.

Codeblock
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<factSheet name="Testprozess ausführen">
    <metaData>
        <createdOn>2015-08-18T15:14:23.445+02:00</createdOn>
        <sourceInstallation>http://www.prozessplattform.de/musterhausen</sourceInstallation>
        <xmlSchemaVersion>http://www.prozessplattform.de/sml/schemas/picxml/v3/factSheet</xmlSchemaVersion>
    </metaData>
    <notation>PROCESS_FACT_SHEET</notation>
    <attributeGroups>
        <group>
            <label>Attribute</label>
            <attributeValues>
                <attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="name" dataType="text">
                    <value>Testprozess ausführen</value>
                </attribute>
                <attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="listValue" attributeID="picture.std.attribute#Schlagworte+01" dataType="tags">
                    <items>
                        <item>beispiel</item>
                        <item>datentypen</item>
                        <item>demo</item>
                        <item>test</item>
                    </items>
                </attribute>
				<!-- weitere Attribute... -->
        </items>group>
		<group>
			<!-- Attribute der Gruppe... -->
		</group>
		<!-- weitere Attribut-Gruppen... -->
     </attribute>attributeGroups>
				<!-- weitere Attribute... -->
        </group>
		<group>
			<!-- Attribute der Gruppe... -->
		</group>
		<!-- weitere Attribut-Gruppen... -->
    </attributeGroups>
</factSheet>

...

Format: Jahr - Monat - Tag Stunde - Minute - Sekunde - Millisekunde - Zeitzone (Angegeben in Abweichung zur GMT)

Beispiel: 2015-08-18T15:14:23.445+02:00

...

Nur relevant für Steckbriefe zum Informationsobjekt "Prozess". Zu einem Prozess existiert immer mindestens ein Steckbrief. Optional ist ein Detailmodell verfügbar. Das Detailmodell ist entweder in der Notation "PICTURE-Classic" oder "PICTURE-BPMN" modelliert.

Derzeit unterstützt das im Format PicXML 3.0 ausschließlich die Repräsentation von Steckbriefen. Zur Repräsentation von Detailmodellen kann das Format PicJSON genutzt werden.

Einziger möglicher Werte daher derzeit:

PROCESS_FACT_SHEET

...

</factSheet>
XML-TagXML-AttributBeschreibungKommentar
factSheet Inhalt des Steckbriefs für ein Informationsobjekt aus der PICTURE-Prozessplattform (z.B. Prozess, Strukturmodell-Element etc.) 
factSheet -> metaData Metadaten des Steckbriefs 
factSheet -> metaData -> createdOn Zeitpunkt, zu welchem der vorliegende Steckbrief exportiert wurde

Format: Jahr - Monat - Tag Stunde - Minute - Sekunde - Millisekunde - Zeitzone (Angegeben in Abweichung zur GMT)

Beispiel: 2015-08-18T15:14:23.445+02:00

factSheet -> metaData -> sourceInstallation URL des PICTURE-Prozessplattform-Mandanten, aus welchem der Steckbrief exportiert wurde 
factSheet -> metaData -> xmlSchemaVersion URL zur Identifizierung des XML-Schemas, auf welchem die Repräsentation des vorliegenden Steckbriefs basiert 
factSheet -> notation Notation, in welcher der durch den Steckbrief repräsentierte Prozess in der PICTURE-Prozessplattform vorliegt

Nur relevant für Steckbriefe zum Informationsobjekt "Prozess". Zu einem Prozess existiert immer mindestens ein Steckbrief. Optional ist ein Detailmodell verfügbar. Das Detailmodell ist entweder in der Notation "PICTURE-Classic" oder "PICTURE-BPMN" modelliert.

Derzeit unterstützt das im Format PicXML 3.0 ausschließlich die Repräsentation von Steckbriefen. Zur Repräsentation von Detailmodellen kann das Format PicJSON genutzt werden.

Einziger möglicher Werte daher derzeit:

PROCESS_FACT_SHEET

factSheet -> attributeGroups Container-Objekt für die einzelnen Attributgruppen 
factSheet -> attributeGroups -> group Bündelung von thematisch zusammengehörenden Attributen des Steckbriefs 
factSheet -> attributeGroups -> group -> label Bezeichnung der Attributgruppe 
factSheet -> attributeGroups -> group -> attributeValues Container-Objekt für alle zur Gruppe gehörenden und im vorliegenden Steckbrief ausgefüllten Attribute

In der Konfiguration der PICTURE-Methode wird festgelegt, welche Attribute zu einem Informationsobjekt (z.B. Prozess, Strukturmodell-Element "Dokument" etc.) prinzipiell erfasst werden können (Metamodell-Ebene). Diese Attribute können in Form von Gruppen strukturiert werden.

Die PicXML-3-Repräsentation eines konkreten Steckbriefs (Modell-Ebene) beinhaltet ausschließlich ausgefüllte Attribute und somit auch nur diejenigen Attribute-Gruppen, welche mindestens ein ausgefülltes Attribut beinhalten.

factSheet -> attributeGroups -> group -> label Bezeichnung der Attributgruppe 
factSheet -> attributeGroups -> group -> attributeValues Container-Objekt für alle zur Gruppe gehörenden und im vorliegenden Steckbrief ausgefüllten Attribute

In der Konfiguration der PICTURE-Methode wird festgelegt, welche Attribute zu einem Informationsobjekt (z.B. Prozess, Strukturmodell-Element "Dokument" etc.) prinzipiell erfasst werden können (Metamodell-Ebene). Diese Attribute können in Form von Gruppen strukturiert werden.

Die PicXML-3-Repräsentation eines konkreten Steckbriefs (Modell-Ebene) beinhaltet ausschließlich ausgefüllte Attribute und somit auch nur diejenigen Attribute-Gruppen, welche mindestens ein ausgefülltes Attribut beinhalten.

factSheet -> attributeGroups -> group -> attributeValues -> attribute Repräsentiert die konkrete Ausprägung eines ausgefüllten Attributs aus dem SteckbriefEine vollständige Darstellung der Repräsentation der Ausprägungen für die einzelnen unterstützen Datentypen vgl. den folgenden Abschnitt "Repräsentation der Attributausprägungen für die verschiedenen unterstützten Datentypen"attributeValues -> attribute Repräsentiert die konkrete Ausprägung eines ausgefüllten Attributs aus dem SteckbriefEine vollständige Darstellung der Repräsentation der Ausprägungen für die einzelnen unterstützen Datentypen vgl. den folgenden Abschnitt "Repräsentation der Attributausprägungen für die verschiedenen unterstützten Datentypen".
factSheet -> attributeGroups -> group -> attributeValues -> attributeattributeIDUUID des Attributs. Identifiziert das Attribut eindeutig innerhalb der Menge aller Attribute, die im Steckbrief ausgefüllt werden können.

Die UUID des Attributs wird in der Konfiguration der PICTURE-Methode festgelegt, auf welcher der Prozessplattform-Arbeitsbereich basiert, aus dem der Steckbrief exportiert wurde. Die UUIDs sind durch Anwender der Prozessplattform nicht änderbar (für Attribute aus der PICTURE-Standardkonfiguration werden die Werte seitens der PICTURE GmbH vorgegeben, bei benutzerdefinierten Attributen werden sie systemseitig automatisch generiert.

Tipp
Eine Übersicht der UUIDs aller in der Konfiguration eines Arbeitsbereichs verwendeten Attribute kann über den Bericht Konfiguration des Arbeitsbereichs erstellt werden.
factSheet -> attributeGroups -> group -> attributeValues -> attributeattributeIDUUID des Attributs. Identifiziert das Attribut eindeutig innerhalb der Menge aller Attribute, die im Steckbrief ausgefüllt werden können.

Die UUID des Attributs wird in der Konfiguration der PICTURE-Methode festgelegt, auf welcher der Prozessplattform-Arbeitsbereich basiert, aus dem der Steckbrief exportiert wurde. Die UUIDs sind durch Anwender der Prozessplattform nicht änderbar (für Attribute aus der PICTURE-Standardkonfiguration werden die Werte seitens der PICTURE GmbH vorgegeben, bei benutzerdefinierten Attributen werden sie systemseitig automatisch generiert.

Tipp
Eine Übersicht der UUIDs aller in der Konfiguration eines Arbeitsbereichs verwendeten Attribute kann über den Bericht Konfiguration des Arbeitsbereichs erstellt werden.
factSheet -> attributeGroups -> group -> attributeValues -> attributedataTypeDatentyp des Attributs

Mögliche (für Weiterverwendung in Dritt-Systemen relevante) Werte:

text, richtext, number, selection, multiselection, references, distribution, links, fileLinks, tags

In Abhängigkeit vom Datentyp des Attributs unterscheidet sich die Inhalte des XML-Tags "attribute". Ausführliche Informationen zu den Repräsentationen der verschiedenen Datentypen finden Sie im folgenden Abschnitt "Repräsentation der Attributausprägungen für die verschiedenen unterstützten Datentypen".

 

...

dataTypeDatentyp des Attributs

Mögliche (für Weiterverwendung in Dritt-Systemen relevante) Werte:

text, richtext, number, selection, multiselection, references, distribution, links, fileLinks, tags

In Abhängigkeit vom Datentyp des Attributs unterscheidet sich die Inhalte des XML-Tags "attribute". Ausführliche Informationen zu den Repräsentationen der verschiedenen Datentypen finden Sie im folgenden Abschnitt "Repräsentation der Attributausprägungen für die verschiedenen unterstützten Datentypen".

 

Repräsentation der Attributausprägungen für die verschiedenen unterstützten Datentypen 

Der Aufbau der XML-Tags zur Repräsentation der konkreten Ausprägungen der ausgefüllten Attribute unterscheidet sich jeweils nach dem Datentyp des ausgeprägten Attributs sowie dem Grad der Ausfüllung der teilweise optionalen Angaben. Für jeden in der PICTURE-Methodenkonfiguration unterstützen Datentyp ist im Folgenden jeweils ein konkretes und vollständiges XML-Beispiel angegeben, das von allen prinzipiell verfügbaren Abbildungsmöglichkeiten Gebraucht macht. Zu jedem Beispiel sind anschließend die verwendeten XML-Tags sowie deren Attribute erläutert.

Kurztext, Text

Codeblock
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="7138ff24-19d6-4803-96af-c75e737ead9b" dataType="text">
	<value>kurzer Text ohne Formatierung</value>
</attribute>

...