Zum Hauptinhalt springen

Jobs

Dieses Skript enthält Callbacks für Standard-Jobs.

tipp

Zum Aktivieren der Callbacks muss das Skript ou.tmpl.eFiles.callbacks.jobs in ou.cust.eFiles.callbacks.jobs umbenannt werden.

Verwendung​

Für was kann ich diese Callbacks verwenden?​

Welche Callbacks sind definiert?​

  • beforeDeleteJobStart: Wird getriggert, bevor der Job gestartet wird
  • beforeDelete: Wird getriggert, bevor eine Mappe gelöscht wird
  • afterDelete: Wird getriggert, nachdem die Mappe gelöscht wurde
  • beforeImportFilesJobStart: Wird getriggert, bevor der Job gestartet wird
  • beforeImportFile: Wird getriggert, bevor eine Mappe erstellt wird
  • afterImportFile: Wird getriggert, nachdem eine Mappe erstellt wurde
  • beforePostProcessingJobStart: Wird getriggert bevor der Job gestartet wird

Callbacks​

beforeDeleteJobStart​

Mittels diesem Callback kann der Job ausgesetzt werden.

beforeDeleteJobStart(): boolean | void;

Beispiel Löschen deaktivieren:

beforeDeleteJobStart: function() {
    return false;
}

beforeDelete​

Dieser Callback wird getriggert, bevor eine Mappe gelöscht wird.

beforeDelete(docFile: eFile): boolean | void;

Beispiel Löschen überspringen:

beforeDelete: function(docFile) {
    return false;
}

afterDelete​

Dieser Callback wird getriggert, nachdem eine Mappe gelöscht wurde.

afterDelete(): void;

Beispiel:

afterDelete: function() {
    // do something
}

beforeImportFilesJobStart​

Mittels diesem Callback kann der Job ausgesetzt werden.

beforeImportFilesJobStart(): boolean | void;

Beispiel Job deaktivieren:

beforeImportFilesJobStart: function() {
    return false;
}

beforeImportFile​

Dieser Callback wird getriggert, bevor eine Mappe importiert wird.

beforeImportFile(data: {
    filename: string;
    filePath: string;
    categoryName: string;
    subCategoryName: string;
    importDirectory: string;
}): boolean | void;

Beispiel :

beforeImportFile: function(data) {
    util.log(data.filename);
    util.log(data.filePath);
    util.log(data.importDirectory);
}

Beispiel Datei überspringen:

beforeImportFile: function(data) {
    return false;
}

afterImportFile​

Dieser Callback wird getriggert, nachdem eine Mappe erstellt wurde.

afterImportFile(docFile: eFile): void;

Beispiel:

afterImportFile: function(docFile) {
    util.log(`New import: ${docFile.getid()}`);
}

beforePostProcessingJobStart​

Mittels diesem Callback kann der Job ausgesetzt werden.

beforePostProcessingJobStart(): boolean | void;

Beispiel Job deaktivieren:

beforePostProcessingJobStart: function() {
    return false;
}