Resources

Release Notes

UiPath v2018.4.1

Release date: 12th December 2018 Version number: 2018.4.1

What’s New

The latest release of 2018 brings us a Long Term Support version and multiple features to help you in terms of scalability, stability, as well as user experience.

With Citrix environments being so popular, we are further extending automation capabilities with native support for Citrix XenApps. Once the Citrix Remote Runtime component is deployed on all the Citrix server machines and the new Citrix extension is installed on the client machine, elements in such environments are natively detected by Studio and the Robot. As such, selectors are properly built, without any hassle. If this raises your interest, get all the details from here.

Authentication

You asked, we delivered. This release ships with the much-awaited support for SAML 2.0 which allows Orchestrator to handle single sign-on authentication. You can now take advantage of the speed and convenience of accessing your Orchestrator instance with the same set of credentials used within your organization. In this regard, the new ExternalAuth.Saml2.Enabled parameter has been added in the web.config file. For more details about how to configure and use this new feature, click here.

A notable addition in this newest release, Smart Card Robot Authentication is now here to handle Common Access Cards and Personal Identity Verification support. As such, Unattended, Development, and NonProduction Robots can simply use your SmartCard to start sessions on machines, besides the conventional way. The connection method is easily selected when a Robot is created or edited. Check out how it is done on this page. Lastly, the Orchestrator API, namely the /odata/Robots endpoint, has been updated to accommodate this functionality. An example is available here.

Scalability

Do you think Attended Floating Robots are sweet? Good! Because the Floating Robots feature has been augmented to incorporate Development Robots as well. This is a major step forward in ensuring better, more convenient resource management of your Non-Persistent VDIs and hotseat environments. Create and configure your Development Floating Robots and connect to them from any defined machine.

This, paired with the fact that you can now activate your Studio license from Orchestrator through the Robot that connects them, makes for a broader automation experience, since workflows can be executed, modified, and debugged with Development Floating Robots. For more information, click here.

Orchestrator’s scheduling mechanism has been substantially improved in terms of performance. As a result, enabling multiple custom schedules in clustered environments does not pose a threat to the performance of system operations.

Extensibility

For an even more fruitful partnership between your UiPath automation and your complex existing app network, we made it possible to use webhooks with Orchestrator. You can now subscribe to Orchestrator events and send them to any external DCM, BPM, or CRM solution. Multiple users can be informed, for example, that there is a new item in a given queue, a schedule has failed, or a process has been updated. As you might have gotten used to by now, the Orchestrator API has also been updated to accommodate this new functionality. For more information, please see the documentation here and some API examples here.

This release, we bring you the first incarnation of the SAP BAPI activities pack. This package enables RPA Developers to invoke a SAP BAPI using a workflow. The package comes with a SAP BAPI Wizard that enables the user to generate a workflow for a specified BAPI. This workflow can then be invoked from any automation process by using the Invoke Workflow File activity. The Open SAP Connection and Close SAP Connection activities manage a connection to the SAP Instance. It is unique for each SAP Instance you connect to and, once obtained, it is stored in a IConnectionService proprietary variable, and can be subsequently used throughout your automation projects for connecting to the said SAP Instance.

Reusability

To remove the necessity of configuring the same project again and again, any automation you now create, along with all its dependencies, libraries, invoked workflows, custom components, and so on, can be saved as a Template. Thus, your custom Templates are available at your fingertips in Studio, ready to be used for new projects and are persistent across future updates. More details are available here.

Agility

Centered around improvements regarding error handling, the new Global Exception Handler project template is aimed at executing a process every time the workflow encounters an error. When the error occurs during execution, the Global Exception Handler steps in and performs a user-defined action. It may either continue the execution and re-throw the exception, ignore the error, retry to execute the activity or abort the execution. The Exception Handler comes in handy during debugging, as it pauses the execution, allowing users to inspect the target application, correct it or retry the activity which threw the error. Check out more details about the Global Exception Handler here.

Fancy using the command line? You might want to know that starting processes this way is now a thing on all Robots, regardless of their type. As long as a process is available for the Robot Agent (Tray), it can be started with a simple command, as well as with arguments. Used along with the Windows Task Scheduler, it is an efficient way to have processes started as soon as a user logs in. The appropriate process is downloaded by the Robot before execution, or updated if necessary.

