Technische Beschreibung der Request-Struktur

Verwendet z.B. für den Datenstrom des START-Konstrukts.

Versionen

Request-Blobs können in den Versionen 1-5 verarbeitet werden. Die nur für eine bestimmte Version geltenden Inhalte sind durch Fußnoten gekennzeichnet.

Version 4 enthält keine Änderungen im Format. Allerdings wird ab Version 4 die EnvVersionID unverändert als Bezeichnung der Config-Unit übernommen. Bis Version 4 wird sie umformatiert in <Anwendung>_<EnvVersionID>, außer EnvVersionID= „A“, was ignoriert wird.

Version 5 betrifft nur die Speicherung von Objekten.

Datenstrom

Der Datenstrom ist aufgebaut aus

Allgemeinen Informationen
START-Properties
Objekte
Dokumente (ab Version 3)
Infos für Aris-PPM (ab Version 6)

Strings werden dargestellt durch ein vorangestelltes Wort (2 Byte) welches die Länge des Strings angibt. Es folgen dann exakt soviele Bytes wie angegeben. Ein Nullterminator wird nicht mittransferiert und ist somit in der Länge nicht berücksichtigt.

Listen werden in Form von TAA-Collections übergeben. Diese beginnen immer mit einen TAA-Collection Header.

Alternative Darstellung als XML: Requeststruktur als XML

Allgemeine Informationen

Version 2 ff.

Länge	Datentyp	Name	Bedeutung	Ursprung/Cobol: Feld in TXTAA
1	Byte	Kompression	EBCDIC Space [0x40] = Keine Kompression, EBCDIC „C“ [0xC3) = Kompression	Konstante
4	Dword¹⁾	Codepage	Codepage-Indikator ist im Big-Endian Format gespeichert. Falls die Codepage mit 273 angegeben ist, sind alle mit Datentyp Long angegebenen Zahlen in Big-Endian Format gespeichert. Alle Character-Daten sind in der EBCDIC Codepage 273 Deutsch dargestellt. Andernfalls liegen Zahlen im Little-Endian Format, Character in ANSI vor. Die Differenzierung beginnt ab dem Feld welches dem Codepage-Indikator folgt.	Konstante
4 ²⁾	Dword	komprimierte Länge	Länge des folgenden, komprimierten Datenblobs	errechnet von Komprimierungsroutine
4	Long	Version	Version des Request	Konstante
2+n	String	Origin	System, wo der Request erstellt wurde, z.B. 'TAAIM-MVS'	Konstante
2+n	String	Environment Version	Konfigurationseinheit	Konstante
2+n	Timestamp	String im Format JJJJ-MM-DD-HH.MM.SS.MMMNNN	TX-TAA-TIMESTAMP
2+n	Modulname	Langname des auszuführenden Moduls	TX-IM-MODL-NAME
2+n	Modultyp	Typ des auszuführenden Moduls	TX-IM-BSTN
2+n	Application	Anwendungdes auszuführenden Moduls	TX-IM-APPL
2+n	Operation	Operation, die in dem Modul ausgeführt werden soll	TX-IM-EVENT
2+n	sTRING	MDate	Änderungsdatum des aufrufenden Moduls	TX-IM-START-MDATE
4	Long	RegisterOnly	0 = nur registrieren, 1 = Ausführung direkt anstoßen in TX-IM-STARTMODE 'R' (registeronly) oder 'D' (direct)	TX-IM-START-STARTMODE
4	Long	Workflowstate	Workflowstate des zu initiierenden Gevos, entfällt ab Version 6	TX-IM-START-WFLSTATE

Es folgen: Start-Properties

Version 1 (obsolet)

Version 1 enthält div. Informationen, die ab Version 2 in Form von Start-Properties übergeben werden:

