Info |
---|
TODO |
Inhalt |
---|
Das Metamodell - konfigurierbare Steckbriefe für Prozesse und Strukturmodelle
TODO
Grundsätzlicher Aufbau eines PicXML-FactSheet-Dokuments
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>
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). 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, der beteiligten Akteure 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.
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 Prozesskontexten. Ein Prozesskontext besteht aus einer hierarchisch strukturierten Menge von Prozesskontextelementen. Mögliche Typen sind z.B. Organisationseinheiten (inkl. Stellen), Dokumente und IT-Verfahren. Jedes Prozesskontext-Element kann mittels eines Steckbriefs (s. oben) ausführlich beschrieben werden.
Das Metamodell, welches der Modellierung von Prozessen und Prozesskontexten 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, Prozesskontext-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, Prozesskontext-Elemente) innerhalb der PICTURE-Prozessplattform sowie Dateianhänge und Verweise (Hyperlinks) auf externe Informationen in Drittsystemen.
PicXML 3.0 unterstützt derzeit den Export von Steckbriefen zu Prozessen und Prozesskontext-Elementen. Falls Sie andere Informationsobjekte aus der PICTURE-Prozessplattform (z.B. Detailmodelle oder Prozesskontext-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, Prozesskontext-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 uuid="d738292a-9c2d-4f60-9a6e-89747dbf340e" name="Testprozess ausführen"> <metaData> <createdOn>2015-08-18T15:14:23.445+02:00</createdOn> <attributeValues> <sourceInstallation>http://www.prozessplattform.de/musterhausen</sourceInstallation> <attribute xmlns:xsi="http<xmlSchemaVersion>http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="name" dataType="text">prozessplattform.de/sml/schemas/picxml/v3/factSheet</xmlSchemaVersion> </metaData> <notation>PROCESS_FACT_SHEET</notation> <attributeGroups> <group> <value>Testprozess ausführen</value> <label>Attribute</label> </attribute><attributeValues> <attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="descriptionname" dataType="richtexttext"> <value><![CDATA[L&auml;ngere Beschreibung des Prozesses. Diese kann<ul><li><u>recht lang</u></li><li>und <strong>formatiert</strong></li></ul>sein.]]>< <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> item> </items> </attribute> <!-- weitere Attribute... --> </group> <group> <!-- Attribute der Gruppe... --> </items> group> <!-- weitere Attribut-Gruppen... --> </attribute> <!-- 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
...
</attributeGroups>
</factSheet> |
XML-Tag | XML-Attribut | Beschreibung | Kommentar |
---|---|---|---|
factSheet | Inhalt des Steckbriefs für ein Informationsobjekt aus der PICTURE-Prozessplattform (z.B. Prozess, Prozesskontext-Element etc.) | ||
factSheet | uuid | UUID des zu durch diesen Steckbrief repräsentierten Informationsobjekts | Die PICTURE-Prozessplattform stellt sicher, dass dieser Wert eindeutig für jede Kombination aus Arbeitsbereich innerhalb der PPP und Informationsobjekt (z.B. Prozess, Dokument etc.) ist. |
factSheet | name | Name des Informationsobjekts, welches durch diesen Steckbrief repräsentiert wird | |
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, Prozesskontext-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.
| ||
factSheet -> attributeGroups -> group -> attributeValues -> attribute |
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. |
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
...
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
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.
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> |
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
Codeblock |
---|
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="72c0f49c-3e99-4329-b9b0-97a10b010188" dataType="richtext"> <value><![CDATA[Formatierter Text ohne L&auml;ngenbegrenzung. Zur Formatierung kann eine sehr einfach Teilmenge von HTML genutzt werden.<br /><br />Schrift-Schnitt:<ul><li><strong>Fett</strong></li><li><em>kursiv</em></li><li><u>unterstrichen</u></li></ul><br />Aufz&auml;hlungen:<ul><li>Mit eindem oder mehreren</li><li>Stichpunkten</li></ul>&nbsp;<ol><li>oder nummeriert</li><li>also mit Zahlen ;-)</li></ol>&nbsp;<ul><li>Aufz&auml;hlungen k&ouml;nnen<ul><li>auch<ul><li>einger&uuml;ckt</li></ul></li><li>sein.</li></ul></li></ul>&nbsp;<ol><li>Das geht auch<ol><li>mit nummerierten<ol><li>Aufz&auml;hlungen.</li><li>Logisch,&nbsp;oder?</li></ol></li></ol></li><li>&nbsp;Ja, ist klar... ;-)&nbsp;</li></ol><br />&nbsp;]]></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:
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:
|
...
...
Zahl
Codeblock |
---|
<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> |
...
number |
...
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
Hinweis |
---|
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. |
...
">
<number>100.0</number>
</attribute> |
XML-Tag | Beschreibung | Kommentar |
---|---|---|
attribute -> number | 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 |
Zahl mit Einheit
Codeblock |
---|
<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 -> number | Attributausprägung in Form einer Dezimalzahl | vgl. Angaben im Abschnitt " |
Zahl" | |
attribute -> unit | Einheit |
Die Einheit(n) sind im Metamodell frei konfigurierbar. Im oben zu sehenden Beispiel wurde als Einheit "%" gewählt. |
Zeit
Codeblock |
---|
<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 -> number | 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:
|
Währung
Codeblock |
---|
<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 -> number | Attributausprägung in Form einer Dezimalzahl | vgl. Angaben im Abschnitt "Ganzzahl, Kommazahl" |
attribute -> unit | Währungseinheit (Kürzel) |
Entscheidung (bool'scher Wert)
Einfach-Auswahl
Codeblock |
---|
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValue" attributeID="b3b79a605a292f8d-910f9edb-49fa4696-afc1b3d9-80aba1815a8a9bacc6555512" dataType="selection"> <value>Ja<<value>Option 1</value> </attribute>attribute> |
XML-Tag | Beschreibung | Kommentar |
---|---|---|
attribute -> value |
Mögliche Werte:
- Ja
- Nein
...
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.
|
Mehrfach-Auswahl
Codeblock |
---|
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="textValuelistValue" attributeID="5a292f8d93e0bdd7-9edbe5a4-4696401f-b3d99d53-9bacc6555512055acc2fa1f6" dataType="selectionmultiselection"> <items> <item>Option A</item> <value>Option 1</value> <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.
|
|
...
Referenzen auf andere Modelle oder Prozesskontext-Elemente
Codeblock |
---|
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="listValuereferenceListValue" attributeID="93e0bdd729d314b8-e5a47b39-401f4236-9d53a8bd-055acc2fa1f63d267096b68f" dataType="multiselectionreferences"> <items><references> <item>Option A</item> <reference> <item>Option<label>Passierschein B<38/11</item>label> </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.
|
Referenz auf Strukturmodelle
Codeblock |
---|
<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&name=Scan</url>
<fileName>587bd071b4ae233fb61b10df580a6692.jpg</fileName>
</link>
<!-- ggf. weitere Links -->
</links>
</reference>
<!-- ggf. weitere Referenzen -->
</references>
</attribute> |
...
<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&name=Scan</url>
<fileName>587bd071b4ae233fb61b10df580a6692.jpg</fileName>
</link>
<!-- ggf. weitere Links -->
</links>
</reference>
<!-- ggf. weitere Referenzen -->
</references>
</attribute> |
XML-Tag | Beschreibung | Kommentar |
---|---|---|
attribute -> references | Container-Objekt für alle zur Ausprägung des jeweiligen Attributs erfassten Referenzen | |
attribute -> references -> reference | Referenz auf ein Prozesskontext-Element / ein Modell | |
attribute -> references -> reference -> label | Bezeichnung des referenzierten Elements | Kann bei der Weiterverarbeitung zur "menschenlesbaren" Visualisierung der Referenz genutzt werden. Soll einfach nur aufgelistet werden, auf welche Elemente im jeweiligen Atribut verwiesen wird, reicht es aus, dieses Tag auszuwerten. Alle anderen Tags der Referenz können in diesem Fall ignoriert werden. |
attribute -> references -> reference -> url | URL, unter welcher in der PICTURE-Prozessplattform der Steckbrief des referenzierten Elements (Dateiformat: PicXML 3.0) abgerufen werden kann | Diese Information kann bei der Weiterverarbeitung genutzt werden, um ggf. in der Prozessplattform erfasste weitergehende Informationen zum referenzierten Prozesskontext-Element abzurufen. Soll nur dessen volle Bezeichnung genutzt werden, ist ein Abruf des unter der URL erreichbaren Dokuments nicht nötig (s. label). Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen). |
attribute -> references -> reference -> targetType | Typ des referenzierten Elements | Mögliche Werte:
|
attribute -> references -> reference -> |
uuid |
UUID des referenzierten |
Elements (identifiziert ein Prozesskontext-Element bzw. einen Prozess eindeutig innerhalb eines Arbeitsbereichs der PICTURE-Prozessplattform) | |
attribute -> references -> reference -> |
Diese Information kann bei der Weiterverarbeitung genutzt werden, um ggf. in der Prozessplattform erfasste weitergehende Informationen zum referenzierten Strukturmodell-Element abzurufen. Soll nur dessen volle Bezeichnung genutzt werden, ist ein Abruf des unter der URL erreichbaren Dokuments nicht nötig, da die Bezeichnung bereits im XML-Tag "attribute -> references -> reference -> label" (s. oben) enthalten ist.
Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen)context |
Kontext-Information, welche zur näheren Beschreibung der Referenz dient (Freitext) | Beispiel: Ein Dokument, welches am Attribut "Benötigte Dokumente" eines Prozess-Steckbriefs hinterlegt ist, wird nur unter bestimmten fachlichen Voraussetzungen benötigt. Hierzu wird an der Zuordnung des Dokuments ein entsprechender Freitext-Kommentar erfasst (z.B. "wird nur gebraucht, wenn der Antragsteller EU-Ausländer ist"). Diese Angabe ist optional. Ist keine Kontext-Information in der Prozessplattform hinterlegt, so entfällt dieses Tag im PicXML-3-Dokument. |
attribute -> references -> reference -> |
Mögliche Werte:
- "OrganisationUnit" (Organisationseinheit)
- "Product" (Produkt)
- "Document" (Dokument)
- "ExternalParticipant" (Externer Beteiligter)
- "Rule" (Regel/Rechtsgrundlage)
- "Software"
- "Hardware"
- "Position" (Stelle)
- "Person"
percent | Kontext-Information, welche zur Quantifizierung der Referenz dient (prozentualer Dezimalwert, vgl. o.g. Abschnitt "Prozentualer Wert") | Beispiel: Zwei Personen, die im Steckbrief des Prozesses im Attribut "Ausführende Sachbearbeiter" hinterlegt sind, teilen sich die Bearbeitung der Fälle im Verhältnis 50:50. Um dies abzubilden wird an der Zuordnung der Personen jeweils der prozentuale Wert "50 %" hinterlegt. Diese Angabe ist optional. Ist keine Kontext-Information in der Prozessplattform hinterlegt, so entfällt dieses Tag im PicXML-3-Dokument. |
attribute -> references -> reference -> |
Beispiel: Ein Dokument, welches am Attribut "Benötigte Dokumente" eines Prozess-Steckbriefs hinterlegt ist, wird nur unter bestimmten fachlichen Voraussetzungen benötigt. Hierzu wird an der Zuordnung des Dokuments ein entsprechender Freitext-Kommentar erfasst (z.B. "wird nur gebraucht, wenn der Antragsteller EU-Ausländer ist").
Diese Angabe ist optional. Ist keine Kontext-Information in der Prozessplattform hinterlegt, so entfällt dieses Tag im PicXML-3-Dokument.links | Container-Objekt für Hyperlinks zum Download von Dateianhängen | Sofern am Steckbrief des referenzierten Strukturmodell-Elements Dateianhänge hinterlegt sind, werden die Hyperlinks zum Download dieser Dateien in diesem Abschnitt aufgeführt. Bei der Weiterverarbeitung des PicXML-Dokuments in Drittsystemen können die entsprechenden Informationen daher bereits genutzt werden, ohne für jede Referenz einzeln jeweils der o.g. URL auf den kompletten Steckbrief des referenzierten Strukturmodell-Elements folgen zu müssen. |
attribute -> references -> reference -> links -> link -> label | Beschriftung des Hyperlinks zum Dateianhang | |
attribute -> references -> reference |
Beispiel: Zwei Personen, die im Steckbrief des Prozesses im Attribut "Ausführende Sachbearbeiter" hinterlegt sind, teilen sich die Bearbeitung der Fälle im Verhältnis 50:50. Um dies abzubilden wird an der Zuordnung der Personen jeweils der prozentuale Wert "50 %" hinterlegt.
Diese Angabe ist optional. Ist keine Kontext-Information in der Prozessplattform hinterlegt, so entfällt dieses Tag im PicXML-3-Dokument.
Container-Objekt für alle Hyperlinks zum Download von Dateianhängen aus dem Steckbrief des referenzierten Strukturmodell-Elements
Sofern am Steckbrief des referenzierten Strukturmodell-Elements Dateianhänge hinterlegt sind, werden die Hyperlinks zum Download dieser Dateien in diesem Abschnitt aufgeführt. Bei der Weiterverarbeitung des PicXML-Dokuments in Drittsystemen können die entsprechenden Informationen daher bereits genutzt werden, ohne für jede Referenz einzeln jeweils der o.g. URL auf den kompletten Steckbrief des referenzierten Strukturmodell-Elements folgen zu müssen.
-> links -> link -> url | URL, unter welcher der Dateianhang des referenzierten Elements heruntergeladen werden kann | 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 "&"). Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen). |
Hyperlinks
Codeblock |
---|
<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 | XML-Attribut | 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 |
Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen).
Bei einem Publikations-Lauf mit dem WebDAV-Publisher werden neben den Steckbriefen der freigegebenen Prozesse auch die dort hinterlegten Dateianhänge auf die WebDAV-Freigabe geschrieben. Dies betrifft
- die direkt am Prozess-Steckbrief hinterlegten Dateien
- Dateien, die an den Steckbriefen von Strukturmodell-Elementen hinterlegt sind, die im Prozess-Steckbrief referenziert sind.
Die in diesem XML-Tag gespeicherten Werte ermöglichen bei der Weiterverarbeitung der veröffentlichten Daten das einfache Auffinden der publizierten Dateianhänge.
Hyperlinks
(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
Codeblock |
---|
<attribute xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="linkListValue" attributeID="6b900a564e2e9d66-9e22a49e-4e144a47-9c3aa2c2-fafc9d06527c98b2ba222438" dataType="linksfileLinks"> <links> <link> <fileName>b2eb795b1b3a3e0f9536c5ed28c8.pdf</fileName> <label>Heise<label>Formblatt online<627</label> <url>http<url>https://www.heise.de<.prozessplattform.de/musterhausen/rest/repository/fileAttachment?file=4a6db2eb795b1b3a3e0f9536c5ed28c8.pdf&name=Formblatt_627</url> </link> <link> <label>Westfälische Nachrichten online<<fileName>589600b43d71695137a5128115bf.jpg</fileName> <label>Formblatt 628</label> <url>http<url>https://www.wn.de<www.prozessplattform.de/musterhausen/rest/repository/fileAttachment?file=9d30589600b43d71695137a5128115bf.pdf&name=Formblatt_628</url> </link> </links> </attribute> |
XML-Tag | XML-Attribut | Beschreibung | Kommentar |
---|---|---|---|
attribute -> links |
Container-Objekt für alle erfassten |
Dateianhänge | |
attribute -> links -> link |
Hyperlink zum Zugriff auf eine dem Steckbrief angehängte Datei | |||
attribute -> links -> link -> label | Beschriftung des Hyperlinks zum Dateianhang | ||
attribute -> links -> link -> url |
URL, |
Entspricht sinngemäß dem Attribut "href" des HTML-Tags "<a>" zur Repräsentation eines Hyperlinks.
Achtung:unter welcher der Dateianhang heruntergeladen werden kann | Das "Kaufmanns-Und" ("&"; wird in URLs zur Trennung mehrerer Query-Parameter genutzt) ist im URL-String per Entity- |
Dateianhänge
Codeblock |
---|
<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&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&name=Formblatt_628</url>
</link>
</links>
</attribute> |
Encoding codiert ("&"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&" durch "&"). Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen). | |||
attribute -> links -> link -> fileName | Dateiname, unter welchem die Datei im internen Datenspeicher der Prozessplattform angelegt ist | Deprecated. Dieses Feld ist nur noch aus Gründen der Abwärtskompatibilität vorhanden. Es kann von neuentwickelten externen Client-Anwendungen ignoriert werden. |
Schlagworte
Codeblock |
---|
<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 -> |
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 "&").
Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen).
Bei einem Publikations-Lauf mit dem WebDAV-Publisher werden neben den Steckbriefen der freigegebenen Prozesse auch die dort hinterlegten Dateianhänge auf die WebDAV-Freigabe geschrieben.
Die in diesem XML-Tag gespeicherten Werte ermöglichen bei der Weiterverarbeitung der veröffentlichten Daten das einfache Auffinden der publizierten Dateianhänge.
Schlagworte
Codeblock |
---|
<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. |
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. |
Aufbau des Steckbrief-Dokuments zur Kennzeichnung des Rückzugs einer Veröffentlichung
Das PicXML-3.0-Format kann genutzt werden, um Veröffentlichungs-Protokolle für die Kommunikation zwischen der PICTURE-Prozessplattform und einem Drittsystem zu realisieren, die auf dem Ablegen von Dateien in einem gemeinsamen Dateisystem-Verzeichnis bzw. einer Netzwerkfreigabe basieren. Um in diesem Zusammenhang an das Drittsystem zu kommunizieren, dass ein Steckbrief, der bei einem vorangegangenen Veröffentlichungslauf veröffentlicht wurde, bei einem weiteren Veröffentlichungslauf zurückgezogen werden soll, kann ein spezielles Steckbrief-Dokument erzeugt werden, welches ein "Lösch-Signal" für das Drittsystem enthält.
Codeblock |
---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<factSheet uuid="d738292a-9c2d-4f60-9a6e-89747dbf340e" name="Testprozess durchführen">
<notation>DELETED</notation>
<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 | uuid | UUID des zu löschenden Informationsobjekts | Die PICTURE-Prozessplattform stellt sicher, dass dieser Wert eindeutig für jede Kombination aus Arbeitsbereich innerhalb der PPP und Informationsobjekt (z.B. Prozess, Dokument etc.) ist. |
factSheet | name | Name des Informationsobjekts, welches durch diesen Steckbrief repräsentiert wird (z.B. Prozess, Strukturmodell-Element) | |
factSheet -> notation | Lösch-Signal "DELETED" ("Dummy-Notation") |