PicXML 3

TODO

Das Metamodell - konfigurierbare Steckbriefe für Prozesse und Strukturmodelle

TODO

Grundsätzlicher Aufbau eines PicXML-FactSheet-Dokuments

<?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="textValue" attributeID="description" dataType="richtext">
                    <value>&lt;![CDATA[L&amp;auml;ngere Beschreibung des Prozesses. Diese kann&lt;ul&gt;&lt;li&gt;&lt;u&gt;recht lang&lt;/u&gt;&lt;/li&gt;&lt;li&gt;und &lt;strong&gt;formatiert&lt;/strong&gt;&lt;/li&gt;&lt;/ul&gt;sein.]]&gt;</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... -->
        </group>
		<group>
			<!-- Attribute der Gruppe... -->
		</group>
		<!-- weitere Attribut-Gruppen... -->
    </attributeGroups>
</factSheet>

XML-Tag	XML-Attribut	Beschreibung	Kommentar
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 -> attributeValues -> attribute		Repräsentiert die konkrete Ausprägung eines ausgefüllten Attributs aus dem Steckbrief	Eine 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 -> attribute	attributeID	UUID 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. 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 -> attribute	dataType	Datentyp 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

Kurztext, Text

<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>

XML-Tag

Beschreibung

Kommentar

attribute -> value

Attributausprägung als einfacher String

Der Text kann Zeilenumbrüche enthalten. Als Zeilentrenner wird hierbei gemäß Unix-Konvention das Steuerzeichen "\n" (newline) verwendet.

Da die PicXML-3-Dokumente grundsätzlich mit UTF-8-Encoding erzeugt werden, sind Sonderzeichen wie deutsche Umlaute etc. ohne weitere Maskierung im Text enthalten.

Zeichen, die in XML-Dokumenten eine besondere Bedeutung haben ("<", ">", "&") sind in Entity-Codierung ("<", ">", "&") repräsentiert.

Formatierter Text

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="72c0f49c-3e99-4329-b9b0-97a10b010188" dataType="richtext">
	<value>&lt;![CDATA[Formatierter Text ohne L&amp;auml;ngenbegrenzung. Zur Formatierung kann eine sehr einfach Teilmenge von HTML genutzt werden.&lt;br /&gt;&lt;br /&gt;Schrift-Schnitt:&lt;ul&gt;&lt;li&gt;&lt;strong&gt;Fett&lt;/strong&gt;&lt;/li&gt;&lt;li&gt;&lt;em&gt;kursiv&lt;/em&gt;&lt;/li&gt;&lt;li&gt;&lt;u&gt;unterstrichen&lt;/u&gt;&lt;/li&gt;&lt;/ul&gt;&lt;br /&gt;Aufz&amp;auml;hlungen:&lt;ul&gt;&lt;li&gt;Mit eindem oder mehreren&lt;/li&gt;&lt;li&gt;Stichpunkten&lt;/li&gt;&lt;/ul&gt;&amp;nbsp;&lt;ol&gt;&lt;li&gt;oder nummeriert&lt;/li&gt;&lt;li&gt;also mit Zahlen ;-)&lt;/li&gt;&lt;/ol&gt;&amp;nbsp;&lt;ul&gt;&lt;li&gt;Aufz&amp;auml;hlungen k&amp;ouml;nnen&lt;ul&gt;&lt;li&gt;auch&lt;ul&gt;&lt;li&gt;einger&amp;uuml;ckt&lt;/li&gt;&lt;/ul&gt;&lt;/li&gt;&lt;li&gt;sein.&lt;/li&gt;&lt;/ul&gt;&lt;/li&gt;&lt;/ul&gt;&amp;nbsp;&lt;ol&gt;&lt;li&gt;Das geht auch&lt;ol&gt;&lt;li&gt;mit nummerierten&lt;ol&gt;&lt;li&gt;Aufz&amp;auml;hlungen.&lt;/li&gt;&lt;li&gt;Logisch,&amp;nbsp;oder?&lt;/li&gt;&lt;/ol&gt;&lt;/li&gt;&lt;/ol&gt;&lt;/li&gt;&lt;li&gt;&amp;nbsp;Ja, ist klar... ;-)&amp;nbsp;&lt;/li&gt;&lt;/ol&gt;&lt;br /&gt;&amp;nbsp;]]&gt;</value>
</attribute>

XML-Tag

Beschreibung

Kommentar

attribute -> value

Attributausprägung in Form eines HTML-formatierten Texts.

Zur Formatierung des Texts wird in der PICTURE-Prozessplattform folgende Teilmenge von HTML unterstützt:

Zeilenumbrüche ( )
fetter Text ()
kursiver Text ()
unterstrichener Text ()
unsortierte Aufzählungen (<ul><li></li></ul)
sortierte Aufzählungen (<ol><li></li></ol).

