Per-instance presentation config (toolbar visibility, related-entity
sections, collapsibility, width, in-form navigation). Set by the form host
(MjEntityFormHostComponent) or any consumer that instantiates the form
directly. Read back by MjRecordFormContainerComponent and the collapsible
panels through the FormComponent reference, so it takes effect WITHOUT
regenerating the CodeGen-produced template. Null means "use the container's
own defaults" (the classic full-page tab behavior).
ID of the currently-rendered variant (null when no override is active and the form is the CodeGen /
ProtectedelementProtectedformEmitted when navigation is requested (record link, external link, email, new record, etc.)
Emitted when a user-facing notification should be shown
Hook called when the user picks a different variant from the picker.
Default is a no-op; the Explorer-level single-record component replaces
this on the form instance to wire FormResolverService.SetSelectedVariant
and reload the record. Kept as a method (not an EventEmitter) so the host
doesn't need to subscribe — assignment is enough.
If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.
Emitted after a record is deleted successfully
Emitted when a record delete fails
Emitted once after ngOnInit completes and the record is fully initialized (favorites loaded, form state initialized). This is the safe point for the container to start loading badge counts and other record-dependent data.
Emitted after a record is refreshed from the database successfully
Emitted after a record is saved successfully
Emitted when a record save fails
ProtectedsectionsReadonlytoolbarHeight of the top area when a splitter layout is used. Referenced by CodeGen-generated templates for entities with "top area" sections.
Size of the top area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.
Emitted when validation fails before save
Variants applicable to the current (entity, user) tuple, supplied by the Explorer-level form resolver. When more than one entry is present, the record-form-container shows a picker that lets the user switch between variants. Empty / single-entry arrays hide the picker.
The container reads this via its EffectiveVariants accessor — generated
form templates do NOT need to bind it explicitly.
StaticɵdirStaticɵfacReturns all organic key related entities across all organic keys, flattened and sorted.
Checks if the AI prompt can be executed
Unsaved changes a form holds OUTSIDE its record's fields and pending records.
A form whose sections own editors — a flow canvas, a designer, a grid — accumulates edits that
neither record.Dirty nor PendingRecordsDirty() can see, because nothing on the entity
changed. Without this the toolbar reports "no changes" while the user is looking at their own
work, and the navigate-away guard lets them lose it silently.
Default false, so no existing form changes behaviour. Override to consult whatever holds the
extra state.
Whether the current entity has any active organic keys with related entities configured.
Returns all active organic keys for the current entity, or an empty array if none.
ProtectedPendingReturns either the default Metadata provider or the one specified in the Provider property, if it was specified
Returns all dynamically registered toolbar items.
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified
Returns either the default RunView provider or the one specified in the Provider property, if it was specified
Checks if OutputExample field should be visible
Checks if ParallelConfigParam field should be visible
Checks if ParallelCount field should be visible
Returns the map of toolbar item overrides.
Check if user can create AI Prompt Models
Check if user can create Template Contents
Check if user can create Templates
Check if user can delete AI Prompt Models
Check if user can delete Templates
Check if user can read Templates
Check if user can update AI Prompt Models
Check if user can update Template Contents
Check if user can update Templates
Adds a new model to the prompt (deferred until save)
Builds RunViewParams for a specific organic key related entity.
Convenience method to build organic key view params by organic key name and related entity name.
OptionalrelatedEntityJoinField: stringOne grid over several FKs to the same related entity (Bill-To OR Ship-To).
Override CancelEdit to restore original state
Change sort field and direction for execution history
Clears the permission cache. Call this when user context changes or permissions are updated.
Configures overrides for any toolbar item (standard built-in items like 'edit', 'delete', 'favorite', 'history', etc., or custom items). Allows dynamically changing visibility, disabled state, tooltips, order, icon, etc.
Creates a new template for this AI prompt (deferred until save)
Dynamically disables a toolbar item by key, with an optional reason string for the tooltip.
Optionalreason: stringOpens the AI prompt execution dialog
Format cost for display
Format duration for display
Optionaldecimals: numberOptionalcurrency: stringFormat tokens for display
Optionaldecimals: numberOptionalcurrency: stringGets the display name for a configuration ID
Custom-layout AI Prompt form looks best full-width on first open.
OptionalrelatedEntityJoinField: stringGet status color for execution
Get status icon for execution
Gets the display name for a model ID
Gets a stable identifier for a model (for form tracking)
Gets the status for a model-vendor combination
Gets the display text for output type
Gets the display text for parallelization mode
Gets the color for a template parameter type
Gets a friendly description of the parameter type
Gets the icon for a template parameter type
Gets the display name for a prompt ID from the tree data
Gets the display name for a prompt type ID
ProtectedgetGets status badge color
Gets the color for validation behavior display
Gets the display name for a vendor ID
Gets vendors for a specific model from cache or loads them
Gets the color for vendor status display
Handles template content record deletion This method should be called by the template editor to properly manage deletions
Handles template content record creation/modification This method should be called by the template editor to properly manage saves
ProtectedinitProtectedInternalOverride InternalSaveRecord to handle template dependencies and related entity changes Templates must be saved before AI Prompts to avoid foreign key constraint errors
OptionaldefaultExpanded: booleanOpens a dialog to link an existing template
Loads available AI configurations for selection
Loads available AI models for selection
Loads available AI prompt types for selection
Loads available AI vendors for selection
Load execution history for this prompt
Loads prompt models for this AI prompt
Loads the result selector tree data (categories and prompts)
Loads the template associated with this AI prompt
Loads vendors available for a specific model
Moves a model down in the list by swapping with the next item
Moves a model up in the list by swapping with the previous item
Navigate to a prompt run record
Default values for a new related-entity record so it links back here.
Pass relatedEntityJoinField when more than one relationship targets the
same entity (Bill-To vs Ship-To). When omitted and several matches exist,
every matching FK is set — same fields the related grid is filtering on.
OptionalrelatedEntityJoinField: stringDefault values for a new related record, setting every listed join field to this record's key. Pair with BuildRelationshipViewParamsForJoinFields.
A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.
Handles configuration change for a prompt model
Hook invoked when a custom or dynamic toolbar item is clicked. Subclasses can override this method to handle custom button clicks.
Handles delete requests from the form container. Emits RecordDeleted on success, RecordDeleteFailed on failure. Generated form templates bind this as: (DeleteRequested)="OnDeleteRequested()"
Handles drag end event
Handles drag over event
Handles drag start event
Handles drop event
Handles favorite toggle from the form container. Generated form templates bind this as: (FavoriteToggled)="OnFavoriteToggled()"
Handles navigation events from the form container and related entity grids. Relays the event upward via the Navigate
Handles history view requests from the form container. Generated form templates bind this as: (HistoryRequested)="OnHistoryRequested()"
Handles list management requests from the form container. Generated form templates bind this as: (ListManagementRequested)="OnListManagementRequested()"
Handles model selection change and loads vendors for that model
Handles result selector selection
Handles template content changes from the editor
Handles template ID changes in the form
Handles when test harness is closed
Opens the current template in a new window
Opens the test harness
ProtectedPendingProtectedPopulateOverride PopulatePendingRecords to add AI prompt model changes
ProtectedRaiseRe-fetches the current record from the database, updating field values in-place and resetting dirty flags. No-op in edit mode or on an unsaved record. Related-entity grids are notified via the form container's FormRecordRefreshCoordinator after this emits RecordRefreshed.
true if the record was reloaded from the database.
Registers a dynamic toolbar action item / button. Can be called during ngOnInit or at runtime.
Removes a model from the prompt (deferred until save)
Sets the numeric display order for a toolbar item (lower numbers appear earlier).
Checks if vendor dropdown should be shown (more than one vendor)
Sort execution history based on current sort field and direction
Called when the splitter layout changes (for entities with "top area" sections). No-op in the generic version; override in host application if splitter resizing is needed.
Override StartEditMode to capture original state for cancel functionality
Unregisters a previously registered dynamic toolbar item by key.
ProtectedValidate
Size of the bottom area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.