120 Chapter 7. Visual Scripting
Scripts
. Generally, read-only scripts are safe to run from a data integrity standpoint, but since
theyāre dealing with sensitive and potentially patient identifying information, care should still be
taken to the data security potential risk with running ESAPI scripts. Therefore this option to force
approvals on read-only scripts is an optional measure by which the Eclipse Administrator can
enforce extra securities. More general information on approvals for ESAPI scripts can be found in
Chapter 2 on ESAPI Basics.
This selection will impact the running of Visual Scripts. For one, each custom action pack
that is created must be approved. The Assembly File Version must be unique for each modiļ¬cation
made to the script, and the script must be approved using the script approval window from the
Tools menu. There are also a few built-in Visual Scripting libraries that will need approval.
In version 15.5, the path to the binaries are as follows
C:/ProgramFiles(x86)/Varian/RTM/
15.5/VisualScripting/ActionPacks
. In this location there are two action packs that are
crucial to the running of most visual scripts, VMS.TPS.VisualScripting.ElementLibrary.dll and
VMS.TPS.VisualScripting.ReportActionPack.dll. Backing up one folder level to the VisualScripting
folder, VMS.TPS.VisualScripting.ElementInterface.dll must also be approved in order to run most
Visual Scripts.
7.5.2 Action Pack Modiļ¬cation
It is important to always save a version of your Visual Script without the inclusion of a custom
action pack. Modiļ¬cations made to the custom action pack can have consequence on the entire
Visual Script. If during modiļ¬cation the name of the parent class of the action pack is changed,
the class that starts with the name YourActionPackElement, or if the key-value pair relationship is
modiļ¬ed in the m_options variable, then the script will be unable to open within the Visual Scripting
UI. An error message will display and that script will become unmodiļ¬able. Modiļ¬cations to the
execute method can be made without this worry.
When making modiļ¬cations to the Execute method, Eclipse and ARIA must be completely
closed at least once to allow for the removal of the action pack from Eclipse memory. After the
change to the script has been made, and the script recompiled, simply replace it in the UserDe-
ļ¬nedActionPacks folder described in section 7.4.3.
7.5.3 Favoriting Visual Scripts
Within the menu of the Visual Scripting Workbench, there exists an option
Add to Favorites
.
When selecting this option with a Visual Script of choice open, the Visual Script will be added to
the Tools menu of External Beam Planning for the user who was logged into Eclipse when the Add
To Favorites option was selected. Unlike traditional ESAPI scripts, this will not allow the user to
assign a hotkey and these Visual Scripts will not be seen globally by all users.
If the script is to be viewed and run by all users, it can be saved into the Published Scripts
folder for visibility. This folder location is in the same File Data Server as the custom action
packs. The Visual Script should be taken from
//<servername>/va_data$/ProgramData/
Vision/VisualScripting/UserScripts/GUID_code
and saved into the following location
//
<servername>/va_data$/ProgramData/Vision/PublishedScripts
. The script in question
will have the user-deļ¬ned saved name with an extension of vs.xml. In order to give this script a
hotkey, simply open the Tools
ā
Script menu from External Beam Planning, ļ¬nd the Visual Script,
and add to favorites from this location.