handlers schema section
Request handlers are items of the HandlerChain mechanism that let 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.
Base request handlers
crt.CreateRecordRequest
Create a record.
crt.UpdateRecordRequest
Update a record.
crt.OpenPageRequest
Open a page.
crt.SaveRecordRequest
Save data.
crt.CancelRecordChangesRequest
Cancel a record update.
crt.RunBusinessProcessRequest
Run a business process.
Parameters
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
string processName | Required | Code of the business process schema. | ||||||
string processRunType | Required | Type of business process to run. Learn more: Run a business process. 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. | ||||||
boolean saveAtProcessStart | Optional | Save the current record before the business process is run. By default, true Save the current record before the business process is run. false Do not save the current record before the business process is run. | ||||||
boolean showNotification | Optional | Display the notification when the business process is run. By default, true Creatio displays the notification when the business process is run. false Creatio does not display the notification when the business process is run. | ||||||
object sorting | Optional | Sorting of selected records before they are passed to the business process. Usually, a variable like | ||||||
string recordIdProcessParameterName | Required, only if | Name of the process parameter that is received by the record whose ID is specified. | ||||||
string dataSourceName | Optional, only if | The data source name. By default, | ||||||
object parameterMappings | Optional, only if | Key-value collection where key is the business process parameter and the value is the data source field. | ||||||
string filters | Optional, only if | Filter selected list records. Set the parameter to | ||||||
string selectionStateAttributeName | Optional, only if | Track changes of the selected variable in data source. By default, |
crt.ClosePageRequest
Close a page.
crt.HandleViewModelInitRequest
Initialize a view model instance.
crt.HandleViewModelResumeRequest
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
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.
crt.HandleSidebarOpenRequest
Open the custom sidebar.
crt.HandleSidebarCloseRequest
Close the custom sidebar.
crt.SidebarInitRequest
Initialize the custom sidebar.
crt.ShowSidebarNotificationMarkRequest
Display the notification mark for the custom sidebar.
crt.HideSidebarNotificationMarkRequest
Hide the notification mark for the custom sidebar.
crt.OpenSidebarRequest
Open the custom sidebar.
crt.CloseSidebarRequest
Close the custom sidebar.
crt.GetSidebarStateRequest
Return the state of the custom sidebar.
crt.ShowDialog
Open the dialog window.