Zum Hauptinhalt springen

Callbacks für Einstellungen

Dieses Skript enthält ein Callback um die Einstellungen zu überschreiben.

tipp

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

Verwendung​

Für was kann ich diese Callbacks verwenden?​

  • Wenn man die Standard-Einstellungen überschreiben möchte
  • Pflichtfelder in Workflow-Schritten erweitern möchte

Welche Callbacks sind definiert?​

  • getSettings: Erweitern der Standard-Einstellungen

Callbacks​

getSettings​

Dieser Callback übergibt die Standard-Einstellungen und erwartet als Rückgabewert die Standard-Einstellungen bzw. die modifizierten Einstellungen.

getSettings: (defaultSettings: DefaultSettings): DefaultSettings;

Möchte man z. B. zusätzliche Pflichtfelder im Freigabe-Step, so kann das Array ersetzt werden:

getSettings: (defaultSettings) => {
    const overriddenSettings = {
        // Einstellungen hier überschreiben, z.B. zusätzliches Pflichtfeld im Freigabe-Step
        verification: {
            mandatoryFields: ["costCenter", "costCenterName", "vendorId"],
        },
    };

    return __assign(__assign({}, defaultSettings), overriddenSettings);
}

Custom Workflow steps​

Mit der Eigenschaft customWorkflowSteps können zusätzlich Workflow-Steps hinterlegt werden.

customWorkflowSteps: Array<{
    globalState: number;
    label: string;
    icon: string;
    tooltip: string;
    visible?: boolean | ((docFile: ptpRequest) => boolean);
    state?: undefined | CustomWorkflowStepStates | ((docFile: ptpRequest) => undefined | CustomWorkflowStepStates);
}>;

Pflichtfelder:

  • globalState (number)
  • label (string)
  • icon (string)
  • tooltip (string)

Beispiel:

getSettings: (defaultSettings) => {
    const overriddenSettings = {
        customWorkflowSteps: [
            {
                globalState: 50,
                icon: "circled-plus",
                label: "Erstellen",
                tooltip: "Bestellung erstellen",
            },
        ],
    };

    return __assign(__assign({}, defaultSettings), overriddenSettings);
}
tipp

Eine ausführliche Anleitung ist hier zu finden.