UI steps Describes how to use the UI steps.
On this page
Expand Collapse Download file # General info # Category Description UIPerforms a download of the specified file.
Label Type Required Visibility Description File ID text yes Always The ID of the file to download.
Outputs # No configuration required.
Sample # The flow begins, and the "download file" step downloads the specified file. If an error occurs during the file download, the error will be logged, and the execution will be terminated. Go back # General info # Category Description UIGoes back in the browser navigation history.
No configuration required.
Outputs # No configuration required.
Sample # The flow initiates, and the "go back" step navigates back in the browser's navigation history. Subsequently, the execution concludes with the "end" step. Go to view # General info # Category Description UINavigates to the specified view in the UI.
Label Type Required Default Visibility Description View view yes - Always The view to navidate to. View type choice config.view.typeENTITY_VIEWRead Only config.view.typeENTITY_VIEWIn case of grid or workflow views define the view type to redirect.Read OnlyCreateEdit Record ID text config.view.typeENTITY_VIEW- config.view.typeENTITY_VIEWID of the record. When this field is set the app navigates to the detail read-only view of the record. Filters query no - config.view.typeCOLLECTION_VIEWconfig.view.typeCARDS_VIEWIn case of grid or workflow views define some view filters to be applied. Parameters query no - config.view.typeCUSTOM_VIEWIn case of custom views you can define some view parameters to be applied. Those parameters are transformed into URL query parameters.
Outputs # No configuration required.
Sample # The flow begins, and the "go to view" step navigates to the specified view. Subsequently, the execution concludes with the "end" step. Open action # General info # Category Description UIOpen the specified action modal in the UI.
Label Type Required Visibility Description Entity entity yes always The entity that the action belongs to. Action entityAction yes Always The action to be executed. Action view view no Always The action view to be used. If it is not specified the default one is going to be used. Record IDs text config.action.typeGLOBAL_ENTITYconfig.action.typeGLOBAL_ENTITYThe condition to be evaluated as true.
Outputs # No configuration required.
Sample # The flow initiates, and the "open action" step opens the specified action modal in the UI. Following this, the execution concludes with the "end" step. Open external link # General info # Category Description UIOpens the specified link in the browser.
Label Type Required Default Visibility Description URL text yes - Always External URL to open. Open link in a new tab boolean yes true Always If true external URL is opened in a new tab of the browser. Otherwise the URL will be opened in same tab.
Outputs # No configuration required.
Sample # The flow begins, and the "open external link" step opens the specified external URL. Subsequently, the execution concludes with the "end" step. Reload # General info # Category Description UIReloads the app.
Label Type Required Visibility Description Go to default view boolean yes Always If set to “true,” when the app is reloaded, the user will be directed to the default view, which is the view displayed when the app is loaded after login. If set to “false,” the current page will be reloaded.
Outputs # No configuration required.
Sample # The flow begins, and the "reload" step refreshes the app. Subsequently, the execution concludes with the "end" step. Show message # General info # Category Description UIDisplays a message in the UI.
Label Type Required Default Visibility Description Target choice yes caller Always Type of users to send the message.CallerUsersAll users Users text config.targetusers- config.targetusersSpecific users to send the message. Title text yes - Always The title to be shown on message. Message text yes - Always The message content to be shown on message. It supports some basic HTML tags. Type choice yes Information Always Define the style for the message.InformationSuccessWarningError Keep visible boolean yes - Always If true the message won’t be closed automatically and the user has to close it manually.
Outputs # No configuration required.
Sample # The flow initiates, and the "show message" step displays the specified message. Following this, the execution concludes with the "end" step. Start task # General info # Category Description UIDisplays the specified task in the top right.
Label Type Required Visibility Description Task ID text yes Always The ID of the task to be displayed on the tasks menu. Title text yes Always The message to be displayed on the tasks menu as the title. Message text no Always The complimentary message to be displayed as a subtitle.
Outputs # No configuration required.
Sample # The flow begins, and the "start task" step displays the specified task in the top right corner. If an error occurs during the task display, the error will be logged, and the execution will be terminated. Update task # General info # Category Description UIUpdates the status of a task displayed in the top right.
Label Type Required Visibility Description Task ID text yes Always The ID of the task to be displayed on the tasks menu. Title text yes Always The message to be displayed on the tasks menu as the title. Message text no Always The complimentary message to be displayed as a subtitle. Status text no Always The status of the task, which can be updated to running, success, or error. The initial status is running.
Outputs # No configuration required.
Sample # The flow initiates, and the "update task" step updates the status of the specified task. If an error occurs during the task update, the error will be logged, and the execution will be terminated. 