Die in der Prozessplattform hinterlegte Attribut-Ausprägung wird in Form eines CDATA-Blocks im PicXML-Dokument ausgegeben. Innerhalb des CDATA-Blocks sind öffnende und schließende Klammern der HTML-Tags ("<", ">") in Form von HTML-Entities dargestellt ("<" bzw. ">"). Das "Kaufmanns-Und" ("&") im HTML-Text ist ebenfalls in HTML-Entity-Darstellung codiert ("&").

Um den Inhalt des CDATA-Blocks in "darstellungsfertiges" HTML umzuwandeln sind folgende Ersetzungen durchzuführen:

"< durch "<" ersetzen
"> durch ">" ersetzen
"& durch "&" ersetzen.

Ganzzahl, Kommazahl

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="numericValue" attributeID="c7bcb479-cade-4dcb-a186-b16cf5264780" dataType="number">
	<number>100.0</number>
</attribute>

XML-Tag

Beschreibung

Kommentar

attribute -> value

Attributausprägung in Form einer Dezimalzahl.

Als Dezimaltrennzeichen wird der Punkt (".") verwendet, ein Tausendertrennzeichen kommt nicht zum Einsatz. Positive Zahlen (inkl. 0) werden ohne Vorzeichen abgebildet, bei negativen Zahlen ist das Minus ("-") ohne Leerzeichen den Ziffern vorangestellt.

Beispiele:

1123.45

-1123.45

Hinweise zur Unterscheidung von Ganzzahlen und Kommazahlen:

In früheren Versionen der PICTURE-Prozessplattform (bis einschließlich v2.16) waren in der Methodenkonfiguration separate Datentypen für Ganzzahlen und Dezimalzahlen vorgesehen. Diese Unterscheidung entfällt ab Version 2.17. Künftig wird nur noch der Datentyp "Dezimalzahl" unterstützt. Sämtliche bestehenden Attribute mit dem (Legacy-) Datentyp "Ganzzahl" werden in der Prozessplattform wie ein Attribut vom Datentyp "Dezimalzahl" behandelt.

Prozentualer Wert

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="numericValue" attributeID="e5467ea7-d817-4ede-8ee1-e4c19c36f8a7" dataType="number">
	<number>99.98</number>
	<unit>%</unit>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> value	Attributausprägung in Form einer Dezimalzahl	vgl. Angaben im Abschnitt "Ganzzahl, Kommazahl"
attribute -> unit	Einheit	Bei Attributen vom Datentyp "Prozentualer Wert" wird in diesem XML-Tag immer immer der Wert "%" benutzt.

Zeit

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="numericValue" attributeID="a0352294-6c10-4bc0-9c7d-c85c24189896" dataType="number">
	<number>3.0</number>
	<unit>Stunde(n)</unit>
</attribute>

XML-Tag

Beschreibung

Kommentar

attribute -> value

Attributausprägung in Form einer Dezimalzahl

vgl. Angaben im Abschnitt "Ganzzahl, Kommazahl". Negative Werte sind hier nicht zulässig.

attribute -> unit

Zeiteinheit

Mögliche Werte:

Sekunde(n)

Minute(n)

Stunde(n)

Tag(e)

Woche(n)

Monat(e)

Jahr(e)

Währung

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="numericValue" attributeID="ecb39883-da81-45e1-88b3-db364be5df42" dataType="number">
	<number>100.0</number>
	<unit>EUR</unit>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> value	Attributausprägung in Form einer Dezimalzahl	vgl. Angaben im Abschnitt "Ganzzahl, Kommazahl"
attribute -> unit	Währungseinheit (Kürzel)

