Set up EHR-level customization
This guide explains how to set up EHR-level customization
How to set up EHR logo
With Smartbox UI
Click the
Settings
link in the headerClick the
Logo
tabPress the
Update logo
buttonEnter the logo URL
Press the
Ok
button
With API
To set up logo use the following request.
PUT /AidboxConfig/smartbox
content-type: text/yaml
smartbox:
logoUrl: https://example.com/ehr-logo.png
Smartbox (portal) templates customization
To understand how Aidbox sends emails, please read this page first:
Reset user password
To change template of "reset password" email, create NotificationTemplate with id reset-user-password
. Here's the example:
PUT /NotificationTemplate/reset-user-password
content-type: text/yaml
subject: Reset your password in {{tenant.name}}
template: |-
<p>Dear {{user.name.givenName}},<br />
To reset your password click this </p>
<a href={{confirm-href}}>link</a>
<p>Best wishes,<br />
Acme Inc</p>
<img src="{{tenant.logoUrl}}" />
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
tenant
id
of the tenantname
of the tenantlogoUrl
of the tenant
confirm-href
is the link users open to change their password
Sandbox email templates customization
To understand how Aidbox sends emails, please read this page first:
Confirm email address
To change template of "confirm email address" email, create NotificationTemplate with id developer-confirm-email
. Here's the example:
PUT /NotificationTemplate/developer-confirm-email
content-type: text/yaml
subject: Confirm email address
template: |-
<p>Dear {{user.name.givenName}},<br />
Please, verify your email address using this </p>
<a href={{confirm-address}}>link</a>
<p>Best wishes,<br />
Acme Inc</p>
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
confirm-address
is the link new user open to confirm the email exist
Application rejected
To change template of "application rejected" email, create NotificationTemplate with id review-request-rejected
. Here's the example:
PUT /NotificationTemplate/review-request-rejected
content-type: text/yaml
subject: Review request rejected
template: |-
<p>Your application was rejected</p>
<p>Best wishes,<br />
Acme Inc</p>
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
client
id
of the applicationname
of the applicationdescription
of the application
Review request approved
To change template of "application approved" email, create NotificationTemplate with id review-request-approved
. Here's the example:
PUT /NotificationTemplate/review-request-approved
content-type: text/yaml
subject: Review request approved
template: |-
<p>Your application was approved</p>
<p>Best wishes,<br />
Acme Inc</p>
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
client
id
of the applicationname
of the applicationdescription
of the application
Application suspended
To change template of "application suspended" email, create NotificationTemplate with id suspend-deployed-application
. Here's the example:
PUT /NotificationTemplate/suspend-deployed-application
content-type: text/yaml
subject: Your application has been suspended
template: |-
<p>Your deployed application was suspended</p>
<p>Best wishes,<br />
Acme Inc</p>
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
client
id
of the applicationname
of the applicationdescription
of the application
Suspended application approved
To change template of "suspended application approved" email, create NotificationTemplate with id approve-deployed-application
. Here's the example:
PUT /NotificationTemplate/approve-deployed-application
content-type: text/yaml
subject: Your application access has been approved
template: |-
<p>Your suspended application was deployed</p>
<p>Best wishes,<br />
Acme Inc</p>
Template parameters
user
email
address of the developername
givenName
of the developerfamilyName
of the developer
client
id
of the applicationname
of the applicationdescription
of the application
Last updated
Was this helpful?