SystmOne Responder Installation - Manual

Tiffany Hodkinson -

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 dedicated Microsoft Windows unattended workstation, or preferably a server, alongside the TPP SystmOne clinical system.  It runs as a Windows service under the LOCALSYSTEM account (if required, a specific user account may be assigned to the service after installing).  Installation will require elevated privileges.



  • Microsoft Windows 10 or above, hardware specification to support the clinical system
  • .NET Framework 3.5 (includes .NET 2.0 and 3.0) to be enabled
  • .Net Framework 4.5
  • 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 on port 5671 (CIDR RANGE

Install node.js

Download and run the latest v18 installer from (select the 32-bit version, ending x86.msi).  When running the installer Wizard accept the default options.


Responder installation

  • Create folder C:\node\ for the deployment 
  • Download
  • Extract the contents of the zip file to C:\node, a subfolder for pyrusconnect-responder should be created
  • Copy the file c:\node\node.exe.config to the folder to which node.exe was installed (usually C:\Program Files (x86)\nodejs), this is to fix a dependency issue
  • Copy the correct responder configuration settings to c:\node\pyrusconnect-responder\config\default.json.  Ensure clinicalSystemQueue is set to the correct values for your deployment.
  • Create a folder called BPTemp within C:\Windows\Temp and ensure users have permissions to write to this folder.
  • From a Windows Command Prompt (Run As Administrator) change folder to C:\node\pyrusconnect-responder\ and run node index install to create and start the Windows service

The responder service will now appear in the Windows services list (under the name provided in responder config file) and can be checked/controlled from the Windows Services control panel app.



After a minute or so ensure the Windows service is still running.  Check log files in C:\node\pyrusconnect-responder\ for any errors, also check the daemon subfolder for an error log.  A Black Pear engineer can check if the installation is successfully connected to the data centre.


After Installation

1) Log in to SystmOne on the Gateway workstation. Users must have the following permissions to allow all functionality of the API to work:

  • Retrieves Patients - Can retrieve and view active patient records
  • Saves Records - Can save new data to patients records
  • View Deducted Patients - Can retrieve deducted patient records

Screenshot 2023-07-24 at 17.42.43.png

2) The user will need to supply permission to use the SystmOne API.  On the first request being sent via the SystmOne responder, a dialog box will appear on the gateway to allow the user to click Approve. This approval must occur within 30 seconds of a request being sent to the API.  A pre-arranged time can be agreed at the customer's convenience.

3) Where multiple user accounts are used on the SystmOne gateway, each one will need to go through the approval stage in step 2.

Additional notes:

  • once logged in fully, SystmOne can be locked for security when unattended without affecting the API.
  • smart cards are not a pre-requisite for API use. Where they are used, SystmOne can be locked and smart cards removed when unattended without impacting the API.


To uninstall the Windows service simply run node index uninstall from the pyrusconnect-responder folder (similar to the install step above).  Then manually delete folder C:\node\.  Node.js can be uninstalled via Windows Control Panel.

Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk