VetView Portal Job
- Cathy Allison
VetView Portal Job
In version 2.1 of VetView, our Portal was changed to a lightweight, stand alone project that communicates to Vetview's main application through authentication tokens. This new portal was built using VetView's robust API commands, which are slated to be expanded in version 2.2 of VetView as well.
Web Service Settings for VetView 3.0 and earlier versions
The settings for the Portal are simplified and consist of a simple token and additional links to the API documentation and Portal settings.
The authentication token generated must be sent and received in the header of every API command sent from the portal application. This is done using the Yaml file located in the same directory as the Portal installation.
The Job must also be enabled to accept requests with the token.
Location in Portal Config
The location for this can be found in the Portal application.yaml file under the heading: #authToken VetView app location: Navigation --> Job & Interface Setup --> VetView Portal Settings.
Web Service Settings for VetView 3.1
In Version 3.1 of VetView, the password settings for the Portal jobs have been moved to the Web Service. Previously, these were located on the Portal Setup under Common Setup, but that screen has been removed.
The authentication token generated must be sent and received in the header of every API command sent from the portal application. This is done using the Yaml file located in the same directory as the Portal installation.
If you have both Labs and Hospital running a portal, they can use the same authentication token if you want them to have the same password requirements.
| 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 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. |
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: Version 2.1 and Greater API Web Services Documentation
VetView Wiki Most recent releases of VetView: Version 5.0.2 and 4.2.8 Hotfix (Released 12/20/2024)
To see commonly used terms in VetView Hospital, please visit our Hospital Glossary of Terms.