### Install PySapGUI from GitHub Source

Source: https://github.com/gutskodv/pysapgui/blob/master/README.md

Provides instructions for installing PySapGUI directly from its GitHub repository. This method involves cloning the repository, building the wheel package, and then installing it. It's useful if pip installation fails.

```shell
git clone https://github.com/gutskodv/PySapGUI.git
```

```shell
python -m pip install --upgrade pip
pip install wheel
python setup.py bdist_wheel
```

```shell
python setup.py dist\PySapGUI*.whl
```

--------------------------------

### Install PySapGUI using Pip

Source: https://github.com/gutskodv/pysapgui/blob/master/README.md

Installs the PySapGUI library using pip, the Python package installer. This is the recommended method for most users. It can also handle installations behind a proxy server by specifying the --proxy option.

```shell
pip install PySapGUI
```

```shell
pip install PySapGUI --proxy http://user:password@proxyserver:port
```

--------------------------------

### Start SAP Logon Application Programmatically in Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

Demonstrates the use of the SAPLogonEXE class to start the SAP Logon application. It includes functionality to check if the application is already running before attempting to start it, and an option to force start without checking. Requires specifying the path to the SAP Logon executable.

```python
from pysapgui.saplogonexe import SAPLogonEXE

# Set path to SAP Logon executable
SAPLogonEXE.set_path(r"C:\\Program Files (x86)\\SAP\\FrontEnd\\SAPgui\\saplogon.exe")

# Start SAP Logon (checks if already running first)
try:
    started = SAPLogonEXE.start(check=True)
    if started:
        print("SAP Logon started successfully")
    else:
        print("SAP Logon was already running")
except ValueError as e:
    print(f"Failed to start SAP Logon: {e}")

# Force start without checking
SAPLogonEXE.start(check=False)
```

--------------------------------

### Install PyWin32 Requirement

Source: https://github.com/gutskodv/pysapgui/blob/master/README.md

Installs the PyWin32 package, which provides Python extensions for Microsoft Windows. This is a requirement for PySapGUI and grants access to the Win32 API and COM objects.

```shell
pip install pywin32
```

--------------------------------

### Extract Data from SAP ALV Grids

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet shows how to use the `SAPAlvGrid` class to iterate over data in SAP ALV Grid controls. It facilitates row-by-row data extraction and includes automatic scrolling capabilities. The example demonstrates initializing the handler and navigating to a screen with an ALV grid.

```python
from pysapgui.alv_grid import SAPAlvGrid
from pysapgui.sapexistedsession import SAPExistedSession
from pysapgui.transaction import SAPTransaction

# Get session and navigate to a screen with ALV grid
sap_session = SAPExistedSession.get_session_by_number(0)
SAPTransaction.call(sap_session, "SE16")

# Initialize ALV Grid handler
grid = SAPAlvGrid(sap_session, "wnd[0]/usr/cntlGRID/shellcont/shell")
```

--------------------------------

### Attach to Existing SAP Sessions using Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

The SAPExistedSession class enables attaching to existing SAP GUI sessions and retrieving detailed session information such as System ID, client, user, and application server. It also provides methods to get all active sessions and the total connection count, along with functionality to close specific sessions. Errors during attachment or information retrieval are handled via RuntimeError.

```python
from pysapgui.sapexistedsession import SAPExistedSession

# Attach to existing session by connection number
try:
    sap_session = SAPExistedSession.get_session_by_number(session_num=0)
    print("Attached to existing SAP session")
except RuntimeError as e:
    print(f"Failed to attach: {e}")

# Get session with detailed system information
try:
    sap_session, session_info = SAPExistedSession.get_sap_session_with_info(session_num=0)
    print(f"System ID: {session_info['sid']}")
    print(f"Client: {session_info['client']}")
    print(f"User: {session_info['user']}")
    print(f"Application Server: {session_info['app_server']}")
except RuntimeError as e:
    print(f"Error retrieving session info: {e}")

# Get all active sessions (unique SID only)
sessions = SAPExistedSession.get_multi_sap_session_with_info(unique_sid=True)
for session, info in sessions:
    print(f"Found session: {info['sid']} - {info['user']}")

# Get total number of active connections
connection_count = SAPExistedSession.get_session_count()
print(f"Total active connections: {connection_count}")

# Close a session
SAPExistedSession.close_session(sap_session)
```

--------------------------------

