Interface UiAction<T>

interface UiAction<T extends TableName> {
    $id: string | number | ExplicitKey<string>;
    $meta?: {
        installMethod?: "first install" | "demo" | "once";
        useEsLatest?: boolean;
    };
    $override?: Record<string, string | number | boolean>;
    actionName?: string;
    active?: boolean;
    client?: {
        isClient?: boolean;
        isUi11Compatible?: boolean;
        isUi16Compatible?: boolean;
        onClick?: string;
    };
    comments?: string;
    condition?: string;
    excludeFromViews?: string[];
    form?: | true
    | {
        iconName?: string;
        showButton?: boolean;
        showContextMenu?: boolean;
        showIconOnly?: boolean;
        showLink?: boolean;
        style?: | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
    };
    hint?: string;
    includeInViews?: string[];
    isolateScript?: boolean;
    list?: | true
    | {
        iconName?: string;
        showBannerButton?: boolean;
        showButton?: boolean;
        showContextMenu?: boolean;
        showIconOnly?: boolean;
        showLink?: boolean;
        showListChoice?: boolean;
        showSaveWithFormButton?: boolean;
        style?: | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
    };
    messages?: string[];
    name: string;
    order?: number;
    overrides?: string
    | Record<"sys_ui_action">;
    protectionPolicy?: "read" | "protected";
    roles?: (string | Role)[];
    script?: string | ((current: any, ...params: any[]) => void);
    showInsert?: boolean;
    showMultipleUpdate?: boolean;
    showQuery?: boolean;
    showUpdate?: boolean;
    table: T;
    workspace?: {
        clientScriptV2?: string;
        isConfigurableWorkspace?: boolean;
        showFormButtonV2?: boolean;
        showFormMenuButtonV2?: boolean;
    };
}

Type Parameters

T extends TableName

Properties

$id

$id: string | number | ExplicitKey<string>

`Optional`$meta

$meta?: {
installMethod?: "first install" | "demo" | "once";
useEsLatest?: boolean;
}

Type Declaration

OptionalinstallMethod?: "first install" | "demo" | "once"
Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)
OptionaluseEsLatest?: boolean
Controls whether this record's server-side script field(s) run with the latest supported ECMAScript version rather than the application's default. Omit to leave the sys_app/now.config default in place. This setting applies to all fields defined for this entity

`Optional`$override

$override?: Record<string, string | number | boolean>

Set properties not directly supported by this API.

`Optional`actionName

actionName?: string

unique string that can be referenced in scripts

`Optional`active

active?: boolean

If true, the UI Action is enabled

`Optional`client

client?: {
    isClient?: boolean;
    isUi11Compatible?: boolean;
    isUi16Compatible?: boolean;
    onClick?: string;
}

If client side script and related properties

`Optional`comments

comments?: string

text field used by developers and admins to add internal notes

`Optional`condition

condition?: string

A script or condition that determines whether the UI Action is visible.

`Optional`excludeFromViews

excludeFromViews?: string[]

Specifies views from which UI action to be excluded TODO: Add support for sysid references

`Optional`form

form?:
    | true
    | {
        iconName?: string;
        showButton?: boolean;
        showContextMenu?: boolean;
        showIconOnly?: boolean;
        showLink?: boolean;
        style?: | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
    }

UI action on form view and related properties. When set to true, the action will be executable in a form via programmatic calls without appearing in the UI (only applicable in UI26). When set as an object, the action will be displayed in a form view following the specified configuration.

Type Declaration

true
{
    iconName?: string;
    showButton?: boolean;
    showContextMenu?: boolean;
    showIconOnly?: boolean;
    showLink?: boolean;
    style?:
        | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
}
- OptionaliconName?: string
  Name of the icon to display on the button. For the list of available icons, go to /styles/retina_icons/retina_icons.html on your instance.
- OptionalshowButton?: boolean
- OptionalshowContextMenu?: boolean
- OptionalshowIconOnly?: boolean
  When true, the button will display only the icon, ignoring the 'Name' field. Remember to add a separate tooltip to the UI action itself to describe its function to users.
- OptionalshowLink?: boolean
- Optionalstyle?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

`Optional`hint

hint?: string

a tooltip or hover text that appears when users hover their mouse pointer over

`Optional`includeInViews

includeInViews?: string[]

Specifies views in which UI action to be included TODO: Add support for sysid references

`Optional`isolateScript

isolateScript?: boolean

Checked, script in a UI Action runs in an isolated script

`Optional`list

list?:
    | true
    | {
        iconName?: string;
        showBannerButton?: boolean;
        showButton?: boolean;
        showContextMenu?: boolean;
        showIconOnly?: boolean;
        showLink?: boolean;
        showListChoice?: boolean;
        showSaveWithFormButton?: boolean;
        style?: | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
    }

UI action on list view and related properties. When set to true, the action will be executable in a list via programmatic calls without appearing in the UI (only applicable in UI26). When set as an object, the action will be displayed in a list view following the specified configuration.

Type Declaration

