Interface FormNodeParameters

Source
interface FormNodeParameters {
    completionMessage?: string;
    completionTitle?: string;
    defineForm?: "json" | "fields";
    formFields?: {
        values: {
            acceptFileTypes?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName?: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "date"
                | "html"
                | "checkbox"
                | "dropdown"
                | "hiddenField"
                | "password"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    inputDataFieldName?: string;
    jsonOutput?: string;
    limitType?: "afterTimeInterval"
    | "atSpecifiedTime";
    limitWaitTime?: boolean;
    maxDateAndTime?: string;
    operation?: "page" | "completion";
    options?:
        | {
            buttonLabel?: string;
            customCss?: string;
            formDescription?: string;
            formTitle?: string;
        }
        | { customCss?: string; formTitle?: string };
    redirectUrl?: string;
    respondWith?:
        | "text"
        | "redirect"
        | "showText"
        | "returnBinary";
    responseText?: string;
    resumeAmount?: number;
    resumeUnit?: "minutes"
    | "hours"
    | "days";
}

Properties§

Source§

readonly completionMessage?: string

Type options: {"rows":2}

Source§

readonly completionTitle?: string

Source§

readonly defineForm?: "json" | "fields"

Default: "fields"

Source§

readonly formFields?: {
    values: {
        acceptFileTypes?: string;
        elementName?: string;
        fieldLabel: string;
        fieldName?: string;
        fieldOptions: { values: { option?: string }[] };
        fieldType:
            | "number"
            | "file"
            | "text"
            | "email"
            | "date"
            | "html"
            | "checkbox"
            | "dropdown"
            | "hiddenField"
            | "password"
            | "radio"
            | "textarea";
        fieldValue?: string;
        formatDate?: string;
        html?: string;
        limitSelection?: "exact"
        | "range"
        | "unlimited";
        maxSelections?: number;
        minSelections?: number;
        multipleFiles?: boolean;
        multiselect?: boolean;
        multiselectLegacyNotice?: string;
        numberOfSelections?: number;
        placeholder?: string;
        requiredField?: boolean;
    }[];
}

Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly inputDataFieldName?: string

Find the name of input field containing the binary data to return in the Input panel on the left, in the Binary tab Default: "data"

Source§

readonly jsonOutput?: string

Default: "[\n {\n "fieldLabel":"Name",\n "placeholder":"enter you name",\n "requiredField":true\n },\n {\n "fieldLabel":"Age",\n "fieldType":"number",\n "placeholder":"enter your age"\n },\n {\n "fieldLabel":"Email",\n "fieldType":"email",\n "requiredField":true\n }\n]" Type options: {"rows":5}

Source§

readonly limitType?: "afterTimeInterval" | "atSpecifiedTime"

Sets the condition for the execution to resume. Can be a specified date or after some time. Default: "afterTimeInterval"

Source§

readonly limitWaitTime?: boolean

Whether to limit the time this node should wait for a user response before execution resumes

Source§

readonly maxDateAndTime?: string

Continue execution after the specified date and time

Source§

readonly operation?: "page" | "completion"

Default: "page"

Source§

readonly options?:
    | {
        buttonLabel?: string;
        customCss?: string;
        formDescription?: string;
        formTitle?: string;
    }
    | { customCss?: string; formTitle?: string }

Default: {}

Source§

readonly redirectUrl?: string

Source§

readonly respondWith?: "text" | "redirect" | "showText" | "returnBinary"

Default: "text"

Source§

readonly responseText?: string

The text to display on the page. Use HTML to show a customized web page. Type options: {"rows":2}

Source§

readonly resumeAmount?: number

The time to wait Default: 1 Type options: {"minValue":0,"numberPrecision":2}

Source§

readonly resumeUnit?: "minutes" | "hours" | "days"

Unit of the interval value Default: "hours"