### Work with SAP GUI Grids

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This section covers operations related to SAP GUI grid controls, including getting the number of rows and retrieving cell values. It uses `get_grid_rows_number` and `get_value_from_grid` from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# row_count = SAPGuiElements.get_grid_rows_number(sap_session, "wnd[0]/usr/cntlGRID/shellcont/shell")
# cell_value = SAPGuiElements.get_value_from_grid(sap_session, "wnd[0]/usr/cntlGRID/shellcont/shell", 0, 0)
```

--------------------------------

### SAP GUI Scroll Operations

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet demonstrates how to get and set the scroll position of elements in SAP GUI. It uses `get_scroll_position`, `get_max_scroll_position`, and `set_scroll_position` from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# current_pos = SAPGuiElements.get_scroll_position(sap_session, "wnd[0]/usr")
# max_pos = SAPGuiElements.get_max_scroll_position(sap_session, "wnd[0]/usr")
# SAPGuiElements.set_scroll_position(sap_session, 10, "wnd[0]/usr")
```

--------------------------------

### Get SAP GUI Grid Row Count and Data in Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

Demonstrates how to retrieve the total number of rows from a SAP GUI grid, access specific cell values, iterate through all rows, and access the list of columns. This is useful for data extraction and validation within SAP GUI tables.

```python
# Get row count
total_rows = grid.get_row_count()
print(f"Grid contains {total_rows} rows")

# Get specific cell value (0-indexed)
cell_value = grid.get_cell(row=0, column=0)
print(f"First cell value: {cell_value}")

# Iterate over all rows (auto-scrolls for large grids)
all_data = []
for row_data in grid:
    all_data.append(row_data)
    print(f"Row: {row_data}")

# Access columns list
print(f"Grid columns: {grid.columns}")
```

--------------------------------

### Get Active SAP GUI Window Identifier

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This function retrieves the identifier of the currently active window in the SAP GUI session. It uses the `get_active_window` function from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# active_window = SAPGuiElements.get_active_window(sap_session)
# print(f"Active window: {active_window}")
```

--------------------------------

### Get Status Bar Messages in SAP GUI

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This function retrieves messages from the SAP GUI status bar. It returns a tuple containing the message type, message number, and message text. Uses `get_status_message` from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# status = SAPGuiElements.get_status_message(sap_session)
# if status:
#     msg_type, msg_num, msg_text = status
#     print(f"Status [{msg_type}] {msg_num}: {msg_text}")
```

--------------------------------

### Retrieve SAP System Software Components and Kernel Info in Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

Explains how to use the SAPSoftwareComponents class to fetch system software component details and kernel information from an active SAP GUI session. This is useful for system auditing, version checking, and troubleshooting.

```python
from pysapgui.software_components import SAPSoftwareComponents
from pysapgui.sapexistedsession import SAPExistedSession

# Get session
sap_session = SAPExistedSession.get_session_by_number(0)

# Load software components list
components = SAPSoftwareComponents.load_software_components(sap_session)
for component in components:
    print(f"Component: {component}")

# Load SAP kernel information
kernel_info = SAPSoftwareComponents.load_sap_core_info(sap_session)
print(f"Kernel Version: {kernel_info['krnl_version']}")
print(f"Kernel Patch Level: {kernel_info['krnl_patch_level']}")
```

--------------------------------

### Create New SAP Sessions with Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

The SAPNewSession class facilitates creating new SAP system connections, including logging in with credentials and handling password change prompts. It utilizes the SAPLogonINI class to configure INI file paths for connection details. Dependencies include the pysapgui library and correctly configured SAPLogonINI paths.

```python
from pysapgui.sapnewsession import SAPNewSession
from pysapgui.saplogonini import SAPLogonINI

# Configure SAP Logon INI file paths
SAPLogonINI.set_ini_files(
    r"C:\\Users\\Public\\SAP\\Common\\saplogon.ini",
    r"C:\\Users\\username\\AppData\\Roaming\\SAP\\Common\\saplogon.ini"
)

# Create a new session to SAP system by SID
try:
    result = SAPNewSession.create_new_session(
        sid="PRD",                    # SAP System ID
        user="SAPUSER",               # Username
        pwd="SecurePassword123",      # Password
        client="100",                 # Client number (optional)
        langu="EN",                   # Language (optional)
        close_conn=False,             # Keep session open
        change_pwd=True               # Auto-change password if prompted
    )
    print("Successfully logged into SAP system")
except RuntimeError as e:
    print(f"Login failed: {e}")
except ValueError as e:
    print(f"Connection not found: {e}")
```

--------------------------------

### SAP Logon Configuration Resolution in Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

Utilizes the SAPLogonINI class to read and parse SAP Logon configuration files (saplogon.ini). This allows for resolving System IDs (SIDs) to their corresponding connection descriptions, supporting retrieval of the first match or all matching connections.

