Python connector methods

  • Release version: Xanadu
  • Updated August 14, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Python connector methods

    The Python connector methods in RPA Desktop Design Studio enable ServiceNow customers to execute custom Python scripts or files as part of automation workflows. This functionality allows integration of Python logic directly within workflows, supporting both class-based methods and standalone functions.

    Show full answer Show less

    Prerequisites

    • Configure the Python connector properly before use.
    • Understand the limitations of Python scripts when used in this context.

    Execute Method

    This method runs Python scripts configured within the Python connector setup. Key steps include:

    • Select the Python connector component in the workflow.
    • Choose the class and method defined during configuration (e.g., class Math, method add).
    • Optionally, enable Show Functions to select functions outside classes.
    • Validate and confirm the selection to create a Data Out port Result that outputs the script’s return value.
    • Test execution by running the method directly in the design environment.

    Result Data Port: Outputs the script result as a string.

    InvokeScript Method

    This method executes Python scripts located on local computers by specifying the full command line, similar to running the script via a command prompt.

    • Ensure the Python script file exists at the provided path.
    • Verify a compatible Python version is installed locally.
    • Confirm the script runs error-free before integration.
    • Provide the command line in the Script parameter, including the Python executable, script path, and any arguments.

    Example command format: python "C:\path\to\script.py" or py -3 "C:\path\to\script.py"

    Output: The method returns the script’s output as a string through the Return data port.

    Example Python Script

    The example script demonstrates several capabilities:

    • Top-level functions like greeting the user and displaying current time.
    • A Calculator class with methods to add and multiply numbers.
    • A main function to run all defined functions and methods in sequence.

    This script can be leveraged within workflows to perform varied Python operations and return outputs for further processing.

    Execute custom Python scripts or files as part of an automation workflow by using the methods of Python connector in RPA Desktop Design Studio.

    Prerequisites for using the Python connector methods

    Configure the Python connector. For more information, see Configure the Python connector.

    Familiarize yourself with the limitations of Python script. For more information, see Limitations of Python script in Python connector.

    Execute

    Executes Python scripts set up in the configuration window. Before executing the method, you must configure the connector. See Configure the Python connector.

    To execute, do the following steps.
    1. Select the component and click the method settings icon (Method settings icon) or double-click the component head bar.
    2. From the Classes list, select the class defined during the configuration of the Python connector.

      For example, Math.

    3. From the Methods list, select the method defined during the configuration of the Python connector.

      For example, add.

    4. Select the Show Functions check box and select a function from the Functions list.

      Functions are those methods that are not written within a class. For example, banner.

      Figure 1. Show Functions check box
      Banner function is selected from the Functions list.
      Figure 2. Function in Execute Method
      Function in Execute Method.
    5. Click Validate.
    6. Click OK.

      A Data Out port (Result) is created to return the output.

    7. To test the method, right-click the Execute method and select Run From Here.
    Table 1. Execute method parameters
    Parameter Description Data port type Data type
    Result Returns the output of the script.
    Figure 3. Result of the Execute method
    "Welcome Abel Tutor" is displayed in the Data Out port of the Execute method.
    		Data Out String

    InvokeScript

    Runs the Python script on local computers and gets the output. Ensure that the Python file is available in the file path provided.

    Ensure that a Python version is installed on your machine. You must ensure that the Python script is running without errors.

    Figure 4. InvokeScript method
    InvokeScript method.
    Table 2. InvokeScript method parameters
    Parameter Description Data port type Data type
    Script Returns the output of the script.

    The command specified in the Script parameter for execution via the InvokeScript component is same as the command line that is used to run in a command prompt.

    Provide a file path for the Python script. For example, python "C:\Users\abel.tutor\Downloads\utility_runner.py"

    For example, py -3 "C:\Python testing\project1\main.py" Abel it has <python with version> <python file path> <arguments> format. For adding multiple arguments, use space.

    Example of a Python script that greets the user, returns current time, and performs calculations of add and multiply.
    # utility_runner.py

import datetime

# Top-level function
def greet_user(name):
    print(f"Hello, {name}!")

# Another top-level function
def get_current_time():
    print(f"Current time: {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")

# Class with methods
class Calculator:
    def __init__(self, a, b):
        self.a = a
        self.b = b

    def add(self):
        print(f"Addition: {self.a + self.b}")

    def multiply(self):
        print(f"Multiplication: {self.a * self.b}")

# Run all functions and methods in sequence
def run_all():
    greet_user("Abel.Tutor")
    get_current_time()

    calc = Calculator(5, 3)
    calc.add()
    calc.multiply()

if __name__ == "__main__":
    run_all()
    		Data In String
    Return Output of the script that is returned.
    Figure 5. Result of the InvokeScript method
    Result is displayed in the Data Out port of the InvokeScript method.
    		Data Out