Entscheidung (bool'scher Wert)

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="b3b79a60-910f-49fa-afc1-80aba1815a8a" dataType="selection">
	<value>Ja</value>
</attribute>

XML-Tag

Beschreibung

Kommentar

attribute -> value

Attribut in Form eines binären Wertes (ja/nein)

Mögliche Werte:

Ja
Nein

Einfach-Auswahl

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="5a292f8d-9edb-4696-b3d9-9bacc6555512" dataType="selection">
	<value>Option 1</value>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> value	Attributausprägung in Form des Namens der gewählten Auswahl-Option	Die möglichen Ausprägungen werden in der PICTURE-Methodenkonfiguration festgelegt und sind benutzerdefiniert zur Laufzeit anpassbar. Eine Übersicht der konfigurierten Auswahl-Optionen für das jeweilige Attribut kann dem Bericht Konfiguration des Arbeitsbereichs entnommen werden.

Mehrfach-Auswahl

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="listValue" attributeID="93e0bdd7-e5a4-401f-9d53-055acc2fa1f6" dataType="multiselection">
	<items>
		<item>Option A</item>
		<item>Option B</item>
	</items>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> items	Container-Objekt für alle ausgewählten Auswahl-Optionen
attribute -> items -> item	ausgewählte Option	Die möglichen Ausprägungen werden in der PICTURE-Methodenkonfiguration festgelegt und sind benutzerdefiniert zur Laufzeit anpassbar. Eine Übersicht der konfigurierten Auswahl-Optionen für das jeweilige Attribut kann dem Bericht Konfiguration des Arbeitsbereichs entnommen werden.

Referenz auf Strukturmodelle

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="referenceListValue" attributeID="29d314b8-7b39-4236-a8bd-3d267096b68f" dataType="references">
	<references>
		<reference>
			<label>Passierschein 38/11</label>
			<url>http://localhost:8081/primestack/rest/repository/workspace/3066c890-9e0b-48e9-b388-9cedd6f904c3/Document/4424d921-d8e7-4bbe-a100-cc8ce777362e/factSheet/representation/xml</url>
			<targetType>Document</targetType>
			<uuid>4424d921-d8e7-4bbe-a100-cc8ce777362e</uuid>
			<context>verpflichtendes Dokument</context>
			<percent>100.0</percent>
			<links>
				<link>
					<label>Scan</label>
					<url>http://localhost:8081/primestack/rest/repository/fileAttachment?file=587bd071b4ae233fb61b10df580a6692.jpg&amp;name=Scan</url>
				</link>
				<!-- ggf. weitere Links -->
			</links>
		</reference>
		<!-- ggf. weitere Referenzen -->
	</references>
</attribute>

XML-Tag	XML-Attribut	Beschreibung	Kommentar
attribute -> references
attribute -> references -> reference
attribute -> references -> reference -> label
attribute -> references -> reference -> url
attribute -> references -> reference -> targetType			Mögliche Werte: TODO
attribute -> references -> reference -> uuid
attribute -> references -> reference -> context			optional
attribute -> references -> reference -> percent			optional
attribute -> references -> reference -> links
attribute -> references -> reference -> links -> link
attribute -> references -> reference -> links -> link -> label
attribute -> references -> reference -> links -> link -> url

Hyperlinks

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="linkListValue" attributeID="6b900a56-9e22-4e14-9c3a-fafc9d06527c" dataType="links">
	<links>
		<link>
			<label>Heise online</label>
			<url>http://www.heise.de</url>
		</link>
		<link>
			<label>Westfälische Nachrichten online</label>
			<url>http://www.wn.de</url>
		</link>
	</links>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> links	Container-Objekt für alle erfassten Hyperlinks
attribute -> links -> link	Hyperlink
attribute -> links -> link -> url	Ziel-URL, auf welche der Hyperlink verweist	Entspricht sinngemäß dem Attribut "href" des HTML-Tags "<a>" zur Repräsentation eines Hyperlinks. Achtung: Das "Kaufmanns-Und" ("&"; wird in URLs zur Trennung mehrerer Query-Parameter genutzt) ist im URL-String per Entity-Encoding codiert ("&"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&" durch "&").
attribute -> links -> link -> label	Beschriftung des Hyperlinks	Entspricht sinngemäß dem Text im Body-Element des HTML-Tags "<a>" zur Repräsentation eines Hyperlinks (Bsp: <a href="http://www.heise.de">Heise online</a>).

Dateianhänge

<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="linkListValue" attributeID="4e2e9d66-a49e-4a47-a2c2-98b2ba222438" dataType="fileLinks">
	<links>
		<link>
			<fileName>b2eb795b1b3a3e0f9536c5ed28c8.pdf</fileName>
			<label>Formblatt 627</label>
			<url>https://www.prozessplattform.de/musterhausen/rest/repository/fileAttachment?file=4a6db2eb795b1b3a3e0f9536c5ed28c8.pdf&amp;name=Formblatt_627</url>
		</link>
		<link>
			<fileName>589600b43d71695137a5128115bf.jpg</fileName>
			<label>Formblatt 628</label>
			<url>https://www.prozessplattform.de/musterhausen/rest/repository/fileAttachment?file=9d30589600b43d71695137a5128115bf.pdf&amp;name=Formblatt_628</url>
		</link>
	</links>
</attribute>

XML-Tag	Beschreibung	Kommentar
attribute -> links	Container-Objekt für alle erfassten Hyperlinks
attribute -> links -> link
attribute -> links -> link -> url		Achtung: Das "Kaufmanns-Und" ("&"; wird in URLs zur Trennung mehrerer Query-Parameter genutzt) ist im URL-String per Entity-Encoding codiert ("&"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&" durch "&").
attribute -> links -> link -> label
attribute -> links -> link -> fileName

Schlagworte

<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>

XML-Tag	Beschreibung	Kommentar
attribute -> items	Container-Objekt für alle vergebenen Schlagwörter
attribute -> items -> item	Schlagwort	Schlagworte sind benutzerdefiniert beliebig zur Laufzeit vergebbar. Bei der Auslesen der Werte kann dieses Feld daher wie ein Freitext-Feld für unformatierten Text behandelt werden.