Ereignis - Abonnement Archiv
 |
||||||||||||||||||||||||||||||||||||||||||
| Ereignis - Abonnement Archiv | ||||||||||||||||||||||||||||||||||||||||||
| Aufruf eines Skripts vor dem Versenden einer Abonnementbenachrichtigung beim Anlegen, Ändern oder Löschen eines Archivs | ||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Ist in den Einstellungen ein Skript eingetragen, wird es immer vor dem Versenden oder Anzeigen einer Abonnementbenachrichtigung ausgeführt.
|
Das eingetragene Skript wird auch dann ausgeführt, wenn keine Benutzerinteraktion möglich ist (zum Beispiel, wenn ein Archiv durch ein Skript vom ArcFlow Jobserver erstellt wird). Innerhalb des Skriptes dürfen daher keine Benutzerabfragen verwendet werden. |
Die Aktion, die zum Auslösen der Abonnementbenachrichtigung geführt hat, wird in der globalen Variablen gAfAboAction übergeben und kann mit folgenden Konstanten verglichen werden:
| Konstante | Wert | Beschreibung |
| sAfActNew | 'NEW' | Arbeitsmappe, Archiv oder Anhangdatei wurde angelegt |
| sAfActEdit | 'EDIT' | Arbeitsmappe, Archiv oder Anhangdatei wurde geändert |
| sAfActDelete | 'DELETE' | Arbeitsmappe, Archiv oder Anhangdatei wurde gelöscht |
| sAfActRetrieve | 'RETRIEVE' | Arbeitsmappe oder Archiv wurde aus dem Papierkorb bzw. eine Anhangdatei aus einer früheren Version wieder hergestellt |
In der Variablen gAfAboArea wird der Bereich angegeben, in dem die Aktion stattgefunden hat. Der Inhalt der Variablen kann mit folgenden Konstaten verglichen werden:
| Konstante | Wert | Beschreibung |
| sAfAboTypeArcHead | 'ARCHEAD' | Änderung an den Stammdaten des Archivs |
| sAfAboTypeArcText | 'ARCTEXT' | Änderung am Archivtext |
| sAfAboTypeArcWflHead | 'ARCWFLHEAD' | Änderung am Workflow-Kopf |
| sAfAboTypeArcWflDet | 'ARCWFLDET' | Änderung am Workflow-Detail |
| sAfAboTypeArcFileHead | 'ARCFILEHE' | Änderung an den Stammdaten der Anhangdatei |
| sAfAboTypeArcFileBlob | 'ARCFILEBL' | Änderung an dem Inhalt der Datei |
Das Abonnement ist bei einem Archiv definiert. Die Informationen zu dem Archiv können in folgenden globalen Variablen abgefragt werden:
| gAFAboObject | alpha(30) | Nummer des auslösenden Archivs |
| gAFAboObjectType | word | Objekt-Typ (sAfAboTypeABM, sAfAboTypeARC oder sAfAboTypeANH) |
| gAFAboSendType | word | Versendetyp des Abonnements (sAfSendTypeMail Versenden per Mail, sAfSendTypeDlg Anzeige als Dialog) |
| gAFAboName | alpha(250) | Name des Abonnements |
| gAFAboNote | alpha(4096) | Beschreibung des Abonnements |
| gAFAboNotifications | int | Benachrichtigung (siehe unten) |
| gAFAboOwner | alpha(25) | Der Benutzer, der das Abonnement erstellt hat |
Der Inhalt der variablen gAfAboNotifications kann mit folgenden Konstanten verglichen werden:
| Konstante | Wert |
| sAfAboAnhCreate | 0x00000001 |
| sAfAboAnhEdit | 0x00000002 |
| sAfAboAnhDelete | 0x00000004 |
| sAfAboArcCreate | 0x00000010 |
| sAfAboArcEdit | 0x00000020 |
| sAfAboArcDelete | 0x00000040 |
| sAfAboAbmCreate | 0x00000100 |
| sAfAboAbmEdit | 0x00000200 |
| sAfAboAbmDelete | 0x00000400 |
| sAfAboAbmSelfEdit | 0x00002000 |
| sAfAboAbmSelfDelete | 0x00004000 |
| sAfAboAbmLinkCreate | 0x00010000 |
| sAfAboAbmLinkEdit | 0x00020000 |
| sAfAboAbmLinkDelete | 0x00040000 |
Der Wert setzt sich aus einem oder mehreren ODER-verknüpften Werten zusammen und gibt an, bei welchen Ereignissen eine Abonnement-Benachrichtigung ausgelöst werden soll. Mit der Bedingung (gAfAboNotifications & sAfAboAbmDelete > 0) kann geprüft werden, ob das Abonnement ausgelöst wird, wenn eine Arbeitsmappe gelöscht wurde.
Die Informationen zu dem Archiv und gegebenenfalls zu der Anhangdatei werden in folgenden Variablen übergeben:
Archiv-Informationen
| gAfArcNr | alpha(12) | Archivnummer |
| gAfArcDocDate | date | Dokumentdatum |
| gAfArcScanDate | date | Scandatum |
| gAfArcCreateModul | alpha(80) | Erstellt durch Modul |
| gAfArcTypeString | alpha(250) | Archivtyp |
| gAfArcFilesCnt | int | Anzahl der Anhangdateien |
| gAfArcScanFilesCnt | int | Anzahl der Scan-Dateien |
| gAfArcFileSize | int | Dateigröße |
| gAfArcStorageYears | int | Aufbewahrungsfrist |
| gAfArcCaption | alpha(250) | Bezeichnung |
| gAfArcLocation | alpha(250) | Standort |
| gAfArcColor | int | Farbe zur Darstellung im Arbeitsmappenbaum |
Informationen der Anhangdatei
| gAfArcFileNr | int | Anhangdateinummer |
| gAfArcFileName | alpha(250) | Anhangdateiname |
| gAfArcFileDescr | alpha(250) | Beschreibung der Anhangdatei |
| gAfArcFileType | alpha(60) | Typ der Anhangdatei |
| gAfArcFileEditDate | date | Datum der letzten Aenderung der Anhangdatei |
| gAfArcFileEditTime | time | Zeit der letzten Aenderung der Anhangdatei |
| gAfArcFileSizeOrg | int | Größe der Anhangdatei (Original) |
| gAfArcFileSizeDba | int | Größe der Anhangdatei (Datenbank) |
| gAfArcFileModeEffect | int | Eigenschaft ModeEffekt bei Bildern |
| gAfArcFileState | int | Status der Anhangdatei (Vorhanden / Papierkorb / Gelöscht) |
| gAfArcFileCheckoutUser | alpha(25) | Benutzer, der die Anhangdatei ausgecheckt hat |
| gAfArcFileCheckoutDate | date | Datum an dem die Anhangdatei ausgecheckt wurde |
| gAfArcFileCheckoutTime | time | Zeit zu der die Anhangdatei ausgecheckt wurde |
Über den Rückgabewert des Skripts kann entschieden werden, ob die Benachrichtigung versendet (true) oder nicht versendet (false) werden soll.
Beispiel:
main() : logic;
local
{
tReturn : logic;
}
{
switch (gAfAboAction)
{
case sAfActNew :
{
if (gAfAboArea = sAfAboTypeArcHead)
{
// archive general data changed
...
tReturn # true;
}
}
...
default :
{
// error: unknown action
...
tReturn # false;
}
}
return(tReturn);
}
