@vertigis/viewer-spec/app-config/common/WorkflowModelProperties.d.ts

VertiGIS Viewer Specification

import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
import type { ComponentModelProperties } from "./ComponentModelProperties.js";
/**
 * Properties that can be passed into the constructor for a Workflow model.
 */
export interface WorkflowModelProperties extends ComponentModelProperties {
    /**
     * The URL where the workflow JSON is located.
     */
    url?: string;
    /**
     * The title of the workflow.
     */
    title?: string;
    /**
     * An icon to display for the workflow.
     */
    icon?: string;
    /**
     * The inputs to be passed into the workflow.
     */
    inputs?: Record<string, unknown>;
    /**
     * The layout ID of the workflow component to use for any workflow forms, or
     * the ID of a container component like taskbar, panel, stack, etc. In the
     * latter case, a new workflow component will be created dynamically as a
     * child of the targeted container, and removed when the workflow finishes
     * running.
     */
    target?: string;
    /**
     * The portal item where the workflow JSON is located.
     */
    portalItem?: PortalItemLike;
    /**
     * The name of the workflow input parameter that the command's context will
     * map to.
     */
    commandArgumentInput?: string;
    /**
     * Whether the workflow accepts URL parameters when run from the URL.
     */
    acceptsUrlParams?: boolean;
}