Länge	Datentyp	Name	Bedeutung	Ursprung/Cobol: Feld in TXTAA
1	Byte	Kompression	EBCDIC Space [0x40] = Keine Kompression, EBCDIC „C“ [0xC3) = Kompression	Konstante
4	Dword	Codepage	Codepage-Indikator ist im Big-Endian Format gespeichert. Falls die Codepage mit 273 angegeben ist, sind alle mit Datentyp Long angegebenen Zahlen in Big-Endian Format gespeichert. Alle Character-Daten sind in der EBCDIC Codepage 273 Deutsch dargestellt. Andernfalls liegen Zahlen im Little-Endian Format, Character in ANSI vor. Die Differenzierung beginnt ab dem Feld welches dem Codepage-Indikator folgt.	Konstante
4 ³⁾	Dword	komprimierte Länge	Länge des folgenden, komprimierten Datenblobs	errechnet von Komprimierungsroutine
4	Long	Version	Version des Request	Konstante
2+n	String	Origin	System, wo der Request erstellt wurde, z.B. 'TAAIM-MVS'	Konstante
2+n	String	Environment Version	Konfigurationseinheit	Konstante
2+n	Timestamp	String im Format JJJJ-MM-DD-HH.MM.SS.MMMNNN	TX-TAA-TIMESTAMP
2+n	Modulname	Langname des auszuführenden Moduls	TX-IM-MODL-NAME
2+n	Modultyp	Typ des auszuführenden Moduls	TX-IM-BSTN
2+n	Application	Anwendungdes auszuführenden Moduls	TX-IM-APPL
2+n	Operation	Operation, die in dem Modul ausgeführt werden soll	TX-IM-EVENT
2+n	sTRING	MDate	Änderungsdatum des aufrufenden Moduls	TX-IM-START-MDATE
2+n	String	Nur V1: Gevo Kurzname	Gevokurzbezeichnung	TX-IM-START-GEVOT-ANW-KURZ/TX-IM-START-GVT-GEVOT-KURZ
2+n	String	Nur V1: Gevo Langname	Gevolangbezeichnung	TX-IM-START-GEVOTITLE
2+n	String	Nur V1: Gevo ID	Gevo-ID des zu startenden Gevos	TX-IM-START-GEVOID
2+n	String	Nur V1: Parent Gevo ID	Gevo-ID des rufenden Gevos	TX-IM-START-PARENTID
4	Long	RegisterOnly	0 = nur registrieren, 1 = Ausführung direkt anstoßen in TX-IM-STARTMODE 'R' (registeronly) oder 'D' (direct)	TX-IM-START-STARTMODE
4	Long	Workflowstate	Workflowstate des zu initiierenden Gevos	TX-IM-START-WFLSTATE
2+n	String	Nur V1: Client	Partnernummer	TX-IM-START-CLIENT Wflp: $BcCustomer
2+n	String	Nur V1: Category	Ordnungsbegriff	TX-IM-START-CATEGORY Wflp: $BcOrdinal
2+n	String	Nur V1: Agent	Vermittlernummer	TX-IM-START-AGENT Wflp: $BcAgent
2+n	String	Nur V1: Gevo OE	Organisationseinheit, mit der der Gevo registriert werden soll	TX-IM-START-GEVORESP-OE Wflp: $BcRespOe
2+n	String	Nur V1: Gevo User	Bentzer, mit dem der Gevo registriert werden soll	TX-IM-START-GEVORESP-BID Wflp: $BcRespOeUser
2+n	String	Nur V1: Current OE	Aktuelle Organisationseinheit	TX-IM-START-CURRRESP-OE Wflp: $CurUserOE
2+n	String	Nur V1: Gevo User	Aktueller Bentzer	TX-IM-START-CURRRESP-BID Wflp: $CurUserOE
2+n	String	Nur V1: Checkdate	Wiedervorlagedatum	TX-IM-START-SUSPENDDATE
4	Long	Nur V1: Checkdays	Prüfdatum	Wflp: $BcCheckDays

START-Properties

Dieser Abschnitt ist in Request-Blobs ab Version 2 enthalten.

