BasePageV2 schema

Level: intermediate

BasePageV2 is a base schema of a mini page. Implemented in the NUI package. This is a view model schema. Learn more about the schema properties in a separate article: Client schema.

Messages

Messages of a base mini page

Name	Mode	Direction	Description
UpdatePageHeaderCaption	Address	Publishing	Updates the page header.
GridRowChanged	Address	Subscription	Retrieves the ID of the selected list record when the record changes.
UpdateCardProperty	Address	Subscription	Changes the model parameter value.
UpdateCardHeader	Address	Subscription	Updates the add page header.
CloseCard	Address	Publishing	Closes the add page.
OpenCard	Address	Subscription	Opens the add page.
OpenCardInChain	Address	Publishing	Opens an add page chain.
GetCardState	Address	Subscription	Returns the add page status.
IsCardChanged	Address	Publishing	Informs of the add page change.
GetActiveViewName	Address	Publishing	Retrieves the name of the active view.
GetMiniPageMasterEntityInfo	Address	Subscription	Retrieves data about the master entity of the mini add page.
GetPageTips	Address	Subscription	Retrieves page tooltips.
GetColumnInfo	Address	Subscription	Retrieves column data.
GetEntityColumnChanges	Broadcasting	Publishing	Sends entity column data when the column changes.
ReloadSectionRow	Address	Publishing	Reloads the section row depending on the primary column value.
ValidateCard	Address	Subscription	Launches the add page validation.
ReInitializeActionsDashboard	Address	Publishing	Relaunches the action dashboard validation.
ReInitializeActionsDashboard	Address	Subscription	Updates the action dashboard configuration.
ReloadDashboardItems	Broadcasting	Publishing	Reloads the dashboard elements.
ReloadDashboardItemsPTP	Address	Publishing	Reloads the dashboard elements on the current page.
CanChangeHistoryState	Broadcasting	Subscription	Allows or prohibits changing the current history state.
IsEntityChanged	Address	Subscription	Returns the changed entity.
IsDcmFilterColumnChanged	Address	Subscription	Returns true if the filtered columns changed.
UpdateParentLookupDisplayValue	Broadcasting	Bidirectional	Updates the parent lookup record in accordance with the configuration.
UpdateParentLookupDisplayValue	Broadcasting	Bidirectional	States that data must be reloaded on the following launch.

The Terrasoft.core.enums.MessageMode enumeration represents the message modes, and the Terrasoft.core.enums.MessageDirectionType enumeration represents the message directions. Learn more about the MessageMode enumeration in the JS class library. Learn more about the MessageDirectionType enumeration in the JS class library.

Attributes

IsLeftModulesContainerVisible BOOLEAN

The visibility flag of LeftModulesContainer.

IsActionDashboardContainerVisible BOOLEAN

The visibility flag of ActionDashboardContainer.

HasActiveDcm BOOLEAN

The visibility flag of DcmActionsDashboardContainer.

ActionsDashboardAttributes CUSTOM_OBJECT

Custom attributes of DcmActionsDashboardContainer.

IsPageHeaderVisible BOOLEAN

The visibility flag of the page title.

ActiveTabName TEXT

Saves the name of the active tab.

GridDataViewName TEXT

The name of the GridData view.

AnalyticsDataViewName TEXT

The name of the AnalyticsData view.

IsCardOpenedAttribute STRING

Attribute of the add page body when the add page is displayed or hidden.

IsMainHeaderVisibleAttribute STRING

Attribute of the add page body when the main header is displayed or hidden.

PageHeaderColumnNames CUSTOM_OBJECT

The array of page header column names.

IsNotAvailable BOOLEAN

Flag that marks the page as not available.

CanCustomize BOOLEAN

Flag that marks the page as customizable.

Operation ENUM

Operations of the add page.

EntityReloadScheduled BOOLEAN

Flag that forces entity reload on the following launch.

The Terrasoft.core.enums.DataValueType enumeration represents the attribute data types. Learn more about the DataValueType enumeration in the JS class library.

Methods

onDiscardChangesClick(callback, scope)

Handles the Discard button click event.

Parameters

{String} [callback]	The callback function.
{Terrasoft.BaseViewModel} [scope]	The method execution scope.

addChangeDataViewOptions(viewOptions)

Adds switchpoint views to the drop-down list of the View button.

Parameters

{Terrasoft.BaseViewModelCollection} viewOptions

Items in the drop-down list of the View button.

addSectionDesignerViewOptions(viewOptions)

Adds the Open section wizard item to the drop-down list of the View button.

Parameters

{Terrasoft.BaseViewModelCollection} viewOptions

Items in the drop-down list of the View button.

getReportFilters()

Returns the query filter collection.

initPageHeaderColumnNames()

Initializes the column names of the page header.

getParameters(parameters)

Returns the values of ViewModel parameters.

Parameters

parameters

Parameter names.

setParameters(parameters)

Sets the ViewModel parameters.

Parameters

parameters

Parameter values.

getLookupModuleId()

Returns the ID of the lookup page module.

onReloadCard(defaultValues)

ReloadCard message handler. Reloads the data of the add page entity.

Parameters

{Object[]} defaultValues

Array of default values.

onGetColumnInfo(columnName)

Returns the column information.

Parameters

{String} columnName

The name of the column.

getTabsContainerVisible()

Returns the visibility status of container tabs.

getPrintMenuItemVisible(reportId)

Returns the visibility status of the Print button’s drop-down list items (i. e., reports).

Parameters

{String} reportId

Report ID.

getDataViews()

Retrieves the section view.

runProcess(tag)

Runs a business process using the start button for global business processes.

Parameters

tag	ID of the business process schema.

runProcessWithParameters(config)

Runs a business process with parameters.

Parameters

config

The configuration object.

onCanBeDestroyed(cacheKey)

Checks for unsaved data. Edit the cached config.result if the data was changed but not saved.

Parameters

{String} cacheKey

The key of the cached configuration object.

onValidateCard()

Displays an error message if the add page is invalid.