Black Pear Software pyrusconnect-responder is a node.js application that interacts with TPP SystmOne clinical system via its desktop API.  It must be deployed to a Windows machine dedicated to running this service (A general use machine is not recommended) alongside the TPP SystmOne clinical system.

To ensure a connection to TPP SystmOne the Gateway must be running at all times and when not in use SystmOne can be locked.

The pyrusconnect-responder runs as a Windows service under the LOCALSYSTEM account (if required, a specific user account may be assigned to the service after installing). The following installer will require require elevated privileges.

What does the installer do?
Once executed the installer will complete the following in order:-

• Create a directory called “BPTemp” into the following locations and set users to have permissions to modify the directories:
  • C:\Windows\Temp\
  • C:\Windows\SystemTemp
• Create a Directory on the root of the C:\ called node and set users to have modify permissions.
• Download the latest Nodejs version (v22.22.3) and the latest release of the PyrusConnect-Responder zip file into the same execution directory as the installer.
• Executes the nodejs.msi silently
• Unzips the PyrusConnect-Responder.zip to C:\node\
• Installs & starts the PyrusConnect-Responder service

Providing the Black Pear Support team are aware that the installation has been completed we can perform a connection test on the practice. This is to approve the API connection to SystmOne.

What happens once the Installation has been completed?

Once the installation has been completed as well as the connection approved your practice should be connected to our service enabling users to post or retrieve information from the clinical system for patients. Depending on whether you post or retrieve (or both) from the clinical system is dependant on the project / service you are using.
To ensure that the connection remains successful, SystmOne must be logged on at all times on the machine in which the service was installed on. The Black Pear support team often perform checks on the connections for the following issues:-

SystmOne Not Found:

SystmOne is NOT running on the SystmOne Gateway where the PyrusConnectResponder is installed on

SystmOne Unresponsive:

The full Error for that we see is: Error: SystmOne API has been unresponsive for 30000ms. Connection has been abandoned . This means that there is a possible dialog box on SystmOne that requires the users attention. Usually this is an approval message or a SystmOne related message. As you maybe aware IF there are any dialog boxes that appear within SystmOne this send the SystmOne into an unresponsive state until the message as been cleared.

Queue Request timed out:

This could be something as simple as the Gateway being powered down OR the PyrusConnectResponder being in a stopped state. If this is not the case then it could be something that may require our attention to resolve, in some cases I have seen that NodeJS being updated by IT Services causing the Responder to be restarted as the components were locked during the update.

This could also be that there are firewalls that are blocking access to the tatooine.blackpear.thirdparty.nhs.uk on port 5671. This would require further investigations and may require the customer to liaise with their IT Services to allow the connection through the firewalls. Within the logs for the responder you should see something similar to : ConnectionManager error (With the connection details).

Refused Connection:

The user that was logged onto the Gateway at the time as refused the connection to the API.

Lets say for example Joe Bloggs initially accepted connection at the time of install but Norman Bates logs onto the Gateway for some reason. If a connection is attempted this would then prompt the user to accept the API connection but the Norman Denies the connection, this would then show us that a user has denied the connection. To resolve this either Joe Bloggs can logon to the Gateway again OR the refused connection can be reversed.

Please note that all logs can be found in C:\node\pyrusconnect-responder

How to Install the PyrusConnect Responder

Pre-requisites

• Microsoft Windows 10 or above, hardware specification to support the clinical system
• .Net Framework 4.5
• .NET Framework 3.5 (includes .NET 2.0 and 3.0) to be enabled
• TPP SystmOne
• It is important to have Time Zone set to London with Daylight Saving. Regional settings, language and date format set to English (UK) - ensure settings are copied to system accounts by clicking Copy settings from the Administrative tab
• The service must have a network route to tatooine.blackpear.thirdparty.nhs.uk on port 5671 (CIDR RANGE 10.41.130.64/27)
• Users of the SystmOne Gateway must have the following permissions:-
  • Retrieves Patients - Can retrieve and view active patient records
  • Saves Records - Can save new data to patients records

Starting the installation

• To start Download Zip that contains the installer from here
  Note:We would recommend downloading to a separate directory, for example C:\BPInstall
• Once zip has been downloaded the installer can then be exacted. To do this simply Right click on the PyrusConnect-Responder.zip and select Extract All:-

• This should then display the Extraction tool similar to below. Simply leave the paths as they are displayed and click Extract. This should then extract the installer into the destination path that was displayed on the extraction tool:-

• Once the installer has been extracted, Right click on the PyrusConnect-ResponderInstaller and then click Run as Administrator. You maybe prompt for the Administrators username and password. If so please enter the Administrator details as required:-

  

• In some cases the Windows Defender will display the following view. If so click the “More info” link. Once done, click the “Run anyway” option. The Run Anyway option MAY also not be available. If so move to the next step:-

• If the Run Anyway Option is not available it is more than likely that the file is blocked. To resolve this simply Right Click on the PyrusConnect-ResponderInstaller.exe and select Properties. This should then display the properties for the installer. On the General Tab there should be an Unblock tick box. Untick this box and click Apply and then OK. The installer should be able to ran as Administrator now:-

• With the installer now running you should see the following view. To begin the installation simply enter your ODS or Unit Code and click Start Installation:-
  (Please note: ODS Code should contain a capital letter. For example, A12345 and not a12345)

• During the installation you should find that each section should become Green with the tick box checked to give a representation of the current installation progress

• Once the installation is complete you should see all check boxes are completed with Green text.

With the service now installed contact the Black Pear Support team via Support@Blackpear.com to perform a connection test. 
An example of the email to the team would be as follows and if you are able to supply more information within the text that you think may assist the team:-

Subject: SystmOne Core1 Connection Test Request: A12345 : Test Practice
Text: Connection Core1 test request for A12345 : Test Practice

If you are able to provide which project the connection is for this would also assist the team.

Please note that when a connection test is being performed an approval message MUST be Approved within 30 seconds. Failure to approve the connection will result in connection failures.