---
title: How to Configure or Update the Excelleris eMessage Service
slug: portal-sub/how-to-configure-or-update-the-excelleris-emessage-service
docTags: 
createdAt: 2026-03-04T12:03:19.071Z
---

# Overview & Requirements

This article provides instructions for system administrators of self-hosted customers on how to configure/set up Excelleris eMessage integration, as well as setup validation.

This configuration guidance is valid for customers in** Ontario, New Brunswick and British Columbia**.

The setup supports the secure delivery of HL7 lab results from Excelleris into the Profile EMR.

## Requirements

- Ensure that .NET 4.8 is installed.
- Obtain the following items from Excelleris. They are used by the eMessage service to connect to Excelleris.
  - Certificate file (.pfx)
  - Certificate password
  - Logon ID/username
  - Logon password
- Ensure that the applicable Excelleris API URL is whitelisted:
  - api.on.excelleris.com OR api.nb.excelleris.com OR api.bc.excelleris.com 
- Contact Excelleris regarding whitelisting of any of your own IPs, if required.

# Configuring/Updating the Excelleris eMessage Service

## Step 1: Perform Certificate Configuration and Conversion

Perform the following steps in order to be able to use the certificate provided by Excelleris in the eMessage service. 

:::hint{type="info"}
**Note: **Below paths should be adjusted to your preferred location, folders may need to be created. Example: "C:\ExcellerisCerts\cert-in\\"

:::

1. Move the certificate file to your Profile server and into the following location, where \[YourPathHere] is a location of your choice: 

:::CodeblockTabs{indent="2"}
```javascript
[YourPathHere]\IHScripts\ExcellerisCerts\cert-in
    
```
:::

2. Navigate to the directory one level above at:

:::CodeblockTabs{indent="2"}
```javascript
[YourPathHere]\ExcellerisCerts
    
```
:::

3. Save the *Export PFX Certificate.txt* file attached to this article locally and change the extension to .ps1.
4. Right-click Powershell ISE and select to run as administrator. 
5. Copy-paste the text from the downloaded file into Powershell ISE to run it.
6. Edit the second line of the ps1 file to substitute the Excelleris-provided certificate password for the placeholder shown below.

:::CodeblockTabs{indent="2"}
```javascript
$certPass = ConvertTo-SecureString -String "ExcellerisCertPassword" -Force –AsPlainText
    
```
:::

7. Edit the third line of the ps1 file to substitute your unique password for the placeholder shown below.

:::CodeblockTabs{indent="2"}
```javascript
$newCertPass = ConvertTo-SecureString -String "NewCertPassword" -Force –AsPlainText
    
```
:::

8. Execute the script. This exports the new certificate to the following folder: 

:::CodeblockTabs{indent="2"}
```javascript
[YourPathHere]\ExcellerisCerts\cert-out
    
```
:::

9. Install the Excelleris public certificates on your application servers where Profile will communicate with the Excelleris server to load/fetch lab results.

## Step 2: Configure the eMessage Service General Properties

Perform the following steps to ensure that Profile is able to connect to the Excelleris API, perform downloads of lab results, and import them into the Profile EMR.

::::WorkflowBlock
:::WorkflowBlockItem
Log in to Profile and navigate to **Organisation/Preferences/eMessages**.
:::

:::WorkflowBlockItem
Move the **Excelleris (BC) **or **Excelleris (ON) **or **Excelleris (NB)** (as applicable) service from **Available Services **to **Installed Services **on the left-hand side.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/yrSIH_0tW33YVE5BBcHY3_n3bdvzloftc9-jy0ookfynwlwvtkdndvg.png" size="87" isUploading="false" initialPath="assets/n3BdvzloFTc9-JY0ooK_FYNwLWvtKdndVg.png" githubPath="en/Plug-ins or Profile Integration/Excelleris/assets/n3BdvzloFTc9-JY0ooK_FYNwLWvtKdndVg.png" position="flex-start" showCaption="false"}
:::

:::WorkflowBlockItem
Double-click on the particular Excelleris eMessage service to open up a console in which you can edit the service's properties.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/U77pfqxfn1Yb5nRewVmXx_akdrqvvbfqucd4z3u95idzvkueo3sknabg.png" size="81" isUploading="false" initialPath="assets/AKdrQvVbFQuCD4Z3u95IdzVkuEO3sknaBg.png" githubPath="en/Plug-ins or Profile Integration/Excelleris/assets/AKdrQvVbFQuCD4Z3u95IdzVkuEO3sknaBg.png" position="flex-start" showCaption="false"}
:::

:::WorkflowBlockItem
Under the **General **tab:

