Page History

Python and .NET...

Tutorials → Python and .NET Integration | Tutorial | How-to Guide | Reference

Step 1

We'll create a shift report showing tank status.

1. Navigate to Reports → Forms
2. Click first row to add new form
3. Configure:
   • Name: ShiftReport
   • SaveFormat: Text
   • SaveFileName: C:/Reports/Shift.txt
4. Press Enter

2. Design Report Content

1. Go to Reports → Forms Editor
2. Double click ShiftReport 
3. Enter the report template below, then Save the report:

================================
    TANK FARM SHIFT REPORT
    Date: {Server.DateTimeInfo.Date}
    Time: {Server.DateTimeInfo.Time}
================================

TANK STATUS SUMMARY
-------------------
Tank 1:
  Level: {Tag.TankFarm/Tank1/Level} ft
  Temperature: {Tag.TankFarm/Tank1/Temp} °F
  Pressure: {Tag.TankFarm/Tank1/Pressure} PSI
  Status: {Tag.TankFarm/Tank1/Status}

Tank 2:
  Level: {Tag.TankFarm/Tank2/Level} ft
  Temperature: {Tag.TankFarm/Tank2/Temp} °F
  Pressure: {Tag.TankFarm/Tank2/Pressure} PSI
  Status: {Tag.TankFarm/Tank2/Status}

PRODUCTION METRICS
------------------
Total Volume: {Tag.TankFarm/Metrics/TotalVolume} gal
Flow Rate: {Tag.TankFarm/Metrics/FlowRate} gpm
Daily Production: {Tag.TankFarm/Metrics/DailyProduction} gal

================================
End of Report

3. Test Report Generation

1. Start runtime 
2. Open PropertyWatch
3. Go to List2 and type: Report.Form.ShiftReport.Save
4. Change the value from 0 to 1
5. Check the folder to see generated report

4. Schedule Automatic Reports

Create scheduled task for shift reports:

1. Go to Reports → Forms
2. Change the SaveTrigger to: Server.Hour
3. The report will be generated every hour once the solution is running.

5. Monitor Report Status

: Installation and Setup

The Python Shell integration requires Python releases 3.7 onwards and the installation of Python.NET.

• You can download Python here.
• Check the User admin privileges checkbox, and select Customize installation.

Image Added

• During the installation of the Python Engine,select the option to “Install for all users”.

Image Added

• If You install Python under your local user, you may have issues when running the solution as a service, or when deploying the solution for production.

• Once you've downloaded, open the command prompt as an ADMINISTRATOR and type “pip install pythonnet”. For this work, you'll need internet access. If internet is not available, download and install manually.
• Once Python.NET has been installed, you can start using Python in your solution.

Image Added

• Go to Solution / Settingsand locate the Python Interpreter box. Click the "..." button, navigate to find the installed Python Engine, and select the python.exe file.

Image Added

Step 2: Using Python in the Solution

Scripts Tasks and Classes

• Scripts / Tasks: Event driven or periodical tasks, running on the server computer. They can be written in Python, C# or VB.NET.
• Scripts / Classes: library of methods and functions that can be used on both server and client machines. They can be written in Python, C# or VB.NET.

Displays CodeBehind and Graphical Elements 

The Code Behind for the displays can be written in C#, VB.NET or JavaScript, not Python directly. But from the CodeBehind you can call tasks and methods, which can be written in Python. 

2.1 Shell Integration

• Shell Integration allows you to execute Python code from external files.

In order to achieve that, follow the steps below:

1. Go to your solution folder (the folder where your solution is located) and add a script with the name "ExternalSum.py"
2. In this file, add the following code:

3. 
   

   Code Block
   language py firstline 1 title ExternalSum linenumbers true
   import sys value1 = float(sys.argv[1]) value2 = float(sys.argv[2]) result = value1 + value2 print(result)

   
   

4. Create a Script → Task and choose Python as the language
5. Add a trigger task into the Trigger column
6. Create the following tags:
   1. Tag1 - Integer
   2. Tag2 - Integer
   3. TagResult - Integer
7. In your task, use the following script:

8. 
   

   Code Block
   language py firstline 1 title ExternalSum linenumbers true
   arg1 = @Tag.Tag1(0) arg2 = @Tag.Tag2(0) result = TK.ExecutePythonShell("_ExecutionPath_ExternalSum.py", [arg1, arg2]) @Tag.Result(0) = result

   
   

9. Run your solution and use Property Watch to change the values and see the results (don't forget to run the task trigger)

2.2 Standard Integration

• Standard Integration allows you to execute Python code in FrameworX script task.

In order to achieve that, follow the steps below:

1. Create a Script → Task and choose Python as the language
2. Add a trigger task into the Trigger column
3. Create the following tags:
   1. Tag1 - Integer
   2. Tag2 - Integer
   3. TagResult - Integer
4. In your task, use the following script:

5. 
   

   Code Block
   language py firstline 1 title Internal Sum linenumbers true
   def add(val1, val2): return val1 + val2

   
   

6. Run your solution and use Property Watch to change the values and see the results (don't forget to run the task trigger)

2.3 Python and .NET Integration

• Python and .NET Integration allows a Python function directly from Python Class on the code editor.

In order to achieve that, follow the steps below:

1. Create a Script → Task and choose CSharp as the language
2. Add a trigger task into the Trigger column
3. Create the following tags:
   1. Tag1 - Integer
   2. Tag2 - Integer
   3. TagResult - Integer
4. In your task, use the following script:

5. 
   

   Code Block
   language c# firstline 1 title Python and .NET linenumbers true
   @Tag.Result = TK.ToInt( @Script.Class.ClassPython.sum(@Tag.Tag1, @Tag.Tag2) );

   
   

6. Run your solution and use Property Watch to change the values and see the results (don't forget to run the task trigger)

In this section...