Portal Setup Tab (3.1 and later)
This page was originally created for VetView 3.1. It has been updated on 6/27/2024 to reflect changes made up through VetView 4.2 and later.
Hospital Portal Setup Tab
The VetView Hospital Portal Setup Tab found under the main Hospital Setup screen is where you control the basic Portal settings for the external client interface for Hospital Portal.
General Portal Settings
The General tab contains the configuration for your hospital portal. The URL where it will reside may need to be coordinated with your institute's technology team.
Portal Header Instructions
The Portal URL should be a valid domain directory that links to the server where your VetView has been installed, with a public file server directory outside of the firewall. Internal VetView authentication is not used on the client portal - external salted passwords are stored separately for security.
For the Header File Path, have a valid local directory on the server itself with full CRUD permissions allowed to the VetView application. We recommend something simple like c:\VetViewPortalUploads but a NAS directory can work as well.
For the Header File and Pre-Login Message File, use any simple HTML file with any image formatting and meta data required by your institution. Image file paths should include "static/portalUploads/" and the directory of the VetView Portal installation if necessary. Click on Refresh Portal Header for a real time preview after uploading. (ex: <img src ="Portal/static/portalUploads/header.jpg"> for images)
The Navigation Bar Option (Home) Label is the name of the external website you can link to as the "home" button in the menu bar on the portal. The URL is the actual link that this button will go to when clicked. This allows you to link to your organization's primary outside managed website from the portal.
Field | Description |
---|---|
Hospital Portal Enabled: | This flag turns your Hospital Portal on. The portal is an optional feature that allows clients to access patient data and parts of the medical record that you have made available. |
Portal URL: | The website address where your portal can be accessed. This URL should be coordinated with your institution's IT department and should be available outside of your firewall / VPN. |
Header File Path: | A file location on your VetView server where the header files and images are stored. |
Header File: | The specific file in the Header File Path that will display as the Portal header. This should be an HTML file that is customized with your organization's branding. Additional customization of the look and feel of your portal can be done using the ZK Configuration file. |
Navigation Bar Option (Home) Label: | The label that will appear on the optional Home tab for your portal's navigation bar. This can be an "About Us" page or your institute's primary home page. |
URL: | The specific link that the Home option should go to. |
Patient Record Options: | Each one controls which parts of your patient records will be accessible to your clients. If you want them to have access to labwork, vaccine records, and upcoming appointments, but not upcoming reminders or your integrated PACs system, you can turn each of those options on and off. |
Registration Subtab
This section is where you can customize the Registration screen on your portal for new members.
Replace the email addresses with one that can be monitored by your staff members in charge of member registration.
Field | Description |
---|---|
Welcome Email From: | The email address that a welcome email for new clients will appear to be from. This can be a specific inbox address, or your hospital's more general email address. This email address will also be used for the Reset Password and Forgot username email from fields. |
Welcome Email Subject: | The subject line of the welcome email that will be sent to your clients. |
Welcome Email Body: | The body of the welcome email that will be sent to your clients. This field supports both rich text for formatting, and placeholders to pull in client data for personalization. |
Reset Password Subject: | The subject line of the email that will be sent to your clients if they request a password reset. |
Reset Password Body: | The body of the email that will be sent to your clients if they request a password reset. This can either be instructions asking them to contact your office for a manual reset, or an auto generated password sent using the placeholder, with instructions to log in and change it if desired. |
Forgot Username Subject: | The subject line of the email that will be sent to your clients if they have forgotten the username they need to log in to the portal. |
Forgot Username Body: | The body of the email that will be sent to your clients if they have forgotten their username. This can either be instructions asking them to contact your office for further assistance, or include a placeholder for the username associated with the email address. |
Communication Subtab
This subtab contains the settings for email communications sent to your clients after registration request has been completed..
Field | Description |
---|---|
Welcome Email From: | The email address that a welcome email for new clients will appear to be from. This can be a specific inbox address, or your hospital's more general email address. This email address will also be used for the Reset Password and Forgot username email from fields. |
Welcome Email Subject: | The subject line of the welcome email that will be sent to your clients. |
Welcome Email Body: | The body of the welcome email that will be sent to your clients. This field supports both rich text for formatting, and placeholders to pull in client data for personalization. |
Reset Password Subject: | The subject line of the email that will be sent to your clients if they request a password reset. |
Reset Password Body: | The body of the email that will be sent to your clients if they request a password reset. This can either be instructions asking them to contact your office for a manual reset, or an auto generated password sent using the placeholder, with instructions to log in and change it if desired. |
Forgot Username Subject: | The subject line of the email that will be sent to your clients if they have forgotten the username they need to log in to the portal. |
Forgot Username Body: | The body of the email that will be sent to your clients if they have forgotten their username. This can either be instructions asking them to contact your office for further assistance, or include a placeholder for the username associated with the email address. |
Accounting Subtab
This subtab is where you can set up the information needed to include a third party payment processor within your portal, such as Touchnet.
You can also show or hide the accounting history, or show or hide the payment form itself. If your clients cannot make payments on your portal, then the Show Payment form should be disabled.
Field | Description |
---|---|
Show Accounting History: | Enables the accounting history section for your client in the portal. If you do not want your clients to have access to their accounting history, this can be disabled. |
Show Payment Form on Accounting Screen: | Enables the payment form for your clients on the portal. If you do not want your clients to be able to pay online, this can be disabled. You must have a third party payment processor, such as Touchnet, already set up for this feature to work. |
External Payment Processor Form Properties: | The technical fields needed to enable the embedded third party payment link. Contact your third party payor to confirm what each of these fields should be. The VetView API will pass through the information with each of these labels in an electronic message to the third party site. |
External Payment Processor Form Data Field Types
These are the fields used to build a POST message that will be sent to the external payment website’s API. You will need the exact order of the message that their API expects, and the specific information needed to build the URL.
This section essentially translates the fields from VetView into the fields that the third party’s system needs to have. These details must come from the third party payment’s technical support - VetView does not know this information in its internal database, so it must be provided the information to sent to the external sites.
Type | Description |
---|---|
Client Account Number | The client account number from VetView that will be sent to the external payment form. |
Client Email | The client email from VetView that will be sent to the external payment form. This field may be a foreign key expected by their POST form. |
External Identifier | A form property type that can be used multiple times to supply the POST URL with an expected field that is fixed or variable, but not part of VetView. An example would be the client account for your hospital or lab with your payment company. |
Failure URL | If your third party payment processor has provided a URL for the failure state, it can be entered here. This is an optional field. |
Post URL | This is the base URL to which the additional form items will be appended. This field will be supplied by the third party payment site, and will be used to feed the data to their API to process the payment. |
Successful URL | If your third party payment processor has provided a unique URL for the success state, it can be entered here. This is an optional field. |
Transaction Amount | The value of the transaction that will be passed from VetView to the third party payment processor, and the form value ID that the processor expects it to become associated with in their POST form. |
Client Account ID | The field name of the Client ID for the third party payment processor. |
URL Client Account Number | The client account number of the third party payment processor as it needs to be passed into the POST URL for the API, if it is different from the client account number or client account ID. |
URL Client Name | The client name of the third party payment processor as it needs to be passed into the POST URL for the API, if it is different from the client name as it appears in the External Identifier fields. |