Blue Prism offers two main functions related to the JSON serialization capabilities:
- serialising a Collection into a JSON string
- de-serializing a JSON string into a Collection
In order to use the JSON serialization capabilities it is necessary to install a 3rd Party JSON.NET Dynamic Link Library (DLL) component produced byNewtonsoft. Details of this component can be found at this web site:
To maintain compatibility with Blue Prism v4, which only supports external components that use the .NET Framework 2.0, the supported version of the JSON.NET component is v1.3.1. This release can be downloaded from this link:
Once the .ZIP file has been downloaded from the GitHub library, then the files need to be extracted. The files that need to be extracted from the downloaded file are:
These files need to be copied to the Blue Prism installation directory (where the Automate.exe application is located), for example:
Adding a reference to the JSON library
The next step is to add a reference to the Newtonsoft.Json.dll file within Blue Prism. Usually this is done via a Business Object’s Initialise page, in the Code Options tab.
Save the changes to the Business Object before attempting to utilize the functionality of the new file reference.
Using the ‘Utility – JSON’ VBO object
The functionality of ‘Collection to JSON’ or ‘JSON to Collection’ can be used within a Blue Prism ‘Action’ stage within a Business Object or Process.
If the file has been correctly referenced, then stepping through the code will reveal the ‘Utility – JSON’ VBO’s process page: