Upload HMRC PAYE files
Basic PAYE Tools is a free software package HMRC provide for small employers to run their payroll. This is available on Windows, Linux, and OS X.
It’s updated annually at the start of April with ‘uprated’ tax rates and thresholds for the new tax year. These updates are critical for employers as if they’re using the wrong version their employees could end up paying the wrong amount of tax. Sometimes HMRC release minor updates during the tax year but these are less regular.
HMRC should submit the ticket to request updates to the exe files at least 2 weeks before the new versions are scheduled to go live. If you get a request with a tighter deadline than this, contact the ‘green’ content support team through their Slack channel.
As part of the initial tranche of ministerial department migration their
upload site was switched off. However, we don’t currently allow
files or other executable binary types to be uploaded to GOV.UK.
Therefore we determined the quickest course of action to meet the user
need of keeping their desktop software up to date was to manually upload
and host the files ourselves, bundled inside ZIP files.
This document describes the process by which this is actioned.
The way the updates work:
- Binaries are provided for Windows, OS X and Linux
- Deltas of the binaries are also provided for partial updates
- The software hits a manifest file
realtimepayetools-update-vXX.xml) to determine which files to download. This manifest contains the version number and partial paths to each of the available binaries. This manifest URL is hard-coded in the desktop software and only changes with each major version.
- The software downloads the relevant binaries from our asset host and updates itself
- There is also a mainstream content item and a Welsh translation which should be updated to link to the full downloads of the new versions
Where are the files?
The files are stored in S3, along with the rest of our uploaded assets.
The process for uploading new versions of the app
The manifest file version vXX is given as an example. You should confirm the version number to use with HMRC because it must match the URL hard-coded into the previous version of the software.
- HMRC submit a ticket via Zendesk (example)
- Check that GOV.UK content teams are aware of the ticket. They may need to request further tickets to be raised to cover the content updates.
- Download all zip files and XML file in the ticket
- Log into a backend machine:
gds govuk connect ssh -e production aws/backend. Yes, production - don’t use integration or staging to test. There’s a test procedure on production.
- Make a note of the IP address you just SSH’d into, e.g.
- Create a directory for the files to go into:
exitto return to your dev machine, or open another shell
- Upload the new files:
$mac scp -oProxyJump=jumpbox.production.govuk.digital *.zip yourname@<aws_machine_ip_address>:/home/yourname/hmrc-paye $mac scp -oProxyJump=jumpbox.production.govuk.digital *.xml yourname@<aws_machine_ip_address>:/home/yourname/hmrc-paye
SSH back into the machine if you exited earlier:
gds govuk connect ssh -e production <aws_machine_ip_address>
Verify that the files copied over correctly:
Move the files over to the
sudo mv ~/hmrc-paye /tmp(The deploy doesn’t work if you try to do it directly from your home directory).
Upload the ZIP files into Asset Manager
cd /var/apps/asset-manager sudo -udeploy govuk_setenv asset-manager bundle exec rake govuk_assets:create_hmrc_paye_zips[/tmp/hmrc-paye]
The command should take a few seconds to run, and the output will look something like this
(it can be safely ignored):
/home/yourname is not writable.
> Bundler will use `/tmp/user/2899/bundler/home/deploy’ as your home directory temporarily.
You should be able to access your zip, e.g. at https://assets.publishing.service.gov.uk/government/uploads/uploaded/hmrc/payetools-rti-[version-and-os].zip You may also see some “high memory for asset-manager app” alerts in the meantime.
Now upload the manifest, but with “test-” at the start of the filename:
sudo -udeploy govuk_setenv asset-manager bundle exec rake \ govuk_assets:create_hmrc_paye_asset[/home/yourname/hmrc-paye/realtimepayetools-update-vXX.xml,test-realtimepayetools-update-vXX.xml]
Purge the cache for the test file.
Reply to the Zendesk ticket, providing the
Wait for HMRC to confirm that it (and/or its suppliers) have tested the file and would like to proceed. Pass the Zendesk ticket over to content support by reassigning it to
3rd line--GOV.UK Contentand adding the green team tag,
business_defence_environment. In your handover comment, link to the mainstream content item (publisher link) and Welsh translation (publisher link). The content team will prep these pages with the new links, file sizes and version number, ready to publish at the launch time.
When the launch time comes (which should be specified in the Zendesk ticket), re-load the test file to the production path:
gds govuk connect ssh -e production <aws_machine_ip_address> cd /var/apps/asset-manager sudo -udeploy govuk_setenv asset-manager bundle exec rake govuk_assets:create_hmrc_paye_asset[/tmp/hmrc-paye/realtimepayetools-update-vXX.xml]
If the SSH connection fails, or if the file is missing, the machine has likely been rebooted and you’ll need to repeat some of the earlier steps to copy the XML file onto the machine again.
Purge the cache for the new file.
Reassign back to the content team to publish the content items. They will then resolve the Zendesk ticket.