Document Processing

The IntelligentOCR package has received a major update, as we've developed three new activities that enable you to approach Document Processing in a much simpler manner. The new activities are:

  • Present Validation Station - offers attended users the ability to make real-time CRUD (Create, Read, Update, and Delete) operations on documents for the purpose of classification and human data validation and extraction.
  • Prepare Validation Station Data - creates a bridge between FlexiCapture's Process Document activity and the new Validation Station, ensuring a much more user-friendly data validation experience.
  • Digitize Document - provides a new way of generating text versions from incoming documents, being able to process any PDF and most image formats.

User Experience

Intended to make collaboration with Attended Robots easier, the Robot Agent (Tray) displays the currently running process in an individual widget, while allowing you to pause, resume, or stop the execution. Not only does this help you keep an eye on what the Robot is doing, but also to pause the execution in case something unexpected happens and resume once everything is in order. Find out more on this page.

Also, to facilitate identifying which step the Robot is performing at any given time, we have created the Report Status activity and added it to the System activities pack, which enables you to create a custom status message that is displayed in the Robot Tray at any point in the execution of a workflow.

Furthering our efforts to bring you a smoother user experience, UiPath Platform now incorporates the highly-anticipated Dark Theme. Both Studio and Orchestrator have been painted in an eye-soothing gray, with bits of blue to keep the products’ color signature. Panels and controls are all available in a darker shade, making the whole UI more appealing and easier on the eyes. Please note that for Studio this feature is still considered experimental. For the Dark Theme to work, automation projects must have as a dependency at minimum UiPath.UIAutomation.Activities v18.4.2 and UiPath.System.Activities v18.4.1.

If you ever wanted to release the licenses on a machine, you are familiar with the tedious task of having to contact your IT support team and waiting for it to happen. As of v2018.4, this is no longer a problem as you can now easily enable/disable non-production and unattended-purposed machines. License consumption in this scenario is now yours to manage and it can be done straight from the convenience of your own Orchestrator instance. See here how to do that. If the Orchestrator API is more of your thing, then you can access a request example here.

Compatibility Matrix

The following table lists what version of Robot and Studio works with what version of Orchestrator.

Please note that by not upgrading to the latest available version you are not taking advantage of the newest features or bug fixes added in our releases.

  Orchestrator v2018.4 Orchestrator v2018.3 Orchestrator v2018.2 Orchestrator v2018.1 Orchestrator v2017.1 Orchestrator v2016.2
Robot v2018.4 check_mark check_mark check_mark close-window-xxl close-window-xxl close-window-xxl
Robot v2018.3 check_mark check_mark check_mark close-window-xxl close-window-xxl close-window-xxl
Robot v2018.2 check_mark check_mark check_mark close-window-xxl close-window-xxl close-window-xxl
Robot v2018.1 check_mark check_mark check_mark check_mark close-window-xxl close-window-xxl
Robot v2017.1 check_mark check_mark check_mark check_mark check_mark check_mark
Robot v2016.2 close-window-xxl close-window-xxl close-window-xxl close-window-xxl check_mark check_mark

More information is available here.

Improvements

Studio

Improvements have also been made available to the source control functionality in Studio. The newly introduced Repository Browser gives you a peek inside TFS and SVN repositories, with the option to have multiple projects in one place, and check out any one you want. Get a glimpse of the repository browser in the documentation.

Continuing the efforts on improving error handling and making the whole automation process more comprehensive, error messages for certain activity packages missing from workflows are more exhaustive. Missing or invalid activities are marked in the Designer panel, while an error banner provides additional information regarding the workflow and its unresolved dependency conflicts. Read more about it here.

Custom NuGet feeds that require authentication can now be added to the Package Manager through the NuGet.config file, and activities packages that they contain can be imported to automation projects. Find more information here.

The Expression Editor in the Properties panel keeps its size when reopened, making it easier to read through the text or expressions that you’ve saved inside.

Orchestrator