```python
from pysapgui.saplogonini import SAPLogonINI

# Configure INI file paths (can specify multiple files)
SAPLogonINI.set_ini_files(
    r"C:\\Users\\Public\\SAP\\Common\\saplogon.ini",
    r"C:\\ProgramData\\SAP\\SAPLogon\\saplogon.ini",
    r"C:\\Users\\username\\AppData\\Roaming\\SAP\\Common\\saplogon.ini"
)

# Get connection name by System ID
try:
    # Get first matching connection
    connection_name = SAPLogonINI.get_connect_name_by_sid("PRD", first=True)
    print(f"Connection name for PRD: {connection_name}")

    # Get all matching connections
    all_connections = SAPLogonINI.get_connect_name_by_sid("DEV", first=False)
    for conn in all_connections:
        print(f"Found connection: {conn}")
except ValueError as e:
    print(f"SID not found: {e}")
except RuntimeError as e:
    print(f"Configuration error: {e}")
```

--------------------------------

### Iterate SAP GUI Elements by Template

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet shows how to iterate over SAP GUI elements using a template pattern, allowing for dynamic selection and processing of elements based on a pattern and index range. Uses `iter_elements_by_template` from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# for index, element in SAPGuiElements.iter_elements_by_template(
#     sap_session, "wnd[0]/usr", "wnd[0]/usr/txt[{0}]", start_index=0, max_index=10
# ):
#     print(f"Element {index}: {element.text}")
```

--------------------------------

### Connect to SAP GUI Application using Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

The SAPGuiApplication class connects to a running SAP Logon application via the Windows COM interface, returning a scripting engine object for programmatic SAP GUI access. It requires the SAP Logon application to be running and accessible.

```python
from pysapgui.sapgui import SAPGuiApplication

# Connect to running SAP Logon application
try:
    sap_application = SAPGuiApplication.connect()
    if sap_application:
        print("Successfully connected to SAP GUI Scripting Engine")
        # Access connection count
        connection_count = sap_application.Children.count
        print(f"Active connections: {connection_count}")
except RuntimeError as e:
    print(f"Error: SAP Logon is not running - {e}")
```

--------------------------------

### Call Menu Items in SAP GUI

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet demonstrates how to programmatically call menu items in SAP GUI, supporting multi-language menus. It uses the `call_menu` function from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# SAPGuiElements.call_menu(sap_session, ["System", "Status..."])
```

--------------------------------

### SAP Password Management with pysapgui

Source: https://context7.com/gutskodv/pysapgui/llms.txt

Shows how to configure and manage SAP passwords using the SAPLogonPwd class. It covers setting password policies (length, digits, letters, case, special characters) and generating compliant passwords, as well as changing passwords via the SU3 transaction in an existing SAP session.

```python
from pysapgui.saplogonpwd import SAPLogonPwd, MIN_PASSWORD_LNG, MIN_PASSWORD_DIGITS
from pysapgui.saplogonpwd import MIN_PASSWORD_LETTERS, MIN_PASSWORD_UPPERCASE
from pysapgui.saplogonpwd import MIN_PASSWORD_LOWERCASE, MIN_PASSWORD_SPECIALS
from pysapgui.sapexistedsession import SAPExistedSession

# Configure password policy
password_policy = {
    MIN_PASSWORD_LNG: 8,           # Minimum length
    MIN_PASSWORD_DIGITS: 2,        # Minimum digits
    MIN_PASSWORD_LETTERS: 4,       # Minimum letters total
    MIN_PASSWORD_UPPERCASE: 1,     # Minimum uppercase letters
    MIN_PASSWORD_LOWERCASE: 1,     # Minimum lowercase letters
    MIN_PASSWORD_SPECIALS: 1       # Minimum special characters
}
SAPLogonPwd.set_password_policy(password_policy)

# Generate compliant password
new_password = SAPLogonPwd.gen_password()
print(f"Generated password: {new_password}")

# Change password using SU3 transaction
sap_session = SAPExistedSession.get_session_by_number(0)
try:
    new_pwd = SAPLogonPwd.change_password_su3(sap_session, old_pwd="CurrentPassword123")
    print(f"Password changed successfully. New password: {new_pwd}")
except RuntimeError as e:
    print(f"Password change failed: {e}")
except AttributeError as e:
    print(f"GUI element error: {e}")
```

--------------------------------

### Data Browser (SE16) Operations with Filters and Export

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet details how to use the `TCodeSE16` class to interact with the SE16 Data Browser. It covers creating field filters, applying them to query tables, counting records, and exporting table content to a file.

