/
Arbeitsweise und Umgang mit der API

Arbeitsweise und Umgang mit der API

Owned by Andreas Sauer
Last updated: Aug. 04, 2023
3 min read

1. Einleitung

Das Outlook-Addin kümmert sich um den kompletten Ablauf - von der UI in Outlook über das selektieren der jeweiligen Mails und die Übergabe nach Domino.
Die Mails werden dabei durch das Addin zunächst in die Outlook-Addin-Datenbank (oa.nsf) erstellt - diese repräsentiert sich für den Entwickler wie eine Mail-Datenbank in Domino.
In Domino kann sich der Entwickler somit auf seine Verarbeitung der heruntergeladenen/vorbereiteten Mails konzentrieren.
Für den Entwickler haben wir es dabei so einfach wie möglich gemacht: alles für die Verarbeitung ist per LotusScript und dort über LotusScript-Klassen realisiert!

Es gibt aktuell zwei Möglichkeiten das UI und damit die Integration von Domino in Outlook zu gewährleisten:

  • per einfacher LotusScript-gesteuerter UI

  • per teamWorkr von unserem Entwicklungspartner Team Technology

2. Nutzung per teamWorkr

2.1. Backend

Um im Backend entwickeln zu können, wird zunächst eine Basisklasse bereitgestellt: die COA_CAgent_STW (LotusScript-Bibliothek).
Wir befinden uns hier im Kontext eines (LotusScript-)Agenten.
Für jede Mail, welche verarbeitet werden soll, wird die Methode “UploadOneDocument” aufgerufen (siehe nachfolgenden Beispielcode).

2.2. Beispiel LotusScript-Bibliothek

Für jede Mail, welche verarbeitet werden soll, wird die Methode “UploadOneDocument” aufgerufen (siehe nachfolgenden Beispielcode).
Das Dokument “odocControl” ist dabei das “Austauschdokument” welches zwischen der UI und dem Backend abgeglichen wird.
Die Kommunikations-Klasse (siehe Abschnitt 3) wird über die Objekt-Variable oExchange zu Verfügung gestellt.

Option Public
Option Declare
Use "COA_CAgent_STW"

Class F_COA_CAgent_STW_Sample

' ###### Produce Function Produce As Variant On Error Goto Err_Exit Goto Err_RunCode

Err_Exit: Call ctool_ErrorSetDescrWP( "F_COA_CAgent_STW_Sample", "F-TOOL-00725", Null, Null, Null, Null, Null, Null, Null, Null, Null, Null )
Err_RunCode:

Set Produce = New COA_CAgent_STW_Sample End Function

End Class

Class COA_CAgent_STW_Sample As COA_CAgent_STW

' ###### UploadOneDocument Sub UploadOneDocument( odocControl As NotesDocument, nEntry, odocXChange As NotesDocument ) On Error Goto Err_Exit Goto Err_RunCode

Err_Exit:
Call ctool_ErrorSetDescrWP( "COA_CAgent_STW_Sample", "F-TOOL-00726", odocControl, Null, Null, Null, Null, Null, Null, Null, Null, Null )
Err_RunCode:

End Class

3. CTOOL_CExchange - Klasse

3.1. Einleitung

Mit dieser Klasse wird die Arbeit mit dem Prozess des Herunterladens und der Übergabe in die Zieldatenbank ermöglicht - und natürlich auch die Interaktion mit dem UI gesteuert.
Für jede Aktion gibt es eine Methode, welche nachfolgend beschrieben wird.
Die Klasse wird über die Objekt-Variable oExchange zu Verfügung gestellt.

3.2. Eigenschaften (Properties)

  • odocControl (NotesDocument) = das “Austauschdokument” welches zwischen der UI und dem Backend abgeglichen wird.

3.3. Methoden

3.3.1. Entries_SetNthEntryStatus( nEntry, odocUploaded As NotesDocument, lNoWEBURL, lNoNotesURL, cStatus, cStatusInfo )

Mit dieser Methode wird der Klasse mitgeteilt, welcher Eintrag in die Zieldatenbank übertragen/verarbeitet wurde.

  • nEntry = Nummer des Eintrages

  • odocUploaded = das Dokument welches in die Zieldatenbank übertragen wurde

  • lNoWEBURL
    true = es soll keine Browser-URL für das Anzeigen des hochgeladenen Dokumentes an die UI übergeben werden
    false =es soll eine Browser-URL für das Anzeigen des hochgeladenen Dokumentes an die UI übergeben werden

  • lNoNotesURL
    true = es soll keine Notes-Client-URL für das Anzeigen des hochgeladenen Dokumentes an die UI übergeben werden
    false =es soll eine Notes-Client-URL für das Anzeigen des hochgeladenen Dokumentes an die UI übergeben werden

  • cStatus
    mit dem Status wird der Verarbeitungszustand eines einzelnen Eintrages gesetzt.
    Hierfür gibt es 4 Möglichkeiten, welche man übergeben kann:
    oExchange.cStatus_Pending = der initiale Status (Element wurde in der UI durch den Benutzer zur Liste hinzugefügt)
    oExchange.cStatus_Processed = das Dokument wurde erfolgreich verarbeitet und es werden keine weiteren Eingriffe benötigt
    oExchange.cStatus_Warning = das Dokument wurde erfolgreich verarbeitet, es werden aber vom Benutzer noch Aktionen/Eingriffe benötigt - die Info dazu wird über cStatusInfo übergeben
    oExchange.cStatus_Error = das Dokument wurde nicht verarbeitet - die Info dazu wird über cStatusInfo übergeben

  • cStatusInfo = zusätzlicher Text für den Status

3.3.2. Entries_GetNthEntryStatus( nEntry, cInfo )

Mit dieser Methode kann man abfragen in welche Status sich ein Eintrage befindet - die Info dazu zurückgeben lassen

  • nEntry = Nummer des Eintrages

  • cInfo = zusätzlicher Text für den Status

Rückgabe

  • Status