"handlers" schema section

Level: advanced

Request handlers are items of the HandlerChain mechanism that lets you describe business logic as an action request and a chain of handlers.

Base request handlers include actions that open pages, work with data on pages, etc.

Lifecycle handlers

Name	Description
crt.HandleViewModelInitRequest	Initialize a view model instance.
crt.HandleViewModelResumeRequest	Resume a view model instance. Add a View model to a container using the attach operation. Creatio calls the handler when you open a module that has the viewModel parameter.
crt.HandleViewModelAttributeChangeRequest	Change an attribute of a view model instance.
crt.HandleViewModelPauseRequest	Pause a view model instance. Remove the View model of the current module from a container using the detach operation. Creatio calls the handler after calling the HandleViewModelResumeRequest handler when you switch to another module and the current module has the viewModel parameter. Creatio does not call the handler if you open a Freedom UI page and switch to another module before executing the attach operation.
crt.HandleViewModelDestroyRequest	Destroy a view model instance. At this stage, execute only synchronous code that destroys resources accumulated as part of runtime.
crt.ModuleLoader	Load the client module to the Freedom UI page.

Page and record handlers

Name	Description
crt.CreateRecordRequest	Open a new record.
crt.UpdateRecordRequest	Open an existing record.
crt.OpenPageRequest	Open a specific page.
crt.OpenDuplicatesPageRequest	Open a duplicates page.
crt.OpenChangeLogRequest	Open a change log.
crt.SaveRecordRequest	Save data.
crt.CancelRecordChangesRequest	Cancel a record update.
crt.LoadDataRequest	Reload data on the page.
crt.ClosePageRequest	Close a page.
crt.RunBusinessProcessRequest	Run a business process. Parameters Name Type Required Description processName string Yes Code of the business process schema. processRunType string Yes Type of business process to run. Learn more: Run a business process. Available values Value Description ForTheSelectedPage Run the business process for the selected app page. RegardlessOfThePage Run the business process without connection to a dedicated app page. ForTheSelectedRecords Run the business process for the selected list records. saveAtProcessStart boolean No Save the current record before the business process is run. By default, "true." Available values Value Description true Save the current record before the business process is run. false Do not save the current record before the business process is run. showNotification boolean No Display the notification when the business process is run. By default, "true." Available values Value Description true Creatio displays the notification when the business process is run. false Creatio does not display the notification when the business process is run. sorting object No Sorting of selected records before they are passed to the business process. Usually, a variable like $ItemsSorting. recordIdProcessParameterName string Required, only if processRunType is set to ForTheSelectedPage, or if processRunType is set to ForTheSelectedRecords and parameterMappings is not defined Name of the process parameter that receives the record ID. dataSourceName string Optional, only if processRunType is set to ForTheSelectedRecords The data source name. By default, "PDS." parameterMappings object Optional, only if processRunType is set to ForTheSelectedRecords Key-value collection where key is the business process parameter and the value is the data source field. filters string Optional, only if processRunType is set to ForTheSelectedRecords Filter selected list records. Set the parameter to $Items. selectionStateAttributeName string Optional, only if processRunType is set to ForTheSelectedRecords Track changes of the selected variable in data source. By default, DataTable_SelectionState.
crt.DeleteRecordsRequest	Delete data.
crt.MergeRecordsRequest	Merge data.
crt.UploadFileRequest	Upload a file.
crt.AddTagsInRecordsRequest	Add tags to records.
crt.RemoveTagsInRecordsRequest	Remove tags from records.
crt.RemoveRecordsInStaticFoldersRequest	Remove records from a static folder.
crt.AddRecordsInStaticFoldersRequest	Add records to a static folder.
crt.AddCommunicationOptionsRequest	Add a communication option to a record.
crt.ImportDataRequest	Import data.
crt.ExportDataGridToExcelRequest	Export data to Excel.
crt.SetRecordRightsRequest	Set up access rights for a record.
crt.SetCalendarTimeScaleRequest	Set a calendar time scale.
crt.ShowRelationshipsRequest	Show record's relationships.
crt.ToggleFollowFeedRequest	Follow or unfollow a record feed.
crt.AddCalendarSyncAccountRequest	Add a calendar synchronization account.
crt.SetupCalendarSyncAccountRequest	Set up a calendar synchronization account.
crt.SendInvitesForActivityRequest	Send an invite for an activity.
crt.ContinueInOtherPageRequest	Continue working with a record in another page.
crt.MoveSelectedItemsRequest	Move selected records.
crt.PrintablesRequest	Print a report.
crt.CopilotActionRequest	Run a Creatio.ai action.
crt.CreateEmailRequest	Create an email.
crt.SidebarInitRequest	Initialize the custom sidebar.
crt.HandleSidebarOpenRequest	Open the custom sidebar.
crt.HandleSidebarCloseRequest	Close the custom sidebar.
crt.OpenSidebarRequest	Open the custom sidebar programmatically.
crt.CloseSidebarRequest	Close the custom sidebar programmatically.
crt.GetSidebarStateRequest	Return the state of the custom sidebar.
crt.ShowSidebarNotificationMarkRequest	Display the notification mark for the custom sidebar.
crt.HideSidebarNotificationMarkRequest	Hide the notification mark for the custom sidebar.
crt.ShowDialog	Open the dialog window.
crt.ShowDesktopNotificationRequest	Show a desktop notification in the browser. Parameters Name Type Required Description code string Yes Code of the system setting of the "Boolean" type that controls the notification type. Creatio shows the notification only if the current user can read the system setting and its value for the current user is "true." title string No Notification title. body string No Notification text. id string No Notification ID. The browser shows a single notification for notifications that have the same ID and replaces the previous notification with the new notification. icon string No URL of the notification icon. mode string No Display mode of the notification. By default, "when-hidden." Available values Value Description when-hidden Show the notification only if the browser window is not active. show-always Show the notification regardless of whether the browser window is active. isSilent boolean No Show the notification without sound and vibration. Available values Value Description true Creatio shows the notification without sound and vibration. false Creatio shows the notification with the sound and vibration set up in the operating system. timeout number No Time in milliseconds after which Creatio closes the notification. If the parameter is not set, the browser and operating system settings determine when to close the notification. Available in Creatio 8.3.2 and later. onClick object No Request that Creatio executes when the user clicks the notification.

See also

Request handlers in Creatio Mobile (user documentation)