Länge	Datentyp	Name	Bedeutung	Ursprung/Cobol: Feld in TX-STARTPROPS
4	Long	Anzahl Properties	Anzahl der Start-Properties	TX-STARTPROPS-COUNT
4	Long	Gesamtlänge der Daten	Länge des Headers und der enhalteten Daten, excl. diesem Längenfeld.
TAA Collection Header , anschließend pro Property ein Collection Item:
4	Long	Länge	Länge des Collection-Items	errechnet
4 Long	Version	Version des Collection-Items, z.Zt. 1	Konstante
2+n	String	Name	Name der Property	TX-STARTPROP-NAME(n)
4	Long	SysID	System-ID bei System-Property, sonst 0	TX-STARTPROP-SYSID(n)
4	Long	Flags	Flags, z.B. numerisch/alphanumerisch	TX-STARTPROP-FLAGS(n)
wenn nummerisch:
4	Long	Value	Nummerischer Inhalt der Property	TX-STARTPROP-VAL-N(n)
wenn alphanummerisch:
2+n	String	Value	Alphanummerischer Inhalt der Property	TX-STARTPROP-VAL-N(n)

Objekte

Bis Version 4:

Länge	Datentyp	Name	Bedeutung	Ursprung/Cobol: Feld in TX-TAA
4	Long	Anzahl	Anzahl TAA_Objekte	TX-IM-NOF-ASSIGNMENTS
4	Long	Gesamtlänge der Daten	Länge des Headers und der enhalteten Daten, excl. diesem Längenfeld.
TAA Collection Header , anschließend pro Property ein Collection Item:
4	Long	Länge	Länge des Collection-Items	errechnet
4 Long	Version	Version des Objekt-Items, immer = 1	Konstante
2+n	String	Name	Name des TAA-Objekts	TX-IM-OBJ-NAME(n)
2+n	String	GenDate	Generierungsdatum der Datenstruktur des TAA-Objekts	TX-IM-OBJ-STRUCT-DATE(n)
2+n	String	DstrName	Name der Datenstruktur des TAA-Objekts	TX-IM-OBJ-STRUCT-NAME(n)
4	Long	Single	1 = REC-Objekt, 2 = LST/REF-Objekt	TX-IM-OBJ-CLASS(n)
wenn LST oder REF:
4	Long	Gesamtlänge der Daten	Länge des Headers und der enhalteten Daten, excl. diesem Längenfeld.
TAA Collection Header , anschließend pro Objektsatz ein Collection Item:
4	Long	ItemLength	Länge der Daten in diesem Collectionitem, excl. diesem Längenfeld	berechnet
4	Long	DateLength	Länge des Imhalts dieses Satzes
4	Byte	Data	Satzinhalt
wenn REC:
4	Long	DateLength	Länge des Imhalts dieses Satzes
4	Byte	Data	Satzinhalt

Ab Version 5:

Länge	Datentyp	Name	Bedeutung	Ursprung/Cobol: Feld in TX-TAA
4	Long	Anzahl	Anzahl TAA_Objekte	TX-IM-NOF-ASSIGNMENTS
4	Long	Gesamtlänge der Daten	Länge des Headers und der enhalteten Daten, excl. diesem Längenfeld.
TAA Collection Header , anschließend pro Property ein Collection Item:
4	Long	Länge	Länge des Collection-Items	errechnet
4 Long	Version	Version des Objekt-Items. 1, 2 oder 3	Konstante
2+n	String	Name	Name des TAA-Objekts	TX-IM-OBJ-NAME(n)
2+n	String	Appl	Anwendung des TAA-Objekts	kann leer sein
2+n	String	Objt	Objekttyp des TAA-Objekts
2+n	String	Class	Objektklasse des TAA-Objekts (REC, LST, REF)
2+n	String	DstrName	Name der Datenstruktur des TAA-Objekts	TX-IM-OBJ-STRUCT-NAME(n)
2+n	String	GenDate	Generierungsdatum der Datenstruktur des TAA-Objekts	TX-IM-OBJ-STRUCT-DATE(n)
4	Long	Länge	Länge der Datenstruktur	(Length of …-REC)
4	Long	NoItems	Anzahl Items
pro Objektsatz:
n	Byte	Data	Objektdaten in der Länge der Datenstruktur, wie oben angegeben
für das Objekt:
	Bei Objektitem-Version >= 2:
		Serialisierte Blobs (Länge und Daten), oder Null:
4	Dword	Gesamtlänge aller Blobs
n	Byte	Wenn Länge > 0: Blobs
	Bei Objektitem-Version >= 3:
		Serialisierte Beschreibung des Objekttyps (Länge und Daten), oder Null:
