-
4. How to start¶
+
+- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/Robot/02_Defs.html b/Wiki/ENG_Guide/html/Robot/02_Defs.html
index bacdf032..728ab150 100644
--- a/Wiki/ENG_Guide/html/Robot/02_Defs.html
+++ b/Wiki/ENG_Guide/html/Robot/02_Defs.html
@@ -102,7 +102,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/Studio/Studio.html b/Wiki/ENG_Guide/html/Studio/Studio.html
index 0e0a1a58..e52f93c5 100644
--- a/Wiki/ENG_Guide/html/Studio/Studio.html
+++ b/Wiki/ENG_Guide/html/Studio/Studio.html
@@ -98,7 +98,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/_modules/index.html b/Wiki/ENG_Guide/html/_modules/index.html
index eb5b9f2f..4418e919 100644
--- a/Wiki/ENG_Guide/html/_modules/index.html
+++ b/Wiki/ENG_Guide/html/_modules/index.html
@@ -96,7 +96,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html
index 92ccbe04..8c9f1ee6 100644
--- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html
+++ b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html
@@ -96,7 +96,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
@@ -196,16 +196,11 @@
"""
Add activity in AgentDict. Check if item is created
- .. code-block:: python
-
- # USAGE
- import this
-
:param inGSettings: Global settings dict (singleton)
:param inHostNameStr: Agent host name
:param inUserStr: User login, where agent is based
:param inActivityItemDict: ActivityItem
- :return: sad
+ :return: None
"""
lAgentDictItemKeyTurple = (inHostNameStr.upper(),inUserStr.upper())
if lAgentDictItemKeyTurple not in inGSettings["AgentDict"]:
@@ -216,9 +211,7 @@
4. How to start process¶
Start configuration example
import psutil, datetime, logging, os, sys # stdout from logging
diff --git a/Wiki/ENG_Guide/html/Robot/01_Robot.html b/Wiki/ENG_Guide/html/Robot/01_Robot.html
index bd0c15de..2e1da439 100644
--- a/Wiki/ENG_Guide/html/Robot/01_Robot.html
+++ b/Wiki/ENG_Guide/html/Robot/01_Robot.html
@@ -101,7 +101,7 @@
[docs]def AgentOSCMD(inGSettings, inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True):
"""
- Send CMD to OS throught the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection
- def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings=None):
- Send to agent activity item to OSCMD
+ Send CMD to OS thought the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection
:param inGSettings: Global settings dict (singleton)
:param inHostNameStr:
@@ -238,9 +231,7 @@
[docs]def AgentOSFileBinaryDataBytesCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataBytes):
"""
- pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmition)
- def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
- Send binary file to Agent (Bytes)
+ Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition)
:param inGSettings: Global settings dict (singleton)
:param inHostNameStr:
@@ -263,9 +254,7 @@
[docs]def AgentOSFileBinaryDataBase64StrCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str):
"""
- pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmission)
- def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
- Send binary file to Agent (base64 string)
+ Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)
:param inGSettings: Global settings dict (singleton)
:param inHostNameStr:
@@ -287,9 +276,7 @@
# Send text file to Agent (string)
[docs]def AgentOSFileTextDataStrCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataStr, inEncodingStr = "utf-8"):
"""
- pyOpenRPA.Agent: Create text file by the string
- def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = "utf-8",inGSettings = None):
- Create Activity Item for the agent
+ Create text file by the string by the pyOpenRPA.Agent daemon process
:param inGSettings: Global settings dict (singleton)
:param inHostNameStr:
@@ -1250,7 +1237,7 @@
# Return list if dublicates
[docs]def RDPSessionDublicatesResolve(inGSettings):
"""
- DEVELOPING Search dublicates in GSettings RDPlist
+ DEVELOPING Search duplicates in GSettings RDPlist
!def is developing!
:param inGSettings: Global settings dict (singleton)
@@ -1262,19 +1249,34 @@
[docs]def RDPSessionConnect(inGSettings, inRDPSessionKeyStr, inRDPTemplateDict=None, inHostStr=None, inPortStr=None, inLoginStr=None, inPasswordStr=None):
"""
- Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if key is exists
+ Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists
2 way of the use
- Var 1: inGSettings, inRDPSessionKeyStr, inRDPTemplateDict
- Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inPortStr, inLoginStr, inPasswordStr
+ Var 1 (Main stream): inGSettings, inRDPSessionKeyStr, inRDPTemplateDict
+ Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inPortStr, inLoginStr, inPasswordStr
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lRDPItemDict = Orchestrator.RDPTemplateCreate(
+ inLoginStr = "USER_99",
+ inPasswordStr = "USER_PASS_HERE", inHostStr="127.0.0.1", inPortInt = 3389, inWidthPXInt = 1680,
+ inHeightPXInt = 1050, inUseBothMonitorBool = False, inDepthBitInt = 32, inSharedDriveList=None)
+ Orchestrator.RDPSessionConnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inRDPTemplateDict = lRDPItemDict)
+ # Orchestrator will create RDP session by the lRDPItemDict configuration
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inRDPTemplateDict:
- :param inHostStr:
- :param inPortStr:
- :param inLoginStr:
- :param inPasswordStr:
- :return: True every time
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inRDPTemplateDict: RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)
+ :param inHostStr: Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
+ :param inPortStr: Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
+ :param inLoginStr: Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
+ :param inPasswordStr: Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
+ :return: True every time :)
"""
# Check thread
if not Core.IsProcessorThread(inGSettings=inGSettings):
@@ -1306,11 +1308,25 @@
[docs]def RDPSessionDisconnect(inGSettings, inRDPSessionKeyStr, inBreakTriggerProcessWOExeList = None):
"""
- Disconnect the RDP session
+ Disconnect the RDP session and stop monitoring it.
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ Orchestrator.RDPSessionDisconnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey")
+ # Orchestrator will disconnect RDP session and will stop to monitoring current RDP
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inBreakTriggerProcessWOExeList:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inBreakTriggerProcessWOExeList: List of the processes, which will stop the execution. Example ["notepad"]
+
+ .. note::
+
+ Orchestrator look processes on the current machine
:return: True every time
"""
if inBreakTriggerProcessWOExeList is None: inBreakTriggerProcessWOExeList = []
@@ -1339,11 +1355,26 @@
[docs]def RDPSessionReconnect(inGSettings, inRDPSessionKeyStr, inRDPTemplateDict=None):
"""
- RDP Session reconnect
+ Reconnect the RDP session
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lRDPItemDict = Orchestrator.RDPTemplateCreate(
+ inLoginStr = "USER_99",
+ inPasswordStr = "USER_PASS_HERE", inHostStr="127.0.0.1", inPortInt = 3389, inWidthPXInt = 1680,
+ inHeightPXInt = 1050, inUseBothMonitorBool = False, inDepthBitInt = 32, inSharedDriveList=None)
+ Orchestrator.RDPSessionReconnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inRDPTemplateDict = inRDPTemplateDict)
+ # Orchestrator will reconnect RDP session and will continue to monitoring current RDP
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inRDPTemplateDict:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inRDPTemplateDict: RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)
:return:
"""
# Check thread
@@ -1359,7 +1390,7 @@
inGSettings["ProcessorDict"]["ActivityList"].append(lResult)
else:
lRDPConfigurationItem = inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr]
- RDPSessionDisconnect(inRDPSessionKeyStr=inRDPSessionKeyStr) # Disconnect the RDP
+ RDPSessionDisconnect(inGSettings = inGSettings, inRDPSessionKeyStr=inRDPSessionKeyStr) # Disconnect the RDP 2021 02 22 minor fix by Ivan Maslov
# Replace Configuration item if inRDPTemplateDict exists
if inRDPTemplateDict is not None: lRDPConfigurationItem=inRDPTemplateDict
# Add item in RDPList
@@ -1370,11 +1401,21 @@
[docs]def RDPSessionMonitorStop(inGSettings, inRDPSessionKeyStr):
"""
- Stop track the RDP session. Current def dont kill RDP session - only stop to track it (it can give )
+ Stop monitoring the RDP session by the Orchestrator process. Current def don't kill RDP session - only stop to track it (it can give )
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ Orchestrator.RDPSessionMonitorStop(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey")
+ # Orchestrator will stop the RDP monitoring
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :return:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :return: True every time :>
"""
lResult = True
inGSettings["RobotRDPActive"]["RDPList"].pop(inRDPSessionKeyStr,None) # Remove item from RDPList
@@ -1382,11 +1423,22 @@
[docs]def RDPSessionLogoff(inGSettings, inRDPSessionKeyStr, inBreakTriggerProcessWOExeList = None):
"""
- Logoff the RDP session
+ Logoff the RDP session from the Orchestrator process (close all apps in session when logoff)
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ Orchestrator.RDPSessionLogoff(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inBreakTriggerProcessWOExeList = ['Notepad'])
+ # Orchestrator will logoff the RDP session
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inBreakTriggerProcessWOExeList:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inBreakTriggerProcessWOExeList: List of the processes, which will stop the execution. Example ["notepad"]
:return: True - logoff is successful
"""
if inBreakTriggerProcessWOExeList is None: inBreakTriggerProcessWOExeList = []
@@ -1418,10 +1470,10 @@
[docs]def RDPSessionResponsibilityCheck(inGSettings, inRDPSessionKeyStr):
"""
- Check RDP Session responsibility TODO NEED DEV + TEST
+ DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
:return: True every time
"""
# Check thread
@@ -1461,28 +1513,41 @@
[docs]def RDPSessionProcessStartIfNotRunning(inGSettings, inRDPSessionKeyStr, inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPathBool=True):
"""
- Start process if it is not running
+ Start process in RDP if it is not running (check by the arg inProcessNameWEXEStr)
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ Orchestrator.RDPSessionProcessStartIfNotRunning(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inProcessNameWEXEStr = 'Notepad.exe',
+ inFilePathStr = "path\\to\the\\executable\\file.exe"
+ inFlagGetAbsPathBool = True)
+ # Orchestrator will start the process in RDP session
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inProcessNameWEXEStr:
- :param inFilePathStr:
- :param inFlagGetAbsPathBool:
- :return:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inProcessNameWEXEStr: Process name with extension (.exe). This arg allow to check the process is running. Example: "Notepad.exe"
+ :param inFilePathStr: Path to run process if it is not running.
+ :param inFlagGetAbsPathBool: True - get abs path from the relative path in inFilePathStr. False - else case
+ :return: True every time :)
"""
# Check thread
+ lResult = True
if not Core.IsProcessorThread(inGSettings=inGSettings):
if inGSettings["Logger"]: inGSettings["Logger"].warning(f"RDP def was called not from processor queue - activity will be append in the processor queue.")
- lResult = {
+ lActivityItem = {
"Def": RDPSessionProcessStartIfNotRunning, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
"ArgList": [], # Args list
"ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inProcessNameWEXEStr": inProcessNameWEXEStr, "inFilePathStr": inFilePathStr, "inFlagGetAbsPathBool": inFlagGetAbsPathBool }, # Args dictionary
"ArgGSettings": "inGSettings", # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
"ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
}
- inGSettings["ProcessorDict"]["ActivityList"].append(lResult)
+ inGSettings["ProcessorDict"]["ActivityList"].append(lActivityItem)
else:
- lResult = True
lCMDStr = CMDStr.ProcessStartIfNotRunning(inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPath= inFlagGetAbsPathBool)
# Calculate the session Hex
lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
@@ -1494,14 +1559,25 @@
[docs]def RDPSessionCMDRun(inGSettings, inRDPSessionKeyStr, inCMDStr, inModeStr="CROSSCHECK"):
"""
- Send command in RDP session
+ Send CMD command to the RDP session "RUN" window
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lResultDict = Orchestrator.RDPSessionCMDRun(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inModeStr = 'LISTEN')
+ # Orchestrator will send CMD to RDP and return the result (see return section)
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inCMDStr:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inCMDStr: Any CMD string
:param inModeStr: Variants:
"LISTEN" - Get result of the cmd command in result;
- "CROSSCHECK" - Check if the command was successufully sent
+ "CROSSCHECK" - Check if the command was successfully sent
"RUN" - Run without crosscheck and get clipboard
:return: # OLD > True - CMD was executed successfully
{
@@ -1536,13 +1612,25 @@
[docs]def RDPSessionProcessStop(inGSettings, inRDPSessionKeyStr, inProcessNameWEXEStr, inFlagForceCloseBool):
"""
- Create CMD str to stop process
+ Send CMD command to the RDP session "RUN" window.
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lResultDict = Orchestrator.RDPSessionProcessStop(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inProcessNameWEXEStr = 'notepad.exe',
+ inFlagForceCloseBool = True)
+ # Orchestrator will send CMD to RDP and return the result (see return section)
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inProcessNameWEXEStr:
- :param inFlagForceCloseBool:
- :return:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inProcessNameWEXEStr: Process name to kill. Example: 'notepad.exe'
+ :param inFlagForceCloseBool: True - force close the process. False - safe close the process
+ :return: True every time
"""
# Check thread
if not Core.IsProcessorThread(inGSettings=inGSettings):
@@ -1569,13 +1657,25 @@
[docs]def RDPSessionFileStoredSend(inGSettings, inRDPSessionKeyStr, inHostFilePathStr, inRDPFilePathStr):
"""
- Send file from Host to Session RDP using shared drive in RDP
+ Send file from Orchestrator session to the RDP session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lResultDict = Orchestrator.RDPSessionFileStoredSend(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inHostFilePathStr = "TESTDIR\\Test.py",
+ inRDPFilePathStr = "C:\\RPA\\TESTDIR\\Test.py")
+ # Orchestrator will send CMD to RDP and return the result (see return section)
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inHostFilePathStr:
- :param inRDPFilePathStr:
- :return:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inHostFilePathStr: Relative or absolute path to the file location on the Orchestrator side. Example: "TESTDIR\\Test.py"
+ :param inRDPFilePathStr: !Absolute! path to the destination file location on the RDP side. Example: "C:\\RPA\\TESTDIR\\Test.py"
+ :return: True every time
"""
# Check thread
if not Core.IsProcessorThread(inGSettings=inGSettings):
@@ -1601,13 +1701,25 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/search.html b/Wiki/ENG_Guide/html/search.html
index e54d8fd8..300233b0 100644
--- a/Wiki/ENG_Guide/html/search.html
+++ b/Wiki/ENG_Guide/html/search.html
@@ -99,7 +99,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/searchindex.js b/Wiki/ENG_Guide/html/searchindex.js
index c539b27d..7051d1f2 100644
--- a/Wiki/ENG_Guide/html/searchindex.js
+++ b/Wiki/ENG_Guide/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["Orchestrator/01_Orchestrator","Orchestrator/02_Defs","Orchestrator/03_gSettingsTemplate","Orchestrator/04_HowToStart","Robot/01_Robot","Robot/02_Defs","Studio/Studio","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["Orchestrator\\01_Orchestrator.rst","Orchestrator\\02_Defs.rst","Orchestrator\\03_gSettingsTemplate.rst","Orchestrator\\04_HowToStart.rst","Robot\\01_Robot.rst","Robot\\02_Defs.rst","Studio\\Studio.rst","index.rst"],objects:{"pyOpenRPA.Orchestrator":{__Orchestrator__:[1,0,0,"-"]},"pyOpenRPA.Orchestrator.__Orchestrator__":{AgentActivityItemAdd:[1,1,1,""],AgentOSCMD:[1,1,1,""],AgentOSFileBinaryDataBase64StrCreate:[1,1,1,""],AgentOSFileBinaryDataBytesCreate:[1,1,1,""],AgentOSFileTextDataStrCreate:[1,1,1,""],GSettingsAutocleaner:[1,1,1,""],GSettingsKeyListValueAppend:[1,1,1,""],GSettingsKeyListValueGet:[1,1,1,""],GSettingsKeyListValueOperatorPlus:[1,1,1,""],GSettingsKeyListValueSet:[1,1,1,""],OSCMD:[1,1,1,""],OSCredentialsVerify:[1,1,1,""],OrchestratorRestart:[1,1,1,""],OrchestratorSessionSave:[1,1,1,""],ProcessIsStarted:[1,1,1,""],ProcessListGet:[1,1,1,""],ProcessStart:[1,1,1,""],ProcessStop:[1,1,1,""],ProcessorActivityItemAppend:[1,1,1,""],ProcessorActivityItemCreate:[1,1,1,""],ProcessorAliasDefCreate:[1,1,1,""],ProcessorAliasDefUpdate:[1,1,1,""],PythonStart:[1,1,1,""],RDPSessionCMDRun:[1,1,1,""],RDPSessionConnect:[1,1,1,""],RDPSessionDisconnect:[1,1,1,""],RDPSessionDublicatesResolve:[1,1,1,""],RDPSessionFileStoredRecieve:[1,1,1,""],RDPSessionFileStoredSend:[1,1,1,""],RDPSessionLogoff:[1,1,1,""],RDPSessionMonitorStop:[1,1,1,""],RDPSessionProcessStartIfNotRunning:[1,1,1,""],RDPSessionProcessStop:[1,1,1,""],RDPSessionReconnect:[1,1,1,""],RDPSessionResponsibilityCheck:[1,1,1,""],RDPTemplateCreate:[1,1,1,""],SchedulerActivityTimeAddWeekly:[1,1,1,""],UACKeyListCheck:[1,1,1,""],UACSuperTokenUpdate:[1,1,1,""],UACUpdate:[1,1,1,""],WebCPUpdate:[1,1,1,""],WebURLConnectDef:[1,1,1,""],WebURLConnectFile:[1,1,1,""],WebURLConnectFolder:[1,1,1,""],WebUserInfoGet:[1,1,1,""],WebUserIsSuperToken:[1,1,1,""],WebUserUACHierarchyGet:[1,1,1,""]},"pyOpenRPA.Robot":{UIDesktop:[5,0,0,"-"]},"pyOpenRPA.Robot.UIDesktop":{Get_OSBitnessInt:[5,1,1,""],PWASpecification_Get_PWAApplication:[5,1,1,""],PWASpecification_Get_UIO:[5,1,1,""],UIOSelectorSecs_WaitAppear_Bool:[5,1,1,""],UIOSelectorSecs_WaitDisappear_Bool:[5,1,1,""],UIOSelector_Exist_Bool:[5,1,1,""],UIOSelector_Get_BitnessInt:[5,1,1,""],UIOSelector_Get_BitnessStr:[5,1,1,""],UIOSelector_Get_UIO:[5,1,1,""],UIOSelector_Get_UIOList:[5,1,1,""],UIOSelector_SafeOtherGet_Process:[5,1,1,""],UIOSelector_SearchChildByMouse_UIO:[5,1,1,""],UIOSelector_SearchChildByMouse_UIOTree:[5,1,1,""],UIOSelectorsSecs_WaitAppear_List:[5,1,1,""],UIOSelectorsSecs_WaitDisappear_List:[5,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"0643":3,"100":2,"1050":[1,2],"120":2,"127":1,"1680":[1,2],"1680x1050":[1,2],"1992":3,"222":[0,2],"300":2,"3389":[1,2],"3600":2,"412":1,"600":2,"640x480":[1,2],"77767775":1,"77777sdfsdf77777dsfdfsf77777777":1,"8081":2,"\u0432":[4,5],"\u0432\u0445\u043e\u0434\u043d\u043e\u0439":[4,5],"\u0432\u044b\u043a\u0438\u043d\u0443\u0442\u044c":[4,5],"\u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0442\u044c":[4,5],"\u0434\u0435\u043c\u043e\u043d\u0430":2,"\u0434\u0435\u043c\u043e\u043d\u0443":2,"\u043a":[2,4,5],"\u043a\u043e\u043d\u043d\u0435\u043a\u0442":[4,5],"\u043a\u043e\u0442\u043e\u0440\u043e\u043c\u0443":2,"\u043b\u043e\u0433\u0433\u0435\u0440\u0430":2,"\u043b\u043e\u0433\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f":2,"\u043c\u043e\u0436\u043d\u043e":2,"\u043d\u0435":[4,5],"\u043e\u0431\u043d\u0430\u0440\u0443\u0436\u0435\u043d\u0438\u0438":[4,5],"\u043e\u0448\u0438\u0431\u043a\u0443":[4,5],"\u043f\u043e":2,"\u043f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430":2,"\u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0438\u0442\u044c\u0441\u044f":2,"\u043f\u043e\u043a\u0430\u0437\u0430\u0442\u0435\u043b\u044c":[4,5],"\u043f\u043e\u0440\u0442":2,"\u043f\u0440\u043e\u0446\u0435\u0441\u0441\u0443":[4,5],"\u043f\u0443\u0441\u0442\u043e\u0433\u043e":[4,5],"\u0440\u0430\u0441\u043f\u043e\u043b\u043e\u0436\u0435\u043d\u0438\u0435":2,"\u0441\u0435\u0440\u0432\u0435\u0440\u0430":2,"\u0441\u0435\u0442\u0435\u0432\u043e\u0435":2,"\u0441\u043b\u0443\u0447\u0430\u0435":[4,5],"\u0441\u043e\u0437\u0434\u0430\u0442\u044c":2,"\u0441\u043f\u0438\u0441\u043a\u0430":[4,5],"\u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f":[4,5],"\u0444\u0430\u0439\u043b":2,"\u0444\u043b\u0430\u0433":[4,5],"\u0447\u0442\u043e":[4,5],"\u044d\u043b\u0435\u043c\u0435\u043d\u0442":[4,5],"byte":1,"case":[0,1,2,4,5],"default":[1,2],"float":[0,2,4,5],"function":[1,2,5],"import":[0,1,2,3,5],"int":[0,1,4,5],"new":[0,1,2,3],"return":[1,2,4,5],"true":[1,2,3,4,5],"try":[1,3],"var":1,Abs:2,For:3,Has:2,The:0,USe:2,Use:[1,3],Will:[1,2],__agentdictitemcreate__:2,__create__:2,__main__:3,__name__:3,__orchestrator__:7,__uacclientadmincreate__:[2,3],_sessionlast_rdplist:1,a2o:1,about:[0,1,2],absolut:[1,2,3],abspath:3,access:[1,2,3],accessus:2,activ:[0,1,2,4,5],activitydict:2,activityitem:1,activityitemdict:1,activitylist:2,activitylistappendprocessorqueuebool:2,activitylistexecut:1,activitylistexecutebool:2,activitytimelist:2,actual:1,add:[1,2,3],addhandl:2,address:[1,2],admindict:[2,3],administr:1,after:[0,2,3],agent:1,agentactivityitemadd:1,agentdict:[1,2],agentkeydict:[2,3],agentkeystr:2,agentoscmd:1,agentosfilebinarydatabase64strcr:1,agentosfilebinarydatabytescr:1,agentosfiletextdatastrcr:1,algorithm:0,algorythm:[0,2],alia:[0,1,2],aliasdefdict:[0,1,2],all:[0,1,2,3,4,5],allow:[1,2,3],alreadi:1,ani:[0,1],anoth:1,app:[4,5],appear:[4,5],append:[0,1,2],appli:[0,2],applic:[0,1,2,4,5],architectur:7,archiv:2,arg:[0,1,2],argdict:[0,1,2],arggset:[0,1,2],arglist:[0,1,2],arglogg:[0,1,2],argument:[1,2],argvaluestr:1,asctim:2,associ:1,async:0,asynchonu:0,attent:[0,1,3],attribut:[0,2,4,5],authent:2,authentif:1,authtoken:2,authtokensdict:2,auto:1,autoclean:[0,2],automat:[0,2],automationsearchmouseel:[4,5],avail:[1,2],b4ff:3,backend:[4,5],backward:1,base64:1,base:[0,1],basic:[0,2,3],becaus:[0,1],been:[1,2],befor:2,beginwith:[1,2],below:[0,3],between:[0,1,2,3],binari:1,bit:[1,4,5],block:2,bool:[0,1,2],both:1,browser:2,build:3,busi:0,button:2,cach:2,call:[0,1,3,4,5],callabl:1,can:[0,1,2,4,5],cancel:[4,5],cant:0,central:0,chang:2,check:[1,2,3,4,5],checkintervalsecfloat:2,checktasknam:2,choos:[4,5],cleaner:1,clear:2,client:[1,2],clientrequesthandl:2,clipboard:1,close:[1,2],cmd:[1,2],cmdinputbool:[2,3],code:0,collect:2,comma:0,command:[1,2],commun:1,compat:1,compex:0,complet:2,complex:0,compon:7,concept:7,config:3,configur:[1,2,3,7],connect:[1,2],connectioncountint:2,connectionfirstqueueitemcountint:2,consist:0,consol:2,consolid:0,contain:[1,2],content:[1,2],control:[0,1,2,3],controlpanel:[2,3],controlpaneldict:2,controlpanelkeyallowedlist:2,controlpanelrefreshintervalsecfloat:2,cooki:2,core:0,cp_test:3,cp_versioncheck:3,cpdict:2,cpkei:2,cpkeydict:[2,3],cpkeystr:2,creat:[0,1,2,3],credenti:1,crosscheck:1,current:[0,1,2,3],custom:0,daemon:1,dai:1,data:2,datasetlast:2,datetim:[2,3],decentr:0,def:[0,2,3,4,7],defaliastest:[0,2],defnamestr:2,defsettingsupdatepathlist:2,del:3,deprec:2,depthbit:[1,2],descript:[2,5,7],desktop:[0,1,2,3],desktopus:1,destin:[4,5],detail:0,detect:[2,4,5],determin:1,dev:1,develop:1,dict:[1,2,4,5,7],dictionari:[0,2],differ:0,directori:1,disappear:[4,5],disc:1,disconnect:[1,2],document:[4,5],docutil:[1,5],doen:1,domain:2,domainadstr:2,domainupperstr:1,don:1,dont:[1,2],drive:[1,2],dsd:[0,2],dublic:1,dump:2,dumploglist:2,dumploglistcountint:2,dumploglisthashstr:2,dumploglistrefreshintervalsecfloat:2,durat:2,each:1,element:[4,5],els:[1,2,3,4,5],empti:2,encod:1,end:0,env:2,environ:1,equal:[1,2],equalcas:[1,2],everi:[1,2],everydai:1,exampl:[0,1,2,3,4,5],except:[1,3],exe:[1,2,5],execut:[0,1,2,6],executebool:2,exist:[1,2,4,5],expir:1,extra:1,fals:[1,2,4,5],featur:[0,1,2],field:[1,2],file:[1,2],filehandl:2,filemanag:2,filemod:2,fileurl:2,fileurlfilepathdict:2,fileurlfilepathdict_help:2,fill:[1,2],find:0,find_window:[4,5],flag:[1,2],flagaccess:2,flagaccessdefrequestglobalauthent:2,flagcredentialsask:2,flagdonotexpir:2,flagforc:2,flagsessionisact:[1,2],flaguseallmonitor:[1,2],flexibl:0,folder:[1,3],forc:[1,2],forget:2,formatt:2,fridai:1,from:[0,1,2,3,4,5],full:[1,2],fullscreen:[1,2],fullscreenbool:2,fullscreenrdpsessionkeystr:2,functional:3,gener:[1,2],get:[1,2,4,5],get_osbitnessint:[4,5],getcontrol:[4,5],getlogg:2,git:[1,2],give:[1,2],given:1,global:[1,7],goe:0,good:0,gset:[0,1,3,7],gsettingsautoclean:1,gsettingsdict:1,gsettingskeylistvalueappend:1,gsettingskeylistvalueget:1,gsettingskeylistvalueoperatorplu:1,gsettingskeylistvalueset:1,gui:[0,1,4,5],guid:2,gurbag:2,handl:2,handler:2,hard:[1,2],has:[0,1],have:1,height:[1,2],help:1,hex:[1,2],hierarchi:1,host:[1,2],hostnameupperstr:2,how:7,html:[1,5],htmlrenderdef:2,http:[0,1,2,5],human:1,ignor:[1,2],ignorebool:2,imaslov:3,inactivityitemdict:1,inactivitylist:1,inadisdefaultbool:[1,3],inadloginstr:[1,3],inadstr:[1,3],inaliasstr:1,inarg1str:1,inargdict:1,inarggset:1,inarggsettingsstr:1,inarglist:1,inargloggerstr:1,inbreaktriggerprocesswoexelist:1,incloseforcebool:1,includ:[4,5],incmdstr:1,incontenttypestr:1,incontrolspecificationarrai:[4,5],incpkeystr:1,indef:1,indefnamestr:1,indepthbitint:1,index:[0,1,2,4,5],indict:2,indomainstr:1,inel:[4,5],inelementspecif:[4,5],inencodingstr:1,infiledatabase64str:1,infiledatabyt:1,infiledatastr:1,infilepathstr:1,inflagforceclosebool:1,inflaggetabspathbool:1,inflagraiseexcept:[4,5],inflagwaitallinmo:[4,5],info:[1,2,3],infolderpathstr:1,inform:[0,1],ingset:[0,1,3],ingsettingsclientdict:2,inhashkeystr:2,inheightpxint:1,inhostfilepathstr:1,inhostnamestr:1,inhoststr:[1,2],inhtmlrenderdef:1,init:[0,1,2,3],initdatetim:2,initi:1,injsinitgeneratordef:1,injsongeneratordef:1,inkeylist:1,inkeystr:2,inlogg:[1,2],inloginstr:[1,2],inmatchtypestr:1,inmethodstr:1,inmodestr:[0,1,2,3],inmodulepathstr:1,inpasswordstr:[1,2],inpathstr:1,inportint:1,inportstr:[1,2],inprocessnamewexestr:1,inprocessnamewoexelist:1,inprocessnamewoexestr:1,input:2,inrdpfilepathstr:1,inrdpsessionkeystr:[1,2],inrdptemplatedict:1,inrequest:1,inrolehierarchyalloweddict:[1,3],inrolekeylist:1,inrowcountint:2,inrunasyncbool:1,insert:3,inshareddrivelist:1,inspecificationlist:[4,5],inspecificationlistlist:[4,5],instanc:[0,1,4,5],instopprocessnamewoexestr:1,insupertokenstr:[1,3],interact:0,interest:1,interfac:0,interpret:0,interv:[1,2],intervalsecfloat:2,intimehhmmstr:1,inuioselector:[4,5],inurllist:[1,3],inurlstr:1,inusebothmonitorbool:1,inusernamestr:1,inuserstr:1,invalu:1,inwaitsec:[4,5],inweekdaylist:1,inwidthpxint:1,islistenbool:2,isresponsiblebool:1,item:[0,1],iter:2,join:3,jsinitgeneratordef:2,json:[0,1,2],jsongeneratordef:2,keep:0,kei:1,keystr:2,kill:1,know:0,kwarg:0,lactivityitem:1,laliasstr:1,last:2,launch:1,left:0,len:2,levelnam:2,lifetim:2,lifetimerequestsecfloat:2,lifetimesecfloat:2,light:0,like:0,link:[0,1,2],list:[0,1,2,4,5],listen:1,listenport:2,listenport_:2,listenurllist:2,listread:2,load:2,local:[1,2],localhost:2,log:[1,2,3],logger:[1,2,3],loggerdumploghandleradd:2,loggerhandlerdumploglist:2,login:[1,2,3],logoff:[1,2],logviewerbool:[2,3],look:[0,1,2],lookmachinescreenshot:2,lowercas:2,lprocessisstartedbool:1,lprocesslist:1,lpyopenrpasourcefolderpathstr:3,lrdpitemdict:1,lrdptemplatedict:1,lresult:2,lresultdict:2,luacclientdict:3,machin:[1,2,3],machina:2,main:[0,2,3],makedir:2,mani:[0,4,5],matchtyp:2,max:2,mechan:0,mega:0,memori:1,merg:1,messag:2,method:2,methodmatchurl:2,methodmatchurlbeforelist:2,mhandlerdumploglist:2,mmstr:2,modul:[0,1,2,3],moduletocal:1,mondai:1,monitor:1,more:0,mrobotlogg:2,mrobotloggerfh:2,mrobotloggerformatt:2,must:2,name:[0,1,2,3,4,5],namewoexestr:1,namewoexeupperstr:1,need:[0,1,2],nest:1,net:[1,5],never:1,newkeydict:1,newkeylist:1,newvalu:1,none:[0,1,2,4,5],notat:[4,5],notepad:[1,2,4,5],noth:1,nothingbool:2,now:[1,2],object:[0,1,2,4,5],occupi:1,octet:1,off:2,old:[1,2,3,4,5],one:[2,3],onli:[1,2,4,5],openrpa52zzz:3,openrpa:2,openrparobotdaemon:2,oper:[1,3],option:2,orc:2,orchestr:[2,3,7],orchestratorrestart:1,orchestratorsessionsav:1,orchestratorstart:2,order:0,oscmd:1,oscredentialsverifi:1,osfilebinarydatabase64strcr:1,osfiletextdatastrcr:1,other:[4,5],out:1,output:2,outstr:1,overwrit:2,own:0,packag:[3,4],page:[1,2],pai:[0,3],panel:[1,2,3],paramet:[0,1,2,4,5],pass:[1,2],password:[1,2],path:[1,2,3],pdb:2,per:3,period:2,phone:0,pid:1,pipupgrad:2,pixel:[1,2],plan:1,plu:1,port:[1,2],post:[1,2],postfix:1,previou:1,print:3,process:[0,1,2,4,5,6],processdetaillist:1,processisstart:1,processlistget:1,processnam:1,processor:[1,2,7],processoractivityitemappend:1,processoractivityitemcr:1,processoraliasdefcr:1,processoraliasdefupd:1,processordict:2,processstart:[1,2],processstartifturnedoff:2,processstop:[1,2],processwoexelist:1,processwoexeupperlist:1,program:[1,2],project:0,protocol:0,psutil:3,pull:2,pwaspecification_get_pwaappl:[4,5],pwaspecification_get_uio:[4,5],pyopenrpa:[0,2,3,6],pyopenrpadict:[2,3],pyrobot_cp:3,python:[0,1,2,4],pythonstart:1,pywinauto:[4,5],queue:[0,1,2],queuelist:2,r01:2,r01_integrationorderout:2,r01_orchestratortorobot:2,rais:1,rdp:[0,1,2],rdpactiv:2,rdpconfigurationdict:2,rdpkeydict:[2,3],rdpkeystr:2,rdplist:[1,2],rdpsession:1,rdpsessioncmdrun:1,rdpsessionconnect:[1,2],rdpsessiondisconnect:[1,2],rdpsessiondublicatesresolv:1,rdpsessionfilereciev:2,rdpsessionfilesend:2,rdpsessionfilestoredreciev:1,rdpsessionfilestoredsend:1,rdpsessionkei:2,rdpsessionkeystr:2,rdpsessionlogoff:[1,2],rdpsessionmonitorstop:1,rdpsessionprocessstart:2,rdpsessionprocessstartifnotrun:1,rdpsessionprocessstop:1,rdpsessionreconnect:[1,2],rdpsessionresponsibilitycheck:1,rdptemplatecr:1,read:2,receiv:1,reciev:[1,2],reconnect:1,reconnectbool:2,reestr_otgruzok:2,refer:7,refresh:2,refreshsecond:2,regener:1,rel:[1,2,3],rememb:2,remot:[1,2],renderfunct:2,renderrobotr01:2,report:2,reqir:0,request:[1,2],requesttimeoutsecfloat:2,requir:1,resolut:[1,2],respons:[1,2],responsecontenttyp:2,responsedefrequestglob:2,responsefilepath:2,responsefolderpath:2,responsibilitycheckintervalsec:2,restart:[1,2],restartorchestr:2,restartorchestratorbool:[2,3],restartorchestratorgitpullbool:[2,3],restartpcbool:[2,3],restructuredtext:[1,5],result:[1,2,4,5],returnbool:2,robot:[0,1,2,3,7],robot_r01:2,robot_r01_help:2,robotlist:2,robotrdpact:[1,2],rolehierarchyalloweddict:2,root:[1,2],row:2,rpa:2,rst:[1,5],ruledomainuserdict:2,rulemethodmatchurlbeforelist:2,run:[1,2,3],sad:1,safe:[1,4,5],same:[4,5],save:1,schedul:[0,1],scheduleractivitytimeaddweekli:1,schedulerdict:2,scopesrcul:2,screen:[1,2],screenshot:2,screenshotviewerbool:[2,3],script:0,search:1,sec:2,second:[1,2,4,5],see:[1,2,3,4,5],select:[4,5],selector:[4,5],send:[1,2],sent:1,sequenc:0,server:[0,2],serverdict:2,serverset:2,sesion:[1,2],session:[1,2],sessionguidstr:2,sessionhex:[1,2],sessionisignoredbool:[1,2],sessioniswindowexistbool:[1,2],sessioniswindowresponsiblebool:[1,2],set:[1,2,3,4,5,7],set_trac:2,setformatt:2,setlevel:2,settingstempl:[0,3],settingsupd:3,setup:2,sever:0,share:1,shareddrivelist:[1,2],shell:1,should:2,show:2,side:[1,2],signal:1,singl:0,singleton:1,socket:0,some:[0,1,2],sort:1,sourc:[0,1,3,4,5],sourceforg:[1,5],space:0,special:2,sphinx:0,standart:2,start:[1,2,7],statu:1,stdout:[2,3],stop:1,storag:2,store:2,str:[0,1,2,4,5],stream:1,streamhandl:2,strftime:2,string:1,struct:2,structur:[0,1,2],studio:[0,6,7],success:1,successfulli:1,successufulli:1,sundai:1,supertoken:[1,3],superus:3,supetoken:1,support:[0,3],symbol:0,sync:0,sys:[2,3],tablet:0,technic:[0,2],technicalsessionguidcach:2,templat:[3,7],test2:2,test:[1,2,3],testcontrolpanelkei:2,testdef:1,testdefalia:1,testrdp:2,text:1,than:0,thi:[1,2],thread:[0,2],threadidint:2,throught:1,thursdai:1,time:[1,2],timehh:2,titl:[4,5],todo:1,token:1,tokendatetim:2,too:[1,2],tool:0,top:[4,5],track:1,transmiss:1,transmit:[0,1],trigger:[1,2],ttt:[0,2],turn:2,turpl:0,txt:1,type:[1,2,3],uac:1,uackeylistcheck:1,uacsupertokenupd:[1,3],uacupd:[1,3],uia:[4,5],uidesktop:[4,7],uio:[4,5],uioselector:[4,5],uioselector_exist_bool:[4,5],uioselector_get_bitnessint:[4,5],uioselector_get_bitnessstr:[4,5],uioselector_get_uio:[4,5],uioselector_get_uiolist:[4,5],uioselector_safeotherget_process:[4,5],uioselector_searchchildbymouse_uio:[4,5],uioselector_searchchildbymouse_uiotre:[4,5],uioselectorsecs_waitappear_bool:[4,5],uioselectorsecs_waitdisappear_bool:[4,5],uioselectorssecs_waitappear_list:[4,5],uioselectorssecs_waitdisappear_list:[4,5],univers:0,updat:[1,2],upper:2,url:[1,2],url_:2,urllist:2,usag:1,use:[0,1,2],used:1,user:[0,1,2,3],user_99:1,user_pass_her:1,useradstr:2,usernam:[1,2],usernameupperstr:1,userupperstr:2,using:1,utf:1,util:2,valu:[1,4,5],variant:1,verifi:1,version:3,versioncheck:3,versionstr:2,viewer:2,virtual:2,vms:1,wai:[1,3],wait:[4,5],want:[0,2],warn:3,web:[0,1,2],webcpupd:1,weburlconnectdef:1,weburlconnectfil:1,weburlconnectfold:1,webuserinfoget:1,webuserissupertoken:1,webuseruachierarchyget:1,wednesdai:1,week:1,weekdai:[1,2],weekdaylist:2,when:[0,1,2,3],where:1,which:[0,1,2,4,5],who:2,why:0,width:[1,2],win32:[4,5],win:1,window:[1,2],without:[1,2],work:[1,2],workingdirectorypathstr:2,wrapper:[4,5],write:0,xlsx:2,you:[0,1,2,4,5]},titles:["1. Description","2. Defs","3. gSettings Template","4. How to start","1. Description","2. Defs","Description","Welcome to pyOpenRPA\u2019s documentation!"],titleterms:{__orchestrator__:1,architectur:0,compon:0,concept:0,configur:0,def:[1,5],descript:[0,4,6],dict:0,document:7,global:0,gset:2,how:[0,3],orchestr:[0,1],processor:0,pyopenrpa:[1,4,5,7],refer:[0,1,5],robot:[4,5],set:0,start:3,templat:2,uidesktop:5,welcom:7}})
\ No newline at end of file
+Search.setIndex({docnames:["Orchestrator/01_Orchestrator","Orchestrator/02_Defs","Orchestrator/03_gSettingsTemplate","Orchestrator/04_HowToStart","Robot/01_Robot","Robot/02_Defs","Studio/Studio","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["Orchestrator\\01_Orchestrator.rst","Orchestrator\\02_Defs.rst","Orchestrator\\03_gSettingsTemplate.rst","Orchestrator\\04_HowToStart.rst","Robot\\01_Robot.rst","Robot\\02_Defs.rst","Studio\\Studio.rst","index.rst"],objects:{"pyOpenRPA.Orchestrator":{__Orchestrator__:[1,0,0,"-"]},"pyOpenRPA.Orchestrator.__Orchestrator__":{AgentActivityItemAdd:[1,1,1,""],AgentOSCMD:[1,1,1,""],AgentOSFileBinaryDataBase64StrCreate:[1,1,1,""],AgentOSFileBinaryDataBytesCreate:[1,1,1,""],AgentOSFileTextDataStrCreate:[1,1,1,""],GSettingsAutocleaner:[1,1,1,""],GSettingsKeyListValueAppend:[1,1,1,""],GSettingsKeyListValueGet:[1,1,1,""],GSettingsKeyListValueOperatorPlus:[1,1,1,""],GSettingsKeyListValueSet:[1,1,1,""],OSCMD:[1,1,1,""],OSCredentialsVerify:[1,1,1,""],OrchestratorRestart:[1,1,1,""],OrchestratorSessionSave:[1,1,1,""],ProcessIsStarted:[1,1,1,""],ProcessListGet:[1,1,1,""],ProcessStart:[1,1,1,""],ProcessStop:[1,1,1,""],ProcessorActivityItemAppend:[1,1,1,""],ProcessorActivityItemCreate:[1,1,1,""],ProcessorAliasDefCreate:[1,1,1,""],ProcessorAliasDefUpdate:[1,1,1,""],PythonStart:[1,1,1,""],RDPSessionCMDRun:[1,1,1,""],RDPSessionConnect:[1,1,1,""],RDPSessionDisconnect:[1,1,1,""],RDPSessionDublicatesResolve:[1,1,1,""],RDPSessionFileStoredRecieve:[1,1,1,""],RDPSessionFileStoredSend:[1,1,1,""],RDPSessionLogoff:[1,1,1,""],RDPSessionMonitorStop:[1,1,1,""],RDPSessionProcessStartIfNotRunning:[1,1,1,""],RDPSessionProcessStop:[1,1,1,""],RDPSessionReconnect:[1,1,1,""],RDPSessionResponsibilityCheck:[1,1,1,""],RDPTemplateCreate:[1,1,1,""],SchedulerActivityTimeAddWeekly:[1,1,1,""],UACKeyListCheck:[1,1,1,""],UACSuperTokenUpdate:[1,1,1,""],UACUpdate:[1,1,1,""],WebCPUpdate:[1,1,1,""],WebURLConnectDef:[1,1,1,""],WebURLConnectFile:[1,1,1,""],WebURLConnectFolder:[1,1,1,""],WebUserInfoGet:[1,1,1,""],WebUserIsSuperToken:[1,1,1,""],WebUserUACHierarchyGet:[1,1,1,""]},"pyOpenRPA.Robot":{UIDesktop:[5,0,0,"-"]},"pyOpenRPA.Robot.UIDesktop":{Get_OSBitnessInt:[5,1,1,""],PWASpecification_Get_PWAApplication:[5,1,1,""],PWASpecification_Get_UIO:[5,1,1,""],UIOSelectorSecs_WaitAppear_Bool:[5,1,1,""],UIOSelectorSecs_WaitDisappear_Bool:[5,1,1,""],UIOSelector_Exist_Bool:[5,1,1,""],UIOSelector_Get_BitnessInt:[5,1,1,""],UIOSelector_Get_BitnessStr:[5,1,1,""],UIOSelector_Get_UIO:[5,1,1,""],UIOSelector_Get_UIOList:[5,1,1,""],UIOSelector_SafeOtherGet_Process:[5,1,1,""],UIOSelector_SearchChildByMouse_UIO:[5,1,1,""],UIOSelector_SearchChildByMouse_UIOTree:[5,1,1,""],UIOSelectorsSecs_WaitAppear_List:[5,1,1,""],UIOSelectorsSecs_WaitDisappear_List:[5,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"0643":3,"100":2,"1050":[1,2],"120":2,"127":1,"1680":[1,2],"1680x1050":[1,2],"1992":3,"222":[0,2],"300":2,"3389":[1,2],"3600":2,"412":1,"600":2,"640x480":[1,2],"77767775":1,"77777sdfsdf77777dsfdfsf77777777":1,"8081":2,"\u0432":[4,5],"\u0432\u0445\u043e\u0434\u043d\u043e\u0439":[4,5],"\u0432\u044b\u043a\u0438\u043d\u0443\u0442\u044c":[4,5],"\u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0442\u044c":[4,5],"\u0434\u0435\u043c\u043e\u043d\u0430":2,"\u0434\u0435\u043c\u043e\u043d\u0443":2,"\u043a":[2,4,5],"\u043a\u043e\u043d\u043d\u0435\u043a\u0442":[4,5],"\u043a\u043e\u0442\u043e\u0440\u043e\u043c\u0443":2,"\u043b\u043e\u0433\u0433\u0435\u0440\u0430":2,"\u043b\u043e\u0433\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f":2,"\u043c\u043e\u0436\u043d\u043e":2,"\u043d\u0435":[4,5],"\u043e\u0431\u043d\u0430\u0440\u0443\u0436\u0435\u043d\u0438\u0438":[4,5],"\u043e\u0448\u0438\u0431\u043a\u0443":[4,5],"\u043f\u043e":2,"\u043f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430":2,"\u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0438\u0442\u044c\u0441\u044f":2,"\u043f\u043e\u043a\u0430\u0437\u0430\u0442\u0435\u043b\u044c":[4,5],"\u043f\u043e\u0440\u0442":2,"\u043f\u0440\u043e\u0446\u0435\u0441\u0441\u0443":[4,5],"\u043f\u0443\u0441\u0442\u043e\u0433\u043e":[4,5],"\u0440\u0430\u0441\u043f\u043e\u043b\u043e\u0436\u0435\u043d\u0438\u0435":2,"\u0441\u0435\u0440\u0432\u0435\u0440\u0430":2,"\u0441\u0435\u0442\u0435\u0432\u043e\u0435":2,"\u0441\u043b\u0443\u0447\u0430\u0435":[4,5],"\u0441\u043e\u0437\u0434\u0430\u0442\u044c":2,"\u0441\u043f\u0438\u0441\u043a\u0430":[4,5],"\u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f":[4,5],"\u0444\u0430\u0439\u043b":2,"\u0444\u043b\u0430\u0433":[4,5],"\u0447\u0442\u043e":[4,5],"\u044d\u043b\u0435\u043c\u0435\u043d\u0442":[4,5],"case":[0,1,2,4,5],"default":[1,2],"float":[0,2,4,5],"function":[1,2,5],"import":[0,1,2,3,5],"int":[0,1,4,5],"new":[0,1,2,3],"return":[1,2,4,5],"true":[1,2,3,4,5],"try":[1,3],"var":1,Abs:2,For:3,Has:2,NOT:1,The:0,USEFUL:1,USe:2,Use:[1,3],Will:[1,2],__agentdictitemcreate__:2,__create__:2,__main__:3,__name__:3,__orchestrator__:7,__uacclientadmincreate__:[2,3],_sessionlast_rdplist:1,a2o:1,about:[0,1,2],abs:1,absolut:[1,2,3],abspath:3,access:[1,2,3],accessus:2,activ:[0,1,2,4,5],activitydict:2,activityitem:1,activityitemdict:1,activitylist:2,activitylistappendprocessorqueuebool:2,activitylistexecut:1,activitylistexecutebool:2,activitytimelist:2,actual:1,add:[1,2,3],addhandl:2,address:[1,2],admindict:[2,3],administr:1,after:[0,2,3],agent:7,agentactivityitemadd:1,agentdict:[1,2],agentkeydict:[2,3],agentkeystr:2,agentoscmd:1,agentosfilebinarydatabase64strcr:1,agentosfilebinarydatabytescr:1,agentosfiletextdatastrcr:1,algorithm:0,algorythm:[0,2],alia:[0,1,2],aliasdefdict:[0,1,2],all:[0,1,2,3,4,5],allow:[1,2,3],alreadi:1,ani:[0,1],anoth:1,app:[1,4,5],appear:[4,5],append:[0,1,2],appli:[0,2],applic:[0,1,2,4,5],architectur:7,archiv:2,arg:[0,1,2],argdict:[0,1,2],arggset:[0,1,2],arglist:[0,1,2],arglogg:[0,1,2],argument:[1,2],argvaluestr:1,asctim:2,associ:1,async:0,asynchonu:0,attent:[0,1,3],attribut:[0,2,4,5],authent:2,authentif:1,authtoken:2,authtokensdict:2,auto:1,autoclean:[0,2],automat:[0,2],automationsearchmouseel:[4,5],avail:[1,2],b4ff:3,backend:[4,5],backward:1,base64:1,base:[0,1],basic:[0,1,2,3],becaus:[0,1],been:[1,2],befor:2,beginwith:[1,2],below:[0,3],between:[0,1,2,3],binari:1,bit:[1,4,5],block:2,bool:[0,1,2],both:1,browser:2,build:3,busi:[0,1],button:2,cach:2,call:[0,1,3,4,5],callabl:1,can:[0,1,2,4,5],cancel:[4,5],cant:0,central:0,chang:2,check:[1,2,3,4,5],checkintervalsecfloat:2,checktasknam:2,choos:[4,5],cleaner:1,clear:[1,2],client:[1,2],clientrequesthandl:2,clipboard:1,close:[1,2],cmd:[1,2],cmdinputbool:[2,3],code:0,collect:2,comma:0,command:[1,2],commun:1,compat:1,compex:0,complet:2,complex:0,compon:7,concept:7,config:3,configur:[1,2,3,7],connect:[1,2],connectioncountint:2,connectionfirstqueueitemcountint:2,consist:0,consol:2,consolid:0,contain:[1,2],content:[1,2],continu:1,control:[0,1,2,3],controlpanel:[2,3],controlpaneldict:2,controlpanelkeyallowedlist:2,controlpanelrefreshintervalsecfloat:2,cooki:2,core:0,cp_test:3,cp_versioncheck:3,cpdict:2,cpkei:2,cpkeydict:[2,3],cpkeystr:2,creat:[0,1,2,3],credenti:1,crosscheck:1,current:[0,1,2,3],custom:0,daemon:1,dai:1,data:2,datasetlast:2,datetim:[2,3],decentr:0,def:[0,2,3,4,7],defaliastest:[0,2],defnamestr:2,defsettingsupdatepathlist:2,del:3,deploi:1,deprec:2,depthbit:[1,2],descript:[2,5,7],desktop:[0,1,2,3],desktopus:1,destin:[1,4,5],detail:0,detect:[2,4,5],determin:1,dev:1,develop:1,dict:[1,2,4,5,7],dictionari:[0,2],differ:0,directori:1,disappear:[4,5],disc:1,disconnect:[1,2],document:[4,5],docutil:[1,5],doen:1,domain:2,domainadstr:2,domainupperstr:1,don:1,dont:[1,2],drive:[1,2],dsd:[0,2],dump:2,dumploglist:2,dumploglistcountint:2,dumploglisthashstr:2,dumploglistrefreshintervalsecfloat:2,duplic:1,durat:2,each:1,element:[4,5],els:[1,2,3,4,5],empti:2,encod:1,end:0,env:2,environ:1,equal:[1,2],equalcas:[1,2],everi:[1,2],everydai:1,exampl:[0,1,2,3,4,5],except:[1,3],exe:[1,2,5],execut:[0,1,2,6],executebool:2,exist:[1,2,4,5],expir:1,extens:1,extra:1,fals:[1,2,4,5],featur:[0,1,2],field:[1,2],file:[1,2],filehandl:2,filemanag:2,filemod:2,fileurl:2,fileurlfilepathdict:2,fileurlfilepathdict_help:2,fill:[1,2],find:0,find_window:[4,5],flag:[1,2],flagaccess:2,flagaccessdefrequestglobalauthent:2,flagcredentialsask:2,flagdonotexpir:2,flagforc:2,flagsessionisact:[1,2],flaguseallmonitor:[1,2],flexibl:0,folder:[1,3],forc:[1,2],forget:2,formatt:2,fridai:1,from:[0,1,2,3,4,5],full:[1,2],fullscreen:[1,2],fullscreenbool:2,fullscreenrdpsessionkeystr:2,functional:3,further:1,garbag:1,gener:[1,2],get:[1,2,4,5],get_osbitnessint:[4,5],getcontrol:[4,5],getlogg:2,git:[1,2],give:[1,2],given:1,global:[1,7],goe:0,good:0,gset:[0,3,7],gsettingsautoclean:1,gsettingsdict:1,gsettingskeylistvalueappend:1,gsettingskeylistvalueget:1,gsettingskeylistvalueoperatorplu:1,gsettingskeylistvalueset:1,gui:[0,1,4,5],guid:2,gurbag:2,handl:2,handler:2,hard:[1,2],has:[0,1],have:1,height:[1,2],help:1,hex:[1,2],hidden:1,hierarchi:1,host:[1,2],hostnameupperstr:2,how:7,html:[1,5],htmlrenderdef:2,http:[0,1,2,5],human:1,identif:1,ignor:[1,2],ignorebool:2,imaslov:3,inactivityitemdict:1,inactivitylist:1,inadisdefaultbool:[1,3],inadloginstr:[1,3],inadstr:[1,3],inaliasstr:1,inarg1str:1,inargdict:1,inarggset:1,inarggsettingsstr:1,inarglist:1,inargloggerstr:1,inbreaktriggerprocesswoexelist:1,incloseforcebool:1,includ:[4,5],incmdstr:1,incontenttypestr:1,incontrolspecificationarrai:[4,5],incpkeystr:1,indef:1,indefnamestr:1,indepthbitint:1,index:[0,1,2,4,5],indict:2,indomainstr:1,inel:[4,5],inelementspecif:[4,5],inencodingstr:1,infiledatabase64str:1,infiledatabyt:1,infiledatastr:1,infilepathstr:1,inflagforceclosebool:1,inflaggetabspathbool:1,inflagraiseexcept:[4,5],inflagwaitallinmo:[4,5],info:[1,2,3],infolderpathstr:1,inform:[0,1],ingset:[0,1,3],ingsettingsclientdict:2,inhashkeystr:2,inheightpxint:1,inhostfilepathstr:1,inhostnamestr:1,inhoststr:[1,2],inhtmlrenderdef:1,init:[0,1,2,3],initdatetim:2,initi:1,injsinitgeneratordef:1,injsongeneratordef:1,inkeylist:1,inkeystr:2,inlogg:[1,2],inloginstr:[1,2],inmatchtypestr:1,inmethodstr:1,inmodestr:[0,1,2,3],inmodulepathstr:1,inpasswordstr:[1,2],inpathstr:1,inportint:1,inportstr:[1,2],inprocessnamewexestr:1,inprocessnamewoexelist:1,inprocessnamewoexestr:1,input:2,inrdpfilepathstr:1,inrdpsessionkeystr:[1,2],inrdptemplatedict:1,inrequest:1,inrolehierarchyalloweddict:[1,3],inrolekeylist:1,inrowcountint:2,inrunasyncbool:1,insert:3,inshareddrivelist:1,inspecificationlist:[4,5],inspecificationlistlist:[4,5],instanc:[0,1,4,5],instopprocessnamewoexestr:1,insupertokenstr:[1,3],interact:[0,1],interest:1,interfac:0,interpret:0,interv:[1,2],intervalsecfloat:2,intimehhmmstr:1,inuioselector:[4,5],inurllist:[1,3],inurlstr:1,inusebothmonitorbool:1,inusernamestr:1,inuserstr:1,invalu:1,inwaitsec:[4,5],inweekdaylist:1,inwidthpxint:1,islistenbool:2,isresponsiblebool:1,item:[0,1],iter:2,join:3,jsinitgeneratordef:2,json:[0,1,2],jsongeneratordef:2,keep:0,kei:1,keystr:2,kill:1,know:0,kwarg:0,lactivityitem:1,laliasstr:1,last:2,launch:1,left:0,len:2,levelnam:2,lifetim:2,lifetimerequestsecfloat:2,lifetimesecfloat:2,light:0,like:0,link:[0,1,2],list:[0,1,2,4,5],listen:1,listenport:2,listenport_:2,listenurllist:2,listread:2,load:2,local:[1,2],localhost:2,locat:1,log:[1,2,3],logger:[1,2,3],loggerdumploghandleradd:2,loggerhandlerdumploglist:2,login:[1,2,3],logoff:[1,2],logviewerbool:[2,3],look:[0,1,2],lookmachinescreenshot:2,lowercas:2,lprocessisstartedbool:1,lprocesslist:1,lpyopenrpasourcefolderpathstr:3,lrdpitemdict:1,lrdptemplatedict:1,lresult:2,lresultdict:[1,2],luacclientdict:3,machin:[1,2,3],machina:2,main:[0,1,2,3],makedir:2,manag:1,mani:[0,4,5],manipul:1,matchtyp:2,max:2,mayb:1,mechan:0,mega:0,memori:1,merg:1,messag:2,method:2,methodmatchurl:2,methodmatchurlbeforelist:2,mhandlerdumploglist:2,mmstr:2,modul:[0,1,2,3],moduletocal:1,mondai:1,monitor:1,more:0,mrobotlogg:2,mrobotloggerfh:2,mrobotloggerformatt:2,must:2,name:[0,1,2,3,4,5],namewoexestr:1,namewoexeupperstr:1,need:[0,1,2],nest:1,net:[1,5],never:1,newkeydict:1,newkeylist:1,newvalu:1,none:[0,1,2,4,5],notat:[4,5],notepad:[1,2,4,5],noth:1,nothingbool:2,now:[1,2],object:[0,1,2,4,5],occupi:1,octet:1,off:2,old:[1,2,3,4,5],one:[2,3],onli:[1,2,4,5],openrpa52zzz:3,openrpa:2,openrparobotdaemon:2,oper:[1,3],option:2,orc:2,orchestr:[2,3,7],orchestratorrestart:1,orchestratorsessionsav:1,orchestratorstart:2,order:0,oscmd:1,oscredentialsverifi:1,other:[4,5],out:1,output:2,outstr:1,overwrit:2,own:0,packag:[3,4],page:[1,2],pai:[0,3],panel:[1,2,3],paramet:[0,1,2,4,5],pass:[1,2],password:[1,2],path:[1,2,3],pdb:2,per:3,period:2,phone:0,pid:1,pipupgrad:2,pixel:[1,2],plan:1,plu:1,port:[1,2],post:[1,2],postfix:1,previou:1,print:3,process:[0,2,4,5,6,7],processdetaillist:1,processisstart:1,processlistget:1,processnam:1,processor:[2,7],processoractivityitemappend:1,processoractivityitemcr:1,processoraliasdefcr:1,processoraliasdefupd:1,processordict:2,processstart:[1,2],processstartifturnedoff:2,processstop:[1,2],processwoexelist:1,processwoexeupperlist:1,program:[1,2],project:0,protocol:0,psutil:3,pull:2,pwaspecification_get_pwaappl:[4,5],pwaspecification_get_uio:[4,5],pyopenrpa:[0,2,3,6],pyopenrpadict:[2,3],pyrobot_cp:3,python:[0,2,4,7],pythonstart:1,pywinauto:[4,5],queue:[0,1,2],queuelist:2,r01:2,r01_integrationorderout:2,r01_orchestratortorobot:2,rais:1,rdp:[0,1,2],rdpactiv:2,rdpconfigurationdict:2,rdpkei:1,rdpkeydict:[2,3],rdpkeystr:2,rdplist:[1,2],rdpsession:7,rdpsessioncmdrun:1,rdpsessionconnect:[1,2],rdpsessiondisconnect:[1,2],rdpsessiondublicatesresolv:1,rdpsessionfilereciev:2,rdpsessionfilesend:2,rdpsessionfilestoredreciev:1,rdpsessionfilestoredsend:1,rdpsessionkei:2,rdpsessionkeystr:2,rdpsessionlogoff:[1,2],rdpsessionmonitorstop:1,rdpsessionprocessstart:2,rdpsessionprocessstartifnotrun:1,rdpsessionprocessstop:1,rdpsessionreconnect:[1,2],rdpsessionresponsibilitycheck:1,rdptemplatecr:1,read:2,reciev:[1,2],reconnect:1,reconnectbool:2,reestr_otgruzok:2,refer:7,refresh:2,refreshsecond:2,regener:1,rel:[1,2,3],rememb:2,remot:[1,2],renderfunct:2,renderrobotr01:2,report:2,reqir:0,request:[1,2],requesttimeoutsecfloat:2,requir:1,resolut:[1,2],respons:[1,2],responsecontenttyp:2,responsedefrequestglob:2,responsefilepath:2,responsefolderpath:2,responsibilitycheckintervalsec:2,restart:[1,2],restartorchestr:2,restartorchestratorbool:[2,3],restartorchestratorgitpullbool:[2,3],restartpcbool:[2,3],restructuredtext:[1,5],result:[1,2,4,5],returnbool:2,robot:[0,1,2,3,7],robot_r01:2,robot_r01_help:2,robotlist:2,robotrdpact:[1,2],rolehierarchyalloweddict:2,root:[1,2],row:2,rpa:[1,2],rpatestdirtest:1,rst:[1,5],ruledomainuserdict:2,rulemethodmatchurlbeforelist:2,run:[1,2,3],safe:[1,4,5],same:[4,5],save:1,schedul:[0,7],scheduleractivitytimeaddweekli:1,schedulerdict:2,scopesrcul:2,screen:[1,2],screenshot:2,screenshotviewerbool:[2,3],script:0,search:1,sec:2,second:[1,2,4,5],section:1,see:[1,2,3,4,5],select:[4,5],selector:[4,5],send:[1,2],sent:1,sequenc:0,server:[0,2],serverdict:2,serverset:2,sesion:[1,2],session:[1,2],sessionguidstr:2,sessionhex:[1,2],sessionisignoredbool:[1,2],sessioniswindowexistbool:[1,2],sessioniswindowresponsiblebool:[1,2],set:[1,2,3,4,5,7],set_trac:2,setformatt:2,setlevel:2,settingstempl:[0,3],settingsupd:3,setup:2,sever:0,share:1,shareddrivelist:[1,2],shell:1,should:2,show:2,side:[1,2],signal:1,singl:0,singleton:1,socket:0,some:[0,1,2],sort:1,sourc:[0,1,3,4,5],sourceforg:[1,5],space:0,special:2,sphinx:0,standart:2,start:[1,2,7],statu:1,stdout:[2,3],stop:1,storag:2,store:2,str:[0,1,2,4,5],stream:1,streamhandl:2,strftime:2,string:1,struct:2,structur:[0,1,2],studio:[0,6,7],success:1,successfulli:1,sundai:1,supertoken:[1,3],superus:3,supetoken:1,support:[0,3],symbol:0,sync:0,sys:[2,3],tablet:0,technic:[0,2],technicalsessionguidcach:2,templat:[3,7],test2:2,test:[1,2,3],testcontrolpanelkei:2,testdef:1,testdefalia:1,testdir:1,testdirtest:1,testrdp:2,text:1,than:0,thi:[1,2],thought:1,thread:[0,2],threadidint:2,thursdai:1,time:[1,2],timehh:2,titl:[4,5],todo:1,token:1,tokendatetim:2,too:[1,2],tool:0,top:[4,5],track:1,transmiss:1,transmit:[0,1],trigger:[1,2],ttt:[0,2],turn:2,turpl:0,txt:1,type:[1,2,3],uac:7,uackeylistcheck:1,uacsupertokenupd:[1,3],uacupd:[1,3],uia:[4,5],uidesktop:[4,7],uio:[4,5],uioselector:[4,5],uioselector_exist_bool:[4,5],uioselector_get_bitnessint:[4,5],uioselector_get_bitnessstr:[4,5],uioselector_get_uio:[4,5],uioselector_get_uiolist:[4,5],uioselector_safeotherget_process:[4,5],uioselector_searchchildbymouse_uio:[4,5],uioselector_searchchildbymouse_uiotre:[4,5],uioselectorsecs_waitappear_bool:[4,5],uioselectorsecs_waitdisappear_bool:[4,5],uioselectorssecs_waitappear_list:[4,5],uioselectorssecs_waitdisappear_list:[4,5],univers:0,updat:[1,2],upper:2,url:[1,2],url_:2,urllist:2,usag:1,use:[0,1,2],used:1,user:[0,1,2,3],user_99:1,user_pass_her:1,useradstr:2,usernam:[1,2],usernameupperstr:1,userupperstr:2,using:1,utf:1,util:2,valu:[1,4,5],variant:1,verifi:1,version:3,versioncheck:3,versionstr:2,viewer:2,virtual:2,vms:1,wai:[1,3],wait:[4,5],want:[0,2],warn:3,web:[0,2,7],webcpupd:1,weburlconnectdef:1,weburlconnectfil:1,weburlconnectfold:1,webuserinfoget:1,webuserissupertoken:1,webuseruachierarchyget:1,wednesdai:1,week:1,weekdai:[1,2],weekdaylist:2,when:[0,1,2,3],where:1,which:[0,1,2,4,5],who:2,why:0,width:[1,2],win32:[4,5],win:1,window:[1,2],without:[1,2],work:[1,2],workingdirectorypathstr:2,wrapper:[4,5],write:0,xlsx:2,you:[0,1,2,4,5]},titles:["1. Description","2. Defs","3. gSettings Template","4. How to start process","1. Description","2. Defs","Description","Welcome to pyOpenRPA\u2019s documentation!"],titleterms:{__orchestrator__:1,agent:1,architectur:0,compon:0,concept:0,configur:0,def:[1,5],descript:[0,4,6],dict:0,document:7,global:0,gset:[1,2],how:[0,3],orchestr:[0,1],process:[1,3],processor:[0,1],pyopenrpa:[1,4,5,7],python:1,rdpsession:1,refer:[0,1,5],robot:[4,5],schedul:1,set:0,start:3,templat:2,uac:1,uidesktop:5,web:1,welcom:7}})
\ No newline at end of file
diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md b/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md
index db556096..92ca5289 100644
--- a/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md
+++ b/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md
@@ -12,6 +12,46 @@ from pyOpenRPA.Orchestrator import __Orchestrator__
__Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
```
+### Defs Agent…
+
+Interaction between Orchestrator and pyOpenRPA.Agent daemon process, which can be deployed in another user session.
+
+### Defs GSettings…
+
+Basic defs to work with singleton gSettings.
+
+### Defs OS…
+
+Interaction with shell on the Orchestrator user session.
+
+### Defs Process…
+
+Interaction with some process on the Orchestrator user session.
+
+### Defs Processor…
+
+Work with Processor queue (see …).
+
+### Defs Python…
+
+Work with extra python modules.
+
+### Defs RDPSession…
+
+Interaction with RDP session, where you can manage some robots.
+
+### Defs Web…
+
+Manipulate the Orchestrator WEB side.
+
+### Defs UAC…
+
+Manipulate the User Access Controls (actual for the Orchestrator WEB access for the business users)
+
+### Defs Scheduler…
+
+Work with activity scheduling.
+
**Functions:**
| `AgentActivityItemAdd`(inGSettings, …)
@@ -21,99 +61,99 @@ __Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
|
| `AgentOSCMD`(inGSettings, inHostNameStr, …)
- | Send CMD to OS throught the pyOpenRPA.Agent daemon.
+ | Send CMD to OS thought the pyOpenRPA.Agent daemon.
|
| `AgentOSFileBinaryDataBase64StrCreate`(…)
- | pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmission) def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None): Send binary file to Agent (base64 string)
+ | Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)
|
| `AgentOSFileBinaryDataBytesCreate`(…)
- | pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmition) def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None): Send binary file to Agent (Bytes)
+ | Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition)
- |
+ |
| `AgentOSFileTextDataStrCreate`(inGSettings, …)
- | pyOpenRPA.Agent: Create text file by the string def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = “utf-8”,inGSettings = None): Create Activity Item for the agent
+ | Create text file by the string by the pyOpenRPA.Agent daemon process
- |
+ |
| `GSettingsAutocleaner`(inGSettings)
- | Interval gsettings auto cleaner
+ | HIDDEN Interval gSettings auto cleaner def to clear some garbage.
- |
+ |
| `GSettingsKeyListValueAppend`(inGSettings, inValue)
| Append value in GSettings by the key list
- |
+ |
| `GSettingsKeyListValueGet`(inGSettings[, …])
| Get the value from the GSettings by the key list
- |
+ |
| `GSettingsKeyListValueOperatorPlus`(…[, …])
| Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList)
- |
+ |
| `GSettingsKeyListValueSet`(inGSettings, inValue)
| Set value in GSettings by the key list
- |
+ |
| `OSCMD`(inCMDStr[, inRunAsyncBool, inLogger])
| OS send command in shell locally
- |
+ |
| `OSCredentialsVerify`(inUserStr, inPasswordStr)
| Verify user credentials in windows.
- |
+ |
| `OrchestratorRestart`([inGSettings])
| Orchestrator restart
- |
+ |
| `OrchestratorSessionSave`([inGSettings])
| Orchestrator session save in file _SessionLast_RDPList.json (encoding = “utf-8”)
- |
+ |
| `ProcessIsStarted`(inProcessNameWOExeStr)
| Check if there is any running process that contains the given name processName.
- |
+ |
| `ProcessListGet`([inProcessNameWOExeList])
| Return process list on the orchestrator machine sorted by Memory Usage.
- |
+ |
| `ProcessStart`(inPathStr, inArgList[, …])
| Start process locally.
- |
+ |
| `ProcessStop`(inProcessNameWOExeStr, …[, …])
| Stop process on the orchestrator machine.
- |
+ |
| `ProcessorActivityItemAppend`(inGSettings[, …])
| Create and add activity item in processor queue.
- |
+ |
| `ProcessorActivityItemCreate`(inDef[, …])
| Create activity item.
- |
+ |
| `ProcessorAliasDefCreate`(inGSettings, inDef)
| Create alias for def (can be used in ActivityItem in field Def) !WHEN DEF ALIAS IS REQUIRED! - Def alias is required when you try to call Python def from the Orchestrator WEB side (because you can’t transmit Python def object out of the Python environment)
@@ -131,64 +171,64 @@ __Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
|
| `RDPSessionCMDRun`(inGSettings, …[, inModeStr])
- | Send command in RDP session
+ | Send CMD command to the RDP session “RUN” window
- |
+ |
| `RDPSessionConnect`(inGSettings, …[, …])
- | Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if key is exists
+ | Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists
- |
+ |
| `RDPSessionDisconnect`(inGSettings, …[, …])
- | Disconnect the RDP session
+ | Disconnect the RDP session and stop monitoring it.
- |
+ |
| `RDPSessionDublicatesResolve`(inGSettings)
- | DEVELOPING Search dublicates in GSettings RDPlist !def is developing!
+ | DEVELOPING Search duplicates in GSettings RDPlist !def is developing!
|
| `RDPSessionFileStoredRecieve`(inGSettings, …)
- | Receive file from Session RDP to Host using shared drive in RDP
+ | Recieve file from RDP session to the Orchestrator session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
- |
+ |
| `RDPSessionFileStoredSend`(inGSettings, …)
- | Send file from Host to Session RDP using shared drive in RDP
+ | Send file from Orchestrator session to the RDP session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
- |
+ |
| `RDPSessionLogoff`(inGSettings, inRDPSessionKeyStr)
- | Logoff the RDP session
+ | Logoff the RDP session from the Orchestrator process (close all apps in session when logoff)
- |
+ |
| `RDPSessionMonitorStop`(inGSettings, …)
- | Stop track the RDP session.
+ | Stop monitoring the RDP session by the Orchestrator process.
- |
+ |
| `RDPSessionProcessStartIfNotRunning`(…[, …])
- | Start process if it is not running
+ | Start process in RDP if it is not running (check by the arg inProcessNameWEXEStr)
- |
+ |
| `RDPSessionProcessStop`(inGSettings, …)
- | Create CMD str to stop process
+ | Send CMD command to the RDP session “RUN” window.
- |
+ |
| `RDPSessionReconnect`(inGSettings, …[, …])
- | RDP Session reconnect
+ | Reconnect the RDP session
- |
+ |
| `RDPSessionResponsibilityCheck`(inGSettings, …)
- | Check RDP Session responsibility TODO NEED DEV + TEST
+ | DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST
- |
+ |
| `RDPTemplateCreate`(inLoginStr, inPasswordStr)
| Create RDP connect dict item/ Use it connect/reconnect (Orchestrator.RDPSessionConnect)
@@ -253,11 +293,6 @@ __Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
### pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemAdd(inGSettings, inHostNameStr, inUserStr, inActivityItemDict)
Add activity in AgentDict. Check if item is created
-```
-# USAGE
-import this
-```
-
* **Parameters**
@@ -277,14 +312,12 @@ import this
* **Returns**
- sad
+ None
### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSCMD(inGSettings, inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True)
-Send CMD to OS throught the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection
-def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings=None):
-Send to agent activity item to OSCMD
+Send CMD to OS thought the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection
* **Parameters**
@@ -307,9 +340,7 @@ Send to agent activity item to OSCMD
### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str)
-pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmission)
-def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
-Send binary file to Agent (base64 string)
+Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)
* **Parameters**
@@ -332,9 +363,7 @@ Send binary file to Agent (base64 string)
### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBytesCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataBytes)
-pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmition)
-def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
-Send binary file to Agent (Bytes)
+Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition)
* **Parameters**
@@ -357,9 +386,7 @@ Send binary file to Agent (Bytes)
### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrCreate(inGSettings, inHostNameStr, inUserStr, inFilePathStr, inFileDataStr, inEncodingStr='utf-8')
-pyOpenRPA.Agent: Create text file by the string
-def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = “utf-8”,inGSettings = None):
-Create Activity Item for the agent
+Create text file by the string by the pyOpenRPA.Agent daemon process
* **Parameters**
@@ -385,7 +412,7 @@ Create Activity Item for the agent
### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsAutocleaner(inGSettings)
-Interval gsettings auto cleaner
+HIDDEN Interval gSettings auto cleaner def to clear some garbage.
* **Parameters**
@@ -396,7 +423,8 @@ Interval gsettings auto cleaner
* **Returns**
-
+ None
+
### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueAppend(inGSettings, inValue, inKeyList=None)
@@ -986,7 +1014,18 @@ Orchestrator.PythonStart(
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionCMDRun(inGSettings, inRDPSessionKeyStr, inCMDStr, inModeStr='CROSSCHECK')
-Send command in RDP session
+Send CMD command to the RDP session “RUN” window
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lResultDict = Orchestrator.RDPSessionCMDRun(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inModeStr = 'LISTEN')
+# Orchestrator will send CMD to RDP and return the result (see return section)
+```
* **Parameters**
@@ -995,15 +1034,15 @@ Send command in RDP session
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inCMDStr** –
+ * **inCMDStr** – Any CMD string
* **inModeStr** – Variants:
“LISTEN” - Get result of the cmd command in result;
- “CROSSCHECK” - Check if the command was successufully sent
+ “CROSSCHECK” - Check if the command was successfully sent
“RUN” - Run without crosscheck and get clipboard
@@ -1023,12 +1062,27 @@ Send command in RDP session
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionConnect(inGSettings, inRDPSessionKeyStr, inRDPTemplateDict=None, inHostStr=None, inPortStr=None, inLoginStr=None, inPasswordStr=None)
-Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if key is exists
+Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists
2 way of the use
-Var 1: inGSettings, inRDPSessionKeyStr, inRDPTemplateDict
-Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inPortStr, inLoginStr, inPasswordStr
+Var 1 (Main stream): inGSettings, inRDPSessionKeyStr, inRDPTemplateDict
+Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inPortStr, inLoginStr, inPasswordStr
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lRDPItemDict = Orchestrator.RDPTemplateCreate(
+ inLoginStr = "USER_99",
+ inPasswordStr = "USER_PASS_HERE", inHostStr="127.0.0.1", inPortInt = 3389, inWidthPXInt = 1680,
+ inHeightPXInt = 1050, inUseBothMonitorBool = False, inDepthBitInt = 32, inSharedDriveList=None)
+Orchestrator.RDPSessionConnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inRDPTemplateDict = lRDPItemDict)
+# Orchestrator will create RDP session by the lRDPItemDict configuration
+```
* **Parameters**
@@ -1037,33 +1091,43 @@ Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inP
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inRDPTemplateDict** –
+ * **inRDPTemplateDict** – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)
- * **inHostStr** –
+ * **inHostStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
- * **inPortStr** –
+ * **inPortStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
- * **inLoginStr** –
+ * **inLoginStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
- * **inPasswordStr** –
+ * **inPasswordStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict
* **Returns**
- True every time
+ True every time :)
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDisconnect(inGSettings, inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None)
-Disconnect the RDP session
+Disconnect the RDP session and stop monitoring it.
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+Orchestrator.RDPSessionDisconnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey")
+# Orchestrator will disconnect RDP session and will stop to monitoring current RDP
+```
* **Parameters**
@@ -1072,10 +1136,13 @@ Disconnect the RDP session
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inBreakTriggerProcessWOExeList** –
+ * **inBreakTriggerProcessWOExeList** – List of the processes, which will stop the execution. Example [“notepad”]
+
+ Orchestrator look processes on the current machine
+
@@ -1086,7 +1153,7 @@ Disconnect the RDP session
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDublicatesResolve(inGSettings)
-DEVELOPING Search dublicates in GSettings RDPlist
+DEVELOPING Search duplicates in GSettings RDPlist
!def is developing!
@@ -1102,7 +1169,19 @@ DEVELOPING Search dublicates in GSettings RDPlist
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredRecieve(inGSettings, inRDPSessionKeyStr, inRDPFilePathStr, inHostFilePathStr)
-Receive file from Session RDP to Host using shared drive in RDP
+Recieve file from RDP session to the Orchestrator session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lResultDict = Orchestrator.RDPSessionFileStoredRecieve(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inHostFilePathStr = "TESTDIR\Test.py",
+ inRDPFilePathStr = "C:\RPA\TESTDIR\Test.py")
+# Orchestrator will send CMD to RDP and return the result (see return section)
+```
* **Parameters**
@@ -1111,23 +1190,36 @@ Receive file from Session RDP to Host using shared drive in RDP
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inRDPFilePathStr** –
+ * **inRDPFilePathStr** – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py”
- * **inHostFilePathStr** –
+ * **inHostFilePathStr** – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py”
* **Returns**
-
+ True every time
+
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredSend(inGSettings, inRDPSessionKeyStr, inHostFilePathStr, inRDPFilePathStr)
-Send file from Host to Session RDP using shared drive in RDP
+Send file from Orchestrator session to the RDP session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lResultDict = Orchestrator.RDPSessionFileStoredSend(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inHostFilePathStr = "TESTDIR\Test.py",
+ inRDPFilePathStr = "C:\RPA\TESTDIR\Test.py")
+# Orchestrator will send CMD to RDP and return the result (see return section)
+```
* **Parameters**
@@ -1136,23 +1228,35 @@ Send file from Host to Session RDP using shared drive in RDP
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inHostFilePathStr** –
+ * **inHostFilePathStr** – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py”
- * **inRDPFilePathStr** –
+ * **inRDPFilePathStr** – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py”
* **Returns**
-
+ True every time
+
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionLogoff(inGSettings, inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None)
-Logoff the RDP session
+Logoff the RDP session from the Orchestrator process (close all apps in session when logoff)
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+Orchestrator.RDPSessionLogoff(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inBreakTriggerProcessWOExeList = ['Notepad'])
+# Orchestrator will logoff the RDP session
+```
* **Parameters**
@@ -1161,10 +1265,10 @@ Logoff the RDP session
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inBreakTriggerProcessWOExeList** –
+ * **inBreakTriggerProcessWOExeList** – List of the processes, which will stop the execution. Example [“notepad”]
@@ -1175,7 +1279,17 @@ Logoff the RDP session
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionMonitorStop(inGSettings, inRDPSessionKeyStr)
-Stop track the RDP session. Current def dont kill RDP session - only stop to track it (it can give )
+Stop monitoring the RDP session by the Orchestrator process. Current def don’t kill RDP session - only stop to track it (it can give )
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+Orchestrator.RDPSessionMonitorStop(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey")
+# Orchestrator will stop the RDP monitoring
+```
* **Parameters**
@@ -1184,17 +1298,31 @@ Stop track the RDP session. Current def dont kill RDP session - only stop to tra
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
* **Returns**
-
+ True every time :>
+
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStartIfNotRunning(inGSettings, inRDPSessionKeyStr, inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPathBool=True)
-Start process if it is not running
+Start process in RDP if it is not running (check by the arg inProcessNameWEXEStr)
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+Orchestrator.RDPSessionProcessStartIfNotRunning(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inProcessNameWEXEStr = 'Notepad.exe',
+ inFilePathStr = "path\to he\executable\file.exe"
+ inFlagGetAbsPathBool = True)
+# Orchestrator will start the process in RDP session
+```
* **Parameters**
@@ -1203,26 +1331,39 @@ Start process if it is not running
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inProcessNameWEXEStr** –
+ * **inProcessNameWEXEStr** – Process name with extension (.exe). This arg allow to check the process is running. Example: “Notepad.exe”
- * **inFilePathStr** –
+ * **inFilePathStr** – Path to run process if it is not running.
- * **inFlagGetAbsPathBool** –
+ * **inFlagGetAbsPathBool** – True - get abs path from the relative path in inFilePathStr. False - else case
* **Returns**
-
+ True every time :)
+
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStop(inGSettings, inRDPSessionKeyStr, inProcessNameWEXEStr, inFlagForceCloseBool)
-Create CMD str to stop process
+Send CMD command to the RDP session “RUN” window.
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lResultDict = Orchestrator.RDPSessionProcessStop(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inProcessNameWEXEStr = 'notepad.exe',
+ inFlagForceCloseBool = True)
+# Orchestrator will send CMD to RDP and return the result (see return section)
+```
* **Parameters**
@@ -1231,23 +1372,39 @@ Create CMD str to stop process
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inProcessNameWEXEStr** –
+ * **inProcessNameWEXEStr** – Process name to kill. Example: ‘notepad.exe’
- * **inFlagForceCloseBool** –
+ * **inFlagForceCloseBool** – True - force close the process. False - safe close the process
* **Returns**
-
+ True every time
+
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionReconnect(inGSettings, inRDPSessionKeyStr, inRDPTemplateDict=None)
-RDP Session reconnect
+Reconnect the RDP session
+
+```
+# USAGE
+from pyOpenRPA import Orchestrator
+
+lRDPItemDict = Orchestrator.RDPTemplateCreate(
+ inLoginStr = "USER_99",
+ inPasswordStr = "USER_PASS_HERE", inHostStr="127.0.0.1", inPortInt = 3389, inWidthPXInt = 1680,
+ inHeightPXInt = 1050, inUseBothMonitorBool = False, inDepthBitInt = 32, inSharedDriveList=None)
+Orchestrator.RDPSessionReconnect(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inRDPTemplateDict = inRDPTemplateDict)
+# Orchestrator will reconnect RDP session and will continue to monitoring current RDP
+```
* **Parameters**
@@ -1256,10 +1413,10 @@ RDP Session reconnect
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
- * **inRDPTemplateDict** –
+ * **inRDPTemplateDict** – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)
@@ -1269,7 +1426,7 @@ RDP Session reconnect
### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionResponsibilityCheck(inGSettings, inRDPSessionKeyStr)
-Check RDP Session responsibility TODO NEED DEV + TEST
+DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST
* **Parameters**
@@ -1278,7 +1435,7 @@ Check RDP Session responsibility TODO NEED DEV + TEST
* **inGSettings** – Global settings dict (singleton)
- * **inRDPSessionKeyStr** –
+ * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification
diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToStart.md b/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToStart.md
index f258c7ed..3387a64b 100644
--- a/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToStart.md
+++ b/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToStart.md
@@ -1,4 +1,4 @@
-# 4. How to start
+# 4. How to start process
Start configuration example
diff --git a/Wiki/ENG_Guide/markdown/index.md b/Wiki/ENG_Guide/markdown/index.md
index abd8feee..1db73796 100644
--- a/Wiki/ENG_Guide/markdown/index.md
+++ b/Wiki/ENG_Guide/markdown/index.md
@@ -49,10 +49,40 @@ contain the root `toctree` directive. -->
* pyOpenRPA.Orchestrator.__Orchestrator__
+ * Defs Agent…
+
+
+ * Defs GSettings…
+
+
+ * Defs OS…
+
+
+ * Defs Process…
+
+
+ * Defs Processor…
+
+
+ * Defs Python…
+
+
+ * Defs RDPSession…
+
+
+ * Defs Web…
+
+
+ * Defs UAC…
+
+
+ * Defs Scheduler…
+
+
* References
* 3. gSettings Template
-* 4. How to start
+* 4. How to start process
[docs]def RDPSessionFileStoredRecieve(inGSettings, inRDPSessionKeyStr, inRDPFilePathStr, inHostFilePathStr):
"""
- Receive file from Session RDP to Host using shared drive in RDP
+ Recieve file from RDP session to the Orchestrator session using shared drive in RDP (see RDP Configuration Dict, Shared drive)
+
+ .. code-block:: python
+
+ # USAGE
+ from pyOpenRPA import Orchestrator
+
+ lResultDict = Orchestrator.RDPSessionFileStoredRecieve(
+ inGSettings = gSettings,
+ inRDPSessionKeyStr = "RDPKey",
+ inHostFilePathStr = "TESTDIR\\Test.py",
+ inRDPFilePathStr = "C:\\RPA\\TESTDIR\\Test.py")
+ # Orchestrator will send CMD to RDP and return the result (see return section)
:param inGSettings: Global settings dict (singleton)
- :param inRDPSessionKeyStr:
- :param inRDPFilePathStr:
- :param inHostFilePathStr:
- :return:
+ :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
+ :param inRDPFilePathStr: !Absolute! path to the destination file location on the RDP side. Example: "C:\\RPA\\TESTDIR\\Test.py"
+ :param inHostFilePathStr: Relative or absolute path to the file location on the Orchestrator side. Example: "TESTDIR\\Test.py"
+ :return: True every time
"""
# Check thread
if not Core.IsProcessorThread(inGSettings=inGSettings):
@@ -1636,10 +1748,10 @@
diff --git a/Wiki/ENG_Guide/html/objects.inv b/Wiki/ENG_Guide/html/objects.inv
index 609203df..7ad3af64 100644
Binary files a/Wiki/ENG_Guide/html/objects.inv and b/Wiki/ENG_Guide/html/objects.inv differ
diff --git a/Wiki/ENG_Guide/html/py-modindex.html b/Wiki/ENG_Guide/html/py-modindex.html
index 2c7fb438..b22e0e6a 100644
--- a/Wiki/ENG_Guide/html/py-modindex.html
+++ b/Wiki/ENG_Guide/html/py-modindex.html
@@ -99,7 +99,7 @@
[docs]def GSettingsAutocleaner(inGSettings):
"""
- Interval gsettings auto cleaner
+ HIDDEN Interval gSettings auto cleaner def to clear some garbage.
:param inGSettings: Global settings dict (singleton)
- :return:
+ :return: None
"""
while True:
time.sleep(inGSettings["Autocleaner"]["IntervalSecFloat"]) # Wait for the next iteration
diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html
index c0f1ea67..c2221b45 100644
--- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html
+++ b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html
@@ -96,7 +96,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt
index 712956b1..1576244f 100644
--- a/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt
+++ b/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt
@@ -18,6 +18,47 @@ pyOpenRPA.Orchestrator.__Orchestrator__
+Defs Agent...
+######################
+Interaction between Orchestrator and pyOpenRPA.Agent daemon process, which can be deployed in another user session.
+
+Defs GSettings...
+######################
+Basic defs to work with singleton gSettings.
+
+Defs OS...
+######################
+Interaction with shell on the Orchestrator user session.
+
+Defs Process...
+######################
+Interaction with some process on the Orchestrator user session.
+
+Defs Processor...
+######################
+Work with Processor queue (see ...).
+
+Defs Python...
+######################
+Work with extra python modules.
+
+Defs RDPSession...
+######################
+Interaction with RDP session, where you can manage some robots.
+
+Defs Web...
+######################
+Manipulate the Orchestrator WEB side.
+
+Defs UAC...
+######################
+Manipulate the User Access Controls (actual for the Orchestrator WEB access for the business users)
+
+Defs Scheduler...
+######################
+Work with activity scheduling.
+
+
.. automodule:: pyOpenRPA.Orchestrator.__Orchestrator__
:members:
:autosummary:
diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToStart.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToStart.rst.txt
index 66e056d7..15c90d8c 100644
--- a/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToStart.rst.txt
+++ b/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToStart.rst.txt
@@ -1,5 +1,5 @@
************************
-4. How to start
+4. How to start process
************************
Start configuration example
diff --git a/Wiki/ENG_Guide/html/genindex.html b/Wiki/ENG_Guide/html/genindex.html
index 925d1b02..14b5a003 100644
--- a/Wiki/ENG_Guide/html/genindex.html
+++ b/Wiki/ENG_Guide/html/genindex.html
@@ -96,7 +96,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
diff --git a/Wiki/ENG_Guide/html/index.html b/Wiki/ENG_Guide/html/index.html
index 3462694b..066ca3d5 100644
--- a/Wiki/ENG_Guide/html/index.html
+++ b/Wiki/ENG_Guide/html/index.html
@@ -97,7 +97,7 @@
- 1. Description
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process
@@ -201,12 +201,24 @@
- 2. Defs
- 3. gSettings Template
-- 4. How to start
+- 4. How to start process