Inhaltsübersicht

Der Name des API ist DAARCAPI. Über eine URL mit entsprechenden Parametern ist es möglich, einen konkreten Request abzusetzen. Die URL wird am PC aufgerufen und enthält bereits eine gültige directweb Session-ID. Die gültige directweb Session-ID wird vorher mit einem Session-API erstellt/geprüft.
Zum Aufruf des API wird eine Schablonendefinition verwendet. Die Schablone ruft DirectWebRequester.exe auf. In dieser wird DirectWebRequester.exe mit URL und Platzhalter definiert. Danach erfolgt der Aufruf der Schablone mit der definierten Tastenfolge. In der Schablone werden die Platzhalter durch Werte (Felder) ersetzt. DirectWebRequester.exe liest aus der Registry den Benutzer und Passwort. DirectWebRequester.exe fordert eine Session-ID über eine URL. Die URL wird zusammengesetzt aus der Basis der übergebenen URL sowie Benutzer und Passwort. Die zurückgegebene Session-ID  wird in die URL des Parameters an einen bestimmten Platzhalter eingetragen. Danach wird der Internet-Explorer mit der zusammengesetzten URL aufgerufen.
Der Aufruf erfolgt in der URL wie folgt:
URL: /cgi-bin/dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID=[SESSID]
Beispiel: Aufruf ohne gültige Session-ID
0072 – API-Aufruf DAARCAPI – ohne gültige Session-ID

API-Aufruf DAARCAPI – für Archive oder Sammelarchive

Für Archiv- oder Sammelarchivabfrage gelten folgende Parameter:
FIND=allg. Suchtext
ARCFROM=Archivdatum von (YYYYMMDD)
ARCTO=Archivdatum bis (YYYYMMDD)
FULLTEXT=Volltextsuche
SHOWSNGHIT=Einzeltreffer in Hitliste anzeigen (Y/N)
SHOWMNU=Menübaum anzeigen (Y/N)
SHOWFLT=Filter anzeigen(Y/N/P=Protected)
IDX_[indexname]=Filterwert für Indexsuche

Beispiel API-Aufruf DAARCAPI – für Archive

Der URL-Aufruf für Archive erfolgt mit folgenden Parametern:
COMMAND=DSPARC (erforderlich)
ARCHIVE=[archiv] (erforderlich)
ALLOWADD=Hinzufügen von Docs erlauben (Y/N)
Beispiel 1: Auswahl eines bestimmten Archivs
DirectWebRequester.exe https:\\192.168.100.10\cgi-bin\dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID={0}&COMMAND=DSPARC&ARCHIVE={1}&ALLOWADD=Y
0073 – Schablonendefinition für ein bestimmtes Archiv in directarchiv
Schablone
Name der Schablonendefinition.
Tastenfolge
Eingabe der Tastenfolge über die die Schablonendefinition aufgerufen werden soll.
Pfad, Pfadliste oder Programmname
DirectWebRequester.exe https:\\192.168.100.10\cgi-bin\dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID={0}&COMMAND=DSPARC&ARCHIVE={1}&ALLOWADD=Y
Felddefinitionen
Es können beliebig viele Felddefinitionen festgelegt werden. Diese beinhalten die Position auf dem IBM i-Bildschirm (Zeile und Spalte) und die Länge des jeweiligen Strings, der vom IBM i-Bildschirm eingelesen werden soll.
0074 – Felddefinition 1 für ein bestimmtes Archiv in directarchiv
0075 – Felddefinition 2 für ein bestimmtes Archiv in directarchiv
Aufruf der Schablonendefinition mit definierter Tastenfolge ALT + J aus dem IBM i-Emulationsfenster mit zugehörigem Archiv GSSPOST:
0076 – Schablonenaufruf mit definierter Tastenfolge auf Archiv
Das Ergebnis der Aufrufes über die Schablonendefinition:
0077 - API-Aufruf DAARCAPI – Auswahl eines bestimmten Archivs
Beispiel 2: Auswahl eines bestimmten Dokumentes in einem Archiv
DirectWebRequester.exe https:\\192.168.100.10\cgi-bin\dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID={0}&COMMAND=DSPARC&ARCHIVE=GSSPOST&ALLOWADD=Y&IDX_DOKID={1}.eml
0078 - Schablonendefinition für ein bestimmtes Dokument in directarchiv
0079 – Felddefinition 1 für ein Dokument in einem Archiv in directarchiv
0080 - Felddefinition 2 für ein Dokument in einem Archiv in directarchiv
Aufruf der Schablonendefinition mit definierter Tastenfolge ALT + Z aus dem IBM i-Emulationsfenster mit ausgewählten Dokument:
0081 – Schablonenaufruf mit definierter Tastenfolge auf Dokument in Archiv
Hinweis
Es können auch mehrere Dokumente ausgewählt werden.
0082 - API-Aufruf DAARCAPI – Auswahl eines bestimmten Dokuments
Wird der Parameter SHOWSNGHIT=Y angegeben, so wird das ausgewählte Dokument gleich geöffnet.
0083 - API-Aufruf DAARCAPI – Auswahl eines bestimmten Dokuments mit Anzeige

Beispiel API-Aufruf DAARCAPI – für Sammelarchive

Der URL-Aufruf für Sammelarchive erfolgt mit folgenden Parametern:
COMMAND=DSPGLO (erforderlich)
GLOBAL=[global link] (erforderlich)
SHOWARC=Archivauswahl anzeigen (Y/N/P=Protected)

Schablonendefinition für directdial über directmedia

Mit entsprechender Schablonendefinition können z.B. auch Funktionen für die Applikation directdial aufgerufen werden.
0084 – Schablonendefinition für directdial
0085 – Felddefinition 1 für directdial (Vorwahl)
0086 – Felddefinition 2 für directdial (Durchwahl)
Aufruf der Schablonendefinition mit definierter Tastenfolge ALT + T aus dem IBM i-Emulationsfenster verbindet directdial mit dem Benutzer.

Schablonendefinition für GoogleSearch über directmedia

Mit entsprechender Schablonendefinition können jederzeit beliebige Funktionen wie z.B. GoogleSearch aufgerufen werden.
DirectWebRequester.exe http:\\www.google.de\search?q={1}{&q={n}}
0087 - Schablonendefinition für GoogleSearch
0088 - Felddefinition 1 für GoogleSearch
0089 - Felddefinition 2 für GoogleSearch
Aufruf der Schablonendefinition mit definierter Tastenfolge ALT + G aus dem IBM i-Emulationsfenster öffnet GoogleSearch mit dem Begriff Toolmaker.
0090 – Aufruf der Schablonendefinition mit ALT & G
0091 – Ergebnis des Schablonenaufrufs