PicXML 3.0

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

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

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 ("&lt;", "&gt;", "&amp;") repräsentiert.

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 (<br/>)

• fetter Text (<strong></strong>)

• kursiver Text (<em></em>)

• unterstrichener Text (<u></u>)

• 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 ("&lt;" bzw. "&gt;"). Das "Kaufmanns-Und" ("&") im HTML-Text ist ebenfalls in HTML-Entity-Darstellung codiert ("&amp;").

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

• "&lt; durch "<" ersetzen

• "&gt; durch ">" ersetzen

• "&amp; durch "&" ersetzen.

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

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.

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:

• Sekunde(n)

• Minute(n)

• Stunde(n)

• Tag(e)

• Woche(n)

• Monat(e)

• Jahr(e)

attribute -> number

Attributausprägung in Form einer Dezimalzahl

vgl. Angaben im Abschnitt "Ganzzahl, Kommazahl"

attribute -> unit

Währungseinheit (Kürzel)

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.

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.

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:

• "Process" (Prozess)

• "ProcessMap" (Prozesslandkarte)

• "FilterBundle" (Filterbündel)

• "OrganisationUnit" (Organisationseinheit)

• "Product" (Produkt)

• "Document" (Dokument)

• "ExternalParticipant" (Externer Beteiligter)

• "Rule" (Regel/Rechtsgrundlage)

• "Software"

• "Hardware"

• "Position" (Stelle)

• "Person"

• "SalaryBracket" (Vergütungsgruppe)

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 -> 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 -> 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 -> 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 -> 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 ("&amp;"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&amp;" durch "&").

Zum Zugriff auf diese URL ist ein Login in die PICTURE-Prozessplattform erforderlich (kann programmatisch per REST-API erfolgen).

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 ("&amp;"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&amp;" 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>).

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, 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-Encoding codiert ("&amp;"). Wenn die URL weiterverarbeitet werden soll, muss diese Codierung zunächst rückgängig gemacht werden (Ersetzung des Strings "&amp;" 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.

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.

factSheet

Inhalt des Steckbriefs für ein Informationsobjekt aus der PICTURE-Prozessplattform (z.B. Prozess, Strukturmodell-Element etc.)