Programmablaufpläne und Beschreibung von Übergabeparametern

Dieser Abschnitt des Kapitels befasst sich mit der Beschreibung von Programmabläufen, die durch bestimmte Aktionen des Nutzers (Fax-Manager und Fax-Nutzer) ausgelöst werden. Des Weiteren werden die an die einzelnen Methoden übergebenen Variablen aufgelistet, wobei auf ihre Bedeutung eingegangen werden soll.

Beschreibung der übergebenen Variablen

Die verschiedenen als Übergabeparameter verwendeten Variablen sind in der nachfolgenden Tabelle aufgelistet. Es werden in der Tabelle alle DTML-Methoden aufgezählt und gleichzeitig alle die Übergabeparameter, die an diese Methoden übergeben werden können. Bei einem Aufruf einer dieser Methoden müssen nicht alle dieser Variablen gesetzt werden, da das von der jeweiligen auszuführenden Aktion abhängt. In welchem Falle welche Parameter übergeben werden müssen, entnehmen Sie bitte aus den Programmablaufplänen der einzelnen Aktionen.

Table 4. Übergabeparameter an DTML-Methoden

Methodenname akzeptierte Variablen (Typ) Bedeutung Wert
faxaction faxId (string | liste) Id von einem(mehrerer) Fax(e). Im Falle vom Aufruf der Faxanzeige wird nur ein String übergeben, der eine Fax-ID beinhaltet beliebig
move2usr (string> lösen Zuweisungsaktion für ein Fax aus (entweder an Nutzer oder in Papierkorb) 1
usrId (liste) Liste von Nutzerkennzeichen beliebig
back1 (string> wird gesetzt, wenn Rücksprung zu index_html erfolgen soll 1
bpress (string) Variable zum Kennzeichnen der Aktion entfernen trash
trashAct Kennzeichnet Papierkorb-Aktion 1
actId (string) Kennzeichnet welche Aktion aus dem Papierkorb ausgeführt werden soll (Fax zurück schieben in Manager-Inbox oder löschen) movebck | delete
selToUser faxId (liste) siehe faxaction siehe faxaction
move2usr siehe faxaction siehe faxaction
showFax faxId (string) siehe faxaction siehe faxaction
size (string) Anzeigemodus eines Faxes s | l | o (Anpassen auf s=Fensterhöhe, l=Fensterbreite, o=Orginalgröße)
act (string) Aktivierter Button für Menüleiste in Anzeige (abhängig von size) 0 | 1 | 2 (0=Fensterhöhe-, 1=Fensterbreite-, 2=Orginalgröße-Button)
page (string) aktuell betrachtete Seite 1 ... n
pact (string) Blätter-Aktion (eine Seite vor/zurück) 0 | 1 | 2 (0 = keine Änderung, 1 = eine Seite zurück, 2 = eine Seite vor)
see (string) zum Setzen der History-Einträge 1 (wenn 1, dann Eintrag in History)
globMailer faxId (string | liste ) ID von mehreren Faxen, wenn Methode aus Fax-Manager-Bereich aufgerufen wird, ansonsten nur die ID eines einzelnen Faxes new | old | fwd
status (string) Kennzeichnet Mailtyp (Mail bei Neueingang eines Faxes, bei veraltetem Fax oder Mail zum Zuweisen eines Faxes) new | old | fwd
mailToUser (string) muss Nutzerkennzeichen beinhalten, wenn status= new|old, oder eine komma-separierte Liste von E-Mail-Adressen, wenn status=fwd beliebig
user (string) enthält Nutzerkennzeichen des angemeldeten Nutzers man (wenn Nutzer faxmanager) | Nutzerkennzeichen
back2 siehe back1 in selToUser siehe back1 in selToUser
mailToTar faxId (liste) siehe faxaction siehe faxaction
rotateShowFax faxId (string) siehe faxaction siehe faxaction
size (string) siehe showFax siehe showFax
act (string) siehe showFax siehe showFax
page (string) siehe showFax siehe showFax
pact (string) siehe showFax siehe showFax
grad (string) Gradanzahl, um die Fax gedreht werden soll 90 | 180
manFaxDoc keine Übergabeparameter Aufruf als einfacher Link 
userFold keine Übergabeparameter Aufruf als einfacher Link 
foldDel actId (string> Kennzeichnet jeweilige Aktion auf Nutzerordnern (Ordnerinhalt verschieben oder Ordner löschen) movDel | delAll
folId (liste)Liste der nicht-zuordenbaren Folder-Idsbeliebig
trashBin success Rückgabewert von Methode faxaction, der erfolgreiche Durchführung der Aktion "Verschieben in Manager-Inbox" meldet 1
trasherr Rückgabewert von Methode faxaction, der fehlerhafte Durchführung der Aktion "Verschieben in Manager-Inbox" meldet 1
deleted Rückgabewert von Methode faxaction, der erfolgreiche Durchführung der Aktion "Faxe endgültig löschen" meldet 1
delerr Rückgabewert von Methode faxaction, der fehlerhafte Durchführung der Aktion "Faxe endgültig löschen" meldet 1
faxInfo target (string) Kennzeichnet Aufruf von faxInfo für ein Fax, welches in entweder in der Manager-Inbox oder in der persönlichen Inbox eines Nutzers liegt man | usr
faxId (string) ID eines Faxes beliebig
fol (string) fol entspricht einem Nutzerkennzeichen und ist damit der Name der persönlichen Inbox des Nutzers beliebig
manSys dev (string) Beschreibt, in welchem Bereich Fehler aufgetreten sind (Manager-Inbox, Papierkorb, Fax-Anzeige, Nutzerordner, Nutzerauswahl) um zu kategorisieren inbox | trash | show | fold | selUsr
emp (string) Meldung bei Bereich, der keine Objekte enthält (z.B. leerer Papierkorb) 1
err0 ... err3, trb (string) lösen verschiedene Fehlerausgaben aus (je nach Wert von dev) 1
succ, succ0, succ1, tra (string) lösen verschieden Erfolgsmeldungen aus 1
faxUsr/index_html keine Übergabeparameter Aufruf der persönlichen Inbox als einfacher Link 
userFaxaction faxId (string) Id eines Faxes beliebig
usrId (liste | string) allg. Liste von Nutzerkennzeichen, aber im Falle von download=1 (siehe unten) ist es einzelnes Nutzerkennzeichen des aktuellen Nutzers beliebig
back (string) wird gesetzt, wenn Rücksprung zu index_html erfolgen soll 1
move2usr (string) lösen Zuweisungsaktion für ein Fax aus 1
download (string) Kennzeichnet Download eines Faxes als PDF 1
reject (string) Kennzeichnet Abweisen eines Faxes 1
kill (string) Kennzeichnet Löschen eines Faxes 1
userToUser faxId (string) siehe userFaxaction siehe userFaxaction
userToTar faxId (string) siehe userFaxaction siehe userFaxaction
userToUser faxId (string) siehe userFaxaction siehe userFaxaction
userShowFax faxId (string) siehe userFaxaction siehe userFaxaction
size (string) Anzeigemodus eines Faxes s | l | o (Anpassen auf s=Fensterhöhe, l=Fensterbreite, o=Orginalgröße)
act (string) Aktivierter Button für Menüleiste in Anzeige (abhängig von size) 0 | 1 | 2 (0=Fensterhöhe-, 1=Fensterbreite-, 2=Orginalgröße-Button)
page (string) aktuell betrachtete Seite 1 ... n
pact (string) Blätter-Aktion (eine Seite vor/zurück) 0 | 1 | 2 (0 = keine Änderung, 1 = eine Seite zurück, 2 = eine Seite vor)
see (string) zum Setzen der History-Einträge 1 (wenn 1, dann Eintrag in History)
tooloff (string) Wenn tooloff übergeben wird, dann wird Werkzeugleiste in Faxansicht (oben und unten) ausgeblendet 1
userRotateFax faxId (string) siehe userFaxaction siehe userFaxaction
size (string) siehe userShowFax siehe userShowFax
act (string) siehe userShowFax siehe userShowFax
page (string) siehe userShowFax siehe userShowFax
pact (string) siehe userShowFax siehe userShowFax
grad (string) Gradanzahl, um die Fax gedreht werden soll 90 | 180
tooloff (string) siehe userShowFax siehe userShowFax
userFaxDoc keine Übergabeparameter Aufruf als einfacher Link 
usrSys dev (string) Beschreibt, in welchem Bereich Fehler aufgetreten sind ( pers. Inbox, Fax-Anzeige, Nutzerauswahl) um zu kategorisieren usrin | usrshow | selUsr
emp (string) Meldung bei Bereich, der keine Objekte enthält (z.B. leere Fax-Inbox) 1
err0 ... err2 (string) lösen verschiedene Fehlerausgaben aus (je nach Wert von dev) 1
succ0 (string) löst Erfolgsmeldungen aus 1
faxMan/index_html success Rückgabewert von Methoden, der erfolgreiche Durchführung einer Aktion meldet 1
deliverr Rückgabewert von Methode faxaction, der fehlerhafte Durchführung einer Aktion meldet 1
trashbin Rückgabewert von Methode faxaction, der erfolgreiche Durchführung der Aktion "Fax entfernen" meldet 1
trasherr Rückgabewert von Methode faxaction, der fehlerhafte Durchführung der Aktion "Fax entfernen" meldet 1
faxUsr/index_html wl Rückgabewert aus verschiedenen Funktionen, der erfolgreiche Durchführung einer Aktion meldet (aus userFaxaction und globMailer) 1

Programmablaufpläne

Die von den Fax-Managern und Fax-Nutzern durchführbaren Aktionen werden durch den Aufruf verschiedener Skripte und Methoden realisiert. Die verschiedenen Programmablaufpläne werden in diesem Abschnitt aufgezeigt.