HeartLab Agent

HeartLab Agent

The HeartLab Agent enables:

• Automated delivery of finalized HeartLab reports to local directories
• Automatic uploading of cardiac stress test files into HeartLab

Applies to

• Users with Administrator permissions

Installing the HeartLab Agent

It is recommended to install the HeartLab Agent on:

• A machine that remains powered on
• A machine that remains logged in regularly
• A stable network connection

This helps ensure reliable report delivery and upload processing.

To install the HeartLab Agent:

1. Navigate to Settings > Integrations > Agent

2. Click Download Agent Installer
3. Run the downloaded Windows installer.
4. Complete the installation process.

Once installed:

• The Agent runs in the system tray
• The Agent does not appear in the Windows taskbar

Configuring the HeartLab Agent

After installation:

1. Navigate to Settings > Integrations > Agent
2. Click Create Agent
3. Enter an Agent name and click Create Agent
4. You will then be shown:
   • Agent URL
   • Agent Token

5. Open the HeartLab Agent application on the Windows machine.
6. Navigate to Authentication

7. Paste the:
   • Agent URL
   • Agent Token

into the Agent application.

8. Click Test Connection
9. Confirm the message Connection test succeeded

Report Deliveries

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

Step 1: Configure the Agent

1. Open the Report Deliveries tab in the Agent

2. Enable the feature by ticking Enabled
3. Set the target directory where reports should be delivered.

Step 2: Configure Report Distribution in HeartLab

1. Navigate to: Settings → Reporting → Distributions

2. Click Create Distribution
3. Select Agent as the distribution type

4. Select the relevant Agent integration.
5. Configure additional settings:
   • File format
   • File naming convention

Step 3: Verify Delivery

1. Complete and finalize a report in HeartLab.
2. Confirm the distribution appears in the Study List.

If successful:

• The report will appear in the configured local directory
• The file will follow the configured naming and formatting rules

Stress Test Uploads

The Agent can automatically upload cardiac stress test files into HeartLab.

Supported Formats

• XML + PDF file pairs
• Supported vendors:
  • Cardiosoft
  • Norav

Configure Stress Test Uploads

1. Open the Stress Test Uploads tab in the Agent

2. Enable the feature by ticking Enabled
3. Configure the Upload Folder
4. Place matching XML and PDF files into the Upload Folder.

Example:

Documents\
  test1.xml
  test1.pdf

The Agent will periodically scan the folder and automatically upload matching file pairs to HeartLab.

Successful Uploads

Successfully processed files are moved to:

Documents\
  processed\
    <timestamp>\

A corresponding study will be created in HeartLab.

Failed Uploads

Failed uploads are moved to:

Documents\
  failed\
    <timestamp>\

An error.log file will also be included.

Failed uploads are additionally visible in HeartLab

Users can select Retry All Failed from the HeartLab upload dialog to retry failed uploads.

Notes

• XML and PDF files must share identical filenames (excluding extension)
• Upload processing occurs automatically at regular intervals
• Failed uploads include error details for troubleshooting

Troubleshooting

Common causes of failed uploads or deliveries include:

• Invalid Agent Token
• Network connectivity interruptions
• Incorrect folder permissions
• Missing XML/PDF file pairs
• Mismatched filenames between XML and PDF files

If uploads or deliveries fail:

• Verify the Agent is online
• Re-run the connection test
• Confirm folder permissions allow read/write access
• Confirm XML and PDF filenames match exactly
• Review failed upload messages for additional detail

Related Articles

• Custom Report PDF File Name Format