Boomi Flow Runtime Reference Documentation
    Preparing search index...

    Interface Options

    Options that may be defined in URL parameters

    interface Options {
        allowLocationControl: boolean;
        authenticationToken: null | string;
        components: { [key: string]: string | ComponentKind };
        culture: null | string;
        environmentId: null | string;
        featureFlags: null | Record<string, boolean>;
        flowId: null | string;
        flowVersionId: null | string;
        headerImageUrl: null | string;
        headerTitle: null | string;
        inputs: null | ObjectDataProperty[];
        mode: ExecutionMode;
        navigation: { isFixed: boolean };
        platformUri: string;
        rootElementSelector: string;
        selectedOutcomeId: null | string;
        stateId: null | string;
        tenantId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowLocationControl authenticationToken components culture environmentId featureFlags flowId flowVersionId headerImageUrl headerTitle inputs mode navigation platformUri rootElementSelector selectedOutcomeId stateId tenantId

    Properties

    allowLocationControl: boolean

    Allow the application to control or manipulate the address bar location.

    authenticationToken: null | string

    A token to use for authenticating requests to the Flow API.

    components: { [key: string]: string | ComponentKind }

    Use the fully supported custom component manager within the Flow design-time UI

    culture: null | string

    Sets a culture for translation.

    environmentId: null | string

    The Id of the environment to run the Flow within.

    featureFlags: null | Record<string, boolean>

    Any feature flags that should be enabled

    flowId: null | string

    The Id of the Flow to execute.

    flowVersionId: null | string

    The version Id of the Flow to execute.

    headerImageUrl: null | string

    A url used to display an image in the header.

    headerTitle: null | string

    Display a heading at the top of all screens in the Flow.

    inputs: null | ObjectDataProperty[]

    Input values passed into the Flow at initialization.

    mode: ExecutionMode

    Enable execution debugging modes.

    navigation: { isFixed: boolean }

    The navigation configuration.

    platformUri: string

    The Flow platform API base URI.

    rootElementSelector: string

    A CSS selector string used to define the root HTML node that hosts the rendered application.

    selectedOutcomeId: null | string

    An Id of an outcome to use when initializing the Flow.

    stateId: null | string

    An Id of a state to use when executing the Flow.

    tenantId: string

    The Id of the tenant which contains the selected Flow.

    Settings

    Member Visibility

    On This Page

    Properties