Windows Connector methods

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 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 Windows Connector methods

    The Windows Connector methods in RPA Desktop Design Studio facilitate interaction with Windows applications, enabling users to automate various tasks effectively. These methods are categorized into three levels: Connector level, Window level, and Element level, each providing specific functionalities to interact with Windows applications.

    Show full answer Show less

    Key Features

    • Connector Level Methods:
      • CloseMainWindow: Closes the active application window.
      • GetMainWindowHandle: Retrieves the handle ID of the active window.
      • GetMainWindowTitle: Fetches the title of the active window.
      • SetWorkingDirectory: Sets the working directory for file operations.
      • Start: Launches the application.
      • Terminate: Closes the application.
    • Window Level Methods:
      • Focus: Brings an inactive or minimized window to the forefront.
      • GetFields: Retrieves data from form fields (requires configuration).
      • GetScreenShot: Captures the current screen.
      • IsCreated: Returns a Boolean indicating if a window matches set rules.
      • Maximize: Maximizes the window.
      • Minimize: Minimizes the window.
      • SendKeys: Simulates keystrokes in applications.
      • SetFields: Inputs data into form fields (requires configuration).
      • WaitForCreate: Introduces a delay before a window or web page loads.
    • Element Level Methods:
      • Click: Performs a click action on an element.
      • IsCreated: Checks if an element meets the defined rules.
      • SendKeys: Sends keyboard inputs to application text boxes.
      • SetPassword: Automates secure password entry (configuration required).

    Key Outcomes

    By utilizing the Windows Connector methods, ServiceNow customers can streamline their automation processes, enhance productivity, and improve data accuracy within Windows applications. Each method empowers users to manipulate window states, input data, and automate repetitive tasks effectively, leading to improved operational efficiency.

    The Windows methods in RPA Desktop Design Studio interact with the Windows applications to perform various tasks. The connector provides methods at different levels of the Windows applications.

    Windows connector method levels

    Connector level methods

    Window level methods

    Element level methods

    Connector level methods

    CloseMainWindow

    Closes the active window of the application.

    GetMainWindowHandle

    Retrieves the handle ID of the active window of the application.

    GetMainWindowTitle

    Retrieves the title of the active window of the application.

    SetWorkingDirectory

    Sets the working directory of the application for all file operations through the application to be performed in the specified directory.

    Input
    Path

    Start

    Starts the application.

    Input
    Path Args

    Terminate

    Terminates the application.

    Window level methods

    Focus

    Sets the focus on a window that is inactive, minimized, or in the background.

    GetFields

    Returns the data in the form fields of the screen. You must configure the method before using.

    To configure, do the following steps.
    1. Click the method settings icon (Method settings icon.).
    2. Select the form elements.
    3. Update the form element data type.
    4. Click OK.
    Output
    Form element data

    GetScreenShot

    Captures the screenshot of the screen.
    Output
    Return (Bitmap)

    IsCreated

    Returns the Boolean response depending on whether a specific window matches the rules set in the MATCH CHILDREN section of the configuration window.
    Inputs
    MatchAllChildren
    Outputs
    Return (Boolean)

    Maximize

    Maximizes the window.

    Minimize

    Minimizes the window.

    SendKeys

    Simulates keystrokes on web pages and windows.
    Inputs
    Keys
    ClearExistingValue (Boolean)
    TypeDelay

    SetFields

    Sets data in form field types. To set the form fields, you must first configure the method. To configure, do the following steps.
    1. Click the method settings icon (Method settings icon.).
    2. Select the form elements.
    3. Update the form element data type.
    4. Click OK.
    Input
    Form data field

    WaitForCreate

    Sets delay before a web page or a window loads.
    Inputs
    timeoutInSeconds
    MatchAllChildren
    Outputs
    Return (Boolean)

    Element level methods

    These methods are exposed when you double-click an application element under the Global Objects in the Project Explorer.

    Click

    Performs a click operation.

    IsCreated

    Checks whether an element matches the rules set in the MATCH CHILDREN window.
    Outputs
    Return (Boolean)

    SendKeys

    Simulates keystrokes on web pages and windows.
    Inputs
    Keys (String)
    ClearExistingValue
    TypeDelay (Double)

    SetPassword

    Automate entering password securely in the password field of a Windows application.

    To provide inputs to the fields see Configure port properties.
    Table 1. SetPassword method parameters
    Parameter Description Data Port type Data type Default value Mandatory? Notes
    Password Accepts the password as a secured string. Data In Secured string None Yes Since it accepts the password as a secured string, it only shows the length of the string when you right-click on the parameter and then click Preview Data.
    UseSendKeys SendKeys is a method used to send keyboard inputs such as characters, numbers, and symbols to text boxes inside an application. Data In Boolean False Yes
    Tip:
    If the SetPassword method fails to input the password in the password field, set the value to True and execute the method again.