Install Python

To write the UDT scripts in Python, you must install Python and Python language server on your computer. This installation provides the necessary environment for the application to execute your scripts.

Important information

• Close all InTouch applications before installing Python.

• Only 32-bit Python is supported.

• You must run with elevated privileges.

• If an error occurs during installation, check the log file for troubleshooting.

Install Python and Python language server automatically

Run the following automated PowerShell script with elevated (Administrator) privileges.

InTouch-install-python-lsp.ps1

Install Python and Python language server manually

Note: Perform the following steps only if the automated PowerShell script installation fails or if you choose to install manually. You can skip these steps if Python and the Python language server have already been installed using the automated PowerShell script.

1. Download the installer file from https://www.python.org/ftp/python/3.12.10/python-3.12.10.exe.

2. Right-click the executable file and select Run as administrator.

3. In the Open File - Security Warning dialog box, select Run.

4. In the Install Python window, do the following:

   1. Select the Add python.exe to PATH check box.

   2. Select Customize installation.

   

5. In the Optional Features window, select the for all users (requires admin privileges) check box and then select Next.

   

6. In the Advanced Options window, do the following:

   1. Select the Install Python 3.12 for all users check box.

   2. Verify the Customize install location field.

   3. Select Install.

   

7. Wait for the installation to complete. On the Successful installation dialog, select Disable Path Length option and then select Close.

8. Set Environment Path (InTouch uses unique python environment variable).

   1. Open Environment Variables.

   2. Press Win + R, type sysdm.cpl, press Enter.

   3. Go to Advanced tab and select Environment Variables

   4. Create the variable under system variables, select New.

   5. Set the following:

      • Variable name: INTOUCH_PYTHON_HOME

      • Variable value: path to your Python install. Example: C:\Program Files (x86)\Python312-32.

   6. Select OK to save.

9. Add to path (Optional but recommended)

   1. Under System variables, find Path.

   2. Select Edit and then select New.

   3. Add the following:

      • %INTOUCH_PYTHON_HOME%

      • %INTOUCH_PYTHON_HOME%\Scripts

   4. Select OK and then select OK to save.

10. Open Command Prompt and run the following commands:

    1. pip install python-lsp-server - to install the Python Language Server (LSP) into your Python environment.

    2. python -m pip install python-lsp-server[websockets] - for WebSocket support.

11. Install PythonLanguageServerPlugin

    1. Verify that the PythonLanguageServerPlugin folder exists at the following path:

       C:\Program Files (x86)\Common Files\ArchestrA\Services\InTouchScriptingService

    2. Navigate to the Python installation directory: C:\Program Files (x86)\Python312-32

    3. Open Command Prompt and run the following command:

       python.exe -m pip install "C:\Program Files (x86)\Common Files\ArchestrA\Services\InTouchScriptingService\PythonLanguageServerPlugin

12. Restart the machine to apply environment path changes.