Den Business Integration Service (BIS) können Sie nicht nur interaktiv über Dialog-Anwendungen nutzen, sondern auch automatisiert. Für den automatisierten BIS ist es teilweise erforderlich, die Programmierschnittstellen des BIS zu kennen.
In diesem Dokument sind die Hintergrund-Anwendungen sowie Workflow-Ereignisse mit ihren Schnittstellen dokumentiert, die der BIS bereitstellt.
Die Schnittstellen für den entfernten Aufruf des BIS sind in der Dokumentation Entfernte BIS-Schnittstellen dokumentiert.
1 Zielgruppe
- Entwickler
- Technische Berater
2 Beschreibung
2.1 Hintergrund-Anwendungen
Die Hintergrund-Anwendungen „Daten im Hintergrund importieren“ (technischer Name „com.cisag.pgm.bi.Import“) und „Daten im Hintergrund exportieren“ (technischer Name „com.cisag.pgm.bi.Export“) können Sie verwenden, um Import- bzw. Exportvorgänge aus dem Workflow oder aus adaptierten Anwendungen heraus aufzurufen.
Die Anwendungen haben die nachfolgend beschriebenen Schnittstellen.
2.1.1 Anwendung Import
2.1.1.1 Parameter
Die Anwendung „Daten im Hintergrund importieren“ wird mit der Action „IMPORT“ (Wert 1) aufgerufen und akzeptiert folgende Parameter für den Aufruf:
| Parameter | Bedeutung |
| ImportFile (String) |
Quell-Datei, aus der die Daten importiert werden sollen. Geben Sie den vollständigen Pfad der Datei mit dem Schema „file:///“ oder „kstore://“ an. Wenn die Datei die Endung „.gz“ besitzt, wird sie als „GZIP“-komprimierte Datei erkannt und automatisch beim Öffnen dekomprimiert.
Rückgabe: Der übergebene Wert. |
| ContentType (String) |
Dateityp. Verwenden Sie für XML „text/xml; charset=utf-8“, für den Dateityp Text „text/comma-separated-values“, für den Dateityp Unicode-Text „text/tab-separated-values“. Rückgabe: Der übergebene Wert. |
| DefaultLocale (String) |
Spracheinstellung für Zahlen- und Datumsschreibweisen.
Lassen Sie diesen Wert leer, um die Standard-Locale des entsprechenden Dateityps zu verwenden. Für XML wird eine XML-Schema-kompatible Schreibweise verwendet. Für Unicode-Text oder Text wird eine zur Inhaltssprache der Session passende Schreibweise verwendet. Falls XML-Dateien selbst eine Angabe über die Locale enthalten, wird die Locale aus der Datei, und nicht dieser Parameter verwendet. Aus Kompatibilität zu Semiramis 4.1 können Sie für den Dateityp XML auch „en-US-XMLSchemaCompliant“ angeben. Für die Dateitypen Text und Unicode-Text können sie auch Sprachcodes, z.B. „de“ oder „en“ angeben. |
| ParserProperties (CisParameterList) |
Lassen Sie diesen Wert für die Dateitypen XML und Unicode-Text leer.
Für den Dateityp Text können Sie die CSV-Formatparameter wie folgt angeben: Der Wert ist eine Parameterliste, in der Sie unter dem Schlüssel „com.cisag.pgm.bi.csv.CSVParser#CSV_FILE“ die CSV-Formatparameter angeben können. Die CSV-Formatparameter sind ein String, der sich aus dem Trennzeichen, dem Texterkennungszeichen und der Zeichenkodierung zusammensetzt. Der Vorgabewert für die die CSV-Formatparameter sind: Komma, Doppeltes Anführungszeichen, Standard-Zeichenkodierung des SAS. |
| ErrorFileMode (Valueset) |
Gibt an, wie die Fehler-Datei erzeugt werden soll. Valueset „com.cisag.pgm.bi.ImportErrorFileMode“.
Mit dem Wert „Automatisch“ wird der Name der Fehler-Datei automatisch erzeugt, wobei immer eine neue Datei angelegt wird. Mit dem Wert „Benutzerdefiniert“ können Sie ihn selbst festlegen. Lassen Sie bei aktivierter Protokollierung den Wert leer. |
| ErrorFile (String) |
Datei, die als Fehler-Datei für nicht importierbare Daten verwendet werden soll.
Geben Sie den vollständigen Pfad der Datei mit dem Schema „file:///“ oder „kstore://“ an. Lassen Sie den Wert leer, wenn der Parameter ErrorFileMode den Wert „Automatisch“ hat. Lassen Sie bei aktivierter Protokollierung den Wert leer. Rückgabe: Tatsächlich verwendete Fehler-Datei, falls sie geschrieben wurde. Falls der Wert leer oder gleich der Quell-Datei ist, wurde keine Fehler-Datei erzeugt. |
| ErrorFileNaming (Valueset) |
Legt fest, ob bei der Verwendung einer benutzerdefinierten Fehler-Datei die Datei automatisch fortlaufend nummeriert werden soll, falls eine Datei gleichen Namens bereits existiert. Valueset „com.cisag.pgm.bi.ImportErrorFileNaming“.
Optional. Vorgabewert ist „Überschreiben“. Lassen Sie den Wert leer, wenn „ErrorFileMode“ den Wert „Automatisch“ hat. Lassen Sie bei aktivierter Protokollierung den Wert leer. |
| WarningsMode (Valueset) |
Gibt an, wie mit Warnungen, die beim Import auftreten, umgegangen wird. Valueset „com.cisag.pgm.bi.ImportWarningsMode“.
Mit dem Wert „Keine bestätigen“ führen Warnungen zu Importfehlern und werden in die Fehler-Datei geschrieben. Mit dem Wert „Alle bestätigen“ werden alle Warnungen, die bei diesem Importvorgang auftreten, ignoriert. |
| CorrectionMode (Valueset) |
Gibt an, ob eine Korrektur fehlerhafter Daten in Semiramis erfolgen soll.
Mit dem Wert „Nicht korrigieren“ geben Sie an, dass keine Korrektur in Semiramis erfolgen soll. Mit dem Wert „Mit Workflow“ geben Sie an, dass eine Korrektur nach der Benachrichtigung durch den Workflow erfolgen kann. Beachten Sie, dass das Workflow-Ereignis unabhängig von diesem Parameter ausgelöst wird. |
| ObjectType (String) |
Vollqualifizierter technischer Name des Business Entitys, das exportiert werden soll.
Rückgabe: der übergebene Wert. |
| Database (String) |
Datenbank, von der Daten exportiert werden sollen. Sie können eine Konstante für ein Datenbank-Alias aus des Java-Interface „CisTransactionManager“ angeben.
Optional. Vorgabewert ist die aktive OLTP-Datenbank der Session. Rückgabe: der übergebene Wert. |
| FilterName (String) |
Filter, mit dem der Datenexport stattfinden soll. Geben Sie den Namen des Filters an.
Optional. Vorgabewert: Leer, d.h. Export mit allen Attributen des Datenmodells. |
| NLSMode (Valueset) |
Spracheinstellung für den Import ohne angegebenen Filter. Geben Sie einen Wert des Valuesets „com.cisag.pgm.bi.model.ObjectInfoFilterNLSMode“ an.
Optional. Vorgabewert ist der Modus „Einsprachig“. Verwenden Sie diesen Parameter nicht zusammen mit dem Parameter „FilterName“. |
| DateTimeMode
(Valueset) |
Zeitformat für den Import ohne angegebenen Filter. Geben Sie einen Wert des Valuesets „com.cisag.pgm.bi.model.ObjectInfoFilterDateTimeMode“ an.
Optional. Vorgabewert ist das Format „Kompakte Form“. Verwenden Sie diesen Parameter nicht zusammen mit dem Parameter „FilterName“. |
| ProcessLogLevel
(Valueset) |
Schaltet die Protokollierung ein oder aus. Valueset com.cisag.pgm.bi.ProcessLogLevel.
· DISABLED: Protokollierung nicht aktiviert (Vorgabewert) · ENABLED: Protokollierung aktiviert. |
Zusätzliche Rückgabeparameter:
| Parameter | Bedeutung |
| ImportedObjectCount (int) |
Anzahl der importierten Objekte. |
| InvalidObjectCount (int) |
Anzahl der fehlerhaften Objekte. |
| NotCorrigibleObjectCount (int) |
Anzahl der fehlerhaften Objekte, die nicht in einer Korrektur-Anwendung korrigiert werden können.
Dieser Wert ist ebenfalls ungleich 0, wenn Parserfehler oder sonstige Fehler aufgetreten sind. |
| ProcessUserGuid (GUID) |
GUID des Benutzers, für den die Session des Importvorganges angemeldet wurde. |
| ProcessBegin (Zeitstempel) |
Anfangszeitpunkt des Importvorganges. |
| ProcessEnd (Zeitstempel) |
Endzeitpunkt des Importvorganges. |
Hinweis:
Die zurückgegebenen Anzahlen sind bei manchen Business Entitys aufgrund der Arbeitsweise der Controller nur Näherungen. Ein Beispiel hierfür sind Controller, die Business-Entity-Instanzen teilweise importieren und teilweise als fehlerhaft markieren können.
Die in der folgenden Tabelle genannten Eigenschaften der Anzahlen sind hingegen immer korrekt.
2.1.1.2 Übersicht über Ergebniszustände
Anhand der Rückgabeparameter können Sie erkennen, mit welchem Ergebnis Importvorgang beendet wurde:
| Beschreibung | Rückgabe |
| Erfolg.
Alle Instanzen aus der Quell-Datei wurden importiert. |
ImportedObjectCount > 0
InvalidObjectCount = 0 ErrorFile = „“ |
| Fehler.
Keine für den Importvorgang passende Instanz in der Quell-Datei gefunden. Ohne Fehler-Datei. |
ImportedObjectCount = 0
InvalidObjectCount = 0 NotCorrigibleObjectCount = 0
|
| Fehler.
Alle fehlerhaften Instanzen sind korrigierbar und in der Fehler-Datei aufgeführt. Die Quell-Datei wurde vollständig eingelesen. |
InvalidObjectCount > 0
NotCorrigibleObjectCount = 0 ErrorFile ≠ ImportFile |
| Fehler.
Mindestens ein nicht-korrigierbarer Fehler beim Import, oder Abbruch des Imports (Quell-Datei nicht gefunden, Lesefehler, Parserfehler, etc.). Mit oder ohne Fehler-Datei. Die Quell-Datei wurde möglicherweise nicht vollständig eingelesen. |
NotCorrigibleObjectCount > 0
ErrorFile ≠ ImportFile, falls Fehler-Datei im Knowledge Store oder Dateisystem erzeugt. |
| Fehler. Anwendung abgebrochen aufgrund von Parameterfehlern.
Ohne Fehler-Datei. Kein Workflow-Ereignis ausgelöst. |
Rückgabe-Parameterliste = null |
Dass einer der Fehlerfälle aufgetreten ist, können Sie nach dem Aufruf aus einer adaptieren Anwendung heraus daran erkennen, dass die Methode
„CisProgramMessageQueue.requiresAttention()“ nach dem Aufruf der Hintergrund-Anwendung den Wert „true“ liefert.
2.1.2 Anwendung Export
2.1.2.1 Parameter
Die Anwendung „Daten im Hintergrund exportieren“ wird mit der Action „EXPORT“ (Wert 1) aufgerufen und akzeptiert folgende Parameter für den Aufruf:
| Parameter | Bedeutung |
| ExportFile
(String) |
Datei, in die die Daten exportiert werden sollen. Eine bestehende Ziel-Datei wird dabei überschrieben. Ob zusätzlich erzeugte Dateien, z.B. für den Inhalt von BLOB-Attributen, überschrieben werden, hängt vom jeweiligen Controller ab. Falls keine Objektinstanz zum Exportieren gefunden wurde, wird keine Datei erzeugt.
Geben Sie die Datei an, in die Sie exportieren möchten. Geben Sie den vollständigen Pfad der Datei mit dem Schema „file:///“ oder „kstore://“ an. Wenn die Datei die Endung „.gz“ besitzt, wird sie als „GZIP“-komprimierte Datei erkannt und automatisch beim Erzeugen komprimiert. |
| ContentType
(String) |
Dateityp. Verwenden Sie für XML „text/xml; charset=utf-8“, für den Dateityp Text „text/comma-separated-values“, für den Dateityp Unicode-Text „text/tab-separated-values“. |
| Locale (String) |
Spracheinstellung für Zahlen- und Datumsformate. Optional.
Lassen Sie diesen Wert leer, um die Standard-Locale des entsprechenden Dateityps zu verwenden. Für XML ist dies das XML-Schema-kompatible Format. Für Unicode-Text oder Text ist dies ein zur Inhaltssprache der Session passendes Format. Für den Dateityp XML können Sie aus Kompatibilität zu Semiramis 4.1 auch “en-US-XMLSchemaCompliant” angeben. Für die Dateitypen Text und Unicode-Text können sie auch Sprachcodes, z.B. „de“ oder „en“ angeben. |
| BuilderProperties
(CisParameterList) |
Lassen Sie diesen Wert für die Dateitypen XML und Unicode-Text leer.
Für den Dateityp Text können Sie die CSV-Formatparameter wie folgt angeben: Der Wert ist eine Parameterliste, in der Sie unter dem Schlüssel „com.cisag.pgm.bi.csv.CSVBuilder#CSV_FILE“ die CSV-Formatparameter angeben können. Die CSV-Formatparameter sind ein String, der sich aus dem Trennzeichen, dem Texterkennungszeichen und der Zeichenkodierung zusammensetzt. Der Vorgabewert für die die CSV-Formatparameter sind: Komma, Doppeltes Anführungszeichen, Standard-Zeichenkodierung des SAS. |
| ObjectType (String) |
Vollqualifizierter technischer Name des Business Entitys, das exportiert werden soll. |
| Database (String) |
Datenbank, von der Daten exportiert werden sollen. Sie können eine Konstante für ein Datenbank-Alias aus des Java-Interface „CisTransactionManager“ angeben.
Optional. Vorgabewert ist die aktive OLTP-Datenbank der Session. |
| FilterName (String) |
Filter, mit dem der Datenexport stattfinden soll. Geben Sie den Namen des Filters an.
Optional. Vorgabewert: Export mit allen Attributen des Datenmodells. |
| NLSMode (Valueset) |
Spracheinstellung für den Export ohne angegebenen Filter. Geben Sie einen Wert des Valuesets „com.cisag.pgm.bi.model.ObjectInfoFilterNLSMode“ an.
Optional. Vorgabewert ist der Modus „Einsprachig“. Verwenden Sie diesen Parameter nicht zusammen mit dem Parameter „FilterName“. |
| DateTimeMode
(Valueset) |
Zeitformat für den Export ohne angegebenen Filter. Geben Sie einen Wert des Valuesets „com.cisag.pgm.bi.model.ObjectInfoFilterDateTimeMode“ an.
Optional. Vorgabewert ist das Format „Kompakte Form“. Verwenden Sie diesen Parameter nicht zusammen mit dem Parameter „FilterName“. |
| SearchName (String) |
Eingrenzung der zu exportierenden Instanzen, entweder mit einer OQL-Suche oder mit einer OQL-Anweisung.
Wenn Sie die Eingrenzung mit einer OQL-Suche vornehmen möchten, geben Sie den voll qualifizierten technischen Namen der OQL-Suche an. Die Menge der zu exportierenden Instanzen durch die OQL-Suche und die optional angegebenen Suchparameter bestimmt. Für eine Eingrenzung mit einer OQL-Anweisung müssen die ersten 7 Zeichen „DynOQL:“ lauten, direkt gefolgt von der eigentlichen OQL-Anweisung. Die OQL-Anweisung bestimmt die Menge und die Sortierung der zu exportierenden Instanzen. |
| SearchParameters (CisParameterList) |
Suchparameter für die Eingrenzung mit OQL-Suche. Optional. Vorgabewert sind keine Suchparameter.
Der Wert ist eine Parameterliste, die die Suchparameter enthält. Parametername ist jeweils der Name des Suchfeldes aus der OQL-Suche, Parameterwert ist jeweils der Selection-String. Geben Sie diejenigen Suchparameter an, die Sie für die Eingrenzung verwenden möchten. Die möglichen Selection-Strings sind vom Datentyp des Suchfeldes abhängig und im Abschnitt „Format für Selection-Strings“ beschrieben. Für eine Eingrenzung mit einer OQL-Anweisung wird dieser Parameter nicht verwendet. |
| SearchSortOrder (String) |
Sortierung der exportierten Instanzen für die Eingrenzung mit OQL-Suche. Optional. Vorgabewert ist die in der OQL-Suche eingetragene Standardsortierung.
Die Syntax der Sortierung ist im Abschnitt „Format für die Sortierung“ beschrieben. Für eine Eingrenzung mit einer OQL-Anweisung wird dieser Parameter nicht verwendet. |
| SearchContextOrganizationGuid (GUID) |
GUID der Organisation, für die der Export ausgeführt werden soll.
Optional. Vorgabewert ist die Organisation der Session, die den Export ausführt. Setzen Sie den Parameter explizit, wenn Sie die Hintergrund-Anwendung in einer Workflow-Aktivitätsdefinition verwenden, oder sie aus einer adaptierten Anwendung im Rahmen eines Verarbeitungsauftrages aufrufen. |
| ProcessLogLevel
(Valueset) |
Schaltet die Protokollierung ein oder aus. Valueset com.cisag.pgm.bi.ProcessLogLevel.
· DISABLED: Protokollierung nicht aktiviert (Vorgabewert) · ENABLED: Protokollierung aktiviert. |
Die Anwendung besitzt folgenden Rückgabeparameter:
| Parameter | Bedeutung |
| ExportedObjectCount (int) |
Anzahl der exportierten Instanzen.
Falls diese Zahl 0 ist, wurde keine Datei erzeugt. Falls in diesem Fall eine Datei unter der angegebenen URI der Ziel-Datei vorhanden ist, stammt diese nicht aus dem aktuellen Exportvorgang. |
2.1.2.2 Format für Selection-Strings
In der folgenden Tabelle ist für die unterstützten Datentypen von Suchfeldern einer OQL-Suche angegeben, welche Syntax für die Selection-Strings verwendet wird.
| Datentyp | Selection-String-Syntax |
| boolean | „true“, „false“, „“ |
| Valueset | Aufsteigend sortierte Liste der ausgewählten Valueset-IDs (short-Werte).
Beispiel: |
| GUID | Hexadezimal-String für jede GUID, mehrere GUIDs mit Komma und Leerzeichen abgetrennt. |
| Zahlen | Mehrere Angaben durch Komma und Leerzeichen abgetrennt.
Beispiel: |
| String | In Strings sind die Platzhalter „*“ (keines bis beliebig viele Zeichen) und „?“ (genau ein Zeichen) an beliebigen Stellen erlaubt. Mehrere solche Strings mit Komma und Leerzeichen abtrennen. Beispiel: abc, de*, a*c |
| Zeitstempel, CisDate | Long-Wert des Zeitstempels (Millisekunden ab 01.01.1970 GMT) als Dezimalstring.
Bereiche, also Zahl – Zahl, – Zahl, Zahl – |
Hinweis:
Das Zeichen „–“ bezeichnet hier einen Bereich von Zahlen. Vor und hinter dem Zeichen muss ein Leerzeichen stehen, um es vom negativen Vorzeichen von Zahlen zu unterscheiden.
2.1.2.3 Format für die Sortierung
Die Angabe der Sortierung für eine OQL-Suche erfolgt in Form von Strings in folgendem Format:
- Sie bestehen aus Sortierkriterien, die durch ein Komma und Leerzeichen abgetrennt sind. Die Sortierkriterien sind in der gewünschten Sortierreihenfolge angegeben.
- Jedes Sortierkriterium besteht aus dem Namen des Feldes in der OQL-Suche, danach ein Leerzeichen, danach die Sortierrichtung ASC (Aufsteigend) oder DESC (Absteigend).
Ein Beispiel für eine Sortierangabe mit zwei Sortierkriterien:
name ASC, itemNumber DESC
2.1.3 Beispiele (Workflow)
Um bei einer Workflow-Aktivität einen Import oder Export durchzuführen, müssen die Hintergrund-Anwendungen in einer Workflow-Aktivitätsdefinition aufgerufen werden. Als Beispiele hierfür werden die Aktivitätsdefinitionen „cis.bis.AutomaticImport“ und „cis.bis.AutomaticExport“ ausgeliefert und sind automatisch auf jedem System vorhanden.
2.2 Workflow-Ereignisse
2.2.1 Ereignis „ImportRunCompleted“
Das Ereignis „com.cisag.pgm.bi.ImportRunCompleted“ wird nach jedem erfolgten Datenimport ausgelöst, unabhängig davon, ob bei dem Import ein Fehler aufgetreten ist oder nicht. Sie können mittels einer Aktivitätsdefinition festlegen, was beim Auftreten dieses Ereignisses geschehen soll.
Hinweis: Das Ereignis wird nicht ausgelöst, wenn die Hintergrund-Anwendung für den Importvorgang mit falschen Parametern gestartet wurde. Hierbei werden stattdessen Fehlermeldungen zurückgeliefert.
Das Ereignis wird auch unabhängig davon ausgelöst, ob eine Korrektur von Importfehlern über den Workflow angefordert wurde oder nicht. Damit können Sie in der Aktivitätsdefinition entscheiden, in welchen Fällen Sie tatsächlich benachrichtigt werden.
Das Ereignis wird ebenfalls unabhängig davon ausgelöst, über welchen Kanal der Importvorgang erfolgt ist.
2.2.1.1 Parameter
Das Ereignis besitzt folgende Parameter, die Sie in einer Aktivitätsdefinition verwenden können:
| Parametername | Bedeutung |
| ObjectType | Name des Business Entitys, für das Daten importiert wurden. |
| ProcessRunType | Art des Datenaustausch-Vorgangs, für den das Workflow-Ereignis ausgelöst wurde.
· „Ursprungsvorgang“ (10): Ein Ursprungsvorgang eines Imports mit eingeschalteter Protokollierung, oder ein beliebiger Import ohne Protokollierung. · „Korrektur“ (11): Eine Korrektur eines Imports, mit aktivierter Protokollierung. Wenn Sie die BIS-Protokollierung nutzen, können Sie anhand dieses Parameters unterscheiden, ob das Ereignis für eine Korrektur ausgelöst wurde. |
| ProcessLogLevel | Zeigt an, ob bei dem Datenimport die Protokollierung eingeschaltet war.
· DISABLED (1): Protokollierung nicht aktiviert, · ENABLED (2): Protokollierung aktiviert. |
| ImportFile | Datei, die importiert wurde. Parameter sollte nach Möglichkeit nicht verwendet werden.
Wenn hier ein Dateiname mit dem Schema „file:///“ zurückgeliefert wird, ist die Datei potenziell nicht von jedem Application-Server aus unter diesem Namen zugreifbar. Der Dateiname der Fehler-Datei hat standardmäßig das gleiche Schema wie der Dateiname der Quell-Datei. Bei der Datei kann es sich um eine temporäre Datei handeln, die zum Zeitpunkt der Auswertung dieses Parameters nicht existiert oder einen anderen Inhalt hat. Wert kann bei Importen über entfernte Schnittstellen leer sein. |
| ErrorFile | Fehler-Datei, falls eine Fehler-Datei erzeugt wurde. Parameter sollte nach Möglichkeit nicht verwendet werden.
Wenn keine Fehler-Datei erzeugt wurde und dennoch Fehler aufgetreten sind, ist dies der Name der Quell-Datei. Wenn hier ein Dateiname mit dem Schema „file:///“ zurückgeliefert wird, so ist diese Datei potenziell nicht von jedem Application-Server aus unter diesem Namen zugreifbar. Bei der Datei kann es sich um eine temporäre Datei handeln, die zum Zeitpunkt der Auswertung dieses Parameters nicht existiert oder einen anderen Inhalt hat. Wert kann bei Importen mit aktivierter Protokollierung oder beim Import über entfernte Schnittstellen leer sein. |
| CorrectionMode | „Korrigieren“-Einstellung des Datenimportes. Mögliche Werte sind:
· „Nicht korrigieren“ (1), · „Mit Workflow“ (2), · „Mit Korrektur-Anwendung“ (3). |
| ImportedObjectCount | Anzahl der importierten Business-Entity-Instanzen. |
| InvalidObjectCount | Anzahl der nicht importierten Business-Entity-Instanzen, unabhängig davon, ob sie in einer Korrektur-Anwendung korrigiert werden können.
Dieser Wert ist von 0 verschieden, wenn Fehler aufgetreten sind, und die Anzahl der fehlerhaften Instanzen bekannt ist. |
| NotCorrigibleCount | Anzahl der nicht importierten Business-Entity-Instanzen, die nicht in einer Korrektur-Anwendung korrigiert werden können.
Dieser Wert ist auch von 0 verschieden, wenn Fehler aufgetreten sind, bei denen die Anzahl fehlerhafter Instanzen aber nicht bekannt ist, beispielsweise bei abgebrochenen Importen oder syntaktischen Fehlern in der Quell-Datei. |
| ProcessUserGuid | GUID des Benutzers, für den der Datenimport durchgeführt wurde. |
| ProcessBegin | Zeitpunkt, an dem der Datenimport begonnen wurde. |
| ProcessEnd | Zeitpunkt, an dem der Datenimport beendet wurde. |
| Parameters | Parameter, die für das Öffnen der Anwendung „Datenimporte“ oder „Datenaustausch-Vorgänge“ benötigt werden. Dieser Wert muss in einer Aktivitätsdefinition an die Anwendung „Datenimporte“ übergeben werden. |
In einer Aktivitätsdefinition können Sie die Parameter wie folgt verwenden:
- Einen Importfehler erkennen Sie daran, dass mindestens einer der Parameter „InvalidObjectCount“ und „NotCorrigibleCount“ von 0 verschieden sind.
- Ob bei einem Importfehler eine Fehler-Datei vorhanden ist, erkennen Sie daran, dass der Parameter „ErrorFile“ gefüllt ist.
- Falls Sie sich nur bei Importvorgängen benachrichtigen lassen möchten, für die eine Korrektur der Daten über den Workflow explizit angefordert wurde, tragen Sie in die Aktivitätsdefinition als Bedingung ein, dass der Parameter „CorrectionMode“ den Wert 2 hat.
- Um die Aktivität an denjenigen Benutzer zu schicken, für den der Importvorgang durchgeführt wurde, tragen Sie den Parameter „ProcessUserGuid“ als Bearbeiter in die Aktivitätsdefinition ein.
- Um aus einer erhaltenen Workflow-Aufgabe im Navigationsbereich die Anwendung „Datenimporte“ öffnen zu können, verfahren Sie wie in der ausgelieferten Aktivitätsdefinition.
2.2.1.2 Beispiele
Als Beispiele für Aktivitätsdefinitionen für das Ereignis „com.cisag.pgm.bi.ImportRunCompleted“ werden folgende Aktivitätsdefinitionen ausgeliefert:
- „bis.ImportCompleted“
Bei fehlerhaften Importen, die ohne Protokollierung gestartet wurden, erhält der Benutzer, der den Import gestartet hat, eine Workflow-Aufgabe. Durch Öffnen der Aufgabe gelangt der Benutzer automatisch in die Anwendung „Datenimporte“. - „bis.ImportCompleted2“
Bei fehlerhaften Importen, die mit Protokollierung gestartet wurden, erhält der Benutzer, der den Import gestartet hat, eine Workflow-Aufgabe. Durch Öffnen der Aufgabe gelangt der Benutzer automatisch in die Anwendung „Datenaustausch-Protokolleinträge“.
2.2.2 Ereignis „ImportError“
Das Ereignis „com.cisag.pgm.bi.ImportError“ aus Semiramis Release V1R2M2 sollte nicht mehr verwendet werden und wurde als Entwicklungsobjekt abgelehnt (deprecated). Verwenden Sie stattdessen das oben beschriebene Ereignis „com.cisag.pgm.bi.ImportRunCompleted“.