VetView Portal Job

VetView Portal Job

This page was originally created for VetView 3.1. It has been updated to reflect changes from VetView 4.2 and later on 4-16-2025.

Search User Guides by Keyword

VetView Portal Overview

The VetView Portal is a standalone application that allows the Labs and Hospital client base to communicate through to the main VetView application using an API.

The Portal can be customized with your organization’s branding, or used out of the box as-is. The VetView API can also be used to add custom features to the portal, if you have a development team in your organization who is capable of coding with Java and JSON based web applications. These applications are Web Service Interfaces, and you can have as many of them linked to your VetView application as you want to develop.

VetView Portal Job

The main VetView Portal job appears in the Job and Interface Setup Screen as “Vetview Portal.”

image-20250416-191837.png
VetView Portal Job

Settings Tab

Once the job has been activated, it must have a unique name, and also be enabled.

The first time it is enabled, it will generated a unique Token Key. This key must be passed in with any API communications from the portal, and included in the YAML file on the server where the VetView portal is installed.

image-20250416-191920.png
VetView Portal Settings Tab

Field

Description

Field

Description

Active Flag

The portal authentication key is turned on and available for VetView Portal applications to use it to speak with the main VetView application.  

Interface Name

The name of the Portal.  If you have multiple portals or web interfaces running, be sure to give them each a unique interface name.

Description

Any additional details regarding this interface that you want to add.    You can also use this to store notes if necessary.

Token Key

The application key needed by the VetView Portal to communication with the main application.  This should be added to the yaml file located in the same directory as the Portal installation.

Minimum Portal Password Length

The minimum length for any new password created by a portal user.  Follow your organization's security guidelines.

Maximum Portal Password Length

The maximum length for any new password created by a portal user.  

Can the portal password contain the username?

By security best practices this is not allowed, but you can turn this option on if your organization's security guidelines permit it.

Does the portal password require a number?

Forces a new user to include at least one digit from 0-9 in their password.

Does the portal password require a special character?

Forces a new user to include at least one special character in their password.

Does the portal password require an uppercase letter?

Forces a new user to include at least one uppercase letter in their password.

Links to Labs Portal Settings

Takes you to the Labs Portal Setup tab under Lab Setup.  Be sure to select the correct lab from the top drop down menu.

Link to Hospital Portal Settings

Takes you to the Hospital Portal Setup tab under Hospital Setup. 

Hospital Portal Setup: Hospital Portal Setup Tab

Lab Portal Setup: Lab Portal Setup Tabarchived

API Documentation Tab

This section is for Swagger testing, if your VetView Portal has been customized to use additional API commands beyond those included with the standard VetView Portal projects from our repository. 

For more information, please see:  API Web Services Documentation