HeartLab Agent

HeartLab Agent

The HeartLab Agent is a Windows application that enables automated delivery of finalized HeartLab reports to local directories.

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.

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 Windows system tray
• The Agent does not appear in the Windows taskbar

Configure the HeartLab Agent

After installation:

1. Navigate to Settings → Integrations → Agent
2. Click Create Agent
3. Enter an Agent name and select Create Agent
4. Record the following information:
   • Agent URL
   • Agent Token

5. Open the HeartLab Agent application.
6. Navigate to Authentication

7. Enter:
   • Agent URL
   • Agent Token
8. Select Test Connection
9. Confirm the message:

Connection test succeeded

Configure Report Deliveries

The HeartLab Agent can automatically save finalized reports to a local directory.

Configure the Agent

1. Open the Report Deliveries tab

2. Enable Report Deliveries
3. Select the destination directory.

Configure Report Distribution

1. Navigate to Settings → Reporting → Distributions

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

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

Verify Delivery

1. Finalize a report in HeartLab.
2. Confirm the distribution appears in the Study List.

If successful:

• The report appears in the configured directory
• The filename follows the configured naming convention
• The file format matches the configured distribution settings

Troubleshooting

Common causes of failed deliveries include:

• Invalid Agent Token
• Network connectivity issues
• Incorrect folder permissions
• Agent service not running

If report delivery fails:

• Verify the Agent is online
• Re-run the connection test
• Confirm folder permissions allow write access
• Review Agent logs for additional details

Related Articles

• Stress Test Uploads
• Custom Report PDF File Name Format