Skip to main content

Installing PATCHS on your TPP Gateway Machine

Gwynneth Derere
  • Updated

How the SystmOne Integration works

Most of PATCHS is accessed entirely through the browser, with no installation required. Integration with SystmOne, however, requires a small application, called an 'agent', to be installed and run on the TPP Gateway machine for your practice. The agent allows the PATCHS servers to communicate with your SystmOne instance, which enables your practice to use Auto Registration and Auto Filing of PATCHS Requests.

Setting up the integration

1. Install the PATCHS Agent software on the TPP Gateway machine

  1. Log into your gateway machine as the TPP user (this is the Windows user that you use to run SystmOne). It often has a name like 'TPP.[your practice code]'
  2. Download the agent software from https://patchs-public.s3.eu-west-2.amazonaws.com/installers/tpp/PATCHS_SystmOne_Agent_Installer_v1-0-6.exe
  3. Install the agent software
  4. Ensure that any firewalls are set up to allow outgoing connections to *.patchs.ai on port 443
  5. Ensure any antivirus software is set to allow the agent software (if it doesn't already)

2. Set up your practice on PATCHS

If you haven't already done so, use the links sent to you during your onboarding process to set up your practice on PATCHS. See the other articles in this section for further information on this.

3. Download the SystmOne configuration file

  1. Log into your gateway machine as the TPP user (this is the Windows user that you use to run SystmOne). It often has a name like 'TPP.[your practice code]'
  2. Log in to PATCHS, and visit the Practice Details page (see Practice Details for more information)
  3. Click on the 'TPP settings' tab
  4. Under the 'TPP Gateway Machine Config' section, click the 'Generate new config file' button
    mceclip2.png
  5. In the window that pops up, enter the username of the TPP user on the gateway machine. This is the user you logged in as in step 1
    mceclip3.png
  6. Click 'Generate'. This will download a configuration file called 'agent.yml' to your computer. Move this file to C:\Users\[username of TPP user]\agent.yml
  7. Go to your 'Documents' folder in windows and create a folder called 'PATCHS'. Inside that folder create a new folder called 'attachments'

4. Start the agent software

The agent software will start on login, but if it doesn't start you can start it manually by searching 'PATCHS SystmOne Agent' in the Windows search bar.

If everything is working the software will show a black window which says "Listening for requests..."