Envisage Link Button Installation

The Envisage link button utilises EXACT’s generic link button capability to launch a script that in turn uses Curl to send a message to the Envisage Agent requesting a patient call to be generated for the patient currently in focus in EXACT. The Envisage Agent then, depending on configuration, broadcasts the requests to potentially multiple CODAs who are responsible for the display ( and optional vocalisation ) of the patient call message.

Installation PART 1: Run the Envisage Link Button installer

1. Place a copy of the Envisagelink-Install application onto the PC where you want to use the link button. (This will be provided by Envisage)
   Please note that this installation step will need to be repeated on every workstation where you want the link button to be used.
   
2. Run the installer
3. You may see the following UAC popup appear.  If it does then please select yes.
   
4. You now need to review and agree to the licensing terms.
   These are principally included to cover the third party distribution of the Curl executable.
   A copy of these terms is also located in the install directory. When ready, please select I agree.
   
5. In order to match the licencing token please ensure you use the default installation folder shown.  below. Select Install.
   
6. Configure the Link Button script
   Once the installer has completed its unpacking the following configuration script will automatically run.
   
   Please enter the IP address of the Call Agent that you wish the link button to communicate with.
7. When prompted to add the room name you have a choice.
   Simply hit return ( entering null ) and the room name will be suppressed from the message
   Enter the real room name you require e.g Surgery 2
   Enter the special word USE_PC_NAME in which the workstations Windows PC Name will be sent in the patient call message and if appropriate could be displayed as the room name or a string substitution set up in the Call Agent to translate to a more meaningful name.
   
   Please note this configuration can be rerun at any time on a workstation by running c:\envisage\configlinkbutton.bat or if you prefer you could edit the envLink.cfg directly.

8. Complete the installation by selecting "close"

Now consider whether you need to do any of the optional steps in Part 2 or move directly to Part 3.

Installation PART 2 : Configure the Envisage Link Button (Optional)

Step 1 (Optional): Display settings

Locate the text

:: Configure the Coda Display settings HERE

:: IMPORTANT: Do not specify displays that don't exist in call agent or no calls will be shown!

:: By Default broadcast to all screens

SET kDisplaySetting= -d "cis_id=None"

:: Alternatively to broadcast to specific screens:

::SET kDisplaySetting= -d "displays=1" -d "displays=2"

If you don’t want call requests from this workstation to be broadcast to all screens then comment out the first KDisplaySetting entry, and configure the second entry appropriately.

Step 2 (Optional): Staff Name

Locate the text

:: Staff name could be set here if fixed for this script deployment

:: Default however is to leave this as blank

SET staff="staff_name="

Where a workstation is permanently associated with a particular member of staff then the staff name option might be used to enrich the patient call message.

Step 3 (Optional): Configure the Envisage Agent to translate computer names to room names.

If you have used the USE_PC_NAME option for the room name you will probably need to do this step.

You will need appropriate Call Agent login privileges to do this ( so not SOE staff ).

For each workstation configured with a link button you will likely need to set up a computer name to room name text replacement rule in the Envisage Agent.

Installation PART 3: Enter the Envisage Link Button Licence Token

1. Ensure that your EXACT version is 12.7 or above, click Help, About or see the login screen for your version number.
2. Login to EXACT as an administrator user
3. Select Configure > Practice Settings > Product Licences
4. Select “+1” to add a new Licence.
   
5. Under Product Name enter a title i.e Enviasge Link.
   Please note that once the licence has been authenticated this name will update to reflect the actual name registered against the licence key.

6. Under the key enter the following SOE link button licence key
   ecbc27d6-0a53-40a5-965c-bb218dcf9253
   Be careful not to enter any leading or trailing whitespace, especially if you use cut and paste for this token.
   This is a generic licence so the same key can be used to enable this link button on any number of workstations.
   

7. Please leave the access code blank ( it is not required for this Link Button ) .
8. Enter the directory path where you have installed the scripts in Part one.
   At the current time you should be using C:\Envisage only.
   This will need to be entered on every workstation that you want to use the link button. You can use the “Computer” drop down to choose the workstation and enter the path. If you wish for the link to be activated on all machines then you can use the “Copy to All Machines” option.

9. Check that all details have been entered correctly and then press OK.
   The licence will now be checked and whilst being validated and you should see an entry similar to below.
   
   Please note this screen does not auto update so please exit this screen by pressing OK.
   Checking the licence validity can sometimes take a couple of minutes to process so please wait a minute or two and then re-enter the product licences screen. Once confirmed the licence should change to enabled = True. Log out and back into EXACT to help refresh the status if it's taking a while. You should now see a screen similar to below.
   
   
   Once the licence is enabled then log out and back into EXACT. When you select a patient from the patient toolbar the extra Envisage Icon will appear. Please note the icon will not appear until you select a patient.
   

If the button appears as an “E” rather than a “Loud Hailer” Icon then there is probably a mismatch between the path entered against the token key and the installation directory used for the installer.

Check that that the c:\Envisage directory exists and is populated and that the path setup for the token matches (Select Configure > Practice Settings > Product Licences + edit with the Envisage licence selected)

When you select (single click) the “loud hailer“ icon the Envisage launch script is executed and the following popup should appear indicating that Patient Call request has been passed to Envisage.

Possible Error Messages

If the script configuration for the Envisage Client was not completed correctly or the client is not accessible ( ie not responding or switched off ) then the request will timeout ( approx. 20 seconds ) and the following popup will be displayed.

Should this occur check that the envisage client is running and check that the correct call agent  IP address has been set in the local copy of the envlaunch.bat file.

If the link button config file was not successfully created or has been subsequently removed then the following message will be displayed.

Should this occur, rerun  c:\envisage\configlinkbutton.bat ( see Part 1.7 for details )

If the Call Agent hits a problem processing a message from the link button then a message

similar to below will be shown

The second sentence represents the message result and description returned by the call agent.

If the link button script receives no patient name when called the following message will be shown

The passing of the patient name to the script is actually controlled by the SOE licence token so if this error is encountered investigation of the  Envisage Link Button token would likely be required by SOE Support.