Use the Terminate component

Abort an automation by using the Terminate component in RPA Desktop Design Studio.

Before you begin

Role required: none

About this task

You can configure the properties for the Terminate component. For more information about these properties, see Properties of the General components.

Use the Terminate component in attended automations to complete the automation execution. For more information about the embedded task automation, Embedded Task Automation in RPA Hub.

Procedure

1. In the Toolbox pane, navigate to General > Terminate.
2. Drag the Terminate component to the Design surface.
3. To configure the input field, see Configure port properties.
4. Optional: Connect the data and control ports of the Terminate components to the corresponding ports of the other components as described in the following table.

   Port type	Port name	Data type	Purpose of connection	Mandatory?	Notes
   Data In	Message	String	Takes the message when an automation is terminated.	No. Connecting the port is optional.	If the Boolean input in the Mark As Error port is True, then you must provide a message.
   Data In	Mark As Error	Boolean	Takes the Boolean value that indicates the status of the process job. If True, the state of the process job is Failed. If False, the status of the process job is a success.	No. Connecting the port is optional.	You can view the status of the process job under the Process Jobs tab of the respective process in the instance.
   Data In	Capture Screen	Boolean	Takes the Boolean value that indicates whether the component captures the screenshot when a component fails to execute. If True, the screen is captured. If False, the screen is not captured. The component captures the screens of all windows that are open at that point in time.	No. Connecting the port is optional.	To view the screenshot, do the following actions: On the Design tab, click Attach > Remote log. Select the required process job and click Fetch Logs. Click Play log. The Execution log window shows the screenshot.

5. Optional: To test the component, right-click the component bar and then click Run From Here.