1. In the **Incoming Directory** field, add the path to the directory where Excelleris messages will be coming in.
2. Fill in the **Logon ID **and associated **Password **provided by Excelleris. 
3. If you are updating the certificate, **Remove **the existing certificate. 
4. To import the new certificate, click **Import**.
   1. You will be prompted to locate and select the new, configured and converted certificate. 
   2. An **Enter Passphrase **dialog pops up. Enter the certificate password (this is the password used in line 3 of the script that was run) and click **OK**.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/-7C3ZQjhnzmMzqneXlxc0_iryiuxettj1dlmha2bddfeiul4gyavvq.png" size="71" isUploading="false" initialPath="assets/iRYIuXe_Ttj1Dlmha2BDDFeIUL4gyAV_VQ.png" githubPath="en/Plug-ins or Profile Integration/Excelleris/assets/iRYIuXe_Ttj1Dlmha2BDDFeIUL4gyAV_VQ.png" position="flex-start" showCaption="false" indent="3"}

5. Click **Test** to validate the certificate.
:::
::::

## Step 3: Configure the eMessage Service Scheduling Properties

Perform the following steps to determine the times and frequencies at which lab results are downloaded from Excelleris.

::::WorkflowBlock
:::WorkflowBlockItem
Within the same eMessage service properties console, click on the **Schedule **tab. 
:::

:::WorkflowBlockItem
Select **Use task schedule (task runs according to the specified time)**.
:::

:::WorkflowBlockItem
If there is no configured schedule, click on **New **to create a new schedule.
:::

:::WorkflowBlockItem
Configure the schedule for when you want the eMessage service to run and then click **OK**.

::Image[]{src="https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/EXNxolqKmb1D_OdWLQvTx_opxnsv7ahasrcjqz8cal94bd0sjlvmfq.png" size="81" isUploading="false" initialPath="assets/OPXNSV7AHASRcJqz8CA_l94BD0SJlVmF_Q.png" githubPath="en/Plug-ins or Profile Integration/Excelleris/assets/OPXNSV7AHASRcJqz8CA_l94BD0SJlVmF_Q.png" position="flex-start" showCaption="false"}

- Ensure that there are *at least *10 minutes between runs; an interval that is too short can cause errors. The recommendation from Excelleris is to run the service at 15 minute intervals.
- A suitable schedule might be for the service to run every day, at 15 minute intervals, from approximately 6AM to 6PM and to end in the year 2099.
:::

:::WorkflowBlockItem
Go to **Organization/System Tasks **and confirm that the service/task runs and completes.

![](https://api.qa.archbee.co/api/optimize/zICxj0dnLereb6UUrBA3-/8bPhsazn740dlFX6SDfKx_ubaazpxckike0av5plsl9cinwzpysub7ea.png)
:::
::::

# Validation

- Certificate validation is performed as part of Step 2.
- eMessage service / system task validation is performed as part of Step 3.
- Once the eMessage service is running and downloading lab results:
  - You will see these appear in the **Incoming Directory** configured in Step 2.
  - Profile will automatically import lab results. 
    - Results that match a patient will show up in the Provider's inbox and in the Patient's medical record.
    - Results that do not match a patient will show up in the **Control Centre/Manage/Manual Matches** view. These results will need to be matched manually to Patient and Provider.

# Learn More

For more information on Excelleris and lab results, please click on the article links below:

- [Profile Changes for OMD Conformance](docId\:Zo7j99000irjlmaKyY5sa)- This includes the following topics:
  - Addition of References Range for Lab Results
  - Document Processor Window Configuration
  - Additional Manual Lab Results Entry Options for Abnormal Flag and Status
  - Excelleris Lab Result Validation
  - Modifying the Default Polling Interval / Download Frequency for Excelleris
  - Manually Downloading Lab Results for Excelleris
  - Laboratory Name Pre-populated with the GNB's Dynamic List of Laboratory Facilities
- [Adding Lab Results Manually](docId\:Jv1vl5xAmJ0M9GlJuiPAc)
- [Using Pre-populated Laboratory Names from GNB Dynamic List for External Provider](docId:3f-_woHZaYY3_zIOC-jxt)
- [Excelleris Display Changes for New Brunswick](docId\:DwtwCvoBDT5rH_aCPT-FN)

***

## Attachments

::File{src="https://api.qa.archbee.co/api/presign/zICxj0dnLereb6UUrBA3-/HaKF8q7GXXWG4xEzt7Sx2_6000280067-export-pfx-certificate.txt" label="Export PFX Certificate.txt" initialPath="../../../attachments-export/6000280067-Export%20PFX%20Certificate.txt" githubPath="attachments-export/6000280067-Export PFX Certificate.txt"}