true
{
    iconName?: string;
    showBannerButton?: boolean;
    showButton?: boolean;
    showContextMenu?: boolean;
    showIconOnly?: boolean;
    showLink?: boolean;
    showListChoice?: boolean;
    showSaveWithFormButton?: boolean;
    style?:
        | "primary"
        | "primary-ai"
        | "secondary-ai"
        | "destructive"
        | "unstyled";
}
- OptionaliconName?: string
  Name of the icon to display on the button. For the list of available icons, go to /styles/retina_icons/retina_icons.html on your instance.
- OptionalshowBannerButton?: boolean
- OptionalshowButton?: boolean
- OptionalshowContextMenu?: boolean
- OptionalshowIconOnly?: boolean
  When true, the button will display only the icon, ignoring the 'Name' field. Remember to add a separate tooltip to the UI action itself to describe its function to users.
- OptionalshowLink?: boolean
- OptionalshowListChoice?: boolean
- OptionalshowSaveWithFormButton?: boolean
- Optionalstyle?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

`Optional`messages

messages?: string[]

messages field holds user facing messages or text that are accessed via the getMessage or getMessages API in client scripts

name

name: string

name of the UI Action. It must be unique within the table

`Optional`order

order?: number

Determines the order in which the UI Action appears. Lower values show first.

`Optional`overrides

overrides?: string | Record<"sys_ui_action">

Action being overridden by the current record

`Optional`protectionPolicy

protectionPolicy?: "read" | "protected"

Controls edit/view access for other developers after the application is installed.

read: Others can see the script logic but not change it.
protected: Others cannot change this record.
Omit to allow other developers to customize this record.

`Optional`roles

roles?: (string | Role)[]

stores roles associated with a UI Action, defining which users can see or execute that UI Action based on their roles TODO: Add support for sysid references

`Optional`script

script?: string | ((current: any, ...params: any[]) => void)

Script runs automatically as part of the UI Action when the client calls it. Note: server module scripts (sys_module) can only be used on server-side UI Actions.

`Optional`showInsert

showInsert?: boolean

Checked, the UI Action appears in insert

`Optional`showMultipleUpdate

showMultipleUpdate?: boolean

Checked, the UI Action appears in insert, update, query or update multiple(bulk edit) mode.

`Optional`showQuery

showQuery?: boolean

Checked, the UI Action appears in insert, update, query or update multiple(bulk edit) mode.

`Optional`showUpdate

showUpdate?: boolean

Checked, the UI Action appears in update

table

table: T

table on which UI Action appears

`Optional`workspace

workspace?: {
    clientScriptV2?: string;
    isConfigurableWorkspace?: boolean;
    showFormButtonV2?: boolean;
    showFormMenuButtonV2?: boolean;
}

UI action on workspace configuration and related properties

Interface UiAction<T>

Type Parameters

Index

Properties

Properties

$id

Optional$meta

Type Declaration

OptionalinstallMethod?: "first install" | "demo" | "once"

OptionaluseEsLatest?: boolean

Optional$override

OptionalactionName

Optionalactive

Optionalclient

Optionalcomments

Optionalcondition

OptionalexcludeFromViews

Optionalform

Type Declaration

OptionaliconName?: string

OptionalshowButton?: boolean

OptionalshowContextMenu?: boolean

OptionalshowIconOnly?: boolean

OptionalshowLink?: boolean

Optionalstyle?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

Optionalhint

OptionalincludeInViews

OptionalisolateScript

Optionallist

Type Declaration

OptionaliconName?: string

OptionalshowBannerButton?: boolean

OptionalshowButton?: boolean

OptionalshowContextMenu?: boolean

OptionalshowIconOnly?: boolean

OptionalshowLink?: boolean

OptionalshowListChoice?: boolean

OptionalshowSaveWithFormButton?: boolean

Optionalstyle?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

Optionalmessages

name

Optionalorder

Optionaloverrides

OptionalprotectionPolicy

Optionalroles

Optionalscript

OptionalshowInsert

OptionalshowMultipleUpdate

OptionalshowQuery

OptionalshowUpdate

table

Optionalworkspace

Settings

On This Page

`Optional`$meta

`Optional`installMethod?: "first install" | "demo" | "once"

`Optional`useEsLatest?: boolean

`Optional`$override

`Optional`actionName

`Optional`active

`Optional`client

`Optional`comments

`Optional`condition

`Optional`excludeFromViews

`Optional`form

`Optional`iconName?: string

`Optional`showButton?: boolean

`Optional`showContextMenu?: boolean

`Optional`showIconOnly?: boolean

`Optional`showLink?: boolean

`Optional`style?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

`Optional`hint

`Optional`includeInViews

`Optional`isolateScript

`Optional`list

`Optional`iconName?: string

`Optional`showBannerButton?: boolean

`Optional`showButton?: boolean

`Optional`showContextMenu?: boolean

`Optional`showIconOnly?: boolean

`Optional`showLink?: boolean

`Optional`showListChoice?: boolean

`Optional`showSaveWithFormButton?: boolean

`Optional`style?: "primary" | "primary-ai" | "secondary-ai" | "destructive" | "unstyled"

`Optional`messages

`Optional`order

`Optional`overrides

`Optional`protectionPolicy

`Optional`roles

`Optional`script

`Optional`showInsert

`Optional`showMultipleUpdate

`Optional`showQuery

`Optional`showUpdate

`Optional`workspace