Ereignis - Archiv

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 Ereignis - Archiv
Aufruf eines Skripts vor dem Anlegen, Ändern oder Löschen eines Archivs
Variablen gAfEvtAction int Aktion, die durchgeführt werden soll (siehe unten)
gAfArc* variable Feldpuffer des Archivs
Resultat true Aktion wird durchgeführt
false Aktion wird abgebrochen
Siehe

Liste aller Ereignisse, Ereignis - Arbeitsmappe, Ereignis - Anhangdatei

Ist in den Einstellungen ein Skript eingetragen, wird es immer vor einer Aktion mit einem Archiv aufgerufen.

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 durchgeführt werden soll, wird in der globalen Variablen gAfEvtAction übergeben und kann mit folgenden Konstanten verglichen werden:

Konstante Wert Beschreibung
sAfEvtArcCreate 41 Archiv soll angelegt werden
sAfEvtArcEdit 42 Archiv soll geändert werden
sAfEvtArcDelete 43 Archiv soll gelöscht werden
sAfEvtArcRetrieve 44 Archiv soll aus dem Papierkorb wieder hergestellt werden
sAfEvtArcAbmAdd 31 Archiv soll einer Arbeitsmappe hinzugefügt werden
sAfEvtArcAbmDelete 32 Archiv soll aus einer Arbeitsmappe entfernt werden

Bei dem Ereignis sAfEvtArcCreate steht in der Variablen gAFArcNr zwar die Archivnummer zur Verfügung, diese kann sich aber beim Speichern noch ändern.

Die Informationen zu dem Archiv 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

Über den Rückgabewert des Skripts kann entschieden werden, ob die Aktion durchgeführt (true) oder nicht durchgeführt (false) werden soll.

Beispiel:

main() : logic;

local
{
}

{
  switch (gAfEvtAction)
  {
    case sAfEvtArcCreate :
    {
      // create archive
      ...
    }
    case sAfEvtArcEdit :
    {
      // edit archive
      ...
    }
    case sAfEvtArcDelete :
    {
      // delete archive
      ...
    }
    case sAfEvtArcRetrieve :
    {
      // restore archive from bin
      ...
    }
    case sAfEvtArcAbmAdd :
    {
      // add archive to folder
      ...
    }
    case sAfEvtArcAbmDelete :
    {
      // remove archive from folder
      ...
    }
    default :
    {
      // error: unknown action
      ...
    }
  }
  return(true);
}