The key to successfully creating Application scripts is to make sure that the machine you are building the scripts on is identical to the platform where the application script is intended to run on from a day to day setup or during a load test.
To achieve this our recommendation is to setup a virtual machine, or spin up a physical desktop, that has the correct image loaded up as the intended target platform.
The reason is that with different iterations of windows or applications the behaviour can change and be different from each other. A difference between the platform on which you create the Application script and where you intend to run the Application script can be the reason the script does not behave in the intended manner.
Software installation
To make sure that all pre-requisites are installed on the platform on which build the Application script we have created this guide. There are a few things to look out for to get the best scripting experience possible.
Step 1. Downloading and installing the toolkit
Open the Login Enterprise Web Interface and go to the Configuration page. Select an environment, it does not matter which one, and select the Applications Tab.
Once the applications tab is open scroll to the bottom of the page where you will see the "Download Script Editor" section. Please download the following files:
Login VSI Scripting toolset
Download and extract the Login VSI Scripting toolset. Please extract the files in your preferred location. The Login VSI Scripting toolset contains a number of different files. It contains the example scripts, documentation about commands, the application Xray tool and more. It should be used as workspace for your application scripts.
If you do not have access to your own Login Enterprise environment you can download the scripting toolset here.
Visual Studio Code
This is the scripting editor we are going to use. This scripting editor can be downloaded and installed from the website. Direct link.
.Net Core SDK
Once you click on the .Net Core SDK link it is important that you download a specific version. By default the used web-page will show you the latest and greatest of the .net core package. However we need the .net core 2.2 SDK. Click here for a direct link and download the windows x64 version of the 2.2.x version.
Newer versions have shown not to work with our intellisense.
Step 2. Initial Setup
Once you are done with installing the software packages and the files are unzipped/unpacked you are ready for the next step: setting up Visual Studio Code.
Once Visual Code has opened make sure to go to the Extensions tab (Ctrl+Shift+X) or click this button. or
Once open please search for the C# plugin and install the plugin.
When using Login PI 3.6.x or lower we recommend the following steps. Once installed we need to make sure we configure the 1.19 version of the C# plugin. To do this right click on the C# plugin and select the "Install Another Version" option.
Next we select the version 1.19.1.
Once done please reload if you are asked to reload the plugin.
Once done restart Visual Code and continue with the next step:
Open Visual Code and select the “open folder…” option:
Select the Scripting Folder you downloaded from the management interface
Once this is done, you will see some folders in your visual studio code environment.
We include some Examples and snippets of code out of the box to get you up and running, feel free to look at these or copy and paste the code into your own script.
You are now ready to start scripting applications.