HeartLab Agent

The HeartLab Agent enables automated delivery of HeartLab reports to local directories, as well as automatic sending of cardiac stress test files into HeartLab.

Applies to

• Users with Other Administrative Tasks permission (typically Administrators)

Install the Agent

It is recommended to install the HeartLab Agent on a machine that remains online and logged in regularly, so downloads are reliable. To install the Agent:

1. Navigate to Settings > Integrations > Agent.

2. Click Download Agent Installer
3. Complete installation on the target machine.

The Agent will run in the system tray (not as a regular application).

Configuring the Agent

1. Navigate to Settings > Integrations > Agent.
2. Click Create Agent in HeartLab, enter a name and click Create Agent.
3. Note the 'Agent URL' and 'Agent Token' - this will only be shown once.

4. Open the Agent app and navigate to Authentication.
5. Paste the 'Agent URL' and 'Agent Token' from HeartLab into the Agent.

6. Click Test Connection to verify the setup. You should see 'Connection Test succeeded.'

Report Deliveries

The Agent can automatically deliver finalised reports to a specified local directory.

1. In the Agent app, navigate to Report Delivery.

2. Tick the 'Enabled' checkbox.
3. Set the target directory where reports should be delivered.
4. In HeartLab, navigate to Settings > Reporting > Distributions.

5. Click Create Distribution.
6. Select Agent as the distribution type.

7. Select the relevant Agent integration.
8. Configure additional settings:
   • File format
   • File naming convention
9. Verify delivery by completing a final report for a study in HeartLab.

The distribution icon should appear in the Study List to indicate delivery status. Delivery to the agent may take up to 1 minute.

Stress Test Uploads

The Agent can automatically upload cardiac stress test files (XML + PDF pairs) into HeartLab. Supported vendors include Cardiosoft and Norav. To configure the Agent:

1. Open the Agent app and navigate to Stress Test Uploads.
2. Tick the 'Enabled' checkbox.
3. Set the Upload Folder from which the Stress Test files will be retrieved.
4. Place XML and PDF files in the Upload Folder.

The Agent will periodically scan the folder and upload matching file pairs to HeartLab. Successful uploads are moved to a 'processed' folder, while unsuccessful uploads are moved toa. 'failed' folder.

Users can click “Retry All Failed” in the HeartLab upload dialog to reattempt any failed uploads.

Notes

• XML and PDF files must have identical filenames (excluding extension).
• Uploads are processed automatically at regular intervals.
• Failed uploads include error details for troubleshooting.

Related

• Custom Report PDF File Name Format