# mulesoft RPA Builder - Full Documentation --- product: RPA Builder version: 6.6 --- # Activity Library Explorer > For the full documentation index, see: https://docs.mulesoft.com/llms.txt In the Activity Library Explorer, you can view all the activity templates assigned to your organization. All users in your organization with the privilege **Activity Library Administration** have access to the same Activity Library. ![The Activity Library Explorer window](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer.png) If another user adds an activity, click **Refresh** (![The Refresh button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-refresh.png)) to update the Activity Library Explorer and see the changes. To view an outline of a workflow, select an activity and click **Show Outline** (![The Show Outline button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-show-outline.png)). To see all revisions of an activity, select the activity and click **Show Log** (![The Show Log button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-show-log.png)). You can create and assign Activity Tags to your activities by clicking **Manage Activity Tags** (![The Manage Activity Tags button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-manage-activity-tags.png)). ## Edit, Copy, and Delete Activities To open the individual editing mode of an activity and make changes to it, select an activity and click **Edit** (![The Edit button](/mulesoft/current/en-us/rpa-builder/6.6/_images/edit-icon.png)). To make a copy of an activity, select it and click **Copy** (![The Copy button](/mulesoft/current/en-us/rpa-builder/6.6/_images/copy-icon.png)) **Copy**. By default, this process copies all information such as name, description, and activity tags. During the upload, the Activity Library prefixes the activity name with _Copy of_. You can edit this information later, if required. To delete an activity, select it and click **Delete from Library** (![The Delete from Library button](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon-alt.png)) **Delete from Library**. ## Import and Export Activities The Activity Library enables you to export activities to a package file `(.calw)` and import these activity package files into the Activity Library. To export an Activity Library Workflow from the Activity Library to your file system as a `(.calw)` package file, click **Export**(![The Export button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-export.png)). When you export Activity Library workflows to a file, RPA Builder removes passwords and all sensitive information stored in wizards of Action Steps, User Account Variables, and Activity Parameters (for example, secrets in OAuthCredentials or AWS Credentials) to prevent this information from being shared. To import an Activity Library Workflow package `(.calw)` file from your file system to the Activity Library, click **Import** (![The Import button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-import.png)). ## See Also - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/6.6/activity-library) - [Activity Tags](https://docs.mulesoft.com/rpa-builder/6.6/activity-tags) - [RPA Manager: Upcoming Process Changes](https://docs.mulesoft.com/rpa-manager/processoperations-upcomingprocesschanges) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Activity Library Explorer > For the full documentation index, see: https://docs.mulesoft.com/llms.txt In the Activity Library Explorer, you can view all the activity templates assigned to your organization. All users in your organization with the privilege **Activity Library Administration** have access to the same Activity Library. ![The Activity Library Explorer window](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer.png) If another user adds an activity, click **Refresh** (![The Refresh button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-refresh.png)) to update the Activity Library Explorer and see the changes. To view an outline of a workflow, select an activity and click **Show Outline** (![The Show Outline button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-show-outline.png)). To see all revisions of an activity, select the activity and click **Show Log** (![The Show Log button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-show-log.png)). You can create and assign Activity Tags to your activities by clicking **Manage Activity Tags** (![The Manage Activity Tags button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-manage-activity-tags.png)). ## Edit, Copy, and Delete Activities To open the individual editing mode of an activity and make changes to it, select an activity and click **Edit** (![The Edit button](/mulesoft/current/en-us/rpa-builder/latest/_images/edit-icon.png)). To make a copy of an activity, select it and click **Copy** (![The Copy button](/mulesoft/current/en-us/rpa-builder/latest/_images/copy-icon.png)) **Copy**. By default, this process copies all information such as name, description, and activity tags. During the upload, the Activity Library prefixes the activity name with _Copy of_. You can edit this information later, if required. To delete an activity, select it and click **Delete from Library** (![The Delete from Library button](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon-alt.png)) **Delete from Library**. ## Import and Export Activities The Activity Library enables you to export activities to a package file `(.calw)` and import these activity package files into the Activity Library. To export an Activity Library Workflow from the Activity Library to your file system as a `(.calw)` package file, click **Export**(![The Export button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-export.png)). When you export Activity Library workflows to a file, RPA Builder removes passwords and all sensitive information stored in wizards of action steps, User Account Variables, and Activity Parameters (for example, secrets in OAuthCredentials or AWS Credentials) to prevent this information from being shared. To import an Activity Library Workflow package `(.calw)` file from your file system to the Activity Library, click **Import** (![The Import button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-import.png)). ## See Also - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/latest/activity-library) - [Activity Tags](https://docs.mulesoft.com/rpa-builder/latest/activity-tags) - [RPA Manager: Upcoming Process Changes](https://docs.mulesoft.com/rpa-manager/processoperations-upcomingprocesschanges) --- product: RPA Builder version: 6.6 --- # Activity Parameters > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Action Step _Activity Parameters_ enables you to map variables that you can use not only in the Workflow, but also in the activities of the business process and gateways. This allows the Activity Parameters to be exchanged among the different elements. For example, the BPMN gateway uses the Activity Parameters to decide which activity should be executed next. ![The Activity Parameters Action Step](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-activity-parameters.png) A Workflow can have one _Activity Parameters_ Action Step and it’s automatically placed in the _Workflow Initialization_ section when creating a new Workflow. Activity Parameters consist of a name, description, and value. Activity parameter names have the following requirements: - The name consists of a combination of letters, numbers, and underscores. - The name contains no special characters or spaces. - The initial letter of the name is lower case. - The name is unique. You can’t use the same name multiple times for different variables. The predefined values are test values that RPA Builder uses only during a local run. The variables register automatically on RPA Manager when uploaded. RPA Manager enables you to modify the values of the variables and define them differently, depending on the station on which the Workflow is executed. See [Using Variables](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-variables) for additional information. The test values might change in the course of the business process due to the possible assignment of new values. If the business process starts again, the values reset to their initial state. ## Defining Activity Parameters To define the Activity Parameters: 1. In the BPMN editor, click the **Business Process Initialization** (![The Business Process Initialization button](/mulesoft/current/en-us/rpa-builder/6.6/_images/business-process-initialization-icon.png)) button. 2. Click **Activity Parameters**. ![The Activity Parameters config window](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-activity-parameters-config.png) 3. In the Business Process Initialization window, click (![The Add icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-icon.png) **Add New Parameter …​**). ![The Business Process Initialization window](/mulesoft/current/en-us/rpa-builder/6.6/_images/business-process-initialization-window.png) 4. Select the Activity Parameter to add from the list. ![The list of available activity parameters to add](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-new-parameters.png) The following data types are available: - Texts (**alphanumeric**) - Integers (**integer**) - Floating point values (**floating-point**) - Boolean values (**boolean**) - Lists (**array**) - Log-in data (**user account**) - Screen coordinates (**coordinates**) - Browser Session ID (**Web Session ID**) - AWS log-in data (**AWS Credentials**) - OAuth credentials (**OAuth Credentials**) - Execution ID (**IDP Execution ID**) - Connected App Credentials (**Connected App Credentials**) 5. Define the **Name**, **Description**, and **Variable Value** for the Activity Parameter. 6. Repeat the process for every Activity Parameter you want to add. 7. Click **OK**. ## Deleting Activity Parameters To delete an Activity Parameter, click the **Delete** (![The Delete icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon.png)) button next to the Activity Parameter you want to delete. ![The business process initialization window](/mulesoft/current/en-us/rpa-builder/6.6/_images/business-process-initialization-window.png) You can delete an Activity Parameter if it’s not being used in a Workflow. If the Activity Parameter is connected to at least one Workflow, a pop-up message indicates that the parameter is still in use. ![A warning message showing that a parameter cannot be deleted because it is still in use](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-activity-parameter-warning.png) All the Workflows in which the Activity Parameter is used are displayed. To delete the Activity Parameter, you must remove the connections in all Workflows. ## Changing the Name of an Activity Parameter Activity Parameter names cannot be changed after creation. After you close the Wizard by clicking **OK**, the **Name** field remains grayed out and you can no longer change the name. You can still edit the fields _Description_ and _Value_ at any time. If you want to subsequently change the name, delete the Activity Parameter and create it again with a new name. This only applies if the Activity Parameter isn’t already being used in a process. ## Connecting Activity Parameters to a Workflow To connect an Activity Parameter with a Workflow: 1. Click the **Edit Variable Mappings** (![The Edit Variable Mappings button](/mulesoft/current/en-us/rpa-builder/6.6/_images/pin-icon.png)) button next to the Action Step for which you want to connect an Activity Parameter. ![The Activity Workflow window](/mulesoft/current/en-us/rpa-home/_images/activity-workflow-ocr.png) 2. Select the Activity Parameter you want to connect. ![The Edit Variable Mappings window showing Activity Parameters](/mulesoft/current/en-us/rpa-builder/6.6/_images/connect-activity-parameters.png) The Wizard lists all Activity Parameters and you can connect them to the Workflows that support the available parameter types. ## Connecting Activity Parameters to a Gateway To connect an Activity Parameter to a Gateway: 1. In the BPMN editor, click any **Gateway** element in your model. 2. In the menu that opens, click the **Set Condition Expression** (![The Set Condition Expression button](/mulesoft/current/en-us/rpa-builder/6.6/_images/cogs-icon.png)) button. ![The BPMN editor showing the Gateway settings](/mulesoft/current/en-us/rpa-builder/6.6/_images/set-expression-condition.png) 3. In the Wizard that opens, click **Build Expression**. ![The Set Condition Expression for Gateway window](/mulesoft/current/en-us/rpa-builder/6.6/_images/set-expression-condition-for-gateway.png) 4. Click **Add Expression** and build an expression by using the available Activity Parameters. After you add all necessary condition expressions, ensure that the last sequence flow has an empty condition expression. This is the default flow when all other conditions aren’t fulfilled. If there is no default sequence flow, add one to the model. ## Properties - **Misc** - **Write Variables to Log File / Run Protocol** If this option is enabled, the variable names and their values are written to the log file and the run protocol. For security reasons, passwords are not shown in the user account data. Simply leave this option disabled if the variables or their values contain confidential data. ## Inbound Variables The Action Step _Activity Parameters_ does not have any inbound variables. ## Outbound Variables The Action Step _Activity Parameters_ does not have any outbound variables. ## Wizard ![The Activity Parameters Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-parameters-wizard.png) Click to select the desired parameters from the _Available Parameters_ column. You can use the arrows to drag them into the _Used in this Workflow_ column and thereby insert them into the Workflow. For more information about the **Write Variables to Log File /Run Protocol** option, see [Properties](#properties). ## Handling Inconsistencies When Importing a Workflow Importing a Workflow with Activity Parameters, for example from the Activity Library, into an existing project can cause inconsistencies. For example, if: - the Activity Parameters referenced in the Workflow do not exist in the project - the imported Activity Parameters have the same names as Activity Parameters already existing in the project that have a different data type In such cases, RPA Builder notifies these inconsistencies by showing a dialog. ![The Inconsistent Activity Parameters dialog](/mulesoft/current/en-us/rpa-builder/6.6/_images/inconsistent-activity-parameters.png) The dialog shows you all the affected Activity Parameters and suggests a suitable action (_Suggested Auto-Correction_). Either missing Activity Parameters are added or, if Activity Parameters have the same name but a different data type, deleted. You can accept the suggestions by clicking on _Proceed_. Click on _Remove Parameters from Workflow_ to remove all the Activity Parameters of the imported Workflow. Clicking on _Cancel_ cancels the import of the Workflow. ## See Also - [Using Variables](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-variables) - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/6.6/activity-library) - [Global Variables for Initializing Activity Parameters](https://docs.mulesoft.com/rpa-manager/processautomation-prepare-deployment-variable) in the RPA Manager documentation - [Credentials for Initializing Activity Parameters](https://docs.mulesoft.com/rpa-manager/processautomation-prepare-deployment-credential) in the RPA Manager documentation --- product: RPA Builder version: 6.7 is-latest-version: true --- # Activity Parameters > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The action step _Activity Parameters_ enables you to map variables that you can use not only in the Workflow, but also in the activities of the business process and gateways. This allows the Activity Parameters to be exchanged among the different elements. For example, the BPMN gateway uses the Activity Parameters to decide which activity should be executed next. ![The Activity Parameters action step](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-activity-parameters.png) A Workflow can have one _Activity Parameters_ action step and it’s automatically placed in the _Workflow Initialization_ section when creating a new Workflow. Activity Parameters consist of a name, description, and value. Activity parameter names have the following requirements: - The name consists of a combination of letters, numbers, and underscores. - The name contains no special characters or spaces. - The initial letter of the name is lower case. - The name is unique. You can’t use the same name multiple times for different variables. The predefined values are test values that RPA Builder uses only during a local run. The variables register automatically on RPA Manager when uploaded. RPA Manager enables you to modify the values of the variables and define them differently, depending on the station on which the Workflow is executed. See [Using Variables](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-variables) for additional information. The test values might change in the course of the business process due to the possible assignment of new values. If the business process starts again, the values reset to their initial state. ## Defining Activity Parameters To define the Activity Parameters: 1. In the BPMN editor, click the **Business Process Initialization** (![The Business Process Initialization button](/mulesoft/current/en-us/rpa-builder/latest/_images/business-process-initialization-icon.png)) button. 2. Click **Activity Parameters**. ![The Activity Parameters config window](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-activity-parameters-config.png) 3. In the Business Process Initialization window, click (![The Add icon](/mulesoft/current/en-us/rpa-builder/latest/_images/add-icon.png) **Add New Parameter …​**). ![The Business Process Initialization window](/mulesoft/current/en-us/rpa-builder/latest/_images/business-process-initialization-window.png) 4. Select the Activity Parameter to add from the list. ![The list of available activity parameters to add.](/mulesoft/current/en-us/rpa-builder/latest/_images/add-new-parameters.png) The following data types are available: - Texts (**alphanumeric**) - Integers (**integer**) - Floating point values (**floating-point**) - Boolean values (**boolean**) - Lists (**array**) - Log-in data (**user account**) - Screen coordinates (**coordinates**) - Browser Session ID (**Web Session ID**) - AWS log-in data (**AWS Credentials**) - OAuth credentials (**OAuth Credentials**) - Execution ID (**IDP Execution ID**) - Connected App Credentials (**Connected App Credentials**) - Google API Service Account Credentials (**Google API Service Account Credentials**) 5. Define the **Name**, **Description**, and **Variable Value** for the Activity Parameter. 6. Repeat the process for every Activity Parameter you want to add. 7. Click **OK**. ## Deleting Activity Parameters To delete an Activity Parameter, click the **Delete** (![The Delete icon](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon.png)) button next to the Activity Parameter you want to delete. ![The business process initialization window](/mulesoft/current/en-us/rpa-builder/latest/_images/business-process-initialization-window.png) You can delete an Activity Parameter if it’s not being used in a Workflow. If the Activity Parameter is connected to at least one Workflow, a pop-up message indicates that the parameter is still in use. ![A warning message showing that a parameter cannot be deleted because it is still in use](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-activity-parameter-warning.png) All the Workflows in which the Activity Parameter is used are displayed. To delete the Activity Parameter, you must remove the connections in all Workflows. ## Changing the Name of an Activity Parameter Activity Parameter names cannot be changed after creation. After you close the Wizard by clicking **OK**, the **Name** field remains grayed out and you can no longer change the name. You can still edit the fields _Description_ and _Value_ at any time. If you want to subsequently change the name, delete the Activity Parameter and create it again with a new name. This only applies if the Activity Parameter isn’t already being used in a process. ## Connecting Activity Parameters to a Workflow To connect an Activity Parameter with a Workflow: 1. Click the **Edit Variable Mappings** (![The Edit Variable Mappings button](/mulesoft/current/en-us/rpa-builder/latest/_images/pin-icon.png)) button next to the action step for which you want to connect an Activity Parameter. ![The Activity Workflow window](/mulesoft/current/en-us/rpa-home/_images/activity-workflow-ocr.png) 2. Select the Activity Parameter you want to connect. ![The Edit Variable Mappings window showing Activity Parameters](/mulesoft/current/en-us/rpa-builder/latest/_images/connect-activity-parameters.png) The Wizard lists all Activity Parameters and you can connect them to the Workflows that support the available parameter types. ## Connecting Activity Parameters to a Gateway To connect an Activity Parameter to a Gateway: 1. In the BPMN editor, click any **Gateway** element in your model. 2. In the menu that opens, click the **Set Condition Expression** (![The Set Condition Expression button](/mulesoft/current/en-us/rpa-builder/latest/_images/cogs-icon.png)) button. ![The BPMN editor showing the Gateway settings](/mulesoft/current/en-us/rpa-builder/latest/_images/set-expression-condition.png) 3. In the Wizard that opens, click **Build Expression**. ![The Set Condition Expression for Gateway window](/mulesoft/current/en-us/rpa-builder/latest/_images/set-expression-condition-for-gateway.png) 4. Click **Add Expression** and build an expression by using the available Activity Parameters. After you add all necessary condition expressions, ensure that the last sequence flow has an empty condition expression. This is the default flow when all other conditions aren’t fulfilled. If there is no default sequence flow, add one to the model. ## Properties - **Misc** - **Write Variables to Log File / Run Protocol** If this option is enabled, the variable names and their values are written to the log file and the run protocol. For security reasons, passwords are not shown in the user account data. Simply leave this option disabled if the variables or their values contain confidential data. ## Inbound Variables The action step _Activity Parameters_ does not have any inbound variables. ## Outbound Variables The action step _Activity Parameters_ does not have any outbound variables. ## Wizard ![The Activity Parameters Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-parameters-wizard.png) Click to select the desired parameters from the _Available Parameters_ column. You can use the arrows to drag them into the _Used in this Workflow_ column and thereby insert them into the Workflow. For more information about the **Write Variables to Log File /Run Protocol** option, see [Properties](#properties). ## Handling Inconsistencies When Importing a Workflow Importing a Workflow with Activity Parameters, for example from the Activity Library, into an existing project can cause inconsistencies. For example, if: - the Activity Parameters referenced in the Workflow do not exist in the project - the imported Activity Parameters have the same names as Activity Parameters already existing in the project that have a different data type In such cases, RPA Builder notifies these inconsistencies by showing a dialog. ![The Inconsistent Activity Parameters dialog](/mulesoft/current/en-us/rpa-builder/latest/_images/inconsistent-activity-parameters.png) The dialog shows you all the affected Activity Parameters and suggests a suitable action (_Suggested Auto-Correction_). Either missing Activity Parameters are added or, if Activity Parameters have the same name but a different data type, deleted. You can accept the suggestions by clicking on _Proceed_. Click on _Remove Parameters from Workflow_ to remove all the Activity Parameters of the imported Workflow. Clicking on _Cancel_ cancels the import of the Workflow. ## See Also - [Using Variables](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-variables) - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/latest/activity-library) - [Global Variables for Initializing Activity Parameters](https://docs.mulesoft.com/rpa-manager/processautomation-prepare-deployment-variable) in the RPA Manager documentation - [Credentials for Initializing Activity Parameters](https://docs.mulesoft.com/rpa-manager/processautomation-prepare-deployment-credential) in the RPA Manager documentation --- product: RPA Builder version: 6.6 --- # Activity Tags > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Activity Tags to categorize the activities in the Activity Library, which enables you to manage the activities, arrange them more efficiently, and subsequently find them more easily using the search function in the Activity Library Explorer. ## Create Activity Tags To create new Activity Tags: 1. In the Activity Library toolbar, click (![The Manage Activity Tags button.](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-manage-activity-tags.png)) **Manage Activity Tags**. 2. Click **Create New Activity Tag**. 3. Provide a descriptive name for the tag and click **OK**. The name of the tag must be unique. > [!WARNING] If you delete tags, they are removed automatically from all assignments. ## Assign an Activity Tag After you create tags, you can assign them to a workflow when you upload the workflow to the Activity Library by using the **Activity Tags** tab. ![The Upload Workflow to Activity Library window showing the Activity Tags tab](/mulesoft/current/en-us/rpa-builder/6.6/_images/upload-workflow-to-activity-library-activity-tags.png) Select an Activity tag and click (![The Add Tag button](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-tag.png)) to add it to the workflow, or click (![The Remove Tag button](/mulesoft/current/en-us/rpa-builder/6.6/_images/remove-tag.png)) to remove the tag from the workflow. Use (![The Add All Tags button](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-all-tags.png)) to add all tags to the workflow or (![The Remove All Tags button](/mulesoft/current/en-us/rpa-builder/6.6/_images/remove-all-tags.png)) to remove all tags from the workflow. ## See Also - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/6.6/activity-library) - [Activity Library Explorer](https://docs.mulesoft.com/rpa-builder/6.6/activity-library-explorer) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Activity Tags > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Activity Tags to categorize the activities in the Activity Library, which enables you to manage the activities, arrange them more efficiently, and subsequently find them more easily using the search function in the Activity Library Explorer. ## Create Activity Tags To create new Activity Tags: 1. In the Activity Library toolbar, click (![The Manage Activity Tags button.](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-manage-activity-tags.png)) **Manage Activity Tags**. 2. Click **Create New Activity Tag**. 3. Provide a descriptive name for the tag and click **OK**. The name of the tag must be unique. > [!WARNING] If you delete tags, they are removed automatically from all assignments. ## Assign an Activity Tag After you create tags, you can assign them to a workflow when you upload the workflow to the Activity Library by using the **Activity Tags** tab. ![The Upload Workflow to Activity Library window showing the Activity Tags tab](/mulesoft/current/en-us/rpa-builder/latest/_images/upload-workflow-to-activity-library-activity-tags.png) Select an Activity tag and click (![The Add Tag button](/mulesoft/current/en-us/rpa-builder/latest/_images/add-tag.png)) to add it to the workflow, or click (![The Remove Tag button](/mulesoft/current/en-us/rpa-builder/latest/_images/remove-tag.png)) to remove the tag from the workflow. Use (![The Add All Tags button](/mulesoft/current/en-us/rpa-builder/latest/_images/add-all-tags.png)) to add all tags to the workflow or (![The Remove All Tags button](/mulesoft/current/en-us/rpa-builder/latest/_images/remove-all-tags.png)) to remove all tags from the workflow. ## See Also - [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/latest/activity-library) - [Activity Library Explorer](https://docs.mulesoft.com/rpa-builder/latest/activity-library-explorer) --- product: RPA Builder version: 6.6 --- # AI OCR (screen-based) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _AI OCR (screen-based)_ Action Step is a further development of the existing OCR Action Steps. In contrast to the other OCR Action Steps, it is based on concepts of neural networks. The available languages, therefore, are based on trained patterns that take account of the characteristics of the relevant language. In many cases, therefore, the correct recognition of texts that are, for example, barely legible or have little contrast or an unusual font, is improved with this Action Step. In contrast to the AI OCR (file-based) Action Step, which works with existing images, e.g. from document scans, the _AI OCR (screen-based)_ Action Step works _with_ screenshots of the currently active desktop_._ This means, it attempts to extract texts from a previously created screen copy. You should consider the Intelligent OCR 2020 Action Step if more than one language is to be recognized at once or if you wish to use your own dictionary. ## Properties **OCR Image Preprocessing** See also [Properties](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition-ai-ocr-file-based#Properties) in the Chapter entitled **AI OCR (File-based)**. ## Inbound Variables **Scan Area relative to** (Coordinates) The defined Search Area is moved relative to these coordinates. The resulting result coordinates are then absolute and are with reference to the left screen corner. This variable can only be mapped in the wizard. ## Outbound Variables **IsSucceeded** (Boolean) Shows whether text recognition has been carried out successfully or not. ## Wizard You can use **OCR Image Preprocessing** to improve the quality of the image so that the OCR operation can run optimally. This is always carried out in the specified sequence. Here, you can also switch the individual steps on or off. First, a screenshot is made of the currently active desktop. Using **Initial wait time**, you can delay this operation. This can be very useful if the image takes time to form, e.g. due to animations. You can find further explanations in [Properties](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition-ai-ocr-file-based#Properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # AI OCR (screen-based) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _AI OCR (screen-based)_ action step is a further development of the existing OCR action steps. In contrast to the other OCR action steps, it is based on concepts of neural networks. The available languages, therefore, are based on trained patterns that take account of the characteristics of the relevant language. In many cases, therefore, the correct recognition of texts that are, for example, barely legible or have little contrast or an unusual font, is improved with this Action Step. In contrast to the AI OCR (file-based) action step, which works with existing images, e.g. from document scans, the _AI OCR (screen-based)_ action step works _with_ screenshots of the currently active desktop_._ This means, it attempts to extract texts from a previously created screen copy. You should consider the Intelligent OCR 2020 action step if more than one language is to be recognized at once or if you wish to use your own dictionary. ## Properties **OCR Image Preprocessing** See also [Properties](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition-ai-ocr-file-based#Properties) in the Chapter entitled **AI OCR (File-based)**. ## Inbound Variables **Scan Area relative to** (Coordinates) The defined Search Area is moved relative to these coordinates. The resulting result coordinates are then absolute and are with reference to the left screen corner. This variable can only be mapped in the wizard. ## Outbound Variables **IsSucceeded** (Boolean) Shows whether text recognition has been carried out successfully or not. ## Wizard You can use **OCR Image Preprocessing** to improve the quality of the image so that the OCR operation can run optimally. This is always carried out in the specified sequence. Here, you can also switch the individual steps on or off. First, a screenshot is made of the currently active desktop. Using **Initial wait time**, you can delay this operation. This can be very useful if the image takes time to form, e.g. due to animations. You can find further explanations in [Properties](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition-ai-ocr-file-based#Properties). --- product: RPA Builder version: 6.6 --- # Analyzing Problems with Analysis Packages > For the full documentation index, see: https://docs.mulesoft.com/llms.txt After a business process runs locally in RPA Builder, you can upload it to RPA Manager, move it to the test phase, run it on an RPA Bot, and start a long-term test. Run tests for at least three days before using the business process productively. If menu runs contain errors, RPA Manager generates Analysis Packages that you can download. The Analysis Package provides detailed information on the run in the same format as if you had executed the Workflow locally. Use this information to fix any errors. Elements, which have caused an error or a warning, are marked with an expandable red or yellow frame. This frame contains more detailed information concerning the run results. Use the Analysis Packages to understand and fix errors for each failed Workflow run. If you see the same error repeatedly, fix the error once and start collecting results again. ## Download and Analysis Package To download an Analysis Package for a Workflow that throws an error: 1. In RPA Manager, open the **Process Management** module. 2. Open the process for which you want to download the Analysis Package. 3. Start a test and wait a few minutes for the test to complete. If you don’t have any test plans available, click **Create new test plan** and follow the instructions to create one. 4. Click **Update** to refresh the test run results. 5. Click the result number in the **Failure** column. ![The Test Results window showing a Failure](/mulesoft/current/en-us/rpa-builder/6.6/_images/test-plan-error.png) If there are no errors, the **Failure** column shows `0` results and there’s no Analysis Package available to download. 6. Click the **Download** button. ![The Process Run Results Window and the Download Analysis Package button](/mulesoft/current/en-us/rpa-builder/6.6/_images/download-analysis-package.png) ## Load and Analysis Package To load an Analysis Package: 1. In RPA Builder, open any Workflow to make the Workbench menu appear. 2. In the Workbench menu, click **Tools**. 3. Click **Load Analysis Package** and select the location of the Analysis Package file. ![The Workbench Tools Menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/workbench-tools-menu.png) ## Analysis Package Directory After you start the workflow locally for the first time, either with the **Run Workflow** button or by pressing _F7_, RPA Builder creates the `custom` directory. The path to the `custom` directory is: `C:\Users\[UserName]\Documents\MuleSoft\Cache\[Process-GUID]\[Activity- GUID]\Robot\custom\`. Right-click on the Workflow tab and select **Open Workflow Location** to open the `C:\Users\[UserName]\Documents\MuleSoft\Cache\[Process-GUID]\[Activity- GUID]\` folder. You can add extra data like screenshots or log files to the Analysis Package by saving them to the project’s `custom` folder. RPA Manager packs all files from this folder into the Analysis Package in case of an error. Note that when an RPA Bot executes the Workflow, it saves the Analysis Package on the machine on which the bot is running. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/6.6/running-workflows-and-using-workflow-run-results) - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/6.6/using-workflow-debugger) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Analyzing Problems with Analysis Packages > For the full documentation index, see: https://docs.mulesoft.com/llms.txt After a business process runs locally in RPA Builder, you can upload it to RPA Manager, move it to the test phase, run it on an RPA Bot, and start a long-term test. Run tests for at least three days before using the business process productively. If menu runs contain errors, RPA Manager generates Analysis Packages that you can download. The Analysis Package provides detailed information on the run in the same format as if you had executed the Workflow locally. Use this information to fix any errors. Elements, which have caused an error or a warning, are marked with an expandable red or yellow frame. This frame contains more detailed information concerning the run results. Use the Analysis Packages to understand and fix errors for each failed Workflow run. If you see the same error repeatedly, fix the error once and start collecting results again. ## Download and Analysis Package To download an Analysis Package for a Workflow that throws an error: 1. In RPA Manager, open the **Process Management** module. 2. Open the process for which you want to download the Analysis Package. 3. Start a test and wait a few minutes for the test to complete. If you don’t have any test plans available, click **Create new test plan** and follow the instructions to create one. 4. Click **Update** to refresh the test run results. 5. Click the result number in the **Failure** column. ![The Test Results window showing a Failure](/mulesoft/current/en-us/rpa-builder/latest/_images/test-plan-error.png) If there are no errors, the **Failure** column shows `0` results and there’s no Analysis Package available to download. 6. Click the **Download** button. ![The Process Run Results Window and the Download Analysis Package button](/mulesoft/current/en-us/rpa-builder/latest/_images/download-analysis-package.png) ## Load and Analysis Package To load an Analysis Package: 1. In RPA Builder, open any Workflow to make the Workbench menu appear. 2. In the Workbench menu, click **Tools**. 3. Click **Load Analysis Package** and select the location of the Analysis Package file. ![The Workbench Tools Menu](/mulesoft/current/en-us/rpa-builder/latest/_images/workbench-tools-menu.png) ## Analysis Package Directory After you start the workflow locally for the first time, either with the **Run Workflow** button or by pressing _F7_, RPA Builder creates the `custom` directory. The path to the `custom` directory is: `C:\Users\[UserName]\Documents\MuleSoft\Cache\[Process-GUID]\[Activity- GUID]\Robot\custom\`. Right-click on the Workflow tab and select **Open Workflow Location** to open the `C:\Users\[UserName]\Documents\MuleSoft\Cache\[Process-GUID]\[Activity- GUID]\` folder. You can add extra data like screenshots or log files to the Analysis Package by saving them to the project’s `custom` folder. RPA Manager packs all files from this folder into the Analysis Package in case of an error. Note that when an RPA Bot executes the Workflow, it saves the Analysis Package on the machine on which the bot is running. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/latest/running-workflows-and-using-workflow-run-results) - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/latest/using-workflow-debugger) --- product: RPA Builder version: 6.6 --- # App Automation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt App Automation lets you address elements directly through their XPaths. The appearance and coordinates are not relevant, in contrast to the Mouse Action and Pattern Search Action Steps. The advantage of this approach is that App Automation works even if the position or design of the target application changes on the desktop. In addition, App Automation makes it easier to create workflows, by recording clicks and keyboard inputs to generate Action Steps automatically. ## Generating Action Steps There are two ways to generate Action Steps automatically. - **RPA Manager** During the design phase on RPA Manager, you can record a process with a sequence of clicks and keyboard inputs by using RPA Recorder, which is available for download in the RPA Manager UI (for more information, see [RPA Manager Overview](https://docs.mulesoft.com/rpa-manager/)). After you finish the recording, you can upload it to RPA Manager, together with the generated process, and move the process to the Build phase. You can then download and open the process in RPA Builder. All the recorded information for generating the Action Steps automatically is now available. - **RPA Builder** If the _App Session_ does not contain any elements yet, use the wizard to start a local recording, which you can then use to generate App Automation Action Steps automatically. After you click **Start Recording** in the wizard of the App Session and complete the recording, click **Finish**. Click **OK & generate** in RPA Builder to generate the Action Steps, which are added to the App Session automatically. ## Example The following example calls Microsoft Excel, opens a new Excel workbook, and inserts text in the first row. The example shows the corresponding clicks and keyboard inputs, together with an example of a filled wizard for a **Click App Element** Action Step: ![Example](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-app-automation-image1.png) You can now edit the generated workflow, for example, adding additional Action Steps or renaming existing ones. The red highlighting in the wizard preview immediately shows you where the click was executed. ## Supported Applications The following types of applications are supported: - Win32 - Windows Forms - WPF - UWP ## Common Properties (App Automation) The _App Automation_ Action Steps also contain the _common properties_ of the other Action Steps. See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. The following are properties common to all _App Automation_ Action Steps: - **Identify Element** The wizard contains the _Identify Element_ button in all Action Steps of the App Automation. This button sets the wizard to _a Capture Mode,_ which lets you hover the mouse over a certain element and capture it by pressing _F2_. When you hover the mouse over an element and press _F2_, the following happens: - A frame is drawn around the element. - The Element XPath and Window Title are filled with the values of the selected element. - The preview shows a screen shot with the selected element. The element is marked with red crosshairs. - If the selected element does not match the Action Step, a warning is displayed below the preview. This is the case, for example, if an element that does not support text entry is selected in a _Set Text to App Element_ Action Step. In this case, the frame is displayed in red instead of green. - **Element _XPath_** XPath is short for XML path language and is used to identify and address elements. Use the _Identify Element_ to read the XPath or specify it manually. - **Window Title** The name of the window to use. - **Use Regular Expression (Regex)** When you select this option, the Window Title is interpreted as a Regex expression. - **Preview** You see a preview of the selected element here. It only appears if the element was selected using _Identify Element_ or the if Action Step was generated automatically. --- product: RPA Builder version: 6.7 is-latest-version: true --- # App Automation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt App Automation lets you address elements directly through their XPaths. The appearance and coordinates are not relevant, in contrast to the Mouse Action and Pattern Search action steps. The advantage of this approach is that App Automation works even if the position or design of the target application changes on the desktop. In addition, App Automation makes it easier to create workflows, by recording clicks and keyboard inputs to generate action steps automatically. ## Generating Action Steps There are two ways to generate action steps automatically. - **RPA Manager** During the design phase on RPA Manager, you can record a process with a sequence of clicks and keyboard inputs by using RPA Recorder, which is available for download in the RPA Manager UI (for more information, see [RPA Manager Overview](https://docs.mulesoft.com/rpa-manager/)). After you finish the recording, you can upload it to RPA Manager, together with the generated process, and move the process to the Build phase. You can then download and open the process in RPA Builder. All the recorded information for generating the action steps automatically is now available. - **RPA Builder** If the _App Session_ does not contain any elements yet, use the wizard to start a local recording, which you can then use to generate App Automation action steps automatically. After you click **Start Recording** in the wizard of the App Session and complete the recording, click **Finish**. Click **OK & generate** in RPA Builder to generate the action steps, which are added to the App Session automatically. ## Example The following example calls Microsoft Excel, opens a new Excel workbook, and inserts text in the first row. The example shows the corresponding clicks and keyboard inputs, together with an example of a filled wizard for a **Click App Element** action step: ![Example](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-app-automation-image1.png) You can now edit the generated workflow, for example, adding additional action steps or renaming existing ones. The red highlighting in the wizard preview immediately shows you where the click was executed. ## Supported Applications The following types of applications are supported: - Win32 - Windows Forms - WPF - UWP ## Common Properties (App Automation) The _App Automation_ action steps also contain the _common properties_ of the other action steps. See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. The following are properties common to all _App Automation_ action steps: - **Identify Element** The wizard contains the _Identify Element_ button in all action steps of the App Automation. This button sets the wizard to _a Capture Mode,_ which lets you hover the mouse over a certain element and capture it by pressing _F2_. When you hover the mouse over an element and press _F2_, the following happens: - A frame is drawn around the element. - The Element XPath and Window Title are filled with the values of the selected element. - The preview shows a screen shot with the selected element. The element is marked with red crosshairs. - If the selected element does not match the action step, a warning is displayed below the preview. This is the case, for example, if an element that does not support text entry is selected in a _Set Text to App Element_ action step. In this case, the frame is displayed in red instead of green. - **Element _XPath_** XPath is short for XML path language and is used to identify and address elements. Use the _Identify Element_ to read the XPath or specify it manually. - **Window Title** The name of the window to use. - **Use Regular Expression (Regex)** When you select this option, the Window Title is interpreted as a Regex expression. - **Preview** You see a preview of the selected element here. It only appears if the element was selected using _Identify Element_ or the if action step was generated automatically. --- product: RPA Builder version: 6.6 --- # App Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _App Session_ Action Step is, similar to the Excel Session, an inclusive element for all App Automation Action Steps. These steps can only be placed within the App Session. All other Action Steps can also be inserted in the App Session. Please note that an App Session **cannot** be added to another App Session. ## Properties - **Keep out mouse** The mouse stays in the position specified in the _Move mouse to_ property, to avoid triggering hover effects inadvertently. - **Move mouse to** Specifies the position where to keep the mouse when _Keep out Mouse_ is active. All four corners are available. - **Repeat keep mouse out** Repeats the _Keep out mouse_ property before every step in the App Session. Note here that some Action Steps move the mouse for execution (such as click element with _Left Click_). ## Inbound Variables The _App Session_ does not have any inbound variables. ## Outbound Variables The _App Session_ does not have any outbound variables. ## Wizard **Start Recording** Enables you to record a single App Session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the App Session doesn’t contain any elements yet. To record an App Session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![App Session Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/app-session-wizard.png) 2. Click **Start Recording** to capture all actions, such as mouse movements and keystrokes. ![Start recording](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-recorder-start-recording.png) 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional App Sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review app session recording](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-recorder-review-app-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate Action Steps, which are added to the App Session automatically. --- product: RPA Builder version: 6.7 is-latest-version: true --- # App Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _App Session_ action step is, similar to the Excel Session, an inclusive element for all App Automation action steps. These steps can only be placed within the App Session. All other action steps can also be inserted in the App Session. Please note that an App Session **cannot** be added to another App Session. ## Properties - **Keep out mouse** The mouse stays in the position specified in the _Move mouse to_ property, to avoid triggering hover effects inadvertently. - **Move mouse to** Specifies the position where to keep the mouse when _Keep out Mouse_ is active. All four corners are available. - **Repeat keep mouse out** Repeats the _Keep out mouse_ property before every step in the App Session. Note here that some action steps move the mouse for execution (such as click element with _Left Click_). ## Inbound Variables The _App Session_ does not have any inbound variables. ## Outbound Variables The _App Session_ does not have any outbound variables. ## Wizard **Start Recording** Enables you to record a single App Session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the App Session doesn’t contain any elements yet. To record an App Session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![App Session Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/app-session-wizard.png) 2. Click **Start Recording** to capture all actions, such as mouse movements and keystrokes. ![Start recording](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-recorder-start-recording.png) 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional App Sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review app session recording](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-recorder-review-app-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate action steps, which are added to the App Session automatically. --- product: RPA Builder version: 6.6 --- # Append to Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this Action Step to append a value to an existing array variable. ## Properties The Append to Array Action Step contains the [common properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) **Description**, **Error Handling**, and **Name**. ## Inbound Variables - **Array to be extended** The base array to extend. - **Array to append** The array to append to the base array. Use the wizard to specify a single value, or an array of values, or to map a variable. When manually defining the array elements, use the comma (`,`) to separate the values. If you define strings that contain commas, enclose the strings with quotes (`"`). For example, `"Hello, this is a single value", This is another value, testValue`. ## Outbound Variables - **New Array Count** Outputs the total number of elements in the base array after appending the data. - **Appended Element Count** Outputs the number of elements appended to the base array. ## See Also - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-array-variable) - [String to Array](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-string-to-array) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Append to Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to append a value to an existing array variable. ## Properties The Append to Array action step contains the [common properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) **Description**, **Error Handling**, and **Name**. ## Inbound Variables - **Array to be extended** The base array to extend. - **Array to append** The array to append to the base array. Use the wizard to specify a single value, or an array of values, or to map a variable. When manually defining the array elements, use the comma (`,`) to separate the values. If you define strings that contain commas, enclose the strings with quotes (`"`). For example, `"Hello, this is a single value", This is another value, testValue`. ## Outbound Variables - **New Array Count** Outputs the total number of elements in the base array after appending the data. - **Appended Element Count** Outputs the number of elements appended to the base array. ## See Also - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-array-variable) - [String to Array](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-string-to-array) --- product: RPA Builder version: 6.6 --- # Break Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt There are cases where you need to exit the _Loop Control Block_ before all iterations have been executed. _Break Loop_ should be used for this purpose. Using _Break Loop_ only makes sense in combination with a _Managed Control Block_, because otherwise it would be executed during the first iteration of a _Loop Control Block_, thus defeating the object of having a loop. ## Properties - **Exit Mode** Determines how the loop reacts _after_ using a _Break Loop_, i.e. with or without error --- product: RPA Builder version: 6.7 is-latest-version: true --- # Break Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt There are cases where you need to exit the _Loop Control Block_ before all iterations have been executed. _Break Loop_ should be used for this purpose. Using _Break Loop_ only makes sense in combination with a _Managed Control Block_, because otherwise it would be executed during the first iteration of a _Loop Control Block_, thus defeating the object of having a loop. ## Properties - **Exit Mode** Determines how the loop reacts _after_ using a _Break Loop_, i.e. with or without error --- product: RPA Builder version: 6.6 --- # Building JSONPath Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt JSONPath expressions navigate through a JSON structure in a similar way that XPath expressions reference parts of an XML document. To simplify the process of creating JSONPath expressions, use the JSONPath Expression Builder included in RPA Builder. Open this tool by clicking (![2.5%](/mulesoft/current/en-us/rpa-builder/6.6/_images/jsonpath-expression-builder-button.png)) in the top menu bar or inside Action Steps that support JSONPath expressions (JSON Query, REST Call, and AWS Action Steps). Opening the JSONPath Expression Builder from the top menu bar enables you to copy the resulting JSONPath expression for further use, instead of assigning it directly within an Action Step. ## Build an Expression Using the JSONPath Expression Builder To create a JSONPath expression using the JSONPath Expression Builder: 1. Click the **Build JSONPath Expression** (![2.5%](/mulesoft/current/en-us/rpa-builder/6.6/_images/jsonpath-expression-builder-button.png)) button. 2. Click **Import from file** to explore and select a JSON file to open or paste the JSON directly in the textbox. ![The import file window of the JSONPath Expression Builder tool.](/mulesoft/current/en-us/rpa-builder/6.6/_images/jsonpath-expression-builder-import.png) 3. Click **Next**. 4. Click an object in the **JSON** panel to extract the object’s JSONPath Expression. ![The JSONPath Expression Builder tool.](/mulesoft/current/en-us/rpa-builder/6.6/_images/jsonpath-expression-builder.png) After clicking a JSON element, the **Result** panel updates to show what values the expression extracts and the **JSONPath expression** field updates to show the expression built to extract the specified value. 5. Click **Next**. 6. You can set filters for the expression at this point. See [Set Filters for a JSONPath Expression](#set-filters) for details. 7. Click **Apply** to confirm and use the built JSONPath expression in the current action step. Optionally, you can click the **Copy JsonPath expression to clipboard** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/copy-filter-icon.png)) button to copy the expression. For more information about JSONPath, see [XPath for JSON](https://goessner.net/articles/JsonPath/). ## Set Filters for a JSONPath Expression During the last step of creating a JSONPath expression, you can set filters by specifying the conditions before applying the expression created using the builder: ![The JSONPath Expression Builder tool showing the filter screen.](/mulesoft/current/en-us/rpa-builder/6.6/_images/jsonpath-expression-builder-filter.png)
1Click on any array element ([*]) of the resulting expression.
2Select the conditions for the filter.
3Click the Add new filter (2.5%) button.
## See Also - [JSON Online Editor](https://jsoneditoronline.org/) - [JSONPath Evaluator](https://jsonpath.com/) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Building JSONPath Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt JSONPath expressions navigate through a JSON structure in a similar way that XPath expressions reference parts of an XML document. To simplify the process of creating JSONPath expressions, use the JSONPath Expression Builder included in RPA Builder. Open this tool by clicking (![2.5%](/mulesoft/current/en-us/rpa-builder/latest/_images/jsonpath-expression-builder-button.png)) in the top menu bar or inside action steps that support JSONPath expressions (JSON Query, REST Call, and AWS action steps). Opening the JSONPath Expression Builder from the top menu bar enables you to copy the resulting JSONPath expression for further use, instead of assigning it directly within an action step. ## Build an Expression Using the JSONPath Expression Builder To create a JSONPath expression using the JSONPath Expression Builder: 1. Click the **Build JSONPath Expression** (![2.5%](/mulesoft/current/en-us/rpa-builder/latest/_images/jsonpath-expression-builder-button.png)) button. 2. Click **Import from file** to explore and select a JSON file to open or paste the JSON directly in the textbox. ![The import file window of the JSONPath Expression Builder tool.](/mulesoft/current/en-us/rpa-builder/latest/_images/jsonpath-expression-builder-import.png) 3. Click **Next**. 4. Click an object in the **JSON** panel to extract the object’s JSONPath Expression. ![The JSONPath Expression Builder tool.](/mulesoft/current/en-us/rpa-builder/latest/_images/jsonpath-expression-builder.png) After clicking a JSON element, the **Result** panel updates to show what values the expression extracts and the **JSONPath expression** field updates to show the expression built to extract the specified value. 5. Click **Next**. 6. You can set filters for the expression at this point. See [Set Filters for a JSONPath Expression](#set-filters) for details. 7. Click **Apply** to confirm and use the built JSONPath expression in the current action step. Optionally, you can click the **Copy JsonPath expression to clipboard** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/copy-filter-icon.png)) button to copy the expression. For more information about JSONPath, see [XPath for JSON](https://goessner.net/articles/JsonPath/). ## Set Filters for a JSONPath Expression During the last step of creating a JSONPath expression, you can set filters by specifying the conditions before applying the expression created using the builder: ![The JSONPath Expression Builder tool showing the filter screen.](/mulesoft/current/en-us/rpa-builder/latest/_images/jsonpath-expression-builder-filter.png)
1Click on any array element ([*]) of the resulting expression.
2Select the conditions for the filter.
3Click the Add new filter (2.5%) button.
## See Also - [JSON Online Editor](https://jsoneditoronline.org/) - [JSONPath Evaluator](https://jsonpath.com/) --- product: RPA Builder version: 6.6 --- # Changing the Most Important System Parameters with One Setting > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Windows_ has a general performance setting for visual effects that will turn off all settings relating to picture search at the same time. We **strongly recommend** adjusting this setting for all client systems and all systems used to create _Workflow_s. Simply go to System Properties on the tab Advanced. ![System properties window](/mulesoft/current/en-us/rpa-builder/6.6/_images/changing-the-most-important-system-parameters-with-one-setting-image1.png) If not selected, switch to the _Visual Effects_ tab and set the radio button to _Adjust for best performance._ ![Performance options window](/mulesoft/current/en-us/rpa-builder/6.6/_images/changing-the-most-important-system-parameters-with-one-setting-image2.png) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Changing the Most Important System Parameters with One Setting > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Windows_ has a general performance setting for visual effects that will turn off all settings relating to picture search at the same time. We **strongly recommend** adjusting this setting for all client systems and all systems used to create _Workflow_s. Simply go to System Properties on the tab Advanced. ![System properties window](/mulesoft/current/en-us/rpa-builder/latest/_images/changing-the-most-important-system-parameters-with-one-setting-image1.png) If not selected, switch to the _Visual Effects_ tab and set the radio button to _Adjust for best performance._ ![Performance options window](/mulesoft/current/en-us/rpa-builder/latest/_images/changing-the-most-important-system-parameters-with-one-setting-image2.png) --- product: RPA Builder version: 6.6 --- # Check Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to check if a folder exists in the specified directory path. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **Folder Operations Settings** - **Check if the folder** Select between **Exists** or **Not Exists** to determine the type of check to perform. - **Directory Path** Path to the directory to check the existence of the folder. ## Inbound Variables - **Directory Path** ## Outbound Variables - **Directory Path** - **Check Succeeded** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Check Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to check if a folder exists in the specified directory path. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Folder Operations Settings** - **Check if the folder** Select between **Exists** or **Not Exists** to determine the type of check to perform. - **Directory Path** Path to the directory to check the existence of the folder. ## Inbound Variables - **Directory Path** ## Outbound Variables - **Directory Path** - **Check Succeeded** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations) --- product: RPA Builder version: 6.6 --- # Check Process > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ enables you to check if a process is running or not and either kill it or launch another program. ## Properties - **Config Action** - **Action** Action to perform when the check gives a positive result. - **Program to start** The executable file that launches when the _Start Program_ action is chosen. - **Process Settings** - **Check for** Establishes whether to check if the process does or does not exist. - **Process name/PID** Name or process ID of the process to check for as listed in the Task Manager. ## Variables - **Start Process ID** The Process ID of the _Process_ started (only available when _Action_ is set to _Start program_) \*\* Syntax: `PID:[PID]` - **Check State** Returns whether the check was successful or not \*\* Syntax: `[Start program OK:/Start Program Error:/] Process '[Process Name]' [exists/does not exist/existed] [and program '[Path To Program/PID:[PID of Process to start]' [successfully started/was not started]]/[[and was killed]/]` ## Wizard First enter the process to check for in the _Process Name_ field. Either enter the process name or its ID manually in the field, then select the process from the drop-down menu there or navigate to an executable file and select it. Next, select from the _Check for_ drop-down menu whether to check if the process does or does not exist. Choose an action from the _Action_ drop-down menu to perform if the check is successful: - **Do nothing** Performs the check and nothing else. - **Start program** Starts the program defined in the _Program to start_ property. - **Kill process** Kills the process you checked for. Not applicable if the check was for non-existence. Check if applications started by the RPA Bot are still running at the end of a workflow. If so, perform a _Kill process_ action to reset the PC into a clean state for the next run. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Check Process > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step enables you to check if a process is running or not and either kill it or launch another program. ## Properties - **Config Action** - **Action** Action to perform when the check gives a positive result. - **Program to start** The executable file that launches when the _Start Program_ action is chosen. - **Process Settings** - **Check for** Establishes whether to check if the process does or does not exist. - **Process name/PID** Name or process ID of the process to check for as listed in the Task Manager. ## Variables - **Start Process ID** The Process ID of the _Process_ started (only available when _Action_ is set to _Start program_) \*\* Syntax: `PID:[PID]` - **Check State** Returns whether the check was successful or not \*\* Syntax: `[Start program OK:/Start Program Error:/] Process '[Process Name]' [exists/does not exist/existed] [and program '[Path To Program/PID:[PID of Process to start]' [successfully started/was not started]]/[[and was killed]/]` ## Wizard First enter the process to check for in the _Process Name_ field. Either enter the process name or its ID manually in the field, then select the process from the drop-down menu there or navigate to an executable file and select it. Next, select from the _Check for_ drop-down menu whether to check if the process does or does not exist. Choose an action from the _Action_ drop-down menu to perform if the check is successful: - **Do nothing** Performs the check and nothing else. - **Start program** Starts the program defined in the _Program to start_ property. - **Kill process** Kills the process you checked for. Not applicable if the check was for non-existence. Check if applications started by the RPA Bot are still running at the end of a workflow. If so, perform a _Kill process_ action to reset the PC into a clean state for the next run. --- product: RPA Builder version: 6.6 --- # Check Regex > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Check Regex Action Step to search for a text fragment using a regular expression. The text fragment can be searched for in a variable. The results of Check Regex provide various Outbound Variables that can processed further in the Workflow. An introduction to regular expressions is provided in the section on [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). ## Properties **Check Regex Settings** - **Input text** Enter the text that the regular expression is to be applied to. This property is only displayed if no variable has been specified in the Check Regex wizard as the target of the regular expression search. - **Regex Pattern** Enter the regular expression that you want to use as the basis of the search. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Regex Pattern** The regular expression that you want to use as the basis of the search. - **Input text** The text to which apply the regular expression. This property is only displayed if no variable is specified in the Check Regex wizard as the target of the regular expression search. ## Outbound Variables - **First Match** Stores the first match found for the search expression. The text to search is read from beginning to end and the first match is given as the output. The output text is truncated to a maximum length of 1024 characters. If no matches are found, this variable is empty. - **IsMatched** (boolean) Specifies whether the expression searched for was found. - **Match Count** The number of matches found in the text searched. - **Number of first line matched** The line number of the first line that contains the text searched for. - **All Matches** An array variable that stores all matches of the regular expression. If no matches are found, this variable is empty. If only one match is found, the array contains only this element. ## Wizard **Regex** Enter the regular expression that you want to use as the basis of the search. Instead of entering the regular expression directly here, you can store it in a variable. Use the pin next to the **Regex** field to assign a variable. The regular expression can be modified in the Regex Tester dialog. Enter the text that you want to use to test the regular expression into the **Test Pattern** field. Click the **Execute Test** button to run the test. Matches will be highlighted in the **Test Pattern** field. Click the **Apply** button to transfer the tested regular expression to the Check Regex Action Step. Click the **Cancel** button to close the Regex Tester and discard any changes. **Text Pattern** Enter the text that the regular expression should be applied to. Use the Outbound Variables from Check Regex to determine if matches were found and what form the matches take. The Text Pattern can either be entered directly or read from the content of a variable. To read from a variable, click on the pin and select one of the available variables. **Please note the following with regard to error handling:** An error message will be displayed if, for example, the Regex syntax is incorrect or an internal error has occurred (e.g. API error). Conversely, if the regular expression is correct but no matching content is found (match=0), a warning message is displayed. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Check Regex > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Check Regex action step to search for a text fragment using a regular expression. The text fragment can be searched for in a variable. The results of Check Regex provide various Outbound Variables that can processed further in the Workflow. An introduction to regular expressions is provided in the section on [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). ## Properties **Check Regex Settings** - **Input text** Enter the text that the regular expression is to be applied to. This property is only displayed if no variable has been specified in the Check Regex wizard as the target of the regular expression search. - **Regex Pattern** Enter the regular expression that you want to use as the basis of the search. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Regex Pattern** The regular expression that you want to use as the basis of the search. - **Input text** The text to which apply the regular expression. This property is only displayed if no variable is specified in the Check Regex wizard as the target of the regular expression search. ## Outbound Variables - **First Match** Stores the first match found for the search expression. The text to search is read from beginning to end and the first match is given as the output. The output text is truncated to a maximum length of 1024 characters. If no matches are found, this variable is empty. - **IsMatched** (boolean) Specifies whether the expression searched for was found. - **Match Count** The number of matches found in the text searched. - **Number of first line matched** The line number of the first line that contains the text searched for. - **All Matches** An array variable that stores all matches of the regular expression. If no matches are found, this variable is empty. If only one match is found, the array contains only this element. ## Wizard **Regex** Enter the regular expression that you want to use as the basis of the search. Instead of entering the regular expression directly here, you can store it in a variable. Use the pin next to the **Regex** field to assign a variable. The regular expression can be modified in the Regex Tester dialog. Enter the text that you want to use to test the regular expression into the **Test Pattern** field. Click the **Execute Test** button to run the test. Matches will be highlighted in the **Test Pattern** field. Click the **Apply** button to transfer the tested regular expression to the Check Regex action step. Click the **Cancel** button to close the Regex Tester and discard any changes. **Text Pattern** Enter the text that the regular expression should be applied to. Use the Outbound Variables from Check Regex to determine if matches were found and what form the matches take. The Text Pattern can either be entered directly or read from the content of a variable. To read from a variable, click on the pin and select one of the available variables. **Please note the following with regard to error handling:** An error message will be displayed if, for example, the Regex syntax is incorrect or an internal error has occurred (e.g. API error). Conversely, if the regular expression is correct but no matching content is found (match=0), a warning message is displayed. --- product: RPA Builder version: 6.6 --- # Check Value > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ allows you to compare two numerical or alphanumerical (case-sensitive and case-insensitive) values to each other, using different comparison methods. ## Properties **Compare Settings** - **Compare Mode** Decide whether to compare two numerical or alphanumerical values to each other. When using alphanumeric comparison, the ASCII values of the given characters will be compared. For example, "B" has an ASCII value of 66 and "a" has an ASCII value of 97, so "a" is greater than "B", so "a" is greater than "B" would be true if upper and lower case are taken into consideration when comparing (Compare Alphanumeric (case-sensitive)) and false if upper and lower case are not taken into consideration (Compare Alphanumeric (case-sensitive)). - **Compare Operator** Define how the two values should be compared. You can choose whether the values need to be equal or unequal, or if one should be greater than or smaller than the other. **Compare Values** - **Value 1** Value to the left of the compare operator, e.g. a in a>b - **Value 2** Value to the right of the compare operator, e.g. b in a>b ## Inbound Variables **Compare Value 1** Value to the left of the compare operator, e.g. a in a>b **Compare Value 2** Value to the right of the compare operator, e.g. b in a>b ## Outbound Variables **Compare Result** Returns whether the comparison was successful or not (Bool) ## Wizard Note that both comparison values can be mapped to variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Check Value > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step allows you to compare two numerical or alphanumerical (case-sensitive and case-insensitive) values to each other, using different comparison methods. ## Properties **Compare Settings** - **Compare Mode** Decide whether to compare two numerical or alphanumerical values to each other. When using alphanumeric comparison, the ASCII values of the given characters will be compared. For example, "B" has an ASCII value of 66 and "a" has an ASCII value of 97, so "a" is greater than "B", so "a" is greater than "B" would be true if upper and lower case are taken into consideration when comparing (Compare Alphanumeric (case-sensitive)) and false if upper and lower case are not taken into consideration (Compare Alphanumeric (case-sensitive)). - **Compare Operator** Define how the two values should be compared. You can choose whether the values need to be equal or unequal, or if one should be greater than or smaller than the other. **Compare Values** - **Value 1** Value to the left of the compare operator, e.g. a in a>b - **Value 2** Value to the right of the compare operator, e.g. b in a>b ## Inbound Variables **Compare Value 1** Value to the left of the compare operator, e.g. a in a>b **Compare Value 2** Value to the right of the compare operator, e.g. b in a>b ## Outbound Variables **Compare Result** Returns whether the comparison was successful or not (Bool) ## Wizard Note that both comparison values can be mapped to variables. --- product: RPA Builder version: 6.6 --- # Check Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to verify if a website or web application element was loaded properly and how long this took. The _Check Element_ object can be used on any website element. ## Properties **Expected Value** Define the value that the attribute must have to be valid **Use regular expression** Use this function if you want to use a regular expression when checking the value of a selected attribute. For an introduction to regular expressions, see Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). **Invert Check logic** If enabled, the _Check Element_ object waits until the defined web element cannot be found any more, instead of waiting for it to appear. ## Inbound Variables **Attribute to check** **Check Value** **InvertLogic** **Regular expression** **Element XPath** **WindowTitle** ## Outbound Variables The Action Step _Check Element_ possesses no outbound variables. ## Wizard When you select the element you want to check using the _Browser Wizard_, the available attributes for the element are listed in a drop-down menu. After you have chosen an attribute, an expected value must be defined for that attribute. The current value will automatically be set as the default. You can also use regular expressions to match the expected value. For more information about regular expressions see Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). This check works as follows:
Normal check logicInvert check logic

Attribute to check is empty

Only checks if there is an element at the given XPath for the given timeout period. Fails if no element can be found at the XPath for the whole timeout.

Checks if there is no element at the given XPath or waits until it disappears. Fails if an element is detected during the timeout period.

Attribute to check has an entry

In addition to the check above, if the element is found, checks if the attribute to check is equal to the Expected Value. Fails if the attribute does not equal the expected value during the whole timeout period.

In addition to the check above, if the element is found, checks if the attribute to check is not equal to the Expected Value. Fails if the attribute equals the expected value at any point during the whole timeout. Note that this check will be instantly successful if the element cannot be found at all!

--- product: RPA Builder version: 6.7 is-latest-version: true --- # Check Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to verify if a website or web application element was loaded properly and how long this took. The _Check Element_ object can be used on any website element. ## Properties **Expected Value** Define the value that the attribute must have to be valid **Use regular expression** Use this function if you want to use a regular expression when checking the value of a selected attribute. For an introduction to regular expressions, see Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). **Invert Check logic** If enabled, the _Check Element_ object waits until the defined web element cannot be found any more, instead of waiting for it to appear. ## Inbound Variables **Attribute to check** **Check Value** **InvertLogic** **Regular expression** **Element XPath** **WindowTitle** ## Outbound Variables The action step _Check Element_ possesses no outbound variables. ## Wizard When you select the element you want to check using the _Browser Wizard_, the available attributes for the element are listed in a drop-down menu. After you have chosen an attribute, an expected value must be defined for that attribute. The current value will automatically be set as the default. You can also use regular expressions to match the expected value. For more information about regular expressions see Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). This check works as follows:
Normal check logicInvert check logic

Attribute to check is empty

Only checks if there is an element at the given XPath for the given timeout period. Fails if no element can be found at the XPath for the whole timeout.

Checks if there is no element at the given XPath or waits until it disappears. Fails if an element is detected during the timeout period.

Attribute to check has an entry

In addition to the check above, if the element is found, checks if the attribute to check is equal to the Expected Value. Fails if the attribute does not equal the expected value during the whole timeout period.

In addition to the check above, if the element is found, checks if the attribute to check is not equal to the Expected Value. Fails if the attribute equals the expected value at any point during the whole timeout. Note that this check will be instantly successful if the element cannot be found at all!

--- product: RPA Builder version: 6.6 --- # Checking System Parameters > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Some system parameters in _Windows_ significantly affect how the screen image is displayed. For example, turning _ClearType_ (a font smoothing algorithm built into _Windows_) on or off affects the rendering of almost all displayed text – this includes browsers, applications, system dialogs, menu bars, etc. ![Example turning Clear Type on or off](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-checking-system-parameters-why-are-system-parameters-so-important-image1.png) As you can see, there is a big difference between the display of text when _ClearType_ is on or off. Our image search algorithm always compares a "_Pattern image_" to what is visible on the screen during execution. Now imagine you capture a _Pattern image_ containing text on a system where _ClearType_ is enabled (i.e. the left part of the picture above), but then execute the _Workflow_ on a system where _ClearType_ is disabled. The _MuleSoft_ image search algorithm compares the left-hand image to the right-hand one and, although it still finds the image, the match precision will be very low. Aside from _ClearType_, the image search is also affected by the "Menu drop shadow" setting and the DPI setting. The display parameters on the system used to create a _Workflow_ should always be identical to the parameters on the system where the workflow is executed! You should also turn off any settings or programs that may disrupt the _Workflow_ during execution due to unexpected behavior, such as displaying sudden pop-up windows. Common causes of sudden _Workflow_ failures are automatic updates to _Windows_ and other programs you have installed. You should always configure your agent systems to show no unexpected behavior such as sudden pop-ups, screensavers, or similar. ## Recommended Systems Settings - Disable screen saver - Turn off all power option properties - Disable automatic _Windows_ updates - Disable _ClearType_ - Disable menu drop shadow effects - Set desktop scaling to _100%_ ## Checking the System Parameters The menu item _View_ → _Show System Parameters_ opens an overview over the most important settings of your system. Settings marked with a green circle can be left this way. Settings marked with a red circle should be changed. With the **Refresh** button you can check if setting changes have led to an optimization of the status. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Checking System Parameters > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Some system parameters in _Windows_ significantly affect how the screen image is displayed. For example, turning _ClearType_ (a font smoothing algorithm built into _Windows_) on or off affects the rendering of almost all displayed text – this includes browsers, applications, system dialogs, menu bars, etc. ![Example turning Clear Type on or off](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-checking-system-parameters-why-are-system-parameters-so-important-image1.png) As you can see, there is a big difference between the display of text when _ClearType_ is on or off. Our image search algorithm always compares a "_Pattern image_" to what is visible on the screen during execution. Now imagine you capture a _Pattern image_ containing text on a system where _ClearType_ is enabled (i.e. the left part of the picture above), but then execute the _Workflow_ on a system where _ClearType_ is disabled. The _MuleSoft_ image search algorithm compares the left-hand image to the right-hand one and, although it still finds the image, the match precision will be very low. Aside from _ClearType_, the image search is also affected by the "Menu drop shadow" setting and the DPI setting. The display parameters on the system used to create a _Workflow_ should always be identical to the parameters on the system where the workflow is executed! You should also turn off any settings or programs that may disrupt the _Workflow_ during execution due to unexpected behavior, such as displaying sudden pop-up windows. Common causes of sudden _Workflow_ failures are automatic updates to _Windows_ and other programs you have installed. You should always configure your agent systems to show no unexpected behavior such as sudden pop-ups, screensavers, or similar. ## Recommended Systems Settings - Disable screen saver - Turn off all power option properties - Disable automatic _Windows_ updates - Disable _ClearType_ - Disable menu drop shadow effects - Set desktop scaling to _100%_ ## Checking the System Parameters The menu item _View_ → _Show System Parameters_ opens an overview over the most important settings of your system. Settings marked with a green circle can be left this way. Settings marked with a red circle should be changed. With the **Refresh** button you can check if setting changes have led to an optimization of the status. --- product: RPA Builder version: 6.6 --- # Checkpoint > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Checkpoints_ are integrated into a _Workflow_ in order to ascertain which part of the _Workflow_ was reached before an error occurred. When a _Checkpoint_ is reached it is given the status True and saves the length of time from starting to execute the _Workflow_ until the _Checkpoint_ is reached. ## Properties The Action Step _Checkpoint_ has no properties. ## Inbound Variables **Suffix** can be used if the _Checkpoint_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Checkpoint_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables **Was Reached** is given the status True if the _Checkpoint_ was executed - Syntax: True **Elapsed Time** is the time taken from when the _Workflow_ starts until the _Checkpoint_ is reached - Syntax: \[Time since Workflow start in seconds\] ## See Also - [Checkpoint Collection](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-checkpoint-collection) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Checkpoint > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Checkpoints_ are integrated into a _Workflow_ in order to ascertain which part of the _Workflow_ was reached before an error occurred. When a _Checkpoint_ is reached it is given the status True and saves the length of time from starting to execute the _Workflow_ until the _Checkpoint_ is reached. ## Properties The action step _Checkpoint_ has no properties. ## Inbound Variables **Suffix** can be used if the _Checkpoint_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Checkpoint_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables **Was Reached** is given the status True if the _Checkpoint_ was executed - Syntax: True **Elapsed Time** is the time taken from when the _Workflow_ starts until the _Checkpoint_ is reached - Syntax: \[Time since Workflow start in seconds\] ## See Also - [Checkpoint Collection](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-checkpoint-collection) --- product: RPA Builder version: 6.6 --- # Checkpoint Collection > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Checkpoint Collection Action Step enables you to collect all timer values from the Checkpoint Action Steps configured in an Activity Workflow. Because all Checkpoint values are determined at the end of the workflow, you can only place this Action Step in the Workflow Finalization section. ## Properties - **Checkpoint Label** The label for the name of the checkpoint in the output JSON. Maximum length: 50 characters. - **Reached Label** The label for the reached status of the checkpoint in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. - **Value Label** The label for the value of the checkpoint in the output JSON. Maximum length: 50 characters. > [!WARNING] The properties panel does not validate the maximum label length. Ensure that you > validate JSON labels and output by using the Wizard. ## Inbound Variables This Action Step contains no inbound variables. ## Outbound Variables - **Checkpoint Collection** The collection of captured checkpoint values in a JSON list, represented as a String. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/checkpoint-collection-wizard.png) - **Settings for JSON labels** - **Checkpoint Label** The label for the name of the checkpoint in the output JSON. Maximum length: 50 characters. - **Reached Label** The label for the reached status of the checkpoint in the output JSON. Maximum length: 50 characters. - **Value Label** The label for the value of the checkpoint in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. The **Preview JSON Output** shows a preview of the resulting JSON based on the configured Checkpoint Action Steps in the Workflow. ## See Also - [Checkpoint](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-checkpoint) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-finalization) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Checkpoint Collection > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Checkpoint Collection action step enables you to collect all timer values from the Checkpoint action steps configured in an Activity Workflow. Because all Checkpoint values are determined at the end of the workflow, you can only place this action step in the Workflow Finalization section. ## Properties - **Checkpoint Label** The label for the name of the checkpoint in the output JSON. Maximum length: 50 characters. - **Reached Label** The label for the reached status of the checkpoint in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. - **Value Label** The label for the value of the checkpoint in the output JSON. Maximum length: 50 characters. > [!WARNING] The properties panel does not validate the maximum label length. Ensure that you > validate JSON labels and output by using the Wizard. ## Inbound Variables This action step contains no inbound variables. ## Outbound Variables - **Checkpoint Collection** The collection of captured checkpoint values in a JSON list, represented as a String. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/checkpoint-collection-wizard.png) - **Settings for JSON labels** - **Checkpoint Label** The label for the name of the checkpoint in the output JSON. Maximum length: 50 characters. - **Reached Label** The label for the reached status of the checkpoint in the output JSON. Maximum length: 50 characters. - **Value Label** The label for the value of the checkpoint in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. The **Preview JSON Output** shows a preview of the resulting JSON based on the configured Checkpoint action steps in the Workflow. ## See Also - [Checkpoint](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-checkpoint) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/latest/workflow-finalization) --- product: RPA Builder version: 6.6 --- # Checks > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Checks are different types of validations that you can add as action steps of an automation project. - [Check Process](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-check-process) This Action Step enables you to check if a process is running or not and either kill it or launch another program. - [Image Search](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-image-search) This Action Step searches for a user-defined image, waits until it appears or disappears, and can also be used as a relative anchor point for mouse clicks. - [Screenshot](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-screenshot) This Action Step takes a screenshot and saves it to the trace folder. You can use it to get feedback on what is happening at any point in a Workflow. - [Search Pattern](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-search-pattern) The Search Pattern Action Step searches for one or more patterns within a defined Search Area on the screen. - [Window Wait](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-window-wait) The Action Step Window Wait pauses the Workflow until a certain window is displayed or not displayed. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Checks > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Checks are different types of validations that you can add as action steps of an automation project. - [Check Process](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-check-process) This action step enables you to check if a process is running or not and either kill it or launch another program. - [Image Search](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-image-search) This action step searches for a user-defined image, waits until it appears or disappears, and can also be used as a relative anchor point for mouse clicks. - [Screenshot](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-screenshot) This action step takes a screenshot and saves it to the trace folder. You can use it to get feedback on what is happening at any point in a Workflow. - [Search Pattern](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-search-pattern) The Search Pattern action step searches for one or more patterns within a defined Search Area on the screen. - [Window Wait](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-window-wait) The action step Window Wait pauses the Workflow until a certain window is displayed or not displayed. --- product: RPA Builder version: 6.6 --- # Clear Screen > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ will try to clear any open window from the screen. First, it will try to stop these processes: _SAPlogon.exe_, _cmd.exe_, and _SAPfewgsrv.exe_. Next, it will try to kill all windows that have the state _Visible_ (this may also include minimized windows!), except for any MuleSoft-related windows and the _System Shell_, which includes the _Desktop_ and the _Task Bar_. It is good practice to use a _Clear screen_ at the beginning of each _Workflow_. This will provide a clean state to run the _Workflow_ in without disturbances and thus improve _Workflow_ reliability. In draft mode, the Clear Screen Action Step is disabled. No windows are closed. After testing the Workflow using the Run Workflowt (F7) button, a yellow warning appears on the Workbench. ## Properties - **Action in case of failure** Define, what should be done if _Clear screen_ failed. Available actions are: _Make screenshot_, _Make screenshot and write log_, _Make reboot,_ and _Minimize windows_ - **Action in case of success** Define what the Workflow should do if _Clear screen_ was successful. Available follow-up actions are: _Do nothing_ or _Write log_ --- product: RPA Builder version: 6.7 is-latest-version: true --- # Clear Screen > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step will try to clear any open window from the screen. First, it will try to stop these processes: _SAPlogon.exe_, _cmd.exe_, and _SAPfewgsrv.exe_. Next, it will try to kill all windows that have the state _Visible_ (this may also include minimized windows!), except for any MuleSoft-related windows and the _System Shell_, which includes the _Desktop_ and the _Task Bar_. It is good practice to use a _Clear screen_ at the beginning of each _Workflow_. This will provide a clean state to run the _Workflow_ in without disturbances and thus improve _Workflow_ reliability. In draft mode, the Clear Screen action step is disabled. No windows are closed. After testing the Workflow using the Run Workflowt (F7) button, a yellow warning appears on the Workbench. ## Properties - **Action in case of failure** Define, what should be done if _Clear screen_ failed. Available actions are: _Make screenshot_, _Make screenshot and write log_, _Make reboot,_ and _Minimize windows_ - **Action in case of success** Define what the Workflow should do if _Clear screen_ was successful. Available follow-up actions are: _Do nothing_ or _Write log_ --- product: RPA Builder version: 6.6 --- # Clear Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object is used to clear the content of fields on a website or in a web application. _Clear Element_ can be used on text entry fields. It does not have any additional properties or wizard functions. ## Properties **Webelement Find Options** - **Screenshot The recorded screenshot is displayed here.** - **Use Regex to find Window (Enable Regex) Use this function if you want to use Regex when searching the window.** Other Properties that are the same in all Action Steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Element XPath** **Window Title** ## Outbound Variables The Action Step _Clear Element_ possesses no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Clear Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object is used to clear the content of fields on a website or in a web application. _Clear Element_ can be used on text entry fields. It does not have any additional properties or wizard functions. ## Properties **Webelement Find Options** - **Screenshot The recorded screenshot is displayed here.** - **Use Regex to find Window (Enable Regex) Use this function if you want to use Regex when searching the window.** Other Properties that are the same in all action steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Element XPath** **Window Title** ## Outbound Variables The action step _Clear Element_ possesses no outbound variables. --- product: RPA Builder version: 6.6 --- # Click App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Click App Element_ Action Step lets you perform a number of click and/or invoke actions for an App Element. _Invoke_ means the Microsoft API is addressed directly to execute the element function, which means no mouse action is needed. ## Properties - **Click App Element Settings** - **Initial Delay (ms)** Defines how long to wait before initially executing the configured action. - **(Additional) Modifier** An additional key or key combination that is active when the configured mouse action executes. The following choices are available: `None`, `Ctrl`, `Alt`, `Ctrl + Alt`, `Shift`, `Ctrl + Shift`, `Alt + Shift`, `Ctrl + Alt + Shift`. - **Mouse Action:** Only available in _Mouse Action_ operation mode. Defines which mouse action to execute. The following choices are available: - **None** Moves the mouse to the selected element and executes no action. This is equivalent to a _hover_. - **Left Click** Executes a single left-click. - **Middle Click** Executes a single click of the middle mouse button (usually the mouse wheel). - **Right Click** Executes a single right-click. - **Double Left Click** Executes a double left-click. - **Double Right Click** Executes a double right-click. - **Wheel up** Executes a _mouse wheel up_ action, corresponding to scrolling up one row. - **Wheel down** Executes a _mouse wheel down_ action, corresponding to scrolling down one row. - **Operation mode** You can select here between _Invoke Element_ and _Mouse Action_. - **Invoke element** Communicates directly with the Microsoft API to execute the functions of the element; the mouse is not moved in this process. - **Mouse Action** Simulates the configured mouse action and moves the mouse to the target element. - **Trigger count** Defines how often the configured action executes. ## Inbound Variables - **Trigger Count** - **Initial Delay** - **XPath to Element** - **Window Title** ## Outbound Variables The Click App Element Action Step does not have any outbound variables. ## Wizard In the **Mouse action**, Operation Mode you determine the type of the action (such as Double Left Click), while **Trigger Count** defines the number of times this action is performed. The Action Step ensures that the clicks are grouped correctly. In other words, a configured double-click is executed directly, while a normal Left Click with two repetitions is executed with a time delay, to ensure that Windows does not register a double-click. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Click App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Click App Element_ action step lets you perform a number of click and/or invoke actions for an App Element. _Invoke_ means the Microsoft API is addressed directly to execute the element function, which means no mouse action is needed. ## Properties - **Click App Element Settings** - **Initial Delay (ms)** Defines how long to wait before initially executing the configured action. - **(Additional) Modifier** An additional key or key combination that is active when the configured mouse action executes. The following choices are available: `None`, `Ctrl`, `Alt`, `Ctrl + Alt`, `Shift`, `Ctrl + Shift`, `Alt + Shift`, `Ctrl + Alt + Shift`. - **Mouse Action:** Only available in _Mouse Action_ operation mode. Defines which mouse action to execute. The following choices are available: - **None** Moves the mouse to the selected element and executes no action. This is equivalent to a _hover_. - **Left Click** Executes a single left-click. - **Middle Click** Executes a single click of the middle mouse button (usually the mouse wheel). - **Right Click** Executes a single right-click. - **Double Left Click** Executes a double left-click. - **Double Right Click** Executes a double right-click. - **Wheel up** Executes a _mouse wheel up_ action, corresponding to scrolling up one row. - **Wheel down** Executes a _mouse wheel down_ action, corresponding to scrolling down one row. - **Operation mode** You can select here between _Invoke Element_ and _Mouse Action_. - **Invoke element** Communicates directly with the Microsoft API to execute the functions of the element; the mouse is not moved in this process. - **Mouse Action** Simulates the configured mouse action and moves the mouse to the target element. - **Trigger count** Defines how often the configured action executes. ## Inbound Variables - **Trigger Count** - **Initial Delay** - **XPath to Element** - **Window Title** ## Outbound Variables The Click App Element action step does not have any outbound variables. ## Wizard In the **Mouse action**, Operation Mode you determine the type of the action (such as Double Left Click), while **Trigger Count** defines the number of times this action is performed. The action step ensures that the clicks are grouped correctly. In other words, a configured double-click is executed directly, while a normal Left Click with two repetitions is executed with a time delay, to ensure that Windows does not register a double-click. --- product: RPA Builder version: 6.6 --- # Click Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Simulate mouse input on a website element. The available click types are: - **Single Left Click** - **Single Left Click (Wait for page load)** Waits for the page to finish loading and then simulates the click. If the page does not load, the action step fails. - **Double Left Click** - **Single Right Click** - **No Click (Hover)** Simulates a mouse hover. ## Properties - **Click Type** --- product: RPA Builder version: 6.7 is-latest-version: true --- # Click Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Simulate mouse input on a website element. The available click types are: - **Single Left Click** - **Single Left Click (Wait for page load)** Waits for the page to finish loading and then simulates the click. If the page does not load, the action step fails. - **Double Left Click** - **Single Right Click** - **No Click (Hover)** Simulates a mouse hover. ## Properties - **Click Type** --- product: RPA Builder version: 6.6 --- # Close Web Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Action Step _Close Web Session_ enables you to close a web session. To do so, the Action Step must be mapped to an existing web session ID, to enable unique identification of the web session to be closed. The Action Step _Close Web Session_ can only be placed outside of a web session. ## Properties **Force error state if session could not be closed** If you activate this option, an error state is forced if the web session could not be opened or has already been closed. If this option is not set (default), the error is simply ignored. ## Inbound Variables **Web Session ID** The web session ID identifies the web session to be closed. **Force error state if session could not be closed** If you activate this option, an error state is forced if the web session could not be opened or has already been closed. If this option is not set (default), the error is simply ignored. ## Outbound Variables **Web Session closed** Indicates whether or not the web session was closed. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Close Web Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The action step _Close Web Session_ enables you to close a web session. To do so, the action step must be mapped to an existing web session ID, to enable unique identification of the web session to be closed. The action step _Close Web Session_ can only be placed outside of a web session. ## Properties **Force error state if session could not be closed** If you activate this option, an error state is forced if the web session could not be opened or has already been closed. If this option is not set (default), the error is simply ignored. ## Inbound Variables **Web Session ID** The web session ID identifies the web session to be closed. **Force error state if session could not be closed** If you activate this option, an error state is forced if the web session could not be opened or has already been closed. If this option is not set (default), the error is simply ignored. ## Outbound Variables **Web Session closed** Indicates whether or not the web session was closed. --- product: RPA Builder version: 6.6 --- # Combine Strings > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use **Combine Strings** to combine multiple variables into a single new variable. This action step supports Script variables, environment variables, and Pin variables. You can insert text before, after, and between variables. Link the Pin variables to use with this action step before opening the wizard. Combine Strings supports a maximum of 5 Pin variables. To define a single text value as a variable, use the Set Variable action step instead. ## Properties **Pattern Text**: Defines the sequence in which variables and texts are concatenated. ## Inbound Variables **Pattern**: Defines the sequence in which variables and texts are concatenated. ## Outbound Variables **Combined String**: The combined strings stated as a single string, as defined in **Pattern Text**. ## Reserved values Because Pin variables use the syntax `{}`, Combine String replaces values such as `{1}` and `{2}` with the corresponding Pin variable or an empty value if there are no variables configured in these slots. To use a string that contains `{1}` or other reserved value as part of the text, define a variable containing the string and then reference it in the pattern. For example, consider the following Pin variables: - `{1}: Workflow Based Variables.constantString`, with value `Value {1} is:` - `{2}: Workflow Based Variables.variableNumber`, with a numeric value defined at runtime. For this example, assume the value is `123456`. By setting the pattern text to: `{1} {2}`, the combined string result is `Value {1} is: 123456`. ## Wizard The wizard contains the editable **Pattern** text field, drop-down lists of script and environment variables, and links to the Pin variables. Clicking the name of a variable from the list adds a reference to the variable in the text field. You can also enter custom text into the **Pattern** field. Clicking variable names in the **Insert Available Variables** section of the Wizard inserts variables into the pattern using the following syntax depending on the type of variable: - Pin variables: `{[number in the list of all Pin variables]}`. Example: `{1}`. - Environment variables: `%[name of variables]%`. Example: `%SYSTEM%`. - Script variables: `($[name of variables])`. Example: `$myVariable`. The Pin variable _Combined String_ contains the result in the form of a single string. ### Example The macro `{1}` is bound to variable _ActivityParameters.ap\_alpha1_ and macro `{2}` is bound to variable _ActivityParameters.ap\_alpha2_. The following table represents the values of both variables and how they translate to a new variable using different pattern texts:
ActivityParameters.ap_alpha1ActivityParameters.ap_alpha2Pattern TextOutput Variable (Combined String)

mulesoft

com

www.{1}.{2}

www.mulesoft.com

mulesoft

Info

www.{1}.{2}

www.mulesoft.info

Ms

Miller

Dear {1}. {2},

Dear Ms. Miller,

Mr

Johnson

Dear {1}. {2},

Dear Mr. Johnson,

Lorem

Ipsum

{1}{2}

LoremIpsum

Lorem

Ipsum

{2}{1} - {1}{2}

IpsumLorem - LoremIpsum

## See Also [Set Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-variable) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Combine Strings > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use **Combine Strings** to combine multiple variables into a single new variable. This action step supports Script variables, environment variables, and Pin variables. You can insert text before, after, and between variables. Link the Pin variables to use with this action step before opening the wizard. Combine Strings supports a maximum of 5 Pin variables. To define a single text value as a variable, use the Set Variable action step instead. ## Properties **Pattern Text**: Defines the sequence in which variables and texts are concatenated. ## Inbound Variables **Pattern**: Defines the sequence in which variables and texts are concatenated. ## Outbound Variables **Combined String**: The combined strings stated as a single string, as defined in **Pattern Text**. ## Reserved values Because Pin variables use the syntax `{}`, Combine String replaces values such as `{1}` and `{2}` with the corresponding Pin variable or an empty value if there are no variables configured in these slots. To use a string that contains `{1}` or other reserved value as part of the text, define a variable containing the string and then reference it in the pattern. For example, consider the following Pin variables: - `{1}: Workflow Based Variables.constantString`, with value `Value {1} is:` - `{2}: Workflow Based Variables.variableNumber`, with a numeric value defined at runtime. For this example, assume the value is `123456`. By setting the pattern text to: `{1} {2}`, the combined string result is `Value {1} is: 123456`. ## Wizard The wizard contains the editable **Pattern** text field, drop-down lists of script and environment variables, and links to the Pin variables. Clicking the name of a variable from the list adds a reference to the variable in the text field. You can also enter custom text into the **Pattern** field. Clicking variable names in the **Insert Available Variables** section of the Wizard inserts variables into the pattern using the following syntax depending on the type of variable: - Pin variables: `{[number in the list of all Pin variables]}`. Example: `{1}`. - Environment variables: `%[name of variables]%`. Example: `%SYSTEM%`. - Script variables: `($[name of variables])`. Example: `$myVariable`. The Pin variable _Combined String_ contains the result in the form of a single string. ### Example The macro `{1}` is bound to variable _ActivityParameters.ap\_alpha1_ and macro `{2}` is bound to variable _ActivityParameters.ap\_alpha2_. The following table represents the values of both variables and how they translate to a new variable using different pattern texts:
ActivityParameters.ap_alpha1ActivityParameters.ap_alpha2Pattern TextOutput Variable (Combined String)

mulesoft

com

www.{1}.{2}

www.mulesoft.com

mulesoft

Info

www.{1}.{2}

www.mulesoft.info

Ms

Miller

Dear {1}. {2},

Dear Ms. Miller,

Mr

Johnson

Dear {1}. {2},

Dear Mr. Johnson,

Lorem

Ipsum

{1}{2}

LoremIpsum

Lorem

Ipsum

{2}{1} - {1}{2}

IpsumLorem - LoremIpsum

## See Also [Set Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-variable) --- product: RPA Builder version: 6.6 --- # Common Properties > For the full documentation index, see: https://docs.mulesoft.com/llms.txt All Action Steps have properties that you can configure via the relevant Action Step wizard or its Properties window, or by editing Variable Mappings. The following properties are common to all Action Steps: - **Common** - **Description** A custom description of the Action Step as defined by the user. - **Error Handling** The error handling strategy to use. The default value is **Normal**. When set to **None**, the error handling strategy disregards an error that occurs during this Action Step. In this case, the _DoAction_ block of a Managed Control Block ignores the error, it doesn’t execute the content of the _OnError_ block, and adds a corresponding note the log file. The **Force Error State** Action Step does not include Error Handling because it is used to produce an error. - **Name** The name of the Action Step. To improve the clarity of a Workflow, ensure you give Action Steps meaningful names. Action Step names accept a maximum of 60 characters in length and are case sensitive. - **Timing** - **Timeout** The time in seconds RPA Builder waits for an Action Step to finish its execution before canceling the Workflow and returning an error. - If _Timeout_ is set to `0`, the duration for executing the Action Step is not limited. - The Timeout defined here applies only if the option **Use general timeout** is disabled. - **Use general timeout** If this option is enabled, RPA Builder uses the time specified in seconds under _Default Timeout_ in the properties of the Workflow as the Timeout for the Action Step. The following properties are also required for Action Steps that can be shown as Measurement Points in Data Sources: - **Common** - **Timer Name** A name for the timer. RPA Builder automatically adds this property in the Ping and Service Check Action Steps. - **Misc** - **Script Feedback / Reporting Function** - **Record Timer** When this option is enabled, the runtime measured for the Ping and Service Check Action Steps is passed to RPA Manager via a linked Data Source. - **Timing** - **Timer Mode** If you use Ping and Service Check Action Steps in the Control Blocks Loop, this option defines which of the Timer values measured is to be passed to RPA Manager via a linked Data Source. - **Last** The only value saved is the one measured in the last loop. - **Average** The mean of all times measured is calculated and saved. - **Min Only** The lowest value measured is saved. - **Max Only** The highest value measured is saved. ## Variables Depending on the way it is configured, every Action Step provides some of its values as Pin variables for subsequent Action Steps. Some properties of Action Steps can be filled by these Pin variables. You can choose from any displayed, completed variables. Variables are named as follows: `[Name of the Action Step in the Workflow].[Name of Variable]`. If a Property of an Action Step is filled by a variable, this Property no longer shows in the Properties window and can only be changed using the wizard. ## Suffixes You can use suffixes for the names of the Checkpoint, Stop Watch, Ping, Service Check and Variable Action Steps, provided that the Action Steps occur within a Control Block’s File Controlled Loop. A suffix is then added to the name of the Action Step during every loop. Each suffix is a column entry in the file that was imported in the File Controlled Loop. The _Suffix_ property shows in the Edit Variable Mappings window only if the Action Step occurs within a Control Block’s File Controlled Loop. To open the Edit Variable Mappings window, click the Pin (![The Pin Icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/pin-icon.png))button next to the Action Step you want to modify. ![A Screenshot showing the Edit Variable Mappings button](/mulesoft/current/en-us/rpa-builder/6.6/_images/edit-variable-mappings.png) ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/6.6/workflow-configure-properties) - [Using Variables](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-variables) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Common Properties > For the full documentation index, see: https://docs.mulesoft.com/llms.txt All action steps have properties that you can configure via the relevant action step wizard or its Properties window, or by editing Variable Mappings. The following properties are common to all action steps: - **Common** - **Description** A custom description of the action step as defined by the user. - **Error Handling** The error handling strategy to use. The default value is **Normal**. When set to **None**, the error handling strategy disregards an error that occurs during this action step. In this case, the _DoAction_ block of a Managed Control Block ignores the error, it doesn’t execute the content of the _OnError_ block, and adds a corresponding note the log file. The **Force Error State** action step does not include Error Handling because it is used to produce an error. - **Name** The name of the action step. To improve the clarity of a Workflow, ensure you give action steps meaningful names. action step names accept a maximum of 60 characters in length and are case sensitive. - **Timing** - **Timeout** The time in seconds RPA Builder waits for an action step to finish its execution before canceling the Workflow and returning an error. - If _Timeout_ is set to `0`, the duration for executing the action step is not limited. - The Timeout defined here applies only if the option **Use general timeout** is disabled. - **Use general timeout** If this option is enabled, RPA Builder uses the time specified in seconds under _Default Timeout_ in the properties of the Workflow as the Timeout for the action step. The following properties are also required for action steps that can be shown as Measurement Points in Data Sources: - **Common** - **Timer Name** A name for the timer. RPA Builder automatically adds this property in the Ping and Service Check action steps. - **Misc** - **Script Feedback / Reporting Function** - **Record Timer** When this option is enabled, the runtime measured for the Ping and Service Check action steps is passed to RPA Manager via a linked Data Source. - **Timing** - **Timer Mode** If you use Ping and Service Check action steps in the Control Blocks Loop, this option defines which of the Timer values measured is to be passed to RPA Manager via a linked Data Source. - **Last** The only value saved is the one measured in the last loop. - **Average** The mean of all times measured is calculated and saved. - **Min Only** The lowest value measured is saved. - **Max Only** The highest value measured is saved. ## Variables Depending on the way it is configured, every action step provides some of its values as Pin variables for subsequent action steps. Some properties of action steps can be filled by these Pin variables. You can choose from any displayed, completed variables. Variables are named as follows: `[Name of the action step in the Workflow].[Name of Variable]`. If a Property of an action step is filled by a variable, this Property no longer shows in the Properties window and can only be changed using the wizard. ## Suffixes You can use suffixes for the names of the Checkpoint, Stop Watch, Ping, Service Check and Variable action steps, provided that the action steps occur within a Control Block’s File Controlled Loop. A suffix is then added to the name of the action step during every loop. Each suffix is a column entry in the file that was imported in the File Controlled Loop. The _Suffix_ property shows in the Edit Variable Mappings window only if the action step occurs within a Control Block’s File Controlled Loop. To open the Edit Variable Mappings window, click the Pin (![The Pin Icon](/mulesoft/current/en-us/rpa-builder/latest/_images/pin-icon.png))button next to the action step you want to modify. ![A Screenshot showing the Edit Variable Mappings button](/mulesoft/current/en-us/rpa-builder/latest/_images/edit-variable-mappings.png) ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/latest/workflow-configure-properties) - [Using Variables](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-variables) --- product: RPA Builder version: 6.6 --- # Common Properties (Web Automation) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Web Automation Web Session_ Action Steps share these _Common Properties_: **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. Additionally, _Web Element_ Action Steps share the following _Properties_: - **Element _XPath_** _XPath_ is short for _XML Path Language_. This is a special language used to uniquely identify elements within an XML document. Since HTML is based on XML, you can use the XPath to identify any object on a webpage. You can use the _Browser Wizard_ (see above) to generate XPaths or you can also enter them manually. - **Window Title** Title of the website where the referenced element is located. This will be set when using the _Browser Wizard_. - **Use Window Title** Determines whether or not the website title should be used to identify the correct browser tab - **Frame Indexes / Frame Hierarchy** A series of indexes needed to identify elements that lie within frames. Each frame is referenced by its index, with individual frames separated by slashes. For example, a _Frame Index_ of _/2/1_ means that the element lies within the first sub-frame of the second frame of the main page. This will be set when using the _Browser Wizard_. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-using-the-browser-wizard) - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-chrome) - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-firefox) - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-ms-edge) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Common Properties (Web Automation) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Web Automation Web Session_ action steps share these _Common Properties_: **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. Additionally, _Web Element_ action steps share the following _Properties_: - **Element _XPath_** _XPath_ is short for _XML Path Language_. This is a special language used to uniquely identify elements within an XML document. Since HTML is based on XML, you can use the XPath to identify any object on a webpage. You can use the _Browser Wizard_ (see above) to generate XPaths or you can also enter them manually. - **Window Title** Title of the website where the referenced element is located. This will be set when using the _Browser Wizard_. - **Use Window Title** Determines whether or not the website title should be used to identify the correct browser tab - **Frame Indexes / Frame Hierarchy** A series of indexes needed to identify elements that lie within frames. Each frame is referenced by its index, with individual frames separated by slashes. For example, a _Frame Index_ of _/2/1_ means that the element lies within the first sub-frame of the second frame of the main page. This will be set when using the _Browser Wizard_. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-using-the-browser-wizard) - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-chrome) - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-firefox) - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-ms-edge) --- product: RPA Builder version: 6.6 --- # Configure Workflow Properties > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To display and configure Workflow properties: 1. Open the Workflow you want to edit by double-clicking its corresponding task in the BPMN editor. ![The BPMN editor showing a project with three tasks](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-open-properties.png) 2. Open the **Project Explorer**. 3. Right-click the Workflow and, from the context menu, select **Edit Workflow Properties**. ![The Project Explorer showing the Workflow to edit](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-properties-window.png) The properties panel of RPA Builder displays the corresponding properties. ## Properties - **Common** - **Description** A custom description of the item. - **Name** The name of this Workflow element. - **Workflow Folder** Path to actual location of the loaded Workflow. - **Compatibility Settings** - **Disable keyboard state reset** Information entered via the keyboard is only applicable for the duration of a Transaction. The keyboard state is reset at the start of every subsequent Transaction. If information entered via the keyboard is intended to apply to more than one Transaction, enable **Disable keyboard state reset**. Example: Transaction 1 includes the keystroke `{CTRLDOWN}` and mouse clicks to select several objects. In Transaction 2, additional objects need to be selected as well. The `CTRL` key must therefore remain held down. This becomes possible by enabling the option to Disable keyboard state reset. Enter the keystroke `{CTRLUP}` as and when the key is to be released. - **Don’t warn about trailing or leading Blanks** Disable warnings for leading and trailing blanks. - **Static analysis image** The analysis package contains additional information, so that you can view the cause of a failed image search directly in the window Search Results of the Action Step Search Pattern. If you want to analyze the errors without using RPA Builder, you can activate the option Static analysis image. The analysis image is packed into the analysis folder. - **Image Processing** - **Color Depth** Compensate for color depth variations of different measurement robots by using Automatic mode. - **Measurement Scheduling** The Measurement Scheduling menu item is a legacy element and can still be found in the Workflow Properties for compatibility reasons. Do not make any changes. - **STC Guard Settings** - **Force kill by STC Guard** A list of additional processes to end if an error occurs while executing a Workflow. Enable the **STC Guard active** setting to activate this feature. STC Guard always closes all visible and associated Windows processes. It is also possible to include windowless processes in the list. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe`. - **Keep Alive** A list of all processes that STC Guard does not end if an error occurs while executing a Workflow. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe`. > [!NOTE] Processes listed under **Kill on Exit** are ended in all circumstances. - **Kill on Exit** A list of all processes that STC Guard ends after a Workflow has been executed, irrespective of its success. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe.` > [!NOTE] The processes listed here are also ended if **STC Guard active** is not selected and > even if the same process is listed under **Keep Alive**. - **STC Guard active** Defines the Activation of STC Guard. > [!NOTE] Processes listed under **Kill on Exit** are ended, irrespective of what is specified > in this setting. - **Workflow Repository Info** - **Version** The Repository Version of this Workflow. Ignore this value if you don’t work with a Workflow Repository. - **Workflow Values** - **Creation Author** Name of the project creator (automatically set by the program). - **Creation Date** Date and time of the project’s creation (automatically set by the program). - **Last Change Date** Date and time the project was last modified (automatically set by the program). - **Last Editor** Windows Login ID of the last person to change the project (automatically set by the program). - **Workflow Type** The Workflow type (`End-to-End` or `Test automation`). The Workflow type is set at the creation of the project and cannot be changed. - **Max Runtime** The maximum allowed time for a workflow to run before it stops its execution. By default, this value is set to 2 hours. The minimum allowed value for this field is 10 minutes and the maximum is 1440 minutes (24 hours). ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Configure Workflow Properties > For the full documentation index, see: https://docs.mulesoft.com/llms.txt To display and configure Workflow properties: 1. Open the Workflow you want to edit by double-clicking its corresponding task in the BPMN editor. ![The BPMN editor showing a project with three tasks](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-open-properties.png) 2. Open the **Project Explorer**. 3. Right-click the Workflow and, from the context menu, select **Edit Workflow Properties**. ![The Project Explorer showing the Workflow to edit](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-properties-window.png) The properties panel of RPA Builder displays the corresponding properties. ## Properties - **Common** - **Description** A custom description of the item. - **Name** The name of this Workflow element. - **Workflow Folder** Path to actual location of the loaded Workflow. - **Compatibility Settings** - **Disable keyboard state reset** Information entered via the keyboard is only applicable for the duration of a Transaction. The keyboard state is reset at the start of every subsequent Transaction. If information entered via the keyboard is intended to apply to more than one Transaction, enable **Disable keyboard state reset**. Example: Transaction 1 includes the keystroke `{CTRLDOWN}` and mouse clicks to select several objects. In Transaction 2, additional objects need to be selected as well. The `CTRL` key must therefore remain held down. This becomes possible by enabling the option to Disable keyboard state reset. Enter the keystroke `{CTRLUP}` as and when the key is to be released. - **Don’t warn about trailing or leading Blanks** Disable warnings for leading and trailing blanks. - **Static analysis image** The analysis package contains additional information, so that you can view the cause of a failed image search directly in the window Search Results of the action step Search Pattern. If you want to analyze the errors without using RPA Builder, you can activate the option Static analysis image. The analysis image is packed into the analysis folder. - **Image Processing** - **Color Depth** Compensate for color depth variations of different measurement robots by using Automatic mode. - **Measurement Scheduling** The Measurement Scheduling menu item is a legacy element and can still be found in the Workflow Properties for compatibility reasons. Do not make any changes. - **STC Guard Settings** - **Force kill by STC Guard** A list of additional processes to end if an error occurs while executing a Workflow. Enable the **STC Guard active** setting to activate this feature. STC Guard always closes all visible and associated Windows processes. It is also possible to include windowless processes in the list. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe`. - **Keep Alive** A list of all processes that STC Guard does not end if an error occurs while executing a Workflow. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe`. > [!NOTE] Processes listed under **Kill on Exit** are ended in all circumstances. - **Kill on Exit** A list of all processes that STC Guard ends after a Workflow has been executed, irrespective of its success. Process names entered into this field must contain no spaces and must be separated in the list by semicolons, for example: `proc_1.exe;proc_2.exe;proc_N.exe.` > [!NOTE] The processes listed here are also ended if **STC Guard active** is not selected and > even if the same process is listed under **Keep Alive**. - **STC Guard active** Defines the Activation of STC Guard. > [!NOTE] Processes listed under **Kill on Exit** are ended, irrespective of what is specified > in this setting. - **Workflow Repository Info** - **Version** The Repository Version of this Workflow. Ignore this value if you don’t work with a Workflow Repository. - **Workflow Values** - **Creation Author** Name of the project creator (automatically set by the program). - **Creation Date** Date and time of the project’s creation (automatically set by the program). - **Last Change Date** Date and time the project was last modified (automatically set by the program). - **Last Editor** Windows Login ID of the last person to change the project (automatically set by the program). - **Workflow Type** The Workflow type (`End-to-End` or `Test automation`). The Workflow type is set at the creation of the project and cannot be changed. - **Max Runtime** The maximum allowed time for a workflow to run before it stops its execution. By default, this value is set to 2 hours. The minimum allowed value for this field is 10 minutes and the maximum is 1440 minutes (24 hours). ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) --- product: RPA Builder version: 6.6 --- # Confirm Alert Box > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to confirm or dismiss _JavaScript_ Alert Boxes, and enter text in _JavaScript_ input boxes. ## Properties **Action on Messagebox** Decide whether to accept a message box (equivalent to clicking _OK_) or dismiss it (equivalent to clicking _Cancel_). If you are handling an input box (a message box with a text input field) and want to enter text, set this to _Enter Text_. **Text to send** Text that should be entered. Only applicable for message boxes with a text input field when _Action on Messagebox_ is set to _Enter Text_. ## Inbound Variables **Action on Messagebox** Decide whether to accept a message box (equivalent to clicking _OK_) or dismiss it (equivalent to clicking _Cancel_). If you are handling an input box (a message box with a text input field) and want to enter text, set this to _Enter Text_. ## Outbound Variables The Action Step _Confirm Alert Box_ possesses no outbound variables. ## Wizard _JavaScript_ pop-ups are a bit difficult to identify. They look slightly different in each browser, but they always look a bit like system dialogs. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Confirm Alert Box > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to confirm or dismiss _JavaScript_ Alert Boxes, and enter text in _JavaScript_ input boxes. ## Properties **Action on Messagebox** Decide whether to accept a message box (equivalent to clicking _OK_) or dismiss it (equivalent to clicking _Cancel_). If you are handling an input box (a message box with a text input field) and want to enter text, set this to _Enter Text_. **Text to send** Text that should be entered. Only applicable for message boxes with a text input field when _Action on Messagebox_ is set to _Enter Text_. ## Inbound Variables **Action on Messagebox** Decide whether to accept a message box (equivalent to clicking _OK_) or dismiss it (equivalent to clicking _Cancel_). If you are handling an input box (a message box with a text input field) and want to enter text, set this to _Enter Text_. ## Outbound Variables The action step _Confirm Alert Box_ possesses no outbound variables. ## Wizard _JavaScript_ pop-ups are a bit difficult to identify. They look slightly different in each browser, but they always look a bit like system dialogs. --- product: RPA Builder version: 6.6 --- # Control > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Control Action Steps enable you to interact with the system where the automation is running by sending certain instructions and input signals. - [Clear Screen](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-clear-screen) This Action Step tries to clear any open window from the screen. - [Enter String](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-enter-string) This Action Step emulates keyboard inputs and accepts text transferred from a previously executed Action Step. - [Keystrokes](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-keystrokes) This Action Step emulates keyboard inputs. - [Mouse Actions](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-mouse-actions) The Mouse Actions Action Step emulates mouse moves and clicks. - [Run Program](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-run-program) This Action Step is used to run a program by directly calling its executable file. - [Sleep](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-sleep) This Action Step causes the Workflow to be paused for the specified duration. - [Window Set State](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-window-set-state) This Action Step allows you to change the state of a specific window. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Control > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Control action steps enable you to interact with the system where the automation is running by sending certain instructions and input signals. - [Clear Screen](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-clear-screen) This action step tries to clear any open window from the screen. - [Enter String](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-enter-string) This action step emulates keyboard inputs and accepts text transferred from a previously executed action step. - [Keystrokes](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-keystrokes) This action step emulates keyboard inputs. - [Mouse Actions](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-mouse-actions) The Mouse Actions action step emulates mouse moves and clicks. - [Run Program](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-run-program) This action step is used to run a program by directly calling its executable file. - [Sleep](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-sleep) This action step causes the Workflow to be paused for the specified duration. - [Window Set State](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-window-set-state) This action step allows you to change the state of a specific window. --- product: RPA Builder version: 6.6 --- # Convert String > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ converts a given string or variable to any other variable type and makes it available as a set of new variables. ## Properties **Conversion Source** The string or variable that is converted. **Regular Expression** You may define a regular expression to use only a specific part of the given Conversion Source. For example, if your conversion source is "Price: €200" and you only want to use the number as an integer variable, you can set the Regular Expression \[0-9\]+ to extract the number from the conversion source. More information about regular expressions can be found in section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). ## Inbound Variables **Conversion Source** The string or variable that is converted. **Regular Expression** You may define a regular expression to use only a specific part of the given Conversion Source. For example, if your conversion source is "Price: €200" and you only want to use the number as an integer variable, you can set the Regular Expression \[0-9\]+ to extract the number from the conversion source. More information about regular expressions can be found in section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). ## Outbound Variables **AsBool** The _Conversion Source_ as a logical value (_True_ or _False_). If the input variable is a number less than ⇐0 or not the string true or True, it returns _False_. **AsInt** The _Conversion Source_ as an integer number. If the _Conversion Source_ does not contain a number, 0 is returned; otherwise it will be the first uninterrupted sequential digits from the _Source_. Decimal places are truncated in the case of floating point numbers. **AsDouble** The _Conversion Source_ as a floating point number. **AsString** The _Conversion Source_ as string value. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Convert String > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step converts a given string or variable to any other variable type and makes it available as a set of new variables. ## Properties **Conversion Source** The string or variable that is converted. **Regular Expression** You may define a regular expression to use only a specific part of the given Conversion Source. For example, if your conversion source is "Price: €200" and you only want to use the number as an integer variable, you can set the Regular Expression \[0-9\]+ to extract the number from the conversion source. More information about regular expressions can be found in section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). ## Inbound Variables **Conversion Source** The string or variable that is converted. **Regular Expression** You may define a regular expression to use only a specific part of the given Conversion Source. For example, if your conversion source is "Price: €200" and you only want to use the number as an integer variable, you can set the Regular Expression \[0-9\]+ to extract the number from the conversion source. More information about regular expressions can be found in section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). ## Outbound Variables **AsBool** The _Conversion Source_ as a logical value (_True_ or _False_). If the input variable is a number less than ⇐0 or not the string true or True, it returns _False_. **AsInt** The _Conversion Source_ as an integer number. If the _Conversion Source_ does not contain a number, 0 is returned; otherwise it will be the first uninterrupted sequential digits from the _Source_. Decimal places are truncated in the case of floating point numbers. **AsDouble** The _Conversion Source_ as a floating point number. **AsString** The _Conversion Source_ as string value. --- product: RPA Builder version: 6.6 --- # Coordinates > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Coordinates_ Action Step can be used to either specify a _Variable_ of type _Coordinates_ in the _Workflow_ or to modify existing coordinates. The X and Y coordinates used in the _Action Step_ can either be defined individually as constant values or linked as a coordinate pair to another variable of type _Coordinates_. The _Coordinates_ Action Step can also be used to define offsets to both the X and Y coordinates. The X and Y offsets are added to the X and Y coordinates respectively. The final result of applying offsets to the coordinates is provided as an output variable from the _Coordinates_ Action Step. ## Properties **Common** - **Coordinate as point** (default: 0.0) X and Y coordinates - **X Offset** (default: 0) This value specifies the X value (horizontal) to be added to the X coordinate. - **Y Offset**\* (default: This value specifies the X value (horizontal) to be added to the X coordinate. ## Inbound Variables **Coordinate** (default: 0.0) X and Y coordinates **X Offset** (default: 0) This value specifies the X value (horizontal) to be added to the X coordinate. **Y Offset**\* (default: This value specifies the X value (horizontal) to be added to the X coordinate. ## Outbound Variables **Modified Coordinate** Coordinate pair calculated at _Workflow_ runtime from (X-coordinate + X-offset) and (Y-coordinate + Y-offset). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Coordinates > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Coordinates_ action step can be used to either specify a _Variable_ of type _Coordinates_ in the _Workflow_ or to modify existing coordinates. The X and Y coordinates used in the action step can either be defined individually as constant values or linked as a coordinate pair to another variable of type _Coordinates_. The _Coordinates_ action step can also be used to define offsets to both the X and Y coordinates. The X and Y offsets are added to the X and Y coordinates respectively. The final result of applying offsets to the coordinates is provided as an output variable from the _Coordinates_ action step. ## Properties **Common** - **Coordinate as point** (default: 0.0) X and Y coordinates - **X Offset** (default: 0) This value specifies the X value (horizontal) to be added to the X coordinate. - **Y Offset**\* (default: This value specifies the X value (horizontal) to be added to the X coordinate. ## Inbound Variables **Coordinate** (default: 0.0) X and Y coordinates **X Offset** (default: 0) This value specifies the X value (horizontal) to be added to the X coordinate. **Y Offset**\* (default: This value specifies the X value (horizontal) to be added to the X coordinate. ## Outbound Variables **Modified Coordinate** Coordinate pair calculated at _Workflow_ runtime from (X-coordinate + X-offset) and (Y-coordinate + Y-offset). --- product: RPA Builder version: 6.6 --- # Copy File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ copies a file from one directory to another. If the file to be copied if not available or the copied file is already located in the destination folder, an error message will interrupt the _Workflow_. ## Properties **File Operation Settings:** - **Create directory if it does not exist** If this option is enabled, Copy File creates either the specified relative directory or the whole specified path, if this does not already exist. - **Destination directory** Enter the path to the target directory where the copied file is to be saved here. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **Directory path** This is where you enter the path to the directory where the file to be copied from. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to copy. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters). - **New File Name** Enter a new name for the file that is to be inserted. This option will only be reported if the option **Use different file name** has been selected. - **Overwrite existing file** This option enables you to overwrite an existing file with the same name in the destination folder. - **Use different file name** Selecting this option means that the copied file will be saved under a new name in the destination directory. Enter the new name in the **New File Name** field. ## Inbound Variables - **Directory path** This is where you enter the path to the directory where the file to be copied from. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be copied here. - **Destination directory** Enter the path to the target directory where the copied file is to be saved here. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. ## Outbound Variables **IsCopied** The _Copy File.IsCopied_ variable indicates whether the file could be copied or not (True/False). **Destination directory** The _Copy File.Destination directory_ variable provides the path to the destination directory. **New File Name** The _Copy File.New file Name_ variable provides the copied file’s new name. **File name** The_Copy File.File Name_ variable provides the name of the copied file. **Directory path** The _Copy File.Directory Path_ variable provides the path to the source directory. ## Wizard - **Directory path** Specify the path to the file that is to be copied here. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be copied here. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Destination directory** Specify the destination path for the file that is to be copied. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **New file name** This field will only be shown if you have enabled the option **Use different file name for copy**. The wizard uses the file name of the source file and adds _copy at the end. You can also specify the new name for the copied file yourself. You can also insert a variable from the Workflow as the \_New file name_. To do so, click on the pin and select one of the available variables. - **Overwrite existing file** If this option has not been enabled, an error message will interrupt the _Workflow_ if there is already a file with the same name in the destination directory. If this option has been enabled and the file already exists, the copied file will replace it and no acknowledgment will be given. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Copy File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step copies a file from one directory to another. If the file to be copied if not available or the copied file is already located in the destination folder, an error message will interrupt the _Workflow_. ## Properties **File Operation Settings:** - **Create directory if it does not exist** If this option is enabled, Copy File creates either the specified relative directory or the whole specified path, if this does not already exist. - **Destination directory** Enter the path to the target directory where the copied file is to be saved here. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **Directory path** This is where you enter the path to the directory where the file to be copied from. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to copy. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters). - **New File Name** Enter a new name for the file that is to be inserted. This option will only be reported if the option **Use different file name** has been selected. - **Overwrite existing file** This option enables you to overwrite an existing file with the same name in the destination folder. - **Use different file name** Selecting this option means that the copied file will be saved under a new name in the destination directory. Enter the new name in the **New File Name** field. ## Inbound Variables - **Directory path** This is where you enter the path to the directory where the file to be copied from. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be copied here. - **Destination directory** Enter the path to the target directory where the copied file is to be saved here. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. ## Outbound Variables **IsCopied** The _Copy File.IsCopied_ variable indicates whether the file could be copied or not (True/False). **Destination directory** The _Copy File.Destination directory_ variable provides the path to the destination directory. **New File Name** The _Copy File.New file Name_ variable provides the copied file’s new name. **File name** The_Copy File.File Name_ variable provides the name of the copied file. **Directory path** The _Copy File.Directory Path_ variable provides the path to the source directory. ## Wizard - **Directory path** Specify the path to the file that is to be copied here. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be copied here. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Destination directory** Specify the destination path for the file that is to be copied. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **New file name** This field will only be shown if you have enabled the option **Use different file name for copy**. The wizard uses the file name of the source file and adds _copy at the end. You can also specify the new name for the copied file yourself. You can also insert a variable from the Workflow as the \_New file name_. To do so, click on the pin and select one of the available variables. - **Overwrite existing file** If this option has not been enabled, an error message will interrupt the _Workflow_ if there is already a file with the same name in the destination directory. If this option has been enabled and the file already exists, the copied file will replace it and no acknowledgment will be given. --- product: RPA Builder version: 6.6 --- # Copy Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Copies a source folder to the target directory. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **Folder Operations Settings** - **Copy empty subfolders** Determines wether to copy empty subfolders or not. - **Copy subfolders** Determines wether to copy all subfolders and files inside them or not. - **Destination Directory Path** Path to the destination directory where to copy the source folder. - **Directory Path** Path to the directory that contains the folder to copy. - **Duplicates file handling** Determines the behavior of the workflow when it finds duplicate files during the copy. Available options are: **Overwrite files**, **Skip files**, and **Force error**. - **Filter files** Defines a filter using wildcards to specify which files to copy. By default, it is set to (`*.*`), meaning all files. ## Inbound Variables - **Destination Directory Path** - **Filter files** - **Copy subfolders** - **Copy empty subfolders** - **Directory Path** ## Outbound Variables - **Is Copied** - **Source Directory Path** - **Destination Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Copy Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Copies a source folder to the target directory. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Folder Operations Settings** - **Copy empty subfolders** Determines wether to copy empty subfolders or not. - **Copy subfolders** Determines wether to copy all subfolders and files inside them or not. - **Destination Directory Path** Path to the destination directory where to copy the source folder. - **Directory Path** Path to the directory that contains the folder to copy. - **Duplicates file handling** Determines the behavior of the workflow when it finds duplicate files during the copy. Available options are: **Overwrite files**, **Skip files**, and **Force error**. - **Filter files** Defines a filter using wildcards to specify which files to copy. By default, it is set to (`*.*`), meaning all files. ## Inbound Variables - **Destination Directory Path** - **Filter files** - **Copy subfolders** - **Copy empty subfolders** - **Directory Path** ## Outbound Variables - **Is Copied** - **Source Directory Path** - **Destination Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations) --- product: RPA Builder version: 6.6 --- # Create File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Create File_ is used to create an empty file at the specified path. ## Properties **File Operation Settings** - **Create directory if it does not exist** If this option is enabled, _Create File_ creates either the specified relative directory or the whole specified path, if this does not already exist. - **Directory path** This is where you enter the path to the directory where the file is to be created. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be created here. - **Force error if file exists** If this option has been enabled, an error message will interrupt the _Workflow_ if a file with the same name already exists. If this option has not been enabled and the file already exists, it will be replaced with an empty file and no acknowledgment will be given. - **Open with associated application** If this option has been enabled, the newly created file will be opened with the application that is associated with the file name of the new file. For example, if the new file name ends in \*.txt it will normally be opened with Notepad. Leave this option disabled if you want another _Action Step_ to be able to access the newly created file – otherwise it will be locked. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Directory path** This is where you enter the path to the directory where the file is to be created. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name**\* Enter the name of the file that is to be created here. ## Outbound Variables **IsCreated** The _Create File.IsCreated_ variable indicates whether the file could be created or not (True/False). **File name** The _Create File.File Name_ variable provides the name of the file that has been created. **Directory path** The _Create File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path here to the file that is being newly created. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. If you specify an absolute path and also enable the option **Create Directory if it does not exist**, the directory path will be created in full if it does not already exist. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file here that is to be created. If you want the file to open with the associated program (option: Open created file with associated application), you must also specify a file extension. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Force error if file exists** If this option has been enabled, an error message will interrupt the _Workflow_ if a file with the same name already exists. If this option has not been enabled and the file already exists, it will be replaced with an empty file and no acknowledgment will be given. - **Open with associated application** If this option has been enabled, the newly created file will be opened with the application that is associated with the file name of the new file. For example, if the new file name ends in \*.txt it will normally be opened with Notepad. - **Create directory if it does not exist** If this option is enabled, _Create File_ creates either the specified relative directory or the whole specified path, if this does not already exist. ## Example Create an empty file using the _Create File_ Action Step and write text to that file using the _Write to Text File_ Action Step. The _Write to Text File_ Action Step can be pointed directly to the newly created file using, for example, the _Create File.Directory Path_ and _Create File.FileName_ variables. This allows you to create your own log file containing text that is of interest to you. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Create File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Create File_ is used to create an empty file at the specified path. ## Properties **File Operation Settings** - **Create directory if it does not exist** If this option is enabled, _Create File_ creates either the specified relative directory or the whole specified path, if this does not already exist. - **Directory path** This is where you enter the path to the directory where the file is to be created. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be created here. - **Force error if file exists** If this option has been enabled, an error message will interrupt the _Workflow_ if a file with the same name already exists. If this option has not been enabled and the file already exists, it will be replaced with an empty file and no acknowledgment will be given. - **Open with associated application** If this option has been enabled, the newly created file will be opened with the application that is associated with the file name of the new file. For example, if the new file name ends in \*.txt it will normally be opened with Notepad. Leave this option disabled if you want another action step to be able to access the newly created file – otherwise it will be locked. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Directory path** This is where you enter the path to the directory where the file is to be created. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name**\* Enter the name of the file that is to be created here. ## Outbound Variables **IsCreated** The _Create File.IsCreated_ variable indicates whether the file could be created or not (True/False). **File name** The _Create File.File Name_ variable provides the name of the file that has been created. **Directory path** The _Create File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path here to the file that is being newly created. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. If you specify an absolute path and also enable the option **Create Directory if it does not exist**, the directory path will be created in full if it does not already exist. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file here that is to be created. If you want the file to open with the associated program (option: Open created file with associated application), you must also specify a file extension. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Force error if file exists** If this option has been enabled, an error message will interrupt the _Workflow_ if a file with the same name already exists. If this option has not been enabled and the file already exists, it will be replaced with an empty file and no acknowledgment will be given. - **Open with associated application** If this option has been enabled, the newly created file will be opened with the application that is associated with the file name of the new file. For example, if the new file name ends in \*.txt it will normally be opened with Notepad. - **Create directory if it does not exist** If this option is enabled, _Create File_ creates either the specified relative directory or the whole specified path, if this does not already exist. ## Example Create an empty file using the _Create File_ action step and write text to that file using the _Write to Text File_ action step. The _Write to Text File_ action step can be pointed directly to the newly created file using, for example, the _Create File.Directory Path_ and _Create File.FileName_ variables. This allows you to create your own log file containing text that is of interest to you. --- product: RPA Builder version: 6.6 --- # Create Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to create an empty folder in the specified directory path. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory where to create the folder. - **Force error if folder exists** Causes the workflow to enter an error state and stop its execution if the folder exists. ## Inbound Variables - **Force error if folder exists** - **Directory Path** ## Outbound Variables - **Directory Path** - **IsCreated** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Create Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to create an empty folder in the specified directory path. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory where to create the folder. - **Force error if folder exists** Causes the workflow to enter an error state and stop its execution if the folder exists. ## Inbound Variables - **Force error if folder exists** - **Directory Path** ## Outbound Variables - **Directory Path** - **IsCreated** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations) --- product: RPA Builder version: 6.6 --- # Credentials for AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Credentials for AWS action step enables you to set up your AWS credentials one time and then reference them in any other AWS action step that requires them. ## Inbound Variables - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** ## Outbound Variables - **AwsCredentials** ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/credentials-with-aws-wizard.png) - **Client ID** The client ID used to authenticate against AWS. - **Client Secret** The client secret used to authenticate against AWS. - **Region Endpoint** The AWS region endpoint Code to connect to, for example: `us-east-1`. See [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html) for a list of available AWS region endpoints. - **Use session token to authenticate** Select this option to specify the AWS session token to use if you are connecting to AWS resources using temporary credentials that require a session token. - **Session Token** The session token to use for authentication when **Use session token to authenticate** is selected. ## See Also - [AWS: Configuration Basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) - [AWS: Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Credentials for AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Credentials for AWS action step enables you to set up your AWS credentials one time and then reference them in any other AWS action step that requires them. ## Inbound Variables - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** ## Outbound Variables - **AwsCredentials** ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/credentials-with-aws-wizard.png) - **Client ID** The client ID used to authenticate against AWS. - **Client Secret** The client secret used to authenticate against AWS. - **Region Endpoint** The AWS region endpoint Code to connect to, for example: `us-east-1`. See [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html) for a list of available AWS region endpoints. - **Use session token to authenticate** Select this option to specify the AWS session token to use if you are connecting to AWS resources using temporary credentials that require a session token. - **Session Token** The session token to use for authentication when **Use session token to authenticate** is selected. ## See Also - [AWS: Configuration Basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) - [AWS: Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) --- product: RPA Builder version: 6.6 --- # Credentials for OAuth > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Credentials for OAuth action step enables you to set up your OAuth credentials one time and then reference them in Action Steps that support OAuth Authentication. You can create a set of tokens that don’t rely on a user password to authenticate with the email server and then use the token to repeatedly log in to the services without asking for the user’s password again. ## Properties - **OAuth Authentication** Settings - **OAuth Host** The host address used to get the credentials. The default address for Outlook services is `https://login.microsoftonline.com/common/oauth2/v2.0/`. This address might change if you use a self-hosted service. - **Client ID** To authenticate with the OAuth Host, an Azure application must be defined in your space. This Azure application has an ID, that is unique in the entire OAuth Host space and it allows users to explicitly grant or revoke access for this Azure application to their accounts. For more information on how to create this Azure application for Outlook, visit [Quickstart: Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app). - **Client Secret** Allows RPA Builder to prove to the OAuth Host that it received permission to access user accounts on behalf of the registered Azure application. Without this permission, authentication is not possible. - **Redirect Uri** The URI to which the OAuth Host redirects after the user has completed the authentication attempt. This redirect URI must be registered with the Azure application. If the entered redirect URI matches one of the registered URIs, the OAuth Host allows the authentication. - **Scopes** Defines which permissions the user grants to the Azure application. By default, RPA Builder requests the following permissions: - **offline\_access** (**Required**) Enables access via a refresh token, which you can use to repeatedly log in to the email services without requiring user interaction each time. - **https://outlook.office.com/IMAP.AccessAsUser.All** (**Required** when using IMAP) Enables reading and moving emails from the Outlook IMAP server. - **https://outlook.office.com/POP.AccessAsUser.All** (**Required** when using POP3) Enables reading emails from the Outlook POP3 server. - **https://outlook.office.com/SMTP.Send** (**Required** when using SMTP) Enables sending emails from the Outlook SMTP server. - **openid email** Enables RPA Builder to automatically detect the email account used to log in to the Azure application. If this scope is omitted, you must provide an email in the wizard. - **Save data to generate Tokens via the Tools menu** Saves the current data for further use when [Generating an OAuth Refresh Token](#generate-oauth-token). - **Email address** The email address populates automatically if RPA Builder detects it from the authentication attempt. If the **openid email** scope is omitted, you must provide an email address manually. ## Inbound Variables - **OAuth Host Address** The host address used to get the credentials. - **OAuth Client ID** The Azure application client ID. - **Client Secret** The Azure application client secret. - **Redirect Uri** The URI to which the OAuth Host redirects after the user completes the authentication attempt. - **Scopes** The set of permissions the user grants to the Azure application. - **E-mail Address** The email address. - **Refresh Token** The OAuth refresh token. ## Outbound Variables - **Credentials of OAuth** ## Wizard ![The Credentials for OAuth Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/credentials-for-oauth.png) Follow these steps to authenticate with your credentials: 1. Complete the **OAuth Authentication** configuration by specifying the required properties. Refer to [Properties](#properties) for a description of each property. 2. Click **Authenticate**. This step starts the authentication process with the OAuth Host, which opens the login page in your default browser. 3. In the OAuth Host’s login page, complete the login process. 4. Close the browser. After completing the last step, the wizard shows that you are authenticated: ![The Logged in confirmation message in the authentication settings window](/mulesoft/current/en-us/rpa-builder/6.6/_images/email-outlook-authentication.png) ### Generating an OAuth Refresh Token To generate and configure a refresh token: 1. In the **Tools** menu, select **Generate OAuth Refresh Token**. ![The Generate OAuth Refresh Token options in the Tools menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/generate-oauth-token.png) 2. Complete the **OAuth Token Creator** form that appears. ![The OAuth Token Creator Form](/mulesoft/current/en-us/rpa-builder/6.6/_images/generate-token-form.png) If you already configured the Credentials for OAuth Action Step details and clicked the **Save data to generate Tokens via the Tools menu** button, the data automatically populates with the last data you entered in the wizard. 3. Click **Authenticate**. 4. Click **Copy Token to Clipboard**. 5. Paste the token in an alphanumeric Server Based Variable. 6. Pin the variable to the field **Refresh Token** in the **Credentials for OAuth** wizard. You can also pin the other values from the **OAuth Token Creator**. By using a Server Based Variable you don’t need to upload a new version of your Workflow to RPA Manager if your token expires or your user gets logged out of Microsoft. In this case, regenerate the refresh token for the same user with the **OAuth Token Creator** and update the assigned Server Based Variable on RPA Manager. ## See Also - [Mail Session (Outlook with OAuth)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-mail-session-outlook-with-oauth) - [Azure](https://azure.microsoft.com/en-us/) - [Authenticate an EWS application by using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth) - [Authenticate an IMAP, POP or SMTP connection using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Credentials for OAuth > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Credentials for OAuth action step enables you to set up your OAuth credentials one time and then reference them in action steps that support OAuth Authentication. You can create a set of tokens that don’t rely on a user password to authenticate with the email server and then use the token to repeatedly log in to the services without asking for the user’s password again. ## Properties - **OAuth Authentication** Settings - **E-Mail Provider** Mail provider, either **Outlook** or **Google**. - **Auth Endpoint** URL for the OAuth authentication endpoint. Defaults to the following values, depending on the selected provider: - **Outlook**: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` - **Google**: `https://accounts.google.com/o/oauth2/v2/auth` - **Token Endpoint** URL for the OAuth Refresh Token process. Defaults to the following values, depending on the selected provider: - **Outlook**: `https://login.microsoftonline.com/common/oauth2/v2.0/token` - **Google**: `https://www.googleapis.com/oauth2/v4/token` - **Client ID** Client ID of your mail application. To authenticate with the OAuth host, you must define an Azure or Gmail application in your space. This application has an ID, that is unique in the entire OAuth host space and it enables users to explicitly grant or revoke access for this application to their accounts. For more information on how to create an Azure application for Outlook, visit [Quickstart: Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app). - **Client Secret** Client Secret of your mail application. Allows RPA Builder to prove to the OAuth host that it received permission to access user accounts. Without this permission, authentication is not possible. - **Redirect URI** URI that the OAuth host redirects to after the user completes the authentication attempt. This redirect URI must be registered with the Azure or Gmail application. If the entered redirect URI matches one of the registered URIs, the OAuth host allows the authentication. - **Scopes** Defines which permissions the user grants to the Azure or Gmail application. By default, RPA Builder requests the following permissions depending on the selected provider: - **Outlook** - **`offline_access`** (Required) Enables access via a refresh token, which you can use to repeatedly log in to the email services without requiring user interaction each time. - **`https://outlook.office.com/IMAP.AccessAsUser.All`** (Required when using IMAP) Enables reading and moving emails from the Outlook IMAP server. - **`https://outlook.office.com/POP.AccessAsUser.All`** (Required when using POP3) Enables reading emails from the Outlook POP3 server. - **`https://outlook.office.com/SMTP.Send`** (Required when using SMTP) Enables sending emails from the Outlook SMTP server. - **`openid email`** Enables RPA Builder to automatically detect the email account used to log in to the Azure application. If this scope is omitted, you must provide an email in the wizard. - **Google** - **`https://mail.google.com/`** Enables RPA Builder to read, compose, send, and permanently delete emails from your Gmail account. - **Save data to generate Tokens via the Tools menu** Saves the current data for further use when [generating an OAuth refresh token](#generate-oauth-token). - **Email address** The email address populates automatically if RPA Builder detects it from the authentication attempt. If the **openid email** scope is omitted, you must provide an email address manually. ## Inbound Variables - **OAuth Host Address** The host address used to get the credentials. - **OAuth Client ID** The Azure application client ID. - **Client Secret** The Azure application client secret. - **Redirect Uri** The URI to which the OAuth Host redirects after the user completes the authentication attempt. - **Scopes** The set of permissions the user grants to the Azure application. - **E-mail Address** The email address. - **Refresh Token** The OAuth refresh token. ## Outbound Variables - **Credentials of OAuth** ## Wizard ![The Credentials for OAuth Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/credentials-for-oauth.png) Follow these steps to authenticate with your credentials: 1. Complete the **OAuth Authentication** configuration by specifying the required properties. Refer to [Properties](#properties) for a description of each property. 2. Click **Authenticate**. This step starts the authentication process with the OAuth Host, which opens the login page in your default browser. 3. In the OAuth Host’s login page, complete the login process. 4. Close the browser. After completing the last step, the wizard shows that you are authenticated: ![The Logged in confirmation message in the authentication settings window](/mulesoft/current/en-us/rpa-builder/latest/_images/email-outlook-authentication.png) ## Generate an OAuth Refresh Token To generate and configure a refresh token: 1. In the **Tools** menu, select **Generate OAuth Refresh Token**. ![The Generate OAuth Refresh Token options in the Tools menu](/mulesoft/current/en-us/rpa-builder/latest/_images/generate-oauth-token.png) 2. Complete the **OAuth Token Creator** form that appears. ![The OAuth Token Creator Form](/mulesoft/current/en-us/rpa-builder/latest/_images/generate-token-form.png) If you already configured the Credentials for OAuth action step details and clicked the **Save data to generate Tokens via the Tools menu** button, the data automatically populates with the last data you entered in the wizard. 3. Click **Authenticate**. 4. Click **Copy Token to Clipboard**. 5. Paste the token in an alphanumeric activity parameter. 6. Pin the variable to the field **Refresh Token** in the **Credentials for OAuth** wizard. You can also pin the other values from the **OAuth Token Creator**. By using an activity parameter, you don’t need to upload a new version of your Workflow to RPA Manager if your token expires or your user gets logged out of your email provider. In this case, regenerate the refresh token for the same user with the **OAuth Token Creator** and update the assigned activity parameter on RPA Manager. ## See Also - [Mail Session (OAuth)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-mail-session-oauth) - [Azure](https://azure.microsoft.com/en-us/) - [Authenticate an EWS application by using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth) - [Authenticate an IMAP, POP or SMTP connection using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth) --- product: RPA Builder version: 6.6 --- # Delete File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Delete File_ will delete a file located at the specified path. The Action Step can be used, for example, to delete files which were generated within a _Workflow_. If the file for deletion does not exist, the Action Step does **not** terminate the Workflow with an error. There is however an option that enables the generation of an error message in the event of a non-existent file. ## Properties **File Operation Settings** - **Directory path** Enter the path to the directory from which the file is to be deleted. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to delete. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters). - **Force error if file does not exist** If this option has been enabled, an error message will interrupt the _Workflow_ if the file for deletion does not exist. If this option is not enabled and the file does not exist, the _Workflow_ will continue and no error message will be generated. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Directory path** Enter the path to the directory from which the file is to be deleted. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be deleted. ## Outbound Variables **IsDeleted** The _Delete File.IsDeleted_ variable indicates whether the file could be deleted or not (True/False). **File Name** The _Delete File.File Name_ variable provides the name of the file that is to be deleted. **Directory path** The _Delete File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be deleted. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be deleted. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Force error if file does not exist** If this option has been enabled, an error message will interrupt the _Workflow_ if the file for deletion does not exist. If this option is not enabled and the file does not exist, the _Workflow_ will continue and no error message will be generated. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Delete File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Delete File_ will delete a file located at the specified path. The action step can be used, for example, to delete files which were generated within a _Workflow_. If the file for deletion does not exist, the action step does **not** terminate the Workflow with an error. There is however an option that enables the generation of an error message in the event of a non-existent file. ## Properties **File Operation Settings** - **Directory path** Enter the path to the directory from which the file is to be deleted. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to delete. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters). - **Force error if file does not exist** If this option has been enabled, an error message will interrupt the _Workflow_ if the file for deletion does not exist. If this option is not enabled and the file does not exist, the _Workflow_ will continue and no error message will be generated. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables - **Directory path** Enter the path to the directory from which the file is to be deleted. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file that is to be deleted. ## Outbound Variables **IsDeleted** The _Delete File.IsDeleted_ variable indicates whether the file could be deleted or not (True/False). **File Name** The _Delete File.File Name_ variable provides the name of the file that is to be deleted. **Directory path** The _Delete File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be deleted. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be deleted. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Force error if file does not exist** If this option has been enabled, an error message will interrupt the _Workflow_ if the file for deletion does not exist. If this option is not enabled and the file does not exist, the _Workflow_ will continue and no error message will be generated. --- product: RPA Builder version: 6.6 --- # Delete Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to delete a folder and all its content. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory that contains the folder to delete. - **Force error if folder does not exist** Causes the workflow to enter an error state and stop its execution if the folder does not exist. - **Only delete if folder is empty** Causes the workflow to enter an error state and stop its execution if the folder exists but it’s not empty. ## Inbound Variables - **Force error if folder does not exist** - **Only delete if folder is empty** - **Directory Path** ## Outbound Variables - **Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Delete Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this action step to delete a folder and all its content. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory that contains the folder to delete. - **Force error if folder does not exist** Causes the workflow to enter an error state and stop its execution if the folder does not exist. - **Only delete if folder is empty** Causes the workflow to enter an error state and stop its execution if the folder exists but it’s not empty. ## Inbound Variables - **Force error if folder does not exist** - **Only delete if folder is empty** - **Directory Path** ## Outbound Variables - **Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations) --- product: RPA Builder version: 6.6 --- # Document Processing > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The document processing action steps enable you to extract data from documents and translate text by using the Amazon Translate and Amazon Textract services. Action steps that use Amazon Textract services process the document in a synchronous fashion, therefore Amazon does not store the document. These action steps automatically convert PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid of the action step. To use these action steps, you need an active subscription to AWS. - [Credentials For AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) The Credentials for AWS action step enables you to set up your AWS credentials one time and then reference them in any other AWS action step that requires them. - [Entitites With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-entities-with-aws) The Entities with AWS action step enables you to use Amazon Comprehend to inspect text for named entities and return information about them. - [ERP Docs With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-erp-docs-with-aws) The ERP Docs with AWS enables you to use Amazon Textract to analyze invoices and receipts to extract relevant data. - [Key Values With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-key-values-with-aws) The Key values with AWS action step enables you to extract form data by sending a local file to the AWS Textract service, which returns the extracted key-value pairs. - [OCR With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-ocr-with-aws) The OCR with AWS action step enables you to recognize the text in a document by sending a local file to the AWS Textract service, which returns the extracted values. - [Queries With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-queries-with-aws) The Queries with AWS action step enables you to extract specific data from a document by specifying a query parameter so that the response contains the data you need, without having to apply further filtering on the JSON output to get the relevant values. - [Signature Detection with AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-signature-detection-with-aws) The Signature Detection with AWS action step enables you to detect single or multiple signatures in files such as PNG, JPEG, or PDF. - [Tables With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-tables-with-aws) The Tables with AWS action step enables you to recognize the text values inside a table by sending a local file to the AWS Textract service, which returns the extracted values. - [Translate With AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-translate-with-aws) The translate with AWS action step enables you to use the Amazon Translate service to translate the specified text. ## See Also - [Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/what-is.html) - [Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/what-is.html) - [Amazon Translate](https://docs.aws.amazon.com/translate/latest/dg/what-is.html) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Document Processing > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The document processing action steps enable you to extract data from documents and translate text by using the Amazon Translate and Amazon Textract services. Action steps that use Amazon Textract services process the document in a synchronous fashion, therefore Amazon does not store the document. These action steps automatically convert PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid of the action step. To use these action steps, you need an active subscription to AWS. - [Credentials For AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) The Credentials for AWS action step enables you to set up your AWS credentials one time and then reference them in any other AWS action step that requires them. - [Entitites With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-entities-with-aws) The Entities with AWS action step enables you to use Amazon Comprehend to inspect text for named entities and return information about them. - [ERP Docs With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-erp-docs-with-aws) The ERP Docs with AWS enables you to use Amazon Textract to analyze invoices and receipts to extract relevant data. - [Key Values With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-key-values-with-aws) The Key values with AWS action step enables you to extract form data by sending a local file to the AWS Textract service, which returns the extracted key-value pairs. - [OCR With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-ocr-with-aws) The OCR with AWS action step enables you to recognize the text in a document by sending a local file to the AWS Textract service, which returns the extracted values. - [Queries With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-queries-with-aws) The Queries with AWS action step enables you to extract specific data from a document by specifying a query parameter so that the response contains the data you need, without having to apply further filtering on the JSON output to get the relevant values. - [Signature Detection with AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-signature-detection-with-aws) The Signature Detection with AWS action step enables you to detect single or multiple signatures in files such as PNG, JPEG, or PDF. - [Tables With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-tables-with-aws) The Tables with AWS action step enables you to recognize the text values inside a table by sending a local file to the AWS Textract service, which returns the extracted values. - [Translate With AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-translate-with-aws) The translate with AWS action step enables you to use the Amazon Translate service to translate the specified text. ## See Also - [Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/what-is.html) - [Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/what-is.html) - [Amazon Translate](https://docs.aws.amazon.com/translate/latest/dg/what-is.html) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Download from Google Drive > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Download or Export files from your Google Drive. You can export Google Docs, Sheets, and Slides to several supported formats, including PDF. ## Before You Begin Before downloading a file: - Configure your Google API Service Account Credentials. You can configure your credentials as an [Activity Parameter](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters#defining-activity-parameters) or inline in the wizard. - Obtain the corresponding File ID by using the Search in Google Drive action step. ## Configure Your Authentication Settings Configure your authentication settings for the Google API service account in the **Authentication Settings** panel. Select **Pin credentials** to specify the activity parameter containing the credentials, or select **Use custom settings** to provide the information inline. You can either import a JSON file with your Google API credentials information or specify the authentication information manually. ## Configure File Download or Export Settings To configure download or export file settings in the wizard: 1. In **Download Settings**, select between **Download file** or **Export Google Workspace document**, depending on the operation to perform. - When exporting a file, select the type of Google file to export (Docs, Sheets, or Slides) and the format for the target file. Available export formats depend on the file being exported. 2. Provide the file ID of the file to download or export. To obtain this ID, use the Search in Google Drive action step. 3. Specify the directory path where you want to download or export the file from your Google Drive. You can specify this action step to create the target directory if it doesn’t exist and to overwrite any existing file in the directory path that contains the same name as the file to download or export. 4. To rename the downloaded or exported file, select **Set new file name** and provide the file name to use, including its extension. ## Properties - **Authentication Settings** - **Auth Provider x509 Cert URL** Authentication provider certificate URL for the Google API credentials. - **Auth URI** OAuth2 authentication URI for the Google API credentials. - **Client Email** Client email of the Google API credentials. - **Client ID** Client ID of the Google API credentials. - **Client x509 Cert URL** Client certificate URL for the Google API credentials. - **Credential Type** Type of Google API credentials. For example, `service_account`. - **Google API Service Account Credentials** Activity parameter containing all Google API credentials. - **Project ID** Project ID of the Google API credentials. - **Token URI** OAuth2 token URI for the Google API credentials. - **Universe Domain** Universe domain of the Google API credentials. - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) - **File ID** ID of the file to download or export. - **Google drive file type** Type of Google file to export. Available types are: - **Google Docs** - **Google Sheets** - **Google Slides** - **Operation mode** Operation to perform, either **DownloadFile** or **ExportDocument**. - **Docs type** File format for exporting Google Docs. Available types: - **Microsoft Word (.docx)** - **OpenDocument (.odt)** - **Rich Text (.rtf)** - **PDF (.pdf)** - **Plain Text (.txt)** - **Web Page (HTML) (.zip)** - **EPUB (.epub)** - **Sheets Type** File format for exporting Google Sheets. Available types: - **Microsoft Excel (.xlsx)** - **OpenDocument (.ods)** - **PDF (.pdf)** - **Web Page (HTML) (.zip)** - **Comma-Separated Values (first-sheet only) (.csv)** - **Tab-Separated Values (first-sheet only) (.tsv)** - **Slides Type** File format for exporting Google Slides. Available types: - **Microsoft PowerPoint (.pptx)** - **ODP (.odp)** - **PDF (.pdf)** - **Plain Text (.txt)** - **JPEG (first-slide only) (.jpg)** - **PNG (first-slide only) (.png)** - **Scalable Vector Graphics (first-slide only) (.svg)** - **Google Drive File Settings** - **Create directory if it does not exist** If selected, creates the folder specified in **Directory path** if it doesn’t exist. - **Directory path** Path to the directory to download or export the file. - **New file name** File name to use if **Set new file name** is enabled. You must specify the file name, including the extension. - **Overwrite existing file** If selected, overwrites any existing file in the specified download directory that has the same name as the downloaded or exported file. - **Set new file name** If selected, renames the downloaded or exported file using the specified **New file name**. ## Inbound Variables - **File ID** - **Directory Path** - **Create directory if it does not exist** - **Overwrite existing file** - **Set new file name** - **New file name** - **Credential Type** - **Project ID** - **Private Key ID** - **Private Key** - **Token URI** - **Auth Provider x509 Cert URL** - **Auth URI** - **Client Email** - **Client ID** - **Client x509 Cert URL** - **Universe Domain** - **Google API Service Account Credentials** ## Outbound Variables - **Download Succeeded** Boolean indicating whether the download was successful (`true`) - **Target folder** String containing the directory path to the downloaded or exported file - **File name** String containing the file name and extension ## See Also - [Activity Parameters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters) - [Google Workspace](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-drive-operations) --- product: RPA Builder version: 6.6 --- # Enter String > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Like the _Keystrokes_ Action Step, the _Enter String_ Action Step emulates keyboard inputs. You can use this to enter search criteria or a URL in the browser address bar, for example. You can also use it to execute hotkeys or macros. The text to be entered can be transferred to the _Enter String_ Action Step from a previously executed Action Step. ## Properties **Input String Settings** **Input string** (string, default blank, cannot be left blank, mapping possible) String to be entered via the emulated keyboard. **Keyboard Settings** - **Initial pause** (integer, ms, default 500 ms, minimum value 0 ms) Pause before emulation of the string input begins. - **Key down delay** (default 5 ms, maximum 1000 ms) Duration in ms for which a key or combination of keys is held down. The input will be executed at the start of this delay. - **Key up delay** (default 5 ms, maximum 1000 ms) Duration in ms for which a key or combination of keys is released. **Window Settings** - **Use a regular expression for window title** If this option is active, the string entered in the _Window Title_ field will be interpreted as a regular expression (see also the section on [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions)). - **Window title** Title of the window where the keyboard inputs are to be executed. ## Inbound Variables **Input string** **Window title** ## Outbound Variables The _Enter String_ Action Step possesses no Outbound Variables. ## Wizard **Input String Settings** The Input String can be supplemented by Insert Variables. **Window Handling Timing** You have the option to specify the title of the window where the string is to be entered under Window Title. If you click on the Collect Window Titles button you can then select a title from the drop-down list of all the windows which are presently open. To open them click the mouse on the arrow symbol at the right-hand side of the input window. The _Window title_ can also be described using a regular expression. For this, please select the check box to _Use a regular expression for window title_. Please make sure for extended input sequences that the _Key up delay_ is set for long enough to send the keyboard inputs to the correct window. There is a visual explaining Keyboard Settings in the section on Keystrokes. ## Enter String or Keystrokes? If you need the _window text_ to specify the input window or want to record the text that is to be entered directly via the keyboard, please use the _Keystrokes_ Action Step. In all other cases, and in particular if the text for inputting is to be transferred by means of a Pin Variable, please use the _Enter String_ Action Step. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Enter String > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Like the _Keystrokes_ action step, the _Enter String_ action step emulates keyboard inputs. You can use this to enter search criteria or a URL in the browser address bar, for example. You can also use it to execute hotkeys or macros. The text to be entered can be transferred to the _Enter String_ Action Step from a previously executed action step. ## Properties **Input String Settings** **Input string** (string, default blank, cannot be left blank, mapping possible) String to be entered via the emulated keyboard. **Keyboard Settings** - **Initial pause** (integer, ms, default 500 ms, minimum value 0 ms) Pause before emulation of the string input begins. - **Key down delay** (default 5 ms, maximum 1000 ms) Duration in ms for which a key or combination of keys is held down. The input will be executed at the start of this delay. - **Key up delay** (default 5 ms, maximum 1000 ms) Duration in ms for which a key or combination of keys is released. **Window Settings** - **Use a regular expression for window title** If this option is active, the string entered in the _Window Title_ field will be interpreted as a regular expression (see also the section on [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions)). - **Window title** Title of the window where the keyboard inputs are to be executed. ## Inbound Variables **Input string** **Window title** ## Outbound Variables The _Enter String_ action step possesses no Outbound Variables. ## Wizard **Input String Settings** The Input String can be supplemented by Insert Variables. **Window Handling Timing** You have the option to specify the title of the window where the string is to be entered under Window Title. If you click on the Collect Window Titles button you can then select a title from the drop-down list of all the windows which are presently open. To open them click the mouse on the arrow symbol at the right-hand side of the input window. The _Window title_ can also be described using a regular expression. For this, please select the check box to _Use a regular expression for window title_. Please make sure for extended input sequences that the _Key up delay_ is set for long enough to send the keyboard inputs to the correct window. There is a visual explaining Keyboard Settings in the section on Keystrokes. ## Enter String or Keystrokes? If you need the _window text_ to specify the input window or want to record the text that is to be entered directly via the keyboard, please use the _Keystrokes_ action step. In all other cases, and in particular if the text for inputting is to be transferred by means of a Pin Variable, please use the _Enter String_ action step. --- product: RPA Builder version: 6.6 --- # Entities With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Entities with AWS action step enables you to use Amazon Comprehend to inspect text for named entities and return information about them. ## Inbound Variables - **Text** The ext to analyze and extract entities from. - **Json Path** Json Path Expression to filter the Normalized Json outbound result. - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** ## Outbound Variables - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/entities-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **Text** The text to analyze. - **Language** The language of the source text to analyze. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/what-is.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Entities With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Entities with AWS action step enables you to use Amazon Comprehend to inspect text for named entities and return information about them. ## Inbound Variables - **Text** The ext to analyze and extract entities from. - **Json Path** Json Path Expression to filter the Normalized Json outbound result. - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** ## Outbound Variables - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/entities-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **Text** The text to analyze. - **Language** The language of the source text to analyze. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/what-is.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # ERP Docs with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The ERP Docs with AWS enables you to use Amazon Textract to analyze invoices and receipts to extract relevant data. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/erp-docs-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # ERP Docs with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The ERP Docs with AWS enables you to use Amazon Textract to analyze invoices and receipts to extract relevant data. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/erp-docs-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Excel Controlled Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Excel Controlled Loop to read an Excel file and make the data available as variables. This Action Step works in a similar way to the [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-file-controlled-loop) and also forms the framework for other Action Steps. The wizard provides setting options for determining the start (Read mode) and the end (Terminate loop) of the iteration. The _Excel Controlled Loop_ Action Step works only within an Excel Session, in which you specify the file to read. Excel Control Loop automatically recognizes the data type of each column. For Date types, the Action Step uses the system’s locale settings to read and display the dates to ensure that the format remains unchanged. ## Properties **Excel Operation Settings** - **Column** The starting column in the Excel sheet to read data from. - **Empty rows count for break** The number of consecutive empty rows after which the loop terminates. - **End column** The ending column in the Excel sheet to read data from. - **End row** The last row to read and terminate the loop. - **Has a header** Select this option to use the first row of the source file as the column header. - **Maximum number of rows** The maximum number of rows to read. - **Only read a maximum number of rows** Select this option to restrict the number of rows to read. - **Read mode** The selected read mode. - **Regex condition for break** The regular expression at which the iteration stops. - **Regex condition for first cell** The regular expression for the cell to start reading from in the Excel sheet. - **Row** The row to start reading from in the Excel sheet. - **Sheet name** Name of the spreadsheet. Enter the name manually using this property or use the wizard to select the spreadsheet directly or via the pin variable. - **Stop (loop break) criterion** The selected termination criterion (Terminate Loop). **Troubleshooting settings** - **Disable recalculation of date formulas** Disables the recalculation of cell values formatted as DateTime to prevent RPA Builder from becoming unresponsive while it finishes calculating formulas that contain many dependencies. ## Inbound Variables - **Sheet name** Name of the spreadsheet. Enter the name manually using this property or use the wizard to select the spreadsheet directly or via the pin variable. - **Column** The starting column in the Excel sheet to read data from. - **Row** The row to start reading from in the Excel sheet. - **Regex to match** ## Outbound Variables Excel Controlled Loop returns the contents of each column as variables. - **Iteration Count** Number of loop cycles. - **RowNumber** The number of lines to read. ## Wizard Use **Read mode** to define the read area. Excel Controlled Loop does not read nor analyze data that is outside of the defined area. The following read modes are available: - **Read entire sheet** (default) - **Start reading from row and column** Select this mode to specify the column and row to start reading from. - **Read part of sheet** Select this mode to specify both a starting and an ending point to read from. - **Read to row** Select this option to specify the row in the spreadsheet to start reading from. - **Read to column** Select this option to specify the column in the spreadsheet to start reading from. - **Start reading when condition matches** Select this option to determine the read area dynamically by using regular expressions. For example, if you specify `^PLZ`, the Action Step reads the spreadsheet from the cell in which the content starts with `PLZ`. Use **Terminate loop** to specify the terminate conditions for the read operation. - **On reaching the end of sheet area** (default) - **On reaching empty rows** The operation ends after reading the specified number of consecutive empty rows. - **On Regex match in the cell value** The operation ends dynamically based on the specified regular expression. For example, if you specify `^PLZ`, the read operation ends when the content of a cell begins with `PLZ`. - **Only read a maximum number of rows** The operation ends after reading the specified number of rows. If you specify a read area in **Read mode** or use the **Only read a maximum number of rows** option and you also define a termination condition under **Terminate loop**, the read operation finishes when the first of these conditions is met. Click **Preview** to display the contents of the selected read area. The preview shows a maximum of 20 rows. To use the first row as the column header, select **Has a header**. If you don’t specify headers, the Action Step automatically creates headers as _Column\_1_, _Column\_2_, etc. To change the data type of each column, use the **Type:** dropdown menus in the preview. ## See Also - [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session) - [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Excel Controlled Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Excel Controlled Loop to read an Excel file and make the data available as variables. This action step works in a similar way to the [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-file-controlled-loop) and also forms the framework for other action steps. The wizard provides setting options for determining the start (Read mode) and the end (Terminate loop) of the iteration. The _Excel Controlled Loop_ action step works only within an Excel Session, in which you specify the file to read. Excel Control Loop automatically recognizes the data type of each column. For Date types, the action step uses the system’s locale settings to read and display the dates to ensure that the format remains unchanged. ## Properties **Excel Operation Settings** - **Column** The starting column in the Excel sheet to read data from. - **Empty rows count for break** The number of consecutive empty rows after which the loop terminates. - **End column** The ending column in the Excel sheet to read data from. - **End row** The last row to read and terminate the loop. - **Has a header** Select this option to use the first row of the source file as the column header. - **Maximum number of rows** The maximum number of rows to read. - **Only read a maximum number of rows** Select this option to restrict the number of rows to read. - **Read mode** The selected read mode. - **Regex condition for break** The regular expression at which the iteration stops. - **Regex condition for first cell** The regular expression for the cell to start reading from in the Excel sheet. - **Row** The row to start reading from in the Excel sheet. - **Sheet name** Name of the spreadsheet. Enter the name manually using this property or use the wizard to select the spreadsheet directly or via the pin variable. - **Stop (loop break) criterion** The selected termination criterion (Terminate Loop). **Troubleshooting settings** - **Disable recalculation of date formulas** Disables the recalculation of cell values formatted as DateTime to prevent RPA Builder from becoming unresponsive while it finishes calculating formulas that contain many dependencies. ## Inbound Variables - **Sheet name** Name of the spreadsheet. Enter the name manually using this property or use the wizard to select the spreadsheet directly or via the pin variable. - **Column** The starting column in the Excel sheet to read data from. - **Row** The row to start reading from in the Excel sheet. - **Regex to match** ## Outbound Variables Excel Controlled Loop returns the contents of each column as variables. - **Iteration Count** Number of loop cycles. - **RowNumber** The number of lines to read. ## Wizard Use **Read mode** to define the read area. Excel Controlled Loop does not read nor analyze data that is outside of the defined area. The following read modes are available: - **Read entire sheet** (default) - **Start reading from row and column** Select this mode to specify the column and row to start reading from. - **Read part of sheet** Select this mode to specify both a starting and an ending point to read from. - **Read to row** Select this option to specify the row in the spreadsheet to start reading from. - **Read to column** Select this option to specify the column in the spreadsheet to start reading from. - **Start reading when condition matches** Select this option to determine the read area dynamically by using regular expressions. For example, if you specify `^PLZ`, the action step reads the spreadsheet from the cell in which the content starts with `PLZ`. Use **Terminate loop** to specify the terminate conditions for the read operation. - **On reaching the end of sheet area** (default) - **On reaching empty rows** The operation ends after reading the specified number of consecutive empty rows. - **On Regex match in the cell value** The operation ends dynamically based on the specified regular expression. For example, if you specify `^PLZ`, the read operation ends when the content of a cell begins with `PLZ`. - **Only read a maximum number of rows** The operation ends after reading the specified number of rows. If you specify a read area in **Read mode** or use the **Only read a maximum number of rows** option and you also define a termination condition under **Terminate loop**, the read operation finishes when the first of these conditions is met. Click **Preview** to display the contents of the selected read area. The preview shows a maximum of 20 rows. To use the first row as the column header, select **Has a header**. If you don’t specify headers, the action step automatically creates headers as _Column\_1_, _Column\_2_, etc. To change the data type of each column, use the **Type:** dropdown menus in the preview. ## See Also - [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session) - [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions) --- product: RPA Builder version: 6.6 --- # Excel Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Excel operations enable you to interact with Microsoft Excel files by extracting and manipulating their data. - [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-controlled-loop) Use Excel Controlled Loop to iterate over data from an Excel file. - [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session) The Excel Session is an element that encompasses all Excel operations. Excel operations include the reading, modification, and creation of entire files and file elements in the Excel format. - [Read from Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-read-from-excel-file) Use Read from Excel File to read the contents of an Excel file. - [Recalculate Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-recalculate-excel-file) Use Recalculate Excel File to recalculate the values of an Excel sheet. - [Save Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-save-excel-file) Use Save Excel File to save the contents of an Excel file. - [Write to Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-write-to-excel-file) Use Write to Excel File to write content to the selected Excel file. You can write the content to the same file or to a new destination file. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Excel Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Excel operations enable you to interact with Microsoft Excel files by extracting and manipulating their data. - [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-controlled-loop) Use Excel Controlled Loop to iterate over data from an Excel file. - [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session) The Excel Session is an element that encompasses Excel operations, except for Execute Excel Macro. Excel operations include reading, modifying, and creating entire files and file elements in Excel format. - [Execute Excel Macro](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-execute-excel-macro) Run a macro in an Excel file or sheet. This action step doesn’t run inside an Excel Session. - [Read from Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-read-from-excel-file) Use Read from Excel File to read the contents of an Excel file. - [Recalculate Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-recalculate-excel-file) Use Recalculate Excel File to recalculate the values of an Excel sheet. - [Save Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-save-excel-file) Use Save Excel File to save the contents of an Excel file. - [Write to Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-write-to-excel-file) Use Write to Excel File to write content to the selected Excel file. You can write the content to the same file or to a new destination file. --- product: RPA Builder version: 6.6 --- # Excel Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Excel Session is an element that encompasses all Excel operations. Excel operations include the reading, modification, and creation of entire files and file elements in the Excel format. Excel Session supports reading and writing password protected Excel files. In Excel Session you define which Excel files to open, their location, and how to use them. Use other Action Steps within Excel Session to process the information from the Excel files. Excel Session opens the Excel files at the beginning of the execution and closes them at the end of the session. An Excel Session may contain a maximum of one embedded Excel Session. To execute a loop across all the elements in a row or column in an Excel file, use the [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-controlled-loop) Actions Step. > [!WARNING] Never set an Excel Session inside a loop to achieve this result because it negatively > impacts performance. Using Excel operations does not require having Microsoft Excel installed on the computer. ## Properties **Destination Excel Operation Settings** The Destination Excel Operation Settings are only relevant if you have selected the mode Read from source and write to different file. - **Create destination file** (Bool, default: False) Determines whether the destination file should be created if it doesn’t exist already. - **Destination file name** (string, no default) Name of the destination file, i.e. the file that will be written. - **Different destination directory path for workflow run** If the option _Use different destination directory path for workflow run_ is activated, the alternative destination directory specified here is used at runtime. - **Different destination file name for workflow run** If the option _Use different destination file name for workflow run_ is activated, the alternative file name is used at runtime. - **Directory Path** (string, default: `%STWS_BASEPATH%`)Path to the directory where the destination file is located Only a single file name is used for the destination file, regardless of whether a different directory path is used at the time of execution compared to the time of design. - **Sheet name to be added** (string, no default) Name of the sheet that is to be added to the destination file - **Use different destination directory path for workflow run** If this option is activated, an alternative path is used at runtime. - **Use different destination file name for workflow run** If this option is activated, an alternative file name is used at runtime. **Excel Operation Settings** - **Operation mode** (drop-down selection, default: Read only) Type of _Excel Operation_. There are three different modes available: - **Read only** The source file is read only and cannot be modified - **Read and write to the same file** The source file is read and can be modified - **Read from source and write to different file** The source file is read but cannot be modified. Furthermore, a destination file is opened and this is where changes are made. **Source Excel Operation Settings** - **Different source directory path for workflow run** (string, no default) If _Use separate source directory path for Execution_ is selected, the path specified here will be used as the path to the directory in which the source file is located. - **Different source file name for workflow run** If the option _Use different source file name for workflow run_ is activated, the alternative file name is used at runtime. - **Directory Path** (string, default: `%STWS_BASEPATH%`)Path to the directory where the source file is located - **Source file name** (string, no default) Name of the source file. The file to read and write to when using the _Read and write to the same file_ mode. - **Use different source directory path for workflow run** (Bool, default: False) Determines whether to use a different source directory when executing the Workflow instead of the directory used during design. - **Use different source file name for workflow run** (Bool., default: False) Determines whether to use an alternative file name when running the workflow instead of the draft name. ## Inbound Variables - **DirectoryPathSource** - **FileNameSource** - **Separate source** - **DirectoryPathDestination** - **FileNameDestination** - **CreateDstIfNotExists** - **SheetToBeCreated** ## Outbound Variables This Action Step has no outbound variables. ## Wizard Use the **Operation Mode** section to choose whether to only read the Excel file, read and modify, or read and then write to a different Excel file. The **Source file** is the file to read. Specify the path to the directory where the source file is located in the **Directory path** field, either manually or using Environment and Script Variables, the file explorer, or a Pin Variable. Specify the file to open in the **File name** field, either manually, using the file explorer, or a Pin Variable. To specify a different file to use at execution time than the one used during creation, select **Use different source file name for workflow run**. In this case, the file names and extensions must be identical and you must specify both. If the Excel file requires a password, select **Excel file is password protected** and specify the password to open the file. Select **Create Excel file if it doesn’t exist** to create the Excel file if the specified file name does not exist in the directory path. You can use a second file as the **Destination file**. In this case, the source file is read-only and you cannot modify it. The destination file is for storing information. If the destination file does not exist, Excel Session creates it if you select **Create destination file if it doesn’t exist**. To specify a separate dynamic Excel file to use during the execution, select **Use different source file name for workflow run** and specify the file in the **Different file name** field, either manually, using the file explorer, or with a Pin Variable. ## See Also - [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-controlled-loop) - [Read from Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-read-from-excel-file) - [Recalculate Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-recalculate-excel-file) - [Write to Excel File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-write-to-excel-file) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Excel Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Excel Session is an element that encompasses all Excel operations. Excel operations include the reading, modification, and creation of entire files and file elements in the Excel format. Excel Session supports reading and writing password protected Excel files. In Excel Session you define which Excel files to open, their location, and how to use them. Use other action steps within Excel Session to process the information from the Excel files. Excel Session opens the Excel files at the beginning of the execution and closes them at the end of the session. An Excel Session may contain a maximum of one embedded Excel Session. To execute a loop across all the elements in a row or column in an Excel file, use the [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-controlled-loop) Actions Step. > [!WARNING] Never set an Excel Session inside a loop to achieve this result because it negatively > impacts performance. Using Excel operations does not require having Microsoft Excel installed on the computer. ## Properties **Destination Excel Operation Settings** The Destination Excel Operation Settings are only relevant if you have selected the mode Read from source and write to different file. - **Create destination file** (Bool, default: False) Determines whether the destination file should be created if it doesn’t exist already. - **Destination file name** (string, no default) Name of the destination file, i.e. the file that will be written. - **Different destination directory path for workflow run** If the option _Use different destination directory path for workflow run_ is activated, the alternative destination directory specified here is used at runtime. - **Different destination file name for workflow run** If the option _Use different destination file name for workflow run_ is activated, the alternative file name is used at runtime. - **Directory Path** (string, default: `%STWS_BASEPATH%`)Path to the directory where the destination file is located Only a single file name is used for the destination file, regardless of whether a different directory path is used at the time of execution compared to the time of design. - **Sheet name to be added** (string, no default) Name of the sheet that is to be added to the destination file - **Use different destination directory path for workflow run** If this option is activated, an alternative path is used at runtime. - **Use different destination file name for workflow run** If this option is activated, an alternative file name is used at runtime. **Excel Operation Settings** - **Operation mode** (drop-down selection, default: Read only) Type of _Excel Operation_. There are three different modes available: - **Read only** The source file is read only and cannot be modified - **Read and write to the same file** The source file is read and can be modified - **Read from source and write to different file** The source file is read but cannot be modified. Furthermore, a destination file is opened and this is where changes are made. **Source Excel Operation Settings** - **Different source directory path for workflow run** (string, no default) If _Use separate source directory path for Execution_ is selected, the path specified here will be used as the path to the directory in which the source file is located. - **Different source file name for workflow run** If the option _Use different source file name for workflow run_ is activated, the alternative file name is used at runtime. - **Directory Path** (string, default: `%STWS_BASEPATH%`)Path to the directory where the source file is located - **Source file name** (string, no default) Name of the source file. The file to read and write to when using the _Read and write to the same file_ mode. - **Use different source directory path for workflow run** (Bool, default: False) Determines whether to use a different source directory when executing the Workflow instead of the directory used during design. - **Use different source file name for workflow run** (Bool., default: False) Determines whether to use an alternative file name when running the workflow instead of the draft name. ## Inbound Variables - **DirectoryPathSource** - **FileNameSource** - **Separate source** - **DirectoryPathDestination** - **FileNameDestination** - **CreateDstIfNotExists** - **SheetToBeCreated** ## Outbound Variables This action step has no outbound variables. ## Wizard Use the **Operation Mode** section to choose whether to only read the Excel file, read and modify, or read and then write to a different Excel file. The **Source file** is the file to read. Specify the path to the directory where the source file is located in the **Directory path** field, either manually or using Environment and Script Variables, the file explorer, or a Pin Variable. Specify the file to open in the **File name** field, either manually, using the file explorer, or a Pin Variable. To specify a different file to use at execution time than the one used during creation, select **Use different source file name for workflow run**. In this case, the file names and extensions must be identical and you must specify both. If the Excel file requires a password, select **Excel file is password protected** and specify the password to open the file. Select **Create Excel file if it doesn’t exist** to create the Excel file if the specified file name does not exist in the directory path. You can use a second file as the **Destination file**. In this case, the source file is read-only and you cannot modify it. The destination file is for storing information. If the destination file does not exist, Excel Session creates it if you select **Create destination file if it doesn’t exist**. To specify a separate dynamic Excel file to use during the execution, select **Use different source file name for workflow run** and specify the file in the **Different file name** field, either manually, using the file explorer, or with a Pin Variable. ## See Also - [Excel Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-controlled-loop) - [Read from Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-read-from-excel-file) - [Recalculate Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-recalculate-excel-file) - [Write to Excel File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-write-to-excel-file) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Execute Excel Macro > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Run a macro in an Excel file or sheet and obtain the execution’s result in a variable. You can pass up to 30 variables as arguments to the macro. Don’t include this action step inside an Excel Session; the Execute Excel Macro runs independently. Execute Excel Macro requires Microsoft Excel installed on the computer that runs the automation. Otherwise, the action step fails to execute. ## Before You Begin Before using this action step, ensure that: - Microsoft Excel is installed on the computer that runs the automation. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Source Excel Operation Settings** - **Directory path** Directory path to the source file - **Macro** Macro to run - **Password protected** Whether the Excel file is password protected If you select this option, specify the password in the wizard. - **Source file name** Name of the source file ## Inbound Variables - **Macro** - **Directory path** - **Source file name** - **Password for the excel file** - **{Arg1} replaced by** …​ **{Arg30} replaced by** - **Is Arg1 used** …​ **Is Arg30 used** ## Outbound Variables - **Result** Result of the macro’s execution. - **Executed** (Boolean) Returns `true` if the execution of the macro was successful. ## Wizard Specify the **Directory path** and **File name** of the Excel file that contains the macro to run. After specifying the file, select the macro to run from the **Macro** dropdown menu. This list autopopulates with the macros existing in the specified Excel file. You can pass up to 30 variables as arguments to the macro by selecting the corresponding checkbox and setting the value. ## See Also - [Excel Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations) - [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session) --- product: RPA Builder version: 6.6 --- # Exit Workflow > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Exit Workflow_ Action Step allows you to end a Workflow in a controlled manner. Use it to end the Workflow with precision at a certain point. This means that even if you have entered possible retries in _Workflow Properties_ or in the _Workflow Wizard_ under _Workflow Exec Tries_ these will be disregarded. As a result you can define exit points anywhere. This function is mainly required in the RPA environment. ## Properties The _Exit Workflow_ Action Step has precisely one property. This can be set either under Properties or directly within the wizard: **Exit severity** This is where you define the status for the Workflow that you are ending. You can choose between OK and Error. The default is Error. - _Error:_ In this case the exit code 120 will be shown. In RPA Manager, for example in the Schedule Run Results_,_ this Workflow is shown as failed (red). In the Workflow Run Results in RPA Builder it will be noted that this involves a user exit. - OK: In this case the exit code 500 will be shown. Unlike with the error status, here the Workflow is deemed to have ended successfully. In RPA Manager there will be a warning (yellow) shown for it. As in a normal case, there will be a check whether timers/checkpoints could not be measured. The Workflow Run Results in RPA Builder will be annotated accordingly. For a description of exit codes, please see **Section Exit Codes**. ## Inbound Variables The _Exit Workflow_ Action Step possesses no inbound variables. ## Outbound Variables The _Exit Workflow_ Action Step possesses no outbound variables. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Exit Workflow > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Exit Workflow_ action step allows you to end a Workflow in a controlled manner. Use it to end the Workflow with precision at a certain point. This means that even if you have entered possible retries in _Workflow Properties_ or in the _Workflow Wizard_ under _Workflow Exec Tries_ these will be disregarded. As a result you can define exit points anywhere. This function is mainly required in the RPA environment. ## Properties The _Exit Workflow_ action step has precisely one property. This can be set either under Properties or directly within the wizard: **Exit severity** This is where you define the status for the Workflow that you are ending. You can choose between OK and Error. The default is Error. - _Error:_ In this case the exit code 120 will be shown. In RPA Manager, for example in the Schedule Run Results_,_ this Workflow is shown as failed (red). In the Workflow Run Results in RPA Builder it will be noted that this involves a user exit. - OK: In this case the exit code 500 will be shown. Unlike with the error status, here the Workflow is deemed to have ended successfully. In RPA Manager there will be a warning (yellow) shown for it. As in a normal case, there will be a check whether timers/checkpoints could not be measured. The Workflow Run Results in RPA Builder will be annotated accordingly. For a description of exit codes, please see **Section Exit Codes**. ## Inbound Variables The _Exit Workflow_ action step possesses no inbound variables. ## Outbound Variables The _Exit Workflow_ action step possesses no outbound variables. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.6 --- # Extract Images from PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With this Action Step, you can extract images from a PDF file. ## Properties **File Settings** **Directory Path** (String) The path to the folder in which the PDF file is located. **File Name** (String) The name of the PDF file. **Password protected** (Boolean) This indicates whether the PDF document is to be opened with a password. **Images Extraction Mode** **Extract images from page** (Integer) The images are extracted from the PDF file from this page onward. **Extract images to end of file** (Boolean) If this option is selected, all images up to the end of the PDF file are extracted. **Extract images to page** (Integer) The images are extracted from the PDF file up to this page. **Images Extraction Mode** The property displays which of the three modes for extraction of images has been selected. **Images Extraction Settings** **Create directory if it does not exist** (Boolean) If this option is selected and there is no folder, a target folder is created automatically and the images are saved in it. **Name prefix** (String) The prefix for the name of the image. **Overwrite existing files with same name** (Boolean) If this option is selected, files with the same name are overwritten. **Save extracted images in** (String) Indicates in which file format the images are saved, PNG or JPEG. **Save extracted images to** (String) Specifies the path in which the extracted images are to be saved. **Start number of name suffix** (Integer) A number is used as a suffix in the name of each image. The start number is displayed here and this is used to count the first image. The number of each additional image increases by 1. ## Inbound Variables **Directory Path** (String) The path to the folder in which the PDF file is located. **File Name** (String) The name of the PDF file. **Password** (Boolean) This indicates whether the PDF document is to be opened with a password. **Extract images from page** (Integer) The images are extracted from the PDF file from this page onward. **Extract images to page** (Integer) The images are extracted from the PDF file up to this page. **Save extracted images to** (String) Specifies the path in which the extracted images are to be saved. **Name prefix** (String) The prefix for the name of the image. **Start number of name suffix** (Integer) A number is used as a suffix in the name of each image. The start number is displayed here and this is used to count the first image. The number of each additional image increases by 1. ## Outbound Variables The _Extract Images from PDF File_ Action Step has no outbound variables. ## Wizard **Images Extraction Mode** displays various options for extracting the images: - **Extract all images** All images are extracted from the PDF file. - **Extract from page range** All images from a defined starting page up to and including a defined ending page are extracted. If you select the option “Extract to end of file”, all images up to the last page of the document are extracted. **Extract from selected area** The images are extracted from a specific area of the PDF document. A **Define area** button opens the selected PDF document in a dialog and you can select the required area using the mouse. You can only define an area within a single page. If you click on the Save button, the window closes and you return to the wizard. If you now click on the **Test button**, the image is saved in the folder you selected under **Save extracted images to**. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Extract Images from PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With this action step, you can extract images from a PDF file. ## Properties **File Settings** **Directory Path** (String) The path to the folder in which the PDF file is located. **File Name** (String) The name of the PDF file. **Password protected** (Boolean) This indicates whether the PDF document is to be opened with a password. **Images Extraction Mode** **Extract images from page** (Integer) The images are extracted from the PDF file from this page onward. **Extract images to end of file** (Boolean) If this option is selected, all images up to the end of the PDF file are extracted. **Extract images to page** (Integer) The images are extracted from the PDF file up to this page. **Images Extraction Mode** The property displays which of the three modes for extraction of images has been selected. **Images Extraction Settings** **Create directory if it does not exist** (Boolean) If this option is selected and there is no folder, a target folder is created automatically and the images are saved in it. **Name prefix** (String) The prefix for the name of the image. **Overwrite existing files with same name** (Boolean) If this option is selected, files with the same name are overwritten. **Save extracted images in** (String) Indicates in which file format the images are saved, PNG or JPEG. **Save extracted images to** (String) Specifies the path in which the extracted images are to be saved. **Start number of name suffix** (Integer) A number is used as a suffix in the name of each image. The start number is displayed here and this is used to count the first image. The number of each additional image increases by 1. ## Inbound Variables **Directory Path** (String) The path to the folder in which the PDF file is located. **File Name** (String) The name of the PDF file. **Password** (Boolean) This indicates whether the PDF document is to be opened with a password. **Extract images from page** (Integer) The images are extracted from the PDF file from this page onward. **Extract images to page** (Integer) The images are extracted from the PDF file up to this page. **Save extracted images to** (String) Specifies the path in which the extracted images are to be saved. **Name prefix** (String) The prefix for the name of the image. **Start number of name suffix** (Integer) A number is used as a suffix in the name of each image. The start number is displayed here and this is used to count the first image. The number of each additional image increases by 1. ## Outbound Variables The _Extract Images from PDF File_ action step has no outbound variables. ## Wizard **Images Extraction Mode** displays various options for extracting the images: - **Extract all images** All images are extracted from the PDF file. - **Extract from page range** All images from a defined starting page up to and including a defined ending page are extracted. If you select the option “Extract to end of file”, all images up to the last page of the document are extracted. **Extract from selected area** The images are extracted from a specific area of the PDF document. A **Define area** button opens the selected PDF document in a dialog and you can select the required area using the mouse. You can only define an area within a single page. If you click on the Save button, the window closes and you return to the wizard. If you now click on the **Test button**, the image is saved in the folder you selected under **Save extracted images to**. --- product: RPA Builder version: 6.6 --- # Extract Pages from PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Extract pages from a PDF file, customize the output, and create a new PDF file with the configured settings. Use this action step to split PDF files, combine multiple PDF files into one, or extract specific pages to create a new PDF file. ## Properties - **File Settings** - **Create Target PDF if it doesn’t exist** Select this option to create the PDF file if the specified output file name doesn’t exist. Otherwise, the action step fails if the file doesn’t exist. - **Extraction Page Range** The pages to extract from the input PDF. Use commas (`,`) to separate multiple ranges and `EOF` to specify the end of the file. This action step reads the pages in the specified order. For example, the value `1-5, EOF-6` outputs a file that contains pages from one to five in the original order and the remaining pages in reverse order, from last to six. - **Input File Directory Path** Path to the input file directory. - **Input File is Password Protected** If the input file is password protected, select this option and specify the password in the wizard. - **Input File Name** Name of the input file. - **Insert Mode** Select where to insert the extracted content in the output file. Available options: `StartOfDocument`, `SpecificPage`, or `EndOfDocument`. - **Insert Position** Select the page after which to insert the extracted content. If the PDF file doesn’t exist, and **Create Target PDF if it doesn’t exist** is selected, the action step inserts the pages at the beginning of the document. - **Output File Directory Path** Path to the output file directory. - **Output File is Password Protected** Select this option if the output file is password protected and specify the password in the Wizard. - **Output File Name** Name of the output file. ## Inbound Variables - **Input File Directory Path** - **Input File Name** - **InputFilePassword** - **Extraction Page Range** - **Output File Directory Path** - **Output File Name** - **OutputFilePassword** - **Insert Position** ## Outbound Variables The _Extract Pages from PDF File_ action step has no outbound variables. ## Wizard - **Input File Settings** Configure the settings for the input file to read: **Directory path**, **File name**, **Page Range**, and **Password** (if the file is password protected). - **Output File Settings** Configure the settings for the output file to write: **Directory path**, **File name**, **Page Range**, and **Password** (if the file is password protected). Also specify if the action step creates the output file if it doesn’t exist and select where to insert the pages in the output file. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Extract Pages from PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Extract pages from a PDF file, customize the output, and create a new PDF file with the configured settings. Use this action step to split PDF files, combine multiple PDF files into one, or extract specific pages to create a new PDF file. ## Properties - **File Settings** - **Create Target PDF if it doesn’t exist** Select this option to create the PDF file if the specified output file name doesn’t exist. Otherwise, the action step fails if the file doesn’t exist. - **Extraction Page Range** The pages to extract from the input PDF. Use commas (`,`) to separate multiple ranges and `EOF` to specify the end of the file. This action step reads the pages in the specified order. For example, the value `1-5, EOF-6` outputs a file that contains pages from one to five in the original order and the remaining pages in reverse order, from last to six. - **Input File Directory Path** Path to the input file directory. - **Input File is Password Protected** If the input file is password protected, select this option and specify the password in the wizard. - **Input File Name** Name of the input file. - **Insert Mode** Select where to insert the extracted content in the output file. Available options: `StartOfDocument`, `SpecificPage`, or `EndOfDocument`. - **Insert Position** Select the page after which to insert the extracted content. If the PDF file doesn’t exist, and **Create Target PDF if it doesn’t exist** is selected, the action step inserts the pages at the beginning of the document. - **Output File Directory Path** Path to the output file directory. - **Output File is Password Protected** Select this option if the output file is password protected and specify the password in the Wizard. - **Output File Name** Name of the output file. ## Inbound Variables - **Input File Directory Path** - **Input File Name** - **InputFilePassword** - **Extraction Page Range** - **Output File Directory Path** - **Output File Name** - **OutputFilePassword** - **Insert Position** ## Outbound Variables The _Extract Pages from PDF File_ action step has no outbound variables. ## Wizard - **Input File Settings** Configure the settings for the input file to read: **Directory path**, **File name**, **Page Range**, and **Password** (if the file is password protected). - **Output File Settings** Configure the settings for the output file to write: **Directory path**, **File name**, **Page Range**, and **Password** (if the file is password protected). Also specify if the action step creates the output file if it doesn’t exist and select where to insert the pages in the output file. --- product: RPA Builder version: 6.6 --- # File Check > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _File Check_ Action Step to check whether a file exists or not. You can evaluate the result using the _File Check.Check Succeeded_ variable and use it in the later stages of the workflow. Before the process starts, the specified _Directory Path_ is checked against the _Allowed Paths_. If the _Directory Path_ specified in the Action Step is not allowed, the workflow is cancelled and an error message displayed. ## Properties - **File Operation Settings** - **Directory path** Path to the directory in which you want to search for the file. You can enter the path either as an absolute or relative path. If you enter it as a relative path, the path refers to the _Base Path_ variable. - **File Check mode** Specify wether to check if the exists or if it doesn’t exist. - **File exists** (default) Checks whether the file exists. If it doesn’t exist, the workflow stops and displays an error message. - **File not exists** Checks if the file _doesn’t_ exist. If it does, the workflow stops and displays an error message. - **File Name** Name of the file you are searching for. This action step does not support using Placeholders. For additional details about path and file name settings and a list of unsupported characters, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters). ## Inbound Variables - **Directory path** Path to the directory in which you want to search for the file. You can enter the path either as an absolute or relative path. If you enter it as a relative path, the path refers to the _Base Path_ variable. - **File Name** Name of the file you are searching for. ## Outbound Variables - **Check Succeeded** Specifies whether the check was successful or not (True/False). - **File Name** The name of the file to be found. - **Directory Path** The path used in the search. ## Wizard Define the path to the file to be found. You can create an absolute path or a path relative to the _Base Path_. The initial value is `` %STWS_BASEPATH%` ``. Select an existing path You can also insert variables from the workflow to create the path. To do this, click the pin and select one of the available variables. In the **File name** field, enter the name of the file to be found. You can also insert the _File Name_ using a variable from the workflow. To do this, click the pin and select one of the available variables. You then use the **Check mode** to define the result that is to be searched for. ## See Also [Common File Settings and Properties](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#common-settings) --- product: RPA Builder version: 6.7 is-latest-version: true --- # File Check > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _File Check_ action step to check whether a file exists or not. You can evaluate the result using the _File Check.Check Succeeded_ variable and use it in the later stages of the workflow. Before the process starts, the specified _Directory Path_ is checked against the _Allowed Paths_. If the _Directory Path_ specified in the action step is not allowed, the workflow is cancelled and an error message displayed. ## Properties - **File Operation Settings** - **Directory path** Path to the directory in which you want to search for the file. You can enter the path either as an absolute or relative path. If you enter it as a relative path, the path refers to the _Base Path_ variable. - **File Check mode** Specify wether to check if the exists or if it doesn’t exist. - **File exists** (default) Checks whether the file exists. If it doesn’t exist, the workflow stops and displays an error message. - **File not exists** Checks if the file _doesn’t_ exist. If it does, the workflow stops and displays an error message. - **File Name** Name of the file you are searching for. This action step does not support using Placeholders. For additional details about path and file name settings and a list of unsupported characters, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters). ## Inbound Variables - **Directory path** Path to the directory in which you want to search for the file. You can enter the path either as an absolute or relative path. If you enter it as a relative path, the path refers to the _Base Path_ variable. - **File Name** Name of the file you are searching for. ## Outbound Variables - **Check Succeeded** Specifies whether the check was successful or not (True/False). - **File Name** The name of the file to be found. - **Directory Path** The path used in the search. ## Wizard Define the path to the file to be found. You can create an absolute path or a path relative to the _Base Path_. The initial value is `` %STWS_BASEPATH%` ``. Select an existing path You can also insert variables from the workflow to create the path. To do this, click the pin and select one of the available variables. In the **File name** field, enter the name of the file to be found. You can also insert the _File Name_ using a variable from the workflow. To do this, click the pin and select one of the available variables. You then use the **Check mode** to define the result that is to be searched for. ## See Also [Common File Settings and Properties](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#common-settings) --- product: RPA Builder version: 6.6 --- # File Controlled Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Flow Control Element_ reads data from a CSV file and makes the data available as variables, whereby each column represents one variable. During execution, _File Controlled Loop_ iterates over each row of data and runs through all the content of each row individually. Ensure you use a valid and well-formatted CSV file where all rows have the same number of columns separated by the selected separation character. RPA Builder selects the semicolon (`;`) as the separation character when it converts existing workflows created with earlier versions. If the file has an incorrect format, _File Controlled Loop_ cannot read the file. The first line of the file is considered the header line. _File Controlled Loop_ uses these headers as variable names and not as actual variable values. ## Properties - **External File** - **Import Filename** Full path of the file to import. - **Relative to 3rd Party Folder** Specifies if the path of the file to load is relative to the _3rd party_ folder. - **Separation character** Specifies the character to use as a column separator when reading the CSV file. - **Shuffle** Shuffles the data rows during execution. - **Miscellaneous** - **Iteration Count** If **Limit iterations** is selected, this property specifies the maximum iterations the loop does. Only applicable when the file is imported at runtime. - **Limit iterations** Decides if the iteration count is limited. Only applicable when the file is imported at runtime. **\* \*Separate File Path for Execution** \+ When **Use separate File Path for Execution** is selected, _File Controlled Loop_ reads the file from this path instead of the path given in **Import Filename**. Only applicable when the file is imported at runtime. **\* \*Use separate File Path for Execution** \+ Select this setting to load the file from a different path during execution. Useful if you want to read the file from a network location. Only applicable when the file is imported at runtime. **\* \*Use type string only** \+ Converts all data to type String during runtime. In the wizard, you can convert the data per column. ## Inbound Variables The Action Step File Controlled Loop has no Inbound variables. ## Outbound Variables The Action Steps inside _File Controlled Loop_ return the respective column contents as variables. The names of the variables follow the pattern `.`. ## Wizard The wizard enables you to select whether to import the file at the moment or during execution, the separation character, and the document’s encoding, including Shift-JIS and EUC-JP for Japanese support. Depending on the read mode you select, the wizard changes. The main difference between the two modes is that when you import the file at design time, you can use its variables in timers, and the data is fixed. If you import the file during execution, you can read the file from anywhere, including network locations, which enables you to alter the data without modifying the _Workflow_ at all (however, you cannot use the variables within timer names). If you switch between the two modes you lose all defined variable mappings. Importing the file during execution enables you to use variables within the column filters. However, the wizard deletes any filters that contain variables if you switch modes. ### Importing a File at Design Time When you select **Read file now**, the wizard shows the following configuration options: ![The File Controlled Loop wizard showing the file preview when Read file now is selected](/mulesoft/current/en-us/rpa-builder/6.6/_images/file-controlled-loop-wizard-read-file-now.png) Click **Import File** to select the file to import. RPA Builder then reads and analyzes the file and displays a content preview in the **File Content Preview** section of the wizard. The **File Content Preview** section enables you to apply filters to each column by clicking the **Filter** button (![The filter icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/filter-icon.png)). When you enter text in the **Filter** field, the preview filters out all rows that do not contain the specified text. ![The filter dialog of the File Controlled Loop Action Step](/mulesoft/current/en-us/rpa-builder/6.6/_images/file-controlled-loop-filter-dialog.png) Select **Use Regex** to use a regular expression instead of plain text when applying filters. Use the drop-down menu next to each column name to change the type of the column content. ### Importing a File During Execution When you select **Read file dynamically during Workflow execution**, the wizard shows the following configuration options: ![The File Controlled Loop wizard showing the file preview when Read file dinamically during Workflow execution is selected](/mulesoft/current/en-us/rpa-builder/6.6/_images/file-controlled-loop-read-file-during-execution.png) Click **\[…​\]** next to the **File Name** field to specify the file path, select and copy the file to the _3rd Party_ folder, or open the _3rd Party_ folder. Select **Use separate File Path during Script Execution** to specify an absolute path to read the file from. Use this option when the file’s location differs in the system that executes the automation and the system where you build the Workflow. Select **Only read a maximum of Records** and specify a number to limit the maximum number of rows to read from the file. ## See Also - [Using Variables](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-variables) --- product: RPA Builder version: 6.7 is-latest-version: true --- # File Controlled Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Flow Control Element_ reads data from a CSV file and makes the data available as variables, whereby each column represents one variable. During execution, _File Controlled Loop_ iterates over each row of data and runs through all the content of each row individually. Ensure you use a valid and well-formatted CSV file where all rows have the same number of columns separated by the selected separation character. RPA Builder selects the semicolon (`;`) as the separation character when it converts existing workflows created with earlier versions. If the file has an incorrect format, _File Controlled Loop_ cannot read the file. The first line of the file is considered the header line. _File Controlled Loop_ uses these headers as variable names and not as actual variable values. ## Properties - **External File** - **Import Filename** Full path of the file to import. - **Relative to 3rd Party Folder** Specifies if the path of the file to load is relative to the _3rd party_ folder. - **Separation character** Specifies the character to use as a column separator when reading the CSV file. - **Shuffle** Shuffles the data rows during execution. - **Miscellaneous** - **Iteration Count** If **Limit iterations** is selected, this property specifies the maximum iterations the loop does. Only applicable when the file is imported at runtime. - **Limit iterations** Decides if the iteration count is limited. Only applicable when the file is imported at runtime. **\* \*Separate File Path for Execution** \+ When **Use separate File Path for Execution** is selected, _File Controlled Loop_ reads the file from this path instead of the path given in **Import Filename**. Only applicable when the file is imported at runtime. **\* \*Use separate File Path for Execution** \+ Select this setting to load the file from a different path during execution. Useful if you want to read the file from a network location. Only applicable when the file is imported at runtime. **\* \*Use type string only** \+ Converts all data to type String during runtime. In the wizard, you can convert the data per column. ## Inbound Variables The action step File Controlled Loop has no Inbound variables. ## Outbound Variables The action steps inside _File Controlled Loop_ return the respective column contents as variables. The names of the variables follow the pattern `.`. ## Wizard The wizard enables you to select whether to import the file at the moment or during execution, the separation character, and the document’s encoding, including Shift-JIS and EUC-JP for Japanese support. Depending on the read mode you select, the wizard changes. The main difference between the two modes is that when you import the file at design time, you can use its variables in timers, and the data is fixed. If you import the file during execution, you can read the file from anywhere, including network locations, which enables you to alter the data without modifying the _Workflow_ at all (however, you cannot use the variables within timer names). If you switch between the two modes you lose all defined variable mappings. Importing the file during execution enables you to use variables within the column filters. However, the wizard deletes any filters that contain variables if you switch modes. ### Importing a File at Design Time When you select **Read file now**, the wizard shows the following configuration options: ![The File Controlled Loop wizard showing the file preview when Read file now is selected](/mulesoft/current/en-us/rpa-builder/latest/_images/file-controlled-loop-wizard-read-file-now.png) Click **Import File** to select the file to import. RPA Builder then reads and analyzes the file and displays a content preview in the **File Content Preview** section of the wizard. The **File Content Preview** section enables you to apply filters to each column by clicking the **Filter** button (![The filter icon](/mulesoft/current/en-us/rpa-builder/latest/_images/filter-icon.png)). When you enter text in the **Filter** field, the preview filters out all rows that do not contain the specified text. ![The filter dialog of the File Controlled Loop action step](/mulesoft/current/en-us/rpa-builder/latest/_images/file-controlled-loop-filter-dialog.png) Select **Use Regex** to use a regular expression instead of plain text when applying filters. Use the drop-down menu next to each column name to change the type of the column content. ### Importing a File During Execution When you select **Read file dynamically during Workflow execution**, the wizard shows the following configuration options: ![The File Controlled Loop wizard showing the file preview when Read file dinamically during Workflow execution is selected](/mulesoft/current/en-us/rpa-builder/latest/_images/file-controlled-loop-read-file-during-execution.png) Click **\[…​\]** next to the **File Name** field to specify the file path, select and copy the file to the _3rd Party_ folder, or open the _3rd Party_ folder. Select **Use separate File Path during Script Execution** to specify an absolute path to read the file from. Use this option when the file’s location differs in the system that executes the automation and the system where you build the Workflow. Select **Only read a maximum of Records** and specify a number to limit the maximum number of rows to read from the file. ## See Also - [Using Variables](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-variables) --- product: RPA Builder version: 6.6 --- # File Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt File Operations enable you to interact with the file system where your automation is running. - [Copy File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-copy-file) This Action Step copies a file from one directory to another. - [Create File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-create-file) This Action Step creates an empty file at the specified path. - [Delete File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-delete-file) This Action Step deletes a file located at the specified path. - [Extract Images from PDF File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-extract-images-from-pdf-file) This Action Step enables you to extract images from a PDF file. - [File Check](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-file-check) This Action Step enables you to check whether a file exists or not. - [Get File Info](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-get-file-info) This Action Step fetches information about a file at the specified path. - [Iterate over Files](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-iterate-over-files) This Action Step performs various Action Steps on a specified number of files. - [Move File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-move-file) This Action Step moves a file from one directory to another. - [Read from Text File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-read-from-text-file) This Action Step enables you to read from a text file and use the Read Mode to specify which part of the file is to be read. - [Read PDF File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-read-pdf-file) With the Read PDF File Action Step, you can read text from a PDF file. - [Rename File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-rename-file) This Action Step renames a file. - [Write to Text File](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations-write-to-text-file) Write to Text File writes text to a text file. ## Common Settings and Properties The following settings and properties apply to all the File Operations Action Steps: - **Action Step Settings** Specify path information for all Action Steps of the type File Operations in Settings. To access the Settings configuration panel, click (![The Settings icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/settings-icon.png) **Settings**) in the Workflow Initialization block. - **Path checking** The paths calculated at runtime for File Operations are checked against the list of allowed paths configured in the **Allow File Operation Action Steps only in following paths** option inside **Workflow Settings** → **File Operation Settings**. - **Path / file name / invalid characters** RPA Builder manages the path and file name separately and makes them available to other operations as the Outbound Variables **File Name** and **Directory Path**. Action Steps cannot interpret wildcards in the form of `?` or `*`. Use unique file names at all times. If the path or file name contains invalid characters, the Action Step goes into an error state (this does not apply to the **File name** in the **Iterate over Files Action Step**). The Iterate over Files Action Step iterates over the result of a wildcard operation in the form of an Action Block. The following characters are invalid:
SymbolExplanation

<

Less than sign

>

Greater than sign

:

Colon

"

Double quotes

/

Forward slash

\

Back slash

|

Vertical bar

?

Question mark

*

Asterisk

- **Timeout** If the desired File Operation is not completed successfully within this time, the Action Step goes into an error state. - **Insert environment variable** The **Insert Environment Variable** drop-down list of all File Operation Action Steps contains a predefined list of Windows environment variables. Use these in the Directory Path field to define a variable path to a file within the relevant Action Steps. The variable will be inserted at the current location of the cursor. The standard environment variables and variables defined by the user in RPA Builder are available. The environment variables contain paths to specific folders. The default installation location for Internet Explorer, for example, is `C:\Program Files\Internet Explorer\` or `C:\Program Files x86\Internet Explorer\`. The path may vary if the operating system was installed on a different drive or in a different language. The following list contains the key environment variables: - **%ALLUSERSPROFILE%** The All Users profile folder - **%APPDATA%** The folder for the Application Data of the user who is presently logged in - **%COMPUTERNAME%** System name - **%ProgramFiles%** The folder for Programs - **%SystemRoot%** The system root folder, for example `C:\Windows` - **%SystemDrive%** The system root drive, for example `C:\` - **%USERPROFILE%** The profile folder for the user who is presently logged in - **Insert Script Variable** The **Insert Script Variable** drop-down list of all File Operation Action Steps contains a predefined list of script variables. Use these in the Directory Path field to define a variable path to a file within the relevant Action Steps. The variable is inserted at the current location of the cursor. The following RPA Builder script variables are available: - **Computer Name** This script variable `{@ComputerName}` inserts the name of the computer on which the Action Script is presently running. - **Local Host Name** This script variable `{$HostName}` inserts the name of the host on which the Action Script is presently running. The host name may differ from the computer name if, for example, several virtual machines are running on one host. - **Login User Name** This script variable `{$UserName}` inserts the name of the user who is logged in. - **New Line** This script variable `{@CRLF}` creates a line break. This script variable works only in the Action Step Write to Text File. - **Script Run Directory** The script variable `{@ScriptDir}` returns the directory containing the Workflow without a trailing backslash. - **Tabulator** This script variable `{@TAB}` inserts a tab stop. This script variable works only in the Action Step Write to Text File. - **User privileges** For all Action Steps of the type File Operations, the file operations are successful only if the user who is presently logged in has privileges to access the directories and files used. --- product: RPA Builder version: 6.7 is-latest-version: true --- # File Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt File Operations enable you to interact with the file system where your automation is running. - [Copy File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-copy-file) This action step copies a file from one directory to another. - [Create File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-create-file) This action step creates an empty file at the specified path. - [Delete File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-delete-file) This action step deletes a file located at the specified path. - [Extract Images from PDF File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-extract-images-from-pdf-file) This action step enables you to extract images from a PDF file. - [File Check](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-file-check) This action step enables you to check whether a file exists or not. - [Get File Info](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-get-file-info) This action step fetches information about a file at the specified path. - [Iterate over Files](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-iterate-over-files) This action step performs various action steps on a specified number of files. - [Move File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-move-file) This action step moves a file from one directory to another. - [Read from Text File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-read-from-text-file) This action step enables you to read from a text file and use the Read Mode to specify which part of the file is to be read. - [Read PDF File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-read-pdf-file) With the Read PDF File action step, you can read text from a PDF file. - [Rename File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-rename-file) This action step renames a file. - [Write to Text File](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations-write-to-text-file) Write to Text File writes text to a text file. ## Common Settings and Properties The following settings and properties apply to all the File Operations action steps: - **Action Step Settings** Specify path information for all action steps of the type File Operations in Settings. To access the Settings configuration panel, click (![The Settings icon](/mulesoft/current/en-us/rpa-builder/latest/_images/settings-icon.png) **Settings**) in the Workflow Initialization block. - **Path checking** The paths calculated at runtime for File Operations are checked against the list of allowed paths configured in the **Allow File Operation Action Steps only in following paths** option inside **Workflow Settings** → **File Operation Settings**. - **Path / file name / invalid characters** RPA Builder manages the path and file name separately and makes them available to other operations as the Outbound Variables **File Name** and **Directory Path**. action steps cannot interpret wildcards in the form of `?` or `*`. Use unique file names at all times. If the path or file name contains invalid characters, the action step goes into an error state (this does not apply to the **File name** in the **Iterate over Files Action Step**). The Iterate over Files action step iterates over the result of a wildcard operation in the form of an Action Block. The following characters are invalid:
SymbolExplanation

<

Less than sign

>

Greater than sign

:

Colon

"

Double quotes

/

Forward slash

\

Back slash

|

Vertical bar

?

Question mark

*

Asterisk

- **Timeout** If the desired File Operation is not completed successfully within this time, the action step goes into an error state. - **Insert environment variable** The **Insert Environment Variable** drop-down list of all File Operation action steps contains a predefined list of Windows environment variables. Use these in the Directory Path field to define a variable path to a file within the relevant action steps. The variable will be inserted at the current location of the cursor. The standard environment variables and variables defined by the user in RPA Builder are available. The environment variables contain paths to specific folders. The default installation location for Internet Explorer, for example, is `C:\Program Files\Internet Explorer\` or `C:\Program Files x86\Internet Explorer\`. The path may vary if the operating system was installed on a different drive or in a different language. The following list contains the key environment variables: - **%ALLUSERSPROFILE%** The All Users profile folder - **%APPDATA%** The folder for the Application Data of the user who is presently logged in - **%COMPUTERNAME%** System name - **%ProgramFiles%** The folder for Programs - **%SystemRoot%** The system root folder, for example `C:\Windows` - **%SystemDrive%** The system root drive, for example `C:\` - **%USERPROFILE%** The profile folder for the user who is presently logged in - **Insert Script Variable** The **Insert Script Variable** drop-down list of all File Operation action steps contains a predefined list of script variables. Use these in the Directory Path field to define a variable path to a file within the relevant action steps. The variable is inserted at the current location of the cursor. The following RPA Builder script variables are available: - **Computer Name** This script variable `{@ComputerName}` inserts the name of the computer on which the Action Script is presently running. - **Local Host Name** This script variable `{$HostName}` inserts the name of the host on which the Action Script is presently running. The host name may differ from the computer name if, for example, several virtual machines are running on one host. - **Login User Name** This script variable `{$UserName}` inserts the name of the user who is logged in. - **New Line** This script variable `{@CRLF}` creates a line break. This script variable works only in the action step Write to Text File. - **Script Run Directory** The script variable `{@ScriptDir}` returns the directory containing the Workflow without a trailing backslash. - **Tabulator** This script variable `{@TAB}` inserts a tab stop. This script variable works only in the action step Write to Text File. - **User privileges** For all action steps of the type File Operations, the file operations are successful only if the user who is presently logged in has privileges to access the directories and files used. --- product: RPA Builder version: 6.6 --- # Flow Control > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Flow Control Action Steps enable you to perform controlled iterations and loops during the automation. - [Break Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-break-loop) Break Loop enables you to exit a _Loop_ control block during its execution. - [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-file-controlled-loop) This _Flow Control Element_ reads data from a CSV file. - [Force Error State](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-force-error-state) This Action Step simply forces the Workflow into an error state. - [Force OK State](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-force-ok-state) This Action Step can reset an error state to OK. - [Group](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-group) The Group block enables you to group Action Steps for better visibility and readability. - [Lock Section](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-lock-section) This Action Step enables you to synchronize access if multiple parallel Workflows need to access a file or a mailbox, for example in the case of Robotic Applications. - [Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-loop) A Loop block enables you to repeat the same Transaction and Action Steps two or more times. - [Managed](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-managed) The Managed block enables you to handle errors within your Workflow as they happen. - [Pattern Select](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-pattern-select) This Action Step enables you to respond flexibly to non-predictable situations. - [Select Case](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-select-case) This Action Step makes it possible to match the contents of a variable against certain predefined cases. - [Transaction](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-transaction) Transactions enable you to split Workflows into logical, self-contained units. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Flow Control > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Flow Control action steps enable you to perform controlled iterations and loops during the automation. - [Break Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-break-loop) Break Loop enables you to exit a _Loop_ control block during its execution. - [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-file-controlled-loop) This _Flow Control Element_ reads data from a CSV file. - [Force Error State](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-force-error-state) This action step simply forces the Workflow into an error state. - [Force OK State](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-force-ok-state) This action step can reset an error state to OK. - [Group](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-group) The Group block enables you to group action steps for better visibility and readability. - [Lock Section](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-lock-section) This action step enables you to synchronize access if multiple parallel Workflows need to access a file or a mailbox, for example in the case of Robotic Applications. - [Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-loop) A Loop block enables you to repeat the same Transaction and action steps two or more times. - [Managed](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-managed) The Managed block enables you to handle errors within your Workflow as they happen. - [Pattern Select](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-pattern-select) This action step enables you to respond flexibly to non-predictable situations. - [Select Case](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-select-case) This action step makes it possible to match the contents of a variable against certain predefined cases. - [Transaction](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-transaction) Transactions enable you to split Workflows into logical, self-contained units. --- product: RPA Builder version: 6.6 --- # Folder Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Folder Operations enable you to interact with the folders of the file system where your automation is running. - [Check Folder](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations-check-folder) Checks if a folder exists in the configured directory path. - [Copy Folder](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations-copy-folder) Copies a source folder to the target directory. - [Create Folder](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations-create-folder) Creates an empty folder in the configured directory path. - [Delete Folder](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations-delete-folder) Deletes a folder and all its content. - [Rename Folder](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations-rename-folder) Renames an existing folder. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Folder Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Folder Operations enable you to interact with the folders of the file system where your automation is running. - [Check Folder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations-check-folder) Checks if a folder exists in the configured directory path. - [Copy Folder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations-copy-folder) Copies a source folder to the target directory. - [Create Folder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations-create-folder) Creates an empty folder in the configured directory path. - [Delete Folder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations-delete-folder) Deletes a folder and all its content. - [Rename Folder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations-rename-folder) Renames an existing folder. --- product: RPA Builder version: 6.6 --- # Force Error State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Forces the _Workflow_ into an error state and writes the error message to the `Error Out` workflow variable. If you don’t handle this error within a _Managed Block_, the _Workflow_ aborts at this point and returns with an error. ## Properties - **Error Message** Custom error message to write into the `Error Out` workflow variable. If this field is not set, the action step outputs `Workflow error state manually forced by action step! [No custom message was set.]` ## Inbound Variables - **Error Message** ## Outbound Variables This action step has no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Force Error State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Forces the _Workflow_ into an error state and writes the error message to the `Error Out` workflow variable. If you don’t handle this error within a _Managed Block_, the _Workflow_ aborts at this point and returns with an error. ## Properties - **Error Message** Custom error message to write into the `Error Out` workflow variable. If this field is not set, the action step outputs `Workflow error state manually forced by action step! [No custom message was set.]` ## Inbound Variables - **Error Message** ## Outbound Variables This action step has no outbound variables. --- product: RPA Builder version: 6.6 --- # Force OK State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This Action Step can reset an error state to OK. A process can thus be continued despite an ERROR. In addition to this, it does not have any other configurable settings or wizard functions. Please note that the Action Step is only useful if you set it in the _OnError_ section of a Managed Block. This is because only in this section will the error be treated as dealt with and processing the Activity Workflow can be continued. If you place the Action Step at a different point and the error occurs with a prior Action Step, the _Force OK State_ Action Step can never be called. The Activity Workflow will therefore be terminated with Error at this point. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Force OK State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step can reset an error state to OK. A process can thus be continued despite an ERROR. In addition to this, it does not have any other configurable settings or wizard functions. Please note that the action step is only useful if you set it in the _OnError_ section of a Managed Block. This is because only in this section will the error be treated as dealt with and processing the Activity Workflow can be continued. If you place the action step at a different point and the error occurs with a prior action step, the _Force OK State_ action step can never be called. The Activity Workflow will therefore be terminated with Error at this point. --- product: RPA Builder version: 6.6 --- # General > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The General Action Steps enable to perform general operations related to the automated process execution. - [Exit Workflow](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-exit-workflow) The Exit Workflow Action Step enables you to end a Workflow in a controlled manner. - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-pattern-gallery) All search patterns belonging to a Workflow are stored centrally in the Pattern Gallery. Search patterns are image files which are used in the Search Pattern and Pattern Select Action Steps to determine a state. - [STC Protector](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-stc-protector) Use STC Protector to handle pop-us windows in a Workflow that needs to run stably and robustly for long periods. --- product: RPA Builder version: 6.7 is-latest-version: true --- # General > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The General action steps enable to perform general operations related to the automated process execution. - [Exit Workflow](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-exit-workflow) The Exit Workflow action step enables you to end a Workflow in a controlled manner. - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-pattern-gallery) All search patterns belonging to a Workflow are stored centrally in the Pattern Gallery. Search patterns are image files which are used in the Search Pattern and Pattern Select action steps to determine a state. - [STC Protector](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-stc-protector) Use STC Protector to handle pop-us windows in a Workflow that needs to run stably and robustly for long periods. --- product: RPA Builder version: 6.6 --- # General Timer Start > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _General timers_ are used to measure whole _Transactions_. First place the _Start Timer_ and then the _Stop Timer_ by the _Transaction_ elements for which the run time is to be measured. _General timers_ are **not** valid as _Measurement Points_ and cannot therefore be linked to a _Data Source_. ## Properties - **Timer name** Name to write to the output file. ## Inbound Variables The _General Timer Start_ Action Step has no inbound variables. ## Outbound Variables The _General Timer Start_ Action Step has no outbound variables. ## See Also - [General Timer Stop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-general-timer-stop) --- product: RPA Builder version: 6.7 is-latest-version: true --- # General Timer Start > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _General timers_ are used to measure whole _Transactions_. First place the _Start Timer_ and then the _Stop Timer_ by the _Transaction_ elements for which the run time is to be measured. _General timers_ are **not** valid as _Measurement Points_ and cannot therefore be linked to a _Data Source_. ## Properties - **Timer name** Name to write to the output file. ## Inbound Variables The _General Timer Start_ action step has no inbound variables. ## Outbound Variables The _General Timer Start_ action step has no outbound variables. ## See Also - [General Timer Stop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-general-timer-stop) --- product: RPA Builder version: 6.6 --- # General Timer Stop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _General timers_ are used to measure whole _Transactions_. First place the _Start Timer_ and then the _Stop Timer_ by the _Transaction_ elements for which the run time is to be measured. _General timers_ are **not** valid as _Measurement Points_ and cannot therefore be linked to a _Data Source_. ## Properties - **Timer name** Name to write to the output file. ## Inbound Variables The _General Timer Stop_ Action Step has no inbound variables. ## Outbound Variables The _General Timer Stop_ Action Step has no outbound variables. ## See Also - [General Timer Start](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-general-timer-start) --- product: RPA Builder version: 6.7 is-latest-version: true --- # General Timer Stop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _General timers_ are used to measure whole _Transactions_. First place the _Start Timer_ and then the _Stop Timer_ by the _Transaction_ elements for which the run time is to be measured. _General timers_ are **not** valid as _Measurement Points_ and cannot therefore be linked to a _Data Source_. ## Properties - **Timer name** Name to write to the output file. ## Inbound Variables The _General Timer Stop_ action step has no inbound variables. ## Outbound Variables The _General Timer Stop_ action step has no outbound variables. ## See Also - [General Timer Start](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-general-timer-start) --- product: RPA Builder version: 6.6 --- # Generate and Modify Date and Time > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use _Generate date and time_ to create a configurable timestamp. Select a country-specific style for the timestamp from the selection of format templates or arrange the available time components as required, e.g. day, month, and hour. You can specify the timestamp as a specific time in the future or past, or use the current system time. It is also possible to incorporate a time offset in days, hours, minutes, and seconds. _Generate date and time_ creates a timestamp that is available in several variables, which you can further process in other _Action Steps_. ## Properties - **Generate Date and Time Settings** _Generate date and time_ incorporates the specified values into the calculation of the selected time stamp (time offset). This action step supports positive and negative numbers. The default value is 0 in each case. - **Calendar week setting** Specify either Monday or Sunday as the starting day for the week. - **Days to Add** Number of days to add. - **Generate day and time mode** Select whether to use the **Current system date and time**, **Custom date and time**, or **Generated date and time from given variables**. The time offsets from the **Years to add**, **Months to add**, **Weeks to add**, **Days to add**, **Hours to add**, **Minutes to add**, **Seconds to add** fields apply for the calculation in all cases. - **Hours to add** Number of hours to add. - **Minutes to add** Number of minutes to add. - **Months to add** Number of months to add. - **Output language culture (for the day of the week)** Specify the output language to use for the days of the week. - **Override activated** Enables overriding workday settings. - **Override to day** Specify the day to override with. - **Override to first or last** Specify either the first or last day of the given period (for example, last day of the month). - **Seconds to add** Number of seconds to add. - **Start workday of week** Specify the starting workday of the week. - **Weeks to add** Number of weeks to add. - **Workdays setting** Select between a five-day or six-day workweek. - **Years to add** Number of years to add. ## Variables The following variables relate to the configurable timestamp generated after applying any time offset. _Generate date and time_ outputs the _Formatted_ variable in the specified _DateTime format_ and the other variables in accordance with the date format settings specified in the operating system. - **Formatted** The _Generate date and time.Formatted_ variable provides the timestamp using the date and time format selected. - **Date** The _Generate date and time.Date_ variable provides the date. - **Time** The _Generate date and time.Time_ variable provides the time. - **Year** The _Generate date and time.Year_ variable provides the year. - **Month** The _Generate date and time.Month_ variable provides the month as a decimal number. - **Day** The _Generate date and time.Day_ variable provides the day as a decimal number. - **Hour** The _Generate date and time.Hour_ variable provides the number of hours. - **Minute** The _Generate date and time.Minute_ variable provides the number of minutes. - **Second** The _Generate date and time.Second_ variable provides the number of seconds. ## Wizard The Wizard enables you to generate a timestamp based on the specified time variables, select the starting day of the week, and specify the output format and language. - **DateTime settings** Enables you to specify the date to generate. Select a **Generation mode** and specify the time variables to generate the desired date output. The available generation modes are: - **Current system date and time**: Uses the current system time as the timestamp. - **Custom date and time**: Uses the time selected in the **DateTime** field as the timestamp. - **Generated date and time from given variables**: Calculates the timestamp using the specified values. - **Workday settings** Enables you to specify a given day of the month by following some rules. Select **Override date to** and use the dropdown options to specify a day in the month to use. - **Calendar settings** Enables you to select the starting day of the week between Monday and Sunday. - **Output settings** Enables you to select the **Output format** and the **Output language for the day of the week**. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Generate and Modify Date and Time > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use _Generate date and time_ to create a configurable timestamp. Select a country-specific style for the timestamp from the selection of format templates or arrange the available time components as required, e.g. day, month, and hour. You can specify the timestamp as a specific time in the future or past, or use the current system time. It is also possible to incorporate a time offset in days, hours, minutes, and seconds. _Generate date and time_ creates a timestamp that is available in several variables, which you can further process in other action steps. ## Properties - **Generate Date and Time Settings** _Generate date and time_ incorporates the specified values into the calculation of the selected time stamp (time offset). This action step supports positive and negative numbers. The default value is 0 in each case. - **Calendar week setting** Specify either Monday or Sunday as the starting day for the week. - **Days to Add** Number of days to add. - **Generate day and time mode** Select whether to use the **Current system date and time**, **Custom date and time**, or **Generated date and time from given variables**. The time offsets from the **Years to add**, **Months to add**, **Weeks to add**, **Days to add**, **Hours to add**, **Minutes to add**, **Seconds to add** fields apply for the calculation in all cases. - **Hours to add** Number of hours to add. - **Minutes to add** Number of minutes to add. - **Months to add** Number of months to add. - **Output language culture (for the day of the week)** Specify the output language to use for the days of the week. - **Override activated** Enables overriding workday settings. - **Override to day** Specify the day to override with. - **Override to first or last** Specify either the first or last day of the given period (for example, last day of the month). - **Seconds to add** Number of seconds to add. - **Start workday of week** Specify the starting workday of the week. - **Weeks to add** Number of weeks to add. - **Workdays setting** Select between a five-day or six-day workweek. - **Years to add** Number of years to add. ## Variables The following variables relate to the configurable timestamp generated after applying any time offset. _Generate date and time_ outputs the _Formatted_ variable in the specified _DateTime format_ and the other variables in accordance with the date format settings specified in the operating system. - **Formatted** The _Generate date and time.Formatted_ variable provides the timestamp using the date and time format selected. - **Date** The _Generate date and time.Date_ variable provides the date. - **Time** The _Generate date and time.Time_ variable provides the time. - **Year** The _Generate date and time.Year_ variable provides the year. - **Month** The _Generate date and time.Month_ variable provides the month as a decimal number. - **Day** The _Generate date and time.Day_ variable provides the day as a decimal number. - **Hour** The _Generate date and time.Hour_ variable provides the number of hours. - **Minute** The _Generate date and time.Minute_ variable provides the number of minutes. - **Second** The _Generate date and time.Second_ variable provides the number of seconds. ## Wizard The Wizard enables you to generate a timestamp based on the specified time variables, select the starting day of the week, and specify the output format and language. - **DateTime settings** Enables you to specify the date to generate. Select a **Generation mode** and specify the time variables to generate the desired date output. The available generation modes are: - **Current system date and time**: Uses the current system time as the timestamp. - **Custom date and time**: Uses the time selected in the **DateTime** field as the timestamp. - **Generated date and time from given variables**: Calculates the timestamp using the specified values. - **Workday settings** Enables you to specify a given day of the month by following some rules. Select **Override date to** and use the dropdown options to specify a day in the month to use. - **Calendar settings** Enables you to select the starting day of the week between Monday and Sunday. - **Output settings** Enables you to select the **Output format** and the **Output language for the day of the week**. --- product: RPA Builder version: 6.6 --- # Get Array Count > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Get Array Count_ Action Step returns the number of elements in an array. You can then use this number as the number of iterations in a loop (_Loop_), for example, across the array elements. ## Properties This Action Step contains no special properties other than the _general_ ones. ## Inbound Variables - **Array to get count of** (array, default: blank) Array for which the number of elements is to be determined. This array must be created beforehand using the _Workflow Based Variables_ element or any action step that creates or returns an array. The return array from the _Read from Excel File_ Action Step is shown only within the same transaction as a Pin Variable. To use the _Array Count_ in a later transaction, copy the return array into an array created beforehand in the Workflow Based Variables (see _Set\_Array\_Variable_). ## Outbound Variables - **Array Count** (integer, default 0) Number of elements in the array ## Wizard All arrays that are available within the Workflow are shown in the drop-down list next to _Array to get count of_. Ensure the array is correctly populated. An empty array returns an _Array Count_ of 0. ## Example In this example, an auto repair shop wants to monitor automatically which _Services_ have been performed on a certain vehicle. These services are read from an array and checked off on a checklist. To test the Workflow, the _Workflow Based Variables_ are populated with sample values. In productive operation these values are then overwritten with values from the _Car Service App_. The _Services_ array is populated with all the services from the _Car Service App_ which are performed. First, in the transaction _130 Process list of done services_, the number of services that have been performed is calculated using the _Get Array Count_ Action Step before each service is read in a loop and graphically (see _OCR_) compared against the services on a checklist. If the service is on the checklist, it will be checked off. The checklist is used later on in the Workflow to calculate costs. The configuration values of the individual Action Steps are passed on using (Pin) _Variables_. ## See Also - [Read from Array](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-read-from-array) - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-array-variable) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Get Array Count > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Get Array Count_ action step returns the number of elements in an array. You can then use this number as the number of iterations in a loop (_Loop_), for example, across the array elements. ## Properties This action step contains no special properties other than the _general_ ones. ## Inbound Variables - **Array to get count of** (array, default: blank) Array for which the number of elements is to be determined. This array must be created beforehand using the _Workflow Based Variables_ element or any action step that creates or returns an array. The return array from the _Read from Excel File_ Action Step is shown only within the same transaction as a Pin Variable. To use the _Array Count_ in a later transaction, copy the return array into an array created beforehand in the Workflow Based Variables (see _Set\_Array\_Variable_). ## Outbound Variables - **Array Count** (integer, default 0) Number of elements in the array ## Wizard All arrays that are available within the Workflow are shown in the drop-down list next to _Array to get count of_. Ensure the array is correctly populated. An empty array returns an _Array Count_ of 0. ## Example In this example, an auto repair shop wants to monitor automatically which _Services_ have been performed on a certain vehicle. These services are read from an array and checked off on a checklist. To test the Workflow, the _Workflow Based Variables_ are populated with sample values. In productive operation these values are then overwritten with values from the _Car Service App_. The _Services_ array is populated with all the services from the _Car Service App_ which are performed. First, in the transaction _130 Process list of done services_, the number of services that have been performed is calculated using the _Get Array Count_ action step before each service is read in a loop and graphically (see _OCR_) compared against the services on a checklist. If the service is on the checklist, it will be checked off. The checklist is used later on in the Workflow to calculate costs. The configuration values of the individual action steps are passed on using (Pin) _Variables_. ## See Also - [Read from Array](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-read-from-array) - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-array-variable) --- product: RPA Builder version: 6.6 --- # Get File Info > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Get File Info_ fetches information about a file at the specified path. You can retrieve the following information: date created, date modified, owner, and when the file was last accessed. The information fetched is saved in the appropriate variables for further processing. Dates are returned in UTC (coordinated universal time) format as follows (yyyyMM-ddTHH:mm:ssZ). ## Properties **File Operation Settings** - **Directory path** Enter the path to the directory where the file is saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file here that require information about. Placeholders are not permitted. For further information please refer to the section on **Invalid characters**. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file is saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **File Name** Enter the name of the file here that require information about. ## Outbound Variables **File Size** The _Get_ _File Info.File Size_ variable provides the size of the file. **Creation Date** The _Get_ _File Info.Creation Date_ variable provides the date the file was created (format: yyyyMM-ddTHH:mm:ssZ). **Modification Date** The _Get_ _File Info.Modification Date_ variable provides the date of the last change to the file (format: yyyyMM-ddTHH:mm:ssZ). **Last Access Date** The _Get_ _File Info.Last Access Date_ variable provides the last access date (format: yyyyMM-ddTHH:mm:ssZ). **File Owner** The _Get_ _File Info.File Owner_ variable provides the name of the owner of the file. **File Name** The _Get_ _File Info.File Name_ variable provides the name of the file. **Directory path** The _Get_ _File Info.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that you require information about. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name here of the file that you require information about. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Get File Info > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Get File Info_ fetches information about a file at the specified path. You can retrieve the following information: date created, date modified, owner, and when the file was last accessed. The information fetched is saved in the appropriate variables for further processing. Dates are returned in UTC (coordinated universal time) format as follows (yyyyMM-ddTHH:mm:ssZ). ## Properties **File Operation Settings** - **Directory path** Enter the path to the directory where the file is saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** Enter the name of the file here that require information about. Placeholders are not permitted. For further information please refer to the section on **Invalid characters**. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file is saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **File Name** Enter the name of the file here that require information about. ## Outbound Variables **File Size** The _Get_ _File Info.File Size_ variable provides the size of the file. **Creation Date** The _Get_ _File Info.Creation Date_ variable provides the date the file was created (format: yyyyMM-ddTHH:mm:ssZ). **Modification Date** The _Get_ _File Info.Modification Date_ variable provides the date of the last change to the file (format: yyyyMM-ddTHH:mm:ssZ). **Last Access Date** The _Get_ _File Info.Last Access Date_ variable provides the last access date (format: yyyyMM-ddTHH:mm:ssZ). **File Owner** The _Get_ _File Info.File Owner_ variable provides the name of the owner of the file. **File Name** The _Get_ _File Info.File Name_ variable provides the name of the file. **Directory path** The _Get_ _File Info.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that you require information about. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name here of the file that you require information about. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. --- product: RPA Builder version: 6.6 --- # Get Web Element Text > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Get Element Text_ action step reads the _innerText_ of an element and returns it as the **Element Text** outbound variable, which makes it available for use in subsequent Action Steps through Pin Variables. As an example, you can use this action step to copy an email address or other text from a web page and use it in another application. ## Properties See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation). ## Inbound Variables - **Element XPath** - **Window Title** ## Outbound Variables - **Element Text** (string, default: blank) The _innerText_ of the selected element. If the element has no _innerText_, this action step returns a blank string. ## Wizard To extract the text from a web element: 1. Click **Open Browser Wizard**. 2. Navigate to the site that contains the text element to extract. 3. Position the mouse over the text element. 4. When a blue border shows to frame the element, press `F2`. The properties of the selected element show in the side bar. In addition to the mandatory XPath, you can select other attributes that help define the correct element. 5. Click **Accept Selection** (![The Accept Selection icon.](/mulesoft/current/en-us/rpa-builder/6.6/_images/check-icon.png)) at the beginning of the sidebar on the browser wizard. ## Example In this example, the Get Web Element Text action step captures an email address from a MuleSoft Accelerators documentation article: ![The Browser Wizard showing a blue frame around the selected email address.](/mulesoft/current/en-us/rpa-builder/6.6/_images/get-web-element-text-example.png) Then, in a subsequent Send Mail action step, the email address is entered as the **To** address through a Pin variable: ![The Send Mail Wizard using a Pin variable to configure the email address.](/mulesoft/current/en-us/rpa-builder/6.6/_images/get-web-element-text-use-variable.png) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Get Web Element Text > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Get Element Text_ action step reads the _innerText_ of an element and returns it as the **Element Text** outbound variable, which makes it available for use in subsequent action steps through Pin Variables. As an example, you can use this action step to copy an email address or other text from a web page and use it in another application. ## Properties See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation). ## Inbound Variables - **Element XPath** - **Window Title** ## Outbound Variables - **Element Text** (string, default: blank) The _innerText_ of the selected element. If the element has no _innerText_, this action step returns a blank string. ## Wizard To extract the text from a web element: 1. Click **Open Browser Wizard**. 2. Navigate to the site that contains the text element to extract. 3. Position the mouse over the text element. 4. When a blue border shows to frame the element, press `F2`. The properties of the selected element show in the side bar. In addition to the mandatory XPath, you can select other attributes that help define the correct element. 5. Click **Accept Selection** (![The Accept Selection icon.](/mulesoft/current/en-us/rpa-builder/latest/_images/check-icon.png)) at the beginning of the sidebar on the browser wizard. ## Example In this example, the Get Web Element Text action step captures an email address from a MuleSoft Accelerators documentation article: ![The Browser Wizard showing a blue frame around the selected email address.](/mulesoft/current/en-us/rpa-builder/latest/_images/get-web-element-text-example.png) Then, in a subsequent Send Mail action step, the email address is entered as the **To** address through a Pin variable: ![The Send Mail Wizard using a Pin variable to configure the email address.](/mulesoft/current/en-us/rpa-builder/latest/_images/get-web-element-text-use-variable.png) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Google Workspace > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Access your Google Drive and perform operations such as downloading or exporting, uploading, or searching for files or folders. These action steps require you to provide your Google API Service Account Credentials. You can specify these credential in the corresponding activity parameter and then link them through a pin variable or specify the values inline in each action step. - [Download from Google Drive](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-workspace-download-from-google-drive) Download files from your Google Drive. You can also export files to a different format. - [Search in Google Drive](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-workspace-search-in-google-drive) Search for files or folders in your Google Drive. - [Upload to Google Drive](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-workspace-upload-to-google-drive) Upload files to your Google Drive. --- product: RPA Builder version: 6.6 --- # Group > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Using the _Group_ block gives you a clearer overview when designing your Workflows. It provides delineation both graphically and in terms of content within a Workflow. For example, you can easily use it to group Action Step variables. You can, however, also use all other Action Steps. A couple of exceptions are the _Transaction_ Action Step and the _Workflow Initialization_ element. It is possible to position multiple _Group_ blocks inside each other. The _Group_ block does **not** restrict the availability of variables in subsequent transactions such as the _Transaction_ Action Step, for example. ## Properties The _Group_ block has no properties. ## Inbound Variables The _Group_ block possesses no inbound variables. ## Outbound Variables The _Group_ block possesses no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Group > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Using the _Group_ block gives you a clearer overview when designing your Workflows. It provides delineation both graphically and in terms of content within a Workflow. For example, you can easily use it to group action step variables. You can, however, also use all other action steps. A couple of exceptions are the _Transaction_ action step and the _Workflow Initialization_ element. It is possible to position multiple _Group_ blocks inside each other. The _Group_ block does **not** restrict the availability of variables in subsequent transactions such as the _Transaction_ action step, for example. ## Properties The _Group_ block has no properties. ## Inbound Variables The _Group_ block possesses no inbound variables. ## Outbound Variables The _Group_ block possesses no outbound variables. --- product: RPA Builder version: 6.6 --- # Hardware and Software Requirements > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Before using RPA Builder, ensure that your environment meets the minimum hardware and software requirements. ## Hardware Requirements
MinimumRecommended

Dual-core 2 GHz CPU (MMX/SSE compatible)

Dual-core 2 GHz CPU (MMX/SSE compatible)

4 GB of RAM

8 GB of RAM

30 GB of disk space

30 GB (SSD) of disk space

Graphics Accelerator Card

## Software Requirements
SoftwareRequired version

Microsoft .NET Framework

4.8

Operating System

Any of the following:

  • Windows 10 (64 bit)

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 10 Enterprise for Virtual Desktops).

    • Enterprise LTSC

  • Windows 11

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 11 Enterprise for Virtual Desktops).

  • Windows Server 2019

  • Windows Server 2022

Java

Any of the following:

  • Java Runtime Environment 11 (JRE, 64-bit version) or higher

  • Adoptium 11 (JRE, 64-bit version) or higher

### File System Permission Requirements RPA Builder needs full write access to folders that are critical to its functioning. To avoid issues during the setup process and subsequent RPA Builder executions, ensure that: - You install RPA Builder as an administrator If you don’t run the setup file as an administrator, the installation process might not finish successfully. If this happens, ensure you reinstall RPA Builder by running the setup file as an administrator. - RPA Builder has full write access to the following folders and any subfolders and files inside them: - `C:\Users\\Documents\Mulesoft` - `C:\Users\Public\Documents\Mulesoft` - `C:\Users\\AppData\Local\MuleSoft_LLC` - `C:\Users\\AppData\Roaming\MuleSoft` - `C:\ProgramData\Mulesoft\RPABuilder\Cache` - Your environment is not blocking the execution of any RPA process The operating system can block the execution of certain files. Ensure that all executable (`.exe`) files inside the RPA Builder home directory and its subfolders are allowed to run. ## Compatibility
ApplicationVersion

RPA Recorder

6.6.0 and later

RPA Bot

1.0.0 and later

## See Also - [Installing and Configuring RPA Builder](https://docs.mulesoft.com/rpa-builder/6.6/install-and-configure) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Hardware and Software Requirements > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Before using RPA Builder, ensure that your environment meets the minimum hardware and software requirements. ## Hardware Requirements
MinimumRecommended

Dual-core 2 GHz CPU (MMX/SSE compatible)

Dual-core 2 GHz CPU (MMX/SSE compatible)

4 GB of RAM

8 GB of RAM

30 GB of disk space

30 GB (SSD) of disk space

Graphics Accelerator Card

## Software Requirements
SoftwareRequired version

Microsoft .NET Framework

4.8

Operating System

Any of the following:

  • Windows 10 (64 bit)

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 10 Enterprise for Virtual Desktops).

    • Enterprise LTSC

  • Windows 11

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 11 Enterprise for Virtual Desktops).

  • Windows Server 2019

  • Windows Server 2022

Java

Any of the following:

  • Java Runtime Environment 11 (JRE, 64-bit version)

  • Adoptium 11 (JRE, 64-bit version)

### File System Permission Requirements RPA Builder needs full write access to folders that are critical to its functioning. To avoid issues during the setup process and subsequent RPA Builder executions, ensure that: - You install RPA Builder as an administrator If you don’t run the setup file as an administrator, the installation process might not finish successfully. If this happens, make sure you reinstall RPA Builder by running the setup file as an administrator. - RPA Builder has full write access to these folders and any subfolders and files inside them: - `C:\Users\\Documents\Mulesoft` - `C:\Users\Public\Documents\Mulesoft` - `C:\Users\\AppData\Local\MuleSoft_LLC` - `C:\Users\\AppData\Roaming\MuleSoft` - `C:\ProgramData\Mulesoft\RPABuilder\Cache` - Your environment isn’t blocking the execution of any RPA process The operating system can block the execution of certain files. Make sure that all executable (`.exe`) files inside the RPA Builder home directory and its subfolders are allowed to run. ### Check for Software Interference Some software can prevent RPA Builder from working properly. Resolve any software issues you find before installing RPA Builder.
SoftwareProblemSolution

Microsoft OneDrive

Microsoft OneDrive is an application for backing up data from a computer.

When you turn on Microsoft OneDrive backup for the Documents folder on your computer, it moves this folder to a different location. When RPA Builder starts, it tries to clean up the cache folder, but OneDrive redirects this to the new location where RPA Builder doesn’t have permission to write:

  • From: C:\Users\<username>\Documents\Mulesoft\Cache

  • To: C:\Users\<username>\OneDrive\Documents\Mulesoft\Cache

This causes an error that you can find in the log files:

System.IO.IOException: Access to the path 'C:\Users\<username>\OneDrive\Documents\Mulesoft\Cache' is denied.

A user describes this problem in detail in a Microsoft Community thread.

If you use RPA Builder on a computer that has OneDrive, don’t let OneDrive back up your Documents folder.

The Microsoft OneDrive documentation explains how to exempt the Documents folder from the OneDrive backup.

## Compatibility
ApplicationVersion

RPA Recorder

6.6.0 and later

RPA Bot

1.0.0 and later

## See Also - [Installing and Configuring RPA Builder](https://docs.mulesoft.com/rpa-builder/latest/install-and-configure) --- product: RPA Builder version: 6.6 --- # Image Search > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Image search_ Action Step searches for a user-defined image, waits until it appears or disappears, and can also be used as a relative anchor point for mouse clicks. Image in this case does not only mean picture, but also includes the visual representation of lettering or control elements like buttons. The most common use cases for _Image search_ are: - Calculating loading times To compute the loading time of a webpage or an application loading data from a distant server, it is not sufficient to wait for the window to appear. In such cases, the webpage or application can only be said to be loaded when the content is also visualized; that is, when an image can be seen. - Checking for feedback from remote applications When the measured application is running on a distant system and the Workflow has to use a Citrix client, VCN, or a similar remote connection tool that only displays the user interface graphically but does not give back handles, Image search is the only way to ascertain that the desired content has appeared onscreen. - Positioning the mouse relative to an image Finally, the position of the image can be used to place a mouse click relatively to the image, for example to enter a URL in the address bar of a web browser, or to enter login information into user and password fields. What the _Image search_ actually does is compare the recorded _Pattern image_ to the whole _Search area_. During execution, it takes a screenshot of the _Search area_, applies the selected _Image search_ algorithm to it, and then compares it to the _Pattern image_. The _Search area_ adjusts automatically if the executing computer has a different screen resolution to the computer the _Workflow_ was originally created on. Also, uses the lowest common color depth setting, so for example, if you created an _Image search_ with a color depth of 32 bits, but the executing computer only has a color depth of 16 bits, the original _Pattern image_ is converted on the fly to match the current system’s color depth. You can adjust this within the Workflow Properties. ## Properties - **Compare Precision** This is an additional setting for the search algorithm modes _Color_ and _Gradient_. In these modes the actual color value of a pixel is recorded. The result is not the exact same value every time a pixel value is calculated by the GPU. By lowering the compare precision to 98% or 97%, you can allow the value to vary a little in the least significant bits. - **Edge detection threshold** Threshold for the difference (distance) between colors that leads to the detection of an edge. A low threshold leads to many detected edges because even a small difference in a pixel’s color value in comparison to its neighbors' is detected as an edge. Conversely, a high threshold leads to fewer edges in the _Pattern image_ the algorithm is searching for. - **Hide Mouse** If this option is enabled, the mouse pointer is moved to the upper left corner of the desktop during the _Image search_. Enable this to avoid triggering hover effects in applications and on websites. This is to ensure that the mouse pointer is not partly covering the image searched for. Afterwards it is moved back to the previous position. - **Image search algorithm** _Image search_ algorithm to use. Available options are _Color_, _Gradient_, _Contour_, and _Contour Plus_. See [The Different Search Modes](#search-modes) for a descriptions of these modes. - **Image search type _Search for picture appear_** Search for the picture until it appears. As soon as it can be detected, the _Image search_ is considered successful. - **Image search type _Search for picture disappear_** The _Image search_ is considered successful as soon as the image cannot be found. An image does not have to be found first, so if finding the image is necessary an _Image search_ with search type _Appear_ must be performed first. - **Original desktop color depth** (_Properties grid_ only): Color depth in bits at the time the image was recorded. - **Original desktop height** (_Properties grid_ only): Desktop height in pixels at the time the image was recorded. - **Original desktop width** (_Properties grid_ only): Desktop width in pixels at the time the image was recorded. - **_Pattern Image_ File Path** (_Properties grid_ only): File location of the recorded image. - **_Pattern image_ rect** (_Properties grid_ only): Original coordinates (upper left corner, lower right corner) of the rectangular area on the desktop enclosing the image to be searched. - **Percentage required** Determines tolerance of the _Image search_, i.e. the minimum quality percentage threshold needed for successful identification of an image. A lower value means a higher tolerance, but also increases the likelihood of a false positive. To avoid false positives, do not set this value below 90%. - **Relative To** Makes the _Search Area_ relative to a previous _Image search_, in the same way as for the _Mouse Clicks Action Step_. - **_Search area_ rect** (_Properties grid_ only): Original coordinates (upper left corner, lower right corner) of the rectangular area on the desktop enclosing the _Search area_. - **Wait time \[ms\]** The pause between two subsequent image searches (only used if _Wait until image is steady_ is activated). - **Wait until image is steady** This function is used to perform a second _Image search_ after the image is detected and introduces an additional _Wait time._ The result of this second run compared to the previous one is to ensure that the image is still there and has not changed its position. If the results are equal, then the _Image search_ is considered successful. If not, additional _Image search_es are performed until two subsequent ones have the same result or until the timeout is reached. - **Interrupt time \[ms\]** Mainly used for _Java_ Applications: time in milliseconds the service stops searching for a picture to provide CPU resources to an application with bad performance (only applicable if _Load Optimizer_ is activated). - **Load Optimizer** If enabled, there is a pause between every attempt to find the image onscreen, as defined by the _Interrupt time_ setting. This pause allows time for other programs to do something when running on a single core computer. - **Performance Limit (%)** Defines how much of the CPU performance can be used for the _Image search_ (only applicable if _Load Optimizer_ is activated). ## Variables - **Find Coordinate** The X and Y coordinates of where the picture was found. ## Wizard ![The image search Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/image-search-wizard.png) - **Start from scratch** Starts the configuration using all steps. - **_Search area_** Only reconfigures the _Search area_, using a previously captured image. - **_Pattern image_** Only recaptures the image to search for - **Refresh _Search area_** Refreshes the _Search area_ frame on the right-hand side of the wizard with the current desktop situation, so you can check if the defined _Search area_ still includes the image. - **Show borders** If active; the _Pattern image_ is marked with a blue border and the _Search area_ is marked with a red border in the _Search area_ frame. - **_Pattern image_** Shows the recorded image that is used in searches. - **Check search** Evaluate the probability the captured image is found. The result shows in a box before the _Pattern image_ frame and comprises the position of the image found, as well as the match precision in percent (this feature uses the current desktop and not the image shown in the _Search area_ frame). - **_Search area_** Shows the desktop situation when the image was captured onscreen. If _Show Borders_ is active, borders of the search image are shown in blue and borders of the _Search area_ are shown in red. If you performed a _Check search_ and the image could be found, its position is marked by a green border. ## Starting the Capture Process To start configuring _Image search_ using the wizard: 1. Click **Start from scratch**. 2. Drag the blue selection frame onto the desktop section that contains the image you want to search. ![The Select pattern image dialog](/mulesoft/current/en-us/rpa-builder/6.6/_images/image-selection-frame.png) This selection frame always lies on top of the desktop view, so you can switch to any desktop section containing the image without losing sight of the selection frame. 3. Adjust the size of the selection frame to match the content. To narrow the selection frame down to the relevant content, grab the edges and resize it. You can also fine-tune the frame by pressing the arrow keys on your keyboard, which moves the frame by 1 pixel at a time; if you press _Ctrl_ + arrow key, the frame moves by 5 pixels at a time. Pressing _Shift_ + arrow key resizes the frame 1 pixel at a time. Choosing and capturing the correct pattern is essential for creating a stable _Workflow_. You need to select a pattern that does not change, is unique, is initially visible at all screen resolutions the _Workflow_ will run with, and (ideally) does not change its position much. ### Freezing the Desktop If you want to capture a _Pattern image_ that is only visible for a short time or under specific conditions, you can freeze the desktop in its current state to select the _Pattern image_. To freeze the desktop, press _Pause_ on your keyboard. You can also click on the bar _Hover or click here to freeze Desktop_ to start a timer. Then you have five seconds to create the situation on the desktop that you want to capture. Use the freeze function to capture things that only show with direct mouse input, such as hover effects. Once the desktop is frozen, a big _Unfreeze_ button appears on the selection frame. Click it to unfreeze the desktop again. ### Using Zoom View for Small Selections If you have to capture a very small part of the screen (which is always a good thing if this part is unique enough to be used for identification), you might need an enhanced view of the _Pattern image_ content. Enable the checkbox _Show Zoom View for small selections_ in the blue frame to make a zoom view window appear onscreen. This window only appears for small selections and disappears if your selection gets too big. ### Capturing the Image Make sure the image contains as many contours as needed to identify the desired part of the screen with 100% certainty. Try to keep images as small as possible, because smaller images can be found faster and do not need as much CPU performance. Avoid leaving too much empty space around the image. If you are satisfied with the selection either press `F10`, click _Capture_ or double-click anywhere on the frame to save the selected area as the _Pattern image_. Your _Pattern image_ size should always follow the rule "as big as necessary, as small as possible" to ensure a good, steady search performance. ### Capturing the Search Area After you captured the _Pattern image_, a red frame appears to define the search area. ![Example of capturing the Search Area](/mulesoft/current/en-us/rpa-builder/6.6/_images/capturing-search-area.png) This is the area of the screen that will later be searched for the _Pattern image_. Again, this selection should be "as big as necessary, as small as possible" – it needs to be large enough to always contain the _Pattern image_, but as small as possible to reduce the CPU load during the search. A larger _Search area_ always means a higher CPU load and higher response times. However, keep in mind that the _Pattern image_ to be identified may be displayed in different desktop positions, so do not narrow the _Search area_ down too much. You can save the _Search area_ the same way you saved the _Pattern image_. After selecting the _Pattern image_ and the _Search area_, RPA Builder evaluates the accuracy with which the defined image is currently found. ![Example image search accuracy](/mulesoft/current/en-us/rpa-builder/6.6/_images/example-image-search-accuracy.png) A newly recorded image search should always be found with 100% accuracy. ## The Different Search Modes The _Image Search_ Action Step supports the following search modes: - **_Color_** The simplest and fastest search algorithm. In the default configuration, the color of the image searched must exactly match the color of the recorded image. However, because the color values of images can differ on the machines the _Workflow_ will run on (depending on the graphics hardware used), you may downscale the _Compare Precision_ settings to stabilize the image search. The color match precision can be downscaled from 100% (exact match) to 88% (ignoring the least significant four bits of the color value). Use the _Color_ search algorithm only if the hardware the _Workflow_ runs on does not differ from the hardware it was created on. - **_Gradient_** Uses edges to detect the _Pattern image_, but checks gray values before the actual edge search is performed. Thus it can detect the presence of an image faster than contour mode using a similar precision. Using gray values has the side effect of being less tolerant regarding color variations than in contour mode. Also, colors leading to the same gray value cannot be distinguished from one another. - **_Contour_** The default and recommended search algorithm. It is very stable regarding color variations and can handle changes in color depth and different desktop resolutions. It creates a contour search image based on the transitions between the different color values in the _Pattern image_ by reducing all colors to black areas while edges become white lines. - **_Contour Plus_** This search algorithm was created specifically to identify characters and writing. It uses the same technique as _Contour_ mode, but with additional compensation for font smoothing. ## Adjusting Threshold for Contour and Contour Plus Mode When you use one of the contour modes, you can adjust the black/white threshold. The default value, 10, is usually the optimal setting for images with high contrast; you should not need to adjust it, particularly if you are searching for text. However, when searching for low contrast _Pattern images_ and actual pictures, you might need to adjust the slider until you see a clear contour. ![The white and black threshold slider to adjust contour detection](/mulesoft/current/en-us/rpa-builder/6.6/_images/contour-threshold.png) For example, consider that we want to use the two people in this image as a _Pattern image_ in _Contour_ mode: ![An example image showing two people and Max the Mule](/mulesoft/current/en-us/rpa-builder/6.6/_images/example-image-contour-mode.png) After recording the image, the default value of the threshold produces this _Pattern image_: ![Example pattern where the contour is not very defined](/mulesoft/current/en-us/rpa-builder/6.6/_images/pattern-image-1.png) In this image, you can see that a lot of the subtle variations in the colors created edges in the contour picture. By increasing the black/white threshold, the Image Search ignores the subtle color variations, resulting in a clear contour that allows for more reliable picture detection: ![Example pattern where the contour is clear due to higher threshold settings](/mulesoft/current/en-us/rpa-builder/6.6/_images/pattern-image-2.png) ## Troubleshooting If you have problems finding the same picture on different machines, ensure that the system parameters of these systems are all the same. If you are still having problems, you can decrease the required match precision. But be careful, if the required percentage is too low, the Image Search Action Step might find the _Pattern image_ even though it does not exist. ![Image search match precision settings](/mulesoft/current/en-us/rpa-builder/6.6/_images/image-search-match-precision.png) > [!WARNING] To avoid false positives, do not set the match precision below 90%. ## See Also - [Workflow Properties](https://docs.mulesoft.com/rpa-builder/6.6/workflow-configure-properties#properties) - [Checking System Parameters](https://docs.mulesoft.com/rpa-builder/6.6/checking-system-parameters) - [Configuring System Parameters With One Setting](https://docs.mulesoft.com/rpa-builder/6.6/configure-system-parameters-one-setting) - [Ensuring Windows Fonts Match](https://docs.mulesoft.com/rpa-builder/6.6/ensure-windows-fonts-match) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Image Search > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Image search_ action step searches for a user-defined image, waits until it appears or disappears, and can also be used as a relative anchor point for mouse clicks. Image in this case does not only mean picture, but also includes the visual representation of lettering or control elements like buttons. The most common use cases for _Image search_ are: - Calculating loading times To compute the loading time of a webpage or an application loading data from a distant server, it is not sufficient to wait for the window to appear. In such cases, the webpage or application can only be said to be loaded when the content is also visualized; that is, when an image can be seen. - Checking for feedback from remote applications When the measured application is running on a distant system and the Workflow has to use a Citrix client, VCN, or a similar remote connection tool that only displays the user interface graphically but does not give back handles, Image search is the only way to ascertain that the desired content has appeared onscreen. - Positioning the mouse relative to an image Finally, the position of the image can be used to place a mouse click relatively to the image, for example to enter a URL in the address bar of a web browser, or to enter login information into user and password fields. What the _Image search_ actually does is compare the recorded _Pattern image_ to the whole _Search area_. During execution, it takes a screenshot of the _Search area_, applies the selected _Image search_ algorithm to it, and then compares it to the _Pattern image_. The _Search area_ adjusts automatically if the executing computer has a different screen resolution to the computer the _Workflow_ was originally created on. Also, uses the lowest common color depth setting, so for example, if you created an _Image search_ with a color depth of 32 bits, but the executing computer only has a color depth of 16 bits, the original _Pattern image_ is converted on the fly to match the current system’s color depth. You can adjust this within the Workflow Properties. ## Properties - **Compare Precision** This is an additional setting for the search algorithm modes _Color_ and _Gradient_. In these modes the actual color value of a pixel is recorded. The result is not the exact same value every time a pixel value is calculated by the GPU. By lowering the compare precision to 98% or 97%, you can allow the value to vary a little in the least significant bits. - **Edge detection threshold** Threshold for the difference (distance) between colors that leads to the detection of an edge. A low threshold leads to many detected edges because even a small difference in a pixel’s color value in comparison to its neighbors' is detected as an edge. Conversely, a high threshold leads to fewer edges in the _Pattern image_ the algorithm is searching for. - **Hide Mouse** If this option is enabled, the mouse pointer is moved to the upper left corner of the desktop during the _Image search_. Enable this to avoid triggering hover effects in applications and on websites. This is to ensure that the mouse pointer is not partly covering the image searched for. Afterwards it is moved back to the previous position. - **Image search algorithm** _Image search_ algorithm to use. Available options are _Color_, _Gradient_, _Contour_, and _Contour Plus_. See [The Different Search Modes](#search-modes) for a descriptions of these modes. - **Image search type _Search for picture appear_** Search for the picture until it appears. As soon as it can be detected, the _Image search_ is considered successful. - **Image search type _Search for picture disappear_** The _Image search_ is considered successful as soon as the image cannot be found. An image does not have to be found first, so if finding the image is necessary an _Image search_ with search type _Appear_ must be performed first. - **Original desktop color depth** (_Properties grid_ only): Color depth in bits at the time the image was recorded. - **Original desktop height** (_Properties grid_ only): Desktop height in pixels at the time the image was recorded. - **Original desktop width** (_Properties grid_ only): Desktop width in pixels at the time the image was recorded. - **_Pattern Image_ File Path** (_Properties grid_ only): File location of the recorded image. - **_Pattern image_ rect** (_Properties grid_ only): Original coordinates (upper left corner, lower right corner) of the rectangular area on the desktop enclosing the image to be searched. - **Percentage required** Determines tolerance of the _Image search_, i.e. the minimum quality percentage threshold needed for successful identification of an image. A lower value means a higher tolerance, but also increases the likelihood of a false positive. To avoid false positives, do not set this value below 90%. - **Relative To** Makes the _Search Area_ relative to a previous _Image search_, in the same way as for the _Mouse Clicks action step_. - **_Search area_ rect** (_Properties grid_ only): Original coordinates (upper left corner, lower right corner) of the rectangular area on the desktop enclosing the _Search area_. - **Wait time \[ms\]** The pause between two subsequent image searches (only used if _Wait until image is steady_ is activated). - **Wait until image is steady** This function is used to perform a second _Image search_ after the image is detected and introduces an additional _Wait time._ The result of this second run compared to the previous one is to ensure that the image is still there and has not changed its position. If the results are equal, then the _Image search_ is considered successful. If not, additional _Image search_es are performed until two subsequent ones have the same result or until the timeout is reached. - **Interrupt time \[ms\]** Mainly used for _Java_ Applications: time in milliseconds the service stops searching for a picture to provide CPU resources to an application with bad performance (only applicable if _Load Optimizer_ is activated). - **Load Optimizer** If enabled, there is a pause between every attempt to find the image onscreen, as defined by the _Interrupt time_ setting. This pause allows time for other programs to do something when running on a single core computer. - **Performance Limit (%)** Defines how much of the CPU performance can be used for the _Image search_ (only applicable if _Load Optimizer_ is activated). ## Variables - **Find Coordinate** The X and Y coordinates of where the picture was found. ## Wizard ![The image search Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/image-search-wizard.png) - **Start from scratch** Starts the configuration using all steps. - **_Search area_** Only reconfigures the _Search area_, using a previously captured image. - **_Pattern image_** Only recaptures the image to search for - **Refresh _Search area_** Refreshes the _Search area_ frame on the right-hand side of the wizard with the current desktop situation, so you can check if the defined _Search area_ still includes the image. - **Show borders** If active; the _Pattern image_ is marked with a blue border and the _Search area_ is marked with a red border in the _Search area_ frame. - **_Pattern image_** Shows the recorded image that is used in searches. - **Check search** Evaluate the probability the captured image is found. The result shows in a box before the _Pattern image_ frame and comprises the position of the image found, as well as the match precision in percent (this feature uses the current desktop and not the image shown in the _Search area_ frame). - **_Search area_** Shows the desktop situation when the image was captured onscreen. If _Show Borders_ is active, borders of the search image are shown in blue and borders of the _Search area_ are shown in red. If you performed a _Check search_ and the image could be found, its position is marked by a green border. ## Starting the Capture Process To start configuring _Image search_ using the wizard: 1. Click **Start from scratch**. 2. Drag the blue selection frame onto the desktop section that contains the image you want to search. ![The Select pattern image dialog](/mulesoft/current/en-us/rpa-builder/latest/_images/image-selection-frame.png) This selection frame always lies on top of the desktop view, so you can switch to any desktop section containing the image without losing sight of the selection frame. 3. Adjust the size of the selection frame to match the content. To narrow the selection frame down to the relevant content, grab the edges and resize it. You can also fine-tune the frame by pressing the arrow keys on your keyboard, which moves the frame by 1 pixel at a time; if you press _Ctrl_ + arrow key, the frame moves by 5 pixels at a time. Pressing _Shift_ + arrow key resizes the frame 1 pixel at a time. Choosing and capturing the correct pattern is essential for creating a stable _Workflow_. You need to select a pattern that does not change, is unique, is initially visible at all screen resolutions the _Workflow_ will run with, and (ideally) does not change its position much. ### Freezing the Desktop If you want to capture a _Pattern image_ that is only visible for a short time or under specific conditions, you can freeze the desktop in its current state to select the _Pattern image_. To freeze the desktop, press _Pause_ on your keyboard. You can also click on the bar _Hover or click here to freeze Desktop_ to start a timer. Then you have five seconds to create the situation on the desktop that you want to capture. Use the freeze function to capture things that only show with direct mouse input, such as hover effects. Once the desktop is frozen, a big _Unfreeze_ button appears on the selection frame. Click it to unfreeze the desktop again. ### Using Zoom View for Small Selections If you have to capture a very small part of the screen (which is always a good thing if this part is unique enough to be used for identification), you might need an enhanced view of the _Pattern image_ content. Enable the checkbox _Show Zoom View for small selections_ in the blue frame to make a zoom view window appear onscreen. This window only appears for small selections and disappears if your selection gets too big. ### Capturing the Image Make sure the image contains as many contours as needed to identify the desired part of the screen with 100% certainty. Try to keep images as small as possible, because smaller images can be found faster and do not need as much CPU performance. Avoid leaving too much empty space around the image. If you are satisfied with the selection either press `F10`, click _Capture_ or double-click anywhere on the frame to save the selected area as the _Pattern image_. Your _Pattern image_ size should always follow the rule "as big as necessary, as small as possible" to ensure a good, steady search performance. ### Capturing the Search Area After you captured the _Pattern image_, a red frame appears to define the search area. ![Example of capturing the Search Area](/mulesoft/current/en-us/rpa-builder/latest/_images/capturing-search-area.png) This is the area of the screen that will later be searched for the _Pattern image_. Again, this selection should be "as big as necessary, as small as possible" – it needs to be large enough to always contain the _Pattern image_, but as small as possible to reduce the CPU load during the search. A larger _Search area_ always means a higher CPU load and higher response times. However, keep in mind that the _Pattern image_ to be identified may be displayed in different desktop positions, so do not narrow the _Search area_ down too much. You can save the _Search area_ the same way you saved the _Pattern image_. After selecting the _Pattern image_ and the _Search area_, RPA Builder evaluates the accuracy with which the defined image is currently found. ![Example image search accuracy](/mulesoft/current/en-us/rpa-builder/latest/_images/example-image-search-accuracy.png) A newly recorded image search should always be found with 100% accuracy. ## The Different Search Modes The _Image Search_ action step supports the following search modes: - **_Color_** The simplest and fastest search algorithm. In the default configuration, the color of the image searched must exactly match the color of the recorded image. However, because the color values of images can differ on the machines the _Workflow_ will run on (depending on the graphics hardware used), you may downscale the _Compare Precision_ settings to stabilize the image search. The color match precision can be downscaled from 100% (exact match) to 88% (ignoring the least significant four bits of the color value). Use the _Color_ search algorithm only if the hardware the _Workflow_ runs on does not differ from the hardware it was created on. - **_Gradient_** Uses edges to detect the _Pattern image_, but checks gray values before the actual edge search is performed. Thus it can detect the presence of an image faster than contour mode using a similar precision. Using gray values has the side effect of being less tolerant regarding color variations than in contour mode. Also, colors leading to the same gray value cannot be distinguished from one another. - **_Contour_** The default and recommended search algorithm. It is very stable regarding color variations and can handle changes in color depth and different desktop resolutions. It creates a contour search image based on the transitions between the different color values in the _Pattern image_ by reducing all colors to black areas while edges become white lines. - **_Contour Plus_** This search algorithm was created specifically to identify characters and writing. It uses the same technique as _Contour_ mode, but with additional compensation for font smoothing. ## Adjusting Threshold for Contour and Contour Plus Mode When you use one of the contour modes, you can adjust the black/white threshold. The default value, 10, is usually the optimal setting for images with high contrast; you should not need to adjust it, particularly if you are searching for text. However, when searching for low contrast _Pattern images_ and actual pictures, you might need to adjust the slider until you see a clear contour. ![The white and black threshold slider to adjust contour detection](/mulesoft/current/en-us/rpa-builder/latest/_images/contour-threshold.png) For example, consider that we want to use the two people in this image as a _Pattern image_ in _Contour_ mode: ![An example image showing two people and Max the Mule](/mulesoft/current/en-us/rpa-builder/latest/_images/example-image-contour-mode.png) After recording the image, the default value of the threshold produces this _Pattern image_: ![Example pattern where the contour is not very defined](/mulesoft/current/en-us/rpa-builder/latest/_images/pattern-image-1.png) In this image, you can see that a lot of the subtle variations in the colors created edges in the contour picture. By increasing the black/white threshold, the Image Search ignores the subtle color variations, resulting in a clear contour that allows for more reliable picture detection: ![Example pattern where the contour is clear due to higher threshold settings](/mulesoft/current/en-us/rpa-builder/latest/_images/pattern-image-2.png) ## Troubleshooting If you have problems finding the same picture on different machines, ensure that the system parameters of these systems are all the same. If you are still having problems, you can decrease the required match precision. But be careful, if the required percentage is too low, the Image Search action step might find the _Pattern image_ even though it does not exist. ![Image search match precision settings](/mulesoft/current/en-us/rpa-builder/latest/_images/image-search-match-precision.png) > [!WARNING] To avoid false positives, do not set the match precision below 90%. ## See Also - [Workflow Properties](https://docs.mulesoft.com/rpa-builder/latest/workflow-configure-properties#properties) - [Checking System Parameters](https://docs.mulesoft.com/rpa-builder/latest/checking-system-parameters) - [Configuring System Parameters With One Setting](https://docs.mulesoft.com/rpa-builder/latest/configure-system-parameters-one-setting) - [Ensuring Windows Fonts Match](https://docs.mulesoft.com/rpa-builder/latest/ensure-windows-fonts-match) --- product: RPA Builder version: 6.6 --- # Inserting Text Modules > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can insert text modules in some text fields that elements of a Workflow use. Each of the Workflow elements that use text modules has drop-down insert lists in the Wizard that enable you to add the text modules. ![The Enter String Action Step Wizard showing the differnt text module drop-down menus](/mulesoft/current/en-us/rpa-builder/6.6/_images/insert-text-module.png) Click on the appropriate element to insert the text module into the input field where the cursor is located. The following Workflow elements use insert lists: - [Workflow Initialization: Settings](https://docs.mulesoft.com/rpa-builder/6.6/workflow-initialization) - [Enter String](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-enter-string) Action Step - [Keystrokes](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-keystrokes) Action Step - [Run Program](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-run-program) Action Step - Some [File Operation](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations) Action Steps - [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-file-controlled-loop) Action Step - [Combine Strings](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-combine-strings) Action Step There are four types of insert lists: Insert Special Character, Insert Script Variable, Insert Macro, and Insert Environment Variable. ## Insert Special Character ![The Insert Special Character drop-down menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/insert-special-character.png) Special Characters are keys and key combinations which are understood as commands rather than strings. For example, `{ENTER}` is not written, it emulates the **Enter** key on the keyboard. ### Available Special Characters - `!` - `#` - `+` - `^` - `{` - `}` - `SPACE` - `ENTER` - `ALT` - `BACKSPACE` - `DELETE` - `UP` - `DOWN` - `LEFT` - `RIGHT` - `HOME` - `END` - `ESCAPE` - `INSERT` - `PGUP` - `PGDN` - `F1` - `F2` - `F3` - `F4` - `F5` - `F6` - `F7` - `F8` - `F9` - `F10` - `F11` - `F12` - `TAB` - `PRINTSCREEN` - `LWIN` - `RWIN` - `NUMLOCK on` - `NUMLOCK off` - `NUMLOCK toggle` - `CAPSLOCK on` - `CAPSLOCK off` - `CAPSLOCK toggle` - `SCROLLLOCK on` - `SCROLLLOCK off` - `SCROLLLOCK toggle` - `CTRLBREAK` - `PAUSE` - `NUMPAD0` - `NUMPAD1` - `NUMPAD2` - `NUMPAD3` - `NUMPAD4` - `NUMPAD5` - `NUMPAD6` - `NUMPAD7` - `NUMPAD8` - `NUMPAD9` - `NUMPADMULT` - `NUMPADADD` - `NUMPADSUB` - `NUMPADDIV` - `NUMPADDOT` - `NUMPADENTER` - `APPSKEY` - `LALT` - `RALT` - `LCTRL` - `RCTRL` - `LSHIFT` - `RSHIFT` - `SLEEP` - `ALTDOWN` - `ALTUP` - `SHIFTDOWN` - `SHIFTUP` - `CTRLDOWN` - `CTRLUP` - `LWINDOWN` - `LWINUP` - `RWINDOWN` - `RWINUP` - `ASC nnnn` ## Insert Script Variable ![The Insert Script Variable drop-down menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/insert-script-variable.png) Script Variables are macros that the RPA bot replaces with real values during the execution of the Action Step, for example: - `{@UserName}` is replaced by the name of the user who is logged into the system during execution - `{@CRLF}` inserts a line break Because script variables are generated at runtime, the available list of variables looks different on each system. Usually, the list includes the computer and host name as well as formatting commands. ## Insert Macro ![The Insert Macro drop-down menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/insert-macro.png) Macros are combinations of characters, Special Characters and Script Variables, which combine to create a meaningful command, for example: - `{$User0}{TAB}{$Password0}{ENTER}` performs a typical login action ### Available Macros - Select All (CTRL+A): `{CTRLDOWN}a{CTRLUP}` - Show Desktop (WIN+D): `{LWINDOWN}d{LWINUP}` - Close Window (ALT+F4): `{ALTDOWN}{F4}{ALTUP}` - Close Pane (CTRL+F4): `{CTRLDOWN}{F4}{CTRLUP}` - Copy (CTRL+C): `{CTRLDOWN}c{CTRLUP}` - Cut (CTRL+X): `{CTRLDOWN}x{CTRLUP}` - Paste (CTRL+V): `{CTRLDOWN}v{CTRLUP}` - Dock Window Left (WIN+Left Arrow): `{LWINDOWN}{LEFT}{LWINUP}` - Dock Window Right (WIN+Right Arrow): `{LWINDOWN}{RIGHT}{LWINUP}` - Maximize Window (WIN+Up Arrow): `{LWINDOWN}{UP}{LWINUP}` - Minimize Window (WIN+Down Arrow): `{LWINDOWN}{DOWN}{LWINUP}` - Minimize all Windows (WIN+M): `{LWINDOWN}m{LWINUP}` - Close English application by menu: `{ALTDOWN}f{ALTUP}x` - Close German application by menu: `{ALTDOWN}d{ALTUP}e` - Find (CTRL+F): `{CTRLDOWN}f{CTRLUP}` - Open (CTRL+O): `{CTRLDOWN}o{CTRLUP}` - Save (CTRL+S): `{CTRLDOWN}s{CTRLUP}` - Undo (CTRL+Z): `{CTRLDOWN}z{CTRLUP}` - Redo (CTRL+Y): `{CTRLDOWN}y{CTRLUP}` - Print (CTRL+P): `{CTRLDOWN}p{CTRLUP}` - Typical Login Action: `{$User0}{TAB}{$Password0}{ENTER}` - Document Top (CTRL+POS1): `{CTRLDOWN}{HOME}{CTRLUP}` - Document End (CTRL+END): `{CTRLDOWN}{END}{CTRLUP}` - Current Date (deu): `#var#=StcGetLocalDate();` - Current Date (en): `#var#=StcGetLocalDate(\"en-us\");` - Current Time: `#var#=StcGetLocalTime();` ## Insert Environment Variable ![The Insert Environment Variable drop-down menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/insert-environment-variable.png) Environment Variables are replaced by the names and paths of the system on which you’re creating the Workflow, for example: - `%COMPUTERNAME%` is replaced by the name of the relevant computer - `%ProgramFiles%` is replaced by the current path to Program Files, for example `C:\Program Files` If you want to replace these variables on execution only, use Insert Script Variable instead. ### Available Environment Variables The Environment Variables that you can select depend on the system on which RPA Builder is installed. RPA Builder replaces environment variables with the relevant value when inserted in an Action Step wizard and are not modified if they are subsequently executed or opened. Usually, environment variables include the computer name as well as some system paths. The following is a non-exhaustive list of available Environment Variables: - `%ALLUSERSPROFILE%` - `%APPDATA%` - `%COMPUTERNAME%` - `%ProgramFiles(x86)%` - `%ProgramFiles%` - `%USERPROFILE%` - `%SystemRoot%` - `%SystemDrive%` ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/6.6/workflow-configure-properties) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Inserting Text Modules > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can insert text modules in some text fields that elements of a Workflow use. Each of the Workflow elements that use text modules has drop-down insert lists in the Wizard that enable you to add the text modules. ![The Enter String action step Wizard showing the different text module drop-down menus](/mulesoft/current/en-us/rpa-builder/latest/_images/insert-text-module.png) Click on the appropriate element to insert the text module into the input field where the cursor is located. The following Workflow elements use insert lists: - [Workflow Initialization: Settings](https://docs.mulesoft.com/rpa-builder/latest/workflow-initialization) - [Enter String](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-enter-string) action step - [Keystrokes](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-keystrokes) action step - [Run Program](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-run-program) action step - Some [File Operation](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations) action steps - [File Controlled Loop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-file-controlled-loop) action step - [Combine Strings](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-combine-strings) action step There are four types of insert lists: Insert Special Character, Insert Script Variable, Insert Macro, and Insert Environment Variable. ## Insert Special Character ![The Insert Special Character drop-down menu](/mulesoft/current/en-us/rpa-builder/latest/_images/insert-special-character.png) Special Characters are keys and key combinations which are understood as commands rather than strings. For example, `{ENTER}` is not written, it emulates the **Enter** key on the keyboard. ### Available Special Characters - `!` - `#` - `+` - `^` - `{` - `}` - `SPACE` - `ENTER` - `ALT` - `BACKSPACE` - `DELETE` - `UP` - `DOWN` - `LEFT` - `RIGHT` - `HOME` - `END` - `ESCAPE` - `INSERT` - `PGUP` - `PGDN` - `F1` - `F2` - `F3` - `F4` - `F5` - `F6` - `F7` - `F8` - `F9` - `F10` - `F11` - `F12` - `TAB` - `PRINTSCREEN` - `LWIN` - `RWIN` - `NUMLOCK on` - `NUMLOCK off` - `NUMLOCK toggle` - `CAPSLOCK on` - `CAPSLOCK off` - `CAPSLOCK toggle` - `SCROLLLOCK on` - `SCROLLLOCK off` - `SCROLLLOCK toggle` - `CTRLBREAK` - `PAUSE` - `NUMPAD0` - `NUMPAD1` - `NUMPAD2` - `NUMPAD3` - `NUMPAD4` - `NUMPAD5` - `NUMPAD6` - `NUMPAD7` - `NUMPAD8` - `NUMPAD9` - `NUMPADMULT` - `NUMPADADD` - `NUMPADSUB` - `NUMPADDIV` - `NUMPADDOT` - `NUMPADENTER` - `APPSKEY` - `LALT` - `RALT` - `LCTRL` - `RCTRL` - `LSHIFT` - `RSHIFT` - `SLEEP` - `ALTDOWN` - `ALTUP` - `SHIFTDOWN` - `SHIFTUP` - `CTRLDOWN` - `CTRLUP` - `LWINDOWN` - `LWINUP` - `RWINDOWN` - `RWINUP` - `ASC nnnn` ## Insert Script Variable ![The Insert Script Variable drop-down menu](/mulesoft/current/en-us/rpa-builder/latest/_images/insert-script-variable.png) Script Variables are macros that the RPA bot replaces with real values during the execution of the action step, for example: - `{@UserName}` is replaced by the name of the user who is logged into the system during execution - `{@CRLF}` inserts a line break Because script variables are generated at runtime, the available list of variables looks different on each system. Usually, the list includes the computer and host name as well as formatting commands. ## Insert Macro ![The Insert Macro drop-down menu](/mulesoft/current/en-us/rpa-builder/latest/_images/insert-macro.png) Macros are combinations of characters, Special Characters and Script Variables, which combine to create a meaningful command, for example: - `{$User0}{TAB}{$Password0}{ENTER}` performs a typical login action ### Available Macros - Select All (CTRL+A): `{CTRLDOWN}a{CTRLUP}` - Show Desktop (WIN+D): `{LWINDOWN}d{LWINUP}` - Close Window (ALT+F4): `{ALTDOWN}{F4}{ALTUP}` - Close Pane (CTRL+F4): `{CTRLDOWN}{F4}{CTRLUP}` - Copy (CTRL+C): `{CTRLDOWN}c{CTRLUP}` - Cut (CTRL+X): `{CTRLDOWN}x{CTRLUP}` - Paste (CTRL+V): `{CTRLDOWN}v{CTRLUP}` - Dock Window Left (WIN+Left Arrow): `{LWINDOWN}{LEFT}{LWINUP}` - Dock Window Right (WIN+Right Arrow): `{LWINDOWN}{RIGHT}{LWINUP}` - Maximize Window (WIN+Up Arrow): `{LWINDOWN}{UP}{LWINUP}` - Minimize Window (WIN+Down Arrow): `{LWINDOWN}{DOWN}{LWINUP}` - Minimize all Windows (WIN+M): `{LWINDOWN}m{LWINUP}` - Close English application by menu: `{ALTDOWN}f{ALTUP}x` - Close German application by menu: `{ALTDOWN}d{ALTUP}e` - Find (CTRL+F): `{CTRLDOWN}f{CTRLUP}` - Open (CTRL+O): `{CTRLDOWN}o{CTRLUP}` - Save (CTRL+S): `{CTRLDOWN}s{CTRLUP}` - Undo (CTRL+Z): `{CTRLDOWN}z{CTRLUP}` - Redo (CTRL+Y): `{CTRLDOWN}y{CTRLUP}` - Print (CTRL+P): `{CTRLDOWN}p{CTRLUP}` - Typical Login Action: `{$User0}{TAB}{$Password0}{ENTER}` - Document Top (CTRL+POS1): `{CTRLDOWN}{HOME}{CTRLUP}` - Document End (CTRL+END): `{CTRLDOWN}{END}{CTRLUP}` - Current Date (deu): `#var#=StcGetLocalDate();` - Current Date (en): `#var#=StcGetLocalDate(\"en-us\");` - Current Time: `#var#=StcGetLocalTime();` ## Insert Environment Variable ![The Insert Environment Variable drop-down menu](/mulesoft/current/en-us/rpa-builder/latest/_images/insert-environment-variable.png) Environment Variables are replaced by the names and paths of the system on which you’re creating the Workflow, for example: - `%COMPUTERNAME%` is replaced by the name of the relevant computer - `%ProgramFiles%` is replaced by the current path to Program Files, for example `C:\Program Files` If you want to replace these variables on execution only, use Insert Script Variable instead. ### Available Environment Variables The Environment Variables that you can select depend on the system on which RPA Builder is installed. RPA Builder replaces environment variables with the relevant value when inserted in an action step wizard and are not modified if they are subsequently executed or opened. Usually, environment variables include the computer name as well as some system paths. The following is a non-exhaustive list of available Environment Variables: - `%ALLUSERSPROFILE%` - `%APPDATA%` - `%COMPUTERNAME%` - `%ProgramFiles(x86)%` - `%ProgramFiles%` - `%USERPROFILE%` - `%SystemRoot%` - `%SystemDrive%` ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/latest/workflow-configure-properties) --- product: RPA Builder version: 6.6 --- # Installing and Configuring RPA Builder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt After downloading and installing RPA Builder, configure the connection with RPA Manager and configure the necessary system parameters in your Windows installation to improve the overall performance of your system and improve text recognition features. You can also customize the RPA Builder UI to match your preferences. ## Download and Install RPA Builder 1. Download the latest RPA Builder installer from the **Home** page of RPA Manager. 2. Right-click the installer file and select **Run as Administrator**. 3. Continue the installation process until it finishes. 4. Ensure you have the [required privileges](https://docs.mulesoft.com/rpa-home/automation-userrolesandpermissions-privilegesbymodule#privileges-of-the-rpa-builder-category) assigned in RPA Manager. See [Assign Privileges to a Users](https://docs.mulesoft.com/rpa-manager/usermanagement-manage#assign-privileges-to-a-user) for instructions. If you are in doubt, contact your organization’s RPA administrator. ## Connect RPA Builder with RPA Manager (Anypoint Platform) After opening RPA Builder for the first time, configure the connection with RPA Manager using your Anypoint Platform credentials: 1. Provide your RPA Manager instance address. ![The Anypoint Platform login screen prompt to configure the RPA Manager address](/mulesoft/current/en-us/rpa-builder/6.6/_images/anypoint-rpa-org-log-in.png) Use **Proxy Settings** to configure a specific proxy to connect with Anypoint Platform. By default, **Use System Proxy Settings** is enabled so that RPA Builder uses the same proxy configuration your system uses to access internet. 2. Log in using your Anypoint Platform account. ![The Anypoint Platform login screen prompt to configure the login credentials](/mulesoft/current/en-us/rpa-builder/6.6/_images/anypoint-rpa-user-log-in.png) After you log in, RPA Builder remains connected using the specified Anypoint Platform credentials. To connect to a different RPA Manager instance or use other login credentials: 1. In the top menu bar, navigate to **Options > Account**. 2. Click **Sign out**. 3. Provide the new RPA Manager address and login credentials. ## Connect RPA Builder with RPA Manager (Legacy) If your organization is not migrated to Anypoint Platform, provide your RPA Manager user credentials to establish the connection after opening RPA Builder for the first time: 1. In the top menu bar, select **Options** > **Repository**. (This menu opens automatically the first time you open RPA Builder) 2. Configure the required values: ![The RPA Builder Repository settings](/mulesoft/current/en-us/rpa-builder/6.6/_images/repository-settings.png) - **RPA Manager Address** The URL of the RPA Manager instance RPA Builder connects to. Do not specify the protocol (`https://`) as part of this value. - **User Name** The RPA Manager user name that RPA Builder uses to log in. - **Password** The RPA Manager password that RPA Builder uses to log in. - **Proxy Settings** Use to configure a proxy to connect to RPA Manager. By default, **Use System Proxy Settings** is enabled so that RPA Builder uses the same proxy configuration your system uses to access internet. 3. Click **Test Connection** and confirm that the login succeeds. If the login attempt fails, verify the provided details and try again. 4. Click **OK**. ## See Also - [Checking System Parameters](https://docs.mulesoft.com/rpa-builder/6.6/checking-system-parameters) - [UI Overview](https://docs.mulesoft.com/rpa-builder/6.6/ui-overview) - [Modifying the User Interface](https://docs.mulesoft.com/rpa-builder/6.6/modify-user-interface) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Installing and Configuring RPA Builder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt After downloading and installing RPA Builder, configure the connection with RPA Manager and configure the necessary system parameters in your Windows installation to improve the overall performance of your system and improve text recognition features. You can also customize the RPA Builder UI to match your preferences. ## Download and Install RPA Builder 1. Download the latest RPA Builder installer from the **Home** page of RPA Manager. 2. Right-click the installer file and select **Run as Administrator**. 3. Continue the installation process until it finishes. 4. Ensure you have the [required privileges](https://docs.mulesoft.com/rpa-home/automation-userrolesandpermissions-privilegesbymodule#privileges-of-the-rpa-builder-category) assigned in RPA Manager. See [Assign Privileges to a Users](https://docs.mulesoft.com/rpa-manager/usermanagement-manage#assign-privileges-to-a-user) for instructions. If you are in doubt, contact your organization’s RPA administrator. ## Connect RPA Builder with RPA Manager (Anypoint Platform) After opening RPA Builder for the first time, configure the connection with RPA Manager using your Anypoint Platform credentials: 1. Provide your RPA Manager instance address. ![The Anypoint Platform login screen prompt to configure the RPA Manager address](/mulesoft/current/en-us/rpa-builder/latest/_images/anypoint-rpa-org-log-in.png) Use **Proxy Settings** to configure a specific proxy to connect with Anypoint Platform. By default, **Use System Proxy Settings** is enabled so that RPA Builder uses the same proxy configuration your system uses to access internet. 2. Log in using your Anypoint Platform account. ![The Anypoint Platform login screen prompt to configure the login credentials](/mulesoft/current/en-us/rpa-builder/latest/_images/anypoint-rpa-user-log-in.png) After you log in, RPA Builder remains connected using the specified Anypoint Platform credentials. To connect to a different RPA Manager instance or use other login credentials: 1. In the top menu bar, navigate to **Options > Account**. 2. Click **Sign out**. 3. Provide the new RPA Manager address and login credentials. ## Connect RPA Builder with RPA Manager (Legacy) If your organization is not migrated to Anypoint Platform, provide your RPA Manager user credentials to establish the connection after opening RPA Builder for the first time: 1. In the top menu bar, select **Options** > **Repository**. (This menu opens automatically the first time you open RPA Builder) 2. Configure the required values: ![The RPA Builder Repository settings](/mulesoft/current/en-us/rpa-builder/latest/_images/repository-settings.png) - **RPA Manager Address** The URL of the RPA Manager instance RPA Builder connects to. Do not specify the protocol (`https://`) as part of this value. - **User Name** The RPA Manager user name that RPA Builder uses to log in. - **Password** The RPA Manager password that RPA Builder uses to log in. - **Proxy Settings** Use to configure a proxy to connect to RPA Manager. By default, **Use System Proxy Settings** is enabled so that RPA Builder uses the same proxy configuration your system uses to access internet. 3. Click **Test Connection** and confirm that the login succeeds. If the login attempt fails, verify the provided details and try again. 4. Click **OK**. ## See Also - [Checking System Parameters](https://docs.mulesoft.com/rpa-builder/latest/checking-system-parameters) - [UI Overview](https://docs.mulesoft.com/rpa-builder/latest/ui-overview) - [Modifying the User Interface](https://docs.mulesoft.com/rpa-builder/latest/modify-user-interface) --- product: RPA Builder version: 6.6 --- # Intelligent OCR (2020) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Intelligent OCR (2020)_ Action Step represents a good alternative to the previous OCR (Legacy OCR). The new OCR contains the languages Arabic, Greek, Hebrew, and Thai. ## Properties **Color Depth** (bpc) In documents with many images and colors, a setting with low color depth leads to faster search results. You can select a value between 0 and 8. Value 0 means that the color depth remains unchanged compared to the original. **Enhance Contrast** Adjusts the image contrast so that the legibility of the text is improved. **Image Type** - **Auto** (default) The document type is determined automatically - **Document** Can improve the OCR operation of a document (PDF) - **Snippet** Can improve the OCR operation of selected text sections **Recognition Strategy** - **Fast** The OCR operation is carried out faster but this can lead to poorer scan quality - **Advanced** (default) The OCR operation can take longer but the results are optimal ## Outbound Variables The outbound variables are identical to those in the Legacy OCR. ## Wizard **Scaling Mode** **Auto Scale by Engine** (default) Scaling to a higher resolution takes place automatically if this improves the OCR operation. This can lead to slightly longer search operations and also requires more main memory. **Scale by 1** The scaling of the recorded image is set to 1. **Manual scale** In the _Manual scale_ mode, you can determine the scaling factor yourself. You can enter an enlargement value of between 1 and 4 in each case. It is **not** recommended to use a high value (4) in combination with a large image excerpt. **Dictionary** The following languages are available here
ArabicItalian

Chinese (simplified)

Japanese

Chinese (traditional)

Korean

Czech

Norwegian

Danish

Polish

English

Portuguese

Finnish

Russian

French

Spanish

German

Swedish

Greek

Turkish

Hebrew

Thai

Hungarian

In contrast to the situation with Action Step _Legacy OCR,_ here you can combine the Asian languages with each other, and also with the other languages. You can select a maximum of two languages at any time. **Timing** **Retries \[0..5\]** (Default: 3) With this menu option, it is possible to repeat the search recognition up to 5 times. If the text recognition is successful, no further attempt is carried out. This option only appears if you have selected text, Regex, or fuzzy comparison in search mode. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Intelligent OCR (2020) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Intelligent OCR (2020)_ action step represents a good alternative to the previous OCR (Legacy OCR). The new OCR contains the languages Arabic, Greek, Hebrew, and Thai. ## Properties **Color Depth** (bpc) In documents with many images and colors, a setting with low color depth leads to faster search results. You can select a value between 0 and 8. Value 0 means that the color depth remains unchanged compared to the original. **Enhance Contrast** Adjusts the image contrast so that the legibility of the text is improved. **Image Type** - **Auto** (default) The document type is determined automatically - **Document** Can improve the OCR operation of a document (PDF) - **Snippet** Can improve the OCR operation of selected text sections **Recognition Strategy** - **Fast** The OCR operation is carried out faster but this can lead to poorer scan quality - **Advanced** (default) The OCR operation can take longer but the results are optimal ## Outbound Variables The outbound variables are identical to those in the Legacy OCR. ## Wizard **Scaling Mode** **Auto Scale by Engine** (default) Scaling to a higher resolution takes place automatically if this improves the OCR operation. This can lead to slightly longer search operations and also requires more main memory. **Scale by 1** The scaling of the recorded image is set to 1. **Manual scale** In the _Manual scale_ mode, you can determine the scaling factor yourself. You can enter an enlargement value of between 1 and 4 in each case. It is **not** recommended to use a high value (4) in combination with a large image excerpt. **Dictionary** The following languages are available here
ArabicItalian

Chinese (simplified)

Japanese

Chinese (traditional)

Korean

Czech

Norwegian

Danish

Polish

English

Portuguese

Finnish

Russian

French

Spanish

German

Swedish

Greek

Turkish

Hebrew

Thai

Hungarian

In contrast to the situation with action step _Legacy OCR,_ here you can combine the Asian languages with each other, and also with the other languages. You can select a maximum of two languages at any time. **Timing** **Retries \[0..5\]** (Default: 3) With this menu option, it is possible to repeat the search recognition up to 5 times. If the text recognition is successful, no further attempt is carried out. This option only appears if you have selected text, Regex, or fuzzy comparison in search mode. --- product: RPA Builder version: 6.6 --- # Iterate over Files > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Iterate over Files_ Action Step performs various Action Steps on a specified number of files. Drag the Action Steps to be processed into the gray area labeled _Drop Items here_ using drag and drop. The Action Steps placed there will be processed from top to bottom in the order specified. This means that the Action Steps for processing will be applied to all files located in a folder and, depending on the settings, its sub-folders. It is possible to set various parameters such as the maximum number of files to be processed. ## Properties - **File Operation Settings** - **Directory path** The path to the directory that contains the files to process. This field supports absolute and relative paths. Relative paths relate to the _Base Path_ variable. - **File name** Specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. - **Force error if iteration limit is exceeded** Set whether the Workflow interrupts its execution and generates an error message. This behavior applies in the following two cases: **If the number of files for processing set under **Max iterations** has been reached and **Use iteration limit** is enabled.** If the maximum number of 100,000 files has been processed. - **Force error if no file found** Generates an error if the action step cannot find any files that match the given **File name** value in the specified **Directory path**. - **Max iterations** Sets the maximum number of files to process until _Iterate over files_ ends. You can specify up to 100,000 iterations. This value works only when **Use iteration limit** is enabled. - **Recursive loop** Specifies whether to process the sub-folders located in **Directory path** and any files they may contain. - **Use a regular expression for file name** Enable this option to evaluate the **File name** field as a regular expression. - **Use iteration limit** Enable this option to process a limit of up to 100,000 files. Set a custom limit in the field **Max iterations**. ## Inbound Variables - **Directory path** The path to the directory that contains the files to process. This field supports absolute and relative paths. Relative paths relate to the _Base Path_ variable. - **File name** Specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. ## Outbound Variables - **Count Of Processed Elements** The _Iterate over Files.Count of Processed Elements_ variable provides the number of processed files. ## Wizard ![The Iterate over files wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/iterate-over-files-wizard.png) Use the **Directory path** field to specify an absolute or relative path to the files to process. The initial value is the environment variable `%STWS_BASEPATH%`. Use the **\[…​\]** button to browse an existing path. Click the **Pin** (![The Pin Variable icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/pin-icon.png)) button to include variables from the _Workflow_. The **File name** field specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. Click the **Pin** (![The Pin Variable icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/pin-icon.png)) button to include variables from the _Workflow_. Select **Use a regular expression for file name** to evaluate the **File name** field as a regular expression. See [**Path / file name / invalid characters**](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters) for a list of invalid characters. To specify a maximum numbers of files to iterate over, select **Use limitation otherwise 100.000** and specify the limit in the numeric field next to this option. Select **Force error if iteration limit is exceeded** to cause the Workflow to interrupt its execution and generate an error message when the iteration limit is exceeded. This behavior applies in the following two cases: **If the number of files for processing set under **Max iterations** has been reached and **Use iteration limit** is enabled.** If the maximum number of 100,000 files has been processed. To generate an error if the specified files cannot be found, select **Force error if no file found**. Select **Recursive loop over all sub-folders** to process sub-folders and any files inside them while processing the files in the specified **Directory path**. ## Example Search Expressions Use individual question marks (`?`) and supported characters in the **File name** field to find a specific number of variable letters or numeric digits in the file name. For example, The placeholder `???_log.*` finds all files with three unknown characters at the start of the file name, followed by `_log`. If you do not know the number of unknown characters, but a constant piece of text appears in the file name, then you can use `*_log*.*` This search expression finds all files containing `_log` in the file name. The placeholder `.*` searches for any file extension. ## See Also - [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters) - [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Iterate over Files > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Iterate over Files_ action step performs various action steps on a specified number of files. Drag the action steps to be processed into the gray area labeled _Drop Items here_ using drag and drop. The Action Steps placed there will be processed from top to bottom in the order specified. This means that the action steps for processing will be applied to all files located in a folder and, depending on the settings, its sub-folders. It is possible to set various parameters such as the maximum number of files to be processed. ## Properties - **File Operation Settings** - **Directory path** The path to the directory that contains the files to process. This field supports absolute and relative paths. Relative paths relate to the _Base Path_ variable. - **File name** Specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. - **Force error if iteration limit is exceeded** Set whether the Workflow interrupts its execution and generates an error message. This behavior applies in the following two cases: **If the number of files for processing set under **Max iterations** has been reached and **Use iteration limit** is enabled.** If the maximum number of 100,000 files has been processed. - **Force error if no file found** Generates an error if the action step cannot find any files that match the given **File name** value in the specified **Directory path**. - **Max iterations** Sets the maximum number of files to process until _Iterate over files_ ends. You can specify up to 100,000 iterations. This value works only when **Use iteration limit** is enabled. - **Recursive loop** Specifies whether to process the sub-folders located in **Directory path** and any files they may contain. - **Use a regular expression for file name** Enable this option to evaluate the **File name** field as a regular expression. - **Use iteration limit** Enable this option to process a limit of up to 100,000 files. Set a custom limit in the field **Max iterations**. ## Inbound Variables - **Directory path** The path to the directory that contains the files to process. This field supports absolute and relative paths. Relative paths relate to the _Base Path_ variable. - **File name** Specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. ## Outbound Variables - **Count Of Processed Elements** The _Iterate over Files.Count of Processed Elements_ variable provides the number of processed files. ## Wizard ![The Iterate over files wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/iterate-over-files-wizard.png) Use the **Directory path** field to specify an absolute or relative path to the files to process. The initial value is the environment variable `%STWS_BASEPATH%`. Use the **\[…​\]** button to browse an existing path. Click the **Pin** (![The Pin Variable icon](/mulesoft/current/en-us/rpa-builder/latest/_images/pin-icon.png)) button to include variables from the _Workflow_. The **File name** field specifies the names of the files to process. Use wildcard characters to build a search expression. By default, this field is set to `*.*`, which finds all files in a directory. Click the **Pin** (![The Pin Variable icon](/mulesoft/current/en-us/rpa-builder/latest/_images/pin-icon.png)) button to include variables from the _Workflow_. Select **Use a regular expression for file name** to evaluate the **File name** field as a regular expression. See [**Path / file name / invalid characters**](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters) for a list of invalid characters. To specify a maximum numbers of files to iterate over, select **Use limitation otherwise 100.000** and specify the limit in the numeric field next to this option. Select **Force error if iteration limit is exceeded** to cause the Workflow to interrupt its execution and generate an error message when the iteration limit is exceeded. This behavior applies in the following two cases: **If the number of files for processing set under **Max iterations** has been reached and **Use iteration limit** is enabled.** If the maximum number of 100,000 files has been processed. To generate an error if the specified files cannot be found, select **Force error if no file found**. Select **Recursive loop over all sub-folders** to process sub-folders and any files inside them while processing the files in the specified **Directory path**. ## Example Search Expressions Use individual question marks (`?`) and supported characters in the **File name** field to find a specific number of variable letters or numeric digits in the file name. For example, The placeholder `???_log.*` finds all files with three unknown characters at the start of the file name, followed by `_log`. If you do not know the number of unknown characters, but a constant piece of text appears in the file name, then you can use `*_log*.*` This search expression finds all files containing `_log` in the file name. The placeholder `.*` searches for any file extension. ## See Also - [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters) - [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions) --- product: RPA Builder version: 6.6 --- # Json Query > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Json Query Action Step to parse Json objects and read individual values or elements from the object. The result remains available for the rest of the process run as a source variable. Combine this Action Step with REST Call to further refine the resulting JSON output. ## Properties - **JsonPath Expression** The JsonPath expression. For example, `$.access_token`. ## Inbound Variables - **Json Object** The Json object from which to extract the value using the JsonPath expression. You can select the result of a REST Call Action Step to serve as an object. - **JsonPath Expression** The JsonPath expression to specify the value to extract from the object. For example, `$.ID`, to extract the value of element `ID` as a result. ## Outbound Variables - **IsSucceeded** (boolean) Shows if the Action Step executed successfully or not. - **FirstItem** (array) Outputs the first element of the array as a string. - **ArrayCount** Indicates the number of elements of the returned array. ## Wizard Use the Wizard to select the source JSON Object, usually an Inbound Variable containing the result of a REST Call, and to specify the JsonPath expression to extract values from the object. An empty result is a valid result and the process continues without considering it as an error. Use the [JsonPath expression Builder](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions#jsonpath-builder) to simplify the process of creating the JsonPath expression. For more information about JSONPath, see [XPath for JSON](https://goessner.net/articles/JsonPath/). ## See Also - [REST Call](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network-rest-call) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Json Query > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Json Query action step to parse Json objects and read individual values or elements from the object. The result remains available for the rest of the process run as a source variable. Combine this action step with REST Call to further refine the resulting JSON output. ## Properties - **JsonPath Expression** The JsonPath expression. For example, `$.access_token`. ## Inbound Variables - **Json Object** The Json object from which to extract the value using the JsonPath expression. You can select the result of a REST Call action step to serve as an object. - **JsonPath Expression** The JsonPath expression to specify the value to extract from the object. For example, `$.ID`, to extract the value of element `ID` as a result. ## Outbound Variables - **IsSucceeded** (boolean) Shows if the action step executed successfully or not. - **FirstItem** (array) Outputs the first element of the array as a string. - **ArrayCount** Indicates the number of elements of the returned array. ## Wizard Use the Wizard to select the source JSON Object, usually an Inbound Variable containing the result of a REST Call, and to specify the JsonPath expression to extract values from the object. An empty result is a valid result and the process continues without considering it as an error. Use the [JsonPath expression Builder](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions#jsonpath-builder) to simplify the process of creating the JsonPath expression. For more information about JSONPath, see [XPath for JSON](https://goessner.net/articles/JsonPath/). ## See Also - [REST Call](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network-rest-call) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Key Values With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Key values with AWS action step enables you to extract form data by sending a local file to the AWS Textract service, which returns the extracted key-value pairs. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/key-values-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Form Data (Key-Value Pairs)](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-kvp.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Key Values With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Key values with AWS action step enables you to extract form data by sending a local file to the AWS Textract service, which returns the extracted key-value pairs. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/key-values-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Form Data (Key-Value Pairs)](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-kvp.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Keystrokes > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Like the _Enter String_ Action Step, the _Keystrokes_ Action Step emulates keyboard inputs. You can use this to enter search criteria or a URL in the browser address bar, for example. You can also use it to execute hotkeys or macros. ## Properties **Keyboard Settings** - **Key Down delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be pressed down. The keyboard input is generated at the start of this time period. - **Key Up Delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be released. - **Pause (ms)/Pause between keystrokes, ms** (default 500 ms) Pause between two input sequences. An input sequence starts with a pause. For a better understanding, please also see the example at the end of this sub-section. **Window Settings** - **Common window title** If the checkbox _Use common window title for all keystrokes_ is activated, the window title used to identify the window that keystrokes are sent to is displayed here - **Use common window title for all keystrokes** Select if all the keystrokes should be performed in the same window - **Use a regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, refer to Section Using Regular Expressions - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to ## Wizard - **Start** Starts the recording of keystrokes - **Stop** Stops the recording of keystrokes - **Raw** Records all keys as they are pressed. This also includes all modifier keys like **S_hift_**. Pressing the **_Shift_** key and **a** records the following key press sequence: "{SHIFTDOWN}a{SHIFTUP}". - **Norm** Records characters as they would appear in an editor like _Notepad_. Here, pressing the **_Shift_** key and **_a_** records a capital **_A_** - **Move** **keystroke** **sequence** Moves the selected keystroke sequence up or down - **Add keystroke** Calls the _Keystrokes Editor_ where you are able to enter a keystroke sequence manually. For more information about the _Keystrokes Editor_ see further down in this section. - **Edit keystroke sequence** Reconfigures an existing keystroke sequence manually with the _Keystrokes Editor_ - **Delete** Deletes the selected keystroke sequence from the list - **Clear** Deletes all keystrokes within the _Action Step_ - **Hide window when start** Hides the wizard window when _Start_ is clicked (if you are using this option, you need to press **_F10_** to stop the capture) - **Hide main window when start** Hides the RPA Builder window when _Start_ is clicked - **List of keystrokes** All the keystrokes defined for this _Action Step_ are listed here - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to - **Use a regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, refer to Section Using Regular Expressions. - **Use a common window title for all keystrokes** Selects if all keystrokes should be performed in the same window - **Collect Window Titles** Collects all titles of all windows that are currently opened; you may select the required title from a drop-down list provided by this function - **Pause (ms)/Pause between keystrokes, ms** (default 500 ms) Pause between two input sequences. An input sequence starts with a pause. - **Key Down delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be pressed down. The keyboard input is generated at the start of this time period. - **Key Up Delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be released. For a better understanding, please also see the example at the end of this sub-section. You can either manually add a keystroke sequence by clicking the plus button, which will open the _Keystrokes Editor_ (see further details below) or you can record keystrokes. Start the recording by clicking the start button. Each keystroke you now perform will be recorded. If you pause for around five seconds between two keystrokes, the following ones will be recorded as a new keystroke sequence. This means they will be recorded on a new line with a new ID in the _Keystrokes wizard_ and the _Pause between keystrokes_ delay will be performed before them during playback. Stop the recording by clicking the stop button. A keystroke sequence can be edited using the edit button or by double-clicking it. If you want to remove a single keystroke click X, if you want to clear the whole keystroke sequence click the clear button. Optionally, a window title can be specified for each keystroke and the pause time between the keystroke sequences can be altered. Error handling is configured as usual. Click the plus button to open the _Keystrokes Editor_. Here you can type a keystroke sequence into the _Keystroke_ field or you can paste into it from the clipboard. You can also use content from the drop-down menus _Insert special character_ (special characters e.g. **_Alt_**, **_Caps Lock_**, **_Esc_**, or the number pad keys) and _Insert Macro_ (complete macros, e.g. to close a window, select all elements, etc.). Finally, you can select and use any defined environment variable for a _Keystroke_ _Action Step_ by using the corresponding drop-down menu. If you want to type into an application that was started with administrator privileges, RPA Builder has to be started with administrator privileges too. Otherwise the key strokes are lost and won’t be displayed. If a _Workflow_ run stops at the point a keystroke should be performed and immediately indicates that an error has occurred, check if the common window title setting is correct. If you are not able to set a common window title that works, you can leave this field empty as a workaround. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Keystrokes > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Like the _Enter String_ action step, the _Keystrokes_ action step emulates keyboard inputs. You can use this to enter search criteria or a URL in the browser address bar, for example. You can also use it to execute hotkeys or macros. ## Properties **Keyboard Settings** - **Key Down delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be pressed down. The keyboard input is generated at the start of this time period. - **Key Up Delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be released. - **Pause (ms)/Pause between keystrokes, ms** (default 500 ms) Pause between two input sequences. An input sequence starts with a pause. For a better understanding, please also see the example at the end of this sub-section. **Window Settings** - **Common window title** If the checkbox _Use common window title for all keystrokes_ is activated, the window title used to identify the window that keystrokes are sent to is displayed here - **Use common window title for all keystrokes** Select if all the keystrokes should be performed in the same window - **Use a regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, refer to Section Using Regular Expressions - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to ## Wizard - **Start** Starts the recording of keystrokes - **Stop** Stops the recording of keystrokes - **Raw** Records all keys as they are pressed. This also includes all modifier keys like **S_hift_**. Pressing the **_Shift_** key and **a** records the following key press sequence: "{SHIFTDOWN}a{SHIFTUP}". - **Norm** Records characters as they would appear in an editor like _Notepad_. Here, pressing the **_Shift_** key and **_a_** records a capital **_A_** - **Move** **keystroke** **sequence** Moves the selected keystroke sequence up or down - **Add keystroke** Calls the _Keystrokes Editor_ where you are able to enter a keystroke sequence manually. For more information about the _Keystrokes Editor_ see further down in this section. - **Edit keystroke sequence** Reconfigures an existing keystroke sequence manually with the _Keystrokes Editor_ - **Delete** Deletes the selected keystroke sequence from the list - **Clear** Deletes all keystrokes within the action step - **Hide window when start** Hides the wizard window when _Start_ is clicked (if you are using this option, you need to press **_F10_** to stop the capture) - **Hide main window when start** Hides the RPA Builder window when _Start_ is clicked - **List of keystrokes** All the keystrokes defined for this action step are listed here - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to - **Use a regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, refer to Section Using Regular Expressions. - **Use a common window title for all keystrokes** Selects if all keystrokes should be performed in the same window - **Collect Window Titles** Collects all titles of all windows that are currently opened; you may select the required title from a drop-down list provided by this function - **Pause (ms)/Pause between keystrokes, ms** (default 500 ms) Pause between two input sequences. An input sequence starts with a pause. - **Key Down delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be pressed down. The keyboard input is generated at the start of this time period. - **Key Up Delay** (default 5 ms, maximum 1000 ms) Duration in ms specifying how long it takes for a key or combination of keys to be released. For a better understanding, please also see the example at the end of this sub-section. You can either manually add a keystroke sequence by clicking the plus button, which will open the _Keystrokes Editor_ (see further details below) or you can record keystrokes. Start the recording by clicking the start button. Each keystroke you now perform will be recorded. If you pause for around five seconds between two keystrokes, the following ones will be recorded as a new keystroke sequence. This means they will be recorded on a new line with a new ID in the _Keystrokes wizard_ and the _Pause between keystrokes_ delay will be performed before them during playback. Stop the recording by clicking the stop button. A keystroke sequence can be edited using the edit button or by double-clicking it. If you want to remove a single keystroke click X, if you want to clear the whole keystroke sequence click the clear button. Optionally, a window title can be specified for each keystroke and the pause time between the keystroke sequences can be altered. Error handling is configured as usual. Click the plus button to open the _Keystrokes Editor_. Here you can type a keystroke sequence into the _Keystroke_ field or you can paste into it from the clipboard. You can also use content from the drop-down menus _Insert special character_ (special characters e.g. **_Alt_**, **_Caps Lock_**, **_Esc_**, or the number pad keys) and _Insert Macro_ (complete macros, e.g. to close a window, select all elements, etc.). Finally, you can select and use any defined environment variable for a _Keystroke_ action step by using the corresponding drop-down menu. If you want to type into an application that was started with administrator privileges, RPA Builder has to be started with administrator privileges too. Otherwise the key strokes are lost and won’t be displayed. If a _Workflow_ run stops at the point a keystroke should be performed and immediately indicates that an error has occurred, check if the common window title setting is correct. If you are not able to set a common window title that works, you can leave this field empty as a workaround. --- product: RPA Builder version: 6.6 --- # Keystrokes to App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Keystrokes to App Element_ emulates keyboard inputs that can be sent to an App Element. In contrast to “Set Text To App Element”, control keys such as “Alt”, “Ctrl”, and “Shift” can also be sent to the element. All the keyboard inputs are played back in sequence, which means if the sequence contains control keys that change the element in an app (such as “Tab”), the subsequent keystrokes might be sent to the element of the new focus. ## Properties - **Keystroke Settings** - **Keystrokes** The keystrokes to send to the element. The input text is interpreted as AutoIT language. The specific AutoIT buttons can be inserted using _Insert Special Character_ and _Insert Macro_. Like in the _Set Text To App Element_ Action Step, you can use _Insert Script Variable_ and _Insert Environment Variable_ to insert placeholders that are replaced at runtime. The behavior here is identical to that in the _Keystrokes_ Action Step. ## Inbound Variables - **Keystrokes** - **XPath to Element** - **Window Title** ## Outbound Variables The _Keystrokes to App Element_ Action Step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-app-automation#app-automation-common-properties) for a description of the common properties. See [Inserting Text Modules](https://docs.mulesoft.com/rpa-builder/6.6/insert-text-modules) for additional information about environment variables and script variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Keystrokes to App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Keystrokes to App Element_ emulates keyboard inputs that can be sent to an App Element. In contrast to “Set Text To App Element”, control keys such as “Alt”, “Ctrl”, and “Shift” can also be sent to the element. All the keyboard inputs are played back in sequence, which means if the sequence contains control keys that change the element in an app (such as “Tab”), the subsequent keystrokes might be sent to the element of the new focus. ## Properties - **Keystroke Settings** - **Keystrokes** The keystrokes to send to the element. The input text is interpreted as AutoIT language. The specific AutoIT buttons can be inserted using _Insert Special Character_ and _Insert Macro_. Like in the _Set Text To App Element_ action step, you can use _Insert Script Variable_ and _Insert Environment Variable_ to insert placeholders that are replaced at runtime. The behavior here is identical to that in the _Keystrokes_ action step. ## Inbound Variables - **Keystrokes** - **XPath to Element** - **Window Title** ## Outbound Variables The _Keystrokes to App Element_ action step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation#app-automation-common-properties) for a description of the common properties. See [Inserting Text Modules](https://docs.mulesoft.com/rpa-builder/latest/insert-text-modules) for additional information about environment variables and script variables. --- product: RPA Builder version: 6.6 --- # Keystrokes to Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to enter alphanumeric characters into fields on a website or within a web application. ## Properties **Input text** The text that will be entered in the given element. Can use script and environment variables. ## Inbound Variables **Element XPath** **Window Title**\] ## Outbound Variables The Action Step _Keystrokes to Element_ possesses no outbound variables. ## Wizard _Keystrokes to Element_ enables you to fill in any field on a website, web application, or form that accepts content. You can manually define a keystroke sequence you want to use by typing into the _Input Text_ field. All the different possibilities for creating an _Input Text_ can be combined into a single sequence. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Keystrokes to Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to enter alphanumeric characters into fields on a website or within a web application. ## Properties **Input text** The text that will be entered in the given element. Can use script and environment variables. ## Inbound Variables **Element XPath** **Window Title**\] ## Outbound Variables The action step _Keystrokes to Element_ possesses no outbound variables. ## Wizard _Keystrokes to Element_ enables you to fill in any field on a website, web application, or form that accepts content. You can manually define a keystroke sequence you want to use by typing into the _Input Text_ field. All the different possibilities for creating an _Input Text_ can be combined into a single sequence. --- product: RPA Builder version: 6.6 --- # Lock Section > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Lock Section_ Action Step is used to synchronize access if multiple parallel _Workflows_ need to access a file or a mailbox, for example in the case of Robotic Applications. Synchronization is achieved by preventing other _Workflows_ from accessing the file when it is in use. A typical scenario where a _Lock Section_ might be used when a _Workflow_ is run in parallel in different sessions. In this case, a _Robot Secure_ is used that enables parallel secure sessions to be launched. If parallel secure sessions, such as in the example above, are running on virtual machines on a server, then a file can be locked in synchronization on this server in order to allow certain content to be read out alternately. ## Properties **Misc** - **Lock Token** Enter an individual token here. Individual tokens are typically only necessary if you work with virtual machines with identical installations running in parallel. Normally it is adequate to use the WorkflowGUID as the token. - **WorkflowGUID** This field shows the GUID (Globally Unique Identifier) of the present _Workflow_. This GUID is intended to be unique anywhere in the world. However, for parallel, identical installations that use _Robot Secure_ and individual _Secure Sessions_, there is no guarantee that this ID will be unique. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Wizard - **Lock on Workflow GUID** Enable this option if parallel executions of the same Workflow need to be synchronized across various _Secure Sessions_ when using _Robot Secure_. The GUID shown in the **Lock Token** field for the active Workflow makes use of this option. - **Lock on user defined token** Enable this option if parallel executions of the same Workflow need to be synchronized in various _Secure Sessions_ using the _Robot Secure_. This is the case for virtual machines and parallel identical installations, for example. This option uses the token entered in the **Lock Token** field. - **Lock Token** Enter an individual token here. All alphanumeric characters except \\ and / are allowed. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Lock Section > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Lock Section_ action step is used to synchronize access if multiple parallel _Workflows_ need to access a file or a mailbox, for example in the case of Robotic Applications. Synchronization is achieved by preventing other _Workflows_ from accessing the file when it is in use. A typical scenario where a _Lock Section_ might be used when a _Workflow_ is run in parallel in different sessions. In this case, a _Robot Secure_ is used that enables parallel secure sessions to be launched. If parallel secure sessions, such as in the example above, are running on virtual machines on a server, then a file can be locked in synchronization on this server in order to allow certain content to be read out alternately. ## Properties **Misc** - **Lock Token** Enter an individual token here. Individual tokens are typically only necessary if you work with virtual machines with identical installations running in parallel. Normally it is adequate to use the WorkflowGUID as the token. - **WorkflowGUID** This field shows the GUID (Globally Unique Identifier) of the present _Workflow_. This GUID is intended to be unique anywhere in the world. However, for parallel, identical installations that use _Robot Secure_ and individual _Secure Sessions_, there is no guarantee that this ID will be unique. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Wizard - **Lock on Workflow GUID** Enable this option if parallel executions of the same Workflow need to be synchronized across various _Secure Sessions_ when using _Robot Secure_. The GUID shown in the **Lock Token** field for the active Workflow makes use of this option. - **Lock on user defined token** Enable this option if parallel executions of the same Workflow need to be synchronized in various _Secure Sessions_ using the _Robot Secure_. This is the case for virtual machines and parallel identical installations, for example. This option uses the token entered in the **Lock Token** field. - **Lock Token** Enter an individual token here. All alphanumeric characters except \\ and / are allowed. --- product: RPA Builder version: 6.6 --- # Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt A _Loop_ allows you to repeat the same _Transaction_ and _Action Steps_ two or more times. ## Properties - **At end of loop** Sets how the _Loop_ should be exited after all iterations have been executed. Available options are _Exit with error_ or _Exit without error_. - **Increment Value** Value the _Loop_ counter increments by on each iteration. - **Iteration Count** Sets how often the _Loop_ will be executed. Default value is 2. - **Start Value** Value the _Loop_ counter starts with. ## Inbound Variables **Iteration Count** Sets how often the _Loop_ will be executed. Default value is 2. **Start Value** Value the _Loop_ counter starts with. **Increment Value** Value the _Loop_ counter increments by on each iteration. ## Outbound Variables **Iteration** Returns the current value of the _Loop_ counter --- product: RPA Builder version: 6.7 is-latest-version: true --- # Loop > For the full documentation index, see: https://docs.mulesoft.com/llms.txt A _Loop_ allows you to repeat the same _Transaction_ and action steps two or more times. ## Properties - **At end of loop** Sets how the _Loop_ should be exited after all iterations have been executed. Available options are _Exit with error_ or _Exit without error_. - **Increment Value** Value the _Loop_ counter increments by on each iteration. - **Iteration Count** Sets how often the _Loop_ will be executed. Default value is 2. - **Start Value** Value the _Loop_ counter starts with. ## Inbound Variables **Iteration Count** Sets how often the _Loop_ will be executed. Default value is 2. **Start Value** Value the _Loop_ counter starts with. **Increment Value** Value the _Loop_ counter increments by on each iteration. ## Outbound Variables **Iteration** Returns the current value of the _Loop_ counter --- product: RPA Builder version: 6.6 --- # Mail Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Mail Operations enable interactions with an email inbox. - [Mail Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-mail-session) The Mail Session Action Step is an inclusive element for all mail operations. - [Read Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-read-mail) With the Read Mail Action Step, you can read the e-mails from a mailbox. - [Send Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-send-mail) With the Send Mail Action Step, you can send an e-mail with the SMTP protocol. - [Set Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-set-mail) With the Set Mail Action Step, you can change the status of an e-mail. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Mail Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Mail Operations enable interactions with an email inbox. - [Mail Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-mail-session) The Mail Session action step is an inclusive element for all mail operations. - [Read Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-read-mail) With the Read Mail action step, you can read the e-mails from a mailbox. - [Send Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-send-mail) With the Send Mail action step, you can send an e-mail with the SMTP protocol. - [Set Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-set-mail) With the Set Mail action step, you can change the status of an e-mail. --- product: RPA Builder version: 6.6 --- # Mail Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Mail Session_ Action Step is, similar to the Excel Session, an inclusive element for all mail operations. The mail operations consist of reading mail (Read Mail), sending mail (Send Mail), and changing e-mails (Set Mail), for example, setting the status of a mail to _unread_ or moving it to a different folder. With the _Mail Session_ Action Step, you can establish a connection to a mail server. ## Properties **Incoming Mail Operation Settings** **Encryption used** (Encryption) Displays which encryption protocol is used, SSL/TLS or STARTTLS. **Operation mode** Here you see which area is activated in the mail session. You can choose between three different modes in the wizard. **Protocol used** (Mail Protocol) Displays which communication protocol is used, IMAP, Exchange or POP3. **Server address** (String) Here, you see the server address that is entered in the wizard. **Server Port** (Integer, Default: 143) Here, you see the selected port. **Outgoing Mail Operation Setting** **Send Mails** (String) If you select this checkbox, the SMTP Mail Session is established. **Send test mail to** (String) E-mail address to which the test mail is to be sent. **SMTP Server address** (String) Here, you see the URL of the selected SMTP mail server. **SMTP Server Port** (Integer) Displays the selected port. **Use Different Credentials**\* (Boolean) If the checkmark is set here, you can set different credentials to those specified under Incoming Mail - User account for outgoing mail. ## Inbound Variables **Incoming Mail** **Server address** **Server port** (Integer) Displays the selected port. **User account** Login data that you require to log in to the server. **Outgoing Mail** **SMTP Server address** (String) Here, you see the URL of the selected SMTP mail server. **SMTP User account** Login data that you require to log in to the SMTP server. **Use Different Credentials**\* (Boolean) If the checkmark is set here, you can set different credentials to those specified under Incoming Mail - User account for outgoing mail. ## Outbound Variables The _Mail Session_ Action Step has no outbound variables. ## Wizard The wizard is split into following sections: **Operation Mode**, **Incoming Mail** and **Outgoing Mail**. In the Operation mode you determine what exactly should happen in the Mail Session and which area is activated in the Mail Session. The following modes are available: - **Read and send mails** Here you can configure the Incoming and Outgoing Mail areas. This means, you can read and send mails. - **Read mails from inbox** Only the Incoming Mail section can be edited here. This means that you can only read mails. - **Send mails via SMTP** Only the Outgoing Mail section can be edited here. In this case, mails are sent only. > [!NOTE] If you have selected the _Send mails via SMTP_ mode, no Read mail Action Step can be used > in the Mail Session. This is also true if you have selected the _Read mails from inbox_ mode. In > this case, no Send Mail Action Step can be used. In the Incoming Mail area, you can make all the settings necessary to import e-mails from an e-mail server. Here, you can also find the **Test Connection Button**. You can use this to test whether the connection to the mail server can be established. The Outgoing Mail area opens if you select the checkbox **Send mails**. If you wish to send e-mails, enter the SMTP mail server settings here. If the login data differs from the Incoming Mails, select the option _Use different credentials or Use no authentication_. You can then enter different login data. With _Use no authentication_ you only need a user name. Using the **Send test mail** button, you can check the connection to the SMTP server and send a test mail. Enter the e-mail address under **Send test mail to**. ## See Also - [Read Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-read-mail) - [Send Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-send-mail) - [Set Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-set-mail) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Mail Session > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Mail Session_ action step is, similar to the Excel Session, an inclusive element for all mail operations. The mail operations consist of reading mail (Read Mail), sending mail (Send Mail), and changing e-mails (Set Mail), for example, setting the status of a mail to _unread_ or moving it to a different folder. With the _Mail Session_ action step, you can establish a connection to a mail server. ## Properties **Incoming Mail Operation Settings** **Encryption used** (Encryption) Displays which encryption protocol is used, SSL/TLS or STARTTLS. **Operation mode** Here you see which area is activated in the mail session. You can choose between three different modes in the wizard. **Protocol used** (Mail Protocol) Displays which communication protocol is used, IMAP, Exchange or POP3. **Server address** (String) Here, you see the server address that is entered in the wizard. **Server Port** (Integer, Default: 143) Here, you see the selected port. **Outgoing Mail Operation Setting** **Send Mails** (String) If you select this checkbox, the SMTP Mail Session is established. **Send test mail to** (String) E-mail address to which the test mail is to be sent. **SMTP Server address** (String) Here, you see the URL of the selected SMTP mail server. **SMTP Server Port** (Integer) Displays the selected port. **Use Different Credentials**\* (Boolean) If the checkmark is set here, you can set different credentials to those specified under Incoming Mail - User account for outgoing mail. ## Inbound Variables **Incoming Mail** **Server address** **Server port** (Integer) Displays the selected port. **User account** Login data that you require to log in to the server. **Outgoing Mail** **SMTP Server address** (String) Here, you see the URL of the selected SMTP mail server. **SMTP User account** Login data that you require to log in to the SMTP server. **Use Different Credentials**\* (Boolean) If the checkmark is set here, you can set different credentials to those specified under Incoming Mail - User account for outgoing mail. ## Outbound Variables The _Mail Session_ action step has no outbound variables. ## Wizard The wizard is split into following sections: **Operation Mode**, **Incoming Mail** and **Outgoing Mail**. In the Operation mode you determine what exactly should happen in the Mail Session and which area is activated in the Mail Session. The following modes are available: - **Read and send mails** Here you can configure the Incoming and Outgoing Mail areas. This means, you can read and send mails. - **Read mails from inbox** Only the Incoming Mail section can be edited here. This means that you can only read mails. - **Send mails via SMTP** Only the Outgoing Mail section can be edited here. In this case, mails are sent only. > [!NOTE] If you have selected the _Send mails via SMTP_ mode, no Read mail action step can be used > in the Mail Session. This is also true if you have selected the _Read mails from inbox_ mode. In > this case, no Send Mail action step can be used. In the Incoming Mail area, you can make all the settings necessary to import e-mails from an e-mail server. Here, you can also find the **Test Connection Button**. You can use this to test whether the connection to the mail server can be established. The Outgoing Mail area opens if you select the checkbox **Send mails**. If you wish to send e-mails, enter the SMTP mail server settings here. If the login data differs from the Incoming Mails, select the option _Use different credentials or Use no authentication_. You can then enter different login data. With _Use no authentication_ you only need a user name. Using the **Send test mail** button, you can check the connection to the SMTP server and send a test mail. Enter the e-mail address under **Send test mail to**. ## See Also - [Read Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-read-mail) - [Send Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-send-mail) - [Set Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-set-mail) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Mail Session (OAuth) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The **Mail Session (OAuth)** action step is an inclusive element for email operations that enables you to establish a connection to an email server using MS Outlook or Gmail and then perform email operations such as **Read Mail**, **Send Mail**, and **Set Mail** (to change email) by using the corresponding action steps. ## Before You Begin Depending on the mail provider you use, ensure you have the following: - **Outlook** - An Azure account - SMTP AUTH enabled for your Microsoft organization or the specific mailbox when connecting with an Azure environment via SMTP For configuration instructions, see: [Enable or disable authenticated client SMTP submission (SMTP AUTH) in Exchange Online](https://learn.microsoft.com/en-us/exchange/clients-and-mobile-in-exchange-online/authenticated-client-smtp-submission) - **Gmail** - A Google account ## Properties - **OAuth Authentication** Settings - **Pin OAuth Settings** Option to specify OAuth credentials created with the [Credentials for OAuth](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-credentials-for-oauth) action step. - **Use custom settings** Option to specify custom OAuth credentials for this action step. - **E-Mail Provider** Mail provider, either **Outlook** or **Google**. - **Auth Endpoint** URL for the OAuth authentication endpoint. Defaults to the following values, depending on the selected provider: - **Outlook**: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` - **Google**: `https://accounts.google.com/o/oauth2/v2/auth` - **Token Endpoint** URL for the OAuth Refresh Token process. Defaults to the following values, depending on the selected provider: - **Outlook**: `https://login.microsoftonline.com/common/oauth2/v2.0/token` - **Google**: `https://www.googleapis.com/oauth2/v4/token` - **Client ID** Client ID of your mail application. To authenticate with the OAuth host, you must define an Azure or Gmail application in your space. This application has an ID, that is unique in the entire OAuth host space and it enables users to explicitly grant or revoke access for this application to their accounts. For more information on how to create an Azure application for Outlook, visit [Quickstart: Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app). - **Client Secret** Client Secret of your mail application. Allows RPA Builder to prove to the OAuth host that it received permission to access user accounts. Without this permission, authentication is not possible. - **Redirect URI** URI that the OAuth host redirects to after the user completes the authentication attempt. This redirect URI must be registered with the Azure or Gmail application. If the entered redirect URI matches one of the registered URIs, the OAuth host allows the authentication. - **Scopes** Defines which permissions the user grants to the Azure or Gmail application. By default, RPA Builder requests the following permissions depending on the selected provider: - **Outlook** - **`offline_access`** (Required) Enables access via a refresh token, which you can use to repeatedly log in to the email services without requiring user interaction each time. - **`https://outlook.office.com/IMAP.AccessAsUser.All`** (Required when using IMAP) Enables reading and moving emails from the Outlook IMAP server. - **`https://outlook.office.com/POP.AccessAsUser.All`** (Required when using POP3) Enables reading emails from the Outlook POP3 server. - **`https://outlook.office.com/SMTP.Send`** (Required when using SMTP) Enables sending emails from the Outlook SMTP server. - **`openid email`** Enables RPA Builder to automatically detect the email account used to log in to the Azure application. If this scope is omitted, you must provide an email in the wizard. - **Google** - **`https://mail.google.com/`** Enables RPA Builder to read, compose, send, and permanently delete emails from your Gmail account. - **Save data to generate Tokens via the Tools menu** Saves the current data for further use when [generating an OAuth refresh token](#generate-oauth-token). - **Email address** The email address populates automatically if RPA Builder detects it from the authentication attempt. If the **openid email** scope is omitted, you must provide an email address manually. - **Incoming Mail Operation** Settings - **Protocol used** (Mail Protocol) The communication protocol to use: IMAP, Exchange, or POP3 - **Encryption used** (Encryption) The encryption protocol to use: None, SSL/TLS, or STARTTLS - **Server address** (String) The server address entered in the wizard For Azure environments using the Exchange protocol, the default server address is `https://outlook.office365.com/EWS/Exchange.asmx`. - **Server Port** (Integer) The selected port - **Outgoing Mail Operation** Setting - **Encryption used** (Encryption) The encryption protocol to use: None, SSL/TLS, or STARTTLS - **SMTP Server address** (String) The URL of the selected SMTP email server - **SMTP Server Port** (Integer) The selected port - **Send test mail to** (String) The email address where to send the test email ## Inbound Variables - **SMTP Server address** - **Server address** - **SMTP Server Port** - **Server Port** - **OAuth Credentials** - **Auth Endpoint** - **Token Endpoint** - **OAuth Client ID** - **Client Secret** - **Redirect URI** - **Scopes** - **E-Mail Address** - **Refresh Token** ## Outbound Variables The **Mail Session (OAuth)** action step has no outbound variables. ## Wizard ![The Mail Session (OAuth) action step wizard.](/mulesoft/current/en-us/rpa-builder/latest/_images/mail-session-outlook-oauth-wizard.png) You can configure the following settings using the wizard: - **Operation Mode** - **OAuth Authentication** - **Incoming Mail** - **Outgoing Mail** ### Operation Mode In **Operation Mode**, you determine what happens and which area activates in the Mail Session. The following modes are available: - **Read and send mails** Enables you to configure the incoming and outgoing mail areas so that you can read and send emails. - **Read mails from inbox** Enables editing for the Incoming Mail section so that you can only read emails. If you select the **Read mails from inbox** mode, you can’t use the Send Mail action step. - **Send mails via SMTP** Enables editing for the Outgoing Mail section so that you can only send emails. If you select the **Send mails via SMTP** mode, you can’t use the Read Mail action step in the Mail Session. ### OAuth Authentication Create a set of tokens that don’t rely on a user password to authenticate with the email server. After you create the refresh token, you can use it to repeatedly log in to the services without asking for the user’s password again. Follow these steps to authenticate with your credentials: 1. Complete the **OAuth Authentication** configuration by specifying the required properties. Refer to [OAuth Authentication Settings](#properties) for a description of each property. 2. Click **Authenticate**. This step starts the authentication process with the OAuth host, which opens the login page in your default browser. To enable using different accounts to log in, Mail Session (OAuth) clears credentials stored in browser cookies when you click **Authenticate**. 3. In the OAuth host’s login page, complete the login process. 4. Close the browser. After completing the last step, the wizard shows that you are authenticated: ![The Logged in confirmation message in the authentication settings window](/mulesoft/current/en-us/rpa-builder/latest/_images/email-outlook-authentication.png) #### Generating an OAuth Refresh Token Instead of authenticating via the **Mail Session (OAuth)** wizard, you can pin the refresh token if you obtain it externally. In this case, you still need to populate or pin the remaining fields. To generate and configure a refresh token: 1. In the **Tools** menu, select **Generate OAuth Refresh Token**. ![The Generate OAuth Refresh Token options in the Tools menu](/mulesoft/current/en-us/rpa-builder/latest/_images/generate-oauth-token.png) 2. Complete the **OAuth Token Creator** form that appears. ![The OAuth Token Creator Form](/mulesoft/current/en-us/rpa-builder/latest/_images/generate-token-form.png) If you already configured the Credentials for OAuth action step details and clicked the **Save data to generate Tokens via the Tools menu** button, the data automatically populates with the last data you entered in the wizard. 3. Click **Authenticate**. 4. Click **Copy Token to Clipboard**. 5. Paste the token in an alphanumeric activity parameter. 6. Pin the variable to the field **Refresh Token** in the **Credentials for OAuth** wizard. You can also pin the other values from the **OAuth Token Creator**. By using an activity parameter, you don’t need to upload a new version of your Workflow to RPA Manager if your token expires or your user gets logged out of your email provider. In this case, regenerate the refresh token for the same user with the **OAuth Token Creator** and update the assigned activity parameter on RPA Manager. ### Incoming Mail In the **Incoming Mail** area, you can configure all the settings necessary to import emails from an email server. You can use the **Test Connection Button** to test whether the connection to the email server can be established. ### Outgoing Mail The **Outgoing Mail** area opens if you select the **Send mails** checkbox. To send emails, enter the SMTP email server settings here. To check the connection to the SMTP server and send a test email to the email address specified in the **Sendtest mail to** field, click **Send test mail**. ## See Also - [Read Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-read-mail) - [Send Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-send-mail) - [Set Mail](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-set-mail) - [Troubleshooting Microsoft Azure Setup](https://docs.mulesoft.com/rpa-builder/latest/troubleshooting-azure-oauth-setup) - [Azure](https://azure.microsoft.com/en-us/) - [Authenticate an EWS application by using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth) - [Authenticate an IMAP, POP or SMTP connection using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth) --- product: RPA Builder version: 6.6 --- # Mail Session (Outlook with OAuth) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Mail Session (Outlook with OAuth)_ Action Step is an inclusive element for email operations that enables you to establish a connection to an email server using MS Outlook and then perform email operations such as **Read Mail**, **Send Mail**, and **Set Mail** (to change email) by using the corresponding Action Steps. ## Before you Begin You must have an Azure account to create an application for Outlook. ## Properties - **OAuth Authentication** Settings - **Pin OAuth Settings** Select this option to specify OAuth credentials created with the [Credentials for OAuth](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-credentials-for-oauth) Action Step. - **Use custom settings** Select this option to specify custom OAuth credentials for this Action Step. - **OAuth Host** The host address used to get the credentials. The default address for Outlook services is `https://login.microsoftonline.com/common/oauth2/v2.0/`. This address might change if you use a self-hosted service. - **Client ID** To authenticate with the OAuth Host, an Azure application must be defined in your space. This Azure application has an ID, that is unique in the entire OAuth Host space and it allows users to explicitly grant or revoke access for this Azure application to their accounts. For more information on how to create this Azure application for Outlook, visit [Quickstart: Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app). - **Client Secret** Allows RPA Builder to prove to the OAuth Host that it received permission to access user accounts on behalf of the registered Azure application. Without this permission, authentication is not possible. - **Redirect URI** The URI to which the OAuth Host redirects after the user completes the authentication attempt. This redirect URI must be registered with the Azure application. If the entered redirect URI matches one of the registered URIs, the OAuth Host allows the authentication. - **Scopes** Defines which permissions the user grants to the Azure application. By default, RPA Builder requests the following permissions: - **offline\_access** (**Required**) Enables access via a refresh token, which you can use to repeatedly log in to the email services without requiring user interaction each time. - **https://outlook.office.com/IMAP.AccessAsUser.All** (**Required** when using IMAP) Enables reading and moving emails from the Outlook IMAP server. - **https://outlook.office.com/POP.AccessAsUser.All** (**Required** when using POP3) Enables reading emails from the Outlook POP3 server. - **https://outlook.office.com/SMTP.Send** (**Required** when using SMTP) Enables sending emails from the Outlook SMTP server. - **openid email** Enables RPA Builder to automatically detect the email account used to log in to the Azure application. If this scope is omitted, you must provide an email in the wizard. - **Save data to generate Tokens via the Tools menu** Saves the current data for further use when [Generating an OAuth Refresh Token](#generate-oauth-token). - **Email address** The email address populates automatically if RPA Builder detects it from the authentication attempt. If the **openid email** scope is omitted, you must provide an email address manually. - **Incoming Mail Operation** Settings - **Protocol used** (Mail Protocol) The communication protocol to use: IMAP, Exchange, or POP3. - **Encryption used** (Encryption) The encryption protocol to use: None, SSL/TLS, or STARTTLS. - **Server address** (String) The server address entered in the wizard. - **Server Port** (Integer, Default: `143`) The selected port. - **Outgoing Mail Operation** Setting - **Encryption used** (Encryption) The encryption protocol to use: None, SSL/TLS, or STARTTLS. - **SMTP Server address** (String) The URL of the selected SMTP email server. - **SMTP Server Port** (Integer) The selected port. - **Send test mail to** (String) The Email address to which the test email is to be sent. ## Inbound Variables - **Incoming Mail** - **Server address** (String) The server address entered in the wizard. - **Server port** (Integer) The selected port. - **User account** The login data that you require to log in to the server. - **Outgoing Mail** - **SMTP Server address** (String) The URL of the selected SMTP email server. - **SMTP User account** The login data that you require to log in to the SMTP server. ## Outbound Variables The _Mail Session_ Action Step has no outbound variables. ## Wizard ![The Mail Session (Outlook with OAuth) Action Step Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/mail-session-outlook-oauth-wizard.png) The wizard contains the following sections: - **Operation Mode** - **OAuth Authentication** - **Incoming Mail** - **Outgoing Mail** ### Operation Mode In **Operation Mode** you determine what happens and which area activates in the Mail Session. The following modes are available: - **Read and send mails** Enables you to configure the Incoming and Outgoing Mail areas so that you can read and send emails. - **Read mails from inbox** Enables editing for the Incoming Mail section so that you can only read emails. If you select the _Read mails from inbox_ mode, you can’t use the Send Mail Action Step. - **Send mails via SMTP** Enables editing for the Outgoing Mail section so that you can only send emails. If you select the _Send mails via SMTP_ mode, you can’t use the Read Mail Action Step in the Mail Session. ### OAuth Authentication The **OAuth Authentication** section enables you to create a set of tokens that don’t rely on a user password to authenticate with the email server. After you create the refresh token, you can use it to repeatedly log in to the services without asking for the user’s password again. Follow these steps to authenticate with your credentials: 1. Complete the **OAuth Authentication** configuration by specifying the required properties. Refer to [OAuth Authentication Settings](#properties) for a description of each property. 2. Click **Authenticate**. This step starts the authentication process with the OAuth Host, which opens the login page in your default browser. To enable using different accounts to log in, Mail Session (Outlook with OAuth) clears credentials stored in browser cookies when you click **Authenticate**. 3. In the OAuth Host’s login page, complete the login process. 4. Close the browser. After completing the last step, the wizard shows that you are authenticated: ![The Logged in confirmation message in the authentication settings window](/mulesoft/current/en-us/rpa-builder/6.6/_images/email-outlook-authentication.png) #### Generating an OAuth Refresh Token Instead of authenticating via the **Mail Session (Outlook with OAuth) wizard**, you can pin the refresh token if you obtain it externally. In this case, you still need to populate or pin the remaining fields. To generate and configure a refresh token: 1. In the **Tools** menu, select **Generate OAuth Refresh Token**. ![The Generate OAuth Refresh Token options in the Tools menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/generate-oauth-token.png) 2. Complete the **OAuth Token Creator** form that appears. ![The OAuth Token Creator Form](/mulesoft/current/en-us/rpa-builder/6.6/_images/generate-token-form.png) If you already configured a Mail Session (Outlook with OAuth) and clicked the **Save data to generate Tokens via the Tools menu** button, the data automatically populates with the last data you entered in the wizard. 3. Click **Authenticate**. 4. Click **Copy Token to Clipboard**. 5. Paste the token in an alphanumeric Server Based Variable. 6. Pin the variable to the field **Refresh Token** in the **Mail Session (Outlook with OAuth)** wizard. You can also pin the other values from the **OAuth Token Creator**. By using a Server Based Variable you don’t need to upload a new version of your Workflow to RPA Manager if your token expires or your user gets logged out of Microsoft. In this case, regenerate the refresh token for the same user with the **OAuth Token Creator** and update the assigned Server Based Variable on RPA Manager. ### Incoming Mail In the **Incoming Mail** area, you can configure all the settings necessary to import emails from an email server. You can use the **Test Connection Button** to test whether the connection to the email server can be established. ### Outgoing Mail The **Outgoing Mail** area opens if you select the **Send mails** checkbox. To send emails, enter the SMTP email server settings here. Use the **Send test mail** button to check the connection to the SMTP server and send a test email to the email address specified in the **Sendtest mail to** field. ## See Also - [Read Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-read-mail) - [Send Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-send-mail) - [Set Mail](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-set-mail) - [Troubleshooting Microsoft Azure Setup](https://docs.mulesoft.com/rpa-builder/6.6/troubleshooting-azure-oauth-setup) - [Azure](https://azure.microsoft.com/en-us/) - [Authenticate an EWS application by using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth) - [Authenticate an IMAP, POP or SMTP connection using OAuth](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth) --- product: RPA Builder version: 6.6 --- # Making Sure Windows Fonts Match > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Ensure that the window colors and fonts of the system a _Workflow_ is created on are identical to the systems the _Workflow_ is going to run on. The window colors and fonts determine how windows are displayed, including size, font and color of captions, buttons, and various control elements. ## Verifying Windows Color Schemes and Font Sizes To access the color and font settings for Windows: 1. Open the Windows **Personalization** settings. - Right-click on the Desktop and select **Personalize**, or - Open the **Start** menu and go to **Settings** > **Personalization**. 2. Click the **Colors** tab and verify the settings. ![Windows settings showing color options](/mulesoft/current/en-us/rpa-builder/6.6/_images/windows-settings-color.png) 3. Click the **Fonts** tab and verify the settings. ![Windows settings showing font options](/mulesoft/current/en-us/rpa-builder/6.6/_images/windows-settings-fonts.png) 4. Ensure the fonts, sizes, and colors are identical on every machine where the _Workflow_ will run and also on the system used to record the _Workflow_. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Making Sure Windows Fonts Match > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Ensure that the window colors and fonts of the system a _Workflow_ is created on are identical to the systems the _Workflow_ is going to run on. The window colors and fonts determine how windows are displayed, including size, font and color of captions, buttons, and various control elements. ## Verifying Windows Color Schemes and Font Sizes To access the color and font settings for Windows: 1. Open the Windows **Personalization** settings. - Right-click on the Desktop and select **Personalize**, or - Open the **Start** menu and go to **Settings** > **Personalization**. 2. Click the **Colors** tab and verify the settings. ![Windows settings showing color options](/mulesoft/current/en-us/rpa-builder/latest/_images/windows-settings-color.png) 3. Click the **Fonts** tab and verify the settings. ![Windows settings showing font options](/mulesoft/current/en-us/rpa-builder/latest/_images/windows-settings-fonts.png) 4. Ensure the fonts, sizes, and colors are identical on every machine where the _Workflow_ will run and also on the system used to record the _Workflow_. --- product: RPA Builder version: 6.6 --- # Managed > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Managed_ block allows you to handle errors within your _Workflow_ as they happen. It also can be used to make sure that certain _Action Steps_ or _Transactions_ are executed, even if an error occurred. ## Properties - **_OnError_ section behavior** If an error happens within the _OnError_ section, it can either be handled like any other error (_Normal error handling_) or the Workflow can be immediately aborted (_Abort script on error_). - In the first case the DoAlways part will be executed before program termination, in the latter case not. ## **_DoAction_** This is the default path of the _Managed Block_. The RPA Bot will first try to execute all _Action Steps_ within the _DoAction_ section. If an error occurs (e.g. an _Image search_ fails), the execution of the _DoAction_ section will be aborted and the _OnError_ section will be executed. If the _OnError_ section is empty, an error within the _DoAction_ section will cause the _Managed Block_ to enter an error state. ## **_OnError_** This section will be executed if an _Action Step_ within the _DoAction_ section has failed. You can try to handle the error here and restore a state in which the rest of the Workflow can still be executed normally, even though the _DoAction_ section failed. If all items within the _OnError_ section are executed successfully, the _Managed Block_ is considered successful ($run = 1). Note that an empty _OnError_ section will **not** change the run state. Use _Force OK State_ (see Section 3.8.4) for that. However, if an error occurs within the _OnError_ section, its execution will be aborted and the _Managed Block_ will remain in the error state ($run = -1). What happens next depends on the setting for behavior of the _OnError_ section. If it is set to _Normal error handling_, the Workflow will handle an error in the _OnError_ section like all other steps, meaning the error can be handled by an enclosing _Managed Block_. If it is set to _Abort script on error_ the Workflow will be instantly aborted if any further error happens within the _OnError_ section. ## **_DoAlways_** The _DoAlways_ section will be executed at the end of the _Managed Block_, regardless of whether an error has occurred within the _Managed Block_ or not. The only exception is when the _OnError section behavior_ is set to _Abort script on error_ and error occurred within the _OnError_ section. If an error occurs within the _DoAlways_ section, its execution will be aborted but the error state of the _Managed Block_ will remain unchanged. Execution of the _DoAlways_ section has no influence on the error state, which will always be the same as at the time the section was entered. ## Example The following example will show you how to react to common problems directly in your _Workflow_ using the _Managed Block_. Imagine you want to open up an _Internet Explorer_ window and enter a web address. First you start _Internet Explorer_ using run program, search for the address bar to verify that _Internet Explorer_ is loaded, and then enter the web address. Usually, when _Internet Explorer_ starts, the focus will be on the address bar. This is what we are searching for with the _Image search_. When we find it, we simply enter the web address and are done. However, it is a common problem that sometimes _Internet Explorer_ loses the focus immediately. This means that the address bar text will not be highlighted and have the focus. The _Image search_ will not find this. Plus, the address bar does not have focus, so you cannot simply start typing with the keystroke item. The desired website will not be opened. The _Managed Block_ gives you the perfect solution for this problem. You put _Run Program_ and _Image search_ within the _DoAction_ section and _Keystrokes_ containing the web address in the _DoAlways_ section. If you do not find the _Pattern image_, the _Managed Block_ will execute the _OnError_ section. There, you simply put another keystroke to press **_F6_** – this is the _Internet Explorer_ shortcut for focusing the address bar. This ensures that the address bar is focused when you enter the _DoAlways_ section. Then you can type in the web address and be sure it is entered correctly – problem solved! --- product: RPA Builder version: 6.7 is-latest-version: true --- # Managed > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Managed_ block allows you to handle errors within your _Workflow_ as they happen. It also can be used to make sure that certain action steps or _Transactions_ are executed, even if an error occurred. ## Properties - **_OnError_ section behavior** If an error happens within the _OnError_ section, it can either be handled like any other error (_Normal error handling_) or the Workflow can be immediately aborted (_Abort script on error_). - In the first case the DoAlways part will be executed before program termination, in the latter case not. ## **_DoAction_** This is the default path of the _Managed Block_. The RPA Bot will first try to execute all action steps within the _DoAction_ section. If an error occurs (e.g. an _Image search_ fails), the execution of the _DoAction_ section will be aborted and the _OnError_ section will be executed. If the _OnError_ section is empty, an error within the _DoAction_ section will cause the _Managed Block_ to enter an error state. ## **_OnError_** This section will be executed if an action step within the _DoAction_ section has failed. You can try to handle the error here and restore a state in which the rest of the Workflow can still be executed normally, even though the _DoAction_ section failed. If all items within the _OnError_ section are executed successfully, the _Managed Block_ is considered successful ($run = 1). Note that an empty _OnError_ section will **not** change the run state. Use _Force OK State_ (see Section 3.8.4) for that. However, if an error occurs within the _OnError_ section, its execution will be aborted and the _Managed Block_ will remain in the error state ($run = -1). What happens next depends on the setting for behavior of the _OnError_ section. If it is set to _Normal error handling_, the Workflow will handle an error in the _OnError_ section like all other steps, meaning the error can be handled by an enclosing _Managed Block_. If it is set to _Abort script on error_ the Workflow will be instantly aborted if any further error happens within the _OnError_ section. ## **_DoAlways_** The _DoAlways_ section will be executed at the end of the _Managed Block_, regardless of whether an error has occurred within the _Managed Block_ or not. The only exception is when the _OnError section behavior_ is set to _Abort script on error_ and error occurred within the _OnError_ section. If an error occurs within the _DoAlways_ section, its execution will be aborted but the error state of the _Managed Block_ will remain unchanged. Execution of the _DoAlways_ section has no influence on the error state, which will always be the same as at the time the section was entered. ## Example The following example will show you how to react to common problems directly in your _Workflow_ using the _Managed Block_. Imagine you want to open up an _Internet Explorer_ window and enter a web address. First you start _Internet Explorer_ using run program, search for the address bar to verify that _Internet Explorer_ is loaded, and then enter the web address. Usually, when _Internet Explorer_ starts, the focus will be on the address bar. This is what we are searching for with the _Image search_. When we find it, we simply enter the web address and are done. However, it is a common problem that sometimes _Internet Explorer_ loses the focus immediately. This means that the address bar text will not be highlighted and have the focus. The _Image search_ will not find this. Plus, the address bar does not have focus, so you cannot simply start typing with the keystroke item. The desired website will not be opened. The _Managed Block_ gives you the perfect solution for this problem. You put _Run Program_ and _Image search_ within the _DoAction_ section and _Keystrokes_ containing the web address in the _DoAlways_ section. If you do not find the _Pattern image_, the _Managed Block_ will execute the _OnError_ section. There, you simply put another keystroke to press **_F6_** – this is the _Internet Explorer_ shortcut for focusing the address bar. This ensures that the address bar is focused when you enter the _DoAlways_ section. Then you can type in the web address and be sure it is entered correctly – problem solved! --- product: RPA Builder version: 6.6 --- # Managing User Templates > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder enables you to save Action Steps and their settings as templates that you can reuse in the project. You can Import and Export these templates as needed. Create a set of templates before creating a Workflow to increase the creation speed significantly. Save the templates before configuring the Workflow objects, so the templates stay flexible in use. RPA Builder automatically loads templates during start-up and makes them available in the toolbox. You can drag and drop templates to your Workflow to use them. ## Before you Begin Consider the following when creating a template: - Search Pattern and Pattern Select Action Steps and all combinations of Action Steps that include them cannot be saved as a template. - RPA Builder removes all passwords from templates before creating them. ## Create a Template You can create a template using the _Context menu_ or the _Workflow Tools_. 1. Use any of the following methods to start creating a template: From the Context Menu 1. Right-click an Action Step to open its context menu. 2. Click **Save As Template**. Using the Workflow Tools 1. Select the Action Step you want to save as a template. 2. In the Workbench Toolbar, click the **Tools** (![The Tools icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/wrench-icon.png)) button. 3. Click **Save Selected Items as Template**. After selecting any of these options, a **Save as** dialog opens in which you continue configuring the template. 2. Select the path to the folder in which to store the template. By default, the RPA Builder template folder is `\MuleSoft\RPA\UserTemplates`. 3. Enter a name for the template and click **Save**. The Template details window that subsequently opens enables you to add additional information to this template. ![The Template details window](/mulesoft/current/en-us/rpa-builder/6.6/_images/save-as-template.png) When you unselect **Clear user data**, the template keeps the settings configured, so specific measurement Workflow elements, like starting MS Edge with a blank page, can be saved as a template as a whole and reused directly from the User Templates category in the Toolbox. ## Delete, Import, and Export Templates The Templates Manager enables you to delete, import, and export templates. ![The Templates manager window](/mulesoft/current/en-us/rpa-builder/6.6/_images/templates-manager.png) To open the Templates Manager, in the top menu bar, go to **Tools** > **Templates Manager**. Use the corresponding buttons in the menu bar of the Templates Manager to **Delete**, **Import**, or **Export** templates: - (![The Delete template button](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon-alt.png)) **Delete** Deletes the selected Template. - (![The Import template button](/mulesoft/current/en-us/rpa-builder/6.6/_images/import-icon.png)) **Import** After you click **Import**, Windows Explorer opens and you can enter the path to the template. Select a template and the following window opens: ![The Import template window](/mulesoft/current/en-us/rpa-builder/6.6/_images/import-user-template.png) You can verify the template again and change the name if necessary. Click **OK** to import the template into the Template Manager, where it becomes available for further use. - (![The Export template button](/mulesoft/current/en-us/rpa-builder/6.6/_images/export-icon.png)) **Export** When you click **Export** after selecting a template, the following window opens: ![The Export template window](/mulesoft/current/en-us/rpa-builder/6.6/_images/export-user-template.png) In this window, you can change the name and navigate to the target folder where to save the exported template. ## Example Templates The following template is a typical template for a normal Transaction with mouse activity: ![A template showing a transaction with mouse activity](/mulesoft/current/en-us/rpa-builder/6.6/_images/template-transaction-mouse.png) A useful variation of this template could use keystrokes: ![A template showing a transaction with mouse activity and keystrokes](/mulesoft/current/en-us/rpa-builder/6.6/_images/template-transaction-keystrokes.png) ## See Also - [Workbench Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workbench-elements-in-detail) - [Workbench Toolbar Overview](https://docs.mulesoft.com/rpa-builder/6.6/workbench-toolbar-overview) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Managing User Templates > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder enables you to save action steps and their settings as templates that you can reuse in the project. You can Import and Export these templates as needed. Create a set of templates before creating a Workflow to increase the creation speed significantly. Save the templates before configuring the Workflow objects, so the templates stay flexible in use. RPA Builder automatically loads templates during start-up and makes them available in the toolbox. You can drag and drop templates to your Workflow to use them. ## Before you Begin Consider the following when creating a template: - Search Pattern and Pattern Select action steps and all combinations of action steps that include them cannot be saved as a template. - RPA Builder removes all passwords from templates before creating them. ## Create a Template You can create a template using the _Context menu_ or the _Workflow Tools_. 1. Use any of the following methods to start creating a template: From the Context Menu 1. Right-click an action step to open its context menu. 2. Click **Save As Template**. Using the Workflow Tools 1. Select the action step you want to save as a template. 2. In the Workbench Toolbar, click the **Tools** (![The Tools icon](/mulesoft/current/en-us/rpa-builder/latest/_images/wrench-icon.png)) button. 3. Click **Save Selected Items as Template**. After selecting any of these options, a **Save as** dialog opens in which you continue configuring the template. 2. Select the path to the folder in which to store the template. By default, the RPA Builder template folder is `\MuleSoft\RPA\UserTemplates`. 3. Enter a name for the template and click **Save**. The Template details window that subsequently opens enables you to add additional information to this template. ![The Template details window](/mulesoft/current/en-us/rpa-builder/latest/_images/save-as-template.png) When you unselect **Clear user data**, the template keeps the settings configured, so specific measurement Workflow elements, like starting MS Edge with a blank page, can be saved as a template as a whole and reused directly from the User Templates category in the Toolbox. ## Delete, Import, and Export Templates The Templates Manager enables you to delete, import, and export templates. ![The Templates manager window](/mulesoft/current/en-us/rpa-builder/latest/_images/templates-manager.png) To open the Templates Manager, in the top menu bar, go to **Tools** > **Templates Manager**. Use the corresponding buttons in the menu bar of the Templates Manager to **Delete**, **Import**, or **Export** templates: - (![The Delete template button](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon-alt.png)) **Delete** Deletes the selected Template. - (![The Import template button](/mulesoft/current/en-us/rpa-builder/latest/_images/import-icon.png)) **Import** After you click **Import**, Windows Explorer opens and you can enter the path to the template. Select a template and the following window opens: ![The Import template window](/mulesoft/current/en-us/rpa-builder/latest/_images/import-user-template.png) You can verify the template again and change the name if necessary. Click **OK** to import the template into the Template Manager, where it becomes available for further use. - (![The Export template button](/mulesoft/current/en-us/rpa-builder/latest/_images/export-icon.png)) **Export** When you click **Export** after selecting a template, the following window opens: ![The Export template window](/mulesoft/current/en-us/rpa-builder/latest/_images/export-user-template.png) In this window, you can change the name and navigate to the target folder where to save the exported template. ## Example Templates The following template is a typical template for a normal Transaction with mouse activity: ![A template showing a transaction with mouse activity](/mulesoft/current/en-us/rpa-builder/latest/_images/template-transaction-mouse.png) A useful variation of this template could use keystrokes: ![A template showing a transaction with mouse activity and keystrokes](/mulesoft/current/en-us/rpa-builder/latest/_images/template-transaction-keystrokes.png) ## See Also - [Workbench Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workbench-elements-in-detail) - [Workbench Toolbar Overview](https://docs.mulesoft.com/rpa-builder/latest/workbench-toolbar-overview) --- product: RPA Builder version: 6.6 --- # Map Network Drive > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ lets you map and unmap any network location and any drive letter. ## Properties **Drive** The drive letter to map the network location to. Or, if you selected _Unmap Drive_, the drive letter to unmap. **Login required** Activate if the network location is password protected. **Network Path** The path of the network location you want to map. **Password** The password required to access the network location. Only applicable if _Login required_ is selected. **Unmap drive** Select this if you want to unmap a drive instead of mapping it. **Username** The username required to access the network location. Only applicable if _Login required_ is activated. **Warning if already mapped** Normally, an error is thrown if you try to map a drive that is already mapped. Activate this if you only want a warning instead. ## Inbound Variable **Network Path** The path of the network location you want to map. ## Outbound Variables The Action Step _Map Network Drive_ possesses no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Map Network Drive > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step lets you map and unmap any network location and any drive letter. ## Properties **Drive** The drive letter to map the network location to. Or, if you selected _Unmap Drive_, the drive letter to unmap. **Login required** Activate if the network location is password protected. **Network Path** The path of the network location you want to map. **Password** The password required to access the network location. Only applicable if _Login required_ is selected. **Unmap drive** Select this if you want to unmap a drive instead of mapping it. **Username** The username required to access the network location. Only applicable if _Login required_ is activated. **Warning if already mapped** Normally, an error is thrown if you try to map a drive that is already mapped. Activate this if you only want a warning instead. ## Inbound Variable **Network Path** The path of the network location you want to map. ## Outbound Variables The action step _Map Network Drive_ possesses no outbound variables. --- product: RPA Builder version: 6.6 --- # Math Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can use this Action Step to perform mathematical calculations. You can enter a formula with fixed values or add values using mapped variables. The result can be reused in the course of the workflow. The following mathematical operations are available: - Addition - Subtraction - Multiplication - Division - Absolute value - Maximum value - Minimum value - Exponentiation - Round value ## Properties **Calculate Expression Result as** Here, you can specify whether the result should be calculated and displayed as a whole number (integer) or as a number with decimals (floating point/double-precision floating point). **Math Expression** The formula entered is shown here. ## Inbound Variables **Math Expression** Here, you can enter a formula with fixed values (for example (42+84)/3), or insert variables via _Insert Available Variables_ for use in performing the mathematical operations (for example, ({a}+{b})/{c}). ## Outbound Variables **ResultAsFloat** The result is displayed as a floating-point value. **ResultAsInt** The result is displayed as a whole number (integer). ## Wizard Enter the formula in the _Math Expression_ text field. Clicking _Insert Mathematical Operation_ opens a drop-down list with all available mathematical operations. Under _Insert Available Variables,_ you will find all variables previously added using the Pin button. Up to ten variables can be mapped. These are displayed in the Wizard and can be selected for the calculation. You can enter test values in the _Test Values_ field to test whether or not the formula is valid. Then click the _Test_ button. If the formula is valid, the result will be displayed. Otherwise, an error message will appear. The values of the mapped variables are not important until the production run of the workflow. If you want to output the result as a floating-point value, select _Calculate Expression Result as Floating-Point Value_; if you want to display the result as a whole number, select _Calculate Expression as Integer Value_. Please note that implied multiplication also applies when you enter the _Math Expression_ and you must put in the parentheses yourself. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Math Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can use this action step to perform mathematical calculations. You can enter a formula with fixed values or add values using mapped variables. The result can be reused in the course of the workflow. The following mathematical operations are available: - Addition - Subtraction - Multiplication - Division - Absolute value - Maximum value - Minimum value - Exponentiation - Round value ## Properties **Calculate Expression Result as** Here, you can specify whether the result should be calculated and displayed as a whole number (integer) or as a number with decimals (floating point/double-precision floating point). **Math Expression** The formula entered is shown here. ## Inbound Variables **Math Expression** Here, you can enter a formula with fixed values (for example (42+84)/3), or insert variables via _Insert Available Variables_ for use in performing the mathematical operations (for example, ({a}+{b})/{c}). ## Outbound Variables **ResultAsFloat** The result is displayed as a floating-point value. **ResultAsInt** The result is displayed as a whole number (integer). ## Wizard Enter the formula in the _Math Expression_ text field. Clicking _Insert Mathematical Operation_ opens a drop-down list with all available mathematical operations. Under _Insert Available Variables,_ you will find all variables previously added using the Pin button. Up to ten variables can be mapped. These are displayed in the Wizard and can be selected for the calculation. You can enter test values in the _Test Values_ field to test whether or not the formula is valid. Then click the _Test_ button. If the formula is valid, the result will be displayed. Otherwise, an error message will appear. The values of the mapped variables are not important until the production run of the workflow. If you want to output the result as a floating-point value, select _Calculate Expression Result as Floating-Point Value_; if you want to display the result as a whole number, select _Calculate Expression as Integer Value_. Please note that implied multiplication also applies when you enter the _Math Expression_ and you must put in the parentheses yourself. --- product: RPA Builder version: 6.6 --- # Measurement Points > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Measurement Points are currently not supported by RPA Manager. This means that it is currently not possible to evaluate the data on the server. You can still use the Measurement Points in RPA Builder because they are still displayed in the _Workflow Run Results_. - [Checkpoint](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-checkpoint) Checkpoints are integrated into a Workflow in order to ascertain which part of the Workflow was reached before an error occurred. - [Checkpoint Collection](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-checkpoint-collection) The Checkpoint Collection Action Step enables you to collect all timer values from the Checkpoint Action Steps configured in an Activity Workflow. - [General Timer Start](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-general-timer-start) General timers are used to measure whole Transactions. Use the _General Timer Start_ Action Step to start the timer. - [General Timer Stop](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-general-timer-stop) General timers are used to measure whole Transactions. Use the _General Timer Stop_ Action Step to stop the timer. - [Stopwatch](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-stopwatch) The Stopwatch is basically a combined Start/Stop Timer with a clear graphical representation. - [Stopwatch Collection](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-stopwatch-collection) The Stopwatch Collection Action Step enables you to collect all timer values from the Stopwatch Action Steps configure in an Activity Workflow. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Measurement Points > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Measurement Points are currently not supported by RPA Manager. This means that it is currently not possible to evaluate the data on the server. You can still use the Measurement Points in RPA Builder because they are still displayed in the _Workflow Run Results_. - [Checkpoint](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-checkpoint) Checkpoints are integrated into a Workflow in order to ascertain which part of the Workflow was reached before an error occurred. - [Checkpoint Collection](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-checkpoint-collection) The Checkpoint Collection action step enables you to collect all timer values from the Checkpoint action steps configured in an Activity Workflow. - [General Timer Start](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-general-timer-start) General timers are used to measure whole Transactions. Use the _General Timer Start_ action step to start the timer. - [General Timer Stop](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-general-timer-stop) General timers are used to measure whole Transactions. Use the _General Timer Stop_ action step to stop the timer. - [Stopwatch](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-stopwatch) The Stopwatch is basically a combined Start/Stop Timer with a clear graphical representation. - [Stopwatch Collection](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-stopwatch-collection) The Stopwatch Collection action step enables you to collect all timer values from the Stopwatch action steps configure in an Activity Workflow. --- product: RPA Builder version: 6.6 --- # Message Box > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ is used to display a message box containing user-defined text and the buttons needed. It can be used at any point in a _Workflow_. ## Properties **Text** The text you want to display in the message box **Timeout** Defines the duration wait before it automatically closes the message box (only works if _Use timeout_ is selected) **Title** Window title for the message box **Use timeout** This option determines whether the message box should be closed automatically. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Message Box > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step is used to display a message box containing user-defined text and the buttons needed. It can be used at any point in a _Workflow_. ## Properties **Text** The text you want to display in the message box **Timeout** Defines the duration wait before it automatically closes the message box (only works if _Use timeout_ is selected) **Title** Window title for the message box **Use timeout** This option determines whether the message box should be closed automatically. --- product: RPA Builder version: 6.6 --- # Modifying the User Interface > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the exception of the menu bar, all areas can be resized and positioned anywhere in the graphical user interface (GUI). Simply click on the title bar of the view you wish to move and drag the frame. It is possible to position the frame anywhere in the GUI by dropping it onto the positioning icons which appear when a frame is moved. For example, drag the _Workflow Outline_ tab and drop it onto the positioning icon on the far right-hand side: The _Workflow Outline_ is now docked to the right-hand edge: ![Example drag and drop the frames](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image1.png) You can also show any view as a standalone window. Again, start dragging a view by its title bar, but instead of dropping it onto a positioning icon, simply drop it anywhere else: ![Example stand alone](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image2.png) Furthermore, every frame can be hidden to make more working space available. To hide a frame, click on the pin icon in its title bar: ![Example to hide a frame](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image3.png) Hidden frames are accessible via the tabs located on the edges of the screen closest to their position before hiding. Move the mouse cursor over the tab and the frame will slide in again: ![How to slide in](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image4.png) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Modifying the User Interface > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the exception of the menu bar, all areas can be resized and positioned anywhere in the graphical user interface (GUI). Simply click on the title bar of the view you wish to move and drag the frame. It is possible to position the frame anywhere in the GUI by dropping it onto the positioning icons which appear when a frame is moved. For example, drag the _Workflow Outline_ tab and drop it onto the positioning icon on the far right-hand side: The _Workflow Outline_ is now docked to the right-hand edge: ![Example drag and drop the frames](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image1.png) You can also show any view as a standalone window. Again, start dragging a view by its title bar, but instead of dropping it onto a positioning icon, simply drop it anywhere else: ![Example stand alone](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image2.png) Furthermore, every frame can be hidden to make more working space available. To hide a frame, click on the pin icon in its title bar: ![Example to hide a frame](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image3.png) Hidden frames are accessible via the tabs located on the edges of the screen closest to their position before hiding. Move the mouse cursor over the tab and the frame will slide in again: ![How to slide in](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-installation-and-first-use-modifying-the-user-interface-image4.png) --- product: RPA Builder version: 6.6 --- # Mouse Actions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Mouse Actions_ Action Step emulates mouse moves and clicks. Keyboard inputs can be used to modify the mouse clicks. You can capture mouse actions directly or create and/or edit them in the wizard. The speed of mouse actions can also be defined. Mouse moves can be created relative to a specific coordinate. This coordinate may be determined by a previous _Action Step_ such as a image or text search, for example. ## Properties **Miscellaneous** **Relative To** (default: 0.0) Anchor point relative to which the mouse action is to be performed. If no _Pin_ variable has been assigned, this is the top-left corner of the screen. This anchor point can also be set as a placeholder ([Inbound Variables](#inbound-variables)). Please note that the _Action Step_ that returns the coordinates must occur within the same _Transaction_ in order to appear here as a possible _Pin_ variable. **Mouse Click Timing** **Mouse Click Down Delay** (ms, default: 200) Duration in milliseconds for which a mouse button is held down. **Mouse Click Up Delay** (ms, default: 10) Pause between two mouse clicks in milliseconds. **Mouse speed** (0–100, default: 4) The mouse must be moved to perform a click. This setting is used to set the speed of this move. High values produce a slower movement. The value 0 disables the movement, meaning that the mouse jumps instantaneously. ## Inbound Variables The property _Relative To_ can be linked to a _Pin_ variable of the type _Coordinate_. The mouse action is then performed relative to this coordinate rather than the top-left corner of the screen. ## Outbound Variables The _Group_ block possesses no outbound variables. ## Wizard **Click position** Pair of X and Y pixel coordinates where the mouse action is to be performed. **Mouse Action**The specific mouse action that is to be performed: - **None** Mouse to hover over an element. No mouse button is pressed; the mouse stays still. To capture a hover action, you must initially perform a mouse click at the relevant position. You can then change this in the _Mouse Action Edit Window_ from _Left_ to _None_ under _Mouse Action_ (one of the properties). - **Left** The left mouse button gets pressed. - **Middle** The middle mouse button gets pressed. - **Right** The right mouse button gets pressed. - **LeftUp** (in the case of drag and drop) The left mouse button is released following a drag operation (moving the mouse with the button held down). - **LeftDown** (in the case of drag and drop) The left mouse button is held down during a drag operation (moving the mouse with the button held down). - **RightUp** The right mouse button is released following a drag operation (moving the mouse with the button held down). - **RightDown** The right mouse button is held down during a drag operation (moving the mouse with the button held down). - **WheelUp** The mouse wheel scrolls forwards/up. - **WheelDown** The mouse wheel scrolls backwards/down. **Click Count** (0-99) The number of clicks within the mouse action. When capturing a double-click, please make sure that the mouse doesn’t slip during the process. Check how the operation has been captured in the wizard. If _LeftDown_ and _LeftUp_ have been saved there because the coordinates differ, please correct this as follows: 1. Remove one line from the incorrectly captured double-click. 2. Set the _Mouse Action_ property to _Left_ and _Counts_ to _2_. **Modifier** Mouse actions can be modified by combinations of keys. This makes it possible, for example, to mark related or individual elements using the mouse. **Initial Action Delay \[ms\]** (default: 500 ms) You can enter a delay of between 0 and 999999999 ms between the cursor movement and the start of the actual mouse action. This would be necessary, for example, if a clickable element only becomes visible when the mouse pointer is hovered over it. Select the checkbox next to _Enable initial action delay_ to enable this. **Enable initial action delay** enables the _Initial Action Delay_ property to be used. _Other wizard functionality_ **Move mouse action up/down** moves the selected mouse action up or down in the table. The ID of the action remains unchanged. Mouse actions are performed in the order in which they appear in the table, regardless of their ID. **Add mouse action** It is possible to add a mouse action that you configure solely using the wizard rather than actually capturing it. **Hide this window when capturing** (default: enabled) If this option is enabled, the _Mouse Action Wizard_ window is hidden while mouse actions are captured. **Hide main window when capturing** (default: enabled) If this option is enabled, the RPA Builder window is hidden while mouse actions are captured. **Relative To** (default: none) The position where the mouse action is to be performed can be defined based on a previously executed Action Step (see also [Inbound Variables](#inbound-variables)). **Mouse click timing** (see [Properties](#properties)). ## Creating Mouse Actions Relative to an Anchor Point If the coordinate relative to which the mouse action is to be performed is not yet known at the time of designing the mouse action, a notification will appear. Click OK to confirm. Then click the mouse to set an anchor point at the position where you expect the coordinate to be and which the mouse action relates to. Then capture the other mouse actions that relate to this. At runtime, the anchor point will be replaced with the actual coordinate that is calculated at the time. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Mouse Actions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Mouse Actions_ action step emulates mouse moves and clicks. Keyboard inputs can be used to modify the mouse clicks. You can capture mouse actions directly or create and/or edit them in the wizard. The speed of mouse actions can also be defined. Mouse moves can be created relative to a specific coordinate. This coordinate may be determined by a previous action step such as a image or text search, for example. ## Properties **Miscellaneous** **Relative To** (default: 0.0) Anchor point relative to which the mouse action is to be performed. If no _Pin_ variable has been assigned, this is the top-left corner of the screen. This anchor point can also be set as a placeholder ([Inbound Variables](#inbound-variables)). Please note that the action step that returns the coordinates must occur within the same _Transaction_ in order to appear here as a possible _Pin_ variable. **Mouse Click Timing** **Mouse Click Down Delay** (ms, default: 200) Duration in milliseconds for which a mouse button is held down. **Mouse Click Up Delay** (ms, default: 10) Pause between two mouse clicks in milliseconds. **Mouse speed** (0–100, default: 4) The mouse must be moved to perform a click. This setting is used to set the speed of this move. High values produce a slower movement. The value 0 disables the movement, meaning that the mouse jumps instantaneously. ## Inbound Variables The property _Relative To_ can be linked to a _Pin_ variable of the type _Coordinate_. The mouse action is then performed relative to this coordinate rather than the top-left corner of the screen. ## Outbound Variables The _Group_ block possesses no outbound variables. ## Wizard **Click position** Pair of X and Y pixel coordinates where the mouse action is to be performed. **Mouse Action**The specific mouse action that is to be performed: - **None** Mouse to hover over an element. No mouse button is pressed; the mouse stays still. To capture a hover action, you must initially perform a mouse click at the relevant position. You can then change this in the _Mouse Action Edit Window_ from _Left_ to _None_ under _Mouse Action_ (one of the properties). - **Left** The left mouse button gets pressed. - **Middle** The middle mouse button gets pressed. - **Right** The right mouse button gets pressed. - **LeftUp** (in the case of drag and drop) The left mouse button is released following a drag operation (moving the mouse with the button held down). - **LeftDown** (in the case of drag and drop) The left mouse button is held down during a drag operation (moving the mouse with the button held down). - **RightUp** The right mouse button is released following a drag operation (moving the mouse with the button held down). - **RightDown** The right mouse button is held down during a drag operation (moving the mouse with the button held down). - **WheelUp** The mouse wheel scrolls forwards/up. - **WheelDown** The mouse wheel scrolls backwards/down. **Click Count** (0-99) The number of clicks within the mouse action. When capturing a double-click, please make sure that the mouse doesn’t slip during the process. Check how the operation has been captured in the wizard. If _LeftDown_ and _LeftUp_ have been saved there because the coordinates differ, please correct this as follows: 1. Remove one line from the incorrectly captured double-click. 2. Set the _Mouse Action_ property to _Left_ and _Counts_ to _2_. **Modifier** Mouse actions can be modified by combinations of keys. This makes it possible, for example, to mark related or individual elements using the mouse. **Initial Action Delay \[ms\]** (default: 500 ms) You can enter a delay of between 0 and 999999999 ms between the cursor movement and the start of the actual mouse action. This would be necessary, for example, if a clickable element only becomes visible when the mouse pointer is hovered over it. Select the checkbox next to _Enable initial action delay_ to enable this. **Enable initial action delay** enables the _Initial Action Delay_ property to be used. _Other wizard functionality_ **Move mouse action up/down** moves the selected mouse action up or down in the table. The ID of the action remains unchanged. Mouse actions are performed in the order in which they appear in the table, regardless of their ID. **Add mouse action** It is possible to add a mouse action that you configure solely using the wizard rather than actually capturing it. **Hide this window when capturing** (default: enabled) If this option is enabled, the _Mouse Action Wizard_ window is hidden while mouse actions are captured. **Hide main window when capturing** (default: enabled) If this option is enabled, the RPA Builder window is hidden while mouse actions are captured. **Relative To** (default: none) The position where the mouse action is to be performed can be defined based on a previously executed action step (see also [Inbound Variables](#inbound-variables)). **Mouse click timing** (see [Properties](#properties)). ## Creating Mouse Actions Relative to an Anchor Point If the coordinate relative to which the mouse action is to be performed is not yet known at the time of designing the mouse action, a notification will appear. Click OK to confirm. Then click the mouse to set an anchor point at the position where you expect the coordinate to be and which the mouse action relates to. Then capture the other mouse actions that relate to this. At runtime, the anchor point will be replaced with the actual coordinate that is calculated at the time. --- product: RPA Builder version: 6.6 --- # Move File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ moves a file from one directory to another. If the file to be moved if not available or the moved file is already located in the destination folder, an error message will interrupt the _Workflow_. ## Properties **File Operation Settings:** - **Create directory if it does not exist** If this option is enabled, Move File creates either the specified relative directory or the whole specified path, if this does not already exist. - **Destination directory** Enter the path to the destination directory where the file that is to be moved will be saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **Directory path**\* Enter the path to the directory where the file to be moved is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to move. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations#invalid-characters). - **Overwrite existing file** This option enables you to overwrite an existing file with the same name in the destination folder. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path**\* Enter the path to the directory where the file to be moved is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **File Name** Enter the name here of the file that is to be moved. ## Outbound Variables **Destination directory** The _Move File.Destination directory_ variable provides the path to the destination directory. **IsMoved** The _Move File.IsMoved_ variable indicates whether the file was successfully moved or not (True/False). **File name** The _Move File.File Name_ variable provides the name of the file that has been moved. **Directory path** The _Move File.Directory Path_ variable provides the path to the source directory. ## Wizard - **Directory path** Specify the path to the file that is to be moved. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be moved. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Destination directory** Specify the destination path for the file that is to be moved. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **Overwrite existing file** If this option has not been enabled, an error message will interrupt the _Workflow_ if there is already a file with the same name in the destination directory. If this option has been enabled and the file already exists, the moved file will replace it and no acknowledgment will be given. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Move File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step moves a file from one directory to another. If the file to be moved if not available or the moved file is already located in the destination folder, an error message will interrupt the _Workflow_. ## Properties **File Operation Settings:** - **Create directory if it does not exist** If this option is enabled, Move File creates either the specified relative directory or the whole specified path, if this does not already exist. - **Destination directory** Enter the path to the destination directory where the file that is to be moved will be saved. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **Directory path**\* Enter the path to the directory where the file to be moved is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File Name** The name of the file to move. This field does not support placeholders. For further information, see [Path / file name / invalid characters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations#invalid-characters). - **Overwrite existing file** This option enables you to overwrite an existing file with the same name in the destination folder. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path**\* Enter the path to the directory where the file to be moved is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **File Name** Enter the name here of the file that is to be moved. ## Outbound Variables **Destination directory** The _Move File.Destination directory_ variable provides the path to the destination directory. **IsMoved** The _Move File.IsMoved_ variable indicates whether the file was successfully moved or not (True/False). **File name** The _Move File.File Name_ variable provides the name of the file that has been moved. **Directory path** The _Move File.Directory Path_ variable provides the path to the source directory. ## Wizard - **Directory path** Specify the path to the file that is to be moved. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be moved. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Destination directory** Specify the destination path for the file that is to be moved. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **Overwrite existing file** If this option has not been enabled, an error message will interrupt the _Workflow_ if there is already a file with the same name in the destination directory. If this option has been enabled and the file already exists, the moved file will replace it and no acknowledgment will be given. --- product: RPA Builder version: 6.6 --- # MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Execute your MuleSoft IDP document actions from RPA to process documents and consume the results. Before you use these action steps, ensure you have created and published _document actions_ in MuleSoft IDP. Then, you can use the MuleSoft IDP action steps to submit documents for processing and retrieve the results of the execution by providing the generated Execution ID. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. - [Retrieve Results from MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mulesoft-idp-retrieve-results-from-mulesoft-idp) Retrieve the results of an IDP document action execution. Before you can query the results, you must run the Submit Document to MuleSoft IDP action step to trigger the execution of said document action. - [Submit Document to MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mulesoft-idp-submit-document-to-mulesoft-idp) Submit a document to MuleSoft IDP and execute a published document action to process the document. Use the returned Execution ID to query the results later using the Retrieve Results from MuleSoft IDP action step. ## See Also - [IDP Overview](https://docs.mulesoft.com/idp/) - [Getting Started with Document Processing](https://docs.mulesoft.com/idp/document-processing) --- product: RPA Builder version: 6.7 is-latest-version: true --- # MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Execute your MuleSoft IDP document actions from RPA to process documents and consume the results. Before you use these action steps, ensure you have created and published _document actions_ in MuleSoft IDP. Then, you can use the MuleSoft IDP action steps to submit documents for processing and retrieve the results of the execution by providing the generated Execution ID. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. - [Retrieve Results from MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mulesoft-idp-retrieve-results-from-mulesoft-idp) Retrieve the results of an IDP document action execution. Before you can query the results, you must run the Submit Document to MuleSoft IDP action step to trigger the execution of said document action. - [Submit Document to MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mulesoft-idp-submit-document-to-mulesoft-idp) Submit a document to MuleSoft IDP and execute a published document action to process the document. Use the returned Execution ID to query the results later using the Retrieve Results from MuleSoft IDP action step. ## See Also - [IDP Overview](https://docs.mulesoft.com/idp/) - [Getting Started with Document Processing](https://docs.mulesoft.com/idp/document-processing) --- product: RPA Builder version: 6.6 --- # Navigate > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to perform navigation operations, such as going backwards or forward in the navigation history or refreshing the current webpage. It can also be used to call a specific URL. ## Properties **Navigation Command** Decide if the current webpage should be refreshed. Use this to go backwards or forwards in the browsing history or if you want to load a specific URL. **Navigate to this URL** If you have selected _Specify a URL to navigate to_ under _Navigation Command_, then enter the URL to be loaded here. ## Inbound Variables **Navigate to this URL** If you have selected _Specify a URL to navigate to_ under _Navigation Command_, then enter the URL to be loaded here. ## Outbound Variables The Action Step _Navigate_ possesses no outbound variables. Please note: When calling a specific page using the _Navigate_ Action Step, it is important to note that the initial page build may take longer than the execution of the Action Step itself. The page request often loads only a very small, initial HTML page. Therefore, while the page is being loaded for the user, the NavigateTo has long been completed. The only help here is an appropriate anchor point. This can be done in WebAutomation, using a _Check Element_ that waits until the elements appear in the completely displayed page. A _PatternSearch_ could also be used at this juncture. You can use this anchor point as a stable starting point for subsequent actions. ## Example Measurement of the initial page load is particularly relevant in connection with APM/TA. This is only possible if you can enclose the transaction in a stopwatch clause. Since this is not possible directly in a web session, the web session is often opened with a neutral page (about:blank). Within the block, you might now expect that a stopwatch and the NavigateTo it contains will return the requested value from the page to be measured. This is usually not the case, however, because the page request often only load a very small, initial HTML page. In turn, this page loads further page content asynchronously, which then creates the actual visual page. Therefore, while the page is being loaded for the user, the NavigateTo has long been completed, which means the measured time does not correspond to the time actually required by the page. The only help here is an appropriate anchor point. This can be done in WebAutomation, using a _Check Element_ that waits until the elements appear in the completely displayed page. A _PatternSearch_ could also be used at this juncture. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Navigate > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to perform navigation operations, such as going backwards or forward in the navigation history or refreshing the current webpage. It can also be used to call a specific URL. ## Properties **Navigation Command** Decide if the current webpage should be refreshed. Use this to go backwards or forwards in the browsing history or if you want to load a specific URL. **Navigate to this URL** If you have selected _Specify a URL to navigate to_ under _Navigation Command_, then enter the URL to be loaded here. ## Inbound Variables **Navigate to this URL** If you have selected _Specify a URL to navigate to_ under _Navigation Command_, then enter the URL to be loaded here. ## Outbound Variables The action step _Navigate_ possesses no outbound variables. Please note: When calling a specific page using the _Navigate_ action step, it is important to note that the initial page build may take longer than the execution of the action step itself. The page request often loads only a very small, initial HTML page. Therefore, while the page is being loaded for the user, the NavigateTo has long been completed. The only help here is an appropriate anchor point. This can be done in WebAutomation, using a _Check Element_ that waits until the elements appear in the completely displayed page. A _PatternSearch_ could also be used at this juncture. You can use this anchor point as a stable starting point for subsequent actions. ## Example Measurement of the initial page load is particularly relevant in connection with APM/TA. This is only possible if you can enclose the transaction in a stopwatch clause. Since this is not possible directly in a web session, the web session is often opened with a neutral page (about:blank). Within the block, you might now expect that a stopwatch and the NavigateTo it contains will return the requested value from the page to be measured. This is usually not the case, however, because the page request often only load a very small, initial HTML page. In turn, this page loads further page content asynchronously, which then creates the actual visual page. Therefore, while the page is being loaded for the user, the NavigateTo has long been completed, which means the measured time does not correspond to the time actually required by the page. The only help here is an appropriate anchor point. This can be done in WebAutomation, using a _Check Element_ that waits until the elements appear in the completely displayed page. A _PatternSearch_ could also be used at this juncture. --- product: RPA Builder version: 6.6 --- # Network > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Network Action Steps enable you to perform network operations as sending pings, making REST calls or perform checks using the FTP and HTTP protocols. - [Ping](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network-ping) This Action Step is used for sending a ping to a computer or network device. - [REST Call](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network-rest-call) You can use the REST Call Action Step to fetch data directly from a server and to collect the required information in a simple way. - [Service Check](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network-service-check) The Service Check plug-in allows you to perform checks using various protocols and services, such as Ping, FTP, HTTP, etc., to see if a service is running and available on a particular server. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Network > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Network action steps enable you to perform network operations as sending pings, making REST calls or perform checks using the FTP and HTTP protocols. - [Ping](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network-ping) This action step is used for sending a ping to a computer or network device. - [REST Call](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network-rest-call) You can use the REST Call action step to fetch data directly from a server and to collect the required information in a simple way. - [Service Check](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network-service-check) The Service Check plug-in allows you to perform checks using various protocols and services, such as Ping, FTP, HTTP, etc., to see if a service is running and available on a particular server. --- product: RPA Builder version: 6.6 --- # OCR With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The OCR with AWS action step enables you to recognize the text in a document by sending a local file to the AWS Textract service, which returns the extracted values. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/ocr-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Detecting Text](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # OCR With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The OCR with AWS action step enables you to recognize the text in a document by sending a local file to the AWS Textract service, which returns the extracted values. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/ocr-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Detecting Text](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Pattern Gallery > For the full documentation index, see: https://docs.mulesoft.com/llms.txt All search patterns belonging to a _Workflow_ are stored centrally in the _Pattern Gallery._ Search patterns are image files which are used in the _Search Pattern_ and _Pattern Select Action Steps_ to determine a state. Search patterns can be created directly in the _Pattern Gallery Wizard_. They are also automatically transferred from the _Search Pattern_ and _Pattern Select Action Steps_. Search patterns that are not used can be deleted from the _Workflow._ There is no limit to the number of search patterns in a _Workflow_. ## Properties The _Pattern Gallery Action Step_ does not contain any additional properties, other than the **Common Properties**. ## Inbound Variables The _Pattern Gallery Action Step_ does not produce any inbound variables. ## Outbound Variables The _Pattern Gallery Action Step_ does not produce any outbound variables. ## Wizard The _Pattern Gallery Wizard_ enables search patterns to be created, processed, and searched for, which can be used throughout the entire _Workflow._ For additional information about the basic functionality of the _Pattern Strip_, which contains all the search patterns and menu bars, see [The Pattern Script Module](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture#pattern-strip). ## See Also - [Pattern Select](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-pattern-select) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-search-pattern) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Pattern Gallery > For the full documentation index, see: https://docs.mulesoft.com/llms.txt All search patterns belonging to a _Workflow_ are stored centrally in the _Pattern Gallery._ Search patterns are image files which are used in the _Search Pattern_ and _Pattern Select action steps_ to determine a state. Search patterns can be created directly in the _Pattern Gallery Wizard_. They are also automatically transferred from the _Search Pattern_ and _Pattern Select action steps_. Search patterns that are not used can be deleted from the _Workflow._ There is no limit to the number of search patterns in a _Workflow_. ## Properties The _Pattern Gallery action step_ does not contain any additional properties, other than the **Common Properties**. ## Inbound Variables The _Pattern Gallery action step_ does not produce any inbound variables. ## Outbound Variables The _Pattern Gallery action step_ does not produce any outbound variables. ## Wizard The _Pattern Gallery Wizard_ enables search patterns to be created, processed, and searched for, which can be used throughout the entire _Workflow._ For additional information about the basic functionality of the _Pattern Strip_, which contains all the search patterns and menu bars, see [The Pattern Script Module](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture#pattern-strip). ## See Also - [Pattern Select](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-pattern-select) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-search-pattern) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.6 --- # Pattern Select > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Pattern Select Action Step_ enables users to respond flexibly to non-predictable situations. It is deployed after executing _Action Steps_ which could result in various states. These states are characterized by the presence of a specific search pattern. How the program path will proceed depends on whether one of these search patterns is found. For this purpose, search patterns are recorded for every possible state. _Pattern Select_ creates a _Case_ for every search pattern. Each _Case_ contains the steps to be executed in that situation. _Cases_ are processed sequentially until a search pattern is found. If none of the search patterns listed are found, error handling (_DoElse_ branch) can be performed. _Pattern Select_ is used, for example, when a new software user is created. As a result, either a message stating that the user has been successfully created can be displayed or a message stating that, for various reasons, the user could not be created. Each of these possible messages is captured in a screenshot and stored as a _Case_, so that the subsequent steps in the _Workflow_ can be executed according to this message. Another use for the _Pattern Select_ _Action Step_ is to close in succession multiple dialog boxes which are not shown on the screen in a predictable order or position. In this scenario, the _Pattern Select_ _Action Step_ will be carried out until all specified windows are closed. The _Pattern Select_ image search is configurable and can contain up to 50 search patterns. The configuration of the _Action Step Pattern Select_ cannot be changed in Debug Mode. However, you can change the configuration of the _Action Steps_ contained in the _Cases_ and the _DoElse_ block of the _Action Step Pattern Select_. If you set a _Breakpoint_ at the _Action Step Pattern Select_, you can run through the different _Case_ branches by repeating the Action Step in _Debug_ mode while changing the displayed search pattern after breaking. ## Properties **Image Processing** **Allow multiple matches of a found pattern** If this option is selected, the pattern may appear more than once in the _Search Area_. When this option is not selected, the _Search Pattern Action Step_ returns an error if the pattern is found but occurs more than once. If the coordinates of the pattern found are to be reused subsequently in a different _Action Step_ (e.g. for mouse clicks relative to pattern), the coordinates used in the case of multiple identical patterns found will be the ones for the pattern furthest to the left within the _Search_ _Area_. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. **Hide mouse** moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. **Margin for automatic search area \[pixel\]** Number of pixels around a found pattern for defining the search area automatically. Valid values lie between 0 and 999; the default-value is 100. **Neighborhood Pixel** indicates the number of pixels by which the position of a pixel found may differ from the specified position. The default value for this setting is 1. Please note that it is easier to search for similar images if the value is greater than 1, i.e. the images are not 100% identical based on pixels. The percentage score may vary by some percentage values depending on position though. **Original Desktop Size** Screen resolution at the time the image search was last tested. This size is required in order to scale the _Search Area_ (but not the _Search Pattern_) if the _Workflow_ is used on a device with a different screen resolution. **Pattern Steady check** enables the option 'Wait For Pattern Steady Timeout' and checks whether the coordinates of the pattern found change again within this time period. If not, the search is successful and ends; otherwise the search is repeated. **Reduce Score By \[%\]** When testing the _Search Pattern_ settings, matches by this percentage below the _Score_ are also shown. These are marked yellow in the test result window. In the wizard, this setting is shown under _Search Settings_ and appears as a yellow zone on the _Required matching precision (%)_ slider. **Repeat search until nothing found** If the option to _Repeat search until nothing found_ is enabled, the image search will be carried out within the _Timeout_ interval until none of the images being searched for are found anymore. **Score \[%\]** indicates the accuracy in percent by which the pattern found must match the specified pattern in order to be considered found. In the wizard, this setting is labeled _Required matching precision (%)_ under _Search Settings_ and appears as a green zone on a slider. **Search Mode** There are three search modes: - **Match only one pattern** is successful if exactly one of the specified patterns being searched for is found - **Match one or more patterns** is successful if at least one of the specified patterns being searched for is found - **Match all patterns** is successful if all of the specified patterns being searched for are found **Wait for Pattern Steady Timeout \[ms\]** If the option _Pattern steady check_ is selected, a check for whether the pattern found is still in the same position, or whether it still does not appear in the _Search Area_, is performed according to the interval value entered here (or in the wizard under _Search Settings_ > _Check whether found match stays in same location every \[time in ms\] milliseconds_). If this is the case, the search is successful and ends. Otherwise, the search is repeated either until it is successful or the _Action Step_ times out. A value of 0 means that the position of the pattern found is not rechecked after having been found. The _Action Step_ does not then wait beyond its runtime. ## Inbound Variables **Find Coordinate** If there is at least one other Action Step that uses patterns before the Action Step Search Pattern, the outbound variable _Find coordinate_ becomes the inbound variable for the subsequent Action Steps. ## Outbound Variables **Pattern Case Index** returns the case index, which is executed based on a pattern found. **Find Coordinate** Top left corner of the pattern that has been found successfully. If a search is made for multiple patterns and they are found, the coordinates returned are of the image on the far left of the series of patterns being searched for as specified in the wizard. If multiple identical patterns are found in the same position on the far left of the _Search Area_, the topmost one is used. **Found Pattern Name** The name of the matched pattern as entered in the _Pattern Gallery_. **Found Matched Pattern Count** Number of found search patterns from the _Regular_ category. The number of matches can consist of matches for different patterns. Matches of patterns of the category _Ignore_ and _Exclude_ are not counted. _Found Matched Pattern Count_ is 0, if _Search Pattern_ returns an error. Even, if matches for patterns of the _Regular_ category are found. ## Wizard The _Pattern Select_ wizard is for selecting _Search Patterns_ and the key search settings. The basic functionality of the _Pattern Strip_ shown here, including all pattern operations, is described in [The Pattern Strip Module](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture#pattern-strip). Click _OK_ to confirm the configuration settings or _Cancel_ as applicable. The _Test_ button evaluates the search and displays the results in the Search Results window. ## Filtering by Pattern Name and Resizing Pattern Images Entering text into the _Filter…_ field hides in stages all patterns in the lower sections of the wizard with names not containing that text. The filter text may appear in any position within the pattern name, but must be continuous. **Example:** If the _Search Pattern_ _Action Step_ contains patterns with the names House, House1, Mouse, and Mouse1, the search filter will find all images when use is entered, only House1 and Mouse1 when 1 is entered, and House and House1 in the case of H. ## Regular Patterns This section lists patterns that are to be found. The number of patterns that can be found is limited to 50. There are three ways of searching for patterns. **Match only one pattern** is successful if **exactly one** of the selected patterns is found in the _Search Area_. An error is returned if none or a number of the selected patterns are found. **Match one or more patterns** is successful if **at least one** of the selected patterns is found in the _Search Area_. An error is returned if none of the selected patterns are found. **Match all patterns** is successful if **all** of the selected patterns are found in the _Search Area_. An error is returned if none or not all of the selected patterns are found. If the option _Match all patterns_ is enabled, only the _Case_ branch for the image with top priority is carried out. In the graphical information that is the first search pattern and/or the top _Case_ in the list. If a pattern appears multiple times, a successful search will occur as above if _Allow multiple matches of a found pattern_ is enabled in the _Search Settings_. The _Action Step_ will otherwise return an error if the same pattern appears multiple times. The order of the _Cases_ in the _Action Step_ corresponds to the order of the search patterns in the wizard. The _Workflow_ continues with the steps for the first _Case_ that arises. Be sure to fill out the _DoElse_ block too. An empty _DoElse_ block causes an error when executed, resulting in the entire _Workflow_ being terminated. Patterns may be chosen from the _Pattern Gallery_ or created by means of a screenshot (_Capture_). Click to select one or multiple patterns and delete or move them as a group. When a pattern is selected, a white tick will appear on a green background in the top right corner. To undo the selection, click the _Clear Selection_ button. A vertical black line indicates where the pattern can be moved to using drag and drop. If _Match one or more patterns_ is selected the first pattern in the list will have a blue border. This image can be used as a reference point for other Action Steps as the Workflow progresses (see [Other Uses of Matched Patterns](#other-uses-of-matched-patterns)). ## Capture Pattern One way of defining a pattern is to take a screenshot that shows it. The function of the _Capture Pattern_ button is described in [Adding a Pattern from Screen Capture](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture#add-pattern-from-screen-capture) All patterns captured using the _Pattern Select_ _Action Step_ are transferred to the _Workflow_'s _Pattern Gallery_. ## Add Pattern from Gallery If the _Pattern Gallery_ for the _Workflow_ already contains patterns, they can be added to the list of patterns for the _Action Step_. The _Select Patterns to add_ window shows all the images that the _Workflow_'s _Pattern Gallery_ contains. A white tick on a green background in the top right corner indicates patterns which are already included in the _Search Pattern_ _Action Step_. Patterns already included in another category of the same _Action Step_ are not shown. To add patterns to the search, simply use the mouse to click and select. Use the same method to deselect patterns which should no longer be included in the search. Click OK to confirm the selection and add it to the pattern list for the _Action Step_. ## Ignore All Matches within These Patterns If checking for the single occurrence of a pattern that may be part of other patterns, you must exclude patterns containing the searched-for pattern within them from the search. The number of patterns that can be excluded is limited to 50. Example: Search for the word staff as a noun but only if it doesn’t form part of another term, e.g. 'staffing'. This pattern must be included in the green field among the patterns being searched for. Other patterns containing this term, e.g. staffing or staffed must be added here. Areas in a single color are not taken into account within the pattern. It is therefore not sufficient in the above example to capture staff with free space at the right edge, because this free space will not form part of the pattern being searched for due to a lack of _features_. ## Changing the Search Pattern Category The patterns selected can be moved between the categories _Regular_ and _Ignored_. Use the _Move to…_ button in the menu bar to do this. ## Search Settings The settings needed most frequently for all types of search can be set and modified using the _Search Pattern_ _Action Step_ wizard under _Search Settings_. The _Required matching precision_ in percent is shown as a green zone on a slider. A yellow zone to the left of the green indicates the range that was entered in the _Properties_ under _Reduce Score by \[%\]_ to monitor criteria during the test in an advanced search. You can use either the general _Timeout_ or your own. If the option _Check whether found match stays in same location every \[time in ms\] milliseconds (Wait for Image Steady Timeout \[ms\]_ in the property pane) is enabled, it may make sense to choose a different _Timeout_ depending on this value. Because the repeated image search has to be completed in an interval defined here within the timeout, the recommended maximum interval value is ½\*_timeout_. _Move mouse to 0,0 while pattern search is active_ moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. The search area is displayed on the right side of the settings section. Click the button _Define manually_ to define the search area by drag&drop. The button _Define automatically_ automatically defines a search area containing all _regular_ matches visible at the time of the definition of the search area. The _ResetTo Full Screen_ button turns the search area back to full screen. The Search Area can be set to either a _fixed_ or dynamic (_relative_) position. To define a dynamic position, use the _Relative To_ picklist, which lists all variables of type _Coordinates_ that are available at this point; these include, for example, Outbound Variables from a previous _Search Pattern_ Action Step in the same transaction. When a coordinate is selected in the wizard as “Relative To”, an offset vector is immediately calculated. While the _Workflow_ is being designed, this points from the selected coordinate to the top-left corner of the _Search Area_. At _Workflow_ runtime, the calculated offset vector is applied to the real-time value of the _Search Area_ that the coordinate relates to. This means that the _Search Area_ at _Workflow_ runtime is positioned at exactly the same distance from the “Relative To” coordinate as at the time of design. The option to _Repeat search until nothing found_ repeats the image search until no more search patterns can be found or until it times out. One possible use is to close multiple dialog boxes which may be encountered in an unknown order and position. If the option to _Repeat search until nothing is found_ is enabled, the maximum _Timeout_ is less than double the time entered here. If multiple patterns are included and the first one is found within the timeout, the timeout period will be extended by the specified _Timeout_ once only. All other patterns must then be found within this remaining _Timeout_ period. Otherwise the program enters an error state and executes the _OnError Case_. The _Timeout_ is therefore adjusted to the duration of the steps that need to be completed within the _Cases_. If the Option to _Repeat search until nothing is found_ is enabled, the following is to be noted with regard to the various search options: - **Match only one patterns** Here only one of the images from the selection may be visible at any time. This option can be used if the patterns are layered on top of one another - **Match one or more patterns** Here any of the search images may appear - **Match all patterns** Here all images within the selection must be found For all modes, the following is applicable: - If multiple patterns are found the _Case_ branch is carried out for the image with top priority. In the graphical information that is the first search pattern and/ or the top _Case_ in the list. - If the option to _Allow multiple instances of a found pattern_ is enabled, the above priority is given and then the image that is located furthest to the left within the _Search Area_ is re-used. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. ## Test Pressing the _Test_ button will launch the search independently of _Workflow_ execution and open the _Search Results_ window where the search is evaluated. This can provide hints about possible improvements that could be made to the _Search Settings_. The screen content at the time the test was performed takes up the main part of the window _Search Result_. A blue border surrounds the _Search Area_. The area outside the _Search Area_ is shown grayed. _Matches_ are highlighted in color. The color legend at the right side of the window works simultaneously as a check box panel for switching the display of the different match types on and off. If there are no matches of a certain type, the according check box field is shown grayed. _Search Patterns_ of the list _Match all / only one / one or more pattern(s)_ found within the defined precision are highlighted green. Matches from the list _Ignore all matches within these patterns_ are highlighted light blue and matches from the list _Make sure none of these patterns appear_ are highlighted red. A yellow highlighting shows that the search pattern could have been found if the precision had been set lower. This reduced precision is calculated by deducting the _Reduced Score_ from the _Score._ In each case, the precision of the match is stated. Matches outside of the _Search Area_ are marked in gray color irrespective of their type. . Patterns with a _Color Spot_ that are found but do not match the _Color Spot_ color at a specific position are marked in blue. You can see the type of the match in the details pane on the right side of the window. On opening the window the size of the screenshot is adjusted so, that the whole screenshot is visible. You can zoom in to or out of the image by dragging the slider at the right side of the screenshot. It is also possible to do this by mouse wheel. Double click on the slider shows the image in its original size. If the image is enlarged, scroll bars for adjusting the position of the view appear on the right side and on the lower border of the image. Below the slider the current mouse position in relation to the screen shown in the screenshot is displayed dynamically. Mouse hover over a match shows the name, a thumbnail and the matching precision as a tooltip. Clicking a Match on the screenshot shows details to this Pattern on the right side of the window. Clicking a pattern in the tab _Pattern_ at the lower border of the window shows details to all matches to this pattern. Clicking a match in the screenshot only shows details for this single match. Details contain the name, type, size in pixels and a thumbnail of the pattern along with a color-marked listing of the found matches. For all matches, the coordinates of the upper left corner and the matching precision are displayed. The coloring is the same as described above. Clicking a match in the details pane toggles the highlighting of the according matches in the screenshot. Highlighting of a Match is indicated in the details pane by a colored border and the intensifying of its background color. Clicking a _Match_ in the details pane displays an animated arrow pointing to this match in the screenshot. In the process, the screenshot is resized so it can be seen in its entirety within the window. The tab _Search Results Summary_ shows a textual overview over the search settings and the search result. If the search failed because of one single pattern, this pattern is shown in tab _Failure Reason_. ## Other Uses of Matched Patterns If mouse clicks are to be performed relative to a matched image and, at the same time, the search is for more than one image, the image that the mouse clicks relate to must be at the top of the list. If the first image on the list is not found, the mouse click will be inserted relative to the first image from the list that is found. If the first image on the list that is found occurs multiple times, the image located on the far left of the screen will be used. If there are multiple images in the identical lateral position on the left, the topmost one will be used. Directly before editing the _Mouse click_ _Action Step_ the reference pattern must be found by performing the _Test_ function for the _Pattern Select_ _Action Step_. Otherwise the previously found search pattern will always be used as the ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-pattern-gallery) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-search-pattern) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Pattern Select > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Pattern Select action step_ enables users to respond flexibly to non-predictable situations. It is deployed after executing action steps which could result in various states. These states are characterized by the presence of a specific search pattern. How the program path will proceed depends on whether one of these search patterns is found. For this purpose, search patterns are recorded for every possible state. _Pattern Select_ creates a _Case_ for every search pattern. Each _Case_ contains the steps to be executed in that situation. _Cases_ are processed sequentially until a search pattern is found. If none of the search patterns listed are found, error handling (_DoElse_ branch) can be performed. _Pattern Select_ is used, for example, when a new software user is created. As a result, either a message stating that the user has been successfully created can be displayed or a message stating that, for various reasons, the user could not be created. Each of these possible messages is captured in a screenshot and stored as a _Case_, so that the subsequent steps in the _Workflow_ can be executed according to this message. Another use for the _Pattern Select_ action step is to close in succession multiple dialog boxes which are not shown on the screen in a predictable order or position. In this scenario, the _Pattern Select_ action step will be carried out until all specified windows are closed. The _Pattern Select_ image search is configurable and can contain up to 50 search patterns. The configuration of the action step _Pattern Select_ cannot be changed in Debug Mode. However, you can change the configuration of the action steps contained in the _Cases_ and the _DoElse_ block of the action step _Pattern Select_. If you set a _Breakpoint_ at the action step _Pattern Select_, you can run through the different _Case_ branches by repeating the action step in _Debug_ mode while changing the displayed search pattern after breaking. ## Properties **Image Processing** **Allow multiple matches of a found pattern** If this option is selected, the pattern may appear more than once in the _Search Area_. When this option is not selected, the _Search Pattern action step_ returns an error if the pattern is found but occurs more than once. If the coordinates of the pattern found are to be reused subsequently in a different action step (e.g. for mouse clicks relative to pattern), the coordinates used in the case of multiple identical patterns found will be the ones for the pattern furthest to the left within the _Search_ _Area_. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. **Hide mouse** moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. **Margin for automatic search area \[pixel\]** Number of pixels around a found pattern for defining the search area automatically. Valid values lie between 0 and 999; the default-value is 100. **Neighborhood Pixel** indicates the number of pixels by which the position of a pixel found may differ from the specified position. The default value for this setting is 1. Please note that it is easier to search for similar images if the value is greater than 1, i.e. the images are not 100% identical based on pixels. The percentage score may vary by some percentage values depending on position though. **Original Desktop Size** Screen resolution at the time the image search was last tested. This size is required in order to scale the _Search Area_ (but not the _Search Pattern_) if the _Workflow_ is used on a device with a different screen resolution. **Pattern Steady check** enables the option 'Wait For Pattern Steady Timeout' and checks whether the coordinates of the pattern found change again within this time period. If not, the search is successful and ends; otherwise the search is repeated. **Reduce Score By \[%\]** When testing the _Search Pattern_ settings, matches by this percentage below the _Score_ are also shown. These are marked yellow in the test result window. In the wizard, this setting is shown under _Search Settings_ and appears as a yellow zone on the _Required matching precision (%)_ slider. **Repeat search until nothing found** If the option to _Repeat search until nothing found_ is enabled, the image search will be carried out within the _Timeout_ interval until none of the images being searched for are found anymore. **Score \[%\]** indicates the accuracy in percent by which the pattern found must match the specified pattern in order to be considered found. In the wizard, this setting is labeled _Required matching precision (%)_ under _Search Settings_ and appears as a green zone on a slider. **Search Mode** There are three search modes: - **Match only one pattern** is successful if exactly one of the specified patterns being searched for is found - **Match one or more patterns** is successful if at least one of the specified patterns being searched for is found - **Match all patterns** is successful if all of the specified patterns being searched for are found **Wait for Pattern Steady Timeout \[ms\]** If the option _Pattern steady check_ is selected, a check for whether the pattern found is still in the same position, or whether it still does not appear in the _Search Area_, is performed according to the interval value entered here (or in the wizard under _Search Settings_ > _Check whether found match stays in same location every \[time in ms\] milliseconds_). If this is the case, the search is successful and ends. Otherwise, the search is repeated either until it is successful or the action step times out. A value of 0 means that the position of the pattern found is not rechecked after having been found. The action step does not then wait beyond its runtime. ## Inbound Variables **Find Coordinate** If there is at least one other action step that uses patterns before the action step Search Pattern, the outbound variable _Find coordinate_ becomes the inbound variable for the subsequent action steps. ## Outbound Variables **Pattern Case Index** returns the case index, which is executed based on a pattern found. **Find Coordinate** Top left corner of the pattern that has been found successfully. If a search is made for multiple patterns and they are found, the coordinates returned are of the image on the far left of the series of patterns being searched for as specified in the wizard. If multiple identical patterns are found in the same position on the far left of the _Search Area_, the topmost one is used. **Found Pattern Name** The name of the matched pattern as entered in the _Pattern Gallery_. **Found Matched Pattern Count** Number of found search patterns from the _Regular_ category. The number of matches can consist of matches for different patterns. Matches of patterns of the category _Ignore_ and _Exclude_ are not counted. _Found Matched Pattern Count_ is 0, if _Search Pattern_ returns an error. Even, if matches for patterns of the _Regular_ category are found. ## Wizard The _Pattern Select_ wizard is for selecting _Search Patterns_ and the key search settings. The basic functionality of the _Pattern Strip_ shown here, including all pattern operations, is described in [The Pattern Strip Module](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture#pattern-strip). Click _OK_ to confirm the configuration settings or _Cancel_ as applicable. The _Test_ button evaluates the search and displays the results in the Search Results window. ## Filtering by Pattern Name and Resizing Pattern Images Entering text into the _Filter…_ field hides in stages all patterns in the lower sections of the wizard with names not containing that text. The filter text may appear in any position within the pattern name, but must be continuous. **Example:** If the _Search Pattern_ action step contains patterns with the names House, House1, Mouse, and Mouse1, the search filter will find all images when use is entered, only House1 and Mouse1 when 1 is entered, and House and House1 in the case of H. ## Regular Patterns This section lists patterns that are to be found. The number of patterns that can be found is limited to 50. There are three ways of searching for patterns. **Match only one pattern** is successful if **exactly one** of the selected patterns is found in the _Search Area_. An error is returned if none or a number of the selected patterns are found. **Match one or more patterns** is successful if **at least one** of the selected patterns is found in the _Search Area_. An error is returned if none of the selected patterns are found. **Match all patterns** is successful if **all** of the selected patterns are found in the _Search Area_. An error is returned if none or not all of the selected patterns are found. If the option _Match all patterns_ is enabled, only the _Case_ branch for the image with top priority is carried out. In the graphical information that is the first search pattern and/or the top _Case_ in the list. If a pattern appears multiple times, a successful search will occur as above if _Allow multiple matches of a found pattern_ is enabled in the _Search Settings_. The action step will otherwise return an error if the same pattern appears multiple times. The order of the _Cases_ in the action step corresponds to the order of the search patterns in the wizard. The _Workflow_ continues with the steps for the first _Case_ that arises. Be sure to fill out the _DoElse_ block too. An empty _DoElse_ block causes an error when executed, resulting in the entire _Workflow_ being terminated. Patterns may be chosen from the _Pattern Gallery_ or created by means of a screenshot (_Capture_). Click to select one or multiple patterns and delete or move them as a group. When a pattern is selected, a white tick will appear on a green background in the top right corner. To undo the selection, click the _Clear Selection_ button. A vertical black line indicates where the pattern can be moved to using drag and drop. If _Match one or more patterns_ is selected the first pattern in the list will have a blue border. This image can be used as a reference point for other Action Steps as the Workflow progresses (see [Other Uses of Matched Patterns](#other-uses-of-matched-patterns)). ## Capture Pattern One way of defining a pattern is to take a screenshot that shows it. The function of the _Capture Pattern_ button is described in [Adding a Pattern from Screen Capture](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture#add-pattern-from-screen-capture) All patterns captured using the _Pattern Select_ action step are transferred to the _Workflow_'s _Pattern Gallery_. ## Add Pattern from Gallery If the _Pattern Gallery_ for the _Workflow_ already contains patterns, they can be added to the list of patterns for the action step. The _Select Patterns to add_ window shows all the images that the _Workflow_'s _Pattern Gallery_ contains. A white tick on a green background in the top right corner indicates patterns which are already included in the _Search Pattern_ action step. Patterns already included in another category of the same action step are not shown. To add patterns to the search, simply use the mouse to click and select. Use the same method to deselect patterns which should no longer be included in the search. Click OK to confirm the selection and add it to the pattern list for the action step. ## Ignore All Matches within These Patterns If checking for the single occurrence of a pattern that may be part of other patterns, you must exclude patterns containing the searched-for pattern within them from the search. The number of patterns that can be excluded is limited to 50. Example: Search for the word staff as a noun but only if it doesn’t form part of another term, e.g. 'staffing'. This pattern must be included in the green field among the patterns being searched for. Other patterns containing this term, e.g. staffing or staffed must be added here. Areas in a single color are not taken into account within the pattern. It is therefore not sufficient in the above example to capture staff with free space at the right edge, because this free space will not form part of the pattern being searched for due to a lack of _features_. ## Changing the Search Pattern Category The patterns selected can be moved between the categories _Regular_ and _Ignored_. Use the _Move to…_ button in the menu bar to do this. ## Search Settings The settings needed most frequently for all types of search can be set and modified using the _Search Pattern_ action step wizard under _Search Settings_. The _Required matching precision_ in percent is shown as a green zone on a slider. A yellow zone to the left of the green indicates the range that was entered in the _Properties_ under _Reduce Score by \[%\]_ to monitor criteria during the test in an advanced search. You can use either the general _Timeout_ or your own. If the option _Check whether found match stays in same location every \[time in ms\] milliseconds (Wait for Image Steady Timeout \[ms\]_ in the property pane) is enabled, it may make sense to choose a different _Timeout_ depending on this value. Because the repeated image search has to be completed in an interval defined here within the timeout, the recommended maximum interval value is ½\*_timeout_. _Move mouse to 0,0 while pattern search is active_ moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. The search area is displayed on the right side of the settings section. Click the button _Define manually_ to define the search area by drag&drop. The button _Define automatically_ automatically defines a search area containing all _regular_ matches visible at the time of the definition of the search area. The _ResetTo Full Screen_ button turns the search area back to full screen. The Search Area can be set to either a _fixed_ or dynamic (_relative_) position. To define a dynamic position, use the _Relative To_ picklist, which lists all variables of type _Coordinates_ that are available at this point; these include, for example, Outbound Variables from a previous _Search Pattern_ action step in the same transaction. When a coordinate is selected in the wizard as “Relative To”, an offset vector is immediately calculated. While the _Workflow_ is being designed, this points from the selected coordinate to the top-left corner of the _Search Area_. At _Workflow_ runtime, the calculated offset vector is applied to the real-time value of the _Search Area_ that the coordinate relates to. This means that the _Search Area_ at _Workflow_ runtime is positioned at exactly the same distance from the “Relative To” coordinate as at the time of design. The option to _Repeat search until nothing found_ repeats the image search until no more search patterns can be found or until it times out. One possible use is to close multiple dialog boxes which may be encountered in an unknown order and position. If the option to _Repeat search until nothing is found_ is enabled, the maximum _Timeout_ is less than double the time entered here. If multiple patterns are included and the first one is found within the timeout, the timeout period will be extended by the specified _Timeout_ once only. All other patterns must then be found within this remaining _Timeout_ period. Otherwise the program enters an error state and executes the _OnError Case_. The _Timeout_ is therefore adjusted to the duration of the steps that need to be completed within the _Cases_. If the Option to _Repeat search until nothing is found_ is enabled, the following is to be noted with regard to the various search options: - **Match only one patterns** Here only one of the images from the selection may be visible at any time. This option can be used if the patterns are layered on top of one another - **Match one or more patterns** Here any of the search images may appear - **Match all patterns** Here all images within the selection must be found For all modes, the following is applicable: - If multiple patterns are found the _Case_ branch is carried out for the image with top priority. In the graphical information that is the first search pattern and/ or the top _Case_ in the list. - If the option to _Allow multiple instances of a found pattern_ is enabled, the above priority is given and then the image that is located furthest to the left within the _Search Area_ is re-used. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. ## Test Pressing the _Test_ button will launch the search independently of _Workflow_ execution and open the _Search Results_ window where the search is evaluated. This can provide hints about possible improvements that could be made to the _Search Settings_. The screen content at the time the test was performed takes up the main part of the window _Search Result_. A blue border surrounds the _Search Area_. The area outside the _Search Area_ is shown grayed. _Matches_ are highlighted in color. The color legend at the right side of the window works simultaneously as a check box panel for switching the display of the different match types on and off. If there are no matches of a certain type, the according check box field is shown grayed. _Search Patterns_ of the list _Match all / only one / one or more pattern(s)_ found within the defined precision are highlighted green. Matches from the list _Ignore all matches within these patterns_ are highlighted light blue and matches from the list _Make sure none of these patterns appear_ are highlighted red. A yellow highlighting shows that the search pattern could have been found if the precision had been set lower. This reduced precision is calculated by deducting the _Reduced Score_ from the _Score._ In each case, the precision of the match is stated. Matches outside of the _Search Area_ are marked in gray color irrespective of their type. . Patterns with a _Color Spot_ that are found but do not match the _Color Spot_ color at a specific position are marked in blue. You can see the type of the match in the details pane on the right side of the window. On opening the window the size of the screenshot is adjusted so, that the whole screenshot is visible. You can zoom in to or out of the image by dragging the slider at the right side of the screenshot. It is also possible to do this by mouse wheel. Double click on the slider shows the image in its original size. If the image is enlarged, scroll bars for adjusting the position of the view appear on the right side and on the lower border of the image. Below the slider the current mouse position in relation to the screen shown in the screenshot is displayed dynamically. Mouse hover over a match shows the name, a thumbnail and the matching precision as a tooltip. Clicking a Match on the screenshot shows details to this Pattern on the right side of the window. Clicking a pattern in the tab _Pattern_ at the lower border of the window shows details to all matches to this pattern. Clicking a match in the screenshot only shows details for this single match. Details contain the name, type, size in pixels and a thumbnail of the pattern along with a color-marked listing of the found matches. For all matches, the coordinates of the upper left corner and the matching precision are displayed. The coloring is the same as described above. Clicking a match in the details pane toggles the highlighting of the according matches in the screenshot. Highlighting of a Match is indicated in the details pane by a colored border and the intensifying of its background color. Clicking a _Match_ in the details pane displays an animated arrow pointing to this match in the screenshot. In the process, the screenshot is resized so it can be seen in its entirety within the window. The tab _Search Results Summary_ shows a textual overview over the search settings and the search result. If the search failed because of one single pattern, this pattern is shown in tab _Failure Reason_. ## Other Uses of Matched Patterns If mouse clicks are to be performed relative to a matched image and, at the same time, the search is for more than one image, the image that the mouse clicks relate to must be at the top of the list. If the first image on the list is not found, the mouse click will be inserted relative to the first image from the list that is found. If the first image on the list that is found occurs multiple times, the image located on the far left of the screen will be used. If there are multiple images in the identical lateral position on the left, the topmost one will be used. Directly before editing the _Mouse click_ action step the reference pattern must be found by performing the _Test_ function for the _Pattern Select_ action step. Otherwise the previously found search pattern will always be used as the ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-pattern-gallery) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-search-pattern) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.6 --- # Ping > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ is used for sending a ping to a computer or network device. _Ping_ is useful to check if a particular machine is available on the network right at the start of a measurement _Workflow_. If not, it may be pointless to even try to continue the measurement.The response time measured provides a _Measurement Point_. The Action Step _Ping_ only supports IPv4. ## Properties **Invert Logic** If it is intentional that the destination host should be unreachable and you want to test this, you can invert the logic of the _Ping_ _Action Step_ by using this function. If the checkbox is selected, then an unsuccessful ping is considered to be the correct result. **Show message box** Defines if a message box with the measured response time should be displayed after the _Ping_ action is finished. **Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can change the number of _Pings_ sent by editing the value in the text field. The resulting response time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_ results in an error and the timer will be unavailable. **Destination Host** Enter the IP or hostname of the machine you want to ping. **ICMP Packet size** Defines the size of the data package that is used for the _Ping_. High values may create a lot of network traffic! **ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by exceeding the set ICMP timeout. **ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response from the destination host. **Ping delay \[ms\]** Pause time between _Ping_ retries. **Ping Threshold \[ms\]** Defines the allowed duration of a _Ping_ response. If the response exceeds this duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If _Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling. **Record Timer** If activated, the _Ping_ response time will be recorded like a _Timer_ or _Stopwatch_ and thus contribute to the reports in RPA Manager. **Timer Mode** When "Record Timer" is enabled and the _Ping_ is used in a loop, the following mode is for calculating the timer value: - **Last** The last time measured is saved - **Average** The script calculates an average of all times measured and saves it - **Min** The fastest time measured is saved - **Max** The slowest time measured is saved ## Inbound Variables **Suffix** can be used if the _Ping_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Ping_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. **Destination Host** Enter the IP or hostname of the machine you want to ping. **ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by exceeding the set ICMP timeout. **ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response from the destination host. **ICMP Packet size** Defines the size of the data package that is used for the _Ping_. **Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can change the number of _Pings_ sent by editing the value in the text field. The resulting response time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_ results in an error and the timer will be unavailable. **Ping Delay** Pause time between _Ping_ retries. **Ping Threshold** Defines the allowed duration of a _Ping_ response. If the response exceeds this duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If _Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling. ## Outbound Variables **Time** provides you the measured time. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Ping > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step is used for sending a ping to a computer or network device. _Ping_ is useful to check if a particular machine is available on the network right at the start of a measurement _Workflow_. If not, it may be pointless to even try to continue the measurement.The response time measured provides a _Measurement Point_. The action step _Ping_ only supports IPv4. ## Properties **Invert Logic** If it is intentional that the destination host should be unreachable and you want to test this, you can invert the logic of the _Ping_ action step by using this function. If the checkbox is selected, then an unsuccessful ping is considered to be the correct result. **Show message box** Defines if a message box with the measured response time should be displayed after the _Ping_ action is finished. **Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can change the number of _Pings_ sent by editing the value in the text field. The resulting response time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_ results in an error and the timer will be unavailable. **Destination Host** Enter the IP or hostname of the machine you want to ping. **ICMP Packet size** Defines the size of the data package that is used for the _Ping_. High values may create a lot of network traffic! **ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by exceeding the set ICMP timeout. **ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response from the destination host. **Ping delay \[ms\]** Pause time between _Ping_ retries. **Ping Threshold \[ms\]** Defines the allowed duration of a _Ping_ response. If the response exceeds this duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If _Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling. **Record Timer** If activated, the _Ping_ response time will be recorded like a _Timer_ or _Stopwatch_ and thus contribute to the reports in RPA Manager. **Timer Mode** When "Record Timer" is enabled and the _Ping_ is used in a loop, the following mode is for calculating the timer value: - **Last** The last time measured is saved - **Average** The script calculates an average of all times measured and saves it - **Min** The fastest time measured is saved - **Max** The slowest time measured is saved ## Inbound Variables **Suffix** can be used if the _Ping_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Ping_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. **Destination Host** Enter the IP or hostname of the machine you want to ping. **ICMP Retries** Number of times a single _Ping_ shall be repeated if a single _Ping_ failed by exceeding the set ICMP timeout. **ICMP Timeout** Defines the length of time after which _Ping_ should stop trying to get a response from the destination host. **ICMP Packet size** Defines the size of the data package that is used for the _Ping_. **Average over** If you want to use more than a single _Ping_ to evaluate the response time, you can change the number of _Pings_ sent by editing the value in the text field. The resulting response time will be calculated as the average of all attempts. If any of those attempts fails, the _Ping_ results in an error and the timer will be unavailable. **Ping Delay** Pause time between _Ping_ retries. **Ping Threshold** Defines the allowed duration of a _Ping_ response. If the response exceeds this duration, the _Ping_ is considered to have failed. This only works if _Invert Logic_ is off. If _Error handling_ is set to _Normal_, a failed _Ping_ will trigger the error handling. ## Outbound Variables **Time** provides you the measured time. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.6 --- # Queries with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Queries with AWS Action Step enables you to extract specific data from a document by specifying queries in natural language so that the response contains the data you need, without having to apply further filtering on the JSON output to get the relevant values. For example, if you are processing a credit card statement, you can specify queries such as: - "What is the customer name?" - "What is the credit card company name?" - "What is the account number?" - "What is the payment due date?" This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Alias text** - **Query text** - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is selected in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Json** The complete AWS response - **Normalized Json** The parsed result based on the normalized result and defined Json path - **First answer** A string containing the first result based on the specified query - **All answers** An array containing all results received as a response to the specified query - **Answers count** The number of matching answers to the specified query - **Confidence first answer** The confidence value of the first result as a floating point number. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/queries-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object - **File Settings** - **Directory path** The path to the directory where the file is located - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. - **Query Settings** - **Query text** Specifies the query to extract the data from the document The maximum length for this field is 200 characters. - **Alias text** Specifies an alias for the query, for ease of location The maximum length allowed for this field is 200 characters. - **The query results in…​ otherwise the action step results is…​** Specifies the behavior of the Action Step based on the result The first dropdown menu enables you to select the expected result of the query: **a single answer**, **one or more results**, or **multiple results**. If this selection matches the query result, the Action Step finishes successfully. When the expected result does not match the actual result from the query, the Action Step results either in **a warning** or **an error**, depending on the value configured in the second dropdown menu. - **Analyze Query** Enables you to test the configured query and see the results in the Wizard ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Best Practices for Queries](https://docs.aws.amazon.com/en_us/textract/latest/dg/bestqueries.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Queries with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Queries with AWS action step enables you to extract specific data from a document by specifying queries in natural language so that the response contains the data you need, without having to apply further filtering on the JSON output to get the relevant values. For example, if you are processing a credit card statement, you can specify queries such as: - "What is the customer name?" - "What is the credit card company name?" - "What is the account number?" - "What is the payment due date?" This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Alias text** - **Query text** - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is selected in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Json** The complete AWS response - **Normalized Json** The parsed result based on the normalized result and defined Json path - **First answer** A string containing the first result based on the specified query - **All answers** An array containing all results received as a response to the specified query - **Answers count** The number of matching answers to the specified query - **Confidence first answer** The confidence value of the first result as a floating point number. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/queries-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object - **File Settings** - **Directory path** The path to the directory where the file is located - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. - **Query Settings** - **Query text** Specifies the query to extract the data from the document The maximum length for this field is 200 characters. - **Alias text** Specifies an alias for the query, for ease of location The maximum length allowed for this field is 200 characters. - **The query results in…​ otherwise the action step results is…​** Specifies the behavior of the action step based on the result The first dropdown menu enables you to select the expected result of the query: **a single answer**, **one or more results**, or **multiple results**. If this selection matches the query result, the action step finishes successfully. When the expected result does not match the actual result from the query, the action step results either in **a warning** or **an error**, depending on the value configured in the second dropdown menu. - **Analyze Query** Enables you to test the configured query and see the results in the Wizard ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Best Practices for Queries](https://docs.aws.amazon.com/en_us/textract/latest/dg/bestqueries.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Read Clipboard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ simply copies the current clipboard content into a variable (see Section [Using Variables](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-variables)) for further usage within the _Workflow_. ## Properties **Clear Clipboard after reading** If activated, the clipboard will be cleared after it was read and saved into a variable **Copy to clipboard before reading** (Default: Disabled) If this property is enabled, the text currently selected will be copied to the clipboard before reading the contents of the buffer. The _CTRL+C_ command is used to copy the text. Please note that some text must be selected when this is executed. The content of the buffer is deleted before copying the selected text. If no text is selected, then the buffer will be empty, i.e. it will not contain any data that might otherwise have been stored there from a previous action. The _CTRL+C_ command takes a variable amount of time to perform the copy, depending on system load, so this _Action Step_ includes a _Timeout_. The buffer is checked every 250 ms to see if it contains any data. If it does, then the contents of the buffer are returned. If the buffer is empty, then the system will check for content after a further 250 ms. This process is repeated until the _Timeout_ has expired. Therefore, do not enter a value of 0 for the _Timeout_. This would result in the buffer being empty. ## Inbound Variables **Clear Clipboard after reading** Contains the information if the clipboard should be cleared after reading or not. ## Outbound Variables **ClipboardContent** The content of the clipboard. Note that this _Action Step_ will throw an error if the clipboard contains anything other than text (such as images, files, etc.). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read Clipboard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step simply copies the current clipboard content into a variable (see Section [Using Variables](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-variables)) for further usage within the _Workflow_. ## Properties **Clear Clipboard after reading** If activated, the clipboard will be cleared after it was read and saved into a variable **Copy to clipboard before reading** (Default: Disabled) If this property is enabled, the text currently selected will be copied to the clipboard before reading the contents of the buffer. The _CTRL+C_ command is used to copy the text. Please note that some text must be selected when this is executed. The content of the buffer is deleted before copying the selected text. If no text is selected, then the buffer will be empty, i.e. it will not contain any data that might otherwise have been stored there from a previous action. The _CTRL+C_ command takes a variable amount of time to perform the copy, depending on system load, so this action step includes a _Timeout_. The buffer is checked every 250 ms to see if it contains any data. If it does, then the contents of the buffer are returned. If the buffer is empty, then the system will check for content after a further 250 ms. This process is repeated until the _Timeout_ has expired. Therefore, do not enter a value of 0 for the _Timeout_. This would result in the buffer being empty. ## Inbound Variables **Clear Clipboard after reading** Contains the information if the clipboard should be cleared after reading or not. ## Outbound Variables **ClipboardContent** The content of the clipboard. Note that this action step will throw an error if the clipboard contains anything other than text (such as images, files, etc.). --- product: RPA Builder version: 6.6 --- # Read from Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read from Array_ Action Step is used to access the content of an array. You can either return a value at a certain point in the array via an index or return the whole array as text. In the latter case, all values are listed as comma separated values. The _Read from Array_ Action Step provides the read values from the array automatically as various data types. You can decide later in the Workflow which data type you wish to use. ## Properties **Get entire array as CSV** (Bool, default: false) If active, the whole array is returned as a string in CSV format (comma separated values). **Index to read at**\*(integer, > 0, default: 1) Position within the array where the content of the array is to be read from. Indexing starts at 1. Please make sure that the index entered is not greater than the total number of all elements within the array. ## Inbound Variables **Array to read from** (Array) The array that is to be read from. The drop-down _Array to read from_ list contains all the arrays that have been created in the Workflow so far. These can be _Workflow Based Variables_ or return arrays from the _Read from Excel File_ Action Step. **Index to read at**\*(integer, > 0, default: 1) Position within the array where the content of the array is to be read from. Indexing starts at 1. ## Outbound Variables The _Read from Array_Action Step automatically supplies four different return values. Each one represents one of the possible data types. Depending on what you want to use the data for, you will take a different data type. In a _Keystroke_, for example, you will use the data type _AsString_, or if it concerns a number that you want to use to manage how often a _Loop_ is repeated, use the data type _AsInt_: - **Read from Array.AsString** (string) Return value as text - **Read from Array.AsInt** (int) Return value as a whole number - **Read from Array.AsDouble** (double) Return value as a floating-point number - **Read from Array.AsBool** (bool) Return value as a Boolean value Please make sure that the content of the value read from the array is compatible with the desired data type. For example, a character string such as "abc" cannot be converted into a meaningful integer number. If you want to use the return value from the Read from Array Action Step in another in Action Step, a pre-selection will be made for you as to which data types can meaningfully be used at this point. The following table provides an overview of the result of converting the data types:
From / toStringIntDoubleBool

String

unchanged

0

0

The strings True and true and all positive numbers > 0 are True; all others give False

Int

unchanged

unchanged

unchanged

If Int ⇐0, false; if Int >= 0 true

Double

unchanged

The decimal places are truncated

unchanged

If Double ⇐0, false; if Double >= 0 true

Bool

unchanged

0

0

unchanged

Each row refers to an outbound data type, each column to the result of converting to the data type in the column header. ## Wizard The drop-down _Array to read from_ list contains all the arrays that have been created in the Workflow so far. These can be _Workflow Based Variables_ or return arrays from the _Read from Excel File_ Action Step. If you select the checkbox _Get entire array as comma separated values_, the whole array will be returned as a string. The individual values will, of course, be separated by commas. The text field _Index to read at_ and its content are deactivated in this case. The _Index to read at_ denotes the position within an array from which the content of the array is to be read. The first element has the index 1. The index can also be mapped to a variable. Simply click on the Pin symbol and select a suitable variable from the list. If you subsequently wish to set the variable manually, click on the Pin symbol again and select None. You can then enter a value manually in the input field. The input field and its content are deactivated if the checkbox above it is selected. ## Example For a detailed example, please refer to the description of the _Get Array Count_ Action Step. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read from Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read from Array_ action step is used to access the content of an array. You can either return a value at a certain point in the array via an index or return the whole array as text. In the latter case, all values are listed as comma separated values. The _Read from Array_ action step provides the read values from the array automatically as various data types. You can decide later in the Workflow which data type you wish to use. ## Properties **Get entire array as CSV** (Bool, default: false) If active, the whole array is returned as a string in CSV format (comma separated values). **Index to read at**\*(integer, > 0, default: 1) Position within the array where the content of the array is to be read from. Indexing starts at 1. Please make sure that the index entered is not greater than the total number of all elements within the array. ## Inbound Variables **Array to read from** (Array) The array that is to be read from. The drop-down _Array to read from_ list contains all the arrays that have been created in the Workflow so far. These can be _Workflow Based Variables_ or return arrays from the _Read from Excel File_ action step. **Index to read at**\*(integer, > 0, default: 1) Position within the array where the content of the array is to be read from. Indexing starts at 1. ## Outbound Variables The _Read from Array_ action step automatically supplies four different return values. Each one represents one of the possible data types. Depending on what you want to use the data for, you will take a different data type. In a _Keystroke_, for example, you will use the data type _AsString_, or if it concerns a number that you want to use to manage how often a _Loop_ is repeated, use the data type _AsInt_: - **Read from Array.AsString** (string) Return value as text - **Read from Array.AsInt** (int) Return value as a whole number - **Read from Array.AsDouble** (double) Return value as a floating-point number - **Read from Array.AsBool** (bool) Return value as a Boolean value Please make sure that the content of the value read from the array is compatible with the desired data type. For example, a character string such as "abc" cannot be converted into a meaningful integer number. If you want to use the return value from the Read from Array action step in another in action step, a pre-selection will be made for you as to which data types can meaningfully be used at this point. The following table provides an overview of the result of converting the data types:
From / toStringIntDoubleBool

String

unchanged

0

0

The strings True and true and all positive numbers > 0 are True; all others give False

Int

unchanged

unchanged

unchanged

If Int ⇐0, false; if Int >= 0 true

Double

unchanged

The decimal places are truncated

unchanged

If Double ⇐0, false; if Double >= 0 true

Bool

unchanged

0

0

unchanged

Each row refers to an outbound data type, each column to the result of converting to the data type in the column header. ## Wizard The drop-down _Array to read from_ list contains all the arrays that have been created in the Workflow so far. These can be _Workflow Based Variables_ or return arrays from the _Read from Excel File_ action step. If you select the checkbox _Get entire array as comma separated values_, the whole array will be returned as a string. The individual values will, of course, be separated by commas. The text field _Index to read at_ and its content are deactivated in this case. The _Index to read at_ denotes the position within an array from which the content of the array is to be read. The first element has the index 1. The index can also be mapped to a variable. Simply click on the Pin symbol and select a suitable variable from the list. If you subsequently wish to set the variable manually, click on the Pin symbol again and select None. You can then enter a value manually in the input field. The input field and its content are deactivated if the checkbox above it is selected. ## Example For a detailed example, please refer to the description of the _Get Array Count_ action step. --- product: RPA Builder version: 6.6 --- # Read from Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Read from Excel File_ Action Step to read the contents of an Excel file. The result will be saved as a string or an array, which you can then use as an Outbound Variable in subsequent Action Steps. The _Read from Excel File_ Action Step can only be used inside an Excel Session. Specify the source file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session). ## Properties **Excel Operation Settings** - **Column** Specifies the column to read. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. For example, instead of A for column A, you can enter a 1 for column A, a 2 for column B (instead of the letter B), and so on. - **Range** Specifies the read mode to use: - **Cell** Reads text from a specific cell and outputs the result as a string. - **Row** Reads text from a complete row and outputs the result as an array. - **Column** Reads text from a complete column and outputs the result as an array. - **Row** Specifies the cell or row number to read. - **Sheet name** Name of the spreadsheet. Under Properties you can only enter the name directly, unlike in the [Wizard](#wizard). **Troubleshooting settings** - **Disable recalculation of date formulas** Disables the recalculation of cell values formatted as DateTime to prevent RPA Builder from becoming unresponsive while it finishes calculating formulas that contain many dependencies. ## Inbound Variables **Sheet name** Name of the spreadsheet. **Column** This is where you enter the column that is to be read. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. **Row** This is where you enter the cell or row number that should be read. ## Outbound Variables **Read from Excel File.Result** This variable is output as a string. The result will only be shown to you if you have selected the _Cell_ mode. If you have selected _Row_ or _Column_ mode, an error message will be displayed and the Workflow cannot be executed. **Read from Excel File.ResultAsArray** This variable will be output as an array if you have selected Column or Row as the mode. **Read from Excel File.HasContent** (Bool) This is how you check whether a specific cell, row or column has content. If there is content, the result will be _True_ and if there is no content the result will be _False_. If in the case of rows or columns only a single cell is populated, the result is _True_. ## Wizard The **Sheet name** field is for selecting the spreadsheet from which text should be read. You can type directly into the input field, select an existing sheet from the drop-down list or connect with a Pin Variable. The drop-down lists contains all the sheets saved within the Excel file. In **Excel Mode** you specify via the drop-down list whether to read a cell, a row or an entire column. You can enter letters or numbers as a value or connect with a Pin Variable. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read from Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Read from Excel File_ action step to read the contents of an Excel file. The result will be saved as a string or an array, which you can then use as an Outbound Variable in subsequent action steps. The _Read from Excel File_ action step can only be used inside an Excel Session. Specify the source file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session). ## Properties **Excel Operation Settings** - **Column** Specifies the column to read. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. For example, instead of A for column A, you can enter a 1 for column A, a 2 for column B (instead of the letter B), and so on. - **Range** Specifies the read mode to use: - **Cell** Reads text from a specific cell and outputs the result as a string. - **Row** Reads text from a complete row and outputs the result as an array. - **Column** Reads text from a complete column and outputs the result as an array. - **Row** Specifies the cell or row number to read. - **Sheet name** Name of the spreadsheet. Under Properties you can only enter the name directly, unlike in the [Wizard](#wizard). **Troubleshooting settings** - **Disable recalculation of date formulas** Disables the recalculation of cell values formatted as DateTime to prevent RPA Builder from becoming unresponsive while it finishes calculating formulas that contain many dependencies. ## Inbound Variables **Sheet name** Name of the spreadsheet. **Column** This is where you enter the column that is to be read. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. **Row** This is where you enter the cell or row number that should be read. ## Outbound Variables **Read from Excel File.Result** This variable is output as a string. The result will only be shown to you if you have selected the _Cell_ mode. If you have selected _Row_ or _Column_ mode, an error message will be displayed and the Workflow cannot be executed. **Read from Excel File.ResultAsArray** This variable will be output as an array if you have selected Column or Row as the mode. **Read from Excel File.HasContent** (Bool) This is how you check whether a specific cell, row or column has content. If there is content, the result will be _True_ and if there is no content the result will be _False_. If in the case of rows or columns only a single cell is populated, the result is _True_. ## Wizard The **Sheet name** field is for selecting the spreadsheet from which text should be read. You can type directly into the input field, select an existing sheet from the drop-down list or connect with a Pin Variable. The drop-down lists contains all the sheets saved within the Excel file. In **Excel Mode** you specify via the drop-down list whether to read a cell, a row or an entire column. You can enter letters or numbers as a value or connect with a Pin Variable. --- product: RPA Builder version: 6.6 --- # Read from Text File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read from Text File_ Action Step allows you to read from a text file and you use the _Read_ _Mode_ to specify which part of the file is to be read. The button in the Workflow shows the _Read Mode_ that is presently active in brackets after the name of the Action Step (in the example above: WholeFile). There is an option to determine whether the text should be deleted after reading. To achieve a correct result, the text file to be read has to be UTF-8 encoded. ## Properties **File Operation Settings:** - **Delete line(s) after read** Specify whether the text should be deleted after it is read. - **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File name** Enter the name here of the file that is to be read. - **Line count** Enter the number of lines to be read. This option can be used if you have specified that more than one line (_Range of lines_) should be read in _Read file check mode_. - **Number of first or Single Line** Specify the number of lines that are to be read here. If you have selected more than one line to be read in _Read file check mode_, i.e. a _Range of lines_, this is where you select the line number at which to start reading. The first line in a text file is line number 1! - **Read file check mode** Use _Read file_ _check mode_ to specify which part of the file is to be read: - **Read whole file** The whole file will be read. - **Last line** Only the last, most recent line of the file will be read. - **Single line** Only a single line will be read (please also note the setting **Number of first or single line**). - **Range of lines** A set of lines will be read (please also note the setting **Number of first or single line**). - **Read to end** Specify whether to read to the end of the file. This option can be used if you have specified that more than one line (_Range of lines_) should be read in _Read file check mode_. The advantage of this option compared to the _Line count_ option is that you do not have to define how many lines are to be read when in _Range of lines_ mode. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. ## Outbound Variables **Read text** The _Read from Text File.Read text_ variable provides the selected read mode (_Read file check mode_). **IsRead** The _Read from Text File.IsRead_ variable indicates whether the file could be read or not (True/False). **Line Count**  The _Read from Text File.Line Count_ variable provides the number of lines that are to be read. **File name** The _Read from Text File.File Name_ variable provides the name of the file that is to be read. **Directory path** The _Read from Text File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be read. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name here of the file that is to be read. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Read mode** Use _Read_ _mode_ to specify which part of the file is to be read. Other fields will be shown depending on the chosen setting: - **Entire file** The whole file will be read. - **Last line** Only the last, most recent line of the file will be read. - **Single line** Only a single line will be read. Enter the line number of the line that is to be read in the **Line Number** field. - **Range of lines** A range of lines will be read. Enter the line number of the first line that is to be read in the **First line to read** field. Enter the number of lines that is to be read in the **Line count** field. Use the option **Read to end of file** to specify that reading is to occur until the end of the file. The advantage of this option compared to the _Line count_ detail is that you do not have to define the number of lines that is to be read. The first line in a text file is line number 1! - **Remove line(s) after read** Specify here whether the text should be deleted after it is read. - **Encoding** The encoding of the file to read. Includes Shift-JIS and EUC-JP for Japanese support. Specify a valid encoding type if the one you need is not in the list. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read from Text File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read from Text File_ action step allows you to read from a text file and you use the _Read_ _Mode_ to specify which part of the file is to be read. The button in the Workflow shows the _Read Mode_ that is presently active in brackets after the name of the action step (in the example above: WholeFile). There is an option to determine whether the text should be deleted after reading. To achieve a correct result, the text file to be read has to be UTF-8 encoded. ## Properties **File Operation Settings:** - **Delete line(s) after read** Specify whether the text should be deleted after it is read. - **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. - **File name** Enter the name here of the file that is to be read. - **Line count** Enter the number of lines to be read. This option can be used if you have specified that more than one line (_Range of lines_) should be read in _Read file check mode_. - **Number of first or Single Line** Specify the number of lines that are to be read here. If you have selected more than one line to be read in _Read file check mode_, i.e. a _Range of lines_, this is where you select the line number at which to start reading. The first line in a text file is line number 1! - **Read file check mode** Use _Read file_ _check mode_ to specify which part of the file is to be read: - **Read whole file** The whole file will be read. - **Last line** Only the last, most recent line of the file will be read. - **Single line** Only a single line will be read (please also note the setting **Number of first or single line**). - **Range of lines** A set of lines will be read (please also note the setting **Number of first or single line**). - **Read to end** Specify whether to read to the end of the file. This option can be used if you have specified that more than one line (_Range of lines_) should be read in _Read file check mode_. The advantage of this option compared to the _Line count_ option is that you do not have to define how many lines are to be read when in _Range of lines_ mode. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. **Directory path** Enter the path to the directory where the file to be read is stored. You can specify an absolute or relative path. If a relative path is used, then the path relates to the _Base Path_ variable. ## Outbound Variables **Read text** The _Read from Text File.Read text_ variable provides the selected read mode (_Read file check mode_). **IsRead** The _Read from Text File.IsRead_ variable indicates whether the file could be read or not (True/False). **Line Count**  The _Read from Text File.Line Count_ variable provides the number of lines that are to be read. **File name** The _Read from Text File.File Name_ variable provides the name of the file that is to be read. **Directory path** The _Read from Text File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be read. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name here of the file that is to be read. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Read mode** Use _Read_ _mode_ to specify which part of the file is to be read. Other fields will be shown depending on the chosen setting: - **Entire file** The whole file will be read. - **Last line** Only the last, most recent line of the file will be read. - **Single line** Only a single line will be read. Enter the line number of the line that is to be read in the **Line Number** field. - **Range of lines** A range of lines will be read. Enter the line number of the first line that is to be read in the **First line to read** field. Enter the number of lines that is to be read in the **Line count** field. Use the option **Read to end of file** to specify that reading is to occur until the end of the file. The advantage of this option compared to the _Line count_ detail is that you do not have to define the number of lines that is to be read. The first line in a text file is line number 1! - **Remove line(s) after read** Specify here whether the text should be deleted after it is read. - **Encoding** The encoding of the file to read. Includes Shift-JIS and EUC-JP for Japanese support. Specify a valid encoding type if the one you need is not in the list. --- product: RPA Builder version: 6.6 --- # Read Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Read Mail_ action step, to read the mails from a mailbox. You can restrict the results using the filter function to simplify the search. All the contents of the read mail become available as outbound variables. This action step works similarly to the Excel Controlled Loop and bundles other action steps, which enable you to further process the mails. Read Mail works only within a Mail Session, where you specify the information required for the connection to the mail server. The following filter functions are available: - Body - Mail info - Read/ Unread - Recipient (To:) - Recipient (Cc:) - Sender - Subject - Text Search Read Mail supports the following encodings: UTF-8, UTF-16, Shift-JIS, and EUC-JP. ## Properties **Read Mail Settings** **Attachment folder path** Path to the folder in which the attachments of the mails are saved. **Body** Text to be contained in the body of the mail. **Create attachment folder** If a checkmark is set here, a folder is created if it did not already exist. In this folder, the attachments from the mails are saved. **Folder name** Name for the folder that is specified in the Read Mail action step under _Inbox Folder Name_. You should ensure that the folder really exists in the mailbox you specified in the Mail Session. If you have selected the IMAP protocol in the Mail Session and you wish to call up a subfolder of the inbox, you must always specify the complete path under Folder Name, e.g. Inbox/MuleSoft/Alerts. If the folder MuleSoft is on the same level as the _Inbox_, then MuleSoft/Alerts would be sufficient as the path name. Regardless of the language configured in your Outlook version, with IMAP, the path must always begin with `Inbox`. POP3, however, does not support the folder structure in the inbox so you cannot specify a folder there. **Mail info** The ID of a specific mail that originates from a different Read Mail action step and can be incorporated here as an inbound variable. **Maximum emails to read** Displays the number of mails to be read. You can read up to 99 mails. **Read** Only those mails that have already been read are displayed. **Recipient (Cc:)** The recipient address is sought in the Cc. **Recipient (To:)** The recipient address is sought. **Save attachments** If the checkbox is selected, the attachments of the mails that were found are saved in the specified folder. A separate folder is generated for each mail. The path to this subfolder is available as an outbound variable. **Sender** The entered text is to be contained in the sender address. **Sort mode** (Default: Newest first) Specifies the order in which the found mails are sorted. You can choose between Newest first and Oldest first. **Subject** Here, the text is sought only in the subject of the mail. **Text search** This text is sought in the entire mail. **Unread** Only unread mails are displayed. ## Inbound Variables **Folder name** Name for the folder that is specified in the Read Mail action step under _Inbox Folder Name_. **Body** Text to be contained in the body of the mail. **Mail info** The ID of a specific mail that originates from a different Read Mail action step and can be incorporated here as an inbound variable. **Recipient (To:)** The recipient address is sought. **Recipient (Cc:)** The recipient address is sought in the Cc. **Sender** The entered text is to be contained in the sender address. **Subject** Here, the text is sought only in the subject of the mail. **Text search** This text is sought in the entire mail. **Maximum emails to read** Displays the number of mails to be read. You can read up to 99 mails. **Attachment folder path** Path to the folder in which the attachments of the mails are saved. ## Outbound Variables **IsSucceeded** Indicates whether filtering of the mails was successful. **Sender** Specifies the sender of the current iterated mail. **Recipients** Specifies the recipient of the current iterated mail. **Cc** Specifies the Carbon Copy recipient of the current iterated mail. **Subject** Specifies the subject of the current iterated mail. **BodyText** Specifies the HTML text body of the current iterated mail. If this is not available, only the text of the mail is specified. **AttachmentsLocalFolder** Specifies the current subfolder for the attachments of the current iterated mail. **Date** Specifies the receipt date of the current iterated mail. **MailCount** Indicates how many mails were found in total. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Read Mail_ action step, to read the mails from a mailbox. You can restrict the results using the filter function to simplify the search. All the contents of the read mail become available as outbound variables. This action step works similarly to the Excel Controlled Loop and bundles other action steps, which enable you to further process the mails. Read Mail works only within a Mail Session, where you specify the information required for the connection to the mail server. The following filter functions are available: - Body - Mail info - Read/ Unread - Recipient (To:) - Recipient (Cc:) - Sender - Subject - Text Search Read Mail supports the following encodings: UTF-8, UTF-16, Shift-JIS, and EUC-JP. ## Properties **Read Mail Settings** **Attachment folder path** Path to the folder in which the attachments of the mails are saved. **Body** Text to be contained in the body of the mail. **Create attachment folder** If a checkmark is set here, a folder is created if it did not already exist. In this folder, the attachments from the mails are saved. **Folder name** Name for the folder that is specified in the Read Mail action step under _Inbox Folder Name_. You should ensure that the folder really exists in the mailbox you specified in the Mail Session. If you have selected the IMAP protocol in the Mail Session and you wish to call up a subfolder of the inbox, you must always specify the complete path under Folder Name, e.g. Inbox/MuleSoft/Alerts. If the folder MuleSoft is on the same level as the _Inbox_, then MuleSoft/Alerts would be sufficient as the path name. Regardless of the language configured in your Outlook version, with IMAP, the path must always begin with `Inbox`. POP3, however, does not support the folder structure in the inbox so you cannot specify a folder there. **Mail info** The ID of a specific mail that originates from a different Read Mail action step and can be incorporated here as an inbound variable. **Maximum emails to read** Displays the number of mails to be read. You can read up to 99 mails. **Read** Only those mails that have already been read are displayed. **Recipient (Cc:)** The recipient address is sought in the Cc. **Recipient (To:)** The recipient address is sought. **Save attachments** If the checkbox is selected, the attachments of the mails that were found are saved in the specified folder. A separate folder is generated for each mail. The path to this subfolder is available as an outbound variable. **Sender** The entered text is to be contained in the sender address. **Sort mode** (Default: Newest first) Specifies the order in which the found mails are sorted. You can choose between Newest first and Oldest first. **Subject** Here, the text is sought only in the subject of the mail. **Text search** This text is sought in the entire mail. **Unread** Only unread mails are displayed. ## Inbound Variables **Folder name** Name for the folder that is specified in the Read Mail action step under _Inbox Folder Name_. **Body** Text to be contained in the body of the mail. **Mail info** The ID of a specific mail that originates from a different Read Mail action step and can be incorporated here as an inbound variable. **Recipient (To:)** The recipient address is sought. **Recipient (Cc:)** The recipient address is sought in the Cc. **Sender** The entered text is to be contained in the sender address. **Subject** Here, the text is sought only in the subject of the mail. **Text search** This text is sought in the entire mail. **Maximum emails to read** Displays the number of mails to be read. You can read up to 99 mails. **Attachment folder path** Path to the folder in which the attachments of the mails are saved. ## Outbound Variables **IsSucceeded** Indicates whether filtering of the mails was successful. **Sender** Specifies the sender of the current iterated mail. **Recipients** Specifies the recipient of the current iterated mail. **Cc** Specifies the Carbon Copy recipient of the current iterated mail. **Subject** Specifies the subject of the current iterated mail. **BodyText** Specifies the HTML text body of the current iterated mail. If this is not available, only the text of the mail is specified. **AttachmentsLocalFolder** Specifies the current subfolder for the attachments of the current iterated mail. **Date** Specifies the receipt date of the current iterated mail. **MailCount** Indicates how many mails were found in total. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.6 --- # Read PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the _Read PDF File_ Action Step, you can read text from a PDF file. ## Properties - **File Settings** - **Directory Path** (String): Path to the folder in which the PDF file is located. - **File Name** (String): Name of the PDF file. - **Password protected** (Boolean): Select this option if the PDF file is password protected. - **Read Mode** - **Read form field data and annotations**: Select this option to read data from form fields and annotations in the PDF file. - **Read Mode**: Read mode for the PDF document. Available modes: **Read entire file**, **Read page range**, and **Read text in selected area**. - **Read text from page** (Integer): Read the file starting from this page. - **Read text to page** (Integer): Read the file up to this page. - **Read to end of file** (Boolean): Read until the end of the file. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** ## Outbound Variables - **ReadText** (String): The content of the text that is read. - **Form field data** (JSON): The form field data extracted from the file as key-value pairs. - **Annotations** (String): The annotations extracted from the file. ## Wizard The wizard is split into two areas **File Settings** and **Read Mode**. In the **File Settings**, you specify the path to the folder in which the file is located and the name of the file. In the **Read Mode** area, there are various modes available for reading a PDF file: - With **Read entire file**, the entire text of the document is read. - With **Read page range**, you can specify a specific range that is to be read. If the option **Read to end file** is selected, the PDF is read to the end. - With **Read text in selected area**, you can read the text from a selected area in the document. For this, you must select a PDF file under File Settings. Then click on **Define Area** and the PDF is opened in a separate window. Here you can select the required area using the mouse. When you have selected the area, close the window with _Save_. If you have selected an area to be read with one of the various Read Modes, you can use the **Test button** at the bottom right of the wizard in the Action Step to display the result. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read PDF File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the _Read PDF File_ action step, you can read text from a PDF file. ## Properties - **File Settings** - **Directory Path** (String): Path to the folder in which the PDF file is located. - **File Name** (String): Name of the PDF file. - **Password protected** (Boolean): Select this option if the PDF file is password protected. - **Read Mode** - **Read form field data and annotations**: Select this option to read data from form fields and annotations in the PDF file. - **Read Mode**: Read mode for the PDF document. Available modes: **Read entire file**, **Read page range**, and **Read text in selected area**. - **Read text from page** (Integer): Read the file starting from this page. - **Read text to page** (Integer): Read the file up to this page. - **Read to end of file** (Boolean): Read until the end of the file. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** ## Outbound Variables - **ReadText** (String): The content of the text that is read. - **Form field data** (JSON): The form field data extracted from the file as key-value pairs. - **Annotations** (String): The annotations extracted from the file. ## Wizard The wizard is split into two areas **File Settings** and **Read Mode**. In the **File Settings**, you specify the path to the folder in which the file is located and the name of the file. In the **Read Mode** area, there are various modes available for reading a PDF file: - With **Read entire file**, the entire text of the document is read. - With **Read page range**, you can specify a specific range that is to be read. If the option **Read to end file** is selected, the PDF is read to the end. - With **Read text in selected area**, you can read the text from a selected area in the document. For this, you must select a PDF file under File Settings. Then click on **Define Area** and the PDF is opened in a separate window. Here you can select the required area using the mouse. When you have selected the area, close the window with _Save_. If you have selected an area to be read with one of the various Read Modes, you can use the **Test button** at the bottom right of the wizard in the action step to display the result. --- product: RPA Builder version: 6.6 --- # Read Text from App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read Text From App Element_ Action Step lets you read the text from a selected App Element. The extracted text is then available for further processing as an outbound variable. ## Properties The _Read Text from App Element_ Action Step does not have any special properties. ## Inbound Variables - **XPath to Element** - **Window Title** ## Outbound Variables - **Read Text** Outputs the text that was read by the Action Step. - **Has Content** Indicates whether the extracted text has content (`true`) or is blank (`false`). ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-app-automation#app-automation-common-properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Read Text from App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Read Text From App Element_ action step lets you read the text from a selected App Element. The extracted text is then available for further processing as an outbound variable. ## Properties The _Read Text from App Element_ action step does not have any special properties. ## Inbound Variables - **XPath to Element** - **Window Title** ## Outbound Variables - **Read Text** Outputs the text that was read by the action step. - **Has Content** Indicates whether the extracted text has content (`true`) or is blank (`false`). ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation#app-automation-common-properties). --- product: RPA Builder version: 6.6 --- # Recalculate Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Recalculate Excel File Action Step can be used to recalculate an Excel sheet. If a value has subsequently changed, the values in the Excel sheet are updated. To be able to continue working with the new values, they must be read out again with the _Read from Excel File_ Action Step. With the Action Step Recalculate Excel File you can determine exactly where a recalculation should take place in the Workflow. The recalculation is documented in the Workflow Run Results. The _Read from Excel File_ Action Step can only be used inside an Excel Session. Specify the source and destination file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session). Please note the operation mode that you have selected in the Excel session: - **Read and write to the same file** The recalculation is performed on the selected Excel sheet. - **Read from source and write to different file** The recalculation is only performed in the selected destination file. - **Read only** The Action Step cannot be executed in Read only mode. ## Properties **Excel Operation Settings** - **Sheet name** Name of the spreadsheet. In the properties, you can only enter the name directly. In the wizard, however, you can select the spreadsheet directly or via the pin variable. ## Inbound Variables - **Sheet name** Name of the spreadsheet. In the properties, you can only enter the name directly. In the wizard, however, you can select the spreadsheet directly or via the pin variable. **Apply calculation to** Here you specify which part of the Excel file is to be included in the recalculation. - **Whole Workbook** (default) The entire workbook is recalculated. - Or you can select a specific spreadsheet from the list. ## Outbound Variables The Action Step _Recalculate Excel File_ possesses no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Recalculate Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Recalculate Excel File action step can be used to recalculate an Excel sheet. If a value has subsequently changed, the values in the Excel sheet are updated. To be able to continue working with the new values, they must be read out again with the _Read from Excel File_ action step. With the action step Recalculate Excel File you can determine exactly where a recalculation should take place in the Workflow. The recalculation is documented in the Workflow Run Results. The _Read from Excel File_ action step can only be used inside an Excel Session. Specify the source and destination file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session). Please note the operation mode that you have selected in the Excel session: - **Read and write to the same file** The recalculation is performed on the selected Excel sheet. - **Read from source and write to different file** The recalculation is only performed in the selected destination file. - **Read only** The action step cannot be executed in Read only mode. ## Properties **Excel Operation Settings** - **Sheet name** Name of the spreadsheet. In the properties, you can only enter the name directly. In the wizard, however, you can select the spreadsheet directly or via the pin variable. ## Inbound Variables - **Sheet name** Name of the spreadsheet. In the properties, you can only enter the name directly. In the wizard, however, you can select the spreadsheet directly or via the pin variable. **Apply calculation to** Here you specify which part of the Excel file is to be included in the recalculation. - **Whole Workbook** (default) The entire workbook is recalculated. - Or you can select a specific spreadsheet from the list. ## Outbound Variables The action step _Recalculate Excel File_ possesses no outbound variables. --- product: RPA Builder version: 6.6 --- # Regex Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following are some examples of using Regular Expressions. ## Example 1: Identifying an Exact Window Title Action Steps identify window titles without using regular expressions if the given string can be found in its entirety in an existing window title. It does not matter if there are any preceding or following characters. Sometimes an application opens two different windows where the title of one is contained in the other. A typical example is _SAP_, where you log on to a system with the _SAP Logon_ application. In this case you will have these two windows on your desktop: ![Example SAP - two windows](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-examples-image1.png) The usual way of identifying a window by searching for a part of its title will not work, since a search for the text "SAP" in the window title would return two valid results. In this case, best practice is to enable the _Use Regex_ function and only allow exact matches for window titles. You can do this using the following pattern _^\[exact\_window\_name\]$_ For this specific example the regular expression would look like this: ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-examples-image2.png) The _^_ indicates that the expression starts here, there must be no preceding characters. The _$_ indicates that the end of the expression is the last character before the _$_. ## Example 2: Identifying Window Titles with Dynamic Beginning, Middle, and End Components Some applications first state their own name in the window title, followed by a dynamic component, such as a session or user ID, and then a module name or similar at the end. Sometimes a _Workflow_ opens more than one application and uses more than one module within an application. If it is necessary to check for the correct use of a module in an application, you might need to identify a window title that is not consistently the same, but rather is separated by dynamic parts. One such application is _Microsoft Dynamics AX_. ![Example for Microsoft Dynamics AX](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-examples-image3.png) If you need to identify a "Dynamics AX" window that contains the text "cfu" near the end of the title, you can use the following regular expression: ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-examples-image4.png) Using _.\*_ allows there to be any number of alphanumeric characters before the term "Dynamics AX", thereby accounting for the word "Microsoft". Using the same method, the example allows there to be a string of any length between "Dynamics AX" and "cfu". How does this work? The _._ stands for exactly one alphanumeric character, excluding newline. The _\*_ is a quantifier that tells the software processing the regular expression that the previous character may repeat indefinitely. Thus the single _._ at the end before the closing _$_ indicates that there has to be exactly one alphanumeric character (excluding newline) present. ## Example 3: Making a Window Title Search Case Insensitive/Use of Environment Variables Some window titles might include components such as the name of the logged-in user. It is a good idea to use the environment variable _%Username%_ to identify the window at runtime so the _Workflow_ does not have to be changed if the user changes (or if the user is random in the first place). It might happen that the username in the application uses upper case, but the environment variable returns lower case, for example "User" and "user". If you want to identify the window title by using the environment variable you have to make sure the case does not matter. You achieve this by using _(?i)_ at the start of your regular expression. ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-examples-image5.png) This regular expression would find a window title like "Document user.txt – Editor". ## See Also - [Testing Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions-testing-regular-expression) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Regex Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following are some examples of using Regular Expressions. ## Example 1: Identifying an Exact Window Title Action steps identify window titles without using regular expressions if the given string can be found in its entirety in an existing window title. It does not matter if there are any preceding or following characters. Sometimes an application opens two different windows where the title of one is contained in the other. A typical example is _SAP_, where you log on to a system with the _SAP Logon_ application. In this case you will have these two windows on your desktop: ![Example SAP - two windows](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-examples-image1.png) The usual way of identifying a window by searching for a part of its title will not work, since a search for the text "SAP" in the window title would return two valid results. In this case, best practice is to enable the _Use Regex_ function and only allow exact matches for window titles. You can do this using the following pattern _^\[exact\_window\_name\]$_ For this specific example the regular expression would look like this: ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-examples-image2.png) The _^_ indicates that the expression starts here, there must be no preceding characters. The _$_ indicates that the end of the expression is the last character before the _$_. ## Example 2: Identifying Window Titles with Dynamic Beginning, Middle, and End Components Some applications first state their own name in the window title, followed by a dynamic component, such as a session or user ID, and then a module name or similar at the end. Sometimes a _Workflow_ opens more than one application and uses more than one module within an application. If it is necessary to check for the correct use of a module in an application, you might need to identify a window title that is not consistently the same, but rather is separated by dynamic parts. One such application is _Microsoft Dynamics AX_. ![Example for Microsoft Dynamics AX](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-examples-image3.png) If you need to identify a "Dynamics AX" window that contains the text "cfu" near the end of the title, you can use the following regular expression: ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-examples-image4.png) Using _.\*_ allows there to be any number of alphanumeric characters before the term "Dynamics AX", thereby accounting for the word "Microsoft". Using the same method, the example allows there to be a string of any length between "Dynamics AX" and "cfu". How does this work? The _._ stands for exactly one alphanumeric character, excluding newline. The _\*_ is a quantifier that tells the software processing the regular expression that the previous character may repeat indefinitely. Thus the single _._ at the end before the closing _$_ indicates that there has to be exactly one alphanumeric character (excluding newline) present. ## Example 3: Making a Window Title Search Case Insensitive/Use of Environment Variables Some window titles might include components such as the name of the logged-in user. It is a good idea to use the environment variable _%Username%_ to identify the window at runtime so the _Workflow_ does not have to be changed if the user changes (or if the user is random in the first place). It might happen that the username in the application uses upper case, but the environment variable returns lower case, for example "User" and "user". If you want to identify the window title by using the environment variable you have to make sure the case does not matter. You achieve this by using _(?i)_ at the start of your regular expression. ![Example for regular expression](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-examples-image5.png) This regular expression would find a window title like "Document user.txt – Editor". ## See Also - [Testing Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions-testing-regular-expression) --- product: RPA Builder version: 6.6 --- # Rename File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This Action Step renames a file. If the renamed file already exists in the destination folder, the workflow is interrupted with an error message. ## Properties **File Operation Settings:** - **Directory path** Enter the path to the directory where the file to be renamed is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the Base Path variable. - **File Name** Enter the name here of the file that is to be renamed. - **New File Name** Here you enter he new name of the file to be renamed. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be renamed is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the Base Path variable. **File Name** Enter the name here of the file that is to be renamed. **New File Name** Here you enter he new name of the file to be renamed. ## Outbound Variables **IsRenamed** The _Rename File.IsRenamed_ variable indicates whether the file could be renamed or not (True/False). **New File Name** The _Rename File.New file Name_ provides the file’s new name. **File name** The _Rename File.File Name_ variable provides the name of the file that is to be renamed. **Directory path** The _Rename File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be renamed. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file here that is to be renamed. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **New file name** Enter the new name for the file here. You can also insert a variable from the Workflow as the _New file name_. To do so, click on the pin and select one of the available variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Rename File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step renames a file. If the renamed file already exists in the destination folder, the workflow is interrupted with an error message. ## Properties **File Operation Settings:** - **Directory path** Enter the path to the directory where the file to be renamed is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the Base Path variable. - **File Name** Enter the name here of the file that is to be renamed. - **New File Name** Here you enter he new name of the file to be renamed. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be renamed is located. You can specify an absolute or relative path. If a relative path is used, then the path relates to the Base Path variable. **File Name** Enter the name here of the file that is to be renamed. **New File Name** Here you enter he new name of the file to be renamed. ## Outbound Variables **IsRenamed** The _Rename File.IsRenamed_ variable indicates whether the file could be renamed or not (True/False). **New File Name** The _Rename File.New file Name_ provides the file’s new name. **File name** The _Rename File.File Name_ variable provides the name of the file that is to be renamed. **Directory path** The _Rename File.Directory Path_ variable provides the path that is used. ## Wizard - **Directory path** Specify the path to the file that is to be renamed. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file here that is to be renamed. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **New file name** Enter the new name for the file here. You can also insert a variable from the Workflow as the _New file name_. To do so, click on the pin and select one of the available variables. --- product: RPA Builder version: 6.6 --- # Rename Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Renames an existing folder. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory that contains the folder to rename. - **New folder name** The new name for the folder. ## Inbound Variables - **New folder name** - **Directory Path** ## Outbound Variables - **Is renamed** - **Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-folder-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Rename Folder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Renames an existing folder. ## Properties - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **Folder Operations Settings** - **Directory Path** Path to the directory that contains the folder to rename. - **New folder name** The new name for the folder. ## Inbound Variables - **New folder name** - **Directory Path** ## Outbound Variables - **Is renamed** - **Directory Path** ## See Also - [Folder Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-folder-operations) --- product: RPA Builder version: 6.6 --- # REST Call > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the REST Call Action Step to fetch data directly from a server and to collect the required information in a simple way. Define the endpoint according to your needs and assign parameters or process variables to the call, which enables you to flexibly address any REST interface. You can use the response in JSON or XML format as a source variable during the remainder of the process run. ## REST Call via a Proxy Server To make REST calls via a proxy server: ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/configure-proxy-settings.png)
1From the Workflow Initialization block, open Settings.
2In the Network Settings tab, configure your proxy settings.
The REST Call Action Step automatically retrieves the necessary information from the network settings. For more information about the configurable settings, see [Workflow Settings Properties](https://docs.mulesoft.com/rpa-builder/6.6/workflow-initialization#properties). ## Properties - **Authentication Options** - **API Key Authentication Key** The name of the API Key to use for authentication. - **API Key Authentication Value** The value to use when using API Key authentication. - **Basic Auth Credentials** The credentials to use when using Basic Authentication. - **REST Call Authentication Type** The type of authentication header to add to the call. Available values are: - NoAuth - ApiKey - BearerToken - BasicAuth - **REST Call Settings** - **Base Url** The base URL of the service. - **Json Path** The JSON path to the property of the response object. For example, `$.access_token`. - **Method Type** The method type to use for the REST call. Available values are: - GET - POST - PUT - PATCH - DELETE - HEAD - OPTIONS - **Parse Type** Specifies how to parse the REST call result. You can choose between **JsonPath** and **XPath**. Both types enable you to extract the exact information that you require without having to use special scripting, which simplifies further processing because you can access the desired result immediately. The _Json Query_ Action Step enables you to read individual values from the JSON object and process the result further. - **Request body** The request body of the REST call to send. - **Request Body Type** The request body type of the REST call result. You can choose between **Json** and **Form URL encoded**. - **Url Extension** A path parameter that uniquely identifies the resource. - **XPath** The Xpath expression to the property of the response object. For example, `/root/access_token/text()`. ## Inbound Variables - **Base Url** The base URL of the service. - **Url Extension** A path parameter that uniquely identifies the resource. - **Json Path Expression** The JSON path to the property of the response object. For Example, `$.access_token`. - **XPath Expression** The Xpath expression to the property of the response object. For example, `/root/access_token/text()`. ## Outbound Variables - **IsSuccessful** (boolean) Shows whether the REST Call was successful. - **ResponseBody** (string) Returns the requested information as a string. - **FirstItem** (array) The first element of the array is output as a string. - **Status** (integer) Displays the HTTP status code. For example, `200` is OK, which means the request was processed successfully and the result was transferred in the answer. - **ArrayCount** The number of elements of the returned array. ## Wizard The wizard is split into the **Settings** and **Parameters** areas. ### Settings ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-settings.png) In **Settings**, you specify: - **Method Type**: The required HTTP method. - **Base Url**: The Host and Base Path. - **Url Extension**: A unique identifier for the resource. You can type in the URL or define it via the pin variable. - **Parse Type**: The method for parsing the result. Available options are **JsonPath** and **XPath**. - **JsonPath Expression**: The path to the property of the response object. Use the [JsonPath expression Builder](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions#jsonpath-builder) to simplify the process of creating the JsonPath expression. ### Parameters ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-parameters.png) In the **Parameters** area, you provide the required information to the end point. There are various options for this, you can enter the parameters directly in the URL or you can configure the parameters using the following tabs: **Request Body**, **Header Parameter**, **Query Parameter**, and **Authentication**. #### Request Body With the **Request Body**, you send data to the server, including, for example, the form of communication between the server and the client. According to convention, the methods GET, HEAD and DELETE do not require a body (see also the network protocol RFC 7231). In the **Parameters** area you can find the mapped variables and their **Test Values**. The mapping is carried out via the Pin variable. With the test values, you can check if the REST call runs successfully. To do this, enter all of the data and click **Send** at the end of the wizard. The actual values of the mapped variables are not effective until the production run of the Workflow. To insert the variables with test values into the request body: ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-parameters-variables.png)
1In the Request body with variables area, click the position where you want to insert the variable.
2In the Test Values section, click on the variable you want to insert. For Example, {A}: Activity Parameters.myVar.
The **Request body with variables** section shows the body of the request and the contained variables. The **Request body with test values** section shows the body with the broken down variables of the JSON object. If you selected JSON, the body is also highlighted for an improved overview. Select between **Json** or **Form URL Encoded** to choose which type of request and answer is to be accepted by the server and client. At the same time, the system checks if your entries are compliant. Depending on the request body type you select, the `Content-Type` parameter updates automatically in the **Header Parameters** tab. #### Header Parameter ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-header-parameter.png) With the **Header Parameter**, you describe exactly which resource is collected or which answer format is required. You can add user-defined headers with the `x-` prefix, for example, `x-Customer` – `Customer ID`. Here, you typically provide the login information for authentication of a user to a server. #### Query Parameter ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-query-parameter.png) With the **Query Parameter**, you filter the resource and you can add further information such as login information. #### Authentication ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/rest-call-wizard-authentication.png) The **Authentication** tab enables you to select the authentication type to add as a header and the corresponding credentials to use. The available authentication types are: - **API Key** - **Bearer Token** - **Basic Auth** - **None** #### Result Viewer In the **Result Viewer**, in the text results, you can view the entire returned body, and in the parsed results, you can view the result specified with JsonPath or Xpath. ## See Also - [Json Query](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-json-query) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # REST Call > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the REST Call action step to fetch data directly from a server and to collect the required information in a simple way. Define the endpoint according to your needs and assign parameters or process variables to the call, which enables you to flexibly address any REST interface. You can use the response in JSON or XML format as a source variable during the remainder of the process run. ## REST Call via a Proxy Server To make REST calls via a proxy server: ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/configure-proxy-settings.png)
1From the Workflow Initialization block, open Settings.
2In the Network Settings tab, configure your proxy settings.
The REST Call action step automatically retrieves the necessary information from the network settings. For more information about the configurable settings, see [Workflow Settings Properties](https://docs.mulesoft.com/rpa-builder/latest/workflow-initialization#properties). ## Properties - **Authentication Options** - **API Key Authentication Key** The name of the API Key to use for authentication. - **API Key Authentication Value** The value to use when using API Key authentication. - **Basic Auth Credentials** The credentials to use when using Basic Authentication. - **REST Call Authentication Type** The type of authentication header to add to the call. Available values are: - NoAuth - ApiKey - BearerToken - BasicAuth - **REST Call Settings** - **Base Url** The base URL of the service. - **Json Path** The JSON path to the property of the response object. For example, `$.access_token`. - **Method Type** The method type to use for the REST call. Available values are: - GET - POST - PUT - PATCH - DELETE - HEAD - OPTIONS - **Parse Type** Specifies how to parse the REST call result. You can choose between **JsonPath** and **XPath**. Both types enable you to extract the exact information that you require without having to use special scripting, which simplifies further processing because you can access the desired result immediately. The _Json Query_ action step enables you to read individual values from the JSON object and process the result further. - **Request body** The request body of the REST call to send. - **Request Body Type** The request body type of the REST call result. You can choose between **Json** and **Form URL encoded**. - **Url Extension** A path parameter that uniquely identifies the resource. - **XPath** The Xpath expression to the property of the response object. For example, `/root/access_token/text()`. ## Inbound Variables - **Base Url** The base URL of the service. - **Url Extension** A path parameter that uniquely identifies the resource. - **Json Path Expression** The JSON path to the property of the response object. For Example, `$.access_token`. - **XPath Expression** The Xpath expression to the property of the response object. For example, `/root/access_token/text()`. ## Outbound Variables - **IsSuccessful** (boolean) Shows whether the REST Call was successful. - **ResponseBody** (string) Returns the requested information as a string. - **FirstItem** (array) The first element of the array is output as a string. - **Status** (integer) Displays the HTTP status code. For example, `200` is OK, which means the request was processed successfully and the result was transferred in the answer. - **ArrayCount** The number of elements of the returned array. ## Wizard The wizard is split into the **Settings** and **Parameters** areas. ### Settings ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-settings.png) In **Settings**, you specify: - **Method Type**: The required HTTP method. - **Base Url**: The Host and Base Path. - **Url Extension**: A unique identifier for the resource. You can type in the URL or define it via the pin variable. - **Parse Type**: The method for parsing the result. Available options are **JsonPath** and **XPath**. - **JsonPath Expression**: The path to the property of the response object. Use the [JsonPath expression Builder](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions#jsonpath-builder) to simplify the process of creating the JsonPath expression. ### Parameters ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-parameters.png) In the **Parameters** area, you provide the required information to the end point. There are various options for this, you can enter the parameters directly in the URL or you can configure the parameters using the following tabs: **Request Body**, **Header Parameter**, **Query Parameter**, and **Authentication**. #### Request Body With the **Request Body**, you send data to the server, including, for example, the form of communication between the server and the client. According to convention, the methods GET, HEAD and DELETE do not require a body (see also the network protocol RFC 7231). In the **Parameters** area you can find the mapped variables and their **Test Values**. The mapping is carried out via the Pin variable. With the test values, you can check if the REST call runs successfully. To do this, enter all of the data and click **Send** at the end of the wizard. The actual values of the mapped variables are not effective until the production run of the Workflow. To insert the variables with test values into the request body: ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-parameters-variables.png)
1In the Request body with variables area, click the position where you want to insert the variable.
2In the Test Values section, click on the variable you want to insert. For Example, {A}: Activity Parameters.myVar.
The **Request body with variables** section shows the body of the request and the contained variables. The **Request body with test values** section shows the body with the broken down variables of the JSON object. If you selected JSON, the body is also highlighted for an improved overview. Select between **Json** or **Form URL Encoded** to choose which type of request and answer is to be accepted by the server and client. At the same time, the system checks if your entries are compliant. Depending on the request body type you select, the `Content-Type` parameter updates automatically in the **Header Parameters** tab. #### Header Parameter ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-header-parameter.png) With the **Header Parameter**, you describe exactly which resource is collected or which answer format is required. You can add user-defined headers with the `x-` prefix, for example, `x-Customer` – `Customer ID`. Here, you typically provide the login information for authentication of a user to a server. #### Query Parameter ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-query-parameter.png) With the **Query Parameter**, you filter the resource and you can add further information such as login information. #### Authentication ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/rest-call-wizard-authentication.png) The **Authentication** tab enables you to select the authentication type to add as a header and the corresponding credentials to use. The available authentication types are: - **API Key** - **Bearer Token** - **Basic Auth** - **None** #### Result Viewer In the **Result Viewer**, in the text results, you can view the entire returned body, and in the parsed results, you can view the result specified with JsonPath or Xpath. ## See Also - [Json Query](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-json-query) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Retrieve Results from MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Retrieve the results of a document processed with MuleSoft IDP. To run this action step, provide an Execution ID, generated during the execution of the Submit Document to MuleSoft IDP action step. The Execution ID links this action step with a document action execution to define which results to retrieve. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. ## Before You Begin Before you begin using this action step, ensure that: - Your Anypoint user account has the Build Actions permission. - You have the Execution ID generated from a Submit Document to MuleSoft IDP action step. - You have IDP document actions published in your organization. See [Publishing Document Actions](https://docs.mulesoft.com/idp/publishing-document-actions) for additional information. - You have a connected app configured to access IDP. See [Processing Documents and Retrieving Results With RPA](https://docs.mulesoft.com/idp/automate-document-processing-with-rpa) for configuration instructions. ## Properties This action step has no properties other than **Common** and **Timing**. See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for further details. ## Inbound Variables - **Client ID** Client ID of the connected app configured to call IDP - **Client Secret** Client Secret of the connected app configured to call IDP - **Connected App Credentials** Pin credentials containing the Client ID and Client Secret of the connected app configured to call IDP - **Execution ID** Execution ID of the document processing operation ## Outbound Variables - **Status** - **JSON Result** ## Wizard Specify a combination of **Execution ID**, **Action**, and **Action Version** to query the results of that execution. These lists populate with the available document actions that your organization has published in IDP. Ensure you specify the same **Action** and **Action Version** used in the Submit Document to MuleSoft IDP configuration that generated the **Execution ID** you are checking. Then, select the connected app credentials to use when connecting to IDP. You can use Pin credentials that you configured or specify the **Client ID** and **Client Secret** manually in the wizard. ## See Also - [Submit Document to MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mulesoft-idp-submit-document-to-mulesoft-idp) - [Permissions in Anypoint Platform](https://docs.mulesoft.com/access-management/managing-permissions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Retrieve Results from MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Retrieve the results of a document processed with MuleSoft IDP. To run this action step, provide an Execution ID, generated during the execution of the Submit Document to MuleSoft IDP action step. The Execution ID links this action step with a document action execution to define which results to retrieve. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. ## Before You Begin Before you begin using this action step, ensure that: - Your Anypoint user account has the Build Actions permission. - You have the Execution ID generated from a Submit Document to MuleSoft IDP action step. - You have IDP document actions published in your organization. See [Publishing Document Actions](https://docs.mulesoft.com/idp/publishing-document-actions) for additional information. - You have a connected app configured to access IDP. See [Processing Documents and Retrieving Results With RPA](https://docs.mulesoft.com/idp/automate-document-processing-with-rpa) for configuration instructions. ## Properties This action step has no properties other than **Common** and **Timing**. See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for further details. ## Inbound Variables - **Client ID** Client ID of the connected app configured to call IDP - **Client Secret** Client Secret of the connected app configured to call IDP - **Connected App Credentials** Pin credentials containing the Client ID and Client Secret of the connected app configured to call IDP - **Execution ID** Execution ID of the document processing operation - **Action ID** ID of the published document action to call. - **Action Version** Version of the referenced document action. - **Anypoint URL** URL of the Anypoint organization that published the IDP document actions to call. - **Organisation ID** ID of the Anypoint organization that published the IDP document actions to call. ## Outbound Variables - **Status** - **JSON Result** ## Wizard Specify a combination of **Execution ID**, **Action**, and **Action Version** to query the results of that execution. These lists populate with the available document actions that your organization has published in IDP. Ensure you specify the same **Action** and **Action Version** used in the Submit Document to MuleSoft IDP configuration that generated the **Execution ID** you are checking. Then, select the connected app credentials to use when connecting to IDP. You can use Pin credentials that you configured or specify the **Client ID** and **Client Secret** manually in the wizard. ## See Also - [Submit Document to MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mulesoft-idp-submit-document-to-mulesoft-idp) - [Permissions in Anypoint Platform](https://docs.mulesoft.com/access-management/managing-permissions) --- product: RPA Builder version: 6.6 --- # RPA Builder Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder is the on-premise development environment that enables you to build the automations by specifying the tasks and steps of the process. With RPA Builder you can import a BPMN diagram generated in RPA Manager, and then drag and drop operations or record keyboard and mouse input to specify the action steps. You can also perform local testing of your workflow and when you finish building the process, you upload it to RPA Manager to move on to the testing phase. RPA Builder enables you to: - Download and upload automation assets to RPA Manager. - Add the automation logic to the processes. - Run local tests for the automations. ## See Also - [Hardware and Software Requirements](https://docs.mulesoft.com/rpa-builder/6.6/hardware-software-requirements) - [Installing and Configuring RPA Builder](https://docs.mulesoft.com/rpa-builder/6.6/install-and-configure) --- product: RPA Builder version: 6.7 is-latest-version: true --- # RPA Builder Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder is the on-premise development environment that enables you to build the automations by specifying the tasks and steps of the process. With RPA Builder you can import a BPMN diagram generated in RPA Manager, and then drag and drop operations or record keyboard and mouse input to specify the action steps. You can also perform local testing of your workflow and when you finish building the process, you upload it to RPA Manager to move on to the testing phase. RPA Builder enables you to: - Download and upload automation assets to RPA Manager. - Add the automation logic to the processes. - Run local tests for the automations. ## See Also - [Hardware and Software Requirements](https://docs.mulesoft.com/rpa-builder/latest/hardware-software-requirements) - [Installing and Configuring RPA Builder](https://docs.mulesoft.com/rpa-builder/latest/install-and-configure) --- product: RPA Builder version: 6.6 --- # RPA Builder UI Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The RPA Builder user interface has the following main areas: ![Overview window panes](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-builder-ui-overview.png) 1. Explorer pane 2. Menu bar 3. BPMN editor 4. Workflow Properties pane 5. Workbench 6. Workflow Run Results In addition to the Workflow Run Result, you can also find the Process Status in this area. Most visual elements in RPA Builder have tooltips. If you ever want to know what a button or setting does, hover your mouse pointer over it for a few seconds. ## Menu Bar The menu bar contains icons for saving, uploading, and validating projects. The other icons are shortcuts to various views in RPA Builder. ### Tools - **Open MuleSoft RPA Builder Log** This menu item opens the RPA Builder log file in your default text editor. The log is a text file containing a chronological list of all relevant events since RPA Builder was last launched. It also contains information about the executing system. - **Open Regex Tester** Use this dialog to create and test regular expressions. You can also access the _Regex Tester_ directly from various _Action Steps_. The section on Using Regular Expressions includes a more detailed description of this dialog and of regular expressions in general. - **Generate OAuth Refresh Token** Use this menu item to generate an OAuth token that you can use with the Mail Session (Outlook with OAuth) Action Step. This option opens the OAuth Token Creator, in which you specify your OAuth credentials to log in to the authentication server and generate the token. - **Templates Manager** This menu item opens the _Templates Manager_. This provides an overview of all the templates which have been created in RPA Builder already. Clicking the template name on the left-hand side of the window opens a preview of that template’s content. Use the _Delete_ button to delete individual templates. You can find out how to create and edit templates in the section entitled Save selected Workflow Objects as template. ![Example Templates](/mulesoft/current/en-us/rpa-builder/6.6/_images/getting-started-installation-and-first-use-application-overview-image3.png) ### Options The menu **Options** in the RPA Builder toolbar contains four sub-menus: - **General** - **Autosave** - **Repository** - **Visibility** Click any of these menu items to open the wizard with the selected tab. #### General The **General** options menu contains the following settings: ![Option General](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-builder-options-general.png) - **Default Settings** - **General timeout default for new projects** If you want to use the same timeout for every _Action Step_ containing this property, you can enter the value here. A timeout is the time span an _Action Step_ waits before reporting an error in case of failure. This value is only used for initialization when creating a new project and can be replaced within each _Action Step_ by a value that is valid only for that _Action Step_. If you want to change the default timeout value for a whole Workflow which has already been created, please use the _Default Timeout \[sec\]_ setting in the _Workflow Properties_. - **Save Projects and Settings in All Users Folder** If this option is set, RPA Builder saves all projects, the most common options, _Page Setup…_, and _Print Template Settings_ for the Printing of a Workflow into the folder `C:\Users\Public\Documents\MuleSoft\RPA`. Otherwise, it saves the settings to the folder `C:\Users\[UserName.Domain]\Documents\MuleSoft\RPA` of the respective user. - **Open last project on start** Selecting this option means that the last project that you opened is reloaded and displayed when you launch RPA Builder. #### Autosave The **Autosave** options menu contains the following settings: ![Option Autosave](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-builder-options-autosave.png) - **Autosave on script run** If this option is selected, RPA Builder saves the Workflow before each local run. - **Common Autosave** - **Activated** If this option is selected, RPA Builder saves projects automatically at the interval defined in **Time between savings, min**. RPA Builder always saves the entire Business Process, including all Workflows. - **Time between savings, min** The time interval in minutes at which RPA Builder saves the project automatically when the common autosave is activated. #### Repository The **Repository** options menu contains the following settings: ![Option Repository](/mulesoft/current/en-us/rpa-builder/6.6/_images/repository-settings.png) - **Repository Settings** - **RPA Manager Address** The URL of the RPA Manager instance RPA Builder connects to. Do not specify the protocol (`https://`) as part of this value. - **User Name** The RPA Manager user name that RPA Builder uses to log in. - **Password** The RPA Manager password that RPA Builder uses to log in. - **Save Password** Select this option if you want RPA Builder to save the password used to connect to the Repository. - **Use HTTPS** Select this option to connect to the repository using HTTPS. - **Auto-Connect to Repository** Select this option if you want RPA Builder to connect to the repository during start-up. - **Proxy Settings** - **Use System Proxy Settings** Select this option to use the proxy settings configured in the system. - **Manual Proxy Configuration** Select this option to manually configure a proxy. - **Proxy Address** The proxy address to use when **Manual Proxy Configuration** is selected. Specify the protocol to use when connecting to the proxy as part of the address. For example: `http://your.proxy.host:1234/` - **Use Authentication** Select this option if the specified proxy requires authentication. - **User Name** The user name to authenticate with the proxy. - **Password** The password to authenticate with the proxy. - **Test Connection** Tests the connection with the repository using the configured settings. #### Visibility The **Visibility** options menu contains the following settings: ![Option Visibility](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-builder-options-visibility.png) - **General Visibility** - **Show Action Step descriptions** (default: off) This option enables you to show and hide the descriptions of individual Workflow elements on the Workbench in RPA Builder. This does not affect the visibility of the individual element descriptions for the Properties and tool tips, which are always visible. This option can also be modified via the _Show Action Step descriptions_ button or the CTRL+D shortcut. It is saved on an individual user basis. - **Show system parameters dialog** If this option is set, the system parameters are shown whenever a new Activity Workflow is created. These can also be shown via the menu _View_ → _Show System Parameters_. ### Help The Help menu contains the following logging options: - **Export log files** Collects all logs from RPA Builder and creates a ZIP file in the specified location. The filename uses the following convention: `RPABuilder_logs_.ZIP`. - **Enable Debug logging until RPA Builder is closed** Sets the RPA Builder log level to `DEBUG` until you close the application. - **Append trace log files instead of overwriting them** Instructs RPA Builder to append trace logs instead of overwriting them. ## Explorer Pane The Explorer pane includes five tabs: _Toolbox_, _Project_, _Activity Library_, _Repository_ and _Outline_. If any of these views are not visible, you can always show them again by using the View menu from the menu bar. The **_Toolbox_** contains a list of all elements, such as _Action Steps_ and _Control Blocks_, which can be inserted in a _Workflow_. Elements are organized in categories, so that you can find fitting ones easily. By clicking on the star symbol next to an element, you can add it to the category _Favorites_. Elements can be inserted into the Workflow using Drag&Drop. You can find a detailed description for each element in the [Toolbox](https://docs.mulesoft.com/rpa-builder/6.6/toolbox) section. If you input text in the field _Filter_ the content of the _Toolbox_ is reduced successively to elements, the names of which contain this text. The filter is case-insensitive. The **_Project_** tab contains a list of all loaded Workflows of a project. If you click on one of the Workflows, it is also displayed in the Workbench. This way you can easily switch back and forth between Workflows Right-clicking a Workflow opens the context menu providing additional functions: - **Edit Workflow Properties** Opens the Properties pane of the selected Workflow - **Clear Run Results marking** Clears the markings of warnings and errors in the Workbench view of the selected project. These markings are shown after a failed local Workflow run or after the import of an analysis package. - **Open Workflow Location** Opens the folder containing the selected Workflow. If you are using the Repository for storing your Business Process, the tab **_Repository Explorer_** shows a list of all available Business Process. These can be downloaded for editing. If you use the **_Activity Library,_** you can view and delete all available Activity Templates here. For a more detailed description of how to use the Activity Library, see [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/6.6/activity-library). The **_Workflow Outline_** is a shortened view of the open Workflow. You can double-click an element to mark it in the Workbench pane. Right-clicking an element opens a context menu: - **Run Wizard** Opens the Wizard of the selected element - **Delete** Deletes the selected element - **Expand all** Expands the view to show all elements, in the _Document Outline_ as well as on the Workbench - **Collapse all** Collapses the view to show only higher-level elements, in the _Document Outline_ as well as on the Workbench ## Workflow Run Results The _Workflow Run Results_ section shows detailed information on the last Activity Workflow that was run. See [The Workflow Run Results Panel](https://docs.mulesoft.com/rpa-builder/6.6/running-workflows-and-using-workflow-run-results#workflow-run-results) for additional details. ## Project Status The Project Status section provides detailed information about the validation and script generation of the project. ## Workflow Properties Grid The _Workflow_ _Properties_ grid is located on the right-hand side of the screen. In the initial view it is set to _auto-hide_, but it will expand as soon as you have opened or created a _Workflow_. It displays all properties of the current selection within the _Workbench_. If you click on an element, a description shows in the bottom of the pane. If you enter text in the field _Filter_, the displayed properties are successively reduced to those containing the entered text. --- product: RPA Builder version: 6.7 is-latest-version: true --- # RPA Builder UI Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The RPA Builder user interface has the following main areas: ![Overview window panes](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-builder-ui-overview.png) 1. Explorer pane 2. Menu bar 3. BPMN editor 4. Workflow Properties pane 5. Workbench 6. Workflow Run Results In addition to the Workflow Run Result, you can also find the Process Status in this area. Most visual elements in RPA Builder have tooltips. If you ever want to know what a button or setting does, hover your mouse pointer over it for a few seconds. ## Menu Bar The menu bar contains icons for saving, uploading, and validating projects. The other icons are shortcuts to various views in RPA Builder. ### Tools - **Open MuleSoft RPA Builder Log** This menu item opens the RPA Builder log file in your default text editor. The log is a text file containing a chronological list of all relevant events since RPA Builder was last launched. It also contains information about the executing system. - **Open Regex Tester** Use this dialog to create and test regular expressions. You can also access the _Regex Tester_ directly from various action steps. The section on Using Regular Expressions includes a more detailed description of this dialog and of regular expressions in general. - **Generate OAuth Refresh Token** Use this menu item to generate an OAuth token that you can use with the Mail Session (Outlook with OAuth) action step. This option opens the OAuth Token Creator, in which you specify your OAuth credentials to log in to the authentication server and generate the token. - **Templates Manager** This menu item opens the _Templates Manager_. This provides an overview of all the templates which have been created in RPA Builder already. Clicking the template name on the left-hand side of the window opens a preview of that template’s content. Use the _Delete_ button to delete individual templates. You can find out how to create and edit templates in the section entitled Save selected Workflow Objects as template. ![Example Templates](/mulesoft/current/en-us/rpa-builder/latest/_images/getting-started-installation-and-first-use-application-overview-image3.png) ### Options The menu **Options** in the RPA Builder toolbar contains four sub-menus: - **General** - **Autosave** - **Repository** - **Visibility** Click any of these menu items to open the wizard with the selected tab. #### General The **General** options menu contains the following settings: ![Option General](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-builder-options-general.png) - **Default Settings** - **General timeout default for new projects** If you want to use the same timeout for every action step containing this property, you can enter the value here. A timeout is the time span an action step waits before reporting an error in case of failure. This value is only used for initialization when creating a new project and can be replaced within each action step by a value that is valid only for that action step. If you want to change the default timeout value for a whole Workflow which has already been created, please use the _Default Timeout \[sec\]_ setting in the _Workflow Properties_. - **Save Projects and Settings in All Users Folder** If this option is set, RPA Builder saves all projects, the most common options, _Page Setup…_, and _Print Template Settings_ for the Printing of a Workflow into the folder `C:\Users\Public\Documents\MuleSoft\RPA`. Otherwise, it saves the settings to the folder `C:\Users\[UserName.Domain]\Documents\MuleSoft\RPA` of the respective user. - **Open last project on start** Selecting this option means that the last project that you opened is reloaded and displayed when you launch RPA Builder. #### Autosave The **Autosave** options menu contains the following settings: ![Option Autosave](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-builder-options-autosave.png) - **Autosave on script run** If this option is selected, RPA Builder saves the Workflow before each local run. - **Common Autosave** - **Activated** If this option is selected, RPA Builder saves projects automatically at the interval defined in **Time between savings, min**. RPA Builder always saves the entire Business Process, including all Workflows. - **Time between savings, min** The time interval in minutes at which RPA Builder saves the project automatically when the common autosave is activated. #### Repository The **Repository** options menu contains the following settings: ![Option Repository](/mulesoft/current/en-us/rpa-builder/latest/_images/repository-settings.png) - **Repository Settings** - **RPA Manager Address** The URL of the RPA Manager instance RPA Builder connects to. Do not specify the protocol (`https://`) as part of this value. - **User Name** The RPA Manager user name that RPA Builder uses to log in. - **Password** The RPA Manager password that RPA Builder uses to log in. - **Save Password** Select this option if you want RPA Builder to save the password used to connect to the Repository. - **Use HTTPS** Select this option to connect to the repository using HTTPS. - **Auto-Connect to Repository** Select this option if you want RPA Builder to connect to the repository during start-up. - **Proxy Settings** - **Use System Proxy Settings** Select this option to use the proxy settings configured in the system. - **Manual Proxy Configuration** Select this option to manually configure a proxy. - **Proxy Address** The proxy address to use when **Manual Proxy Configuration** is selected. Specify the protocol to use when connecting to the proxy as part of the address. For example: `http://your.proxy.host:1234/` - **Use Authentication** Select this option if the specified proxy requires authentication. - **User Name** The user name to authenticate with the proxy. - **Password** The password to authenticate with the proxy. - **Test Connection** Tests the connection with the repository using the configured settings. #### Visibility The **Visibility** options menu contains the following settings: ![Option Visibility](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-builder-options-visibility.png) - **General Visibility** - **Show Action Step descriptions** (default: off) This option enables you to show and hide the descriptions of individual Workflow elements on the Workbench in RPA Builder. This does not affect the visibility of the individual element descriptions for the Properties and tool tips, which are always visible. This option can also be modified via the _Show action step descriptions_ button or the CTRL+D shortcut. It is saved on an individual user basis. - **Show system parameters dialog** If this option is set, the system parameters are shown whenever a new Activity Workflow is created. These can also be shown via the menu _View_ → _Show System Parameters_. ### Help The Help menu contains the following logging options: - **Export log files** Collects all logs from RPA Builder and creates a ZIP file in the specified location. The filename uses the following convention: `RPABuilder_logs_.ZIP`. - **Enable Debug logging until RPA Builder is closed** Sets the RPA Builder log level to `DEBUG` until you close the application. - **Append trace log files instead of overwriting them** Instructs RPA Builder to append trace logs instead of overwriting them. ## Explorer Pane The Explorer pane includes five tabs: _Toolbox_, _Project_, _Activity Library_, _Repository_ and _Outline_. If any of these views are not visible, you can always show them again by using the View menu from the menu bar. The **_Toolbox_** contains a list of all elements, such as action steps and _Control Blocks_, which can be inserted in a _Workflow_. Elements are organized in categories, so that you can find fitting ones easily. By clicking on the star symbol next to an element, you can add it to the category _Favorites_. Elements can be inserted into the Workflow using Drag&Drop. You can find a detailed description for each element in the [Toolbox](https://docs.mulesoft.com/rpa-builder/latest/toolbox) section. If you input text in the field _Filter_ the content of the _Toolbox_ is reduced successively to elements, the names of which contain this text. The filter is case-insensitive. The **_Project_** tab contains a list of all loaded Workflows of a project. If you click on one of the Workflows, it is also displayed in the Workbench. This way you can easily switch back and forth between Workflows Right-clicking a Workflow opens the context menu providing additional functions: - **Edit Workflow Properties** Opens the Properties pane of the selected Workflow - **Clear Run Results marking** Clears the markings of warnings and errors in the Workbench view of the selected project. These markings are shown after a failed local Workflow run or after the import of an analysis package. - **Open Workflow Location** Opens the folder containing the selected Workflow. If you are using the Repository for storing your Business Process, the tab **_Repository Explorer_** shows a list of all available Business Process. These can be downloaded for editing. If you use the **_Activity Library,_** you can view and delete all available Activity Templates here. For a more detailed description of how to use the Activity Library, see [Using the Activity Library](https://docs.mulesoft.com/rpa-builder/latest/activity-library). The **_Workflow Outline_** is a shortened view of the open Workflow. You can double-click an element to mark it in the Workbench pane. Right-clicking an element opens a context menu: - **Run Wizard** Opens the Wizard of the selected element - **Delete** Deletes the selected element - **Expand all** Expands the view to show all elements, in the _Document Outline_ as well as on the Workbench - **Collapse all** Collapses the view to show only higher-level elements, in the _Document Outline_ as well as on the Workbench ## Workflow Run Results The _Workflow Run Results_ section shows detailed information on the last Activity Workflow that was run. See [The Workflow Run Results Panel](https://docs.mulesoft.com/rpa-builder/latest/running-workflows-and-using-workflow-run-results#workflow-run-results) for additional details. ## Project Status The Project Status section provides detailed information about the validation and script generation of the project. ## Workflow Properties Grid The _Workflow_ _Properties_ grid is located on the right-hand side of the screen. In the initial view it is set to _auto-hide_, but it will expand as soon as you have opened or created a _Workflow_. It displays all properties of the current selection within the _Workbench_. If you click on an element, a description shows in the bottom of the pane. If you enter text in the field _Filter_, the displayed properties are successively reduced to those containing the entered text. --- product: RPA Builder version: 6.6 --- # Run Program > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ is used to run a program by directly calling its executable file. ## Properties **Domain** If a process is started with a specific user, this defines the domain of the user **Inherit Environment** If process is started with a specific user, this determines if the environment will be inherited from that user **Interactive logon with profile** If this option is checked additionally to the option _UseCredentials,_ the user’s profile from the registry is passed on to the process. **Password** If a process is started with a specific user, this is the user’s password. Only applicable if "Use Credentials" is set. **Use Credentials** Determines whether to start the process with a different user or not **Username** If a process is started with a specific user this is the user’s name. Only applicable if _Use Credentials_ is set. **File name** Contains the full path to the executable file that should be run **Parameters** Defines additional command line parameters to use when running the program **Path is relative to 3rd Party Folder** The related process will be started relative to the _3rd Party Folder_. This folder must be below the scripts directory and can contain user-defined applications. **Start mode** Sets the status of the application window (_Normal_, _Maximized_, _Minimized_) **Working Directory** Defines the working directory of the process started **Timeout** If _Wait for window_ _to appear_ is set, this defines how long the _Action Step_ will wait for the window to appear **Use regular expression** If _Wait for window to appear_ is set, this setting defines whether the _Window Title_ field contains a regular expression or not **Wait for window to appear** Defines whether the _Action Step_ should wait until the window appears **Window Title** If _Wait for window_ _to appear_ is set, this defines the _Window Title_ to wait for ## Inbound Variables **File name** **Working Dir** **Parameters** **Window TitleUsername** **Password** **Domain** Process Window Handle The window handle associated with the newly opened window. (Only available if _Wait for window_ _to appear_ is set.) ## Outbound Variables **Process ID** The ID of the process that has been started **Executable** The name of the executed file **Working Dir** The working directory of the process ## Wizard **Insert** Environment **Variable** Select and use any defined environment variable as a path to the desired program file via the drop-down menu **Auto-Replace Variables** If you have entered the path to the executable manually or used the browse button to specify it, you can click this button to check if there are any environment variables that can replace parts of the path You can place an executable file in the **_3rd Party Folder_** within the folder where the project is saved. To do so, use the _Select & Copy File to 3rd Party Folder…_ function in the drop-down menu accessed by clicking the triangle symbol next to the browse button (…​). This is very useful if, for example, you want to use a user-defined batch file in the _Workflow_. Using this function ensures that the executable file can still be found correctly, even when the project folder has been moved or deployed. Select _Open 3rd Party Folder_ to copy files into the folder yourself. If you use this option, remember to manually select the _Path is relative to 3rd Party Folder_ checkbox and enter the filename to call too. Using _Select & Copy…_ fills out the _File name_ field and selects the checkbox automatically. To select the program to run, enter the full path manually into the _File name_ field or just browse to the executable file you want to run. > [!TIP] If you intend to use an _Image search_ within the application when it is running, it is > recommended that you use _Maximized_ _Start mode_ so the application window will always be in the > same position! This makes defining a reliable _Search area_ for the _Image search_ much easier. As mentioned above, you can use _Windows_ environment variables in the _File name_ and _Parameters_ field. This can be done with both default environment variables defined by _Windows_ and with user-defined environment variables. These environment variables contain paths to certain folders. For example, _Internet Explorer_ is often installed in _C:\\Program Files\\Internet Explorer\\_ or _C:\\Program Files x86\\Internet Explorer\\_. However, the folder might have a completely different name, depending on the language used with your operating system, or it might even be installed on a different hard drive. To help avoid problems, the environment variable _%ProgramFiles%_ is set automatically to the correct folder when _Windows_ is installed. Here is a list of the most important environment variables: - **%ALLUSERSPROFILE%** The _All Users_ profile folder - **%APPDATA%** The current user’s application data folder (_Windows Vista_ and later only) - **%COMPUTERNAME%** The system name - **%ProgramFiles%** is replaced by the current program path. This variable depends on whether you are running a 32-bit or a 64-bit program. If you are running a 32-bit program, _C:\\Program Files (x86)_ is the resulting variable. If you are running a 64-bit program, _C:\\Program Files_ is the resulting variable. RPA Builder is usually run as a 64-bit program but the generated workflow code, on the other hand, is usually run as a 32-bit program. That is why the _Test Button_ in the wizard can provide you with a different result than the actual run does later on. To avoid possible differences when the programs are being run, it is therefore recommended to use: - the variable **%ProgramFiles(86)%** for 32-bit programs - the variable **%ProgramW6432** for 64-bit programs. (This does not apply to 32-bit-only Windows installations.) - **%SystemRoot%** The system root folder - **%SystemDrive%** The system drive letter - **%USERPROFILE%** The current user’s profile folder You will find a complete list of predefined environment variables by opening the drop-down menu _Insert Environment Variable_ in the _Run program_ wizard. If you want to test the new _Run program_ configuration, click the Test button and the executable will be run according to the configuration. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Run Program > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step is used to run a program by directly calling its executable file. ## Properties **Domain** If a process is started with a specific user, this defines the domain of the user **Inherit Environment** If process is started with a specific user, this determines if the environment will be inherited from that user **Interactive logon with profile** If this option is checked additionally to the option _UseCredentials,_ the user’s profile from the registry is passed on to the process. **Password** If a process is started with a specific user, this is the user’s password. Only applicable if "Use Credentials" is set. **Use Credentials** Determines whether to start the process with a different user or not **Username** If a process is started with a specific user this is the user’s name. Only applicable if _Use Credentials_ is set. **File name** Contains the full path to the executable file that should be run **Parameters** Defines additional command line parameters to use when running the program **Path is relative to 3rd Party Folder** The related process will be started relative to the _3rd Party Folder_. This folder must be below the scripts directory and can contain user-defined applications. **Start mode** Sets the status of the application window (_Normal_, _Maximized_, _Minimized_) **Working Directory** Defines the working directory of the process started **Timeout** If _Wait for window_ _to appear_ is set, this defines how long the action step will wait for the window to appear **Use regular expression** If _Wait for window to appear_ is set, this setting defines whether the _Window Title_ field contains a regular expression or not **Wait for window to appear** Defines whether the action step should wait until the window appears **Window Title** If _Wait for window_ _to appear_ is set, this defines the _Window Title_ to wait for ## Inbound Variables **File name** **Working Dir** **Parameters** **Window TitleUsername** **Password** **Domain** Process Window Handle The window handle associated with the newly opened window. (Only available if _Wait for window_ _to appear_ is set.) ## Outbound Variables **Process ID** The ID of the process that has been started **Executable** The name of the executed file **Working Dir** The working directory of the process ## Wizard **Insert** Environment **Variable** Select and use any defined environment variable as a path to the desired program file via the drop-down menu **Auto-Replace Variables** If you have entered the path to the executable manually or used the browse button to specify it, you can click this button to check if there are any environment variables that can replace parts of the path You can place an executable file in the **_3rd Party Folder_** within the folder where the project is saved. To do so, use the _Select & Copy File to 3rd Party Folder…_ function in the drop-down menu accessed by clicking the triangle symbol next to the browse button (…​). This is very useful if, for example, you want to use a user-defined batch file in the _Workflow_. Using this function ensures that the executable file can still be found correctly, even when the project folder has been moved or deployed. Select _Open 3rd Party Folder_ to copy files into the folder yourself. If you use this option, remember to manually select the _Path is relative to 3rd Party Folder_ checkbox and enter the filename to call too. Using _Select & Copy…_ fills out the _File name_ field and selects the checkbox automatically. To select the program to run, enter the full path manually into the _File name_ field or just browse to the executable file you want to run. > [!TIP] If you intend to use an _Image search_ within the application when it is running, it is > recommended that you use _Maximized_ _Start mode_ so the application window will always be in the > same position! This makes defining a reliable _Search area_ for the _Image search_ much easier. As mentioned above, you can use _Windows_ environment variables in the _File name_ and _Parameters_ field. This can be done with both default environment variables defined by _Windows_ and with user-defined environment variables. These environment variables contain paths to certain folders. For example, _Internet Explorer_ is often installed in _C:\\Program Files\\Internet Explorer\\_ or _C:\\Program Files x86\\Internet Explorer\\_. However, the folder might have a completely different name, depending on the language used with your operating system, or it might even be installed on a different hard drive. To help avoid problems, the environment variable _%ProgramFiles%_ is set automatically to the correct folder when _Windows_ is installed. Here is a list of the most important environment variables: - **%ALLUSERSPROFILE%** The _All Users_ profile folder - **%APPDATA%** The current user’s application data folder (_Windows Vista_ and later only) - **%COMPUTERNAME%** The system name - **%ProgramFiles%** is replaced by the current program path. This variable depends on whether you are running a 32-bit or a 64-bit program. If you are running a 32-bit program, _C:\\Program Files (x86)_ is the resulting variable. If you are running a 64-bit program, _C:\\Program Files_ is the resulting variable. RPA Builder is usually run as a 64-bit program but the generated workflow code, on the other hand, is usually run as a 32-bit program. That is why the _Test Button_ in the wizard can provide you with a different result than the actual run does later on. To avoid possible differences when the programs are being run, it is therefore recommended to use: - the variable **%ProgramFiles(86)%** for 32-bit programs - the variable **%ProgramW6432** for 64-bit programs. (This does not apply to 32-bit-only Windows installations.) - **%SystemRoot%** The system root folder - **%SystemDrive%** The system drive letter - **%USERPROFILE%** The current user’s profile folder You will find a complete list of predefined environment variables by opening the drop-down menu _Insert Environment Variable_ in the _Run program_ wizard. If you want to test the new _Run program_ configuration, click the Test button and the executable will be run according to the configuration. --- product: RPA Builder version: 6.6 --- # Running Workflows and Viewing Workflow Run Results > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder enables you to test a Workflow by executing a local run. After the Workflow execution finishes, the Workflow Run Results panel shows detailed information about the execution. To perform a test run of a Workflow in RPA Builder, click **Run Workflow** (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-process.png)) on the Workbench toolbar or press _F7_ on your keyboard. The RPA Builder window is hidden while the Workflow executes, so the engine can now use the mouse and keyboard just like a normal user would and you can watch to confirm if the Workflow performs correctly. Do not use the mouse or keyboard while the Workflow runs. Depending on the settings you made for the **Show Message boxes** value in the _Project Properties_, additional information may appear during the run. Note that every message box takes a few seconds to disappear, which causes a corresponding pause in the Workflow and affects measured times and Workflow stability. Before using a Workflow for productive measurement, turn off debug message boxes and perform at least one test run afterward. ## Pause or Exit a Workflow Run To pause or exit the Workflow during the execution: 1. Click the (![Test script tray button](/mulesoft/current/en-us/rpa-builder/6.6/_images/test-script-tray-icon.png)) tray icon. 2. Select either **Script Paused** or **Exit**. ![The test script tray icon showing the Script Paused and Exit options](/mulesoft/current/en-us/rpa-builder/6.6/_images/test-tray-options.png) Pressing _Pause/Break_ on your keyboard also stops a running Workflow. ## The Workflow Run Results Panel After you execute a Workflow from within RPA Builder, information about the last run displays in the Workflow Run Results panel at the end of the RPA Builder screen: ![The Workflow Run Results window](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-run-results-window.png) This information helps you identify problems and their causes in your Workflow. If you do not see the Workflow Run Results window, click **Show Workflow Run Results** in the menu bar. The Workflow Run Results window lists information about measured response times, found images, errors that occurred, and captured screenshots. You can double-click an entry to navigate to its corresponding Workflow element. ### Identifying Errors After a Workflow run, RPA Builder highlights Workflow elements that failed to execute and caused an error by marking them in red: ![The Activity Workflow window showing the Workflow element that failed marked in red](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-run-error.png) Click the expander arrows to get more detailed information about an error: ![The Activity Workflow window showing the additional details for the Workflow element that failed](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-run-error-detail.png) This panel provides detailed information about what failed. In this case, the _Web Session (Firefox)_ Action Step cannot start because Firefox is not installed in the computer that is executing the test run for the Workflow. The error screenshot shows the desktop as it looked when the error occurred. Click the screenshot to enlarge it. ## Opening the Trace Log The Trace Log contains even more detailed information about the last run. To open the Trace Log, click **Open Trace Log** in the Tools submenu inside the Workbench toolbar: ![The Workbench Tools menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/workbench-tools-menu.png) ## See Also - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/6.6/using-workflow-debugger) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/6.6/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Running Workflows and Viewing Workflow Run Results > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder enables you to test a Workflow by executing a local run. After the Workflow execution finishes, the Workflow Run Results panel shows detailed information about the execution. To perform a test run of a Workflow in RPA Builder, click **Run Workflow** (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-process.png)) on the Workbench toolbar or press _F7_ on your keyboard. The RPA Builder window is hidden while the Workflow executes, so the engine can now use the mouse and keyboard just like a normal user would and you can watch to confirm if the Workflow performs correctly. Do not use the mouse or keyboard while the Workflow runs. Depending on the settings you made for the **Show Message boxes** value in the _Project Properties_, additional information may appear during the run. Note that every message box takes a few seconds to disappear, which causes a corresponding pause in the Workflow and affects measured times and Workflow stability. Before using a Workflow for productive measurement, turn off debug message boxes and perform at least one test run afterward. ## Pause or Exit a Workflow Run To pause or exit the Workflow during the execution: 1. Click the (![Test script tray button](/mulesoft/current/en-us/rpa-builder/latest/_images/test-script-tray-icon.png)) tray icon. 2. Select either **Script Paused** or **Exit**. ![The test script tray icon showing the Script Paused and Exit options](/mulesoft/current/en-us/rpa-builder/latest/_images/test-tray-options.png) Pressing _Pause/Break_ on your keyboard also stops a running Workflow. ## The Workflow Run Results Panel After you execute a Workflow from within RPA Builder, information about the last run displays in the Workflow Run Results panel at the end of the RPA Builder screen: ![The Workflow Run Results window](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-run-results-window.png) This information helps you identify problems and their causes in your Workflow. If you do not see the Workflow Run Results window, click **Show Workflow Run Results** in the menu bar. The Workflow Run Results window lists information about measured response times, found images, errors that occurred, and captured screenshots. You can double-click an entry to navigate to its corresponding Workflow element. ### Identifying Errors After a Workflow run, RPA Builder highlights Workflow elements that failed to execute and caused an error by marking them in red: ![The Activity Workflow window showing the Workflow element that failed marked in red](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-run-error.png) Click the expander arrows to get more detailed information about an error: ![The Activity Workflow window showing the additional details for the Workflow element that failed](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-run-error-detail.png) This panel provides detailed information about what failed. In this case, the _Web Session (Firefox)_ action step cannot start because Firefox is not installed in the computer that is executing the test run for the Workflow. The error screenshot shows the desktop as it looked when the error occurred. Click the screenshot to enlarge it. ## Opening the Trace Log The Trace Log contains even more detailed information about the last run. To open the Trace Log, click **Open Trace Log** in the Tools submenu inside the Workbench toolbar: ![The Workbench Tools menu](/mulesoft/current/en-us/rpa-builder/latest/_images/workbench-tools-menu.png) ## See Also - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/latest/using-workflow-debugger) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/latest/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.6 --- # Runtime Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Runtime Variables action step provides a set of variables that the workflow populates at runtime. Use these variables to get information from the runtime context. The following variables are available: - **Project Name** Name of the _Workflow_ project - **Project GUID** GUID of the _Workflow_ project - **Run GUID** GUID related to the execution of the _Workflow_ (regenerated for each run) - **Time** Actual time as local time or UTC in configurable format - **Date** Actual date as local time or UTC in configurable format - **HostName** Name of _Host_ system - **UserName** Name of the user - **RandomVariable** Positive random number with a configurable range of values. The workflow generates a different number on each run. - **Business Process ID** ID of the business process - **Session Id** Terminal session ID of the environment where the bot is running - **Session Name** Terminal session name of the environment where the bot is running - **Bot ID** GUID of the bot that is executing the workflow _RandomVariable_ is an integer value. All other variables are strings. Debugging the _Runtime Variables_ action step is not possible. Therefore, the debug functionality is disabled and you cannot set breakpoints for this action step. ## Properties - **Write Runtime Variables to Logfile** When enabled, the workflow writes runtime variables to the Stc log file. ## Outbound Variables - **Runtime Variables.\[name of the runtime variables\]** Content of _Runtime variables_. ## Wizard Use the wizard to add new runtime variables and specify their **Name** and **Description**. To make variables available in later transactions, select **Make Variables available in all further Transactions**. Use the **Delete** button to remove variables. The values listed in **Sample Data** are for local testing. If a bot completes the workflow, the workflow re-determines the values at each run. Some variables such as **Random Variable** show a **Settings** menu that you can expand for further configuring the variable. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Runtime Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Runtime Variables action step provides a set of variables that the workflow populates at runtime. Use these variables to get information from the runtime context. The following variables are available: - **Project Name** Name of the _Workflow_ project - **Project GUID** GUID of the _Workflow_ project - **Run GUID** GUID related to the execution of the _Workflow_ (regenerated for each run) - **Time** Actual time as local time or UTC in configurable format - **Date** Actual date as local time or UTC in configurable format - **HostName** Name of _Host_ system - **UserName** Name of the user - **RandomVariable** Positive random number with a configurable range of values. The workflow generates a different number on each run. - **Business Process ID** ID of the business process - **Session Id** Terminal session ID of the environment where the bot is running - **Session Name** Terminal session name of the environment where the bot is running - **Bot ID** GUID of the bot that is executing the workflow _RandomVariable_ is an integer value. All other variables are strings. Debugging the _Runtime Variables_ action step is not possible. Therefore, the debug functionality is disabled and you cannot set breakpoints for this action step. ## Properties - **Write Runtime Variables to Logfile** When enabled, the workflow writes runtime variables to the Stc log file. ## Outbound Variables - **Runtime Variables.\[name of the runtime variables\]** Content of _Runtime variables_. ## Wizard Use the wizard to add new runtime variables and specify their **Name** and **Description**. To make variables available in later transactions, select **Make Variables available in all further Transactions**. Use the **Delete** button to remove variables. The values listed in **Sample Data** are for local testing. If a bot completes the workflow, the workflow re-determines the values at each run. Some variables such as **Random Variable** show a **Settings** menu that you can expand for further configuring the variable. --- product: RPA Builder version: 6.6 --- # Save Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Save Excel File Action Step to save the changes to the Excel file being modified inside the Excel Session at any point of the execution. For example, saving the Excel file after loop operations serves as a way to prevent data loss in case the workflow execution stops because of an unknown error. The Excel Session automatically saves the file at the end of its execution. The Save Excel File Action Step works only inside an Excel Session. Specify the file to modify in the [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session). > [!WARNING] Save Excel File cannot save the file if the Excel Session opens the file in read-only > mode. ## Properties This Action Step does not have any specific properties. See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a list of properties common to all Action Steps. ## Inbound Variables Save Excel File has no inbound variables. ## Outbound Variables - **Success** (bool) Confirms if the save file operation was successful. If the operation fails (`false`), the workflow run state is set to Error. ## See Also - [Excel Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Save Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Save Excel File action step to save the changes to the Excel file being modified inside the Excel Session at any point of the execution. For example, saving the Excel file after loop operations serves as a way to prevent data loss in case the workflow execution stops because of an unknown error. The Excel Session automatically saves the file at the end of its execution. The Save Excel File action step works only inside an Excel Session. Specify the file to modify in the [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session). > [!WARNING] Save Excel File cannot save the file if the Excel Session opens the file in read-only > mode. ## Properties This action step does not have any specific properties. See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a list of properties common to all action steps. ## Inbound Variables Save Excel File has no inbound variables. ## Outbound Variables - **Success** (bool) Confirms if the save file operation was successful. If the operation fails (`false`), the workflow run state is set to Error. ## See Also - [Excel Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations) --- product: RPA Builder version: 6.6 --- # Screenshot > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ takes a screenshot and saves it to the trace folder. You can use this screenshot to get feedback on what is happening at any point in a _Workflow_, which is specially helpful for debugging _Workflows_ running on distant machines. ## Properties - **Capture Area** - **Height** The height of the screenshot. Set _Height_ **and** _Width_ to 0 to capture the whole screen. - **Image Type** Determines if the screenshots will be saved as compressed JPG files or uncompressed BMP files or loss-free compressed PNG files. - **Shrink to \[%\]** Size in % to which the image shall be reduced to. This value refers to the length and the width of the image and not to its area or file size. You can enter any integer between 10 and 100. The default value is 50% for newly created Workflows and 100% for Workflows created with an older version of RPA Builder. - **Width** The width of the screenshot. Set _Height_ **and** _Width_ to 0 to capture the whole screen. - **X Coordinate/Offset** Defines the x-coordinate (horizontal axis) of the screenshot. If _Capture relative to_ is set to anything other than _None_, this defines the horizontal offset from the relative coordinates. - **Y Coordinate/Offset** Defines the y-coordinate (vertical axis) of the screenshot. If _Capture relative to_ is set to anything other than _None_, this defines the vertical offset from the relative coordinates. - **Custom Folder Settings** - **Filename** Defines which name the saved screenshot file should have. Leave empty for automatic name generation. - **Path** Where the screenshot is saved to. - **Use Custom Settings** Specifies whether to save the screenshot in a custom folder with a custom name. If not selected, screenshots will be saved within the usual trace folder (and will subsequently be part of analysis packages). ## Wizard - **Define Screenshot Area** It is possible to restrict the screenshot to a certain part of the screen. This area is captured in the same way as described in the section Add pattern from screen capture (Capture Pattern). - **Set to full screen** Captures the entire screen. - **Image Size \[%\]** Size in percent, to which the image shall be reduced to. In the Wizard you can set this value in steps of 10 with the help of the slider. In the Properties you can enter any integer between 10 and 100. The percentage given refers to the length and the width of the image and not to the image’s file size or its area. For example if you set the reduction to Shrink To 50%, the area of the image is reduced to 25%. The default value for newly created Workflows is set to 50%. - **Capture relative to** Takes a screenshot relative to a previous _Image Search_ result. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Screenshot > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step takes a screenshot and saves it to the trace folder. You can use this screenshot to get feedback on what is happening at any point in a _Workflow_, which is specially helpful for debugging _Workflows_ running on distant machines. ## Properties - **Capture Area** - **Height** The height of the screenshot. Set _Height_ **and** _Width_ to 0 to capture the whole screen. - **Image Type** Determines if the screenshots will be saved as compressed JPG files or uncompressed BMP files or loss-free compressed PNG files. - **Shrink to \[%\]** Size in % to which the image shall be reduced to. This value refers to the length and the width of the image and not to its area or file size. You can enter any integer between 10 and 100. The default value is 50% for newly created Workflows and 100% for Workflows created with an older version of RPA Builder. - **Width** The width of the screenshot. Set _Height_ **and** _Width_ to 0 to capture the whole screen. - **X Coordinate/Offset** Defines the x-coordinate (horizontal axis) of the screenshot. If _Capture relative to_ is set to anything other than _None_, this defines the horizontal offset from the relative coordinates. - **Y Coordinate/Offset** Defines the y-coordinate (vertical axis) of the screenshot. If _Capture relative to_ is set to anything other than _None_, this defines the vertical offset from the relative coordinates. - **Custom Folder Settings** - **Filename** Defines which name the saved screenshot file should have. Leave empty for automatic name generation. - **Path** Where the screenshot is saved to. - **Use Custom Settings** Specifies whether to save the screenshot in a custom folder with a custom name. If not selected, screenshots will be saved within the usual trace folder (and will subsequently be part of analysis packages). ## Wizard - **Define Screenshot Area** It is possible to restrict the screenshot to a certain part of the screen. This area is captured in the same way as described in the section Add pattern from screen capture (Capture Pattern). - **Set to full screen** Captures the entire screen. - **Image Size \[%\]** Size in percent, to which the image shall be reduced to. In the Wizard you can set this value in steps of 10 with the help of the slider. In the Properties you can enter any integer between 10 and 100. The percentage given refers to the length and the width of the image and not to the image’s file size or its area. For example if you set the reduction to Shrink To 50%, the area of the image is reduced to 25%. The default value for newly created Workflows is set to 50%. - **Capture relative to** Takes a screenshot relative to a previous _Image Search_ result. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Search in Google Drive > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Search for files or folders in your Google Drive, including your shared drives. This action step returns the number of matches found, the file or folder IDs, and the names of the files or folders found. You can add variables, filters, and operators to your search query. ## Configure Authentication Settings Configure your authentication settings for the Google API service account in the **Authentication Settings** panel. Select **Pin credentials** to specify the activity parameter containing the credentials, or select **Use custom settings** to provide the information inline. You can either import a JSON file with your Google API credentials information or specify the authentication information manually. ## Configure Search Settings To configure search settings in the wizard: 1. Enter your search terms in the **Search Query** textbox. The **Insert filters** and **Insert operators** dropdown lists contain the most common filters and operators. However, you can use any supported Google [search query terms and operators](https://developers.google.com/workspace/drive/api/guides/ref-search-terms). 2. To search in all shared drives, in addition to **My Drive**, select **Include all files from share drives**. 3. Select the criteria to sort your results in the **Order by** dropdown list. ## Properties - **Authentication Settings** - **Auth Provider x509 Cert URL** Authentication provider certificate URL for the Google API credentials. - **Auth URI** OAuth2 authentication URI for the Google API credentials. - **Client Email** Client email of the Google API credentials. - **Client ID** Client ID of the Google API credentials. - **Client x509 Cert URL** Client certificate URL for the Google API credentials. - **Credential Type** Type of Google API credentials. For example, `service_account`. - **Google API Service Account Credentials** Activity parameter containing all Google API credentials. - **Project ID** Project ID of the Google API credentials. - **Token URI** OAuth2 token URI for the Google API credentials. - **Universe Domain** Universe domain of the Google API credentials. - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) - **Include all files from shared drives** Option to search files and folders in your shared drives in addition to My Drive - **Search Query** String containing the search query Use the wizard for assistance while building your query. You can use any of the supported Google [search query terms and operators](https://developers.google.com/workspace/drive/api/guides/ref-search-terms). ## Inbound Variables - **{A} replaced by** …​ **{Z} replaced by** - **Credential Type** - **Project ID** - **Private Key ID** - **Private Key** - **Token URI** - **Auth Provider x509 Cert URL** - **Auth URI** - **Client Email** - **Client ID** - **Client x509 Cert URL** - **Universe Domain** - **Google API Service Account Credentials** ## Outbound Variables - **Amount found matches** Number of files or folders found - **IDs of files or folders found** Array of strings containing the IDs of the files or folders found - **Names of files or folders found** Array of strings containing the names of the files or folders found - **Success** String indicating if the search was successful and returned no errors (`True`) To confirm if the search returns any results, verify if the **Amount found matches** is higher than zero. The **Success** variable returns (`True`) even if there are no results in a successful search. ## See Also - [Activity Parameters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters) - [Google Workspace](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-drive-operations) --- product: RPA Builder version: 6.6 --- # Search Pattern > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Search Pattern_ _Action Step_ searches for one or more patterns within a defined _Search Area_ on the screen. Patterns can be taken directly from a screenshot or from the _Workflow_'s _Pattern Gallery_. All patterns for a _Workflow_ are saved in the _Pattern Gallery_. The search algorithm is fast and stable. Search results can be reused in subsequent _Action Steps_, for example as a reference point for mouse clicks. Various aspects of the search are configurable. You may choose to search for one of more patterns, decide whether an image may appear in the search area or not, and exclude patterns containing the pattern being searched for within them from the search. A tolerance for deviations between the pattern found and the pattern being searched for may also be set. It is possible to monitor that the position or existence of the image does not change within a defined period. The search can be tested prior to executing the _Workflow_. An evaluation window shows possible matches and provides information about how search results could be improved. ## Properties - **Image Processing** - **Allow multiple matches of a found pattern** If this option is selected, the pattern may appear more than once in the _Search Area_. When this option is not selected, the _Search Pattern Action Step_ returns an error if the pattern is found but occurs more than once. In the wizard this option is listed under _Search Settings_ as _Allow multiple matches of a found pattern_. If the coordinates of the pattern found are to be reused subsequently in a different _Action Step_ (e.g. for mouse clicks relative to pattern), the coordinates used in the case of multiple identical patterns found will be the ones for the pattern furthest to the left within the _Search_ _Area_. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. - **Hide mouse** Moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. - **Margin for automatic search area \[pixel\]** Number of pixels around a found pattern for defining the search area automatically. Valid values are between 0 and 999; the default-value is 100. - **Neighborhood Pixel** Indicates the number of pixels by which the position of a pixel found may differ from the specified position. The default value for this setting is 1. It is easier to search for similar images if the value is greater than 1, which means the images are not 100% identical based on pixels. The percentage score may vary by some percentage values depending on position though. - **Original Desktop Size** Screen resolution at the time the image search was last tested. This size is required in order to scale the _Search Area_ (but not the _Search Pattern_) if the _Workflow_ is used on a device with a different screen resolution. - **Pattern Steady check** Enables the option **Wait For Pattern Steady Timeout** and checks whether the coordinates of the pattern found change again within this time period. If not, the search is successful and ends; otherwise the search is repeated. - **Reduce Score By \[%\]** When testing the _Search Pattern_ settings, matches by this percentage below the _Score_ are also shown. These are marked yellow in the test result window. In the wizard, this setting shows under _Search Settings_ and appears as a yellow zone on the _Required matching precision (%)_ slider. - **Score \[%\]** Indicates the accuracy in percent by which the pattern found must match the specified pattern in order to be considered found. In the wizard, this setting is labeled _Required matching precision (%)_ under _Search Settings_ and appears as a green zone on a slider. - **Search Mode** - **Match all patterns** The search is successful if all of the specified patterns are found. - **Match only one pattern** The search is successful if exactly one of the specified patterns is found. - **Match one or more patterns** The search is successful if at least one of the specified patterns is found. - **Wait for Pattern Steady Timeout \[ms\]** If the option **Pattern steady check** is selected, a check for whether the pattern found is still in the same position, or whether it still does not appear in the _Search Area_, is performed according to the interval value entered here (or in the wizard under **Search Settings** > **Check whether found match stays in same location every \[time in ms\] milliseconds**). If this is the case, the search is successful and ends. Otherwise, the search is repeated either until it is successful or the _Action Step_ times out. A value of 0 means that the position of the pattern found is not rechecked after having been found. The _Action Step_ does not then wait beyond its runtime. ## Inbound Variables - **Find Coordinate** If there is at least one other Action Step that uses patterns before the Action Step Search Pattern, the outbound variable _Find coordinate_ becomes the inbound variable for the subsequent Action Steps. ## Outbound Variables - **Find Coordinate** Topnleft corner of the pattern that has been found successfully. If a search is made for multiple patterns and they are found, the coordinates returned are of the image on the far left of the series of patterns being searched for as specified in the wizard. If multiple identical patterns are found in the same position on the far left of the _Search Area_, the topmost one is used for the coordinates. - **Found Pattern Name** The name of the matched pattern as entered in the _Pattern Gallery_. - **Found Matched Pattern Count** Number of found search patterns from the _Regular_ category. The number of matches can consist of matches for different patterns. Matches of patterns of the category _Ignore_ and _Exclude_ are not counted. The **Found Matched Pattern Count** is 0 if _Search Pattern_ returns an error, even if matches for patterns of the _Regular_ category are found. ## Wizard The _Search Pattern Wizard_ enables you to select _Search Patterns_ and the key search settings. Pattern Strip is a UI module that consists of a list of Search Patterns, their associated options, and a menu bar. See [The Pattern Strip Module](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture#pattern-strip) for a description of the module’s functionality and all available pattern operations. Click **OK** to confirm the configuration settings or **Cancel** as applicable. The **Test** button evaluates the search and displays the results in the _Search Results_ window. ### Regular Patterns This section lists patterns that are to be found. The number of patterns that you can exclude is limited to 25. There are three ways of searching for patterns: - **Match only one pattern** The search is successful if _exactly one_ of the selected patterns is found in the _Search Area_. An error is returned if none or a number of the selected patterns are found. - **Match one or more patterns** The search is successful if _at least one_ of the selected patterns is found in the _Search Area_. An error is returned if none of the selected patterns are found. - **Match all patterns** The search is successful if _all_ of the selected patterns are found in the _Search Area_. An error is returned if none or not all of the selected patterns are found. If a pattern appears multiple times, a successful search will occur as above if _Allow multiple matches of a found pattern_ is enabled in the _Search Settings_. The _Action Step_ will otherwise return an error if the same pattern appears multiple times. Chose a pattern from the _Pattern Gallery_ or create a new one by using the **Capture** button. ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image1.png) Click to select one or multiple patterns and delete or move them as a group. When a pattern is selected, a white tick will appear on a green background in the top right corner. To undo the selection, click the _Clear Selection_ button. A vertical black line indicates where the pattern can be moved to using drag and drop. If _Match one or more patterns_ is selected, the first pattern in the list will have a blue border. This image can be used as a reference point for other Action Steps as the Workflow progresses (see Other Uses of Matched Patterns). #### Capture Pattern One way of defining a pattern is to take a screenshot that shows it. All patterns captured using the _Search Pattern_ _Action Step_ are transferred to the _Workflow_'s _Pattern Gallery_. For a complete description of the Capture Pattern functionality, see [Adding a Pattern from Screen Capture](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture). #### Add Pattern from Gallery If the _Pattern Gallery_ for the _Workflow_ already contains patterns, they can be added to the list of patterns for the _Action Step_ using the _Add from Gallery_ button. The _Add from Gallery_ window shows all the images that the _Workflow_'s _Pattern Gallery_ contains, categorized into the **Available Groups**. A white tick on a blue background in the top right corner indicates patterns which are already included in the _Search Pattern_ _Action Step_. Patterns already included in another category of the same _Action Step_ do not show. ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image2.png) To add patterns to the search, simply use the mouse to click and select. Use the same method to deselect patterns which should no longer be included in the search. Click OK to confirm the selection and add it to the pattern list for the _Action Step_. ### Ignore All Matches within These Patterns ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image3.png) If you are checking for the single occurrence of a pattern that may be part of other patterns, exclude patterns containing the searched-for pattern within them from the search. The number of patterns that you can exclude is limited to 25. You can add patterns to be excluded from the search by using the **Capture** or by selecting them from the Pattern Gallery. Consider an example where you want to search for the word _staff_ as a noun but only if it doesn’t form part of another term like _staffing_. In this case, include the _staff_ pattern in the green **Regular** search patterns section among the patterns being searched for and add the patterns to ignore, like _staffing_ or _staffing_, in the blue **Ignored** search patterns section. Areas in a single color are not taken into account within the pattern. It is therefore not sufficient in the previous example to capture staff with free space at the right edge, because this free space will not form part of the pattern being searched for due to a lack of _features_. ### Make Sure None of These Patterns Appear ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image4.png) You can use the _Search Pattern_ _Action Step_ to check that a certain pattern does not appear. When you are rechecking that a pattern does not appear, select **Check whether found match stays in same location every \[time in ms\] milliseconds** in the _Search Settings_ and set the interval value (_Wait for Image Steady Timeout \[ms\]_) to other than 0. As described before, patterns to be excluded from the search can be inserted here using a screenshot or from the Pattern Gallery. The number of patterns that you can exclude is limited to 25. ### Changing the Category for a Search Pattern Use the **Move to…​** button in the menu bar to move the selected patterns between the categories _Regular_ and _Ignored_. ### Search Settings ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image5.png) - **Required matching precision** The required matching precision percentage in percent shows as a green zone on a slider. A yellow zone to the left of the green indicates the range that was entered in the _Properties_ under _Reduce Score by \[%\]_ to monitor criteria during the test in an advanced search. - **Use general timeout** Select this option to use the general _Timeout_ or specify one in the **Timeout \[sec\]** box to use a custom value. - **Check whether found match stays in same location every \[time\_in\_ms\] milliseconds** Select this option and specify a time value to check if the match stays in the same location after the set interval. This option takes the same value as **Wait for Pattern Steady Timeout \[ms\]** from the properties panel. When you select this option, ensure that you specify a proper _Timeout_ depending on this value. Because the repeated image search has to be completed in an interval defined here within the timeout, the recommended maximum interval value is ½\*_timeout_. If you are using the **Excluded: Make sure none of these patterns appears** search, enable this option and set the interval value to other than 0. - **Allow multiple matches of a found of a pattern** Select this option to allow the pattern to occur in the _Search Area_ more than once. When this option is not selected, the _Search Pattern Action Step_ returns an error if the pattern is found more than once. - **Move mouse to 0,0 while pattern search is active** Select this option to move the cursor during the search to the upper left corner of the screen to the position with the coordinates `x=0` and `y=0`. This feature prevents unwanted mouse hover effects. Independently of this setting, the cursor is not included in the search, so patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. - **Search Area** The search area is displayed on the right side of the settings section. - **Define manually** Enables you to define the search area by using drag&drop. - **Define automatically** Automatically defines a search area containing all _regular_ matches visible at the time of the definition of the search area. - **Reset to fullscreen** Turns the search area back to full screen. - **Relative To** The Search Area can be set to either a _fixed_ or dynamic (_relative_) position. The **Relative To** dropdown menu lists all variables of type _Coordinates_ that are available at this point. These include, for example, Outbound Variables from a previous _Search Pattern_ Action Step in the same transaction. When you select a coordinate in the wizard as _Relative To_, an offset vector is immediately calculated. While the _Workflow_ is being designed, this points from the selected coordinate to the top-left corner of the _Search Area_. At _Workflow_ runtime, the calculated offset vector is applied to the real-time value of the _Search Area_ that the coordinate relates to. This means that the _Search Area_ at _Workflow_ runtime is positioned at exactly the same distance from the “Relative To” coordinate as at the time of design. ### Test Pressing the **Test** button launches the search independently of _Workflow_ execution and open the _Search Results_ window where the search is evaluated. This can provide hints about possible improvements that could be made to the _Search Settings_. ![Search Result screen](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image6.png) The screen content at the time the test was performed takes up the main part of the window _Search Result_. A blue border surrounds the _Search Area_. The area outside the _Search Area_ is shown grayed. _Matches_ are highlighted in color. The color legend at the right side of the window works simultaneously as a check box panel for switching the display of the different match types on and off. If there are no matches of a certain type, the according check box field is shown grayed. _Search Patterns_ of the list _Match all / only one / one or more pattern(s)_ found within the defined precision are highlighted green. Matches from the list _Ignore all matches within these patterns_ are highlighted light blue and matches from the list _Make sure none of these patterns appear_ are highlighted red. A yellow highlighting shows that the search pattern could have been found if the precision had been set lower. This reduced precision is calculated by deducting the _Reduced Score_ from the _Score._ In each case, the precision of the match is stated. Matches outside of the _Search Area_ are marked in gray color irrespective of their type. Patterns with a _Color Spot_ that are found but do not match the _Color Spot_ color at a specific position are marked in blue. You can see the type of every match in the details pane on the right side of the window. On opening the window, the size of the screenshot is adjusted so that the whole screenshot is visible. You can zoom in to or out of the image by dragging the slider at the right side of the screenshot. It is also possible to do this by mouse wheel. Double click on the slider shows the image in its original size. If the image is enlarged, scroll bars for adjusting the position of the view appear on the right side and on the lower border of the image. Below the slider the current mouse position in relation to the screen shown in the screenshot is displayed dynamically. Mouse hover over a match shows the name, a thumbnail and the matching precision as a tooltip. Clicking on a found Pattern on the screenshot shows details to this Pattern on the right side of the window. Clicking a pattern in the tab _Pattern_ at the lower border of the window shows details to all matches to this pattern. Clicking a match in the screenshot only shows details for this single match. Details contain the name, type, size in pixels and a thumbnail of the pattern along with a color-marked listing of the found matches. For all matches, the coordinates of the upper left corner and the matching precision are displayed. The coloring is the same as described before. ![Search Result screen showing found patterns](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-search-pattern-image7.png) The tab _Search Results Summary_ shows a textual overview over the search settings and the search result. If the search failed because of one single pattern, this pattern is shown in tab _Failure Reason_. ## Other Uses of Matched Patterns If mouse clicks are to be performed relative to a matched image and, at the same time, the search is for more than one image, the image that the mouse clicks relate to must be at the top of the list. If the first image on the list is not found, the mouse click will be inserted relative to the first image from the list that is found. If the first image on the list that is found occurs multiple times, the image located on the far left of the screen will be used. If there are multiple images in the identical lateral position on the left, the topmost one will be used. If multiple identical images are found, the image on the far left or top far left will be used. ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-pattern-gallery) - [Pattern Select](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-pattern-select) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/6.6/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Search Pattern > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Search Pattern_ action step searches for one or more patterns within a defined _Search Area_ on the screen. Patterns can be taken directly from a screenshot or from the _Workflow_'s _Pattern Gallery_. All patterns for a _Workflow_ are saved in the _Pattern Gallery_. The search algorithm is fast and stable. Search results can be reused in subsequent action steps, for example as a reference point for mouse clicks. Various aspects of the search are configurable. You may choose to search for one of more patterns, decide whether an image may appear in the search area or not, and exclude patterns containing the pattern being searched for within them from the search. A tolerance for deviations between the pattern found and the pattern being searched for may also be set. It is possible to monitor that the position or existence of the image does not change within a defined period. The search can be tested prior to executing the _Workflow_. An evaluation window shows possible matches and provides information about how search results could be improved. ## Properties - **Image Processing** - **Allow multiple matches of a found pattern** If this option is selected, the pattern may appear more than once in the _Search Area_. When this option is not selected, the _Search Pattern action step_ returns an error if the pattern is found but occurs more than once. In the wizard this option is listed under _Search Settings_ as _Allow multiple matches of a found pattern_. If the coordinates of the pattern found are to be reused subsequently in a different action step (e.g. for mouse clicks relative to pattern), the coordinates used in the case of multiple identical patterns found will be the ones for the pattern furthest to the left within the _Search_ _Area_. If multiple identical search images are located on top of each other in the same position on the left, the topmost image will be selected. - **Hide mouse** Moves the cursor during the search to the upper left corner of the screen to the position with the coordinates x=0 and y=0. By this way unwanted mouse hover effects can be avoided. Independently of this setting the cursor is not included in the search. So also search patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. - **Margin for automatic search area \[pixel\]** Number of pixels around a found pattern for defining the search area automatically. Valid values are between 0 and 999; the default-value is 100. - **Neighborhood Pixel** Indicates the number of pixels by which the position of a pixel found may differ from the specified position. The default value for this setting is 1. It is easier to search for similar images if the value is greater than 1, which means the images are not 100% identical based on pixels. The percentage score may vary by some percentage values depending on position though. - **Original Desktop Size** Screen resolution at the time the image search was last tested. This size is required in order to scale the _Search Area_ (but not the _Search Pattern_) if the _Workflow_ is used on a device with a different screen resolution. - **Pattern Steady check** Enables the option **Wait For Pattern Steady Timeout** and checks whether the coordinates of the pattern found change again within this time period. If not, the search is successful and ends; otherwise the search is repeated. - **Reduce Score By \[%\]** When testing the _Search Pattern_ settings, matches by this percentage below the _Score_ are also shown. These are marked yellow in the test result window. In the wizard, this setting shows under _Search Settings_ and appears as a yellow zone on the _Required matching precision (%)_ slider. - **Score \[%\]** Indicates the accuracy in percent by which the pattern found must match the specified pattern in order to be considered found. In the wizard, this setting is labeled _Required matching precision (%)_ under _Search Settings_ and appears as a green zone on a slider. - **Search Mode** - **Match all patterns** The search is successful if all of the specified patterns are found. - **Match only one pattern** The search is successful if exactly one of the specified patterns is found. - **Match one or more patterns** The search is successful if at least one of the specified patterns is found. - **Wait for Pattern Steady Timeout \[ms\]** If the option **Pattern steady check** is selected, a check for whether the pattern found is still in the same position, or whether it still does not appear in the _Search Area_, is performed according to the interval value entered here (or in the wizard under **Search Settings** > **Check whether found match stays in same location every \[time in ms\] milliseconds**). If this is the case, the search is successful and ends. Otherwise, the search is repeated either until it is successful or the action step times out. A value of 0 means that the position of the pattern found is not rechecked after having been found. The action step does not then wait beyond its runtime. ## Inbound Variables - **Find Coordinate** If there is at least one other action step that uses patterns before the action step Search Pattern, the outbound variable _Find coordinate_ becomes the inbound variable for the subsequent action steps. ## Outbound Variables - **Find Coordinate** Topnleft corner of the pattern that has been found successfully. If a search is made for multiple patterns and they are found, the coordinates returned are of the image on the far left of the series of patterns being searched for as specified in the wizard. If multiple identical patterns are found in the same position on the far left of the _Search Area_, the topmost one is used for the coordinates. - **Found Pattern Name** The name of the matched pattern as entered in the _Pattern Gallery_. - **Found Matched Pattern Count** Number of found search patterns from the _Regular_ category. The number of matches can consist of matches for different patterns. Matches of patterns of the category _Ignore_ and _Exclude_ are not counted. The **Found Matched Pattern Count** is 0 if _Search Pattern_ returns an error, even if matches for patterns of the _Regular_ category are found. ## Wizard The _Search Pattern Wizard_ enables you to select _Search Patterns_ and the key search settings. Pattern Strip is a UI module that consists of a list of Search Patterns, their associated options, and a menu bar. See [The Pattern Strip Module](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture#pattern-strip) for a description of the module’s functionality and all available pattern operations. Click **OK** to confirm the configuration settings or **Cancel** as applicable. The **Test** button evaluates the search and displays the results in the _Search Results_ window. ### Regular Patterns This section lists patterns that are to be found. The number of patterns that you can exclude is limited to 25. There are three ways of searching for patterns: - **Match only one pattern** The search is successful if _exactly one_ of the selected patterns is found in the _Search Area_. An error is returned if none or a number of the selected patterns are found. - **Match one or more patterns** The search is successful if _at least one_ of the selected patterns is found in the _Search Area_. An error is returned if none of the selected patterns are found. - **Match all patterns** The search is successful if _all_ of the selected patterns are found in the _Search Area_. An error is returned if none or not all of the selected patterns are found. If a pattern appears multiple times, a successful search will occur as above if _Allow multiple matches of a found pattern_ is enabled in the _Search Settings_. The action step will otherwise return an error if the same pattern appears multiple times. Chose a pattern from the _Pattern Gallery_ or create a new one by using the **Capture** button. ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image1.png) Click to select one or multiple patterns and delete or move them as a group. When a pattern is selected, a white tick will appear on a green background in the top right corner. To undo the selection, click the _Clear Selection_ button. A vertical black line indicates where the pattern can be moved to using drag and drop. If _Match one or more patterns_ is selected, the first pattern in the list will have a blue border. This image can be used as a reference point for other Action Steps as the Workflow progresses (see Other Uses of Matched Patterns). #### Capture Pattern One way of defining a pattern is to take a screenshot that shows it. All patterns captured using the _Search Pattern_ action step are transferred to the _Workflow_'s _Pattern Gallery_. For a complete description of the Capture Pattern functionality, see [Adding a Pattern from Screen Capture](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture). #### Add Pattern from Gallery If the _Pattern Gallery_ for the _Workflow_ already contains patterns, they can be added to the list of patterns for the action step using the _Add from Gallery_ button. The _Add from Gallery_ window shows all the images that the _Workflow_'s _Pattern Gallery_ contains, categorized into the **Available Groups**. A white tick on a blue background in the top right corner indicates patterns which are already included in the _Search Pattern_ action step. Patterns already included in another category of the same action step do not show. ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image2.png) To add patterns to the search, simply use the mouse to click and select. Use the same method to deselect patterns which should no longer be included in the search. Click OK to confirm the selection and add it to the pattern list for the action step. ### Ignore All Matches within These Patterns ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image3.png) If you are checking for the single occurrence of a pattern that may be part of other patterns, exclude patterns containing the searched-for pattern within them from the search. The number of patterns that you can exclude is limited to 25. You can add patterns to be excluded from the search by using the **Capture** or by selecting them from the Pattern Gallery. Consider an example where you want to search for the word _staff_ as a noun but only if it doesn’t form part of another term like _staffing_. In this case, include the _staff_ pattern in the green **Regular** search patterns section among the patterns being searched for and add the patterns to ignore, like _staffing_ or _staffing_, in the blue **Ignored** search patterns section. Areas in a single color are not taken into account within the pattern. It is therefore not sufficient in the previous example to capture staff with free space at the right edge, because this free space will not form part of the pattern being searched for due to a lack of _features_. ### Make Sure None of These Patterns Appear ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image4.png) You can use the _Search Pattern_ action step to check that a certain pattern does not appear. When you are rechecking that a pattern does not appear, select **Check whether found match stays in same location every \[time in ms\] milliseconds** in the _Search Settings_ and set the interval value (_Wait for Image Steady Timeout \[ms\]_) to other than 0. As described before, patterns to be excluded from the search can be inserted here using a screenshot or from the Pattern Gallery. The number of patterns that you can exclude is limited to 25. ### Changing the Category for a Search Pattern Use the **Move to…​** button in the menu bar to move the selected patterns between the categories _Regular_ and _Ignored_. ### Search Settings ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image5.png) - **Required matching precision** The required matching precision percentage in percent shows as a green zone on a slider. A yellow zone to the left of the green indicates the range that was entered in the _Properties_ under _Reduce Score by \[%\]_ to monitor criteria during the test in an advanced search. - **Use general timeout** Select this option to use the general _Timeout_ or specify one in the **Timeout \[sec\]** box to use a custom value. - **Check whether found match stays in same location every \[time\_in\_ms\] milliseconds** Select this option and specify a time value to check if the match stays in the same location after the set interval. This option takes the same value as **Wait for Pattern Steady Timeout \[ms\]** from the properties panel. When you select this option, ensure that you specify a proper _Timeout_ depending on this value. Because the repeated image search has to be completed in an interval defined here within the timeout, the recommended maximum interval value is ½\*_timeout_. If you are using the **Excluded: Make sure none of these patterns appears** search, enable this option and set the interval value to other than 0. - **Allow multiple matches of a found of a pattern** Select this option to allow the pattern to occur in the _Search Area_ more than once. When this option is not selected, the _Search Pattern action step_ returns an error if the pattern is found more than once. - **Move mouse to 0,0 while pattern search is active** Select this option to move the cursor during the search to the upper left corner of the screen to the position with the coordinates `x=0` and `y=0`. This feature prevents unwanted mouse hover effects. Independently of this setting, the cursor is not included in the search, so patterns covered by the cursor symbol are found. After the search the cursor is set back to its original position. - **Search Area** The search area is displayed on the right side of the settings section. - **Define manually** Enables you to define the search area by using drag&drop. - **Define automatically** Automatically defines a search area containing all _regular_ matches visible at the time of the definition of the search area. - **Reset to fullscreen** Turns the search area back to full screen. - **Relative To** The Search Area can be set to either a _fixed_ or dynamic (_relative_) position. The **Relative To** dropdown menu lists all variables of type _Coordinates_ that are available at this point. These include, for example, Outbound Variables from a previous _Search Pattern_ action step in the same transaction. When you select a coordinate in the wizard as _Relative To_, an offset vector is immediately calculated. While the _Workflow_ is being designed, this points from the selected coordinate to the top-left corner of the _Search Area_. At _Workflow_ runtime, the calculated offset vector is applied to the real-time value of the _Search Area_ that the coordinate relates to. This means that the _Search Area_ at _Workflow_ runtime is positioned at exactly the same distance from the “Relative To” coordinate as at the time of design. ### Test Pressing the **Test** button launches the search independently of _Workflow_ execution and open the _Search Results_ window where the search is evaluated. This can provide hints about possible improvements that could be made to the _Search Settings_. ![Search Result screen](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image6.png) The screen content at the time the test was performed takes up the main part of the window _Search Result_. A blue border surrounds the _Search Area_. The area outside the _Search Area_ is shown grayed. _Matches_ are highlighted in color. The color legend at the right side of the window works simultaneously as a check box panel for switching the display of the different match types on and off. If there are no matches of a certain type, the according check box field is shown grayed. _Search Patterns_ of the list _Match all / only one / one or more pattern(s)_ found within the defined precision are highlighted green. Matches from the list _Ignore all matches within these patterns_ are highlighted light blue and matches from the list _Make sure none of these patterns appear_ are highlighted red. A yellow highlighting shows that the search pattern could have been found if the precision had been set lower. This reduced precision is calculated by deducting the _Reduced Score_ from the _Score._ In each case, the precision of the match is stated. Matches outside of the _Search Area_ are marked in gray color irrespective of their type. Patterns with a _Color Spot_ that are found but do not match the _Color Spot_ color at a specific position are marked in blue. You can see the type of every match in the details pane on the right side of the window. On opening the window, the size of the screenshot is adjusted so that the whole screenshot is visible. You can zoom in to or out of the image by dragging the slider at the right side of the screenshot. It is also possible to do this by mouse wheel. Double click on the slider shows the image in its original size. If the image is enlarged, scroll bars for adjusting the position of the view appear on the right side and on the lower border of the image. Below the slider the current mouse position in relation to the screen shown in the screenshot is displayed dynamically. Mouse hover over a match shows the name, a thumbnail and the matching precision as a tooltip. Clicking on a found Pattern on the screenshot shows details to this Pattern on the right side of the window. Clicking a pattern in the tab _Pattern_ at the lower border of the window shows details to all matches to this pattern. Clicking a match in the screenshot only shows details for this single match. Details contain the name, type, size in pixels and a thumbnail of the pattern along with a color-marked listing of the found matches. For all matches, the coordinates of the upper left corner and the matching precision are displayed. The coloring is the same as described before. ![Search Result screen showing found patterns](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-search-pattern-image7.png) The tab _Search Results Summary_ shows a textual overview over the search settings and the search result. If the search failed because of one single pattern, this pattern is shown in tab _Failure Reason_. ## Other Uses of Matched Patterns If mouse clicks are to be performed relative to a matched image and, at the same time, the search is for more than one image, the image that the mouse clicks relate to must be at the top of the list. If the first image on the list is not found, the mouse click will be inserted relative to the first image from the list that is found. If the first image on the list that is found occurs multiple times, the image located on the far left of the screen will be used. If there are multiple images in the identical lateral position on the left, the topmost one will be used. If multiple identical images are found, the image on the far left or top far left will be used. ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-pattern-gallery) - [Pattern Select](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-pattern-select) - [Using Search Patterns in a Workflow](https://docs.mulesoft.com/rpa-builder/latest/adding-a-pattern-from-screen-capture) --- product: RPA Builder version: 6.6 --- # Select Case > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Select Case_ Action Step makes it possible to match the contents of a variable against certain predefined cases. For example, you can search the content of a text variable for specific information and specify different Action Steps to be executed depending on what is found. The “DoElse” component is always present. This is used to provide a default action for cases that have not been specified. ## Properties **Misc** - **CaseValue** Enter the comparison value for the selected case query. This is the value that will be compared with a variable or that will be searched for. - **Text Affinity** Value for the textual similarity in a fuzzy search, expressed as a percentage. A value of 0% denotes no similarity while a value of 100% means identical. The default value is 50%. - **CompareValue String** - **Compare Value Int** Integer - **Compare Value Bool** - **Compare Value Float** Other properties that are the same in all Action Steps are described in section **Common Properties**. For reasons of clarity they are not shown here. ## Wizard - **Type** One of the following variable types: - **Integer** Positive or negative integer - **Alphanumeric** Characters that are either letters or numeric digits, or both (text) - **Boolean** Boolean value (True/False) - **Float** Positive or negative floating-point number If you have already defined cases and then change the type, a warning will be shown informing you that all the cases in _Select Case_ will be lost. This is because cases in a _Select Case_ are generated based on the previously selected data type and it is not possible to simply convert the type of existing cases without further consideration. - **Cases** You can create one or more cases depending on which data type you have selected above. After you have created a case, you can modify it. ## Data Types and Comparison Options
File typeComparison options

Integer (positive or negative whole number)

≠ variable must not be a match

< variable must be less than Value

> variable must be greater than Value

≤ variable must be less than or equal to Value

≥ variable must be greater than or equal to Value

Alphanumeric (text)

Full match: Value found must match exactly

Substring: Part of the text in Value must match

Regex comparison: Search for matches for the regular expression entered as the Value. More information about Regular Expressions is provided in the section on Using Regular Expressions.

Fuzzy: Search for text similar to that in Value Adjust the level of similarity, expressed as a percentage, using the slider under “Text Affinity”. The default value is 50%. A higher value means that fewer matches will be found.

Boolean (True or False)

For Boolean there is only one case because this is sufficient in combination with “DoElse” to cover the two possibilities of True and False.

False: Value in evaluated variable must be False.

True: Value in evaluate variable must be True.

Float (positive or negative floating-point number)

≠ variable must not be a match

< variable must be less than Value

> variable must be greater than Value

≤ variable must be less than or equal to Value

≥ variable must be greater than or equal to Value

--- product: RPA Builder version: 6.7 is-latest-version: true --- # Select Case > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Select Case_ action step makes it possible to match the contents of a variable against certain predefined cases. For example, you can search the content of a text variable for specific information and specify different action steps to be executed depending on what is found. The “DoElse” component is always present. This is used to provide a default action for cases that have not been specified. ## Properties **Misc** - **CaseValue** Enter the comparison value for the selected case query. This is the value that will be compared with a variable or that will be searched for. - **Text Affinity** Value for the textual similarity in a fuzzy search, expressed as a percentage. A value of 0% denotes no similarity while a value of 100% means identical. The default value is 50%. - **CompareValue String** - **Compare Value Int** Integer - **Compare Value Bool** - **Compare Value Float** Other properties that are the same in all action steps are described in section **Common Properties**. For reasons of clarity they are not shown here. ## Wizard - **Type** One of the following variable types: - **Integer** Positive or negative integer - **Alphanumeric** Characters that are either letters or numeric digits, or both (text) - **Boolean** Boolean value (True/False) - **Float** Positive or negative floating-point number If you have already defined cases and then change the type, a warning will be shown informing you that all the cases in _Select Case_ will be lost. This is because cases in a _Select Case_ are generated based on the previously selected data type and it is not possible to simply convert the type of existing cases without further consideration. - **Cases** You can create one or more cases depending on which data type you have selected above. After you have created a case, you can modify it. ## Data Types and Comparison Options
File typeComparison options

Integer (positive or negative whole number)

≠ variable must not be a match

< variable must be less than Value

> variable must be greater than Value

≤ variable must be less than or equal to Value

≥ variable must be greater than or equal to Value

Alphanumeric (text)

Full match: Value found must match exactly

Substring: Part of the text in Value must match

Regex comparison: Search for matches for the regular expression entered as the Value. More information about Regular Expressions is provided in the section on Using Regular Expressions.

Fuzzy: Search for text similar to that in Value Adjust the level of similarity, expressed as a percentage, using the slider under “Text Affinity”. The default value is 50%. A higher value means that fewer matches will be found.

Boolean (True or False)

For Boolean there is only one case because this is sufficient in combination with “DoElse” to cover the two possibilities of True and False.

False: Value in evaluated variable must be False.

True: Value in evaluate variable must be True.

Float (positive or negative floating-point number)

≠ variable must not be a match

< variable must be less than Value

> variable must be greater than Value

≤ variable must be less than or equal to Value

≥ variable must be greater than or equal to Value

--- product: RPA Builder version: 6.6 --- # Select Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to select an option from a list box or a drop-down box. ## Properties - **Select Index** The index of the option to be selected. Only applicable if _Selection Method_ is _Index_. - **Select Text** The text of the option to be selected. Only applicable if _Selection Method_ is _Text_. - **Select Value** The value of the option to be selected. Only applicable if _Selection Method_ is _Value_. - **Selection Method** Decide which method should be used to identify the option which should be selected from the list or drop-down box. This can either be _Index_, _Text_, or _Value_. ## Inbound Variables - **Element XPath** - **Window Title** - **Value** - **Index** - **Text** ## Outbound Variables The Action Step _Select Web Element_ possesses no outbound variables. ## Wizard Use _Select Web Element_ to select an element inside a list or drop-down menu in a website or web application. If the element you want to select has an underlying hyperlink, use _Click Element_ instead. When you use the _Browser Wizard_ to select the drop-down menu that contains the element to use, all current options display in the **Available Options** field. After selecting an option, you can choose the method to identify it: - **Value**: The standard selection. On an average website, this is usually the value that changes the least. - **Text**: The text that shows in the picklist. Product names or similar values are easy to select in text form. - **Index**: The index might be imprecise, particularly on dynamic websites. Use **Index** only if the selected element is of secondary importance. When using Internet Explorer, selecting an option by index takes longer than with other browsers. You can use Pin variables to specify the value for the selection method. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Select Web Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use this _Web Automation_ object to select an option from a list box or a drop-down box. ## Properties - **Select Index** The index of the option to be selected. Only applicable if _Selection Method_ is _Index_. - **Select Text** The text of the option to be selected. Only applicable if _Selection Method_ is _Text_. - **Select Value** The value of the option to be selected. Only applicable if _Selection Method_ is _Value_. - **Selection Method** Decide which method should be used to identify the option which should be selected from the list or drop-down box. This can either be _Index_, _Text_, or _Value_. ## Inbound Variables - **Element XPath** - **Window Title** - **Value** - **Index** - **Text** ## Outbound Variables The action step _Select Web Element_ possesses no outbound variables. ## Wizard Use _Select Web Element_ to select an element inside a list or drop-down menu in a website or web application. If the element you want to select has an underlying hyperlink, use _Click Element_ instead. When you use the _Browser Wizard_ to select the drop-down menu that contains the element to use, all current options display in the **Available Options** field. After selecting an option, you can choose the method to identify it: - **Value**: The standard selection. On an average website, this is usually the value that changes the least. - **Text**: The text that shows in the picklist. Product names or similar values are easy to select in text form. - **Index**: The index might be imprecise, particularly on dynamic websites. Use **Index** only if the selected element is of secondary importance. When using Internet Explorer, selecting an option by index takes longer than with other browsers. You can use Pin variables to specify the value for the selection method. --- product: RPA Builder version: 6.6 --- # Send Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the _Send Mail_ Action Step, you can send a mail with the SMTP protocol. You can enter the recipient, the subject, or send attachments just as with other mail programs. You can only use the Send Mail Action Step within a Mail Session. You enter the information required for the connection to the mail server in the Mail Session. ## Properties **Send Mail Settings** **Body** Here, the content of the mail is displayed. A total of 3900 characters are available. **Enter error state when a file does not exist** If this checkbox is selected and if one of the attached files is not found in the production run, the Action Step is ended with an error. **First directory path** Path to the directory, in which the first file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **First file name** Contains the path to the first file that is to be attached. **Second directory path** Path to the directory, in which the second file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Second file name** Contains the path to the second file that is to be attached. **Subject** Subject of the mail. **Third directory path** Path to the directory, in which the third file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Third file name** Contains the path to the third file that is to be attached. ## Inbound Variables **To** Recipient. **Cc** Carbon copy. **Bcc** Blind carbon copy. **Subject** Subject of the mail. **First directory path** Path to the directory, in which the first file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **First file name** Contains the path to the first file that is to be attached. **Second directory path** Path to the directory, in which the second file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Second file name** Contains the path to the second file that is to be attached. **Third directory path** Path to the directory, in which the third file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Third file name** Contains the path to the third file that is to be attached. **Enter error state when a file does not exist** If this checkbox is selected and if one of the attached files is not found in the production run, the Action Step is ended with an error. ## Outbound Variables **IsSucceeded** Indicates whether an mail was sent successfully. ## Wizard The wizard is split into two tabs, **Message** and **Attachment**. In the Message area, you can enter text under **Body**. You can link the content with **Insert Available Variables**, assuming you defined variables in advance either using the Activity Parameters or the Workflow Based Variables. Select the encoding to use between UTF-8, UTF-16, Shift-JIS, and EUC-JP. The pin variable is only displayed if you have defined a variable of type Bool using the Activity Parameters or the Workflow Based Variables. In the Attachment area, you can add up to three attachments to the mail. Under Directory path, you define the path to the new file to be created. You can create an absolute path or a path relative to the _Base Path_. The default value is %STWS\_BASEPATH%. Select an existing path. To construct the path, you can also insert variables from the workflow. You can find further explanations under [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Send Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the Send Mail action step to send a mail with the SMTP protocol. You can enter the recipient, the subject, or send attachments just as with other mail programs. You can only use the Send Mail action step within a Mail Session. You enter the information required for the connection to the mail server in the Mail Session. Send Mail doesn’t support sending HTML emails and sends the content in **Body** over SMTP as plain text. To send a message body rendered as HTML, use RPA Builder to automate any SMTP CLI tool or any online or local mail client. ## Properties **Send Mail Settings** **Body** Here, the content of the mail is displayed. A total of 3900 characters are available. RPA Builder sends the body as plain text. **Enter error state when a file does not exist** If this checkbox is selected and if one of the attached files is not found in the production run, the Action Step is ended with an error. **First directory path** Path to the directory, in which the first file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **First file name** Contains the path to the first file that is to be attached. **Second directory path** Path to the directory, in which the second file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Second file name** Contains the path to the second file that is to be attached. **Subject** Subject of the mail. **Third directory path** Path to the directory, in which the third file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Third file name** Contains the path to the third file that is to be attached. ## Inbound Variables **To** Recipient. **Cc** Carbon copy. **Bcc** Blind carbon copy. **Subject** Subject of the mail. **First directory path** Path to the directory, in which the first file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **First file name** Contains the path to the first file that is to be attached. **Second directory path** Path to the directory, in which the second file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Second file name** Contains the path to the second file that is to be attached. **Third directory path** Path to the directory, in which the third file to be attached, is located. Enter the absolute or relative path. If relative, then the path refers to the variable _Base Path_. **Third file name** Contains the path to the third file that is to be attached. **Enter error state when a file does not exist** If this checkbox is selected and if one of the attached files is not found in the production run, the Action Step is ended with an error. ## Outbound Variables **IsSucceeded** Indicates whether an mail was sent successfully. ## Wizard The wizard is split into two tabs, **Message** and **Attachment**. In the Message area, enter text under **Body**. RPA Builder sends the content as plain text, not as HTML. If you defined variables in advance either using the Activity Parameters or the Workflow Based Variables, link the content with **Insert Available Variables**. Select the encoding to use between UTF-8, UTF-16, Shift-JIS, and EUC-JP. The pin variable is only displayed if you have defined a variable of type Bool using the Activity Parameters or the Workflow Based Variables. In the Attachment area, you can add up to three attachments to the mail. Under Directory path, you define the path to the new file to be created. You can create an absolute path or a path relative to the _Base Path_. The default value is %STWS\_BASEPATH%. Select an existing path. To construct the path, you can also insert variables from the workflow. You can find further explanations under [Properties](#properties). ## See also - [Mail Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-mail-session) - [Mail Session (OAuth)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-mail-session-oauth) - [REST Call](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network-rest-call) - [Credentials for OAuth](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-credentials-for-oauth) - [Json Query](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-json-query) - [Run Program](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control-run-program) --- product: RPA Builder version: 6.6 --- # Service Check > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Service Check_ plug-in allows you to perform checks using various protocols and services, such as Ping, FTP, HTTP, etc., to see if a service is running and available on a particular server. This augments the classic end-to-end monitoring tools included with RPA Builder with some element monitoring checks. The _Service Check_ plug-in consists of a single new Action Step called _Service Check_ – this is accessed in the same place as the other Action Step elements. ## Properties **Backup Target Host** Enter the host name without protocol prefix. When the _Target Host_ cannot be reached, the _Backup Host_ will be checked instead. Leave blank if not required. **Enable Error Trace** You can define a set of _Error Traces_ that will be executed when the check fails and this property is enabled **Iteration Count/Iteration must succeed** Define how often the check should be repeated and how often it needs to be successful **Iteration delay** If you defined more than one iteration, this specifies the pause in milliseconds between each iteration **Packet Size (kb)** Shows you the payload of the sent packages. This is only relevant for TCP Ping. **Protocol** Protocol to use for this check. Available values are: _Ping, TCP Echo, FTP, HTTP, HTTPS, SMTP, POP3, IMAP,_ and _TCP Portcheck_. **Target Host** Enter the DNS name or IP address of the host without protocol prefix to check. **Target Port** Which port to check on. Will be populated with default protocol after protocol is selected within the wizard. **Timer Mode** When "Record Timer" is enabled and the _Ping_ is used in a loop, the following mode is for calculating the timer value: - **Last** The last time measured is saved - **Average** The Workflow calculates an average of all times measured and saves it - **Min** The fastest time measured is saved - **Max** The slowest time measured is saved Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Target Host** Enter the DNS name or IP address of the host without protocol prefix to check. **Backup Target Host** Enter the host name without protocol prefix. When the _Target Host_ cannot be reached, the _Backup Host_ will be checked instead. Leave blank if not required. **Target Port** Which port to check on. Will be populated with default protocol after protocol is selected within the wizard. **Packet Size** Shows you the payload of the sent packages. This is only relevant for TCP Ping. **Suffix** can be used if the _Service Check_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Service Check_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables **Time** provides you the measured time. ## Wizard _Service Check_ will connect to the specified _Target Host_ on the specified _Port_ and attempt to perform a default handshake for the chosen protocol. It will try as many times as defined in the _Iteration Count_. If you have activated the _Record Timer,_ the response time of the check will be recorded as a timer and sent to the server. The name appearing in the reporting corresponds to the name of the Action Step. If it does not succeed after the defined number of attempts, it will fail and try again with the _Backup Host_. If the _Backup Host_ fails too (or the field is empty), the _Error Traces_ will be created and logged. You can define _Error Traces_ by clicking the appropriate button. With _Define Error Traces_ you can configure the _Error Traces_. These are a set of checks that will be executed on failure. Each of these checks resembles a _Service Check_, but it only has the properties _Protocol_\], _Target Host_\], _Port_\], and _Timeout_\]. _Error Traces_ may also use _Traceroute_ as the protocol – this will perform a standard trace route command and log the results. Simply click in the empty row to create a new _Error Trace_. You can then choose the _Protocol_ (note that for _Error Traces_, _Traceroute_ is available), specify the _Target Host_ and _Port_, and change the _Timeout_ if required. Press **_Enter_** or click _OK_ when you are done. You can repeat this as often as you like to create as many _Error Traces_ as needed. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Service Check > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Service Check_ plug-in allows you to perform checks using various protocols and services, such as Ping, FTP, HTTP, etc., to see if a service is running and available on a particular server. This augments the classic end-to-end monitoring tools included with RPA Builder with some element monitoring checks. The _Service Check_ plug-in consists of a single new action step called _Service Check_ – this is accessed in the same place as the other Action Step elements. ## Properties **Backup Target Host** Enter the host name without protocol prefix. When the _Target Host_ cannot be reached, the _Backup Host_ will be checked instead. Leave blank if not required. **Enable Error Trace** You can define a set of _Error Traces_ that will be executed when the check fails and this property is enabled **Iteration Count/Iteration must succeed** Define how often the check should be repeated and how often it needs to be successful **Iteration delay** If you defined more than one iteration, this specifies the pause in milliseconds between each iteration **Packet Size (kb)** Shows you the payload of the sent packages. This is only relevant for TCP Ping. **Protocol** Protocol to use for this check. Available values are: _Ping, TCP Echo, FTP, HTTP, HTTPS, SMTP, POP3, IMAP,_ and _TCP Portcheck_. **Target Host** Enter the DNS name or IP address of the host without protocol prefix to check. **Target Port** Which port to check on. Will be populated with default protocol after protocol is selected within the wizard. **Timer Mode** When "Record Timer" is enabled and the _Ping_ is used in a loop, the following mode is for calculating the timer value: - **Last** The last time measured is saved - **Average** The Workflow calculates an average of all times measured and saves it - **Min** The fastest time measured is saved - **Max** The slowest time measured is saved Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Target Host** Enter the DNS name or IP address of the host without protocol prefix to check. **Backup Target Host** Enter the host name without protocol prefix. When the _Target Host_ cannot be reached, the _Backup Host_ will be checked instead. Leave blank if not required. **Target Port** Which port to check on. Will be populated with default protocol after protocol is selected within the wizard. **Packet Size** Shows you the payload of the sent packages. This is only relevant for TCP Ping. **Suffix** can be used if the _Service Check_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Service Check_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables **Time** provides you the measured time. ## Wizard _Service Check_ will connect to the specified _Target Host_ on the specified _Port_ and attempt to perform a default handshake for the chosen protocol. It will try as many times as defined in the _Iteration Count_. If you have activated the _Record Timer,_ the response time of the check will be recorded as a timer and sent to the server. The name appearing in the reporting corresponds to the name of the action step. If it does not succeed after the defined number of attempts, it will fail and try again with the _Backup Host_. If the _Backup Host_ fails too (or the field is empty), the _Error Traces_ will be created and logged. You can define _Error Traces_ by clicking the appropriate button. With _Define Error Traces_ you can configure the _Error Traces_. These are a set of checks that will be executed on failure. Each of these checks resembles a _Service Check_, but it only has the properties _Protocol_\], _Target Host_\], _Port_\], and _Timeout_\]. _Error Traces_ may also use _Traceroute_ as the protocol – this will perform a standard trace route command and log the results. Simply click in the empty row to create a new _Error Trace_. You can then choose the _Protocol_ (note that for _Error Traces_, _Traceroute_ is available), specify the _Target Host_ and _Port_, and change the _Timeout_ if required. Press **_Enter_** or click _OK_ when you are done. You can repeat this as often as you like to create as many _Error Traces_ as needed. --- product: RPA Builder version: 6.6 --- # Session Based Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Session Based Variables to share variables accross all workflows that run inside the same session. You can define session variables of the following types: - Alphanumeric - Integer - Floating-point - Boolean - Array - User account - Web Session ID. Use the Set Variable and the Set Array Variable action steps to overwrite the initial variable values with new values at a later point in the Workflow. You can include only one instance of Session Based Variables in a Workflow and it must be in the Workflow Initialization section. ## Properties See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties). ## Inbound Variables This action step has no inbound variables. ## Outbound Variables All Session Based Variables are outbound variables. Variables are specified in the format _Workflow Based Variables._. Session Based Variables show in Variable Mappings only for action steps that support that type of variable. ## Wizard To create new variables: 1. Click **Add new parameter**. 2. Select the type of variable to create. 3. Specify the variable’s name, description, and value. 4. Click **OK** To delete variables, click the **Delete Variable** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon.png)) button. ## See Also - [Workflow Based Variables](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-workflow-based-variables) - [Set Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-variable) - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-array-variable) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Session Based Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use Session Based Variables to share variables accross all workflows that run inside the same session. You can define session variables of the following types: - Alphanumeric - Integer - Floating-point - Boolean - Array - User account - Web Session ID. Use the Set Variable and the Set Array Variable action steps to overwrite the initial variable values with new values at a later point in the Workflow. You can include only one instance of Session Based Variables in a Workflow and it must be in the Workflow Initialization section. ## Properties See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties). ## Inbound Variables This action step has no inbound variables. ## Outbound Variables All Session Based Variables are outbound variables. Variables are specified in the format _Workflow Based Variables._. Session Based Variables show in Variable Mappings only for action steps that support that type of variable. ## Wizard To create new variables: 1. Click **Add new parameter**. 2. Select the type of variable to create. 3. Specify the variable’s name, description, and value. 4. Click **OK** To delete variables, click the **Delete Variable** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon.png)) button. ## Sharing Session Based Variables Between Workflows To share Session Based Variables, create the variables in each workflow using the same variable name and type. When a workflow updates a variable, any successive workflow that reads the same variable uses the updated value of said variable. ## See Also - [Workflow Based Variables](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-workflow-based-variables) - [Set Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-variable) - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-array-variable) --- product: RPA Builder version: 6.6 --- # Set Array Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Set Array Variable Action Step enables you to assign new values to an array. One possible use is to copy a list to an array in order to iterate through all elements in the list more easily and to process individual list elements further. ## Properties The _Set Array Variable_ Action Step contains no other properties other than the _general_ ones. ## Inbound Variables **Array to change** (Array) Array in which values are to be changed. The array must have previously been created as a _Workflow Based Variable_ or using _Read from Excel File_. Please make sure that arrays are named according to their content. This makes a Workflow easier to understand. It is preferable to create an extra array in the _Workflow Based Variables_ rather than to overwrite an array created using the _Read from Excel File_ Action Step with different values. **New array value** (array or alphanumeric) Values to overwrite the entire array. The entire array is rewritten with the given values. The former values are deleted. By changing the values it is possible to also change the number of elements in the array (_Array Count_). ## Outbound Variables The _Set Array Variable_ Action Step possesses no outbound variables. ## Wizard The _Array to change_ is the array with values to be overwritten. You can select it from a drop-down list if such an array already exists. The _New array value_ is the new values for overwriting the array. You can include them via a Pin Variable or enter them directly as a list of comma separated values in the relevant field. The elements for array variables must be separated by commas. The values for array variables are initially saved as strings. That is why, when saving the Action Step, all array elements which are not yet presented in double quotes will automatically be placed in double quotes. If you want to include an element containing one or more commas in your list, you must place this element in double quotes before saving it. E.g. “4,2” or “many commas: ,,,, , , ” Text elements are permitted to contain single quotes: E.g. “This ‘text’ contains single quotation marks.” Text elements which need to contain double quotes must include another double quotation mark before each double quotation mark and the whole element also needs to be placed inside double quotes. E.g. “This “”text”” contains double quotation marks.” ## Example Car servicing is to be automated at a workshop. For testing purposes, the array _Services_, which is generated via the _Workflow Based Variables_ and which contains the services actually performed, can be pre-populated with values. Further on in the Workflow, services are read from a scanned-in form, e.g. using _OCR_, and the array _Services_ in the _Set Array Variable_ Action Step is overwritten with the actual values. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Set Array Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Set Array Variable action step enables you to assign new values to an array. One possible use is to copy a list to an array in order to iterate through all elements in the list more easily and to process individual list elements further. ## Properties The _Set Array Variable_ action step contains no other properties other than the _general_ ones. ## Inbound Variables **Array to change** (Array) Array in which values are to be changed. The array must have previously been created as a _Workflow Based Variable_ or using _Read from Excel File_. Please make sure that arrays are named according to their content. This makes a Workflow easier to understand. It is preferable to create an extra array in the _Workflow Based Variables_ rather than to overwrite an array created using the _Read from Excel File_ action step with different values. **New array value** (array or alphanumeric) Values to overwrite the entire array. The entire array is rewritten with the given values. The former values are deleted. By changing the values it is possible to also change the number of elements in the array (_Array Count_). ## Outbound Variables The _Set Array Variable_ action step possesses no outbound variables. ## Wizard The _Array to change_ is the array with values to be overwritten. You can select it from a drop-down list if such an array already exists. The _New array value_ is the new values for overwriting the array. You can include them via a Pin Variable or enter them directly as a list of comma separated values in the relevant field. The elements for array variables must be separated by commas. The values for array variables are initially saved as strings. That is why, when saving the action step, all array elements which are not yet presented in double quotes will automatically be placed in double quotes. If you want to include an element containing one or more commas in your list, you must place this element in double quotes before saving it. E.g. “4,2” or “many commas: ,,,, , , ” Text elements are permitted to contain single quotes: E.g. “This ‘text’ contains single quotation marks.” Text elements which need to contain double quotes must include another double quotation mark before each double quotation mark and the whole element also needs to be placed inside double quotes. E.g. “This “”text”” contains double quotation marks.” ## Example Car servicing is to be automated at a workshop. For testing purposes, the array _Services_, which is generated via the _Workflow Based Variables_ and which contains the services actually performed, can be pre-populated with values. Further on in the Workflow, services are read from a scanned-in form, e.g. using _OCR_, and the array _Services_ in the _Set Array Variable_ action step is overwritten with the actual values. --- product: RPA Builder version: 6.6 --- # Set Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the _Set Mail_ Action Step, you can change the status of an e-mail. That is, you can mark it either as read or unread and/or move it to a different folder. You can only use the Set Mail Action Step within the Read Mail Action Step. You enter the information required for the connection to the mail server in the Mail Session. ## Properties **Change Read/ Unread Status** The e-mail is marked as either read or unread. **Create folder if it does not exist** If the checkbox is selected, and no folder exists, then a folder is created. **Move mail to folder** If the checkbox is selected, the e-mail is moved to a different folder. **Read mail status** Indicates whether the e-mail is marked as read or unread. **Target folder** Name of the target folder. ## Inbound Variables **Mail Info** Is made available only by the Read Mail Action Step. This can be used to uniquely identify an e-mail. **Target folder** Name of the target folder. ## Outbound Variables **IsSucceeded** Indicates whether the action was carried out successfully. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Set Mail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt With the _Set Mail_ action step, you can change the status of an e-mail. That is, you can mark it either as read or unread and/or move it to a different folder. You can only use the Set Mail action step within the Read Mail Action Step. You enter the information required for the connection to the mail server in the Mail Session. ## Properties **Change Read/ Unread Status** The e-mail is marked as either read or unread. **Create folder if it does not exist** If the checkbox is selected, and no folder exists, then a folder is created. **Move mail to folder** If the checkbox is selected, the e-mail is moved to a different folder. **Read mail status** Indicates whether the e-mail is marked as read or unread. **Target folder** Name of the target folder. ## Inbound Variables **Mail Info** Is made available only by the Read Mail action step. This can be used to uniquely identify an e-mail. **Target folder** Name of the target folder. ## Outbound Variables **IsSucceeded** Indicates whether the action was carried out successfully. ## Wizard See [Properties](#properties). --- product: RPA Builder version: 6.6 --- # Set Text to App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Set Text To App Element_ Action Step can be used to set text directly to a selected App Element. ## Properties - **Input String (Input Text)** The text to write to the selected element. You can use _Insert environment variable_ and _Insert script variable_ to swap in other values for the text at runtime. ## Inbound Variables - **XPath to Element** - **Window Title** - **Input Text** ## Outbound Variables The _Set Text to App Element_ Action Step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-app-automation#app-automation-common-properties). See [Inserting Text Modules](https://docs.mulesoft.com/rpa-builder/6.6/insert-text-modules) for additional information about environment variables and script variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Set Text to App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Set Text To App Element_ action step can be used to set text directly to a selected App Element. ## Properties - **Input String (Input Text)** The text to write to the selected element. You can use _Insert environment variable_ and _Insert script variable_ to swap in other values for the text at runtime. ## Inbound Variables - **XPath to Element** - **Window Title** - **Input Text** ## Outbound Variables The _Set Text to App Element_ action step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation#app-automation-common-properties). See [Inserting Text Modules](https://docs.mulesoft.com/rpa-builder/latest/insert-text-modules) for additional information about environment variables and script variables. --- product: RPA Builder version: 6.6 --- # Set Toggle App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Set Toggle App Element_ Action Step to set a toggle App Element to `enabled` or `disabled`. Examples of these elements include checkboxes and toggle buttons. ## Properties **Set Element to** \+ Enables you to define the status you want to set the element to: `enabled` or `disabled`. ## Inbound Variables - **XPath to Element** - **Window Title** - **Set Element to** ## Outbound Variables The _Set Toggle App Element_ Action Step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-app-automation#app-automation-common-properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Set Toggle App Element > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Set Toggle App Element_ action step to set a toggle App Element to `enabled` or `disabled`. Examples of these elements include checkboxes and toggle buttons. ## Properties **Set Element to** \+ Enables you to define the status you want to set the element to: `enabled` or `disabled`. ## Inbound Variables - **XPath to Element** - **Window Title** - **Set Element to** ## Outbound Variables The _Set Toggle App Element_ action step does not have any outbound variables. ## Wizard See [Common Properties (App Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation#app-automation-common-properties). --- product: RPA Builder version: 6.6 --- # Set Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Set Variable_ Action Step assigns a new value to a variable. You can either enter the new value directly or use an existing variable of the same type, e.g. the input variable of another _Action Step_. The variables must be of the same type in order to populate one variable with the content of another variable, e.g. you can only populate a variable of type:Text with another variable of type:Text In order to ensure that the types are the same, this _Action Step_ has to be configured in several stages (see step-by-step instructions for the wizard below). Validation of variable types is performed when the _Action Step_ is launched. Variables from the _BasePath_ **cannot** be modified using the _Set Variable_ Action Step. Attempting to do so will generate an error message. Changes to a variable are logged in the _Workflow Run Results_. The logs record both the old and new values of the variables. Variable values that are longer than 16 characters are shown in truncated form. ## Properties **Common** - **New value** Enter the new value for the variable to be modified. This field is only displayed when the new value is being entered manually. If the new value is based on another variable, the field is not displayed. Other properties that are the same in all Action Steps are described in section 2.2. For reasons of clarity they are not shown here. ## Wizard - **Variable** The field displays the variable that will be overwritten with _Value_ as well as the variable’s type. If "No Variable is mapped…" is displayed, this means that no variable has been set using the _Mappings Editor_ (in this case, proceed as described in the step-by-step instructions below). - **New value** Enter the new value for the variable to be modified. You can also insert variables from the workflow. Variables from the _BasePath_ **cannot** be modified using the _Set Variable_ Action Step. Attempting to do so will generate an error message. ## Step-By-Step – Configure Set Variable as Follows 1. Drag the _Set Variable_ Action Step to the desired position in the workflow. 2. Open the _Set Variable_ wizard. 3. Enter a new value for the variable to be changed in the _Value_ field. You can also insert variables from the _Workflow_. To do so, click the pin button and select one of the available variables. 4. Click on the pin in the _Set Variable_ Action Step in the _Workflow_. 5. In the "Edit Variable Mappings for …" dialog, select the variable that you wish to modify from the "Variable" drop-down menu. The drop-down menu will only show variables that are of the same type. Use the "New value" drop-down menu to set the new variable to the value of another variable. This menu also only displays variables that are of the same type. To use the value specified in the wizard, leave the option in the drop-down menu. Confirm your selection with OK. 6. The pin for the _Set Variable_ Action Step will now be shown in red. 7. As an extra check, open the _Set Variable_ wizard. The "Variable" field should now show the variable to be changed, followed by its type in brackets. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Set Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Set Variable_ action step assigns a new value to a variable. You can either enter the new value directly or use an existing variable of the same type, e.g. the input variable of another action step. The variables must be of the same type in order to populate one variable with the content of another variable, e.g. you can only populate a variable of type:Text with another variable of type:Text In order to ensure that the types are the same, this action step has to be configured in several stages (see step-by-step instructions for the wizard below). Validation of variable types is performed when the action step is launched. Variables from the _BasePath_ **cannot** be modified using the _Set Variable_ action step. Attempting to do so will generate an error message. Changes to a variable are logged in the _Workflow Run Results_. The logs record both the old and new values of the variables. Variable values that are longer than 16 characters are shown in truncated form. ## Properties **Common** - **New value** Enter the new value for the variable to be modified. This field is only displayed when the new value is being entered manually. If the new value is based on another variable, the field is not displayed. Other properties that are the same in all action steps are described in section 2.2. For reasons of clarity they are not shown here. ## Wizard - **Variable** The field displays the variable that will be overwritten with _Value_ as well as the variable’s type. If "No Variable is mapped…" is displayed, this means that no variable has been set using the _Mappings Editor_ (in this case, proceed as described in the step-by-step instructions below). - **New value** Enter the new value for the variable to be modified. You can also insert variables from the workflow. Variables from the _BasePath_ **cannot** be modified using the _Set Variable_ action step. Attempting to do so will generate an error message. ## Step-By-Step – Configure Set Variable as Follows 1. Drag the _Set Variable_ action step to the desired position in the workflow. 2. Open the _Set Variable_ wizard. 3. Enter a new value for the variable to be changed in the _Value_ field. You can also insert variables from the _Workflow_. To do so, click the pin button and select one of the available variables. 4. Click on the pin in the _Set Variable_ action step in the _Workflow_. 5. In the "Edit Variable Mappings for …" dialog, select the variable that you wish to modify from the "Variable" drop-down menu. The drop-down menu will only show variables that are of the same type. Use the "New value" drop-down menu to set the new variable to the value of another variable. This menu also only displays variables that are of the same type. To use the value specified in the wizard, leave the option in the drop-down menu. Confirm your selection with OK. 6. The pin for the _Set Variable_ action step will now be shown in red. 7. As an extra check, open the _Set Variable_ wizard. The "Variable" field should now show the variable to be changed, followed by its type in brackets. --- product: RPA Builder version: 6.6 --- # Signature Detection with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Detect signatures in a PNG, JPEG, or PDF file using the AWS Signature Detection services. You can configure the action step to expect one or more signatures and adjust the confidence level for the detection. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Json** The complete AWS response. - **Normalized Json** The parsed JSON response including page number, signature name, and confidence score. - **Signature Found** A boolean value to confirm if a signature was found. - **Signature Count** The number of signatures found. ## Properties - **Authentication Settings** - **Region Endpoint** The region endpoint to use for the AWS Service. - **Use Session Token** Enables using a session token for authentication. - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for a description. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **Json Path** The Json path to the property of the response object. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. - **Signature Detection Settings** - **Minimum Confidence Score** The minimum confidence score for the detected signatures. - **Signature Detection mismatch handling** Defines if a mismatch between the expected and the actual detection causes a warning or an error. - **Signature Detection Mode** Defines the amount of expected signatures. ## Wizard The Wizard enables you to configure: - **Authentication Settings**: The credentials to use when connecting to the AWS services. You can either configure the credentials manually or reference an existing configuration of Credentials with AWS. - **Response settings**: The JsonPath Expression to filter the JSON response. - **File Settings**: The path and file name of the file to read. - **Signature Detection Settings**: The number of expected signatures (one, one or more, multiple), the minimum confidence level, and the expected behavior (warning or error) when the detection is below the configured confidence level. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Analyzing Documents](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Signature Detection with AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Detect signatures in a PNG, JPEG, or PDF file using the AWS Signature Detection services. You can configure the action step to expect one or more signatures and adjust the confidence level for the detection. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Json** The complete AWS response. - **Normalized Json** The parsed JSON response including page number, signature name, and confidence score. - **Signature Found** A boolean value to confirm if a signature was found. - **Signature Count** The number of signatures found. ## Properties - **Authentication Settings** - **Region Endpoint** The region endpoint to use for the AWS Service. - **Use Session Token** Enables using a session token for authentication. - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for a description. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **Json Path** The Json path to the property of the response object. - **PDF Settings** These settings show when the selected file is a PDF. - **Automatically detect the best quality for conversion** Disable this option to manually adjust the image quality. - **Image Quality** Specifies the quality of the image created from the PDF. The value ranges from `10` (lowest quality) to `100` (highest quality). This property is not available in the Wizard. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. - **Signature Detection Settings** - **Minimum Confidence Score** The minimum confidence score for the detected signatures. - **Signature Detection mismatch handling** Defines if a mismatch between the expected and the actual detection causes a warning or an error. - **Signature Detection Mode** Defines the amount of expected signatures. ## Wizard The Wizard enables you to configure: - **Authentication Settings**: The credentials to use when connecting to the AWS services. You can either configure the credentials manually or reference an existing configuration of Credentials with AWS. - **Response settings**: The JsonPath Expression to filter the JSON response. - **File Settings**: The path and file name of the file to read. - **Signature Detection Settings**: The number of expected signatures (one, one or more, multiple), the minimum confidence level, and the expected behavior (warning or error) when the detection is below the configured confidence level. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Analyzing Documents](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html) --- product: RPA Builder version: 6.6 --- # Sleep > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ causes the _Workflow_ to be paused for the specified duration. ## Properties **Sleep interval, msec** Pause time in milliseconds --- product: RPA Builder version: 6.7 is-latest-version: true --- # Sleep > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step causes the _Workflow_ to be paused for the specified duration. ## Properties **Sleep interval, msec** Pause time in milliseconds --- product: RPA Builder version: 6.6 --- # STC Protector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt When creating a _Workflow_ that needs to run stably and robustly for long periods, pop-up windows can be difficult to handle. Mostly they appear irregularly, so it is not easy to implement them into a static _Workflow_. To handle these pop-ups, you can use _STC Protector_. Think of it as a process running parallel to your actual measurement _Workflow_, checking if any window appears onscreen, and then closing it in an instant by sending a predefined keystroke sequence. ## Properties - **Pause between keystrokes, ms** Define how long _the Robot_ should pause between each keystroke sequence - **Use regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, see [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to - **Window check type** Sets whether the protector reacts if a window merely exists or if it has to be active to be handled by _STC Protector._ ## Wizard Click _Start_ to begin recording the keystroke sequence for handling pop-up windows. Select the pop-up window with the mouse and press the combination of keys needed to close it. When you are finished, click _Stop_. A new line for this window will appear in the _STC Protector_ wizard. The pop-up windows are identified by the window title. Make sure only one line exists for each window title! You can also add pop-up windows that are not actually onscreen. Use the **+** button and enter the window title and the combination of keys needed to close it. Some applications open pop-up windows that have the exact same title as the main application. In this case, the _STC Protector_ cannot decide which window should be handled by means of the title alone. To avoid this problem activate _Use window text_ before clicking _Start_. Now _STC Protector_ will use text displayed in the window and not only its title to decide whether it is a pop-up window to be closed. You can also distinguish between window titles by using the checkbox _Use regular expression for window title_. This function is described in detail in Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). ## Example When there is more than one tab opened in _Internet Explorer_, the program asks you if they should all be closed when you wish to exit the application. This question is displayed in a pop-up window. Now, during execution, when the pop-up window appears, the _STC Protector_ will automatically send the **_Enter_** keystroke to it and thus close the window. To ensure that the window is closed as quickly as possible (to avoid any interference with the measurement), leave the _Pause between keystrokes_ setting at "0". ## Troubleshooting In extremely rare cases, the _Workflow_ seems to stop and do nothing more after a pop-up window has been handled. This might be the case when the window is not actually closed by the given keystroke sequence, but the main application hides it completely from the desktop without removing the window handle from the operating system. In such cases, try setting _Window Check type_ to _Active_. --- product: RPA Builder version: 6.7 is-latest-version: true --- # STC Protector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt When creating a _Workflow_ that needs to run stably and robustly for long periods, pop-up windows can be difficult to handle. Mostly they appear irregularly, so it is not easy to implement them into a static _Workflow_. To handle these pop-ups, you can use _STC Protector_. Think of it as a process running parallel to your actual measurement _Workflow_, checking if any window appears onscreen, and then closing it in an instant by sending a predefined keystroke sequence. ## Properties - **Pause between keystrokes, ms** Define how long _the Robot_ should pause between each keystroke sequence - **Use regular expression for window title** You can further distinguish between window titles by selecting this checkbox. For a short introduction to regular expressions, see [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). - **Use window text** Defines if, in addition to the window title, window text should also be used to identify the window that the keystrokes should be sent to - **Window check type** Sets whether the protector reacts if a window merely exists or if it has to be active to be handled by _STC Protector._ ## Wizard Click _Start_ to begin recording the keystroke sequence for handling pop-up windows. Select the pop-up window with the mouse and press the combination of keys needed to close it. When you are finished, click _Stop_. A new line for this window will appear in the _STC Protector_ wizard. The pop-up windows are identified by the window title. Make sure only one line exists for each window title! You can also add pop-up windows that are not actually onscreen. Use the **+** button and enter the window title and the combination of keys needed to close it. Some applications open pop-up windows that have the exact same title as the main application. In this case, the _STC Protector_ cannot decide which window should be handled by means of the title alone. To avoid this problem activate _Use window text_ before clicking _Start_. Now _STC Protector_ will use text displayed in the window and not only its title to decide whether it is a pop-up window to be closed. You can also distinguish between window titles by using the checkbox _Use regular expression for window title_. This function is described in detail in Section [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). ## Example When there is more than one tab opened in _Internet Explorer_, the program asks you if they should all be closed when you wish to exit the application. This question is displayed in a pop-up window. Now, during execution, when the pop-up window appears, the _STC Protector_ will automatically send the **_Enter_** keystroke to it and thus close the window. To ensure that the window is closed as quickly as possible (to avoid any interference with the measurement), leave the _Pause between keystrokes_ setting at "0". ## Troubleshooting In extremely rare cases, the _Workflow_ seems to stop and do nothing more after a pop-up window has been handled. This might be the case when the window is not actually closed by the given keystroke sequence, but the main application hides it completely from the desktop without removing the window handle from the operating system. In such cases, try setting _Window Check type_ to _Active_. --- product: RPA Builder version: 6.6 --- # Stopwatch > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Stopwatch_ is basically a combined _Start/Stop Timer_ with a clear graphical representation. It also enables you to use additional timer modes in combination with the _Loop_ item. ## Properties **Timer mode** Decide how the measured time will be computed when the _Stopwatch_ is within a _Loop_. See below for details. ## Inbound Variables **Suffix** can be used if the _Stopwatch_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Stopwatch_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables The Action Step _Stopwatch_ has no outbound variables. ## Wizard The _Stopwatch_ wizard is similar to the _Transaction_ wizard. It suggests the name of the surrounding _Transaction_ to be _Stopwatch_ by default. Just edit the name to change it if required. ## Timer Modes (Using the Stopwatch within a Loop) Use the _Timer mode_ setting for the _Stopwatch_ to determine how the measurement value is calculated: - **Last** The last measured time is saved - **Average** The Workflow calculates an average value of all measured times and saves it - **Min** The fastest measured time is saved - **Max** The slowest measured time is saved ## See Also - [Stopwatch Collection](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-stopwatch-collection) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Stopwatch > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Stopwatch_ is basically a combined _Start/Stop Timer_ with a clear graphical representation. It also enables you to use additional timer modes in combination with the _Loop_ item. ## Properties **Timer mode** Decide how the measured time will be computed when the _Stopwatch_ is within a _Loop_. See below for details. ## Inbound Variables **Suffix** can be used if the _Stopwatch_ is within the _Control Block_'s _File Controlled Loop_. A suffix is then added to the name of the _Stopwatch_ during every loop. Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. ## Outbound Variables The action step _Stopwatch_ has no outbound variables. ## Wizard The _Stopwatch_ wizard is similar to the _Transaction_ wizard. It suggests the name of the surrounding _Transaction_ to be _Stopwatch_ by default. Just edit the name to change it if required. ## Timer Modes (Using the Stopwatch within a Loop) Use the _Timer mode_ setting for the _Stopwatch_ to determine how the measurement value is calculated: - **Last** The last measured time is saved - **Average** The Workflow calculates an average value of all measured times and saves it - **Min** The fastest measured time is saved - **Max** The slowest measured time is saved ## See Also - [Stopwatch Collection](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-stopwatch-collection) --- product: RPA Builder version: 6.6 --- # Stopwatch Collection > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Stopwatch Collection Action Step enables you to collect all timer values from the _Stopwatch_ and the _General Timer_ Actions Steps configured in an Activity Workflow. Because all Stopwatch values are determined at the end of the workflow, you can only place this Action Step in the Workflow Finalization section. ## Properties - **Json Labels** - **Reached Label** The label for the Stopwatch Reached State in the output JSON. Maximum length: 50 characters. - **Timer Label** The label for the Stopwatch Name in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. - **Value Label** The label for the Stopwatch Value in the output JSON. Maximum length: 50 characters. > [!WARNING] The properties panel does not validate the maximum label length. Ensure that you > validate JSON labels and output by using the Wizard. ## Inbound Variables This Action Step contains no inbound variables. ## Outbound Variables - **Stopwatch Timer Collection** The collection of captured stopwatch values in a JSON list, represented as a String. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/stopwatch-collection-wizard.png) - **Settings for JSON labels** - **Timer Label** The label for the Stopwatch Name in the output JSON. - **Reached Label** The label for the Stopwatch Reached State in the output JSON. - **Value Label** The label for the Stopwatch Value in the output JSON. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. The **Preview JSON Output** section shows a preview of the resulting JSON based on the configured Stopwatch Action Steps in the Workflow. ## See Also - [Stopwatch](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-stopwatch) - [General Timer Start](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points-general-timer-start) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-finalization) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Stopwatch Collection > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Stopwatch Collection action step enables you to collect all timer values from the _Stopwatch_ and the _General Timer_ Actions Steps configured in an Activity Workflow. Because all Stopwatch values are determined at the end of the workflow, you can only place this action step in the Workflow Finalization section. ## Properties - **Json Labels** - **Reached Label** The label for the Stopwatch Reached State in the output JSON. Maximum length: 50 characters. - **Timer Label** The label for the Stopwatch Name in the output JSON. Maximum length: 50 characters. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. - **Value Label** The label for the Stopwatch Value in the output JSON. Maximum length: 50 characters. > [!WARNING] The properties panel does not validate the maximum label length. Ensure that you > validate JSON labels and output by using the Wizard. ## Inbound Variables This action step contains no inbound variables. ## Outbound Variables - **Stopwatch Timer Collection** The collection of captured stopwatch values in a JSON list, represented as a String. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/stopwatch-collection-wizard.png) - **Settings for JSON labels** - **Timer Label** The label for the Stopwatch Name in the output JSON. - **Reached Label** The label for the Stopwatch Reached State in the output JSON. - **Value Label** The label for the Stopwatch Value in the output JSON. - **Touch Time Label** The label for the touch time in the output JSON. The touch time is a timestamp from the last time the checkpoint was touched. Maximum length: 50 characters. The **Preview JSON Output** section shows a preview of the resulting JSON based on the configured Stopwatch action steps in the Workflow. ## See Also - [Stopwatch](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-stopwatch) - [General Timer Start](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points-general-timer-start) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/latest/workflow-finalization) --- product: RPA Builder version: 6.6 --- # String Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The String Operations action step enables you to modify strings by using several operations, including find and replace and trimming. ## Properties - **Input Text** The string that you want to modify. Specify this value manually or use the wizard to define this value via the pin variable. - **Use a regular expresion for string to find** Select this option to evaluate the value specified in the **Find what** field in the wizard (`StringToFind` variable) as a regular expression and apply the regex to the **Input Text**. This option is valid only when using the string operation **Find and replace text**. ## Inbound Variables - **Input Text** The string that you want to modify. Specify this value manually or by using the wizard to select a pin variable for the value. - **StringToFind** The string to search for inside the **Input Text** string. - **StringToReplaceWith** The string to replace the found instances of **StringToFind**. - **CharacterToTrimAt** The character to use as delimiter when using trim operations. - **NumberOfCharacters** The number of characters to count when using trim operations. ## Outbound Variables - **Result** The modified string is output as the result. You can then use this string in later action steps. - **Result Length** The length of the modified result string. - **Start Index** The index of the first character of a substring that is found during the operation. - **End Index** The index of the last character of a substring that is found during the operation. - **Match Count** The numbers of substrings found during the operation. ## Wizard Use the Wizard to select the string operation to perform, the input text to analyze, and any other necessary parameters depending on the operation you select. Available operations are: **Analyse** Outputs the length of the specified input text string. **Find and replace text** Searches and replaces text found in the input text. For example: - **Input text (string)** = `MyTESTString` - **Find what** = `TEST` - **Replace with** = `NEW` - Output = `MyNEWString` **Left (take first characters)** Outputs the specified number of characters from the string, starting from the first character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `4` - Output = `MyTE` **Right (take last characters)** Outputs the specified number of characters from the string, starting from the last character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `4` - Output = `ring` **Trim left (remove first characters)** Removes the specified number of characters from the string, starting from the first character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `3` - Output = `ESTString` **Trim right (remove last characters)** Removes the specified number of characters from the string, starting from the last character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `3` - Output = `MyTESTStr` **Takes first characters of the string until a specific character (specific character is not part of output)** Outputs all characters between the beginning of the string and the first occurrence of the **Character to trim at** value. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `t` - Output = `MyTESTS` The output string does not include the search character. **Takes last characters of the string until a specific character (specific character is not part of output)** Outputs all characters between the last occurrence of the **Character to trim at** value and the end of the string. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `String` The output string does not include the search character. **Removes first characters of the string until a specific character (specific character is not part of output)** Removes all characters between the beginning of the string and the first occurrence of the **Character to trim at** value. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `ESTString` The search character is removed from the output string. **Removes last characters of the string until a specific character (specific character is not part of output)** Removes all characters between the last occurrence of the **Character to trim at** value and the end of the string. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `MyTES` The search character is removed from the output string. **Reverse string** Reverses and outputs the input string in the existing _Result_ outbound variable. For example: - **Input text (string**) = `This is a test string` - Output = `gnirts tset a si sihT` **Uppercase conversion** Converts all characters to uppercase. For example: - **Input text (string)** = `my test string` - Output = `MY TEST STRING` **Lowercase conversion** Converts all characters to uppercase. For example: - **Input text (string)** = `MY TEST STRING` - Output = `my test string` **Find and return index of string found** Searches for a substring within the input string and outputs the index where the substring is found. You can use a regular expression to define the substring to search. For example: - **Input text (string)** = `My test string` - **Find what** = `test` - Output = `4` If the substring is not found, the output result is `0`. If the regular expression is invalid, the action step is set to error state. --- product: RPA Builder version: 6.7 is-latest-version: true --- # String Operations > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The String Operations action step enables you to modify strings by using several operations, including find and replace and trimming. ## Properties - **Input Text** The string that you want to modify. Specify this value manually or use the wizard to define this value via the pin variable. - **Use a regular expresion for string to find** Select this option to evaluate the value specified in the **Find what** field in the wizard (`StringToFind` variable) as a regular expression and apply the regex to the **Input Text**. This option is valid only when using the string operation **Find and replace text**. ## Inbound Variables - **Input Text** The string that you want to modify. Specify this value manually or by using the wizard to select a pin variable for the value. - **StringToFind** The string to search for inside the **Input Text** string. - **StringToReplaceWith** The string to replace the found instances of **StringToFind**. - **CharacterToTrimAt** The character to use as delimiter when using trim operations. - **NumberOfCharacters** The number of characters to count when using trim operations. ## Outbound Variables - **Result** The modified string is output as the result. You can then use this string in later action steps. - **Result Length** The length of the modified result string. - **Start Index** The index of the first character of a substring that is found during the operation. - **End Index** The index of the last character of a substring that is found during the operation. - **Match Count** The numbers of substrings found during the operation. ## Wizard Use the Wizard to select the string operation to perform, the input text to analyze, and any other necessary parameters depending on the operation you select. Available operations are: **Analyse** Outputs the length of the specified input text string. **Find and replace text** Searches and replaces text found in the input text. For example: - **Input text (string)** = `MyTESTString` - **Find what** = `TEST` - **Replace with** = `NEW` - Output = `MyNEWString` **Left (take first characters)** Outputs the specified number of characters from the string, starting from the first character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `4` - Output = `MyTE` **Right (take last characters)** Outputs the specified number of characters from the string, starting from the last character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `4` - Output = `ring` **Trim left (remove first characters)** Removes the specified number of characters from the string, starting from the first character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `3` - Output = `ESTString` **Trim right (remove last characters)** Removes the specified number of characters from the string, starting from the last character. For example: - **Input text (string)** = `MyTESTString` - **Number of characters** = `3` - Output = `MyTESTStr` **Takes first characters of the string until a specific character (specific character is not part of output)** Outputs all characters between the beginning of the string and the first occurrence of the **Character to trim at** value. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `t` - Output = `MyTESTS` The output string does not include the search character. **Takes last characters of the string until a specific character (specific character is not part of output)** Outputs all characters between the last occurrence of the **Character to trim at** value and the end of the string. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `String` The output string does not include the search character. **Removes first characters of the string until a specific character (specific character is not part of output)** Removes all characters between the beginning of the string and the first occurrence of the **Character to trim at** value. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `ESTString` The search character is removed from the output string. **Removes last characters of the string until a specific character (specific character is not part of output)** Removes all characters between the last occurrence of the **Character to trim at** value and the end of the string. For example: - **Input text (string)** = `MyTESTString` - **Character to trim at** = `T` - Output = `MyTES` The search character is removed from the output string. **Reverse string** Reverses and outputs the input string in the existing _Result_ outbound variable. For example: - **Input text (string**) = `This is a test string` - Output = `gnirts tset a si sihT` **Uppercase conversion** Converts all characters to uppercase. For example: - **Input text (string)** = `my test string` - Output = `MY TEST STRING` **Lowercase conversion** Converts all characters to uppercase. For example: - **Input text (string)** = `MY TEST STRING` - Output = `my test string` **Find and return index of string found** Searches for a substring within the input string and outputs the index where the substring is found. You can use a regular expression to define the substring to search. For example: - **Input text (string)** = `My test string` - **Find what** = `test` - Output = `4` If the substring is not found, the output result is `0`. If the regular expression is invalid, the action step is set to error state. --- product: RPA Builder version: 6.6 --- # String to Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _String to Array_ Action Step allows you to split a string into arrays and to process them further in the subsequent Action Steps, such as with the _Read from Array_ Action Step. ## Properties **Input String** (string, empty with the default setting, must not be empty) String that can be entered using the keyboard or in the wizard, including with the help of the pin variables. **Separator** Define a separator that the string is to be separated after. In the wizard, you also have the option of entering the separator via a pin variable. The separator may comprise more than one character, such as //, or also be a space. ## Inbound Variables **Input String** (string, empty with the default setting, must not be empty) String that can be entered using the keyboard or in the wizard, including with the help of the pin variables. **Separator** Define a separator that the string is to be separated after. In the wizard, you also have the option of entering the separator via a pin variable. ## Outbound Variables **ResultAsArray** The converted string is output as an array. ## Example 1. String = DE 123456789 Separator = space Array output = DE;123456789 2. String = 1234567/123/456 Separator = / Array output 1234567;123;456 --- product: RPA Builder version: 6.7 is-latest-version: true --- # String to Array > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _String to Array_ action step allows you to split a string into arrays and to process them further in the subsequent action steps, such as with the _Read from Array_ action step. ## Properties **Input String** (string, empty with the default setting, must not be empty) String that can be entered using the keyboard or in the wizard, including with the help of the pin variables. **Separator** Define a separator that the string is to be separated after. In the wizard, you also have the option of entering the separator via a pin variable. The separator may comprise more than one character, such as //, or also be a space. ## Inbound Variables **Input String** (string, empty with the default setting, must not be empty) String that can be entered using the keyboard or in the wizard, including with the help of the pin variables. **Separator** Define a separator that the string is to be separated after. In the wizard, you also have the option of entering the separator via a pin variable. ## Outbound Variables **ResultAsArray** The converted string is output as an array. ## Example 1. String = DE 123456789 Separator = space Array output = DE;123456789 2. String = 1234567/123/456 Separator = / Array output 1234567;123;456 --- product: RPA Builder version: 6.6 --- # Submit Document to MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Send documents to MuleSoft IDP and process them with your published document actions. Each execution generates an execution ID that you must use when you run the Retrieve Results from MuleSoft IDP action step to query the results of said execution. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. ## Before You Begin Before using this action step, ensure that: - Your Anypoint user account has the Build Actions permission. - You have IDP document actions published in your organization. See [Publishing Document Actions](https://docs.mulesoft.com/idp/publishing-document-actions) for additional information. - You have a connected app configured to access IDP. See [Processing Documents and Retrieving Results With RPA](https://docs.mulesoft.com/idp/automate-document-processing-with-rpa) for configuration instructions. ## Properties This action step has no properties other than **Common** and **Timing**. See [Common Properties](https://docs.mulesoft.com/rpa-builder/6.6/common-properties) for further details. ## Inbound Variables - **Directory Path** Path to the directory where the file to submit is located - **File Name** Name of the file to submit - **Client ID** Client ID of the connected app configured to call IDP - **Client Secret** Client Secret of the connected app configured to call IDP - **Connected App Credentials** Pin credentials containing the Client ID and Client Secret of the connected app configured to call IDP - **Execution ID** Execution ID of the document processing operation ## Outbound Variables - **Success** - **ExecutionID** ## Wizard Start by selecting the **Action** and the **Action Version** to call from IDP. These lists populate with the available document actions published by your organization in IDP. Then, specify the **Directory path** and **File name** of the file to submit to IDP for processing with the selected document action. Finally, specify the connected app credentials to use when connecting to IDP. Either use the previously configured Pin credentials or specify the **Client ID** and **Client Secret** manually in the wizard. ## See Also - [Retrieve Results from MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mulesoft-idp-retrieve-results-from-mulesoft-idp) - [Permissions in Anypoint Platform](https://docs.mulesoft.com/access-management/managing-permissions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Submit Document to MuleSoft IDP > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Send documents to MuleSoft IDP to be processed asynchronously with your published document actions. Each successful execution returns an execution ID that you must use when you run the Retrieve Results from MuleSoft IDP action step to query the results of said execution. Calls to IDP from RPA Builder consume automation credits per page processed in addition to the bot minutes consumed by the RPA process. See [Automation Credits Usage and Rates](https://docs.mulesoft.com/general/automation-credits-usage-and-rates) for conversion rates and usage details. ## Before You Begin Before using this action step, ensure that: - Your currently logged-in Anypoint user account has read permissions for IDP. The wizard uses this user to query MuleSoft IDP for the available **Action** and **Action Version** options. - You have IDP document actions published in your organization. See [Publishing Document Actions](https://docs.mulesoft.com/idp/publishing-document-actions) for additional information. - You have a Connected App configured to access IDP. The Connected App must have the **Execute Published Actions** scope in Anypoint Platform. See [Processing Documents and Retrieving Results With RPA](https://docs.mulesoft.com/idp/automate-document-processing-with-rpa) for configuration instructions. ## Properties This action step has no properties other than **Common** and **Timing**. See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) for further details. ## Inbound Variables - **Directory Path** Path to the directory where the file to submit is located - **File Name** Name of the file to submit - **Client ID** Client ID of the connected app configured to call IDP - **Client Secret** Client Secret of the connected app configured to call IDP - **Connected App Credentials** Pin credentials containing the Client ID and Client Secret of the connected app configured to call IDP - **Execution ID** Leave this value empty. This action step sets it automatically if it is pinned to an activity parameter; any existing value is overwritten and ignored. - **Action ID** ID of the published document action to call. - **Action Version** Version of the referenced document action. - **Anypoint URL** URL of the Anypoint organization that published the IDP document actions to call. - **Organisation ID** ID of the Anypoint organization that published the IDP document actions to call. ## Outbound Variables - **Success** - **ExecutionID** ## Wizard Start by selecting the **Action** and the **Action Version** to call from IDP. These lists populate with the available document actions published by your organization in IDP. Then, specify the **Directory path** and **File name** of the file to submit to IDP for processing with the selected document action. Finally, specify the connected app credentials to use when connecting to IDP. Either use the previously configured Pin credentials or specify the **Client ID** and **Client Secret** manually in the wizard. ## See Also - [Retrieve Results from MuleSoft IDP](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mulesoft-idp-retrieve-results-from-mulesoft-idp) - [Permissions in Anypoint Platform](https://docs.mulesoft.com/access-management/managing-permissions) --- product: RPA Builder version: 6.6 --- # Submit Form > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to submit a form on a webpage. It will work on any field contained within a form and submit the whole form. ## Properties **Webelement Find Options** - **Screenshot The recorded screenshot is displayed here.** - **Use Regex to find Window (Enable Regex) Use this function if you want to use Regex when searching the window.** Other Properties that are the same in all Action Steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Element XPath** **Window Title** ## Outbound Variables The Action Step _Submit Form_ possesses no outbound variables. ## Wizard Forms are often used on websites to collect various data. The most common example would be a registration form to get an account to log in to a website. _Submit Form_ is a very simple-to-use tool that allows you to transfer the required data. Just define an element XPath to identify the form that you want to submit. You do not have to use the submit button to start transferring the data; modifying any of the fields contained in the form is sufficient. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Submit Form > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Web Automation_ object allows you to submit a form on a webpage. It will work on any field contained within a form and submit the whole form. ## Properties **Webelement Find Options** - **Screenshot The recorded screenshot is displayed here.** - **Use Regex to find Window (Enable Regex) Use this function if you want to use Regex when searching the window.** Other Properties that are the same in all action steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Element XPath** **Window Title** ## Outbound Variables The action step _Submit Form_ possesses no outbound variables. ## Wizard Forms are often used on websites to collect various data. The most common example would be a registration form to get an account to log in to a website. _Submit Form_ is a very simple-to-use tool that allows you to transfer the required data. Just define an element XPath to identify the form that you want to submit. You do not have to use the submit button to start transferring the data; modifying any of the fields contained in the form is sufficient. --- product: RPA Builder version: 6.6 --- # System > For the full documentation index, see: https://docs.mulesoft.com/llms.txt System Action Steps enable you to perform some system interactions as mapping network drives, displaying a message box, compare system parameters, and write logs. - [Map Network Drive](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system-map-network-drive) This Action Step lets you map and unmap any network location and any drive letter. - [Message Box](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system-message-box) This Action Step is used to display a message box containing user-defined text and the buttons needed. - [System Validation](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system-system-validation) System Validation compares various parameters between the system the Workflow was created on and the system where it is executed. It does not have any additional properties on the Properties grid. - [Write Bot Message](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system-write-bot-message) The Write Bot Message Action Step enables you to enrich the result message the RPA Bot generates after each failed run. In case of execution failure, this message shows in the **Run Results** section of the **Process Management** view in RPA Manager. - [Write Log](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system-write-log) This Action Step can be used to leave a comment or brief description at a certain point in the Workflow. --- product: RPA Builder version: 6.7 is-latest-version: true --- # System > For the full documentation index, see: https://docs.mulesoft.com/llms.txt System action steps enable you to perform some system interactions as mapping network drives, displaying a message box, compare system parameters, and write logs. - [Map Network Drive](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system-map-network-drive) This action step lets you map and unmap any network location and any drive letter. - [Message Box](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system-message-box) This action step is used to display a message box containing user-defined text and the buttons needed. - [System Validation](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system-system-validation) System Validation compares various parameters between the system the Workflow was created on and the system where it is executed. It does not have any additional properties on the Properties grid. - [Write Bot Message](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system-write-bot-message) The Write Bot Message action step enables you to enrich the result message the RPA Bot generates after each failed run. In case of execution failure, this message shows in the **Run Results** section of the **Process Management** view in RPA Manager. - [Write Log](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system-write-log) This action step can be used to leave a comment or brief description at a certain point in the Workflow. --- product: RPA Builder version: 6.6 --- # System Validation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _System Validation_ compares various parameters (see Section **Checking System Parameters**) between the system the _Workflow_ was created on and the system where it is executed. It does not have any additional properties on the _Properties grid_. ## Properties _Action Step_ _System Validation_ has no further properties_._ ## Variables _Action Step_ _System Validation_ possesses no variables. ## Wizard The wizard shows a list of all system parameters that are available to be checked; these can all be selected separately. The _Compare Value_ column shows the current value that will be checked against. Click _Reset_ to set the value to the system’s current value. Finally, you can choose what happens when two values differs. You can either select to display an _Info_, _Warning,_ or _Error_ message, or set an actual _Error State_ that causes the _Workflow_ to fail and throw a warning or error. For example, you could prevent a system with a different desktop resolution from executing the _Workflow_. --- product: RPA Builder version: 6.7 is-latest-version: true --- # System Validation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _System Validation_ compares various parameters (see Section **Checking System Parameters**) between the system the _Workflow_ was created on and the system where it is executed. It does not have any additional properties on the _Properties grid_. ## Properties _System Validation_ has no further properties_._ ## Variables _System Validation_ possesses no variables. ## Wizard The wizard shows a list of all system parameters that are available to be checked; these can all be selected separately. The _Compare Value_ column shows the current value that will be checked against. Click _Reset_ to set the value to the system’s current value. Finally, you can choose what happens when two values differs. You can either select to display an _Info_, _Warning,_ or _Error_ message, or set an actual _Error State_ that causes the _Workflow_ to fail and throw a warning or error. For example, you could prevent a system with a different desktop resolution from executing the _Workflow_. --- product: RPA Builder version: 6.6 --- # Tables With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Tables with AWS action step enables you to recognize the text values inside a table by sending a local file to the AWS Textract service, which returns the extracted values. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/tables-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Tables](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-tables.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Tables With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Tables with AWS action step enables you to recognize the text values inside a table by sending a local file to the AWS Textract service, which returns the extracted values. This action step processes the document in a synchronous fashion (Amazon does not store the document) and automatically converts PDF files to PNG images. You can adjust the fidelity of the conversion in the properties grid. ## Inbound Variables - **Directory Path** - **File Name** - **Password** - **Read text from page** - **Read text to page** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/tables-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **File Settings** - **Directory path** The path to the directory where the file is located. - **File name** The name of the file to analyze. Supported file types: PDF, JPEG, and PNG. - **PDF Settings** These settings show when the selected file is a PDF. - **PDF file is password protected** Specifies if the selected PDF file is password protected. When selected, specify the password to open the file in the **Password to open PDF file** filed. - **Read entire file** Instructs the service to read the entire file. - **Read page range** Instructs the service to read the selected range of pages. - **From page** Specify from which page the service starts reading the file. - **To page** Specifies until which page the service reads the file. - **Read to end of file** Instructs the service to continue reading until the end of the file. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Textract: Tables](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-tables.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Testing and Debugging Workflows > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder provides a framework for testing and debugging workflows. Before testing your workflows, learn how to [differentiate errors from unavailability](#differentiate-errors-from-unavailability). Then, you can [run a workflow and view Workflow Run results](https://docs.mulesoft.com/rpa-builder/6.6/running-workflows-and-using-workflow-run-results) to obtain detailed information about the workflow’s execution. Use [Workflow Debugger](https://docs.mulesoft.com/rpa-builder/6.6/using-workflow-debugger) to set breakpoints and debug a workflow by stopping on each configured breakpoint to troubleshoot workflow elements. RPA Builder also enables you to [analyze problems with analysis packages](https://docs.mulesoft.com/rpa-builder/6.6/analyzing-problems-with-analysis-packages) downloaded from RPA Manager after a failed workflow run. ## Differentiate Errors from Unavailability When testing a Workflow, it is extremely important to distinguish errors caused by the Workflow from errors that occur because of the unavailability of the measured application. To understand the difference, verify the relevant details: where an error happened, why it happened, and what the screenshot tells you about it. There are several reasons why a keystroke action might fail with a message stating that the specified window title could not be found. For example, it could mean the window was not there at all or that the specified window title was incorrect. Analyzing the screenshots enables you to distinguish between those two cases. If the window is not there at all, then the monitored application did not start in the expected time, meaning there’s actual unavailability and there’s no need to change the Workflow. If, on the contrary, the screenshot shows that the window is there, it means the Workflow has an error. In this case, looking at the screenshot helps see the actual window title and edit the keystroke action accordingly. Workflows commonly fail for these reasons: - An image could not be detected in the given timeout period. - An application window could not be detected or did not disappear in the given timeout period. - The target window of a Keystroke action could not be detected. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/6.6/running-workflows-and-using-workflow-run-results) - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/6.6/using-workflow-debugger) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/6.6/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Testing and Debugging Workflows > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder provides a framework for testing and debugging workflows. Before testing your workflows, learn how to [differentiate errors from unavailability](#differentiate-errors-from-unavailability). Then, you can [run a workflow and view Workflow Run results](https://docs.mulesoft.com/rpa-builder/latest/running-workflows-and-using-workflow-run-results) to obtain detailed information about the workflow’s execution. Use [Workflow Debugger](https://docs.mulesoft.com/rpa-builder/latest/using-workflow-debugger) to set breakpoints and debug a workflow by stopping on each configured breakpoint to troubleshoot workflow elements. RPA Builder also enables you to [analyze problems with analysis packages](https://docs.mulesoft.com/rpa-builder/latest/analyzing-problems-with-analysis-packages) downloaded from RPA Manager after a failed workflow run. ## Differentiate Errors from Unavailability When testing a Workflow, it is extremely important to distinguish errors caused by the Workflow from errors that occur because of the unavailability of the measured application. To understand the difference, verify the relevant details: where an error happened, why it happened, and what the screenshot tells you about it. There are several reasons why a keystroke action might fail with a message stating that the specified window title could not be found. For example, it could mean the window was not there at all or that the specified window title was incorrect. Analyzing the screenshots enables you to distinguish between those two cases. If the window is not there at all, then the monitored application did not start in the expected time, meaning there’s actual unavailability and there’s no need to change the Workflow. If, on the contrary, the screenshot shows that the window is there, it means the Workflow has an error. In this case, looking at the screenshot helps see the actual window title and edit the keystroke action accordingly. Workflows commonly fail for these reasons: - An image could not be detected in the given timeout period. - An application window could not be detected or did not disappear in the given timeout period. - The target window of a Keystroke action could not be detected. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/latest/running-workflows-and-using-workflow-run-results) - [Using Workflow Debugger](https://docs.mulesoft.com/rpa-builder/latest/using-workflow-debugger) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/latest/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.6 --- # Testing Regular Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Regex Tester_ is a tool in RPA Builder that enables you to create and test regular expressions. You can open the _Regex Tester_ in three different ways: - In the top menu bar, click **Tools** → **Open Regex Tester**. - In the top menu bar, click the **Open Regex Tester** button (![Regex Tester icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-testing-regular-expression-image1.png)). - In an _Action Step_ that supports Regex, click the **Test Regex** button (![Regex Tester icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/test-regex-icon.png)). Opening the _Regex Tester_ this way automatically transfers any regular expressions and text patterns associated with the _Action Step_ to the tool. ## Regex Tester Wizard ![Regex Tester wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-regular-expressions-testing-regular-expression-image2.png) - **Regex** Enter the regular expression that you want to test. Commonly used regular expressions can be selected from the **Commonly used Regex** table by double clicking on the desired entry. - **Test Pattern** Enter a piece of text that you wish to use for testing the regular expression. Click the Execute Test button to run the test. Matches will be highlighted in the **Test Pattern** field. - **Commonly used Regex** This table contains commonly used regular expressions that can be used in the **Regex** field. Double click on the desired entry to transfer it to the _Regex_ field. ## See Also - [Regex Examples](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions-examples) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Testing Regular Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Regex Tester_ is a tool in RPA Builder that enables you to create and test regular expressions. You can open the _Regex Tester_ in three different ways: - In the top menu bar, click **Tools** → **Open Regex Tester**. - In the top menu bar, click the **Open Regex Tester** button (![Regex Tester icon](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-testing-regular-expression-image1.png)). - In an action step that supports Regex, click the **Test Regex** button (![Regex Tester icon](/mulesoft/current/en-us/rpa-builder/latest/_images/test-regex-icon.png)). Opening the _Regex Tester_ this way automatically transfers any regular expressions and text patterns associated with the action step to the tool. ## Regex Tester Wizard ![Regex Tester wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-regular-expressions-testing-regular-expression-image2.png) - **Regex** Enter the regular expression that you want to test. Commonly used regular expressions can be selected from the **Commonly used Regex** table by double clicking on the desired entry. - **Test Pattern** Enter a piece of text that you wish to use for testing the regular expression. Click the Execute Test button to run the test. Matches will be highlighted in the **Test Pattern** field. - **Commonly used Regex** This table contains commonly used regular expressions that can be used in the **Regex** field. Double click on the desired entry to transfer it to the _Regex_ field. ## See Also - [Regex Examples](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions-examples) --- product: RPA Builder version: 6.6 --- # Text Recognition > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Text Recognition enables you to use different methods of Optical Character Recognition(OCR) to analyze images and extract text from them. - [AI OCR (File-based)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition-ai-ocr-file-based) Using the AI OCR (file-based) Action Step, existing images such as document scans can be recognized. - [AI OCR (Screen-based)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition-ai-ocr-screen-based) The AI OCR (screen-based) Action Step attempts to extract texts from screenshots of the currently active desktop. - [Intelligent OCR (2020)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition-intelligent-ocr-2020) The Intelligent OCR (2020) Action Step supports the following additional languages: Arabic, Greek, Hebrew, and Thai. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Text Recognition > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Text Recognition enables you to use different methods of Optical Character Recognition(OCR) to analyze images and extract text from them. - [AI OCR (File-based)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition-ai-ocr-file-based) Using the AI OCR (file-based) action step, existing images such as document scans can be recognized. - [AI OCR (Screen-based)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition-ai-ocr-screen-based) The AI OCR (screen-based) action step attempts to extract texts from screenshots of the currently active desktop. - [Intelligent OCR (2020)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition-intelligent-ocr-2020) The Intelligent OCR (2020) action step supports the following additional languages: Arabic, Greek, Hebrew, and Thai. --- product: RPA Builder version: 6.6 --- # Text Recognition (OCR) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## AI OCR (file-based) The _AI OCR (file-based)_ Action Step is a further development of the existing OCR Action Steps. In contrast to the other OCR Action Steps, it is based on concepts of neural networks. The available languages, therefore, are based on trained patterns that take account of the characteristics of the relevant language. In many cases, therefore, the correct recognition of texts that are, for example, barely legible or have little contrast or an unusual font, is improved with this Action Step. Using the _AI OCR (file-based)_ Action Step, existing images such as document scans can be recognized. The basis for this Action Step is an image file. This can be available in the regular graphic formats such as BMP, JPEG, PNG and TIFF. You should consider the Intelligent OCR 2020 Action Step if more than one language is to be recognized at once or if you wish to use your own dictionary. ## Properties **OCR Image Preprocessing** 1. **Force Black Background** Reverses the color of the screenshots. This is especially recommended for white text on a black background. 2. **Scaling factor** Displays the selected enlargement in the wizard. 3. **Remove Shadows** If there are uneven shadows on the image, you can remove them with this option. 4. **Noise Filter** If there are disruptive pixels (image noise) in the image, you can suppress them with this option. 5. **Enhance Contrast** If an image has low contrast and is very pale as a result, you can use this option to increase the contrast. 6. **Color Depth** The digitalization of an image consists of two steps, rasterization and quantization. Rasterization refers to breaking down the image into small pieces. An original dot becomes a pixel. In the case of scanned templates, due to the low resolution of the scanner, not all original dots are converted. A reduction in resolution takes place. In quantization, it is determined which value is assigned to a pixel. If we only distinguish between black and white, we get a binary image. Each pixel is stored as one bit, we refer to 1-bit color depth. Typically, an image has a resolution (or color depth) of 8 bits. If there are several levels of brightness, we refer to grayscale values. Every other value that differs from 1 bit reduces the image to a lower grayscale value. This way, it is often possible to remove disruptive image artifacts, which simplifies processing with OCR. We recommend a value of 3 or 4. **Bypass processing pipeline** With this option, you can completely deactivate image processing. The settings made in the wizard are not taken into consideration. **OCR Settings** **Area mode** Appears as soon as you define the search area under Scan Area. You can choose between: - **Actual Pixels** The image is used in its original resolution - **Fit to DIN A4** The original image is enlarged in height or width until it corresponds to the aspect ratio of a DIN A4 sheet. Depending on whether height or width is adjusted, there are areas that are augmented. The original resolution of the image remains intact. - **Fit to DIN A3** Behaves as with DIN A4. Since DIN A4 and A5 have an identical aspect ratio, there is currently no difference. However, in the future, new algorithms are likely to have to take account of the size. Therefore, this selection is now available. **Image file name**\* Name of the image file. **Image folder path**\* The path to the folder in which the image file is located. **Orientation** If you selected _Fit to A4_ or _A3_ in Area mode, you can select the format. - **Automatic** - **Landscape** - **Portrait** ## Inbound Variables **Image file name**\* Name of the image file. **Image folder path**\* The path to the folder in which the image file is located. ## Outbound Variables **IsSucceeded** (Boolean) Indicates whether text recognition has been carried out successfully or not. ## Wizard You can use **OCR Image Preprocessing** to improve the quality of the image so that the OCR operation can run optimally. This is always carried out in the specified sequence. Here, you can also switch the individual steps on or off. If you click on **Load design-time file**, the Windows Explorer opens and you can select a sample file. You can start a test run with the **Test button**. For a local Workflow run or the subsequent productive process run, the Directory Path and file name must be entered correctly. The sample image selected for the test run is no longer considered in this case. Under Directory path, you define the path to the new file to be created. You can create an absolute path or a path relative to the _Base Path_. You select an existing path To construct the path, you can also insert variables from the Workflow. You can find further explanations under [Properties](#properties). --- product: RPA Builder version: 6.7 is-latest-version: true --- # Text Recognition (OCR) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## AI OCR (file-based) The _AI OCR (file-based)_ action step is a further development of the existing OCR action steps. In contrast to the other OCR action steps, it is based on concepts of neural networks. The available languages, therefore, are based on trained patterns that take account of the characteristics of the relevant language. In many cases, therefore, the correct recognition of texts that are, for example, barely legible or have little contrast or an unusual font, is improved with this Action Step. Using the _AI OCR (file-based)_ action step, existing images such as document scans can be recognized. The basis for this action step is an image file. This can be available in the regular graphic formats such as BMP, JPEG, PNG and TIFF. You should consider the Intelligent OCR 2020 action step if more than one language is to be recognized at once or if you wish to use your own dictionary. ## Properties **OCR Image Preprocessing** 1. **Force Black Background** Reverses the color of the screenshots. This is especially recommended for white text on a black background. 2. **Scaling factor** Displays the selected enlargement in the wizard. 3. **Remove Shadows** If there are uneven shadows on the image, you can remove them with this option. 4. **Noise Filter** If there are disruptive pixels (image noise) in the image, you can suppress them with this option. 5. **Enhance Contrast** If an image has low contrast and is very pale as a result, you can use this option to increase the contrast. 6. **Color Depth** The digitalization of an image consists of two steps, rasterization and quantization. Rasterization refers to breaking down the image into small pieces. An original dot becomes a pixel. In the case of scanned templates, due to the low resolution of the scanner, not all original dots are converted. A reduction in resolution takes place. In quantization, it is determined which value is assigned to a pixel. If we only distinguish between black and white, we get a binary image. Each pixel is stored as one bit, we refer to 1-bit color depth. Typically, an image has a resolution (or color depth) of 8 bits. If there are several levels of brightness, we refer to grayscale values. Every other value that differs from 1 bit reduces the image to a lower grayscale value. This way, it is often possible to remove disruptive image artifacts, which simplifies processing with OCR. We recommend a value of 3 or 4. **Bypass processing pipeline** With this option, you can completely deactivate image processing. The settings made in the wizard are not taken into consideration. **OCR Settings** **Area mode** Appears as soon as you define the search area under Scan Area. You can choose between: - **Actual Pixels** The image is used in its original resolution - **Fit to DIN A4** The original image is enlarged in height or width until it corresponds to the aspect ratio of a DIN A4 sheet. Depending on whether height or width is adjusted, there are areas that are augmented. The original resolution of the image remains intact. - **Fit to DIN A3** Behaves as with DIN A4. Since DIN A4 and A5 have an identical aspect ratio, there is currently no difference. However, in the future, new algorithms are likely to have to take account of the size. Therefore, this selection is now available. **Image file name**\* Name of the image file. **Image folder path**\* The path to the folder in which the image file is located. **Orientation** If you selected _Fit to A4_ or _A3_ in Area mode, you can select the format. - **Automatic** - **Landscape** - **Portrait** ## Inbound Variables **Image file name**\* Name of the image file. **Image folder path**\* The path to the folder in which the image file is located. ## Outbound Variables **IsSucceeded** (Boolean) Indicates whether text recognition has been carried out successfully or not. ## Wizard You can use **OCR Image Preprocessing** to improve the quality of the image so that the OCR operation can run optimally. This is always carried out in the specified sequence. Here, you can also switch the individual steps on or off. If you click on **Load design-time file**, the Windows Explorer opens and you can select a sample file. You can start a test run with the **Test button**. For a local Workflow run or the subsequent productive process run, the Directory Path and file name must be entered correctly. The sample image selected for the test run is no longer considered in this case. Under Directory path, you define the path to the new file to be created. You can create an absolute path or a path relative to the _Base Path_. You select an existing path To construct the path, you can also insert variables from the Workflow. You can find further explanations under [Properties](#properties). --- product: RPA Builder version: 6.6 --- # The Toolbox > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Toolbox contains all action steps that you can configure to add logic to the tasks in your process automations. All actions are grouped in different containers and the documentation follows the same order as they appear in the RPA Builder UI. - [App Automation](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-app-automation) - [Checks](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks) - [Control](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control) - [Document Processing](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-document-processing) - [Excel Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations) - [File Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations) - [Flow Control](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control) - [General](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general) - [Mail Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations) - [Measurement Points](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-measurement-points) - [Network](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-network) - [System](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-system) - [Text Recognition](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-text-recognition) - [Variable Handling](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling) - [Web Automation](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation) --- product: RPA Builder version: 6.7 is-latest-version: true --- # The Toolbox > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Toolbox contains all action steps that you can configure to add logic to the tasks in your process automations. All actions are grouped in different containers and the documentation follows the same order as they appear in the RPA Builder UI. - [App Automation](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation) - [Checks](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks) - [Control](https://docs.mulesoft.com/rpa-builder/latest/toolbox-control) - [Document Processing](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-document-processing) - [Excel Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations) - [File Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations) - [Flow Control](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control) - [General](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general) - [Mail Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations) - [Measurement Points](https://docs.mulesoft.com/rpa-builder/latest/toolbox-measurement-points) - [Network](https://docs.mulesoft.com/rpa-builder/latest/toolbox-network) - [System](https://docs.mulesoft.com/rpa-builder/latest/toolbox-system) - [Text Recognition](https://docs.mulesoft.com/rpa-builder/latest/toolbox-text-recognition) - [Variable Handling](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling) - [Web Automation](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation) --- product: RPA Builder version: 6.6 --- # Transaction > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Transactions_ are used to split _Workflow_s into logical, self-contained units. They provide structure for your _Workflow_s, which is more important the larger a _Workflow_ gets. They do not have additional properties. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Transaction > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Transactions_ are used to split _Workflow_s into logical, self-contained units. They provide structure for your _Workflow_s, which is more important the larger a _Workflow_ gets. They do not have additional properties. --- product: RPA Builder version: 6.6 --- # Translate With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The translate with AWS action step enables you to use the Amazon Translate service to translate the specified text. See [Supported Languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) for a list of languages that the Amazon Translate service supports. ## Inbound Variables - **Text** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. - **Detected Language** The detected language of the document’s text. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/translate-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **Text** The text to translate. - **Language** The language of the source text to translate. Disabled if **Auto-Detect source language** is selected. - **Target Language** The target language for the translation of the source text. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-aws-operations-credentials-for-aws) - [Amazon Translate](https://docs.aws.amazon.com/translate/latest/dg/what-is.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/6.6/building-jsonpath-expressions) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Translate With AWS > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The translate with AWS action step enables you to use the Amazon Translate service to translate the specified text. See [Supported Languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) for a list of languages that the Amazon Translate service supports. ## Inbound Variables - **Text** - **AWS Credentials** Or, if **Use custom settings** is activated in the wizard: - **Client Id** - **Client Secret** - **Session Token** - **Use Session Token** - **Region Endpoint** - **Json Path** ## Outbound Variables - **Raw Text** The extracted raw text of the document. - **Normalized Json** The parsed result based on the normalized result and defined Json path. - **Raw Json** The complete AWS response. - **Detected Language** The detected language of the document’s text. ## Wizard ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/translate-with-aws-wizard.png) - **Authentication Settings** The AWS credentials to use for authentication - **Pin credentials** Use this option to reference an existing **Credentials for AWS** configuration. - **Use custom settings** Use this option to manually specify an AWS **Cliend ID**, **Client Secret**, **Region Endpoint**, and **Session Token** for this action step. - **Response settings** - **JsonPath Expression** The Json path to the property of the response object. - **Text** The text to translate. - **Language** The language of the source text to translate. Disabled if **Auto-Detect source language** is selected. - **Target Language** The target language for the translation of the source text. ## See Also - [Credentials for AWS](https://docs.mulesoft.com/rpa-builder/latest/toolbox-aws-operations-credentials-for-aws) - [Amazon Translate](https://docs.aws.amazon.com/translate/latest/dg/what-is.html) - [Building JSONPath Expressions](https://docs.mulesoft.com/rpa-builder/latest/building-jsonpath-expressions) --- product: RPA Builder version: 6.6 --- # Troubleshooting Microsoft Azure Setup > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you have issues configuring your Azure account with Mail Session (Outlook with OAuth), follow these troubleshooting steps to ensure your app is properly registered and configured: 1. [Register an App in Azure](#register-app) 2. [Create a Client Secret for the App](#create-secret) 3. [Verify the Settings](#verify-settings) 4. [Add Permissions to the App](#add-permissions) ## Register an App in Azure 1. Navigate to [https://portal.azure.com/](https://portal.azure.com/) and log in with your Azure account. 2. Open the **App Registrations** page and create a new registration. - Select the supported account types. - Provide a Redirect URI. For the configuration to work, you must specify a valid redirect URL, for example: `http://localhost:49453/`. For additional instructions about registering apps in Azure, see [Azure: Register a web application](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications#register-a-web-application). ## Create a Client Secret for the App After registering an app in Azure, the app’s setting page opens. 1. Open the **Certificates & Secrets** page. 2. Create a new client secret. > [!WARNING] After creating the secret, ensure you copy its **Value** as this is the only time > you can see it. After you leave this page, the secret is no longer accessible. For additional instructions about creating client secrets, see [Azure: Create a client secret](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications#create-a-client-secret). In some cases, authentication might not work if you have more than one secret defined or use the 24 month expiration cycle. When your authentication in RPA Builder doesn’t work, try deleting all client secrets in your Azure app and adding a new client secret with an expiration cycle of 6 months. ## Verify the Settings After registering the app and creating a client secret, open the app’s **Overview** page and ensure you have: - One secret under **Client Credentials** - One **Redirect URI** If you created a Single-tenant app, locate the tenant ID for further use in the Mail Session (Outlook with OAuth) configuration. Depending on the account type you selected when registering your app (Single or Multi tenant), the **OAuth Host** you configure in Mail Session (Outlook with OAuth) changes: - Multitenant: Specify `https://login.microsoftonline.com/common/oauth2/v2.0/` as the **OAuth Host** URL. - Single tenant: Specify `https://login.microsoftonline.com/{{YOUR_TENANT_ID}}/oauth2/v2.0/` as the **OAuth Host** URL. ## Add Permissions to the App After registering your app and creating its client secret, configure permission settings: 1. Open **API Permissions** in the side bar. 2. Click **Add a Permission** and select **Microsoft Graph**. 3. Select **Delegated Permissions** and add the following permissions from the **OpenId permissions** category: - `email` - `offline_access` - `openid` - `profile` 4. Select the appropriate permissions and protocols depending on your workflow needs: - Category `Mail` - Category `IMAP` - Category `EWS` - Category `POP` - Category `SMTP` If you don’t know the permissions and protocols that apply to your case, select all of them. ## See Also - [Mail Session (Outlook with OAuth)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-mail-operations-mail-session-outlook-with-oauth) - [Azure Tutorial: Register a web application in Azure Active Directory B2C](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications) - [Known Issues](https://help.salesforce.com/s/issues) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Troubleshooting Microsoft Azure Setup > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you have issues configuring your Azure account with Mail Session (Outlook with OAuth), follow these troubleshooting steps to ensure your app is properly registered and configured: 1. [Register an App in Azure](#register-app) 2. [Create a Client Secret for the App](#create-secret) 3. [Verify the Settings](#verify-settings) 4. [Add Permissions to the App](#add-permissions) ## Register an App in Azure 1. Navigate to [https://portal.azure.com/](https://portal.azure.com/) and log in with your Azure account. 2. Open the **App Registrations** page and create a new registration. - Select the supported account types. - Provide a Redirect URI. For the configuration to work, you must specify a valid redirect URL, for example: `http://localhost:49453/`. For additional instructions about registering apps in Azure, see [Azure: Register a web application](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications#register-a-web-application). ## Create a Client Secret for the App After registering an app in Azure, the app’s setting page opens. 1. Open the **Certificates & Secrets** page. 2. Create a new client secret. > [!WARNING] After creating the secret, ensure you copy its **Value** as this is the only time > you can see it. After you leave this page, the secret is no longer accessible. For additional instructions about creating client secrets, see [Azure: Create a client secret](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications#create-a-client-secret). In some cases, authentication might not work if you have more than one secret defined or use the 24 month expiration cycle. When your authentication in RPA Builder doesn’t work, try deleting all client secrets in your Azure app and adding a new client secret with an expiration cycle of 6 months. ## Verify the Settings After registering the app and creating a client secret, open the app’s **Overview** page and ensure you have: - One secret under **Client Credentials** - One **Redirect URI** If you created a Single-tenant app, locate the tenant ID for further use in the Mail Session (Outlook with OAuth) configuration. Depending on the account type you selected when registering your app (Single or Multi tenant), the **OAuth Host** you configure in Mail Session (Outlook with OAuth) changes: - Multitenant: Specify `https://login.microsoftonline.com/common/oauth2/v2.0/` as the **OAuth Host** URL. - Single tenant: Specify `https://login.microsoftonline.com/{{YOUR_TENANT_ID}}/oauth2/v2.0/` as the **OAuth Host** URL. ## Add Permissions to the App After registering your app and creating its client secret, configure permission settings: 1. Open **API Permissions** in the side bar. 2. Click **Add a Permission** and select **Microsoft Graph**. 3. Select **Delegated Permissions** and add the following permissions from the **OpenId permissions** category: - `email` - `offline_access` - `openid` - `profile` 4. Select the appropriate permissions and protocols depending on your workflow needs: - Category `Mail` - Category `IMAP` - Category `EWS` - Category `POP` - Category `SMTP` If you don’t know the permissions and protocols that apply to your case, select all of them. ## See Also - [Mail Session (OAuth)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-mail-operations-mail-session-oauth) - [Azure Tutorial: Register a web application in Azure Active Directory B2C](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-applications) - [Known Issues](https://help.salesforce.com/s/issues) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Upload to Google Drive > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upload files to your Google Drive. You can specify a target folder from your Google Workspace for the upload. ## Before You Begin Before uploading a file: - Configure your Google API Service Account Credentials. You can configure your credentials as an [Activity Parameter](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters#defining-activity-parameters) or inline in the action step wizard. ## Configure Your Authentication Settings Configure your authentication settings for the Google API service account in the **Authentication Settings** panel. Select **Pin credentials** to specify the activity parameter containing the credentials, or select **Use custom settings** to provide the information inline. You can either import a JSON file with your Google API credentials information or specify the authentication information manually. ## Configure File Upload Settings To configure file upload settings in the wizard: 1. Specify the directory path and the name of the file to upload. 2. Provide a Google Drive Folder ID to upload the file into this folder. If you don’t provide this value, this action step uploads the file to the root folder of your Google Drive. ## Properties - **Authentication Settings** - **Auth Provider x509 Cert URL** Authentication provider certificate URL for the Google API credentials. - **Auth URI** OAuth2 authentication URI for the Google API credentials. - **Client Email** Client email of the Google API credentials. - **Client ID** Client ID of the Google API credentials. - **Client x509 Cert URL** Client certificate URL for the Google API credentials. - **Credential Type** Type of Google API credentials. For example, `service_account`. - **Google API Service Account Credentials** Activity parameter containing all Google API credentials. - **Project ID** Project ID of the Google API credentials. - **Token URI** OAuth2 token URI for the Google API credentials. - **Universe Domain** Universe domain of the Google API credentials. - **Common** See [Common Properties](https://docs.mulesoft.com/rpa-builder/latest/common-properties) - **File Operation Settings** - **Directory path** Path to the directory where the file to upload is You can specify an absolute path or a path relative to the Base Path. - **File name** Name of the file to upload - **Google Drive Folder ID** ID of the destination Google Drive folder where to upload the file To get the folder ID, use the Search in Google Drive action step to find the folder. You can also go to the Google Drive folder and extract the ID (the value after `folder/`) from the URL. If you don’t specify a folder ID, this action step uploads the file to the root folder. ## Inbound Variables - **Directory path** - **File name** - **Google Drive Folder ID** - **Credential Type** - **Project ID** - **Private Key ID** - **Private Key** - **Token URI** - **Auth Provider x509 Cert URL** - **Auth URI** - **Client Email** - **Client ID** - **Client x509 Cert URL** - **Universe Domain** - **Google API Service Account Credentials** ## Outbound Variables - **Upload successful** Boolean indicating whether the upload was successful - **File ID in Google Drive** Returns the Google Drive file ID of the uploaded file ## See Also - [Activity Parameters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters) - [Google Workspace](https://docs.mulesoft.com/rpa-builder/latest/toolbox-google-drive-operations) --- product: RPA Builder version: 6.6 --- # User Account Decrypter > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Action Step _User Account Decrypter_ allows you to accept the activity parameter _User Account_ as an inbound variable and further process it as log-in data in the subsequent Action Steps. Please note that the username and password are displayed in plain text in the run results, among other places. ## Properties The Action Step _User Account Decrypter_ does not have any properties. ## Inbound Variables **User Account** Only one activity parameter of the type _User Account_ can be connected to this Action Step. ## Outbound Variables **Username** This variable is output as a string. **Password** This variable is output as a string. --- product: RPA Builder version: 6.7 is-latest-version: true --- # User Account Decrypter > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The action step _User Account Decrypter_ allows you to accept the activity parameter _User Account_ as an inbound variable and further process it as log-in data in the subsequent action steps. Please note that the username and password are displayed in plain text in the run results, among other places. ## Properties The action step _User Account Decrypter_ does not have any properties. ## Inbound Variables **User Account** Only one activity parameter of the type _User Account_ can be connected to this action step. ## Outbound Variables **Username** This variable is output as a string. **Password** This variable is output as a string. --- product: RPA Builder version: 6.6 --- # Using Regular Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Regular Expression or Regex are patterns that provide a means to specify and recognize texts. Some action steps support using Regex in their configuration. RPA Builder uses C# flavor for Regex and includes the Regex Tester tool, which enables you to [test regular expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions-testing-regular-expression). For specific use cases and examples, see [Regex Examples](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions-examples). If you need further information and references, following are some links to get you started with Regex: - Wikipedia on regular expressions: [https://en.wikipedia.org/wiki/Regular\_expression](https://en.wikipedia.org/wiki/Regular_expression) - Regex tutorials, examples, and references: [https://www.regular-expressions.info/](https://www.regular-expressions.info/) - External Regex tester tool: [http://regexstorm.net/tester](http://regexstorm.net/tester) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using Regular Expressions > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Regular Expression or Regex are patterns that provide a means to specify and recognize texts. Some action steps support using Regex in their configuration. RPA Builder uses C# flavor for Regex and includes the Regex Tester tool, which enables you to [test regular expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions-testing-regular-expression). For specific use cases and examples, see [Regex Examples](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions-examples). If you need further information and references, following are some links to get you started with Regex: - Wikipedia on regular expressions: [https://en.wikipedia.org/wiki/Regular\_expression](https://en.wikipedia.org/wiki/Regular_expression) - Regex tutorials, examples, and references: [https://www.regular-expressions.info/](https://www.regular-expressions.info/) - External Regex tester tool: [http://regexstorm.net/tester](http://regexstorm.net/tester) --- product: RPA Builder version: 6.6 --- # Using Search Patterns in a Workflow > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The **Capture** functionality provided in the Search Pattern, Pattern Select, and Pattern Gallery Action Steps enables you to create search patterns from a screenshot. Then, you can use these patterns in different elements of your Workflow. The Search Pattern, Pattern Select, and Pattern Gallery Action Steps also share the Pattern Strip module in the wizard, which provides a list of the existing patterns and their associated operations. ## Adding a Pattern from Screen Capture You can create search patterns in the Search Pattern, Pattern Select, and Pattern Gallery Action Steps by capturing a screenshot. The menu bars for these Action Steps include a **Capture** button (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/capture-button-icon.png)) for this purpose. Clicking **Capture** freezes the screen content like a screenshot and a small window with the title Capture Patterns appears. Then, you can select the search pattern by clicking and dragging to specify the area that contains the pattern. The selection surrounded with a blue rectangle is no longer transparent gray and you can move or resize it using the mouse or the keyboard. Press `Shift+Arrow key` to move the selection. Press `Ctrl+Arrow key` to resize the selection by moving the right and bottom edges. ![30%](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-pattern-capture.png) Select more than one search pattern by clicking and dragging multiple times. If the selected image detail is too small, not adequately differentiated, or if it contains too few of the features needed to recognize a search pattern, the search pattern definition window shows a red cross with a red background. ![20%](/mulesoft/current/en-us/rpa-builder/6.6/_images/incorrect-search-pattern.png) Click **Accept selection & continue** to add the applicable pattern to the wizard for the relevant Action Step. The wizard enables you to specify names and color spots for each of the captured patterns. To cancel the recording of a search pattern at any time, click the close button (**X**) in the upper right corner of the Capture Patterns window. ## The Capture Patterns Window ![30%](/mulesoft/current/en-us/rpa-builder/6.6/_images/capture-patterns-window.png) - **Unfreeze screen** Releases the frozen screen so that changes can be made on the screen again. - **Define Search Area** Enables you to reduce the search area from full screen to a smaller area by clicking and dragging the mouse. The selection is transparent red with a red border. When defining the search area, you can unfreeze and refreeze the screen. - **Reuse last defined Search Area** Enables you to reuse a search area defined in a previous capture. This option shows only if you already defined a search area when setting up the Workflow. - **Accept selection & continue** Adds the selection into the wizard for the corresponding Action Step and then returns to that Action Step. After you capture at least one search pattern, the **Delete selected pattern** option shows. This option removes the border around the previously selected pattern (or the last search area defined). ### Unfreeze Screen When you click **Unfreeze screen** the Capture Patterns window changes as follows: ![30%](/mulesoft/current/en-us/rpa-builder/6.6/_images/take-a-screenshot-window.png) - **Capture screen** Freezes the screen image again so that the pattern can be captured. - **Capture screen with delay** Starts the timer. After a delay, the screen image refreezes and the Capture Patterns window reappears. ## Using Color Spot with Search Patterns By default, RPA Builder only captures the pattern features for search patterns and color plays no role in pattern-based searches. However, sometimes you may find that it is necessary to determine when the color in a certain position in the search pattern is correct. For example, the text of an error message needs to be in red, or a traffic light symbol needs to appear green rather than yellow or red. In order to guarantee this, there is an option to define a Color Spot for a Search Pattern. In the case of a Search Pattern with Color Spot, the pattern-based image search is successful only if the color in a defined position matches a predefined color. When you hover a search pattern in the wizard for the relevant Action Step, an overlay menu bar shows at the end of the image. ![20%](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-pattern-icons.png) Click the **Color Spot Picker** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/color-picker-icon.png)) to open a window where you can select the color spot to use with the search pattern. ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/color-spot-picker-window.png) As you move the mouse over the image, the **Live values** section updates showing the following information: - **Color** The color value, expressed in RGB color values (`R:255`, `G:255`, `B:255`), for the current image coordinates. - **Coordinates** The image coordinates based on the current position of the mouse, indicated in `x;y` coordinates being `0;0` the upper-left corner of the image. To define the current selection as a Color Spot, either click the left mouse button or press `Insert` or `Space` on the keyboard. To delete the Color Spot, use the `Delete` or `Backspace` key. When you select a Color Spot, it shows in the **Selected Color Spot** section on the left side of the window. ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/color-spot-picker-window-selected-color.png) The following settings lessen the restrictions on Color Spots: - **Compare Radius (in pixels)** Determines the radius around the specified position for the Color Spot in which the specified color must be found. There is a graphical representation of this radius next to the input field. - **Color Fuzziness (in bits)** Determines the color deviation which is permitted for each RGB color channel. Use this option to specify how many low-order digits in the binary 8-digit color code can be ignored when comparing the color. ## The Pattern Strip Module Pattern Strip is a UI module that is used across all the wizards for the Search Pattern, Pattern Select, and Pattern Gallery Action Steps. The Pattern Strip consists of a list of Search Patterns, the associated options, and a menu bar. The menu bar buttons vary according to the Action Step and the quantity and selection status of the search patterns. Pattern Strip for the Pattern Gallery Action Step: ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/pattern-strip-pattern-gallery.png) Pattern Strip for the Pattern Select Action Step: ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/pattern-strip-pattern-select.png) Use the mouse to click and select search patterns. A white check mark appears on a blue background in the top-right corner to highlight a selected item. Click again to undo the selection. Buttons for functions relating only to the selected patterns appear on the menu bar only if at least one pattern is selected. ### Menu Bar The Pattern Strip menu bar has general buttons that show in all related Action Steps and buttons that are specific to the Search Pattern, Pattern Select, and Pattern Gallery Action Steps. The following table shows the button images, names, descriptions, and also in which of the related Action Steps they are available:
ButtonName and DescriptionPattern GalleryPattern SelectSearch Pattern

25%

Add from Gallery: Enables you to add existing patterns from the Pattern Gallery.

Yes

Yes

25%

Add Pattern Group: Creates a new pattern group which enables you to group patterns based on different criteria and perform group operations.

Yes

25%

Capture: Enables you to create a new pattern from a screen capture.

Yes

Yes

Yes

25%

Clear Selection: Removes all selections so that no image is selected.

Yes

Yes

Yes

25%

Copy: Copies the selected patterns to the specified pattern group.

Yes

25%

Delete Selection: Deletes the selected patterns.

Yes

Yes

Yes

25%

Delete Unused: Deletes the patterns that are not being used by any Action Steps.

Yes

25%

Link Group: Selects a Pattern Group and all search patterns included in that group. If the search patterns inside the linked group change, those changes are also reflected here.

Yes

Yes

25%

Move: In the Pattern Gallery, moves the selected patterns to the specified pattern group. In Search Pattern and Pattern Select, moves the selected patterns to the specified to either the Regular, Ignored, or Excluded sections.

Yes

Yes

Yes

25%

Select All: Selects all patterns in the current pattern group.

Yes

25%

Show Usage: Shows which Action Steps are using the currently selected patterns.

Yes

### Filtering for Pattern Names and Zooming Search Pattern Images ![30%](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-pattern-filter-and-zoom.png) The Pattern Gallery includes filter options in the main menu bar. Search Pattern and Pattern Select Action Steps show filter options at the beginning of the **Search Patterns** section in a separate menu bar and apply to all Pattern Strips in the wizard equally. Entering text into the **Filter…​** field hides all patterns in the subsequent sections of the wizard with names that do not contain the specified text. Filtering is applied as you type each letter. The filter text may appear in any position within the pattern name, but must be contiguous to be considered a match. For example: Consider a Search Pattern Action Step that contains search patterns with the following names `House`, `House1`, `Mouse`, and `Mouse1`. - If you type `use` in the filter, all images show. - If you type `1`, only `House1` and `Mouse1` show. - If you type `H`, only `House` and `House1` show. The **Zoom Out** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/zoom-out-icon.png)) and **Zoom In** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/zoom-in-icon.png)) buttons make all pattern images in the wizard either smaller or larger. ### Search Pattern Options When you position the mouse over a pattern, the following buttons appear: ![20%](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-pattern-icons.png) - The **Edit** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/edit-icon.png)) button enables you to rename the search pattern. Alternatively, you can click the name of the search pattern to rename it. This action also changes the name in the Pattern Gallery and all other Action Steps that use this pattern. - The **Recapture Pattern** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/capture-button-icon.png)) button enables you to replace the pattern with a new screenshot. Recapturing the pattern ensure that both the pattern name and its position in the list remain the same. - The **Color Spot Picker** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/color-picker-icon.png)) button opens a window where you can select the Color Spot within the pattern. See [Using Color Spot with Search Patterns](#using-color-spot-with-search-patterns) for additional details about the Color Spot functionality. - The **Delete Pattern** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-unused-button-icon.png)) button deletes the pattern. You can also delete a selected pattern using the **Delete Selection** (![2%](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-selection-button-icon.png)) button from the menu bar. ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-general-pattern-gallery) - [Pattern Select](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-flow-control-pattern-select) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-checks-search-pattern) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using Search Patterns in a Workflow > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The **Capture** functionality provided in the Search Pattern, Pattern Select, and Pattern Gallery action steps enables you to create search patterns from a screenshot. Then, you can use these patterns in different elements of your Workflow. The Search Pattern, Pattern Select, and Pattern Gallery action steps also share the Pattern Strip module in the wizard, which provides a list of the existing patterns and their associated operations. ## Adding a Pattern from Screen Capture You can create search patterns in the Search Pattern, Pattern Select, and Pattern Gallery action steps by capturing a screenshot. The menu bars for these action steps include a **Capture** button (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/capture-button-icon.png)) for this purpose. Clicking **Capture** freezes the screen content like a screenshot and a small window with the title Capture Patterns appears. Then, you can select the search pattern by clicking and dragging to specify the area that contains the pattern. The selection surrounded with a blue rectangle is no longer transparent gray and you can move or resize it using the mouse or the keyboard. Press `Shift+Arrow key` to move the selection. Press `Ctrl+Arrow key` to resize the selection by moving the right and bottom edges. ![30%](/mulesoft/current/en-us/rpa-builder/latest/_images/search-pattern-capture.png) Select more than one search pattern by clicking and dragging multiple times. If the selected image detail is too small, not adequately differentiated, or if it contains too few of the features needed to recognize a search pattern, the search pattern definition window shows a red cross with a red background. ![20%](/mulesoft/current/en-us/rpa-builder/latest/_images/incorrect-search-pattern.png) Click **Accept selection & continue** to add the applicable pattern to the wizard for the relevant action step. The wizard enables you to specify names and color spots for each of the captured patterns. To cancel the recording of a search pattern at any time, click the close button (**X**) in the upper right corner of the Capture Patterns window. ## The Capture Patterns Window ![30%](/mulesoft/current/en-us/rpa-builder/latest/_images/capture-patterns-window.png) - **Unfreeze screen** Releases the frozen screen so that changes can be made on the screen again. - **Define Search Area** Enables you to reduce the search area from full screen to a smaller area by clicking and dragging the mouse. The selection is transparent red with a red border. When defining the search area, you can unfreeze and refreeze the screen. - **Reuse last defined Search Area** Enables you to reuse a search area defined in a previous capture. This option shows only if you already defined a search area when setting up the Workflow. - **Accept selection & continue** Adds the selection into the wizard for the corresponding action step and then returns to that action step. After you capture at least one search pattern, the **Delete selected pattern** option shows. This option removes the border around the previously selected pattern (or the last search area defined). ### Unfreeze Screen When you click **Unfreeze screen** the Capture Patterns window changes as follows: ![30%](/mulesoft/current/en-us/rpa-builder/latest/_images/take-a-screenshot-window.png) - **Capture screen** Freezes the screen image again so that the pattern can be captured. - **Capture screen with delay** Starts the timer. After a delay, the screen image refreezes and the Capture Patterns window reappears. ## Using Color Spot with Search Patterns By default, RPA Builder only captures the pattern features for search patterns and color plays no role in pattern-based searches. However, sometimes you may find that it is necessary to determine when the color in a certain position in the search pattern is correct. For example, the text of an error message needs to be in red, or a traffic light symbol needs to appear green rather than yellow or red. In order to guarantee this, there is an option to define a Color Spot for a Search Pattern. In the case of a Search Pattern with Color Spot, the pattern-based image search is successful only if the color in a defined position matches a predefined color. When you hover a search pattern in the wizard for the relevant action step, an overlay menu bar shows at the end of the image. ![20%](/mulesoft/current/en-us/rpa-builder/latest/_images/search-pattern-icons.png) Click the **Color Spot Picker** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/color-picker-icon.png)) to open a window where you can select the color spot to use with the search pattern. ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/color-spot-picker-window.png) As you move the mouse over the image, the **Live values** section updates showing the following information: - **Color** The color value, expressed in RGB color values (`R:255`, `G:255`, `B:255`), for the current image coordinates. - **Coordinates** The image coordinates based on the current position of the mouse, indicated in `x;y` coordinates being `0;0` the upper-left corner of the image. To define the current selection as a Color Spot, either click the left mouse button or press `Insert` or `Space` on the keyboard. To delete the Color Spot, use the `Delete` or `Backspace` key. When you select a Color Spot, it shows in the **Selected Color Spot** section on the left side of the window. ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/color-spot-picker-window-selected-color.png) The following settings lessen the restrictions on Color Spots: - **Compare Radius (in pixels)** Determines the radius around the specified position for the Color Spot in which the specified color must be found. There is a graphical representation of this radius next to the input field. - **Color Fuzziness (in bits)** Determines the color deviation which is permitted for each RGB color channel. Use this option to specify how many low-order digits in the binary 8-digit color code can be ignored when comparing the color. ## The Pattern Strip Module Pattern Strip is a UI module that is used across all the wizards for the Search Pattern, Pattern Select, and Pattern Gallery action steps. The Pattern Strip consists of a list of Search Patterns, the associated options, and a menu bar. The menu bar buttons vary according to the action step and the quantity and selection status of the search patterns. Pattern Strip for the Pattern Gallery Action Step: ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/pattern-strip-pattern-gallery.png) Pattern Strip for the Pattern Select Action Step: ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/pattern-strip-pattern-select.png) Use the mouse to click and select search patterns. A white check mark appears on a blue background in the top-right corner to highlight a selected item. Click again to undo the selection. Buttons for functions relating only to the selected patterns appear on the menu bar only if at least one pattern is selected. ### Menu Bar The Pattern Strip menu bar has general buttons that show in all related action steps and buttons that are specific to the Search Pattern, Pattern Select, and Pattern Gallery action steps. The following table shows the button images, names, descriptions, and also in which of the related action steps they are available:
ButtonName and DescriptionPattern GalleryPattern SelectSearch Pattern

25%

Add from Gallery: Enables you to add existing patterns from the Pattern Gallery.

Yes

Yes

25%

Add Pattern Group: Creates a new pattern group which enables you to group patterns based on different criteria and perform group operations.

Yes

25%

Capture: Enables you to create a new pattern from a screen capture.

Yes

Yes

Yes

25%

Clear Selection: Removes all selections so that no image is selected.

Yes

Yes

Yes

25%

Copy: Copies the selected patterns to the specified pattern group.

Yes

25%

Delete Selection: Deletes the selected patterns.

Yes

Yes

Yes

25%

Delete Unused: Deletes the patterns that are not being used by any action steps.

Yes

25%

Link Group: Selects a Pattern Group and all search patterns included in that group. If the search patterns inside the linked group change, those changes are also reflected here.

Yes

Yes

25%

Move: In the Pattern Gallery, moves the selected patterns to the specified pattern group. In Search Pattern and Pattern Select, moves the selected patterns to the specified to either the Regular, Ignored, or Excluded sections.

Yes

Yes

Yes

25%

Select All: Selects all patterns in the current pattern group.

Yes

25%

Show Usage: Shows which action steps are using the currently selected patterns.

Yes

### Filtering for Pattern Names and Zooming Search Pattern Images ![30%](/mulesoft/current/en-us/rpa-builder/latest/_images/search-pattern-filter-and-zoom.png) The Pattern Gallery includes filter options in the main menu bar. Search Pattern and Pattern Select action steps show filter options at the beginning of the **Search Patterns** section in a separate menu bar and apply to all Pattern Strips in the wizard equally. Entering text into the **Filter…​** field hides all patterns in the subsequent sections of the wizard with names that do not contain the specified text. Filtering is applied as you type each letter. The filter text may appear in any position within the pattern name, but must be contiguous to be considered a match. For example: Consider a Search Pattern action step that contains search patterns with the following names `House`, `House1`, `Mouse`, and `Mouse1`. - If you type `use` in the filter, all images show. - If you type `1`, only `House1` and `Mouse1` show. - If you type `H`, only `House` and `House1` show. The **Zoom Out** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/zoom-out-icon.png)) and **Zoom In** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/zoom-in-icon.png)) buttons make all pattern images in the wizard either smaller or larger. ### Search Pattern Options When you position the mouse over a pattern, the following buttons appear: ![20%](/mulesoft/current/en-us/rpa-builder/latest/_images/search-pattern-icons.png) - The **Edit** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/edit-icon.png)) button enables you to rename the search pattern. Alternatively, you can click the name of the search pattern to rename it. This action also changes the name in the Pattern Gallery and all other action steps that use this pattern. - The **Recapture Pattern** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/capture-button-icon.png)) button enables you to replace the pattern with a new screenshot. Recapturing the pattern ensure that both the pattern name and its position in the list remain the same. - The **Color Spot Picker** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/color-picker-icon.png)) button opens a window where you can select the Color Spot within the pattern. See [Using Color Spot with Search Patterns](#using-color-spot-with-search-patterns) for additional details about the Color Spot functionality. - The **Delete Pattern** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-unused-button-icon.png)) button deletes the pattern. You can also delete a selected pattern using the **Delete Selection** (![2%](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-selection-button-icon.png)) button from the menu bar. ## See Also - [Pattern Gallery](https://docs.mulesoft.com/rpa-builder/latest/toolbox-general-pattern-gallery) - [Pattern Select](https://docs.mulesoft.com/rpa-builder/latest/toolbox-flow-control-pattern-select) - [Search Pattern](https://docs.mulesoft.com/rpa-builder/latest/toolbox-checks-search-pattern) --- product: RPA Builder version: 6.6 --- # Using the Activity Library > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Activity Library enables you to reuse certain activities that repeat during the automation of business processes, such as a login, to avoid creating the same workflow multiple times. Use the Activity Library Explorer to edit, copy, or delete activities and search for activities in your organization’s library based on Activity Tags. You can export activities to a package file `(.calw)` and import these activity package files into the Activity Library. You can create Activity Tags and assign them to the activities for further categorization and filtering capabilities. ## Before You Begin - To open and to use the Activity Library, you need the **Activity Library Open** and **Activity Library Administration** privileges. For more information about assigning user privileges, see [Assign Privileges to a User](https://docs.mulesoft.com/rpa-manager/usermanagement-manage#assign-privileges-to-a-user). ## Upload an Activity to the Activity Library To upload an activity to the Activity Library: 1. In RPA Builder, open a process for editing. 2. Click an activity to select it and open the context pad. 3. In the context pad, click **Add to Activity Library** (![Add to Activity Library Icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-to-activity-library-icon.png)) ![The context pad of an activity](/mulesoft/current/en-us/rpa-builder/6.6/_images/context-pad.png) 4. In the **Upload Workflow to Activity Library** window, provide a name and description for the activity. ![Upload Workflow to Activity Library window](/mulesoft/current/en-us/rpa-builder/6.6/_images/upload-workflow-to-activity-library.png) > [!IMPORTANT] Each activity must have a unique name, which cannot be longer than 60 characters. > Otherwise, RPA Builder cancels the upload and shows an error message. 5. Click **Upload**. ## Import an Activity from the Activity Library To import an activity from the Activity Library to your project: 1. Select an activity in your project. 2. In the context pad, click **Import Workflow from Activity Library** (![Import Workflow from Activity Library Icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/import-workflow-from-activity-library-icon.png)) 3. Select the activity to import and click either **Add as a library reference** or **Add as a local copy**, depending on which method you want to use. - **Add as a library reference** This method creates a link in each process to an activity from the Activity Library. Because the activity is already saved in the library, it is not uploaded again. The activity automatically receives the name of the reference, and you cannot change the name in the BPMN editor. An activity with a referenced workflow shows a gray background in the task element. ![An activity showing a gray background to specify that it has a referenced workflow](/mulesoft/current/en-us/rpa-builder/6.6/_images/referenced-activity.png) If you import an activity from the Activity Library as a reference, the system checks whether the activity parameters contained in the activity fit the process. If the activity (or the workflow behind it) contains activity parameters that are missing in the process, you can either add these parameters to the process or cancel the import. You cannot import an activity that contains activity parameters that use the same name but a different data type as the activity parameters in the process. - **Add as a local copy** This method creates a local copy of the workflow behind the activity and inserts it into the project, which enables you to make changes. However, because there is no reference to the activity in the Activity Library, the local copy does not automatically update if the activity in the Activity Library changes. ## Change the Revision of a Referenced Activity If the deployed revision of a referenced activity does not work properly in a process or if you accidentally [deployed the latest revision using RPA Manager](https://docs.mulesoft.com/rpa-manager/processoperations-upcomingprocesschanges#deploy-the-latest-version-of-an-activity), follow these steps to revert the activity to an earlier or later revision: 1. In the BPMN editor, click the referencing activity. 2. On the context pad, click **Show Activity Log** (![The Show Log button](/mulesoft/current/en-us/rpa-builder/6.6/_images/activity-library-explorer-toolbar-show-log.png)). 3. In the window **Activity Log**, select the revision to use. The link symbol shows the currently referenced revision. 4. Click **Download**. 5. In the window **A workflow is already mapped to this activity**, click **Yes** to replace the workflow with the selected revision. ## Convert Referenced Activities to a Local Copy Creating a copy of a referenced activity enables you to modify the activity. To create a local copy of a referenced activity: 1. In the BMPN editor, double-click the referenced activity to copy. 2. Click **Create Copy**. After you click **Create a Copy**, the workflow behind the activity opens in the Workbench for editing. Because the activity loses its reference, the next time you upload the activity, it is treated as a new workflow. ## See Also - [Activity Library Explorer](https://docs.mulesoft.com/rpa-builder/6.6/activity-library-explorer) - [Activity Tags](https://docs.mulesoft.com/rpa-builder/6.6/activity-tags) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using the Activity Library > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Activity Library enables you to reuse certain activities that repeat during the automation of business processes, such as a login, to avoid creating the same workflow multiple times. Use the Activity Library Explorer to edit, copy, or delete activities and search for activities in your organization’s library based on Activity Tags. You can export activities to a package file `(.calw)` and import these activity package files into the Activity Library. You can create Activity Tags and assign them to the activities for further categorization and filtering capabilities. ## Before You Begin - To open and to use the Activity Library, you need the **Activity Library Open** and **Activity Library Administration** privileges. For more information about assigning user privileges, see [Assign Privileges to a User](https://docs.mulesoft.com/rpa-manager/usermanagement-manage#assign-privileges-to-a-user). ## Upload an Activity to the Activity Library To upload an activity to the Activity Library: 1. In RPA Builder, open a process for editing. 2. Click an activity to select it and open the context pad. 3. In the context pad, click **Add to Activity Library** (![Add to Activity Library Icon](/mulesoft/current/en-us/rpa-builder/latest/_images/add-to-activity-library-icon.png)) ![The context pad of an activity](/mulesoft/current/en-us/rpa-builder/latest/_images/context-pad.png) 4. In the **Upload Workflow to Activity Library** window, provide a name and description for the activity. ![Upload Workflow to Activity Library window](/mulesoft/current/en-us/rpa-builder/latest/_images/upload-workflow-to-activity-library.png) > [!IMPORTANT] Each activity must have a unique name, which cannot be longer than 60 characters. > Otherwise, RPA Builder cancels the upload and shows an error message. 5. Click **Upload**. ## Import an Activity from the Activity Library To import an activity from the Activity Library to your project: 1. Select an activity in your project. 2. In the context pad, click **Import Workflow from Activity Library** (![Import Workflow from Activity Library Icon](/mulesoft/current/en-us/rpa-builder/latest/_images/import-workflow-from-activity-library-icon.png)) 3. Select the activity to import and click either **Add as a library reference** or **Add as a local copy**, depending on which method you want to use. - **Add as a library reference** This method creates a link in each process to an activity from the Activity Library. Because the activity is already saved in the library, it is not uploaded again. The activity automatically receives the name of the reference, and you cannot change the name in the BPMN editor. An activity with a referenced workflow shows a gray background in the task element. ![An activity showing a gray background to specify that it has a referenced workflow](/mulesoft/current/en-us/rpa-builder/latest/_images/referenced-activity.png) If you import an activity from the Activity Library as a reference, the system checks whether the activity parameters contained in the activity fit the process. If the activity (or the workflow behind it) contains activity parameters that are missing in the process, you can either add these parameters to the process or cancel the import. You cannot import an activity that contains activity parameters that use the same name but a different data type as the activity parameters in the process. - **Add as a local copy** This method creates a local copy of the workflow behind the activity and inserts it into the project, which enables you to make changes. However, because there is no reference to the activity in the Activity Library, the local copy does not automatically update if the activity in the Activity Library changes. ## Change the Revision of a Referenced Activity If the deployed revision of a referenced activity does not work properly in a process or if you accidentally [deployed the latest revision using RPA Manager](https://docs.mulesoft.com/rpa-manager/processoperations-upcomingprocesschanges#deploy-the-latest-version-of-an-activity), follow these steps to revert the activity to an earlier or later revision: 1. In the BPMN editor, click the referencing activity. 2. On the context pad, click **Show Activity Log** (![The Show Log button](/mulesoft/current/en-us/rpa-builder/latest/_images/activity-library-explorer-toolbar-show-log.png)). 3. In the window **Activity Log**, select the revision to use. The link symbol shows the currently referenced revision. 4. Click **Download**. 5. In the window **A workflow is already mapped to this activity**, click **Yes** to replace the workflow with the selected revision. ## Convert Referenced Activities to a Local Copy Creating a copy of a referenced activity enables you to modify the activity. To create a local copy of a referenced activity: 1. In the BMPN editor, double-click the referenced activity to copy. 2. Click **Create Copy**. After you click **Create a Copy**, the workflow behind the activity opens in the Workbench for editing. Because the activity loses its reference, the next time you upload the activity, it is treated as a new workflow. ## See Also - [Activity Library Explorer](https://docs.mulesoft.com/rpa-builder/latest/activity-library-explorer) - [Activity Tags](https://docs.mulesoft.com/rpa-builder/latest/activity-tags) --- product: RPA Builder version: 6.6 --- # Using the Browser Wizard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Browser Wizard_ is part of _Web Automation Action Step_ wizards. It behaves like a normal browser and enables you to select additional elements of a website and determine their _Xpath_. Using the _Browser Wizard_ is required by most _Web Automation_ objects embedded in a _Web Session_. ![The Open Browser Wizard button](/mulesoft/current/en-us/rpa-builder/6.6/_images/open-browser-wizard-button.png) Clicking the **Open Browser Wizard** button in one of the wizards opens a new window that functions as a browser and loads the URL that is defined as the initial URL for the enclosing _Web Session_. ![The Browser Wizard window](/mulesoft/current/en-us/rpa-builder/6.6/_images/browser-wizard.png) If you start the _Web Session_ with `about:blank`, you can enter a URL in the address bar of the _Browser Wizard_ and the wizard loads this URL when you press _Enter_. ## Selecting Web Elements When you position the cursor over the element you want to check or use within a _Web Automation_ object, the wizard highlights the element with a blue background. If hovering over the elements does not highlight them, click on the website or web application within the _Browser Wizard_ to activate it first. ![The Browser Wizard window showing a highlighted element](/mulesoft/current/en-us/rpa-builder/6.6/_images/browser-wizard-highlight.png) To select the highlighted element press _F2_. After selecting an element, its background turns blue and the _XPath_ and available attributes corresponding to this element show on the Properties panel. ## Browser Wizard Toolbar The following list describes the buttons of the _Browser Wizard_ toolbar: - (![The Back button](/mulesoft/current/en-us/rpa-builder/6.6/_images/back-icon.png)): Navigates back. - (![The Forward button](/mulesoft/current/en-us/rpa-builder/6.6/_images/forward-icon.png)): Navigates forward. - (![The Reload button](/mulesoft/current/en-us/rpa-builder/6.6/_images/reload-icon.png)): Reloads the current page. - (![The Clear Cache and delete Cookies button](/mulesoft/current/en-us/rpa-builder/6.6/_images/clear-cache-cookies.png)): Clears the browser cache data and Cookies. - (![The Accept Selection and take over Input/Selection button](/mulesoft/current/en-us/rpa-builder/6.6/_images/double-check-icon.png)): Confirms the selection and extracts the _XPath_ of the selected element along with the current input as values. This option is available only in the **Keystrokes to Web Element** Wizard. - (![The back button](/mulesoft/current/en-us/rpa-builder/6.6/_images/check-icon.png)): Confirms the selection and extracts the _XPath_ of the selected element. ## See Also - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation) - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-chrome) - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-firefox) - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-ms-edge) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using the Browser Wizard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Browser Wizard_ is part of _Web Automation action step_ wizards. It behaves like a normal browser and enables you to select additional elements of a website and determine their _Xpath_. Using the _Browser Wizard_ is required by most _Web Automation_ objects embedded in a _Web Session_. ![The Open Browser Wizard button](/mulesoft/current/en-us/rpa-builder/latest/_images/open-browser-wizard-button.png) Clicking the **Open Browser Wizard** button in one of the wizards opens a new window that functions as a browser and loads the URL that is defined as the initial URL for the enclosing _Web Session_. ![The Browser Wizard window](/mulesoft/current/en-us/rpa-builder/latest/_images/browser-wizard.png) If you start the _Web Session_ with `about:blank`, you can enter a URL in the address bar of the _Browser Wizard_ and the wizard loads this URL when you press _Enter_. ## Selecting Web Elements When you position the cursor over the element you want to check or use within a _Web Automation_ object, the wizard highlights the element with a blue background. If hovering over the elements does not highlight them, click on the website or web application within the _Browser Wizard_ to activate it first. ![The Browser Wizard window showing a highlighted element](/mulesoft/current/en-us/rpa-builder/latest/_images/browser-wizard-highlight.png) To select the highlighted element press _F2_. After selecting an element, its background turns blue and the _XPath_ and available attributes corresponding to this element show on the Properties panel. ## Browser Wizard Toolbar The following list describes the buttons of the _Browser Wizard_ toolbar: - (![The Back button](/mulesoft/current/en-us/rpa-builder/latest/_images/back-icon.png)): Navigates back. - (![The Forward button](/mulesoft/current/en-us/rpa-builder/latest/_images/forward-icon.png)): Navigates forward. - (![The Reload button](/mulesoft/current/en-us/rpa-builder/latest/_images/reload-icon.png)): Reloads the current page. - (![The Clear Cache and delete Cookies button](/mulesoft/current/en-us/rpa-builder/latest/_images/clear-cache-cookies.png)): Clears the browser cache data and Cookies. - (![The Accept Selection and take over Input/Selection button](/mulesoft/current/en-us/rpa-builder/latest/_images/double-check-icon.png)): Confirms the selection and extracts the _XPath_ of the selected element along with the current input as values. This option is available only in the **Keystrokes to Web Element** Wizard. - (![The back button](/mulesoft/current/en-us/rpa-builder/latest/_images/check-icon.png)): Confirms the selection and extracts the _XPath_ of the selected element. ## See Also - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation) - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-chrome) - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-firefox) - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-ms-edge) --- product: RPA Builder version: 6.6 --- # Using Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Variables are powerful tools that allow you to save and use values throughout your Workflow. You can predefine variables (the _Login Data_ in your _Workflow_ for example) or create variables at runtime (by using _Read Clipboard_ for example) and then use these variables within other _Action Steps_. Think of a variable as a placeholder for any text/numeric constant, or value. When creating the _Workflow_, you can create variables and use them as placeholders. During execution, these variables will be resolved to the value you gave them or that you want to assign to during execution. For example, if _Read Clipboard_ is used, then the clipboard content at that point during execution will be transferred to a variable and any _Action Step_ referencing that variable will then use the value transferred. ## Pin Variables Pin variables are used by creating a mapping between one set of _Action Step_ properties and another _Action Step_ variable. If this option is available, a little pin will be shown on the _Action Step_ that can be mapped to: ![Example Pin](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-variables-pin-variables-image1.png) In the example above, _Read Clipboard_ provides a variable which can then be subsequently used by _Ping_. This is indicated by the pin icon on the right-hand side of the _Ping_ element. Click on the pin to open the _Edit Variable Mappings_ wizard: ![Edit Variable Mappings wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-variables-pin-variables-image2.png) Here you can see a list of all _Ping_ properties that can be mapped to. Each property has an adjacent drop-down box containing all variables which can be mapped to the associated property. To map a variable, simply select it from the drop-down box. The variables which can be allocated may change depending on the position of the _Action Step_. A variable can only be allocated to the property "Suffix" within a configured _File Controlled Loop_. Other variables are limited to one _Transaction_. This limitation can be overcome using the _Variable_ _Action Step_. When you close the wizard, you will see that there is now an active mapping, indicated by a black pin: ![Example black pin](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-variables-pin-variables-image3.png) You can also view a list of all other _Action Steps_ that a particular _Action Step_ has taken variables from. To do this, open the context menu for the _Action Step_ of interest by right-clicking on the _Workbench_, then select the entry _Mapped to Action Step_. The list will be displayed as a sub-menu. ![List Mapped to Action Step](/mulesoft/current/en-us/rpa-builder/6.6/_images/advanced-concepts-using-variables-pin-variables-image4.png) Clicking on an element in this sub-menu will take you directly to the corresponding _Action Step._ --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Variables are powerful tools that allow you to save and use values throughout your Workflow. You can predefine variables (the _Login Data_ in your _Workflow_ for example) or create variables at runtime (by using _Read Clipboard_ for example) and then use these variables within other action steps. Think of a variable as a placeholder for any text/numeric constant, or value. When creating the _Workflow_, you can create variables and use them as placeholders. During execution, these variables will be resolved to the value you gave them or that you want to assign to during execution. For example, if _Read Clipboard_ is used, then the clipboard content at that point during execution will be transferred to a variable and any action step referencing that variable will then use the value transferred. ## Pin Variables Pin variables are used by creating a mapping between one set of action step properties and another action step variable. If this option is available, a little pin will be shown on the action step that can be mapped to: ![Example Pin](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-variables-pin-variables-image1.png) In the example above, _Read Clipboard_ provides a variable which can then be subsequently used by _Ping_. This is indicated by the pin icon on the right-hand side of the _Ping_ element. Click on the pin to open the _Edit Variable Mappings_ wizard: ![Edit Variable Mappings wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-variables-pin-variables-image2.png) Here you can see a list of all _Ping_ properties that can be mapped to. Each property has an adjacent drop-down box containing all variables which can be mapped to the associated property. To map a variable, simply select it from the drop-down box. The variables which can be allocated may change depending on the position of the action step. A variable can only be allocated to the property "Suffix" within a configured _File Controlled Loop_. Other variables are limited to one _Transaction_. This limitation can be overcome using the _Variable_ action step. When you close the wizard, you will see that there is now an active mapping, indicated by a black pin: ![Example black pin](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-variables-pin-variables-image3.png) You can also view a list of all other action steps that a particular action step has taken variables from. To do this, open the context menu for the action step of interest by right-clicking on the _Workbench_, then select the entry _Mapped to action step_. The list will be displayed as a sub-menu. ![List Mapped to action step](/mulesoft/current/en-us/rpa-builder/latest/_images/advanced-concepts-using-variables-pin-variables-image4.png) Clicking on an element in this sub-menu will take you directly to the corresponding action step. --- product: RPA Builder version: 6.6 --- # Using Workflow Debugger > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder provides an integrated debugger for Workflows. To use the debugger, click **Debug Workflow** (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/debug-icon.png)) or press _F8_. This starts a test run and opens Workflow Debugger instead of stopping the execution of the Workflow if an error occurs. When you execute a **Debug Workflow** run, you can call Workflow Debugger by pressing _Pause/Break_ on your keyboard. You can change the configuration of Workflow objects within the Workflow Debugger and then re-run them or continue from the current position. When the Workflow enters an error state, Workflow Debugger appears. ![The Workflow Debugger window](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-debugger-window.png)
1The first pane in Workflow Debugger shows a condensed view of your Workflow and an arrow indicating which step was the last to execute.
2The second pane shows the debug information for the selected Action Step. The Debug Information panel contains a combination of configuration settings and runtime information relating to Action Steps already executed.
In this example, the Workflow entered the error state at the Window Wait Action Step. In the Debug Information panel, the **Result** section confirms that the window could not be found. Also, in the **Configuration** section, the **WindowTitle** value is set to `testname`, which caused the error because no window with that title existed during the execution. ## Workflow Debugger Toolbar The Workflow Debugger Toolbar contains the following buttons: - (![The Repeat icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/reload-workflow-icon.png)): **Repeat** Executes the Action Step again. - (![The Edit & Repeat icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/edit-and-repeat-icon.png)): **Edit & Repeat** Opens the wizard for the last Action Step executed and enables you to modify its configuration and settings to fix the error. The Action Step then executes again to ensure it works correctly after the changes. The Workflow Debugger shows again on completion and you can check whether the **Run State** is `OK` or `Error`. - (![The Continue icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-process.png)): **Continue** Continues the Workflow execution. Note that the **Continue with Runstate:** drop-down menu reflects the current **Run State**. You can force the state to `Error` or `OK` at this point. For example, if you want to debug the _OnError_ part of a Managed Block, set the state to `Error` during the _DoAction_ section which subsequently leads to the execution of the _OnError_ section. You can also force the **Run State** to `OK` when you want the rest of the Workflow to be executed even though an error occurred. - (![The Single Step icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/step-forward.png)): **Single Step** Use this button to execute the Workflow step-by-step. - (![The Stop icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/stop-icon.png)): **Stop** Stops the current debugging run and returns to RPA Builder. Note that you can call the wizard for an Action Step at any time by double-clicking it. ## Using Breakpoints Breakpoints enable you to set points in the Workflow where the Workflow Debugger always stops the execution. You can either set breakpoints before starting a debug run or you can set them within the Workflow Debugger itself. Any Workflow object can have a breakpoint. To add a breakpoint to a Workflow object in the Workbench, right-click the object and select **Set Breakpoint** from the context menu. The breakpoint icon (![The Breakpoint icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/breakpoint-icon.png)) shows next to that element. ![The Workflow window showing a Breakpoint next the to the Window Wait Action Step](/mulesoft/current/en-us/rpa-builder/6.6/_images/breakpoint.png) To remove the breakpoint, right-click the Workflow object again and select **Delete Breakpoint** from the context menu. Setting a breakpoint for an item that contains other Action Steps (Transaction, Managed Block, etc.) enables you to repeat that item (and all of its contents) as a complete unit. This is useful when you are not quite sure of the root cause of an error. You can repeat the surrounding Transaction until you find out where an error occurs. You can also set and delete breakpoints directly in the Workflow Debugger by clicking on the bar that shows before an object: ![The Workflow Debugger showing breakpoints](/mulesoft/current/en-us/rpa-builder/6.6/_images/set-breakpoint.png) RPA Builder saves breakpoints that you have defined in a Workflow along with the Workflow and you can reuse them at any time. Note that breakpoints only affect debug runs. Actual Workflow executions ignore breakpoints. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/6.6/running-workflows-and-using-workflow-run-results) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/6.6/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Using Workflow Debugger > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder provides an integrated debugger for Workflows. To use the debugger, click **Debug Workflow** (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/debug-icon.png)) or press _F8_. This starts a test run and opens Workflow Debugger instead of stopping the execution of the Workflow if an error occurs. When you execute a **Debug Workflow** run, you can call Workflow Debugger by pressing _Pause/Break_ on your keyboard. You can change the configuration of Workflow objects within the Workflow Debugger and then re-run them or continue from the current position. When the Workflow enters an error state, Workflow Debugger appears. ![The Workflow Debugger window](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-debugger-window.png)
1The first pane in Workflow Debugger shows a condensed view of your Workflow and an arrow indicating which step was the last to execute.
2The second pane shows the debug information for the selected action step. The Debug Information panel contains a combination of configuration settings and runtime information relating to action steps already executed.
In this example, the Workflow entered the error state at the Window Wait action step. In the Debug Information panel, the **Result** section confirms that the window could not be found. Also, in the **Configuration** section, the **WindowTitle** value is set to `testname`, which caused the error because no window with that title existed during the execution. ## Workflow Debugger Toolbar The Workflow Debugger Toolbar contains the following buttons: - (![The Repeat icon](/mulesoft/current/en-us/rpa-builder/latest/_images/reload-workflow-icon.png)): **Repeat** Executes the action step again. - (![The Edit & Repeat icon](/mulesoft/current/en-us/rpa-builder/latest/_images/edit-and-repeat-icon.png)): **Edit & Repeat** Opens the wizard for the last action step executed and enables you to modify its configuration and settings to fix the error. The action step then executes again to ensure it works correctly after the changes. The Workflow Debugger shows again on completion and you can check whether the **Run State** is `OK` or `Error`. - (![The Continue icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-process.png)): **Continue** Continues the Workflow execution. Note that the **Continue with Runstate:** drop-down menu reflects the current **Run State**. You can force the state to `Error` or `OK` at this point. For example, if you want to debug the _OnError_ part of a Managed Block, set the state to `Error` during the _DoAction_ section which subsequently leads to the execution of the _OnError_ section. You can also force the **Run State** to `OK` when you want the rest of the Workflow to be executed even though an error occurred. - (![The Single Step icon](/mulesoft/current/en-us/rpa-builder/latest/_images/step-forward.png)): **Single Step** Use this button to execute the Workflow step-by-step. - (![The Stop icon](/mulesoft/current/en-us/rpa-builder/latest/_images/stop-icon.png)): **Stop** Stops the current debugging run and returns to RPA Builder. Note that you can call the wizard for an action step at any time by double-clicking it. ## Using Breakpoints Breakpoints enable you to set points in the Workflow where the Workflow Debugger always stops the execution. You can either set breakpoints before starting a debug run or you can set them within the Workflow Debugger itself. Any Workflow object can have a breakpoint. To add a breakpoint to a Workflow object in the Workbench, right-click the object and select **Set Breakpoint** from the context menu. The breakpoint icon (![The Breakpoint icon](/mulesoft/current/en-us/rpa-builder/latest/_images/breakpoint-icon.png)) shows next to that element. ![The Workflow window showing a Breakpoint next the to the Window Wait action step](/mulesoft/current/en-us/rpa-builder/latest/_images/breakpoint.png) To remove the breakpoint, right-click the Workflow object again and select **Delete Breakpoint** from the context menu. Setting a breakpoint for an item that contains other action steps (Transaction, Managed Block, etc.) enables you to repeat that item (and all of its contents) as a complete unit. This is useful when you are not quite sure of the root cause of an error. You can repeat the surrounding Transaction until you find out where an error occurs. You can also set and delete breakpoints directly in the Workflow Debugger by clicking on the bar that shows before an object: ![The Workflow Debugger showing breakpoints](/mulesoft/current/en-us/rpa-builder/latest/_images/set-breakpoint.png) RPA Builder saves breakpoints that you have defined in a Workflow along with the Workflow and you can reuse them at any time. Note that breakpoints only affect debug runs. Actual Workflow executions ignore breakpoints. ## See Also - [Running Workflows and Using Workflow Run Results](https://docs.mulesoft.com/rpa-builder/latest/running-workflows-and-using-workflow-run-results) - [Analyzing Problems with Analysis Packages](https://docs.mulesoft.com/rpa-builder/latest/analyzing-problems-with-analysis-packages) --- product: RPA Builder version: 6.6 --- # Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ makes it possible to set up a simple string variable. This variable can also be made available globally for the entire _Workflow_ under Properties and "Make Variable available in all Transactions". Other variables can be used as Inbound Variables and therefore made global. ## Properties **Variable Value** Defines the variable value which can be mapped onto another variable. **Make Variable available in all Transactions** Makes the variable available for the entire _Workflow_ in all transactions. Variables are normally only available within their transaction. ## Inbound Variables **Suffix** can be used if the _Variable_ is located within the _Control Block’s_ _File Controlled Loop_**.** A suffix is then added to the name of the _Variable_ during every loop_._ Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. **Variable Value** Defines the variable value which can be mapped onto another variable. ## Outbound Variables **Value** Returns the current value of the _Variable._ --- product: RPA Builder version: 6.7 is-latest-version: true --- # Variable > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step makes it possible to set up a simple string variable. This variable can also be made available globally for the entire _Workflow_ under Properties and "Make Variable available in all Transactions". Other variables can be used as Inbound Variables and therefore made global. ## Properties **Variable Value** Defines the variable value which can be mapped onto another variable. **Make Variable available in all Transactions** Makes the variable available for the entire _Workflow_ in all transactions. Variables are normally only available within their transaction. ## Inbound Variables **Suffix** can be used if the _Variable_ is located within the _Control Block’s_ _File Controlled Loop_**.** A suffix is then added to the name of the _Variable_ during every loop_._ Each suffix is a column entry in the file that was imported in the _File Controlled Loop_. **Variable Value** Defines the variable value which can be mapped onto another variable. ## Outbound Variables **Value** Returns the current value of the _Variable._ --- product: RPA Builder version: 6.6 --- # Variable Handling > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Variable Handling enables you to perform multiple actions like mathematical operations, parse objects, read system variables, and also read and write variables for the automation workflow. - [Activity Parameters](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-activity-parameters) The Action Step Activity Parameters (AP) enables you to map variables that you can use not only in the Workflow, but also in the activities of the business process and gateways. - [Append to Array](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-append-to-array) The Append to Array Action Step enables you to append a single value or an array to an existing array. - [Check Regex](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-check-regex) Use the Check Regex Action Step to search for a text fragment using a regular expression. - [Check Value](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-check-value) This Action Step enables you to compare two numerical or alphanumerical (case-sensitive and case-insensitive) values to each other, using different comparison methods. - [Combine Strings](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-combine-strings) The Combine Strings Action Step enables you to combine multiple variables into a single new variable. - [Convert String](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-convert-string) This Action Step converts a given string or variable to any other variable type and makes it available as a set of new variables. - [Coordinates](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-coordinates) The Coordinates Action Step can be used to either specify a Variable of type Coordinates in the Workflow or to modify existing coordinates. - [Generate Date and Time](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-generate-and-modify-date-and-time) Use Generate date and time to create a configurable time stamp. - [Get Array Count](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-get-array-count) The Get Array Count Action Step returns the number of elements in an array. - [Json Query](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-json-query) The Json Query Action Step enables you to parse Json objects and to read individual values / elements from the object. - [Math Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-math-operations) You can use this Action Step to perform mathematical calculations. - [Read Clipboard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-read-clipboard) This Action Step simply copies the current clipboard content into a variable (see Section Using Variables) for further usage within the Workflow. - [Read from Array](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-read-from-array) The Read from Array Action Step is used to access the content of an array. - [Run Time Variables](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-runtime-variables) The RunTime Variables Action Step enables you to use variables defined during runtime in a Workflow. - [Session Based Variables](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-session-based-variables) The Session Based Variables Action Step enables you to share variables between workflows that execute on the same session. - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-array-variable) The Set Array Variable Action Step enables you to assign new values to an array. - [Set Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-set-variable) The Set Variable Action Step assigns a new value to a variable. - [String Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-string-operations) The String Operations Action Step enables you to modify strings. - [String to Array](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-string-to-array) The String to Array Action Step enables you to split a string into arrays and to process them further in next Action Steps, such as with the Read from Array Action Step. - [User Account Decrypter](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-user-account-decrypter) The Action Step User Account Decrypter enables you to accept the activity parameter User Account as an inbound variable and further process it as log-in data in next Action Steps. - [Variable](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-variable) This Action Step makes it possible to set up a simple string variable. - [Workflow Based Variables](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-workflow-based-variables) The Workflow Based Variables Action Step contains variables which can be used throughout the entire Workflow and which can be modified. - [Write Clipboard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-write-clipboard) Use Write Clipboard to copy a piece of text to the clipboard. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Variable Handling > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Variable Handling enables you to perform multiple actions like mathematical operations, parse objects, read system variables, and also read and write variables for the automation workflow. - [Activity Parameters](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-activity-parameters) The action step Activity Parameters (AP) enables you to map variables that you can use not only in the Workflow, but also in the activities of the business process and gateways. - [Append to Array](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-append-to-array) The Append to Array action step enables you to append a single value or an array to an existing array. - [Check Regex](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-check-regex) Use the Check Regex action step to search for a text fragment using a regular expression. - [Check Value](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-check-value) This action step enables you to compare two numerical or alphanumerical (case-sensitive and case-insensitive) values to each other, using different comparison methods. - [Combine Strings](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-combine-strings) The Combine Strings action step enables you to combine multiple variables into a single new variable. - [Convert String](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-convert-string) This action step converts a given string or variable to any other variable type and makes it available as a set of new variables. - [Coordinates](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-coordinates) The Coordinates action step can be used to either specify a Variable of type Coordinates in the Workflow or to modify existing coordinates. - [Generate Date and Time](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-generate-and-modify-date-and-time) Use Generate date and time to create a configurable time stamp. - [Get Array Count](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-get-array-count) The Get Array Count action step returns the number of elements in an array. - [Json Query](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-json-query) The Json Query action step enables you to parse Json objects and to read individual values / elements from the object. - [Math Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-math-operations) You can use this action step to perform mathematical calculations. - [Read Clipboard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-read-clipboard) This action step simply copies the current clipboard content into a variable (see Section Using Variables) for further usage within the Workflow. - [Read from Array](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-read-from-array) The Read from Array action step is used to access the content of an array. - [Run Time Variables](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-runtime-variables) The RunTime Variables action step enables you to use variables defined during runtime in a Workflow. - [Session Based Variables](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-session-based-variables) The Session Based Variables action step enables you to share variables between workflows that execute on the same session. - [Set Array Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-array-variable) The Set Array Variable action step enables you to assign new values to an array. - [Set Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-set-variable) The Set Variable action step assigns a new value to a variable. - [String Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-string-operations) The String Operations action step enables you to modify strings. - [String to Array](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-string-to-array) The String to Array action step enables you to split a string into arrays and to process them further in next action steps, such as with the Read from Array action step. - [User Account Decrypter](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-user-account-decrypter) The action step User Account Decrypter enables you to accept the activity parameter User Account as an inbound variable and further process it as log-in data in next action steps. - [Variable](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-variable) This action step makes it possible to set up a simple string variable. - [Workflow Based Variables](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-workflow-based-variables) The Workflow Based Variables action step contains variables which can be used throughout the entire Workflow and which can be modified. - [Write Clipboard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-write-clipboard) Use Write Clipboard to copy a piece of text to the clipboard. --- product: RPA Builder version: 6.6 --- # Web Automation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Web Automation_ Action Steps are designed specifically to automate browsers and web-based applications. In contrast to the regular _Action Steps_, these do not just simulate user operations, but are also able to handle and control objects within a web-based application. This features can be used in any website or application that runs in a browser. - [Check Web Element](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-check-web-element) Use this Web Automation object to verify if a website or web application element was loaded properly and how long this took. - [Clear Web Element](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-clear-web-element) This Web Automation object is used to clear the content of fields on a website or in a web application. - [Click Web Element](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-click-web-element) Use this element to simulate mouse input on a website element. - [Close Web Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-close-web-session) The Action Step Close Web Session enables you to close a web session. - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation) The Web Automation Action Steps share the Common Properties. - [Confirm Alert Box](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-confirm-alert-box) This Web Automation object allows you to confirm or dismiss JavaScript Alert Boxes, and enter text in JavaScript input boxes. - [Get Web Element Text](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-get-web-element-text) The Get Element Text Action Step reads the innerText of an element. - [Keystrokes to Web Element](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-keystrokes-to-web-element) Use this Web Automation object to enter alphanumeric characters into fields on a website or within a web application. - [Navigate](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-navigate) This Web Automation object allows you to perform navigation operations, such as going backwards or forward in the navigation history or refreshing the current webpage. - [Select Web Element](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-select-web-element) Use this Web Automation object to select an option from a list box or a drop-down box. - [Submit Form](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-submit-form) This Web Automation object allows you to submit a form on a webpage. - [Using the Browser Wizard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-using-the-browser-wizard) The Browser Wizard can be used inside Web Automation Action Step wizards. - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-chrome) Use a Web Session to open a Chrome browser window in which all the Web Automation elements contained therein interact. - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-firefox) Use a Web Session to open a Firefox browser window in which all the Web Automation elements contained therein interact. - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-web-session-ms-edge) Use a Web Session to open an Edge browser window in which all the Web Automation elements contained therein interact. - [Website Load Time](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-website-load-time) The Website Load Time Action Step measures the time taken to load a website and the websites that it references. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Web Automation > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Web Automation_ action steps are designed specifically to automate browsers and web-based applications. In contrast to the regular action steps, these do not just simulate user operations, but are also able to handle and control objects within a web-based application. This features can be used in any website or application that runs in a browser. - [Check Web Element](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-check-web-element) Use this Web Automation object to verify if a website or web application element was loaded properly and how long this took. - [Clear Web Element](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-clear-web-element) This Web Automation object is used to clear the content of fields on a website or in a web application. - [Click Web Element](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-click-web-element) Use this element to simulate mouse input on a website element. - [Close Web Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-close-web-session) The action step Close Web Session enables you to close a web session. - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation) The Web Automation action steps share the Common Properties. - [Confirm Alert Box](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-confirm-alert-box) This Web Automation object allows you to confirm or dismiss JavaScript Alert Boxes, and enter text in JavaScript input boxes. - [Get Web Element Text](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-get-web-element-text) The Get Element Text action step reads the innerText of an element. - [Keystrokes to Web Element](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-keystrokes-to-web-element) Use this Web Automation object to enter alphanumeric characters into fields on a website or within a web application. - [Navigate](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-navigate) This Web Automation object allows you to perform navigation operations, such as going backwards or forward in the navigation history or refreshing the current webpage. - [Select Web Element](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-select-web-element) Use this Web Automation object to select an option from a list box or a drop-down box. - [Submit Form](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-submit-form) This Web Automation object allows you to submit a form on a webpage. - [Using the Browser Wizard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-using-the-browser-wizard) The Browser Wizard can be used inside Web Automation action step wizards. - [Web Session (Chrome)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-chrome) Use a Web Session to open a Chrome browser window in which all the Web Automation elements contained therein interact. - [Web Session (Firefox)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-firefox) Use a Web Session to open a Firefox browser window in which all the Web Automation elements contained therein interact. - [Web Session (MS Edge)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-web-session-ms-edge) Use a Web Session to open an Edge browser window in which all the Web Automation elements contained therein interact. - [Website Load Time](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-website-load-time) The Website Load Time action step measures the time taken to load a website and the websites that it references. --- product: RPA Builder version: 6.6 --- # Web Session (Chrome) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use a _Web Session_ to open and close the browser window in which all the _Web Automation_ elements contained therein interact. The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Additional Chrome Arguments** Define command-line parameters for _Google Chrome_. Use `;` as a delimiter when specifying more than one parameter. By default, _disable-translate_ is set, which disables the automatic translation bar feature of _Google Chrome_ because it may hinder _Workflow_ execution. - **Alternative User Agent String** Override the default User Agent string for the browser. - **Disable Unpacked Extensions support** Select this option to prevent the use of unpacked extensions in the browser. The communication between Webdriver and the browser is restricted as a result. This usually does not have any effect on the Webdriver functions RPA uses. - **Pageload Strategy** - **Default**: Not specified. - **Normal**: Waits until the pages finish loading and _Ready State_ is _Complete_. - **Eager**: Waits until pages finish loading and _Ready State_ is either _Interactive_ or _Complete._ - **None**: Doesn’t wait until pages finish loading, returns immediately. - **Verbose Logging** Enables verbose logging for the WebDriver. ## Inbound Variables - **Additional Chrome arguments** - **Alternative User Agent String** - **Web Session ID** - **Initial URL** ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate Action Steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every Action Step. ### Browser Specific Settings ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image8.png) You can specify a user data profile as an argument in the **Additional arguments** field to start the web session using said profile, for example: `--user-data-dir=c:\Users\\AppData\Local\Google\Chrome\User Data`. See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ Action Step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ Action Step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The Action Step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Web Session (Chrome) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use a _Web Session_ to open and close the browser window in which all the _Web Automation_ elements contained therein interact. The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Additional Chrome Arguments** Define command-line parameters for _Google Chrome_. Use `;` as a delimiter when specifying more than one parameter. By default, _disable-translate_ is set, which disables the automatic translation bar feature of _Google Chrome_ because it may hinder _Workflow_ execution. - **Alternative User Agent String** Override the default User Agent string for the browser. - **Disable Unpacked Extensions support** Select this option to prevent the use of unpacked extensions in the browser. The communication between Webdriver and the browser is restricted as a result. This usually does not have any effect on the Webdriver functions RPA uses. - **Pageload Strategy** - **Default**: Not specified. - **Normal**: Waits until the pages finish loading and _Ready State_ is _Complete_. - **Eager**: Waits until pages finish loading and _Ready State_ is either _Interactive_ or _Complete._ - **None**: Doesn’t wait until pages finish loading, returns immediately. - **Verbose Logging** Enables verbose logging for the WebDriver. ## Inbound Variables - **Additional Chrome arguments** - **Alternative User Agent String** - **Web Session ID** - **Initial URL** ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate action steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every action step. ### Browser Specific Settings ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image8.png) You can specify a user data profile as an argument in the **Additional arguments** field to start the web session using said profile, for example: `--user-data-dir=c:\Users\\AppData\Local\Google\Chrome\User Data`. See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ action step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ action step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The action step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation) --- product: RPA Builder version: 6.6 --- # Web Session (Firefox) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use a _Web Session_ to open and close the browser window in which all the _Web Automation_ elements contained therein interact. The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Accept untrusted certificates** When set, Firefox automatically accepts untrusted certificates. - **Additional profile extensions** Use this setting to add additional Firefox configuration settings. One or more settings have to be in the form of: `;;;;;` For example: `intl.accept_languages;string;no,en-us,en` Valid types are `int`, `bool`, and `string`. Values containing `;` must be enclosed in double quotation marks `"`. - **Alternative user agent string** Override the default User Agent string for Firefox. - **Enable native events** Enable this option if you are having trouble with mouse hover during execution. - **Port** Defines the TCP/IP listener port number used for Firefox for communication between Firefox and an RPA Bot. If set to `-1` an ephemeral port number is used (and may also be used for all concurrent secure sessions). To ensure optimal operation when using secure sessions, set it to `0`. In this case, the port used is calculated by the following function: `port = TSID * 4 + 45000` (TSID is the current Terminal Session ID). To choose a base value other than `45000`, a value greater than `0` must be assigned. - **Prefer 64Bit Webdriver** Select your preferred bitness here. The program tries the other one in case the preferred one is not available and generates a warning. - **Profile name** Start Firefox with a specific profile. This profile must be created beforehand on the executing agent using the Firefox profile manager. ## Inbound Variables - **Profile name** - **Prefer 64Bit Webdriver** - **Alternative user agent string** - **Accept untrusted certificates** - **Enable native events** - **Port** - **Web Session ID** - **Initial URL** ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate Action Steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every Action Step. ### Browser Specific Settings ![An image showing the browser specific settings.](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image6.png) See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ Action Step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ Action Step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The Action Step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation) - [Secure Session](https://docs.mulesoft.com/rpa-bot/latest/configuration#secure-session) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Web Session (Firefox) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use a _Web Session_ to open and close the browser window in which all the _Web Automation_ elements contained therein interact. The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Accept untrusted certificates** When set, Firefox automatically accepts untrusted certificates. - **Additional profile extensions** Use this setting to add additional Firefox configuration settings. One or more settings have to be in the form of: `;;;;;` For example: `intl.accept_languages;string;no,en-us,en` Valid types are `int`, `bool`, and `string`. Values containing `;` must be enclosed in double quotation marks `"`. - **Alternative user agent string** Override the default User Agent string for Firefox. - **Enable native events** Enable this option if you are having trouble with mouse hover during execution. - **Port** Defines the TCP/IP listener port number used for Firefox for communication between Firefox and an RPA Bot. If set to `-1` an ephemeral port number is used (and may also be used for all concurrent secure sessions). To ensure optimal operation when using secure sessions, set it to `0`. In this case, the port used is calculated by the following function: `port = TSID * 4 + 45000` (TSID is the current Terminal Session ID). To choose a base value other than `45000`, a value greater than `0` must be assigned. - **Prefer 64Bit Webdriver** Select your preferred bitness here. The program tries the other one in case the preferred one is not available and generates a warning. - **Profile name** Start Firefox with a specific profile. This profile must be created beforehand on the executing agent using the Firefox profile manager. ## Inbound Variables - **Profile name** - **Prefer 64Bit Webdriver** - **Alternative user agent string** - **Accept untrusted certificates** - **Enable native events** - **Port** - **Web Session ID** - **Initial URL** ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate action steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every action step. ### Browser Specific Settings ![An image showing the browser specific settings.](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image6.png) See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ action step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ action step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The action step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation) - [Secure Session](https://docs.mulesoft.com/rpa-bot/latest/configuration#secure-session) --- product: RPA Builder version: 6.6 --- # Web Session (MS Edge) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Additional Edge Arguments** Define command-line parameters for _MS Edge_. Use `;` as a delimiter when specifying more than one parameter. By default, _disable-translate_ is set, which disables the automatic translation bar feature of _MS Edge_ because it may hinder _Workflow_ execution. - **Alternative User Agent String** Override the default User Agent string for the browser. - **Disable Unpacked Extensions support** Select this option to prevent the use of unpacked extensions in the browser. The communication between Webdriver and the browser is restricted as a result. This usually does not have any effect on the Webdriver functions RPA uses. - **Pageload Strategy** - **Default**: Not specified. - **Normal**: Waits until the pages finish loading and _Ready State_ is _Complete_. - **Eager**: Waits until pages finish loading and _Ready State_ is either _Interactive_ or _Complete._ - **None**: Doesn’t wait until pages finish loading, returns immediately. - **Verbose Logging** Enables verbose logging for the WebDriver. ## Inbound Variables - Web Session ID - Initial URL ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/6.6/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate Action Steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every Action Step. ### Browser Specific Settings ![60%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-variable-web-automation-web-session-images/image8.png) You can specify a user data profile as an argument in the **Additional arguments** field to start the web session using said profile, for example: `--user-data-dir=C:\Users\\AppData\Local\Microsoft\Edge\User Data`. See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ Action Step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ Action Step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The Action Step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-web-automation-common-properties-web-automation) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Web Session (MS Edge) > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _web session ID_ enables you to reuse a session that has already started in a different web session. ## Properties **Browser Settings** - **Browser mismatch** Specifies if the execution aborts when there is a browser mismatch or if it shows a warning. - **Hide Command Prompt** Hides the web driver’s command prompt (default). Can be displayed again for diagnostic purposes. - **Initial URL** The URL that the web session launches when it starts. Default: `about: blank`. - **Keep out mouse** When selected, at the start of the _Web session_ the mouse moves to the corner defined in the _Move mouse to_ property. This feature enables you to avoid triggering hover effects on a website accidentally. - **Move mouse to** Defines where the mouse pointer moves to if _Keep out mouse_ is enabled. - **Repeat keep out mouse** When selected, the mouse moves to the corner defined in the _Move mouse to_ property before each step within the _Web Session_. This feature enables you to avoid triggering hover effects on a website accidentally. - **Script Timeout \[sec\]** Maximum waiting time in seconds before the internal scripting of the web driver aborts. Do not change this value unless MuleSoft Support advises you to do so. - **Start maximized** Decide wether the browser window starts maximized. - **Webdriver Retries** Number of retries to establish a successful web driver connection. - **Webdriver Timeout \[sec\]** After the assigned time, the web session aborts a Webdriver command. **Browser Specific Settings** - **Additional Edge Arguments** Define command-line parameters for _MS Edge_. Use `;` as a delimiter when specifying more than one parameter. By default, _disable-translate_ is set, which disables the automatic translation bar feature of _MS Edge_ because it may hinder _Workflow_ execution. - **Alternative User Agent String** Override the default User Agent string for the browser. - **Disable Unpacked Extensions support** Select this option to prevent the use of unpacked extensions in the browser. The communication between Webdriver and the browser is restricted as a result. This usually does not have any effect on the Webdriver functions RPA uses. - **Pageload Strategy** - **Default**: Not specified. - **Normal**: Waits until the pages finish loading and _Ready State_ is _Complete_. - **Eager**: Waits until pages finish loading and _Ready State_ is either _Interactive_ or _Complete._ - **None**: Doesn’t wait until pages finish loading, returns immediately. - **Verbose Logging** Enables verbose logging for the WebDriver. ## Inbound Variables - Web Session ID - Initial URL ## Outbound Variables This action step has no outbound variables. ## Wizard The Web Session Wizard contains the **Start Recording**, **Reuse Web Session**, **General Settings**, and **Browser Specific Settings** sections. ### Start Recording Enables you to record a single web session by using the full functionality of RPA Recorder within RPA Builder. The button is only active if the web session doesn’t contain any elements yet. To record a web session: 1. Click **Start Recording** to open RPA Recorder. If you have another RPA Recorder instance in progress, you must end the other instance if you want to proceed. ![Web Session (Chrome) Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/web-session-chrome-wizard.png) 2. Click **Start Recording** to capture all actions. 3. Use the [Recording Toolbar](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) to pause or stop the recording, take a screenshot, or add Image—​based mouse clicks or comments. Additional web sessions cannot be added. 4. After you stop the recording, the documentation shows in the **Review Recording** dialogue. Click **Finish** to keep the recording and return to RPA Builder. Click **Re-record** to replace the current recording with a new one. Click **Discard Recording** to cancel the recording and return to RPA Builder. ![Review web session recording](/mulesoft/current/en-us/rpa-builder/latest/_images/rpa-recorder-review-web-recording.png) 5. Click **OK & generate** in RPA Builder to generate the appropriate action steps, which are added to the web session automatically. ### Reuse Web Session ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image1.png) The **Reuse Web Session** section defines which web session to reuse. To reuse a web session, use the **web session ID** that you previously saved in the workflow-based variables. ![75%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image2.png) You can define a name and a description and then RPA Builder assigns a value automatically. Once you have created the web session ID, you can link it with the session using the drop-down in the Web Session Wizard. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image3.png) In the script Run Results, you see whether a new web session was created or a web session ID was used, and in the latter case, which one. If you use a web session ID that was created with the web session type Firefox, for example, but is to be continued with a different web session type, such as a Chrome session, RPA Builder shows a warning. You can change this response with the **Browser Mismatch** option. There are two options for this scenario: - **Warning** (default) The Workflow Run is assigned a warning, but continues running. In this case, the original web session browser is used automatically. - **Error** The Workflow Run ends in an error. Define the standard response of the browser and the execution in the **General Settings** section. ### General Settings ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-general-settings.png) - **Initial URL** Specifies the initial URL of the web page you want to call. If another web session that was created with the same web session ID is opened, the initial URL from that session is ignored. - **Open Browser Wizard when done** If this option is enabled, the Browser Wizard opens when the Web Session Wizard is closed. - **Keep out mouse, move it to** Use this option to define where you want the mouse to move to. This prevents the mouse from covering certain buttons or texts. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image4.png) You can also define whether or not you want to execute this action after every action step. ### Browser Specific Settings ![60%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-variable-web-automation-web-session-images/image8.png) You can specify a user data profile as an argument in the **Additional arguments** field to start the web session using said profile, for example: `--user-data-dir=C:\Users\\AppData\Local\Microsoft\Edge\User Data`. See [Browser Specific Settings](#browser-specific-settings) for a definition of these fields. ## Activity Workflow Overlapping Web Session You can use web sessions across workflows within a business process. For example, you can open a web session in an initial workflow, perform a web login there, and then process this workflow in a different, independent workflow. The web session ID lets you use the session globally within the workflow. To pass the web session on to another workflow within a business process, the web session ID must be defined as an activity parameter (and not as a workflow-based variable). To do this, proceed as follows: 1. Create a web session ID in the activity parameter. 2. Link the web session ID with the workflow. You will find the web session ID in the _Activity Parameters_ action step, which you placed in the Workflow Initialization Block beforehand. 3. Link the web session ID in the corresponding web session. 4. Optionally, ff you want the web session to be closed at a later point in the workflow, use the _Close Web Session_ action step. ## Closing a Web Session There are three different variants for closing a web session: - The closing of the browser is already contained in the web session In this case, the session is closed automatically when session execution is complete. This only applies if the web session is **not** linked with a web session ID. - The browser is not closed until the end of the workflow If the web session block is linked with a web session ID, the browser remains open. This only applies if the web session was linked using a workflow-based variable. If it is linked with an activity parameter, in contrast, the web session remains active – that is, the browser remains open – and can be used further - The browsers is closed by using the _Close Web Session_ action step The action step _Close Web Session_ gives you the additional option of closing the session at a specific point in the Workflow. ## See Also - [Using the Web Browser Wizard](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-using-the-browser-wizard) - [Common Properties (Web Automation)](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation-common-properties-web-automation) --- product: RPA Builder version: 6.6 --- # Website Load Time > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Website Load Time_ Action Step measures the time taken to load a website and the websites that it references. Referenced websites are websites that are embedded within a website and loaded automatically at the same time, e.g. visitor counters, analysis pages, Web stores, integrated payment systems, etc. The _Website Load Time_ Action Step logs all data measured in a special file, identified by a `.har` extension (har = Http ARchive). This file is located in Windows under "My Documents → NameOfRPABuilderProject → Robot → trace → [http@www-website-xx.har](mailto:http@www-website-xx.har)“. The name of the `.har` file is derived from the website tested (e.g. [http@www-wikipedia-de.har](mailto:http@www-wikipedia-de.har)). The file is overwritten every time the _Workflow_ is executed. You can display the `.har` file using a suitable viewer. The viewer will show the load times of all website components in a waterfall diagram. There are many free viewers for `.har` files. The following list is not comprehensive: - [http://www.softwareishard.com/har/viewer/](http://www.softwareishard.com/har/viewer/) - [https://phantomjs.org/network-monitoring.html](https://phantomjs.org/network-monitoring.html) - [https://yslow.org/](https://yslow.org/) Show the content of the waterfall file using a viewer, e.g. _softwareishard_, as described below: 1. Open the `.har` file in an ASCII editor, e.g. Notepad++. 2. Select all using `` + `` and copy the entire content of the file to the clipboard using `` + ``. 3. Start the viewer, e.g. _softwareishard_, in a browser. 4. Paste the content of the clipboard into the input field on the website using `` + `` 5. Click the button. 6. The next page of _softwareishard_, which is on the "Preview" tab, shows the waterfall diagram of your measurement. The components of the website of interest are shown on the left of the page and the load times are shown on the right. Error message: FAIL to load the address. The error message "FAIL to load the address" will be recorded in the `.har` log file if the _Website Load Time_ Action Step was unable to load the specified URL. It is also possible to perform further processing on the measured values for _Website Load Time_ using the _Website Load Time.Result_ variable. This variable has the same content as the `.har` file after the _Action Step_ has been executed. ## Properties **Load Time Settings** - **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. Other Properties that are the same in all Action Steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. ## Outbound Variables **Result** The _Website Load Time.Result_ variable provides the results of the load time measurement in the form of a log (the log has the same content as the `.har` file). **IsOnline** The _Website Load Time.IsOnline_ variable records whether the website tested was available or not (True/False). ## Wizard - **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. The URL can also be constructed by inserting variables from the _Workflow_. Error message: FAIL to load the address. The error message "FAIL to load the address" will be recorded in the `.har` log file if the _Website Load Time_ Action Step was unable to load the specified URL. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Website Load Time > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Website Load Time_ action step measures the time taken to load a website and the websites that it references. Referenced websites are websites that are embedded within a website and loaded automatically at the same time, e.g. visitor counters, analysis pages, Web stores, integrated payment systems, etc. The _Website Load Time_ action step logs all data measured in a special file, identified by a `.har` extension (har = Http ARchive). This file is located in Windows under "My Documents → NameOfRPABuilderProject → Robot → trace → [http@www-website-xx.har](mailto:http@www-website-xx.har)“. The name of the `.har` file is derived from the website tested (e.g. [http@www-wikipedia-de.har](mailto:http@www-wikipedia-de.har)). The file is overwritten every time the _Workflow_ is executed. You can display the `.har` file using a suitable viewer. The viewer will show the load times of all website components in a waterfall diagram. There are many free viewers for `.har` files. The following list is not comprehensive: - [http://www.softwareishard.com/har/viewer/](http://www.softwareishard.com/har/viewer/) - [https://phantomjs.org/network-monitoring.html](https://phantomjs.org/network-monitoring.html) - [https://yslow.org/](https://yslow.org/) Show the content of the waterfall file using a viewer, e.g. _softwareishard_, as described below: 1. Open the `.har` file in an ASCII editor, e.g. Notepad++. 2. Select all using `` + `` and copy the entire content of the file to the clipboard using `` + ``. 3. Start the viewer, e.g. _softwareishard_, in a browser. 4. Paste the content of the clipboard into the input field on the website using `` + `` 5. Click the button. 6. The next page of _softwareishard_, which is on the "Preview" tab, shows the waterfall diagram of your measurement. The components of the website of interest are shown on the left of the page and the load times are shown on the right. Error message: FAIL to load the address. The error message "FAIL to load the address" will be recorded in the `.har` log file if the _Website Load Time_ action step was unable to load the specified URL. It is also possible to perform further processing on the measured values for _Website Load Time_ using the _Website Load Time.Result_ variable. This variable has the same content as the `.har` file after the action step has been executed. ## Properties **Load Time Settings** - **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. Other Properties that are the same in all action steps in the _Web Automation_ are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. ## Outbound Variables **Result** The _Website Load Time.Result_ variable provides the results of the load time measurement in the form of a log (the log has the same content as the `.har` file). **IsOnline** The _Website Load Time.IsOnline_ variable records whether the website tested was available or not (True/False). ## Wizard - **WebsiteUrl** Enter the URL to be tested, e.g. www.wikipedia.de. The URL can also be constructed by inserting variables from the _Workflow_. Error message: FAIL to load the address. The error message "FAIL to load the address" will be recorded in the `.har` log file if the _Website Load Time_ action step was unable to load the specified URL. --- product: RPA Builder version: 6.6 --- # Window Set State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ allows you to change the state of a specific window. ## Properties - **Use Regex** You can further distinguish between window titles by selecting this checkbox. The function is described in detail in Section Using Regular Expression. - **Window state** Choose which state the selected window should be set to. Available options are _Hide_, _Show_, _Minimize_, _Maximize_, _Restore_, _Activate_, _Close_, and _Kill_. - **Window text** Contains the captured _Window text_ for the window in question (only works if _Use window text_ is activated) - **Window title** Contains the captured _Window title_ for the window in question ## Inbound Variables **Window title** **Window text** ## Outbound Variables **Window Handle** The window handle of the window to be manipulated **Process ID** The process ID of the window to be manipulated ## Wizard - **Start** Starts capture - **Stop** Stops capture - **Collect window titles** Click this button to list all currently available window titles in the drop-down menu in the _Window title_ field - **Hide window** Hides the wizard window when _Start_ is clicked (if you are using this option you need to press **_F10_** to stop the capture) - **Hide main window** Hides the RPA Builder window when _Start_ is clicked - **Use window text** Captures the _Window text_ in the window as well as the title - **Use Regex** You can further distinguish between window titles by selecting this checkbox. The function is described in detail in Section Using Regular Expression. To capture a window, simply click _Start_, open the desired window, and click _Stop_ again. This will automatically capture the window title and text. You can also click _Collect window titles_ to display all available window titles within the drop-down box in the _Window title_ field. **Options for window state:** - **Hide** Sets the window to hidden state, which makes it invisible - **Show** Makes hidden windows visible - **Minimize** Minimizes a window to the task bar - **Maximize** Maximizes a window - **Restore** Tries to restore a window to its previous bounds. Will make hidden windows visible. - **Activate** Sets focus on the selected window - **Close** Attempts to "cleanly" close a window (equivalent to pressing the red **_X_** in the upper right corner or using **_ALT+F4_**) - **Kill** Kills the process that is associated with the selected window - **Wait Delay** - **Legacy mode** (Compatibility setting) The wait delay until the start of the search is the value entered **before the last saving**. **For Workflows built with a WorkflowEditor version earlier than 4.2 this value is 250 ms.** - **Normal mode** If this option is activated, you can enter a value of your choice in the field _Wait Delay_. The default value is 50 ms. - This value can also be filled via Pin-Variable. Often the title of a window changes. In particular, the title of _Internet Explorer_ windows is dependent on the webpage that is shown. This means that if you want to use _Window wait_ for a certain URL, be sure to capture the correct title with the wizard or use regular expressions. You could also simply use only a part of the window title. Please consider, that _Wait Delay_ in _WorkflowEditor_ versions earlier than 4.2 was always 250 ms. For reasons of compatibility, _Wait Delay_ is set to _Legacy mode,_ and thereby to 250 ms, in Workflows built with older versions. You can change this mode. However, this can lead to differences in the measurement results between the old and the new version of your Workflow. Before you perform an image search, maximize the affected window using _Set window state_. This makes defining a reliable search area for an image search much easier. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Window Set State > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step allows you to change the state of a specific window. ## Properties - **Use Regex** You can further distinguish between window titles by selecting this checkbox. The function is described in detail in Section Using Regular Expression. - **Window state** Choose which state the selected window should be set to. Available options are _Hide_, _Show_, _Minimize_, _Maximize_, _Restore_, _Activate_, _Close_, and _Kill_. - **Window text** Contains the captured _Window text_ for the window in question (only works if _Use window text_ is activated) - **Window title** Contains the captured _Window title_ for the window in question ## Inbound Variables **Window title** **Window text** ## Outbound Variables **Window Handle** The window handle of the window to be manipulated **Process ID** The process ID of the window to be manipulated ## Wizard - **Start** Starts capture - **Stop** Stops capture - **Collect window titles** Click this button to list all currently available window titles in the drop-down menu in the _Window title_ field - **Hide window** Hides the wizard window when _Start_ is clicked (if you are using this option you need to press **_F10_** to stop the capture) - **Hide main window** Hides the RPA Builder window when _Start_ is clicked - **Use window text** Captures the _Window text_ in the window as well as the title - **Use Regex** You can further distinguish between window titles by selecting this checkbox. The function is described in detail in Section Using Regular Expression. To capture a window, simply click _Start_, open the desired window, and click _Stop_ again. This will automatically capture the window title and text. You can also click _Collect window titles_ to display all available window titles within the drop-down box in the _Window title_ field. **Options for window state:** - **Hide** Sets the window to hidden state, which makes it invisible - **Show** Makes hidden windows visible - **Minimize** Minimizes a window to the task bar - **Maximize** Maximizes a window - **Restore** Tries to restore a window to its previous bounds. Will make hidden windows visible. - **Activate** Sets focus on the selected window - **Close** Attempts to "cleanly" close a window (equivalent to pressing the red **_X_** in the upper right corner or using **_ALT+F4_**) - **Kill** Kills the process that is associated with the selected window - **Wait Delay** - **Legacy mode** (Compatibility setting) The wait delay until the start of the search is the value entered **before the last saving**. **For Workflows built with a WorkflowEditor version earlier than 4.2 this value is 250 ms.** - **Normal mode** If this option is activated, you can enter a value of your choice in the field _Wait Delay_. The default value is 50 ms. - This value can also be filled via Pin-Variable. Often the title of a window changes. In particular, the title of _Internet Explorer_ windows is dependent on the webpage that is shown. This means that if you want to use _Window wait_ for a certain URL, be sure to capture the correct title with the wizard or use regular expressions. You could also simply use only a part of the window title. Please consider, that _Wait Delay_ in _WorkflowEditor_ versions earlier than 4.2 was always 250 ms. For reasons of compatibility, _Wait Delay_ is set to _Legacy mode,_ and thereby to 250 ms, in Workflows built with older versions. You can change this mode. However, this can lead to differences in the measurement results between the old and the new version of your Workflow. Before you perform an image search, maximize the affected window using _Set window state_. This makes defining a reliable search area for an image search much easier. --- product: RPA Builder version: 6.6 --- # Window Wait > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Action Step Window Wait_ pauses the Workflow until a certain window is displayed or not displayed. This window is recognized by its window title and can be specified by _Window Text_ additionally. Different modes allow for checking if the window is appearing, disappearing or activated. You can deploy _Window Wait_ after the _Action Step Run Program_ or if you anticipate a dialog window as result of a preceding action. This enables you to continue the _Workflow_ and stop or start a timer at exactly the right moment. Often the title of a window changes. In particular, the title of Internet Explorer windows is dependent on the webpage that is shown. This means that if you want to use Window wait for a certain URL, be sure to capture the correct title with the wizard, use regular expressions, or use only a part of the window title. ## Properties - **Enable Wait Delay** If this option is activated you can use an individual time value while waiting for a stable state. If this option is not activated this value is 50ms. - **Use Regex** Enables regular expressions for the _Window title_ field. You can further distinguish between window titles by selecting this checkbox. For a brief introduction to regular expressions, see section Using Regular Expressions. - **Use window text** Also captures the _Window text_ of the window - **Wait Delay** The time to wait until window system is in a stable state if **Enable Wait Delay** is enabled. The default value is 50ms and you can reduce it down to 1ms. - **Wait for** Defines the mode of the window search - **Window text** Contains the captured _Window text_ to wait for in addition to the _Window title_ (only works if **Use window text** is selected). - **Window title** Contains the captured _Window title_ to wait for. ## Inbound Variables - **Window title** - **Window text** ## Outbound Variables - **Window Handle** The hexadecimal reference value of the found window in text format. If no matching window was found this value is 0. - **Process ID** The process ID of the found window in text format. If no matching window was found this value is 0. ## Wizard The _Window Wait wizard_ allows for the comfortable selection of _Window Title_ and other selection criteria. You can choose the _Window Title_ directly by clicking in the appropriate window. For this purpose open the window, click on the button _Start_ and then click on the window’s frame. After the correct title is adopted in the field _Window Title_ click _Stop_. _Window Title_ and _Window Text_ can also be bound to preceding _Action Steps_ via Pin Variables. ![50%](/mulesoft/current/en-us/rpa-builder/6.6/_images/toolbox-checks-window-wait-wizard.png) - **Start** Starts the recording of the _Window Title_. If you click a window after clicking this button the window’s title is entered automatically in the corresponding text field. - **Stop** Ends the recording of the _Window Title_. - **Collect Window Titles** Click this button to show all window titles available now in the drop-down menu of the text field _Window Title_ - **Hide window** Hides the wizard while recording the window title - **Hide main window** Hides the RPA Builder while recording the window title - **Use window text** If checked _Window Text_ will be used for the identification of the window - **Use Regex** If this option is activated, the entered window title has to be formed according to the rules of a correct regular expression. If the regular expression is not correct validation returns an error. The use of regular expressions also facilitates a case-insensitive search. You can find further information on this topic in [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). - **Window Title** Title of the window to be found. The entered title needs to be considered as part of the window title to be searched for. For example the entered title _Pad_ will find all windows whose title contains the text _Pad_ (like `NotePad - MyText.txt`). The search is case-sensitive. If this field remains empty all windows are considered. If the option **Use Regex** is activated, the entered window title has to be formed according to the rules of a correct regular expression. If the regular expression is not correct the validation returns an error. The use of regular expressions also facilitates a case-insensitive search. You can find further information on this topic in chapter [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/6.6/advanced-concepts-using-regular-expressions). - **Timeout** Length of time before a not successful search is aborted - **Wait for** Defines the mode of the window search - **Window Appears (with Activation)** _Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria is found. If one or more windows are found, the first from this list will be activated. If the _Timeout_ is exceeded without the window having appeared, the _Actions Step_ returns an error. - **Window Disappears** +_Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria cannot be found (anymore). If the _Timeout_ is exceeded without the window having appeared, the _Actions Step_ returns an error. - **Window is active** _Window Wait_ checks, if a window matching the given criteria is active. If this is not the case, the _Action Step_ returns an error immediately. - **Window exists (with Activation)** _Window Wait_ checks, if a window matching the given criteria does exist. This window can be minimized or in the background. If such a window is found, it will be activated (and be brought to the foreground, even from a minimized state). If the window does not exist, the _Action Step_ returns an error immediately. - **Window doesn’t exist** _Window Wait_ checks, if a window matching the given criteria does not exist. If such a window is found, the _Action Step_ returns an error immediately. - **Window Appears (without Activation)** _Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria is found. If the _Timeout_ is exceeded without the window having appeared, the _Actions Step_ returns an error. - **Window exists (without Activation)** _Window Wait_ checks, if a window matching the given criteria does exist. This window might be minimized or might be in the background. If the window does not exist, the _Action Step_ returns an error immediately. - **Wait Delay** - **Legacy mode** (Compatibility setting) The wait delay until the start of the search is the value entered before the last saving. - **Normal mode** If this option is activated, you can enter a value of your choice in the field _Wait Delay_. The default value is 50ms. This value can also be filled via Pin-Variable. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Window Wait > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The action step _Window Wait_ pauses the Workflow until a certain window is displayed or not displayed. This window is recognized by its window title and can be specified by _Window Text_ additionally. Different modes allow for checking if the window is appearing, disappearing or activated. You can deploy _Window Wait_ after the action step _Run Program_ or if you anticipate a dialog window as result of a preceding action. This enables you to continue the _Workflow_ and stop or start a timer at exactly the right moment. Often the title of a window changes. In particular, the title of Internet Explorer windows is dependent on the webpage that is shown. This means that if you want to use Window wait for a certain URL, be sure to capture the correct title with the wizard, use regular expressions, or use only a part of the window title. ## Properties - **Enable Wait Delay** If this option is activated you can use an individual time value while waiting for a stable state. If this option is not activated this value is 50ms. - **Use Regex** Enables regular expressions for the _Window title_ field. You can further distinguish between window titles by selecting this checkbox. For a brief introduction to regular expressions, see section Using Regular Expressions. - **Use window text** Also captures the _Window text_ of the window - **Wait Delay** The time to wait until window system is in a stable state if **Enable Wait Delay** is enabled. The default value is 50ms and you can reduce it down to 1ms. - **Wait for** Defines the mode of the window search - **Window text** Contains the captured _Window text_ to wait for in addition to the _Window title_ (only works if **Use window text** is selected). - **Window title** Contains the captured _Window title_ to wait for. ## Inbound Variables - **Window title** - **Window text** ## Outbound Variables - **Window Handle** The hexadecimal reference value of the found window in text format. If no matching window was found this value is 0. - **Process ID** The process ID of the found window in text format. If no matching window was found this value is 0. ## Wizard The _Window Wait wizard_ allows for the comfortable selection of _Window Title_ and other selection criteria. You can choose the _Window Title_ directly by clicking in the appropriate window. For this purpose open the window, click on the button _Start_ and then click on the window’s frame. After the correct title is adopted in the field _Window Title_ click _Stop_. _Window Title_ and _Window Text_ can also be bound to preceding action steps via Pin Variables. ![50%](/mulesoft/current/en-us/rpa-builder/latest/_images/toolbox-checks-window-wait-wizard.png) - **Start** Starts the recording of the _Window Title_. If you click a window after clicking this button the window’s title is entered automatically in the corresponding text field. - **Stop** Ends the recording of the _Window Title_. - **Collect Window Titles** Click this button to show all window titles available now in the drop-down menu of the text field _Window Title_ - **Hide window** Hides the wizard while recording the window title - **Hide main window** Hides the RPA Builder while recording the window title - **Use window text** If checked _Window Text_ will be used for the identification of the window - **Use Regex** If this option is activated, the entered window title has to be formed according to the rules of a correct regular expression. If the regular expression is not correct validation returns an error. The use of regular expressions also facilitates a case-insensitive search. You can find further information on this topic in [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). - **Window Title** Title of the window to be found. The entered title needs to be considered as part of the window title to be searched for. For example the entered title _Pad_ will find all windows whose title contains the text _Pad_ (like `NotePad - MyText.txt`). The search is case-sensitive. If this field remains empty all windows are considered. If the option **Use Regex** is activated, the entered window title has to be formed according to the rules of a correct regular expression. If the regular expression is not correct the validation returns an error. The use of regular expressions also facilitates a case-insensitive search. You can find further information on this topic in chapter [Using Regular Expressions](https://docs.mulesoft.com/rpa-builder/latest/advanced-concepts-using-regular-expressions). - **Timeout** Length of time before a not successful search is aborted - **Wait for** Defines the mode of the window search - **Window Appears (with Activation)** _Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria is found. If one or more windows are found, the first from this list will be activated. If the _Timeout_ is exceeded without the window having appeared, the action step returns an error. - **Window Disappears** +_Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria cannot be found (anymore). If the _Timeout_ is exceeded without the window having appeared, the action step returns an error. - **Window is active** _Window Wait_ checks, if a window matching the given criteria is active. If this is not the case, the action step returns an error immediately. - **Window exists (with Activation)** _Window Wait_ checks, if a window matching the given criteria does exist. This window can be minimized or in the background. If such a window is found, it will be activated (and be brought to the foreground, even from a minimized state). If the window does not exist, the action step returns an error immediately. - **Window doesn’t exist** _Window Wait_ checks, if a window matching the given criteria does not exist. If such a window is found, the action step returns an error immediately. - **Window Appears (without Activation)** _Window Wait_ waits at most for the given _Timeout_ time until a window matching the search criteria is found. If the _Timeout_ is exceeded without the window having appeared, the action step returns an error. - **Window exists (without Activation)** _Window Wait_ checks, if a window matching the given criteria does exist. This window might be minimized or might be in the background. If the window does not exist, the action step returns an error immediately. - **Wait Delay** - **Legacy mode** (Compatibility setting) The wait delay until the start of the search is the value entered before the last saving. - **Normal mode** If this option is activated, you can enter a value of your choice in the field _Wait Delay_. The default value is 50ms. This value can also be filled via Pin-Variable. --- product: RPA Builder version: 6.6 --- # Workbench Elements in Detail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Workbench contains a graphical representation of a Workflow. The Workflow type shows as a watermark in the upper right corner. The Workbench is capable of holding several windows as tabs, which enables you to work on more than one project at a time. Hold the mouse pointer over a tab for a short time and the path to the folder where the project is stored shows as a tooltip. ![The Workbench showing the location path tooltip](/mulesoft/current/en-us/rpa-builder/6.6/_images/workbench-tooltip.png)
1Multiple Workflows organized in tabs
2Project location tooltip
3Workflow type icon
## Selecting Objects To select an object, click on its icon. Selected objects show a blue border and their properties show in the Properties panel. Right-click to access a context menu for any Workbench element: ![The context menu of a Workbench element](/mulesoft/current/en-us/rpa-builder/6.6/_images/workbench-context-menu2.png)
1The context menu
2The selected object
To select more than one object, press and hold _Ctrl_ or _Shift_ while clicking to select the objects. If you drag an object into the Workbench, it is automatically selected. ## Context Menu Options The context menu consists of the following elements: - (![The Record icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/record-icon.png)) **Record** Starts RPA Recorder to record an activity and append it to the workflow depending of the context: - If you click a Transaction element, the option changes to **Record Into** and adds the recorded activities at the end of the transaction. - If you click an action step, you can choose between **Record Before** and **Record After** to decide where to append the recorded actions. - **Disable/Enable** Use this option to disable an Action Step and prevent its execution or to enable an Action Step that was previously disabled. Disabled Action Steps are greyed out on the workbench. - **Enable All Selected/Disable All Selected** Use this option to disable or enable multiple Action Steps simultaneously. - **Save As Template** Saves the selected Action Step and its settings as a template that you can use again later. See [Managing User Templates](https://docs.mulesoft.com/rpa-builder/6.6/managing-user-templates) for additional details about creating, importing, and exporting Templates. - **Select all steps of same type** Selects all Action Steps of the same type as the one you have clicked on. This option enables you to change the properties of these Action Steps uniformly. - **Mapped to Action Steps** Shows all incoming Pin variables associated with this Action Step. Click on the name of a variable to select the Action Step that populates that variable. - **Set Breakpoint** Sets a breakpoint for an Action Step, which causes the Workflow to stop at this point during its execution in Debug mode. - **Rename** Enables you to rename the selected element. - **Collapse All** Collapses all levels of the Workflow to the highest level shown in the current view. Use the **Collapse All** (![The Collapse All button](/mulesoft/current/en-us/rpa-builder/6.6/_images/minus-icon.png)) button to collapse individual elements. - **Expand All** Fully expands all levels of the Workflow on view. Use the **Expand All** (![The Expand All button](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-icon.png)) button to expand individual elements. ## See Also - [Workbench Toolbar Overview](https://docs.mulesoft.com/rpa-builder/6.6/workbench-toolbar-overview) - [Managing User Templates](https://docs.mulesoft.com/rpa-builder/6.6/managing-user-templates) - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workbench Elements in Detail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Workbench contains a graphical representation of a Workflow. The Workflow type shows as a watermark in the upper right corner. The Workbench is capable of holding several windows as tabs, which enables you to work on more than one project at a time. Hold the mouse pointer over a tab for a short time and the path to the folder where the project is stored shows as a tooltip. ![The Workbench showing the location path tooltip](/mulesoft/current/en-us/rpa-builder/latest/_images/workbench-tooltip.png)
1Multiple Workflows organized in tabs
2Project location tooltip
3Workflow type icon
## Selecting Objects To select an object, click on its icon. Selected objects show a blue border and their properties show in the Properties panel. Right-click to access a context menu for any Workbench element: ![The context menu of a Workbench element](/mulesoft/current/en-us/rpa-builder/latest/_images/workbench-context-menu2.png)
1The context menu
2The selected object
To select more than one object, press and hold _Ctrl_ or _Shift_ while clicking to select the objects. If you drag an object into the Workbench, it is automatically selected. ## Context Menu Options The context menu consists of the following elements: - (![The Record icon](/mulesoft/current/en-us/rpa-builder/latest/_images/record-icon.png)) **Record** Starts RPA Recorder to record an activity and append it to the workflow depending of the context: - If you click a Transaction element, the option changes to **Record Into** and adds the recorded activities at the end of the transaction. - If you click an action step, you can choose between **Record Before** and **Record After** to decide where to append the recorded actions. - **Disable/Enable** Use this option to disable an action step and prevent its execution or to enable an action step that was previously disabled. Disabled action steps are greyed out on the workbench. - **Enable All Selected/Disable All Selected** Use this option to disable or enable multiple action steps simultaneously. - **Save As Template** Saves the selected action step and its settings as a template that you can use again later. See [Managing User Templates](https://docs.mulesoft.com/rpa-builder/latest/managing-user-templates) for additional details about creating, importing, and exporting Templates. - **Select all steps of same type** Selects all action steps of the same type as the one you have clicked on. This option enables you to change the properties of these action steps uniformly. - **Mapped to action steps** Shows all incoming Pin variables associated with this action step. Click on the name of a variable to select the action step that populates that variable. - **Set Breakpoint** Sets a breakpoint for an action step, which causes the Workflow to stop at this point during its execution in Debug mode. - **Rename** Enables you to rename the selected element. - **Collapse All** Collapses all levels of the Workflow to the highest level shown in the current view. Use the **Collapse All** (![The Collapse All button](/mulesoft/current/en-us/rpa-builder/latest/_images/minus-icon.png)) button to collapse individual elements. - **Expand All** Fully expands all levels of the Workflow on view. Use the **Expand All** (![The Expand All button](/mulesoft/current/en-us/rpa-builder/latest/_images/add-icon.png)) button to expand individual elements. ## See Also - [Workbench Toolbar Overview](https://docs.mulesoft.com/rpa-builder/latest/workbench-toolbar-overview) - [Managing User Templates](https://docs.mulesoft.com/rpa-builder/latest/managing-user-templates) - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) --- product: RPA Builder version: 6.6 --- # Workbench Toolbar Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Next to the Workbench tab bar is the Workbench toolbar, which enables you to perform different actions related to the Workflow and its elements. ![The Workbench Toolbar](/mulesoft/current/en-us/rpa-builder/6.6/_images/workbench-toolbar.png) Some of these actions apply to the selected objects in the Workflow. The unavailable functions are grayed out depending on which Workflow object is selected. The Workbench Toolbar contains the following buttons: - (![The copy icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/copy-icon.png)) [Copy selected object(s)](#copy-paste) - (![The paste icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/paste-icon.png)) [Paste copied object(s)](#copy-paste) - (![The Undo icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-rotate-left-icon.png)) [Undo previous action](#undo-redo) - (![The Redo icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-rotate-right-icon.png)) [Redo action](#undo-redo) - (![The Move selected object up icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-up.png)) [Move selected object up](#move-up-down) - (![The Move selected object down icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-down.png)) [Move selected object down](#move-up-down) - (![The Delete selected object icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon-alt.png)) [Delete selected object(s)](#delete) - (![The Run wizard for selected object icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-wizard-icon.png)) [Run wizard for selected object](#start-wizard) - (![The Start Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/quick-creation-icon.png)) [Start Quick Creation Mode](#start-quick-creation) - (![The Validate Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/validate-icon.png)) [Validate Workflow](#validate) - (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/play-icon.png)) [Run Workflow](#run-workflow) - (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/debug-icon.png)) [Debug Workflow](#debug-workflow) - (![The Print icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/print-icon.png)) [Print](#print-workflow) - (![The Tools icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/wrench-icon.png)) [Tools](#tools) - (![The Record icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/record-icon.png)) [Record](#record) In addition to the Workbench Toolbar, you can find the [Search](#search-bar) bar at the end of the Workbench: ![The Search bar](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-bar.png) ## Copy and Paste Workflow Objects Clicking **Copy** (![The copy icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/copy-icon.png)) copies the selected Workflow objects and their underlying elements to the clipboard. Select the target object and click **Paste** (![The paste icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/paste-icon.png)) to paste it. You can also use _Ctrl + C_ for copying and _Ctrl + V_ for pasting. ## Undo and Redo Previous Action The **Undo** button (![The copy icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-rotate-left-icon.png)) enables you to undo any previous action you carried out in RPA Builder. If you accidentally went back too far, use the **Redo** button (![The copy icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-rotate-right-icon.png)) to get back to the desired action. Using _Ctrl + Z_ for undo and _Ctrl + Y_ for redo also works. ## Change the Order of Workflow Objects To change the order of objects, select the object and move it up or down in the Workflow by clicking **Move up** (![The Move selected object up icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-up.png)) or **Move down** (![The Move selected object down icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/arrow-down.png)) until the object reaches the desired position. You can also drag and drop elements to rearrange them. Action Steps cannot be moved outside of their Transaction. If you want to move an Action Step to another Transaction, use copy and paste instead, and then delete the old one. You can also use _Ctrl + X_ or the **Cut** option from the context menu to remove the Action Step from the Workflow and put it into the clipboard in one step. ## Delete Workflow Objects To delete an object, select it and click **Delete** (![The Delete selected object icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon-alt.png)). Pressing the _Del_ key has the same effect. ## Starting the Configuration Wizard of a Workflow Object To configure a Workflow object with the wizard, select it and then click **Wizard** (![The Run wizard for selected object icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-wizard-icon.png)). This process works for single Action Steps as well as for complete Transactions. You can also double-click a Workflow object to start its wizard. ## Start Quick Creation Mode Use this function to speed up the initial Workflow creation. When you start a new Workflow project from scratch, click **Start Quick Creation Mode** (![The Start Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/quick-creation-icon.png)) to open the Quick Creation Mode interface. ![The quick creation mode window](/mulesoft/current/en-us/rpa-builder/6.6/_images/quick-creation-mode.png) Depending on the state and position your Workflow project is in, Quick Creation Mode provides the Workflow objects that you can use. For every object you insert, the wizard automatically starts so you can configure the different steps without ever losing focus on the actual application you want to automate. You can also insert any possible object at any position later on. If, for example, you want to add a Window wait Action Step in front of an Image search in a Transaction you have already created, place the blue position indicator where you want to add the Action Step and then click Window wait. You can position the objects with the blue arrow buttons or by clicking on the desired position directly. The blue arrow buttons also enable you to collapse or expand the selected Workflows, Transactions, or Control Blocks to optimize the graphical representation of your Workflow. If the Quick Creation Mode interface is blocking parts of the application you need to use in the Workflow, click **Switch Monitor Side** (![The Switch Monitor Side icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/switch-monitor-side-icon.png)) and the interface switches from the right to the left side of the screen and vice versa. After you finish creating the Workflow, close Quick Creation Mode by clicking **Exit Quick Creation Mode** (![The Exit Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/exit-quick-creation-mode.png)). After you exit Quick Creation Mode, the standard RPA Builder GUI shows again, including the Workflow you just created. ## Validate Workflow To check if a Workflow is ready for script generation, press **Validation** (![The Validate Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/validate-icon.png)). If the project contains Workflow objects that are not configured, are wrongly configured, or have errors, RPA Builder shows warnings or general messages as a list in the Validation result window. Double-click an entry in this list to navigate to the corresponding Workflow object. ## Run Workflow To test the created Workflow, click **Run Workflow** (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/play-icon.png)) to generate or update the script file from the currently active project. The script executes automatically after its creation. When you start a Workflow from within RPA Builder, the workflow runs in design mode so you can already test whether the Workflow behaves as expected or still needs modifications before the production phase. Note that the STC Guard module does not execute and does not close any windows if an error occurs, and the Clear screen Action Step does not execute in design mode. ## Debug Workflow With the **Debug Workflow** (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/debug-icon.png)) button, you can start a debug run of the active Workflow project. The Workflow Debugger automatically starts if you have set break points in your Workflow or if any error occurs during the debug run. Here you can make changes to Workflow elements and retry certain Action Steps or complete Transactions until they work properly. Then, you can continue to execute the Workflow from the current position without having to start the debug run at the beginning. ## Print You can document a Workflow project by clicking **Print Workflow** (![The Print icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/print-icon.png)), which opens the printing function and displays a Print Preview: ![The print Workflow preview](/mulesoft/current/en-us/rpa-builder/6.6/_images/print-preview.png) The resulting document shows the steps the Workflow executes during a run, together with the most important settings. At the beginning of the window Print Preview, there is a menu for further processing the Workflow Print. ![The Print Workflow menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/print-menu.png) - **Print…​** Opens a window for starting the print of the Workflow. - **Page Setup…​** Opens a window for setting the page format and margins for the print or export of the Workflow. RPA Builder saves the changes in the **Page Setup…​** settings according to your configuration for all users in common or for every user separately. It then uses these settings for the Print of a Workflow. - **First Page** Shows the first page. - **Previous Page** Shows the previous page. - **Next Page** Shows the next page. - **Last Page** Shows the last page. - **Zoom Out** Reduces the size of the view by 25%, so that more of the page is visible on screen. - **Zoom** Sets the size of the view to a certain percentage of the original size, to the whole width of the screen, or so that a whole page fits on the screen. - **Zoom In** Increases the size of the view by 25% at a time. - **Export…​** Opens a window for choosing the file format, choosing the folder to save to, and configuring additional settings for the print export. Allowed formats are PDF, HTML, and RTF. - **Send…​** Opens a window for choosing whether to export the print in PDF or RTF format. The file is attached to an Email automatically after saving. For the option **Send…​**, an Outlook Email profile configured on the computer is required. - **Watermark** Opens a window in which you can specify a text or an image to use as a watermark on the print. - **Print Template Settings** Opens a window for choosing a logo for the print, the format of the page numbering, and the scaling of text and images. RPA Builder saves the changes in **Print Template Settings** according to your configuration for all users in common or for every user separately. It then uses these settings for the Print of a Workflow. The current page number is referenced by `{0}` and the total number of pages is referenced by `{1}`. If the formatting has errors, RPA Builder sets the footer back to the default configuration `{0}/{1}`. ## Tools The **Tools** (![The Tools icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/wrench-icon.png)) button enables you to access additional functions: ![The Tools menu](/mulesoft/current/en-us/rpa-builder/6.6/_images/tools-menu.png) ### Reload Workflow (![The Reload Workflow icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/reload-workflow-icon.png)): Reverts back to the last saved state of your project. > [!WARNING] After reloading a Workflow, you cannot use the undo function. Therefore, all unsaved > changes in the Workflow are lost. ### Save Selected Items as Template (![The Save Selected Items as Template icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/save-as-template-icon.png)): To create a template, select the Workflow object you want to save as a template and click Save as template in the context menu. See [Managing User Templates](https://docs.mulesoft.com/rpa-builder/6.6/managing-user-templates) for additional details about creating, importing, and exporting User Templates. ### Open Trace Log (![The Open trace log icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/open-trace-log.png)): Shows the content of the log file created during the last test run of this Workflow. Use this option to obtain additional information for failure analysis. ### Load Analysis Package (![The Load Analysis Package icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/load-analysis-package.png)): RPA Manager provides analysis packages for Workflow runs that don’t execute successfully. RPA Builder can display errors that occur within a Workflow run, whether from a run started by RPA Builder or by reading the analysis package of a run executed in RPA Manager. To load an analysis package: 1. Get the analysis package you want to use from RPA Manager and save it to the local disk. 2. Open the File Explorer by clicking **File** > **Load Analysis Package**. 3. Browse to the analysis package you downloaded and then press **Open**. Alternatively, you can drag the package from Windows Explorer and drop it into RPA Builder. You can also select an Analysis Package directly in the Activity Workflow. Click the **Tools** button on the Workbench toolbar and select the **Load Analysis Package** entry. The analysis information includes the trace file and Workflow Run Results. After loading and analysis package, RPA Builder displays the error screenshots and replaces the current log file with the log file in the analysis package. #### Opening an analysis package When you import an analysis package into RPA Builder, the corresponding process and the relevant Activity Workflow open automatically. To make searching for the error easier, **Run Result Marking** immediately displays the Action Step in which the error occurred. ![The Run Result Marking icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-result-marking.png) If the process to open is not in the local cache, RPA Builder downloads it automatically from RPA Manager. In this case, the process must be in the Build phase. ### Clear Run Results Markings (![The Clear Run Results Markings icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/clear-run-results-icon.png)): Use this menu item to clear the markings of warnings and errors in the Workbench view of the selected project. These markings are shown after a failed local Workflow run or after the import of an analysis package. Errors and warnings are still displayed in the pane Workflow Run Results. ## Record Starts RPA Recorder to record an activity. After you finish the recording, RPA Builder appends a new transaction containing the recorded actions at the end of the workflow. ## Search At the end of the Workbench is the **Search…​** (![The Search icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-icon.png)) function. If you gave your Workflow elements descriptive names and want to detect them in a Workflow, type the name (or part of it) into the search field and press Enter. The first element with a matching name shows on the Workbench. If there are additional matching occurrences, you can access them by pressing _F3_. ![The Search bar](/mulesoft/current/en-us/rpa-builder/6.6/_images/search-bar.png) If there are multiple results, you can switch between the results with the arrow buttons. ## See Also - [Workbench Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workbench-elements-in-detail) - [Managing User Templates](https://docs.mulesoft.com/rpa-builder/6.6/managing-user-templates) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workbench Toolbar Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Next to the Workbench tab bar is the Workbench toolbar, which enables you to perform different actions related to the Workflow and its elements. ![The Workbench Toolbar](/mulesoft/current/en-us/rpa-builder/latest/_images/workbench-toolbar.png) Some of these actions apply to the selected objects in the Workflow. The unavailable functions are grayed out depending on which Workflow object is selected. The Workbench Toolbar contains the following buttons: - (![The copy icon](/mulesoft/current/en-us/rpa-builder/latest/_images/copy-icon.png)) [Copy selected object(s)](#copy-paste) - (![The paste icon](/mulesoft/current/en-us/rpa-builder/latest/_images/paste-icon.png)) [Paste copied object(s)](#copy-paste) - (![The Undo icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-rotate-left-icon.png)) [Undo previous action](#undo-redo) - (![The Redo icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-rotate-right-icon.png)) [Redo action](#undo-redo) - (![The Move selected object up icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-up.png)) [Move selected object up](#move-up-down) - (![The Move selected object down icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-down.png)) [Move selected object down](#move-up-down) - (![The Delete selected object icon](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon-alt.png)) [Delete selected object(s)](#delete) - (![The Run wizard for selected object icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-wizard-icon.png)) [Run wizard for selected object](#start-wizard) - (![The Start Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/latest/_images/quick-creation-icon.png)) [Start Quick Creation Mode](#start-quick-creation) - (![The Validate Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/validate-icon.png)) [Validate Workflow](#validate) - (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/play-icon.png)) [Run Workflow](#run-workflow) - (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/debug-icon.png)) [Debug Workflow](#debug-workflow) - (![The Print icon](/mulesoft/current/en-us/rpa-builder/latest/_images/print-icon.png)) [Print](#print-workflow) - (![The Tools icon](/mulesoft/current/en-us/rpa-builder/latest/_images/wrench-icon.png)) [Tools](#tools) - (![The Record icon](/mulesoft/current/en-us/rpa-builder/latest/_images/record-icon.png)) [Record](#record) In addition to the Workbench Toolbar, you can find the [Search](#search-bar) bar at the end of the Workbench: ![The Search bar](/mulesoft/current/en-us/rpa-builder/latest/_images/search-bar.png) ## Copy and Paste Workflow Objects Clicking **Copy** (![The copy icon](/mulesoft/current/en-us/rpa-builder/latest/_images/copy-icon.png)) copies the selected Workflow objects and their underlying elements to the clipboard. Select the target object and click **Paste** (![The paste icon](/mulesoft/current/en-us/rpa-builder/latest/_images/paste-icon.png)) to paste it. You can also use _Ctrl + C_ for copying and _Ctrl + V_ for pasting. ## Undo and Redo Previous Action The **Undo** button (![The copy icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-rotate-left-icon.png)) enables you to undo any previous action you carried out in RPA Builder. If you accidentally went back too far, use the **Redo** button (![The copy icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-rotate-right-icon.png)) to get back to the desired action. Using _Ctrl + Z_ for undo and _Ctrl + Y_ for redo also works. ## Change the Order of Workflow Objects To change the order of objects, select the object and move it up or down in the Workflow by clicking **Move up** (![The Move selected object up icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-up.png)) or **Move down** (![The Move selected object down icon](/mulesoft/current/en-us/rpa-builder/latest/_images/arrow-down.png)) until the object reaches the desired position. You can also drag and drop elements to rearrange them. Action steps cannot be moved outside of their Transaction. If you want to move an action step to another Transaction, use copy and paste instead, and then delete the old one. You can also use _Ctrl + X_ or the **Cut** option from the context menu to remove the action step from the Workflow and put it into the clipboard in one step. ## Delete Workflow Objects To delete an object, select it and click **Delete** (![The Delete selected object icon](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon-alt.png)). Pressing the _Del_ key has the same effect. ## Starting the Configuration Wizard of a Workflow Object To configure a Workflow object with the wizard, select it and then click **Wizard** (![The Run wizard for selected object icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-wizard-icon.png)). This process works for single action steps as well as for complete Transactions. You can also double-click a Workflow object to start its wizard. ## Start Quick Creation Mode Use this function to speed up the initial Workflow creation. When you start a new Workflow project from scratch, click **Start Quick Creation Mode** (![The Start Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/latest/_images/quick-creation-icon.png)) to open the Quick Creation Mode interface. ![The quick creation mode window](/mulesoft/current/en-us/rpa-builder/latest/_images/quick-creation-mode.png) Depending on the state and position your Workflow project is in, Quick Creation Mode provides the Workflow objects that you can use. For every object you insert, the wizard automatically starts so you can configure the different steps without ever losing focus on the actual application you want to automate. You can also insert any possible object at any position later on. If, for example, you want to add a Window wait action step in front of an Image search in a Transaction you have already created, place the blue position indicator where you want to add the action step and then click Window wait. You can position the objects with the blue arrow buttons or by clicking on the desired position directly. The blue arrow buttons also enable you to collapse or expand the selected Workflows, Transactions, or Control Blocks to optimize the graphical representation of your Workflow. If the Quick Creation Mode interface is blocking parts of the application you need to use in the Workflow, click **Switch Monitor Side** (![The Switch Monitor Side icon](/mulesoft/current/en-us/rpa-builder/latest/_images/switch-monitor-side-icon.png)) and the interface switches from the right to the left side of the screen and vice versa. After you finish creating the Workflow, close Quick Creation Mode by clicking **Exit Quick Creation Mode** (![The Exit Quick Creation Mode icon](/mulesoft/current/en-us/rpa-builder/latest/_images/exit-quick-creation-mode.png)). After you exit Quick Creation Mode, the standard RPA Builder GUI shows again, including the Workflow you just created. ## Validate Workflow To check if a Workflow is ready for script generation, press **Validation** (![The Validate Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/validate-icon.png)). If the project contains Workflow objects that are not configured, are wrongly configured, or have errors, RPA Builder shows warnings or general messages as a list in the Validation result window. Double-click an entry in this list to navigate to the corresponding Workflow object. ## Run Workflow To test the created Workflow, click **Run Workflow** (![The Run Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/play-icon.png)) to generate or update the script file from the currently active project. The script executes automatically after its creation. When you start a Workflow from within RPA Builder, the workflow runs in design mode so you can already test whether the Workflow behaves as expected or still needs modifications before the production phase. Note that the STC Guard module does not execute and does not close any windows if an error occurs, and the Clear screen action step does not execute in design mode. ## Debug Workflow With the **Debug Workflow** (![The Debug Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/debug-icon.png)) button, you can start a debug run of the active Workflow project. The Workflow Debugger automatically starts if you have set break points in your Workflow or if any error occurs during the debug run. Here you can make changes to Workflow elements and retry certain action steps or complete Transactions until they work properly. Then, you can continue to execute the Workflow from the current position without having to start the debug run at the beginning. ## Print You can document a Workflow project by clicking **Print Workflow** (![The Print icon](/mulesoft/current/en-us/rpa-builder/latest/_images/print-icon.png)), which opens the printing function and displays a Print Preview: ![The print Workflow preview](/mulesoft/current/en-us/rpa-builder/latest/_images/print-preview.png) The resulting document shows the steps the Workflow executes during a run, together with the most important settings. At the beginning of the window Print Preview, there is a menu for further processing the Workflow Print. ![The Print Workflow menu](/mulesoft/current/en-us/rpa-builder/latest/_images/print-menu.png) - **Print…​** Opens a window for starting the print of the Workflow. - **Page Setup…​** Opens a window for setting the page format and margins for the print or export of the Workflow. RPA Builder saves the changes in the **Page Setup…​** settings according to your configuration for all users in common or for every user separately. It then uses these settings for the Print of a Workflow. - **First Page** Shows the first page. - **Previous Page** Shows the previous page. - **Next Page** Shows the next page. - **Last Page** Shows the last page. - **Zoom Out** Reduces the size of the view by 25%, so that more of the page is visible on screen. - **Zoom** Sets the size of the view to a certain percentage of the original size, to the whole width of the screen, or so that a whole page fits on the screen. - **Zoom In** Increases the size of the view by 25% at a time. - **Export…​** Opens a window for choosing the file format, choosing the folder to save to, and configuring additional settings for the print export. Allowed formats are PDF, HTML, and RTF. - **Send…​** Opens a window for choosing whether to export the print in PDF or RTF format. The file is attached to an Email automatically after saving. For the option **Send…​**, an Outlook Email profile configured on the computer is required. - **Watermark** Opens a window in which you can specify a text or an image to use as a watermark on the print. - **Print Template Settings** Opens a window for choosing a logo for the print, the format of the page numbering, and the scaling of text and images. RPA Builder saves the changes in **Print Template Settings** according to your configuration for all users in common or for every user separately. It then uses these settings for the Print of a Workflow. The current page number is referenced by `{0}` and the total number of pages is referenced by `{1}`. If the formatting has errors, RPA Builder sets the footer back to the default configuration `{0}/{1}`. ## Tools The **Tools** (![The Tools icon](/mulesoft/current/en-us/rpa-builder/latest/_images/wrench-icon.png)) button enables you to access additional functions: ![The Tools menu](/mulesoft/current/en-us/rpa-builder/latest/_images/tools-menu.png) ### Reload Workflow (![The Reload Workflow icon](/mulesoft/current/en-us/rpa-builder/latest/_images/reload-workflow-icon.png)): Reverts back to the last saved state of your project. > [!WARNING] After reloading a Workflow, you cannot use the undo function. Therefore, all unsaved > changes in the Workflow are lost. ### Save Selected Items as Template (![The Save Selected Items as Template icon](/mulesoft/current/en-us/rpa-builder/latest/_images/save-as-template-icon.png)): To create a template, select the Workflow object you want to save as a template and click Save as template in the context menu. See [Managing User Templates](https://docs.mulesoft.com/rpa-builder/latest/managing-user-templates) for additional details about creating, importing, and exporting User Templates. ### Open Trace Log (![The Open trace log icon](/mulesoft/current/en-us/rpa-builder/latest/_images/open-trace-log.png)): Shows the content of the log file created during the last test run of this Workflow. Use this option to obtain additional information for failure analysis. ### Load Analysis Package (![The Load Analysis Package icon](/mulesoft/current/en-us/rpa-builder/latest/_images/load-analysis-package.png)): RPA Manager provides analysis packages for Workflow runs that don’t execute successfully. RPA Builder can display errors that occur within a Workflow run, whether from a run started by RPA Builder or by reading the analysis package of a run executed in RPA Manager. To load an analysis package: 1. Get the analysis package you want to use from RPA Manager and save it to the local disk. 2. Open the File Explorer by clicking **File** > **Load Analysis Package**. 3. Browse to the analysis package you downloaded and then press **Open**. Alternatively, you can drag the package from Windows Explorer and drop it into RPA Builder. You can also select an Analysis Package directly in the Activity Workflow. Click the **Tools** button on the Workbench toolbar and select the **Load Analysis Package** entry. The analysis information includes the trace file and Workflow Run Results. After loading and analysis package, RPA Builder displays the error screenshots and replaces the current log file with the log file in the analysis package. #### Opening an analysis package When you import an analysis package into RPA Builder, the corresponding process and the relevant Activity Workflow open automatically. To make searching for the error easier, **Run Result Marking** immediately displays the action step in which the error occurred. ![The Run Result Marking icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-result-marking.png) If the process to open is not in the local cache, RPA Builder downloads it automatically from RPA Manager. In this case, the process must be in the Build phase. ### Clear Run Results Markings (![The Clear Run Results Markings icon](/mulesoft/current/en-us/rpa-builder/latest/_images/clear-run-results-icon.png)): Use this menu item to clear the markings of warnings and errors in the Workbench view of the selected project. These markings are shown after a failed local Workflow run or after the import of an analysis package. Errors and warnings are still displayed in the pane Workflow Run Results. ## Record Starts RPA Recorder to record an activity. After you finish the recording, RPA Builder appends a new transaction containing the recorded actions at the end of the workflow. ## Search At the end of the Workbench is the **Search…​** (![The Search icon](/mulesoft/current/en-us/rpa-builder/latest/_images/search-icon.png)) function. If you gave your Workflow elements descriptive names and want to detect them in a Workflow, type the name (or part of it) into the search field and press Enter. The first element with a matching name shows on the Workbench. If there are additional matching occurrences, you can access them by pressing _F3_. ![The Search bar](/mulesoft/current/en-us/rpa-builder/latest/_images/search-bar.png) If there are multiple results, you can switch between the results with the arrow buttons. ## See Also - [Workbench Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workbench-elements-in-detail) - [Managing User Templates](https://docs.mulesoft.com/rpa-builder/latest/managing-user-templates) --- product: RPA Builder version: 6.6 --- # Workflow Based Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Workflow Based Variables_ Action Step contains variables which can be used throughout the entire Workflow and which can be modified. The variables are typed. They may be structured as text (_alphanumeric_), whole numbers (_integers_) or floats (_floating_\-_point numbers_), Boolean values (_Boolean_) and lists (_array_). Use the _Set Variable_ and the _Set Array Variable_ Action Steps to overwrite the initial variable values with new values at a later point in the Workflow. The _Workflow Based Variables_ Action Step can only appear once in a Workflow and must be positioned in the _Workflow Initialization_ section. ## Properties This Action Step contains no special properties other than the _common_ ones. ## Inbound Variables This Action Step possesses no inbound variables. ## Outbound Variables All _Workflow Based Variables_ are outbound variables. They are specified in the format Workflow Based Variables.\[name of variables\]. In the _Variable Mappings_ for an Action Step only those _Workflow Based Variables_ of the appropriate type are shown. The symbols next to the variable names indicate the type. Action Steps which work with strings will show _Workflow Based Variables_ of all types except _Array_. Action Steps which work with arrays internally can also use alphanumeric variables. That is why such Action Steps will show array and alphanumeric _Workflow Based Variables_ to choose from. (It is possible to populate the elements of an array via a string if this string contains comma separated values. For more information, please refer to the section entitled [\_Set Array Variable](#Set_Array_Variable).) ## Wizard Add a new variable. Then select the type of variable from the menu. You can then enter the name, description, and value of the variables directly into the relevant fields. The variable names can be comprised of a combination of letters, numbers, and underscores. Special characters and spaces are not permitted. The variable name must be unique. It must not be used multiple times for different variables. The floating point variable will display up to 14 decimal digits. When entering more than 14 decimal digits the value will be rounded off to the nearest 14th place. The elements for array variables must be separated by commas. The values for array variables are initially saved as strings. That is why, when saving the Action Step, all array elements which are not yet presented in double quotes will automatically be placed in double quotes. If you want to include an element containing one or more commas in your list, you must place this element in double quotes before saving it. E.g. “4,2” or “many commas: ,,,, , , ” Text elements are permitted to contain single quotes: E.g. “This ‘text’ contains single quotation marks.” Text elements which need to contain double quotes must include another double quotation mark before each double quotation mark and the whole element also needs to be placed inside double quotes. E.g. “This “”text”” contains double quotation marks.” ## Example Car servicing is to be processed automatically at a workshop. For this purpose the variables required in the Workflow are to be created as Workflow Based Variables. For testing purposes, they may be pre-populated with meaningful values. If all Transactions are active, the Workflow Based Variables in Transaction 120 are populated with data from the application using the _Set Variable_ Action Step. In the example, however, only Transactions 130 and above are intended to be tested. Because the variables are not generated first in Transaction 120 and instead are generally available as Workflow Based Variables, Transactions 100 – 120 can simply be deactivated and the other parts of the Workflow work with the initial values. ## Variable or Workflow Based Variables? The _Workflow Based Variables_ provide a clear overview and a place for all the variables used within a Workflow. They are already standardized and, by contrast to the variables in the _Variable_ Action Step, do not need to be converted to an appropriate type for use in a different Action Step. Because they are not first generated within a transaction, any parts of the Workflow can be _disabled_ or _enabled_ without breaking the mapping between variables. The possibility of initially populating the _Workflow Based Variables_ means that different scenarios can be effected deliberately in the process. This makes it easier to test individual parts of a large Workflow. The _Variable_ Action Step is intended to be used if information is being stored that is only required within a single Transaction and is then not subsequently needed. ## See Also - [Session Based Variables](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-variable-handling-session-based-variables) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workflow Based Variables > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The _Workflow Based Variables_ action step contains variables which can be used throughout the entire Workflow and which can be modified. The variables are typed. They may be structured as text (_alphanumeric_), whole numbers (_integers_) or floats (_floating_\-_point numbers_), Boolean values (_Boolean_) and lists (_array_). Use the _Set Variable_ and the _Set Array Variable_ action steps to overwrite the initial variable values with new values at a later point in the Workflow. The _Workflow Based Variables_ action step can only appear once in a Workflow and must be positioned in the _Workflow Initialization_ section. ## Properties This action step contains no special properties other than the _common_ ones. ## Inbound Variables This action step possesses no inbound variables. ## Outbound Variables All _Workflow Based Variables_ are outbound variables. They are specified in the format Workflow Based Variables.\[name of variables\]. In the _Variable Mappings_ for an action step only those _Workflow Based Variables_ of the appropriate type are shown. The symbols next to the variable names indicate the type. action steps which work with strings will show _Workflow Based Variables_ of all types except _Array_. Action steps which work with arrays internally can also use alphanumeric variables. That is why such action steps will show array and alphanumeric _Workflow Based Variables_ to choose from. (It is possible to populate the elements of an array via a string if this string contains comma separated values. For more information, please refer to the section entitled [\_Set Array Variable](#Set_Array_Variable).) ## Wizard Add a new variable. Then select the type of variable from the menu. You can then enter the name, description, and value of the variables directly into the relevant fields. The variable names can be comprised of a combination of letters, numbers, and underscores. Special characters and spaces are not permitted. The variable name must be unique. It must not be used multiple times for different variables. The floating point variable will display up to 14 decimal digits. When entering more than 14 decimal digits the value will be rounded off to the nearest 14th place. The elements for array variables must be separated by commas. The values for array variables are initially saved as strings. That is why, when saving the action step, all array elements which are not yet presented in double quotes will automatically be placed in double quotes. If you want to include an element containing one or more commas in your list, you must place this element in double quotes before saving it. E.g. “4,2” or “many commas: ,,,, , , ” Text elements are permitted to contain single quotes: E.g. “This ‘text’ contains single quotation marks.” Text elements which need to contain double quotes must include another double quotation mark before each double quotation mark and the whole element also needs to be placed inside double quotes. E.g. “This “”text”” contains double quotation marks.” ## Example Car servicing is to be processed automatically at a workshop. For this purpose the variables required in the Workflow are to be created as Workflow Based Variables. For testing purposes, they may be pre-populated with meaningful values. If all Transactions are active, the Workflow Based Variables in Transaction 120 are populated with data from the application using the _Set Variable_ action step. In the example, however, only Transactions 130 and above are intended to be tested. Because the variables are not generated first in Transaction 120 and instead are generally available as Workflow Based Variables, Transactions 100 – 120 can simply be deactivated and the other parts of the Workflow work with the initial values. ## Variable or Workflow Based Variables? The _Workflow Based Variables_ provide a clear overview and a place for all the variables used within a Workflow. They are already standardized and, by contrast to the variables in the _Variable_ action step, do not need to be converted to an appropriate type for use in a different action step. Because they are not first generated within a transaction, any parts of the Workflow can be _disabled_ or _enabled_ without breaking the mapping between variables. The possibility of initially populating the _Workflow Based Variables_ means that different scenarios can be effected deliberately in the process. This makes it easier to test individual parts of a large Workflow. The _Variable_ action step is intended to be used if information is being stored that is only required within a single Transaction and is then not subsequently needed. ## See Also - [Session Based Variables](https://docs.mulesoft.com/rpa-builder/latest/toolbox-variable-handling-session-based-variables) --- product: RPA Builder version: 6.6 --- # Workflow Elements in Detail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder creates the basic structure of a Workflow when you set up a new project. ![The Workflow Initialization and Activity Workflow windows](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-elements.png) The Workflow is the surrounding container for all Action Steps and Control Blocks. The Workflow element is fixed, cannot be deleted, and does not appear within the Toolbox. Workflow elements fall into different categories. There are elements that affect the entire Workflow, elements that control the Workflow sequence, elements that can simulate inputs, elements that monitor something, and elements that can measure the length of time taken to execute the Workflow and its availability. The Toolbox is structured based on these categories. ## Properties Properties are shown in the Workflow Properties panel. If this panel is not visible, enable it by going to **View** → **Show Workflow Properties** in the top menu bar. After you select an Activity Workflow, its properties are shown in the Workflow Properties panel. The following is a list of available properties: - **Miscellaneous** - **Defined Checkpoints** A list of all Checkpoints within the Workflow. - **Defined Timers** A list of all timers within the Workflow. - **Record Timer Sum** If activated, the Workflow generates an additional timer that contains the sum of all measured response times. - **Workflow Fail Handling** - **Default Timeout Defines** A global setting for the maximum time a Workflow will wait for an expected event. - **Reduce Design time Exec Tries** Limits the number of attempts in design mode to 1. Has no effect on execution on an agent. - **Retry Delay** The waiting time after a failed Workflow run before the next error cycle is started. - **Workflow Exec Tries** The Number of attempts that the Workflow starts before reporting an error. ## Action Steps Action Steps are the smallest components in a Workflow. They can be combined into logical blocks in Transactions. There are two ways of editing an Action Step. You can either use an Action Step wizard or edit directly using the Properties grid. - The **Wizard** provides special functions (like capturing an image within the Image search wizard), can disable or hide properties that are not currently applicable, and displays all properties in a condensed and more user-friendly view. Configure each Action Step by using its wizard at least once. There are three ways to start a wizard: - Double-click an Action Step and select **Run Wizard** from the context menu. - Click **Run Wizard** (![The Run Wizard icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/run-wizard-icon.png))in the Workbench toolbar while the Action Step is selected. - Insert and element using the Quick Creation Mode. In this case, the wizard opens automatically for each element inserted. - Using the **Properties grid** enables you to edit several Action Steps at once. Select multiple Action Steps by using **Ctrl + Click** or **Shift + Click**. The Properties grid only shows the properties that are available on every selected Action Step and you can set those properties for all steps at once. If the Properties grid is not visible, from the top menu bar, click **View** > **Show Workflow Properties**. ## See Also - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/6.6/workflow-configure-properties) - [Workflow Initialization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-initialization) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-finalization) - [Toolbox](https://docs.mulesoft.com/rpa-builder/6.6/toolbox) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workflow Elements in Detail > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Builder creates the basic structure of a Workflow when you set up a new project. ![The Workflow Initialization and Activity Workflow windows](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-elements.png) The Workflow is the surrounding container for all action steps and Control Blocks. The Workflow element is fixed, cannot be deleted, and does not appear within the Toolbox. Workflow elements fall into different categories. There are elements that affect the entire Workflow, elements that control the Workflow sequence, elements that can simulate inputs, elements that monitor something, and elements that can measure the length of time taken to execute the Workflow and its availability. The Toolbox is structured based on these categories. ## Properties Properties are shown in the Workflow Properties panel. If this panel is not visible, enable it by going to **View** → **Show Workflow Properties** in the top menu bar. After you select an Activity Workflow, its properties are shown in the Workflow Properties panel. The following is a list of available properties: - **Miscellaneous** - **Defined Checkpoints** A list of all Checkpoints within the Workflow. - **Defined Timers** A list of all timers within the Workflow. - **Record Timer Sum** If activated, the Workflow generates an additional timer that contains the sum of all measured response times. - **Workflow Fail Handling** - **Default Timeout Defines** A global setting for the maximum time a Workflow will wait for an expected event. - **Reduce Design time Exec Tries** Limits the number of attempts in design mode to 1. Has no effect on execution on an agent. - **Retry Delay** The waiting time after a failed Workflow run before the next error cycle is started. - **Workflow Exec Tries** The Number of attempts that the Workflow starts before reporting an error. ## Action Steps Action steps are the smallest components in a Workflow. They can be combined into logical blocks in Transactions. There are two ways of editing an action step. You can either use an action step wizard or edit directly using the Properties grid. - The **Wizard** provides special functions (like capturing an image within the Image search wizard), can disable or hide properties that are not currently applicable, and displays all properties in a condensed and more user-friendly view. Configure each action step by using its wizard at least once. There are three ways to start a wizard: - Double-click an action step and select **Run Wizard** from the context menu. - Click **Run Wizard** (![The Run Wizard icon](/mulesoft/current/en-us/rpa-builder/latest/_images/run-wizard-icon.png))in the Workbench toolbar while the action step is selected. - Insert and element using the Quick Creation Mode. In this case, the wizard opens automatically for each element inserted. - Using the **Properties grid** enables you to edit several action steps at once. Select multiple action steps by using **Ctrl + Click** or **Shift + Click**. The Properties grid only shows the properties that are available on every selected action step and you can set those properties for all steps at once. If the Properties grid is not visible, from the top menu bar, click **View** > **Show Workflow Properties**. ## See Also - [Configure Workflow Properties](https://docs.mulesoft.com/rpa-builder/latest/workflow-configure-properties) - [Workflow Initialization](https://docs.mulesoft.com/rpa-builder/latest/workflow-initialization) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/latest/workflow-finalization) - [Toolbox](https://docs.mulesoft.com/rpa-builder/latest/toolbox) --- product: RPA Builder version: 6.6 --- # Workflow Finalization > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Similar to the Workflow Initialization element, there is also the Workflow Finalization Action Block that is placed at the end of each Workflow with the default settings. It is used to end a Workflow in a controlled manner. This means that you can define different behavior depending on whether a Workflow has failed or has run successfully. This is important, for example, if the higher-order process is to continue to run despite a failed Workflow. You can add any Action Steps in the Workflow Finalization Action Block. The Transaction and Exit Workflow Action Steps and the Measurement Points are exceptions. ![The Workflow Finalization window](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-finalization.png) - **Workflow run succeeded** If a Workflow runs successfully up to the Workflow Finalization block, the Workflow run succeeded section is automatically triggered. First, the system attempts to execute all the Action Steps that are located here. If an error occurs (for example an Image Search fails), execution is terminated. How the process continues depends on which settings you have selected in the Workflow Finalization Wizard for the particular error. - **Workflow run failed** This section is executed if the previous Workflow has failed at a prior point. You can deal with the error in the Workflow run failed section, and define the further behavior of the higher-order Business Process in the Workflow Finalization Wizard. - **Common finalization handling** The Common finalization handling section is executed at the end of the Workflow Finalization block with each execution, irrespective of whether an error has occurred or not in the Workflow or within the block. Execution of the section does not affect the error state; the state that applied at the time the section was entered is kept. ## Wizard ![The Workflow Finalization Wizard window](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-finalization-wizard.png) The cases that can possibly occur and the ways they are dealt with, defined by the settings in the Wizard, are as follows: - **Workflow run succeded** The Workflow execution succeeds but an Action Step within the section fails. For this scenario, you can define the following behaviors in the Wizard: - **Keep success state** The error is ignored and the success Workflow state is kept, and the Business Process continues to run. - **Proceed with Business Process execution** The Workflow’s error state is kept and also documented but the higher-order Business Process continues to run. - **Terminate Business Process execution** The Workflow’s error state is kept and the Workflow is also ended with Failed state. Execution of the higher-order Business Process is terminated. - **Workflow run failed** The Workflow execution fails and it is dealt with in the Workflow run failed section. The state of the Workflow is not changed in this scenario, regardless of the options configured in the Wizard. If a Workflow has failed, it cannot subsequently be set to Succeeded. If the Action Steps within the **Workflow run failed** section fail, this does not affect the settings concerning the further execution of the Business Process made in the wizard. For this scenario, you can define the following behaviors in the Wizard: - **Ignore error, proceed with Business Process execution** The error is recognized and documented as an error but the higher-order Business Process continues to run. - **Keep error, terminate Business Process execution** The Workflow’s error state is kept and the Workflow is also ended with Failed state. Execution of the higher-order Business Process is terminated. - **Action Step failed in the Common finalization handling section** In this case, the Action Steps within the section are worked through but do not affect the Workflow’s state. If the Workflow has failed, the Failed state is kept. If the Workflow was successful, the Succeeded state is kept. The behavior can be described as _neutral_. If the Workflow is ended via a user exit, such as the Exit Workflow Action Step, only the Common finalization handling section is run through. The advantage of the **Proceed with Business Process** mode is that it enables you to deal with the error states of a Workflow at Business Process level. For example, if you define a `LastActivityError` activity parameter and give it a value, irrespective of what has happened, a suitable error handling process can be modeled via a gateway at Business Process level. ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) - [Workflow Initialization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-initialization) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workflow Finalization > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Similar to the Workflow Initialization element, there is also the Workflow Finalization Action Block that is placed at the end of each Workflow with the default settings. It is used to end a Workflow in a controlled manner. This means that you can define different behavior depending on whether a Workflow has failed or has run successfully. This is important, for example, if the higher-order process is to continue to run despite a failed Workflow. You can add any action steps in the Workflow Finalization Action Block. The Transaction and Exit Workflow action steps and the Measurement Points are exceptions. ![The Workflow Finalization window](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-finalization.png) - **Workflow run succeeded** If a Workflow runs successfully up to the Workflow Finalization block, the Workflow run succeeded section is automatically triggered. First, the system attempts to execute all the action steps that are located here. If an error occurs (for example an Image Search fails), execution is terminated. How the process continues depends on which settings you have selected in the Workflow Finalization Wizard for the particular error. - **Workflow run failed** This section is executed if the previous Workflow has failed at a prior point. You can deal with the error in the Workflow run failed section, and define the further behavior of the higher-order Business Process in the Workflow Finalization Wizard. - **Common finalization handling** The Common finalization handling section is executed at the end of the Workflow Finalization block with each execution, irrespective of whether an error has occurred or not in the Workflow or within the block. Execution of the section does not affect the error state; the state that applied at the time the section was entered is kept. ## Wizard ![The Workflow Finalization Wizard window](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-finalization-wizard.png) The cases that can possibly occur and the ways they are dealt with, defined by the settings in the Wizard, are as follows: - **Workflow run succeded** The Workflow execution succeeds but an action step within the section fails. For this scenario, you can define the following behaviors in the Wizard: - **Keep success state** The error is ignored and the success Workflow state is kept, and the Business Process continues to run. - **Proceed with Business Process execution** The Workflow’s error state is kept and also documented but the higher-order Business Process continues to run. - **Terminate Business Process execution** The Workflow’s error state is kept and the Workflow is also ended with Failed state. Execution of the higher-order Business Process is terminated. - **Workflow run failed** The Workflow execution fails and it is dealt with in the Workflow run failed section. The state of the Workflow is not changed in this scenario, regardless of the options configured in the Wizard. If a Workflow has failed, it cannot subsequently be set to Succeeded. If the action steps within the **Workflow run failed** section fail, this does not affect the settings concerning the further execution of the Business Process made in the wizard. For this scenario, you can define the following behaviors in the Wizard: - **Ignore error, proceed with Business Process execution** The error is recognized and documented as an error but the higher-order Business Process continues to run. - **Keep error, terminate Business Process execution** The Workflow’s error state is kept and the Workflow is also ended with Failed state. Execution of the higher-order Business Process is terminated. - **Action Step failed in the Common finalization handling section** In this case, the action steps within the section are worked through but do not affect the Workflow’s state. If the Workflow has failed, the Failed state is kept. If the Workflow was successful, the Succeeded state is kept. The behavior can be described as _neutral_. If the Workflow is ended via a user exit, such as the Exit Workflow action step, only the Common finalization handling section is run through. The advantage of the **Proceed with Business Process** mode is that it enables you to deal with the error states of a Workflow at Business Process level. For example, if you define a `LastActivityError` activity parameter and give it a value, irrespective of what has happened, a suitable error handling process can be modeled via a gateway at Business Process level. ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) - [Workflow Initialization](https://docs.mulesoft.com/rpa-builder/latest/workflow-initialization) --- product: RPA Builder version: 6.6 --- # Workflow Initialization > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ![The Workflow Initialization window](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-initialization.png) The Workflow Initialization element groups different configuration elements. You can only insert suitable elements here, such as the Actions Steps Activity Parameters, STC Protector or Settings. Workflow Initialization is at the project level and cannot be deleted. The Workflow Initialization section contains additional elements that are not available in the Toolbox. The **Settings** Action Step is located in the global initialization section of a Workflow. It is always there and cannot be removed. This Action Step defines basic path information and checks paths for all Action Steps of the type File Operations. In addition, you can define the proxy settings for the Action Step REST Call in the Network Settings tab. ## Workflow Settings Properties The following are the properties of the **Settings** Action Step. - **Misc** - **Base Path** Shows the currently selected base path. - **Generate Subfolder per run** When you enable this option, RPA Builder creates a temporary directory using a GUID (unique random number). - **Remove Base Path Subfolder after Run** When you enable this option, RPA Builder deletes the temporary directory after the Action Step runs. - **Use Allowed Paths limitation** When enabled, only the _allowed_ paths set in **Workflow Initialization** → **Settings** are used. Note that before executing any Action Step of the type File Operations, the specified Directory Path is checked against the _Allowed Paths_. If the Directory Path specified in the Action Step is not allowed, the Workflow terminates and displays an error message. > [!WARNING] Do not disable the **Use Allowed Paths limitation** option if important data is > stored on your system, as this information could be deleted by mistake. - **Network Settings** - **Proxy setting** - **No Proxy** (Default) No proxy is used. - **Use system proxy settings** The proxy settings of the operating system are used. No further configuration is necessary. - **Manual proxy configuration** The connection data to the proxy can be entered manually in the wizard. - **Proxy url** Shows the address to the proxy server entered in the Wizard. - **Use Authentication** Shows if this option is enabled in the wizard. ## Workflow Settings Wizard - **File Operation Settings** ![The Workflow Settings Wizard](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-settings-wizard.png) These settings apply for all File Operation Action Steps. - **Base Path Settings** - **Base Path (%Stws\_BasePath%)** Specifies the base path to use for all Action Steps of the type File Operations. Use the Browse button (![The browse button](/mulesoft/current/en-us/rpa-builder/6.6/_images/browse-button.png)) to browse the path. If you leave the path blank, the default `%Stws_BasePath%` is used internally as the path. To retrieve the specified base path later when configuring Action Steps of the type File Operations, use the Pin button (![The Pin button](/mulesoft/current/en-us/rpa-builder/6.6/_images/pin-icon.png)) and the `Settings-BasePath` option. The base path is shown in the Workflow Run Results and Print Preview. - **Base Path Preview** Shows the currently selected base path. - **Generate subfolder per run** When you enable this option, RPA Builder creates a temporary directory using a GUID (unique random number). The temporary directory is shown in the **Base Path Preview** and appended with `\[RunGuidFolder]`. - **Remove subfolder after run** Enabling this option means that the temporary directory is deleted after the Action Step has been run. - **Allowed Paths** - **No path limitations for File Operation Action Steps (default)** Use this option if you don’t want to set any limitations on the path for executing the Action Step and allow all possible paths. > [!WARNING] Do not disable the **Use Allowed Paths limitation** option if important data is > stored on your system, as this information could be deleted by mistake. - **Allow File Operation Action Steps only in following paths** Use this option if you want to restrict Action Step execution to certain paths (Allowed Paths). The gray field then shows the path specified in **Base Path Settings**, which means that, for File Operations, only the base path is allowed. Add up to 10 more allowed paths using the (![The Add icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-icon.png) **Add Allowed Path …​**) button. Enter a path in the field shown or browse for a path using the Browse (![The browse button](/mulesoft/current/en-us/rpa-builder/6.6/_images/browse-button.png)) button. Additional paths can be deleted using the **Delete Path** (![The Delete Path button](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon.png)) button. The paths calculated at runtime are checked against the **Allowed Paths**. Allowed paths show in the Workflow Run Results and Print Preview. Note that before executing any Action Step of the type File Operations, the specified Directory Path is checked against the **Allowed Paths**. If the specified Directory Path is not allowed in the Action Step, the Workflow terminates and displays an error message. - **Runtime Environment Settings** ![The Workflow Settings Wizard showing the Runtime Environment Settings tab](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-settings-environment-wizard.png) - **Name** and **Value** Create new environment variables using the (![The Add icon](/mulesoft/current/en-us/rpa-builder/6.6/_images/add-icon.png) **Add Environment Variable …​**) button. Enter the name of the new environment variables in the **Name** field enclosed in `%` signs, for example `%newPath%`. Enter a path for the new variable in the **Value** field. To enter path information, it is best to browse for the path using the Browse (![The browse button](/mulesoft/current/en-us/rpa-builder/6.6/_images/browse-button.png)) button. Additional variables can be deleted using the **Delete Environment Variable** (![The Delete Path button](/mulesoft/current/en-us/rpa-builder/6.6/_images/delete-icon.png)) button. - **Network Settings** ![The Workflow Settings Wizard showing the Network Settings tab](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-settings-network-wizard.png) To run the Action Step _REST Call_ via a proxy, configure the appropriate settings here. If an additional authentication is necessary, activate the checkbox **Use Authentication** and enter **Username** and **Password**. See [Workflow Settings Properties](#properties) for a detailed description of the Network Settings properties that are available in the Wizard. - **Error Handling Settings** ![The Workflow Settings Wizard showing the Error Handling Settings tab](/mulesoft/current/en-us/rpa-builder/6.6/_images/workflow-settings-error-handling-wizard.png) Specify the behavior of the Error Out variable when receiving more than one error message. Choose between appending or overwriting values. ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/6.6/workflow-elements-in-detail) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/6.6/workflow-finalization) - [File Operations](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-file-operations) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Workflow Initialization > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ![The Workflow Initialization window](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-initialization.png) The Workflow Initialization element groups different configuration elements. You can only insert suitable elements here, such as the Actions Steps Activity Parameters, STC Protector or Settings. Workflow Initialization is at the project level and cannot be deleted. The Workflow Initialization section contains additional elements that are not available in the Toolbox. The **Settings** action step is located in the global initialization section of a Workflow. It is always there and cannot be removed. This action step defines basic path information and checks paths for all action steps of the type File Operations. In addition, you can define the proxy settings for the action step REST Call in the Network Settings tab. ## Workflow Settings Properties The following are the properties of the **Settings** action step. - **Misc** - **Base Path** Shows the currently selected base path. - **Generate Subfolder per run** When you enable this option, RPA Builder creates a temporary directory using a GUID (unique random number). - **Remove Base Path Subfolder after Run** When you enable this option, RPA Builder deletes the temporary directory after the action step runs. - **Use Allowed Paths limitation** When enabled, only the _allowed_ paths set in **Workflow Initialization** → **Settings** are used. Note that before executing any action step of the type File Operations, the specified Directory Path is checked against the _Allowed Paths_. If the Directory Path specified in the action step is not allowed, the Workflow terminates and displays an error message. > [!WARNING] Do not disable the **Use Allowed Paths limitation** option if important data is > stored on your system, as this information could be deleted by mistake. - **Network Settings** - **Proxy setting** - **No Proxy** (Default) No proxy is used. - **Use system proxy settings** The proxy settings of the operating system are used. No further configuration is necessary. - **Manual proxy configuration** The connection data to the proxy can be entered manually in the wizard. - **Proxy url** Shows the address to the proxy server entered in the Wizard. - **Use Authentication** Shows if this option is enabled in the wizard. ## Workflow Settings Wizard - **File Operation Settings** ![The Workflow Settings Wizard](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-settings-wizard.png) These settings apply for all File Operation action steps. - **Base Path Settings** - **Base Path (%Stws\_BasePath%)** Specifies the base path to use for all action steps of the type File Operations. Use the Browse button (![The browse button](/mulesoft/current/en-us/rpa-builder/latest/_images/browse-button.png)) to browse the path. If you leave the path blank, the default `%Stws_BasePath%` is used internally as the path. To retrieve the specified base path later when configuring action steps of the type File Operations, use the Pin button (![The Pin button](/mulesoft/current/en-us/rpa-builder/latest/_images/pin-icon.png)) and the `Settings-BasePath` option. The base path is shown in the Workflow Run Results and Print Preview. - **Base Path Preview** Shows the currently selected base path. - **Generate subfolder per run** When you enable this option, RPA Builder creates a temporary directory using a GUID (unique random number). The temporary directory is shown in the **Base Path Preview** and appended with `\[RunGuidFolder]`. - **Remove subfolder after run** Enabling this option means that the temporary directory is deleted after the action step has been run. - **Allowed Paths** - **No path limitations for File Operation Action Steps (default)** Use this option if you don’t want to set any limitations on the path for executing the action step and allow all possible paths. > [!WARNING] Do not disable the **Use Allowed Paths limitation** option if important data is > stored on your system, as this information could be deleted by mistake. - **Allow File Operation Action Steps only in following paths** Use this option if you want to restrict action step execution to certain paths (Allowed Paths). The gray field then shows the path specified in **Base Path Settings**, which means that, for File Operations, only the base path is allowed. Add up to 10 more allowed paths using the (![The Add icon](/mulesoft/current/en-us/rpa-builder/latest/_images/add-icon.png) **Add Allowed Path …​**) button. Enter a path in the field shown or browse for a path using the Browse (![The browse button](/mulesoft/current/en-us/rpa-builder/latest/_images/browse-button.png)) button. Additional paths can be deleted using the **Delete Path** (![The Delete Path button](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon.png)) button. The paths calculated at runtime are checked against the **Allowed Paths**. Allowed paths show in the Workflow Run Results and Print Preview. Note that before executing any action step of the type File Operations, the specified Directory Path is checked against the **Allowed Paths**. If the specified Directory Path is not allowed in the action step, the Workflow terminates and displays an error message. - **Runtime Environment Settings** ![The Workflow Settings Wizard showing the Runtime Environment Settings tab](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-settings-environment-wizard.png) - **Name** and **Value** Create new environment variables using the (![The Add icon](/mulesoft/current/en-us/rpa-builder/latest/_images/add-icon.png) **Add Environment Variable …​**) button. Enter the name of the new environment variables in the **Name** field enclosed in `%` signs, for example `%newPath%`. Enter a path for the new variable in the **Value** field. To enter path information, it is best to browse for the path using the Browse (![The browse button](/mulesoft/current/en-us/rpa-builder/latest/_images/browse-button.png)) button. Additional variables can be deleted using the **Delete Environment Variable** (![The Delete Path button](/mulesoft/current/en-us/rpa-builder/latest/_images/delete-icon.png)) button. - **Network Settings** ![The Workflow Settings Wizard showing the Network Settings tab](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-settings-network-wizard.png) To run the action step _REST Call_ via a proxy, configure the appropriate settings here. If an additional authentication is necessary, activate the checkbox **Use Authentication** and enter **Username** and **Password**. See [Workflow Settings Properties](#properties) for a detailed description of the Network Settings properties that are available in the Wizard. - **Error Handling Settings** ![The Workflow Settings Wizard showing the Error Handling Settings tab](/mulesoft/current/en-us/rpa-builder/latest/_images/workflow-settings-error-handling-wizard.png) Specify the behavior of the Error Out variable when receiving more than one error message. Choose between appending or overwriting values. ## See Also - [Workflow Elements in Detail](https://docs.mulesoft.com/rpa-builder/latest/workflow-elements-in-detail) - [Workflow Finalization](https://docs.mulesoft.com/rpa-builder/latest/workflow-finalization) - [File Operations](https://docs.mulesoft.com/rpa-builder/latest/toolbox-file-operations) --- product: RPA Builder version: 6.6 --- # Write Bot Message > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Write Bot Message Action Step enables you to enrich the result message the RPA Bot generates after each failed run. In case of execution failure, this message shows in the **Run Results** section of the **Process Management** view in RPA Manager. ## Properties - **Bot message** The text to write in the message. - **Overwrite message** Select this option to overwrite the previous messages shown in **Run Results**. ## Inbound Variables - **Bot message** The text to write in the message. ## Outbound Variables This Action Step has no outbound Variables. ## See Also [RPA Manager: View Run Results](https://docs.mulesoft.com/rpa-manager/processautomation-deploy#view-run-results) --- product: RPA Builder version: 6.7 is-latest-version: true --- # Write Bot Message > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The Write Bot Message action step enables you to enrich the result message the RPA Bot generates after each failed run. In case of execution failure, this message shows in the **Run Results** section of the **Process Management** view in RPA Manager. Bot messages shouldn’t exceed 2000 characters. Mapping an activity parameter containing more than 2000 characters causes the message to show truncated in RPA Manager bot message logs. To view the complete bot log, download the log files in RPA Manager. ## Properties - **Bot message** The text to write in the message. - **Overwrite message** Select this option to overwrite the previous messages shown in **Run Results**. ## Inbound Variables - **Bot message** The text to write in the message. ## Outbound Variables This action step has no outbound Variables. ## See Also - [RPA Manager: View the Bot Log Messages](https://docs.mulesoft.com/rpa-manager/botmanagement-troubleshoot#view-the-bot-log-messages) - [RPA Manager: Download the Log Files of a Bot](https://docs.mulesoft.com/rpa-manager/botmanagement-troubleshoot#download-the-log-files-of-a-bot) --- product: RPA Builder version: 6.6 --- # Write Clipboard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use _Write Clipboard_ to copy a piece of text to the clipboard. This will replace the content s of the clipboard with the text. This is similar to the copy function, ``+``, used in a text editor to copy a selected piece of text, but in this case a value from the _Workflow_ is used for the clipboard instead of selected text. You can either enter the text used by _Write Clipboard_ yourself, or use the value of a variable. ## Properties _Write Clipboard_ has no special properties. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. ## Inbound Variables **Clipboard Text** Enter the text that should be copied to the clipboard when this _Action Step_ is executed. You can also transfer the content of a _Workflow_ variable to the clipboard. To do so, click on the pin and select one of the available variables. ## Outbound Variables **Write Clipboard** The _Write Clipboard.ClipboardText_ variable provides the text to be written to the clipboard. ## Example _Write Clipboard_ can be useful in transactions and robotic applications when it is necessary to enter text quickly. This might be necessary, for example, when an article description or a password has to be entered automatically into a field. Another use for this function might be to transfer data (text) from application 'A' to GUI 'B'. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Write Clipboard > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use _Write Clipboard_ to copy a piece of text to the clipboard. This will replace the content s of the clipboard with the text. This is similar to the copy function, ``+``, used in a text editor to copy a selected piece of text, but in this case a value from the _Workflow_ is used for the clipboard instead of selected text. You can either enter the text used by _Write Clipboard_ yourself, or use the value of a variable. ## Properties _Write Clipboard_ has no special properties. Other Properties that are the same in all action steps are described in the section on **Common Properties**. ## Inbound Variables **Clipboard Text** Enter the text that should be copied to the clipboard when this action step is executed. You can also transfer the content of a _Workflow_ variable to the clipboard. To do so, click on the pin and select one of the available variables. ## Outbound Variables **Write Clipboard** The _Write Clipboard.ClipboardText_ variable provides the text to be written to the clipboard. ## Example _Write Clipboard_ can be useful in transactions and robotic applications when it is necessary to enter text quickly. This might be necessary, for example, when an article description or a password has to be entered automatically into a field. Another use for this function might be to transfer data (text) from application 'A' to GUI 'B'. --- product: RPA Builder version: 6.6 --- # Write Log > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This _Action Step_ can be used to leave a comment or brief description at a certain point in the _Workflow_. The comment will be logged in the _Trace Log_ and be shown in the _Workflow Run Results_. Note that if you set the _Workflow Run Result_ property to _Error_, it will **not** force the _Workflow_ to enter an error state. ## Properties **Log Message** The text that will be written into the log. You can use pin variables here. **Workflow Run Result** If activated, the _Message text_ also shows in the _Workflow Run Results_ ## Inbound Variables **Log Message**\* The text that will be written into the log. You can use pin variables here. ## Outbound Variables The Action Step _Write Log_ possesses no outbound variables. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Write Log > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This action step can be used to leave a comment or brief description at a certain point in the _Workflow_. The comment will be logged in the _Trace Log_ and be shown in the _Workflow Run Results_. Note that if you set the _Workflow Run Result_ property to _Error_, it will **not** force the _Workflow_ to enter an error state. ## Properties **Log Message** The text that will be written into the log. You can use pin variables here. **Workflow Run Result** If activated, the _Message text_ also shows in the _Workflow Run Results_ ## Inbound Variables **Log Message**\* The text that will be written into the log. You can use pin variables here. ## Outbound Variables The action step _Write Log_ possesses no outbound variables. --- product: RPA Builder version: 6.6 --- # Write to Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Write to Excel File_ Action Step if you want to write the content you have read from an Excel file using the _Read from Excel File_ Action Step either to the same or a different destination file. The _Write to Excel File_ Action Step can only be used inside an Excel Session. Specify the destination file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/6.6/toolbox-excel-operations-excel-session). ## Properties **Excel Operation Settings** - **Add Sheet name if doesn’t exist** If you select the checkbox here, the sheet will be created new if it does not already exist. - **Column** This is where you enter the column to which you are writing. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. - Example: Instead of A for column A, you can enter a 1 for column A, a 2 for column B (instead of the letter B), and so on. - **Overwrite content** This is where you determine whether a cell, row or column which already has content is overwritten with new content. - **Range** (drop-down selection, default: Cell) There are three different modes available: - **Cell** If you select _Cell_, the text will be written to a specific cell. - **Row** If you select _Row_, the text will be written to a specific row. - **Column** If you select _Column_, the text will be written to a specific column. - **Row** This is where you enter the precise cell or row number to which text is to be written. - **Sheet name** Name of the spreadsheet. Under Properties you can only enter the name directly, unlike in the _Write to Excel File_ [Wizard](#wizard). - **Text to write** This is where you enter the free text that will populate the cell, row or column. - **Write value as** Here you can see whether the data in a cell is written as text or number. ## Inbound Variables - **Sheet name** Name of the spreadsheet. - **Column** This is where you enter the column to which you are writing. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. - **Row** This is where you enter the precise cell or row number to which text is to be written. - **Text to write** This is where you enter the free text that will populate the cell, row or column. - **Array to write** This variable is only used in Row and Column mode. It accepts an array as well as a string in CSV format. ## Outbound Variables **IsWritten** (Bool) This is how you check whether the text has been successfully written to a specific cell, row or column. The result is _True_ if the text was written successfully to the destination file. ## Wizard The **Sheet name** field is for selecting the spreadsheet to which text should be written. You can type directly into the input field, select an existing sheet from the drop-down list or connect with a Pin Variable. The drop-down list contains all the sheets saved within the Excel file. If you add a checkmark next to **Add sheet if it doesn’t exist**, the sheet will be created new if it doesn’t already exist. You can also connect here with a Pin Variable. In **Excel Mode** you specify via the drop-down list whether to write to a cell, a row or an entire column. You can enter letters or numbers as a value or connect with a Pin Variable. Under Write value as you specify whether the data in a cell is to be written as text or number. This function is only active if you have selected the Cell mode under Excel mode. This is useful to avoid errors in calculations. If you enter a number and select Write value as **Number**, the value is treated as a number in the Excel sheet. The original formatting of the cell in the target file is retained. In the **Text to write** field you can enter free text which is to be written to the Excel file or you can insert text via a Pin Variable. **Text to write** appears if you have selected **Cell** mode. In the Row and Column modes you will find the option **Array to write** at this point. Selecting the checkbox next to **Overwrite content with text** will overwrite a pre-populated cell, row or column with new content. You can also connect here with a Pin Variable. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Write to Excel File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the _Write to Excel File_ action step if you want to write the content you have read from an Excel file using the _Read from Excel File_ action step either to the same or a different destination file. The _Write to Excel File_ action step can only be used inside an Excel Session. Specify the destination file in the [Excel Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-excel-operations-excel-session). ## Properties **Excel Operation Settings** - **Add Sheet name if doesn’t exist** If you select the checkbox here, the sheet will be created new if it does not already exist. - **Column** This is where you enter the column to which you are writing. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. - Example: Instead of A for column A, you can enter a 1 for column A, a 2 for column B (instead of the letter B), and so on. - **Overwrite content** This is where you determine whether a cell, row or column which already has content is overwritten with new content. - **Range** (drop-down selection, default: Cell) There are three different modes available: - **Cell** If you select _Cell_, the text will be written to a specific cell. - **Row** If you select _Row_, the text will be written to a specific row. - **Column** If you select _Column_, the text will be written to a specific column. - **Row** This is where you enter the precise cell or row number to which text is to be written. - **Sheet name** Name of the spreadsheet. Under Properties you can only enter the name directly, unlike in the _Write to Excel File_ [Wizard](#wizard). - **Text to write** This is where you enter the free text that will populate the cell, row or column. - **Write value as** Here you can see whether the data in a cell is written as text or number. ## Inbound Variables - **Sheet name** Name of the spreadsheet. - **Column** This is where you enter the column to which you are writing. You can enter letters or numbers in this field. If you enter a number, this will correspond to the number of the column in the Excel file. - **Row** This is where you enter the precise cell or row number to which text is to be written. - **Text to write** This is where you enter the free text that will populate the cell, row or column. - **Array to write** This variable is only used in Row and Column mode. It accepts an array as well as a string in CSV format. ## Outbound Variables **IsWritten** (Bool) This is how you check whether the text has been successfully written to a specific cell, row or column. The result is _True_ if the text was written successfully to the destination file. ## Wizard The **Sheet name** field is for selecting the spreadsheet to which text should be written. You can type directly into the input field, select an existing sheet from the drop-down list or connect with a Pin Variable. The drop-down list contains all the sheets saved within the Excel file. If you add a checkmark next to **Add sheet if it doesn’t exist**, the sheet will be created new if it doesn’t already exist. You can also connect here with a Pin Variable. In **Excel Mode** you specify via the drop-down list whether to write to a cell, a row or an entire column. You can enter letters or numbers as a value or connect with a Pin Variable. Under Write value as you specify whether the data in a cell is to be written as text or number. This function is only active if you have selected the Cell mode under Excel mode. This is useful to avoid errors in calculations. If you enter a number and select Write value as **Number**, the value is treated as a number in the Excel sheet. The original formatting of the cell in the target file is retained. In the **Text to write** field you can enter free text which is to be written to the Excel file or you can insert text via a Pin Variable. **Text to write** appears if you have selected **Cell** mode. In the Row and Column modes you will find the option **Array to write** at this point. Selecting the checkbox next to **Overwrite content with text** will overwrite a pre-populated cell, row or column with new content. You can also connect here with a Pin Variable. --- product: RPA Builder version: 6.6 --- # Write to Text File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Write to Text File_ writes text to a plain text file, with `.txt` as the only supported file format. You can specify if you want _Write to Text File_ to overwrite existing text in a file or create a new file. ## Properties **File Operation Settings:** - **Add new line** Specify here whether a new line should be added after the new text. - **Create if file does not exist** Specify here whether a new file should be created if the specified file does not exist. This option prevent the _Workflow_ from ending with an error message if the file does not exist. - **Directory path** Enter the path to the directory where the file to be written to is stored. You can specify an absolute or relative path. If a relative path is used, then the path refers to a storage location relative to the _Base Path_ variable. - **File name** Enter the name of the file that is to be written. - **Overwrite file content** Specify here whether the whole content of the destination file is to be deleted before writing. This option can be used if you want the specified file to contain only the text that is to be written. If this option is not selected, the new text will be appended at the end of the existing text. - **Text to write** Specify here the text that is to be written. Other Properties that are the same in all Action Steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be written to is stored. You can specify an absolute or relative path. If a relative path is used, then the path refers to a storage location relative to the _Base Path_ variable. **File name** Enter the name of the file that is to be written. **Text to write** Specify here the text that is to be written. ## Outbound Variables **Text to write** The _Write to Text File.Text to write_ provides the text that is to be written. **IsWritten** The _Write to Text File.IsWritten_ variable indicates whether the text could be written to the file or not (True/False). **File name** The _Write to Text File.File Name_ variable provides the name of the file that is to be written. **Directory path** The _Write to Text File.Directory Path_ variable provides the path used. ## Wizard - **Directory path** Specify the path here to the file that is to be written. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be written. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Text to write** Enter the text that is to be written. You can also insert a variable from the Workflow as the _Text to write_. To do so, click on the pin and select one of the available variables. - **Overwrite content with text** Specify here whether the whole content of the destination file is to be deleted before writing. This option can be used if you want the specified file to contain only the text that is to be written. If this option is not selected, the new text will be appended at the end of the existing text. - **Add a new line after text** Specify here whether a new line should be added after the new text. - **Create file if it does not exist** This option determines whether a new file should be created if the specified file does not exist. This option prevents the _Workflow_ from ending with an error message if the file does not exist. - **Encoding** The encoding to use when writing the file. Includes Shift-JIS and EUC-JP for Japanese support. Specify a valid encoding type if the one you need is not in the list. --- product: RPA Builder version: 6.7 is-latest-version: true --- # Write to Text File > For the full documentation index, see: https://docs.mulesoft.com/llms.txt _Write to Text File_ writes text to a plain text file, with `.txt` as the only supported file format. You can specify if you want _Write to Text File_ to overwrite existing text in a file or create a new file. ## Properties **File Operation Settings:** - **Add new line** Specify here whether a new line should be added after the new text. - **Create if file does not exist** Specify here whether a new file should be created if the specified file does not exist. This option prevent the _Workflow_ from ending with an error message if the file does not exist. - **Directory path** Enter the path to the directory where the file to be written to is stored. You can specify an absolute or relative path. If a relative path is used, then the path refers to a storage location relative to the _Base Path_ variable. - **File name** Enter the name of the file that is to be written. - **Overwrite file content** Specify here whether the whole content of the destination file is to be deleted before writing. This option can be used if you want the specified file to contain only the text that is to be written. If this option is not selected, the new text will be appended at the end of the existing text. - **Text to write** Specify here the text that is to be written. Other Properties that are the same in all action steps are described in the section on **Common Properties**. For reasons of clarity they are not shown here. ## Inbound Variables **Directory path** Enter the path to the directory where the file to be written to is stored. You can specify an absolute or relative path. If a relative path is used, then the path refers to a storage location relative to the _Base Path_ variable. **File name** Enter the name of the file that is to be written. **Text to write** Specify here the text that is to be written. ## Outbound Variables **Text to write** The _Write to Text File.Text to write_ provides the text that is to be written. **IsWritten** The _Write to Text File.IsWritten_ variable indicates whether the text could be written to the file or not (True/False). **File name** The _Write to Text File.File Name_ variable provides the name of the file that is to be written. **Directory path** The _Write to Text File.Directory Path_ variable provides the path used. ## Wizard - **Directory path** Specify the path here to the file that is to be written. You can create an absolute path or a path relative to the _Base Path_. The initial value is %STWS\_BASEPATH%. Select an existing path. You can also insert variables from the _Workflow_ in order to construct the path. To do so, click on the pin and select one of the available variables. - **File name** Enter the name of the file that is to be written. You can also insert a variable from the Workflow as the _File Name_. To do so, click on the pin and select one of the available variables. - **Text to write** Enter the text that is to be written. You can also insert a variable from the Workflow as the _Text to write_. To do so, click on the pin and select one of the available variables. - **Overwrite content with text** Specify here whether the whole content of the destination file is to be deleted before writing. This option can be used if you want the specified file to contain only the text that is to be written. If this option is not selected, the new text will be appended at the end of the existing text. - **Add a new line after text** Specify here whether a new line should be added after the new text. - **Create file if it does not exist** This option determines whether a new file should be created if the specified file does not exist. This option prevents the _Workflow_ from ending with an error message if the file does not exist. - **Encoding** The encoding to use when writing the file. Includes Shift-JIS and EUC-JP for Japanese support. Specify a valid encoding type if the one you need is not in the list.