Validation has been added to the /odata/Processes/UiPath.Server.Configuration.OData.SetArguments endpoint. Additionally, please note that this endpoint can no longer be used to change the input and output parameters of an automation package if you upload it to Orchestrator through the API, the Packages page, or the NuGet feed.

Additionally, please note that the serialized string of input and output parameters is now used all throughout Orchestrator.

We simplified the process of creating an Attended Standard Robot, by removing the Password field. A gladdening "side-effect" of the removal is the consistency between the Floating and Standard Robot-creation scenarios.

All email address input fields are now limited to 254 characters.

In terms of setup, you might want to know that the UiPathPlatformInstaller.exe, UiPathStudio.msi, and UiPathOrchestrator.msi installers now also check the operating system to ensure a smooth execution of the entire ecosystem.

SignalR has been upgraded to v2.2.3 in an effort to attain a more reliable WebSocket communication and better memory management.

The performance of deleting Robots has been significantly improved in the context of a large deployment.

A confirmation dialog is now displayed when you grant a user Edit permissions on Robots. This comes in addition to the existing Edit permissions on Settings, Roles, and Users which require user confirmation.

The Jobs and Robots charts on the Dashboard have been enhanced so as to achieve better visibility.

Known Issues

Studio

  • Launching the Community Edition Studio UiPathStudio.exe installer while another such installer is running, results in corrupt installation.
  • When copying activities in the Designer panel from one flowchart into another, the order is not maintained. This does not occur for activities copied from one sequence to another.
  • When creating a new library from a template, the Designer panel doesn’t automatically open the .xaml file, unless the library template has a Main.xaml file.
  • Due to the experimental nature of Dark Theme, some tooltips, error messages, notifications and buttons in Studio are displayed in Classic Theme after the switch.
  • After updating Studio Community Edition UiPathStudio.exe, it is recommended to close the UiPath.Service.Host.exe and UiPath.Agent.exe before opening Studio.

Robot

  • Upgrading your Citrix client from Citrix Receiver to Citrix WorkSpace requires you to reinstall the UiPath Citrix extension. Find out more on this page.
  • The Citrix Receiver and Citrix WorkSpace are also available as Universal Windows Platform (UWP) applications. You can not install the UiPath Citrix Extension for these applications. Please use the standard Citrix Receiver or Citrix WorkSpace. You can find more information here.
  • Native Citrix automation does not currently support high DPI. You can prevent possible issues by disabling the DPI scaling options in your Citrix Receiver or Citrix WorkSpace client. Read more about it here.
  • Because of ICA and RDP cross-protocol compatibility issues, you need to restart all your active Citrix sessions after installing the UiPath Remote Runtime and UiPath Citrix Extension. More information is available here.
  • Lengthy executions in Citrix environments can often result in failure. This is caused by known limitations in the WPF Renderer, which interrupt process execution if the Citrix application session reaches the timeout limit.
  • Because of a limitation in NuGet libraries, the fully qualified file name or path must be less than 260 characters.
  • Connecting the Robot to Orchestrator during a paused process execution shows the Robot as connected, but unlicensed.
  • Input arguments are not displayed in Orchestrator for a process started with input and output arguments from the command line.
  • Sending text to an editable combo box, such as a save dialog, often results in the text not being sent. This is because of a known limitation of the Active Accessibility property in editable combo boxes.

Orchestrator

  • Updating a v2016.2 Orchestrator to any newer version is not possible if you have duplicate entries in the SQL database. Remove the duplicates prior to database migration as a workaround. Additional information is available here.
  • If you have more than 2 million logs in the SQL database, the update process times out. If your logs are kept in Elasticsearch, the update is smooth regardless of the number of logs maintained there.
  • In rare cases, if you click the Allocate button, in the Tenants page, an error message is displayed and the page is refreshed. Use the License page to distribute your licenses across tenants, if this occurs in your environment.
  • For enabled webhooks, payloads are not sent if you manually stop or kill a pending job.
  • If a large number of Robots become unresponsive at the same time, the robot.status webhook event is not triggered.
  • The Job.created webhook event is not sent to an external system if it is triggered by a Robot.
  • It is possible to add duplicate webhooks through POST requests to the /odata/Webhooks endpoint.

