Running Python Scripts

JAMS provides three Execution Methods to let you easily run Python scripts. Each Execution Method is specific to the supported operating system. You will need to choose the appropriate one based on your environment.

The following Execution Methods are available:

• PythonSSH – Execute Python code on an SSH Agent.
• PythonUnix – Execute Python code on a Unix Agent.
• PythonWindows – Execute Python code on a Windows Agent or JAMS Scheduler.

Running Python Scripts on an SSH Agent

JAMS has an Execution Method to let you run Python code on an SSH Agent. With this Execution Method, you can copy and paste your code into the Job and have JAMS run it.

Before you Begin

• Ensure you have JAMS AgentX installed.
• Ensure Python is installed on the JAMS Agent.
• Ensure you have a JAMS Credential created to run the Job in JAMS. This credential should have permissions to the relevant Agent. See Working with User Credential Definitions for more information.

Using the PythonSSH Execution Method

1. Click Execution Methods from the JAMS Shortcuts menu.
2. Double-click the PythonSSH Execution Method to review its properties.
3. Click the Template tab.
4. Enter the location of the Python executable on the Agent. The default value of this is:
   

#!/usr/bin/env python 
<<JAMS.Source>>

5. Click Save and Close.
6. Click Definitions from the JAMS Shortcuts menu.
7. In the Folder Navigator, select a Folder where the Job will be saved.
8. Click + to add a new Job.
9. In the Name field, enter a name for the Job.
10. In the Execution Method field, select PythonSSH.
11. Click Ok.
12. On the Source tab, paste your Python code.
13. Click the Schedule tab.
14. As needed, schedule when the Job will run.
15. Click the Properties tab.
16. In the Agent field, select the JAMS Agent that will run the Job.
17. In the Execute As field, select the JAMS Credential that will be used to run the Job.
18. Click Save and Close.

Running Python Scripts on a Unix Agent

JAMS has an Execution Method to let you run Python code in a Unix environment. With this Execution Method, you can copy and paste your code into the Job and have JAMS run it.

Before you Begin

• Ensure you have a JAMS AgentD installed. See JAMS AgentD for Linux/Unix for more information.
• Ensure Python is installed on the JAMS Agent.
• Ensure you have a JAMS Credential created to run the Job in JAMS. This credential should have permissions to the relevant Agent. See Working with User Credential Definitions for more information.

Using the PythonUnix Execution Method

1. Click Execution Methods from the JAMS Shortcuts menu.
2. Double-click the PythonUnix Execution Method to review its properties.
3. Click the Template tab.
4. Enter the location of the Python executable on the Agent. The default value of this is:
   #!/usr/bin/env python <br /> \<\<JAMS.Source\>\>
5. Click Save and Close.
6. Click Definitions from the JAMS Shortcuts menu.
7. In the Folder Navigator, select a Folder where the Job will be saved.
8. Click + to add a new Job.
9. In the Name field, enter a name for the Job.
10. In the Execution Method field, select PythonUnix.
11. Click Ok.
12. On the Source tab, paste your Python code.
13. Click the Schedule tab.
14. As needed, schedule when the Job will run.
15. Click the Properties tab.
16. In the Agent field, select the JAMS Agent that will run the Job.
17. In the Execute As field, select the JAMS Credential that will be used to run the Job.
18. Click Save and Close.

Running Python Scripts on Windows Agent

JAMS has an Execution Method to let you run Python code in a Windows environment. With this Execution Method, you can copy and paste your code into the Job and have JAMS run it.

You can also have your Python code in a separate .PY file and reference it within a JAMS Job by using the Command Execution Method. Both Execution Methods are described in the sections below.

Before you Begin

• Ensure you have a JAMS Windows Agent installed. See JAMS Agent for Windows for more information.
• Ensure Python (Python.exe) is installed on the JAMS Windows Agent or JAMS Scheduler.
• Ensure you have a JAMS Credential created to run the Job in JAMS.

Using the PythonWindows Execution Method

1. Click Execution Methods from the JAMS Shortcuts menu.
2. Double-click the PythonWindows Execution Method to review its properties.
3. Click the Properties tab.
4. From the list of properties, go to the Command property.
5. Update or verify the property that lists the location of the Python.exe on your JAMS Windows Agent or JAMS Scheduler. It will look similar to the following: C:\Users\MyAccount\AppData\Local\Programs\Python\Python314\python.exe "{0}". Ensure the "{0}" is included.
6. Click Save and Close.
7. Click Definitions from the JAMS Shortcuts menu.
8. In the Folder Navigator, select a Folder where the Job will be saved.
9. Click + to add a new Job.
10. In the Name field, enter a name for the Job.
11. In the Execution Method field, select PythonWindows.
12. Click Ok.
13. On the Source tab, paste your Python code.
14. Click the Schedule tab.
15. As needed, schedule when the Job will run.
16. Click the Properties tab.
17. In the Agent field, select the JAMS Agent that will run the Job. Leave it blank to have it run on the JAMS Scheduler.
18. In the Execute As field, select the JAMS Credential that will be used to run the Job.
19. Click Save and Close.

Using the Command Execution Method to run Python Scripts on Windows

1. Click Definitions from the JAMS Shortcuts menu.
2. In the Folder Navigator, select a Folder where the Job will be saved.
3. Click + to add a new Job.
4. In the Name field, enter a name for the Job.
5. In the Execution Method field, select Command.
6. Click Ok.
7. On the Source tab, paste your Python code. You will need to reference the location of the python.exe and .py files. It may look similar to the following:
   

c:\\Users\\MyAccount\\AppData\\Local\\Programs\\Python\\Python314\\python.exe c:\\hello.py

8. Click the Schedule tab.
9. As needed, schedule when the Job will run.
10. Click the Properties tab.
11. In the Agent field, select the JAMS Agent that will run the Job. Leave it blank to have it run on the JAMS Scheduler.
12. In the Execute As field, select the JAMS Credential that will be used to run the Job.
13. Click Save and Close.