Applications are used to group entities in the user interface for ease of user access. Provides organizational structure for presenting entities to users.

Hierarchy (view full)

Constructors

Properties

AutoUpdatePath: boolean = true

When true, Path is automatically generated from Name on save. Set to false to manually control the Path value. Defaults to true for new applications.

ClassName: string = null

TypeScript class name for ClassFactory registration (e.g., CRMApplication)

Color: string = null

Hex color code for visual theming (e.g., #4caf50)

DefaultForNewUser: boolean = null

If turned on, when a new user first uses the MJ Explorer app, the application records with this turned on will have this application included in their selected application list

DefaultNavItems: string = null

JSON array of default navigation items for this application. Parsed by BaseApplication.GetNavItems()

DefaultSequence: number = 100

Default sequence position when adding this application to a new user's User Applications. Lower values appear first. Used when DefaultForNewUser is true.

Description: string = null

Description of the application

HideNavBarIconWhenActive: boolean = false

When true, the Nav Bar icon for this application is hidden when the application is active. Useful for launcher-style apps like Home that should only be visible when the user is NOT in that app. Only applies when NavigationStyle is Nav Bar or Both.

ID: string = null

Unique identifier for the application

Icon: string = null

CSS class information for the display icon for each application

Name: string = null

Name of the application

NavigationStyle: "App Switcher" | "Nav Bar" | "Both" = 'App Switcher'

How the application appears in navigation. App Switcher = only in dropdown menu, Nav Bar = permanent icon in top nav, Both = shown in both locations.

Path: string = null

URL-friendly slug for the application (e.g., "data-explorer" for "Data Explorer"). Used in URLs instead of the full Name. Auto-generated from Name when AutoUpdatePath is true. Must be unique across all applications.

SchemaAutoAddNewEntities: string = null

Comma-delimited list of schema names where entities will be automatically added to the application when created in those schemas

Status: "Pending" | "Active" | "Disabled" | "Deprecated" = 'Active'

Application lifecycle status. Pending = not yet ready, Active = available for use, Disabled = temporarily unavailable, Deprecated = being phased out. Only Active applications are shown to users.

TopNavLocation: "Left of App Switcher" | "Left of User Menu" = null

Position of the permanent nav icon when NavigationStyle is Nav Bar or Both. Left of App Switcher = appears before the app switcher, Left of User Menu = appears near the user avatar. Ignored when NavigationStyle is App Switcher.

_ApplicationEntities: ApplicationEntityInfo[] = []
_ApplicationSettings: ApplicationSettingInfo[] = []
__mj_CreatedAt: Date = null

Timestamp when the record was created

__mj_UpdatedAt: Date = null

Timestamp when the record was last updated

Accessors

Methods

  • Copies initialization data from a plain object to the class instance. Only copies properties that already exist on the class to prevent creating new fields. Special handling for DefaultValue fields to extract actual values from SQL Server syntax.

    Parameters

    • initData: any

      The initialization data object

    Returns void