Activities

  • If filtered by using the Search bar, the table in the Arguments section of the SAP BAPI Wizard is not refreshed when navigating to the Generate section and back.

Bug Fixes

Studio

  • Fixes were brought to autocomplete functionality for variables and arguments part of automation projects.
  • Fixed an issue that caused Studio to become unresponsive for a short period of time after typing a network path in the location field part of the New Blank Process and New Blank Library windows.
  • Fixed an issue that prevented files versioned under TFS version control system from being deleted if they contained pending changes.
  • Files located in paths with restricted access permissions can now be opened in Studio in read-only mode.
  • Fixed an issue that caused the Designer panel to throw an error when opening workflows with names containing double-byte chars and arguments with default value.
  • The Expression Editor no longer truncates and hides the inputted condition if written on multiple lines of text.
  • Fixed an issue that prevented processes and libraries without descriptions from being published from Studio.
  • Variables of type System.Windows.Forms.Integration are now properly imported and used in automation projects.
  • Validation error occurred when adding an activity resulted from a library project which imported workflows that were created in a version prior to v2018.3 and used GenericValue variables.
  • Fixed an issue that caused Studio to freeze or improperly display certain controls after being left idle for a while on a remote desktop machine.
  • Projects created in Studio v2018.2 and saved on shared drives, could not be migrated and opened in v2018.3.
  • Keyboard shortcut CTRL+Tab didn't switch between active workflows if the focus was inside the Designer panel.
  • In some cases, DiagTool would generate inconsistent or empty report files.
  • Validation error occurred in some cases when the type of variable was modified in the Variables panel.
  • In the project folder, renaming a workflow and deleting the project.json file would result in a second Main.xaml file being generated when the workflow was opened in Studio.
  • If you updated your Studio and Chrome extension while the browser was opened, an error was displayed.
  • Solved an issue that caused a workflow validation error of automatically imported namespaces when copying VB expressions into activity input fields.

Robot

  • Particular Kanji characters were not identified by the Click Text activity.
  • On rare occasions, the Java extension failed to install if it was already on that machine and the deployment path was too long.
  • UIExplorer would throw an error when trying to select particular text strings from a HTML file opened in Internet Explorer or Chrome.
  • The user got disconnected from a RDP machine on which a Robot was executing a process. This only happened on Windows 10 Enterprise N 1709 versions and higher.
  • Trying to install the UiPath Silverlight extension without having the Silverlight runtime library installed would throw an exception.
  • The Type Into, Click, and Click Image activities would considerably reduce the process execution performance when used on Internet Explorer.
  • Selectors were not generated for elements inside IFrames on pages opened in Chrome.
  • On some occasions, the HtmlWindowName selector was not taken into account when automating pop-up windows in web browser automations. This resulted in erroneous actions being performed by activities.
  • Errors generated by incorrect selectors indicated it was triggered by the UiPath.Executor rather than the corresponding activity.
  • Some Katakana characters were inconsistently sent when used with the Type Into activity.
  • Sending the Alt + F4 hotkey to an IE instance under high load would often fail to close it.
  • Click Trigger events were not detected when used on the Adobe Reader DC application.
  • If you locked the screen of a machine over an active RDP session during a process execution, you would have been unable to log back into the machine until restarting it.

