This is UltimateRPA Documentation
urpa.py File Reference

Classes

class  urpa.ElementNotFoundError
 Exception raised when the required GUI element could not be found. More...
 
class  urpa.Config
 
class  urpa.App
 A class representing a general application. More...
 
class  urpa.AppElement
 This class represents the GUI element in an application. More...
 
class  urpa.VisualElement
 This class represents a visual GUI element in an application. More...
 
class  urpa.AppJavaElement
 
class  urpa.JavaCondition
 This class is used to define conditions for GUI element searches. More...
 
class  urpa.TransformationFactory
 An auxiliary class that defines how images are to be transformed. More...
 
class  urpa.Transformation
 An auxiliary class that defines how images are to be transformed. More...
 
class  urpa.ConditionFactory
 This class is used to create an instance of a Condition-type object and to define the conditions for searching for GUI elements in this instance of the object. More...
 
class  urpa.Condition
 This class is used to define conditions for GUI element searches. More...
 
class  urpa.AppExcel
 A class representing MS Excel. More...
 
class  urpa.ExcelWorkbook
 This class represents a workbook in MS Excel. More...
 
class  urpa.ExcelWorksheet
 This class represents one sheet in an MS Excel workbook. More...
 
class  urpa.ExcelCells
 This method represents one cell, one row, a column or a block of cells in an MS Excel workbook sheet. More...
 
class  urpa.AppIE
 This class is used to manage the Internet Explorer browser window. More...
 

Namespaces

 urpa
 The urpa module can be used for process automation.
 

Functions

def urpa.set_password (system, user, password)
 The "Windows Credential Vault", separate for each user profile, is used to store login details. More...
 
def urpa.get_password (system, user)
 The "Windows Credential Vault", separate for each user profile, is used to store login details. More...
 
def urpa.set_debug_mode (debug_mode, sleep_time=None)
 If enabled, it highlights the elements found and also waits for a certain time after an element has been found. More...
 
def urpa.set_default_timeout (timeout)
 Defines the default timeout for all element searches. More...
 
def urpa.set_default_text_action (type, char_delay=None, decomposition_delay=None)
 Defines the default text action type and, optionally, the inter-character delay while simulating the text typing. More...
 
def urpa.set_default_mouse_action (type)
 This method defines the default mouse action type. More...
 
def urpa.set_default_focus_action (type)
 Sets the default action type for invoking AppElement.set_focus. More...
 
def urpa.set_default_key_action (type)
 Sets the default action type for send_key. More...
 
def urpa.set_default_keyboard_layout (kl)
 Sets the default keyboard layout for word processing. More...
 
def urpa.set_default_search_method (method)
 Sets the default search type for methods find_first, find_all. More...
 
def urpa.condition_factory ()
 Auxiliary class for entering more complex search conditions, see ConditionFactory. More...
 
def urpa.transformation_factory ()
 An auxiliary class that defines how images are to be transformed viz TransformationFactory. More...
 
def urpa.exec_app (cmd_line, show_window=None)
 Runs a general application, see the App class. More...
 
def urpa.exec_excel_app (filename=None)
 Runs Excel. More...
 
def urpa.exec_ie_app (url=None)
 Runs Internet Explorer and goes to the URL passed. More...
 
def urpa.open_app (pid)
 Opens the application with the process ID (PID) entered. More...
 
def urpa.find_first_app (name, timeout=default_timeout)
 Finds the running application according to the name parameter passed. More...
 
def urpa.find_first_excel_app (timeout=default_timeout)
 Finds the already running Excel application. More...
 
def urpa.find_first_ie_app ()
 Finds already running Internet Explorer application. More...
 
def urpa.bring_to_foreground (foreground=True)
 Switches the simulation to the foreground/background. More...
 
def urpa.default_error_processing ()
 Executes default exception processing: i.e. More...
 
def urpa.check_screen_resolution (width, height, bits_per_pixel=None)
 Executes a resolution and color depth check. More...
 
def urpa.set_screen_resolution (width, height, bits_per_pixel=None)
 Sets resolution and color depth of default display device. More...
 
def urpa.set_clipboard_text (text)
 Inserts the text passed into the Windows clipboard. More...
 
def urpa.clipboard_text ()
 Returns text stored in the Windows clipboard. More...
 
def urpa.write_sydesk_measure (directory, source_id, value, expiration, description=None)
 It writes measurements in msr6 format to the directory passed. More...
 
def urpa.write_measure (name, status, value=None, unit=None, tolerance=0, description=None, precision=None, id=None)
 It writes measurements to the directory passed. More...
 
def urpa.take_screenshot ()
 

Variables

int urpa.default_timeout = 5000
 Default timeout for all searches, see set_default_timeout. More...
 
string urpa.default_kl = "00000409"
 
string urpa.default_text_action = "WM_CHAR"
 
int urpa.default_char_delay = 50
 
int urpa.default_decomposition_delay = 20
 
string urpa.default_key_action = "Hardware"
 
string urpa.default_mouse_action = "HW Left"
 
string urpa.default_focus_action = "Default"
 
 urpa.default = Config()