```python
from pysapgui.transaction_se16 import TCodeSE16, FieldFilters, FieldFilter
from pysapgui.sapexistedsession import SAPExistedSession

# Get session
sap_session = SAPExistedSession.get_session_by_number(0)

# Create SE16 instance for a table
se16 = TCodeSE16(table_name="USR02", sap_session=sap_session)

# Create filters for querying
filters = FieldFilters()

# Add field filter with equal values
user_filter = FieldFilter("BNAME")
user_filter.set_equal_values(["ADMIN", "SAPUSER", "TESTUSER"])
filters.add_filter(user_filter)

# Add field filter with exclude values
lock_filter = FieldFilter("UFLAG")
lock_filter.set_exclude_values(["64", "128"])
filters.add_filter(lock_filter)

# Alternatively, initialize filters from dictionary
filter_config = [
    {"field_name": "BNAME", "equal_values": ["ADMIN", "SAPUSER"]},
    {"field_name": "UFLAG", "exclude_values": ["64"]}
]
filters.init_filter_by_dict(filter_config)

# Get record count with filters
try:
    row_count = se16.get_row_number_by_filter(sap_session, table_filter=filters)
    print(f"Found {row_count} records matching filter criteria")
except ValueError as e:
    print(f"Table error: {e}")
except PermissionError as e:
    print(f"Authorization error: {e}")

# Export table content to file
try:
    se16.save_table_content(
        filepath=r"C:\\exports",
        filename="usr02_export.txt",
        sap_session=sap_session
    )
    print("Table exported successfully")
except ValueError as e:
    print(f"Export error: {e}")
```

--------------------------------

### Send Keyboard Keys in SAP GUI

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet demonstrates how to send various keyboard keys, including special keys and key combinations, to the SAP GUI session. It utilizes the `press_keyboard_keys` function from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# SAPGuiElements.press_keyboard_keys(sap_session, "Enter")
# SAPGuiElements.press_keyboard_keys(sap_session, "F8")
# SAPGuiElements.press_keyboard_keys(sap_session, "Shift+F3")  # Back
```

--------------------------------

### Manipulate SAP GUI Elements using Python

Source: https://context7.com/gutskodv/pysapgui/llms.txt

The SAPGuiElements class offers static methods for interacting with various SAP GUI elements, including setting text in input fields, retrieving text from elements, and pressing buttons. It requires an active SAP session object obtained through other PySapGUI classes. This class is essential for automating user input and actions within SAP.

```python
from pysapgui.sapguielements import SAPGuiElements
from pysapgui.sapexistedsession import SAPExistedSession

# Get an existing session
sap_session = SAPExistedSession.get_session_by_number(0)

# Set text in input fields
SAPGuiElements.set_text(sap_session, "wnd[0]/usr/txtRSYST-BNAME", "USERNAME")
SAPGuiElements.set_text(sap_session, "wnd[0]/usr/pwdRSYST-BCODE", "PASSWORD")

# Get text from GUI elements
label_text = SAPGuiElements.get_text(sap_session, "wnd[0]/usr/lblSOME_LABEL")
print(f"Label value: {label_text}")

# Press buttons
SAPGuiElements.press_button(sap_session, "wnd[0]/tbar[0]/btn[0]")
```

--------------------------------

### Select Elements in SAP GUI

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This function allows for selecting specific elements within the SAP GUI, such as radio buttons or tabs, by providing their UI path. It uses the `select_element` function from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# SAPGuiElements.select_element(sap_session, "wnd[0]/usr/radRADIO_OPTION1")
```

--------------------------------

### Execute SAP Transactions with Error Handling

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This section demonstrates how to execute SAP transaction codes (T-codes) programmatically using the `SAPTransaction` class. It includes automatic error handling for invalid transactions and authorization issues.

```python
from pysapgui.transaction import SAPTransaction
from pysapgui.sapexistedsession import SAPExistedSession

# Get session
sap_session = SAPExistedSession.get_session_by_number(0)

# Execute transaction with error checking
try:
    SAPTransaction.call(sap_session, "SE16")  # Open SE16 - Data Browser
    print("Transaction SE16 executed successfully")
except ValueError as e:
    print(f"Invalid transaction: {e}")
except PermissionError as e:
    print(f"Authorization error: {e}")

# Execute transaction without error checking
SAPTransaction.call(sap_session, "SM37", check_error=False)

# Exit current transaction (return to main menu)
SAPTransaction.exit_transaction(sap_session)
```

--------------------------------

### Set Checkbox State in SAP GUI

Source: https://context7.com/gutskodv/pysapgui/llms.txt

This snippet shows how to set the state of a checkbox in SAP GUI. It requires the UI path to the checkbox and uses the `set_checkbox` function from `SAPGuiElements`.

```python
from pysapgui import SAPGuiElements

# Assuming sap_session is an active SAP GUI session object
# SAPGuiElements.set_checkbox(sap_session, "wnd[0]/usr/chkCHECKBOX_FIELD")
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.