Orchestrator

  • Installed versions of Robots on a machine were inconsistently displayed across multiple organization units.
  • "Robot is unresponsive" alerts were received despite having disabled Robot alerts. (Profile page > Alerts section > Robots).
  • When multiple new versions were available for a package, clicking the Latest button updated the package incrementally instead of updating it to the latest version in one go. This happened if you used an external feed.
  • Switching to an older version of a package in an environment caused the associated process icon to be updated in all environments containing that package. This happened if you used an external feed.
  • Development Robots having the same username were not correctly licensed if you had acquired fewer concurrent licenses than the number of Robots. One of the Robots was never licensed, and therefore was unable to execute jobs.
  • Switching from an API key to basic authentication credentials when securing your external feed prevented processes from being displayed. This occurred when you used the same deployment URL.
  • In rare cases, in Orchestrator environments with a Load Balancer, if you logged in with the same user on two different browsers, the first session did not expire after 1 minute.
  • If you created a schedule on an empty environment, the exceptions and their stack traces were logged twice in Event Viewer.
  • Business conflict exceptions such as failures to retrieve statistics for charts are now logged in Event Viewer under the Orchestrator.BusinessException source.
  • It was possible to add invalid cron expressions in schedules if they were disabled.
  • Better validation was added to the Security tab of the Settings page.
  • It was possible to create a process using a package that did not exist through POST requests to the /odata/Releases endpoint. Now, if you try to perform this call with a package that does not exist, an error is thrown.
  • A warning was displayed in the Parameters tab of the Edit Schedule window, if you replaced the initial process with one that had input and output parameters.
  • If you changed the email of an Active Directory user, Orchestrator failed to send a confirmation message on the newly added address.
  • An issue was fixed that prevented you from updating Orchestrator if your activities and/or automation packages were stored in a shared folder and did not have special elevated permissions. Now, when updating, UiPathOrchestrator.msi only requires Write access to the shared folder in which you store your packages.
  • The UiPathStudio.msi did not remove the Java extension through the Change functionality.
  • You could not reinstall Orchestrator if the folder you used had broken permissions.
  • The UiPathPlatformInstaller.exe stopped working if you started the installation process under a specific user, then tried to uninstall the products under a different user. Now, the UiPathPlatformInstaller.exe setup can handle multiple login sessions.
  • Better validation has been added for the TenantId parameter, when making requests to the /odata/Users endpoint.
  • Duplicate records were returned if you made calls to the /odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo={},queueDefinitionId={}) and /odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus() endpoints.
  • The /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset endpoint has been deprecated. Instead, you can use the newly added one - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKey through POST requests. Last but not least, the Get Credential and Get Asset activities have also been updated to use the aforementioned call, if you are using them with a v2018.4 Orchestrator.
  • SQL queries for bulk operations caused deadlocks in the database. Multiple adjustments which improve bulk operations in terms of performance have been made.
  • A user that became idle was not automatically logged out of the application while on the Dashboard page.
  • An error message was displayed when you tried to add or edit a user without having permissions on Units. This occurred if you had organization units enabled in your Orchestrator instance.
  • The Platform does not support setting SSL protocols on HTTP client handler error message was displayed twice in the Event Viewer when Orchestrator was started.
  • An error message was displayed when you tried to log in using an incorrect password.
  • An error message was displayed when you cleared the Select All check box on the Manage Environments window before it was fully loaded.
  • The confirmation email concerning tenant creation was not sent despite having a valid email address and correctly set up email settings.
  • A user was able to see the Edit button on the Environments page despite not having the appropriate permissions.
  • Fixed an issue that prevented page numbering from being reset after a filter was applied.
  • Several of the latest generated alerts were not displayed in the Alerts drop-down.
  • The Account Lockout Seconds field is now limited to a value of 2592000.
  • An error message was displayed when you filled in more than 2000 characters in the Reviewer field on the Assign Reviewer window. The field is now limited to 64 characters.
  • Fixed an issue that allowed users to create a queue with a blank space character for a name.
  • An error message was displayed when you tried to add or remove Robots from an environment having at least 12,000 Robots.
  • The same confirmation message is now displayed at password reset, whether the user exists or not.
  • User details were not retrieved when you imported an Active Directory user group on an Orchestrator instance using Windows authentication.
  • Importing an Active Directory user group without defining organization units caused all the existing organization units to be assigned to each of the users.
  • Refreshing the Queues page while items were still being processed caused the containing queue to be displayed twice on the page.
  • When using Windows authentication, after your session expired you were redirected to the Login page of Orchestrator instead of Windows login.
  • Fixed an issue that allowed an Active Directory user to see the information from the Dashboard without having the appropriate permissions. This happened when being automatically logged into the Default tenant after session timeout of a different user.

Activities Versions

The following activity packages and versions are included in the installers and are added as dependencies, by default, to a newly created project in Studio:

  • UiPath.Excel.Activities - v2.4.6884.25683
  • UiPath.Mail.Activities - v1.2.6863.29868
  • UiPath.System.Activities - v18.4.1
  • UiPath.UIAutomation.Activities - v18.4.2