AfAboCreate

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
 AfAboCreate(int1, alpha2, int3[, int4]) : int Nicht ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Nicht ausführbar mit der Application Remote ControlAusführbar von der Script-API
Erstellen eines Abonnements
int1 Abonnementtyp
sAfAboTypeAbm Arbeitsmappe
sAfAboTypeArc Archiv
sAfAboTypeAnh Anhangdatei
alpha2 Archiv- oder Arbeitsmappennummer
int3 Nummer des neuen Abonnements
int4 Nummer der Anhangdatei (optional)
Feldpuffer
gAfAboId int Nummer des Abonnements
gAFAboObjectType int Objekttyp
gAfAboObject alpha(80) Nummer der Arbeitsmappe, des Archives und der Anhangdatei
gAFAboSendType int Benachrichtigungstyp
gAFAboName alpha(250) Bezeichnung
gAFAboNote alpha(4096) Beschreibung
gAFAboNotifications int Anzahl der Benachrichtigungen
gAFAboOwner alpha(25) Ersteller
gAfAboWorkFlow int Standard-Workflow
gAFAboRepeat logic Wiederholendes Abonnement
gAFAboMaxRepeats int Anzahl der Wiederholungen
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAboEdit(), AfAboDelete()

Die Funktion erstellt ein Abonnement bei dem übergebenen Objekt. Der Objekt-Typ wird in (int1) übergeben. Folgende Typen können angegeben werden:

Konstante
Wert
Beschreibung
sAfAboTypeAbm
ABM
Arbeitsmappe
sAfAboTypeArc
ARC
Archiv
sAfAboTypeAnh
ANH
Anhangdatei

Soll das Abonnement einer Arbeitsmappe zugewiesen werden, muss in (alpha2) die in eine Zeichenkette gewandelte Id (siehe CnvAI()) der Arbeitsmappe angegeben werden. Beim Erstellen eines Abonnements für ein Archiv oder für eine Anhangdatei, werden in (alpha2) die Archivnummer und gegebenenfalls in (int4) die Nummer der Anhangdatei angegeben. Die weiteren Informationen zum Abonnement müssen in den folgenden globalen Variablen vor dem Aufrufen der Anweisung geschrieben werden.

gAFAboSendType int Benachrichtigungstyp
gAFAboName alpha(250) Bezeichnung
gAFAboNote alpha(4096) Beschreibung
gAFAboNotifications int Auslöser der Benachrichtigung
gAFAboOwner alpha(25) Ersteller
gAfAboWorkFlow int Standard-Workflow
gAFAboRepeat logic Wiederholendes Abonnement
gAFAboMaxRepeats int Anzahl der Wiederholungen
Die Variablen gAfAboId, gAfAboObjectType und gAfAboObject werden durch die Übergabeparameter überschrieben.

In der Variablen gAfAboSendType wird der Benachrichtigungstyp angegeben. Es stehen folgende Konstanten zur Verfügung:

Konstante Wert Beschreibung
sAfSendTypeMail
1
Benachrichtigung per Mail
sAfSendTypeDlg
2
Benachrichtigung per Dialog beim ArcFlow-Agent
sAfSendTypeWfl
4
Starten eines Workflows

Die Konstanten sAfSendTypeMail und sAfSendTypeDlg können miteinander kombiniert werden. Wird ein Workflow gestartet, erfolgt keine Benachrichtigung vom Abonnement, sondern von den einzelnen Workflow-Schritten.

Im Feldpuffer gAfAboNotifications werden die Ereignisse angegeben, die zu einer Auslösung des Abonnements führen. Es kann eine Kombination aus folgenden Konstanten angegeben werden:

Konstante Wert Arbeitsmappe Archiv Anhangdatei Beschreibung
sAfAboAnhCreate 0x00000001
X
Anhangdatei anlegen
sAfAboAnhEdit 0x00000002
X
X
Anhangdatei ändern
sAfAboAnhDelete 0x00000004
X
X
Anhangdatei löschen
sAfAboArcCreate 0x00000010
X
Archiv anlegen
sAfAboArcEdit 0x00000020
X
X
Archiv ändern
sAfAboArcDelete 0x00000040
X
X
Archiv löschen
sAfAboAbmCreate 0x00000100
X
untergeordnete Arbeitsmappe anlegen
sAfAboAbmEdit 0x00000200
X
untergeordnete Arbeitsmappe ändern
sAfAboAbmDelete 0x00000400
X
untergeordnete Arbeitsmappe löschen
sAfAboAbmSelfEdit 0x00002000
X
eigene Arbeitsmappe ändern
sAfAboAbmSelfDelete 0x00004000
X
eigene Arbeitsmappe löschen
sAfAboAbmLinkEdit 0x00020000
X
Mappenverknüpfung ändern

Nicht alle Kombinationen sind zulässig. Die Auslöser müssen zum angegebenen Objekt passen. Bei einer ungültigen Kombination gibt die Anweisung den Fehlerwert _ErrValueInvalid zurück.

Beispiel:

In diesem Beispiel wird ein Abonnement zur Überwachung einer Anhangdatei eingerichtet. Über weitere Anweisungen wird der zu benachrichtigende Benutzer und das Zeitintervall definiert. In diesem Beispiel wird der Sachbearbeiter Dieter Staub (DST) bei Änderungen an der Anhangdatei am nachfolgenden Montag benachrichtigt.

gAfAboSendType # sAfSendTypeMail;
gAfAboName # 'Benachrichtigung bei Veränderung der Anhangdatei';
gAfAboNote # '';
gAfAboNotifications # sAfAboAnhEdit | sAfAboAnhDelete;
tResult # AfAboCreate(sAfAboTypeAnh, gAfArcNr, var tAboNo, gAfArcFileNr);
...
tResult # AfAboUserAdd(tAboNo, sAfAboUserTypeSab, 'DST');
...
gAfAboTimeNotifyTime # 11:00;
gAfAboTimeNotifyWeekDay # sAfWeekdayMonday;
tResult # AfAboTimeAdd(tAboNo, sAfCheckWeekly);
...

Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_ErrValueInvalid -188 Der in (int1) übergebene Typ oder die Auslöser in gAfAboNotifications ist ungültig.

Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.