Benutzerdefinierte Aktionen

Dieses Skript enthält Callbacks für den Mappentyp ptpRequest .

tipp

Zum Aktivieren der Callbacks muss das Skript ou.tmpl.ptpREQ.callbacks.actions in ou.cust.ptpREQ.callbacks.actions umbenannt werden.

Verwendung

Für was kann ich diese Callbacks verwenden?

• Standard-Benutzerdefinierte Aktionen beeinflussen

Welche Callbacks sind definiert?

• beforeCreateForm Bevor die Aktion "Formular erstellen" ausgeführt wird
• afterCreateForm Nachdem die Aktion "Formular erstellen" ausgeführt wurde
• beforeManualRestartWorkflow Bevor die Aktion "Neustart Workflow" ausgeführt wird
• afterManualRestartWorkflow Nachdem die Aktion "Neustart Workflow" ausgeführt wurde
• beforeTakeTask Bevor die Aktion "Aufgabe übernehmen" ausgeführt wird
• afterTakeTask Nachdem die Aktion "Aufgabe übernehmen" ausgeführt wurde

Callbacks

beforeCreateForm

Dieser Callback wird getriggert, bevor die Aktion Formular erstellen ausgeführt wird.

beforeCreateForm: (): string | void;

tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeCreateForm: function(tagName) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeCreateForm: function(tagName) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    throw new Error("Nope du nicht!");
}

afterCreateForm

Dieser Callback wird getriggert, nachdem die Aktion Formular erstellen ausgeführt wurde. In dem data Parameter wird die neu erzeugte PDF als Document übergeben.

afterCreateForm: (data: { document: Document }): void;

afterCreateForm: function(data) {
    util.log(data.document.fullname);
}

beforeManualRestartWorkflow

Dieser Callback wird getriggert, bevor die Aktion Neustart Workflow ausgeführt wird.

beforeManualRestartWorkflow: (data: { isProcess: boolean }): string | void;

Das Flag isProcess ist der Wert aus dem Dialog "Sind Sie sicher?".

tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeManualRestartWorkflow: function(data) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeManualRestartWorkflow: function(data) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    if (!data.isProcess) {
        throw new Error("Hey warte mal! So geht das aber nicht!");
    }
}

afterManualRestartWorkflow

Dieser Callback wird getriggert, nachdem die Aktion Neustart Workflow ausgeführt wurde.

afterManualRestartWorkflow: (): void;

afterManualRestartWorkflow: function() {

}

beforeTakeTask

Dieser Callback wird getriggert, bevor die Aktion Aufgabe übernehmen ausgeführt wird.

beforeTakeTask: (data: { newUser: string }): string | void;

tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeTakeTask: function(data) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeTakeTask: function(data) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    if (!data.newUser) {
        throw new Error("Hey warte mal! So geht das aber nicht!");
    }
}

afterTakeTask

Dieser Callback wird getriggert, nachdem die Aktion Aufgabe übernehmen ausgeführt wurde.

afterTakeTask: (): void;

afterTakeTask: function() {

}