4	Dword	Länge der Objekttypsbeschreibung
n	Byte	Wenn Länge > 0: Objekttypbeschreibung
		Serialisierte Beschreibung der Datenstruktur (Länge und Daten), oder Null:
4	Dword	Länge der Datenstrukturbeschreibung
n	Byte	Wenn Länge > 0: Datenstrukturbeschreibung

Dokumente

Ab Versión 3:

Länge	Datentyp	Name	Bedeutung	Inhalt/abgeleitet aus
4	Long	Dokumente?	1, wenn Dokumente übergeben werden, sonst 0
TAA Collection Header , anschließend pro Dokument ein Collection Item:
4	Long	Länge	Länge des Collection-Items	errechnet
4	Long	Version	Version des Dokument-Items, z.Zt. = 7	Konstante
4	Long	Sgut-Handle	Handle auf Schriftgut	darf nicht null sein
4	Long	Sgut-Def	Definition vorhanden (0=nein, 1=ja)?	immer 0, da kein CTV-Modul zugrunde liegt
2+n	String	Name	Name des Dokuments	Dokument-Titel
2+n	String	Appl	Anwendung, zu der das Dokument gehört	zur Laufzeit aktive Anwendung
2+n	String	Bundle	Bündel, zu dem das Dokument gehört
4	Long	Flags	Eigenschaften-Flags	CTR_SGUT_ISDOC CTR_SGUT_DYNAMIC CTR_SGUT_IMMUTABLE (~CTR_SGUT_VARISET & ~CTR_SGUT_GNVRSET) CTR_SGUT_ISDIRTY
4	Long	ID	eindeutige Schriftgut-ID (taaImBcUniqueIDGet)
2+n	String	Operation	Operation	leer
2+n	String	Tag	Tag	leer
2+n	String	UserData	Benutzerdaten	leer
8	Byte	Mask	Maske	leer
4	Long	Parent	Handle von Parent-Sgut	0
4	Long	CtrNgen	Handle auf Ctr-Ngen	0
TAA Collection Header für im Schriftgut enthaltenes Schriftgut				leer
4	Long	FlagTxtk	Textkonserve vorhanden?	hier: 1
Beschreibung der Textkonserve:
4	Long	Version	Res-Version Textkonserve	z.Zt. 3
4	Long	Htxtk	Handle auf Textkonserve	darf nicht null sein
4	Long	TxtkDef	Definition der Textkonserve vorhanden?	0
4	Long	Parent	Handle auf Parent	darf nicht null sein
4	Long	Flags	Flags zur Textkonserve	(CTR_TXTK_FIXED CTR_TXTK_READONLY CTR_TXTK_ISDIRTY) & ~CTR_TXTK_TXTPSET & ~CTR_TXTK_TXTFSET
2+n	String	Type	Dateityp	File Extension aus Pfadnamen
4	Long	Länge	Länge des Textinhalts
n	Bytes	Data	Textinhalt, Länge wie oben angegeben
Zum Schriftgut gehörige Symtab:
4	Long	Version	Res-Version Symtab	z.Zt. 2
4	Long	hSymTab	Handle auf Symtab	kann null sein
TAA Collection Header für enthaltene Symbole				leer
Zum Schriftgut gehörige Zuweisungen:
TAA Collection Header für enthaltene Zuweisungen				leer

TAA Collection Header

Der Collection Header steht immer vor eine Aufzählung von Request-Bestandteilen, z.N. Start-Properties oder Objekten. Er wird hier einmalig beschieben:

Länge	Datentyp	Name	Bedeutung / Wert im Requestblob
4	Long	Version	1
4	Long	Callback Function	1
4	Long	User Data	0
4	Long	Current Item	Index des aktuellen Items
4	Long	Itemcount	Anzahl Items in der Liste

Alternative Darstellung als XML: TAACollectionHeader als XML

Blobs

Alle Inhalte aus Blob- oder Clob-Feldern in einem Objekt werden direkt hintereinander serialisiert:

Länge	Datentyp	Bedeutung / Wert im Requestblob
	pro Blob:
4	Long	Länge des Blobs
n	Byte	Wenn Länge > 0: Blob Data

¹⁾

unsigned Long

²⁾ , ³⁾

nur bei komprimiertem Blob