diff --git a/LICENSE b/LICENSE index bc4274a8..75128552 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,8 @@ -Лицензия-оферта -pyOpenRPA License +pyOpenRPA open license +pyOpenRPA открытая лицензия Copyright (c) 2019 Ivan Maslov +Правообладатель: 2019 Маслов Иван Дмитриевич + +Текст лицензии см. в файле: LICENSE.PDF (в корне репозитория) или по адресу: https://pyopenrpa.ru/license/oferta.pdf + diff --git a/LICENSE.pdf b/LICENSE.pdf new file mode 100644 index 00000000..0ecaa7ed Binary files /dev/null and b/LICENSE.pdf differ diff --git a/README.md b/README.md index d43341e3..51cf0982 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,19 @@ contain the root `toctree` directive. --> ## Donate -pyOpenRPA is absolutely non-commercial project. - -Please donate some $ if pyOpenRPA project is actual for you. Link to online donations. -[https://yoomoney.ru/to/4100115560661986](https://money.yandex.ru/to/4100115560661986) +pyOpenRPA is a commercial project. ## About Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + The pyOpenRPA - free, fast and reliable Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. -The pyOpenRPA is distributed under the MIT license which allows you to use it in any way you want and any time you need without any restrictions. +The pyOpenRPA is distributed under the PYOPENRPA open license. At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. ## Wiki @@ -41,14 +40,14 @@ Now you can use the following docs: - RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) ## Copyrights & Contacts -pyOpenRPA is created by Ivan Maslov (Russia). Use it for free (MIT)! +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. My purpose is to create #IT4Business models. If you need IT help feel free to contact me. -My contacts: +Ivan Maslov contacts (CEO & FOUNDER): -- E-mail: I.Maslov@mail.ru +- E-mail: Ivan.Maslov@pyOpenRPA.ru - Skype: MegaFinder -- Facebook: https://www.facebook.com/RU.IT4Business -- LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ -- WhatsApp | Telegram: +7 906 722 39 25 \ No newline at end of file +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov \ No newline at end of file diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA deleted file mode 100644 index 2d9287f9..00000000 --- a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA +++ /dev/null @@ -1,93 +0,0 @@ -Metadata-Version: 2.1 -Name: pyOpenRPA -Version: 1.2.7 -Summary: First open source RPA platform for business -Home-page: https://pyopenrpa.ru/ -Author: Ivan Maslov -Author-email: Ivan.Maslov@pyopenrpa.ru -License: PYOPENRPA -Keywords: pyOpenRPA OpenRPA RPA Robot Automation Robotization OpenSource IT4Business -Platform: UNKNOWN -Classifier: Development Status :: 5 - Production/Stable -Classifier: License :: Free For Educational Use -Classifier: License :: Free For Home Use -Classifier: License :: Free for non-commercial use -Classifier: Intended Audience :: Developers -Classifier: Environment :: Win32 (MS Windows) -Classifier: Environment :: X11 Applications -Classifier: Programming Language :: Python -Classifier: Programming Language :: Python :: 3.7 -Classifier: Topic :: Software Development :: Libraries :: Python Modules -Classifier: Topic :: Software Development :: Testing -Classifier: Topic :: Software Development :: User Interfaces -Classifier: Topic :: Software Development :: Quality Assurance -Classifier: Topic :: Home Automation -Description-Content-Type: text/markdown -Requires-Dist: pillow (>=6.0.0) -Requires-Dist: keyboard (>=0.13.3) -Requires-Dist: pyautogui (<=0.9.52) -Requires-Dist: crypto (>=1.4.1) -Requires-Dist: schedule (>=1.1.0) -Requires-Dist: pywinauto (>=0.6.8) ; platform_system == "win32" and python_version >= "3.0" -Requires-Dist: WMI (>=1.4.9) ; platform_system == "win32" and python_version >= "3.0" -Requires-Dist: pywin32 (>=224) ; platform_system == "win32" and python_version >= "3.0" - -# OpenRPA -First open source RPA platform for business is released! - -# How to run -Studio -Double click to Studio\StudioRun_32.cmd or Studio\StudioRun_64.cmd - -# Robot how to debug -Robot\PythonDebug_64.cmd -import Robot -Robot.ActivityRun( - { - ModuleName: <"GUI"|..., str>, - ActivityName: , - ArgumentList: [, ...] - optional, - ArgumentDict: {:, ...} - optional - } -) - -# Robot example script: -Robot\Examples\GetFolderList\Python_32_Script_Run.cmd - -# Python 32 bit -Resources\WPy32-3720\python-3.7.2\python.exe - -# Python 64 bit -Resources\WPy64-3720\python-3.7.2.amd64\python.exe - -# Module GUI activity List: -############################ -Новая версия -############################ -Получить список элементов, который удовлетворяет условиям через расширенный движок поиска -[ - { - "index":<Позиция элемента в родительском объекте>, - "depth_start" - глубина, с которой начинается поиск (по умолчанию 1) - "depth_end" - глубина, до которой ведется поиск (по умолчанию 1) - "class_name" - наименование класса, который требуется искать - "title" - наименование заголовка - "rich_text" - наименование rich_text - } -] - - -# Open RPA Wiki -- [Home](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/home) -- [04. Desktop app access (win32 & ui automation)](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/04.-Desktop-app-access-(win32-&-ui-automation)) - -#Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - -Created by Unicode Labs (Ivan Maslov) - diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/INSTALLER b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/INSTALLER similarity index 100% rename from Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/INSTALLER rename to Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/INSTALLER diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA new file mode 100644 index 00000000..0a87afa2 --- /dev/null +++ b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA @@ -0,0 +1,88 @@ +Metadata-Version: 2.1 +Name: pyOpenRPA +Version: 1.2.8 +Summary: First open source RPA platform for business +Home-page: https://pyopenrpa.ru/ +Author: Ivan Maslov +Author-email: Ivan.Maslov@pyopenrpa.ru +License: Текст лицензии см. в файле: LICENSE.PDF (в корне) или по адресу: https://pyopenrpa.ru/license/oferta.pdf +Keywords: pyOpenRPA OpenRPA RPA Robot Automation Robotization OpenSource IT4Business +Platform: UNKNOWN +Classifier: Development Status :: 5 - Production/Stable +Classifier: License :: Free For Educational Use +Classifier: License :: Free For Home Use +Classifier: License :: Free for non-commercial use +Classifier: Intended Audience :: Developers +Classifier: Environment :: Win32 (MS Windows) +Classifier: Environment :: X11 Applications +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 3.7 +Classifier: Topic :: Software Development :: Libraries :: Python Modules +Classifier: Topic :: Software Development :: Testing +Classifier: Topic :: Software Development :: User Interfaces +Classifier: Topic :: Software Development :: Quality Assurance +Classifier: Topic :: Home Automation +Description-Content-Type: text/markdown +Requires-Dist: pillow (>=6.0.0) +Requires-Dist: keyboard (>=0.13.3) +Requires-Dist: pyautogui (<=0.9.52) +Requires-Dist: crypto (>=1.4.1) +Requires-Dist: schedule (>=1.1.0) +Requires-Dist: pywinauto (>=0.6.8) ; platform_system == "win32" and python_version >= "3.0" +Requires-Dist: WMI (>=1.4.9) ; platform_system == "win32" and python_version >= "3.0" +Requires-Dist: pywin32 (>=224) ; platform_system == "win32" and python_version >= "3.0" + + +# Welcome to pyOpenRPA’s wiki + + +![image](Wiki/ENG_Guide/markdown/img/ModalGuide.png) + +*by Ivan Maslov (Russia)* + +## Donate + +pyOpenRPA is a commercial project. + +## About + +Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! + +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + +The pyOpenRPA - free, fast and reliable +Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the PYOPENRPA open license. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +## Wiki + +Now you can use the following docs: + +- ENG Guide HTML [|OPEN GITLAB|](Wiki/ENG_Guide/html/index.html) +- ENG Guide MarkDown [|OPEN GITLAB|](Wiki/ENG_Guide/markdown/index.md) +- ENG Guide PDF [|OPEN GITLAB|](Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) + +- RUS Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) +- RUS Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/DesktopGUI_Habr/README.md) +- RUS Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/WebGUI_Habr/3.%20WebGUI_Habr.md) +- RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) + +## Copyrights & Contacts +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. +My purpose is to create #IT4Business models. +If you need IT help feel free to contact me. + +Ivan Maslov contacts (CEO & FOUNDER): + +- E-mail: Ivan.Maslov@pyOpenRPA.ru +- Skype: MegaFinder +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov + diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD similarity index 97% rename from Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD rename to Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD index 23916d31..d9a99da1 100644 --- a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD +++ b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD @@ -1,15 +1,9 @@ -pyOpenRPA-1.2.7.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 -pyOpenRPA-1.2.7.dist-info/METADATA,sha256=BzhjdELqdQkNJuXEIKiYjzPFg1-cNp2PHBfF9sVzBT4,3744 -pyOpenRPA-1.2.7.dist-info/RECORD,, -pyOpenRPA-1.2.7.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 -pyOpenRPA-1.2.7.dist-info/WHEEL,sha256=qB97nP5e4MrOsXW5bIU5cUn_KSVr10EV0l-GCHG9qNs,97 -pyOpenRPA-1.2.7.dist-info/top_level.txt,sha256=RPzwQXgYBRo_m5L3ZLs6Voh8aEkMeT29Xsul1w1qE0g,10 -pyOpenRPA/.idea/inspectionProfiles/profiles_settings.xml,sha256=YXLFmX7rPNGcnKK1uX1uKYPN0fpgskYNe7t0BV7cqkY,174 -pyOpenRPA/.idea/misc.xml,sha256=V-fQnOz-bYEZULgfbFgm-8mURphZrKfXMSd0wKjeEyA,188 -pyOpenRPA/.idea/modules.xml,sha256=Q__U1JIA2cjxbLRXAv-SfYY00fZA0TNlpkkbY4s3ncg,277 -pyOpenRPA/.idea/pyOpenRPA.iml,sha256=EXh41F8lqRiSBMVg-n2tKaEaHC6_3gGSuKkPJA12Na0,408 -pyOpenRPA/.idea/vcs.xml,sha256=2HygA1oRAwc3VBf-irxHrX5JJG9DXuQwrN0BlubhoKY,191 -pyOpenRPA/.idea/workspace.xml,sha256=6tJZehshdK4And6tEoUvkIB0KE7waL_NnTSkTYYAeFA,3802 +pyOpenRPA-1.2.8.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 +pyOpenRPA-1.2.8.dist-info/METADATA,sha256=x3nGjVFNGZqhxaCQPUaRI7GTQlV4la4j11ZEndmBfws,4110 +pyOpenRPA-1.2.8.dist-info/RECORD,, +pyOpenRPA-1.2.8.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 +pyOpenRPA-1.2.8.dist-info/WHEEL,sha256=qB97nP5e4MrOsXW5bIU5cUn_KSVr10EV0l-GCHG9qNs,97 +pyOpenRPA-1.2.8.dist-info/top_level.txt,sha256=RPzwQXgYBRo_m5L3ZLs6Voh8aEkMeT29Xsul1w1qE0g,10 pyOpenRPA/Agent/A2O.py,sha256=PlIZZCTnVrYF2i6DSAi_KbzZfc2gtcBPmOerrEZq68U,1718 pyOpenRPA/Agent/O2A.py,sha256=XHl5nytUoUqfPvmYWh5auYo-s0GIThNmkOA9ON-JCis,5535 pyOpenRPA/Agent/Processor.py,sha256=xNZfQ_HcV-qm_x90tBLKYJqvnENiTqHSoUk2LhDfqWQ,6346 @@ -22,6 +16,7 @@ pyOpenRPA/Agent/__pycache__/__Agent__.cpython-37.pyc,, pyOpenRPA/Agent/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/Agent/readme.md,sha256=QF_Bnv204OK3t1JUEhjfICkxFmSdX6bvaRl_HI6lH9I,19 pyOpenRPA/Info.md,sha256=u4Nv-PjniSF0Zlbtr6jEJX2vblK3_1zhSLNUgOdtDaA,85 +pyOpenRPA/LICENSE.pdf,sha256=HEqffy8FIWpylw0zF7k-Wgwd8ppWQT9s9EGBgKV-6G8,321175 pyOpenRPA/Orchestrator/BackwardCompatibility.py,sha256=CpJtOc_WnV14AGIU7FKVRuemlf9bSr4Eo5_67wuyi_k,37506 pyOpenRPA/Orchestrator/ControlPanel.py,sha256=OzS8HjG__8OZgqhajr8L8owyugXPuSLWHLtXuKdEP78,103 pyOpenRPA/Orchestrator/Core.py,sha256=OHa3mSC3_wRAizqrWBVjlR6ln4-xVVvBpOSnWl6qVvY,529 @@ -95,7 +90,7 @@ pyOpenRPA/Orchestrator/__pycache__/Timer.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__Orchestrator__.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__main__.cpython-37.pyc,, -pyOpenRPA/README.md,sha256=e2hKh7Tx6DAsX6jY_hBDhguL1L2Wiv6iugDB5otMzIA,2293 +pyOpenRPA/README.md,sha256=Sm-GOS-s3QkxFPFUW_FrFE7ZTcSDMbDznsUK7nLGJ7M,2521 pyOpenRPA/Resources/Web/Google/LatoItalic.css,sha256=pB6OZ6F2VsaqkL-g5hW-wE_T0m9H_NltzmzjX-XAKDk,3112 pyOpenRPA/Resources/Web/Handlebars/handlebars-v4.1.2.js,sha256=h6O4BrhyPtJspLDEQwogC53uHFRozuBpxvN2S4tJHE8,171994 pyOpenRPA/Resources/Web/JsRender/jsrender.min.js,sha256=00hs6PwCiAfN_gatFdLofj3yBf8ue5Z7jCXX_th2FFg,25927 @@ -349,6 +344,6 @@ pyOpenRPA/Tools/StopSafe.py,sha256=BNTtMmvsRE1Wtri3EkwhoBi6gGOjEPRQnJSV1C03c84,2 pyOpenRPA/Tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 pyOpenRPA/Tools/__pycache__/StopSafe.cpython-37.pyc,, pyOpenRPA/Tools/__pycache__/__init__.cpython-37.pyc,, -pyOpenRPA/__init__.py,sha256=thBwsh1ouqe_mKoJCCECIcKbo7oF6WPz9ZV52uvuPQM,174 +pyOpenRPA/__init__.py,sha256=JANgL8ICc-bOKqhDpeGii5JiI3_Ul8ngccEquMcHbmc,174 pyOpenRPA/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/test.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/REQUESTED b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/REQUESTED similarity index 100% rename from Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/REQUESTED rename to Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/REQUESTED diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/WHEEL b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/WHEEL similarity index 100% rename from Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/WHEEL rename to Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/WHEEL diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/top_level.txt b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/top_level.txt similarity index 100% rename from Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/top_level.txt rename to Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/top_level.txt diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/LICENSE.pdf b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/LICENSE.pdf new file mode 100644 index 00000000..0ecaa7ed Binary files /dev/null and b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/LICENSE.pdf differ diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/README.md b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/README.md index f5f30305..51cf0982 100644 --- a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/README.md +++ b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/README.md @@ -1,58 +1,53 @@ -# OpenRPA -First open source RPA platform for business is released! - -# How to run -Studio -Double click to Studio\StudioRun_32.cmd or Studio\StudioRun_64.cmd - -# Robot how to debug -Robot\PythonDebug_64.cmd -import Robot -Robot.ActivityRun( - { - ModuleName: <"GUI"|..., str>, - ActivityName: , - ArgumentList: [, ...] - optional, - ArgumentDict: {:, ...} - optional - } -) - -# Robot example script: -Robot\Examples\GetFolderList\Python_32_Script_Run.cmd - -# Python 32 bit -Resources\WPy32-3720\python-3.7.2\python.exe - -# Python 64 bit -Resources\WPy64-3720\python-3.7.2.amd64\python.exe - -# Module GUI activity List: -############################ -Новая версия -############################ -Получить список элементов, который удовлетворяет условиям через расширенный движок поиска -[ - { - "index":<Позиция элемента в родительском объекте>, - "depth_start" - глубина, с которой начинается поиск (по умолчанию 1) - "depth_end" - глубина, до которой ведется поиск (по умолчанию 1) - "class_name" - наименование класса, который требуется искать - "title" - наименование заголовка - "rich_text" - наименование rich_text - } -] - - -# Open RPA Wiki -- [Home](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/home) -- [04. Desktop app access (win32 & ui automation)](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/04.-Desktop-app-access-(win32-&-ui-automation)) - -#Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - -Created by Unicode Labs (Ivan Maslov) \ No newline at end of file + +# Welcome to pyOpenRPA’s wiki + + +![image](Wiki/ENG_Guide/markdown/img/ModalGuide.png) + +*by Ivan Maslov (Russia)* + +## Donate + +pyOpenRPA is a commercial project. + +## About + +Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! + +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + +The pyOpenRPA - free, fast and reliable +Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the PYOPENRPA open license. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +## Wiki + +Now you can use the following docs: + +- ENG Guide HTML [|OPEN GITLAB|](Wiki/ENG_Guide/html/index.html) +- ENG Guide MarkDown [|OPEN GITLAB|](Wiki/ENG_Guide/markdown/index.md) +- ENG Guide PDF [|OPEN GITLAB|](Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) + +- RUS Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) +- RUS Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/DesktopGUI_Habr/README.md) +- RUS Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/WebGUI_Habr/3.%20WebGUI_Habr.md) +- RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) + +## Copyrights & Contacts +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. +My purpose is to create #IT4Business models. +If you need IT help feel free to contact me. + +Ivan Maslov contacts (CEO & FOUNDER): + +- E-mail: Ivan.Maslov@pyOpenRPA.ru +- Skype: MegaFinder +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov \ No newline at end of file diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/__init__.py b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/__init__.py index bcb3231f..ab1f13c3 100644 --- a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/__init__.py +++ b/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA/__init__.py @@ -3,7 +3,7 @@ r""" The OpenRPA package (from UnicodeLabs) """ -__version__ = 'v1.2.7' +__version__ = 'v1.2.8' __all__ = [] __author__ = 'Ivan Maslov ' #from .Core import Robot \ No newline at end of file diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA deleted file mode 100644 index 2d9287f9..00000000 --- a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/METADATA +++ /dev/null @@ -1,93 +0,0 @@ -Metadata-Version: 2.1 -Name: pyOpenRPA -Version: 1.2.7 -Summary: First open source RPA platform for business -Home-page: https://pyopenrpa.ru/ -Author: Ivan Maslov -Author-email: Ivan.Maslov@pyopenrpa.ru -License: PYOPENRPA -Keywords: pyOpenRPA OpenRPA RPA Robot Automation Robotization OpenSource IT4Business -Platform: UNKNOWN -Classifier: Development Status :: 5 - Production/Stable -Classifier: License :: Free For Educational Use -Classifier: License :: Free For Home Use -Classifier: License :: Free for non-commercial use -Classifier: Intended Audience :: Developers -Classifier: Environment :: Win32 (MS Windows) -Classifier: Environment :: X11 Applications -Classifier: Programming Language :: Python -Classifier: Programming Language :: Python :: 3.7 -Classifier: Topic :: Software Development :: Libraries :: Python Modules -Classifier: Topic :: Software Development :: Testing -Classifier: Topic :: Software Development :: User Interfaces -Classifier: Topic :: Software Development :: Quality Assurance -Classifier: Topic :: Home Automation -Description-Content-Type: text/markdown -Requires-Dist: pillow (>=6.0.0) -Requires-Dist: keyboard (>=0.13.3) -Requires-Dist: pyautogui (<=0.9.52) -Requires-Dist: crypto (>=1.4.1) -Requires-Dist: schedule (>=1.1.0) -Requires-Dist: pywinauto (>=0.6.8) ; platform_system == "win32" and python_version >= "3.0" -Requires-Dist: WMI (>=1.4.9) ; platform_system == "win32" and python_version >= "3.0" -Requires-Dist: pywin32 (>=224) ; platform_system == "win32" and python_version >= "3.0" - -# OpenRPA -First open source RPA platform for business is released! - -# How to run -Studio -Double click to Studio\StudioRun_32.cmd or Studio\StudioRun_64.cmd - -# Robot how to debug -Robot\PythonDebug_64.cmd -import Robot -Robot.ActivityRun( - { - ModuleName: <"GUI"|..., str>, - ActivityName: , - ArgumentList: [, ...] - optional, - ArgumentDict: {:, ...} - optional - } -) - -# Robot example script: -Robot\Examples\GetFolderList\Python_32_Script_Run.cmd - -# Python 32 bit -Resources\WPy32-3720\python-3.7.2\python.exe - -# Python 64 bit -Resources\WPy64-3720\python-3.7.2.amd64\python.exe - -# Module GUI activity List: -############################ -Новая версия -############################ -Получить список элементов, который удовлетворяет условиям через расширенный движок поиска -[ - { - "index":<Позиция элемента в родительском объекте>, - "depth_start" - глубина, с которой начинается поиск (по умолчанию 1) - "depth_end" - глубина, до которой ведется поиск (по умолчанию 1) - "class_name" - наименование класса, который требуется искать - "title" - наименование заголовка - "rich_text" - наименование rich_text - } -] - - -# Open RPA Wiki -- [Home](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/home) -- [04. Desktop app access (win32 & ui automation)](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/04.-Desktop-app-access-(win32-&-ui-automation)) - -#Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - -Created by Unicode Labs (Ivan Maslov) - diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/INSTALLER b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/INSTALLER similarity index 100% rename from Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/INSTALLER rename to Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/INSTALLER diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA new file mode 100644 index 00000000..0a87afa2 --- /dev/null +++ b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/METADATA @@ -0,0 +1,88 @@ +Metadata-Version: 2.1 +Name: pyOpenRPA +Version: 1.2.8 +Summary: First open source RPA platform for business +Home-page: https://pyopenrpa.ru/ +Author: Ivan Maslov +Author-email: Ivan.Maslov@pyopenrpa.ru +License: Текст лицензии см. в файле: LICENSE.PDF (в корне) или по адресу: https://pyopenrpa.ru/license/oferta.pdf +Keywords: pyOpenRPA OpenRPA RPA Robot Automation Robotization OpenSource IT4Business +Platform: UNKNOWN +Classifier: Development Status :: 5 - Production/Stable +Classifier: License :: Free For Educational Use +Classifier: License :: Free For Home Use +Classifier: License :: Free for non-commercial use +Classifier: Intended Audience :: Developers +Classifier: Environment :: Win32 (MS Windows) +Classifier: Environment :: X11 Applications +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 3.7 +Classifier: Topic :: Software Development :: Libraries :: Python Modules +Classifier: Topic :: Software Development :: Testing +Classifier: Topic :: Software Development :: User Interfaces +Classifier: Topic :: Software Development :: Quality Assurance +Classifier: Topic :: Home Automation +Description-Content-Type: text/markdown +Requires-Dist: pillow (>=6.0.0) +Requires-Dist: keyboard (>=0.13.3) +Requires-Dist: pyautogui (<=0.9.52) +Requires-Dist: crypto (>=1.4.1) +Requires-Dist: schedule (>=1.1.0) +Requires-Dist: pywinauto (>=0.6.8) ; platform_system == "win32" and python_version >= "3.0" +Requires-Dist: WMI (>=1.4.9) ; platform_system == "win32" and python_version >= "3.0" +Requires-Dist: pywin32 (>=224) ; platform_system == "win32" and python_version >= "3.0" + + +# Welcome to pyOpenRPA’s wiki + + +![image](Wiki/ENG_Guide/markdown/img/ModalGuide.png) + +*by Ivan Maslov (Russia)* + +## Donate + +pyOpenRPA is a commercial project. + +## About + +Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! + +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + +The pyOpenRPA - free, fast and reliable +Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the PYOPENRPA open license. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +## Wiki + +Now you can use the following docs: + +- ENG Guide HTML [|OPEN GITLAB|](Wiki/ENG_Guide/html/index.html) +- ENG Guide MarkDown [|OPEN GITLAB|](Wiki/ENG_Guide/markdown/index.md) +- ENG Guide PDF [|OPEN GITLAB|](Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) + +- RUS Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) +- RUS Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/DesktopGUI_Habr/README.md) +- RUS Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/WebGUI_Habr/3.%20WebGUI_Habr.md) +- RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) + +## Copyrights & Contacts +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. +My purpose is to create #IT4Business models. +If you need IT help feel free to contact me. + +Ivan Maslov contacts (CEO & FOUNDER): + +- E-mail: Ivan.Maslov@pyOpenRPA.ru +- Skype: MegaFinder +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov + diff --git a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD similarity index 97% rename from Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD rename to Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD index 23916d31..d9a99da1 100644 --- a/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/RECORD +++ b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/RECORD @@ -1,15 +1,9 @@ -pyOpenRPA-1.2.7.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 -pyOpenRPA-1.2.7.dist-info/METADATA,sha256=BzhjdELqdQkNJuXEIKiYjzPFg1-cNp2PHBfF9sVzBT4,3744 -pyOpenRPA-1.2.7.dist-info/RECORD,, -pyOpenRPA-1.2.7.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 -pyOpenRPA-1.2.7.dist-info/WHEEL,sha256=qB97nP5e4MrOsXW5bIU5cUn_KSVr10EV0l-GCHG9qNs,97 -pyOpenRPA-1.2.7.dist-info/top_level.txt,sha256=RPzwQXgYBRo_m5L3ZLs6Voh8aEkMeT29Xsul1w1qE0g,10 -pyOpenRPA/.idea/inspectionProfiles/profiles_settings.xml,sha256=YXLFmX7rPNGcnKK1uX1uKYPN0fpgskYNe7t0BV7cqkY,174 -pyOpenRPA/.idea/misc.xml,sha256=V-fQnOz-bYEZULgfbFgm-8mURphZrKfXMSd0wKjeEyA,188 -pyOpenRPA/.idea/modules.xml,sha256=Q__U1JIA2cjxbLRXAv-SfYY00fZA0TNlpkkbY4s3ncg,277 -pyOpenRPA/.idea/pyOpenRPA.iml,sha256=EXh41F8lqRiSBMVg-n2tKaEaHC6_3gGSuKkPJA12Na0,408 -pyOpenRPA/.idea/vcs.xml,sha256=2HygA1oRAwc3VBf-irxHrX5JJG9DXuQwrN0BlubhoKY,191 -pyOpenRPA/.idea/workspace.xml,sha256=6tJZehshdK4And6tEoUvkIB0KE7waL_NnTSkTYYAeFA,3802 +pyOpenRPA-1.2.8.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 +pyOpenRPA-1.2.8.dist-info/METADATA,sha256=x3nGjVFNGZqhxaCQPUaRI7GTQlV4la4j11ZEndmBfws,4110 +pyOpenRPA-1.2.8.dist-info/RECORD,, +pyOpenRPA-1.2.8.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 +pyOpenRPA-1.2.8.dist-info/WHEEL,sha256=qB97nP5e4MrOsXW5bIU5cUn_KSVr10EV0l-GCHG9qNs,97 +pyOpenRPA-1.2.8.dist-info/top_level.txt,sha256=RPzwQXgYBRo_m5L3ZLs6Voh8aEkMeT29Xsul1w1qE0g,10 pyOpenRPA/Agent/A2O.py,sha256=PlIZZCTnVrYF2i6DSAi_KbzZfc2gtcBPmOerrEZq68U,1718 pyOpenRPA/Agent/O2A.py,sha256=XHl5nytUoUqfPvmYWh5auYo-s0GIThNmkOA9ON-JCis,5535 pyOpenRPA/Agent/Processor.py,sha256=xNZfQ_HcV-qm_x90tBLKYJqvnENiTqHSoUk2LhDfqWQ,6346 @@ -22,6 +16,7 @@ pyOpenRPA/Agent/__pycache__/__Agent__.cpython-37.pyc,, pyOpenRPA/Agent/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/Agent/readme.md,sha256=QF_Bnv204OK3t1JUEhjfICkxFmSdX6bvaRl_HI6lH9I,19 pyOpenRPA/Info.md,sha256=u4Nv-PjniSF0Zlbtr6jEJX2vblK3_1zhSLNUgOdtDaA,85 +pyOpenRPA/LICENSE.pdf,sha256=HEqffy8FIWpylw0zF7k-Wgwd8ppWQT9s9EGBgKV-6G8,321175 pyOpenRPA/Orchestrator/BackwardCompatibility.py,sha256=CpJtOc_WnV14AGIU7FKVRuemlf9bSr4Eo5_67wuyi_k,37506 pyOpenRPA/Orchestrator/ControlPanel.py,sha256=OzS8HjG__8OZgqhajr8L8owyugXPuSLWHLtXuKdEP78,103 pyOpenRPA/Orchestrator/Core.py,sha256=OHa3mSC3_wRAizqrWBVjlR6ln4-xVVvBpOSnWl6qVvY,529 @@ -95,7 +90,7 @@ pyOpenRPA/Orchestrator/__pycache__/Timer.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__Orchestrator__.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/Orchestrator/__pycache__/__main__.cpython-37.pyc,, -pyOpenRPA/README.md,sha256=e2hKh7Tx6DAsX6jY_hBDhguL1L2Wiv6iugDB5otMzIA,2293 +pyOpenRPA/README.md,sha256=Sm-GOS-s3QkxFPFUW_FrFE7ZTcSDMbDznsUK7nLGJ7M,2521 pyOpenRPA/Resources/Web/Google/LatoItalic.css,sha256=pB6OZ6F2VsaqkL-g5hW-wE_T0m9H_NltzmzjX-XAKDk,3112 pyOpenRPA/Resources/Web/Handlebars/handlebars-v4.1.2.js,sha256=h6O4BrhyPtJspLDEQwogC53uHFRozuBpxvN2S4tJHE8,171994 pyOpenRPA/Resources/Web/JsRender/jsrender.min.js,sha256=00hs6PwCiAfN_gatFdLofj3yBf8ue5Z7jCXX_th2FFg,25927 @@ -349,6 +344,6 @@ pyOpenRPA/Tools/StopSafe.py,sha256=BNTtMmvsRE1Wtri3EkwhoBi6gGOjEPRQnJSV1C03c84,2 pyOpenRPA/Tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 pyOpenRPA/Tools/__pycache__/StopSafe.cpython-37.pyc,, pyOpenRPA/Tools/__pycache__/__init__.cpython-37.pyc,, -pyOpenRPA/__init__.py,sha256=thBwsh1ouqe_mKoJCCECIcKbo7oF6WPz9ZV52uvuPQM,174 +pyOpenRPA/__init__.py,sha256=JANgL8ICc-bOKqhDpeGii5JiI3_Ul8ngccEquMcHbmc,174 pyOpenRPA/__pycache__/__init__.cpython-37.pyc,, pyOpenRPA/test.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/REQUESTED b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/REQUESTED similarity index 100% rename from Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/REQUESTED rename to Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/REQUESTED diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/WHEEL b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/WHEEL similarity index 100% rename from Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/WHEEL rename to Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/WHEEL diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/top_level.txt b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/top_level.txt similarity index 100% rename from Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.7.dist-info/top_level.txt rename to Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA-1.2.8.dist-info/top_level.txt diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/LICENSE.pdf b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/LICENSE.pdf new file mode 100644 index 00000000..0ecaa7ed Binary files /dev/null and b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/LICENSE.pdf differ diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/README.md b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/README.md index f5f30305..51cf0982 100644 --- a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/README.md +++ b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/README.md @@ -1,58 +1,53 @@ -# OpenRPA -First open source RPA platform for business is released! - -# How to run -Studio -Double click to Studio\StudioRun_32.cmd or Studio\StudioRun_64.cmd - -# Robot how to debug -Robot\PythonDebug_64.cmd -import Robot -Robot.ActivityRun( - { - ModuleName: <"GUI"|..., str>, - ActivityName: , - ArgumentList: [, ...] - optional, - ArgumentDict: {:, ...} - optional - } -) - -# Robot example script: -Robot\Examples\GetFolderList\Python_32_Script_Run.cmd - -# Python 32 bit -Resources\WPy32-3720\python-3.7.2\python.exe - -# Python 64 bit -Resources\WPy64-3720\python-3.7.2.amd64\python.exe - -# Module GUI activity List: -############################ -Новая версия -############################ -Получить список элементов, который удовлетворяет условиям через расширенный движок поиска -[ - { - "index":<Позиция элемента в родительском объекте>, - "depth_start" - глубина, с которой начинается поиск (по умолчанию 1) - "depth_end" - глубина, до которой ведется поиск (по умолчанию 1) - "class_name" - наименование класса, который требуется искать - "title" - наименование заголовка - "rich_text" - наименование rich_text - } -] - - -# Open RPA Wiki -- [Home](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/home) -- [04. Desktop app access (win32 & ui automation)](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/04.-Desktop-app-access-(win32-&-ui-automation)) - -#Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - -Created by Unicode Labs (Ivan Maslov) \ No newline at end of file + +# Welcome to pyOpenRPA’s wiki + + +![image](Wiki/ENG_Guide/markdown/img/ModalGuide.png) + +*by Ivan Maslov (Russia)* + +## Donate + +pyOpenRPA is a commercial project. + +## About + +Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! + +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + +The pyOpenRPA - free, fast and reliable +Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the PYOPENRPA open license. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +## Wiki + +Now you can use the following docs: + +- ENG Guide HTML [|OPEN GITLAB|](Wiki/ENG_Guide/html/index.html) +- ENG Guide MarkDown [|OPEN GITLAB|](Wiki/ENG_Guide/markdown/index.md) +- ENG Guide PDF [|OPEN GITLAB|](Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) + +- RUS Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) +- RUS Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/DesktopGUI_Habr/README.md) +- RUS Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/WebGUI_Habr/3.%20WebGUI_Habr.md) +- RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) + +## Copyrights & Contacts +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. +My purpose is to create #IT4Business models. +If you need IT help feel free to contact me. + +Ivan Maslov contacts (CEO & FOUNDER): + +- E-mail: Ivan.Maslov@pyOpenRPA.ru +- Skype: MegaFinder +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov \ No newline at end of file diff --git a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/__init__.py b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/__init__.py index bcb3231f..ab1f13c3 100644 --- a/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/__init__.py +++ b/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/pyOpenRPA/__init__.py @@ -3,7 +3,7 @@ r""" The OpenRPA package (from UnicodeLabs) """ -__version__ = 'v1.2.7' +__version__ = 'v1.2.8' __all__ = [] __author__ = 'Ivan Maslov ' #from .Core import Robot \ No newline at end of file diff --git a/Sources/GuideSphinx/03_Copyrights_Contacts.rst b/Sources/GuideSphinx/03_Copyrights_Contacts.rst index b02d3ee3..b67d5cc2 100644 --- a/Sources/GuideSphinx/03_Copyrights_Contacts.rst +++ b/Sources/GuideSphinx/03_Copyrights_Contacts.rst @@ -19,17 +19,15 @@ If you will find some issue in pyOpenRPA - write about it to me via e-mail/skype Thank you! ************************************************** -Ivan Maslov (founder) +Ivan Maslov (CEO & FOUNDER) ************************************************** -- E-mail: Ivan.Maslov@UnicodeLabs.ru +Our contacts: +- E-mail: Ivan.Maslov@pyOpenRPA.ru - Skype: MegaFinder - -- Facebook: https://www.facebook.com/RU.IT4Business - -- LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ - -- WhatsApp | Telegram: +7 906 722 39 25 +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov ************************************************** diff --git a/Sources/GuideSphinx/index.rst b/Sources/GuideSphinx/index.rst index 884bcbac..59424d38 100644 --- a/Sources/GuideSphinx/index.rst +++ b/Sources/GuideSphinx/index.rst @@ -26,7 +26,7 @@ The pyOpenRPA - free, fast and reliable Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. -The pyOpenRPA is distributed under the PYOPENRPA license. +The pyOpenRPA is distributed under the PYOPENRPA open license. At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. ************************************************** diff --git a/Sources/pyOpenRPA/LICENSE.pdf b/Sources/pyOpenRPA/LICENSE.pdf new file mode 100644 index 00000000..0ecaa7ed Binary files /dev/null and b/Sources/pyOpenRPA/LICENSE.pdf differ diff --git a/Sources/pyOpenRPA/README.md b/Sources/pyOpenRPA/README.md index f5f30305..51cf0982 100644 --- a/Sources/pyOpenRPA/README.md +++ b/Sources/pyOpenRPA/README.md @@ -1,58 +1,53 @@ -# OpenRPA -First open source RPA platform for business is released! - -# How to run -Studio -Double click to Studio\StudioRun_32.cmd or Studio\StudioRun_64.cmd - -# Robot how to debug -Robot\PythonDebug_64.cmd -import Robot -Robot.ActivityRun( - { - ModuleName: <"GUI"|..., str>, - ActivityName: , - ArgumentList: [, ...] - optional, - ArgumentDict: {:, ...} - optional - } -) - -# Robot example script: -Robot\Examples\GetFolderList\Python_32_Script_Run.cmd - -# Python 32 bit -Resources\WPy32-3720\python-3.7.2\python.exe - -# Python 64 bit -Resources\WPy64-3720\python-3.7.2.amd64\python.exe - -# Module GUI activity List: -############################ -Новая версия -############################ -Получить список элементов, который удовлетворяет условиям через расширенный движок поиска -[ - { - "index":<Позиция элемента в родительском объекте>, - "depth_start" - глубина, с которой начинается поиск (по умолчанию 1) - "depth_end" - глубина, до которой ведется поиск (по умолчанию 1) - "class_name" - наименование класса, который требуется искать - "title" - наименование заголовка - "rich_text" - наименование rich_text - } -] - - -# Open RPA Wiki -- [Home](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/home) -- [04. Desktop app access (win32 & ui automation)](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/04.-Desktop-app-access-(win32-&-ui-automation)) - -#Dependencies -* Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -* pywinauto (Windows GUI automation) -* Semantic UI CSS framework -* JsRender by https://www.jsviews.com (switch to Handlebars) -* Handlebars - -Created by Unicode Labs (Ivan Maslov) \ No newline at end of file + +# Welcome to pyOpenRPA’s wiki + + +![image](Wiki/ENG_Guide/markdown/img/ModalGuide.png) + +*by Ivan Maslov (Russia)* + +## Donate + +pyOpenRPA is a commercial project. + +## About + +Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! + +pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) + +The pyOpenRPA - free, fast and reliable +Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! + +The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. +The pyOpenRPA is distributed under the PYOPENRPA open license. +At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. + +## Wiki + +Now you can use the following docs: + +- ENG Guide HTML [|OPEN GITLAB|](Wiki/ENG_Guide/html/index.html) +- ENG Guide MarkDown [|OPEN GITLAB|](Wiki/ENG_Guide/markdown/index.md) +- ENG Guide PDF [|OPEN GITLAB|](Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) + +- RUS Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) +- RUS Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/DesktopGUI_Habr/README.md) +- RUS Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](Wiki/RUS_Tutorial/WebGUI_Habr/3.%20WebGUI_Habr.md) +- RUS Leaflet pyOpenRPA v5.pdf [|OPEN GITLAB|](Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v5.pdf) + +## Copyrights & Contacts +pyOpenRPA is created by Ivan Maslov (Russia). Use it for free only for non-commercial purposes. For commercial purpose please ask pyOpenRPA vendor for license. +My purpose is to create #IT4Business models. +If you need IT help feel free to contact me. + +Ivan Maslov contacts (CEO & FOUNDER): + +- E-mail: Ivan.Maslov@pyOpenRPA.ru +- Skype: MegaFinder +- Web: https://pyopenrpa.ru/ +- Telegram: https://t.me/pyopenrpa +- WhatsApp | Telegram: +7 906 722 39 25 | @IvanMaslov \ No newline at end of file diff --git a/Sources/pyOpenRPA/__init__.py b/Sources/pyOpenRPA/__init__.py index bcb3231f..ab1f13c3 100644 --- a/Sources/pyOpenRPA/__init__.py +++ b/Sources/pyOpenRPA/__init__.py @@ -3,7 +3,7 @@ r""" The OpenRPA package (from UnicodeLabs) """ -__version__ = 'v1.2.7' +__version__ = 'v1.2.8' __all__ = [] __author__ = 'Ivan Maslov ' #from .Core import Robot \ No newline at end of file diff --git a/Sources/setup.py b/Sources/setup.py index 94f953e6..830b5ba7 100644 --- a/Sources/setup.py +++ b/Sources/setup.py @@ -25,6 +25,8 @@ datafile = "pyOpenRPA\\Tools\\RobotRDPActive\\Template.rdp" datafiles = datafiles + [datafile] datafile = "pyOpenRPA\\Tools\\RobotScreenActive\\ConsoleStart.bat" datafiles = datafiles + [datafile] +datafile = "pyOpenRPA\\LICENSE.pdf" +datafiles = datafiles + [datafile] setup(name='pyOpenRPA', version=Version.Get(".."), description='First open source RPA platform for business', @@ -50,7 +52,7 @@ setup(name='pyOpenRPA', url='https://pyopenrpa.ru/', author='Ivan Maslov', author_email='Ivan.Maslov@pyopenrpa.ru', - license='PYOPENRPA', + license='Текст лицензии см. в файле: LICENSE.PDF (в корне) или по адресу: https://pyopenrpa.ru/license/oferta.pdf', packages=find_packages(), install_requires=[ 'pywinauto>=0.6.8;platform_system=="win32" and python_version>="3.0"', diff --git a/Wiki/ENG_Guide/html/.buildinfo b/Wiki/ENG_Guide/html/.buildinfo deleted file mode 100644 index 4b1d2442..00000000 --- a/Wiki/ENG_Guide/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1f7d335ae78af2465667fce9967ef73c -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/Wiki/ENG_Guide/html/01_HowToInstall.html b/Wiki/ENG_Guide/html/01_HowToInstall.html deleted file mode 100644 index 6312cc36..00000000 --- a/Wiki/ENG_Guide/html/01_HowToInstall.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - 1. How to install — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

1. How to install

-

Are you ready to install the pyOpenRPA solution on your machine?

-

Ok, we start. -Do the following operations:

- -

Installation has been completed :)

-
-

How to check installation

-
    -

  • Run portable python (built in the pyOpenRPA)

    -
      -

    • x32 python (GIT\Resources\WPy32-3720\python-3.7.2\python.exe)

      • -

    • x64 python (GIT\Resources\WPy64-3720\python-3.7.2.amd64\python.exe)

      • -
    -
    • -
-

The pyOpenRPA has been successfully installed if the portable python 3.7.2 was started without any exceptions (see screenshot).

-cb5dec8cecafa7d64f6cd14b2672acce.png -
-
-

System requirements

-
    -

  • OS Windows 7+. Need Windows package KB2999226 if use windows Vista/7/8/8.1/Server 2008/Server 2012 (https://support.microsoft.com/ru-ru/help/2999226)

    • -

  • For OpenCV: OS Windows 7/8/8/10 only (no Windows Server)

    • -
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/02_RoadMap.html b/Wiki/ENG_Guide/html/02_RoadMap.html deleted file mode 100644 index f10cb40b..00000000 --- a/Wiki/ENG_Guide/html/02_RoadMap.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - 2. Roadmap — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. Roadmap

- -
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html b/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html deleted file mode 100644 index 4242e83a..00000000 --- a/Wiki/ENG_Guide/html/03_Copyrights_Contacts.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - - - 3. Copyrights & Contacts — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

3. Copyrights & Contacts

-

pyOpenRPA is created by Ivan Maslov (Russia). -Hosted by PYOPENRPA LLC (Russia)

-

My purpose is to create #IT4Business models in the companies. -I can help you to create the new #IT4Business in your company. -#IT4Business homepage - https://www.facebook.com/RU.IT4Business -#IT4Busines is the methodology which is created for build compact fast and reliable IT function in company. -If you has many IT specialists, very long deadlines for the IT tasks, many bugs in IT software - #IT4Business is for you :)

-

If you need some IT help - feel free to contact me (prefer e-mail or skype). -If you will find some issue in pyOpenRPA - write about it to me via e-mail/skype/gitlab issue.

-

Thank you!

-
-

Ivan Maslov (founder)

- -
-
-

3-rd party components license dependencies

- -
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Agent/02_Defs.html b/Wiki/ENG_Guide/html/Agent/02_Defs.html deleted file mode 100644 index 4c51cf28..00000000 --- a/Wiki/ENG_Guide/html/Agent/02_Defs.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - - - - - 2. Defs — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. Defs

-
-

pyOpenRPA.Agent.__Agent__

-

Functions:

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

OSCMD(inCMDStr[, inRunAsyncBool, …])

Execute CMD on the Agent daemonic process

OSFileBinaryDataBase64StrAppend(…[, …])

Create binary file by the base64 string (safe for JSON transmition)

OSFileBinaryDataBase64StrCreate(…[, …])

Create binary file by the base64 string (safe for JSON transmition)

OSFileBinaryDataBase64StrReceive(inFilePathStr)

Read binary file and encode in base64 to transmit (safe for JSON transmition)

OSFileMTimeGet(inFilePathStr)

Read file modification time timestamp format (float)

OSFileTextDataStrCreate(inFilePathStr, …)

Create text file in the agent GUI session

OSFileTextDataStrReceive(inFilePathStr[, …])

Read text file in the agent GUI session

ProcessWOExeUpperUserListGet()

Return the process list only for the current user (where Agent is running) without .EXE in upper case.

-
-
-pyOpenRPA.Agent.__Agent__.OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings=None, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr='cp1251', inCaptureBool=True)[source]
-

Execute CMD on the Agent daemonic process

-
-
Parameters
-
    -

  • inCMDStr – command to execute on the Agent session

    • -

  • inRunAsyncBool – True - Agent processor don’t wait execution; False - Agent processor wait cmd execution

    • -

  • inGSettings – Agent global settings dict

    • -

  • inSendOutputToOrchestratorLogsBool – True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True

    • -

  • inCMDEncodingStr – Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is “cp1251” early was “cp866” - need test

    • -

  • inCaptureBool – !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrAppend(inFilePathStr, inFileDataBase64Str, inGSettings=None)[source]
-

Create binary file by the base64 string (safe for JSON transmition)

-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str, inGSettings=None)[source]
-

Create binary file by the base64 string (safe for JSON transmition)

-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrReceive(inFilePathStr, inGSettings=None)[source]
-

Read binary file and encode in base64 to transmit (safe for JSON transmition)

-
-
Parameters
-
    -

  • inFilePathStr – File path to read

    • -

  • inGSettings – global settings of the Agent (singleton)

    • -
-
-
Returns
-

File content in string base64 format (use base64.b64decode to decode data). Return None if file is not exist

-
-
-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileMTimeGet(inFilePathStr: str) → float[source]
-

Read file modification time timestamp format (float)

-
-
Parameters
-

inFilePathStr – File path to read

-
-
Returns
-

timestamp (float) Return None if file is not exist

-
-
-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr='utf-8', inGSettings=None)[source]
-

Create text file in the agent GUI session

-
-
Parameters
-
    -

  • inFilePathStr – File abs path

    • -

  • inFileDataStr – File data text content

    • -

  • inEncodingStr – Write file encoding

    • -

  • inGSettings – global settings of the Agent (singleton)

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Agent.__Agent__.OSFileTextDataStrReceive(inFilePathStr, inEncodingStr='utf-8', inGSettings=None)[source]
-

Read text file in the agent GUI session

-
-
Parameters
-
    -

  • inFilePathStr – File abs path

    • -

  • inEncodingStr – Read file encoding. Default utf-8

    • -

  • inGSettings – global settings of the Agent (singleton)

    • -
-
-
Returns
-

File text content in string format (use base64.b64decode to decode data). Return None if file is not exist

-
-
-
- -
-
-pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet()[source]
-

Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent

-
-
Parameters
-

inProcessNameWOExeList –

-
-
Returns
-

list of the agent user process in upper case without .EXE. Example [“NOTEPAD”,”…”],

-
-
-
- -
- -
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html b/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html deleted file mode 100644 index 8178bb62..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/01_Orchestrator.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - - - - - 1. Description — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

1. Description

-

pyOpenRPA Orchestrator is the executable process.

-

The features of the orchestrator is: -- Centralized/decentralized user control interface (applicable and for business users and for technical users). Web based, support desktop, tablet, phone. -- Automatized robots control (customized algorithms, robots scheduling) -- Source code mega flexibility: Light Orchestrator architecture is good for own customization

-
-

Global settings dict concept

-

pyOpenRPA project is complex tool which consist of several executable modules such as Robot, Orchestrator, Studio,

-

Because of module compexity, we use 1 init arg - inGSettings -inGSettings is a complex dictionary which has all reqired parameters for the module execution.

-

The description of the GSettings you can find in executable module details.

-
-
-

Orchestrator how to configure

-

To init pyOpenRPA Orchestrator instance use script:

-

from pyOpenRPA import Orchestrator # Import orchestrator main -gSettings = SettingsTemplate.Create(inModeStr=”BASIC”) # Create GSettings with basic configuration -Orchestrator.Orchestrator(inGSettings=gSettings) # Call the orchestrator def

-

gSettings structure

-
-
-

Orchestrator architecture

-

Orchestrator has several source code components: -- User/robot activity consolidated queue single thread (Processor) -- User/robot activity asynchonus many threads (Processor) -- Scheduler single thread (main) -- RDP keep active many thread -- Autocleaner single thread -- GUI keep active single thread -- HTTP web server single thread (create user socket threads) --

-

Below you can find more information about all of the component.

-
-
-

Component Processor

-

Sync - Append activity list to consolidated processor queue. Execution goes sequency by the activity list order

-

Async - Create New thread to execute the activity list

-
    -

  • Activity list

    • -
-

List of the activity item

-
    -

  • Activity item

    • -
-

Activity item is universal mechanism to execute different algorythms from any sources. -The core feature of the Activity is to call python defs with args and kwargs. -If you need to init do some activity you can write some python def, then create Activity item with current def. -ATTENTION: In some cases (such as web transmition), when you can’t transmit python def as object you can use symbolic names for python defs. It is apply you to init all of you want from the web UI.

-

?Why i cant transmit python def from the web -Because the WEB space is not the Python executable space. Interaction between it spaces create by JSON protocol. So, we know than JSON apply int, float, str, bool, None, list, dict - that is all.

-
-

Note

-

Example -{

-
-

“Def”:”DefAliasTest”, # def link or def alias (look gSettings[“Processor”][“AliasDefDict”]) -“ArgList”:[1,2,3], # Args list -“ArgDict”:{“ttt”:1,”222”:2,”dsd”:3}, # Args dictionary -“ArgGSettings”: None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) -“ArgLogger”: None # Name of GSettings attribute: str (ArgDict) or index (for ArgList)

-
-

}# Pay attention! Do not left comma symbol after the end of the dict - it can be interpretated like a turple..

-
-
-
-

References

-

`Python-sphinx`_

-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/02_Defs.html b/Wiki/ENG_Guide/html/Orchestrator/02_Defs.html deleted file mode 100644 index d58c7260..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/02_Defs.html +++ /dev/null @@ -1,2736 +0,0 @@ - - - - - - - - - - 2. Defs — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. Defs

-
-

pyOpenRPA.Orchestrator.__Orchestrator__

-
# EXAMPLE 1
-from pyOpenRPA import Orchestrator
-Orchestrator.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
-
-# EXAMPLE 2
-from pyOpenRPA.Orchestrator import __Orchestrator__
-__Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True)
-
-
-
-

Group Agent…

-

Interaction between Orchestrator and pyOpenRPA.Agent daemon process, which can be deployed in another user session.

-
-
-

Group GSettings…

-

Basic defs to work with singleton gSettings.

-
-
-

Group Storage…

-

Defs to work with special locations in Orchestrator: Robot, User (TODO), User + Robot (TODO)

-
-
-

Group OS…

-

Interaction with shell on the Orchestrator user session.

-
-
-

Group Process…

-

Interaction with some process on the Orchestrator user session.

-
-
-

Group Processor…

-

Work with Processor queue (see …).

-
-
-

Group Python…

-

Work with extra python modules.

-
-
-

Group RDPSession…

-

Interaction with RDP session, where you can manage some robots.

-
-
-

Group Web…

-

Manipulate the Orchestrator WEB side.

-
-
-

Group UAC…

-

Manipulate the User Access Controls (actual for the Orchestrator WEB access for the business users)

-
-
-

Group Scheduler…

-

Work with activity scheduling.

-

Functions:

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

ActivityItemCreate(inDef[, inArgList, …])

Create activity item.

ActivityItemDefAliasCreate(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)

ActivityItemDefAliasModulesLoad()

Load all def from sys.modules.

ActivityItemDefAliasUpdate(inDef, inAliasStr)

Update alias for def (can be used in ActivityItem in field Def).

ActivityItemHelperDefAutofill(inDef)

Detect def by the name and prepare the activity item dict with values.

ActivityItemHelperDefList([inDefQueryStr])

Create list of the available Def names in activity item. You can use query def filter via arg inDefQueryStr

AgentActivityItemAdd(inHostNameStr, …[, …])

Add activity in AgentDict.

AgentActivityItemExists(inHostNameStr, …)

Check by GUID if ActivityItem has exists in request list.

AgentActivityItemReturnExists(inGUIDStr[, …])

Check by GUID if ActivityItem has been executed and result has come to the Orchestrator

AgentActivityItemReturnGet(inGUIDStr[, …])

Work synchroniously! Wait while result will be recieved.

AgentOSCMD(inHostNameStr, inUserStr, inCMDStr)

Send CMD to OS thought the pyOpenRPA.Agent daemon.

AgentOSFileBinaryDataBase64StrAppend(…[, …])

Append binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)

AgentOSFileBinaryDataBase64StrCreate(…[, …])

Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)

AgentOSFileBinaryDataBase64StrReceive(…[, …])

Read binary file and encode in base64 to transmit (safe for JSON transmition)

AgentOSFileBinaryDataBytesCreate(…[, …])

Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition)

AgentOSFileBinaryDataReceive(inHostNameStr, …)

Read binary file from agent (synchronious)

AgentOSFileSend(inHostNameStr, inUserStr, …)

Send the file from the Orchestrator to Agent (synchroniously) pyOpenRPA.Agent daemon process (safe for JSON transmition).

AgentOSFileTextDataStrCreate(inHostNameStr, …)

Create text file by the string by the pyOpenRPA.Agent daemon process

AgentOSFileTextDataStrReceive(inHostNameStr, …)

Read text file in the agent GUI session

AgentOSLogoff(inHostNameStr, inUserStr)

Logoff the agent user session

AgentProcessWOExeUpperUserListGet(…[, …])

Return the process list only for the current user (where Agent is running) without .EXE in upper case.

GSettingsAutocleaner([inGSettings])

HIDDEN Interval gSettings auto cleaner def to clear some garbage.

GSettingsGet([inGSettings])

Get the GSettings from the singleton module.

GSettingsKeyListValueAppend(inValue[, …])

Append value in GSettings by the key list

GSettingsKeyListValueGet([inKeyList, …])

Get the value from the GSettings by the key list

GSettingsKeyListValueOperatorPlus(inValue[, …])

Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList)

GSettingsKeyListValueSet(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.

OSLogoff()

Logoff the current orchestrator session :return:

OSRemotePCRestart(inHostStr[, inForceBool, …])

Send signal via power shell to restart remote PC ATTENTION: Orchestrator user need to have restart right on the Remote machine to restart PC.

Orchestrator([inGSettings, …])

Main def to start orchestrator

OrchestratorInitWait()

Wait thread while orc will process initial action.

OrchestratorIsAdmin()

Check if Orchestrator process is running as administrator

OrchestratorIsInited()

Check if Orchestrator initial actions were processed

OrchestratorLoggerGet()

Get the logger from the Orchestrator

OrchestratorPySearchInit(inGlobPatternStr[, …])

Search the py files by the glob and do the safe init (in try except).

OrchestratorRerunAsAdmin()

Check if not admin - then rerun orchestrator as administrator

OrchestratorRestart([inGSettings])

Orchestrator restart

OrchestratorScheduleGet()

Get the schedule (schedule.readthedocs.io) from the Orchestrator

OrchestratorSessionRestore([inGSettings])

Check _SessioLast… files in working directory. if exist - load into gsettings (from version 1.2.7) _SessionLast_GSettings.pickle (binary).

OrchestratorSessionSave([inGSettings])

Orchestrator session save in file (from version 1.2.7) _SessionLast_GSettings.pickle (binary)

OrchestratorThreadStart(inDef, *inArgList, …)

Execute def in new thread and pass some args with list and dict types

ProcessDefIntervalCall(inDef, inIntervalSecFloat)

Use this procedure if you need to run periodically some def.

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(inDef[, inAliasStr, …])

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) Deprecated.

ProcessorAliasDefUpdate(inDef, inAliasStr[, …])

Update alias for def (can be used in ActivityItem in field Def).

PythonStart(inModulePathStr, inDefNameStr[, …])

Import module and run def in the Orchestrator process.

RDPSessionCMDRun(inRDPSessionKeyStr, inCMDStr)

Send CMD command to the RDP session “RUN” window

RDPSessionConnect(inRDPSessionKeyStr[, …])

Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists

RDPSessionDisconnect(inRDPSessionKeyStr[, …])

Disconnect the RDP session and stop monitoring it.

RDPSessionDublicatesResolve(inGSettings)

DEVELOPING Search duplicates in GSettings RDPlist !def is developing!

RDPSessionFileStoredRecieve(…[, inGSettings])

Recieve file from RDP session to the Orchestrator session using shared drive in RDP (see RDP Configuration Dict, Shared drive)

RDPSessionFileStoredSend(inRDPSessionKeyStr, …)

Send file from Orchestrator session to the RDP session using shared drive in RDP (see RDP Configuration Dict, Shared drive)

RDPSessionLogoff(inRDPSessionKeyStr[, …])

Logoff the RDP session from the Orchestrator process (close all apps in session when logoff)

RDPSessionMonitorStop(inRDPSessionKeyStr[, …])

Stop monitoring the RDP session by the Orchestrator process.

RDPSessionProcessStartIfNotRunning(…[, …])

Start process in RDP if it is not running (check by the arg inProcessNameWEXEStr)

RDPSessionProcessStop(inRDPSessionKeyStr, …)

Send CMD command to the RDP session “RUN” window.

RDPSessionReconnect(inRDPSessionKeyStr[, …])

Reconnect the RDP session

RDPSessionResponsibilityCheck(inRDPSessionKeyStr)

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)

SchedulerActivityTimeAddWeekly([…])

Add activity item list in scheduler.

Start([inDumpRestoreBool, …])

Start the orchestrator threads execution

StorageRobotExists(inRobotNameStr)

Check if robot storage exists

StorageRobotGet(inRobotNameStr)

Get the robot storage by the robot name.

UACKeyListCheck(inRequest, inRoleKeyList)

Check is client is has access for the key list

UACSuperTokenUpdate(inSuperTokenStr[, …])

Add supertoken for the all access (it is need for the robot communication without human)

UACUpdate(inADLoginStr[, inADStr, …])

Update user access (UAC)

UACUserDictGet(inRequest)

Return user UAC hierarchy dict of the inRequest object.

WebAuditMessageCreate([inRequest, …])

Create message string with request user details (IP, Login etc…).

WebCPUpdate(inCPKeyStr[, inHTMLRenderDef, …])

Add control panel HTML, JSON generator or JS when page init

WebListenCreate([inServerKeyStr, …])

Create listen interface for the web server

WebRequestGet()

Return the web request instance if current thread was created by web request from client.

WebRequestParseBodyBytes([inRequest])

Extract the body in bytes from the request

WebRequestParseBodyJSON([inRequest])

Extract the body in dict/list from the request

WebRequestParseBodyStr([inRequest])

Extract the body in str from the request

WebRequestParseFile([inRequest])

Parse the request - extract the file (name, body in bytes)

WebRequestParsePath([inRequest])

Parse the request - extract the url.

WebRequestResponseSend(inResponeStr[, inRequest])

Send response for the request

WebURLConnectDef(inMethodStr, inURLStr, …)

Connect URL to DEF

WebURLConnectFile(inMethodStr, inURLStr, …)

Connect URL to File

WebURLConnectFolder(inMethodStr, inURLStr, …)

Connect URL to Folder

WebUserInfoGet([inRequest])

Return User info about request

WebUserIsSuperToken([inRequest, inGSettings])

Return bool if request is authentificated with supetoken (token which is never expires)

WebUserUACHierarchyGet([inRequest])

Return User UAC Hierarchy DICT Return {…}

-
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr=None, inThreadBool=False)[source]
-

Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-# EXAMPLE 1
-def TestDef(inArg1Str, inGSettings, inLogger):
-    pass
-lActivityItem = Orchestrator.ActivityItemCreate(
-    inDef = TestDef,
-    inArgList=[],
-    inArgDict={"inArg1Str": "ArgValueStr"},
-    inArgGSettingsStr = "inGSettings",
-    inArgLoggerStr = "inLogger")
-# lActivityItem:
-#   {
-#       "Def":TestDef,
-#       "ArgList":inArgList,
-#       "ArgDict":inArgDict,
-#       "ArgGSettings": "inArgGSettings",
-#       "ArgLogger": "inLogger"
-#   }
-
-# EXAMPLE 2
-def TestDef(inArg1Str):
-    pass
-Orchestrator.ActivityItemDefAliasUpdate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-lActivityItem = Orchestrator.ActivityItemCreate(
-    inDef = "TestDefAlias",
-    inArgList=[],
-    inArgDict={"inArg1Str": "ArgValueStr"},
-    inArgGSettingsStr = None,
-    inArgLoggerStr = None)
-# lActivityItem:
-#   {
-#       "Def":"TestDefAlias",
-#       "ArgList":inArgList,
-#       "ArgDict":inArgDict,
-#       "ArgGSettings": None,
-#       "ArgLogger": None
-#   }
-
-
-
-
Parameters
-
    -

  • inDef – def link or def alias (look gSettings[“Processor”][“AliasDefDict”])

    • -

  • inArgList – Args list for the Def

    • -

  • inArgDict – Args dict for the def

    • -

  • inArgGSettingsStr – Name of def argument of the GSettings dict

    • -

  • inArgLoggerStr – Name of def argument of the logging object

    • -

  • inGUIDStr – GUID which you can specify. If None the GUID will be generated

    • -

  • inThreadBool – True - execute ActivityItem in new thread; False - in processor thread

    • -
-
-
Returns
-

{}

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasCreate(inDef, inAliasStr=None, inGSettings=None)[source]
-

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)

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-def TestDef():
-    pass
-lAliasStr = Orchestrator.ActivityItemDefAliasCreate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-# Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr)
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inDef – Def

    • -

  • inAliasStr – String alias for associated def

    • -
-
-
Returns
-

str Alias string (Alias can be regenerated if previous alias was occupied)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasModulesLoad()[source]
-

Load all def from sys.modules… in ActivityItem def alias dict

-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasUpdate(inDef, inAliasStr, inGSettings=None)[source]
-

Update 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)

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-def TestDef():
-    pass
-Orchestrator.ActivityItemDefAliasUpdate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-# Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias")
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inDef – Def

    • -

  • inAliasStr – String alias for associated def

    • -
-
-
Returns
-

str Alias string

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemHelperDefAutofill(inDef)[source]
-

Detect def by the name and prepare the activity item dict with values.

-
-
Parameters
-

inDef –

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemHelperDefList(inDefQueryStr=None)[source]
-
-

Create list of the available Def names in activity item. You can use query def filter via arg inDefQueryStr

-
-
-
Parameters
-

inDefStr –

-
-
Returns
-

[“ActivityItemDefAliasUpdate”, “ActivityItemDefAliasCreate”, etc…]

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemAdd(inHostNameStr, inUserStr, inActivityItemDict, inGSettings=None)[source]
-

Add activity in AgentDict. Check if item is created

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr – Agent host name

    • -

  • inUserStr – User login, where agent is based

    • -

  • inActivityItemDict – ActivityItem

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemExists(inHostNameStr, inUserStr, inGUIDStr, inGSettings=None)[source]
-

Check by GUID if ActivityItem has exists in request list. If exist - the result response has not been recieved from the agent

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inGUIDStr – GUID String of the ActivityItem

    • -
-
-
Returns
-

True - ActivityItem is exist in AgentDict ; False - else case

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemReturnExists(inGUIDStr, inGSettings=None)[source]
-

Check by GUID if ActivityItem has been executed and result has come to the Orchestrator

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inGUIDStr – GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

    • -
-
-
Returns
-

True - result has been received from the Agent to orc; False - else case

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemReturnGet(inGUIDStr, inCheckIntervalSecFloat=0.5, inGSettings=None)[source]
-

Work synchroniously! Wait while result will be recieved. Get the result of the ActivityItem execution on the Agent side. Before this please check by the def AgentActivityItemReturnExists that result has come to the Orchestrator

-

!ATTENTION! Use only after Orchestrator initialization! Before orchestrator init exception will be raised.

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inGUIDStr – GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

    • -

  • inCheckIntervalSecFloat – Interval in sec of the check Activity Item result

    • -
-
-
Returns
-

Result of the ActivityItem executed on the Agent side anr transmitted to the Orchestrator. IMPORTANT! ONLY JSON ENABLED Types CAN BE TRANSMITTED TO ORCHESTRATOR!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSCMD(inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr='cp1251', inGSettings=None, inCaptureBool=True)[source]
-

Send CMD to OS thought the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr – Agent host name in upper case (example “RPA01”, “RPA_99” and so on). Active agent session you can see on the orchestrator dashboard as Orchestrator admin

    • -

  • inUserStr – Agent user name in upper case (example “UserRPA”). Active agent session you can see on the orchestrator dashboard as Orchestrator admin

    • -

  • inCMDStr – command to execute on the Agent session

    • -

  • inRunAsyncBool – True - Agent processor don’t wait execution; False - Agent processor wait cmd execution

    • -

  • inSendOutputToOrchestratorLogsBool – True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True

    • -

  • inCMDEncodingStr – Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is “cp1251” early was “cp866” - need test

    • -

  • inCaptureBool – !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrAppend(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings=None)[source]
-

Append binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr –

    • -

  • inFileDataBase64Str –

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings=None)[source]
-

Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr –

    • -

  • inFileDataBase64Str –

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrReceive(inHostNameStr, inUserStr, inFilePathStr, inGSettings=None)[source]
-

Read binary file and encode in base64 to transmit (safe for JSON transmition)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr – File path to read

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBytesCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBytes, inGSettings=None)[source]
-

Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr –

    • -

  • inFileDataBytes –

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataReceive(inHostNameStr, inUserStr, inFilePathStr)[source]
-

Read binary file from agent (synchronious)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr – File path to read

    • -
-
-
Returns
-

file data bytes

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileSend(inHostNameStr, inUserStr, inOrchestratorFilePathStr, inAgentFilePathStr, inGSettings=None)[source]
-

Send the file from the Orchestrator to Agent (synchroniously) pyOpenRPA.Agent daemon process (safe for JSON transmition). -Work safety with big files -Thread safe - you can call def even if you dont init the orchestrator - def will be executed later

-
-
-
param inGSettings
-

Global settings dict (singleton)

-
-
param inHostNameStr
-

-
param inUserStr
-

-
param inFilePathStr
-

-
param inFileDataBytes
-

-
return
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataStr, inEncodingStr='utf-8', inGSettings=None)[source]
-

Create text file by the string by the pyOpenRPA.Agent daemon process

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr –

    • -

  • inFileDataStr –

    • -

  • inEncodingStr –

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrReceive(inHostNameStr, inUserStr, inFilePathStr, inEncodingStr='utf-8', inGSettings=None)[source]
-

Read text file in the agent GUI session

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -

  • inFilePathStr – File path to read

    • -

  • inEncodingStr – Text file encoding. Default ‘utf-8’

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSLogoff(inHostNameStr, inUserStr)[source]
-

Logoff the agent user session

-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.AgentProcessWOExeUpperUserListGet(inHostNameStr, inUserStr, inGSettings=None)[source]
-

Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inHostNameStr –

    • -

  • inUserStr –

    • -
-
-
Returns
-

GUID String of the ActivityItem - you can wait (sync or async) result by this guid!

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsAutocleaner(inGSettings=None)[source]
-

HIDDEN Interval gSettings auto cleaner def to clear some garbage.

-
-
Parameters
-

inGSettings – Global settings dict (singleton)

-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsGet(inGSettings=None)[source]
-

Get the GSettings from the singleton module.

-
-
Parameters
-

inGSettings – You can pass some GSettings to check if it equal to base gsettings. If not equal - def will merge it

-
-
Returns
-

GSettings

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueAppend(inValue, inKeyList=None, inGSettings=None)[source]
-

Append value in GSettings by the key list

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-Orchestrator.GSettingsKeyListValueAppend(
-    inGSettings = gSettings,
-    inValue = "NewValue",
-    inKeyList=["NewKeyDict","NewKeyList"]):
-# result inGSettings: {
-#    ... another keys in gSettings ...,
-#    "NewKeyDict":{
-#        "NewKeyList":[
-#            "NewValue"
-#        ]
-#    }
-#}
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inValue – Any value to be appended in gSettings Dict by the key list

    • -

  • inKeyList – List of the nested keys (see example)

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueGet(inKeyList=None, inGSettings=None)[source]
-

Get the value from the GSettings by the key list

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inKeyList –

    • -
-
-
Returns
-

value any type

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueOperatorPlus(inValue, inKeyList=None, inGSettings=None)[source]
-

Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList)

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-Orchestrator.GSettingsKeyListValueOperatorPlus(
-    inGSettings = gSettings,
-    inValue = [1,2,3],
-    inKeyList=["NewKeyDict","NewKeyList"]):
-# result inGSettings: {
-#    ... another keys in gSettings ...,
-#    "NewKeyDict":{
-#        "NewKeyList":[
-#            "NewValue",
-#            1,
-#            2,
-#            3
-#        ]
-#    }
-#}
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inValue – List with values to be merged with list in gSettings

    • -

  • inKeyList – List of the nested keys (see example)

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueSet(inValue, inKeyList=None, inGSettings=None)[source]
-

Set value in GSettings by the key list

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inValue –

    • -

  • inKeyList –

    • -
-
-
Returns
-

bool

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OSCMD(inCMDStr, inRunAsyncBool=True, inLogger=None)[source]
-

OS send command in shell locally

-
-
Parameters
-
    -

  • inCMDStr –

    • -

  • inRunAsyncBool –

    • -

  • inLogger –

    • -
-
-
Returns
-

CMD result string

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OSCredentialsVerify(inUserStr, inPasswordStr, inDomainStr='')[source]
-

Verify user credentials in windows. Return bool

-
-
Parameters
-
    -

  • inUserStr –

    • -

  • inPasswordStr –

    • -

  • inDomainStr –

    • -
-
-
Returns
-

True - Credentials are actual; False - Credentials are not actual

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OSLogoff()[source]
-

Logoff the current orchestrator session -:return:

-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OSRemotePCRestart(inHostStr, inForceBool=True, inLogger=None)[source]
-

Send signal via power shell to restart remote PC -ATTENTION: Orchestrator user need to have restart right on the Remote machine to restart PC.

-
-
Parameters
-
    -

  • inLogger – logger to log powershell result in logs

    • -

  • inHostStr – PC hostname which you need to restart.

    • -

  • inForceBool – True - send signal to force retart PC; False - else case

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.Orchestrator(inGSettings=None, inDumpRestoreBool=True, inRunAsAdministratorBool=True)[source]
-

Main def to start orchestrator

-
-
Parameters
-
    -

  • inGSettings –

    • -

  • inDumpRestoreBool –

    • -

  • inRunAsAdministratorBool –

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorInitWait() → None[source]
-

Wait thread while orc will process initial action. -ATTENTION: DO NOT CALL THIS DEF IN THREAD WHERE ORCHESTRATOR MUST BE INITIALIZED - INFINITE LOOP

-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorIsAdmin()[source]
-

Check if Orchestrator process is running as administrator

-
-
Returns
-

True - run as administrator; False - not as administrator

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorIsInited() → bool[source]
-

Check if Orchestrator initial actions were processed

-
-
Returns
-

True - orc is already inited; False - else

-
-
Return type
-

bool

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorLoggerGet() → logging.Logger[source]
-

Get the logger from the Orchestrator

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorPySearchInit(inGlobPatternStr, inDefStr=None, inDefArgNameGSettingsStr=None, inAsyncInitBool=False)[source]
-

Search the py files by the glob and do the safe init (in try except). Also add inited module in sys.modules as imported (module name = file name without extension). -You can init CP in async way! -.. code-block:: python

-
-

# USAGE VAR 1 (without the def auto call) -# Autoinit control panels starts with CP_ -Orchestrator.OrchestratorPySearchInit(inGlobPatternStr=”ControlPanelCP_*.py”)

-

# USAGE VAR 2 (with the def auto call) - for the backward compatibility CP for the Orchestrator ver. < 1.2.7 -# Autoinit control panels starts with CP_ -Orchestrator.OrchestratorPySearchInit(inGlobPatternStr=”ControlPanelCP_*.py”, inDefStr=”SettingsUpdate”, inDefArgNameGSettingsStr=”inGSettings”)

-

# INFO: The code above will replace the code below -## !!! For Relative import !!! CP Version Check -try:

-
-

sys.path.insert(0,os.path.abspath(os.path.join(r””))) -from ControlPanel import CP_VersionCheck -CP_VersionCheck.SettingsUpdate(inGSettings=gSettings)

-
-
-
except Exception as e:

gSettings[“Logger”].exception(f”Exception when init CP. See below.”)

-
-
-
-
-
Parameters
-
    -

  • inGlobPatternStr – example”..***X64*.cmd”

    • -

  • inDefStr – OPTIONAL The string name of the def. For backward compatibility if you need to auto call some def from initialized module

    • -

  • inDefArgNameGSettingsStr – OPTIONAL The name of the GSettings argument in def (if exists)

    • -

  • inAsyncInitBool – OPTIONAL True - init py modules in many threads - parallel execution. False (default) - sequence execution

    • -
-
-
Returns
-

{ “ModuleNameStr”:{“PyPathStr”: “”, “Module”: …}, …}

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRerunAsAdmin()[source]
-

Check if not admin - then rerun orchestrator as administrator

-
-
Returns
-

True - run as administrator; False - not as administrator

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRestart(inGSettings=None)[source]
-

Orchestrator restart

-
-
Parameters
-

inGSettings – Global settings dict (singleton)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorScheduleGet() → <module ‘schedule’ from ‘c:\abs\archive\scopesrcul\pyopenrpa\resources\wpy64-3720\python-3.7.2.amd64\lib\site-packages\schedule\__init__.py’>[source]
-

Get the schedule (schedule.readthedocs.io) from the Orchestrator

-

Fro example you can use:

-
-
Returns
-

schedule module. Example see here https://schedule.readthedocs.io/en/stable/examples.html

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionRestore(inGSettings=None)[source]
-

Check _SessioLast… files in working directory. if exist - load into gsettings -(from version 1.2.7)

-
-

_SessionLast_GSettings.pickle (binary)

-
-
-
(above the version 1.2.7)

_SessionLast_RDPList.json (encoding = “utf-8”) -_SessionLast_StorageDict.pickle (binary)

-
-
-
-
Parameters
-

inGSettings – Global settings dict (singleton)

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionSave(inGSettings=None)[source]
-

Orchestrator session save in file -(from version 1.2.7)

-
-

_SessionLast_GSettings.pickle (binary)

-
-
-
(above the version 1.2.7)

_SessionLast_RDPList.json (encoding = “utf-8”) -_SessionLast_StorageDict.pickle (binary)

-
-
-
-
Parameters
-

inGSettings – Global settings dict (singleton)

-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorThreadStart(inDef, *inArgList, **inArgDict)[source]
-

Execute def in new thread and pass some args with list and dict types

-
-
Parameters
-
    -

  • inDef – Python Def

    • -

  • inArgList – args as list

    • -

  • inArgDict – args as dict

    • -
-
-
Returns
-

threading.Thread object

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessDefIntervalCall(inDef, inIntervalSecFloat, inIntervalAsyncBool=False, inDefArgList=None, inDefArgDict=None, inDefArgGSettingsNameStr=None, inDefArgLoggerNameStr=None, inExecuteInNewThreadBool=True, inLogger=None, inGSettings=None)[source]
-

Use this procedure if you need to run periodically some def. Set def, args, interval and enjoy :)

-
-
Parameters
-
    -

  • inGSettings – global settings

    • -

  • inDef – def link, which will be called with interval inIntervalSecFloat

    • -

  • inIntervalSecFloat – Interval in seconds between call

    • -

  • inIntervalAsyncBool – False - wait interval before next call after the previous iteration result; True - wait interval after previous iteration call

    • -

  • inDefArgList – List of the args in def. Default None (empty list)

    • -

  • inDefArgDict – Dict of the args in def. Default None (empty dict)

    • -

  • inDefArgGSettingsNameStr – Name of the GSettings arg name for def (optional)

    • -

  • inDefArgLoggerNameStr – Name of the Logger arg name for def (optional). If Use - please check fill of the inLogger arg.

    • -

  • inExecuteInNewThreadBool – True - create new thread for the periodic execution; False - execute in current thread. Default: True

    • -

  • inLogger – logging def if some case is appear

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessIsStarted(inProcessNameWOExeStr)[source]
-

Check if there is any running process that contains the given name processName.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-lProcessIsStartedBool = Orchestrator.ProcessIsStarted(inProcessNameWOExeStr = "notepad")
-# lProcessIsStartedBool is True - notepad.exe is running on the Orchestrator machine
-
-
-
-
Parameters
-

inProcessNameWOExeStr – Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”)

-
-
Returns
-

True - process is running on the orchestrator machine; False - process is not running on the orchestrator machine

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessListGet(inProcessNameWOExeList=None)[source]
-

Return process list on the orchestrator machine sorted by Memory Usage. You can determine the list of the processes you are interested - def will return the list about it.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-lProcessList = Orchestrator.ProcessListGet()
-# Return the list of the process on the machine.
-# !ATTENTION! RUn orchestrator as administrator to get all process list on the machine.
-
-
-
-
Parameters
-

inProcessNameWOExeList –

-
-
Returns
-

{

-

-
-
-

“ProcessWOExeList”: [“notepad”,”…”], -“ProcessWOExeUpperList”: [“NOTEPAD”,”…”], -“ProcessDetailList”: [

-
-
-
{

‘pid’: 412, -‘username’: “DESKTOPUSER”, -‘name’: ‘notepad.exe’, -‘vms’: 13.77767775, -‘NameWOExeUpperStr’: ‘NOTEPAD’, -‘NameWOExeStr’: “‘notepad’”},

-
-
-

{…}]

-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStart(inPathStr, inArgList, inStopProcessNameWOExeStr=None)[source]
-

Start process locally. Extra feature: Use inStopProcessNameWOExeStr to stop the execution if current process is running.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-Orchestrator.ProcessStart(
-    inPathStr = "notepad"
-    inArgList = []
-    inStopProcessNameWOExeStr = "notepad")
-# notepad.exe will be started if no notepad.exe is active on the machine
-
-
-
-
Parameters
-
    -

  • inPathStr – Command to send in CMD

    • -

  • inArgList – List of the arguments for the CMD command. Example: [“test.txt”]

    • -

  • inStopProcessNameWOExeStr – Trigger: stop execution if process is running. Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”)

    • -
-
-
Returns
-

None - nothing is returned. If process will not start -exception will be raised

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStop(inProcessNameWOExeStr, inCloseForceBool, inUserNameStr='%username%')[source]
-

Stop process on the orchestrator machine. You can set user session on the machine and set flag about to force close process.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-Orchestrator.ProcessStop(
-    inProcessNameWOExeStr = "notepad"
-    inCloseForceBool = True
-    inUserNameStr = "USER_99")
-# Will close process "notepad.exe" on the user session "USER_99" (!ATTENTION! if process not exists no exceptions will be raised)
-
-
-
-
Parameters
-
    -

  • inProcessNameWOExeStr – Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”)

    • -

  • inCloseForceBool – True - do force close. False - send signal to safe close (!ATTENTION! - Safe close works only in orchestrator session. Win OS doens’t allow to send safe close signal between GUI sessions)

    • -

  • inUserNameStr – User name which is has current process to close. Default value is close process on the Orchestrator session

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemAppend(inGSettings=None, inDef=None, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inActivityItemDict=None)[source]
-

Create and add activity item in processor queue.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-# EXAMPLE 1
-def TestDef(inArg1Str, inGSettings, inLogger):
-    pass
-lActivityItem = Orchestrator.ProcessorActivityItemAppend(
-    inGSettings = gSettingsDict,
-    inDef = TestDef,
-    inArgList=[],
-    inArgDict={"inArg1Str": "ArgValueStr"},
-    inArgGSettingsStr = "inGSettings",
-    inArgLoggerStr = "inLogger")
-# Activity have been already append in the processor queue
-
-# EXAMPLE 2
-def TestDef(inArg1Str):
-    pass
-Orchestrator.ProcessorAliasDefUpdate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-    inDef = "TestDefAlias",
-    inArgList=[],
-    inArgDict={"inArg1Str": "ArgValueStr"},
-    inArgGSettingsStr = None,
-    inArgLoggerStr = None)
-Orchestrator.ProcessorActivityItemAppend(
-    inGSettings = gSettingsDict,
-    inActivityItemDict = lActivityItem)
-# Activity have been already append in the processor queue
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inDef – def link or def alias (look gSettings[“Processor”][“AliasDefDict”])

    • -

  • inArgList – Args list for the Def

    • -

  • inArgDict – Args dict for the Def

    • -

  • inArgGSettingsStr – Name of def argument of the GSettings dict

    • -

  • inArgLoggerStr – Name of def argument of the logging object

    • -

  • inActivityItemDict – Fill if you already have ActivityItemDict (don’t fill inDef, inArgList, inArgDict, inArgGSettingsStr, inArgLoggerStr)

    • -
-
-
-

:return ActivityItem GUIDStr

-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr=None, inThreadBool=False)[source]
-

Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute. -Deprecated. See ActivityItemCreate -.. code-block:: python

-
-

# USAGE -from pyOpenRPA import Orchestrator

-

# EXAMPLE 1 -def TestDef(inArg1Str, inGSettings, inLogger):

-
-

pass

-
-
-
lActivityItem = Orchestrator.ProcessorActivityItemCreate(

inDef = TestDef, -inArgList=[], -inArgDict={“inArg1Str”: “ArgValueStr”}, -inArgGSettingsStr = “inGSettings”, -inArgLoggerStr = “inLogger”)

-
-
-

# lActivityItem: -# { -# “Def”:TestDef, -# “ArgList”:inArgList, -# “ArgDict”:inArgDict, -# “ArgGSettings”: “inArgGSettings”, -# “ArgLogger”: “inLogger” -# }

-

# EXAMPLE 2 -def TestDef(inArg1Str):

-
-

pass

-
-
-
Orchestrator.ProcessorAliasDefUpdate(

inGSettings = gSettings, -inDef = TestDef, -inAliasStr=”TestDefAlias”)

-
-
lActivityItem = Orchestrator.ProcessorActivityItemCreate(

inDef = “TestDefAlias”, -inArgList=[], -inArgDict={“inArg1Str”: “ArgValueStr”}, -inArgGSettingsStr = None, -inArgLoggerStr = None)

-
-
-

# lActivityItem: -# { -# “Def”:”TestDefAlias”, -# “ArgList”:inArgList, -# “ArgDict”:inArgDict, -# “ArgGSettings”: None, -# “ArgLogger”: None -# }

-
-
-
Parameters
-
    -

  • inDef – def link or def alias (look gSettings[“Processor”][“AliasDefDict”])

    • -

  • inArgList – Args list for the Def

    • -

  • inArgDict – Args dict for the def

    • -

  • inArgGSettingsStr – Name of def argument of the GSettings dict

    • -

  • inArgLoggerStr – Name of def argument of the logging object

    • -

  • inGUIDStr – GUID which you can specify. If None the GUID will be generated

    • -

  • inThreadBool – True - execute ActivityItem in new thread; False - in processor thread

    • -
-
-
Returns
-

{}

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefCreate(inDef, inAliasStr=None, inGSettings=None)[source]
-

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) -Deprecated. See ActivityItemDefAliasCreate

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-def TestDef():
-    pass
-lAliasStr = Orchestrator.ProcessorAliasDefCreate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-# Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr)
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inDef – Def

    • -

  • inAliasStr – String alias for associated def

    • -
-
-
Returns
-

str Alias string (Alias can be regenerated if previous alias was occupied)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefUpdate(inDef, inAliasStr, inGSettings=None)[source]
-

Update 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) -Deprecated. See ActivityItemDefAliasUpdate

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-def TestDef():
-    pass
-Orchestrator.ProcessorAliasDefUpdate(
-    inGSettings = gSettings,
-    inDef = TestDef,
-    inAliasStr="TestDefAlias")
-# Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias")
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inDef – Def

    • -

  • inAliasStr – String alias for associated def

    • -
-
-
Returns
-

str Alias string

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.PythonStart(inModulePathStr, inDefNameStr, inArgList=None, inArgDict=None, inLogger=None)[source]
-

Import module and run def in the Orchestrator process.

-
-

Note

-

Import module will be each time when PythonStart def will be called.

-
-
# USAGE
-from pyOpenRPA import Orchestrator
-
-Orchestrator.PythonStart(
-    inModulePathStr="ModuleToCall.py", # inModulePathStr: Working Directory\ModuleToCall.py
-    inDefNameStr="TestDef")
-# Import module in Orchestrator process and call def "TestDef" from module "ModuleToCall.py"
-
-
-
-
Parameters
-
    -

  • inModulePathStr – Absolute or relative (working directory of the orchestrator process) path to the importing module .py

    • -

  • inDefNameStr – Def name in module

    • -

  • inArgList – List of the arguments for callable def

    • -

  • inArgDict – Dict of the named arguments for callable def

    • -

  • inLogger – Logger instance to log some information when PythonStart def is running

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionCMDRun(inRDPSessionKeyStr, inCMDStr, inModeStr='CROSSCHECK', inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inCMDStr – Any CMD string

    • -

  • inModeStr – Variants: -“LISTEN” - Get result of the cmd command in result; -“CROSSCHECK” - Check if the command was successfully sent -“RUN” - Run without crosscheck and get clipboard

    • -
-
-
Returns
-

-
# OLD > True - CMD was executed successfully
-
{

“OutStr”: <> # Result string -“IsResponsibleBool”: True|False # Flag is RDP is responsible - works only when inModeStr = CROSSCHECK

-
-
-
-
-

}

-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionConnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inHostStr=None, inPortStr=None, inLoginStr=None, inPasswordStr=None, inGSettings=None, inRedirectClipboardBool=True)[source]
-
-
Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists

2 way of the use

-
-
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inRDPTemplateDict – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)

    • -

  • inHostStr – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict

    • -

  • inPortStr – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict

    • -

  • inLoginStr – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict

    • -

  • inPasswordStr – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict

    • -
-
-
Returns
-

True every time :)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDisconnect(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inBreakTriggerProcessWOExeList –

    List of the processes, which will stop the execution. Example [“notepad”]

    -

    Orchestrator look processes on the current machine

    -

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDublicatesResolve(inGSettings)[source]
-

DEVELOPING Search duplicates in GSettings RDPlist -!def is developing!

-
-
Parameters
-

inGSettings – Global settings dict (singleton)

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredRecieve(inRDPSessionKeyStr, inRDPFilePathStr, inHostFilePathStr, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inRDPFilePathStr – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py”

    • -

  • inHostFilePathStr – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py”

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredSend(inRDPSessionKeyStr, inHostFilePathStr, inRDPFilePathStr, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inHostFilePathStr – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py”

    • -

  • inRDPFilePathStr – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py”

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionLogoff(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inBreakTriggerProcessWOExeList – List of the processes, which will stop the execution. Example [“notepad”]

    • -
-
-
Returns
-

True - logoff is successful

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionMonitorStop(inRDPSessionKeyStr, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -
-
-
Returns
-

True every time :>

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStartIfNotRunning(inRDPSessionKeyStr, inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPathBool=True, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inProcessNameWEXEStr – Process name with extension (.exe). This arg allow to check the process is running. Example: “Notepad.exe”

    • -

  • inFilePathStr – Path to run process if it is not running.

    • -

  • inFlagGetAbsPathBool – True - get abs path from the relative path in inFilePathStr. False - else case

    • -
-
-
Returns
-

True every time :)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStop(inRDPSessionKeyStr, inProcessNameWEXEStr, inFlagForceCloseBool, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inProcessNameWEXEStr – Process name to kill. Example: ‘notepad.exe’

    • -

  • inFlagForceCloseBool – True - force close the process. False - safe close the process

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionReconnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inGSettings=None)[source]
-

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
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -

  • inRDPTemplateDict – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionResponsibilityCheck(inRDPSessionKeyStr, inGSettings=None)[source]
-

DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inRDPSessionKeyStr – RDP Session string key - need for the further identification

    • -
-
-
Returns
-

True every time

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.RDPTemplateCreate(inLoginStr, inPasswordStr, inHostStr='127.0.0.1', inPortInt=3389, inWidthPXInt=1680, inHeightPXInt=1050, inUseBothMonitorBool=False, inDepthBitInt=32, inSharedDriveList=None, inRedirectClipboardBool=True)[source]
-

Create RDP connect dict item/ Use it connect/reconnect (Orchestrator.RDPSessionConnect)

-
# 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)
-#     lRDPTemplateDict= {  # Init the configuration item
-#         "Host": "127.0.0.1", "Port": "3389", "Login": "USER_99", "Password": "USER_PASS_HERE",
-#         "Screen": { "Width": 1680, "Height": 1050, "FlagUseAllMonitors": False, "DepthBit": "32" },
-#         "SharedDriveList": ["c"],
-#         "RedirectClipboardBool": True, # True - share clipboard to RDP; False - else
-#         ###### Will updated in program ############
-#         "SessionHex": "77777sdfsdf77777dsfdfsf77777777",  # Hex is created when robot runs, example ""
-#         "SessionIsWindowExistBool": False, "SessionIsWindowResponsibleBool": False, "SessionIsIgnoredBool": False
-#     }
-
-
-
-
Parameters
-
    -

  • inLoginStr – User/Robot Login, example “USER_99”

    • -

  • inPasswordStr – Password, example “USER_PASS_HERE”

    • -

  • inHostStr – Host address, example “77.77.22.22”

    • -

  • inPortInt – RDP Port, example “3389” (default)

    • -

  • inWidthPXInt – Width of the remote desktop in pixels, example 1680

    • -

  • inHeightPXInt – Height of the remote desktop in pixels, example 1050

    • -

  • inUseBothMonitorBool – True - connect to the RDP with both monitors. False - else case

    • -

  • inDepthBitInt – Remote desktop bitness. Available: 32 or 24 or 16 or 15, example 32

    • -

  • inSharedDriveList – Host local disc to connect to the RDP session. Example: [“c”, “d”]

    • -

  • inRedirectClipboardBool – # True - share clipboard to RDP; False - else

    • -
-
-
Returns
-

-
{

“Host”: inHostStr, # Host address, example “77.77.22.22” -“Port”: str(inPortInt), # RDP Port, example “3389” -“Login”: inLoginStr, # Login, example “test” -“Password”: inPasswordStr, # Password, example “test” -“Screen”: {

-
-

”Width”: inWidthPXInt, # Width of the remote desktop in pixels, example 1680 -“Height”: inHeightPXInt, # Height of the remote desktop in pixels, example 1050 -# “640x480” or “1680x1050” or “FullScreen”. If Resolution not exists set full screen, example -“FlagUseAllMonitors”: inUseBothMonitorBool, # True or False, example False -“DepthBit”: str(inDepthBitInt) # “32” or “24” or “16” or “15”, example “32”

-
-

}, -“SharedDriveList”: inSharedDriveList, # List of the Root sesion hard drives, example [“c”] -“RedirectClipboardBool”: True, # True - share clipboard to RDP; False - else -###### Will updated in program ############ -“SessionHex”: “77777sdfsdf77777dsfdfsf77777777”, # Hex is created when robot runs, example “” -“SessionIsWindowExistBool”: False, -# Flag if the RDP window is exist, old name “FlagSessionIsActive”. Check every n seconds , example False -“SessionIsWindowResponsibleBool”: False, -# Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too , example False -“SessionIsIgnoredBool”: False # Flag to ignore RDP window False - dont ignore, True - ignore, example False

-
-
-

}

-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.SchedulerActivityTimeAddWeekly(inTimeHHMMStr='23:55:', inWeekdayList=None, inActivityList=None, inGSettings=None)[source]
-

Add activity item list in scheduler. You can set weekday list and set time when launch. Activity list will be executed at planned time/day.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-# EXAMPLE 1
-def TestDef(inArg1Str):
-    pass
-lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-    inDef = TestDef,
-    inArgList=[],
-    inArgDict={"inArg1Str": "ArgValueStr"},
-    inArgGSettingsStr = None,
-    inArgLoggerStr = None)
-Orchestrator.SchedulerActivityTimeAddWeekly(
-    inGSettings = gSettingsDict,
-    inTimeHHMMStr = "04:34",
-    inWeekdayList=[2,3,4],
-    inActivityList = [lActivityItem])
-# Activity will be executed at 04:34 Wednesday (2), thursday (3), friday (4)
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inTimeHHMMStr – Activation time from “00:00” to “23:59”. Example: “05:29”

    • -

  • inWeekdayList – Week day list to initiate activity list. Use int from 0 (monday) to 6 (sunday) as list items. Example: [0,1,2,3,4]. Default value is everyday ([0,1,2,3,4,5,6])

    • -

  • inActivityList – Activity list structure

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.Start(inDumpRestoreBool=True, inRunAsAdministratorBool=True)[source]
-

Start the orchestrator threads execution

-
-
Parameters
-
    -

  • inDumpRestoreBool – True - restore data from the dumo

    • -

  • inRunAsAdministratorBool – True - rerun as admin if not

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.StorageRobotExists(inRobotNameStr)[source]
-

Check if robot storage exists

-
-
Parameters
-

inRobotNameStr – Robot name (case sensitive)

-
-
Returns
-

True - robot storage exist; False - does not exist

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.StorageRobotGet(inRobotNameStr)[source]
-

Get the robot storage by the robot name. If Robot storage is not exist - function will create it

-
-
Parameters
-

inRobotNameStr – Robot name (case sensitive)

-
-
Returns
-

Dict

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.UACKeyListCheck(inRequest, inRoleKeyList) → bool[source]
-

Check is client is has access for the key list

-
-
Parameters
-
    -

  • inRequest – request handler (from http.server import BaseHTTPRequestHandler)

    • -

  • inRoleKeyList –

    • -
-
-
Returns
-

bool

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.UACSuperTokenUpdate(inSuperTokenStr, inGSettings=None)[source]
-

Add supertoken for the all access (it is need for the robot communication without human)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inSuperTokenStr –

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.UACUpdate(inADLoginStr, inADStr='', inADIsDefaultBool=True, inURLList=None, inRoleHierarchyAllowedDict=None, inGSettings=None)[source]
-

Update user access (UAC)

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inADLoginStr –

    • -

  • inADStr –

    • -

  • inADIsDefaultBool –

    • -

  • inURLList –

    • -

  • inRoleHierarchyAllowedDict –

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.UACUserDictGet(inRequest) → dict[source]
-

Return user UAC hierarchy dict of the inRequest object. Empty dict - superuser access

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

user UAC hierarchy dict

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebAuditMessageCreate(inRequest=None, inOperationCodeStr='-', inMessageStr='-')[source]
-

Create message string with request user details (IP, Login etc…). Very actual for IT security in big company.

-
# USAGE
-from pyOpenRPA import Orchestrator
-
-lWebAuditMessageStr = Orchestrator.WebAuditMessageCreate(
-    inRequest = lRequest,
-    inOperationCodeStr = "OP_CODE_1",
-    inMessageStr="Success"):
-
-# Log the WebAudit message
-lLogger.info(lWebAuditMessageStr)
-
-
-
-
Parameters
-
    -

  • inRequest – HTTP request handler. Optional if call def from request thread

    • -

  • inOperationCodeStr – operation code in string format (actual for IT audit in control panels)

    • -

  • inMessageStr – additional message after

    • -
-
-
Returns
-

format “WebAudit :: DOMAINUSER@101.121.123.12 :: operation code :: message”

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebCPUpdate(inCPKeyStr, inHTMLRenderDef=None, inJSONGeneratorDef=None, inJSInitGeneratorDef=None, inGSettings=None)[source]
-

Add control panel HTML, JSON generator or JS when page init

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inCPKeyStr –

    • -

  • inHTMLRenderDef –

    • -

  • inJSONGeneratorDef –

    • -

  • inJSInitGeneratorDef –

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebListenCreate(inServerKeyStr='Default', inAddressStr='', inPortInt=80, inCertFilePEMPathStr=None, inKeyFilePathStr=None, inGSettings=None)[source]
-

Create listen interface for the web server

-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inAddressStr – IP interface to listen

    • -

  • inPortInt – Port int to listen for HTTP default is 80; for HTTPS default is 443

    • -

  • inCertFilePEMPathStr – Path to .pem (base 64) certificate. Required for SSL connection. ATTENTION - do not use certificate with password

    • -

  • inKeyFilePathStr – Path to the private key file

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestGet()[source]
-

Return the web request instance if current thread was created by web request from client. else return None

-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyBytes(inRequest=None)[source]
-

Extract the body in bytes from the request

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

Bytes or None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyJSON(inRequest=None)[source]
-

Extract the body in dict/list from the request

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

dict or list

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyStr(inRequest=None)[source]
-

Extract the body in str from the request

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

str or None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseFile(inRequest=None)[source]
-

Parse the request - extract the file (name, body in bytes)

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

(FileNameStr, FileBodyBytes) or (None, None)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParsePath(inRequest=None)[source]
-

Parse the request - extract the url. Example: /pyOpenRPA/Debugging/DefHelper/…

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

Str, Example: /pyOpenRPA/Debugging/DefHelper/…

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestResponseSend(inResponeStr, inRequest=None)[source]
-

Send response for the request

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectDef(inMethodStr, inURLStr, inMatchTypeStr, inDef, inContentTypeStr='application/octet-stream', inGSettings=None, inUACBool=None)[source]
-
-
-
Connect URL to DEF

“inMethodStr”:”GET|POST”, -“inURLStr”: “/index”, #URL of the request -“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, -“inContentTypeStr”: “”, #HTTP Content-type -“inDef”: None #Function with str result

-
-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inMethodStr – “GET|POST”,

    • -

  • inURLStr – example “/index”, #URL of the request

    • -

  • inMatchTypeStr – #”BeginWith|Contains|Equal|EqualCase”,

    • -

  • inDef – def arg allowed list: 2:[inRequest, inGSettings], 1: [inRequest], 0: []

    • -

  • inContentTypeStr – default: “application/octet-stream”

    • -

  • inUACBool – default: None; True - check user access before do this URL item. None - get Server flag if ask user

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFile(inMethodStr, inURLStr, inMatchTypeStr, inFilePathStr, inContentTypeStr='application/octet-stream', inGSettings=None, inUACBool=None)[source]
-
-
Connect URL to File

“inMethodStr”:”GET|POST”, -“inURLStr”: “/index”, #URL of the request -“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, -“inFolderPathStr”: “”, #Absolute or relative path

-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inMethodStr –

    • -

  • inURLStr –

    • -

  • inMatchTypeStr –

    • -

  • inFilePathStr –

    • -

  • inContentTypeStr –

    • -

  • inUACBool – default: None; True - check user access before do this URL item. None - get Server flag if ask user

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFolder(inMethodStr, inURLStr, inMatchTypeStr, inFolderPathStr, inGSettings=None, inUACBool=None)[source]
-
-
Connect URL to Folder

“inMethodStr”:”GET|POST”, -“inURLStr”: “/Folder/”, #URL of the request -“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, -“inFolderPathStr”: “”, #Absolute or relative path -“inUACBool”

-
-
-
-
Parameters
-
    -

  • inGSettings – Global settings dict (singleton)

    • -

  • inMethodStr –

    • -

  • inURLStr –

    • -

  • inMatchTypeStr –

    • -

  • inFolderPathStr –

    • -

  • inUACBool – default: None; True - check user access before do this URL item. None - get Server flag if ask user

    • -
-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebUserInfoGet(inRequest=None)[source]
-

Return User info about request

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

{“DomainUpperStr”: “”, “UserNameUpperStr”: “”}

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebUserIsSuperToken(inRequest=None, inGSettings=None)[source]
-

Return bool if request is authentificated with supetoken (token which is never expires)

-
-
Parameters
-
    -

  • inRequest – inRequest from the server. Optional if call def from request thread

    • -

  • inGSettings – Global settings dict (singleton)

    • -
-
-
Returns
-

bool True - is supertoken; False - is not supertoken

-
-
-
- -
-
-pyOpenRPA.Orchestrator.__Orchestrator__.WebUserUACHierarchyGet(inRequest=None)[source]
-

Return User UAC Hierarchy DICT Return {…}

-
-
Parameters
-

inRequest – inRequest from the server. Optional if call def from request thread

-
-
Returns
-

UAC Dict {}

-
-
-
- -
-
-
-

pyOpenRPA.Orchestrator.Web.Basic

-

Functions:

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

JSActivityListExecute(inActivityList[, …])

Create JS for execute activity list/ activity permanent

JSProcessorActivityListAdd(inActivityList[, …])

# Create JS for send activity list/ activity to the processor

-
-
-pyOpenRPA.Orchestrator.Web.Basic.JSActivityListExecute(inActivityList, inGUIDRemoveBool=True)[source]
-
-

Create JS for execute activity list/ activity permanent -USAGE: Orchestrator.Web.Basic.JSActivityListExecute(inActivityList, inGUIDRemoveBool = True)

-
-
-
Parameters
-
    -

  • inActivityList – List of the activities (See __Orchestrator__.ProcessorActivityItemCreate)

    • -

  • inGUIDRemoveBool – True - remove GUID before generate JS (if GUID is not important)

    • -
-
-
Returns
-

JavaScript string for the front end

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Web.Basic.JSProcessorActivityListAdd(inActivityList, inGUIDRemoveBool=True)[source]
-
-

# Create JS for send activity list/ activity to the processor -# USAGE: Orchestrator.Web.Basic.JSProcessorActivityListAdd(inActivityList)

-
-
-
Parameters
-
    -

  • inActivityList – List of the activities (See __Orchestrator__.ProcessorActivityItemCreate)

    • -

  • inGUIDRemoveBool – True - remove GUID before generate JS (if GUID is not important)

    • -
-
-
Returns
-

JavaScript string for the front end

-
-
-
- -
- -
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/03_gSettingsTemplate.html b/Wiki/ENG_Guide/html/Orchestrator/03_gSettingsTemplate.html deleted file mode 100644 index f6b34add..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/03_gSettingsTemplate.html +++ /dev/null @@ -1,607 +0,0 @@ - - - - - - - - - - 3. gSettings Template — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

3. gSettings Template

-

gSettings structure

-
import os, logging, datetime, sys
-import schedule # https://schedule.readthedocs.io/en/stable/examples.html
-
-# Technical def - return GSettings structure with examples
-def __Create__():
-    return {
-        "VersionStr": None, # Will be filled in orchestrator,
-        "Autocleaner": {
-            # Some gurbage is collecting in g settings. So you can configure autocleaner to periodically clear gSettings
-            "IntervalSecFloat": 3600.0,  # Sec float to periodically clear gsettings
-            "AgentActivityReturnLifetimeSecFloat": 300.0 # Time in seconds to life for activity result recieved from the agent
-        },
-        "Client": {  # Settings about client web orchestrator
-            "Session": {
-                # Settings about web session. Session algorythms works only for special requests (URL in ServerSettings)
-                "LifetimeSecFloat": 600.0,
-                # Client Session lifetime in seconds. after this time server will forget about this client session
-                "LifetimeRequestSecFloat": 120.0,  # 1 client request lifetime in server in seconds
-                "ControlPanelRefreshIntervalSecFloat": 2.0,  # Interval to refresh control panels for session,
-                "TechnicalSessionGUIDCache": {  # TEchnical cache. Fills when web browser is requesting
-                    # "SessionGUIDStr":{ # Session with some GUID str. On client session guid stored in cookie "SessionGUIDStr"
-                    #    "InitDatetime": None, # Datetime when session GUID was created
-                    #    "DatasetLast": {
-                    #        "ControlPanel": {
-                    #            "Data": None, # Struct to check with new iterations. None if starts
-                    #            "ReturnBool": False # flag to return, close request and return data as json
-                    #        }
-                    #    },
-                    #    "ClientRequestHandler": None, # Last client request handler
-                    #    "UserADStr": None, # User, who connect. None if user is not exists
-                    #    "DomainADStr": None, # Domain of the user who connect. None if user is not exists
-                    # }
-                },
-            },
-            # # # # # # Client... # # # # # # # #
-            "DumpLogListRefreshIntervalSecFloat": 3.0,  # Duration between updates for the Client
-            "DumpLogListCountInt": 100,  # Set the max row for the dump
-            "DumpLogList": [],  # Will be filled automatically
-            "DumpLogListHashStr": None,  # Will be filled automatically
-            # # # # # # # # # # # # # # # # # #
-        },
-        "ServerDict": {
-            "ControlPanelDict": {
-                # "CPKey": <Managers.ControlPanel instance>
-            },
-            "AgentLimitLogSizeBytesInt": 300, # Don't show body if json body of transmition is more than
-            "ServerThread": None, # Server thread is there
-            "AgentActivityLifetimeSecFloat": 1200.0,  # Time in seconds to life for activity for the agent
-            "AgentConnectionLifetimeSecFloat": 300.0,  # Time in seconds to handle the open connection to the Agent
-            "AgentLoopSleepSecFloat": 2.0,  # Time in seconds to sleep between loops when check to send some activity to the agent
-            "AgentFileChunkBytesSizeInt": 50000000, # size of the each chunk for the agent transmition
-            "AgentFileChunkCheckIntervalSecFloat": 0.2, # The interval for check last activity item was successfully sent
-            "WorkingDirectoryPathStr": None,  # Will be filled automatically
-            "RequestTimeoutSecFloat": 300,  # Time to handle request in seconds,
-            "ListenDict": { # Prototype
-                #"Default":{
-                #    "AddressStr":"",
-                #    "PortInt":80,
-                #    "CertFilePEMPathStr":None,
-                #    "KeyFilePathStr":None,
-                #    "ServerInstance": None
-                #}
-            },
-            "AccessUsers": {  # Default - all URL is blocked
-                "FlagCredentialsAsk": True,  # Turn on Authentication
-                "RuleDomainUserDict": {
-                    # ("DOMAIN", "USER"): { !!!!! only in upper case !!!!
-                    #    "MethodMatchURLBeforeList": [
-                    #       {
-                    #           "Method":"GET|POST",
-                    #           "MatchType":"BeginWith|Contains|Equal|EqualCase",
-                    #           "URL":"",
-                    #           "FlagAccessDefRequestGlobalAuthenticate": None, #Return bool
-                    #           "FlagAccess": True
-                    #        }
-                    #    ],
-                    #    "ControlPanelKeyAllowedList":[], # If empty - all is allowed
-                    #    "RoleHierarchyAllowedDict": {
-                    #       "Orchestrator":{
-                    #           "Controls": {
-                    #               "RestartOrchestrator": {}, # Feature to restart orchestrator on virtual machine
-                    #               "LookMachineScreenshots": {} # Feature to look machina screenshots
-                    #          },
-                    #           "RDPActive": { # Robot RDP active module
-                    #               "ListRead": {} # Access to read RDP session list
-                    #            }
-                    #        }
-                    #      }
-                    #   }
-                },
-                "RuleMethodMatchURLBeforeList": [  # General MethodMatchURL list (no domain/user)
-                    #       {
-                    #           "Method":"GET|POST",
-                    #           "MatchType":"BeginWith|Contains|Equal|EqualCase",
-                    #           "URL":"",
-                    #           "FlagAccessDefRequestGlobalAuthenticate": None, #Return bool
-                    #           "FlagAccess": True
-                    #        }
-                ],
-                "AuthTokensDict": {
-                    # "<AuthToken>":{"User":"", "Domain":"", "TokenDatetime":<Datetime>, "FlagDoNotExpire":True}
-                }
-            },
-            "URLList": [  # List of available URLs with the orchestrator server
-                # {
-                #    "Method":"GET|POST",
-                #    "URL": "/index", #URL of the request
-                #    "MatchType": "", #"BeginWith|Contains|Equal|EqualCase",
-                #    "ResponseFilePath": "", #Absolute or relative path
-                #    "ResponseFolderPath": "", #Absolute or relative path
-                #    "ResponseContentType": "", #HTTP Content-type
-                #    "ResponseDefRequestGlobal": None ,#Function with str result
-                #    "UACBool": True # True - check user access before do this URL item. None - get Server flag if ask user
-                # }
-                #{
-                #    "Method": "GET",
-                #    "URL": "/test/",  # URL of the request
-                #    "MatchType": "BeginWith",  # "BeginWith|Contains|Equal|EqualCase",
-                #    # "ResponseFilePath": "", #Absolute or relative path
-                #    "ResponseFolderPath": "C:\Abs\Archive\scopeSrcUL\OpenRPA\Orchestrator\Settings",
-                #    # Absolute or relative path
-                #    # "ResponseContentType": "", #HTTP Content-type
-                #    # "ResponseDefRequestGlobal": None #Function with str result
-                #    # "UACBool": True # True - check user access before do this URL item
-                #}
-            ],
-
-        },
-        "OrchestratorStart": {
-            "DefSettingsUpdatePathList": [],
-            # List of the .py files which should be loaded before init the algorythms
-            "ActivityList": []
-        },
-        "SchedulerDict": {
-            "Schedule": schedule, # https://schedule.readthedocs.io/en/stable/examples.html
-            "CheckIntervalSecFloat": 5.0,  # Check interval in seconds
-            "ActivityTimeList": [
-                # {
-                #    "TimeHH:MMStr": "22:23",  # Time [HH:MM] to trigger activity
-                #    "WeekdayList": [0, 1, 2, 3, 4, 5, 6], #List of the weekday index when activity is applicable, Default [0,1,2,3,4,5,6]
-                #    "ActivityList": [
-                #                    # {
-                #                 #    "Def":"DefAliasTest", # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-                #                 #    "ArgList":[1,2,3], # Args list
-                #                 #    "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary
-                #                 #    "ArgGSettings": # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-                #                 #    "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-                #                 #    "GUIDStr": ..., # GUID of the activity
-                #                 # },
-                #    ],
-                #    "GUID": None # Will be filled in Orchestrator automatically - is needed for detect activity completion
-                # },
-            ],
-        },
-        "ManagersProcessDict":{}, # The key of the Process is (mAgentHostNameStr.upper(), mAgentUserNameStr.upper(), mProcessNameWOExeStr.upper())
-        "ManagersGitDict":{}, # The key of the Git instance is (mAgentHostNameStr.upper(), mAgentUserNameStr.upper(), mAbsPathUpperStr.upper())
-        "ProcessorDict": {  # Has been changed. New general processor (one threaded) v.1.2.0
-            "ActivityList": [  # List of the activities
-                # {
-                #    "Def":"DefAliasTest", # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-                #    "ArgList":[1,2,3], # Args list
-                #    "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary
-                #    "ArgGSettings": # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-                #    "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-                #    "GUIDStr": ..., # GUID of the activity
-                # },
-            ],
-            "ActivityItemNowDict": None, # Activity Item which is executing now
-            "AliasDefDict": {},  # Storage for def with Str alias. To use it see pyOpenRPA.Orchestrator.ControlPanel
-            "CheckIntervalSecFloat": 1.0,  # Interval for check gSettings in ProcessorDict > ActivityList
-            "ExecuteBool": True,  # Flag to execute thread processor
-            "ThreadIdInt": None, # Technical field - will be setup when processor init
-            "WarningExecutionMoreThanSecFloat": 60.0 # Push warning if execution more than n seconds
-        },
-        # # # # # # # # # # # # # #
-        "RobotRDPActive": {
-            "RecoveryDict": {
-                "CatchPeriodSecFloat": 1200, # Catch last 10 minutes
-                "TriggerCountInt": 10, # Activate trigger if for the period orch will catch the reconnect RDP n times
-                "DoDict": {
-                    "OSRemotePCRestart": True # Do powershell remote restart
-                },
-                "__StatisticsDict__": {
-                    # RDPSessionKeyStr : [time.time(), time.time()],
-                }
-            },
-            "RDPList": {
-                # "RDPSessionKey":{
-                #    "Host": "77.77.22.22",  # Host address
-                #    "Port": "3389",  # RDP Port
-                #    "Login": "test",  # Login
-                #    "Password": "test",  # Password
-                #    "Screen": {
-                #        "Width": 1680,  # Width of the remote desktop in pixels
-                #        "Height": 1050,  # Height of the remote desktop in pixels
-                #        # "640x480" or "1680x1050" or "FullScreen". If Resolution not exists set full screen
-                #        "FlagUseAllMonitors": False,  # True or False
-                #        "DepthBit": "32"  # "32" or "24" or "16" or "15"
-                #    },
-                #    "SharedDriveList": ["c"],  # List of the Root sesion hard drives
-                #    ###### Will updated in program ############
-                #    "SessionHex": "",  # Hex is created when robot runs
-                #    "SessionIsWindowExistBool": False, # Flag if the RDP window is exist, old name "FlagSessionIsActive". Check every n seconds
-                #    "SessionIsWindowResponsibleBool": False, # Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too
-                #    "SessionIsIgnoredBool": False # Flag to ignore RDP window False - dont ignore, True - ignore
-                # }
-            },
-            "ResponsibilityCheckIntervalSec": None,
-            # Seconds interval when Robot check the RDP responsibility. if None - dont check
-            "FullScreenRDPSessionKeyStr": None,
-            # RDPSessionKeyStr of the current session which is full screened, None is no session in fullscreen
-            "ActivityList": [
-                # Technical Activity list for RobotRDPActive thread - equal to Main activity list, apply only RDP activity
-                # {
-                #    "DefNameStr":"test", # Function name in RobotRDPActive.Processor
-                #    "ArgList":[1,2,3], # Args list
-                #    "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary
-                # },
-                # {
-                #    "DefNameStr": "RDPSessionConnect",  # Function name in RobotRDPActive.Processor
-                #    "ArgList": [],  # Args list
-                #    "ArgDict": {"inRDPSessionKeyStr": "TestRDP", "inHostStr": "77.44.33.22", "inPortStr": "3389",
-                #                "inLoginStr": "login", "inPasswordStr": "pass"}  # Args dictionary
-                # },
-                # {
-                #    "DefNameStr": "RDPSessionDisconnect",  # Disconnect the RDP session without logoff. Function name in RobotRDPActive.Processor
-                #    "ArgList": [],  # Args list
-                #    "ArgDict": {"inRDPSessionKeyStr": "TestRDP"}
-                # },
-                # {
-                #    "DefNameStr": "RDPSessionReconnect",  # Disconnect the RDP session without logoff. Function name in RobotRDPActive.Processor
-                #    "ArgList": [],  # Args list
-                #    "ArgDict": {"inRDPSessionKeyStr": "TestRDP"}
-                # }
-            ]
-        },
-        # # # # # # # # # # # # # #
-        "FileManager": {
-            "FileURLFilePathDict_help": "https://localhost:8081/filemanager/<file URL>. All FileURL s must be set in lowercase",
-            "FileURLFilePathDict": {
-                #"r01/report.xlsx": "C:\\RPA\\R01_IntegrationOrderOut\\Data\\Reestr_otgruzok.xlsx"
-            }
-        },
-        "Logger": logging.getLogger("Orchestrator"),
-        "StorageDict": {
-            "Robot_R01_help": "Robot data storage in orchestrator env",
-            "Robot_R01": {},
-            "R01_OrchestratorToRobot": {"Test2": "Test2"}
-        },
-        "AgentDict": { # Will be filled when program runs
-            #("HostNameUpperStr", "UserUpperStr"): { "IsListenBool": True, "QueueList": [] }
-        },
-        "AgentActivityReturnDict": { # Will be filled when programs run - fill result of the Activity execution on the agent
-            # Key - Activity Item GUID str, Value {"Return": ..., "ReturnedByDatetime": datetime.datetime}
-            # If key exists - def has been completed
-        }
-        # "HiddenIsOrchestratorInitialized" - will be inited when orchestrator will be initialized
-    }
-
-# Create full configuration for
-def __AgentDictItemCreate__():
-    return {"IsListenBool":False, "ConnectionCountInt":0, "ConnectionFirstQueueItemCountInt":0, "ActivityList":[]}
-
-# Create full configuration for AgentActivityReturnDict
-def __AgentActivityReturnDictItemCreate__(inReturn):
-    return {"Return": inReturn, "ReturnedByDatetime": datetime.datetime.now()}
-
-# Create full configuration for
-def __UACClientAdminCreate__():
-    lResultDict = {
-        "pyOpenRPADict":{
-            "CPKeyDict":{ # Empty dict - all access
-                # "CPKeyStr"{
-                # }
-            },
-            "RDPKeyDict":{ # Empty dict - all access
-                #"RDPKeyStr"{
-                #   "FullscreenBool": True,
-                #   "IgnoreBool":True,
-                #   "ReconnectBool": True
-                #   "NothingBool": True # USe option if you dont want to give some access to the RDP controls
-                # }
-            },
-            "AgentKeyDict": { # Empty dict - all access
-                # "AgentKeyStr"{
-                # }
-            },
-            "AdminDict":{ # Empty dict - all access
-                "LogViewerBool":True, # Show log viewer on the web page
-                "CMDInputBool":True, # Execute CMD on the server side and result to the logs
-                "ScreenshotViewerBool":True, # Show button to look screenshots
-                "RestartOrchestratorBool": True, # Restart orchestrator activity
-                "RestartOrchestratorGITPullBool": True, # Turn off (RDP remember) orc + git pull + Turn on (rdp remember)
-                "RestartPCBool": True, # Send CMD to restart pc
-                "NothingBool":True, # USe option if you dont want to give some access to the RDP controls
-                "Debugging":True # Debugging tool
-            },
-            "ActivityDict": { # Empty dict - all access
-                "ActivityListExecuteBool": True,  # Execute activity at the current thread
-                "ActivityListAppendProcessorQueueBool": True  # Append activity to the processor queue
-            }
-        }
-
-    }
-    return lResultDict
-
-
-# Init the log dump to WEB
-# import pdb; pdb.set_trace()
-############################################
-def LoggerDumpLogHandlerAdd(inLogger, inGSettingsClientDict):
-    lL = inLogger
-    if len(lL.handlers) == 0:
-        mRobotLoggerFormatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
-    else:
-        mRobotLoggerFormatter = lL.handlers[0].formatter
-    mHandlerDumpLogList = LoggerHandlerDumpLogList.LoggerHandlerDumpLogList(inDict=inGSettingsClientDict,
-        inKeyStr="DumpLogList", inHashKeyStr="DumpLogListHashStr", inRowCountInt=inGSettingsClientDict[
-                                                                                "DumpLogListCountInt"])
-    mHandlerDumpLogList.setFormatter(mRobotLoggerFormatter)
-    lL.addHandler(mHandlerDumpLogList)
-
-# inModeStr:
-#   "BASIC" - create standart configuration
-from pyOpenRPA.Orchestrator.Utils import LoggerHandlerDumpLogList
-def Create(inModeStr="BASIC", inLoggerLevel = None):
-    if inModeStr=="BASIC":
-        lResult = __Create__() # Create settings
-        # Создать файл логирования
-        # add filemode="w" to overwrite
-        if not os.path.exists("Reports"):
-            os.makedirs("Reports")
-        ##########################
-        # Подготовка логгера Robot
-        #########################
-        if inLoggerLevel is None: inLoggerLevel=logging.INFO
-        lL = lResult["Logger"]
-        if len(lL.handlers) == 0:
-            lL.setLevel(logging.INFO)
-            # create the logging file handler
-            mRobotLoggerFH = logging.FileHandler(
-                "Reports\\" + datetime.datetime.now().strftime("%Y_%m_%d") + ".log")
-            mRobotLoggerFormatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
-            mRobotLoggerFH.setFormatter(mRobotLoggerFormatter)
-            # add handler to logger object
-            lL.addHandler(mRobotLoggerFH)
-            ####################Add console output
-            handler = logging.StreamHandler(sys.stdout)
-            handler.setFormatter(mRobotLoggerFormatter)
-            lL.addHandler(handler)
-            ############################################
-            LoggerDumpLogHandlerAdd(inLogger=lL, inGSettingsClientDict=lResult["Client"])
-            #mHandlerDumpLogList = LoggerHandlerDumpLogList.LoggerHandlerDumpLogList(inDict=lResult["Client"],
-            #                                                                        inKeyStr="DumpLogList",
-            #                                                                        inHashKeyStr="DumpLogListHashStr",
-            #                                                                        inRowCountInt=lResult["Client"][
-            #                                                                            "DumpLogListCountInt"])
-            #mHandlerDumpLogList.setFormatter(mRobotLoggerFormatter)
-            #mRobotLogger.addHandler(mHandlerDumpLogList)
-        else:
-            if lL: lL.warning("Pay attention! Your code has been call SettingsTemplate.Create - since pyOpenRPA v1.2.7 GSettings is creating automatically")
-    return lResult # return the result dict
-
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/04_HowToUse.html b/Wiki/ENG_Guide/html/Orchestrator/04_HowToUse.html deleted file mode 100644 index 03ba4ea0..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/04_HowToUse.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - 4. How to use — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

4. How to use

-

You need to run orchestrator process?

-
if __name__ == "__main__": # New init way - allow run as module -m PyOpenRPA.Orchestrator
-    from pyOpenRPA import Orchestrator  # Import orchestrator main
-    gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration - no more config is available from the box - you can create own
-    # Call the orchestrator main def
-    Orchestrator.Orchestrator(inGSettings=gSettings)
-
-
-

If you need more configurations - so you can see here:

-
import psutil, datetime, logging, os, sys
-
-
-# Config settings
-lPyOpenRPASourceFolderPathStr = r"..\Sources" # Path for test pyOpenRPA package
-
-# Operations
-if lPyOpenRPASourceFolderPathStr != "": sys.path.insert(0,os.path.abspath(os.path.join(lPyOpenRPASourceFolderPathStr))) # Path for test pyOpenRPA package
-# Start import after config the pyOpenRPA folder
-from pyOpenRPA.Orchestrator import SettingsTemplate # Import functionallity
-
-from pyOpenRPA import Orchestrator  # Import orchestrator main
-#Run as administrator
-if not Orchestrator.OrchestratorIsAdmin():
-    Orchestrator.OrchestratorRerunAsAdmin()
-    print(f"Orchestrator will be run as administrator!")
-else:
-    gSettings = Orchestrator.GSettingsGet()
-    #gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration - no more config is available from the box - you can create own
-    Orchestrator.OrchestratorLoggerGet().setLevel(logging.INFO)
-    # TEST Add User ND - Add Login ND to superuser of the Orchestrator
-    lUACClientDict = SettingsTemplate.__UACClientAdminCreate__()
-    Orchestrator.UACUpdate(inGSettings=gSettings, inADLoginStr="ND", inADStr="", inADIsDefaultBool=True, inURLList=[], inRoleHierarchyAllowedDict=lUACClientDict)
-    # TEST Add User IMaslov - Add Login IMaslov to superuser of the Orchestrator
-    Orchestrator.UACUpdate(inGSettings=gSettings, inADLoginStr="IMaslov", inADStr="", inADIsDefaultBool=True, inURLList=[])
-    # TEST Add Supertoken for the all access between robots
-    Orchestrator.UACSuperTokenUpdate(inGSettings=gSettings, inSuperTokenStr="1992-04-03-0643-ru-b4ff-openrpa52zzz")
-    # Add first interface!
-    Orchestrator.WebListenCreate(inGSettings=gSettings)
-    # Restore DUMP
-    Orchestrator.OrchestratorSessionRestore(inGSettings=gSettings)
-    # Autoinit control panels starts with CP_
-    lPyModules = Orchestrator.OrchestratorPySearchInit(inGlobPatternStr="ControlPanel\\CP_*.py", inDefStr="SettingsUpdate", inDefArgNameGSettingsStr="inGSettings", inAsyncInitBool=True)
-    # Call the orchestrator def
-    Orchestrator.Orchestrator(inGSettings=gSettings, inDumpRestoreBool=False)
-
-
-
-
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/05_UAC.html b/Wiki/ENG_Guide/html/Orchestrator/05_UAC.html deleted file mode 100644 index 2d8e8ecb..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/05_UAC.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - 5. UAC - User Access Control — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

5. UAC - User Access Control

-
-

About

-

Orchestrator has mega feature - user access control (UAC). This feature allow you to manipulate access of the web UI for the all users!

-

If you need to give admin rights - you don’t customize UAC dict.

-

If you need to give some little rights for user only for one robot in orchestrator web panel - you can set the following properties in UAC dict.

-

To work with UAC you can use defs Orchestrator.UAC group.

-

!!!ATTENTION!!!

-

Need practice example to work with UAC! - too hard to understand

-
-
-

UAC Dict for Orchestrator WEB UI rights

-

UAC Dict for pyOpenRPA Orchestrator WEB UI rights.

-
"pyOpenRPADict":{
-    "CPKeyDict":{ # Empty dict - all access
-        # "CPKeyStr"{
-        # }
-    },
-    "RDPKeyDict":{ # Empty dict - all access
-        #"RDPKeyStr"{
-        #   "FullscreenBool": True,
-        #   "IgnoreBool":True,
-        #   "ReconnectBool": True
-        #   "NothingBool": True # USe option if you dont want to give some access to the RDP controls
-        # }
-    },
-    "AgentKeyDict": { # Empty dict - all access
-        # "AgentKeyStr"{
-        # }
-    },
-    "AdminDict":{ # Empty dict - all access
-        "LogViewerBool":True, # Show log viewer on the web page
-        "CMDInputBool":True, # Execute CMD on the server side and result to the logs
-        "ScreenshotViewerBool":True, # Show button to look screenshots
-        "RestartOrchestratorBool": True, # Restart orchestrator activity
-        "RestartOrchestratorGITPullBool": True, # Turn off (RDP remember) orc + git pull + Turn on (rdp remember)
-        "RestartPCBool": True, # Send CMD to restart pc
-        "NothingBool":True # USe option if you dont want to give some access to the RDP controls
-    },
-    "ActivityDict": { # Empty dict - all access
-        "ActivityListExecuteBool": True,  # Execute activity at the current thread
-        "ActivityListAppendProcessorQueueBool": True  # Append activity to the processor queue
-    }
-}
-
-
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Orchestrator/06_Defs Managers.html b/Wiki/ENG_Guide/html/Orchestrator/06_Defs Managers.html deleted file mode 100644 index 73301e09..00000000 --- a/Wiki/ENG_Guide/html/Orchestrator/06_Defs Managers.html +++ /dev/null @@ -1,2210 +0,0 @@ - - - - - - - - - - 6. Defs Managers — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

6. Defs Managers

-
-

Process (General)

-
# EXAMPLE
-from pyOpenRPA.Orchestrator import Orchestrator
-lProcess = Orchestrator.Managers.Process(inAgentHostNameStr="PC-DESKTOP",inAgentUserNameStr="ND", inProcessNameWOExeStr="notepad",inStartCMDStr="notepad")
-
-
-

Classes:

- ---- - - - - - -

Process(inAgentHostNameStr, …[, …])

Manager process, which is need to be started / stopped / restarted

-

Functions:

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

ProcessExists(inAgentHostNameStr, …)

Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)

ProcessGet(inAgentHostNameStr, …)

Return the process instance by the inProcessNameWOExeStr

ProcessInitSafe(inAgentHostNameStr, …[, …])

Exception safe function.

ProcessManual2Auto(inAgentHostNameStr, …)

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ProcessManualStopListClear(…)

Clear the last start tries list.

ProcessManualStopTriggerSet(…)

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ProcessScheduleStatusCheckEverySeconds(…)

Run status check every interval in second you specify.

ProcessStart(inAgentHostNameStr, …[, …])

Manual/Auto start.

ProcessStatusCheck(inAgentHostNameStr, …)

Check if process is alive.

ProcessStatusRestore(inAgentHostNameStr, …)

Execute the StatusCheck, after that restore status to the saved state (see StatusSave).

ProcessStatusSave(inAgentHostNameStr, …)

Save current status of the process.

ProcessStatusStrGet(inAgentHostNameStr, …)

Get the status of the Process instance.

ProcessStopForce(inAgentHostNameStr, …[, …])

Manual/Auto stop force.

ProcessStopSafe(inAgentHostNameStr, …[, …])

Manual/Auto stop safe.

-
-
-class pyOpenRPA.Orchestrator.Managers.Process.Process(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300, inStartArgDict=None, inStatusCheckIntervalSecFloat=30)[source]
-

Manager process, which is need to be started / stopped / restarted

-

With Process instance you can automate your process activity. Use schedule package to set interval when process should be active and when not.

-

All defs in class are pickle safe! After orchestrator restart (if not the force stop of the orchestrator process) your instance with properties will be restored. But it not coverage the scheduler which is in __Orchestrator__ . -After orc restart you need to reinit all schedule rules: Orchestrator.OrchestratorScheduleGet

-
-
Process instance has the following statuses:
    -

  • 0_STOPPED

    • -

  • 1_STOPPED_MANUAL

    • -

  • 2_STOP_SAFE

    • -

  • 3_STOP_SAFE_MANUAL

    • -

  • 4_STARTED

    • -

  • 5_STARTED_MANUAL

    • -
-
-
-

How to use StopSafe on the robot side

-

Methods:

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

KeyTurpleGet()

Get the key turple of the current process

Manual2Auto()

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ManualStopListClear()

Clear the last start tries list.

ManualStopTriggerNewStart()

Log new start event.

ManualStopTriggerSet(inMSTdTSecFloat, inMSTdNInt)

Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period

MuteWait()

Internal def.

RestartForce([inIsManualBool])

Manual/Auto restart force.

RestartSafe([inIsManualBool])

Manual/Auto restart safe.

Start([inIsManualBool, inStartArgDict])

Manual/Auto start.

StartCheck()

Start program if auto stopped (0_STOPPED).

StatusChangeLog()

Lof information about status change

StatusCheck()

Check if process is alive.

StatusCheckIntervalRestore()

Call from orchestrator when init

StatusCheckStart()

Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED”

StatusCheckStopForce()

Check process status and auto stop force it if self.mStatusStr is 4_STARTED

StatusCheckStopSafe()

Check process status and auto stop safe it if self.mStatusStr is 4_STARTED

StatusRestore()

Execute the StatusCheck, after that restore status to the saved state (see StatusSave).

StatusSave()

Save current status of the process.

StopForce([inIsManualBool, inMuteIgnoreBool])

Manual/Auto stop force.

StopForceCheck()

Stop force program if auto started (4_STARTED).

StopSafe([inIsManualBool, …])

Manual/Auto stop safe.

StopSafeCheck([inStopSafeTimeoutSecFloat])

Stop safe program if auto started (4_STARTED).

-
-
-KeyTurpleGet()[source]
-

Get the key turple of the current process

-
- -
-
-Manual2Auto() → str[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-ManualStopListClear() → None[source]
-

Clear the last start tries list.

-
-
Returns
-

None

-
-
-
- -
-
-ManualStopTriggerNewStart()[source]
-

Log new start event. Check if it is applicable. Change status if ManualStop trigger criteria is applied

-
-
Returns
-

# 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-ManualStopTriggerSet(inMSTdTSecFloat: float, inMSTdNInt: int) → None[source]
-

Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period

-
-
Parameters
-
    -

  • inMSTdTSecFloat – Time perios in seconds

    • -

  • inMSTdNInt – Counts of the start tries

    • -
-
-
Returns
-

None

-
-
-
- -
-
-MuteWait()[source]
-

Internal def. Wait when class is apply to send new activities to the agent

-
-
Returns
-

-
-
-
- -
-
-RestartForce(inIsManualBool=True)[source]
-

Manual/Auto restart force. Force restart dont wait process termination - it just terminate process now ant then start it. -Manual restart will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-RestartSafe(inIsManualBool=True)[source]
-

Manual/Auto restart safe. Restart safe is the operation which send signal to process to terminate own work (send term signal to process). Then it run process. Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-Start(inIsManualBool=True, inStartArgDict=None) → str[source]
-

Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto. -Will not start if STOP SAFE is now and don’t start auto is stopped manual now

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StartCheck() → str[source]
-

Start program if auto stopped (0_STOPPED).

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusChangeLog()[source]
-

Lof information about status change

-
-
Returns
-

-
-
-
- -
-
-StatusCheck()[source]
-

Check if process is alive. The def will save the manual flag is exists. Don’t wait mute but set mute if it is not set.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckIntervalRestore()[source]
-

Call from orchestrator when init

-
- -
-
-StatusCheckStart()[source]
-

Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckStopForce()[source]
-

Check process status and auto stop force it if self.mStatusStr is 4_STARTED

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckStopSafe()[source]
-

Check process status and auto stop safe it if self.mStatusStr is 4_STARTED

-
-
Returns
-

-
-
-
- -
-
-StatusRestore()[source]
-

Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusSave()[source]
-

Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopForce(inIsManualBool=True, inMuteIgnoreBool=False) → str[source]
-

Manual/Auto stop force. Force stop don’t wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopForceCheck() → str[source]
-

Stop force program if auto started (4_STARTED).

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopSafe(inIsManualBool=True, inStopSafeTimeoutSecFloat=None) → str[source]
-

Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -

  • inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

    • -
-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopSafeCheck(inStopSafeTimeoutSecFloat=None) → str[source]
-

Stop safe program if auto started (4_STARTED).

-
-
Parameters
-

inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessExists(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → bool[source]
-

Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

True - process exists in gsettings; False - else

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → pyOpenRPA.Orchestrator.Managers.Process.Process[source]
-

Return the process instance by the inProcessNameWOExeStr

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process instance (if exists) Else None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessInitSafe(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300) → pyOpenRPA.Orchestrator.Managers.Process.Process[source]
-

Exception safe function. Check if process instance is not exists in GSettings (it can be after restart because Orchestrator restore objects from dump of the previous Orchestrator session) -Return existing instance (if exists) or create new instance and return it.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inStartPathStr – Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute

    • -

  • inStartCMDStr – CMD script to start program (if no start file is exists)

    • -

  • inStopSafeTimeoutSecFloat – Time to wait for stop safe. After that do the stop force (if process is not stopped)

    • -
-
-
Returns
-

Process instance

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManual2Auto(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopListClear(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → None[source]
-

Clear the last start tries list.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopTriggerSet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inMSTdTSecFloat: float, inMSTdNInt: int) → None[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inMSTdTSecFloat – Time periods in seconds

    • -

  • inMSTdNInt – Counts of the start tries

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessScheduleStatusCheckEverySeconds(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIntervalSecondsInt: int = 120)[source]
-

Run status check every interval in second you specify.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIntervalSecondsInt – Interval in seconds. Default is 120

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStart(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) → str[source]
-

Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusCheck(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Check if process is alive. The def will save the manual flag is exists.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusRestore(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)[source]
-

Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusSave(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)[source]
-

Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusStrGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Get the status of the Process instance.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStopForce(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) → str[source]
-

Manual/Auto stop force. Force stop dont wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStopSafe(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True, inStopSafeTimeoutSecFloat=None) → str[source]
-

Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -

  • inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-

Process (Details)

-

Classes:

- ---- - - - - - -

Process(inAgentHostNameStr, …[, …])

Manager process, which is need to be started / stopped / restarted

-

Functions:

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

ProcessExists(inAgentHostNameStr, …)

Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)

ProcessGet(inAgentHostNameStr, …)

Return the process instance by the inProcessNameWOExeStr

ProcessInitSafe(inAgentHostNameStr, …[, …])

Exception safe function.

ProcessManual2Auto(inAgentHostNameStr, …)

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ProcessManualStopListClear(…)

Clear the last start tries list.

ProcessManualStopTriggerSet(…)

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ProcessScheduleStatusCheckEverySeconds(…)

Run status check every interval in second you specify.

ProcessStart(inAgentHostNameStr, …[, …])

Manual/Auto start.

ProcessStatusCheck(inAgentHostNameStr, …)

Check if process is alive.

ProcessStatusRestore(inAgentHostNameStr, …)

Execute the StatusCheck, after that restore status to the saved state (see StatusSave).

ProcessStatusSave(inAgentHostNameStr, …)

Save current status of the process.

ProcessStatusStrGet(inAgentHostNameStr, …)

Get the status of the Process instance.

ProcessStopForce(inAgentHostNameStr, …[, …])

Manual/Auto stop force.

ProcessStopSafe(inAgentHostNameStr, …[, …])

Manual/Auto stop safe.

-
-
-class pyOpenRPA.Orchestrator.Managers.Process.Process(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300, inStartArgDict=None, inStatusCheckIntervalSecFloat=30)[source]
-

Manager process, which is need to be started / stopped / restarted

-

With Process instance you can automate your process activity. Use schedule package to set interval when process should be active and when not.

-

All defs in class are pickle safe! After orchestrator restart (if not the force stop of the orchestrator process) your instance with properties will be restored. But it not coverage the scheduler which is in __Orchestrator__ . -After orc restart you need to reinit all schedule rules: Orchestrator.OrchestratorScheduleGet

-
-
Process instance has the following statuses:
    -

  • 0_STOPPED

    • -

  • 1_STOPPED_MANUAL

    • -

  • 2_STOP_SAFE

    • -

  • 3_STOP_SAFE_MANUAL

    • -

  • 4_STARTED

    • -

  • 5_STARTED_MANUAL

    • -
-
-
-

How to use StopSafe on the robot side

-

Methods:

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

KeyTurpleGet()

Get the key turple of the current process

Manual2Auto()

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

ManualStopListClear()

Clear the last start tries list.

ManualStopTriggerNewStart()

Log new start event.

ManualStopTriggerSet(inMSTdTSecFloat, inMSTdNInt)

Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period

MuteWait()

Internal def.

RestartForce([inIsManualBool])

Manual/Auto restart force.

RestartSafe([inIsManualBool])

Manual/Auto restart safe.

Start([inIsManualBool, inStartArgDict])

Manual/Auto start.

StartCheck()

Start program if auto stopped (0_STOPPED).

StatusChangeLog()

Lof information about status change

StatusCheck()

Check if process is alive.

StatusCheckIntervalRestore()

Call from orchestrator when init

StatusCheckStart()

Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED”

StatusCheckStopForce()

Check process status and auto stop force it if self.mStatusStr is 4_STARTED

StatusCheckStopSafe()

Check process status and auto stop safe it if self.mStatusStr is 4_STARTED

StatusRestore()

Execute the StatusCheck, after that restore status to the saved state (see StatusSave).

StatusSave()

Save current status of the process.

StopForce([inIsManualBool, inMuteIgnoreBool])

Manual/Auto stop force.

StopForceCheck()

Stop force program if auto started (4_STARTED).

StopSafe([inIsManualBool, …])

Manual/Auto stop safe.

StopSafeCheck([inStopSafeTimeoutSecFloat])

Stop safe program if auto started (4_STARTED).

-
-
-KeyTurpleGet()[source]
-

Get the key turple of the current process

-
- -
-
-Manual2Auto() → str[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-ManualStopListClear() → None[source]
-

Clear the last start tries list.

-
-
Returns
-

None

-
-
-
- -
-
-ManualStopTriggerNewStart()[source]
-

Log new start event. Check if it is applicable. Change status if ManualStop trigger criteria is applied

-
-
Returns
-

# 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-ManualStopTriggerSet(inMSTdTSecFloat: float, inMSTdNInt: int) → None[source]
-

Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period

-
-
Parameters
-
    -

  • inMSTdTSecFloat – Time perios in seconds

    • -

  • inMSTdNInt – Counts of the start tries

    • -
-
-
Returns
-

None

-
-
-
- -
-
-MuteWait()[source]
-

Internal def. Wait when class is apply to send new activities to the agent

-
-
Returns
-

-
-
-
- -
-
-RestartForce(inIsManualBool=True)[source]
-

Manual/Auto restart force. Force restart dont wait process termination - it just terminate process now ant then start it. -Manual restart will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-RestartSafe(inIsManualBool=True)[source]
-

Manual/Auto restart safe. Restart safe is the operation which send signal to process to terminate own work (send term signal to process). Then it run process. Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-Start(inIsManualBool=True, inStartArgDict=None) → str[source]
-

Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto. -Will not start if STOP SAFE is now and don’t start auto is stopped manual now

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StartCheck() → str[source]
-

Start program if auto stopped (0_STOPPED).

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusChangeLog()[source]
-

Lof information about status change

-
-
Returns
-

-
-
-
- -
-
-StatusCheck()[source]
-

Check if process is alive. The def will save the manual flag is exists. Don’t wait mute but set mute if it is not set.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckIntervalRestore()[source]
-

Call from orchestrator when init

-
- -
-
-StatusCheckStart()[source]
-

Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckStopForce()[source]
-

Check process status and auto stop force it if self.mStatusStr is 4_STARTED

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusCheckStopSafe()[source]
-

Check process status and auto stop safe it if self.mStatusStr is 4_STARTED

-
-
Returns
-

-
-
-
- -
-
-StatusRestore()[source]
-

Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StatusSave()[source]
-

Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopForce(inIsManualBool=True, inMuteIgnoreBool=False) → str[source]
-

Manual/Auto stop force. Force stop don’t wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-

inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopForceCheck() → str[source]
-

Stop force program if auto started (4_STARTED).

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopSafe(inIsManualBool=True, inStopSafeTimeoutSecFloat=None) → str[source]
-

Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -

  • inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

    • -
-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-StopSafeCheck(inStopSafeTimeoutSecFloat=None) → str[source]
-

Stop safe program if auto started (4_STARTED).

-
-
Parameters
-

inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessExists(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → bool[source]
-

Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

True - process exists in gsettings; False - else

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → pyOpenRPA.Orchestrator.Managers.Process.Process[source]
-

Return the process instance by the inProcessNameWOExeStr

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process instance (if exists) Else None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessInitSafe(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300) → pyOpenRPA.Orchestrator.Managers.Process.Process[source]
-

Exception safe function. Check if process instance is not exists in GSettings (it can be after restart because Orchestrator restore objects from dump of the previous Orchestrator session) -Return existing instance (if exists) or create new instance and return it.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inStartPathStr – Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute

    • -

  • inStartCMDStr – CMD script to start program (if no start file is exists)

    • -

  • inStopSafeTimeoutSecFloat – Time to wait for stop safe. After that do the stop force (if process is not stopped)

    • -
-
-
Returns
-

Process instance

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManual2Auto(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopListClear(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → None[source]
-

Clear the last start tries list.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopTriggerSet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inMSTdTSecFloat: float, inMSTdNInt: int) → None[source]
-

Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self):

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inMSTdTSecFloat – Time periods in seconds

    • -

  • inMSTdNInt – Counts of the start tries

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessScheduleStatusCheckEverySeconds(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIntervalSecondsInt: int = 120)[source]
-

Run status check every interval in second you specify.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIntervalSecondsInt – Interval in seconds. Default is 120

    • -
-
-
Returns
-

None

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStart(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) → str[source]
-

Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusCheck(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Check if process is alive. The def will save the manual flag is exists.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusRestore(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)[source]
-

Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusSave(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)[source]
-

Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED”

-
-
Returns
-

Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusStrGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) → str[source]
-

Get the status of the Process instance.

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStopForce(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) → str[source]
-

Manual/Auto stop force. Force stop dont wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-pyOpenRPA.Orchestrator.Managers.Process.ProcessStopSafe(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True, inStopSafeTimeoutSecFloat=None) → str[source]
-

Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto

-
-
Parameters
-
    -

  • inAgentHostNameStr – Agent hostname in any case. Required to identify Process

    • -

  • inAgentUserNameStr – Agent user name in any case. Required to identify Process

    • -

  • inProcessNameWOExeStr – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case

    • -

  • inIsManualBool – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation

    • -

  • inStopSafeTimeoutSecFloat – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force

    • -
-
-
Returns
-

Process status. See self.mStatusStr. -Process instance has the following statuses: -- 0_STOPPED -- 1_STOPPED_MANUAL -- 2_STOP_SAFE -- 3_STOP_SAFE_MANUAL -- 4_STARTED -- 5_STARTED_MANUAL -- None (if Process instance not exists)

-
-
-
- -
-
-

ControlPanel (General)

-
# EXAMPLE
-from pyOpenRPA.Orchestrator import Orchestrator
-    lCP = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestTTT",inRefreshHTMLJinja2TemplatePathStr="ControlPanel\\test.html", inJinja2TemplateRefreshBool = True)
-
-
-

Classes:

- ---- - - - - - -

ControlPanel(inControlPanelNameStr[, …])

Manage your control panel on the orchestrator

-
-
-class pyOpenRPA.Orchestrator.Managers.ControlPanel.ControlPanel(inControlPanelNameStr, inRefreshHTMLJinja2TemplatePathStr=None, inJinja2TemplateRefreshBool=False, inRobotNameStr=None)[source]
-

Manage your control panel on the orchestrator

-

Control panel has 3 events types: -- onRefreshHTML - run every n (see settings) second to detect changes in HTML control panel. -- onRefreshJSON - run every n (see settings) second to detect changes in JSON data container to client side. -- onInitJS - run when client reload the Orchestrator web page

-
# Usage example:
-lCPManager = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestControlPanel",
-    inRefreshHTMLJinja2TemplatePathStr="ControlPanel\test.html", inJinja2TemplateRefreshBool = True)
-
-
-

If you use Jinja2 you can use next data context: -StorageRobotDict: Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr), -ControlPanelInstance: self, -OrchestratorModule:Orchestrator, -RequestInstance: inRequest, -UserInfoDict: Orchestrator.WebUserInfoGet(inRequest=inRequest), -UserUACDict: Orchestrator.UACUserDictGet(inRequest=inRequest), -UserUACCheckDef: inRequest.UACClientCheck, -EnumerateDef: enumerate, -OperatorModule: operator, -MathModule: math

-

You can modify jinja context by use the function: -Jinja2DataUpdateDictSet

-

Methods:

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

DataDictGenerate(inRequest)

-
param inRequest
-

request handler (from http.server import BaseHTTPRequestHandler)

-
-
-

InitJSJinja2StrGenerate(inDataDict)

Generate the HTML str from the Jinja2.

InitJSJinja2TemplatePathSet(…)

Create Jinja2 env and load the template html

Jinja2DataUpdateDictSet(inJinja2DataUpdateDict)

Set the data dict from the Jinja2 context (you can add some new params)

OnInitJSDataDict(inRequest)

Event to prepare data context for the futher Jinja2 JS init generation.

OnInitJSStr(inRequest)

Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once.

OnRefreshHTMLDataDict(inRequest)

Event to prepare data context for the futher Jinja2 HTML generation.

OnRefreshHTMLHashStr(inRequest)

Generate the hash the result output HTML.

OnRefreshHTMLStr(inRequest)

Event to generate HTML code of the control panel when refresh time is over.

OnRefreshJSONDict(inRequest)

Event to transmit some data from server side to the client side in JSON format.

RefreshHTMLJinja2StrGenerate(inDataDict)

Generate the HTML str from the Jinja2.

RefreshHTMLJinja2TemplatePathSet(…)

Create Jinja2 env and load the template html

-
-
-DataDictGenerate(inRequest)[source]
-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

-
-
-
- -
-
-InitJSJinja2StrGenerate(inDataDict)[source]
-

Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return:

-
- -
-
-InitJSJinja2TemplatePathSet(inJinja2TemplatePathStr)[source]
-

Create Jinja2 env and load the template html

-
-
Parameters
-

inJinja2TemplatePathStr –

-
-
Returns
-

-
-
-
- -
-
-Jinja2DataUpdateDictSet(inJinja2DataUpdateDict)[source]
-

Set the data dict from the Jinja2 context (you can add some new params)

-
-
Parameters
-

inJinja2DataUpdateDict – dict, which will be appended to main data context

-
-
Returns
-

None

-
-
-
- -
-
-OnInitJSDataDict(inRequest)[source]
-

Event to prepare data context for the futher Jinja2 JS init generation. You can override this def if you want some thing more data

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

dict

-
-
-
- -
-
-OnInitJSStr(inRequest)[source]
-

Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once.

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

””

-

-
-
-
- -
-
-OnRefreshHTMLDataDict(inRequest)[source]
-

Event to prepare data context for the futher Jinja2 HTML generation. You can override this def if you want some thing more data

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

dict

-
-
-
- -
-
-OnRefreshHTMLHashStr(inRequest)[source]
-

Generate the hash the result output HTML. You can override this function if you know how to optimize HTML rendering. -TODO NEED TO MODIFY ServerSettings to work with Hash because of all defs are need do use Hash

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

None - default, hash function is not determined. Str - hash function is working on!

-
-
-
- -
-
-OnRefreshHTMLStr(inRequest)[source]
-

Event to generate HTML code of the control panel when refresh time is over. -Support backward compatibility for previous versions.

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

-
-
-
- -
-
-OnRefreshJSONDict(inRequest)[source]
-

Event to transmit some data from server side to the client side in JSON format. Call when page refresh is initialized

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

Dict type

-
-
-
- -
-
-RefreshHTMLJinja2StrGenerate(inDataDict)[source]
-

Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return:

-
- -
-
-RefreshHTMLJinja2TemplatePathSet(inJinja2TemplatePathStr)[source]
-

Create Jinja2 env and load the template html

-
-
Parameters
-

inJinja2TemplatePathStr –

-
-
Returns
-

-
-
-
- -
- -
-
-

ControlPanel (Details)

-

Classes:

- ---- - - - - - -

ControlPanel(inControlPanelNameStr[, …])

Manage your control panel on the orchestrator

-
-
-class pyOpenRPA.Orchestrator.Managers.ControlPanel.ControlPanel(inControlPanelNameStr, inRefreshHTMLJinja2TemplatePathStr=None, inJinja2TemplateRefreshBool=False, inRobotNameStr=None)[source]
-

Manage your control panel on the orchestrator

-

Control panel has 3 events types: -- onRefreshHTML - run every n (see settings) second to detect changes in HTML control panel. -- onRefreshJSON - run every n (see settings) second to detect changes in JSON data container to client side. -- onInitJS - run when client reload the Orchestrator web page

-
# Usage example:
-lCPManager = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestControlPanel",
-    inRefreshHTMLJinja2TemplatePathStr="ControlPanel\test.html", inJinja2TemplateRefreshBool = True)
-
-
-

If you use Jinja2 you can use next data context: -StorageRobotDict: Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr), -ControlPanelInstance: self, -OrchestratorModule:Orchestrator, -RequestInstance: inRequest, -UserInfoDict: Orchestrator.WebUserInfoGet(inRequest=inRequest), -UserUACDict: Orchestrator.UACUserDictGet(inRequest=inRequest), -UserUACCheckDef: inRequest.UACClientCheck, -EnumerateDef: enumerate, -OperatorModule: operator, -MathModule: math

-

You can modify jinja context by use the function: -Jinja2DataUpdateDictSet

-

Methods:

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

DataDictGenerate(inRequest)

-
param inRequest
-

request handler (from http.server import BaseHTTPRequestHandler)

-
-
-

InitJSJinja2StrGenerate(inDataDict)

Generate the HTML str from the Jinja2.

InitJSJinja2TemplatePathSet(…)

Create Jinja2 env and load the template html

Jinja2DataUpdateDictSet(inJinja2DataUpdateDict)

Set the data dict from the Jinja2 context (you can add some new params)

OnInitJSDataDict(inRequest)

Event to prepare data context for the futher Jinja2 JS init generation.

OnInitJSStr(inRequest)

Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once.

OnRefreshHTMLDataDict(inRequest)

Event to prepare data context for the futher Jinja2 HTML generation.

OnRefreshHTMLHashStr(inRequest)

Generate the hash the result output HTML.

OnRefreshHTMLStr(inRequest)

Event to generate HTML code of the control panel when refresh time is over.

OnRefreshJSONDict(inRequest)

Event to transmit some data from server side to the client side in JSON format.

RefreshHTMLJinja2StrGenerate(inDataDict)

Generate the HTML str from the Jinja2.

RefreshHTMLJinja2TemplatePathSet(…)

Create Jinja2 env and load the template html

-
-
-DataDictGenerate(inRequest)[source]
-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

-
-
-
- -
-
-InitJSJinja2StrGenerate(inDataDict)[source]
-

Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return:

-
- -
-
-InitJSJinja2TemplatePathSet(inJinja2TemplatePathStr)[source]
-

Create Jinja2 env and load the template html

-
-
Parameters
-

inJinja2TemplatePathStr –

-
-
Returns
-

-
-
-
- -
-
-Jinja2DataUpdateDictSet(inJinja2DataUpdateDict)[source]
-

Set the data dict from the Jinja2 context (you can add some new params)

-
-
Parameters
-

inJinja2DataUpdateDict – dict, which will be appended to main data context

-
-
Returns
-

None

-
-
-
- -
-
-OnInitJSDataDict(inRequest)[source]
-

Event to prepare data context for the futher Jinja2 JS init generation. You can override this def if you want some thing more data

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

dict

-
-
-
- -
-
-OnInitJSStr(inRequest)[source]
-

Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once.

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

””

-

-
-
-
- -
-
-OnRefreshHTMLDataDict(inRequest)[source]
-

Event to prepare data context for the futher Jinja2 HTML generation. You can override this def if you want some thing more data

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

dict

-
-
-
- -
-
-OnRefreshHTMLHashStr(inRequest)[source]
-

Generate the hash the result output HTML. You can override this function if you know how to optimize HTML rendering. -TODO NEED TO MODIFY ServerSettings to work with Hash because of all defs are need do use Hash

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

None - default, hash function is not determined. Str - hash function is working on!

-
-
-
- -
-
-OnRefreshHTMLStr(inRequest)[source]
-

Event to generate HTML code of the control panel when refresh time is over. -Support backward compatibility for previous versions.

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

-
-
-
- -
-
-OnRefreshJSONDict(inRequest)[source]
-

Event to transmit some data from server side to the client side in JSON format. Call when page refresh is initialized

-
-
Parameters
-

inRequest – request handler (from http.server import BaseHTTPRequestHandler)

-
-
Returns
-

Dict type

-
-
-
- -
-
-RefreshHTMLJinja2StrGenerate(inDataDict)[source]
-

Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return:

-
- -
-
-RefreshHTMLJinja2TemplatePathSet(inJinja2TemplatePathStr)[source]
-

Create Jinja2 env and load the template html

-
-
Parameters
-

inJinja2TemplatePathStr –

-
-
Returns
-

-
-
-
- -
- -
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Robot/01_Robot.html b/Wiki/ENG_Guide/html/Robot/01_Robot.html deleted file mode 100644 index 54f19d2f..00000000 --- a/Wiki/ENG_Guide/html/Robot/01_Robot.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - - - - 1. Description — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

1. Description

-

pyOpenRPA Robot is the python package which allow you to create best RPA program.

-

The description of the functions you can find page ‘Defs’ (see menu)

-

Here is the example of the pyOpenRPA usage.

-
# EXAMPLE 1
-from pyOpenRPA.Robot import UIDesktop
-
-lNotepadOKButton = UIDesktop.UIOSelector_Get_UIO(
-    inSpecificationList=[
-        {"title":"notepad.exe"},{"title":"OK"}],
-    inElement=None,
-    inFlagRaiseException=True)
-
-lNotepadOKButton.click()
-
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Robot/02_Defs.html b/Wiki/ENG_Guide/html/Robot/02_Defs.html deleted file mode 100644 index 26196949..00000000 --- a/Wiki/ENG_Guide/html/Robot/02_Defs.html +++ /dev/null @@ -1,700 +0,0 @@ - - - - - - - - - - 2. Defs — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. Defs

-

Here you can find the functions description for interaction with desktop GUI applications

-

How to use both x32 and x64 python processes (it can be helpfully, if another app GUI is on another bitness than your app)

-
from pyOpenRPA.Robot import UIDesktop
-#Section for robot init
-lPyOpenRPA_SettingsDict = {
-        "Python32FullPath": "..\\Resources\\WPy32-3720\\python-3.7.2\\python.exe", #Set from user: "..\\Resources\\WPy32-3720\\python-3.7.2\\OpenRPARobotGUIx32.exe"
-        "Python64FullPath": "..\\Resources\\WPy64-3720\\python-3.7.2.amd64\\python.exe", #Set from user
-        "Python32ProcessName": "pyOpenRPA_UIDesktopX32.exe", #Config set once
-        "Python64ProcessName": "pyOpenRPA_UIDesktopX64.exe" #Config set once
-}
-# Init the pyOpenRPA configuration
-UIDesktop.Utils.ProcessBitness.SettingsInit(lPyOpenRPA_SettingsDict)
-# Now you can use pyOpenRPA with both bitness.
-
-
-

Functions:

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

Get_OSBitnessInt()

Detect OS bitness.

PWASpecification_Get_PWAApplication(…)

#Backend selection - attribute “backend” (“win32” || “uia”) in 1-st list element

PWASpecification_Get_UIO(…)

#Backend def selection - attribute “backend” (“win32” || “uia”) in 1-st list element #old name - GetControl

UIOSelectorSecs_WaitAppear_Bool(…)

Wait for UI object will appear in GUI for inWaitSecs seconds.

UIOSelectorSecs_WaitDisappear_Bool(…)

Wait for UI object will disappear in GUI for inWaitSecs seconds.

UIOSelectorUIOActivity_Run_Dict(…[, …])

Run the activity in UIO (UI Object)

UIOSelector_Exist_Bool(inUIOSelector)

Check if object is exist by the UIO selector.

UIOSelector_FocusHighlight(inUIOSelector)

Set focus and highlight (draw outline) the element (in app) by the UIO selector.

UIOSelector_GetChildList_UIOList([…])

Get list of child UIO’s by the parent UIOSelector

UIOSelector_Get_BitnessInt(inSpecificationList)

Detect process bitness by the UI Object UIO Selector.

UIOSelector_Get_BitnessStr(inSpecificationList)

Detect process bitness by the UI Object UIO Selector.

UIOSelector_Get_UIO(inSpecificationList[, …])

Get the pywinauto object by the UIO selector.

UIOSelector_Get_UIOActivityList(inUIOSelector)

Get the list of the UI object activities

UIOSelector_Get_UIOInfo(inUIOSelector)

Get the UIO dict of the attributes

UIOSelector_Get_UIOList(inSpecificationList)

Get the UIO list by the selector

UIOSelector_Highlight(inUIOSelector)

Highlight (draw outline) the element (in app) by the UIO selector.

UIOSelector_SafeOtherGet_Process(inUIOSelector)

Safe get other process or None if destination app is the other/same bitness

UIOSelector_SearchChildByMouse_UIO(…)

UIOSelector (see description on the top of the document) #old name - AutomationSearchMouseElement

UIOSelector_SearchChildByMouse_UIOTree(…)

!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!

UIOSelector_TryRestore_Dict(inSpecificationList)

Try to restore (maximize) window, if it’s minimized.

UIOSelectorsSecs_WaitAppear_List(…[, …])

Wait for many UI object will appear in GUI for inWaitSecs seconds.

UIOSelectorsSecs_WaitDisappear_List(…[, …])

Wait for many UI object will disappear in GUI for inWaitSecs seconds.

-
-
-pyOpenRPA.Robot.UIDesktop.Get_OSBitnessInt()[source]
-

Detect OS bitness.

-
-
Returns
-

int 32 or int 64

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.PWASpecification_Get_PWAApplication(inControlSpecificationArray)[source]
-

#Backend selection - attribute “backend” (“win32” || “uia”) in 1-st list element

-
-
Parameters
-

inControlSpecificationArray – List of dict, dict in pywinauto.find_windows notation

-
-
Returns
-

process application object

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.PWASpecification_Get_UIO(inControlSpecificationArray)[source]
-

#Backend def selection - attribute “backend” (“win32” || “uia”) in 1-st list element -#old name - GetControl

-
-
Parameters
-

inControlSpecificationArray – List of dict, dict in pywinauto.find_windows notation

-
-
Returns
-

list of UIO object

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelectorSecs_WaitAppear_Bool(inSpecificationList, inWaitSecs)[source]
-

Wait for UI object will appear in GUI for inWaitSecs seconds.

-
-
Parameters
-
    -

  • inSpecificationList – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}]

    • -

  • inWaitSecs – Float value (seconds) for wait UI element appear in GUI

    • -
-
-
Returns
-

True - UI object will appear. False - else case

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelectorSecs_WaitDisappear_Bool(inSpecificationList, inWaitSecs)[source]
-

Wait for UI object will disappear in GUI for inWaitSecs seconds.

-
-
Parameters
-
    -

  • inSpecificationList – UIOSelector. -Example: [{“title”:”notepad”},{“title”:”OK”}]

    • -

  • inWaitSecs – Float value (seconds) for wait UI element disappear in GUI

    • -
-
-
Returns
-

True - UI object will disappear. False - else case

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelectorUIOActivity_Run_Dict(inUIOSelector, inActionName, inArgumentList=None, inkwArgumentObject=None)[source]
-

Run the activity in UIO (UI Object)

-
-
Parameters
-
    -

  • inUIOSelector – UIOSelector - List of items, which contains condition attributes

    • -

  • inActionName – UIOActivity (name) activity name string from Pywinauto

    • -

  • inArgumentList –

    • -

  • inkwArgumentObject –

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Exist_Bool(inUIOSelector)[source]
-

Check if object is exist by the UIO selector.

-
-
Parameters
-

inUIOSelector –

-
-
Returns
-

True - Object is exist. False - else case

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_FocusHighlight(inUIOSelector)[source]
-

Set focus and highlight (draw outline) the element (in app) by the UIO selector.

-
-
Parameters
-

inUIOSelector – UIOSelector - List of items, which contains condition attributes

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_GetChildList_UIOList(inUIOSelector=None, inBackend='win32')[source]
-

Get list of child UIO’s by the parent UIOSelector

-
-
Parameters
-
    -

  • inUIOSelector – UIOSelector - List of items, which contains condition attributes

    • -

  • inBackend – “win32” or “uia”

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_BitnessInt(inSpecificationList)[source]
-

Detect process bitness by the UI Object UIO Selector.

-
-
Parameters
-

inSpecificationList – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}]

-
-
Returns
-

int 32 or int 64

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_BitnessStr(inSpecificationList)[source]
-

Detect process bitness by the UI Object UIO Selector.

-
-
Parameters
-

inSpecificationList – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}]

-
-
Returns
-

str “32” or str “64”

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIO(inSpecificationList, inElement=None, inFlagRaiseException=True)[source]
-

Get the pywinauto object by the UIO selector.

-
-
Parameters
-
    -

  • inSpecificationList –

    • -

  • inElement –

    • -

  • inFlagRaiseException –

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOActivityList(inUIOSelector)[source]
-

Get the list of the UI object activities

-
-
Parameters
-

inUIOSelector – UIOSelector - List of items, which contains condition attributes

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOInfo(inUIOSelector)[source]
-

Get the UIO dict of the attributes

-
-
Parameters
-

inUIOSelector – UIOSelector - List of items, which contains condition attributes

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOList(inSpecificationList, inElement=None, inFlagRaiseException=True)[source]
-

Get the UIO list by the selector

-
-
Parameters
-
    -

  • inSpecificationList – UIO Selector

    • -

  • inElement – Входной элемент - показатель, что не требуется выполнять коннект к процессу

    • -

  • inFlagRaiseException – Флаг True - выкинуть ошибку в случае обнаружении пустого списка

    • -
-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_Highlight(inUIOSelector)[source]
-

Highlight (draw outline) the element (in app) by the UIO selector.

-
-
Parameters
-

inUIOSelector – UIOSelector - List of items, which contains condition attributes

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_SafeOtherGet_Process(inUIOSelector)[source]
-

Safe get other process or None if destination app is the other/same bitness

-
-
Parameters
-

inUIOSelector – UIO Selector of the UI object

-
-
Returns
-

None or process (of the other bitness)

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_SearchChildByMouse_UIO(inElementSpecification)[source]
-

UIOSelector (see description on the top of the document) -#old name - AutomationSearchMouseElement

-
-
Parameters
-

inElementSpecification – UIOSelector of the UI Object

-
-
Returns
-

pywinauto element wrapper instance or None

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_SearchChildByMouse_UIOTree(inUIOSelector)[source]
-

!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!

-
-
Parameters
-

inUIOSelector – UIOSelector of the UI Object

-
-
Returns
-

?

-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelector_TryRestore_Dict(inSpecificationList)[source]
-

Try to restore (maximize) window, if it’s minimized. (!IMPORTANT! When use UIA framework minimized windows doesn’t appear by the UIOSelector. You need to try restore windows and after that try to get UIO)

-
-
Parameters
-

inSpecificationList – UIOSelector - List of items, which contains condition attributes

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelectorsSecs_WaitAppear_List(inSpecificationListList, inWaitSecs, inFlagWaitAllInMoment=False)[source]
-

Wait for many UI object will appear in GUI for inWaitSecs seconds.

-
-
Parameters
-
    -

  • inSpecificationListList –

    UIOSelector list. -Example: [

    -
    -

    [{“title”:”notepad”},{“title”:”OK”}], -[{“title”:”notepad”},{“title”:”Cancel”}]

    -
    -

    ]

    -

    • -

  • inWaitSecs – Float value (seconds) for wait UI element appear in GUI

    • -

  • inFlagWaitAllInMoment – True - Wait all UI objects from the UIOSelector list to be appeared

    • -
-
-
Returns
-

List of index, which UI object UIO will be appeared. Example: [1] # Appear only UI object with UIO selector: [{“title”:”notepad”},{“title”:”Cancel”}]

-
-
-
- -
-
-pyOpenRPA.Robot.UIDesktop.UIOSelectorsSecs_WaitDisappear_List(inSpecificationListList, inWaitSecs, inFlagWaitAllInMoment=False)[source]
-

Wait for many UI object will disappear in GUI for inWaitSecs seconds.

-
-
Parameters
-
    -

  • inSpecificationListList –

    UIOSelector list. -Example: [

    -
    -

    [{“title”:”notepad”},{“title”:”OK”}], -[{“title”:”notepad”},{“title”:”Cancel”}]

    -
    -

    ]

    -

    • -

  • inWaitSecs – Float value (seconds) for wait UI element disappear in GUI

    • -

  • inFlagWaitAllInMoment – True - Wait all UI objects from the UIOSelector list to be disappeared.

    • -
-
-
Returns
-

List of index, which UI object UIO will be disappeared. Example: [1] # Disappear only UI object with UIO selector: [{“title”:”notepad”},{“title”:”Cancel”}]

-
-
Returns
-

-
-
-
- - -
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Robot/03_HowToUse.html b/Wiki/ENG_Guide/html/Robot/03_HowToUse.html deleted file mode 100644 index 28473334..00000000 --- a/Wiki/ENG_Guide/html/Robot/03_HowToUse.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - - - - - - 3. How to use — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

3. How to use

-

The Robot tool is the main module for production process automation. It has no graphic/console interface. All low-level actions to OS are perfoming by the Robot tool in pyOpenRPA.

-
-

How to execute RPA script

-

You can use the robot by the several ways:

-
    -

  • In Python script

    • -

  • In Studio script (n/a)

    • -
-
-

Create python script

-

In order to use robot just add Robot tool folder in work directory and add line “import GUI” in your script.

-
import sys
-sys.path.append('../../')
-import selenium # [Web app access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.1.-Theory-&-practice:-Web-app-access-(Chrome,-Firefox,-Opera))<br>
-import GUI  # [Win32 & UI Automation access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.2.-Theory-&-practice:-Desktop-app-UI-access-(win32-and-UI-automation-dlls)) <br>
-import pyautogui #[Screen capture/recognition](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition) [#Mouse manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)<br>
-import cv2 # [Computer vision](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition)<br>
-import keyboard #[Keyboard manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)<br>
-
-
-
-
-

Execute python script

-

The pyOpenRPA is fully portable solution. It contains own python enviroment both 32 and 64 bit versions. So, you can execute your python script in several ways: -- Execute in python x32 (OpenRPAResourcesWPy32-3720python-3.7.2) -- Execute in python x64 (OpenRPAResourcesWPy64-3720python-3.7.2.amd64) -- Execute from .cmd file

-
-
-

Execute in the Python x32

-

To execute your python script in x32 bit version just write in command line from x32 python directory:

-
cd "\OpenRPA\Resources\WPy32-3720\python-3.7.2"
-python.exe "path to your python script.py"
-
-
-
-
-

Execute in the Python x64

-

To execute your python script in x32 bit version just write in command line from x32 python directory:

-
cd "\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64"
-python.exe "path to your python script.py"
-
-
-
-
-

Execute from .cmd file

-

In order to simplify the execution process you can write several code lines in file with the .cmd extension:

-
cd %~dp0
-copy /Y ..\Resources\WPy32-3720\python-3.7.2\python.exe ..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe
-.\..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe orchestratorMain.py
-pause >nul
-
-
-
-
-

Use in studio script (n/a)

-
import sys
-sys.path.append('../../')
-import GUI
-import keyboard
-import subprocess
-import time
-
-#Highlight the UI Object in Folder explorer
-GUI.UIOSelector_FocusHighlight([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}])
-
-#Wait 2 seconds
-time.sleep(3)
-
-#Loop: get child element of UI List
-for lItem in GUI.UIOSelector_Get_UIO([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]).children():
-    print(str(lItem))
-
-
-

Here you can find the docs and examples of the OpenRPA desktop (GUI) app access.

-
-
-
-

Desktop app UI access (win32 and UI automation dlls)

-
-

Definitions

-
    -

  • UIO - UI Object (class of pywinauto UI object) [pywinauto.base_wrapper]

    • -

  • UIOSelector - List of dict (key attributes)

    • -

  • PWA - PyWinAuto

    • -

  • PWASpecification - List of dict (key attributes in pywinauto.find_window notation)

    • -

  • UIOTree - Recursive Dict of Dict … (UI Parent -> Child hierarchy)

    • -

  • UIOInfo - Dict of UIO attributes

    • -

  • UIOActivity - Activity of the UIO (UI object) from the Pywinauto module

    • -

  • UIOEI - UI Object info object

    • -
-
-
-

What is UIO?

-

UIO is a User Interface Object (pyOpenRPA terminology). For maximum compatibility, this instance is inherited from the object model developed in the [pywinauto library (click to get a list of available class functions)](https://pywinauto.readthedocs.io/en/latest/code/pywinauto.base_wrapper.html).

-

This approach allows us to implement useful functionality that has already been successfully developed in other libraries, and Supplement it with the missing functionality. In our case, the missing functionality is the ability to dynamically access UIO objects using UIO selectors.

-
-
-

UIOSelector structure & example

-

UIOSelector is the list of condition items for the UIO in GUI. Each item has condition attributes for detect applicable UIO. Here is the description of the available condition attributes in item.

-

Desciption

-
[
-    {
-        "depth_start" :: [int, start from 1] :: the depth index, where to start check the condition list (default 1),
-        "depth_end" :: [int, start from 1] :: the depth index, where to stop check the condition list (default 1),
-        "ctrl_index" || "index" :: [int, starts from 0] :: the index of the UIO in parent UIO child list,
-        "title" :: [str] :: the condition for the UIO attribute *title*,
-        "title_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *title*,
-        "rich_text" :: [str] :: the condition for the UIO attribute *rich_text*,
-        "rich_text_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *rich_text*,
-        "class_name" :: [str] :: the condition for the UIO attribute *class_name*,
-        "class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *class_name*,
-        "friendly_class_name" :: [str] :: the condition for the UIO attribute *friendly_class_name*,
-        "friendly_class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *friendly_class_name*,
-        "control_type" :: [str] :: the condition for the UIO attribute *control_type*,
-        "control_type_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *control_type*,
-        "is_enabled" :: [bool] :: the condition for the UIO attribute *is_enabled*. If UI object is enabled on GUI,
-        "is_visible" :: [bool] :: the condition for the UIO attribute *is_visible*. If UI object is visible on GUI,
-        "backend" :: [str, "win32" || "uia"] :: the method of UIO extraction (default "win32"). ATTENTION! Current option can be only for the first item of the UIO selector. For the next items this option will be implemented from the first item.
-    },
-    { ... specification next level UIO }
-]
-
-
-

The UIO selector example

-
[
-    {"class_name":"CalcFrame", "backend":"win32"}, # 1-st level UIO specification
-    {"title":"Hex", "depth_start":3, "depth_end": 3} # 3-rd level specification (because of attribute depth_start|depth_stop)
-]
-
-
-
-
-

The UIDesktop module (OpenRPA/Robot/UIDesktop.py)

-

The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the win32 and ui automation dll frameworks (big thx to the Microsoft :) ).

-
# EXAMPLE 1
-from pyOpenRPA.Robot import UIDesktop
-
-UIDesktop.UIOSelector_Get_UIO(
-    inSpecificationList=[
-        {"title":"notepad.exe"},{"title":"OK"}],
-    inElement=None,
-    inFlagRaiseException=True)
-
-
-
-
-

The UIDesktop module (OpenRPA/Robot/UIDesktop.py)

-

The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the win32 and ui automation dll frameworks (big thx to the Microsoft :) ).

-

*Naming convention: <InArgument>_<ActivityName>_<OutArgument - if exist>*<br>

-
-
-
-

Theory & practice. WEB app UI access (selenium)

-
-

About

-

The pyOpenRPA support web app manipulation (by the Selenium lib). -More docs about selenium you can find here (https://selenium-python.readthedocs.io/)

-
-
-

How to use

-

To start use selenium just import selenium modules in the robot tool. Here is the example of the usage.

-
from selenium import webdriver
-from selenium.webdriver.common.keys import Keys
-
-driver = webdriver.Chrome()
-driver.get("http://www.python.org")
-assert "Python" in driver.title
-elem = driver.find_element_by_name("q")
-elem.clear()
-elem.send_keys("pycon")
-elem.send_keys(Keys.RETURN)
-assert "No results found." not in driver.page_source
-driver.close()
-
-
-
-
-
-

Theory & practice. Keyboard & mouse manipulation

-
-
-

Theory & practice. Screen capture & image recognition

-
-

How to automate image recognition on PC

-

Here you can find any ways you need to use in your business case: -- Find the exact match on the screen with the other image -- Use text recognition module (OCR) -- Use computer vision (CV) to identify the objects on screen/image/video -- Use artificial intelligence (AI) to make custom identification/classification/text recognition

-
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Robot/04_Dependencies.html b/Wiki/ENG_Guide/html/Robot/04_Dependencies.html deleted file mode 100644 index ee1de53d..00000000 --- a/Wiki/ENG_Guide/html/Robot/04_Dependencies.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - - - - - 4. Dependencies — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

4. Dependencies

-

Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -pywinauto (Windows GUI automation) -Semantic UI CSS framework -JsRender by https://www.jsviews.com (switch to Handlebars) -Handlebars

-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Studio/01_Studio.html b/Wiki/ENG_Guide/html/Studio/01_Studio.html deleted file mode 100644 index fa924dc0..00000000 --- a/Wiki/ENG_Guide/html/Studio/01_Studio.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - - - - - 1. Description — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

1. Description

-

pyOpenRPA Studio is the executable process.

-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Studio/02_HowToUse.html b/Wiki/ENG_Guide/html/Studio/02_HowToUse.html deleted file mode 100644 index 330df347..00000000 --- a/Wiki/ENG_Guide/html/Studio/02_HowToUse.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - - - - 2. How to use — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. How to use

-
-

Content

- -
-
-

How to run

-
    -

  • For OS x32

    • -

  • Run (double click): OpenRPA_32.cmd (for OS x32)

    • -

  • For OS x64

    • -

  • Run (double click): OpenRPA_64.cmd (for OS x64)

    • -

  • Wait text “running server” in console. Default browser will be open -automatically

    • -

  • Attention! The studio tool does not support the Internet explorer -(any version) for GUI rendering (lol)

    • -
-504b98f76747f63900a2943532a946bb.png -
-
-

UI Description

-

The studio tool GUI contains of:

-
    -

  1. UI tree viewer

    2. -

  2. Selected UI object hierarchy list

    3. -

  3. Selected UI object property list

    4. -

  4. UIO selector editor

    5. -

  5. UIO action panel

    6. -

  6. Another Python activity panel

    7. -

  7. Action/activity list

    8. -
-

Look it on the GUI screenshots are listed below

-
-

GUI Screenshot 1

-504b98f76747f63900a2943532a946bb.png -
-
-

GUI Screenshot 2

-65b7d51c0a5b21e6b27dc23d4062d3ca.png -
-
-
-

How to extract UI tree

-

In order to extract the UI tree do the following: in UI tree viewer -choose the object you are interested and click the button “Expand”. ##

-
-

Action: Click the button “Expand”

-6effc376ff6ea928840674bd744caced.png -
-
-

Result

-18b9ab36126c8c32168bf5bbb9330701.png -
-
-

How to search UI object by mouse hover

-

In order to search UI object do the -following: in UI tree viewer choose the parent object, where you are -want to search UI object, and click the button “Mouse search”. The mouse -search mode will start. Turn mouse on the UI object you are interested -and wait when the studio will highlight the UI object. After the -hightlight hold the “Ctrl” key and wait 3 seconds. The interested UI -object will be shown in UI tree viewer.

-
- -
-

Action: Turn mouse on the UI object you are interested and hold the “Ctrl” key for 3 seconds

-b7c38d622bf5b7afa5b26d1686d7302a.png -
-
-

Result: The interested UI object will be shown in UI tree viewer

-629bbf4db2c01b9c640194230949fcd2.png -
-
-
-

How to extract UI object properties

-

In order to extract UI object properties do the following: in -Selected UI object hierarchy list choose the UI object you are -interested and click it. The UI object property list will be shown in -Selected UI object property list

-
-

Action: Choose the UI object you are interested and click it

-2c27be5bdde20b5d062cbb40e74eaec5.png -
-
-

Result: The UI object property list will be shown in Selected UI object property list

-f235ae29099a713e0246cd574ac3a17c.png -
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png b/Wiki/ENG_Guide/html/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png deleted file mode 100644 index 55decb13..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png b/Wiki/ENG_Guide/html/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png deleted file mode 100644 index 3040bcd0..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/504b98f76747f63900a2943532a946bb.png b/Wiki/ENG_Guide/html/Studio/img/504b98f76747f63900a2943532a946bb.png deleted file mode 100644 index fa33c487..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/504b98f76747f63900a2943532a946bb.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/629bbf4db2c01b9c640194230949fcd2.png b/Wiki/ENG_Guide/html/Studio/img/629bbf4db2c01b9c640194230949fcd2.png deleted file mode 100644 index d4115094..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/629bbf4db2c01b9c640194230949fcd2.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png b/Wiki/ENG_Guide/html/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png deleted file mode 100644 index 973ed138..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/6effc376ff6ea928840674bd744caced.png b/Wiki/ENG_Guide/html/Studio/img/6effc376ff6ea928840674bd744caced.png deleted file mode 100644 index 2652cb1d..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/6effc376ff6ea928840674bd744caced.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png b/Wiki/ENG_Guide/html/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png deleted file mode 100644 index 8dd5df72..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png b/Wiki/ENG_Guide/html/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png deleted file mode 100644 index e0ef0818..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png b/Wiki/ENG_Guide/html/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png deleted file mode 100644 index fa33c487..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Studio/img/f235ae29099a713e0246cd574ac3a17c.png b/Wiki/ENG_Guide/html/Studio/img/f235ae29099a713e0246cd574ac3a17c.png deleted file mode 100644 index ea6b153f..00000000 Binary files a/Wiki/ENG_Guide/html/Studio/img/f235ae29099a713e0246cd574ac3a17c.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/Tools/02_Defs.html b/Wiki/ENG_Guide/html/Tools/02_Defs.html deleted file mode 100644 index 0146ebdf..00000000 --- a/Wiki/ENG_Guide/html/Tools/02_Defs.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - 2. Defs StopSafe — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

2. Defs StopSafe

-

How to use StopSafe on the robot side

-

# How to use -# from pyOpenRPA.Tools import StopSafe -# StopSafe.Init(inLogger=None) -# StopSafe.IsSafeStop() # True - WM_CLOSE SIGNAL has come. taskkill /im someprocess.exe

-

Functions:

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

Init([inLogger])

Init the StopSafe module.

IsStopSafe()

Check if stop signal has come.

-
-
-pyOpenRPA.Tools.StopSafe.Init(inLogger=None)[source]
-

Init the StopSafe module. After that you can use def IsStopSafe() to check if close signal has come.

-
-
Parameters
-

inLogger – Logger to log messages about StopSafe

-
-
Returns
-

-
-
-
- -
-
-pyOpenRPA.Tools.StopSafe.IsStopSafe()[source]
-

Check if stop signal has come.

-
-
Returns
-

-
-
-
- - -
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_images/ModalGuide.png b/Wiki/ENG_Guide/html/_images/ModalGuide.png deleted file mode 100644 index ce0890a5..00000000 Binary files a/Wiki/ENG_Guide/html/_images/ModalGuide.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_images/cb5dec8cecafa7d64f6cd14b2672acce.png b/Wiki/ENG_Guide/html/_images/cb5dec8cecafa7d64f6cd14b2672acce.png deleted file mode 100644 index 3d82a369..00000000 Binary files a/Wiki/ENG_Guide/html/_images/cb5dec8cecafa7d64f6cd14b2672acce.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_modules/index.html b/Wiki/ENG_Guide/html/_modules/index.html deleted file mode 100644 index 3953b4ce..00000000 --- a/Wiki/ENG_Guide/html/_modules/index.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - - - - - Overview: module code — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Overview: module code
    • - - -
  • - -
    • - -
- - -
-
-
- - -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Agent/__Agent__.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Agent/__Agent__.html deleted file mode 100644 index 620739e4..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Agent/__Agent__.html +++ /dev/null @@ -1,477 +0,0 @@ - - - - - - - - - - pyOpenRPA.Agent.__Agent__ — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Agent.__Agent__
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Agent.__Agent__

-import threading, socket, getpass, sys, uuid, subprocess, base64, psutil, getpass, time
-from . import O2A, A2O # Data flow Orchestrator To Agent
-from . import Processor # Processor Queue
-from subprocess import CREATE_NEW_CONSOLE # Flag to create new process in another CMD
-import os
-
-gSettings = None
-
-# Create binary file by the base64 string (safe for JSON transmition)
-
[docs]def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
-    """
-    Create binary file by the base64 string (safe for JSON transmition)
-
-    """
-    lFile = open(inFilePathStr, "wb")
-    lFile.write(base64.b64decode(inFileDataBase64Str))
-    lFile.close()
-    lL = inGSettings.get("Logger", None) if type(inGSettings) is dict else None
-    lMessageStr = f"AGENT Binary file {inFilePathStr} has been created."
-    if lL: lL.info(lMessageStr)
-    A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])

-
-# Append binary file by the base64 string (safe for JSON transmition)
-
[docs]def OSFileBinaryDataBase64StrAppend(inFilePathStr, inFileDataBase64Str,inGSettings = None):
-    """
-    Create binary file by the base64 string (safe for JSON transmition)
-
-    """
-    lFile = open(inFilePathStr, "ab")
-    lFile.write(base64.b64decode(inFileDataBase64Str))
-    lFile.close()
-    lL = inGSettings.get("Logger", None) if type(inGSettings) is dict else None
-    lMessageStr = f"AGENT Binary file {inFilePathStr} has been appended."
-    if lL: lL.info(lMessageStr)
-    A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])

-
-# Create text file by the string
-
[docs]def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = "utf-8",inGSettings = None):
-    """
-    Create text file in the agent GUI session
-
-    :param inFilePathStr: File abs path
-    :param inFileDataStr: File data text content
-    :param inEncodingStr:  Write file encoding
-    :param inGSettings: global settings of the Agent (singleton)
-    :return:
-    """
-    lFile = open(inFilePathStr, "w", encoding=inEncodingStr)
-    lFile.write(inFileDataStr)
-    lFile.close()
-    lL = inGSettings.get("Logger", None) if type(inGSettings) is dict else None
-    lMessageStr = f"AGENT Text file {inFilePathStr} has been created."
-    if lL: lL.info(lMessageStr)
-    A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])

-
-
[docs]def OSFileBinaryDataBase64StrReceive(inFilePathStr, inGSettings=None):
-    """
-    Read binary file and encode in base64 to transmit (safe for JSON transmition)
-
-    :param inFilePathStr: File path to read
-    :param inGSettings:  global settings of the Agent (singleton)
-    :return: File content in string base64 format (use base64.b64decode to decode data). Return None if file is not exist
-    """
-    lL = inGSettings.get("Logger", None) if type(inGSettings) is dict else None
-    lFileDataBase64Str = None
-    if os.path.exists(inFilePathStr):
-        lFile = open(inFilePathStr, "rb")
-        lFileDataBytes = lFile.read()
-        lFile.close()
-        lFileDataBase64Str = base64.b64encode(lFileDataBytes).decode("utf-8")
-        lMessageStr = f"OSFileBinaryDataBase64StrReceive: file {inFilePathStr} has been read"
-        if lL: lL.debug(lMessageStr)
-        #A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
-    else: 
-        if lL: lL.debug(f"OSFileBinaryDataBase64StrReceive: file {inFilePathStr} is not exists - return None")
-    return lFileDataBase64Str

-
-
[docs]def OSFileMTimeGet(inFilePathStr: str) -> float or None:
-    """
-    Read file modification time timestamp format (float)
-
-    :param inFilePathStr: File path to read
-    :return: timestamp (float) Return None if file is not exist
-    """
-    global gSettings
-    lL = gSettings.get("Logger", None) if type(gSettings) is dict else None
-    lFileMTimeFloat = None
-    if os.path.exists(inFilePathStr):
-        lFileMTimeFloat = os.path.getmtime(inFilePathStr)
-        if lL: lL.debug(f"OSFileMTimeGet: file {inFilePathStr} has been read")
-    else: 
-        if lL: lL.debug(f"OSFileMTimeGet: file {inFilePathStr} is not exists - return None")
-    return lFileMTimeFloat

-
-
[docs]def OSFileTextDataStrReceive(inFilePathStr, inEncodingStr="utf-8", inGSettings=None):
-    """
-    Read text file in the agent GUI session
-
-    :param inFilePathStr: File abs path
-    :param inEncodingStr:  Read file encoding. Default utf-8
-    :param inGSettings: global settings of the Agent (singleton)
-    :return: File text content in string format (use base64.b64decode to decode data). Return None if file is not exist
-    """
-    lFileDataStr = None
-    lL = inGSettings.get("Logger", None) if type(inGSettings) is dict else None
-    if os.path.exists(inFilePathStr):
-        lFile = open(inFilePathStr, "r", encoding=inEncodingStr)
-        lFileDataStr = lFile.read()
-        lFile.close()
-        lMessageStr = f"OSFileTextDataStrReceive: file {inFilePathStr} has been read"
-        if lL: lL.info(lMessageStr)
-        #A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
-    else:
-        if lL: lL.info(f"OSFileTextDataStrReceive: file {inFilePathStr} is not exists - return None")
-    return lFileDataStr

-
-# Send CMD to OS. Result return to log + Orchestrator by the A2O connection
-
[docs]def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings = None, inSendOutputToOrchestratorLogsBool = True, inCMDEncodingStr = "cp1251", inCaptureBool = True):
-    """
-    Execute CMD on the Agent daemonic process
-
-    :param inCMDStr: command to execute on the Agent session
-    :param inRunAsyncBool: True - Agent processor don't wait execution; False - Agent processor wait cmd execution
-    :param inGSettings: Agent global settings dict
-    :param inSendOutputToOrchestratorLogsBool: True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True
-    :param inCMDEncodingStr: Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is "cp1251" early was "cp866" - need test
-    :param inCaptureBool: !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent
-    :return:
-    """
-    lResultStr = ""
-    # New feature
-    if inSendOutputToOrchestratorLogsBool == False and inCaptureBool == False:
-        inCMDStr = f"start {inCMDStr}"
-    # Subdef to listen OS result
-    def _CMDRunAndListenLogs(inCMDStr, inSendOutputToOrchestratorLogsBool, inCMDEncodingStr,  inGSettings = None, inCaptureBool = True):
-        lL = inGSettings.get("Logger",None) if type(inGSettings) is dict else None
-        lResultStr = ""
-        lOSCMDKeyStr = str(uuid.uuid4())[0:4].upper()
-        lCMDProcess = None
-        if inCaptureBool == True:
-            lCMDProcess = subprocess.Popen(f'cmd /c {inCMDStr}', stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-        else:
-            lCMDProcess = subprocess.Popen(f'cmd /c {inCMDStr}', stdout=None, stderr=None,
-                                           creationflags=CREATE_NEW_CONSOLE)
-        lListenBool = True
-        lMessageStr = f"{lOSCMDKeyStr}: # # # # AGENT CMD Process has been STARTED # # # # "
-        if lL: lL.info(lMessageStr)
-        if inSendOutputToOrchestratorLogsBool == True:  # Capturing can be turned on!
-            A2O.LogListSend(inGSettings=inGSettings,inLogList=[lMessageStr])
-        lMessageStr = f"{lOSCMDKeyStr}: {inCMDStr}"
-        if lL: lL.info(lMessageStr)
-        if inSendOutputToOrchestratorLogsBool == True:  # Capturing can be turned on!
-            A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
-        while lListenBool:
-            #if inSendOutputToOrchestratorLogsBool == True: # Capturing can be turned on!
-            if inCaptureBool == True: # Capturing can be turned on!
-                lOutputLineBytes = lCMDProcess.stdout.readline()
-                if lOutputLineBytes == b"":
-                    lListenBool = False
-                lStr = lOutputLineBytes.decode(inCMDEncodingStr) # was cp866, on win server don't work properly - set cp1251
-                if lStr.endswith("\n"): lStr = lStr[:-1]
-                lMessageStr = f"{lOSCMDKeyStr}: {lStr}"
-                if lL: lL.info(lMessageStr)
-                if inSendOutputToOrchestratorLogsBool == True:  # Capturing can be turned on!
-                    A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
-                lResultStr+=lStr
-            else: #Capturing is not turned on - wait until process will be closed
-                lCMDProcessPoll = lCMDProcess.poll()
-                if lCMDProcessPoll is None: # Process is alive - wait
-                    time.sleep(2)
-                else:
-                    lListenBool = False
-        lMessageStr = f"{lOSCMDKeyStr}: # # # # AGENT CMD Process has been FINISHED # # # # "
-        if lL: lL.info(lMessageStr)
-        if inSendOutputToOrchestratorLogsBool == True:  # Capturing can be turned on!
-            A2O.LogListSend(inGSettings=inGSettings, inLogList=[lMessageStr])
-        return lResultStr
-    # New call
-    if inRunAsyncBool:
-        lThread = threading.Thread(target=_CMDRunAndListenLogs, kwargs={"inCMDStr":inCMDStr, "inGSettings":inGSettings, "inSendOutputToOrchestratorLogsBool":inSendOutputToOrchestratorLogsBool, "inCMDEncodingStr":inCMDEncodingStr, "inCaptureBool": inCaptureBool })
-        lThread.start()
-        lResultStr="ActivityList has been started in async mode - no output is available here."
-    else:
-        lResultStr = _CMDRunAndListenLogs(inCMDStr=inCMDStr, inGSettings=inGSettings, inSendOutputToOrchestratorLogsBool = inSendOutputToOrchestratorLogsBool, inCMDEncodingStr = inCMDEncodingStr, inCaptureBool=inCaptureBool)
-    #lCMDCode = "cmd /c " + inCMDStr
-    #subprocess.Popen(lCMDCode)
-    #lResultCMDRun = 1  # os.system(lCMDCode)
-    return lResultStr

-
-
-
[docs]def ProcessWOExeUpperUserListGet():
-    """
-    Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent
-
-    :param inProcessNameWOExeList:
-    :return: list of the agent user process in upper case without .EXE. Example ["NOTEPAD","..."],
-
-    """
-    lUserNameStr = getpass.getuser()
-    lResult = []
-    # Create updated list for quick check
-    lProcessNameWOExeList = []
-    # Iterate over the list
-    for proc in psutil.process_iter():
-        try:
-            # Fetch process details as dict
-            pinfo = proc.as_dict(attrs=['pid', 'name', 'username'])
-            # Add if empty inProcessNameWOExeList or if process in inProcessNameWOExeList
-            lUserNameWODomainStr = proc.username().split('\\')[-1]
-            if lUserNameWODomainStr == lUserNameStr:
-                lResult.append(pinfo['name'][:-4].upper())
-        except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
-           pass
-    return lResult

-
-# Main def
-def Agent(inGSettings):
-    lL = inGSettings["Logger"]
-    global gSettings
-    gSettings = inGSettings
-    # Append Orchestrator def to ProcessorDictAlias
-    lModule = sys.modules[__name__]
-    lModuleDefList = dir(lModule)
-    for lItemDefNameStr in lModuleDefList:
-        # Dont append alias for defs Agent
-        if lItemDefNameStr not in ["Agent"]:
-            lItemDef = getattr(lModule,lItemDefNameStr)
-            if callable(lItemDef): inGSettings["ProcessorDict"]["AliasDefDict"][lItemDefNameStr]=lItemDef
-
-    # Detect Machine host name and username
-    inGSettings["AgentDict"]["HostNameUpperStr"] = socket.gethostname().upper()
-    inGSettings["AgentDict"]["UserUpperStr"] = getpass.getuser().upper()
-
-    # Processor thread
-    lProcessorThread = threading.Thread(target= Processor.ProcessorRunSync, kwargs={"inGSettings":inGSettings})
-    lProcessorThread.daemon = True # Run the thread in daemon mode.
-    lProcessorThread.start() # Start the thread execution.
-    if lL: lL.info("Processor has been started (ProcessorDict)")  #Logging
-
-    # Start thread to wait data from Orchestrator (O2A)
-    lO2AThread = threading.Thread(target=O2A.O2A_Loop, kwargs={"inGSettings":inGSettings})
-    lO2AThread.start()
-
-    # Send log that Agent has been started
-    A2O.LogListSend(inGSettings=inGSettings, inLogList=[f'Host: {inGSettings["AgentDict"]["HostNameUpperStr"]}, User: {inGSettings["AgentDict"]["UserUpperStr"]}, Agent has been started.'])
-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/ControlPanel.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/ControlPanel.html deleted file mode 100644 index 90a5db27..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/ControlPanel.html +++ /dev/null @@ -1,580 +0,0 @@ - - - - - - - - - - pyOpenRPA.Orchestrator.Managers.ControlPanel — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Orchestrator.Managers.ControlPanel
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Orchestrator.Managers.ControlPanel

-from ... import Orchestrator
-import jinja2
-import os
-from inspect import signature # For detect count of def args
-from ..Web import Basic
-import operator
-import math
-
-
[docs]class ControlPanel():
-    """
-    Manage your control panel on the orchestrator
-
-    Control panel has 3 events types:
-    - onRefreshHTML - run every n (see settings) second to detect changes in HTML control panel.
-    - onRefreshJSON - run every n (see settings) second to detect changes in JSON data container to client side.
-    - onInitJS - run when client reload the Orchestrator web page
-
-    .. code-block:: python
-
-        # Usage example:
-        lCPManager = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestControlPanel",
-            inRefreshHTMLJinja2TemplatePathStr="ControlPanel\\test.html", inJinja2TemplateRefreshBool = True)
-        
-        
-
-    If you use Jinja2 you can use next data context:
-    StorageRobotDict: Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr),
-    ControlPanelInstance: self,
-    OrchestratorModule:Orchestrator,
-    RequestInstance: inRequest,
-    UserInfoDict: Orchestrator.WebUserInfoGet(inRequest=inRequest),
-    UserUACDict: Orchestrator.UACUserDictGet(inRequest=inRequest),
-    UserUACCheckDef: inRequest.UACClientCheck,
-    EnumerateDef: enumerate,
-    OperatorModule: operator,
-    MathModule: math
-
-    You can modify jinja context by use the function:
-    Jinja2DataUpdateDictSet 
-
-    .. code-block:: html
-        Hello my control panel!
-        You can use any def from Orchestrator module here in Jinja2 HTML template:
-        Example: OrchestratorModule.OSCMD(inCMDStr="notepad")
-        {{MathModule.pi}}
-        {% if UserInfoDict['UserNameUpperStr']=="ND" %}
-        YES - IT IS ND
-        {% endif %}
-
-    """
-    mControlPanelNameStr = None
-    # Jinja2 consolidated
-    mJinja2TemplateRefreshBool = None
-    mJinja2DataUpdateDict = None
-
-    # RefreshHTML block
-    mRefreshHTMLJinja2TemplatePathStr = None
-    mRefreshHTMLJinja2TemplateFileNameStr = None
-    mRefreshHTMLJinja2Loader = None
-    mRefreshHTMLJinja2Env = None
-    mRefreshHTMLJinja2Template = None
-
-    # InitJS block
-    mInitJSJinja2TemplatePathStr = None
-    mInitJSJinja2TemplateFileNameStr = None
-    mInitJSJinja2Loader = None
-    mInitJSJinja2Env = None
-    mInitJSJinja2Template = None
-
-    mBackwardCompatibilityHTMLDef = None
-    mBackwardCompatibilityJSDef = None
-    mBackwardCompatibilityJSONDef = None
-
-    mRobotNameStr = None
-
-    def __init__(self, inControlPanelNameStr, inRefreshHTMLJinja2TemplatePathStr = None, inJinja2TemplateRefreshBool = False, inRobotNameStr = None):
-        """
-        Constructor of the control panel manager
-
-        :param inControlPanelNameStr:
-        :param inJinja2TemplatePathStr:
-        """
-        # Connect self witch pyOpenRPA via ControlPanelNameStr
-        if inControlPanelNameStr in Orchestrator.GSettingsGet()["ServerDict"]["ControlPanelDict"]:
-            raise Exception(f"Another control panel with name {inControlPanelNameStr} is already exists. Please resolve the error and restart")
-        Orchestrator.GSettingsGet()["ServerDict"]["ControlPanelDict"][inControlPanelNameStr] = self
-        self.RefreshHTMLJinja2TemplatePathSet(inJinja2TemplatePathStr = inRefreshHTMLJinja2TemplatePathStr)
-        self.mJinja2TemplateRefreshBool = inJinja2TemplateRefreshBool
-        self.mControlPanelNameStr = inControlPanelNameStr # Set the name of the control panel
-        self.mRobotNameStr = inRobotNameStr # Set the robot name for robot it execute
-
-
[docs]    def Jinja2DataUpdateDictSet(self, inJinja2DataUpdateDict):
-        """
-        Set the data dict from the Jinja2 context (you can add some new params)
-
-        :param inJinja2DataUpdateDict: dict, which will be appended to main data context
-        :return: None
-        """
-        self.mJinja2DataUpdateDict = inJinja2DataUpdateDict

-
-
[docs]    def RefreshHTMLJinja2TemplatePathSet(self, inJinja2TemplatePathStr):
-        """
-        Create Jinja2 env and load the template html
-
-        :param inJinja2TemplatePathStr:
-        :return:
-        """
-        try:
-            if inJinja2TemplatePathStr is not None:
-                lSystemLoaderPathStr = "/".join(inJinja2TemplatePathStr.split("\\")[0:-1])
-                lTemplateFileNameStr = inJinja2TemplatePathStr.split("\\")[-1]
-                self.mRefreshHTMLJinja2TemplateFileNameStr = lTemplateFileNameStr
-                self.mRefreshHTMLJinja2Loader = jinja2.FileSystemLoader(lSystemLoaderPathStr)
-                self.mRefreshHTMLJinja2Env = jinja2.Environment(loader=self.mRefreshHTMLJinja2Loader, trim_blocks=True)
-                self.mRefreshHTMLJinja2Template = self.mRefreshHTMLJinja2Env.get_template(lTemplateFileNameStr)
-        except Exception as e:
-            Orchestrator.OrchestratorLoggerGet().exception("EXCEPTION WHEN INIT Jinja2")

-
-
[docs]    def RefreshHTMLJinja2StrGenerate(self, inDataDict):
-        """
-        Generate the HTML str from the Jinja2. Pass the context inDataDict
-        :param inDataDict:
-        :return:
-        """
-        if self.mJinja2TemplateRefreshBool == True:
-            self.mRefreshHTMLJinja2Template = self.mRefreshHTMLJinja2Env.get_template(self.mRefreshHTMLJinja2TemplateFileNameStr)
-        lHTMLStr = self.mRefreshHTMLJinja2Template.render(**inDataDict) # Render the template into str
-        return lHTMLStr

-
-
[docs]    def InitJSJinja2TemplatePathSet(self, inJinja2TemplatePathStr):
-        """
-        Create Jinja2 env and load the template html
-
-        :param inJinja2TemplatePathStr:
-        :return:
-        """
-        try:
-            if inJinja2TemplatePathStr is not None:
-                lSystemLoaderPathStr = "/".join(inJinja2TemplatePathStr.split("\\")[0:-1])
-                lTemplateFileNameStr = inJinja2TemplatePathStr.split("\\")[-1]
-                self.mInitJSJinja2TemplateFileNameStr = lTemplateFileNameStr
-                self.mInitJSJinja2Loader = jinja2.FileSystemLoader(lSystemLoaderPathStr)
-                self.mInitJSJinja2Env = jinja2.Environment(loader=self.mInitJSJinja2Loader, trim_blocks=True)
-                self.mInitJSJinja2Template = self.mInitJSJinja2Env.get_template(lTemplateFileNameStr)
-        except Exception as e:
-            Orchestrator.OrchestratorLoggerGet().exception("EXCEPTION WHEN INIT Jinja2")

-
-
[docs]    def InitJSJinja2StrGenerate(self, inDataDict):
-        """
-        Generate the HTML str from the Jinja2. Pass the context inDataDict
-        :param inDataDict:
-        :return:
-        """
-        if self.mJinja2TemplateRefreshBool == True:
-            self.mInitJSJinja2Template = self.mInitJSJinja2Env.get_template(self.mInitJSJinja2TemplateFileNameStr)
-        lHTMLStr = self.mInitJSJinja2Template.render(**inDataDict) # Render the template into str
-        return lHTMLStr

-
-
[docs]    def DataDictGenerate(self, inRequest):
-        """
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return:
-        """
-        lData = {
-            "StorageRobotDict": None,
-            "ControlPanelInstance":self,
-            "OrchestratorModule":Orchestrator,
-            "RequestInstance": inRequest,
-            "UserInfoDict": Orchestrator.WebUserInfoGet(inRequest=inRequest),
-            "UserUACDict": Orchestrator.UACUserDictGet(inRequest=inRequest),
-            "UserUACCheckDef": inRequest.UACClientCheck,
-            "EnumerateDef": enumerate,
-            "OperatorModule": operator,
-            "MathModule": math
-        }
-        # Get the robot storage by the robot name (if you set robot name when init)
-        if self.mRobotNameStr is not None:
-            lData["StorageRobotDict"] = Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr)
-        # Checkj Jinja2DataUpdateDict
-        if self.mJinja2DataUpdateDict is not None:
-            lData.update(self.mJinja2DataUpdateDict)
-        return lData

-
-
[docs]    def OnRefreshHTMLStr(self, inRequest):
-        """
-        Event to generate HTML code of the control panel when refresh time is over.
-        Support backward compatibility for previous versions.
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return:
-        """
-        lHTMLStr = None
-        lL = Orchestrator.OrchestratorLoggerGet()
-        if self.mBackwardCompatibilityHTMLDef is None:
-            if self.mRefreshHTMLJinja2Template is not None or (self.mJinja2TemplateRefreshBool == True and self.mRefreshHTMLJinja2TemplateFileNameStr is not None):
-                lDataDict = self.OnRefreshHTMLDataDict(inRequest = inRequest)
-                # Jinja code
-                lHTMLStr = self.RefreshHTMLJinja2StrGenerate(inDataDict=lDataDict)
-        else:
-            lHTMLStr = self.BackwardAdapterHTMLDef(inRequest=inRequest)
-        # return the str
-        return lHTMLStr

-
-
[docs]    def OnRefreshHTMLDataDict(self, inRequest):
-        """
-        Event to prepare data context for the futher Jinja2 HTML generation. You can override this def if you want some thing more data
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return: dict
-        """
-        return self.DataDictGenerate(inRequest=inRequest)

-
-
[docs]    def OnRefreshHTMLHashStr(self, inRequest):
-        """
-        Generate the hash the result output HTML. You can override this function if you know how to optimize HTML rendering.
-        TODO NEED TO MODIFY ServerSettings to work with Hash because of all defs are need do use Hash
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return: None - default, hash function is not determined. Str - hash function is working on!
-        """
-        return None

-
-
[docs]    def OnRefreshJSONDict(self, inRequest):
-        """
-        Event to transmit some data from server side to the client side in JSON format. Call when page refresh is initialized
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return: Dict type
-        """
-        lResultDict = None
-        if self.mBackwardCompatibilityJSONDef is None:
-            pass
-        else:
-            lResultDict = self.BackwardAdapterJSONDef(inRequest=inRequest)
-        return lResultDict

-
-
[docs]    def OnInitJSStr(self, inRequest):
-        """
-        Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once.
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return: ""
-        """
-        lJSStr = ""
-        if self.mBackwardCompatibilityJSDef is None:
-            if self.mInitJSJinja2Template is not None or (self.mJinja2TemplateRefreshBool == True and self.mInitJSJinja2TemplateFileNameStr is not None):
-                lDataDict = self.OnInitJSDataDict(inRequest = inRequest)
-                # Jinja code
-                lJSStr = self.InitJSJinja2StrGenerate(inDataDict=lDataDict)
-        else:
-            lJSStr = self.BackwardAdapterJSDef(inRequest=inRequest)
-        return lJSStr

-
-
[docs]    def OnInitJSDataDict(self, inRequest):
-        """
-        Event to prepare data context for the futher Jinja2 JS init generation. You can override this def if you want some thing more data
-
-        :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-        :return: dict
-        """
-        return self.DataDictGenerate(inRequest=inRequest)

-
-    def BackwardAdapterHTMLDef(self,inRequest):
-        lGS = Orchestrator.GSettingsGet()
-        lL = Orchestrator.OrchestratorLoggerGet()
-        # HTMLRenderDef
-        lItemHTMLRenderDef = self.mBackwardCompatibilityHTMLDef
-        lResultStr = ""
-        if lItemHTMLRenderDef is not None:  # Call def (inRequest, inGSettings) or def (inGSettings)
-            lHTMLResult = None
-            lDEFSignature = signature(lItemHTMLRenderDef)  # Get signature of the def
-            lDEFARGLen = len(lDEFSignature.parameters.keys())  # get count of the def args
-            try:
-                if lDEFARGLen == 1:  # def (inGSettings)
-                    lHTMLResult = lItemHTMLRenderDef(lGS)
-                elif lDEFARGLen == 2:  # def (inRequest, inGSettings)
-                    lHTMLResult = lItemHTMLRenderDef(inRequest, lGS)
-                elif lDEFARGLen == 0:  # def ()
-                    lHTMLResult = lItemHTMLRenderDef()
-                # RunFunction
-                # Backward compatibility up to 1.2.0 - call HTML generator if result has no "HTMLStr"
-                if type(lHTMLResult) is str:
-                    lResultStr = lHTMLResult
-                elif "HTMLStr" in lHTMLResult or "JSONDict" in lHTMLResult:
-                    lResultStr = lHTMLResult["HTMLStr"]
-                else:
-                    # Call backward compatibility HTML generator
-                    lResultStr = Basic.HTMLControlPanelBC(inCPDict=lHTMLResult)
-            except Exception as e:
-                if lL: lL.exception(f"Error in control panel HTMLRenderDef. CP Key {self.mControlPanelNameStr}. Exception are below")
-        return lResultStr
-
-
-    def BackwardAdapterJSONDef(self,inRequest):
-        lGS = Orchestrator.GSettingsGet()
-        lL = Orchestrator.OrchestratorLoggerGet()
-        # HTMLRenderDef
-        lItemJSONGeneratorDef = self.mBackwardCompatibilityJSONDef
-        lResultDict = {}
-        if lItemJSONGeneratorDef is not None:  # Call def (inRequest, inGSettings) or def (inGSettings)
-            lJSONResult = None
-            lDEFSignature = signature(lItemJSONGeneratorDef)  # Get signature of the def
-            lDEFARGLen = len(lDEFSignature.parameters.keys())  # get count of the def args
-            try:
-                if lDEFARGLen == 1:  # def (inGSettings)
-                    lJSONResult = lItemJSONGeneratorDef(lGS)
-                elif lDEFARGLen == 2:  # def (inRequest, inGSettings)
-                    lJSONResult = lItemJSONGeneratorDef(inRequest, lGS)
-                elif lDEFARGLen == 0:  # def ()
-                    lJSONResult = lItemJSONGeneratorDef()
-                # RunFunction
-                # Backward compatibility up to 1.2.0 - call HTML generator if result has no "HTMLStr"
-                lType = type(lJSONResult)
-                if lType is str or lJSONResult is None or lType is int or lType is list or lType is dict or lType is bool or lType is float:
-                    lResultDict = lJSONResult
-                else:
-                    if lL: lL.warning(f"JSONGenerator return bad type: {str(type(lJSONResult))}, CP Key {self.mControlPanelNameStr}")
-            except Exception as e:
-                if lL: lL.exception(
-                    f"Error in control panel JSONGeneratorDef. CP Key {self.mControlPanelNameStr}. Exception are below")
-        return lResultDict
-
-    def BackwardAdapterJSDef(self,inRequest):
-        lGS = Orchestrator.GSettingsGet()
-        lL = Orchestrator.OrchestratorLoggerGet()
-        # HTMLRenderDef
-        lJSInitGeneratorDef = self.mBackwardCompatibilityJSDef
-        lResultStr = ""
-        if lJSInitGeneratorDef is not None:  # Call def (inRequest, inGSettings) or def (inGSettings)
-            lJSResult = ""
-            lDEFSignature = signature(lJSInitGeneratorDef)  # Get signature of the def
-            lDEFARGLen = len(lDEFSignature.parameters.keys())  # get count of the def args
-            try:
-                if lDEFARGLen == 1:  # def (inGSettings)
-                    lJSResult = lJSInitGeneratorDef(lGS)
-                elif lDEFARGLen == 2:  # def (inRequest, inGSettings)
-                    lJSResult = lJSInitGeneratorDef(inRequest, lGS)
-                elif lDEFARGLen == 0:  # def ()
-                    lJSResult = lJSInitGeneratorDef()
-                if type(lJSResult) is str:
-                    lResultStr = lJSResult  # Add delimiter to some cases
-                else:
-                    if lL: lL.warning(f"JSInitGenerator return bad type: {str(type(lJSResult))}, CP Key {self.mControlPanelNameStr}")
-            except Exception as e:
-                if lL: lL.exception(
-                    f"Error in control panel JSInitGeneratorDef. CP Key {self.mControlPanelNameStr}. Exception are below")
-        return lResultStr

-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/Process.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/Process.html deleted file mode 100644 index 657a3b1b..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/Process.html +++ /dev/null @@ -1,924 +0,0 @@ - - - - - - - - - - pyOpenRPA.Orchestrator.Managers.Process — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Orchestrator.Managers.Process
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Orchestrator.Managers.Process

-#from pyOpenRPA.Orchestrator import Managers
-from .. import __Orchestrator__
-import os
-import time
-
-from pyOpenRPA import Orchestrator
-
[docs]class Process():
-    """
-    Manager process, which is need to be started / stopped / restarted
-
-    With Process instance you can automate your process activity. Use schedule package to set interval when process should be active and when not.
-
-    All defs in class are pickle safe! After orchestrator restart (if not the force stop of the orchestrator process) your instance with properties will be restored. But it not coverage the scheduler which is in __Orchestrator__ .
-    After orc restart you need to reinit all schedule rules: Orchestrator.OrchestratorScheduleGet
-
-    Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-
-    .. code-block:: python
-        # For the safe init class use ProcessInitSafe
-        lProcess = Orchestrator.Managers.ProcessInitSafe(inAgentHostNameStr="PCNAME",inAgentUserNameStr="USER",
-             inProcessNameWOExeStr="notepad",inStartCMDStr="notepad",inStopSafeTimeoutSecFloat=3)
-        # Async way to run job
-        lProcess.ScheduleStatusCheckEverySeconds(inIntervalSecondsInt=5)
-        Orchestrator.OrchestratorScheduleGet().every(5).seconds.do(Orchestrator.OrchestratorThreadStart,
-                                                                   lProcess.StartCheck)
-        # OR (sync mode)
-        Orchestrator.OrchestratorScheduleGet().every(5).seconds.do(lProcess.StartCheck)
-
-    How to use StopSafe on the robot side
-
-    .. code-block:: python
-        from pyOpenRPA.Tools import StopSafe
-        StopSafe.Init(inLogger=None)
-        StopSafe.IsSafeStop() # True - WM_CLOSE SIGNAL has come. taskkill /im someprocess.exe
-    """
-
-    mAgentHostNameStr = None
-    mAgentUserNameStr = None
-    mStartPathStr = None
-    mStartCMDStr = None
-    mStartArgDict = None
-    mStatusCheckIntervalSecFloat = None
-    mProcessNameWOExeStr = None
-    mStopSafeTimeoutSecFloat = None
-    mStatusStr = None # 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-
-    # MST - Manual Stop Trigger
-    mMSTdTSecFloat: float = None
-    mMSTdNInt = None
-    mMSTStartTimeList = []
-
-    mAgentMuteBool = False # Mute any sends to agent while some action is perfomed
-
-    mStatusSavedStr = None # Saved status to the further restore
-
-
[docs]    def MuteWait(self):
-        """
-        Internal def. Wait when class is apply to send new activities to the agent
-
-        :return:
-        """
-        lIntervalSecFloat = 0.3
-        while self.mAgentMuteBool == True:
-            time.sleep(lIntervalSecFloat)
-        return None

-
-
[docs]    def KeyTurpleGet(self):
-        """
-        Get the key turple of the current process
-
-        """
-        return (self.mAgentHostNameStr.upper(), self.mAgentUserNameStr.upper(), self.mProcessNameWOExeStr.upper())

-
-
-    def __init__(self, inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr = None, inStopSafeTimeoutSecFloat=300, inStartArgDict=None, inStatusCheckIntervalSecFloat=30):
-        """
-        Init the class instance.
-        !ATTENTION! Function can raise exception if process with the same (inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr) is already exists in GSettings (can be restored from previous Orchestrator session). See ProcessInitSafe to sefaty init the instance or restore previous
-        !ATTENTION! Schedule options you must
-
-        :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-        :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-        :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-        :param inStartPathStr: Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute
-        :param inStartCMDStr: CMD script to start program (if no start file is exists)
-        :param inStopSafeTimeoutSecFloat: Time to wait for stop safe. After that do the stop force (if process is not stopped)
-        """
-        lGS = __Orchestrator__.GSettingsGet()
-        # Check if Process is not exists in GSettings
-        if (inAgentHostNameStr.upper(), inAgentUserNameStr.upper(), inProcessNameWOExeStr.upper()) not in lGS["ManagersProcessDict"]:
-            self.mStartArgDict = inStartArgDict
-            self.mAgentHostNameStr = inAgentHostNameStr
-            self.mAgentUserNameStr = inAgentUserNameStr
-            self.mStartPathStr = inStartPathStr
-            self.mStartCMDStr = inStartCMDStr
-            self.mProcessNameWOExeStr = inProcessNameWOExeStr
-            self.mStopSafeTimeoutSecFloat = inStopSafeTimeoutSecFloat
-            lGS["ManagersProcessDict"][(inAgentHostNameStr.upper(), inAgentUserNameStr.upper(), inProcessNameWOExeStr.upper())]=self
-            lActivityDict = __Orchestrator__.ProcessorActivityItemCreate(inDef=self.StatusCheck,inArgList=[], inThreadBool=True)
-            __Orchestrator__.ProcessorActivityItemAppend(inActivityItemDict=lActivityDict)
-            if inStatusCheckIntervalSecFloat is not None: __Orchestrator__.OrchestratorScheduleGet().every(inStatusCheckIntervalSecFloat).seconds.do(Orchestrator.OrchestratorThreadStart,self.StatusCheck)
-            self.mStatusCheckIntervalSecFloat = inStatusCheckIntervalSecFloat
-        else: raise Exception(f"Managers.Process ({inAgentHostNameStr}, {inAgentUserNameStr}, {inProcessNameWOExeStr}): Can't init the Process instance because it already inited in early (see ProcessInitSafe)")
-
-
[docs]    def ManualStopTriggerSet(self, inMSTdTSecFloat: float, inMSTdNInt: int) -> None:
-        """
-        Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period
-
-        :param inMSTdTSecFloat: Time perios in seconds
-        :param inMSTdNInt: Counts of the start tries
-        :return: None
-        """
-
-        # MST - Manual Stop Trigger
-        self.mMSTdTSecFloat = inMSTdTSecFloat
-        self.mMSTdNInt = inMSTdNInt

-
-
-
[docs]    def ManualStopTriggerNewStart(self):
-        """
-        Log new start event. Check if it is applicable. Change status if ManualStop trigger criteria is applied
-
-        :return: # 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        if self.mMSTdTSecFloat is not None and self.mMSTdNInt is not None:
-            lTimeNowSecFloat  = time.time()
-            self.mMSTStartTimeList.append(lTimeNowSecFloat) # Append current time to MST list
-            # Remove old items from list
-            lMSTStartTimeList = []
-            for lTimeItemSecFloat in self.mMSTStartTimeList:
-                ldTSecFloat = lTimeNowSecFloat - lTimeItemSecFloat
-                # Move to the new list if dT less
-                if ldTSecFloat < self.mMSTdTSecFloat: lMSTStartTimeList.append(lTimeItemSecFloat)
-            self.mMSTStartTimeList = lMSTStartTimeList # Set new list
-            # Check count in list
-            if len(lMSTStartTimeList) > self.mMSTdNInt:
-                self.mStatusStr = "1_STOPPED_MANUAL"
-                # Log info about process
-                lL = __Orchestrator__.OrchestratorLoggerGet()
-                lL.info(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): ManualStopTrigger is activated. {self.mMSTdNInt} start tries in {self.mMSTdTSecFloat} sec.")
-        return self.mStatusStr

-
-
[docs]    def ManualStopListClear(self) -> None:
-        """
-        Clear the last start tries list.
-
-        :return: None
-        """
-        self.mMSTStartTimeList=[]

-
-
[docs]    def Manual2Auto(self) -> str:
-        """
-        Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self):    def StatusCheckStorForce(self): def StatusCheckStopSafe(self):
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        lLogBool = False
-        if self.mStatusStr=="1_STOPPED_MANUAL": self.mStatusStr = "0_STOPPED"; lLogBool=True
-        if self.mStatusStr=="3_STOP_SAFE_MANUAL": self.mStatusStr = "2_STOP_SAFE"; lLogBool=True
-        if self.mStatusStr=="5_STARTED_MANUAL": self.mStatusStr = "4_STARTED"; lLogBool=True
-        # Log info about process
-        if lLogBool == True: self.StatusChangeLog()
-        return self.mStatusStr

-
-
[docs]    def Start(self, inIsManualBool = True, inStartArgDict=None) -> str:
-        """
-        Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto.
-        Will not start if STOP SAFE is now and don't start auto is stopped manual now
-
-        :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        if inIsManualBool == False: self.ManualStopTriggerNewStart() # Set the time
-        if self.mStatusStr is not None and (self.mStatusStr == "1_STOPPED_MANUAL" or "STOP_SAFE" in self.mStatusStr) and inIsManualBool == False:
-            lStr = f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Process will not start because of stopped manual or stop safe is now."
-            __Orchestrator__.OrchestratorLoggerGet().warning(lStr)
-            return self.mStatusStr
-        # Send activity item to agent - wait result
-        if self.mStartPathStr is not None: lCMDStr = os.path.abspath(self.mStartPathStr)
-        elif self.mStartCMDStr is not None: lCMDStr = self.mStartCMDStr
-        # Append args
-        if inStartArgDict is not None: self.mStartArgDict = inStartArgDict
-        if self.mStartArgDict is not None:
-            for lItemKeyStr in self.mStartArgDict:
-                lItemValueStr = self.mStartArgDict[lItemKeyStr]
-                lCMDStr = f"{lCMDStr} {lItemKeyStr} {lItemValueStr}"
-        #import pdb
-        #pdb.set_trace()
-        self.MuteWait()
-        self.mAgentMuteBool=True
-        lActivityItemStart = __Orchestrator__.ProcessorActivityItemCreate(inDef="OSCMD",
-              inArgDict={"inCMDStr":lCMDStr,"inSendOutputToOrchestratorLogsBool":False, "inCaptureBool":False},
-              inArgGSettingsStr="inGSettings")
-        lGUIDStr = __Orchestrator__.AgentActivityItemAdd(inHostNameStr=self.mAgentHostNameStr,
-                                                         inUserStr=self.mAgentUserNameStr,
-                                                         inActivityItemDict=lActivityItemStart)
-        lStartResult = __Orchestrator__.AgentActivityItemReturnGet(inGUIDStr=lGUIDStr)
-        if inIsManualBool==True:
-            self.mStatusStr = "5_STARTED_MANUAL"
-        else:
-            self.mStatusStr = "4_STARTED"
-        # Log info about process
-        self.StatusChangeLog()
-        self.mAgentMuteBool = False
-        return self.mStatusStr

-
-
[docs]    def StartCheck(self) -> str:
-        """
-        Start program if auto stopped (0_STOPPED).
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.MuteWait()
-        if self.mStatusStr == "0_STOPPED":
-            self.Start(inIsManualBool=False)
-        return self.mStatusStr

-
-
[docs]    def StopSafe(self, inIsManualBool = True, inStopSafeTimeoutSecFloat = None) -> str:
-        """
-        Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it.
-        Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto
-
-        :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-        :param inStopSafeTimeoutSecFloat: Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        if inStopSafeTimeoutSecFloat is None: inStopSafeTimeoutSecFloat = self.mStopSafeTimeoutSecFloat
-        self.MuteWait()
-        self.mAgentMuteBool=True
-        # Send activity item to agent - wait result
-        lCMDStr = f'taskkill /im "{self.mProcessNameWOExeStr}.exe" /fi "username eq %USERNAME%"'
-        lActivityItemStart = __Orchestrator__.ProcessorActivityItemCreate(
-            inDef="OSCMD",inArgDict={"inCMDStr": lCMDStr,"inSendOutputToOrchestratorLogsBool":False, "inCaptureBool": False},inArgGSettingsStr="inGSettings")
-        lGUIDStr = __Orchestrator__.AgentActivityItemAdd(inHostNameStr=self.mAgentHostNameStr,
-                                                         inUserStr=self.mAgentUserNameStr,
-                                                         inActivityItemDict=lActivityItemStart)
-        lStartResult = __Orchestrator__.AgentActivityItemReturnGet(inGUIDStr=lGUIDStr)
-        if inIsManualBool==True:
-            self.mStatusStr = "3_STOP_SAFE_MANUAL"
-        else:
-            self.mStatusStr = "2_STOP_SAFE"
-        # Log info about process
-        self.StatusChangeLog()
-        # Interval check is stopped
-        lTimeStartFloat = time.time()
-        lIntervalCheckSafeStatusFLoat = 15.0
-        while "SAFE" in self.mStatusStr and (time.time() - lTimeStartFloat) < inStopSafeTimeoutSecFloat:
-            self.StatusCheck()
-            if "SAFE" not in self.mStatusStr: break
-            time.sleep(lIntervalCheckSafeStatusFLoat)
-        if "SAFE" in  self.mStatusStr:
-            # Log info about process
-            lL = __Orchestrator__.OrchestratorLoggerGet()
-            lL.info(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Safe stop has been wait for {inStopSafeTimeoutSecFloat} sec. Now do the force stop.")
-            self.StopForce(inIsManualBool=inIsManualBool,inMuteIgnoreBool=True)
-        # Log info about process
-        # self.StatusChangeLog() status check has already log status (see above)
-        self.mAgentMuteBool = False
-        return self.mStatusStr

-
-
[docs]    def StopSafeCheck(self, inStopSafeTimeoutSecFloat = None) -> str:
-        """
-        Stop safe program if auto started (4_STARTED).
-
-        :param inStopSafeTimeoutSecFloat: Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.MuteWait()
-        if self.mStatusStr == "4_STARTED":
-            self.StopSafe(inIsManualBool=False, inStopSafeTimeoutSecFloat = inStopSafeTimeoutSecFloat)
-        return self.mStatusStr

-
-
[docs]    def StopForce(self, inIsManualBool = True, inMuteIgnoreBool = False) -> str:
-        """
-        Manual/Auto stop force. Force stop don't wait process termination  - it just terminate process now.
-        Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto
-
-        :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        if inMuteIgnoreBool == False: self.MuteWait()
-        lMuteWorkBool = False
-        if self.mAgentMuteBool==False: self.mAgentMuteBool=True; lMuteWorkBool=True
-        # Send activity item to agent - wait result
-        lCMDStr = f'taskkill /F /im "{self.mProcessNameWOExeStr}.exe" /fi "username eq %USERNAME%"'
-        lActivityItemStart = __Orchestrator__.ProcessorActivityItemCreate(
-            inDef="OSCMD",inArgDict={"inCMDStr": lCMDStr,"inSendOutputToOrchestratorLogsBool":False, "inCaptureBool": False},inArgGSettingsStr="inGSettings")
-        lGUIDStr = __Orchestrator__.AgentActivityItemAdd(inHostNameStr=self.mAgentHostNameStr,
-                                                         inUserStr=self.mAgentUserNameStr,
-                                                         inActivityItemDict=lActivityItemStart)
-        lStartResult = __Orchestrator__.AgentActivityItemReturnGet(inGUIDStr=lGUIDStr)
-        if inIsManualBool==True:
-            self.mStatusStr = "1_STOPPED_MANUAL"
-        else:
-            self.mStatusStr = "0_STOPPED"
-        # Log info about process
-        self.StatusChangeLog()
-        if lMuteWorkBool == True:
-            self.mAgentMuteBool=False
-        return self.mStatusStr

-
-
[docs]    def StopForceCheck(self) -> str:
-        """
-        Stop force program if auto started (4_STARTED).
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.MuteWait()
-        if self.mStatusStr == "4_STARTED":
-            self.StopForce(inIsManualBool=False)
-        return self.mStatusStr

-
-
[docs]    def RestartSafe(self, inIsManualBool = True):
-        """
-        Manual/Auto restart safe. Restart safe is the operation which send signal to process to terminate own work (send term signal to process). Then it run process. Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it.
-        Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto
-
-        :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.StopSafe(inIsManualBool=inIsManualBool)
-        return self.Start(inIsManualBool=inIsManualBool)

-
-
[docs]    def RestartForce(self, inIsManualBool = True):
-        """
-        Manual/Auto restart force. Force restart dont wait process termination  - it just terminate process now ant then start it.
-        Manual restart will block scheduling execution. To return schedule execution use def Manual2Auto
-
-        :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.StopForce(inIsManualBool=inIsManualBool)
-        return self.Start(inIsManualBool=inIsManualBool)

-
-
[docs]    def StatusSave(self):
-        """
-        Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don't save "STOP_SAFE" status > "STOPPED"
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        lWarnSafeBool = True
-        if self.mStatusStr == "2_STOP_SAFE": self.mStatusSavedStr = "0_STOPPED"
-        elif self.mStatusStr == "3_STOP_SAFE_MANUAL": self.mStatusSavedStr = "1_STOPPED_MANUAL"
-        else: self.mStatusSavedStr = self.mStatusStr; lWarnSafeBool = False
-        if lWarnSafeBool==True: __Orchestrator__.OrchestratorLoggerGet().warning(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Safe status has been catched when safe > change saved status to stopped.")
-        return self.mStatusStr

-
-
-
[docs]    def StatusCheckIntervalRestore(self):
-        """Call from orchestrator when init
-        """
-        if self.mStatusCheckIntervalSecFloat is not None: 
-            __Orchestrator__.OrchestratorLoggerGet().info(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Restore schedule to StatusCheck in interval of {self.mStatusCheckIntervalSecFloat} sec.")
-            __Orchestrator__.OrchestratorScheduleGet().every(self.mStatusCheckIntervalSecFloat).seconds.do(Orchestrator.OrchestratorThreadStart,self.StatusCheck)

-
-
[docs]    def StatusRestore(self):
-        """
-        Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        self.StatusCheck() # check current status
-        # Do some action
-        if self.mStatusSavedStr != self.mStatusStr and self.mStatusSavedStr is not None:
-            #lManualBool = False
-            #if "MANUAL" in self.mStatusSavedStr:
-            #    lManualBool = True
-            if "STOPPED" in self.mStatusSavedStr and "STOPPED" not in self.mStatusStr:
-                self.StopSafe(inIsManualBool=True)
-            if "STARTED" in self.mStatusSavedStr and "STARTED" not in self.mStatusStr:
-                self.Start(inIsManualBool=True)
-            Orchestrator.OrchestratorLoggerGet().info(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Status has been restored to {self.mStatusSavedStr}")
-            self.mStatusStr = self.mStatusSavedStr
-            self.mStatusSavedStr = None
-        return self.mStatusStr

-
-
[docs]    def StatusChangeLog(self):
-        """
-        Lof information about status change
-
-        :return:
-        """
-        # Log info about process
-        lL = __Orchestrator__.OrchestratorLoggerGet()
-        lL.info(f"Managers.Process ({self.mAgentHostNameStr}, {self.mAgentUserNameStr}, {self.mProcessNameWOExeStr}): Status has been changed to {self.mStatusStr})")

-
-
-
[docs]    def StatusCheck(self):
-        """
-        Check if process is alive. The def will save the manual flag is exists. Don't wait mute but set mute if it is not set.
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        # Send activity item to agent - wait result
-        lLogBool = False
-        lActivityItemUserProcessList = __Orchestrator__.ProcessorActivityItemCreate(inDef="ProcessWOExeUpperUserListGet")
-        #self.MuteWait()
-        self.mAgentMuteBool=True
-        lGUIDStr = __Orchestrator__.AgentActivityItemAdd(inHostNameStr=self.mAgentHostNameStr,inUserStr=self.mAgentUserNameStr,inActivityItemDict=lActivityItemUserProcessList)
-        lUserProcessList = __Orchestrator__.AgentActivityItemReturnGet(inGUIDStr=lGUIDStr)
-        if self.mProcessNameWOExeStr.upper() in lUserProcessList:
-            if self.mStatusStr == "1_STOPPED_MANUAL": self.mStatusStr = "5_STARTED_MANUAL"; lLogBool=True
-            if self.mStatusStr == "0_STOPPED": self.mStatusStr = "4_STARTED"; lLogBool=True
-            if self.mStatusStr is None: self.mStatusStr = "4_STARTED"; lLogBool=True
-        else:
-            if self.mStatusStr == "2_STOP_SAFE": self.mStatusStr = "0_STOPPED"; lLogBool = True
-            if self.mStatusStr == "3_STOP_SAFE_MANUAL": self.mStatusStr = "1_STOPPED_MANUAL"; lLogBool = True
-            if self.mStatusStr == "5_STARTED_MANUAL": self.mStatusStr = "1_STOPPED_MANUAL"; lLogBool=True
-            if self.mStatusStr == "4_STARTED": self.mStatusStr = "0_STOPPED"; lLogBool=True
-            if self.mStatusStr is None: self.mStatusStr = "0_STOPPED"; lLogBool=True
-        # Log info about process
-        if lLogBool == True: self.StatusChangeLog()
-        self.mAgentMuteBool = False
-        return self.mStatusStr

-
[docs]    def StatusCheckStart(self):
-        """
-        Check process status and run it if auto stopped self.mStatusStr is "0_STOPPED"
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        lStatusStr = self.StatusCheck()
-        if lStatusStr == "0_STOPPED":
-            self.Start(inIsManualBool=False)
-        return self.mStatusStr

-
[docs]    def StatusCheckStopForce(self):
-        """
-        Check process status and auto stop force it if self.mStatusStr is 4_STARTED
-
-        :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-        """
-        lStatusStr = self.StatusCheck()
-        if lStatusStr == "4_STARTED":
-            self.StopForce(inIsManualBool=False)
-        return self.mStatusStr

-
-
[docs]    def StatusCheckStopSafe(self):
-        """
-        Check process status and auto stop safe it if self.mStatusStr is 4_STARTED
-
-        :return:
-        """
-        lStatusStr = self.StatusCheck()
-        if lStatusStr == "4_STARTED":
-            self.StopSafe(inIsManualBool=False)
-        return self.mStatusStr

-
-
-
[docs]def ProcessInitSafe(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr = None, inStopSafeTimeoutSecFloat=300) -> Process:
-    """
-    Exception safe function. Check if process instance is not exists in GSettings (it can be after restart because Orchestrator restore objects from dump of the previous Orchestrator session)
-    Return existing instance (if exists) or create new instance and return it.
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inStartPathStr: Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute
-    :param inStartCMDStr: CMD script to start program (if no start file is exists)
-    :param inStopSafeTimeoutSecFloat: Time to wait for stop safe. After that do the stop force (if process is not stopped)
-    :return: Process instance
-    """
-    lProcess = ProcessGet(inAgentHostNameStr = inAgentHostNameStr, inAgentUserNameStr = inAgentUserNameStr, inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess
-    else: return Process(inAgentHostNameStr=inAgentHostNameStr,inAgentUserNameStr=inAgentUserNameStr,inProcessNameWOExeStr=inProcessNameWOExeStr,
-                  inStartPathStr=inStartPathStr,inStartCMDStr=inStartCMDStr,inStopSafeTimeoutSecFloat=inStopSafeTimeoutSecFloat)

-
-
[docs]def ProcessExists(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> bool:
-    """
-    Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str)
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: True - process exists in gsettings; False - else
-    """
-    return (inAgentHostNameStr.upper(), inAgentUserNameStr.upper(), inProcessNameWOExeStr.upper()) in __Orchestrator__.GSettingsGet()["ManagersProcessDict"]

-
-
-
[docs]def ProcessGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> Process:
-    """
-    Return the process instance by the inProcessNameWOExeStr
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: Process instance (if exists) Else None
-    """
-    return __Orchestrator__.GSettingsGet()["ManagersProcessDict"].get((inAgentHostNameStr.upper(), inAgentUserNameStr.upper(), inProcessNameWOExeStr.upper()),None)

-
-
[docs]def ProcessStatusStrGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> str:
-    """
-    Get the status of the Process instance.
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr = inAgentHostNameStr, inAgentUserNameStr = inAgentUserNameStr, inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess.mStatusStr

-
-
[docs]def ProcessStart(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -> str:
-    """
-    Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr = inAgentHostNameStr, inAgentUserNameStr = inAgentUserNameStr, inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess.Start(inIsManualBool=inIsManualBool)

-
-
-
[docs]def ProcessStopSafe(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True, inStopSafeTimeoutSecFloat = None) -> str:
-    """
-    Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it.
-    Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-    :param inStopSafeTimeoutSecFloat: Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr = inAgentHostNameStr, inAgentUserNameStr = inAgentUserNameStr, inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess.StopSafe(inIsManualBool=inIsManualBool)

-
-
[docs]def ProcessStopForce(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -> str:
-    """
-    Manual/Auto stop force. Force stop dont wait process termination  - it just terminate process now.
-    Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inIsManualBool: Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr = inAgentHostNameStr, inAgentUserNameStr = inAgentUserNameStr, inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess.StopForce(inIsManualBool=inIsManualBool)

-
-
[docs]def ProcessStatusSave(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str):
-    """
-    Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don't save "STOP_SAFE" status > "STOPPED"
-
-    :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None:
-        lProcess.StatusSave()
-        return lProcess.mStatusStr

-
-
[docs]def ProcessStatusRestore(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str):
-    """
-    Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted.
-
-    :return: Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None:
-        lProcess.StatusRestore()
-        return lProcess.mStatusStr

-
-
[docs]def ProcessStatusCheck(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> str:
-    """
-    Check if process is alive. The def will save the manual flag is exists.
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None:
-        lProcess.StatusCheck()
-        return lProcess.mStatusStr

-
-
[docs]def ProcessManual2Auto(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> str:
-    """
-    Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self):    def StatusCheckStorForce(self): def StatusCheckStopSafe(self):
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: Process status. See self.mStatusStr.
-        Process instance has the following statuses:
-        - 0_STOPPED
-        - 1_STOPPED_MANUAL
-        - 2_STOP_SAFE
-        - 3_STOP_SAFE_MANUAL
-        - 4_STARTED
-        - 5_STARTED_MANUAL
-        - None (if Process instance not exists)
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: return lProcess.Manual2Auto()

-
-
[docs]def ProcessManualStopTriggerSet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str,  inMSTdTSecFloat: float, inMSTdNInt: int) -> None:
-    """
-    Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self):    def StatusCheckStorForce(self): def StatusCheckStopSafe(self):
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inMSTdTSecFloat: Time periods in seconds
-    :param inMSTdNInt: Counts of the start tries
-    :return: None
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: lProcess.ManualStopTriggerSet(inMSTdTSecFloat = inMSTdTSecFloat, inMSTdNInt = inMSTdNInt)

-
-
-
[docs]def ProcessManualStopListClear(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -> None:
-    """
-    Clear the last start tries list.
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :return: None
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    if lProcess is not None: lProcess.ManualStopListClear()

-
-
[docs]def ProcessScheduleStatusCheckEverySeconds(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str,inIntervalSecondsInt: int = 120):
-    """
-    Run status check every interval in second you specify.
-
-    :param inAgentHostNameStr: Agent hostname in any case. Required to identify Process
-    :param inAgentUserNameStr: Agent user name in any case. Required to identify Process
-    :param inProcessNameWOExeStr: The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case
-    :param inIntervalSecondsInt: Interval in seconds. Default is 120
-    :return: None
-    """
-    lProcess = ProcessGet(inAgentHostNameStr=inAgentHostNameStr, inAgentUserNameStr=inAgentUserNameStr,
-                          inProcessNameWOExeStr=inProcessNameWOExeStr)
-    # Check job in threaded way
-    __Orchestrator__.OrchestratorScheduleGet().every(inIntervalSecondsInt).seconds.do(__Orchestrator__.OrchestratorThreadStart,lProcess.StatusCheck)

-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Web/Basic.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Web/Basic.html deleted file mode 100644 index 9311a985..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Web/Basic.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - - - - - pyOpenRPA.Orchestrator.Web.Basic — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Orchestrator.Web.Basic
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Orchestrator.Web.Basic

-import json, copy
-from .. import __Orchestrator__
-from .. import Processor
-# Escape JS to the safe JS for the inline JS in HTML tags ATTENTION! Use it only if want to paste JS into HTML tag - not in <script>
-# USAGE: JSEscapeForHTMLInline(inJSStr="lTest=\"Hello World\"; alert(\"lTest\")")
-def JSEscapeForHTMLInline(inJSStr):
-    lResult = inJSStr.replace("\"","&quot;")
-    return lResult
-
-
[docs]def JSProcessorActivityListAdd(inActivityList, inGUIDRemoveBool = True):
-    """
-        # Create JS for send activity list/ activity to the processor
-        # USAGE: Orchestrator.Web.Basic.JSProcessorActivityListAdd(inActivityList)
-
-    :param inActivityList: List of the activities (See __Orchestrator__.ProcessorActivityItemCreate)
-    :param inGUIDRemoveBool: True - remove GUID before generate JS (if GUID is not important)
-    :return: JavaScript string for the front end
-    """
-    Processor.__ActivityListVerify__(inActivityList=inActivityList)  # DO VERIFICATION FOR THE inActivityList
-    inActivityList = copy.deepcopy(inActivityList)
-    # Check if no def function is here - if exist - replace to alias
-    for lActivityItem in inActivityList:
-        if "GUIDStr" in lActivityItem and inGUIDRemoveBool == True: del lActivityItem["GUIDStr"] # Remove GUID from activity items if exists
-        lDef = lActivityItem["Def"]
-        if callable(lDef): raise Exception(f"pyOpenRPA Exception: You can't send ActivityList with def to JS. Use Def Alias (see Orchestrator.ProcessorAliasDefUpdate)")
-    lJSStr = f"""mGlobal.pyOpenRPA.ProcessorQueueAdd({json.dumps(inActivityList)});"""
-    return lJSStr

-
-
-
[docs]def JSActivityListExecute(inActivityList, inGUIDRemoveBool = True):
-    """
-        Create JS for execute activity list/ activity permanent
-        USAGE: Orchestrator.Web.Basic.JSActivityListExecute(inActivityList, inGUIDRemoveBool = True)
-
-    :param inActivityList: List of the activities (See __Orchestrator__.ProcessorActivityItemCreate)
-    :param inGUIDRemoveBool: True - remove GUID before generate JS (if GUID is not important)
-    :return: JavaScript string for the front end
-    """
-    Processor.__ActivityListVerify__(inActivityList=inActivityList)  # DO VERIFICATION FOR THE inActivityList
-    inActivityList = copy.deepcopy(inActivityList)
-    # Check if no def function is here - if exist - replace to alias
-    for lActivityItem in inActivityList:
-        if "GUIDStr" in lActivityItem and inGUIDRemoveBool == True: del lActivityItem["GUIDStr"] # Remove GUID from activity items if exists
-        lDef = lActivityItem["Def"]
-        if callable(lDef): raise Exception(f"pyOpenRPA Exception: You can't send ActivityList with def to JS. Use Def Alias (see Orchestrator.ProcessorAliasDefUpdate)")
-    lJSStr = f"""mGlobal.pyOpenRPA.ActivityListExecute({json.dumps(inActivityList)});"""
-    return lJSStr

-
-# Generate HTML code of the simple URL link by the URL
-# USAGE: Orchestrator.Web.Basic.HTMLLinkURL(inURLStr="test",inColorStr="orange")
-# USAGE: Basic.HTMLLinkURL(inURLStr="test",inColorStr="orange")
-def HTMLLinkURL(inURLStr, inTitleStr=None, inColorStr=None):
-    lCSSStyleStr = ""
-    if not inTitleStr: inTitleStr = inURLStr
-    if inColorStr: lCSSStyleStr=f"style=\"color:{inColorStr}\""
-    lResult=f"<a {lCSSStyleStr} href=\"{inURLStr}\">{inTitleStr}</a>"
-    return lResult
-
-# Generate HTML code of the simple URL link by the JS when onclick
-# USAGE: Orchestrator.Web.Basic.HTMLLinkJSOnClick(inJSOnClickStr="",inColorStr="orange")
-# USAGE: Basic.HTMLLinkJSOnClick(inJSOnClickStr="test",inColorStr="orange")
-def HTMLLinkJSOnClick(inJSOnClickStr, inTitleStr, inColorStr=None):
-    lCSSStyleStr = ""
-    if inColorStr: lCSSStyleStr=f"style=\"color:{inColorStr}\""
-    inJSOnClickStr= JSEscapeForHTMLInline(inJSStr=inJSOnClickStr) # Escape some symbols for the inline JS
-    lResult=f"<a {lCSSStyleStr} onclick=\"{inJSOnClickStr}\">{inTitleStr}</a>"
-    return lResult
-
-# Create HTMLLink by the def, argdict, arglist, gsettingsStr, logger Str titleStr, color, (add in processor queue)
-def HTMLLinkDefProcessor(inGSettings, inDef, inArgDict=None, inArgList=None, inArgGSettingsStr=None, inArgLoggerStr=None, inLinkTitleStr=None, inLinkColorStr=""):
-    lDefAliasStr = inDef
-    if callable(inDef):
-        lDefAliasStr = str(inDef)
-        lDefAliasStr = __Orchestrator__.ProcessorAliasDefUpdate(inGSettings=inGSettings, inDef=inDef, inAliasStr=lDefAliasStr)
-    if inLinkTitleStr is None: inLinkTitleStr = lDefAliasStr
-    lActivityList = [__Orchestrator__.ProcessorActivityItemCreate(inDef=lDefAliasStr,inArgList=inArgList,inArgDict=inArgDict,inArgGSettingsStr=inArgGSettingsStr,inArgLoggerStr=inArgLoggerStr)]
-    lJSStr = JSProcessorActivityListAdd(lActivityList)
-    lHTMLStr = HTMLLinkJSOnClick(inJSOnClickStr=lJSStr,inTitleStr=inLinkTitleStr, inColorStr=inLinkColorStr)
-    return lHTMLStr
-
-# Create HTMLLink by the def, argdict, arglist, gsettingsStr, logger Str titleStr, color, (execute permanently)
-def HTMLLinkDefExecute(inGSettings, inDef, inArgDict=None, inArgList=None, inArgGSettingsStr=None, inArgLoggerStr=None, inLinkTitleStr=None, inLinkColorStr=""):
-    lDefAliasStr = inDef
-    if callable(inDef):
-        lDefAliasStr = str(inDef)
-        lDefAliasStr = __Orchestrator__.ProcessorAliasDefUpdate(inGSettings=inGSettings, inDef=inDef, inAliasStr=lDefAliasStr)
-    if inLinkTitleStr is None: inLinkTitleStr = lDefAliasStr
-    lActivityList = [__Orchestrator__.ProcessorActivityItemCreate(inDef=lDefAliasStr,inArgList=inArgList,inArgDict=inArgDict,inArgGSettingsStr=inArgGSettingsStr,inArgLoggerStr=inArgLoggerStr)]
-    lJSStr = JSActivityListExecute(lActivityList)
-    lHTMLStr = HTMLLinkJSOnClick(inJSOnClickStr=lJSStr,inTitleStr=inLinkTitleStr, inColorStr=inLinkColorStr)
-    return lHTMLStr
-
-# HTML Generator for the CP up to v.1.2.0
-def HTMLControlPanelBC(inCPDict):
-    # FooterButtonX2List generation
-    lFooterButtonX2Str = ""
-    for lItem in inCPDict["FooterButtonX2List"]:
-        lFooterButtonX2Str+=f'<div class="ui basic {lItem.get("Color","")} button" onclick="{JSEscapeForHTMLInline(lItem.get("OnClick",""))}">{lItem.get("Text","")}</div>'
-    # FooterButtonX1List generation
-    lFooterButtonX1Str = ""
-    for lItem in inCPDict["FooterButtonX1List"]:
-        lFooterButtonX1Str+=f'<div class="ui basic {lItem.get("Color","")} button" onclick="{JSEscapeForHTMLInline(lItem.get("OnClick",""))}">{lItem.get("Text","")}</div>'
-    # BodyKeyValue generation
-    lBodyKeyValueStr = ""
-    for lItem in inCPDict["BodyKeyValueList"]:
-        lBodyKeyValueStr+=f"<li>{lItem['Key']}: {lItem['Value']}</li>"
-    # Generate consolidated string
-    lResultHTMLStr = f"""
-    <div class="card">
-        <div class="content">
-            <div class="right floated mini ui ">
-                {inCPDict['HeaderRightText']}
-            </div>
-            <div class="header">
-                {inCPDict['HeaderLeftText']}
-
-            </div>
-            <div class="meta">
-                {inCPDict['SubheaderText']}
-            </div>
-            <div class="description">
-                <ul style="padding-inline-start:16px;margin:0px">
-                    {lBodyKeyValueStr}
-                </ul>
-            </div>
-        </div>
-        <div class="extra content">
-            {inCPDict['FooterText']}
-        </div>
-        <div class="extra content">
-            <div class="ui two buttons">
-            {lFooterButtonX2Str}
-            </div>
-            <div class="ui horizontal divider">Add. controls</div>
-            <div class="ui one buttons">
-            {lFooterButtonX1Str}
-            </div>
-        </div>
-    </div>
-    """
-
-    return lResultHTMLStr
-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html deleted file mode 100644 index 050663f1..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html +++ /dev/null @@ -1,3160 +0,0 @@ - - - - - - - - - - pyOpenRPA.Orchestrator.__Orchestrator__ — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Orchestrator.__Orchestrator__
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Orchestrator.__Orchestrator__

-import subprocess, json, psutil, time, os, win32security, sys, base64, logging, ctypes, copy #Get input argument
-import pickle
-import inspect
-import schedule
-#from partd import Server
-
-from . import Server
-from . import Timer
-from . import Processor
-from . import BackwardCompatibility # Backward compatibility from v1.1.13
-from . import Core
-from . import Managers
-from subprocess import CREATE_NEW_CONSOLE
-from .Utils import LoggerHandlerDumpLogList
-
-# ATTENTION! HERE IS NO Relative import because it will be imported dynamically
-# All function check the flag SessionIsWindowResponsibleBool == True else no cammand is processed
-# All functions can return None, Bool or Dict { "IsSuccessful": True }
-from .RobotRDPActive import CMDStr # Create CMD Strings
-from .RobotRDPActive import Connector # RDP API
-
-#from .Settings import Settings
-import importlib
-from importlib import util
-import threading # Multi-threading for RobotRDPActive
-from .RobotRDPActive import RobotRDPActive #Start robot rdp active
-from .RobotScreenActive import Monitor #Start robot screen active
-from . import SettingsTemplate # Settings template
-import uuid # Generate uuid
-import datetime # datetime
-import math
-import glob # search the files
-import urllib
-
-#Единый глобальный словарь (За основу взять из Settings.py)
-gSettingsDict = None
-
-# AGENT DEFS
-
-
[docs]def AgentActivityItemAdd(inHostNameStr, inUserStr, inActivityItemDict, inGSettings=None):
-    """
-    Add activity in AgentDict. Check if item is created
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr: Agent host name
-    :param inUserStr: User login, where agent is based
-    :param inActivityItemDict: ActivityItem
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = copy.deepcopy(inActivityItemDict)
-    # Add GUIDStr if not exist
-    lGUIDStr = None
-    if "GUIDStr" not in lActivityItemDict:
-        lGUIDStr = str(uuid.uuid4()) # generate new GUID
-        lActivityItemDict["GUIDStr"] = lGUIDStr
-    else: lGUIDStr = lActivityItemDict["GUIDStr"]
-    # Add CreatedByDatetime
-    lActivityItemDict["CreatedByDatetime"] = datetime.datetime.now()
-    # Main alg
-    lAgentDictItemKeyTurple = (inHostNameStr.upper(),inUserStr.upper())
-    if lAgentDictItemKeyTurple not in inGSettings["AgentDict"]:
-        inGSettings["AgentDict"][lAgentDictItemKeyTurple] = SettingsTemplate.__AgentDictItemCreate__()
-    lThisAgentDict = inGSettings["AgentDict"][lAgentDictItemKeyTurple]
-    lThisAgentDict["ActivityList"].append(lActivityItemDict)
-    # Return the result
-    return lGUIDStr

-
-
-
[docs]def AgentActivityItemExists(inHostNameStr, inUserStr, inGUIDStr, inGSettings = None):
-    """
-    Check by GUID if ActivityItem has exists in request list. If exist - the result response has not been recieved from the agent
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inGUIDStr: GUID String of the ActivityItem
-    :return: True - ActivityItem is exist in AgentDict ; False - else case
-    """
-    # Check if GUID is exists in dict - has been recieved
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Main alg
-    lAgentDictItemKeyTurple = (inHostNameStr.upper(),inUserStr.upper())
-    lResultBool = False
-    if lAgentDictItemKeyTurple in inGSettings["AgentDict"]:
-        for lActivityItem in inGSettings["AgentDict"][lAgentDictItemKeyTurple]["ActivityList"]:
-            if inGUIDStr == lActivityItem.get("GUIDStr",None):
-                lResultBool = True
-                break
-    return lResultBool

-
-
[docs]def AgentActivityItemReturnExists(inGUIDStr, inGSettings = None):
-    """
-    Check by GUID if ActivityItem has been executed and result has come to the Orchestrator
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inGUIDStr: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    :return: True - result has been received from the Agent to orc; False - else case
-    """
-
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check if GUID is exists in dict - has been recieved
-    return inGUIDStr in inGSettings["AgentActivityReturnDict"]

-
-
-
[docs]def AgentActivityItemReturnGet(inGUIDStr, inCheckIntervalSecFloat = 0.5, inGSettings=None):
-    """
-    Work synchroniously! Wait while result will be recieved. Get the result of the ActivityItem execution on the Agent side. Before this please check by the def AgentActivityItemReturnExists that result has come to the Orchestrator
-
-    !ATTENTION! Use only after Orchestrator initialization! Before orchestrator init exception will be raised.
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inGUIDStr: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    :param inCheckIntervalSecFloat: Interval in sec of the check Activity Item result
-    :return: Result of the ActivityItem executed on the Agent side anr transmitted to the Orchestrator. IMPORTANT! ONLY JSON ENABLED Types CAN BE TRANSMITTED TO ORCHESTRATOR!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    #Check if Orchestrator has been initialized - else raise exception
-    if Core.IsOrchestratorInitialized(inGSettings=inGSettings) == True:
-        # Wait while result will not come here
-        while not AgentActivityItemReturnExists(inGSettings=inGSettings, inGUIDStr=inGUIDStr):
-            time.sleep(inCheckIntervalSecFloat)
-        # Return the result
-        return inGSettings["AgentActivityReturnDict"][inGUIDStr]["Return"]
-    else:
-        raise Exception(f"__Orchestrator__.AgentActivityItemReturnGet !ATTENTION! Use this function only after Orchestrator initialization! Before orchestrator init exception will be raised.")

-
-
[docs]def AgentOSCMD(inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr="cp1251", inGSettings=None, inCaptureBool=True):
-    """
-    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: Agent host name in upper case (example "RPA01", "RPA_99" and so on). Active agent session you can see on the orchestrator dashboard as Orchestrator admin
-    :param inUserStr: Agent user name in upper case (example "UserRPA"). Active agent session you can see on the orchestrator dashboard as Orchestrator admin
-    :param inCMDStr: command to execute on the Agent session
-    :param inRunAsyncBool: True - Agent processor don't wait execution; False - Agent processor wait cmd execution
-    :param inSendOutputToOrchestratorLogsBool: True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True
-    :param inCMDEncodingStr: Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is "cp1251" early was "cp866" - need test
-    :param inCaptureBool: !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSCMD", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inCMDStr":inCMDStr,"inRunAsyncBool":inRunAsyncBool, "inSendOutputToOrchestratorLogsBool": inSendOutputToOrchestratorLogsBool, "inCMDEncodingStr": inCMDEncodingStr, "inCaptureBool":inCaptureBool}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
[docs]def AgentOSLogoff(inHostNameStr, inUserStr):
-    """
-    Logoff the agent user session
-
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet()  # Set the global settings
-    lCMDStr = "shutdown /l"
-    lActivityItemDict = {
-        "Def":"OSCMD", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inCMDStr":lCMDStr,"inRunAsyncBool":False, "inSendOutputToOrchestratorLogsBool": True, "inCMDEncodingStr": "cp1251"}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
[docs]def AgentOSFileSend(inHostNameStr, inUserStr, inOrchestratorFilePathStr, inAgentFilePathStr, inGSettings = None):
-    """
-   Send the file from the Orchestrator to Agent (synchroniously) pyOpenRPA.Agent daemon process (safe for JSON transmition).
-   Work safety with big files
-   Thread safe - you can call def even if you dont init the orchestrator - def will be executed later
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr:
-    :param inFileDataBytes:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    if  inGSettings["ServerDict"]["ServerThread"] is None:
-        if inGSettings["Logger"]: inGSettings["Logger"].warning(f"AgentOSFileSend run before server init - activity will be append in the processor queue.")
-        lResult = {
-            "Def": AgentOSFileSend, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inHostNameStr":inHostNameStr, "inUserStr":inUserStr, "inOrchestratorFilePathStr":inOrchestratorFilePathStr, "inAgentFilePathStr": inAgentFilePathStr},  # 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)
-    else: # In processor - do execution
-        lActivityItemCheckIntervalSecFloat = inGSettings["ServerDict"]["AgentFileChunkCheckIntervalSecFloat"]
-
-        # Get the chunk limit
-        lChunkByteSizeInt = inGSettings["ServerDict"]["AgentFileChunkBytesSizeInt"]
-
-        lL = inGSettings.get("Logger",None)
-
-        # Open the file and get the size (in bytes)
-        lFile = open(inOrchestratorFilePathStr,"rb")
-        lFileSizeBytesInt = lFile.seek(0,2)
-        lFile.seek(0)
-        #import pdb
-        #pdb.set_trace()
-        lChunkCountInt = math.ceil(lFileSizeBytesInt/lChunkByteSizeInt)
-        if lL: lL.info(f"O2A: Start to send binary file via chunks. Chunk count: {lChunkCountInt}, From (Orch side): {inOrchestratorFilePathStr}, To (Agent side): {inAgentFilePathStr}")
-        for lChunkNumberInt in range(lChunkCountInt):
-            # Read chunk
-            lFileChunkBytes = lFile.read(lChunkByteSizeInt)
-            # Convert to base64
-            lFileChunkBase64Str = base64.b64encode(lFileChunkBytes).decode("utf-8")
-            # Send chunk
-            if lChunkNumberInt == 0:
-                lActivityItemGUIDStr = AgentOSFileBinaryDataBase64StrCreate(inGSettings=inGSettings,inHostNameStr=inHostNameStr,
-                                                     inUserStr=inUserStr,inFilePathStr=inAgentFilePathStr,
-                                                     inFileDataBase64Str=lFileChunkBase64Str)
-            else:
-                lActivityItemGUIDStr = AgentOSFileBinaryDataBase64StrAppend(inGSettings=inGSettings, inHostNameStr=inHostNameStr,
-                                                     inUserStr=inUserStr, inFilePathStr=inAgentFilePathStr,
-                                                     inFileDataBase64Str=lFileChunkBase64Str)
-            # Wait for the activity will be deleted
-            while AgentActivityItemExists(inGSettings=inGSettings,inHostNameStr=inHostNameStr,inUserStr=inUserStr,inGUIDStr=lActivityItemGUIDStr):
-                time.sleep(lActivityItemCheckIntervalSecFloat)
-            if lL: lL.debug(
-                    f"O2A: BINARY SEND: Current chunk index: {lChunkNumberInt}")
-        if lL: lL.info(
-            f"O2A: BINARY SEND: Transmition has been complete")
-        # Close the file
-        lFile.close()

-
-
[docs]def AgentOSFileBinaryDataBytesCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBytes, inGSettings=None):
-    """
-    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:
-    :param inUserStr:
-    :param inFilePathStr:
-    :param inFileDataBytes:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lFileDataBase64Str = base64.b64encode(inFileDataBytes).decode("utf-8")
-    lActivityItemDict = {
-        "Def":"OSFileBinaryDataBase64StrCreate", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr,"inFileDataBase64Str":lFileDataBase64Str}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
-
[docs]def AgentOSFileBinaryDataBase64StrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings=None):
-    """
-    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:
-    :param inUserStr:
-    :param inFilePathStr:
-    :param inFileDataBase64Str:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSFileBinaryDataBase64StrCreate", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr,"inFileDataBase64Str":inFileDataBase64Str}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
-
[docs]def AgentOSFileBinaryDataBase64StrAppend(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings = None):
-    """
-    Append binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr:
-    :param inFileDataBase64Str:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSFileBinaryDataBase64StrAppend", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr,"inFileDataBase64Str":inFileDataBase64Str}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
-# Send text file to Agent (string)
-
[docs]def AgentOSFileTextDataStrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataStr, inEncodingStr = "utf-8",inGSettings=None):
-    """
-    Create text file by the string by the pyOpenRPA.Agent daemon process
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr:
-    :param inFileDataStr:
-    :param inEncodingStr:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSFileTextDataStrCreate", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr,"inFileDataStr":inFileDataStr, "inEncodingStr": inEncodingStr}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
[docs]def AgentOSFileBinaryDataBase64StrReceive(inHostNameStr, inUserStr, inFilePathStr, inGSettings = None):
-    """
-    Read binary file and encode in base64 to transmit (safe for JSON transmition)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr: File path to read
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSFileBinaryDataBase64StrReceive", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
-
[docs]def AgentOSFileBinaryDataReceive(inHostNameStr, inUserStr, inFilePathStr):
-    """
-    Read binary file from agent (synchronious)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr: File path to read
-    :return: file data bytes
-    """
-    lFileDataBytes = None
-    inGSettings = GSettingsGet()  # Set the global settings
-    # Check thread
-    if  OrchestratorIsInited() == False:
-        if inGSettings["Logger"]: inGSettings["Logger"].warning(f"AgentOSFileBinaryDataReceive run before orc init - activity will be append in the processor queue.")
-        lResult = {
-            "Def": AgentOSFileBinaryDataReceive, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inHostNameStr":inHostNameStr, "inUserStr":inUserStr, "inFilePathStr":inFilePathStr},  # Args dictionary
-            "ArgGSettings": None,  # 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)
-    else: # In processor - do execution
-        lActivityItemDict = {
-            "Def":"OSFileBinaryDataBase64StrReceive", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-            "ArgList":[], # Args list
-            "ArgDict":{"inFilePathStr":inFilePathStr}, # 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)
-        }
-        
-        #Send item in AgentDict for the futher data transmition
-        lGUIDStr = AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)
-        lFileBase64Str = AgentActivityItemReturnGet(inGUIDStr=lGUIDStr)
-        if lFileBase64Str is not None: lFileDataBytes = base64.b64decode(lFileBase64Str)
-        return lFileDataBytes

-
-
[docs]def AgentOSFileTextDataStrReceive(inHostNameStr, inUserStr, inFilePathStr, inEncodingStr="utf-8", inGSettings = None):
-    """
-    Read text file in the agent GUI session
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :param inFilePathStr: File path to read
-    :param inEncodingStr: Text file encoding. Default 'utf-8'
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"OSFileTextDataStrReceive", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{"inFilePathStr":inFilePathStr, "inEncodingStr": inEncodingStr}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-
[docs]def AgentProcessWOExeUpperUserListGet(inHostNameStr, inUserStr, inGSettings = None):
-    """
-    Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inHostNameStr:
-    :param inUserStr:
-    :return: GUID String of the ActivityItem - you can wait (sync or async) result by this guid!
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lActivityItemDict = {
-        "Def":"ProcessWOExeUpperUserListGet", # def alias (look pyOpeRPA.Agent gSettings["ProcessorDict"]["AliasDefDict"])
-        "ArgList":[], # Args list
-        "ArgDict":{}, # 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)
-    }
-    #Send item in AgentDict for the futher data transmition
-    return AgentActivityItemAdd(inGSettings=inGSettings, inHostNameStr=inHostNameStr, inUserStr=inUserStr, inActivityItemDict=lActivityItemDict)

-
-# OS DEFS
-
-
[docs]def OSLogoff():
-    """
-    Logoff the current orchestrator session
-    :return:
-    """
-    os.system("shutdown /l")

-
-
[docs]def OSCredentialsVerify(inUserStr, inPasswordStr, inDomainStr=""): ##
-    """
-    Verify user credentials in windows. Return bool
-
-    :param inUserStr:
-    :param inPasswordStr:
-    :param inDomainStr:
-    :return: True - Credentials are actual; False - Credentials are not actual
-    """
-    try:
-        hUser = win32security.LogonUser(
-            inUserStr,inDomainStr, inPasswordStr,
-            win32security.LOGON32_LOGON_NETWORK, win32security.LOGON32_PROVIDER_DEFAULT
-        )
-    except win32security.error:
-        return False
-    else:
-        return True

-
-
[docs]def OSRemotePCRestart(inHostStr, inForceBool=True, inLogger = None):
-    """
-    Send signal via power shell to restart remote PC
-    ATTENTION: Orchestrator user need to have restart right on the Remote machine to restart PC.
-
-    :param inLogger: logger to log powershell result in logs
-    :param inHostStr: PC hostname which you need to restart.
-    :param inForceBool: True - send signal to force retart PC; False - else case
-    :return:
-    """
-    if inLogger is None: inLogger = OrchestratorLoggerGet()
-    lCMDStr = f"powershell -Command Restart-Computer -ComputerName {inHostStr}"
-    if inForceBool == True: lCMDStr = lCMDStr + " -Force"
-    OSCMD(inCMDStr=lCMDStr,inLogger=inLogger)

-
-
[docs]def OSCMD(inCMDStr, inRunAsyncBool=True, inLogger = None):
-    """
-    OS send command in shell locally
-
-    :param inCMDStr:
-    :param inRunAsyncBool:
-    :param inLogger:
-    :return: CMD result string
-    """
-    if inLogger is None: inLogger = OrchestratorLoggerGet()
-    lResultStr = ""
-    # New feature
-    if inRunAsyncBool == True:
-        inCMDStr = f"start {inCMDStr}"
-    # Subdef to listen OS result
-    def _CMDRunAndListenLogs(inCMDStr, inLogger):
-        lResultStr = ""
-        lOSCMDKeyStr = str(uuid.uuid4())[0:4].upper()
-        lCMDProcess = subprocess.Popen(f'cmd /c {inCMDStr}', stdout=subprocess.PIPE, stderr=subprocess.STDOUT, creationflags=CREATE_NEW_CONSOLE)
-        if inLogger:
-            lListenBool = True
-            inLogger.info(f"{lOSCMDKeyStr}: # # # # CMD Process has been STARTED # # # # ")
-            inLogger.info(f"{lOSCMDKeyStr}: {inCMDStr}")
-            while lListenBool:
-                lOutputLineBytes = lCMDProcess.stdout.readline()
-                if lOutputLineBytes == b"":
-                    lListenBool = False
-                lStr = lOutputLineBytes.decode('cp866')
-                if lStr.endswith("\n"): lStr = lStr[:-1]
-                inLogger.info(f"{lOSCMDKeyStr}: {lStr}")
-                lResultStr+=lStr
-            inLogger.info(f"{lOSCMDKeyStr}: # # # # CMD Process has been FINISHED # # # # ")
-        return lResultStr
-    # New call
-    if inRunAsyncBool:
-        lThread = threading.Thread(target=_CMDRunAndListenLogs, kwargs={"inCMDStr":inCMDStr, "inLogger":inLogger})
-        lThread.start()
-        lResultStr="ActivityList has been started in async mode - no output is available here."
-    else:
-        lResultStr = _CMDRunAndListenLogs(inCMDStr=inCMDStr, inLogger=inLogger)
-    #lCMDCode = "cmd /c " + inCMDStr
-    #subprocess.Popen(lCMDCode)
-    #lResultCMDRun = 1  # os.system(lCMDCode)
-    return lResultStr

-
-
[docs]def OrchestratorRestart(inGSettings=None):
-    """
-    Orchestrator restart
-
-    :param inGSettings: Global settings dict (singleton)
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    OrchestratorSessionSave(inGSettings=inGSettings) # Dump RDP List in file json
-    if inGSettings is not None:
-        lL = inGSettings["Logger"]
-        if lL: lL.info(f"Do restart")
-    # Restart session
-    os.execl(sys.executable, os.path.abspath(__file__), *sys.argv)
-    sys.exit(0)

-
-
[docs]def OrchestratorLoggerGet() -> logging.Logger:
-    """
-    Get the logger from the Orchestrator
-
-    :return:
-    """
-    return GSettingsGet().get("Logger",None)

-
-
-
[docs]def OrchestratorScheduleGet() -> schedule:
-    """
-    Get the schedule (schedule.readthedocs.io) from the Orchestrator
-
-    Fro example you can use:
-
-    .. code-block:: python
-        # One schedule threaded
-        Orchestrator.OrchestratorScheduleGet().every(5).seconds.do(lProcess.StatusCheckStart)
-
-        #New schedule thread # See def description Orchestrator.OrchestratorThreadStart
-        Orchestrator.OrchestratorScheduleGet().every(5).seconds.do(Orchestrator.OrchestratorThreadStart,lProcess.StatusCheckStart)
-
-    :return: schedule module. Example see here https://schedule.readthedocs.io/en/stable/examples.html
-    """
-    if GSettingsGet().get("SchedulerDict",{}).get("Schedule",None) is None:
-        GSettingsGet()["SchedulerDict"]["Schedule"]=schedule
-    return GSettingsGet().get("SchedulerDict",{}).get("Schedule",None)

-
-
[docs]def OrchestratorThreadStart(inDef, *inArgList, **inArgDict):
-    """
-    Execute def in new thread and pass some args with list and dict types
-
-    :param inDef: Python Def
-    :param inArgList: args as list
-    :param inArgDict: args as dict
-    :return: threading.Thread object
-    """
-    lDefThread = threading.Thread(target=inDef,args=inArgList,kwargs=inArgDict)
-    lDefThread.start()
-    return lDefThread

-
-
[docs]def OrchestratorIsAdmin():
-    """
-    Check if Orchestrator process is running as administrator
-
-    :return: True - run as administrator; False - not as administrator
-    """
-    try:
-        return ctypes.windll.shell32.IsUserAnAdmin()
-    except:
-        return False

-
-
[docs]def OrchestratorIsInited() -> bool:
-    """Check if Orchestrator initial actions were processed
-
-    :return: True - orc is already inited; False - else
-    :rtype: bool
-    """    
-
-    return Core.IsOrchestratorInitialized(inGSettings=GSettingsGet())

-
-
[docs]def OrchestratorInitWait() -> None:
-    """Wait thread while orc will process initial action. 
-    ATTENTION: DO NOT CALL THIS DEF IN THREAD WHERE ORCHESTRATOR MUST BE INITIALIZED - INFINITE LOOP
-    """
-    lIntervalSecFloat = 0.5
-    while not OrchestratorIsInited():
-        time.sleep(lIntervalSecFloat)

-    
-
-
[docs]def OrchestratorRerunAsAdmin():
-    """
-    Check if not admin - then rerun orchestrator as administrator
-
-    :return: True - run as administrator; False - not as administrator
-    """
-    if not OrchestratorIsAdmin():
-        # Re-run the program with admin rights
-        ctypes.windll.shell32.ShellExecuteW(None, "runas", sys.executable, " ".join(sys.argv), None, 1)
-    else:
-        print(f"!SKIPPED! Already run as administrator!")

-
-
[docs]def OrchestratorPySearchInit(inGlobPatternStr, inDefStr = None, inDefArgNameGSettingsStr = None, inAsyncInitBool = False):
-    """
-    Search the py files by the glob and do the safe init (in try except). Also add inited module in sys.modules as imported (module name = file name without extension).
-    You can init CP in async way!
-    .. code-block:: python
-
-        # USAGE VAR 1 (without the def  auto call)
-        # Autoinit control panels starts with CP_
-        Orchestrator.OrchestratorPySearchInit(inGlobPatternStr="ControlPanel\\CP_*.py")
-
-        # USAGE VAR 2 (with the def auto call) - for the backward compatibility CP for the Orchestrator ver. < 1.2.7
-        # Autoinit control panels starts with CP_
-        Orchestrator.OrchestratorPySearchInit(inGlobPatternStr="ControlPanel\\CP_*.py", inDefStr="SettingsUpdate", inDefArgNameGSettingsStr="inGSettings")
-
-        # INFO: The code above will replace the code below
-        ## !!! For Relative import !!! CP Version Check
-        try:
-            sys.path.insert(0,os.path.abspath(os.path.join(r"")))
-            from ControlPanel import CP_VersionCheck
-            CP_VersionCheck.SettingsUpdate(inGSettings=gSettings)
-        except Exception as e:
-            gSettings["Logger"].exception(f"Exception when init CP. See below.")
-
-
-    :param inGlobPatternStr: example"..\\*\\*\\*X64*.cmd"
-    :param inDefStr: OPTIONAL The string name of the def. For backward compatibility if you need to auto call some def from initialized module
-    :param inDefArgNameGSettingsStr: OPTIONAL The name of the GSettings argument in def (if exists)
-    :param inAsyncInitBool: OPTIONAL True - init py modules in many threads - parallel execution. False (default) - sequence execution
-    :return: { "ModuleNameStr":{"PyPathStr": "", "Module": ...},  ...}
-    """
-
-    # # # # # # # #
-    def __execute__(inResultDict, inPyPathItemStr, inDefStr = None, inDefArgNameGSettingsStr = None):
-        try:
-            lPyPathItemStr = inPyPathItemStr
-            lModuleNameStr = os.path.basename(lPyPathItemStr)[0:-3]
-            lTechSpecification = importlib.util.spec_from_file_location(lModuleNameStr, lPyPathItemStr)
-            lTechModuleFromSpec = importlib.util.module_from_spec(lTechSpecification)
-            sys.modules[lModuleNameStr] = lTechModuleFromSpec  # Add initialized module in sys - python will not init this module enought
-            lTechSpecificationModuleLoader = lTechSpecification.loader.exec_module(lTechModuleFromSpec)
-            lItemDict = {"ModuleNameStr": lModuleNameStr, "PyPathStr": lPyPathItemStr, "Module": lTechModuleFromSpec}
-            if lL: lL.info(f"Py module {lModuleNameStr} has been successfully initialized.")
-            inResultDict[lModuleNameStr]=lItemDict
-            # Backward compatibility to call def with gsettings when init
-            if inDefStr is not None and inDefStr is not "":
-                lDef = getattr(lTechModuleFromSpec, inDefStr)
-                lArgDict = {}
-                if inDefArgNameGSettingsStr is not None and inDefArgNameGSettingsStr is not "":
-                    lArgDict = {inDefArgNameGSettingsStr:GSettingsGet()}
-                lDef(**lArgDict)
-        except Exception as e:
-            if lL: lL.exception(f"Exception when init the .py file {os.path.abspath(lPyPathItemStr)}")
-    # # # # # # # #
-
-    lResultDict = {}
-
-    lPyPathStrList = glob.glob(inGlobPatternStr) # get the file list
-    lL = OrchestratorLoggerGet() # get the logger
-    for lPyPathItemStr in lPyPathStrList:
-        if inAsyncInitBool == True:
-            # ASYNC EXECUTION
-            lThreadInit = threading.Thread(target=__execute__,kwargs={
-                "inResultDict":lResultDict, "inPyPathItemStr": lPyPathItemStr, 
-                "inDefStr": inDefStr, "inDefArgNameGSettingsStr": inDefArgNameGSettingsStr}, daemon=True)
-            lThreadInit.start()
-        else:
-            # SYNC EXECUTION
-            __execute__(inResultDict=lResultDict, inPyPathItemStr=lPyPathItemStr, inDefStr = inDefStr, inDefArgNameGSettingsStr = inDefArgNameGSettingsStr)
-    return lResultDict

-
-
[docs]def OrchestratorSessionSave(inGSettings=None):
-    """
-    Orchestrator session save in file
-    (from version 1.2.7)
-        _SessionLast_GSettings.pickle (binary)
-
-    (above the version 1.2.7)
-        _SessionLast_RDPList.json (encoding = "utf-8")
-        _SessionLast_StorageDict.pickle (binary)
-
-    :param inGSettings: Global settings dict (singleton)
-    :return: True every time
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lL = inGSettings["Logger"]
-    try:
-        # Dump RDP List in file json
-        #lFile = open("_SessionLast_RDPList.json", "w", encoding="utf-8")
-        #lFile.write(json.dumps(inGSettings["RobotRDPActive"]["RDPList"]))  # dump json to file
-        #lFile.close()  # Close the file
-        #if inGSettings is not None:
-        #    if lL: lL.info(
-        #        f"Orchestrator has dump the RDP list before the restart.")
-        ## _SessionLast_StorageDict.pickle (binary)
-        #if "StorageDict" in inGSettings:
-        #    with open('_SessionLast_StorageDict.pickle', 'wb') as lFile:
-        #        pickle.dump(inGSettings["StorageDict"], lFile)
-        #        if lL: lL.info(
-        #            f"Orchestrator has dump the StorageDict before the restart.")
-
-        #SessionLast
-        lDumpDict = {"StorageDict":inGSettings["StorageDict"], "ManagersProcessDict":inGSettings["ManagersProcessDict"],
-                     "RobotRDPActive":{"RDPList": inGSettings["RobotRDPActive"]["RDPList"]}}
-        with open('_SessionLast_GSettings.pickle', 'wb') as lFile:
-            pickle.dump(lDumpDict, lFile)
-            if lL: lL.info(
-                f"Orchestrator has dump the GSettings (new dump mode from v1.2.7) before the restart.")
-
-    except Exception as e:
-        if lL: lL.exception(f"Exception when dump data before restart the Orchestrator")
-    return True

-
-
[docs]def OrchestratorSessionRestore(inGSettings=None):
-    """
-    Check _SessioLast... files in working directory. if exist - load into gsettings
-    (from version 1.2.7)
-        _SessionLast_GSettings.pickle (binary)
-
-    (above the version 1.2.7)
-        _SessionLast_RDPList.json (encoding = "utf-8")
-        _SessionLast_StorageDict.pickle (binary)
-
-    :param inGSettings: Global settings dict (singleton)
-    :return:
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lL = inGSettings.get("Logger",None)
-    # _SessionLast_RDPList.json (encoding = "utf-8")
-    if os.path.exists("_SessionLast_RDPList.json"):
-        lFile = open("_SessionLast_RDPList.json", "r", encoding="utf-8")
-        lSessionLastRDPList = json.loads(lFile.read())
-        lFile.close()  # Close the file
-        os.remove("_SessionLast_RDPList.json")  # remove the temp file
-        inGSettings["RobotRDPActive"]["RDPList"] = lSessionLastRDPList  # Set the last session dict
-        if lL: lL.warning(f"RDP Session List was restored from previous Orchestrator session")
-    # _SessionLast_StorageDict.pickle (binary)
-    if os.path.exists("_SessionLast_StorageDict.pickle"):
-        if "StorageDict" not in inGSettings:
-            inGSettings["StorageDict"] = {}
-        with open('_SessionLast_StorageDict.pickle', 'rb') as lFile:
-            lStorageDictDumpDict = pickle.load(lFile)
-            Server.__ComplexDictMerge2to1Overwrite__(in1Dict=inGSettings["StorageDict"],
-                                                     in2Dict=lStorageDictDumpDict)  # Merge dict 2 into dict 1
-            if lL: lL.warning(f"StorageDict was restored from previous Orchestrator session")
-        os.remove("_SessionLast_StorageDict.pickle")  # remove the temp file
-    # _SessionLast_Gsettings.pickle (binary)
-    if os.path.exists("_SessionLast_GSettings.pickle"):
-        if "StorageDict" not in inGSettings:
-            inGSettings["StorageDict"] = {}
-        if "ManagersProcessDict" not in inGSettings:
-            inGSettings["ManagersProcessDict"] = {}
-        with open('_SessionLast_GSettings.pickle', 'rb') as lFile:
-            lStorageDictDumpDict = pickle.load(lFile)
-            Server.__ComplexDictMerge2to1Overwrite__(in1Dict=inGSettings,
-                                                     in2Dict=lStorageDictDumpDict)  # Merge dict 2 into dict 1
-            if lL: lL.warning(f"GSettings was restored from previous Orchestrator session")
-        os.remove("_SessionLast_GSettings.pickle")  # remove the temp file

-
-
[docs]def UACKeyListCheck(inRequest, inRoleKeyList) -> bool:
-    """
-    Check is client is has access for the key list
-
-    :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-    :param inRoleKeyList:
-    :return: bool
-    """
-    return inRequest.UACClientCheck(inRoleKeyList=inRoleKeyList)

-
-
[docs]def UACUserDictGet(inRequest) -> dict:
-    """
-    Return user UAC hierarchy dict of the inRequest object. Empty dict - superuser access
-
-    :param inRequest: request handler (from http.server import BaseHTTPRequestHandler)
-    :return: user UAC hierarchy dict
-    """
-    return inRequest.UserRoleHierarchyGet() # get the Hierarchy

-
-
[docs]def UACUpdate(inADLoginStr, inADStr="", inADIsDefaultBool=True, inURLList=None, inRoleHierarchyAllowedDict=None, inGSettings = None):
-    """
-    Update user access (UAC)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inADLoginStr:
-    :param inADStr:
-    :param inADIsDefaultBool:
-    :param inURLList:
-    :param inRoleHierarchyAllowedDict:
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lUserTurple = (inADStr.upper(),inADLoginStr.upper()) # Create turple key for inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"]
-    if inURLList is None: inURLList = [] # Check if None
-    if inRoleHierarchyAllowedDict is None: inRoleHierarchyAllowedDict = {} # Check if None
-    # Get the old URLList
-    try:
-        inURLList += inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"][lUserTurple]["MethodMatchURLBeforeList"]
-    except:
-        pass
-    # Check RoleHierarchyAllowedDict in gSettings for the old role hierarchy - include in result.
-    if lUserTurple in inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"] and "RoleHierarchyAllowedDict" in inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"][lUserTurple]:
-        lRoleHierarchyAllowedOLDDict = inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"][lUserTurple]["RoleHierarchyAllowedDict"]
-        Server.__ComplexDictMerge2to1__(in1Dict=inRoleHierarchyAllowedDict, in2Dict=lRoleHierarchyAllowedOLDDict) # Merge dict 2 into dict 1
-
-    # Create Access item
-    lRuleDomainUserDict = {
-        "MethodMatchURLBeforeList": inURLList,
-        "RoleHierarchyAllowedDict": inRoleHierarchyAllowedDict
-    }
-    # Case add domain + user
-    inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"].update({(inADStr.upper(),inADLoginStr.upper()):lRuleDomainUserDict})
-    if inADIsDefaultBool:
-        # Case add default domain + user
-        inGSettings["ServerDict"]["AccessUsers"]["RuleDomainUserDict"].update({("",inADLoginStr.upper()):lRuleDomainUserDict})

-
-
[docs]def UACSuperTokenUpdate(inSuperTokenStr, inGSettings=None):
-    """
-    Add supertoken for the all access (it is need for the robot communication without human)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inSuperTokenStr:
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lLoginStr = "SUPERTOKEN"
-    UACUpdate(inGSettings=inGSettings, inADLoginStr=lLoginStr)
-    inGSettings["ServerDict"]["AccessUsers"]["AuthTokensDict"].update(
-        {inSuperTokenStr:{"User":lLoginStr, "Domain":"", "TokenDatetime":  datetime.datetime.now(), "FlagDoNotExpire":True}}
-    )

-
-# # # # # # # # # # # # # # # # # # # # # # #
-# OrchestratorWeb defs
-# # # # # # # # # # # # # # # # # # # # # # #
-
-
-
[docs]def WebURLConnectDef(inMethodStr, inURLStr, inMatchTypeStr, inDef, inContentTypeStr="application/octet-stream", inGSettings = None, inUACBool = None):
-    """
-     Connect URL to DEF
-        "inMethodStr":"GET|POST",
-        "inURLStr": "/index", #URL of the request
-        "inMatchTypeStr": "", #"BeginWith|Contains|Equal|EqualCase",
-        "inContentTypeStr": "", #HTTP Content-type
-        "inDef": None #Function with str result
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inMethodStr: "GET|POST",
-    :param inURLStr: example "/index", #URL of the request
-    :param inMatchTypeStr: #"BeginWith|Contains|Equal|EqualCase",
-    :param inDef: def arg allowed list: 2:[inRequest, inGSettings], 1: [inRequest], 0: []
-    :param inContentTypeStr: default: "application/octet-stream"
-    :param inUACBool: default: None; True - check user access before do this URL item. None - get Server flag if ask user
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lURLItemDict = {
-        "Method": inMethodStr.upper(),
-        "URL": inURLStr,  # URL of the request
-        "MatchType": inMatchTypeStr,  # "BeginWith|Contains|Equal|EqualCase",
-        # "ResponseFilePath": "", #Absolute or relative path
-        #"ResponseFolderPath": "C:\Abs\Archive\scopeSrcUL\OpenRPA\Orchestrator\Settings",
-        # Absolute or relative path
-        "ResponseContentType": inContentTypeStr, #HTTP Content-type
-        "ResponseDefRequestGlobal": inDef, #Function with str result
-        "UACBool": inUACBool
-    }
-    inGSettings["ServerDict"]["URLList"].append(lURLItemDict)

-
-
-
[docs]def WebURLConnectFolder(inMethodStr, inURLStr, inMatchTypeStr, inFolderPathStr, inGSettings = None, inUACBool = None):
-    """
-    Connect URL to Folder
-        "inMethodStr":"GET|POST",
-        "inURLStr": "/Folder/", #URL of the request
-        "inMatchTypeStr": "", #"BeginWith|Contains|Equal|EqualCase",
-        "inFolderPathStr": "", #Absolute or relative path
-        "inUACBool"
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inMethodStr:
-    :param inURLStr:
-    :param inMatchTypeStr:
-    :param inFolderPathStr:
-    :param inUACBool: default: None; True - check user access before do this URL item. None - get Server flag if ask user
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check if last symbol is "/" - append if not exist
-    lFolderPathStr = os.path.abspath(inFolderPathStr)
-    if lFolderPathStr[-1]!="/":lFolderPathStr+="/"
-    # Prepare URLItem
-    lURLItemDict = {
-        "Method": inMethodStr.upper(),
-        "URL": inURLStr,  # URL of the request
-        "MatchType": inMatchTypeStr,  # "BeginWith|Contains|Equal|EqualCase",
-        # "ResponseFilePath": "", #Absolute or relative path
-        "ResponseFolderPath": lFolderPathStr, # Absolute or relative path
-        "ResponseContentType": "application/octet-stream", #HTTP Content-type
-        #"ResponseDefRequestGlobal": inDef #Function with str result
-        "UACBool": inUACBool
-    }
-    inGSettings["ServerDict"]["URLList"].append(lURLItemDict)

-
-
-
[docs]def WebURLConnectFile(inMethodStr, inURLStr, inMatchTypeStr, inFilePathStr, inContentTypeStr="application/octet-stream", inGSettings = None, inUACBool = None):
-    """
-    Connect URL to File
-        "inMethodStr":"GET|POST",
-        "inURLStr": "/index", #URL of the request
-        "inMatchTypeStr": "", #"BeginWith|Contains|Equal|EqualCase",
-        "inFolderPathStr": "", #Absolute or relative path
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inMethodStr:
-    :param inURLStr:
-    :param inMatchTypeStr:
-    :param inFilePathStr:
-    :param inContentTypeStr:
-    :param inUACBool: default: None; True - check user access before do this URL item. None - get Server flag if ask user
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lURLItemDict = {
-        "Method": inMethodStr.upper(),
-        "URL": inURLStr,  # URL of the request
-        "MatchType": inMatchTypeStr,  # "BeginWith|Contains|Equal|EqualCase",
-        "ResponseFilePath": os.path.abspath(inFilePathStr), #Absolute or relative path
-        #"ResponseFolderPath": os.path.abspath(inFilePathStr), # Absolute or relative path
-        "ResponseContentType": inContentTypeStr, #HTTP Content-type
-        #"ResponseDefRequestGlobal": inDef #Function with str result
-        "UACBool":inUACBool
-    }
-    inGSettings["ServerDict"]["URLList"].append(lURLItemDict)

-
-
[docs]def WebListenCreate(inServerKeyStr="Default", inAddressStr="", inPortInt=80, inCertFilePEMPathStr=None, inKeyFilePathStr=None, inGSettings = None):
-    """
-    Create listen interface for the web server
-
-    :param inGSettings:  Global settings dict (singleton)
-    :param inAddressStr: IP interface to listen
-    :param inPortInt: Port int to listen for HTTP default is 80; for HTTPS default is 443
-    :param inCertFilePEMPathStr: Path to .pem (base 64) certificate. Required for SSL connection. ATTENTION - do not use certificate with password
-    :param inKeyFilePathStr: Path to the private key file
-    :return: 
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    inGSettings["ServerDict"]["ListenDict"][inServerKeyStr]={
-        "AddressStr":inAddressStr,
-        "PortInt":inPortInt,
-        "CertFilePEMPathStr":inCertFilePEMPathStr,
-        "KeyFilePathStr":inKeyFilePathStr,
-        "ServerInstance": None
-    }

-
-
-
[docs]def WebCPUpdate(inCPKeyStr, inHTMLRenderDef=None, inJSONGeneratorDef=None, inJSInitGeneratorDef=None, inGSettings = None):
-    """
-    Add control panel HTML, JSON generator or JS when page init
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inCPKeyStr:
-    :param inHTMLRenderDef:
-    :param inJSONGeneratorDef:
-    :param inJSInitGeneratorDef:
-    """
-    lCPManager = Managers.ControlPanel(inControlPanelNameStr=inCPKeyStr, inRefreshHTMLJinja2TemplatePathStr=None)
-    # CASE HTMLRender
-    if inHTMLRenderDef is not None: lCPManager.mBackwardCompatibilityHTMLDef = inHTMLRenderDef
-    # CASE JSONGenerator
-    if inJSONGeneratorDef is not None: lCPManager.mBackwardCompatibilityJSONDef = inJSONGeneratorDef
-    # CASE JSInitGeneratorDef
-    if inJSInitGeneratorDef is not None: lCPManager.mBackwardCompatibilityJSDef = inJSInitGeneratorDef

-
-
-
[docs]def WebAuditMessageCreate(inRequest=None, inOperationCodeStr="-", inMessageStr="-"):
-    """
-    Create message string with request user details (IP, Login etc...). Very actual for IT security in big company.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        lWebAuditMessageStr = Orchestrator.WebAuditMessageCreate(
-            inRequest = lRequest,
-            inOperationCodeStr = "OP_CODE_1",
-            inMessageStr="Success"):
-
-        # Log the WebAudit message
-        lLogger.info(lWebAuditMessageStr)
-
-    :param inRequest: HTTP request handler. Optional if call def from request thread
-    :param inOperationCodeStr: operation code in string format (actual for IT audit in control panels)
-    :param inMessageStr: additional message after
-    :return: format "WebAudit :: DOMAIN\\USER@101.121.123.12 :: operation code :: message"
-    """
-    try:
-        if inRequest is None: inRequest = WebRequestGet()
-        lClientIPStr = inRequest.client_address[0]
-        lUserDict = WebUserInfoGet(inRequest=inRequest)
-        lDomainUpperStr = lUserDict["DomainUpperStr"]
-        lUserLoginStr = lUserDict["UserNameUpperStr"]
-        lResultStr = f"WebAudit :: {lDomainUpperStr}\\\\{lUserLoginStr}@{lClientIPStr} :: {inOperationCodeStr} :: {inMessageStr}"
-    except Exception as e:
-        print(str(e)) # Has no logger - must be dead alg branch
-        lResultStr = inMessageStr
-    return lResultStr

-
-
[docs]def WebRequestParseBodyBytes(inRequest=None):
-    """
-    Extract the body in bytes from the request
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: Bytes or None
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    lBodyBytes=None
-    if inRequest.headers.get('Content-Length') is not None:
-        lInputByteArrayLength = int(inRequest.headers.get('Content-Length'))
-        lBodyBytes = inRequest.rfile.read(lInputByteArrayLength)
-    return lBodyBytes

-
-
[docs]def WebRequestParseBodyStr(inRequest=None):
-    """
-    Extract the body in str from the request
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: str or None
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    return WebRequestParseBodyBytes(inRequest=inRequest).decode('utf-8')

-
-
[docs]def WebRequestParseBodyJSON(inRequest=None):
-    """
-    Extract the body in dict/list from the request
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: dict or list
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    return json.loads(WebRequestParseBodyStr(inRequest=inRequest))

-
-
[docs]def WebRequestParsePath(inRequest=None):
-    """
-    Parse the request - extract the url. Example: /pyOpenRPA/Debugging/DefHelper/...
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: Str, Example: /pyOpenRPA/Debugging/DefHelper/...
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    return urllib.parse.unquote(inRequest.path)

-
-
[docs]def WebRequestParseFile(inRequest=None):
-    """
-    Parse the request - extract the file (name, body in bytes)
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: (FileNameStr, FileBodyBytes) or (None, None)
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    lResultTurple=(None,None)
-    if inRequest.headers.get('Content-Length') is not None:
-        lInputByteArray = WebRequestParseBodyBytes(inRequest=inRequest)
-        #print(f"BODY:ftInputByteArrayl")
-        # Extract bytes data
-        lBoundaryStr = str(inRequest.headers.get('Content-Type'))
-        lBoundaryStr = lBoundaryStr[lBoundaryStr.index("boundary=")+9:] # get the boundary key #print(LBoundoryStr)
-        lSplit = lInputByteArray.split('\r\n\r\n')
-        lDelimiterRNRNIndex = lInputByteArray.index(b'\r\n\r\n') #print(LSplit) # Get file name
-        lSplit0 = lInputByteArray[:lDelimiterRNRNIndex].split(b'\r\n')[1]
-        lFileNameBytes = lSplit0[lSplit0.index(b'filename="')+10:-1]
-        lFileNameStr = lFileNameBytes.decode("utf-8")
-        # File data bytes
-        lFileDataBytes = lInputByteArray[lDelimiterRNRNIndex+4:]
-        lFileDataBytes = lFileDataBytes[:lFileDataBytes.index(b"\r\n--"+lBoundaryStr.encode("utf-8"))]
-        lResultTurple = (lFileNameStr, lFileDataBytes)
-
-    return lResultTurple

-
-
[docs]def WebRequestResponseSend(inResponeStr, inRequest=None):
-    """
-    Send response for the request
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return:
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    inRequest.OpenRPAResponseDict["Body"] = bytes(inResponeStr, "utf8")

-
-
-
[docs]def WebRequestGet():
-    """
-    Return the web request instance if current thread was created by web request from client. else return None
-
-    """
-    lCurrentThread = threading.current_thread()
-    if hasattr(lCurrentThread, "request"):
-        return lCurrentThread.request

-
-
[docs]def WebUserInfoGet(inRequest=None):
-    """
-    Return User info about request
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: {"DomainUpperStr": "", "UserNameUpperStr": ""}
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    lDomainUpperStr = inRequest.OpenRPA["Domain"].upper()
-    lUserUpperStr = inRequest.OpenRPA["User"].upper()
-    return {"DomainUpperStr": lDomainUpperStr, "UserNameUpperStr": lUserUpperStr}

-
-
[docs]def WebUserIsSuperToken(inRequest = None, inGSettings = None):
-    """
-    Return bool if request is authentificated with supetoken (token which is never expires)
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :param inGSettings: Global settings dict (singleton)
-    :return: bool True - is supertoken; False - is not supertoken
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lIsSuperTokenBool = False
-    # Get Flag is supertoken (True|False)
-    lIsSuperTokenBool = inGSettings.get("ServerDict", {}).get("AccessUsers", {}).get("AuthTokensDict", {}).get(inRequest.OpenRPA["AuthToken"], {}).get("FlagDoNotExpire", False)
-    return lIsSuperTokenBool

-
-
[docs]def WebUserUACHierarchyGet(inRequest = None):
-    """
-    Return User UAC Hierarchy DICT Return {...}
-
-    :param inRequest: inRequest from the server. Optional if call def from request thread
-    :return: UAC Dict {}
-    """
-    if inRequest is None: inRequest = WebRequestGet()
-    return inRequest.UserRoleHierarchyGet()

-
-
-## GSettings defs
-
-from . import SettingsTemplate
-
-GSettings = SettingsTemplate.Create(inModeStr = "BASIC")
-# Modules alias for pyOpenRPA.Orchestrator and pyOpenRPA.Orchestrator.__Orchestrator__
-lCurrentModule = sys.modules[__name__]
-if __name__ == "pyOpenRPA.Orchestrator" and "pyOpenRPA.Orchestrator.__Orchestrator__" not in sys.modules:
-    sys.modules["pyOpenRPA.Orchestrator.__Orchestrator__"] = lCurrentModule
-if __name__ == "pyOpenRPA.Orchestrator.__Orchestrator__" and "pyOpenRPA.Orchestrator" not in sys.modules:
-    sys.modules["pyOpenRPA.Orchestrator"] = lCurrentModule
-
-
[docs]def GSettingsGet(inGSettings=None):
-    """
-    Get the GSettings from the singleton module.
-
-    :param inGSettings: You can pass some GSettings to check if it equal to base gsettings. If not equal - def will merge it
-    :return: GSettings
-    """
-    global GSettings # identify the global variable
-    # Merge dictionaries if some new dictionary has come
-    if inGSettings is not None and GSettings is not inGSettings:
-        GSettings = Server.__ComplexDictMerge2to1Overwrite__(in1Dict = inGSettings, in2Dict = GSettings)
-    return GSettings # Return the result

-
-
[docs]def GSettingsKeyListValueSet(inValue, inKeyList=None, inGSettings = None):
-    """
-    Set value in GSettings by the key list
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inValue:
-    :param inKeyList:
-    :return: bool
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inKeyList is None: inKeyList = []
-    lDict = inGSettings
-    for lItem2 in inKeyList[:-1]:
-        #Check if key - value exists
-        if lItem2 in lDict:
-            pass
-        else:
-            lDict[lItem2]={}
-        lDict=lDict[lItem2]
-    lDict[inKeyList[-1]] = inValue #Set value
-    return True

-
-
[docs]def GSettingsKeyListValueGet(inKeyList=None, inGSettings = None):
-    """
-    Get the value from the GSettings by the key list
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inKeyList:
-    :return: value any type
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inKeyList is None: inKeyList = []
-    lDict = inGSettings
-    for lItem2 in inKeyList[:-1]:
-        #Check if key - value exists
-        if lItem2 in lDict:
-            pass
-        else:
-            lDict[lItem2]={}
-        lDict=lDict[lItem2]
-    return lDict.get(inKeyList[-1],None)

-
-
[docs]def GSettingsKeyListValueAppend(inValue, inKeyList=None, inGSettings = None):
-    """
-    Append value in GSettings by the key list
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        Orchestrator.GSettingsKeyListValueAppend(
-            inGSettings = gSettings,
-            inValue = "NewValue",
-            inKeyList=["NewKeyDict","NewKeyList"]):
-        # result inGSettings: {
-        #    ... another keys in gSettings ...,
-        #    "NewKeyDict":{
-        #        "NewKeyList":[
-        #            "NewValue"
-        #        ]
-        #    }
-        #}
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inValue: Any value to be appended in gSettings Dict by the key list
-    :param inKeyList: List of the nested keys (see example)
-    :return: True every time
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inKeyList is None: inKeyList = []
-    lDict = inGSettings
-    for lItem2 in inKeyList[:-1]:
-        #Check if key - value exists
-        if lItem2 in lDict:
-            pass
-        else:
-            lDict[lItem2]={}
-        lDict=lDict[lItem2]
-    lDict[inKeyList[-1]].append(inValue) #Set value
-    return True

-
-
[docs]def GSettingsKeyListValueOperatorPlus(inValue, inKeyList=None, inGSettings = None):
-    """
-    Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList)
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        Orchestrator.GSettingsKeyListValueOperatorPlus(
-            inGSettings = gSettings,
-            inValue = [1,2,3],
-            inKeyList=["NewKeyDict","NewKeyList"]):
-        # result inGSettings: {
-        #    ... another keys in gSettings ...,
-        #    "NewKeyDict":{
-        #        "NewKeyList":[
-        #            "NewValue",
-        #            1,
-        #            2,
-        #            3
-        #        ]
-        #    }
-        #}
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inValue: List with values to be merged with list in gSettings
-    :param inKeyList: List of the nested keys (see example)
-    :return: True every time
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inKeyList is None: inKeyList = []
-    lDict = inGSettings
-    for lItem2 in inKeyList[:-1]:
-        #Check if key - value exists
-        if lItem2 in lDict:
-            pass
-        else:
-            lDict[lItem2]={}
-        lDict=lDict[lItem2]
-    lDict[inKeyList[-1]] += inValue #Set value
-    return True

-
-
[docs]def StorageRobotExists(inRobotNameStr):
-    """
-    Check if robot storage exists
-
-    :param inRobotNameStr: Robot name (case sensitive)
-    :return: True - robot storage exist; False - does not exist
-    """
-    return inRobotNameStr in GSettingsGet()["StorageDict"]

-
-
[docs]def StorageRobotGet(inRobotNameStr):
-    """
-    Get the robot storage by the robot name. If Robot storage is not exist - function will create it
-
-    :param inRobotNameStr: Robot name (case sensitive)
-    :return: Dict
-    """
-    if inRobotNameStr not in GSettingsGet()["StorageDict"]:
-        GSettingsGet()["StorageDict"][inRobotNameStr]={}
-    return GSettingsGet()["StorageDict"][inRobotNameStr]

-
-
[docs]def ProcessorAliasDefCreate(inDef, inAliasStr=None, inGSettings = None):
-    """
-    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)
-    Deprecated. See ActivityItemDefAliasCreate
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        def TestDef():
-            pass
-        lAliasStr = Orchestrator.ProcessorAliasDefCreate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        # Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inDef: Def
-    :param inAliasStr: String alias for associated def
-    :return: str Alias string (Alias can be regenerated if previous alias was occupied)
-    """
-    return ActivityItemDefAliasCreate(inDef=inDef, inAliasStr=inAliasStr, inGSettings = inGSettings)

-
-
[docs]def ProcessorAliasDefUpdate(inDef, inAliasStr, inGSettings = None):
-    """
-    Update 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)
-    Deprecated. See ActivityItemDefAliasUpdate
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        def TestDef():
-            pass
-        Orchestrator.ProcessorAliasDefUpdate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        # Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias")
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inDef: Def
-    :param inAliasStr: String alias for associated def
-    :return: str Alias string
-    """
-    return ActivityItemDefAliasUpdate(inDef=inDef, inAliasStr=inAliasStr, inGSettings = inGSettings)

-
-# ActivityItem defs
-
[docs]def ActivityItemHelperDefList(inDefQueryStr=None):
-    """
-     Create list of the available Def names in activity item. You can use query def filter via arg inDefQueryStr
-
-    :param inDefStr:
-    :return: ["ActivityItemDefAliasUpdate", "ActivityItemDefAliasCreate", etc...]
-    """
-    lResultList = []
-    if inDefQueryStr is not None: # do search alg
-        for lKeyStr in GSettingsGet()["ProcessorDict"]["AliasDefDict"]:
-            if inDefQueryStr.upper() in lKeyStr.upper():
-                lResultList.append(lKeyStr)
-    else:
-        for lKeyStr in GSettingsGet()["ProcessorDict"]["AliasDefDict"]:
-            lResultList.append(lKeyStr)
-    return lResultList

-
-
[docs]def ActivityItemHelperDefAutofill(inDef):
-    """
-    Detect def by the name and prepare the activity item dict with values.
-
-    :param inDef:
-    :return:
-    """
-    lResultDict = {
-        "Def": None,
-        "ArgList": [],
-        "ArgDict": {},
-        "ArgGSettingsStr": None,
-        "ArgLoggerStr": None
-    }
-    lResultDict["Def"] = inDef
-    lGS = GSettingsGet()
-    if inDef in lGS["ProcessorDict"]["AliasDefDict"]:
-        lDefSignature = inspect.signature(lGS["ProcessorDict"]["AliasDefDict"][inDef])
-        for lItemKeyStr in lDefSignature.parameters:
-            lItemValue = lDefSignature.parameters[lItemKeyStr]
-            # Check if arg name contains "GSetting" or "Logger"
-            if "GSETTING" in lItemKeyStr.upper():
-                lResultDict["ArgGSettingsStr"] = lItemKeyStr
-            elif "LOGGER" in lItemKeyStr.upper():
-                lResultDict["ArgLoggerStr"] = lItemKeyStr
-            else:
-                if lItemValue.default is inspect._empty:
-                    lResultDict["ArgDict"][lItemKeyStr] = None
-                else:
-                    lResultDict["ArgDict"][lItemKeyStr] = lItemValue.default
-    return lResultDict

-
-
[docs]def ActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr = None, inThreadBool = False):
-    """
-    Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        # EXAMPLE 1
-        def TestDef(inArg1Str, inGSettings, inLogger):
-            pass
-        lActivityItem = Orchestrator.ActivityItemCreate(
-            inDef = TestDef,
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = "inGSettings",
-            inArgLoggerStr = "inLogger")
-        # lActivityItem:
-        #   {
-        #       "Def":TestDef,
-        #       "ArgList":inArgList,
-        #       "ArgDict":inArgDict,
-        #       "ArgGSettings": "inArgGSettings",
-        #       "ArgLogger": "inLogger"
-        #   }
-
-        # EXAMPLE 2
-        def TestDef(inArg1Str):
-            pass
-        Orchestrator.ActivityItemDefAliasUpdate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        lActivityItem = Orchestrator.ActivityItemCreate(
-            inDef = "TestDefAlias",
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = None,
-            inArgLoggerStr = None)
-        # lActivityItem:
-        #   {
-        #       "Def":"TestDefAlias",
-        #       "ArgList":inArgList,
-        #       "ArgDict":inArgDict,
-        #       "ArgGSettings": None,
-        #       "ArgLogger": None
-        #   }
-
-    :param inDef: def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-    :param inArgList: Args list for the Def
-    :param inArgDict: Args dict for the def
-    :param inArgGSettingsStr: Name of def argument of the GSettings dict
-    :param inArgLoggerStr: Name of def argument of the logging object
-    :param inGUIDStr: GUID which you can specify. If None the GUID will be generated
-    :param inThreadBool: True - execute ActivityItem in new thread; False - in processor thread
-    :return: {}
-    """
-    # Work about GUID in Activity items
-    if inGUIDStr is None:
-        inGUIDStr = str(uuid.uuid4())  # generate new GUID
-    if inArgList is None: inArgList=[]
-    if inArgDict is None: inArgDict={}
-    lActivityItemDict= {
-        "Def":inDef, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-        "ArgList":inArgList, # Args list
-        "ArgDict":inArgDict, # Args dictionary
-        "ArgGSettings": inArgGSettingsStr, # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-        "ArgLogger": inArgLoggerStr, # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-        "GUIDStr": inGUIDStr,
-        "ThreadBool": inThreadBool
-    }
-    return lActivityItemDict

-
-
-
[docs]def ActivityItemDefAliasCreate(inDef, inAliasStr=None, inGSettings = None):
-    """
-    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)
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        def TestDef():
-            pass
-        lAliasStr = Orchestrator.ActivityItemDefAliasCreate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        # Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inDef: Def
-    :param inAliasStr: String alias for associated def
-    :return: str Alias string (Alias can be regenerated if previous alias was occupied)
-    """
-    #TODO Pay attention - New alias can be used too - need to create more complex algorythm to create new alias!
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lL = inGSettings["Logger"]
-    if inAliasStr is None: inAliasStr = str(inDef)
-    # Check if key is not exists
-    if inAliasStr in inGSettings["ProcessorDict"]["AliasDefDict"]:
-        inAliasStr = str(inDef)
-        if lL: lL.warning(f"Orchestrator.ProcessorAliasDefCreate: Alias {inAliasStr} already exists in alias dictionary. Another alias will be generated and returned")
-    inGSettings["ProcessorDict"]["AliasDefDict"][inAliasStr] = inDef
-    return inAliasStr

-
-
[docs]def ActivityItemDefAliasModulesLoad():
-    """
-    Load all def from sys.modules... in ActivityItem def alias dict
-
-    :return: None
-    """
-    lL = OrchestratorLoggerGet()
-    lL.info(f"ActivityItem aliases: start to load sys.modules")
-    lSysModulesSnapshot = copy.copy(sys.modules) # Actual when start from jupyter
-    for lModuleItemStr in lSysModulesSnapshot:
-        lModuleItem = lSysModulesSnapshot[lModuleItemStr]
-        for lDefItemStr in dir(lModuleItem):
-            try:
-                lDefItem = getattr(lModuleItem,lDefItemStr)
-                if callable(lDefItem) and not lDefItemStr.startswith("_"):
-                    ActivityItemDefAliasCreate(inDef=lDefItem, inAliasStr=f"{lModuleItemStr}.{lDefItemStr}")
-            except ModuleNotFoundError:
-                pass
-    lL.info(f"ActivityItem aliases: finish to load sys.modules")

-
-
[docs]def ActivityItemDefAliasUpdate(inDef, inAliasStr, inGSettings = None):
-    """
-    Update 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)
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        def TestDef():
-            pass
-        Orchestrator.ActivityItemDefAliasUpdate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        # Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias")
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inDef: Def
-    :param inAliasStr: String alias for associated def
-    :return: str Alias string
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if callable(inDef): inGSettings["ProcessorDict"]["AliasDefDict"][inAliasStr] = inDef
-    else: raise Exception(f"pyOpenRPA Exception: You can't use Orchestrator.ActivityItemDefAliasUpdate with arg 'inDef' string value. inDef is '{inDef}', inAliasStr is '{inAliasStr}'")
-    return inAliasStr

-
-
-
-
[docs]def ProcessorActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr = None, inThreadBool = False):
-    """
-    Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute.
-    Deprecated. See ActivityItemCreate
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        # EXAMPLE 1
-        def TestDef(inArg1Str, inGSettings, inLogger):
-            pass
-        lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-            inDef = TestDef,
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = "inGSettings",
-            inArgLoggerStr = "inLogger")
-        # lActivityItem:
-        #   {
-        #       "Def":TestDef,
-        #       "ArgList":inArgList,
-        #       "ArgDict":inArgDict,
-        #       "ArgGSettings": "inArgGSettings",
-        #       "ArgLogger": "inLogger"
-        #   }
-
-        # EXAMPLE 2
-        def TestDef(inArg1Str):
-            pass
-        Orchestrator.ProcessorAliasDefUpdate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-            inDef = "TestDefAlias",
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = None,
-            inArgLoggerStr = None)
-        # lActivityItem:
-        #   {
-        #       "Def":"TestDefAlias",
-        #       "ArgList":inArgList,
-        #       "ArgDict":inArgDict,
-        #       "ArgGSettings": None,
-        #       "ArgLogger": None
-        #   }
-
-    :param inDef: def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-    :param inArgList: Args list for the Def
-    :param inArgDict: Args dict for the def
-    :param inArgGSettingsStr: Name of def argument of the GSettings dict
-    :param inArgLoggerStr: Name of def argument of the logging object
-    :param inGUIDStr: GUID which you can specify. If None the GUID will be generated
-    :param inThreadBool: True - execute ActivityItem in new thread; False - in processor thread
-    :return: {}
-    """
-    return ActivityItemCreate(inDef=inDef, inArgList=inArgList, inArgDict=inArgDict, inArgGSettingsStr=inArgGSettingsStr, inArgLoggerStr=inArgLoggerStr,
-                           inGUIDStr=inGUIDStr, inThreadBool=inThreadBool)

-
-
[docs]def ProcessorActivityItemAppend(inGSettings = None, inDef=None, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inActivityItemDict=None):
-    """
-    Create and add activity item in processor queue.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        # EXAMPLE 1
-        def TestDef(inArg1Str, inGSettings, inLogger):
-            pass
-        lActivityItem = Orchestrator.ProcessorActivityItemAppend(
-            inGSettings = gSettingsDict,
-            inDef = TestDef,
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = "inGSettings",
-            inArgLoggerStr = "inLogger")
-        # Activity have been already append in the processor queue
-
-        # EXAMPLE 2
-        def TestDef(inArg1Str):
-            pass
-        Orchestrator.ProcessorAliasDefUpdate(
-            inGSettings = gSettings,
-            inDef = TestDef,
-            inAliasStr="TestDefAlias")
-        lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-            inDef = "TestDefAlias",
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = None,
-            inArgLoggerStr = None)
-        Orchestrator.ProcessorActivityItemAppend(
-            inGSettings = gSettingsDict,
-            inActivityItemDict = lActivityItem)
-        # Activity have been already append in the processor queue
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inDef: def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-    :param inArgList: Args list for the Def
-    :param inArgDict: Args dict for the Def
-    :param inArgGSettingsStr: Name of def argument of the GSettings dict
-    :param inArgLoggerStr: Name of def argument of the logging object
-    :param inActivityItemDict: Fill if you already have ActivityItemDict (don't fill inDef, inArgList, inArgDict, inArgGSettingsStr, inArgLoggerStr)
-    :return ActivityItem GUIDStr
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inActivityItemDict is None:
-        if inArgList is None: inArgList=[]
-        if inArgDict is None: inArgDict={}
-        if inDef is None: raise Exception(f"pyOpenRPA Exception: ProcessorActivityItemAppend need inDef arg if you dont use inActivityItemDict")
-        lActivityList=[
-            {
-                "Def":inDef, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-                "ArgList":inArgList, # Args list
-                "ArgDict":inArgDict, # Args dictionary
-                "ArgGSettings": inArgGSettingsStr, # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-                "ArgLogger": inArgLoggerStr # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-            }
-        ]
-    else:
-        lActivityList = [inActivityItemDict]
-    # Work about GUID in Activity items
-    lGUIDStr = None
-    for lItemDict in lActivityList:
-        # Add GUIDStr if not exist
-        if "GUIDStr" not in lItemDict:
-            lGUIDStr = str(uuid.uuid4())  # generate new GUID
-            lItemDict["GUIDStr"] = lGUIDStr
-    # Add activity list in ProcessorDict
-    inGSettings["ProcessorDict"]["ActivityList"]+=lActivityList
-    return lGUIDStr

-
-## Process defs
-
[docs]def ProcessIsStarted(inProcessNameWOExeStr): # Check if process is started
-    """
-    Check if there is any running process that contains the given name processName.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        lProcessIsStartedBool = Orchestrator.ProcessIsStarted(inProcessNameWOExeStr = "notepad")
-        # lProcessIsStartedBool is True - notepad.exe is running on the Orchestrator machine
-
-    :param inProcessNameWOExeStr: Process name WithOut (WO) '.exe' postfix. Example: "notepad" (not "notepad.exe")
-    :return: True - process is running on the orchestrator machine; False - process is not running on the orchestrator machine
-    """
-    #Iterate over the all the running process
-    for proc in psutil.process_iter():
-        try:
-            # Check if process name contains the given name string.
-            if inProcessNameWOExeStr.lower() in proc.name().lower():
-                return True
-        except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
-            pass
-    return False

-
-
[docs]def ProcessStart(inPathStr, inArgList, inStopProcessNameWOExeStr=None):
-    """
-    Start process locally. Extra feature: Use inStopProcessNameWOExeStr to stop the execution if current process is running.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        Orchestrator.ProcessStart(
-            inPathStr = "notepad"
-            inArgList = []
-            inStopProcessNameWOExeStr = "notepad")
-        # notepad.exe will be started if no notepad.exe is active on the machine
-
-    :param inPathStr: Command to send in CMD
-    :param inArgList: List of the arguments for the CMD command. Example: ["test.txt"]
-    :param inStopProcessNameWOExeStr: Trigger: stop execution if process is running. Process name WithOut (WO) '.exe' postfix. Example: "notepad" (not "notepad.exe")
-    :return: None - nothing is returned. If process will not start -exception will be raised
-    """
-    lStartProcessBool = True
-    if inStopProcessNameWOExeStr is not None: #Check if process running
-        lCheckTaskName = inStopProcessNameWOExeStr
-        if len(lCheckTaskName)>4:
-            if lCheckTaskName[-4:].upper() != ".EXE":
-                lCheckTaskName = lCheckTaskName+".exe"
-        else:
-            lCheckTaskName = lCheckTaskName+".exe"
-        #Check if process exist
-        if not ProcessIsStarted(inProcessNameWOExeStr=lCheckTaskName): lStartProcessBool=True
-
-    if lStartProcessBool == True: # Start if flag is true
-        lItemArgs=[inPathStr]
-        if inArgList is None: inArgList = [] # 2021 02 22 Minor fix default value
-        lItemArgs.extend(inArgList)
-        subprocess.Popen(lItemArgs,shell=True)

-
-
[docs]def ProcessStop(inProcessNameWOExeStr, inCloseForceBool, inUserNameStr = "%username%"):
-    """
-    Stop process on the orchestrator machine. You can set user session on the machine and set flag about to force close process.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        Orchestrator.ProcessStop(
-            inProcessNameWOExeStr = "notepad"
-            inCloseForceBool = True
-            inUserNameStr = "USER_99")
-        # Will close process "notepad.exe" on the user session "USER_99" (!ATTENTION! if process not exists no exceptions will be raised)
-
-    :param inProcessNameWOExeStr: Process name WithOut (WO) '.exe' postfix. Example: "notepad" (not "notepad.exe")
-    :param inCloseForceBool: True - do force close. False - send signal to safe close (!ATTENTION! - Safe close works only in orchestrator session. Win OS doens't allow to send safe close signal between GUI sessions)
-    :param inUserNameStr: User name which is has current process to close. Default value is close process on the Orchestrator session
-    :return: None
-    """
-    # Support input arg if with .exe
-    lProcessNameWExeStr = inProcessNameWOExeStr
-    if len(lProcessNameWExeStr) > 4:
-        if lProcessNameWExeStr[-4:].upper() != ".EXE":
-            lProcessNameWExeStr = lProcessNameWExeStr + ".exe"
-    else:
-        lProcessNameWExeStr = lProcessNameWExeStr + ".exe"
-    # Flag Force
-    lActivityCloseCommand = 'taskkill /im ' + lProcessNameWExeStr
-    if inCloseForceBool == True:
-        lActivityCloseCommand += " /F"
-    # None - all users, %username% - current user, another str - another user
-    if inUserNameStr is not None:
-        lActivityCloseCommand += f' /fi "username eq {inUserNameStr}"'
-    # Kill process
-    os.system(lActivityCloseCommand)

-
-
[docs]def ProcessListGet(inProcessNameWOExeList=None):
-    """
-    Return process list on the orchestrator machine sorted by Memory Usage. You can determine the list of the processes you are interested - def will return the list about it.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        lProcessList = Orchestrator.ProcessListGet()
-        # Return the list of the process on the machine.
-        # !ATTENTION! RUn orchestrator as administrator to get all process list on the machine.
-
-    :param inProcessNameWOExeList:
-    :return: {
-    "ProcessWOExeList": ["notepad","..."],
-    "ProcessWOExeUpperList": ["NOTEPAD","..."],
-    "ProcessDetailList": [
-        {
-            'pid': 412,
-            'username': "DESKTOP\\USER",
-            'name': 'notepad.exe',
-            'vms': 13.77767775,
-            'NameWOExeUpperStr': 'NOTEPAD',
-            'NameWOExeStr': "'notepad'"},
-        {...}]
-
-    """
-    if inProcessNameWOExeList is None: inProcessNameWOExeList = []
-    lMapUPPERInput = {} # Mapping for processes WO exe
-    lResult = {"ProcessWOExeList":[], "ProcessWOExeUpperList":[],"ProcessDetailList":[]}
-    # Create updated list for quick check
-    lProcessNameWOExeList = []
-    for lItem in inProcessNameWOExeList:
-        if lItem is not None:
-            lProcessNameWOExeList.append(f"{lItem.upper()}.EXE")
-            lMapUPPERInput[f"{lItem.upper()}.EXE"]= lItem
-    # Iterate over the list
-    for proc in psutil.process_iter():
-        try:
-            # Fetch process details as dict
-            pinfo = proc.as_dict(attrs=['pid', 'name', 'username'])
-            pinfo['vms'] = proc.memory_info().vms / (1024 * 1024)
-            pinfo['NameWOExeUpperStr'] = pinfo['name'][:-4].upper()
-            # Add if empty inProcessNameWOExeList or if process in inProcessNameWOExeList
-            if len(lProcessNameWOExeList)==0 or pinfo['name'].upper() in lProcessNameWOExeList:
-                try: # 2021 02 22 Minor fix if not admin rights
-                    pinfo['NameWOExeStr'] = lMapUPPERInput[pinfo['name'].upper()]
-                except Exception as e:
-                    pinfo['NameWOExeStr'] = pinfo['name'][:-4]
-                lResult["ProcessDetailList"].append(pinfo) # Append dict to list
-                lResult["ProcessWOExeList"].append(pinfo['NameWOExeStr'])
-                lResult["ProcessWOExeUpperList"].append(pinfo['NameWOExeUpperStr'])
-        except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
-           pass
-    return lResult

-
-
-
[docs]def ProcessDefIntervalCall(inDef, inIntervalSecFloat, inIntervalAsyncBool=False, inDefArgList=None, inDefArgDict=None, inDefArgGSettingsNameStr=None, inDefArgLoggerNameStr=None, inExecuteInNewThreadBool=True, inLogger=None, inGSettings = None):
-    """
-    Use this procedure if you need to run periodically some def. Set def, args, interval and enjoy :)
-
-    :param inGSettings: global settings
-    :param inDef: def link, which will be called with interval inIntervalSecFloat
-    :param inIntervalSecFloat: Interval in seconds between call
-    :param inIntervalAsyncBool: False - wait interval before next call after the previous iteration result; True - wait interval after previous iteration call
-    :param inDefArgList: List of the args in def. Default None (empty list)
-    :param inDefArgDict: Dict of the args in def. Default None (empty dict)
-    :param inDefArgGSettingsNameStr: Name of the GSettings arg name for def (optional)
-    :param inDefArgLoggerNameStr: Name of the Logger arg name for def (optional). If Use - please check fill of the inLogger arg.
-    :param inExecuteInNewThreadBool: True - create new thread for the periodic execution; False - execute in current thread. Default: True
-    :param inLogger: logging def if some case is appear
-    :return:
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inLogger is None: inLogger = OrchestratorLoggerGet()
-    #Some edits on start
-    if inDefArgDict is None: inDefArgDict = {}
-    if inDefArgList is None: inDefArgList = []
-    # Check if inDefArgLogger is set and inLogger is exist
-    if inDefArgLoggerNameStr=="": inDefArgLoggerNameStr=None
-    if inDefArgGSettingsNameStr=="": inDefArgGSettingsNameStr=None
-    if inDefArgLoggerNameStr is not None and not inLogger:
-        raise Exception(f"!ERROR! ProcessDefIntervalCall - You need to send logger in def because your def is require logger. Raise error!")
-
-    # Check thread
-    if not Core.IsProcessorThread(inGSettings=inGSettings):
-        if inGSettings["Logger"]: inGSettings["Logger"].warning(f"__Orchestrator__.ProcessDefIntervalCall def was called not from processor queue - activity will be append in the processor queue.")
-        lProcessorActivityDict = {
-            "Def": ProcessDefIntervalCall, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inDef": inDef, "inIntervalSecFloat": inIntervalSecFloat,
-                        "inIntervalAsyncBool":inIntervalAsyncBool, "inDefArgList": inDefArgList,
-                        "inDefArgDict": inDefArgDict, "inDefArgGSettingsNameStr":inDefArgGSettingsNameStr,
-                        "inDefArgLoggerNameStr": inDefArgLoggerNameStr, "inExecuteInNewThreadBool": inExecuteInNewThreadBool},  # Args dictionary
-            "ArgGSettings": "inGSettings",  # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-            "ArgLogger": "inLogger"  # Name of GSettings attribute: str (ArgDict) or index (for ArgList)
-        }
-        inGSettings["ProcessorDict"]["ActivityList"].append(lProcessorActivityDict)
-    else:
-        # Internal def to execute periodically
-        def __Execute__(inGSettings, inDef, inIntervalSecFloat, inIntervalAsyncBool, inDefArgList, inDefArgDict, inLogger,  inDefArgGSettingsNameStr, inDefArgLoggerNameStr):
-            if inLogger: inLogger.info(f"__Orchestrator__.ProcessDefIntervalCall: Interval execution has been started. Def: {str(inDef)}")
-            # Prepare gSettings and logger args
-            if inDefArgGSettingsNameStr is not None:
-                inDefArgDict[inDefArgGSettingsNameStr] = inGSettings
-            if inDefArgLoggerNameStr is not None:
-                inDefArgDict[inDefArgLoggerNameStr] = inLogger
-            while True:
-                try:
-                    # Call async if needed
-                    if inIntervalAsyncBool == False:  # Case wait result then wait
-                        inDef(*inDefArgList, **inDefArgDict)
-                    else:  # Case dont wait result - run sleep then new iteration (use many threads)
-                        lThread2 = threading.Thread(target=inDef,
-                                                    args=inDefArgList,
-                                                    kwargs=inDefArgDict)
-                        lThread2.start()
-                except Exception as e:
-                    if inLogger: inLogger.exception(
-                        f"ProcessDefIntervalCall: Interval call has been failed. Traceback is below. Code will sleep for the next call")
-                # Sleep interval
-                time.sleep(inIntervalSecFloat)
-
-        # Check to call in new thread
-        if inExecuteInNewThreadBool:
-            lThread = threading.Thread(target=__Execute__,
-                                       kwargs={"inGSettings":inGSettings, "inDef": inDef, "inIntervalSecFloat": inIntervalSecFloat,
-                                               "inIntervalAsyncBool": inIntervalAsyncBool, "inDefArgList": inDefArgList,
-                                               "inDefArgDict": inDefArgDict, "inLogger": inLogger,
-                                               "inDefArgGSettingsNameStr":inDefArgGSettingsNameStr , "inDefArgLoggerNameStr":inDefArgLoggerNameStr})
-            lThread.start()
-        else:
-            __Execute__(inGSettings=inGSettings, inDef=inDef, inIntervalSecFloat=inIntervalSecFloat, inIntervalAsyncBool=inIntervalAsyncBool,
-                        inDefArgList=inDefArgList, inDefArgDict=inDefArgDict, inLogger=inLogger,
-                        inDefArgGSettingsNameStr=inDefArgGSettingsNameStr , inDefArgLoggerNameStr=inDefArgLoggerNameStr)

-
-
-# Python def - start module function
-
[docs]def PythonStart(inModulePathStr, inDefNameStr, inArgList=None, inArgDict=None, inLogger = None):
-    """
-    Import module and run def in the Orchestrator process.
-
-    .. note::
-
-        Import module will be each time when PythonStart def will be called.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        Orchestrator.PythonStart(
-            inModulePathStr="ModuleToCall.py", # inModulePathStr: Working Directory\\ModuleToCall.py
-            inDefNameStr="TestDef")
-        # Import module in Orchestrator process and call def "TestDef" from module "ModuleToCall.py"
-
-    :param inModulePathStr: Absolute or relative (working directory of the orchestrator process) path to the importing module .py
-    :param inDefNameStr: Def name in module
-    :param inArgList: List of the arguments for callable def
-    :param inArgDict: Dict of the named arguments for callable def
-    :param inLogger: Logger instance to log some information when PythonStart def is running
-    :return: None
-    """
-    if inLogger is None: inLogger = OrchestratorLoggerGet()
-    if inArgList is None: inArgList=[]
-    if inArgDict is None: inArgDict={}
-    try:
-        lModule=importlib.import_module(inModulePathStr) #Подключить модуль для вызова
-        lFunction=getattr(lModule,inDefNameStr) #Найти функцию
-        return lFunction(*inArgList,**inArgDict)
-    except Exception as e:
-        if inLogger: inLogger.exception("Loop activity error: module/function not founded")

-
-# # # # # # # # # # # # # # # # # # # # # # #
-# Scheduler
-# # # # # # # # # # # # # # # # # # # # # # #
-
-
[docs]def SchedulerActivityTimeAddWeekly(inTimeHHMMStr="23:55:", inWeekdayList=None, inActivityList=None, inGSettings = None):
-    """
-    Add activity item list in scheduler. You can set weekday list and set time when launch. Activity list will be executed at planned time/day.
-
-    .. code-block:: python
-
-        # USAGE
-        from pyOpenRPA import Orchestrator
-
-        # EXAMPLE 1
-        def TestDef(inArg1Str):
-            pass
-        lActivityItem = Orchestrator.ProcessorActivityItemCreate(
-            inDef = TestDef,
-            inArgList=[],
-            inArgDict={"inArg1Str": "ArgValueStr"},
-            inArgGSettingsStr = None,
-            inArgLoggerStr = None)
-        Orchestrator.SchedulerActivityTimeAddWeekly(
-            inGSettings = gSettingsDict,
-            inTimeHHMMStr = "04:34",
-            inWeekdayList=[2,3,4],
-            inActivityList = [lActivityItem])
-        # Activity will be executed at 04:34 Wednesday (2), thursday (3), friday (4)
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inTimeHHMMStr: Activation time from "00:00" to "23:59". Example: "05:29"
-    :param inWeekdayList: Week day list to initiate activity list. Use int from 0 (monday) to 6 (sunday) as list items. Example: [0,1,2,3,4]. Default value is everyday ([0,1,2,3,4,5,6])
-    :param inActivityList: Activity list structure
-    :return: None
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inWeekdayList is None: inWeekdayList=[0,1,2,3,4,5,6]
-    if inActivityList is None: inActivityList=[]
-    Processor.__ActivityListVerify__(inActivityList=inActivityList) # DO VERIFICATION FOR THE inActivityList
-    lActivityTimeItemDict = {
-        "TimeHH:MMStr": inTimeHHMMStr,  # Time [HH:MM] to trigger activity
-        "WeekdayList": inWeekdayList, # List of the weekday index when activity is applicable, Default [1,2,3,4,5,6,7]
-        "ActivityList": inActivityList,
-        "GUID": None  #    # Will be filled in Orchestrator automatically - is needed for detect activity completion
-    }
-    inGSettings["SchedulerDict"]["ActivityTimeList"].append(lActivityTimeItemDict)

-
-# # # # # # # # # # # # # # # # # # # # # # #
-# RDPSession
-# # # # # # # # # # # # # # # # # # # # # # #
-
-
[docs]def RDPTemplateCreate(inLoginStr, inPasswordStr, inHostStr="127.0.0.1", inPortInt = 3389, inWidthPXInt = 1680,  inHeightPXInt = 1050,
-                      inUseBothMonitorBool = False, inDepthBitInt = 32, inSharedDriveList=None, inRedirectClipboardBool=True):
-    """
-    Create RDP connect dict item/ Use it connect/reconnect (Orchestrator.RDPSessionConnect)
-
-    .. 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)
-        #     lRDPTemplateDict= {  # Init the configuration item
-        #         "Host": "127.0.0.1", "Port": "3389", "Login": "USER_99", "Password": "USER_PASS_HERE",
-        #         "Screen": { "Width": 1680, "Height": 1050, "FlagUseAllMonitors": False, "DepthBit": "32" },
-        #         "SharedDriveList": ["c"],
-        #         "RedirectClipboardBool": True, # True - share clipboard to RDP; False - else
-        #         ###### Will updated in program ############
-        #         "SessionHex": "77777sdfsdf77777dsfdfsf77777777",  # Hex is created when robot runs, example ""
-        #         "SessionIsWindowExistBool": False, "SessionIsWindowResponsibleBool": False, "SessionIsIgnoredBool": False
-        #     }
-
-    :param inLoginStr: User/Robot Login, example "USER_99"
-    :param inPasswordStr: Password, example "USER_PASS_HERE"
-    :param inHostStr: Host address, example "77.77.22.22"
-    :param inPortInt: RDP Port, example "3389" (default)
-    :param inWidthPXInt: Width of the remote desktop in pixels, example 1680
-    :param inHeightPXInt: Height of the remote desktop in pixels, example 1050
-    :param inUseBothMonitorBool: True - connect to the RDP with both monitors. False - else case
-    :param inDepthBitInt: Remote desktop bitness. Available: 32 or 24 or 16 or 15, example 32
-    :param inSharedDriveList: Host local disc to connect to the RDP session. Example: ["c", "d"]
-    :param inRedirectClipboardBool: # True - share clipboard to RDP; False - else
-    :return:
-        {
-            "Host": inHostStr,  # Host address, example "77.77.22.22"
-            "Port": str(inPortInt),  # RDP Port, example "3389"
-            "Login": inLoginStr,  # Login, example "test"
-            "Password": inPasswordStr,  # Password, example "test"
-            "Screen": {
-                "Width": inWidthPXInt,  # Width of the remote desktop in pixels, example 1680
-                "Height": inHeightPXInt,  # Height of the remote desktop in pixels, example 1050
-                # "640x480" or "1680x1050" or "FullScreen". If Resolution not exists set full screen, example
-                "FlagUseAllMonitors": inUseBothMonitorBool,  # True or False, example False
-                "DepthBit": str(inDepthBitInt)  # "32" or "24" or "16" or "15", example "32"
-            },
-            "SharedDriveList": inSharedDriveList,  # List of the Root sesion hard drives, example ["c"]
-            "RedirectClipboardBool": True, # True - share clipboard to RDP; False - else
-            ###### Will updated in program ############
-            "SessionHex": "77777sdfsdf77777dsfdfsf77777777",  # Hex is created when robot runs, example ""
-            "SessionIsWindowExistBool": False,
-            # Flag if the RDP window is exist, old name "FlagSessionIsActive". Check every n seconds , example False
-            "SessionIsWindowResponsibleBool": False,
-            # Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too , example False
-            "SessionIsIgnoredBool": False  # Flag to ignore RDP window False - dont ignore, True - ignore, example False
-        }
-
-    """
-    if inSharedDriveList is None: inSharedDriveList = ["c"]
-    if inPortInt is None: inPortInt = 3389
-    if inRedirectClipboardBool is None: inRedirectClipboardBool = True
-    lRDPTemplateDict= {  # Init the configuration item
-        "Host": inHostStr,  # Host address, example "77.77.22.22"
-        "Port": str(inPortInt),  # RDP Port, example "3389"
-        "Login": inLoginStr,  # Login, example "test"
-        "Password": inPasswordStr,  # Password, example "test"
-        "Screen": {
-            "Width": inWidthPXInt,  # Width of the remote desktop in pixels, example 1680
-            "Height": inHeightPXInt,  # Height of the remote desktop in pixels, example 1050
-            # "640x480" or "1680x1050" or "FullScreen". If Resolution not exists set full screen, example
-            "FlagUseAllMonitors": inUseBothMonitorBool,  # True or False, example False
-            "DepthBit": str(inDepthBitInt)  # "32" or "24" or "16" or "15", example "32"
-        },
-        "SharedDriveList": inSharedDriveList,  # List of the Root sesion hard drives, example ["c"],
-        "RedirectClipboardBool": inRedirectClipboardBool, # True - share clipboard to RDP; False - else
-        ###### Will updated in program ############
-        "SessionHex": "77777sdfsdf77777dsfdfsf77777777",  # Hex is created when robot runs, example ""
-        "SessionIsWindowExistBool": False,
-        # Flag if the RDP window is exist, old name "FlagSessionIsActive". Check every n seconds , example False
-        "SessionIsWindowResponsibleBool": False,
-        # Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too , example False
-        "SessionIsIgnoredBool": False  # Flag to ignore RDP window False - dont ignore, True - ignore, example False
-    }
-    return lRDPTemplateDict

-
-# TODO Search dublicates in GSettings RDPlist !
-# Return list if dublicates
-
[docs]def RDPSessionDublicatesResolve(inGSettings):
-    """
-    DEVELOPING Search duplicates in GSettings RDPlist
-    !def is developing!
-
-    :param inGSettings: Global settings dict (singleton)
-    :return:
-    """
-    pass

-    #for lItemKeyStr in inGSettings["RobotRDPActive"]["RDPList"]:
-    #   lItemDict = inGSettings["RobotRDPActive"]["RDPList"][lItemKeyStr]
-
-
[docs]def RDPSessionConnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inHostStr=None, inPortStr=None, inLoginStr=None, inPasswordStr=None, inGSettings = None, inRedirectClipboardBool=True):
-    """
-    Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists
-     2 way of the use
-    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: 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 :)
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionConnect, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inRDPTemplateDict":inRDPTemplateDict, "inHostStr": inHostStr, "inPortStr": inPortStr,
-                    "inLoginStr": inLoginStr, "inPasswordStr": inPasswordStr, "inRedirectClipboardBool": inRedirectClipboardBool},  # 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)
-    else: # In processor - do execution
-        # Var 1 - if RDPTemplateDict is input
-        lRDPConfigurationItem=inRDPTemplateDict
-        # Var 2 - backward compatibility
-        if lRDPConfigurationItem is None:
-            lRDPConfigurationItem = RDPTemplateCreate(inLoginStr=inLoginStr, inPasswordStr=inPasswordStr,
-                  inHostStr=inHostStr, inPortInt = int(inPortStr), inRedirectClipboardBool=inRedirectClipboardBool)            # ATTENTION - dont connect if RDP session is exist
-        # Start the connect
-        if inRDPSessionKeyStr not in inGSettings["RobotRDPActive"]["RDPList"]:
-            inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr] = lRDPConfigurationItem # Add item in RDPList
-            Connector.Session(lRDPConfigurationItem) # Create the RDP session
-            Connector.SystemRDPWarningClickOk()  # Click all warning messages
-        else:
-            if inGSettings["Logger"]: inGSettings["Logger"].warning(f"RDP session was not created because it is alredy exists in the RDPList. Use RDPSessionReconnect if you want to update RDP configuration.")
-    return True

-
-
[docs]def RDPSessionDisconnect(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList = None, inGSettings = None):
-    """
-    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: 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
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inBreakTriggerProcessWOExeList is None: inBreakTriggerProcessWOExeList = []
-    # Check thread
-    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 = {
-            "Def": RDPSessionDisconnect, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inBreakTriggerProcessWOExeList": inBreakTriggerProcessWOExeList },  # 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)
-    else: # In processor - do execution
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        if lSessionHex:
-            lProcessListResult = {"ProcessWOExeList":[],"ProcessDetailList":[]}
-            if len(inBreakTriggerProcessWOExeList) > 0:
-                lProcessListResult = ProcessListGet(inProcessNameWOExeList=inBreakTriggerProcessWOExeList)  # Run the task manager monitor
-            if len(lProcessListResult["ProcessWOExeList"]) == 0: # Start disconnect if no process exist
-                inGSettings["RobotRDPActive"]["RDPList"].pop(inRDPSessionKeyStr,None)
-                Connector.SessionClose(inSessionHexStr=lSessionHex)
-                Connector.SystemRDPWarningClickOk()  # Click all warning messages
-    return True

-
-
[docs]def RDPSessionReconnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inGSettings = None):
-    """
-    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: RDP Session string key - need for the further identification
-    :param inRDPTemplateDict: RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate)
-    :return:
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionReconnect, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inRDPTemplateDict":inRDPTemplateDict },  # 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)
-    else:
-        lRDPConfigurationItem = inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr]
-        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
-        inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr] = lRDPConfigurationItem
-        # Create the RDP session
-        Connector.Session(lRDPConfigurationItem)
-    return True

-
-
[docs]def RDPSessionMonitorStop(inRDPSessionKeyStr, inGSettings = None):
-    """
-    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: RDP Session string key - need for the further identification
-    :return: True every time :>
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lResult = True
-    inGSettings["RobotRDPActive"]["RDPList"].pop(inRDPSessionKeyStr,None) # Remove item from RDPList
-    return lResult

-
-
[docs]def RDPSessionLogoff(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList = None, inGSettings = None):
-    """
-    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: 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
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    if inBreakTriggerProcessWOExeList is None: inBreakTriggerProcessWOExeList = []
-    lResult = True
-    # Check thread
-    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 = {
-            "Def": RDPSessionLogoff, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inBreakTriggerProcessWOExeList": inBreakTriggerProcessWOExeList },  # 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)
-    else:
-        lCMDStr = "shutdown -L" # CMD logoff command
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        if lSessionHex:
-            lProcessListResult = {"ProcessWOExeList":[],"ProcessDetailList":[]}
-            if len(inBreakTriggerProcessWOExeList) > 0:
-                lProcessListResult = ProcessListGet(inProcessNameWOExeList=inBreakTriggerProcessWOExeList)  # Run the task manager monitor
-            if len(lProcessListResult["ProcessWOExeList"]) == 0: # Start logoff if no process exist
-                # Run CMD - dont crosscheck because CMD dont return value to the clipboard when logoff
-                Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=lCMDStr, inModeStr="RUN", inLogger=inGSettings["Logger"], inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-                inGSettings["RobotRDPActive"]["RDPList"].pop(inRDPSessionKeyStr,None) # Remove item from RDPList
-    return lResult

-
-
[docs]def RDPSessionResponsibilityCheck(inRDPSessionKeyStr, inGSettings = None):
-    """
-    DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST
-
-    :param inGSettings: Global settings dict (singleton)
-    :param inRDPSessionKeyStr: RDP Session string key - need for the further identification
-    :return: True every time
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionResponsibilityCheck, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr },  # 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)
-    else:
-        lRDPConfigurationItem = inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr] # Get the alias
-        # set the fullscreen
-        # ATTENTION!!! Session hex can be updated!!!
-        Connector.SessionScreenFull(inSessionHex=lRDPConfigurationItem["SessionHex"], inLogger=inGSettings["Logger"], inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-        time.sleep(1)
-        # Check RDP responsibility
-        lDoCheckResponsibilityBool = True
-        lDoCheckResponsibilityCountMax = 20
-        lDoCheckResponsibilityCountCurrent = 0
-        while lDoCheckResponsibilityBool:
-            # Check if counter is exceed - raise exception
-            if lDoCheckResponsibilityCountCurrent >= lDoCheckResponsibilityCountMax:
-                pass
-                #raise ConnectorExceptions.SessionWindowNotResponsibleError("Error when initialize the RDP session - RDP window is not responding!")
-            # Check responding
-            lDoCheckResponsibilityBool = not Connector.SystemRDPIsResponsible(inSessionHexStr = lRDPConfigurationItem["SessionHex"])
-            # Wait if is not responding
-            if lDoCheckResponsibilityBool:
-                time.sleep(3)
-            # increase the couter
-            lDoCheckResponsibilityCountCurrent+=1
-    return True

-
-
[docs]def RDPSessionProcessStartIfNotRunning(inRDPSessionKeyStr, inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPathBool=True, inGSettings = None):
-    """
-    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: 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 :)
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # 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.")
-        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(lActivityItem)
-    else:
-        lCMDStr = CMDStr.ProcessStartIfNotRunning(inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPath= inFlagGetAbsPathBool)
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        # Run CMD
-        if lSessionHex:
-            Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=lCMDStr, inModeStr="CROSSCHECK", inLogger=inGSettings["Logger"],
-                                    inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-    return lResult

-
-
[docs]def RDPSessionCMDRun(inRDPSessionKeyStr, inCMDStr, inModeStr="CROSSCHECK", inGSettings = None):
-    """
-    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: 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 successfully sent
-        "RUN" - Run without crosscheck and get clipboard
-    :return: # OLD > True - CMD was executed successfully
-         {
-          "OutStr": <> # Result string
-          "IsResponsibleBool": True|False # Flag is RDP is responsible - works only when inModeStr = CROSSCHECK
-        }
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    lResult = {
-        "OutStr": None,  # Result string
-        "IsResponsibleBool": False  # Flag is RDP is responsible - works only when inModeStr = CROSSCHECK
-    }
-    # Check thread
-    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.")
-        lProcessorActivityDict = {
-            "Def": RDPSessionCMDRun, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr,  "inCMDStr": inCMDStr, "inModeStr": inModeStr },  # 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(lProcessorActivityDict)
-    else:
-        #lResult = True
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        # Run CMD
-        if lSessionHex:
-            lResult = Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=inCMDStr, inModeStr=inModeStr, inLogger=inGSettings["Logger"],
-                                    inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-    return lResult

-
-
[docs]def RDPSessionProcessStop(inRDPSessionKeyStr, inProcessNameWEXEStr, inFlagForceCloseBool, inGSettings = None):
-    """
-    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: 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
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionProcessStop, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr,  "inProcessNameWEXEStr": inProcessNameWEXEStr, "inFlagForceCloseBool": inFlagForceCloseBool },  # 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)
-    else:
-        lResult = True
-        lCMDStr = f'taskkill /im "{inProcessNameWEXEStr}" /fi "username eq %USERNAME%"'
-        if inFlagForceCloseBool:
-            lCMDStr+= " /F"
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        # Run CMD
-        if lSessionHex:
-            Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=lCMDStr, inModeStr="CROSSCHECK", inLogger=inGSettings["Logger"], inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-    return lResult

-
-
[docs]def RDPSessionFileStoredSend(inRDPSessionKeyStr, inHostFilePathStr, inRDPFilePathStr, inGSettings = None):
-    """
-    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: 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
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionFileStoredSend, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr,  "inHostFilePathStr": inHostFilePathStr, "inRDPFilePathStr": inRDPFilePathStr },  # 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)
-    else:
-        lResult = True
-        lCMDStr = CMDStr.FileStoredSend(inHostFilePath = inHostFilePathStr, inRDPFilePath = inRDPFilePathStr)
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr, {}).get("SessionHex", None)
-        #lSessionHex = inGlobalDict["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr]["SessionHex"]
-        # Run CMD
-        if lSessionHex:
-            Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=lCMDStr, inModeStr="LISTEN", inClipboardTimeoutSec = 120, inLogger=inGSettings["Logger"], inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-    return lResult

-
-
[docs]def RDPSessionFileStoredRecieve(inRDPSessionKeyStr, inRDPFilePathStr, inHostFilePathStr, inGSettings = None):
-    """
-    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: 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
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    # Check thread
-    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 = {
-            "Def": RDPSessionFileStoredRecieve, # def link or def alias (look gSettings["Processor"]["AliasDefDict"])
-            "ArgList": [],  # Args list
-            "ArgDict": {"inRDPSessionKeyStr": inRDPSessionKeyStr, "inRDPFilePathStr": inRDPFilePathStr, "inHostFilePathStr": inHostFilePathStr },  # 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)
-    else:
-        lResult = True
-        lCMDStr = CMDStr.FileStoredRecieve(inRDPFilePath = inRDPFilePathStr, inHostFilePath = inHostFilePathStr)
-        # Calculate the session Hex
-        lSessionHex = inGSettings["RobotRDPActive"]["RDPList"].get(inRDPSessionKeyStr,{}).get("SessionHex", None)
-        # Run CMD
-        if lSessionHex:
-            Connector.SessionCMDRun(inSessionHex=lSessionHex, inCMDCommandStr=lCMDStr, inModeStr="LISTEN", inClipboardTimeoutSec = 120, inLogger=inGSettings["Logger"], inRDPConfigurationItem=inGSettings["RobotRDPActive"]["RDPList"][inRDPSessionKeyStr])
-    return lResult

-
-# # # # # # # # # # # # # # # # # # # # # # #
-# # # # # Start orchestrator
-# # # # # # # # # # # # # # # # # # # # # # #
-
-
[docs]def GSettingsAutocleaner(inGSettings=None):
-    """
-    HIDDEN Interval gSettings auto cleaner def to clear some garbage.
-
-    :param inGSettings: Global settings dict (singleton)
-    :return: None
-    """
-    inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-    while True:
-        time.sleep(inGSettings["Autocleaner"]["IntervalSecFloat"])  # Wait for the next iteration
-        lL = inGSettings["Logger"]
-        lNowDatetime = datetime.datetime.now() # Get now time
-        # Clean old items in Client > Session > TechnicalSessionGUIDCache
-        lTechnicalSessionGUIDCacheNew = {}
-        for lItemKeyStr in inGSettings["Client"]["Session"]["TechnicalSessionGUIDCache"]:
-            lItemValue = inGSettings["Client"]["Session"]["TechnicalSessionGUIDCache"][lItemKeyStr]
-            if (lNowDatetime - lItemValue["InitDatetime"]).total_seconds() < inGSettings["Client"]["Session"]["LifetimeSecFloat"]: # Add if lifetime is ok
-                lTechnicalSessionGUIDCacheNew[lItemKeyStr]=lItemValue # Lifetime is ok - set
-            else:
-                if lL: lL.debug(f"Client > Session > TechnicalSessionGUIDCache > lItemKeyStr: Lifetime is expired. Remove from gSettings")  # Info
-        inGSettings["Client"]["Session"]["TechnicalSessionGUIDCache"] = lTechnicalSessionGUIDCacheNew # Set updated Cache
-        # Clean old items in AgentActivityReturnDict > GUIDStr > ReturnedByDatetime
-        lTechnicalAgentActivityReturnDictNew = {}
-        for lItemKeyStr in inGSettings["AgentActivityReturnDict"]:
-            lItemValue = inGSettings["AgentActivityReturnDict"][lItemKeyStr]
-            if (lNowDatetime - lItemValue["ReturnedByDatetime"]).total_seconds() < inGSettings["Autocleaner"]["AgentActivityReturnLifetimeSecFloat"]: # Add if lifetime is ok
-                lTechnicalAgentActivityReturnDictNew[lItemKeyStr]=lItemValue # Lifetime is ok - set
-            else:
-                if lL: lL.debug(f"AgentActivityReturnDict lItemKeyStr: Lifetime is expired. Remove from gSettings")  # Info
-        inGSettings["AgentActivityReturnDict"] = lTechnicalAgentActivityReturnDictNew # Set updated Cache

-    # # # # # # # # # # # # # # # # # # # # # # # # # #
-
-from .. import __version__ # Get version from the package
-
-
[docs]def Start(inDumpRestoreBool = True, inRunAsAdministratorBool = True):
-    """
-    Start the orchestrator threads execution
-
-    :param inDumpRestoreBool: True - restore data from the dumo
-    :param inRunAsAdministratorBool: True - rerun as admin if not
-    :return:
-    """
-    Orchestrator(inDumpRestoreBool = True, inRunAsAdministratorBool = True)

-
-
[docs]def Orchestrator(inGSettings=None, inDumpRestoreBool = True, inRunAsAdministratorBool = True):
-    """
-    Main def to start orchestrator
-
-    :param inGSettings:
-    :param inDumpRestoreBool:
-    :param inRunAsAdministratorBool:
-    :return:
-    """
-    lL = inGSettings["Logger"]
-    # https://stackoverflow.com/questions/130763/request-uac-elevation-from-within-a-python-script
-    if not OrchestratorIsAdmin() and inRunAsAdministratorBool==True:
-        OrchestratorRerunAsAdmin()
-    else:
-        # Code of your program here
-        inGSettings = GSettingsGet(inGSettings=inGSettings)  # Set the global settings
-        #mGlobalDict = Settings.Settings(sys.argv[1])
-        global gSettingsDict
-        gSettingsDict = inGSettings # Alias for old name in alg
-        inGSettings["VersionStr"] = __version__
-        #Logger alias
-        lL = gSettingsDict["Logger"]
-
-        if lL: lL.info("Link the gSettings in submodules")  #Logging
-        Processor.gSettingsDict = gSettingsDict
-        Timer.gSettingsDict = gSettingsDict
-        Timer.Processor.gSettingsDict = gSettingsDict
-        Server.gSettingsDict = gSettingsDict
-        Server.ProcessorOld.gSettingsDict = gSettingsDict # Backward compatibility
-
-        #Backward compatibility - restore in Orc def if old def
-        if inDumpRestoreBool == True:
-            OrchestratorSessionRestore(inGSettings=inGSettings)
-
-        # Init SettingsUpdate defs from file list (after RDP restore)
-        lSettingsUpdateFilePathList = gSettingsDict.get("OrchestratorStart", {}).get("DefSettingsUpdatePathList",[])
-        lSubmoduleFunctionName = "SettingsUpdate"
-        lSettingsPath = "\\".join(os.path.join(os.getcwd(), __file__).split("\\")[:-1])
-        for lModuleFilePathItem in lSettingsUpdateFilePathList:  # Import defs with try catch
-            try:  # Try to init - go next if error and log in logger
-                lModuleName = lModuleFilePathItem[0:-3]
-                lFileFullPath = os.path.join(lSettingsPath, lModuleFilePathItem)
-                lTechSpecification = importlib.util.spec_from_file_location(lModuleName, lFileFullPath)
-                lTechModuleFromSpec = importlib.util.module_from_spec(lTechSpecification)
-                lTechSpecificationModuleLoader = lTechSpecification.loader.exec_module(lTechModuleFromSpec)
-                if lSubmoduleFunctionName in dir(lTechModuleFromSpec):
-                    # Run SettingUpdate function in submodule
-                    getattr(lTechModuleFromSpec, lSubmoduleFunctionName)(gSettingsDict)
-            except Exception as e:
-                if lL: lL.exception(f"Error when init .py file in orchestrator '{lModuleFilePathItem}'. Exception is below:")
-
-        # Turn on backward compatibility
-        BackwardCompatibility.Update(inGSettings= gSettingsDict)
-
-        # Append Orchestrator def to ProcessorDictAlias
-        lModule = sys.modules[__name__]
-        lModuleDefList = dir(lModule)
-        for lItemDefNameStr in lModuleDefList:
-            # Dont append alias for defs Orchestrator and ___deprecated_orchestrator_start__
-            if lItemDefNameStr not in ["Orchestrator", "___deprecated_orchestrator_start__"]:
-                lItemDef = getattr(lModule,lItemDefNameStr)
-                if callable(lItemDef): inGSettings["ProcessorDict"]["AliasDefDict"][lItemDefNameStr]=lItemDef
-
-        #Load all defs from sys.modules
-        ActivityItemDefAliasModulesLoad()
-
-        #Инициализация настроечных параметров
-        gSettingsDict["ServerDict"]["WorkingDirectoryPathStr"] = os.getcwd() # Set working directory in g settings
-
-        #Инициализация сервера (инициализация всех интерфейсов)
-        lListenDict = gSettingsDict.get("ServerDict",{}).get("ListenDict",{})
-        for lItemKeyStr in lListenDict:
-            lItemDict = lListenDict[lItemKeyStr]
-            lThreadServer = Server.RobotDaemonServer(lItemKeyStr, gSettingsDict)
-            lThreadServer.start()
-            gSettingsDict["ServerDict"]["ServerThread"] = lThreadServer
-            lItemDict["ServerInstance"] = lThreadServer
-
-        # Init the RobotScreenActive in another thread
-        lRobotScreenActiveThread = threading.Thread(target= Monitor.CheckScreen)
-        lRobotScreenActiveThread.daemon = True # Run the thread in daemon mode.
-        lRobotScreenActiveThread.start() # Start the thread execution.
-        if lL: lL.info("Robot Screen active has been started")  #Logging
-
-        # Init the RobotRDPActive in another thread
-        lRobotRDPThreadControlDict = {"ThreadExecuteBool":True} # inThreadControlDict = {"ThreadExecuteBool":True}
-        lRobotRDPActiveThread = threading.Thread(target= RobotRDPActive.RobotRDPActive, kwargs={"inGSettings":gSettingsDict, "inThreadControlDict":lRobotRDPThreadControlDict})
-        lRobotRDPActiveThread.daemon = True # Run the thread in daemon mode.
-        lRobotRDPActiveThread.start() # Start the thread execution.
-        if lL: lL.info("Robot RDP active has been started")  #Logging
-
-
-
-        # Init autocleaner in another thread
-        lAutocleanerThread = threading.Thread(target= GSettingsAutocleaner, kwargs={"inGSettings":gSettingsDict})
-        lAutocleanerThread.daemon = True # Run the thread in daemon mode.
-        lAutocleanerThread.start() # Start the thread execution.
-        if lL: lL.info("Autocleaner thread has been started")  #Logging
-
-        # Set flag that orchestrator has been initialized
-        inGSettings["HiddenIsOrchestratorInitializedBool"] = True
-
-        # Orchestrator start activity
-        if lL: lL.info("Orchestrator start activity run")  #Logging
-        for lActivityItem in gSettingsDict["OrchestratorStart"]["ActivityList"]:
-            # Processor.ActivityListOrDict(lActivityItem)
-            Processor.ActivityListExecute(inGSettings=gSettingsDict,inActivityList=[BackwardCompatibility.v1_2_0_ProcessorOld2NewActivityDict(lActivityItem)])
-        # Processor thread
-        lProcessorThread = threading.Thread(target= Processor.ProcessorRunSync, kwargs={"inGSettings":gSettingsDict, "inRobotRDPThreadControlDict":lRobotRDPThreadControlDict})
-        lProcessorThread.daemon = True # Run the thread in daemon mode.
-        lProcessorThread.start() # Start the thread execution.
-        if lL: lL.info("Processor has been started (ProcessorDict)")  #Logging
-
-        # Processor monitor thread
-        lProcessorMonitorThread = threading.Thread(target= Processor.ProcessorMonitorRunSync, kwargs={"inGSettings":gSettingsDict})
-        lProcessorMonitorThread.daemon = True # Run the thread in daemon mode.
-        lProcessorMonitorThread.start() # Start the thread execution.
-        if lL: lL.info("Processor monitor has been started")  #Logging
-
-        # Scheduler loop
-        lSchedulerThread = threading.Thread(target= __deprecated_orchestrator_loop__)
-        lSchedulerThread.daemon = True # Run the thread in daemon mode.
-        lSchedulerThread.start() # Start the thread execution.
-        if lL: lL.info("Scheduler (old) loop start")  #Logging
-
-        # Schedule (new) loop
-        lScheduleThread = threading.Thread(target= __schedule_loop__)
-        lScheduleThread.daemon = True # Run the thread in daemon mode.
-        lScheduleThread.start() # Start the thread execution.
-        if lL: lL.info("Schedule module (new) loop start")  #Logging
-
-        # Restore state for process
-        for lProcessKeyTuple in inGSettings["ManagersProcessDict"]:
-            lProcess = inGSettings["ManagersProcessDict"][lProcessKeyTuple]
-            lProcess.StatusCheckIntervalRestore()
-            lThread = threading.Thread(target= lProcess.StatusRestore)
-            lThread.start()

-
-def __schedule_loop__():
-    while True:
-        schedule.run_pending()
-        time.sleep(3)
-
-# Backward compatibility below to 1.2.7
-def __deprecated_orchestrator_loop__():
-    lL = OrchestratorLoggerGet()
-    inGSettings = GSettingsGet()
-    lDaemonLoopSeconds = gSettingsDict["SchedulerDict"]["CheckIntervalSecFloat"]
-    lDaemonActivityLogDict = {}  # Словарь отработанных активностей, ключ - кортеж (<activityType>, <datetime>, <processPath || processName>, <processArgs>)
-    lDaemonLastDateTime = datetime.datetime.now()
-    gDaemonActivityLogDictRefreshSecInt = 10  # The second period for clear lDaemonActivityLogDict from old items
-    gDaemonActivityLogDictLastTime = time.time()  # The second perioad for clean lDaemonActivityLogDict from old items
-    while True:
-        try:
-            lCurrentDateTime = datetime.datetime.now()
-            # Циклический обход правил
-            lFlagSearchActivityType = True
-            # Periodically clear the lDaemonActivityLogDict
-            if time.time() - gDaemonActivityLogDictLastTime >= gDaemonActivityLogDictRefreshSecInt:
-                gDaemonActivityLogDictLastTime = time.time()  # Update the time
-                for lIndex, lItem in enumerate(lDaemonActivityLogDict):
-                    if lItem["ActivityEndDateTime"] and lCurrentDateTime <= lItem["ActivityEndDateTime"]:
-                        pass
-                        # Activity is actual - do not delete now
-                    else:
-                        # remove the activity - not actual
-                        lDaemonActivityLogDict.pop(lIndex, None)
-            lIterationLastDateTime = lDaemonLastDateTime  # Get current datetime before iterator (need for iterate all activities in loop)
-            # Iterate throught the activity list
-            for lIndex, lItem in enumerate(gSettingsDict["SchedulerDict"]["ActivityTimeList"]):
-                try:
-                    # Prepare GUID of the activity
-                    lGUID = None
-                    if "GUID" in lItem and lItem["GUID"]:
-                        lGUID = lItem["GUID"]
-                    else:
-                        lGUID = str(uuid.uuid4())
-                        lItem["GUID"] = lGUID
-
-                    # Проверка дней недели, в рамках которых можно запускать активность
-                    lItemWeekdayList = lItem.get("WeekdayList", [0, 1, 2, 3, 4, 5, 6])
-                    if lCurrentDateTime.weekday() in lItemWeekdayList:
-                        if lFlagSearchActivityType:
-                            #######################################################################
-                            # Branch 1 - if has TimeHH:MM
-                            #######################################################################
-                            if "TimeHH:MMStr" in lItem:
-                                # Вид активности - запуск процесса
-                                # Сформировать временной штамп, относительно которого надо будет проверять время
-                                # часовой пояс пока не учитываем
-                                lActivityDateTime = datetime.datetime.strptime(lItem["TimeHH:MMStr"], "%H:%M")
-                                lActivityDateTime = lActivityDateTime.replace(year=lCurrentDateTime.year,
-                                                                              month=lCurrentDateTime.month,
-                                                                              day=lCurrentDateTime.day)
-                                # Убедиться в том, что время наступило
-                                if (
-                                        lActivityDateTime >= lDaemonLastDateTime and
-                                        lCurrentDateTime >= lActivityDateTime):
-                                    # Log info about activity
-                                    if lL: lL.info(
-                                        f"Scheduler:: Activity list is started in new thread. Parameters are not available to see.")  # Logging
-                                    # Do the activity
-                                    lThread = threading.Thread(target=Processor.ActivityListExecute,
-                                                               kwargs={"inGSettings": inGSettings,
-                                                                       "inActivityList": lItem["ActivityList"]})
-                                    lThread.start()
-                                    lIterationLastDateTime = datetime.datetime.now()  # Set the new datetime for the new processor activity
-                except Exception as e:
-                    if lL: lL.exception(
-                        f"Scheduler: Exception has been catched in Scheduler module when activity time item was initialising. ActivityTimeItem is {lItem}")
-            lDaemonLastDateTime = lIterationLastDateTime  # Set the new datetime for the new processor activity
-            # Уснуть до следующего прогона
-            time.sleep(lDaemonLoopSeconds)
-        except Exception as e:
-            if lL: lL.exception(f"Scheduler: Exception has been catched in Scheduler module. Global error")
-
-# Backward compatibility below to 1.2.0
-def __deprecated_orchestrator_start__():
-    lSubmoduleFunctionName = "Settings"
-    lFileFullPath = sys.argv[1]
-    lModuleName = (lFileFullPath.split("\\")[-1])[0:-3]
-    lTechSpecification = importlib.util.spec_from_file_location(lModuleName, lFileFullPath)
-    lTechModuleFromSpec = importlib.util.module_from_spec(lTechSpecification)
-    lTechSpecificationModuleLoader = lTechSpecification.loader.exec_module(lTechModuleFromSpec)
-    gSettingsDict = None
-    if lSubmoduleFunctionName in dir(lTechModuleFromSpec):
-        # Run SettingUpdate function in submodule
-        gSettingsDict = getattr(lTechModuleFromSpec, lSubmoduleFunctionName)()
-    #################################################
-    Orchestrator(inGSettings=gSettingsDict) # Call the orchestrator
-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html deleted file mode 100644 index cdeff589..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Robot/UIDesktop.html +++ /dev/null @@ -1,1691 +0,0 @@ - - - - - - - - - - pyOpenRPA.Robot.UIDesktop — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Robot.UIDesktop
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Robot.UIDesktop

-from pywinauto import win32defines, win32structures, win32functions
-import pywinauto
-import ctypes
-import struct
-import win32api
-import time
-from .Utils import ProcessCommunicator
-from . import Utils #For ProcessBitness
-import re
-import copy
-
-############################################
-# When import UIDesktop init the other bitness python
-# For this type
-# UIDesktop.Utils.ProcessBitness.SettingsInit(inSettingsDict)
-# inSettingsDict = {
-#    "Python32FullPath": None, #Set from user: "..\\Resources\\WPy32-3720\\python-3.7.2\\OpenRPARobotGUIx32.exe"
-#    "Python64FullPath": None, #Set from user
-#    "Python32ProcessName": "OpenRPAUIDesktopX32.exe", #Config set once
-#    "Python64ProcessName": "OpenRPAUIDesktopX64.exe" #Config set once
-#}
-############################################
-
-#logging.basicConfig(filename="Reports\ReportRobotGUIRun_"+datetime.datetime.now().strftime("%Y_%m_%d")+".log", level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-
-#####Внимание#######
-#TODO В перспективе нужно реализовать алгоритм определения разрядности не в Robot.py, а в UIDesktop.py, тк начинают появляться функции, на входе в которые еще неизвестна разрядность элемента + селектор может охватить сразу два элемента из 2-х разных разрядностей - обрабатываться это должно непосредственно при выполнении
-
-####################################
-#Info: GUI module of the Robot app (OpenRPA - Robot)
-####################################
-# GUI Module - interaction with Desktop application
-
-#GUI Naming convention
-#<InArgument>_<ActivityName>_<OutArgument - if exist>
-
-#UIO - UI Object (class of pywinauto UI object)
-#UIOSelector - List of dict (key attributes)
-#PWA - PyWinAuto
-#PWASpecification - List of dict (key attributes in pywinauto.find_window notation)
-#UIOTree - Recursive Dict of Dict ... (UI Parent -> Child hierarchy)
-#UIOInfo - Dict of UIO attributes
-#UIOActivity - Activity of the UIO (UI object) from the Pywinauto module
-#UIOEI - UI Object info object
-
-#inActivitySpecificationDict:
-#{
-#   ModuleName: <"GUI", str>, - optional
-#   ActivityName: <Function or procedure name in module, str>,
-#   ArgumentList: [<Argument 1, any type>, ...] - optional,
-#   ArgumentDict: {<Argument 1 name, str>:<Argument 1 value, any type>, ...} - optional
-#}
-
-#outActivityResultDict:
-#{
-#   ActivitySpecificationDict: {
-#       ModuleName: <"GUI", str>, -optional
-#       ActivityName: <Function or procedure name in module, str>,
-#       ArgumentList: [<Argument 1, any type>, ...] - optional,
-#       ArgumentDict: {<Argument 1 name, str>: <Argument 1 value, any type>, ...} - optional
-#   },
-#   ErrorFlag: <Boolean flag - Activity result has error (true) or not (false), boolean>,
-#   ErrorMessage: <Error message, str> - required if ErrorFlag is true,
-#   ErrorTraceback: <Error traceback log, str> - required if ErrorFlag is true,
-#   Result: <Result, returned from the Activity, int, str, boolean, list, dict> - required if ErrorFlag is false
-#}
-
-#inUIOSelector:
-#[
-#   {
-#       "index":<Позиция элемента в родительском объекте>,
-#       "depth_start" - глубина, с которой начинается поиск (по умолчанию 1),
-#       "depth_end" - глубина, до которой ведется поиск (по умолчанию 1),
-#       "class_name" - наименование класса, который требуется искать,
-#       "title" - наименование заголовка,
-#       "rich_text" - наименование rich_text,
-#       "backend": <"win32"||"uia", only for the 1-st list element> - if not specified, use mDefaultPywinautoBackend
-#   },
-#   { ... }
-#
-#]
-
-#Default parameters
-mDefaultPywinautoBackend="win32"
-
-############################
-#Новая версия
-############################
-#Получить список элементов, который удовлетворяет условиям через расширенный движок поиска
-#[
-#   {
-#       "index":<Позиция элемента в родительском объекте>,
-#       "depth_start" - глубина, с которой начинается поиск (по умолчанию 1)
-#       "depth_end" - глубина, до которой ведется поиск (по умолчанию 1)
-#       "class_name" - наименование класса, который требуется искать
-#       "title" - наименование заголовка
-#       "rich_text" - наименование rich_text
-#   }
-#]
-################
-#return: List of UI Object
-#inElement - Входной элемент - показатель, что не требуется выполнять коннект к процессу
-#inFlagRaiseException - Флаг True - выкинуть ошибку в случае обнаружении пустого списка
-#old name - PywinautoExtElementsGet
-
[docs]def UIOSelector_Get_UIOList (inSpecificationList,inElement=None,inFlagRaiseException=True):
-    '''
-    Get the UIO list by the selector
-
-    :param inSpecificationList: UIO Selector
-    :param inElement: Входной элемент - показатель, что не требуется выполнять коннект к процессу
-    :param inFlagRaiseException: Флаг True - выкинуть ошибку в случае обнаружении пустого списка
-    :return:
-    '''
-    #Создать копию входного листа, чтобы не менять массив в других верхнеуровневых функциях
-    inSpecificationList=copy.deepcopy(inSpecificationList)
-    lResultList=[]
-    lChildrenList=[]
-    #Получить родительский объект если на вход ничего не поступило
-    if inElement is None:
-        #сформировать спецификацию на получение элемента
-        lRootElementSpecification=[inSpecificationList[0]]
-        lRootElementList=PWASpecification_Get_UIO(lRootElementSpecification)
-        for lRootItem in lRootElementList:
-            if lRootItem is not None:
-                lChildrenList.append(lRootItem.wrapper_object())
-    #Елемент на вход поступил - выполнить его анализ
-    else:
-        #Получить список элементов
-        lElementChildrenList=inElement.children()
-        #Поступил index - точное добавление
-        if 'index' in inSpecificationList[0]:
-            if inSpecificationList[0]['index']<len(lElementChildrenList):
-                #Получить дочерний элемент - точное добавление
-                lChildrenList.append(lElementChildrenList[inSpecificationList[0]['index']])
-            else:
-                if inFlagRaiseException:
-                    raise ValueError('Object has no children with index: ' + str(inSpecificationList[0]['index']))
-        #Поступил ctrl_index - точное добавление
-        elif 'ctrl_index' in inSpecificationList[0]:
-            if inSpecificationList[0]['ctrl_index']<len(lElementChildrenList):
-                #Получить дочерний элемент
-                lChildrenList.append(lElementChildrenList[inSpecificationList[0]['ctrl_index']])
-            else:
-                if inFlagRaiseException:
-                    raise ValueError('Object has no children with index: ' + str(inSpecificationList[0]['ctrl_index']))
-        #Если нет точного обозначения элемента
-        else:
-            lFlagGoCheck=True
-            #Учесть поле depth_start (если указано)
-            if 'depth_start' in inSpecificationList[0]:
-                if inSpecificationList[0]["depth_start"]>1:
-                    lFlagGoCheck=False
-            #Циклический обход по детям, на предмет соответствия всем условиям
-            for lChildrenItem in lElementChildrenList:
-                #Обработка глубины depth (рекурсивный вызов для всех детей с занижением индекса глубины)
-                #По умолчанию значение глубины 1
-                if 'depth_end' in inSpecificationList[0]:
-                    if inSpecificationList[0]['depth_end']>1:
-                        #Подготовка новой версии спецификации
-                        lChildrenItemNewSpecificationList=inSpecificationList.copy()
-                        lChildrenItemNewSpecificationList[0]=lChildrenItemNewSpecificationList[0].copy()
-                        lChildrenItemNewSpecificationList[0]["depth_end"]=lChildrenItemNewSpecificationList[0]["depth_end"]-1
-                        if 'depth_start' in lChildrenItemNewSpecificationList[0]:
-                            lChildrenItemNewSpecificationList[0]["depth_start"]=lChildrenItemNewSpecificationList[0]["depth_start"]-1
-                        #Циклический вызов для всех детей со скорректированной спецификацией
-                        lResultList.extend(UIOSelector_Get_UIOList(lChildrenItemNewSpecificationList,lChildrenItem,inFlagRaiseException))
-                #Фильтрация
-                #TODO Сделать поддержку этих атрибутов для первого уровня селектора
-                if lFlagGoCheck:
-                    lFlagAddChild=True
-                    #Фильтрация по title
-                    if 'title' in inSpecificationList[0]:
-                        if lChildrenItem.element_info.name != inSpecificationList[0]["title"]:
-                            lFlagAddChild=False
-                    #Фильтрация по title_re (regexp)
-                    if 'title_re' in inSpecificationList[0]:
-                        if re.fullmatch(inSpecificationList[0]["title_re"],lChildrenItem.element_info.name) is None:
-                            lFlagAddChild=False
-                    #Фильтрация по rich_text
-                    if 'rich_text' in inSpecificationList[0]:
-                        if lChildrenItem.element_info.rich_text != inSpecificationList[0]["rich_text"]:
-                            lFlagAddChild=False
-                    #Фильтрация по rich_text_re (regexp)
-                    if 'rich_text_re' in inSpecificationList[0]:
-                        if re.fullmatch(inSpecificationList[0]["rich_text_re"],lChildrenItem.element_info.rich_text) is None:
-                            lFlagAddChild=False
-                    #Фильтрация по class_name
-                    if 'class_name' in inSpecificationList[0]:
-                        if lChildrenItem.element_info.class_name != inSpecificationList[0]["class_name"]:
-                            lFlagAddChild=False
-                    #Фильтрация по class_name_re (regexp)
-                    if 'class_name_re' in inSpecificationList[0]:
-                        if re.fullmatch(inSpecificationList[0]["class_name_re"],lChildrenItem.element_info.class_name) is None:
-                            lFlagAddChild=False
-                    #Фильтрация по friendly_class_name
-                    if 'friendly_class_name' in inSpecificationList[0]:
-                        if lChildrenItem.friendly_class_name() != inSpecificationList[0]["friendly_class_name"]:
-                            lFlagAddChild=False
-                    #Фильтрация по friendly_class_name_re (regexp)
-                    if 'friendly_class_name_re' in inSpecificationList[0]:
-                        if re.fullmatch(inSpecificationList[0]["friendly_class_name_re"],lChildrenItem.friendly_class_name) is None:
-                            lFlagAddChild=False
-                    #Фильтрация по control_type
-                    if 'control_type' in inSpecificationList[0]:
-                        if lChildrenItem.element_info.control_type != inSpecificationList[0]["control_type"]:
-                            lFlagAddChild=False
-                    #Фильтрация по control_type_re (regexp)
-                    if 'control_type_re' in inSpecificationList[0]:
-                        if re.fullmatch(inSpecificationList[0]["control_type_re"],lChildrenItem.element_info.control_type) is None:
-                            lFlagAddChild=False
-                    #Фильтрация по is_enabled (bool)
-                    if 'is_enabled' in inSpecificationList[0]:
-                        if lChildrenItem.is_enabled()!=inSpecificationList[0]["is_enabled"]:
-                            lFlagAddChild=False
-                    #Фильтрация по is_visible (bool)
-                    if 'is_visible' in inSpecificationList[0]:
-                        if lChildrenItem.is_visible()!=inSpecificationList[0]["is_visible"]:
-                            lFlagAddChild=False
-                    #####
-                    #Все проверки пройдены - флаг добавления
-                    if lFlagAddChild:
-                        lChildrenList.append(lChildrenItem)
-    #Выполнить рекурсивный вызов (уменьшение количества спецификаций), если спецификация больше одного элемента
-    #????????Зачем в условии ниже is not None ???????????
-    if len(inSpecificationList)>1 and len(lChildrenList)>0 is not None:
-        #Вызвать рекурсивно функцию получения следующего объекта, если в спецификации есть следующий объект
-        for lChildElement in lChildrenList:
-            lResultList.extend(UIOSelector_Get_UIOList(inSpecificationList[1:],lChildElement,inFlagRaiseException))
-    else:
-        lResultList.extend(lChildrenList)
-    #Условие, если результирующий список пустой и установлен флаг создания ошибки (и inElement is None - не следствие рекурсивного вызова)
-    if inElement is None and len(lResultList)==0 and inFlagRaiseException:
-        raise pywinauto.findwindows.ElementNotFoundError("Robot can't find element by the UIOSelector")
-    return lResultList

-
-#################################################################################################
-#Get first (in more than one) UIO (UI Object)
-#inSpecificationList - UIOSelector
-#inElement - Входной элемент - показатель, что не требуется выполнять коннект к процессу
-#inFlagRaiseException - Флаг True - выкинуть ошибку в случае обнаружении пустого списка
-#old name - PywinautoExtElementGet
-
[docs]def UIOSelector_Get_UIO (inSpecificationList,inElement=None,inFlagRaiseException=True):
-    '''
-    Get the pywinauto object by the UIO selector.
-
-    :param inSpecificationList:
-    :param inElement:
-    :param inFlagRaiseException:
-    :return:
-    '''
-    lResult=None
-    #Получить родительский объект если на вход ничего не поступило
-    lResultList=UIOSelector_Get_UIOList(inSpecificationList,inElement,False)
-    if len(lResultList)>0:
-        lResult=lResultList[0]
-    #Условие, если результирующий список пустой и установлен флаг создания ошибки (и inElement is None - не следствие рекурсивного вызова)
-    if lResult is None and inFlagRaiseException:
-        raise pywinauto.findwindows.ElementNotFoundError("Robot can't find element by the UIOSelector")
-    return lResult

-#################################################################################################
-#Check if UIO exist (Identified by the UIOSelector)
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#UIOSelector
-#old name - -
-
[docs]def UIOSelector_Exist_Bool (inUIOSelector):
-    '''
-    Check if object is exist by the UIO selector.
-
-    :param inUIOSelector:
-    :return: True - Object is exist. False - else case
-    '''
-    lResult=False
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Получить родительский объект если на вход ничего не поступило
-        lResultList=UIOSelector_Get_UIOList(inUIOSelector, None, False)
-        if len(lResultList)>0:
-            lResult=True
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_Exist_Bool",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResult = lPIPEResponseDict["Result"]
-    return lResult

-#################################################################################################
-#Wait for UIO is appear (at least one of them or all at the same time)
-#inSpecificationListList - List of the UIOSelector
-#inWaitSecs - Время ожидания объекта в секундах
-#inFlagWaitAllInMoment - доп. условие - ожидать появление всех UIOSelector одновременно
-#return: [0,1,2] - index of UIOSpecification, which is appear
-#old name - -
-#####Внимание#####
-##Функция ожидания появления элементов (тк элементы могут быть недоступны, неизвестно в каком фреймворке каждый из них может появиться)
-
[docs]def UIOSelectorsSecs_WaitAppear_List (inSpecificationListList,inWaitSecs,inFlagWaitAllInMoment=False):
-    '''
-    Wait for many UI object will appear in GUI for inWaitSecs seconds.
-
-    :param inSpecificationListList: UIOSelector list.
-        Example: [
-            [{"title":"notepad"},{"title":"OK"}],
-            [{"title":"notepad"},{"title":"Cancel"}]
-        ]
-    :param inWaitSecs: Float value (seconds) for wait UI element appear in GUI
-    :param inFlagWaitAllInMoment: True - Wait all UI objects from the UIOSelector list to be appeared
-    :return: List of index, which UI object UIO will be appeared. Example: [1] # Appear only UI object with UIO selector: [{"title":"notepad"},{"title":"Cancel"}]
-    '''
-    lResultFlag=False
-    lSecsSleep = 1 #Настроечный параметр
-    lSecsDone = 0
-    lResultList = None
-    #Цикл проверки
-    while lResultFlag == False and lSecsDone<inWaitSecs:
-        #pdb.set_trace()
-        lResultList=[]
-        #Итерация проверки
-        lIndex = 0
-        for lItem in inSpecificationListList:
-            lItemResultFlag=UIOSelector_Exist_Bool(lItem)
-            #Если обнаружен элемент - добавить его индекс в массив
-            if lItemResultFlag:
-                lResultList.append(lIndex)
-            #Инкремент индекса
-            lIndex=lIndex + 1
-        #Проверка в зависимости от флага
-        if inFlagWaitAllInMoment and len(lResultList)==len(inSpecificationListList):
-            #Условие выполнено
-            lResultFlag=True
-        elif not inFlagWaitAllInMoment and len(lResultList)>0:
-            #Условие выполнено
-            lResultFlag=True
-        #Если флаг не изменился - увеличить время и уснуть
-        if lResultFlag == False:
-            lSecsDone=lSecsDone+lSecsSleep
-            time.sleep(lSecsSleep)
-    return lResultList

-#################################################################################################
-#Wait for UIO is Disappear (at least one of them or all at the same time)
-#inSpecificationListList - List of the UIOSelector
-#inWaitSecs - Время ожидания пропажи объекта в секундах
-#inFlagWaitAllInMoment - доп. условие - ожидать пропажу всех UIOSelector одновременно
-#return: [0,1,2] - index of UIOSpecification, which is Disappear
-#old name - -
-#####Внимание#####
-##Функция ожидания пропажи элементов (тк элементы могут быть недоступны, неизвестно в каком фреймворке каждый из них может появиться)
-
[docs]def UIOSelectorsSecs_WaitDisappear_List (inSpecificationListList,inWaitSecs,inFlagWaitAllInMoment=False):
-    '''
-    Wait for many UI object will disappear in GUI for inWaitSecs seconds.
-
-    :param inSpecificationListList: UIOSelector list.
-        Example: [
-            [{"title":"notepad"},{"title":"OK"}],
-            [{"title":"notepad"},{"title":"Cancel"}]
-        ]
-    :param inWaitSecs: Float value (seconds) for wait UI element disappear in GUI
-    :param inFlagWaitAllInMoment: True - Wait all UI objects from the UIOSelector list to be disappeared.
-    :return: List of index, which UI object UIO will be disappeared. Example: [1] # Disappear only UI object with UIO selector: [{"title":"notepad"},{"title":"Cancel"}]
-    :return:
-    '''
-    lResultFlag=False
-    lSecsSleep = 1 #Настроечный параметр
-    lSecsDone = 0
-    lResultList = None
-    #Цикл проверки
-    while lResultFlag == False and lSecsDone<inWaitSecs:
-        #pdb.set_trace()
-        lResultList=[]
-        #Итерация проверки
-        lIndex = 0
-        for lItem in inSpecificationListList:
-            lItemResultFlag=UIOSelector_Exist_Bool(lItem)
-            #Если обнаружен элемент - добавить его индекс в массив
-            if not lItemResultFlag:
-                lResultList.append(lIndex)
-            #Инкремент индекса
-            lIndex=lIndex + 1
-        #Проверка в зависимости от флага
-        if inFlagWaitAllInMoment and len(lResultList)==len(inSpecificationListList):
-            #Условие выполнено
-            lResultFlag=True
-        elif not inFlagWaitAllInMoment and len(lResultList)>0:
-            #Условие выполнено
-            lResultFlag=True
-        #Если флаг не изменился - увеличить время и уснуть
-        if lResultFlag == False:
-            lSecsDone=lSecsDone+lSecsSleep
-            time.sleep(lSecsSleep)
-    return lResultList

-#################################################################################################
-#Wait for UIO is appear (at least one of them or all at the same time)
-#inSpecificationList - UIOSelector
-#inWaitSecs - Время ожидания объекта в секундах
-#return: Bool - True - UIO is appear
-#old name - -
-
[docs]def UIOSelectorSecs_WaitAppear_Bool (inSpecificationList,inWaitSecs):
-    '''
-    Wait for UI object will appear in GUI for inWaitSecs seconds.
-
-    :param inSpecificationList: UIOSelector. Example: [{"title":"notepad"},{"title":"OK"}]
-    :param inWaitSecs: Float value (seconds) for wait UI element appear in GUI
-    :return: True - UI object will appear. False - else case
-    '''
-    lWaitAppearList=UIOSelectorsSecs_WaitAppear_List([inSpecificationList],inWaitSecs)
-    lResult=False
-    if len(lWaitAppearList)>0:
-        lResult=True
-    return lResult

-#################################################################################################
-#Wait for UIO is disappear (at least one of them or all at the same time)
-#inSpecificationList - UIOSelector
-#inWaitSecs - Время ожидания пропажи объекта в секундах
-#return: Bool - True - UIO is Disappear
-#old name - -
-
[docs]def UIOSelectorSecs_WaitDisappear_Bool (inSpecificationList,inWaitSecs):
-    '''
-    Wait for UI object will disappear in GUI for inWaitSecs seconds.
-
-    :param inSpecificationList: UIOSelector.
-        Example: [{"title":"notepad"},{"title":"OK"}]
-    :param inWaitSecs: Float value (seconds) for wait UI element disappear in GUI
-    :return: True - UI object will disappear. False - else case
-    '''
-    lWaitDisappearList=UIOSelectorsSecs_WaitDisappear_List([inSpecificationList],inWaitSecs)
-    lResult=False
-    if len(lWaitDisappearList)>0:
-        lResult=True
-    return lResult

-#################################################################################################
-#Get process bitness (32 or 64)
-#inSpecificationList - UIOSelector
-#old name - None
-#return None (if Process not found), int 32, or int 64
-
[docs]def UIOSelector_Get_BitnessInt (inSpecificationList):
-    '''
-    Detect process bitness by the UI Object UIO Selector.
-
-    :param inSpecificationList: UIOSelector. Example: [{"title":"notepad"},{"title":"OK"}]
-    :return: int 32 or int 64
-    '''
-    lResult=None
-    #Получить объект Application (Для проверки разрядности)
-    lRootElement=PWASpecification_Get_PWAApplication(inSpecificationList)
-    if lRootElement is not None:
-        if lRootElement.is64bit():
-            lResult=64
-        else:
-            lResult=32
-    return lResult

-#################################################################################################
-#Get process bitness ("32" or "64")
-#inSpecificationList - UIOSelector
-#old name - None
-#return None (if Process not found), int 32, or int 64
-
[docs]def UIOSelector_Get_BitnessStr (inSpecificationList):
-    '''
-    Detect process bitness by the UI Object UIO Selector.
-
-    :param inSpecificationList: UIOSelector. Example: [{"title":"notepad"},{"title":"OK"}]
-    :return: str "32" or str "64"
-    '''
-    lResult=None
-    #Получить объект Application (Для проверки разрядности)
-    lRootElement=PWASpecification_Get_PWAApplication(inSpecificationList)
-    if lRootElement is not None:
-        if lRootElement.is64bit():
-            lResult="64"
-        else:
-            lResult="32"
-    return lResult

-#################################################################################################
-#Get OS bitness (32 or 64)
-#old name - None
-#return int 32, or int 64
-
[docs]def Get_OSBitnessInt ():
-    '''
-    Detect OS bitness.
-
-    :return: int 32 or int 64
-    '''
-    lResult=32
-    if pywinauto.sysinfo.is_x64_OS():
-        lResult=64
-    return lResult

-#################################################################################################
-
[docs]def UIOSelector_SafeOtherGet_Process(inUIOSelector):
-    '''
-    Safe get other process or None if destination app is the other/same bitness
-
-    :param inUIOSelector: UIO Selector of the UI object
-    :return: None or process (of the other bitness)
-    '''
-    #Default value
-    lResult = None
-    #Go check bitness if selector exists
-    if inUIOSelector:
-        #Get selector bitness
-        lUIOSelectorAppBitness = UIOSelector_Get_BitnessStr(inUIOSelector)
-        if lUIOSelectorAppBitness and Utils.ProcessBitness.mSettingsDict["BitnessProcessCurrent"] != lUIOSelectorAppBitness:
-            lResult = Utils.ProcessBitness.OtherProcessGet()
-    return lResult

-##################################################################################################
-
[docs]def PWASpecification_Get_UIO(inControlSpecificationArray):
-    '''
-    #Backend def selection - attribute "backend" ("win32" || "uia") in 1-st list element
-    #old name - GetControl
-
-    :param inControlSpecificationArray: List of dict, dict in pywinauto.find_windows notation
-    :return: list of UIO object
-    '''
-    #Определение backend
-    lBackend=mDefaultPywinautoBackend
-    if "backend" in inControlSpecificationArray[0]:
-        lBackend=inControlSpecificationArray[0]["backend"]
-        inControlSpecificationArray[0].pop("backend")
-    #Подготовка входного массива
-    inControlSpecificationOriginArray=copy.deepcopy(inControlSpecificationArray)
-    inControlSpecificationArray=UIOSelector_SearchProcessNormalize_UIOSelector(inControlSpecificationArray)
-    #Выполнить идентификацию объектов, если передан массив
-    lResultList=[]
-    lTempObject=None
-    if len(inControlSpecificationArray) > 0:
-        #Сформировать выборку элементов, которые подходят под первый уровень спецификации
-        lSpecificationLvL1List = pywinauto.findwindows.find_elements(**inControlSpecificationArray[0])
-        for lItem in lSpecificationLvL1List:
-            #Сделать независимую копию и установить информацию о process_id и handle
-            lItemControlSpecificationArray=copy.deepcopy(inControlSpecificationArray)
-            lItemControlSpecificationArray[0]["process_id"]=lItem.process_id
-            lItemControlSpecificationArray[0]["handle"]=lItem.handle
-            lItemControlSpecificationOriginArray=copy.deepcopy(inControlSpecificationOriginArray)
-            lItemControlSpecificationOriginArray[0]["process_id"]=lItem.process_id
-            lItemControlSpecificationOriginArray[0]["handle"]=lItem.handle
-            #Выполнить подключение к объекту
-            lRPAApplication = pywinauto.Application(backend=lBackend)
-            #Проверка разрядности
-            try:
-                lRPAApplication.connect(**lItemControlSpecificationArray[0])
-            except Exception as e:
-                UIOSelector_TryRestore_Dict(lItemControlSpecificationArray)
-                try:
-                    lRPAApplication.connect(**lItemControlSpecificationArray[0])
-                except Exception as e:
-                    lRPAApplication = None
-            if lRPAApplication is not None:
-                #lTempObject=lRPAApplication.window(**lItemControlSpecificationArray[0])
-                #Скорректировано из-за недопонимания структуры
-                lTempObject=lRPAApplication
-                #Нормализация массива для целей выборки объекта (удаление конфликтующих ключей)
-                lItemControlSpecificationArray=UIOSelector_SearchUIONormalize_UIOSelector(lItemControlSpecificationOriginArray)
-                #Циклическое прохождение к недрам объекта
-                for lWindowSpecification in lItemControlSpecificationArray[0:]:
-                    lTempObject=lTempObject.window(**lWindowSpecification)
-                #Добавить объект в результирующий массив
-                lResultList.append(lTempObject)
-    return lResultList

-##################################################################################################
-
[docs]def PWASpecification_Get_PWAApplication(inControlSpecificationArray):
-    '''
-    #Backend selection - attribute "backend" ("win32" || "uia") in 1-st list element
-
-    :param inControlSpecificationArray: List of dict, dict in pywinauto.find_windows notation
-    :return: process application object
-    '''
-    inControlSpecificationArray=copy.deepcopy(inControlSpecificationArray)
-    #Определение backend
-    lBackend=mDefaultPywinautoBackend
-    if "backend" in inControlSpecificationArray[0]:
-        lBackend=inControlSpecificationArray[0]["backend"]
-        inControlSpecificationArray[0].pop("backend")
-    #Подготовка входного массива
-    inControlSpecificationOriginArray=inControlSpecificationArray
-    inControlSpecificationArray=UIOSelector_SearchProcessNormalize_UIOSelector(inControlSpecificationArray)
-    #Выполнить идентификацию объектов, если передан массив
-    lResultList=[]
-    lTempObject=None
-    if len(inControlSpecificationArray) > 0:
-        #Выполнить подключение к объекту
-        lRPAApplication = pywinauto.Application(backend=lBackend)
-        #Проверка разрядности
-        try:
-            lRPAApplication.connect(**inControlSpecificationArray[0])
-        except Exception as e:
-            UIOSelector_TryRestore_Dict(inControlSpecificationArray)
-            try:
-                lRPAApplication.connect(**inControlSpecificationArray[0])
-            except Exception as e:
-                lRPAApplication = None
-        if lRPAApplication is not None:
-            #lTempObject=lRPAApplication.window(**inControlSpecificationArray[0])
-            #Скорректировано из-за недопонимания структуры
-            lTempObject=lRPAApplication
-    return lTempObject

-
-###########################################################################################################
-
[docs]def UIOSelector_SearchChildByMouse_UIO(inElementSpecification):
-    '''
-    UIOSelector (see description on the top of the document)
-    #old name - AutomationSearchMouseElement
-
-    :param inElementSpecification: UIOSelector of the UI Object
-    :return: pywinauto element wrapper instance or None
-    '''
-    lGUISearchElementSelected=None
-    #Настройка - частота обновления подсвечивания
-    lTimeSleepSeconds=0.4
-    lElementFoundedList=[]
-    #Ветка поиска в режиме реального времени
-    #Сбросить нажатие Ctrl, если оно было
-    bool(win32api.GetAsyncKeyState(17))
-    #Оптимизация - получить объект для опроса единажды
-    lUIORoot=UIOSelector_Get_UIO(inElementSpecification)
-    lFlagLoop = True
-    while lFlagLoop:
-        #Проверить, нажата ли клавиша Ctrl (код 17)
-        lFlagKeyPressedCtrl=bool(win32api.GetAsyncKeyState(17))
-        #Подсветить объект, если мышка наведена над тем объектом, который не подсвечивался в прошлый раз
-        if not lFlagKeyPressedCtrl:
-            #Получить координаты мыши
-            (lX,lY) = win32api.GetCursorPos()
-            lElementFounded={}
-            #Создать карту пикселей и элементов
-            #####Внимание! Функция UIOXY_SearchChild_ListDict не написана
-            lElementFoundedList=UIOXY_SearchChild_ListDict(lUIORoot,lX,lY)
-            #print(lElementFoundedList)
-            lElementFounded=lElementFoundedList[-1]["element"]
-            #Подсветить объект, если он мышь раньше стояла на другом объекте
-            if lGUISearchElementSelected != lElementFounded:
-                lGUISearchElementSelected = lElementFounded
-                #Доработанная функция отрисовки
-                if lElementFounded is not None:
-                    UIO_Highlight(lElementFounded)
-        else:
-            #Была нажата клавиша Ctrl - выйти из цикла
-            lFlagLoop=False
-        #Заснуть до следующего цикла
-        time.sleep(lTimeSleepSeconds)
-    #Вернуть результат поиска
-    return lElementFoundedList

-
-####################################################################################################
-#old name - AutomationSearchMouseElementHierarchy
-
[docs]def UIOSelector_SearchChildByMouse_UIOTree(inUIOSelector):
-    '''
-    !!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-
-    :param inUIOSelector: UIOSelector of the UI Object
-    :return: ?
-    '''
-    lItemInfo = []
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Запустить функцию поиска элемента по мыши
-        lElementList = UIOSelector_SearchChildByMouse_UIO(inUIOSelector)
-        lElement = lElementList[-1]['element']
-        #Detect backend of the elements
-        lFlagIsBackendWin32 = True
-        #Если объект имеется (не None), то выполнить построение иерархии
-        if lElement is not None:
-            if lElement.backend.name == 'uia':
-                lFlagIsBackendWin32 = False
-            #Циклическое создание дерева
-            #while lElement is not None:
-            lListIterator=0
-            lItemInfo2=lItemInfo
-            for lListItem in lElementList:
-                lElement = lListItem["element"]
-                #Продолжать построение иерархии во всех случаях кроме бэк uia & parent() is None
-                #if not lFlagIsBackendWin32 and lElement.parent() is None:
-                #    lElement = None
-                #else:
-                #Получить информацию про объект
-                lItemInfo2.append(UIOEI_Convert_UIOInfo(lElement.element_info))
-                #Дообогатить информацией об индексе ребенка в родительском объекте
-                if "index" in lListItem:
-                    if lListItem["index"] is not None:
-                        lItemInfo2[-1]['ctrl_index']=lListItem["index"]
-                    else:
-                        if "ctrl_index" in lListItem:
-                            lItemInfo2[-1]['ctrl_index']=lListItem["ctrl_index"]
-                else:
-                    if "ctrl_index" in lListItem:
-                        lItemInfo2[-1]['ctrl_index']=lListItem["ctrl_index"]
-                #Оборачиваем потомка в массив, потому что у родителя по структуре интерфейса может быть больше одного наследников
-                lItemInfo2[-1]['SpecificationChild']=[]
-                lItemInfo2=lItemInfo2[-1]['SpecificationChild']
-                #Переход на родительский объект
-                #lElement = lElement.parent()
-                lListIterator=lListIterator+1
-            #Добавить информацию о Backend в первый объект
-            lItemInfo[0]["backend"]=lElement.backend.name
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_SearchChildByMouse_UIOTree",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lItemInfo = lPIPEResponseDict["Result"]
-    #Вернуть результат
-    return lItemInfo

-####################################################################################################
-#inElement- UIO (UI Object)
-#old name - PywinautoExtElementCtrlIndexGet
-def UIO_GetCtrlIndex_Int(inElement):
-    lResult = None
-    #Выполнить алгоритм, если есть Element
-    if inElement is not None:
-        lElementParent = inElement.parent()
-        if lElementParent is not None:
-            lResult = 0
-            lFlagFind = True
-            #Получить список потомков
-            lElementParentChildrenList = lElementParent.children()
-            #Циклический поиск до того момента, пока не упремся в текущий элемент
-            while lFlagFind:
-                if lResult<len(lElementParentChildrenList):
-                    #Прекратить поиск, если элемент был обнаружен
-                    if inElement == lElementParentChildrenList[lResult]:
-                        lFlagFind = False
-                    else:
-                        #Прекратить поиски, если итератор вышел за пределы списка
-                        if lResult>=len(lElementParentChildrenList):
-                            lResult = None
-                            lFlagFind = False
-                        else:
-                            lResult = lResult + 1
-                else:
-                    lResult=-1
-                    lFlagFind=False
-    #Вернуть результат    
-    return lResult
-
-####################################################################################################
-# Get the UIO Info list for the selected criteria
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#inSpecificationList - UIOSelector
-#old name - PywinautoExtElementsGetInfo
-def UIOSelector_Get_UIOInfoList (inUIOSelector, inElement=None):
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Получить родительский объект если на вход ничего не поступило
-        lResultList=UIOSelector_Get_UIOList(inUIOSelector, inElement)
-        lIterator = 0
-        for lItem in lResultList:
-            lResultList[lIterator]=UIOEI_Convert_UIOInfo(lResultList[lIterator].element_info)
-            lIterator = lIterator + 1
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_Get_UIOInfoList",
-                            "ArgumentList": [inUIOSelector, inElement],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResultList = lPIPEResponseDict["Result"]
-    return lResultList
-
-####################################################################################################
-#Try to restore (maximize) window, if it's was minimized
-#(особенность uia backend - он не может прицепиться к окну, если оно свернуто)
-#inSpecificationList - UIOSelector
-#old name - PywinautoExtTryToRestore
-
[docs]def UIOSelector_TryRestore_Dict(inSpecificationList):
-    """
-    Try to restore (maximize) window, if it's minimized. (!IMPORTANT! When use UIA framework minimized windows doesn't appear by the UIOSelector. You need to try restore windows and after that try to get UIO)
-
-    :param inSpecificationList: UIOSelector - List of items, which contains condition attributes
-    :return:
-    """
-    lResult={}
-    try:
-        #Подготовка взодного массива
-        inControlSpecificationArray=UIOSelector_SearchUIONormalize_UIOSelector(inSpecificationList)
-        #Выполнить подключение к объекту. Восстановление необходимо только в бэке win32,
-        #так как в uia свернутое окно не распознается
-        lRPAApplication = pywinauto.Application(backend="win32")
-        lRPAApplication.connect(**inSpecificationList[0])
-        lRPAApplication.top_window().restore()
-    except Exception:
-        True==False
-    return lResult

-####################################################################################################
-#Get the list of the UI object activities
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#inControlSpecificationArray - UIOSelector
-#old name - ElementActionGetList
-
[docs]def UIOSelector_Get_UIOActivityList (inUIOSelector):
-    """
-    Get the list of the UI object activities
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :return:
-    """
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Получить объект
-        lObject=UIOSelector_Get_UIO(inUIOSelector)
-        lActionList=dir(lObject)
-        lResult=dir(lObject)
-        #Выполнить чистку списка от неактуальных методов
-        for lActionItem in lActionList:
-            #Удалить те, которые начинаются на _
-            if lActionItem[0]=='_':
-                lResult.remove(lActionItem)
-            #Удалить те, которые начинаются с символа верхнего регистра
-            if lActionItem[0].isupper():
-                lResult.remove(lActionItem)
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_Get_UIOActivityList",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResult = lPIPEResponseDict["Result"]
-    return lResult

-
-####################################################################################################
-#Run the activity in UIO (UI Object)
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#inUIOSelector
-#inActionName - UIOActivity (name) from Pywinauto
-#old name - ElementRunAction
-
[docs]def UIOSelectorUIOActivity_Run_Dict(inUIOSelector, inActionName, inArgumentList=None, inkwArgumentObject=None):
-    """
-    Run the activity in UIO (UI Object)
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :param inActionName: UIOActivity (name) activity name string from Pywinauto
-    :param inArgumentList:
-    :param inkwArgumentObject:
-    :return:
-    """
-    if inArgumentList is None: inArgumentList=[] # 2021 02 22 Minor fix by Ivan Maslov
-    if inkwArgumentObject is None: inkwArgumentObject={} # 2021 02 22 Minor fix by Ivan Maslov
-    lResult={}
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    #Run activity if SafeOtherProcess is None
-    if lSafeOtherProcess is None:
-        #Определить объект
-        lObject=UIOSelector_Get_UIO(inUIOSelector)
-        #Получить метод для вызова
-        lFunction = getattr(lObject, inActionName)
-        #Выполнить действие
-        #Обернуто в безопасную обработку, тк для некоторых объектов метод не работает и может выдавать ошибку типа: NotImplementedError: This method not work properly for WinForms DataGrid, use cells()
-        try:
-            return lFunction(*inArgumentList,**inkwArgumentObject)
-        except Exception as e:
-            #Если ошибка возникла на action get_properties
-            if inActionName=="get_properties":
-                lResult={}
-                #Ручное формирование
-                lResult["class_name"]=lObject.class_name()
-                lResult["friendly_class_name"]=lObject.friendly_class_name()
-                lResult["texts"]=lObject.texts()
-                lResult["control_id"]=lObject.control_id()
-                lResult["control_count"]=lObject.control_count()
-                lResult["automation_id"]=lObject.automation_id()
-                return lResult
-            else:
-                raise e
-    else:
-        #Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelectorUIOActivity_Run_Dict",
-         "ArgumentList": [inUIOSelector, inActionName, inArgumentList, inkwArgumentObject],
-         "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResult = lPIPEResponseDict["Result"]
-    return lResult

-
-####################################################################################################
-#Get the UIO dict of the attributes
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#old name - ElementGetInfo
-
[docs]def UIOSelector_Get_UIOInfo(inUIOSelector):
-    """
-    Get the UIO dict of the attributes
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :return:
-    """
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Подготовка входного массива
-        inUIOSelector=UIOSelector_SearchUIONormalize_UIOSelector(inUIOSelector)
-        #Выполнить идентификацию объектов, если передан массив
-        lResultList=[]
-        if len(inUIOSelector) > 0:
-            #Получить объект
-            lTempObject=UIOSelector_Get_UIO(inUIOSelector)
-            #Получить инфо объект
-            lTempObjectInfo = lTempObject.element_info
-            #Добавить информацию об обнаруженом объекте
-            lResultList.append(UIOEI_Convert_UIOInfo(lTempObjectInfo))
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_Get_UIOInfo",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResultList = lPIPEResponseDict["Result"]
-    return lResultList

-####################################################################################################
-#Search child UIO by the: Parent UIO, X, Y
-#inHierarchyList: [{"index":<>,"element":<>}] - technical argument for internal purpose
-#result -List of dict [{"index":<>,"element":<>}] -- list of element hierarchy specifications
-#old name - GUISearchElementByRootXY
-def UIOXY_SearchChild_ListDict(inRootElement,inX,inY,inHierarchyList=None):
-    if inHierarchyList is None: inHierarchyList = []
-    #Инициализация результирующего значения
-    lResultElement = None
-    lResultElementX1 = None
-    lResultElementX2 = None
-    lResultElementY1 = None
-    lResultElementY2 = None
-    lResultHierarchyList=[{'index':None,'element':None}]
-    #Получить координаты текущего объекта
-    try:
-        lRootElementRectX1=inRootElement.element_info.rectangle.left
-        lRootElementRectX2=inRootElement.element_info.rectangle.right
-        lRootElementRectY1=inRootElement.element_info.rectangle.top
-        lRootElementRectY2=inRootElement.element_info.rectangle.bottom
-        #Добавить объект в результирующий, если координаты попадают в него
-        if inX>=lRootElementRectX1 and inX<=lRootElementRectX2 and inY>=lRootElementRectY1 and inY<=lRootElementRectY2:
-            lResultElement = inRootElement
-            lResultElementX1 = lRootElementRectX1
-            lResultElementX2 = lRootElementRectX2
-            lResultElementY1 = lRootElementRectY1
-            lResultElementY2 = lRootElementRectY2
-            #Сформировать результирующий обьъект
-            lParentHierarchy = inHierarchyList
-            if len(lParentHierarchy)==0:
-                lParentHierarchy.append({"index":None,"element":lResultElement})
-            else:
-                lParentHierarchy[-1]["element"] = lResultElement
-            lResultHierarchyList=lParentHierarchy
-            #Получить список детей и добавить в карту
-            lChildIterator=0
-            for lChildElement in inRootElement.children():
-                #Сформировать результирующий массив
-                lChildFoundedHierarchyList = lParentHierarchy.copy()
-                lChildFoundedHierarchyList.append({'index': lChildIterator})
-                lChildFoundedHierarchyList = UIOXY_SearchChild_ListDict(lChildElement,inX,inY, lChildFoundedHierarchyList)
-                lChildFoundedElement = lChildFoundedHierarchyList[-1]["element"]
-                #Установить обнаруженный элемент, если текущий результат пустой
-                if lResultElement is None and lChildFoundedElement is not None:
-                    lResultElement = lChildFoundedElement
-                    lResultElementX1 = lResultElement.element_info.rectangle.left
-                    lResultElementX2 = lResultElement.element_info.rectangle.right
-                    lResultElementY1 = lResultElement.element_info.rectangle.top
-                    lResultElementY2 = lResultElement.element_info.rectangle.bottom
-                    lResultHierarchyList = lChildFoundedHierarchyList
-                #Выполнить сверку lChildFoundedElement и lResultElement если оба имеются
-                elif lResultElement is not None and lChildFoundedElement is not None: 
-                    #Правила перезатирания карты, если имеется старый объект
-                    #[Накладываемый объект] - НО - ElementNew
-                    #[Имеющийся объект] - ИО - ElementOld
-                    #3 типа вхождения объектов
-                    #тип 1 - [имеющийся объект] полностью входит в [накладываемый объект] (ИО X1 Y1 >= НО X1 Y1; ИО X2 Y2 <= НО X2 Y2) - не вносить НО в bitmap в эти диапазоны
-                    #тип 2 - [имеющийся объект] полностью выходит за пределы [накладываемого объекта] (ИО X1 Y1 < НО X1 Y1; ИО X2 Y2 > НО X2 Y2) - вносить НО в bitmap
-                    #тип 3 - [имеющийся объект] частично входит в [накладываемый объект] (все остальные случаи)- вносить НО в bitmap
-                    #Получить координаты ИО
-                    lChildFoundedElementInfo = lChildFoundedElement.element_info
-                    #lElementNew = inElement
-                    lChildFoundedElementX1 = lChildFoundedElementInfo.rectangle.left
-                    lChildFoundedElementX2 = lChildFoundedElementInfo.rectangle.right
-                    lChildFoundedElementY1 = lChildFoundedElementInfo.rectangle.top
-                    lChildFoundedElementY2 = lChildFoundedElementInfo.rectangle.bottom
-                    #Проверка вхождения по типу 1
-                    if (lResultElementX1>=lChildFoundedElementX1) and (lResultElementY1>=lChildFoundedElementY1) and (lResultElementX2<=lChildFoundedElementX2) and (lResultElementY2<=lChildFoundedElementY2):
-                        False == True
-                    #Проверка вхождения по типу 3
-                    elif (lResultElementX1<lChildFoundedElementX1) and (lResultElementY1<lChildFoundedElementY1) and (lResultElementX2>lChildFoundedElementX2) and (lResultElementY2>lChildFoundedElementY2):
-                        lResultElement = lChildFoundedElement
-                        lResultElementX1 = lChildFoundedElementX1
-                        lResultElementX2 = lChildFoundedElementX2
-                        lResultElementY1 = lChildFoundedElementY1
-                        lResultElementY2 = lChildFoundedElementY2
-                        lResultHierarchyList = lChildFoundedHierarchyList
-                    #Проверка вхождения по типу 2
-                    else:
-                        lResultElement = lChildFoundedElement
-                        lResultElementX1 = lChildFoundedElementX1
-                        lResultElementX2 = lChildFoundedElementX2
-                        lResultElementY1 = lChildFoundedElementY1
-                        lResultElementY2 = lChildFoundedElementY2
-                        lResultHierarchyList = lChildFoundedHierarchyList
-                lChildIterator=lChildIterator+1
-    except Exception as e:
-        False == False
-    return lResultHierarchyList
-
-###################################################################################################
-#Get list of child UIO's by Parent UIOSelector
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#inControlSpecificationArray- UIOSelector
-#old name - ElementGetChildElementList
-
[docs]def UIOSelector_GetChildList_UIOList(inUIOSelector=None, inBackend=mDefaultPywinautoBackend):
-    """
-    Get list of child UIO's by the parent UIOSelector
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :param inBackend: "win32" or "uia"
-    :return:
-    """
-
-
-    if inUIOSelector is None: inUIOSelector = []
-    #mRobotLogger.info(f"File!!!!")
-    #mRobotLogger.info(f"inSelector:{str(inUIOSelector)}, inBackend:{str(inBackend)}")
-    #pdb.set_trace()
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        #Подготовка входного массива
-        inUIOSelector=UIOSelector_SearchUIONormalize_UIOSelector(inUIOSelector)
-        #Выполнить идентификацию объектов, если передан массив
-        lResultList=[]
-        #ctypes.windll.user32.MessageBoxW(0, str(inControlSpecificationArray), "Your title", 1)
-        if len(inUIOSelector) > 0:
-            #Получить объект
-            lTempObject = UIOSelector_Get_UIO(inUIOSelector)
-            #Получить список дочерних объектов
-            lTempChildList = lTempObject.children()
-            lIterator=0
-            #Подготовить результирующий объект
-            for lChild in lTempChildList:
-                lTempObjectInfo=lChild.element_info
-                #Добавить информацию об обнаруженом объекте
-                lObjectInfoItem=UIOEI_Convert_UIOInfo(lTempObjectInfo)
-                #Итератор внутри объекта (для точной идентификации)
-                lObjectInfoItem['ctrl_index']=lIterator
-                lResultList.append(lObjectInfoItem)
-                #Инкремент счетчика
-                lIterator=lIterator+1
-        else:
-            lResultList=BackendStr_GetTopLevelList_UIOInfo(inBackend)
-            #Установка бэк-енда на первый элемент
-            for lItem in lResultList:
-                lItem["backend"]=inBackend
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_GetChildList_UIOList",
-                            "ArgumentList": [inUIOSelector, inBackend],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            lResultList = lPIPEResponseDict["Result"]
-    return lResultList

-
-####################################################################################################
-#Подготовить массив для обращшения к поиску элемементов
-#inControlSpecificationArray - UIOSelector (can be dirty)
-#old name 1 - ElementSpecificationArraySearchPrepare
-#old name 2 - ElementSpecificationListNormalize
-def UIOSelector_SearchUIONormalize_UIOSelector (inControlSpecificationArray):
-    lResult=[]
-    #Циклический обход
-    for lSpecificationItem in inControlSpecificationArray:
-        lSpecificationItemNew=lSpecificationItem.copy()
-        #Перебор всех элементов
-        for lItemKey,lItemValue in lSpecificationItem.items():
-            #Флаг удаления атрибута
-            lFlagRemoveAttribute=False
-            #############################
-            #Если является вложенным словарем - удалить
-            if type(lItemValue) is dict:
-                lFlagRemoveAttribute=True
-            #Является типом None
-            if lItemValue is None:
-                lFlagRemoveAttribute=True
-            #Проверка допустимого ключевого слова
-            if (
-                lItemKey == "class_name" or
-                lItemKey == "class_name_re" or
-                lItemKey == "parent" or
-                lItemKey == "process" or
-                lItemKey == "title" or
-                lItemKey == "title_re" or
-                lItemKey == "top_level_only" or
-                lItemKey == "visible_only" or
-                lItemKey == "enabled_only" or
-                lItemKey == "best_match" or
-                lItemKey == "handle" or
-                lItemKey == "ctrl_index" or
-                lItemKey == "found_index" or
-                lItemKey == "predicate_func" or
-                lItemKey == "active_only" or
-                lItemKey == "control_id" or
-                lItemKey == "control_type" or
-                lItemKey == "auto_id" or
-                lItemKey == "framework_id" or
-                lItemKey == "backend"):
-                True == True
-            else:
-                lFlagRemoveAttribute=True
-
-                
-            #############################
-            #Конструкция по удалению ключа из словаря
-            if lFlagRemoveAttribute:
-                lSpecificationItemNew.pop(lItemKey)
-        #Проверит наличие ctrl_index - если он есть, то удалить control_id и control_type из-за того, что они мешают друг другу
-        if 'ctrl_index' in lSpecificationItemNew:
-            if "control_id" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_id")
-            if "control_type" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_type")
-        #Проверить наличие handle - если он есть, то удалить process, control_id и control_type из-за того, что они мешают друг другу
-        if 'handle' in lSpecificationItemNew:
-            if "control_id" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_id")
-            if "control_type" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_type")
-            if "process" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("process")
-        #Иначе Проверить наличие process - если он есть, то удалить тк он нужен только при подключении к процессу
-        if 'process' in lSpecificationItemNew:
-            lSpecificationItemNew.pop("process")
-        #Добавить строку в результирующий массив
-        lResult.append(lSpecificationItemNew)
-    #Вернуть результат
-    return lResult
-####################################################################################################
-#Подготовить массив для обращшения к поиску процесса (отличается от поиска элемента, тк данная функция нужна для нормализации спецификации для подключения к процессу с окнами)
-#inControlSpecificationArray - UIOSelector (can be dirty)
-#old name 1 - ElementSpecificationArraySearchPrepare
-#old name 2 - ElementSpecificationListNormalize
-def UIOSelector_SearchProcessNormalize_UIOSelector (inControlSpecificationArray):
-    lResult=[]
-    #Циклический обход
-    for lSpecificationItem in inControlSpecificationArray:
-        lSpecificationItemNew=lSpecificationItem.copy()
-        #Перебор всех элементов
-        for lItemKey,lItemValue in lSpecificationItem.items():
-            #Флаг удаления атрибута
-            lFlagRemoveAttribute=False
-            #############################
-            #Если является вложенным словарем - удалить
-            if type(lItemValue) is dict:
-                lFlagRemoveAttribute=True
-            #Является типом None
-            if lItemValue is None:
-                lFlagRemoveAttribute=True
-            #Проверка допустимого ключевого слова
-            if (
-                lItemKey == "class_name" or
-                lItemKey == "class_name_re" or
-                lItemKey == "parent" or
-                lItemKey == "process" or
-                lItemKey == "title" or
-                lItemKey == "title_re" or
-                lItemKey == "top_level_only" or
-                lItemKey == "visible_only" or
-                lItemKey == "enabled_only" or
-                lItemKey == "best_match" or
-                lItemKey == "handle" or
-                lItemKey == "ctrl_index" or
-                lItemKey == "found_index" or
-                lItemKey == "predicate_func" or
-                lItemKey == "active_only" or
-                lItemKey == "control_id" or
-                lItemKey == "control_type" or
-                lItemKey == "auto_id" or
-                lItemKey == "framework_id" or
-                lItemKey == "backend"):
-                True == True
-            else:
-                lFlagRemoveAttribute=True
-
-                
-            #############################
-            #Конструкция по удалению ключа из словаря
-            if lFlagRemoveAttribute:
-                lSpecificationItemNew.pop(lItemKey)
-        #Проверит наличие ctrl_index - если он есть, то удалить control_id и control_type из-за того, что они мешают друг другу
-        if 'ctrl_index' in lSpecificationItemNew:
-            if "control_id" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_id")
-            if "control_type" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_type")
-        #Проверить наличие handle - если он есть, то удалить process, control_id и control_type из-за того, что они мешают друг другу
-        if 'handle' in lSpecificationItemNew:
-            if "control_id" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_id")
-            if "control_type" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_type")
-            if "process" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("process")
-        #Иначе Проверить наличие process - если он есть, то удалить title, control_id и control_type из-за того, что они мешают друг другу
-        elif 'process' in lSpecificationItemNew:
-            if "control_id" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_id")
-            if "control_type" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("control_type")
-            if "title" in lSpecificationItemNew:
-                lSpecificationItemNew.pop("title")
-        #Добавить строку в результирующий массив
-        lResult.append(lSpecificationItemNew)
-    #Вернуть результат
-    return lResult
-####################################################################################################
-#Transfer UI object element info (pywinauto) to UIOInfo (dict of attributes)
-#inElementInfo - UIOEI
-#old name - ElementInfoExportObject
-def UIOEI_Convert_UIOInfo(inElementInfo):
-    #Подготовить выходную структуру данных
-    lResult = {"title":None,"rich_text":None,"process_id":None,"process":None,"handle":None,"class_name":None,"control_type":None,"control_id":None,"rectangle":{"left":None,"top":None,"right":None,"bottom":None}, 'runtime_id':None}
-    #Проверка name
-    try:
-        lResult['title']=inElementInfo.name
-    except Exception as e:
-        True == False
-    #Проверка rich_text
-    try:
-        lResult['rich_text']=inElementInfo.rich_text
-    except Exception as e:
-        True == False
-    #Проверка process_id
-    try:
-        lResult['process_id']=inElementInfo.process_id
-        lResult['process']=inElementInfo.process_id
-    except Exception as e:
-        True == False
-    #Проверка handle
-    try:
-        lResult['handle']=inElementInfo.handle
-    except Exception as e:
-        True == False
-    #Проверка class_name
-    try:
-        lResult['class_name']=inElementInfo.class_name
-    except Exception as e:
-        True == False
-    #Проверка control_type
-    try:
-        lResult['control_type']=inElementInfo.control_type
-    except Exception as e:
-        True == False
-    #Проверка control_id
-    try:
-        if inElementInfo.control_id!=0:
-            lResult['control_id']=inElementInfo.control_id
-    except Exception as e:
-        True == False
-    #Проверка rectangle left
-    try:
-        lResult['rectangle']['left']=inElementInfo.rectangle.left
-    except Exception as e:
-        True == False
-    #Проверка rectangle right
-    try:
-        lResult['rectangle']['right']=inElementInfo.rectangle.right
-    except Exception as e:
-        True == False
-    #Проверка rectangle top
-    try:
-        lResult['rectangle']['top']=inElementInfo.rectangle.top
-    except Exception as e:
-        True == False
-    #Проверка rectangle bottom
-    try:
-        lResult['rectangle']['bottom']=inElementInfo.rectangle.bottom
-    except Exception as e:
-        True == False
-    #Проверка runtime_id
-    try:
-        lResult['runtime_id']=inElementInfo.runtime_id
-    except Exception as e:
-        True == False
-    #Вернуть результат
-    return lResult
-
-###################################################################################################
-#Get list of top level
-#old name - GetRootElementList
-def BackendStr_GetTopLevelList_UIOInfo(inBackend=mDefaultPywinautoBackend):
-    #Получить список объектов
-    lResultList=pywinauto.findwindows.find_elements(top_level_only=True,backend=inBackend)    
-    lResultList2=[]
-    for lI in lResultList:
-        lTempObjectInfo=lI
-        lResultList2.append(UIOEI_Convert_UIOInfo(lI))
-    return lResultList2
-
-###################################################################################################
-#Highlight the UI object
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#old name - ElementDrawOutlineNew
-
[docs]def UIOSelector_Highlight(inUIOSelector):
-    """
-    Highlight (draw outline) the element (in app) by the UIO selector.
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :return:
-    """
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        UIO_Highlight(UIOSelector_Get_UIO(inUIOSelector))
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_Highlight",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            return lPIPEResponseDict["Result"]
-    return True

-
-###################################################################################################
-#inSpecificationArray - UIOSelector
-#!!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!!
-#old name - ElementDrawOutlineNewFocus
-
[docs]def UIOSelector_FocusHighlight(inUIOSelector):
-    """
-    Set focus and highlight (draw outline) the element (in app) by the UIO selector.
-
-    :param inUIOSelector: UIOSelector - List of items, which contains condition attributes
-    :return:
-    """
-
-    #Check the bitness
-    lSafeOtherProcess = UIOSelector_SafeOtherGet_Process(inUIOSelector)
-    if lSafeOtherProcess is None:
-        UIO_FocusHighlight(UIOSelector_Get_UIO(inUIOSelector))
-    else:
-        # Run function from other process with help of PIPE
-        lPIPEResuestDict = {"ModuleName": "UIDesktop", "ActivityName": "UIOSelector_FocusHighlight",
-                            "ArgumentList": [inUIOSelector],
-                            "ArgumentDict": {}}
-        # Отправить запрос в дочерний процесс, который отвечает за работу с Windows окнами
-        ProcessCommunicator.ProcessChildSendObject(lSafeOtherProcess, lPIPEResuestDict)
-        # Get answer from child process
-        lPIPEResponseDict = ProcessCommunicator.ProcessChildReadWaitObject(lSafeOtherProcess)
-        if lPIPEResponseDict["ErrorFlag"]:
-            raise Exception(
-                f"Exception was occured in child process (message): {lPIPEResponseDict['ErrorMessage']}, (traceback): {lPIPEResponseDict['ErrorTraceback']}")
-        else:
-            return lPIPEResponseDict["Result"]
-    return True

-
-###################################################################################################
-#old name - draw_outline_new
-def UIO_Highlight(lWrapperObject,colour='green',thickness=2,fill=win32defines.BS_NULL,rect=None,inFlagSetFocus=False):
-    if lWrapperObject is not None:
-        """
-        Draw an outline around the window.
-        * **colour** can be either an integer or one of 'red', 'green', 'blue'
-        (default 'green')
-        * **thickness** thickness of rectangle (default 2)
-        * **fill** how to fill in the rectangle (default BS_NULL)
-        * **rect** the coordinates of the rectangle to draw (defaults to
-          the rectangle of the control)
-        """
-        if inFlagSetFocus:
-            #Установить фокус на объект, чтобы было видно выделение
-            lWrapperObject.set_focus()
-            time.sleep(0.5)
-        # don't draw if dialog is not visible
-        #if not lWrapperObject.is_visible():
-        #    return
-        colours = {
-            "green": 0x00ff00,
-            "blue": 0xff0000,
-            "red": 0x0000ff,
-        }
-        # if it's a known colour
-        if colour in colours:
-            colour = colours[colour]
-        if rect is None:
-            rect = lWrapperObject.rectangle()
-        # create the pen(outline)
-        pen_handle = win32functions.CreatePen(
-                win32defines.PS_SOLID, thickness, colour)
-        # create the brush (inside)
-        brush = win32structures.LOGBRUSH()
-        brush.lbStyle = fill
-        brush.lbHatch = win32defines.HS_DIAGCROSS
-        brush_handle = win32functions.CreateBrushIndirect(ctypes.byref(brush))
-        # get the Device Context
-        dc = win32functions.CreateDC("DISPLAY", None, None, None )
-        # push our objects into it
-        win32functions.SelectObject(dc, brush_handle)
-        win32functions.SelectObject(dc, pen_handle)
-        # draw the rectangle to the DC
-        win32functions.Rectangle(
-            dc, rect.left, rect.top, rect.right, rect.bottom)
-        # Delete the brush and pen we created
-        win32functions.DeleteObject(brush_handle)
-        win32functions.DeleteObject(pen_handle)
-        # delete the Display context that we created
-        win32functions.DeleteDC(dc)
-
-###################################################################################################
-#Аналог подсвечивания + установка фокуса
-#old name - draw_outline_new_focus
-def UIO_FocusHighlight(lWrapperObject,colour='green',thickness=2,fill=win32defines.BS_NULL,rect=None):
-    UIO_Highlight(lWrapperObject,'green',2,win32defines.BS_NULL,None,True)
-
-#Определить разрядность процесса
-lProcessBitnessStr = str(struct.calcsize("P") * 8)
-
-
-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Tools/StopSafe.html b/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Tools/StopSafe.html deleted file mode 100644 index b3a2c72c..00000000 --- a/Wiki/ENG_Guide/html/_modules/pyOpenRPA/Tools/StopSafe.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - pyOpenRPA.Tools.StopSafe — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Module code »
    • - -
  • pyOpenRPA.Tools.StopSafe
    • - - -
  • - -
    • - -
- - -
-
-
-
- -

Source code for pyOpenRPA.Tools.StopSafe

-"""
-# How to use
-# from pyOpenRPA.Tools import StopSafe
-# StopSafe.Init(inLogger=None)
-# StopSafe.IsSafeStop() # True - WM_CLOSE SIGNAL has come. taskkill /im someprocess.exe
-"""
-
-
-import win32con
-import win32gui
-import os
-gIsSignalCloseBool = False
-gLogger = None
-gWindowTitleStr = "PythonTerminator" # Title of the phantom window
-gWindowDescriptionStr = "pyOpenRPA library for safe turn off the program (by send the WM_CLOSE signal from task kill)" # Description of the phantom window
-
-
[docs]def Init(inLogger=None):
-    """
-    Init the StopSafe module. After that you can use def IsStopSafe() to check if close signal has come.
-
-    :param inLogger: Logger to log messages about StopSafe
-    :return:
-    """
-    global gLogger
-    global gIsSignalCloseBool
-    gIsSignalCloseBool = False # Init default
-    gLogger = inLogger
-    import threading
-    if gLogger: gLogger.info(f"StopSafe: Init termination catch thread")
-    shutdown_thread = threading.Thread(target=_shutdown_monitor)
-    shutdown_thread.start()

-    #shutdown_thread.join()
-    #shutdown_monitor()
-    
-
-
[docs]def IsStopSafe():
-    """
-    Check if stop signal has come.
-
-    :return:
-    """
-    global gIsSignalCloseBool # Init the global variable
-    return gIsSignalCloseBool # Return the result

-
-def _shutdown_monitor():
-    global gIsSignalCloseBool # Init the global variable
-    global gLogger
-    def wndproc(hwnd, msg, wparam, lparam):
-        if msg == win32con.WM_CLOSE:
-            win32gui.DestroyWindow(hwnd)
-            return 0
-        elif msg == win32con.WM_DESTROY:
-            win32gui.PostQuitMessage(0)
-            return 0
-        return win32gui.DefWindowProc(hwnd, msg, wparam, lparam)
-    wc = win32gui.WNDCLASS()
-    wc.lpszClassName = gWindowTitleStr
-    wc.lpfnWndProc = wndproc
-    win32gui.RegisterClass(wc)
-    hwnd = win32gui.CreateWindow(gWindowTitleStr, gWindowDescriptionStr,
-                0, 0, 0, 0, 0, 0, 0, 0, None)
-    win32gui.PumpMessages()
-    gIsSignalCloseBool = True # WM_CLOSE message has come
-    if gLogger:
-        gLogger.info(f"StopSafe: Program has catch VM_CLOSE signal - do safe exit")
-    
-
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/01_HowToInstall.rst.txt b/Wiki/ENG_Guide/html/_sources/01_HowToInstall.rst.txt deleted file mode 100644 index 50ca1f9e..00000000 --- a/Wiki/ENG_Guide/html/_sources/01_HowToInstall.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -#################################### -1. How to install -#################################### - -Are you ready to install the pyOpenRPA solution on your machine? - -Ok, we start. -**Do the following operations:** - -- Download the pyOpenRPA package from master branch on GitLab [Download ZIP](https://gitlab.com/UnicodeLabs/OpenRPA/-/archive/master/OpenRPA-master.zip) -- Unzip the package - -**Installation has been completed :)** - -************************************************** -How to check installation -************************************************** -- Run portable python (built in the pyOpenRPA) - - - x32 python (GIT\\Resources\\WPy32-3720\\python-3.7.2\\python.exe) - - x64 python (GIT\\Resources\\WPy64-3720\\python-3.7.2.amd64\\python.exe) - -**The pyOpenRPA has been successfully installed if the portable python 3.7.2 was started without any exceptions (see screenshot).** - -.. image:: /img/cb5dec8cecafa7d64f6cd14b2672acce.png - :alt: cb5dec8cecafa7d64f6cd14b2672acce.png - -************************************************** -System requirements -************************************************** -- OS Windows 7+. *Need Windows package KB2999226 if use windows Vista/7/8/8.1/Server 2008/Server 2012 (https://support.microsoft.com/ru-ru/help/2999226)* -- For OpenCV: OS Windows 7/8/8/10 only (no Windows Server) \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/02_RoadMap.rst.txt b/Wiki/ENG_Guide/html/_sources/02_RoadMap.rst.txt deleted file mode 100644 index 5eee7ac3..00000000 --- a/Wiki/ENG_Guide/html/_sources/02_RoadMap.rst.txt +++ /dev/null @@ -1,22 +0,0 @@ -#################################### -2. Roadmap -#################################### - -- Guide - - ENG - done 2021.03.11 - - HTML `|OPEN GITLAB| `_ - - MarkDown `|OPEN GITLAB| `_ - - PDF `[|OPEN GITLAB|] `_ - - RUS - queue - -- Tutorial - - ENG - queue - - RUS - in progress - - Article: Less cost - no paid RPA `|OPEN HABR| `_ - - Tutorial Desktop UI `|OPEN HABR| `_; `|OPEN GITLAB| `_ - - Tutorial Web UI `|OPEN HABR| `_; `|OPEN GITLAB| `_ - - Article: RPA as a core of the IT automation - soon -- Leaflet - - ENG queue - - RUS done 2021.02.23 - - RUS Leaflet pyOpenRPA v4.pdf `|OPEN GITLAB| `_ diff --git a/Wiki/ENG_Guide/html/_sources/03_Copyrights_Contacts.rst.txt b/Wiki/ENG_Guide/html/_sources/03_Copyrights_Contacts.rst.txt deleted file mode 100644 index b02d3ee3..00000000 --- a/Wiki/ENG_Guide/html/_sources/03_Copyrights_Contacts.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -.. _3.-Copyrights-&-Contacts: - -#################################### -3. Copyrights & Contacts -#################################### - -pyOpenRPA is created by Ivan Maslov (Russia). -Hosted by PYOPENRPA LLC (Russia) - -My purpose is to create #IT4Business models in the companies. -I can help you to create the new #IT4Business in your company. -#IT4Business homepage - https://www.facebook.com/RU.IT4Business -#IT4Busines is the methodology which is created for build compact fast and reliable IT function in company. -If you has many IT specialists, very long deadlines for the IT tasks, many bugs in IT software - #IT4Business is for you :) - -If you need some IT help - feel free to contact me (prefer e-mail or skype). -If you will find some issue in pyOpenRPA - write about it to me via e-mail/skype/gitlab issue. - -Thank you! - -************************************************** -Ivan Maslov (founder) -************************************************** -- E-mail: Ivan.Maslov@UnicodeLabs.ru - -- Skype: MegaFinder - -- Facebook: https://www.facebook.com/RU.IT4Business - -- LinkedIn: https://www.linkedin.com/in/RU-IvanMaslov/ - -- WhatsApp | Telegram: +7 906 722 39 25 - - -************************************************** -3-rd party components license dependencies -************************************************** -- WinPython 3.7.1 32-bit & 64-bit, license MIT (https://github.com/winpython/winpython) -- Selenium v..., license Apache 2.0 -- pywinauto 0.6.5, license BSD 3-Clause (https://github.com/pywinauto/pywinauto) -- Semantic UI ..., license MIT (https://github.com/Semantic-Org/Semantic-UI) -- PyAutoGUI ..., license BSD 3-Clause (https://github.com/asweigart/pyautogui) -- keyboard ..., license MIT (https://github.com/boppreh/keyboard) -- pywin32 \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/Agent/02_Defs.rst.txt b/Wiki/ENG_Guide/html/_sources/Agent/02_Defs.rst.txt deleted file mode 100644 index 64850fbb..00000000 --- a/Wiki/ENG_Guide/html/_sources/Agent/02_Defs.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -#################################### -2. Defs -#################################### - -************************************************** -pyOpenRPA.Agent.__Agent__ -************************************************** - - - -.. automodule:: pyOpenRPA.Agent.__Agent__ - :members: - :autosummary: - - -********** -References -********** - -`reStructuredText`_ - -.. target-notes:: -.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/01_Orchestrator.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/01_Orchestrator.rst.txt deleted file mode 100644 index 6004515a..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/01_Orchestrator.rst.txt +++ /dev/null @@ -1,90 +0,0 @@ -#################################### -1. Description -#################################### - -pyOpenRPA Orchestrator is the executable process. - -The features of the orchestrator is: -- Centralized/decentralized user control interface (applicable and for business users and for technical users). Web based, support desktop, tablet, phone. -- Automatized robots control (customized algorithms, robots scheduling) -- Source code mega flexibility: Light Orchestrator architecture is good for own customization - -************************************ -Global settings dict concept -************************************ -pyOpenRPA project is complex tool which consist of several executable modules such as Robot, Orchestrator, Studio, - -Because of module compexity, we use 1 init arg - inGSettings -inGSettings is a complex dictionary which has all reqired parameters for the module execution. - -The description of the GSettings you can find in executable module details. - -************************************ -Orchestrator how to configure -************************************ - - -To init pyOpenRPA Orchestrator instance use script: - -from pyOpenRPA import Orchestrator # Import orchestrator main -gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration -Orchestrator.Orchestrator(inGSettings=gSettings) # Call the orchestrator def - -gSettings structure - - -************************************ -Orchestrator architecture -************************************ -Orchestrator has several source code components: -- User/robot activity consolidated queue single thread (Processor) -- User/robot activity asynchonus many threads (Processor) -- Scheduler single thread (main) -- RDP keep active many thread -- Autocleaner single thread -- GUI keep active single thread -- HTTP web server single thread (create user socket threads) -- - -Below you can find more information about all of the component. - -*************************** -Component Processor -*************************** -Sync - Append activity list to consolidated processor queue. Execution goes sequency by the activity list order - -Async - Create New thread to execute the activity list - -- Activity list - -List of the activity item - -- Activity item - -Activity item is universal mechanism to execute different algorythms from any sources. -The core feature of the Activity is to call python defs with args and kwargs. -If you need to init do some activity you can write some python def, then create Activity item with current def. -ATTENTION: In some cases (such as web transmition), when you can't transmit python def as object you can use symbolic names for python defs. It is apply you to init all of you want from the web UI. - -?Why i cant transmit python def from the web -Because the WEB space is not the Python executable space. Interaction between it spaces create by JSON protocol. So, we know than JSON apply int, float, str, bool, None, list, dict - that is all. - -.. note:: - Example - { - "Def":"DefAliasTest", # def link or def alias (look gSettings["Processor"]["AliasDefDict"]) - "ArgList":[1,2,3], # Args list - "ArgDict":{"ttt":1,"222":2,"dsd":3}, # Args dictionary - "ArgGSettings": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - }# Pay attention! Do not left comma symbol after the end of the dict - it can be interpretated like a turple.. - - -********** -References -********** - -`Python-sphinx`_ - -.. target-notes:: -.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt deleted file mode 100644 index e9857c70..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/02_Defs.rst.txt +++ /dev/null @@ -1,88 +0,0 @@ -#################################### -2. Defs -#################################### - -************************************************** -pyOpenRPA.Orchestrator.__Orchestrator__ -************************************************** - -.. code-block:: python - - # EXAMPLE 1 - from pyOpenRPA import Orchestrator - Orchestrator.OSCMD(inCMDStr = "git status", inRunAsyncBool=True) - - # EXAMPLE 2 - from pyOpenRPA.Orchestrator import __Orchestrator__ - __Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True) - - - -Group Agent... -###################### -Interaction between Orchestrator and pyOpenRPA.Agent daemon process, which can be deployed in another user session. - -Group GSettings... -###################### -Basic defs to work with singleton gSettings. - -Group Storage... -###################### -Defs to work with special locations in Orchestrator: Robot, User (TODO), User + Robot (TODO) - -Group OS... -###################### -Interaction with shell on the Orchestrator user session. - -Group Process... -###################### -Interaction with some process on the Orchestrator user session. - -Group Processor... -###################### -Work with Processor queue (see ...). - -Group Python... -###################### -Work with extra python modules. - -Group RDPSession... -###################### -Interaction with RDP session, where you can manage some robots. - -Group Web... -###################### -Manipulate the Orchestrator WEB side. - -Group UAC... -###################### -Manipulate the User Access Controls (actual for the Orchestrator WEB access for the business users) - -Group Scheduler... -###################### -Work with activity scheduling. - - -.. automodule:: pyOpenRPA.Orchestrator.__Orchestrator__ - :members: - :autosummary: - - -************************************************** -pyOpenRPA.Orchestrator.Web.Basic -************************************************** - -.. automodule:: pyOpenRPA.Orchestrator.Web.Basic - :members: - :autosummary: - - - -********** -References -********** - -`reStructuredText`_ - -.. target-notes:: -.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/03_gSettingsTemplate.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/03_gSettingsTemplate.rst.txt deleted file mode 100644 index 4efe8d47..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/03_gSettingsTemplate.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. _gSettingsTemplate: -************************ -3. gSettings Template -************************ - -gSettings structure - -.. include:: ../../pyOpenRPA/Orchestrator/SettingsTemplate.py - :literal: \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToUse.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToUse.rst.txt deleted file mode 100644 index 392bc9cf..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/04_HowToUse.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -************************ -4. How to use -************************ - -You need to run orchestrator process? - -.. code-block:: python - - if __name__ == "__main__": # New init way - allow run as module -m PyOpenRPA.Orchestrator - from pyOpenRPA import Orchestrator # Import orchestrator main - gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration - no more config is available from the box - you can create own - # Call the orchestrator main def - Orchestrator.Orchestrator(inGSettings=gSettings) - - -If you need more configurations - so you can see here: - -.. include:: ../../../Orchestrator/OrchestratorSettings.py - :literal: diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/05_UAC.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/05_UAC.rst.txt deleted file mode 100644 index e7f5e58a..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/05_UAC.rst.txt +++ /dev/null @@ -1,58 +0,0 @@ -#################################### -5. UAC - User Access Control -#################################### - -***************** -About -***************** -Orchestrator has mega feature - user access control (UAC). This feature allow you to manipulate access of the web UI for the all users! - -If you need to give admin rights - you don't customize UAC dict. - -If you need to give some little rights for user only for one robot in orchestrator web panel - you can set the following properties in UAC dict. - -To work with UAC you can use defs ``Orchestrator.UAC`` group. - -!!!ATTENTION!!! - -Need practice example to work with UAC! - too hard to understand - -*************************************************** -UAC Dict for Orchestrator WEB UI rights -*************************************************** - -UAC Dict for pyOpenRPA Orchestrator WEB UI rights. - -.. code-block:: python - - "pyOpenRPADict":{ - "CPKeyDict":{ # Empty dict - all access - # "CPKeyStr"{ - # } - }, - "RDPKeyDict":{ # Empty dict - all access - #"RDPKeyStr"{ - # "FullscreenBool": True, - # "IgnoreBool":True, - # "ReconnectBool": True - # "NothingBool": True # USe option if you dont want to give some access to the RDP controls - # } - }, - "AgentKeyDict": { # Empty dict - all access - # "AgentKeyStr"{ - # } - }, - "AdminDict":{ # Empty dict - all access - "LogViewerBool":True, # Show log viewer on the web page - "CMDInputBool":True, # Execute CMD on the server side and result to the logs - "ScreenshotViewerBool":True, # Show button to look screenshots - "RestartOrchestratorBool": True, # Restart orchestrator activity - "RestartOrchestratorGITPullBool": True, # Turn off (RDP remember) orc + git pull + Turn on (rdp remember) - "RestartPCBool": True, # Send CMD to restart pc - "NothingBool":True # USe option if you dont want to give some access to the RDP controls - }, - "ActivityDict": { # Empty dict - all access - "ActivityListExecuteBool": True, # Execute activity at the current thread - "ActivityListAppendProcessorQueueBool": True # Append activity to the processor queue - } - } \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/Orchestrator/06_Defs Managers.rst.txt b/Wiki/ENG_Guide/html/_sources/Orchestrator/06_Defs Managers.rst.txt deleted file mode 100644 index 060b8528..00000000 --- a/Wiki/ENG_Guide/html/_sources/Orchestrator/06_Defs Managers.rst.txt +++ /dev/null @@ -1,52 +0,0 @@ -#################################### -6. Defs Managers -#################################### - -************************************************** -Process (General) -************************************************** - -.. code-block:: python - - # EXAMPLE - from pyOpenRPA.Orchestrator import Orchestrator - lProcess = Orchestrator.Managers.Process(inAgentHostNameStr="PC-DESKTOP",inAgentUserNameStr="ND", inProcessNameWOExeStr="notepad",inStartCMDStr="notepad") - - -.. automodule:: pyOpenRPA.Orchestrator.Managers.Process - :members: - :autosummary: - - -************************************************** -Process (Details) -************************************************** - -.. automodule:: pyOpenRPA.Orchestrator.Managers.Process - :members: - :autosummary: - - -************************************************** -ControlPanel (General) -************************************************** - -.. code-block:: python - - # EXAMPLE - from pyOpenRPA.Orchestrator import Orchestrator - lCP = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestTTT",inRefreshHTMLJinja2TemplatePathStr="ControlPanel\\test.html", inJinja2TemplateRefreshBool = True) - - -.. automodule:: pyOpenRPA.Orchestrator.Managers.ControlPanel - :members: - :autosummary: - - -************************************************** -ControlPanel (Details) -************************************************** - -.. automodule:: pyOpenRPA.Orchestrator.Managers.ControlPanel - :members: - :autosummary: diff --git a/Wiki/ENG_Guide/html/_sources/Robot/01_Robot.rst.txt b/Wiki/ENG_Guide/html/_sources/Robot/01_Robot.rst.txt deleted file mode 100644 index 20aa95d2..00000000 --- a/Wiki/ENG_Guide/html/_sources/Robot/01_Robot.rst.txt +++ /dev/null @@ -1,22 +0,0 @@ -************************ -1. Description -************************ - -pyOpenRPA Robot is the python package which allow you to create best RPA program. - -The description of the functions you can find page 'Defs' (see menu) - -Here is the example of the pyOpenRPA usage. - -.. code-block:: python - - # EXAMPLE 1 - from pyOpenRPA.Robot import UIDesktop - - lNotepadOKButton = UIDesktop.UIOSelector_Get_UIO( - inSpecificationList=[ - {"title":"notepad.exe"},{"title":"OK"}], - inElement=None, - inFlagRaiseException=True) - - lNotepadOKButton.click() diff --git a/Wiki/ENG_Guide/html/_sources/Robot/02_Defs.rst.txt b/Wiki/ENG_Guide/html/_sources/Robot/02_Defs.rst.txt deleted file mode 100644 index 6d7093a8..00000000 --- a/Wiki/ENG_Guide/html/_sources/Robot/02_Defs.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -#################################### -2. Defs -#################################### - -Here you can find the functions description for interaction with desktop GUI applications - -How to use both x32 and x64 python processes (it can be helpfully, if another app GUI is on another bitness than your app) - -.. code-block:: python - - from pyOpenRPA.Robot import UIDesktop - #Section for robot init - lPyOpenRPA_SettingsDict = { - "Python32FullPath": "..\\Resources\\WPy32-3720\\python-3.7.2\\python.exe", #Set from user: "..\\Resources\\WPy32-3720\\python-3.7.2\\OpenRPARobotGUIx32.exe" - "Python64FullPath": "..\\Resources\\WPy64-3720\\python-3.7.2.amd64\\python.exe", #Set from user - "Python32ProcessName": "pyOpenRPA_UIDesktopX32.exe", #Config set once - "Python64ProcessName": "pyOpenRPA_UIDesktopX64.exe" #Config set once - } - # Init the pyOpenRPA configuration - UIDesktop.Utils.ProcessBitness.SettingsInit(lPyOpenRPA_SettingsDict) - # Now you can use pyOpenRPA with both bitness. - - -.. automodule:: pyOpenRPA.Robot.UIDesktop - :members: - :autosummary: - - -********** -References -********** - -`reStructuredText`_ - -.. target-notes:: -.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html diff --git a/Wiki/ENG_Guide/html/_sources/Robot/03_HowToUse.rst.txt b/Wiki/ENG_Guide/html/_sources/Robot/03_HowToUse.rst.txt deleted file mode 100644 index 349bf194..00000000 --- a/Wiki/ENG_Guide/html/_sources/Robot/03_HowToUse.rst.txt +++ /dev/null @@ -1,226 +0,0 @@ -#################################### -3. How to use -#################################### - -The Robot tool is the main module for production process automation. It has no graphic/console interface. All low-level actions to OS are perfoming by the Robot tool in pyOpenRPA. - -************************************************** -How to execute RPA script -************************************************** -You can use the robot by the several ways: - -- In Python script -- In Studio script (n/a) - - -Create python script -############################################ -In order to use robot just add Robot tool folder in work directory and add line "import GUI" in your script. - - -.. code-block:: python - - import sys - sys.path.append('../../') - import selenium # [Web app access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.1.-Theory-&-practice:-Web-app-access-(Chrome,-Firefox,-Opera))
- import GUI # [Win32 & UI Automation access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.2.-Theory-&-practice:-Desktop-app-UI-access-(win32-and-UI-automation-dlls))
- import pyautogui #[Screen capture/recognition](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition) [#Mouse manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
- import cv2 # [Computer vision](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition)
- import keyboard #[Keyboard manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
- -Execute python script -############################################ - -The pyOpenRPA is fully portable solution. It contains own python enviroment both 32 and 64 bit versions. So, you can execute your python script in several ways: -- Execute in python x32 (\OpenRPA\Resources\WPy32-3720\python-3.7.2) -- Execute in python x64 (\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64) -- Execute from .cmd file - -Execute in the Python x32 -############################################ - -To execute your python script in x32 bit version just write in command line from x32 python directory: - -.. code-block:: python - - cd "\OpenRPA\Resources\WPy32-3720\python-3.7.2" - python.exe "path to your python script.py" - -Execute in the Python x64 -############################################ - -To execute your python script in x32 bit version just write in command line from x32 python directory: - -.. code-block:: python - - cd "\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64" - python.exe "path to your python script.py" - -Execute from .cmd file -############################################ - -In order to simplify the execution process you can write several code lines in file with the .cmd extension: - -.. code-block:: python - - cd %~dp0 - copy /Y ..\Resources\WPy32-3720\python-3.7.2\python.exe ..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe - .\..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe orchestratorMain.py - pause >nul - - -Use in studio script (n/a) -############################################ -.. code-block:: python - - import sys - sys.path.append('../../') - import GUI - import keyboard - import subprocess - import time - - #Highlight the UI Object in Folder explorer - GUI.UIOSelector_FocusHighlight([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]) - - #Wait 2 seconds - time.sleep(3) - - #Loop: get child element of UI List - for lItem in GUI.UIOSelector_Get_UIO([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]).children(): - print(str(lItem)) - - - -Here you can find the docs and examples of the OpenRPA desktop (GUI) app access. - -**************************************************************************************************** -Desktop app UI access (win32 and UI automation dlls) -**************************************************************************************************** - -Definitions -############################################ - -- **UIO** - UI Object (class of pywinauto UI object) [pywinauto.base_wrapper] -- **UIOSelector** - List of dict (key attributes) -- **PWA** - PyWinAuto -- **PWASpecification** - List of dict (key attributes in pywinauto.find_window notation) -- **UIOTree** - Recursive Dict of Dict ... (UI Parent -> Child hierarchy) -- **UIOInfo** - Dict of UIO attributes -- **UIOActivity** - Activity of the UIO (UI object) from the Pywinauto module -- **UIOEI** - UI Object info object - - -What is UIO? -############################################ -UIO is a User Interface Object (pyOpenRPA terminology). For maximum compatibility, this instance is inherited from the object model developed in the [pywinauto library (click to get a list of available class functions)](https://pywinauto.readthedocs.io/en/latest/code/pywinauto.base_wrapper.html). - -This approach allows us to implement useful functionality that has already been successfully developed in other libraries, and Supplement it with the missing functionality. In our case, the missing functionality is the ability to dynamically access UIO objects using UIO selectors. - - -UIOSelector structure & example -############################################ -UIOSelector is the list of condition items for the UIO in GUI. Each item has condition attributes for detect applicable UIO. Here is the description of the available condition attributes in item. - -**Desciption** - -.. code-block:: python - - [ - { - "depth_start" :: [int, start from 1] :: the depth index, where to start check the condition list (default 1), - "depth_end" :: [int, start from 1] :: the depth index, where to stop check the condition list (default 1), - "ctrl_index" || "index" :: [int, starts from 0] :: the index of the UIO in parent UIO child list, - "title" :: [str] :: the condition for the UIO attribute *title*, - "title_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *title*, - "rich_text" :: [str] :: the condition for the UIO attribute *rich_text*, - "rich_text_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *rich_text*, - "class_name" :: [str] :: the condition for the UIO attribute *class_name*, - "class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *class_name*, - "friendly_class_name" :: [str] :: the condition for the UIO attribute *friendly_class_name*, - "friendly_class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *friendly_class_name*, - "control_type" :: [str] :: the condition for the UIO attribute *control_type*, - "control_type_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *control_type*, - "is_enabled" :: [bool] :: the condition for the UIO attribute *is_enabled*. If UI object is enabled on GUI, - "is_visible" :: [bool] :: the condition for the UIO attribute *is_visible*. If UI object is visible on GUI, - "backend" :: [str, "win32" || "uia"] :: the method of UIO extraction (default "win32"). ATTENTION! Current option can be only for the first item of the UIO selector. For the next items this option will be implemented from the first item. - }, - { ... specification next level UIO } - ] -**The UIO selector example** - -.. code-block:: python - - [ - {"class_name":"CalcFrame", "backend":"win32"}, # 1-st level UIO specification - {"title":"Hex", "depth_start":3, "depth_end": 3} # 3-rd level specification (because of attribute depth_start|depth_stop) - ] - -The UIDesktop module (OpenRPA/Robot/UIDesktop.py) -######################################################################################## -The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the **win32** and **ui automation** dll frameworks (big thx to the Microsoft :) ). - -.. code-block:: python - - # EXAMPLE 1 - from pyOpenRPA.Robot import UIDesktop - - UIDesktop.UIOSelector_Get_UIO( - inSpecificationList=[ - {"title":"notepad.exe"},{"title":"OK"}], - inElement=None, - inFlagRaiseException=True) - - -The UIDesktop module (OpenRPA/Robot/UIDesktop.py) -######################################################################################## -The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the **win32** and **ui automation** dll frameworks (big thx to the Microsoft :) ). - -*Naming convention: \\_\\_\*
- - -**************************************************************************************************** -Theory & practice. WEB app UI access (selenium) -**************************************************************************************************** - -About -############################################### -The pyOpenRPA support web app manipulation (by the Selenium lib). -More docs about selenium you can find here (https://selenium-python.readthedocs.io/) - -How to use -############################################### -To start use selenium just import selenium modules in the robot tool. Here is the example of the usage. - -.. code-block:: python - - from selenium import webdriver - from selenium.webdriver.common.keys import Keys - - driver = webdriver.Chrome() - driver.get("http://www.python.org") - assert "Python" in driver.title - elem = driver.find_element_by_name("q") - elem.clear() - elem.send_keys("pycon") - elem.send_keys(Keys.RETURN) - assert "No results found." not in driver.page_source - driver.close() - -**************************************************************************************************** -Theory & practice. Keyboard & mouse manipulation -**************************************************************************************************** - - -**************************************************************************************************** -Theory & practice. Screen capture & image recognition -**************************************************************************************************** - -How to automate image recognition on PC -########################################### - -Here you can find any ways you need to use in your business case: -- Find the exact match on the screen with the other image -- Use text recognition module (OCR) -- Use computer vision (CV) to identify the objects on screen/image/video -- Use artificial intelligence (AI) to make custom identification/classification/text recognition \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/Robot/04_Dependencies.rst.txt b/Wiki/ENG_Guide/html/_sources/Robot/04_Dependencies.rst.txt deleted file mode 100644 index 072b606c..00000000 --- a/Wiki/ENG_Guide/html/_sources/Robot/04_Dependencies.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -#################################### -4. Dependencies -#################################### - -Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -pywinauto (Windows GUI automation) -Semantic UI CSS framework -JsRender by https://www.jsviews.com (switch to Handlebars) -Handlebars \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_sources/Studio/01_Studio.rst.txt b/Wiki/ENG_Guide/html/_sources/Studio/01_Studio.rst.txt deleted file mode 100644 index 55375546..00000000 --- a/Wiki/ENG_Guide/html/_sources/Studio/01_Studio.rst.txt +++ /dev/null @@ -1,5 +0,0 @@ -************************ -1. Description -************************ - -pyOpenRPA Studio is the executable process. diff --git a/Wiki/ENG_Guide/html/_sources/Studio/02_HowToUse.rst.txt b/Wiki/ENG_Guide/html/_sources/Studio/02_HowToUse.rst.txt deleted file mode 100644 index 32802639..00000000 --- a/Wiki/ENG_Guide/html/_sources/Studio/02_HowToUse.rst.txt +++ /dev/null @@ -1,126 +0,0 @@ -#################################### -2. How to use -#################################### - -Content -======= - -- `How to run <#how-to-run>`__ -- `UI Description <#ui-description>`__ -- `How to extract UI tree <#how-to-extract-ui-tree>`__ -- `How to search UI object by mouse - hover <#how-to-search-ui-object-by-mouse-hover>`__ -- `How to extract UI object - properties <#how-to-extract-ui-object-properties>`__ - -How to run -========== - -- For OS x32 -- Run (double click): OpenRPA\_32.cmd (for OS x32) -- For OS x64 -- Run (double click): OpenRPA\_64.cmd (for OS x64) -- Wait text "running server" in console. Default browser will be open - automatically -- **Attention!** The studio tool does not support the Internet explorer - (any version) for GUI rendering (lol) - -.. image:: /img/504b98f76747f63900a2943532a946bb.png - :alt: 504b98f76747f63900a2943532a946bb.png - - -UI Description -============== - -**The studio tool GUI contains of:** - -1. UI tree viewer -2. Selected UI object hierarchy list -3. Selected UI object property list -4. UIO selector editor -5. UIO action panel -6. Another Python activity panel -7. Action/activity list - -*Look it on the GUI screenshots are listed below* - -GUI Screenshot 1 ----------------- - -.. image:: /img/d3d6ad14a7e50843bd89d2b14a092fee.png - :alt: 504b98f76747f63900a2943532a946bb.png - - -GUI Screenshot 2 ----------------- - -.. image:: /img/65b7d51c0a5b21e6b27dc23d4062d3ca.png - :alt: 65b7d51c0a5b21e6b27dc23d4062d3ca.png - - -How to extract UI tree -====================== - -In order to extract the UI tree do the following: in ``UI tree viewer`` -choose the object you are interested and click the button "Expand". ## - -Action: Click the button "Expand" ---------------------------------------- - -.. image:: /img/6effc376ff6ea928840674bd744caced.png - :alt: 6effc376ff6ea928840674bd744caced.png - -Result ---------------------------------------- - -.. image:: /img/18b9ab36126c8c32168bf5bbb9330701.png - :alt: 18b9ab36126c8c32168bf5bbb9330701.png - -How to search UI object by mouse hover ---------------------------------------- -In order to search UI object do the -following: in ``UI tree viewer`` choose the parent object, where you are -want to search UI object, and click the button "Mouse search". The mouse -search mode will start. Turn mouse on the UI object you are interested -and wait when the studio will highlight the UI object. After the -hightlight hold the "Ctrl" key and wait 3 seconds. The interested UI -object will be shown in ``UI tree viewer``. - -Action: Click the button "Mouse search" ---------------------------------------- - -.. image:: /img/84d7e4de0c840631f87cf7b325b53ad8.png - :alt: 84d7e4de0c840631f87cf7b325b53ad8.png - -Action: Turn mouse on the UI object you are interested and hold the "Ctrl" key for 3 seconds --------------------------------------------------------------------------------------------- - -.. image:: /img/b7c38d622bf5b7afa5b26d1686d7302a.png - :alt: b7c38d622bf5b7afa5b26d1686d7302a.png - -Result: The interested UI object will be shown in ``UI tree viewer`` --------------------------------------------------------------------- - -.. image:: /img/629bbf4db2c01b9c640194230949fcd2.png - :alt: 629bbf4db2c01b9c640194230949fcd2.png - -How to extract UI object properties -=================================== - -In order to extract UI object properties do the following: in -``Selected UI object hierarchy list`` choose the UI object you are -interested and click it. The UI object property list will be shown in -``Selected UI object property list`` - -Action: Choose the UI object you are interested and click it ------------------------------------------------------------------------------- - -.. image:: /img/2c27be5bdde20b5d062cbb40e74eaec5.png - :alt: 2c27be5bdde20b5d062cbb40e74eaec5.png - -Result: The UI object property list will be shown in ``Selected UI object property list`` ------------------------------------------------------------------------------------------ - -.. image:: /img/f235ae29099a713e0246cd574ac3a17c.png - :alt: f235ae29099a713e0246cd574ac3a17c.png - diff --git a/Wiki/ENG_Guide/html/_sources/Tools/02_Defs.rst.txt b/Wiki/ENG_Guide/html/_sources/Tools/02_Defs.rst.txt deleted file mode 100644 index e12fb213..00000000 --- a/Wiki/ENG_Guide/html/_sources/Tools/02_Defs.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -#################################### -2. Defs StopSafe -#################################### - -How to use StopSafe on the robot side - -.. code-block:: python - from pyOpenRPA.Tools import StopSafe - StopSafe.Init(inLogger=None) - StopSafe.IsSafeStop() # True - WM_CLOSE SIGNAL has come. taskkill /im someprocess.exe - - -.. automodule:: pyOpenRPA.Tools.StopSafe - :members: - :autosummary: - - -********** -References -********** - -`reStructuredText`_ - -.. target-notes:: -.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html diff --git a/Wiki/ENG_Guide/html/_sources/index.rst.txt b/Wiki/ENG_Guide/html/_sources/index.rst.txt deleted file mode 100644 index 884bcbac..00000000 --- a/Wiki/ENG_Guide/html/_sources/index.rst.txt +++ /dev/null @@ -1,165 +0,0 @@ -.. pyOpenRPA documentation master file, created by - sphinx-quickstart on Sat Dec 19 23:59:00 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -#################################### -Welcome to pyOpenRPA's wiki -#################################### - -.. image:: /img/ModalGuide.png - :alt: ModalGuide.png - -*by Ivan Maslov (Russia)* - see :ref:`3.-Copyrights-&-Contacts`. - -! ATTENTION ! pyOpenRPA works only on MS Windows 7+/Server 2008+. Guys from Unix/Mac - sorry. We will come to you soon :) - - -************************************************** -About -************************************************** -Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! - -pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) - -The pyOpenRPA - free, fast and reliable -Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! - -The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. -The pyOpenRPA is distributed under the PYOPENRPA license. -At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. - -************************************************** -Repo structure -************************************************** - -The description of the each folder in GitLab repo is going below: - -- **Agent**: template build for the pyOpenRPA.Agent component -- **Orchestrator**: template build for the pyOpenRPA.Orchestrator component -- **Resources**: 3rd party resources which is needed to provide pyOpenRPA encapsulation from the Operating System (OS) dependencies. -- **Robot**: template build for the robot -- **Sources**: pyOpenRPA python package sources + sphinx sources -- **Studio**: build for the pyOpenRPA.Studio which support Desktop UI (support x32 and x64 desktop UI apps) -- **Utils**: many additional good tools for the python developer -- **Wiki**: compiled wiki documentation - -************************************************** -The pyOpenRPA structure -************************************************** - -The pyOpenRPA has 4 main tools: -############################################ -- Studio -- Robot -- Orchestrator -- Agent - -Studio -###################### -The pyOpenRPA.Studio tool has been developed to help RPA-tors to create the robot algorythms. - -**Features** - -- Run actions -- Create visual algorythms of the robot -- Desktop app: Analyze desktop app ui tree -- Desktop app: Search desktop app ui by mouse -- Desktop app: Generate & edit the UIO Selector - -Robot -###################### -The pyOpenRPA.Robot package is the core of any action execution in the pyOpenRPA. All action from algorythms are perfoming by the Robot tool. It looks like a console process without graphic user interface. - -**Features** - -- Based on Python (killer feature) -- Support Win32 GUI framework (desktop app) -- Support UI automation framework (desktop app) -- Support Selenium (web app) -- Support PyAutoGUI (screen capture & mouse) -- Support OpenCV (computer vision) - -Orchestrator -###################### - -The pyOpenRPA.Orchestrator package has been developed to maintain robot infrastructure (2+ robots algorythm). - -**Features** - -- Start/Stop robot algorithm -- Robot scheduler -- Remote machine screenshot viewer -- Remote machine cmd shell -- Remote machine logs storage - -Agent -###################### - -The pyOpenRPA.Agent tool has been developed to maintain robot infrastructure (2+ robots algorythm). - -**Features** - -- Send CMD to the RPA GUI session (start/safe stop/force stop/logout) -- Get screenshots from the RPA GUI session -- Get the list of the running processes - -************************************************** -Wiki structure -************************************************** -In wiki you can use the following docs: - -- ENG Guide HTML `[|OPEN GITLAB|] `_ -- ENG Guide MarkDown `[|OPEN GITLAB|] `_ -- ENG Guide PDF `[|OPEN GITLAB|] `_ - -- RUS Article: Less cost - no paid RPA `[|OPEN HABR|] `_ -- RUS Tutorial Desktop UI `[|OPEN HABR|] `_; `[|OPEN GITLAB|] `_ -- RUS Tutorial Web UI `[|OPEN HABR|] `_; `[|OPEN GITLAB|] `_ -- RUS Leaflet pyOpenRPA v4.pdf `[|OPEN GITLAB|] `_ - -************************************************** -Guide content -************************************************** - -.. toctree:: - :maxdepth: 2 - :caption: GENERAL - :glob: - - * - -.. toctree:: - :maxdepth: 2 - :caption: ROBOT - :glob: - - Robot/* - -.. toctree:: - :maxdepth: 2 - :caption: STUDIO - :glob: - - Studio/* - -.. toctree:: - :maxdepth: 3 - :caption: ORCHESTRATOR - :glob: - - Orchestrator/* - -.. toctree:: - :maxdepth: 3 - :caption: AGENT - :glob: - - Agent/* - -.. toctree:: - :maxdepth: 2 - :caption: TOOLS - :glob: - - Tools/* \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_static/basic.css b/Wiki/ENG_Guide/html/_static/basic.css deleted file mode 100644 index 24a49f09..00000000 --- a/Wiki/ENG_Guide/html/_static/basic.css +++ /dev/null @@ -1,856 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 450px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -dl.footnote > dt, -dl.citation > dt { - float: left; - margin-right: 0.5em; -} - -dl.footnote > dd, -dl.citation > dd { - margin-bottom: 0em; -} - -dl.footnote > dd:after, -dl.citation > dd:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dt:after { - content: ":"; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0.5em; - content: ":"; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -code.descclassname { - background-color: transparent; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_static/css/badge_only.css b/Wiki/ENG_Guide/html/_static/css/badge_only.css deleted file mode 100644 index e380325b..00000000 --- a/Wiki/ENG_Guide/html/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff b/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb60000..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e231..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff b/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63f..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5b..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.eot b/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca9..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.svg b/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e..00000000 --- a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.ttf b/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2f..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff b/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc60..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff b/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b9..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d804..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff b/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51f..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb195043..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff b/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc0..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37e..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff b/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307ff..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff2 b/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf98433..00000000 Binary files a/Wiki/ENG_Guide/html/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/css/theme.css b/Wiki/ENG_Guide/html/_static/css/theme.css deleted file mode 100644 index 8cd4f101..00000000 --- a/Wiki/ENG_Guide/html/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li span.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li span.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p.caption .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.btn .wy-menu-vertical li span.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p.caption .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.nav .wy-menu-vertical li span.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p.caption .btn .headerlink,.rst-content p.caption .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li span.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol li,.rst-content ol.arabic li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content ol.arabic li p:last-child,.rst-content ol.arabic li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover span.toctree-expand,.wy-menu-vertical li.on a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content .code-block-caption .headerlink:after,.rst-content .toctree-wrapper>p.caption .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"\f0c1";font-family:FontAwesome}.rst-content .code-block-caption:hover .headerlink:after,.rst-content .toctree-wrapper>p.caption:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl dt span.classifier:before{content:" : "}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code,html.writer-html4 .rst-content dl:not(.docutils) tt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_static/doctools.js b/Wiki/ENG_Guide/html/_static/doctools.js deleted file mode 100644 index 7d88f807..00000000 --- a/Wiki/ENG_Guide/html/_static/doctools.js +++ /dev/null @@ -1,316 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box, textarea, dropdown or button - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey - && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/Wiki/ENG_Guide/html/_static/documentation_options.js b/Wiki/ENG_Guide/html/_static/documentation_options.js deleted file mode 100644 index 8e57d2b1..00000000 --- a/Wiki/ENG_Guide/html/_static/documentation_options.js +++ /dev/null @@ -1,12 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'v1.2.0', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/_static/favicon.ico b/Wiki/ENG_Guide/html/_static/favicon.ico deleted file mode 100644 index 867515cf..00000000 Binary files a/Wiki/ENG_Guide/html/_static/favicon.ico and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/file.png b/Wiki/ENG_Guide/html/_static/file.png deleted file mode 100644 index a858a410..00000000 Binary files a/Wiki/ENG_Guide/html/_static/file.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/_static/jquery-3.5.1.js b/Wiki/ENG_Guide/html/_static/jquery-3.5.1.js deleted file mode 100644 index 50937333..00000000 --- a/Wiki/ENG_Guide/html/_static/jquery-3.5.1.js +++ /dev/null @@ -1,10872 +0,0 @@ -/*! - * jQuery JavaScript Library v3.5.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2020-05-04T22:49Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var flat = arr.flat ? function( array ) { - return arr.flat.call( array ); -} : function( array ) { - return arr.concat.apply( [], array ); -}; - - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML elements - // (i.e., `typeof document.createElement( "object" ) === "function"`). - // We don't want to classify *any* DOM node as a function. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - -var document = window.document; - - - - var preservedScriptAttributes = { - type: true, - src: true, - nonce: true, - noModule: true - }; - - function DOMEval( code, node, doc ) { - doc = doc || document; - - var i, val, - script = doc.createElement( "script" ); - - script.text = code; - if ( node ) { - for ( i in preservedScriptAttributes ) { - - // Support: Firefox 64+, Edge 18+ - // Some browsers don't support the "nonce" property on scripts. - // On the other hand, just using `getAttribute` is not enough as - // the `nonce` attribute is reset to an empty string whenever it - // becomes browsing-context connected. - // See https://github.com/whatwg/html/issues/2369 - // See https://html.spec.whatwg.org/#nonce-attributes - // The `node.getAttribute` check was added for the sake of - // `jQuery.globalEval` so that it can fake a nonce-containing node - // via an object. - val = node[ i ] || node.getAttribute && node.getAttribute( i ); - if ( val ) { - script.setAttribute( i, val ); - } - } - } - doc.head.appendChild( script ).parentNode.removeChild( script ); - } - - -function toType( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; -} -/* global Symbol */ -// Defining this global in .eslintrc.json would create a danger of using the global -// unguarded in another place, it seems safer to define global only for this module - - - -var - version = "3.5.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }; - -jQuery.fn = jQuery.prototype = { - - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - - // Return all the elements in a clean array - if ( num == null ) { - return slice.call( this ); - } - - // Return just the one element from the set - return num < 0 ? this[ num + this.length ] : this[ num ]; - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - each: function( callback ) { - return jQuery.each( this, callback ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map( this, function( elem, i ) { - return callback.call( elem, i, elem ); - } ) ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - even: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return ( i + 1 ) % 2; - } ) ); - }, - - odd: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return i % 2; - } ) ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[ 0 ] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // Skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !isFunction( target ) ) { - target = {}; - } - - // Extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - - // Only deal with non-null/undefined values - if ( ( options = arguments[ i ] ) != null ) { - - // Extend the base object - for ( name in options ) { - copy = options[ name ]; - - // Prevent Object.prototype pollution - // Prevent never-ending loop - if ( name === "__proto__" || target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject( copy ) || - ( copyIsArray = Array.isArray( copy ) ) ) ) { - src = target[ name ]; - - // Ensure proper type for the source value - if ( copyIsArray && !Array.isArray( src ) ) { - clone = []; - } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { - clone = {}; - } else { - clone = src; - } - copyIsArray = false; - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend( { - - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - isPlainObject: function( obj ) { - var proto, Ctor; - - // Detect obvious negatives - // Use toString instead of jQuery.type to catch host objects - if ( !obj || toString.call( obj ) !== "[object Object]" ) { - return false; - } - - proto = getProto( obj ); - - // Objects with no prototype (e.g., `Object.create( null )`) are plain - if ( !proto ) { - return true; - } - - // Objects with prototype are plain iff they were constructed by a global Object function - Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; - return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; - }, - - isEmptyObject: function( obj ) { - var name; - - for ( name in obj ) { - return false; - } - return true; - }, - - // Evaluates a script in a provided context; falls back to the global one - // if not specified. - globalEval: function( code, options, doc ) { - DOMEval( code, { nonce: options && options.nonce }, doc ); - }, - - each: function( obj, callback ) { - var length, i = 0; - - if ( isArrayLike( obj ) ) { - length = obj.length; - for ( ; i < length; i++ ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } else { - for ( i in obj ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } - - return obj; - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArrayLike( Object( arr ) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var length, value, - i = 0, - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArrayLike( elems ) ) { - length = elems.length; - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return flat( ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -} ); - -if ( typeof Symbol === "function" ) { - jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; -} - -// Populate the class2type map -jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( _i, name ) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -} ); - -function isArrayLike( obj ) { - - // Support: real iOS 8.2 only (not reproducible in simulator) - // `in` check used to prevent JIT error (gh-2145) - // hasOwn isn't used here due to false negatives - // regarding Nodelist length in IE - var length = !!obj && "length" in obj && obj.length, - type = toType( obj ); - - if ( isFunction( obj ) || isWindow( obj ) ) { - return false; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v2.3.5 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2020-03-14 - */ -( function( window ) { -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + 1 * new Date(), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - nonnativeSelectorCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // Instance methods - hasOwn = ( {} ).hasOwnProperty, - arr = [], - pop = arr.pop, - pushNative = arr.push, - push = arr.push, - slice = arr.slice, - - // Use a stripped-down indexOf as it's faster than native - // https://jsperf.com/thor-indexof-vs-for/5 - indexOf = function( list, elem ) { - var i = 0, - len = list.length; - for ( ; i < len; i++ ) { - if ( list[ i ] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + - "ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - - // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram - identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + - "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + - - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - - // "Attribute values must be CSS identifiers [capture 5] - // or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + - whitespace + "*\\]", - - pseudos = ":(" + identifier + ")(?:\\((" + - - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + - whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + - "*" ), - rdescend = new RegExp( whitespace + "|>" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + identifier + ")" ), - "CLASS": new RegExp( "^\\.(" + identifier + ")" ), - "TAG": new RegExp( "^(" + identifier + "|[*])" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + - whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + - whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + - "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + - "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rhtml = /HTML$/i, - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - - // CSS escapes - // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), - funescape = function( escape, nonHex ) { - var high = "0x" + escape.slice( 1 ) - 0x10000; - - return nonHex ? - - // Strip the backslash prefix from a non-hex escape sequence - nonHex : - - // Replace a hexadecimal escape sequence with the encoded Unicode code point - // Support: IE <=11+ - // For values outside the Basic Multilingual Plane (BMP), manually construct a - // surrogate pair - high < 0 ? - String.fromCharCode( high + 0x10000 ) : - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }, - - // CSS string/identifier serialization - // https://drafts.csswg.org/cssom/#common-serializing-idioms - rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, - fcssescape = function( ch, asCodePoint ) { - if ( asCodePoint ) { - - // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER - if ( ch === "\0" ) { - return "\uFFFD"; - } - - // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + - ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; - } - - // Other potentially-special ASCII characters get backslash-escaped - return "\\" + ch; - }, - - // Used for iframes - // See setDocument() - // Removing the function wrapper causes a "Permission Denied" - // error in IE - unloadHandler = function() { - setDocument(); - }, - - inDisabledFieldset = addCombinator( - function( elem ) { - return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; - }, - { dir: "parentNode", next: "legend" } - ); - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - ( arr = slice.call( preferredDoc.childNodes ) ), - preferredDoc.childNodes - ); - - // Support: Android<4.0 - // Detect silently failing push.apply - // eslint-disable-next-line no-unused-expressions - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - pushNative.apply( target, slice.call( els ) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - - // Can't trust NodeList.length - while ( ( target[ j++ ] = els[ i++ ] ) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var m, i, elem, nid, match, groups, newSelector, - newContext = context && context.ownerDocument, - - // nodeType defaults to 9, since context defaults to document - nodeType = context ? context.nodeType : 9; - - results = results || []; - - // Return early from calls with invalid selector or context - if ( typeof selector !== "string" || !selector || - nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { - - return results; - } - - // Try to shortcut find operations (as opposed to filters) in HTML documents - if ( !seed ) { - setDocument( context ); - context = context || document; - - if ( documentIsHTML ) { - - // If the selector is sufficiently simple, try using a "get*By*" DOM method - // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { - - // ID selector - if ( ( m = match[ 1 ] ) ) { - - // Document context - if ( nodeType === 9 ) { - if ( ( elem = context.getElementById( m ) ) ) { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - - // Element context - } else { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( newContext && ( elem = newContext.getElementById( m ) ) && - contains( context, elem ) && - elem.id === m ) { - - results.push( elem ); - return results; - } - } - - // Type selector - } else if ( match[ 2 ] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Class selector - } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && - context.getElementsByClassName ) { - - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // Take advantage of querySelectorAll - if ( support.qsa && - !nonnativeSelectorCache[ selector + " " ] && - ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && - - // Support: IE 8 only - // Exclude object elements - ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { - - newSelector = selector; - newContext = context; - - // qSA considers elements outside a scoping root when evaluating child or - // descendant combinators, which is not what we want. - // In such cases, we work around the behavior by prefixing every selector in the - // list with an ID selector referencing the scope context. - // The technique has to be used as well when a leading combinator is used - // as such selectors are not recognized by querySelectorAll. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && - ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - - // We can use :scope instead of the ID hack if the browser - // supports it & if we're not changing the context. - if ( newContext !== context || !support.scope ) { - - // Capture the context ID, setting it first if necessary - if ( ( nid = context.getAttribute( "id" ) ) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", ( nid = expando ) ); - } - } - - // Prefix every selector in the list - groups = tokenize( selector ); - i = groups.length; - while ( i-- ) { - groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + - toSelector( groups[ i ] ); - } - newSelector = groups.join( "," ); - } - - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - nonnativeSelectorCache( selector, true ); - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {function(string, object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return ( cache[ key + " " ] = value ); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created element and returns a boolean result - */ -function assert( fn ) { - var el = document.createElement( "fieldset" ); - - try { - return !!fn( el ); - } catch ( e ) { - return false; - } finally { - - // Remove from its parent by default - if ( el.parentNode ) { - el.parentNode.removeChild( el ); - } - - // release memory in IE - el = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split( "|" ), - i = arr.length; - - while ( i-- ) { - Expr.attrHandle[ arr[ i ] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - a.sourceIndex - b.sourceIndex; - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( ( cur = cur.nextSibling ) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return ( name === "input" || name === "button" ) && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for :enabled/:disabled - * @param {Boolean} disabled true for :disabled; false for :enabled - */ -function createDisabledPseudo( disabled ) { - - // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable - return function( elem ) { - - // Only certain elements can match :enabled or :disabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled - if ( "form" in elem ) { - - // Check for inherited disabledness on relevant non-disabled elements: - // * listed form-associated elements in a disabled fieldset - // https://html.spec.whatwg.org/multipage/forms.html#category-listed - // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled - // * option elements in a disabled optgroup - // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled - // All such elements have a "form" property. - if ( elem.parentNode && elem.disabled === false ) { - - // Option elements defer to a parent optgroup if present - if ( "label" in elem ) { - if ( "label" in elem.parentNode ) { - return elem.parentNode.disabled === disabled; - } else { - return elem.disabled === disabled; - } - } - - // Support: IE 6 - 11 - // Use the isDisabled shortcut property to check for disabled fieldset ancestors - return elem.isDisabled === disabled || - - // Where there is no isDisabled, check manually - /* jshint -W018 */ - elem.isDisabled !== !disabled && - inDisabledFieldset( elem ) === disabled; - } - - return elem.disabled === disabled; - - // Try to winnow out elements that can't be disabled before trusting the disabled property. - // Some victims get caught in our net (label, legend, menu, track), but it shouldn't - // even exist on them, let alone have a boolean value. - } else if ( "label" in elem ) { - return elem.disabled === disabled; - } - - // Remaining elements are neither :enabled nor :disabled - return false; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction( function( argument ) { - argument = +argument; - return markFunction( function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ ( j = matchIndexes[ i ] ) ] ) { - seed[ j ] = !( matches[ j ] = seed[ j ] ); - } - } - } ); - } ); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== "undefined" && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - var namespace = elem.namespaceURI, - docElem = ( elem.ownerDocument || elem ).documentElement; - - // Support: IE <=8 - // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes - // https://bugs.jquery.com/ticket/4833 - return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, subWindow, - doc = node ? node.ownerDocument || node : preferredDoc; - - // Return early if doc is invalid or already selected - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Update global variables - document = doc; - docElem = document.documentElement; - documentIsHTML = !isXML( document ); - - // Support: IE 9 - 11+, Edge 12 - 18+ - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( preferredDoc != document && - ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { - - // Support: IE 11, Edge - if ( subWindow.addEventListener ) { - subWindow.addEventListener( "unload", unloadHandler, false ); - - // Support: IE 9 - 10 only - } else if ( subWindow.attachEvent ) { - subWindow.attachEvent( "onunload", unloadHandler ); - } - } - - // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, - // Safari 4 - 5 only, Opera <=11.6 - 12.x only - // IE/Edge & older browsers don't support the :scope pseudo-class. - // Support: Safari 6.0 only - // Safari 6.0 supports :scope but it's an alias of :root there. - support.scope = assert( function( el ) { - docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); - return typeof el.querySelectorAll !== "undefined" && - !el.querySelectorAll( ":scope fieldset div" ).length; - } ); - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties - // (excepting IE8 booleans) - support.attributes = assert( function( el ) { - el.className = "i"; - return !el.getAttribute( "className" ); - } ); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert( function( el ) { - el.appendChild( document.createComment( "" ) ); - return !el.getElementsByTagName( "*" ).length; - } ); - - // Support: IE<9 - support.getElementsByClassName = rnative.test( document.getElementsByClassName ); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programmatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert( function( el ) { - docElem.appendChild( el ).id = expando; - return !document.getElementsByName || !document.getElementsByName( expando ).length; - } ); - - // ID filter and find - if ( support.getById ) { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute( "id" ) === attrId; - }; - }; - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var elem = context.getElementById( id ); - return elem ? [ elem ] : []; - } - }; - } else { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode( "id" ); - return node && node.value === attrId; - }; - }; - - // Support: IE 6 - 7 only - // getElementById is not reliable as a find shortcut - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var node, i, elems, - elem = context.getElementById( id ); - - if ( elem ) { - - // Verify the id attribute - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - - // Fall back on getElementsByName - elems = context.getElementsByName( id ); - i = 0; - while ( ( elem = elems[ i++ ] ) ) { - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - } - } - - return []; - } - }; - } - - // Tag - Expr.find[ "TAG" ] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== "undefined" ) { - return context.getElementsByTagName( tag ); - - // DocumentFragment nodes don't have gEBTN - } else if ( support.qsa ) { - return context.querySelectorAll( tag ); - } - } : - - function( tag, context ) { - var elem, - tmp = [], - i = 0, - - // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See https://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { - - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert( function( el ) { - - var input; - - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // https://bugs.jquery.com/ticket/12359 - docElem.appendChild( el ).innerHTML = "" + - ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll( "[selected]" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ - if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push( "~=" ); - } - - // Support: IE 11+, Edge 15 - 18+ - // IE 11/Edge don't find elements on a `[name='']` query in some cases. - // Adding a temporary attribute to the document before the selection works - // around the issue. - // Interestingly, IE 10 & older don't seem to have the issue. - input = document.createElement( "input" ); - input.setAttribute( "name", "" ); - el.appendChild( input ); - if ( !el.querySelectorAll( "[name='']" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + - whitespace + "*(?:''|\"\")" ); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll( ":checked" ).length ) { - rbuggyQSA.push( ":checked" ); - } - - // Support: Safari 8+, iOS 8+ - // https://bugs.webkit.org/show_bug.cgi?id=136851 - // In-page `selector#id sibling-combinator selector` fails - if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push( ".#.+[+~]" ); - } - - // Support: Firefox <=3.6 - 5 only - // Old Firefox doesn't throw on a badly-escaped identifier. - el.querySelectorAll( "\\\f" ); - rbuggyQSA.push( "[\\r\\n\\f]" ); - } ); - - assert( function( el ) { - el.innerHTML = "" + - ""; - - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement( "input" ); - input.setAttribute( "type", "hidden" ); - el.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll( "[name=d]" ).length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: IE9-11+ - // IE's :disabled selector does not pick up the children of disabled fieldsets - docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: Opera 10 - 11 only - // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll( "*,:x" ); - rbuggyQSA.push( ",.*:" ); - } ); - } - - if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector ) ) ) ) { - - assert( function( el ) { - - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( el, "*" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( el, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - } ); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully self-exclusive - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - ) ); - } : - function( a, b ) { - if ( b ) { - while ( ( b = b.parentNode ) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { - - // Choose the first element that is related to our preferred document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( a == document || a.ownerDocument == preferredDoc && - contains( preferredDoc, a ) ) { - return -1; - } - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( b == document || b.ownerDocument == preferredDoc && - contains( preferredDoc, b ) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - return a == document ? -1 : - b == document ? 1 : - /* eslint-enable eqeqeq */ - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( ( cur = cur.parentNode ) ) { - ap.unshift( cur ); - } - cur = b; - while ( ( cur = cur.parentNode ) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[ i ] === bp[ i ] ) { - i++; - } - - return i ? - - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[ i ], bp[ i ] ) : - - // Otherwise nodes in our document sort first - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - ap[ i ] == preferredDoc ? -1 : - bp[ i ] == preferredDoc ? 1 : - /* eslint-enable eqeqeq */ - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - setDocument( elem ); - - if ( support.matchesSelector && documentIsHTML && - !nonnativeSelectorCache[ expr + " " ] && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch ( e ) { - nonnativeSelectorCache( expr, true ); - } - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( context.ownerDocument || context ) != document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( elem.ownerDocument || elem ) != document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; -}; - -Sizzle.escape = function( sel ) { - return ( sel + "" ).replace( rcssescape, fcssescape ); -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - - // If no nodeType, this is expected to be an array - while ( ( node = elem[ i++ ] ) ) { - - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[ 1 ] = match[ 1 ].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[ 3 ] = ( match[ 3 ] || match[ 4 ] || - match[ 5 ] || "" ).replace( runescape, funescape ); - - if ( match[ 2 ] === "~=" ) { - match[ 3 ] = " " + match[ 3 ] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[ 1 ] = match[ 1 ].toLowerCase(); - - if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { - - // nth-* requires argument - if ( !match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[ 4 ] = +( match[ 4 ] ? - match[ 5 ] + ( match[ 6 ] || 1 ) : - 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); - match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); - - // other types prohibit arguments - } else if ( match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[ 6 ] && match[ 2 ]; - - if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[ 3 ] ) { - match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - - // Get excess from tokenize (recursively) - ( excess = tokenize( unquoted, true ) ) && - - // advance to the next closing parenthesis - ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { - - // excess is a negative index - match[ 0 ] = match[ 0 ].slice( 0, excess ); - match[ 2 ] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { - return true; - } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - ( pattern = new RegExp( "(^|" + whitespace + - ")" + className + "(" + whitespace + "|$)" ) ) && classCache( - className, function( elem ) { - return pattern.test( - typeof elem.className === "string" && elem.className || - typeof elem.getAttribute !== "undefined" && - elem.getAttribute( "class" ) || - "" - ); - } ); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - /* eslint-disable max-len */ - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - /* eslint-enable max-len */ - - }; - }, - - "CHILD": function( type, what, _argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, _context, xml ) { - var cache, uniqueCache, outerCache, node, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType, - diff = false; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( ( node = node[ dir ] ) ) { - if ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) { - - return false; - } - } - - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - - // Seek `elem` from a previously-cached index - - // ...in a gzip-friendly way - node = parent; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex && cache[ 2 ]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( ( node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - } else { - - // Use previously-cached element index if available - if ( useCache ) { - - // ...in a gzip-friendly way - node = elem; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex; - } - - // xml :nth-child(...) - // or :nth-last-child(...) or :nth(-last)?-of-type(...) - if ( diff === false ) { - - // Use the same loop as above to seek `elem` from the start - while ( ( node = ++nodeIndex && node && node[ dir ] || - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - if ( ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) && - ++diff ) { - - // Cache the index of each encountered element - if ( useCache ) { - outerCache = node[ expando ] || - ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - uniqueCache[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction( function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf( seed, matched[ i ] ); - seed[ idx ] = !( matches[ idx ] = matched[ i ] ); - } - } ) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - - // Potentially complex pseudos - "not": markFunction( function( selector ) { - - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction( function( seed, matches, _context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( ( elem = unmatched[ i ] ) ) { - seed[ i ] = !( matches[ i ] = elem ); - } - } - } ) : - function( elem, _context, xml ) { - input[ 0 ] = elem; - matcher( input, null, xml, results ); - - // Don't keep the element (issue #299) - input[ 0 ] = null; - return !results.pop(); - }; - } ), - - "has": markFunction( function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - } ), - - "contains": markFunction( function( text ) { - text = text.replace( runescape, funescape ); - return function( elem ) { - return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; - }; - } ), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - - // lang value must be a valid identifier - if ( !ridentifier.test( lang || "" ) ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( ( elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); - return false; - }; - } ), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && - ( !document.hasFocus || document.hasFocus() ) && - !!( elem.type || elem.href || ~elem.tabIndex ); - }, - - // Boolean properties - "enabled": createDisabledPseudo( false ), - "disabled": createDisabledPseudo( true ), - - "checked": function( elem ) { - - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return ( nodeName === "input" && !!elem.checked ) || - ( nodeName === "option" && !!elem.selected ); - }, - - "selected": function( elem ) { - - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - // eslint-disable-next-line no-unused-expressions - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos[ "empty" ]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( ( attr = elem.getAttribute( "type" ) ) == null || - attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo( function() { - return [ 0 ]; - } ), - - "last": createPositionalPseudo( function( _matchIndexes, length ) { - return [ length - 1 ]; - } ), - - "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - } ), - - "even": createPositionalPseudo( function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "odd": createPositionalPseudo( function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? - argument + length : - argument > length ? - length : - argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ) - } -}; - -Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || ( match = rcomma.exec( soFar ) ) ) { - if ( match ) { - - // Don't consume trailing commas as valid - soFar = soFar.slice( match[ 0 ].length ) || soFar; - } - groups.push( ( tokens = [] ) ); - } - - matched = false; - - // Combinators - if ( ( match = rcombinators.exec( soFar ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - - // Cast descendant combinators to space - type: match[ 0 ].replace( rtrim, " " ) - } ); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || - ( match = preFilters[ type ]( match ) ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - type: type, - matches: match - } ); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[ i ].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - skip = combinator.next, - key = skip || dir, - checkNonElements = base && key === "parentNode", - doneName = done++; - - return combinator.first ? - - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - return false; - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, uniqueCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching - if ( xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || ( elem[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || - ( outerCache[ elem.uniqueID ] = {} ); - - if ( skip && skip === elem.nodeName.toLowerCase() ) { - elem = elem[ dir ] || elem; - } else if ( ( oldCache = uniqueCache[ key ] ) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return ( newCache[ 2 ] = oldCache[ 2 ] ); - } else { - - // Reuse newcache so results back-propagate to previous elements - uniqueCache[ key ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { - return true; - } - } - } - } - } - return false; - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[ i ]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[ 0 ]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[ i ], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( ( elem = unmatched[ i ] ) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction( function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( - selector || "*", - context.nodeType ? [ context ] : context, - [] - ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( ( elem = temp[ i ] ) ) { - matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) ) { - - // Restore matcherIn since elem is not yet a final match - temp.push( ( matcherIn[ i ] = elem ) ); - } - } - postFinder( null, ( matcherOut = [] ), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) && - ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { - - seed[ temp ] = !( results[ temp ] = elem ); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - } ); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[ 0 ].type ], - implicitRelative = leadingRelative || Expr.relative[ " " ], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - ( checkContext = context ).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - - // Avoid hanging onto element (issue #299) - checkContext = null; - return ret; - } ]; - - for ( ; i < len; i++ ) { - if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { - matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; - } else { - matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[ j ].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens - .slice( 0, i - 1 ) - .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), - - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), - len = elems.length; - - if ( outermost ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - outermostContext = context == document || context || outermost; - } - - // Add elements passing elementMatchers directly to results - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( !context && elem.ownerDocument != document ) { - setDocument( elem ); - xml = !documentIsHTML; - } - while ( ( matcher = elementMatchers[ j++ ] ) ) { - if ( matcher( elem, context || document, xml ) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - - // They will have gone through all possible matchers - if ( ( elem = !matcher && elem ) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // `i` is now the count of elements visited above, and adding it to `matchedCount` - // makes the latter nonnegative. - matchedCount += i; - - // Apply set filters to unmatched elements - // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` - // equals `i`), unless we didn't visit _any_ elements in the above loop because we have - // no element matchers and no seed. - // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that - // case, which will result in a "00" `matchedCount` that differs from `i` but is also - // numerically zero. - if ( bySet && i !== matchedCount ) { - j = 0; - while ( ( matcher = setMatchers[ j++ ] ) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !( unmatched[ i ] || setMatched[ i ] ) ) { - setMatched[ i ] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[ i ] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( - selector, - matcherFromGroupMatchers( elementMatchers, setMatchers ) - ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( ( selector = compiled.selector || selector ) ); - - results = results || []; - - // Try to minimize operations if there is only one selector in the list and no seed - // (the latter of which guarantees us context) - if ( match.length === 1 ) { - - // Reduce context if the leading compound selector is an ID - tokens = match[ 0 ] = match[ 0 ].slice( 0 ); - if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { - - context = ( Expr.find[ "ID" ]( token.matches[ 0 ] - .replace( runescape, funescape ), context ) || [] )[ 0 ]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[ i ]; - - // Abort if we hit a combinator - if ( Expr.relative[ ( type = token.type ) ] ) { - break; - } - if ( ( find = Expr.find[ type ] ) ) { - - // Search, expanding context for leading sibling combinators - if ( ( seed = find( - token.matches[ 0 ].replace( runescape, funescape ), - rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || - context - ) ) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - !context || rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; - -// Support: Chrome 14-35+ -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert( function( el ) { - - // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; -} ); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert( function( el ) { - el.innerHTML = ""; - return el.firstChild.getAttribute( "href" ) === "#"; -} ) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - } ); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert( function( el ) { - el.innerHTML = ""; - el.firstChild.setAttribute( "value", "" ); - return el.firstChild.getAttribute( "value" ) === ""; -} ) ) { - addHandle( "value", function( elem, _name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - } ); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert( function( el ) { - return el.getAttribute( "disabled" ) == null; -} ) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; - } - } ); -} - -return Sizzle; - -} )( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; - -// Deprecated -jQuery.expr[ ":" ] = jQuery.expr.pseudos; -jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; -jQuery.escapeSelector = Sizzle.escape; - - - - -var dir = function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; -}; - - -var siblings = function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; -}; - - -var rneedsContext = jQuery.expr.match.needsContext; - - - -function nodeName( elem, name ) { - - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - -}; -var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); - - - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - return !!qualifier.call( elem, i, elem ) !== not; - } ); - } - - // Single element - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - } ); - } - - // Arraylike of elements (jQuery, arguments, Array) - if ( typeof qualifier !== "string" ) { - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not; - } ); - } - - // Filtered directly for both simple and complex selectors - return jQuery.filter( qualifier, elements, not ); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - if ( elems.length === 1 && elem.nodeType === 1 ) { - return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; - } - - return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - } ) ); -}; - -jQuery.fn.extend( { - find: function( selector ) { - var i, ret, - len = this.length, - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter( function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - } ) ); - } - - ret = this.pushStack( [] ); - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - return len > 1 ? jQuery.uniqueSort( ret ) : ret; - }, - filter: function( selector ) { - return this.pushStack( winnow( this, selector || [], false ) ); - }, - not: function( selector ) { - return this.pushStack( winnow( this, selector || [], true ) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -} ); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - // Shortcut simple #id case for speed - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, - - init = jQuery.fn.init = function( selector, context, root ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Method init() accepts an alternate rootjQuery - // so migrate can support jQuery.sub (gh-2101) - root = root || rootjQuery; - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[ 0 ] === "<" && - selector[ selector.length - 1 ] === ">" && - selector.length >= 3 ) { - - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && ( match[ 1 ] || !context ) ) { - - // HANDLE: $(html) -> $(array) - if ( match[ 1 ] ) { - context = context instanceof jQuery ? context[ 0 ] : context; - - // Option to run scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[ 1 ], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - - // Properties of context are called as methods if possible - if ( isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[ 2 ] ); - - if ( elem ) { - - // Inject the element directly into the jQuery object - this[ 0 ] = elem; - this.length = 1; - } - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || root ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this[ 0 ] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( isFunction( selector ) ) { - return root.ready !== undefined ? - root.ready( selector ) : - - // Execute immediately if ready is not present - selector( jQuery ); - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - - // Methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.fn.extend( { - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter( function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[ i ] ) ) { - return true; - } - } - } ); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - targets = typeof selectors !== "string" && jQuery( selectors ); - - // Positional selectors never match, since there's no _selection_ context - if ( !rneedsContext.test( selectors ) ) { - for ( ; i < l; i++ ) { - for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { - - // Always skip document fragments - if ( cur.nodeType < 11 && ( targets ? - targets.index( cur ) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector( cur, selectors ) ) ) { - - matched.push( cur ); - break; - } - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); - }, - - // Determine the position of an element within the set - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // Index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.uniqueSort( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter( selector ) - ); - } -} ); - -function sibling( cur, dir ) { - while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each( { - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, _i, until ) { - return dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, _i, until ) { - return dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, _i, until ) { - return dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return siblings( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return siblings( elem.firstChild ); - }, - contents: function( elem ) { - if ( elem.contentDocument != null && - - // Support: IE 11+ - // elements with no `data` attribute has an object - // `contentDocument` with a `null` prototype. - getProto( elem.contentDocument ) ) { - - return elem.contentDocument; - } - - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } - - return jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.uniqueSort( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -} ); -var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); - - - -// Convert String-formatted options into Object-formatted ones -function createOptions( options ) { - var object = {}; - jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { - object[ flag ] = true; - } ); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - createOptions( options ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - - // Last fire value for non-forgettable lists - memory, - - // Flag to know if list was already fired - fired, - - // Flag to prevent firing - locked, - - // Actual callback list - list = [], - - // Queue of execution data for repeatable lists - queue = [], - - // Index of currently firing callback (modified by add/remove as needed) - firingIndex = -1, - - // Fire callbacks - fire = function() { - - // Enforce single-firing - locked = locked || options.once; - - // Execute callbacks for all pending executions, - // respecting firingIndex overrides and runtime changes - fired = firing = true; - for ( ; queue.length; firingIndex = -1 ) { - memory = queue.shift(); - while ( ++firingIndex < list.length ) { - - // Run callback and check for early termination - if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && - options.stopOnFalse ) { - - // Jump to end and forget the data so .add doesn't re-fire - firingIndex = list.length; - memory = false; - } - } - } - - // Forget the data if we're done with it - if ( !options.memory ) { - memory = false; - } - - firing = false; - - // Clean up if we're done firing for good - if ( locked ) { - - // Keep an empty list if we have data for future add calls - if ( memory ) { - list = []; - - // Otherwise, this object is spent - } else { - list = ""; - } - } - }, - - // Actual Callbacks object - self = { - - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - - // If we have memory from a past run, we should fire after adding - if ( memory && !firing ) { - firingIndex = list.length - 1; - queue.push( memory ); - } - - ( function add( args ) { - jQuery.each( args, function( _, arg ) { - if ( isFunction( arg ) ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && toType( arg ) !== "string" ) { - - // Inspect recursively - add( arg ); - } - } ); - } )( arguments ); - - if ( memory && !firing ) { - fire(); - } - } - return this; - }, - - // Remove a callback from the list - remove: function() { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - - // Handle firing indexes - if ( index <= firingIndex ) { - firingIndex--; - } - } - } ); - return this; - }, - - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? - jQuery.inArray( fn, list ) > -1 : - list.length > 0; - }, - - // Remove all callbacks from the list - empty: function() { - if ( list ) { - list = []; - } - return this; - }, - - // Disable .fire and .add - // Abort any current/pending executions - // Clear all callbacks and values - disable: function() { - locked = queue = []; - list = memory = ""; - return this; - }, - disabled: function() { - return !list; - }, - - // Disable .fire - // Also disable .add unless we have memory (since it would have no effect) - // Abort any pending executions - lock: function() { - locked = queue = []; - if ( !memory && !firing ) { - list = memory = ""; - } - return this; - }, - locked: function() { - return !!locked; - }, - - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( !locked ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - queue.push( args ); - if ( !firing ) { - fire(); - } - } - return this; - }, - - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -function Identity( v ) { - return v; -} -function Thrower( ex ) { - throw ex; -} - -function adoptValue( value, resolve, reject, noValue ) { - var method; - - try { - - // Check for promise aspect first to privilege synchronous behavior - if ( value && isFunction( ( method = value.promise ) ) ) { - method.call( value ).done( resolve ).fail( reject ); - - // Other thenables - } else if ( value && isFunction( ( method = value.then ) ) ) { - method.call( value, resolve, reject ); - - // Other non-thenables - } else { - - // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: - // * false: [ value ].slice( 0 ) => resolve( value ) - // * true: [ value ].slice( 1 ) => resolve() - resolve.apply( undefined, [ value ].slice( noValue ) ); - } - - // For Promises/A+, convert exceptions into rejections - // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in - // Deferred#then to conditionally suppress rejection. - } catch ( value ) { - - // Support: Android 4.0 only - // Strict mode functions invoked without .call/.apply get global-object context - reject.apply( undefined, [ value ] ); - } -} - -jQuery.extend( { - - Deferred: function( func ) { - var tuples = [ - - // action, add listener, callbacks, - // ... .then handlers, argument index, [final state] - [ "notify", "progress", jQuery.Callbacks( "memory" ), - jQuery.Callbacks( "memory" ), 2 ], - [ "resolve", "done", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 0, "resolved" ], - [ "reject", "fail", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 1, "rejected" ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - "catch": function( fn ) { - return promise.then( null, fn ); - }, - - // Keep pipe for back-compat - pipe: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - - return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( _i, tuple ) { - - // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; - - // deferred.progress(function() { bind to newDefer or newDefer.notify }) - // deferred.done(function() { bind to newDefer or newDefer.resolve }) - // deferred.fail(function() { bind to newDefer or newDefer.reject }) - deferred[ tuple[ 1 ] ]( function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && isFunction( returned.promise ) ) { - returned.promise() - .progress( newDefer.notify ) - .done( newDefer.resolve ) - .fail( newDefer.reject ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( - this, - fn ? [ returned ] : arguments - ); - } - } ); - } ); - fns = null; - } ).promise(); - }, - then: function( onFulfilled, onRejected, onProgress ) { - var maxDepth = 0; - function resolve( depth, deferred, handler, special ) { - return function() { - var that = this, - args = arguments, - mightThrow = function() { - var returned, then; - - // Support: Promises/A+ section 2.3.3.3.3 - // https://promisesaplus.com/#point-59 - // Ignore double-resolution attempts - if ( depth < maxDepth ) { - return; - } - - returned = handler.apply( that, args ); - - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError( "Thenable self-resolution" ); - } - - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && - - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; - - // Handle a returned thenable - if ( isFunction( then ) ) { - - // Special processors (notify) just wait for resolution - if ( special ) { - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ) - ); - - // Normal processors (resolve) also hook into progress - } else { - - // ...and disregard older resolution values - maxDepth++; - - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ), - resolve( maxDepth, deferred, Identity, - deferred.notifyWith ) - ); - } - - // Handle all other returned values - } else { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Identity ) { - that = undefined; - args = [ returned ]; - } - - // Process the value(s) - // Default process is resolve - ( special || deferred.resolveWith )( that, args ); - } - }, - - // Only normal processors (resolve) catch and reject exceptions - process = special ? - mightThrow : - function() { - try { - mightThrow(); - } catch ( e ) { - - if ( jQuery.Deferred.exceptionHook ) { - jQuery.Deferred.exceptionHook( e, - process.stackTrace ); - } - - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Thrower ) { - that = undefined; - args = [ e ]; - } - - deferred.rejectWith( that, args ); - } - } - }; - - // Support: Promises/A+ section 2.3.3.3.1 - // https://promisesaplus.com/#point-57 - // Re-resolve promises immediately to dodge false rejection from - // subsequent errors - if ( depth ) { - process(); - } else { - - // Call an optional hook to record the stack, in case of exception - // since it's otherwise lost when execution goes async - if ( jQuery.Deferred.getStackHook ) { - process.stackTrace = jQuery.Deferred.getStackHook(); - } - window.setTimeout( process ); - } - }; - } - - return jQuery.Deferred( function( newDefer ) { - - // progress_handlers.add( ... ) - tuples[ 0 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onProgress ) ? - onProgress : - Identity, - newDefer.notifyWith - ) - ); - - // fulfilled_handlers.add( ... ) - tuples[ 1 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onFulfilled ) ? - onFulfilled : - Identity - ) - ); - - // rejected_handlers.add( ... ) - tuples[ 2 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onRejected ) ? - onRejected : - Thrower - ) - ); - } ).promise(); - }, - - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 5 ]; - - // promise.progress = list.add - // promise.done = list.add - // promise.fail = list.add - promise[ tuple[ 1 ] ] = list.add; - - // Handle state - if ( stateString ) { - list.add( - function() { - - // state = "resolved" (i.e., fulfilled) - // state = "rejected" - state = stateString; - }, - - // rejected_callbacks.disable - // fulfilled_callbacks.disable - tuples[ 3 - i ][ 2 ].disable, - - // rejected_handlers.disable - // fulfilled_handlers.disable - tuples[ 3 - i ][ 3 ].disable, - - // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock, - - // progress_handlers.lock - tuples[ 0 ][ 3 ].lock - ); - } - - // progress_handlers.fire - // fulfilled_handlers.fire - // rejected_handlers.fire - list.add( tuple[ 3 ].fire ); - - // deferred.notify = function() { deferred.notifyWith(...) } - // deferred.resolve = function() { deferred.resolveWith(...) } - // deferred.reject = function() { deferred.rejectWith(...) } - deferred[ tuple[ 0 ] ] = function() { - deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); - return this; - }; - - // deferred.notifyWith = list.fireWith - // deferred.resolveWith = list.fireWith - // deferred.rejectWith = list.fireWith - deferred[ tuple[ 0 ] + "With" ] = list.fireWith; - } ); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( singleValue ) { - var - - // count of uncompleted subordinates - remaining = arguments.length, - - // count of unprocessed arguments - i = remaining, - - // subordinate fulfillment data - resolveContexts = Array( i ), - resolveValues = slice.call( arguments ), - - // the master Deferred - master = jQuery.Deferred(), - - // subordinate callback factory - updateFunc = function( i ) { - return function( value ) { - resolveContexts[ i ] = this; - resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( !( --remaining ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.promise(); - } -} ); - - -// These usually indicate a programmer mistake during development, -// warn about them ASAP rather than swallowing them by default. -var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; - -jQuery.Deferred.exceptionHook = function( error, stack ) { - - // Support: IE 8 - 9 only - // Console exists when dev tools are open, which can happen at any time - if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { - window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); - } -}; - - - - -jQuery.readyException = function( error ) { - window.setTimeout( function() { - throw error; - } ); -}; - - - - -// The deferred used on DOM ready -var readyList = jQuery.Deferred(); - -jQuery.fn.ready = function( fn ) { - - readyList - .then( fn ) - - // Wrap jQuery.readyException in a function so that the lookup - // happens at the time of error handling instead of callback - // registration. - .catch( function( error ) { - jQuery.readyException( error ); - } ); - - return this; -}; - -jQuery.extend( { - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - } -} ); - -jQuery.ready.then = readyList.then; - -// The ready event handler and self cleanup method -function completed() { - document.removeEventListener( "DOMContentLoaded", completed ); - window.removeEventListener( "load", completed ); - jQuery.ready(); -} - -// Catch cases where $(document).ready() is called -// after the browser event has already occurred. -// Support: IE <=9 - 10 only -// Older IE sometimes signals "interactive" too soon -if ( document.readyState === "complete" || - ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { - - // Handle it asynchronously to allow scripts the opportunity to delay ready - window.setTimeout( jQuery.ready ); - -} else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed ); -} - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( toType( key ) === "object" ) { - chainable = true; - for ( i in key ) { - access( elems, fn, i, key[ i ], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, _key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( - elems[ i ], key, raw ? - value : - value.call( elems[ i ], i, fn( elems[ i ], key ) ) - ); - } - } - } - - if ( chainable ) { - return elems; - } - - // Gets - if ( bulk ) { - return fn.call( elems ); - } - - return len ? fn( elems[ 0 ], key ) : emptyGet; -}; - - -// Matches dashed string for camelizing -var rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g; - -// Used by camelCase as callback to replace() -function fcamelCase( _all, letter ) { - return letter.toUpperCase(); -} - -// Convert dashed to camelCase; used by the css and data modules -// Support: IE <=9 - 11, Edge 12 - 15 -// Microsoft forgot to hump their vendor prefix (#9572) -function camelCase( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); -} -var acceptData = function( owner ) { - - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - - - -function Data() { - this.expando = jQuery.expando + Data.uid++; -} - -Data.uid = 1; - -Data.prototype = { - - cache: function( owner ) { - - // Check if the owner object already has a cache - var value = owner[ this.expando ]; - - // If not, create one - if ( !value ) { - value = {}; - - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return an empty object. - if ( acceptData( owner ) ) { - - // If it is a node unlikely to be stringify-ed or looped over - // use plain assignment - if ( owner.nodeType ) { - owner[ this.expando ] = value; - - // Otherwise secure it in a non-enumerable property - // configurable must be true to allow the property to be - // deleted when data is removed - } else { - Object.defineProperty( owner, this.expando, { - value: value, - configurable: true - } ); - } - } - } - - return value; - }, - set: function( owner, data, value ) { - var prop, - cache = this.cache( owner ); - - // Handle: [ owner, key, value ] args - // Always use camelCase key (gh-2257) - if ( typeof data === "string" ) { - cache[ camelCase( data ) ] = value; - - // Handle: [ owner, { properties } ] args - } else { - - // Copy the properties one-by-one to the cache object - for ( prop in data ) { - cache[ camelCase( prop ) ] = data[ prop ]; - } - } - return cache; - }, - get: function( owner, key ) { - return key === undefined ? - this.cache( owner ) : - - // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; - }, - access: function( owner, key, value ) { - - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ( ( key && typeof key === "string" ) && value === undefined ) ) { - - return this.get( owner, key ); - } - - // When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, - cache = owner[ this.expando ]; - - if ( cache === undefined ) { - return; - } - - if ( key !== undefined ) { - - // Support array or space separated string of keys - if ( Array.isArray( key ) ) { - - // If key is an array of keys... - // We always set camelCase keys, so remove that. - key = key.map( camelCase ); - } else { - key = camelCase( key ); - - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - key = key in cache ? - [ key ] : - ( key.match( rnothtmlwhite ) || [] ); - } - - i = key.length; - - while ( i-- ) { - delete cache[ key[ i ] ]; - } - } - - // Remove the expando if there's no more data - if ( key === undefined || jQuery.isEmptyObject( cache ) ) { - - // Support: Chrome <=35 - 45 - // Webkit & Blink performance suffers when deleting properties - // from DOM nodes, so set to undefined instead - // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) - if ( owner.nodeType ) { - owner[ this.expando ] = undefined; - } else { - delete owner[ this.expando ]; - } - } - }, - hasData: function( owner ) { - var cache = owner[ this.expando ]; - return cache !== undefined && !jQuery.isEmptyObject( cache ); - } -}; -var dataPriv = new Data(); - -var dataUser = new Data(); - - - -// Implementation Summary -// -// 1. Enforce API surface and semantic compatibility with 1.9.x branch -// 2. Improve the module's maintainability by reducing the storage -// paths to a single mechanism. -// 3. Use the same single mechanism to support "private" and "user" data. -// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) -// 5. Avoid exposing implementation details on user objects (eg. expando properties) -// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /[A-Z]/g; - -function getData( data ) { - if ( data === "true" ) { - return true; - } - - if ( data === "false" ) { - return false; - } - - if ( data === "null" ) { - return null; - } - - // Only convert to a number if it doesn't change the string - if ( data === +data + "" ) { - return +data; - } - - if ( rbrace.test( data ) ) { - return JSON.parse( data ); - } - - return data; -} - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = getData( data ); - } catch ( e ) {} - - // Make sure we set the data so it isn't changed later - dataUser.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend( { - hasData: function( elem ) { - return dataUser.hasData( elem ) || dataPriv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return dataUser.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - dataUser.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to dataPriv methods, these can be deprecated. - _data: function( elem, name, data ) { - return dataPriv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - dataPriv.remove( elem, name ); - } -} ); - -jQuery.fn.extend( { - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = dataUser.get( elem ); - - if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE 11 only - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = camelCase( name.slice( 5 ) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - dataPriv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each( function() { - dataUser.set( this, key ); - } ); - } - - return access( this, function( value ) { - var data; - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - - // Attempt to get data from the cache - // The key will always be camelCased in Data - data = dataUser.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, key ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each( function() { - - // We always store the camelCased key - dataUser.set( this, key, value ); - } ); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each( function() { - dataUser.remove( this, key ); - } ); - } -} ); - - -jQuery.extend( { - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = dataPriv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || Array.isArray( data ) ) { - queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // Clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // Not public - generate a queueHooks object, or return the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { - empty: jQuery.Callbacks( "once memory" ).add( function() { - dataPriv.remove( elem, [ type + "queue", key ] ); - } ) - } ); - } -} ); - -jQuery.fn.extend( { - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[ 0 ], type ); - } - - return data === undefined ? - this : - this.each( function() { - var queue = jQuery.queue( this, type, data ); - - // Ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - } ); - }, - dequeue: function( type ) { - return this.each( function() { - jQuery.dequeue( this, type ); - } ); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -} ); -var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; - -var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); - - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var documentElement = document.documentElement; - - - - var isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ); - }, - composed = { composed: true }; - - // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only - // Check attachment across shadow DOM boundaries when possible (gh-3504) - // Support: iOS 10.0-10.2 only - // Early iOS 10 versions support `attachShadow` but not `getRootNode`, - // leading to errors. We need to check for `getRootNode`. - if ( documentElement.getRootNode ) { - isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ) || - elem.getRootNode( composed ) === elem.ownerDocument; - }; - } -var isHiddenWithinTree = function( elem, el ) { - - // isHiddenWithinTree might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - - // Inline style trumps all - return elem.style.display === "none" || - elem.style.display === "" && - - // Otherwise, check computed style - // Support: Firefox <=43 - 45 - // Disconnected elements can have computed display: none, so first confirm that elem is - // in the document. - isAttached( elem ) && - - jQuery.css( elem, "display" ) === "none"; - }; - - - -function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, scale, - maxIterations = 20, - currentValue = tween ? - function() { - return tween.cur(); - } : - function() { - return jQuery.css( elem, prop, "" ); - }, - initial = currentValue(), - unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), - - // Starting value computation is required for potential unit mismatches - initialInUnit = elem.nodeType && - ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && - rcssNum.exec( jQuery.css( elem, prop ) ); - - if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { - - // Support: Firefox <=54 - // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) - initial = initial / 2; - - // Trust units reported by jQuery.css - unit = unit || initialInUnit[ 3 ]; - - // Iteratively approximate from a nonzero starting point - initialInUnit = +initial || 1; - - while ( maxIterations-- ) { - - // Evaluate and update our best guess (doubling guesses that zero out). - // Finish if the scale equals or crosses 1 (making the old*new product non-positive). - jQuery.style( elem, prop, initialInUnit + unit ); - if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { - maxIterations = 0; - } - initialInUnit = initialInUnit / scale; - - } - - initialInUnit = initialInUnit * 2; - jQuery.style( elem, prop, initialInUnit + unit ); - - // Make sure we update the tween properties later on - valueParts = valueParts || []; - } - - if ( valueParts ) { - initialInUnit = +initialInUnit || +initial || 0; - - // Apply relative offset (+=/-=) if specified - adjusted = valueParts[ 1 ] ? - initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : - +valueParts[ 2 ]; - if ( tween ) { - tween.unit = unit; - tween.start = initialInUnit; - tween.end = adjusted; - } - } - return adjusted; -} - - -var defaultDisplayMap = {}; - -function getDefaultDisplay( elem ) { - var temp, - doc = elem.ownerDocument, - nodeName = elem.nodeName, - display = defaultDisplayMap[ nodeName ]; - - if ( display ) { - return display; - } - - temp = doc.body.appendChild( doc.createElement( nodeName ) ); - display = jQuery.css( temp, "display" ); - - temp.parentNode.removeChild( temp ); - - if ( display === "none" ) { - display = "block"; - } - defaultDisplayMap[ nodeName ] = display; - - return display; -} - -function showHide( elements, show ) { - var display, elem, - values = [], - index = 0, - length = elements.length; - - // Determine new display value for elements that need to change - for ( ; index < length; index++ ) { - elem = elements[ index ]; - if ( !elem.style ) { - continue; - } - - display = elem.style.display; - if ( show ) { - - // Since we force visibility upon cascade-hidden elements, an immediate (and slow) - // check is required in this first loop unless we have a nonempty display value (either - // inline or about-to-be-restored) - if ( display === "none" ) { - values[ index ] = dataPriv.get( elem, "display" ) || null; - if ( !values[ index ] ) { - elem.style.display = ""; - } - } - if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { - values[ index ] = getDefaultDisplay( elem ); - } - } else { - if ( display !== "none" ) { - values[ index ] = "none"; - - // Remember what we're overwriting - dataPriv.set( elem, "display", display ); - } - } - } - - // Set the display of the elements in a second loop to avoid constant reflow - for ( index = 0; index < length; index++ ) { - if ( values[ index ] != null ) { - elements[ index ].style.display = values[ index ]; - } - } - - return elements; -} - -jQuery.fn.extend( { - show: function() { - return showHide( this, true ); - }, - hide: function() { - return showHide( this ); - }, - toggle: function( state ) { - if ( typeof state === "boolean" ) { - return state ? this.show() : this.hide(); - } - - return this.each( function() { - if ( isHiddenWithinTree( this ) ) { - jQuery( this ).show(); - } else { - jQuery( this ).hide(); - } - } ); - } -} ); -var rcheckableType = ( /^(?:checkbox|radio)$/i ); - -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); - -var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); - - - -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; - - // Support: IE <=9 only - // IE <=9 replaces "; - support.option = !!div.lastChild; -} )(); - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // XHTML parsers do not magically insert elements in the - // same way that tag soup parsers do. So we cannot shorten - // this by omitting or other required elements. - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] -}; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -// Support: IE <=9 only -if ( !support.option ) { - wrapMap.optgroup = wrapMap.option = [ 1, "" ]; -} - - -function getAll( context, tag ) { - - // Support: IE <=9 - 11 only - // Use typeof to avoid zero-argument method invocation on host objects (#15151) - var ret; - - if ( typeof context.getElementsByTagName !== "undefined" ) { - ret = context.getElementsByTagName( tag || "*" ); - - } else if ( typeof context.querySelectorAll !== "undefined" ) { - ret = context.querySelectorAll( tag || "*" ); - - } else { - ret = []; - } - - if ( tag === undefined || tag && nodeName( context, tag ) ) { - return jQuery.merge( [ context ], ret ); - } - - return ret; -} - - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - dataPriv.set( - elems[ i ], - "globalEval", - !refElements || dataPriv.get( refElements[ i ], "globalEval" ) - ); - } -} - - -var rhtml = /<|&#?\w+;/; - -function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, attached, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( toType( elem ) === "object" ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Ensure the created nodes are orphaned (#12392) - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( ( elem = nodes[ i++ ] ) ) { - - // Skip elements already in the context collection (trac-4087) - if ( selection && jQuery.inArray( elem, selection ) > -1 ) { - if ( ignored ) { - ignored.push( elem ); - } - continue; - } - - attached = isAttached( elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( attached ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( ( elem = tmp[ j++ ] ) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; -} - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -// Support: IE <=9 - 11+ -// focus() and blur() are asynchronous, except when they are no-op. -// So expect focus to be synchronous when the element is already active, -// and blur to be synchronous when the element is not already active. -// (focus and blur are always synchronous in other supported browsers, -// this just defines when we can count on it). -function expectSync( elem, type ) { - return ( elem === safeActiveElement() ) === ( type === "focus" ); -} - -// Support: IE <=9 only -// Accessing document.activeElement can throw unexpectedly -// https://bugs.jquery.com/ticket/13393 -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -function on( elem, types, selector, data, fn, one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - on( elem, type, selector, data, types[ type ], one ); - } - return elem; - } - - if ( data == null && fn == null ) { - - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return elem; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return elem.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - } ); -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.get( elem ); - - // Only attach events to objects that accept data - if ( !acceptData( elem ) ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Ensure that invalid selectors throw exceptions at attach time - // Evaluate against documentElement in case elem is a non-element node (e.g., document) - if ( selector ) { - jQuery.find.matchesSelector( documentElement, selector ); - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !( events = elemData.events ) ) { - events = elemData.events = Object.create( null ); - } - if ( !( eventHandle = elemData.handle ) ) { - eventHandle = elemData.handle = function( e ) { - - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend( { - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join( "." ) - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !( handlers = events[ type ] ) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || - special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); - - if ( !elemData || !( events = elemData.events ) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[ 2 ] && - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || - selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || - special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove data and the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - dataPriv.remove( elem, "handle events" ); - } - }, - - dispatch: function( nativeEvent ) { - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - - // Make a writable jQuery.Event from the native event object - event = jQuery.event.fix( nativeEvent ), - - handlers = ( - dataPriv.get( this, "events" ) || Object.create( null ) - )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - for ( i = 1; i < arguments.length; i++ ) { - args[ i ] = arguments[ i ]; - } - - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( ( handleObj = matched.handlers[ j++ ] ) && - !event.isImmediatePropagationStopped() ) { - - // If the event is namespaced, then each handler is only invoked if it is - // specially universal or its namespaces are a superset of the event's. - if ( !event.rnamespace || handleObj.namespace === false || - event.rnamespace.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || - handleObj.handler ).apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( ( event.result = ret ) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, handleObj, sel, matchedHandlers, matchedSelectors, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - if ( delegateCount && - - // Support: IE <=9 - // Black-hole SVG instance trees (trac-13180) - cur.nodeType && - - // Support: Firefox <=42 - // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) - // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click - // Support: IE 11 only - // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) - !( event.type === "click" && event.button >= 1 ) ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { - matchedHandlers = []; - matchedSelectors = {}; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matchedSelectors[ sel ] === undefined ) { - matchedSelectors[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) > -1 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matchedSelectors[ sel ] ) { - matchedHandlers.push( handleObj ); - } - } - if ( matchedHandlers.length ) { - handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); - } - } - } - } - - // Add the remaining (directly-bound) handlers - cur = this; - if ( delegateCount < handlers.length ) { - handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); - } - - return handlerQueue; - }, - - addProp: function( name, hook ) { - Object.defineProperty( jQuery.Event.prototype, name, { - enumerable: true, - configurable: true, - - get: isFunction( hook ) ? - function() { - if ( this.originalEvent ) { - return hook( this.originalEvent ); - } - } : - function() { - if ( this.originalEvent ) { - return this.originalEvent[ name ]; - } - }, - - set: function( value ) { - Object.defineProperty( this, name, { - enumerable: true, - configurable: true, - writable: true, - value: value - } ); - } - } ); - }, - - fix: function( originalEvent ) { - return originalEvent[ jQuery.expando ] ? - originalEvent : - new jQuery.Event( originalEvent ); - }, - - special: { - load: { - - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - click: { - - // Utilize native event to ensure correct state for checkable inputs - setup: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Claim the first handler - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - // dataPriv.set( el, "click", ... ) - leverageNative( el, "click", returnTrue ); - } - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Force setup before triggering a click - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - leverageNative( el, "click" ); - } - - // Return non-false to allow normal event-path propagation - return true; - }, - - // For cross-browser consistency, suppress native .click() on links - // Also prevent it if we're currently inside a leveraged native-event stack - _default: function( event ) { - var target = event.target; - return rcheckableType.test( target.type ) && - target.click && nodeName( target, "input" ) && - dataPriv.get( target, "click" ) || - nodeName( target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - } -}; - -// Ensure the presence of an event listener that handles manually-triggered -// synthetic events by interrupting progress until reinvoked in response to -// *native* events that it fires directly, ensuring that state changes have -// already occurred before other listeners are invoked. -function leverageNative( el, type, expectSync ) { - - // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add - if ( !expectSync ) { - if ( dataPriv.get( el, type ) === undefined ) { - jQuery.event.add( el, type, returnTrue ); - } - return; - } - - // Register the controller as a special universal handler for all event namespaces - dataPriv.set( el, type, false ); - jQuery.event.add( el, type, { - namespace: false, - handler: function( event ) { - var notAsync, result, - saved = dataPriv.get( this, type ); - - if ( ( event.isTrigger & 1 ) && this[ type ] ) { - - // Interrupt processing of the outer synthetic .trigger()ed event - // Saved data should be false in such cases, but might be a leftover capture object - // from an async native handler (gh-4350) - if ( !saved.length ) { - - // Store arguments for use when handling the inner native event - // There will always be at least one argument (an event object), so this array - // will not be confused with a leftover capture object. - saved = slice.call( arguments ); - dataPriv.set( this, type, saved ); - - // Trigger the native event and capture its result - // Support: IE <=9 - 11+ - // focus() and blur() are asynchronous - notAsync = expectSync( this, type ); - this[ type ](); - result = dataPriv.get( this, type ); - if ( saved !== result || notAsync ) { - dataPriv.set( this, type, false ); - } else { - result = {}; - } - if ( saved !== result ) { - - // Cancel the outer synthetic event - event.stopImmediatePropagation(); - event.preventDefault(); - return result.value; - } - - // If this is an inner synthetic event for an event with a bubbling surrogate - // (focus or blur), assume that the surrogate already propagated from triggering the - // native event and prevent that from happening again here. - // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the - // bubbling surrogate propagates *after* the non-bubbling base), but that seems - // less bad than duplication. - } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { - event.stopPropagation(); - } - - // If this is a native event triggered above, everything is now in order - // Fire an inner synthetic event with the original arguments - } else if ( saved.length ) { - - // ...and capture the result - dataPriv.set( this, type, { - value: jQuery.event.trigger( - - // Support: IE <=9 - 11+ - // Extend with the prototype to reset the above stopImmediatePropagation() - jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), - saved.slice( 1 ), - this - ) - } ); - - // Abort handling of the native event - event.stopImmediatePropagation(); - } - } - } ); -} - -jQuery.removeEvent = function( elem, type, handle ) { - - // This "if" is needed for plain objects - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle ); - } -}; - -jQuery.Event = function( src, props ) { - - // Allow instantiation without the 'new' keyword - if ( !( this instanceof jQuery.Event ) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - - // Support: Android <=2.3 only - src.returnValue === false ? - returnTrue : - returnFalse; - - // Create target properties - // Support: Safari <=6 - 7 only - // Target should not be a text node (#504, #13143) - this.target = ( src.target && src.target.nodeType === 3 ) ? - src.target.parentNode : - src.target; - - this.currentTarget = src.currentTarget; - this.relatedTarget = src.relatedTarget; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || Date.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - constructor: jQuery.Event, - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - isSimulated: false, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && !this.isSimulated ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Includes all common event props including KeyEvent and MouseEvent specific props -jQuery.each( { - altKey: true, - bubbles: true, - cancelable: true, - changedTouches: true, - ctrlKey: true, - detail: true, - eventPhase: true, - metaKey: true, - pageX: true, - pageY: true, - shiftKey: true, - view: true, - "char": true, - code: true, - charCode: true, - key: true, - keyCode: true, - button: true, - buttons: true, - clientX: true, - clientY: true, - offsetX: true, - offsetY: true, - pointerId: true, - pointerType: true, - screenX: true, - screenY: true, - targetTouches: true, - toElement: true, - touches: true, - - which: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, jQuery.event.addProp ); - -jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { - jQuery.event.special[ type ] = { - - // Utilize native event if possible so blur/focus sequence is correct - setup: function() { - - // Claim the first handler - // dataPriv.set( this, "focus", ... ) - // dataPriv.set( this, "blur", ... ) - leverageNative( this, type, expectSync ); - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function() { - - // Force setup before trigger - leverageNative( this, type ); - - // Return non-false to allow normal event-path propagation - return true; - }, - - delegateType: delegateType - }; -} ); - -// Create mouseenter/leave events using mouseover/out and event-time checks -// so that event delegation works in jQuery. -// Do the same for pointerenter/pointerleave and pointerover/pointerout -// -// Support: Safari 7 only -// Safari sends mouseenter too often; see: -// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 -// for the description of the bug (it existed in older Chrome versions as well). -jQuery.each( { - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mouseenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -} ); - -jQuery.fn.extend( { - - on: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn ); - }, - one: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? - handleObj.origType + "." + handleObj.namespace : - handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each( function() { - jQuery.event.remove( this, types, fn, selector ); - } ); - } -} ); - - -var - - // Support: IE <=10 - 11, Edge 12 - 13 only - // In IE/Edge using regex groups here causes severe slowdowns. - // See https://connect.microsoft.com/IE/feedback/details/1736512/ - rnoInnerhtml = /\s*$/g; - -// Prefer a tbody over its parent table for containing new rows -function manipulationTarget( elem, content ) { - if ( nodeName( elem, "table" ) && - nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - - return jQuery( elem ).children( "tbody" )[ 0 ] || elem; - } - - return elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { - elem.type = elem.type.slice( 5 ); - } else { - elem.removeAttribute( "type" ); - } - - return elem; -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.get( src ); - events = pdataOld.events; - - if ( events ) { - dataPriv.remove( dest, "handle events" ); - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( dataUser.hasData( src ) ) { - udataOld = dataUser.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - dataUser.set( dest, udataCur ); - } -} - -// Fix IE bugs, see support tests -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -function domManip( collection, args, callback, ignored ) { - - // Flatten any nested arrays - args = flat( args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = collection.length, - iNoClone = l - 1, - value = args[ 0 ], - valueIsFunction = isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( valueIsFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return collection.each( function( index ) { - var self = collection.eq( index ); - if ( valueIsFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - domManip( self, args, callback, ignored ); - } ); - } - - if ( l ) { - fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - // Require either new content or an interest in ignored elements to invoke the callback - if ( first || ignored ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item - // instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( collection[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !dataPriv.access( node, "globalEval" ) && - jQuery.contains( doc, node ) ) { - - if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { - - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl && !node.noModule ) { - jQuery._evalUrl( node.src, { - nonce: node.nonce || node.getAttribute( "nonce" ) - }, doc ); - } - } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); - } - } - } - } - } - } - - return collection; -} - -function remove( elem, selector, keepData ) { - var node, - nodes = selector ? jQuery.filter( selector, elem ) : elem, - i = 0; - - for ( ; ( node = nodes[ i ] ) != null; i++ ) { - if ( !keepData && node.nodeType === 1 ) { - jQuery.cleanData( getAll( node ) ); - } - - if ( node.parentNode ) { - if ( keepData && isAttached( node ) ) { - setGlobalEval( getAll( node, "script" ) ); - } - node.parentNode.removeChild( node ); - } - } - - return elem; -} - -jQuery.extend( { - htmlPrefilter: function( html ) { - return html; - }, - - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = isAttached( elem ); - - // Fix IE cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - cleanData: function( elems ) { - var data, elem, type, - special = jQuery.event.special, - i = 0; - - for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { - if ( acceptData( elem ) ) { - if ( ( data = elem[ dataPriv.expando ] ) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataPriv.expando ] = undefined; - } - if ( elem[ dataUser.expando ] ) { - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataUser.expando ] = undefined; - } - } - } - } -} ); - -jQuery.fn.extend( { - detach: function( selector ) { - return remove( this, selector, true ); - }, - - remove: function( selector ) { - return remove( this, selector ); - }, - - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each( function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - } ); - }, null, value, arguments.length ); - }, - - append: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - } ); - }, - - prepend: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - } ); - }, - - before: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - } ); - }, - - after: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - } ); - }, - - empty: function() { - var elem, - i = 0; - - for ( ; ( elem = this[ i ] ) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map( function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - } ); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = jQuery.htmlPrefilter( value ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch ( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var ignored = []; - - // Make the changes, replacing each non-ignored context element with the new content - return domManip( this, arguments, function( elem ) { - var parent = this.parentNode; - - if ( jQuery.inArray( this, ignored ) < 0 ) { - jQuery.cleanData( getAll( this ) ); - if ( parent ) { - parent.replaceChild( elem, this ); - } - } - - // Force callback invocation - }, ignored ); - } -} ); - -jQuery.each( { - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: Android <=4.0 only, PhantomJS 1 only - // .get() because push.apply(_, arraylike) throws on ancient WebKit - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -} ); -var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); - -var getStyles = function( elem ) { - - // Support: IE <=11 only, Firefox <=30 (#15098, #14150) - // IE throws on elements created in popups - // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" - var view = elem.ownerDocument.defaultView; - - if ( !view || !view.opener ) { - view = window; - } - - return view.getComputedStyle( elem ); - }; - -var swap = function( elem, options, callback ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.call( elem ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - -var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); - - - -( function() { - - // Executing both pixelPosition & boxSizingReliable tests require only one layout - // so they're executed at the same time to save the second computation. - function computeStyleTests() { - - // This is a singleton, we need to execute it only once - if ( !div ) { - return; - } - - container.style.cssText = "position:absolute;left:-11111px;width:60px;" + - "margin-top:1px;padding:0;border:0"; - div.style.cssText = - "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + - "margin:auto;border:1px;padding:1px;" + - "width:60%;top:1%"; - documentElement.appendChild( container ).appendChild( div ); - - var divStyle = window.getComputedStyle( div ); - pixelPositionVal = divStyle.top !== "1%"; - - // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - - // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 - // Some styles come back with percentage values, even though they shouldn't - div.style.right = "60%"; - pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; - - // Support: IE 9 - 11 only - // Detect misreporting of content dimensions for box-sizing:border-box elements - boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; - - // Support: IE 9 only - // Detect overflow:scroll screwiness (gh-3699) - // Support: Chrome <=64 - // Don't get tricked when zoom affects offsetWidth (gh-4029) - div.style.position = "absolute"; - scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; - - documentElement.removeChild( container ); - - // Nullify the div so it wouldn't be stored in the memory and - // it will also be a sign that checks already performed - div = null; - } - - function roundPixelMeasures( measure ) { - return Math.round( parseFloat( measure ) ); - } - - var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, - reliableTrDimensionsVal, reliableMarginLeftVal, - container = document.createElement( "div" ), - div = document.createElement( "div" ); - - // Finish early in limited (non-browser) environments - if ( !div.style ) { - return; - } - - // Support: IE <=9 - 11 only - // Style of cloned element affects source element cloned (#8908) - div.style.backgroundClip = "content-box"; - div.cloneNode( true ).style.backgroundClip = ""; - support.clearCloneStyle = div.style.backgroundClip === "content-box"; - - jQuery.extend( support, { - boxSizingReliable: function() { - computeStyleTests(); - return boxSizingReliableVal; - }, - pixelBoxStyles: function() { - computeStyleTests(); - return pixelBoxStylesVal; - }, - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, - reliableMarginLeft: function() { - computeStyleTests(); - return reliableMarginLeftVal; - }, - scrollboxSize: function() { - computeStyleTests(); - return scrollboxSizeVal; - }, - - // Support: IE 9 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Behavior in IE 9 is more subtle than in newer versions & it passes - // some versions of this test; make sure not to make it pass there! - reliableTrDimensions: function() { - var table, tr, trChild, trStyle; - if ( reliableTrDimensionsVal == null ) { - table = document.createElement( "table" ); - tr = document.createElement( "tr" ); - trChild = document.createElement( "div" ); - - table.style.cssText = "position:absolute;left:-11111px"; - tr.style.height = "1px"; - trChild.style.height = "9px"; - - documentElement - .appendChild( table ) - .appendChild( tr ) - .appendChild( trChild ); - - trStyle = window.getComputedStyle( tr ); - reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; - - documentElement.removeChild( table ); - } - return reliableTrDimensionsVal; - } - } ); -} )(); - - -function curCSS( elem, name, computed ) { - var width, minWidth, maxWidth, ret, - - // Support: Firefox 51+ - // Retrieving style before computed somehow - // fixes an issue with getting wrong values - // on detached elements - style = elem.style; - - computed = computed || getStyles( elem ); - - // getPropertyValue is needed for: - // .css('filter') (IE 9 only, #12537) - // .css('--customProperty) (#3144) - if ( computed ) { - ret = computed.getPropertyValue( name ) || computed[ name ]; - - if ( ret === "" && !isAttached( elem ) ) { - ret = jQuery.style( elem, name ); - } - - // A tribute to the "awesome hack by Dean Edwards" - // Android Browser returns percentage for some values, - // but width seems to be reliably pixels. - // This is against the CSSOM draft spec: - // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { - - // Remember the original values - width = style.width; - minWidth = style.minWidth; - maxWidth = style.maxWidth; - - // Put in the new values to get a computed value out - style.minWidth = style.maxWidth = style.width = ret; - ret = computed.width; - - // Revert the changed values - style.width = width; - style.minWidth = minWidth; - style.maxWidth = maxWidth; - } - } - - return ret !== undefined ? - - // Support: IE <=9 - 11 only - // IE returns zIndex value as an integer. - ret + "" : - ret; -} - - -function addGetHookIf( conditionFn, hookFn ) { - - // Define the hook, we'll check on the first run if it's really needed. - return { - get: function() { - if ( conditionFn() ) { - - // Hook not needed (or it's not possible to use it due - // to missing dependency), remove it. - delete this.get; - return; - } - - // Hook needed; redefine it so that the support test is not executed again. - return ( this.get = hookFn ).apply( this, arguments ); - } - }; -} - - -var cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style, - vendorProps = {}; - -// Return a vendor-prefixed property or undefined -function vendorPropName( name ) { - - // Check for vendor prefixed names - var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), - i = cssPrefixes.length; - - while ( i-- ) { - name = cssPrefixes[ i ] + capName; - if ( name in emptyStyle ) { - return name; - } - } -} - -// Return a potentially-mapped jQuery.cssProps or vendor prefixed property -function finalPropName( name ) { - var final = jQuery.cssProps[ name ] || vendorProps[ name ]; - - if ( final ) { - return final; - } - if ( name in emptyStyle ) { - return name; - } - return vendorProps[ name ] = vendorPropName( name ) || name; -} - - -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }; - -function setPositiveNumber( _elem, value, subtract ) { - - // Any relative (+/-) values have already been - // normalized at this point - var matches = rcssNum.exec( value ); - return matches ? - - // Guard against undefined "subtract", e.g., when used as in cssHooks - Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : - value; -} - -function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { - var i = dimension === "width" ? 1 : 0, - extra = 0, - delta = 0; - - // Adjustment may not be necessary - if ( box === ( isBorderBox ? "border" : "content" ) ) { - return 0; - } - - for ( ; i < 4; i += 2 ) { - - // Both box models exclude margin - if ( box === "margin" ) { - delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); - } - - // If we get here with a content-box, we're seeking "padding" or "border" or "margin" - if ( !isBorderBox ) { - - // Add padding - delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - - // For "border" or "margin", add border - if ( box !== "padding" ) { - delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - - // But still keep track of it otherwise - } else { - extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - - // If we get here with a border-box (content + padding + border), we're seeking "content" or - // "padding" or "margin" - } else { - - // For "content", subtract padding - if ( box === "content" ) { - delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } - - // For "content" or "padding", subtract border - if ( box !== "margin" ) { - delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - } - } - - // Account for positive content-box scroll gutter when requested by providing computedVal - if ( !isBorderBox && computedVal >= 0 ) { - - // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border - // Assuming integer scroll gutter, subtract the rest and round down - delta += Math.max( 0, Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - computedVal - - delta - - extra - - 0.5 - - // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter - // Use an explicit zero to avoid NaN (gh-3964) - ) ) || 0; - } - - return delta; -} - -function getWidthOrHeight( elem, dimension, extra ) { - - // Start with computed style - var styles = getStyles( elem ), - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). - // Fake content-box until we know it's needed to know the true value. - boxSizingNeeded = !support.boxSizingReliable() || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - valueIsBorderBox = isBorderBox, - - val = curCSS( elem, dimension, styles ), - offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); - - // Support: Firefox <=54 - // Return a confounding non-pixel value or feign ignorance, as appropriate. - if ( rnumnonpx.test( val ) ) { - if ( !extra ) { - return val; - } - val = "auto"; - } - - - // Support: IE 9 - 11 only - // Use offsetWidth/offsetHeight for when box sizing is unreliable. - // In those cases, the computed value can be trusted to be border-box. - if ( ( !support.boxSizingReliable() && isBorderBox || - - // Support: IE 10 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Interestingly, in some cases IE 9 doesn't suffer from this issue. - !support.reliableTrDimensions() && nodeName( elem, "tr" ) || - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - val === "auto" || - - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - - // Make sure the element is visible & connected - elem.getClientRects().length ) { - - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; - - // Where available, offsetWidth/offsetHeight approximate border box dimensions. - // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the - // retrieved value as a content box dimension. - valueIsBorderBox = offsetProp in elem; - if ( valueIsBorderBox ) { - val = elem[ offsetProp ]; - } - } - - // Normalize "" and auto - val = parseFloat( val ) || 0; - - // Adjust for the element's box model - return ( val + - boxModelAdjustment( - elem, - dimension, - extra || ( isBorderBox ? "border" : "content" ), - valueIsBorderBox, - styles, - - // Provide the current computed size to request scroll gutter calculation (gh-3589) - val - ) - ) + "px"; -} - -jQuery.extend( { - - // Add in style property hooks for overriding the default - // behavior of getting and setting a style property - cssHooks: { - opacity: { - get: function( elem, computed ) { - if ( computed ) { - - // We should always get a number back from opacity - var ret = curCSS( elem, "opacity" ); - return ret === "" ? "1" : ret; - } - } - } - }, - - // Don't automatically add "px" to these possibly-unitless properties - cssNumber: { - "animationIterationCount": true, - "columnCount": true, - "fillOpacity": true, - "flexGrow": true, - "flexShrink": true, - "fontWeight": true, - "gridArea": true, - "gridColumn": true, - "gridColumnEnd": true, - "gridColumnStart": true, - "gridRow": true, - "gridRowEnd": true, - "gridRowStart": true, - "lineHeight": true, - "opacity": true, - "order": true, - "orphans": true, - "widows": true, - "zIndex": true, - "zoom": true - }, - - // Add in properties whose names you wish to fix before - // setting or getting the value - cssProps: {}, - - // Get and set the style property on a DOM Node - style: function( elem, name, value, extra ) { - - // Don't set styles on text and comment nodes - if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { - return; - } - - // Make sure that we're working with the right name - var ret, type, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ), - style = elem.style; - - // Make sure that we're working with the right name. We don't - // want to query the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Gets hook for the prefixed version, then unprefixed version - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // Check if we're setting a value - if ( value !== undefined ) { - type = typeof value; - - // Convert "+=" or "-=" to relative numbers (#7345) - if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { - value = adjustCSS( elem, name, ret ); - - // Fixes bug #9237 - type = "number"; - } - - // Make sure that null and NaN values aren't set (#7116) - if ( value == null || value !== value ) { - return; - } - - // If a number was passed in, add the unit (except for certain CSS properties) - // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append - // "px" to a few hardcoded values. - if ( type === "number" && !isCustomProp ) { - value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); - } - - // background-* props affect original clone's values - if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { - style[ name ] = "inherit"; - } - - // If a hook was provided, use that value, otherwise just set the specified value - if ( !hooks || !( "set" in hooks ) || - ( value = hooks.set( elem, value, extra ) ) !== undefined ) { - - if ( isCustomProp ) { - style.setProperty( name, value ); - } else { - style[ name ] = value; - } - } - - } else { - - // If a hook was provided get the non-computed value from there - if ( hooks && "get" in hooks && - ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { - - return ret; - } - - // Otherwise just get the value from the style object - return style[ name ]; - } - }, - - css: function( elem, name, extra, styles ) { - var val, num, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ); - - // Make sure that we're working with the right name. We don't - // want to modify the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Try prefixed name followed by the unprefixed name - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // If a hook was provided get the computed value from there - if ( hooks && "get" in hooks ) { - val = hooks.get( elem, true, extra ); - } - - // Otherwise, if a way to get the computed value exists, use that - if ( val === undefined ) { - val = curCSS( elem, name, styles ); - } - - // Convert "normal" to computed value - if ( val === "normal" && name in cssNormalTransform ) { - val = cssNormalTransform[ name ]; - } - - // Make numeric if forced or a qualifier was provided and val looks numeric - if ( extra === "" || extra ) { - num = parseFloat( val ); - return extra === true || isFinite( num ) ? num || 0 : val; - } - - return val; - } -} ); - -jQuery.each( [ "height", "width" ], function( _i, dimension ) { - jQuery.cssHooks[ dimension ] = { - get: function( elem, computed, extra ) { - if ( computed ) { - - // Certain elements can have dimension info if we invisibly show them - // but it must have a current display style that would benefit - return rdisplayswap.test( jQuery.css( elem, "display" ) ) && - - // Support: Safari 8+ - // Table columns in Safari have non-zero offsetWidth & zero - // getBoundingClientRect().width unless display is changed. - // Support: IE <=11 only - // Running getBoundingClientRect on a disconnected node - // in IE throws an error. - ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? - swap( elem, cssShow, function() { - return getWidthOrHeight( elem, dimension, extra ); - } ) : - getWidthOrHeight( elem, dimension, extra ); - } - }, - - set: function( elem, value, extra ) { - var matches, - styles = getStyles( elem ), - - // Only read styles.position if the test has a chance to fail - // to avoid forcing a reflow. - scrollboxSizeBuggy = !support.scrollboxSize() && - styles.position === "absolute", - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) - boxSizingNeeded = scrollboxSizeBuggy || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - subtract = extra ? - boxModelAdjustment( - elem, - dimension, - extra, - isBorderBox, - styles - ) : - 0; - - // Account for unreliable border-box dimensions by comparing offset* to computed and - // faking a content-box to get border and padding (gh-3699) - if ( isBorderBox && scrollboxSizeBuggy ) { - subtract -= Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - parseFloat( styles[ dimension ] ) - - boxModelAdjustment( elem, dimension, "border", false, styles ) - - 0.5 - ); - } - - // Convert to pixels if value adjustment is needed - if ( subtract && ( matches = rcssNum.exec( value ) ) && - ( matches[ 3 ] || "px" ) !== "px" ) { - - elem.style[ dimension ] = value; - value = jQuery.css( elem, dimension ); - } - - return setPositiveNumber( elem, value, subtract ); - } - }; -} ); - -jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, - function( elem, computed ) { - if ( computed ) { - return ( parseFloat( curCSS( elem, "marginLeft" ) ) || - elem.getBoundingClientRect().left - - swap( elem, { marginLeft: 0 }, function() { - return elem.getBoundingClientRect().left; - } ) - ) + "px"; - } - } -); - -// These hooks are used by animate to expand properties -jQuery.each( { - margin: "", - padding: "", - border: "Width" -}, function( prefix, suffix ) { - jQuery.cssHooks[ prefix + suffix ] = { - expand: function( value ) { - var i = 0, - expanded = {}, - - // Assumes a single number if not a string - parts = typeof value === "string" ? value.split( " " ) : [ value ]; - - for ( ; i < 4; i++ ) { - expanded[ prefix + cssExpand[ i ] + suffix ] = - parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; - } - - return expanded; - } - }; - - if ( prefix !== "margin" ) { - jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; - } -} ); - -jQuery.fn.extend( { - css: function( name, value ) { - return access( this, function( elem, name, value ) { - var styles, len, - map = {}, - i = 0; - - if ( Array.isArray( name ) ) { - styles = getStyles( elem ); - len = name.length; - - for ( ; i < len; i++ ) { - map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); - } - - return map; - } - - return value !== undefined ? - jQuery.style( elem, name, value ) : - jQuery.css( elem, name ); - }, name, value, arguments.length > 1 ); - } -} ); - - -function Tween( elem, options, prop, end, easing ) { - return new Tween.prototype.init( elem, options, prop, end, easing ); -} -jQuery.Tween = Tween; - -Tween.prototype = { - constructor: Tween, - init: function( elem, options, prop, end, easing, unit ) { - this.elem = elem; - this.prop = prop; - this.easing = easing || jQuery.easing._default; - this.options = options; - this.start = this.now = this.cur(); - this.end = end; - this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); - }, - cur: function() { - var hooks = Tween.propHooks[ this.prop ]; - - return hooks && hooks.get ? - hooks.get( this ) : - Tween.propHooks._default.get( this ); - }, - run: function( percent ) { - var eased, - hooks = Tween.propHooks[ this.prop ]; - - if ( this.options.duration ) { - this.pos = eased = jQuery.easing[ this.easing ]( - percent, this.options.duration * percent, 0, 1, this.options.duration - ); - } else { - this.pos = eased = percent; - } - this.now = ( this.end - this.start ) * eased + this.start; - - if ( this.options.step ) { - this.options.step.call( this.elem, this.now, this ); - } - - if ( hooks && hooks.set ) { - hooks.set( this ); - } else { - Tween.propHooks._default.set( this ); - } - return this; - } -}; - -Tween.prototype.init.prototype = Tween.prototype; - -Tween.propHooks = { - _default: { - get: function( tween ) { - var result; - - // Use a property on the element directly when it is not a DOM element, - // or when there is no matching style property that exists. - if ( tween.elem.nodeType !== 1 || - tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { - return tween.elem[ tween.prop ]; - } - - // Passing an empty string as a 3rd parameter to .css will automatically - // attempt a parseFloat and fallback to a string if the parse fails. - // Simple values such as "10px" are parsed to Float; - // complex values such as "rotate(1rad)" are returned as-is. - result = jQuery.css( tween.elem, tween.prop, "" ); - - // Empty strings, null, undefined and "auto" are converted to 0. - return !result || result === "auto" ? 0 : result; - }, - set: function( tween ) { - - // Use step hook for back compat. - // Use cssHook if its there. - // Use .style if available and use plain properties where available. - if ( jQuery.fx.step[ tween.prop ] ) { - jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && ( - jQuery.cssHooks[ tween.prop ] || - tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { - jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); - } else { - tween.elem[ tween.prop ] = tween.now; - } - } - } -}; - -// Support: IE <=9 only -// Panic based approach to setting things on disconnected nodes -Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { - set: function( tween ) { - if ( tween.elem.nodeType && tween.elem.parentNode ) { - tween.elem[ tween.prop ] = tween.now; - } - } -}; - -jQuery.easing = { - linear: function( p ) { - return p; - }, - swing: function( p ) { - return 0.5 - Math.cos( p * Math.PI ) / 2; - }, - _default: "swing" -}; - -jQuery.fx = Tween.prototype.init; - -// Back compat <1.8 extension point -jQuery.fx.step = {}; - - - - -var - fxNow, inProgress, - rfxtypes = /^(?:toggle|show|hide)$/, - rrun = /queueHooks$/; - -function schedule() { - if ( inProgress ) { - if ( document.hidden === false && window.requestAnimationFrame ) { - window.requestAnimationFrame( schedule ); - } else { - window.setTimeout( schedule, jQuery.fx.interval ); - } - - jQuery.fx.tick(); - } -} - -// Animations created synchronously will run synchronously -function createFxNow() { - window.setTimeout( function() { - fxNow = undefined; - } ); - return ( fxNow = Date.now() ); -} - -// Generate parameters to create a standard animation -function genFx( type, includeWidth ) { - var which, - i = 0, - attrs = { height: type }; - - // If we include width, step value is 1 to do all cssExpand values, - // otherwise step value is 2 to skip over Left and Right - includeWidth = includeWidth ? 1 : 0; - for ( ; i < 4; i += 2 - includeWidth ) { - which = cssExpand[ i ]; - attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; - } - - if ( includeWidth ) { - attrs.opacity = attrs.width = type; - } - - return attrs; -} - -function createTween( value, prop, animation ) { - var tween, - collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), - index = 0, - length = collection.length; - for ( ; index < length; index++ ) { - if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { - - // We're done with this property - return tween; - } - } -} - -function defaultPrefilter( elem, props, opts ) { - var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, - isBox = "width" in props || "height" in props, - anim = this, - orig = {}, - style = elem.style, - hidden = elem.nodeType && isHiddenWithinTree( elem ), - dataShow = dataPriv.get( elem, "fxshow" ); - - // Queue-skipping animations hijack the fx hooks - if ( !opts.queue ) { - hooks = jQuery._queueHooks( elem, "fx" ); - if ( hooks.unqueued == null ) { - hooks.unqueued = 0; - oldfire = hooks.empty.fire; - hooks.empty.fire = function() { - if ( !hooks.unqueued ) { - oldfire(); - } - }; - } - hooks.unqueued++; - - anim.always( function() { - - // Ensure the complete handler is called before this completes - anim.always( function() { - hooks.unqueued--; - if ( !jQuery.queue( elem, "fx" ).length ) { - hooks.empty.fire(); - } - } ); - } ); - } - - // Detect show/hide animations - for ( prop in props ) { - value = props[ prop ]; - if ( rfxtypes.test( value ) ) { - delete props[ prop ]; - toggle = toggle || value === "toggle"; - if ( value === ( hidden ? "hide" : "show" ) ) { - - // Pretend to be hidden if this is a "show" and - // there is still data from a stopped show/hide - if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { - hidden = true; - - // Ignore all other no-op show/hide data - } else { - continue; - } - } - orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); - } - } - - // Bail out if this is a no-op like .hide().hide() - propTween = !jQuery.isEmptyObject( props ); - if ( !propTween && jQuery.isEmptyObject( orig ) ) { - return; - } - - // Restrict "overflow" and "display" styles during box animations - if ( isBox && elem.nodeType === 1 ) { - - // Support: IE <=9 - 11, Edge 12 - 15 - // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY and Edge just mirrors - // the overflowX value there. - opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; - - // Identify a display type, preferring old show/hide data over the CSS cascade - restoreDisplay = dataShow && dataShow.display; - if ( restoreDisplay == null ) { - restoreDisplay = dataPriv.get( elem, "display" ); - } - display = jQuery.css( elem, "display" ); - if ( display === "none" ) { - if ( restoreDisplay ) { - display = restoreDisplay; - } else { - - // Get nonempty value(s) by temporarily forcing visibility - showHide( [ elem ], true ); - restoreDisplay = elem.style.display || restoreDisplay; - display = jQuery.css( elem, "display" ); - showHide( [ elem ] ); - } - } - - // Animate inline elements as inline-block - if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { - if ( jQuery.css( elem, "float" ) === "none" ) { - - // Restore the original display value at the end of pure show/hide animations - if ( !propTween ) { - anim.done( function() { - style.display = restoreDisplay; - } ); - if ( restoreDisplay == null ) { - display = style.display; - restoreDisplay = display === "none" ? "" : display; - } - } - style.display = "inline-block"; - } - } - } - - if ( opts.overflow ) { - style.overflow = "hidden"; - anim.always( function() { - style.overflow = opts.overflow[ 0 ]; - style.overflowX = opts.overflow[ 1 ]; - style.overflowY = opts.overflow[ 2 ]; - } ); - } - - // Implement show/hide animations - propTween = false; - for ( prop in orig ) { - - // General show/hide setup for this element animation - if ( !propTween ) { - if ( dataShow ) { - if ( "hidden" in dataShow ) { - hidden = dataShow.hidden; - } - } else { - dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); - } - - // Store hidden/visible for toggle so `.stop().toggle()` "reverses" - if ( toggle ) { - dataShow.hidden = !hidden; - } - - // Show elements before animating them - if ( hidden ) { - showHide( [ elem ], true ); - } - - /* eslint-disable no-loop-func */ - - anim.done( function() { - - /* eslint-enable no-loop-func */ - - // The final step of a "hide" animation is actually hiding the element - if ( !hidden ) { - showHide( [ elem ] ); - } - dataPriv.remove( elem, "fxshow" ); - for ( prop in orig ) { - jQuery.style( elem, prop, orig[ prop ] ); - } - } ); - } - - // Per-property setup - propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); - if ( !( prop in dataShow ) ) { - dataShow[ prop ] = propTween.start; - if ( hidden ) { - propTween.end = propTween.start; - propTween.start = 0; - } - } - } -} - -function propFilter( props, specialEasing ) { - var index, name, easing, value, hooks; - - // camelCase, specialEasing and expand cssHook pass - for ( index in props ) { - name = camelCase( index ); - easing = specialEasing[ name ]; - value = props[ index ]; - if ( Array.isArray( value ) ) { - easing = value[ 1 ]; - value = props[ index ] = value[ 0 ]; - } - - if ( index !== name ) { - props[ name ] = value; - delete props[ index ]; - } - - hooks = jQuery.cssHooks[ name ]; - if ( hooks && "expand" in hooks ) { - value = hooks.expand( value ); - delete props[ name ]; - - // Not quite $.extend, this won't overwrite existing keys. - // Reusing 'index' because we have the correct "name" - for ( index in value ) { - if ( !( index in props ) ) { - props[ index ] = value[ index ]; - specialEasing[ index ] = easing; - } - } - } else { - specialEasing[ name ] = easing; - } - } -} - -function Animation( elem, properties, options ) { - var result, - stopped, - index = 0, - length = Animation.prefilters.length, - deferred = jQuery.Deferred().always( function() { - - // Don't match elem in the :animated selector - delete tick.elem; - } ), - tick = function() { - if ( stopped ) { - return false; - } - var currentTime = fxNow || createFxNow(), - remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), - - // Support: Android 2.3 only - // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) - temp = remaining / animation.duration || 0, - percent = 1 - temp, - index = 0, - length = animation.tweens.length; - - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( percent ); - } - - deferred.notifyWith( elem, [ animation, percent, remaining ] ); - - // If there's more to do, yield - if ( percent < 1 && length ) { - return remaining; - } - - // If this was an empty animation, synthesize a final progress notification - if ( !length ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - } - - // Resolve the animation and report its conclusion - deferred.resolveWith( elem, [ animation ] ); - return false; - }, - animation = deferred.promise( { - elem: elem, - props: jQuery.extend( {}, properties ), - opts: jQuery.extend( true, { - specialEasing: {}, - easing: jQuery.easing._default - }, options ), - originalProperties: properties, - originalOptions: options, - startTime: fxNow || createFxNow(), - duration: options.duration, - tweens: [], - createTween: function( prop, end ) { - var tween = jQuery.Tween( elem, animation.opts, prop, end, - animation.opts.specialEasing[ prop ] || animation.opts.easing ); - animation.tweens.push( tween ); - return tween; - }, - stop: function( gotoEnd ) { - var index = 0, - - // If we are going to the end, we want to run all the tweens - // otherwise we skip this part - length = gotoEnd ? animation.tweens.length : 0; - if ( stopped ) { - return this; - } - stopped = true; - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( 1 ); - } - - // Resolve when we played the last frame; otherwise, reject - if ( gotoEnd ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - deferred.resolveWith( elem, [ animation, gotoEnd ] ); - } else { - deferred.rejectWith( elem, [ animation, gotoEnd ] ); - } - return this; - } - } ), - props = animation.props; - - propFilter( props, animation.opts.specialEasing ); - - for ( ; index < length; index++ ) { - result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); - if ( result ) { - if ( isFunction( result.stop ) ) { - jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - result.stop.bind( result ); - } - return result; - } - } - - jQuery.map( props, createTween, animation ); - - if ( isFunction( animation.opts.start ) ) { - animation.opts.start.call( elem, animation ); - } - - // Attach callbacks from options - animation - .progress( animation.opts.progress ) - .done( animation.opts.done, animation.opts.complete ) - .fail( animation.opts.fail ) - .always( animation.opts.always ); - - jQuery.fx.timer( - jQuery.extend( tick, { - elem: elem, - anim: animation, - queue: animation.opts.queue - } ) - ); - - return animation; -} - -jQuery.Animation = jQuery.extend( Animation, { - - tweeners: { - "*": [ function( prop, value ) { - var tween = this.createTween( prop, value ); - adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); - return tween; - } ] - }, - - tweener: function( props, callback ) { - if ( isFunction( props ) ) { - callback = props; - props = [ "*" ]; - } else { - props = props.match( rnothtmlwhite ); - } - - var prop, - index = 0, - length = props.length; - - for ( ; index < length; index++ ) { - prop = props[ index ]; - Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; - Animation.tweeners[ prop ].unshift( callback ); - } - }, - - prefilters: [ defaultPrefilter ], - - prefilter: function( callback, prepend ) { - if ( prepend ) { - Animation.prefilters.unshift( callback ); - } else { - Animation.prefilters.push( callback ); - } - } -} ); - -jQuery.speed = function( speed, easing, fn ) { - var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { - complete: fn || !fn && easing || - isFunction( speed ) && speed, - duration: speed, - easing: fn && easing || easing && !isFunction( easing ) && easing - }; - - // Go to the end state if fx are off - if ( jQuery.fx.off ) { - opt.duration = 0; - - } else { - if ( typeof opt.duration !== "number" ) { - if ( opt.duration in jQuery.fx.speeds ) { - opt.duration = jQuery.fx.speeds[ opt.duration ]; - - } else { - opt.duration = jQuery.fx.speeds._default; - } - } - } - - // Normalize opt.queue - true/undefined/null -> "fx" - if ( opt.queue == null || opt.queue === true ) { - opt.queue = "fx"; - } - - // Queueing - opt.old = opt.complete; - - opt.complete = function() { - if ( isFunction( opt.old ) ) { - opt.old.call( this ); - } - - if ( opt.queue ) { - jQuery.dequeue( this, opt.queue ); - } - }; - - return opt; -}; - -jQuery.fn.extend( { - fadeTo: function( speed, to, easing, callback ) { - - // Show any hidden elements after setting opacity to 0 - return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() - - // Animate to the value specified - .end().animate( { opacity: to }, speed, easing, callback ); - }, - animate: function( prop, speed, easing, callback ) { - var empty = jQuery.isEmptyObject( prop ), - optall = jQuery.speed( speed, easing, callback ), - doAnimation = function() { - - // Operate on a copy of prop so per-property easing won't be lost - var anim = Animation( this, jQuery.extend( {}, prop ), optall ); - - // Empty animations, or finishing resolves immediately - if ( empty || dataPriv.get( this, "finish" ) ) { - anim.stop( true ); - } - }; - doAnimation.finish = doAnimation; - - return empty || optall.queue === false ? - this.each( doAnimation ) : - this.queue( optall.queue, doAnimation ); - }, - stop: function( type, clearQueue, gotoEnd ) { - var stopQueue = function( hooks ) { - var stop = hooks.stop; - delete hooks.stop; - stop( gotoEnd ); - }; - - if ( typeof type !== "string" ) { - gotoEnd = clearQueue; - clearQueue = type; - type = undefined; - } - if ( clearQueue ) { - this.queue( type || "fx", [] ); - } - - return this.each( function() { - var dequeue = true, - index = type != null && type + "queueHooks", - timers = jQuery.timers, - data = dataPriv.get( this ); - - if ( index ) { - if ( data[ index ] && data[ index ].stop ) { - stopQueue( data[ index ] ); - } - } else { - for ( index in data ) { - if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { - stopQueue( data[ index ] ); - } - } - } - - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && - ( type == null || timers[ index ].queue === type ) ) { - - timers[ index ].anim.stop( gotoEnd ); - dequeue = false; - timers.splice( index, 1 ); - } - } - - // Start the next in the queue if the last step wasn't forced. - // Timers currently will call their complete callbacks, which - // will dequeue but only if they were gotoEnd. - if ( dequeue || !gotoEnd ) { - jQuery.dequeue( this, type ); - } - } ); - }, - finish: function( type ) { - if ( type !== false ) { - type = type || "fx"; - } - return this.each( function() { - var index, - data = dataPriv.get( this ), - queue = data[ type + "queue" ], - hooks = data[ type + "queueHooks" ], - timers = jQuery.timers, - length = queue ? queue.length : 0; - - // Enable finishing flag on private data - data.finish = true; - - // Empty the queue first - jQuery.queue( this, type, [] ); - - if ( hooks && hooks.stop ) { - hooks.stop.call( this, true ); - } - - // Look for any active animations, and finish them - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && timers[ index ].queue === type ) { - timers[ index ].anim.stop( true ); - timers.splice( index, 1 ); - } - } - - // Look for any animations in the old queue and finish them - for ( index = 0; index < length; index++ ) { - if ( queue[ index ] && queue[ index ].finish ) { - queue[ index ].finish.call( this ); - } - } - - // Turn off finishing flag - delete data.finish; - } ); - } -} ); - -jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { - var cssFn = jQuery.fn[ name ]; - jQuery.fn[ name ] = function( speed, easing, callback ) { - return speed == null || typeof speed === "boolean" ? - cssFn.apply( this, arguments ) : - this.animate( genFx( name, true ), speed, easing, callback ); - }; -} ); - -// Generate shortcuts for custom animations -jQuery.each( { - slideDown: genFx( "show" ), - slideUp: genFx( "hide" ), - slideToggle: genFx( "toggle" ), - fadeIn: { opacity: "show" }, - fadeOut: { opacity: "hide" }, - fadeToggle: { opacity: "toggle" } -}, function( name, props ) { - jQuery.fn[ name ] = function( speed, easing, callback ) { - return this.animate( props, speed, easing, callback ); - }; -} ); - -jQuery.timers = []; -jQuery.fx.tick = function() { - var timer, - i = 0, - timers = jQuery.timers; - - fxNow = Date.now(); - - for ( ; i < timers.length; i++ ) { - timer = timers[ i ]; - - // Run the timer and safely remove it when done (allowing for external removal) - if ( !timer() && timers[ i ] === timer ) { - timers.splice( i--, 1 ); - } - } - - if ( !timers.length ) { - jQuery.fx.stop(); - } - fxNow = undefined; -}; - -jQuery.fx.timer = function( timer ) { - jQuery.timers.push( timer ); - jQuery.fx.start(); -}; - -jQuery.fx.interval = 13; -jQuery.fx.start = function() { - if ( inProgress ) { - return; - } - - inProgress = true; - schedule(); -}; - -jQuery.fx.stop = function() { - inProgress = null; -}; - -jQuery.fx.speeds = { - slow: 600, - fast: 200, - - // Default speed - _default: 400 -}; - - -// Based off of the plugin by Clint Helfers, with permission. -// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ -jQuery.fn.delay = function( time, type ) { - time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; - type = type || "fx"; - - return this.queue( type, function( next, hooks ) { - var timeout = window.setTimeout( next, time ); - hooks.stop = function() { - window.clearTimeout( timeout ); - }; - } ); -}; - - -( function() { - var input = document.createElement( "input" ), - select = document.createElement( "select" ), - opt = select.appendChild( document.createElement( "option" ) ); - - input.type = "checkbox"; - - // Support: Android <=4.3 only - // Default value for a checkbox should be "on" - support.checkOn = input.value !== ""; - - // Support: IE <=11 only - // Must access selectedIndex to make default options select - support.optSelected = opt.selected; - - // Support: IE <=11 only - // An input loses its value after becoming a radio - input = document.createElement( "input" ); - input.value = "t"; - input.type = "radio"; - support.radioValue = input.value === "t"; -} )(); - - -var boolHook, - attrHandle = jQuery.expr.attrHandle; - -jQuery.fn.extend( { - attr: function( name, value ) { - return access( this, jQuery.attr, name, value, arguments.length > 1 ); - }, - - removeAttr: function( name ) { - return this.each( function() { - jQuery.removeAttr( this, name ); - } ); - } -} ); - -jQuery.extend( { - attr: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set attributes on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - // Fallback to prop when attributes are not supported - if ( typeof elem.getAttribute === "undefined" ) { - return jQuery.prop( elem, name, value ); - } - - // Attribute hooks are determined by the lowercase version - // Grab necessary hook if one is defined - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - hooks = jQuery.attrHooks[ name.toLowerCase() ] || - ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); - } - - if ( value !== undefined ) { - if ( value === null ) { - jQuery.removeAttr( elem, name ); - return; - } - - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - elem.setAttribute( name, value + "" ); - return value; - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - ret = jQuery.find.attr( elem, name ); - - // Non-existent attributes return null, we normalize to undefined - return ret == null ? undefined : ret; - }, - - attrHooks: { - type: { - set: function( elem, value ) { - if ( !support.radioValue && value === "radio" && - nodeName( elem, "input" ) ) { - var val = elem.value; - elem.setAttribute( "type", value ); - if ( val ) { - elem.value = val; - } - return value; - } - } - } - }, - - removeAttr: function( elem, value ) { - var name, - i = 0, - - // Attribute names can contain non-HTML whitespace characters - // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 - attrNames = value && value.match( rnothtmlwhite ); - - if ( attrNames && elem.nodeType === 1 ) { - while ( ( name = attrNames[ i++ ] ) ) { - elem.removeAttribute( name ); - } - } - } -} ); - -// Hooks for boolean attributes -boolHook = { - set: function( elem, value, name ) { - if ( value === false ) { - - // Remove boolean attributes when set to false - jQuery.removeAttr( elem, name ); - } else { - elem.setAttribute( name, name ); - } - return name; - } -}; - -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { - var getter = attrHandle[ name ] || jQuery.find.attr; - - attrHandle[ name ] = function( elem, name, isXML ) { - var ret, handle, - lowercaseName = name.toLowerCase(); - - if ( !isXML ) { - - // Avoid an infinite loop by temporarily removing this function from the getter - handle = attrHandle[ lowercaseName ]; - attrHandle[ lowercaseName ] = ret; - ret = getter( elem, name, isXML ) != null ? - lowercaseName : - null; - attrHandle[ lowercaseName ] = handle; - } - return ret; - }; -} ); - - - - -var rfocusable = /^(?:input|select|textarea|button)$/i, - rclickable = /^(?:a|area)$/i; - -jQuery.fn.extend( { - prop: function( name, value ) { - return access( this, jQuery.prop, name, value, arguments.length > 1 ); - }, - - removeProp: function( name ) { - return this.each( function() { - delete this[ jQuery.propFix[ name ] || name ]; - } ); - } -} ); - -jQuery.extend( { - prop: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set properties on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - - // Fix name and attach hooks - name = jQuery.propFix[ name ] || name; - hooks = jQuery.propHooks[ name ]; - } - - if ( value !== undefined ) { - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - return ( elem[ name ] = value ); - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - return elem[ name ]; - }, - - propHooks: { - tabIndex: { - get: function( elem ) { - - // Support: IE <=9 - 11 only - // elem.tabIndex doesn't always return the - // correct value when it hasn't been explicitly set - // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ - // Use proper attribute retrieval(#12072) - var tabindex = jQuery.find.attr( elem, "tabindex" ); - - if ( tabindex ) { - return parseInt( tabindex, 10 ); - } - - if ( - rfocusable.test( elem.nodeName ) || - rclickable.test( elem.nodeName ) && - elem.href - ) { - return 0; - } - - return -1; - } - } - }, - - propFix: { - "for": "htmlFor", - "class": "className" - } -} ); - -// Support: IE <=11 only -// Accessing the selectedIndex property -// forces the browser to respect setting selected -// on the option -// The getter ensures a default option is selected -// when in an optgroup -// eslint rule "no-unused-expressions" is disabled for this code -// since it considers such accessions noop -if ( !support.optSelected ) { - jQuery.propHooks.selected = { - get: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent && parent.parentNode ) { - parent.parentNode.selectedIndex; - } - return null; - }, - set: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent ) { - parent.selectedIndex; - - if ( parent.parentNode ) { - parent.parentNode.selectedIndex; - } - } - } - }; -} - -jQuery.each( [ - "tabIndex", - "readOnly", - "maxLength", - "cellSpacing", - "cellPadding", - "rowSpan", - "colSpan", - "useMap", - "frameBorder", - "contentEditable" -], function() { - jQuery.propFix[ this.toLowerCase() ] = this; -} ); - - - - - // Strip and collapse whitespace according to HTML spec - // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace - function stripAndCollapse( value ) { - var tokens = value.match( rnothtmlwhite ) || []; - return tokens.join( " " ); - } - - -function getClass( elem ) { - return elem.getAttribute && elem.getAttribute( "class" ) || ""; -} - -function classesToArray( value ) { - if ( Array.isArray( value ) ) { - return value; - } - if ( typeof value === "string" ) { - return value.match( rnothtmlwhite ) || []; - } - return []; -} - -jQuery.fn.extend( { - addClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - if ( cur.indexOf( " " + clazz + " " ) < 0 ) { - cur += clazz + " "; - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - removeClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - if ( !arguments.length ) { - return this.attr( "class", "" ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - - // This expression is here for better compressibility (see addClass) - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - - // Remove *all* instances - while ( cur.indexOf( " " + clazz + " " ) > -1 ) { - cur = cur.replace( " " + clazz + " ", " " ); - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - toggleClass: function( value, stateVal ) { - var type = typeof value, - isValidValue = type === "string" || Array.isArray( value ); - - if ( typeof stateVal === "boolean" && isValidValue ) { - return stateVal ? this.addClass( value ) : this.removeClass( value ); - } - - if ( isFunction( value ) ) { - return this.each( function( i ) { - jQuery( this ).toggleClass( - value.call( this, i, getClass( this ), stateVal ), - stateVal - ); - } ); - } - - return this.each( function() { - var className, i, self, classNames; - - if ( isValidValue ) { - - // Toggle individual class names - i = 0; - self = jQuery( this ); - classNames = classesToArray( value ); - - while ( ( className = classNames[ i++ ] ) ) { - - // Check each className given, space separated list - if ( self.hasClass( className ) ) { - self.removeClass( className ); - } else { - self.addClass( className ); - } - } - - // Toggle whole class name - } else if ( value === undefined || type === "boolean" ) { - className = getClass( this ); - if ( className ) { - - // Store className if set - dataPriv.set( this, "__className__", className ); - } - - // If the element has a class name or if we're passed `false`, - // then remove the whole classname (if there was one, the above saved it). - // Otherwise bring back whatever was previously saved (if anything), - // falling back to the empty string if nothing was stored. - if ( this.setAttribute ) { - this.setAttribute( "class", - className || value === false ? - "" : - dataPriv.get( this, "__className__" ) || "" - ); - } - } - } ); - }, - - hasClass: function( selector ) { - var className, elem, - i = 0; - - className = " " + selector + " "; - while ( ( elem = this[ i++ ] ) ) { - if ( elem.nodeType === 1 && - ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { - return true; - } - } - - return false; - } -} ); - - - - -var rreturn = /\r/g; - -jQuery.fn.extend( { - val: function( value ) { - var hooks, ret, valueIsFunction, - elem = this[ 0 ]; - - if ( !arguments.length ) { - if ( elem ) { - hooks = jQuery.valHooks[ elem.type ] || - jQuery.valHooks[ elem.nodeName.toLowerCase() ]; - - if ( hooks && - "get" in hooks && - ( ret = hooks.get( elem, "value" ) ) !== undefined - ) { - return ret; - } - - ret = elem.value; - - // Handle most common string cases - if ( typeof ret === "string" ) { - return ret.replace( rreturn, "" ); - } - - // Handle cases where value is null/undef or number - return ret == null ? "" : ret; - } - - return; - } - - valueIsFunction = isFunction( value ); - - return this.each( function( i ) { - var val; - - if ( this.nodeType !== 1 ) { - return; - } - - if ( valueIsFunction ) { - val = value.call( this, i, jQuery( this ).val() ); - } else { - val = value; - } - - // Treat null/undefined as ""; convert numbers to string - if ( val == null ) { - val = ""; - - } else if ( typeof val === "number" ) { - val += ""; - - } else if ( Array.isArray( val ) ) { - val = jQuery.map( val, function( value ) { - return value == null ? "" : value + ""; - } ); - } - - hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; - - // If set returns undefined, fall back to normal setting - if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { - this.value = val; - } - } ); - } -} ); - -jQuery.extend( { - valHooks: { - option: { - get: function( elem ) { - - var val = jQuery.find.attr( elem, "value" ); - return val != null ? - val : - - // Support: IE <=10 - 11 only - // option.text throws exceptions (#14686, #14858) - // Strip and collapse whitespace - // https://html.spec.whatwg.org/#strip-and-collapse-whitespace - stripAndCollapse( jQuery.text( elem ) ); - } - }, - select: { - get: function( elem ) { - var value, option, i, - options = elem.options, - index = elem.selectedIndex, - one = elem.type === "select-one", - values = one ? null : [], - max = one ? index + 1 : options.length; - - if ( index < 0 ) { - i = max; - - } else { - i = one ? index : 0; - } - - // Loop through all the selected options - for ( ; i < max; i++ ) { - option = options[ i ]; - - // Support: IE <=9 only - // IE8-9 doesn't update selected after form reset (#2551) - if ( ( option.selected || i === index ) && - - // Don't return options that are disabled or in a disabled optgroup - !option.disabled && - ( !option.parentNode.disabled || - !nodeName( option.parentNode, "optgroup" ) ) ) { - - // Get the specific value for the option - value = jQuery( option ).val(); - - // We don't need an array for one selects - if ( one ) { - return value; - } - - // Multi-Selects return an array - values.push( value ); - } - } - - return values; - }, - - set: function( elem, value ) { - var optionSet, option, - options = elem.options, - values = jQuery.makeArray( value ), - i = options.length; - - while ( i-- ) { - option = options[ i ]; - - /* eslint-disable no-cond-assign */ - - if ( option.selected = - jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 - ) { - optionSet = true; - } - - /* eslint-enable no-cond-assign */ - } - - // Force browsers to behave consistently when non-matching value is set - if ( !optionSet ) { - elem.selectedIndex = -1; - } - return values; - } - } - } -} ); - -// Radios and checkboxes getter/setter -jQuery.each( [ "radio", "checkbox" ], function() { - jQuery.valHooks[ this ] = { - set: function( elem, value ) { - if ( Array.isArray( value ) ) { - return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); - } - } - }; - if ( !support.checkOn ) { - jQuery.valHooks[ this ].get = function( elem ) { - return elem.getAttribute( "value" ) === null ? "on" : elem.value; - }; - } -} ); - - - - -// Return jQuery for attributes-only inclusion - - -support.focusin = "onfocusin" in window; - - -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - stopPropagationCallback = function( e ) { - e.stopPropagation(); - }; - -jQuery.extend( jQuery.event, { - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - - cur = lastElement = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf( "." ) > -1 ) { - - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split( "." ); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf( ":" ) < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join( "." ); - event.rnamespace = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === ( elem.ownerDocument || document ) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - lastElement = cur; - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( - dataPriv.get( cur, "events" ) || Object.create( null ) - )[ event.type ] && - dataPriv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( ( !special._default || - special._default.apply( eventPath.pop(), data ) === false ) && - acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - - if ( event.isPropagationStopped() ) { - lastElement.addEventListener( type, stopPropagationCallback ); - } - - elem[ type ](); - - if ( event.isPropagationStopped() ) { - lastElement.removeEventListener( type, stopPropagationCallback ); - } - - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - // Piggyback on a donor event to simulate a different one - // Used only for `focus(in | out)` events - simulate: function( type, elem, event ) { - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true - } - ); - - jQuery.event.trigger( e, null, elem ); - } - -} ); - -jQuery.fn.extend( { - - trigger: function( type, data ) { - return this.each( function() { - jQuery.event.trigger( type, data, this ); - } ); - }, - triggerHandler: function( type, data ) { - var elem = this[ 0 ]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -} ); - - -// Support: Firefox <=44 -// Firefox doesn't have focus(in | out) events -// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 -// -// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 -// focus(in | out) events fire after focus & blur events, -// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order -// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 -if ( !support.focusin ) { - jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - - // Handle: regular nodes (via `this.ownerDocument`), window - // (via `this.document`) & document (via `this`). - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - dataPriv.remove( doc, fix ); - - } else { - dataPriv.access( doc, fix, attaches ); - } - } - }; - } ); -} -var location = window.location; - -var nonce = { guid: Date.now() }; - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - if ( !data || typeof data !== "string" ) { - return null; - } - - // Support: IE 9 - 11 only - // IE throws on parseFromString with invalid input. - try { - xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); - } catch ( e ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + data ); - } - return xml; -}; - - -var - rbracket = /\[\]$/, - rCRLF = /\r?\n/g, - rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, - rsubmittable = /^(?:input|select|textarea|keygen)/i; - -function buildParams( prefix, obj, traditional, add ) { - var name; - - if ( Array.isArray( obj ) ) { - - // Serialize array item. - jQuery.each( obj, function( i, v ) { - if ( traditional || rbracket.test( prefix ) ) { - - // Treat each array item as a scalar. - add( prefix, v ); - - } else { - - // Item is non-scalar (array or object), encode its numeric index. - buildParams( - prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", - v, - traditional, - add - ); - } - } ); - - } else if ( !traditional && toType( obj ) === "object" ) { - - // Serialize object item. - for ( name in obj ) { - buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); - } - - } else { - - // Serialize scalar item. - add( prefix, obj ); - } -} - -// Serialize an array of form elements or a set of -// key/values into a query string -jQuery.param = function( a, traditional ) { - var prefix, - s = [], - add = function( key, valueOrFunction ) { - - // If value is a function, invoke it and use its return value - var value = isFunction( valueOrFunction ) ? - valueOrFunction() : - valueOrFunction; - - s[ s.length ] = encodeURIComponent( key ) + "=" + - encodeURIComponent( value == null ? "" : value ); - }; - - if ( a == null ) { - return ""; - } - - // If an array was passed in, assume that it is an array of form elements. - if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { - - // Serialize the form elements - jQuery.each( a, function() { - add( this.name, this.value ); - } ); - - } else { - - // If traditional, encode the "old" way (the way 1.3.2 or older - // did it), otherwise encode params recursively. - for ( prefix in a ) { - buildParams( prefix, a[ prefix ], traditional, add ); - } - } - - // Return the resulting serialization - return s.join( "&" ); -}; - -jQuery.fn.extend( { - serialize: function() { - return jQuery.param( this.serializeArray() ); - }, - serializeArray: function() { - return this.map( function() { - - // Can add propHook for "elements" to filter or add form elements - var elements = jQuery.prop( this, "elements" ); - return elements ? jQuery.makeArray( elements ) : this; - } ) - .filter( function() { - var type = this.type; - - // Use .is( ":disabled" ) so that fieldset[disabled] works - return this.name && !jQuery( this ).is( ":disabled" ) && - rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && - ( this.checked || !rcheckableType.test( type ) ); - } ) - .map( function( _i, elem ) { - var val = jQuery( this ).val(); - - if ( val == null ) { - return null; - } - - if ( Array.isArray( val ) ) { - return jQuery.map( val, function( val ) { - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ); - } - - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ).get(); - } -} ); - - -var - r20 = /%20/g, - rhash = /#.*$/, - rantiCache = /([?&])_=[^&]*/, - rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, - - // #7653, #8125, #8152: local protocol detection - rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, - rnoContent = /^(?:GET|HEAD)$/, - rprotocol = /^\/\//, - - /* Prefilters - * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) - * 2) These are called: - * - BEFORE asking for a transport - * - AFTER param serialization (s.data is a string if s.processData is true) - * 3) key is the dataType - * 4) the catchall symbol "*" can be used - * 5) execution will start with transport dataType and THEN continue down to "*" if needed - */ - prefilters = {}, - - /* Transports bindings - * 1) key is the dataType - * 2) the catchall symbol "*" can be used - * 3) selection will start with transport dataType and THEN go to "*" if needed - */ - transports = {}, - - // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression - allTypes = "*/".concat( "*" ), - - // Anchor tag for parsing the document origin - originAnchor = document.createElement( "a" ); - originAnchor.href = location.href; - -// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport -function addToPrefiltersOrTransports( structure ) { - - // dataTypeExpression is optional and defaults to "*" - return function( dataTypeExpression, func ) { - - if ( typeof dataTypeExpression !== "string" ) { - func = dataTypeExpression; - dataTypeExpression = "*"; - } - - var dataType, - i = 0, - dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - - if ( isFunction( func ) ) { - - // For each dataType in the dataTypeExpression - while ( ( dataType = dataTypes[ i++ ] ) ) { - - // Prepend if requested - if ( dataType[ 0 ] === "+" ) { - dataType = dataType.slice( 1 ) || "*"; - ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); - - // Otherwise append - } else { - ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); - } - } - } - }; -} - -// Base inspection function for prefilters and transports -function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { - - var inspected = {}, - seekingTransport = ( structure === transports ); - - function inspect( dataType ) { - var selected; - inspected[ dataType ] = true; - jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { - var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); - if ( typeof dataTypeOrTransport === "string" && - !seekingTransport && !inspected[ dataTypeOrTransport ] ) { - - options.dataTypes.unshift( dataTypeOrTransport ); - inspect( dataTypeOrTransport ); - return false; - } else if ( seekingTransport ) { - return !( selected = dataTypeOrTransport ); - } - } ); - return selected; - } - - return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); -} - -// A special extend for ajax options -// that takes "flat" options (not to be deep extended) -// Fixes #9887 -function ajaxExtend( target, src ) { - var key, deep, - flatOptions = jQuery.ajaxSettings.flatOptions || {}; - - for ( key in src ) { - if ( src[ key ] !== undefined ) { - ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; - } - } - if ( deep ) { - jQuery.extend( true, target, deep ); - } - - return target; -} - -/* Handles responses to an ajax request: - * - finds the right dataType (mediates between content-type and expected dataType) - * - returns the corresponding response - */ -function ajaxHandleResponses( s, jqXHR, responses ) { - - var ct, type, finalDataType, firstDataType, - contents = s.contents, - dataTypes = s.dataTypes; - - // Remove auto dataType and get content-type in the process - while ( dataTypes[ 0 ] === "*" ) { - dataTypes.shift(); - if ( ct === undefined ) { - ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); - } - } - - // Check if we're dealing with a known content-type - if ( ct ) { - for ( type in contents ) { - if ( contents[ type ] && contents[ type ].test( ct ) ) { - dataTypes.unshift( type ); - break; - } - } - } - - // Check to see if we have a response for the expected dataType - if ( dataTypes[ 0 ] in responses ) { - finalDataType = dataTypes[ 0 ]; - } else { - - // Try convertible dataTypes - for ( type in responses ) { - if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { - finalDataType = type; - break; - } - if ( !firstDataType ) { - firstDataType = type; - } - } - - // Or just use first one - finalDataType = finalDataType || firstDataType; - } - - // If we found a dataType - // We add the dataType to the list if needed - // and return the corresponding response - if ( finalDataType ) { - if ( finalDataType !== dataTypes[ 0 ] ) { - dataTypes.unshift( finalDataType ); - } - return responses[ finalDataType ]; - } -} - -/* Chain conversions given the request and the original response - * Also sets the responseXXX fields on the jqXHR instance - */ -function ajaxConvert( s, response, jqXHR, isSuccess ) { - var conv2, current, conv, tmp, prev, - converters = {}, - - // Work with a copy of dataTypes in case we need to modify it for conversion - dataTypes = s.dataTypes.slice(); - - // Create converters map with lowercased keys - if ( dataTypes[ 1 ] ) { - for ( conv in s.converters ) { - converters[ conv.toLowerCase() ] = s.converters[ conv ]; - } - } - - current = dataTypes.shift(); - - // Convert to each sequential dataType - while ( current ) { - - if ( s.responseFields[ current ] ) { - jqXHR[ s.responseFields[ current ] ] = response; - } - - // Apply the dataFilter if provided - if ( !prev && isSuccess && s.dataFilter ) { - response = s.dataFilter( response, s.dataType ); - } - - prev = current; - current = dataTypes.shift(); - - if ( current ) { - - // There's only work to do if current dataType is non-auto - if ( current === "*" ) { - - current = prev; - - // Convert response if prev dataType is non-auto and differs from current - } else if ( prev !== "*" && prev !== current ) { - - // Seek a direct converter - conv = converters[ prev + " " + current ] || converters[ "* " + current ]; - - // If none found, seek a pair - if ( !conv ) { - for ( conv2 in converters ) { - - // If conv2 outputs current - tmp = conv2.split( " " ); - if ( tmp[ 1 ] === current ) { - - // If prev can be converted to accepted input - conv = converters[ prev + " " + tmp[ 0 ] ] || - converters[ "* " + tmp[ 0 ] ]; - if ( conv ) { - - // Condense equivalence converters - if ( conv === true ) { - conv = converters[ conv2 ]; - - // Otherwise, insert the intermediate dataType - } else if ( converters[ conv2 ] !== true ) { - current = tmp[ 0 ]; - dataTypes.unshift( tmp[ 1 ] ); - } - break; - } - } - } - } - - // Apply converter (if not an equivalence) - if ( conv !== true ) { - - // Unless errors are allowed to bubble, catch and return them - if ( conv && s.throws ) { - response = conv( response ); - } else { - try { - response = conv( response ); - } catch ( e ) { - return { - state: "parsererror", - error: conv ? e : "No conversion from " + prev + " to " + current - }; - } - } - } - } - } - } - - return { state: "success", data: response }; -} - -jQuery.extend( { - - // Counter for holding the number of active queries - active: 0, - - // Last-Modified header cache for next request - lastModified: {}, - etag: {}, - - ajaxSettings: { - url: location.href, - type: "GET", - isLocal: rlocalProtocol.test( location.protocol ), - global: true, - processData: true, - async: true, - contentType: "application/x-www-form-urlencoded; charset=UTF-8", - - /* - timeout: 0, - data: null, - dataType: null, - username: null, - password: null, - cache: null, - throws: false, - traditional: false, - headers: {}, - */ - - accepts: { - "*": allTypes, - text: "text/plain", - html: "text/html", - xml: "application/xml, text/xml", - json: "application/json, text/javascript" - }, - - contents: { - xml: /\bxml\b/, - html: /\bhtml/, - json: /\bjson\b/ - }, - - responseFields: { - xml: "responseXML", - text: "responseText", - json: "responseJSON" - }, - - // Data converters - // Keys separate source (or catchall "*") and destination types with a single space - converters: { - - // Convert anything to text - "* text": String, - - // Text to html (true = no transformation) - "text html": true, - - // Evaluate text as a json expression - "text json": JSON.parse, - - // Parse text as xml - "text xml": jQuery.parseXML - }, - - // For options that shouldn't be deep extended: - // you can add your own custom options here if - // and when you create one that shouldn't be - // deep extended (see ajaxExtend) - flatOptions: { - url: true, - context: true - } - }, - - // Creates a full fledged settings object into target - // with both ajaxSettings and settings fields. - // If target is omitted, writes into ajaxSettings. - ajaxSetup: function( target, settings ) { - return settings ? - - // Building a settings object - ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : - - // Extending ajaxSettings - ajaxExtend( jQuery.ajaxSettings, target ); - }, - - ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), - ajaxTransport: addToPrefiltersOrTransports( transports ), - - // Main method - ajax: function( url, options ) { - - // If url is an object, simulate pre-1.5 signature - if ( typeof url === "object" ) { - options = url; - url = undefined; - } - - // Force options to be an object - options = options || {}; - - var transport, - - // URL without anti-cache param - cacheURL, - - // Response headers - responseHeadersString, - responseHeaders, - - // timeout handle - timeoutTimer, - - // Url cleanup var - urlAnchor, - - // Request state (becomes false upon send and true upon completion) - completed, - - // To know if global events are to be dispatched - fireGlobals, - - // Loop variable - i, - - // uncached part of the url - uncached, - - // Create the final options object - s = jQuery.ajaxSetup( {}, options ), - - // Callbacks context - callbackContext = s.context || s, - - // Context for global events is callbackContext if it is a DOM node or jQuery collection - globalEventContext = s.context && - ( callbackContext.nodeType || callbackContext.jquery ) ? - jQuery( callbackContext ) : - jQuery.event, - - // Deferreds - deferred = jQuery.Deferred(), - completeDeferred = jQuery.Callbacks( "once memory" ), - - // Status-dependent callbacks - statusCode = s.statusCode || {}, - - // Headers (they are sent all at once) - requestHeaders = {}, - requestHeadersNames = {}, - - // Default abort message - strAbort = "canceled", - - // Fake xhr - jqXHR = { - readyState: 0, - - // Builds headers hashtable if needed - getResponseHeader: function( key ) { - var match; - if ( completed ) { - if ( !responseHeaders ) { - responseHeaders = {}; - while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() + " " ] = - ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) - .concat( match[ 2 ] ); - } - } - match = responseHeaders[ key.toLowerCase() + " " ]; - } - return match == null ? null : match.join( ", " ); - }, - - // Raw string - getAllResponseHeaders: function() { - return completed ? responseHeadersString : null; - }, - - // Caches the header - setRequestHeader: function( name, value ) { - if ( completed == null ) { - name = requestHeadersNames[ name.toLowerCase() ] = - requestHeadersNames[ name.toLowerCase() ] || name; - requestHeaders[ name ] = value; - } - return this; - }, - - // Overrides response content-type header - overrideMimeType: function( type ) { - if ( completed == null ) { - s.mimeType = type; - } - return this; - }, - - // Status-dependent callbacks - statusCode: function( map ) { - var code; - if ( map ) { - if ( completed ) { - - // Execute the appropriate callbacks - jqXHR.always( map[ jqXHR.status ] ); - } else { - - // Lazy-add the new callbacks in a way that preserves old ones - for ( code in map ) { - statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; - } - } - } - return this; - }, - - // Cancel the request - abort: function( statusText ) { - var finalText = statusText || strAbort; - if ( transport ) { - transport.abort( finalText ); - } - done( 0, finalText ); - return this; - } - }; - - // Attach deferreds - deferred.promise( jqXHR ); - - // Add protocol if not provided (prefilters might expect it) - // Handle falsy url in the settings object (#10093: consistency with old signature) - // We also use the url parameter if available - s.url = ( ( url || s.url || location.href ) + "" ) - .replace( rprotocol, location.protocol + "//" ); - - // Alias method option to type as per ticket #12004 - s.type = options.method || options.type || s.method || s.type; - - // Extract dataTypes list - s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; - - // A cross-domain request is in order when the origin doesn't match the current origin. - if ( s.crossDomain == null ) { - urlAnchor = document.createElement( "a" ); - - // Support: IE <=8 - 11, Edge 12 - 15 - // IE throws exception on accessing the href property if url is malformed, - // e.g. http://example.com:80x/ - try { - urlAnchor.href = s.url; - - // Support: IE <=8 - 11 only - // Anchor's host property isn't correctly set when s.url is relative - urlAnchor.href = urlAnchor.href; - s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== - urlAnchor.protocol + "//" + urlAnchor.host; - } catch ( e ) { - - // If there is an error parsing the URL, assume it is crossDomain, - // it can be rejected by the transport if it is invalid - s.crossDomain = true; - } - } - - // Convert data if not already a string - if ( s.data && s.processData && typeof s.data !== "string" ) { - s.data = jQuery.param( s.data, s.traditional ); - } - - // Apply prefilters - inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); - - // If request was aborted inside a prefilter, stop there - if ( completed ) { - return jqXHR; - } - - // We can fire global events as of now if asked to - // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) - fireGlobals = jQuery.event && s.global; - - // Watch for a new set of requests - if ( fireGlobals && jQuery.active++ === 0 ) { - jQuery.event.trigger( "ajaxStart" ); - } - - // Uppercase the type - s.type = s.type.toUpperCase(); - - // Determine if request has content - s.hasContent = !rnoContent.test( s.type ); - - // Save the URL in case we're toying with the If-Modified-Since - // and/or If-None-Match header later on - // Remove hash to simplify url manipulation - cacheURL = s.url.replace( rhash, "" ); - - // More options handling for requests with no content - if ( !s.hasContent ) { - - // Remember the hash so we can put it back - uncached = s.url.slice( cacheURL.length ); - - // If data is available and should be processed, append data to url - if ( s.data && ( s.processData || typeof s.data === "string" ) ) { - cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; - - // #9682: remove data so that it's not used in an eventual retry - delete s.data; - } - - // Add or update anti-cache param if needed - if ( s.cache === false ) { - cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + - uncached; - } - - // Put hash and anti-cache on the URL that will be requested (gh-1732) - s.url = cacheURL + uncached; - - // Change '%20' to '+' if this is encoded form body content (gh-2658) - } else if ( s.data && s.processData && - ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { - s.data = s.data.replace( r20, "+" ); - } - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - if ( jQuery.lastModified[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); - } - if ( jQuery.etag[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); - } - } - - // Set the correct header, if data is being sent - if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { - jqXHR.setRequestHeader( "Content-Type", s.contentType ); - } - - // Set the Accepts header for the server, depending on the dataType - jqXHR.setRequestHeader( - "Accept", - s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? - s.accepts[ s.dataTypes[ 0 ] ] + - ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : - s.accepts[ "*" ] - ); - - // Check for headers option - for ( i in s.headers ) { - jqXHR.setRequestHeader( i, s.headers[ i ] ); - } - - // Allow custom headers/mimetypes and early abort - if ( s.beforeSend && - ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { - - // Abort if not done already and return - return jqXHR.abort(); - } - - // Aborting is no longer a cancellation - strAbort = "abort"; - - // Install callbacks on deferreds - completeDeferred.add( s.complete ); - jqXHR.done( s.success ); - jqXHR.fail( s.error ); - - // Get transport - transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); - - // If no transport, we auto-abort - if ( !transport ) { - done( -1, "No Transport" ); - } else { - jqXHR.readyState = 1; - - // Send global event - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); - } - - // If request was aborted inside ajaxSend, stop there - if ( completed ) { - return jqXHR; - } - - // Timeout - if ( s.async && s.timeout > 0 ) { - timeoutTimer = window.setTimeout( function() { - jqXHR.abort( "timeout" ); - }, s.timeout ); - } - - try { - completed = false; - transport.send( requestHeaders, done ); - } catch ( e ) { - - // Rethrow post-completion exceptions - if ( completed ) { - throw e; - } - - // Propagate others as results - done( -1, e ); - } - } - - // Callback for when everything is done - function done( status, nativeStatusText, responses, headers ) { - var isSuccess, success, error, response, modified, - statusText = nativeStatusText; - - // Ignore repeat invocations - if ( completed ) { - return; - } - - completed = true; - - // Clear timeout if it exists - if ( timeoutTimer ) { - window.clearTimeout( timeoutTimer ); - } - - // Dereference transport for early garbage collection - // (no matter how long the jqXHR object will be used) - transport = undefined; - - // Cache response headers - responseHeadersString = headers || ""; - - // Set readyState - jqXHR.readyState = status > 0 ? 4 : 0; - - // Determine if successful - isSuccess = status >= 200 && status < 300 || status === 304; - - // Get response data - if ( responses ) { - response = ajaxHandleResponses( s, jqXHR, responses ); - } - - // Use a noop converter for missing script - if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { - s.converters[ "text script" ] = function() {}; - } - - // Convert no matter what (that way responseXXX fields are always set) - response = ajaxConvert( s, response, jqXHR, isSuccess ); - - // If successful, handle type chaining - if ( isSuccess ) { - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - modified = jqXHR.getResponseHeader( "Last-Modified" ); - if ( modified ) { - jQuery.lastModified[ cacheURL ] = modified; - } - modified = jqXHR.getResponseHeader( "etag" ); - if ( modified ) { - jQuery.etag[ cacheURL ] = modified; - } - } - - // if no content - if ( status === 204 || s.type === "HEAD" ) { - statusText = "nocontent"; - - // if not modified - } else if ( status === 304 ) { - statusText = "notmodified"; - - // If we have data, let's convert it - } else { - statusText = response.state; - success = response.data; - error = response.error; - isSuccess = !error; - } - } else { - - // Extract error from statusText and normalize for non-aborts - error = statusText; - if ( status || !statusText ) { - statusText = "error"; - if ( status < 0 ) { - status = 0; - } - } - } - - // Set data for the fake xhr object - jqXHR.status = status; - jqXHR.statusText = ( nativeStatusText || statusText ) + ""; - - // Success/Error - if ( isSuccess ) { - deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); - } else { - deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); - } - - // Status-dependent callbacks - jqXHR.statusCode( statusCode ); - statusCode = undefined; - - if ( fireGlobals ) { - globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", - [ jqXHR, s, isSuccess ? success : error ] ); - } - - // Complete - completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); - - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); - - // Handle the global AJAX counter - if ( !( --jQuery.active ) ) { - jQuery.event.trigger( "ajaxStop" ); - } - } - } - - return jqXHR; - }, - - getJSON: function( url, data, callback ) { - return jQuery.get( url, data, callback, "json" ); - }, - - getScript: function( url, callback ) { - return jQuery.get( url, undefined, callback, "script" ); - } -} ); - -jQuery.each( [ "get", "post" ], function( _i, method ) { - jQuery[ method ] = function( url, data, callback, type ) { - - // Shift arguments if data argument was omitted - if ( isFunction( data ) ) { - type = type || callback; - callback = data; - data = undefined; - } - - // The url can be an options object (which then must have .url) - return jQuery.ajax( jQuery.extend( { - url: url, - type: method, - dataType: type, - data: data, - success: callback - }, jQuery.isPlainObject( url ) && url ) ); - }; -} ); - -jQuery.ajaxPrefilter( function( s ) { - var i; - for ( i in s.headers ) { - if ( i.toLowerCase() === "content-type" ) { - s.contentType = s.headers[ i ] || ""; - } - } -} ); - - -jQuery._evalUrl = function( url, options, doc ) { - return jQuery.ajax( { - url: url, - - // Make this explicit, since user can override this through ajaxSetup (#11264) - type: "GET", - dataType: "script", - cache: true, - async: false, - global: false, - - // Only evaluate the response if it is successful (gh-4126) - // dataFilter is not invoked for failure responses, so using it instead - // of the default converter is kludgy but it works. - converters: { - "text script": function() {} - }, - dataFilter: function( response ) { - jQuery.globalEval( response, options, doc ); - } - } ); -}; - - -jQuery.fn.extend( { - wrapAll: function( html ) { - var wrap; - - if ( this[ 0 ] ) { - if ( isFunction( html ) ) { - html = html.call( this[ 0 ] ); - } - - // The elements to wrap the target around - wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); - - if ( this[ 0 ].parentNode ) { - wrap.insertBefore( this[ 0 ] ); - } - - wrap.map( function() { - var elem = this; - - while ( elem.firstElementChild ) { - elem = elem.firstElementChild; - } - - return elem; - } ).append( this ); - } - - return this; - }, - - wrapInner: function( html ) { - if ( isFunction( html ) ) { - return this.each( function( i ) { - jQuery( this ).wrapInner( html.call( this, i ) ); - } ); - } - - return this.each( function() { - var self = jQuery( this ), - contents = self.contents(); - - if ( contents.length ) { - contents.wrapAll( html ); - - } else { - self.append( html ); - } - } ); - }, - - wrap: function( html ) { - var htmlIsFunction = isFunction( html ); - - return this.each( function( i ) { - jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); - } ); - }, - - unwrap: function( selector ) { - this.parent( selector ).not( "body" ).each( function() { - jQuery( this ).replaceWith( this.childNodes ); - } ); - return this; - } -} ); - - -jQuery.expr.pseudos.hidden = function( elem ) { - return !jQuery.expr.pseudos.visible( elem ); -}; -jQuery.expr.pseudos.visible = function( elem ) { - return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); -}; - - - - -jQuery.ajaxSettings.xhr = function() { - try { - return new window.XMLHttpRequest(); - } catch ( e ) {} -}; - -var xhrSuccessStatus = { - - // File protocol always yields status code 0, assume 200 - 0: 200, - - // Support: IE <=9 only - // #1450: sometimes IE returns 1223 when it should be 204 - 1223: 204 - }, - xhrSupported = jQuery.ajaxSettings.xhr(); - -support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); -support.ajax = xhrSupported = !!xhrSupported; - -jQuery.ajaxTransport( function( options ) { - var callback, errorCallback; - - // Cross domain only allowed if supported through XMLHttpRequest - if ( support.cors || xhrSupported && !options.crossDomain ) { - return { - send: function( headers, complete ) { - var i, - xhr = options.xhr(); - - xhr.open( - options.type, - options.url, - options.async, - options.username, - options.password - ); - - // Apply custom fields if provided - if ( options.xhrFields ) { - for ( i in options.xhrFields ) { - xhr[ i ] = options.xhrFields[ i ]; - } - } - - // Override mime type if needed - if ( options.mimeType && xhr.overrideMimeType ) { - xhr.overrideMimeType( options.mimeType ); - } - - // X-Requested-With header - // For cross-domain requests, seeing as conditions for a preflight are - // akin to a jigsaw puzzle, we simply never set it to be sure. - // (it can always be set on a per-request basis or even using ajaxSetup) - // For same-domain requests, won't change header if already provided. - if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { - headers[ "X-Requested-With" ] = "XMLHttpRequest"; - } - - // Set headers - for ( i in headers ) { - xhr.setRequestHeader( i, headers[ i ] ); - } - - // Callback - callback = function( type ) { - return function() { - if ( callback ) { - callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.ontimeout = - xhr.onreadystatechange = null; - - if ( type === "abort" ) { - xhr.abort(); - } else if ( type === "error" ) { - - // Support: IE <=9 only - // On a manual native abort, IE9 throws - // errors on any property access that is not readyState - if ( typeof xhr.status !== "number" ) { - complete( 0, "error" ); - } else { - complete( - - // File: protocol always yields status 0; see #8605, #14207 - xhr.status, - xhr.statusText - ); - } - } else { - complete( - xhrSuccessStatus[ xhr.status ] || xhr.status, - xhr.statusText, - - // Support: IE <=9 only - // IE9 has no XHR2 but throws on binary (trac-11426) - // For XHR2 non-text, let the caller handle it (gh-2498) - ( xhr.responseType || "text" ) !== "text" || - typeof xhr.responseText !== "string" ? - { binary: xhr.response } : - { text: xhr.responseText }, - xhr.getAllResponseHeaders() - ); - } - } - }; - }; - - // Listen to events - xhr.onload = callback(); - errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); - - // Support: IE 9 only - // Use onreadystatechange to replace onabort - // to handle uncaught aborts - if ( xhr.onabort !== undefined ) { - xhr.onabort = errorCallback; - } else { - xhr.onreadystatechange = function() { - - // Check readyState before timeout as it changes - if ( xhr.readyState === 4 ) { - - // Allow onerror to be called first, - // but that will not handle a native abort - // Also, save errorCallback to a variable - // as xhr.onerror cannot be accessed - window.setTimeout( function() { - if ( callback ) { - errorCallback(); - } - } ); - } - }; - } - - // Create the abort callback - callback = callback( "abort" ); - - try { - - // Do send the request (this may raise an exception) - xhr.send( options.hasContent && options.data || null ); - } catch ( e ) { - - // #14683: Only rethrow if this hasn't been notified as an error yet - if ( callback ) { - throw e; - } - } - }, - - abort: function() { - if ( callback ) { - callback(); - } - } - }; - } -} ); - - - - -// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) -jQuery.ajaxPrefilter( function( s ) { - if ( s.crossDomain ) { - s.contents.script = false; - } -} ); - -// Install script dataType -jQuery.ajaxSetup( { - accepts: { - script: "text/javascript, application/javascript, " + - "application/ecmascript, application/x-ecmascript" - }, - contents: { - script: /\b(?:java|ecma)script\b/ - }, - converters: { - "text script": function( text ) { - jQuery.globalEval( text ); - return text; - } - } -} ); - -// Handle cache's special case and crossDomain -jQuery.ajaxPrefilter( "script", function( s ) { - if ( s.cache === undefined ) { - s.cache = false; - } - if ( s.crossDomain ) { - s.type = "GET"; - } -} ); - -// Bind script tag hack transport -jQuery.ajaxTransport( "script", function( s ) { - - // This transport only deals with cross domain or forced-by-attrs requests - if ( s.crossDomain || s.scriptAttrs ) { - var script, callback; - return { - send: function( _, complete ) { - script = jQuery( " - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Index
    • - - -
  • - - - -
    • - -
- - -
-
-
-
- - -

Index

- -
- A - | C - | D - | G - | I - | J - | K - | M - | O - | P - | R - | S - | U - | W - -
-

A

- - - -
- -

C

- - -
- -

D

- - -
- -

G

- - - -
- -

I

- - - -
- -

J

- - - -
- -

K

- - -
- -

M

- - - -
- -

O

- - - -
- -

P

- - - -
- -

R

- - - -
- -

S

- - - -
- -

U

- - - -
- -

W

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

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/img/ModalGuide.png b/Wiki/ENG_Guide/html/img/ModalGuide.png deleted file mode 100644 index ce0890a5..00000000 Binary files a/Wiki/ENG_Guide/html/img/ModalGuide.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/img/cb5dec8cecafa7d64f6cd14b2672acce.png b/Wiki/ENG_Guide/html/img/cb5dec8cecafa7d64f6cd14b2672acce.png deleted file mode 100644 index 3d82a369..00000000 Binary files a/Wiki/ENG_Guide/html/img/cb5dec8cecafa7d64f6cd14b2672acce.png and /dev/null differ diff --git a/Wiki/ENG_Guide/html/index.html b/Wiki/ENG_Guide/html/index.html deleted file mode 100644 index f10b1d05..00000000 --- a/Wiki/ENG_Guide/html/index.html +++ /dev/null @@ -1,456 +0,0 @@ - - - - - - - - - - Welcome to pyOpenRPA’s wiki — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

Welcome to pyOpenRPA’s wiki

-ModalGuide.png -

by Ivan Maslov (Russia) - see 3. Copyrights & Contacts.

-

! ATTENTION ! pyOpenRPA works only on MS Windows 7+/Server 2008+. Guys from Unix/Mac - sorry. We will come to you soon :)

-
-

About

-

Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here!

-

pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA)

-

The pyOpenRPA - free, fast and reliable -Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free!

-

The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. -The pyOpenRPA is distributed under the PYOPENRPA license. -At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses.

-
-
-

Repo structure

-

The description of the each folder in GitLab repo is going below:

-
    -

  • Agent: template build for the pyOpenRPA.Agent component

    • -

  • Orchestrator: template build for the pyOpenRPA.Orchestrator component

    • -

  • Resources: 3rd party resources which is needed to provide pyOpenRPA encapsulation from the Operating System (OS) dependencies.

    • -

  • Robot: template build for the robot

    • -

  • Sources: pyOpenRPA python package sources + sphinx sources

    • -

  • Studio: build for the pyOpenRPA.Studio which support Desktop UI (support x32 and x64 desktop UI apps)

    • -

  • Utils: many additional good tools for the python developer

    • -

  • Wiki: compiled wiki documentation

    • -
-
-
-

The pyOpenRPA structure

-
-

The pyOpenRPA has 4 main tools:

-
    -

  • Studio

    • -

  • Robot

    • -

  • Orchestrator

    • -

  • Agent

    • -
-
-
-

Studio

-

The pyOpenRPA.Studio tool has been developed to help RPA-tors to create the robot algorythms.

-

Features

-
    -

  • Run actions

    • -

  • Create visual algorythms of the robot

    • -

  • Desktop app: Analyze desktop app ui tree

    • -

  • Desktop app: Search desktop app ui by mouse

    • -

  • Desktop app: Generate & edit the UIO Selector

    • -
-
-
-

Robot

-

The pyOpenRPA.Robot package is the core of any action execution in the pyOpenRPA. All action from algorythms are perfoming by the Robot tool. It looks like a console process without graphic user interface.

-

Features

-
    -

  • Based on Python (killer feature)

    • -

  • Support Win32 GUI framework (desktop app)

    • -

  • Support UI automation framework (desktop app)

    • -

  • Support Selenium (web app)

    • -

  • Support PyAutoGUI (screen capture & mouse)

    • -

  • Support OpenCV (computer vision)

    • -
-
-
-

Orchestrator

-

The pyOpenRPA.Orchestrator package has been developed to maintain robot infrastructure (2+ robots algorythm).

-

Features

-
    -

  • Start/Stop robot algorithm

    • -

  • Robot scheduler

    • -

  • Remote machine screenshot viewer

    • -

  • Remote machine cmd shell

    • -

  • Remote machine logs storage

    • -
-
-
-

Agent

-

The pyOpenRPA.Agent tool has been developed to maintain robot infrastructure (2+ robots algorythm).

-

Features

-
    -

  • Send CMD to the RPA GUI session (start/safe stop/force stop/logout)

    • -

  • Get screenshots from the RPA GUI session

    • -

  • Get the list of the running processes

    • -
-
-
-
-

Wiki structure

-

In wiki you can use the following docs:

- -
-
-

Guide content

-
-

GENERAL

- -
-
-

ROBOT

- -
-
-

STUDIO

- -
-
-

ORCHESTRATOR

- -
-
-

AGENT

- -
-
-

TOOLS

- -
-
-
- - -
- -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/objects.inv b/Wiki/ENG_Guide/html/objects.inv deleted file mode 100644 index 16f5f690..00000000 Binary files a/Wiki/ENG_Guide/html/objects.inv and /dev/null differ diff --git a/Wiki/ENG_Guide/html/py-modindex.html b/Wiki/ENG_Guide/html/py-modindex.html deleted file mode 100644 index bc7c02ac..00000000 --- a/Wiki/ENG_Guide/html/py-modindex.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - - - - Python Module Index — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Python Module Index
    • - - -
  • - -
    • - -
- - -
-
-
-
- - -

Python Module Index

- -
- p -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
- p
- pyOpenRPA -
    - pyOpenRPA.Agent.__Agent__ -
    - pyOpenRPA.Orchestrator.__Orchestrator__ -
    - pyOpenRPA.Orchestrator.Managers.ControlPanel -
    - pyOpenRPA.Orchestrator.Managers.Process -
    - pyOpenRPA.Orchestrator.Web.Basic -
    - pyOpenRPA.Robot.UIDesktop -
    - pyOpenRPA.Tools.StopSafe -
- - -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/search.html b/Wiki/ENG_Guide/html/search.html deleted file mode 100644 index 6a1c3d9d..00000000 --- a/Wiki/ENG_Guide/html/search.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - - - - Search — pyOpenRPA v1.2.0 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Search
    • - - -
  • - -
    • - -
- - -
-
-
-
- - - - -
- -
- -
- -
-
- -
- -
-

- © Copyright 2021, Ivan Maslov. - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
-
-
- -
- -
- - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Wiki/ENG_Guide/html/searchindex.js b/Wiki/ENG_Guide/html/searchindex.js deleted file mode 100644 index 6de73e15..00000000 --- a/Wiki/ENG_Guide/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["01_HowToInstall","02_RoadMap","03_Copyrights_Contacts","Agent/02_Defs","Orchestrator/01_Orchestrator","Orchestrator/02_Defs","Orchestrator/03_gSettingsTemplate","Orchestrator/04_HowToUse","Orchestrator/05_UAC","Orchestrator/06_Defs Managers","Robot/01_Robot","Robot/02_Defs","Robot/03_HowToUse","Robot/04_Dependencies","Studio/01_Studio","Studio/02_HowToUse","Tools/02_Defs","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:["01_HowToInstall.rst","02_RoadMap.rst","03_Copyrights_Contacts.rst","Agent\\02_Defs.rst","Orchestrator\\01_Orchestrator.rst","Orchestrator\\02_Defs.rst","Orchestrator\\03_gSettingsTemplate.rst","Orchestrator\\04_HowToUse.rst","Orchestrator\\05_UAC.rst","Orchestrator\\06_Defs Managers.rst","Robot\\01_Robot.rst","Robot\\02_Defs.rst","Robot\\03_HowToUse.rst","Robot\\04_Dependencies.rst","Studio\\01_Studio.rst","Studio\\02_HowToUse.rst","Tools\\02_Defs.rst","index.rst"],objects:{"pyOpenRPA.Agent":{__Agent__:[3,0,0,"-"]},"pyOpenRPA.Agent.__Agent__":{OSCMD:[3,1,1,""],OSFileBinaryDataBase64StrAppend:[3,1,1,""],OSFileBinaryDataBase64StrCreate:[3,1,1,""],OSFileBinaryDataBase64StrReceive:[3,1,1,""],OSFileMTimeGet:[3,1,1,""],OSFileTextDataStrCreate:[3,1,1,""],OSFileTextDataStrReceive:[3,1,1,""],ProcessWOExeUpperUserListGet:[3,1,1,""]},"pyOpenRPA.Orchestrator":{__Orchestrator__:[5,0,0,"-"]},"pyOpenRPA.Orchestrator.Managers":{ControlPanel:[9,0,0,"module-1"],Process:[9,0,0,"module-0"]},"pyOpenRPA.Orchestrator.Managers.ControlPanel":{ControlPanel:[9,2,1,"id37"]},"pyOpenRPA.Orchestrator.Managers.ControlPanel.ControlPanel":{DataDictGenerate:[9,3,1,"id38"],InitJSJinja2StrGenerate:[9,3,1,"id39"],InitJSJinja2TemplatePathSet:[9,3,1,"id40"],Jinja2DataUpdateDictSet:[9,3,1,"id41"],OnInitJSDataDict:[9,3,1,"id42"],OnInitJSStr:[9,3,1,"id43"],OnRefreshHTMLDataDict:[9,3,1,"id44"],OnRefreshHTMLHashStr:[9,3,1,"id45"],OnRefreshHTMLStr:[9,3,1,"id46"],OnRefreshJSONDict:[9,3,1,"id47"],RefreshHTMLJinja2StrGenerate:[9,3,1,"id48"],RefreshHTMLJinja2TemplatePathSet:[9,3,1,"id49"]},"pyOpenRPA.Orchestrator.Managers.Process":{Process:[9,2,1,"id0"],ProcessExists:[9,1,1,"id23"],ProcessGet:[9,1,1,"id24"],ProcessInitSafe:[9,1,1,"id25"],ProcessManual2Auto:[9,1,1,"id26"],ProcessManualStopListClear:[9,1,1,"id27"],ProcessManualStopTriggerSet:[9,1,1,"id28"],ProcessScheduleStatusCheckEverySeconds:[9,1,1,"id29"],ProcessStart:[9,1,1,"id30"],ProcessStatusCheck:[9,1,1,"id31"],ProcessStatusRestore:[9,1,1,"id32"],ProcessStatusSave:[9,1,1,"id33"],ProcessStatusStrGet:[9,1,1,"id34"],ProcessStopForce:[9,1,1,"id35"],ProcessStopSafe:[9,1,1,"id36"]},"pyOpenRPA.Orchestrator.Managers.Process.Process":{KeyTurpleGet:[9,3,1,"id1"],Manual2Auto:[9,3,1,"id2"],ManualStopListClear:[9,3,1,"id3"],ManualStopTriggerNewStart:[9,3,1,"id4"],ManualStopTriggerSet:[9,3,1,"id5"],MuteWait:[9,3,1,"id6"],RestartForce:[9,3,1,"id7"],RestartSafe:[9,3,1,"id8"],Start:[9,3,1,"id9"],StartCheck:[9,3,1,"id10"],StatusChangeLog:[9,3,1,"id11"],StatusCheck:[9,3,1,"id12"],StatusCheckIntervalRestore:[9,3,1,"id13"],StatusCheckStart:[9,3,1,"id14"],StatusCheckStopForce:[9,3,1,"id15"],StatusCheckStopSafe:[9,3,1,"id16"],StatusRestore:[9,3,1,"id17"],StatusSave:[9,3,1,"id18"],StopForce:[9,3,1,"id19"],StopForceCheck:[9,3,1,"id20"],StopSafe:[9,3,1,"id21"],StopSafeCheck:[9,3,1,"id22"]},"pyOpenRPA.Orchestrator.Web":{Basic:[5,0,0,"-"]},"pyOpenRPA.Orchestrator.Web.Basic":{JSActivityListExecute:[5,1,1,""],JSProcessorActivityListAdd:[5,1,1,""]},"pyOpenRPA.Orchestrator.__Orchestrator__":{ActivityItemCreate:[5,1,1,""],ActivityItemDefAliasCreate:[5,1,1,""],ActivityItemDefAliasModulesLoad:[5,1,1,""],ActivityItemDefAliasUpdate:[5,1,1,""],ActivityItemHelperDefAutofill:[5,1,1,""],ActivityItemHelperDefList:[5,1,1,""],AgentActivityItemAdd:[5,1,1,""],AgentActivityItemExists:[5,1,1,""],AgentActivityItemReturnExists:[5,1,1,""],AgentActivityItemReturnGet:[5,1,1,""],AgentOSCMD:[5,1,1,""],AgentOSFileBinaryDataBase64StrAppend:[5,1,1,""],AgentOSFileBinaryDataBase64StrCreate:[5,1,1,""],AgentOSFileBinaryDataBase64StrReceive:[5,1,1,""],AgentOSFileBinaryDataBytesCreate:[5,1,1,""],AgentOSFileBinaryDataReceive:[5,1,1,""],AgentOSFileSend:[5,1,1,""],AgentOSFileTextDataStrCreate:[5,1,1,""],AgentOSFileTextDataStrReceive:[5,1,1,""],AgentOSLogoff:[5,1,1,""],AgentProcessWOExeUpperUserListGet:[5,1,1,""],GSettingsAutocleaner:[5,1,1,""],GSettingsGet:[5,1,1,""],GSettingsKeyListValueAppend:[5,1,1,""],GSettingsKeyListValueGet:[5,1,1,""],GSettingsKeyListValueOperatorPlus:[5,1,1,""],GSettingsKeyListValueSet:[5,1,1,""],OSCMD:[5,1,1,""],OSCredentialsVerify:[5,1,1,""],OSLogoff:[5,1,1,""],OSRemotePCRestart:[5,1,1,""],Orchestrator:[5,1,1,""],OrchestratorInitWait:[5,1,1,""],OrchestratorIsAdmin:[5,1,1,""],OrchestratorIsInited:[5,1,1,""],OrchestratorLoggerGet:[5,1,1,""],OrchestratorPySearchInit:[5,1,1,""],OrchestratorRerunAsAdmin:[5,1,1,""],OrchestratorRestart:[5,1,1,""],OrchestratorScheduleGet:[5,1,1,""],OrchestratorSessionRestore:[5,1,1,""],OrchestratorSessionSave:[5,1,1,""],OrchestratorThreadStart:[5,1,1,""],ProcessDefIntervalCall:[5,1,1,""],ProcessIsStarted:[5,1,1,""],ProcessListGet:[5,1,1,""],ProcessStart:[5,1,1,""],ProcessStop:[5,1,1,""],ProcessorActivityItemAppend:[5,1,1,""],ProcessorActivityItemCreate:[5,1,1,""],ProcessorAliasDefCreate:[5,1,1,""],ProcessorAliasDefUpdate:[5,1,1,""],PythonStart:[5,1,1,""],RDPSessionCMDRun:[5,1,1,""],RDPSessionConnect:[5,1,1,""],RDPSessionDisconnect:[5,1,1,""],RDPSessionDublicatesResolve:[5,1,1,""],RDPSessionFileStoredRecieve:[5,1,1,""],RDPSessionFileStoredSend:[5,1,1,""],RDPSessionLogoff:[5,1,1,""],RDPSessionMonitorStop:[5,1,1,""],RDPSessionProcessStartIfNotRunning:[5,1,1,""],RDPSessionProcessStop:[5,1,1,""],RDPSessionReconnect:[5,1,1,""],RDPSessionResponsibilityCheck:[5,1,1,""],RDPTemplateCreate:[5,1,1,""],SchedulerActivityTimeAddWeekly:[5,1,1,""],Start:[5,1,1,""],StorageRobotExists:[5,1,1,""],StorageRobotGet:[5,1,1,""],UACKeyListCheck:[5,1,1,""],UACSuperTokenUpdate:[5,1,1,""],UACUpdate:[5,1,1,""],UACUserDictGet:[5,1,1,""],WebAuditMessageCreate:[5,1,1,""],WebCPUpdate:[5,1,1,""],WebListenCreate:[5,1,1,""],WebRequestGet:[5,1,1,""],WebRequestParseBodyBytes:[5,1,1,""],WebRequestParseBodyJSON:[5,1,1,""],WebRequestParseBodyStr:[5,1,1,""],WebRequestParseFile:[5,1,1,""],WebRequestParsePath:[5,1,1,""],WebRequestResponseSend:[5,1,1,""],WebURLConnectDef:[5,1,1,""],WebURLConnectFile:[5,1,1,""],WebURLConnectFolder:[5,1,1,""],WebUserInfoGet:[5,1,1,""],WebUserIsSuperToken:[5,1,1,""],WebUserUACHierarchyGet:[5,1,1,""]},"pyOpenRPA.Robot":{UIDesktop:[11,0,0,"-"]},"pyOpenRPA.Robot.UIDesktop":{Get_OSBitnessInt:[11,1,1,""],PWASpecification_Get_PWAApplication:[11,1,1,""],PWASpecification_Get_UIO:[11,1,1,""],UIOSelectorSecs_WaitAppear_Bool:[11,1,1,""],UIOSelectorSecs_WaitDisappear_Bool:[11,1,1,""],UIOSelectorUIOActivity_Run_Dict:[11,1,1,""],UIOSelector_Exist_Bool:[11,1,1,""],UIOSelector_FocusHighlight:[11,1,1,""],UIOSelector_GetChildList_UIOList:[11,1,1,""],UIOSelector_Get_BitnessInt:[11,1,1,""],UIOSelector_Get_BitnessStr:[11,1,1,""],UIOSelector_Get_UIO:[11,1,1,""],UIOSelector_Get_UIOActivityList:[11,1,1,""],UIOSelector_Get_UIOInfo:[11,1,1,""],UIOSelector_Get_UIOList:[11,1,1,""],UIOSelector_Highlight:[11,1,1,""],UIOSelector_SafeOtherGet_Process:[11,1,1,""],UIOSelector_SearchChildByMouse_UIO:[11,1,1,""],UIOSelector_SearchChildByMouse_UIOTree:[11,1,1,""],UIOSelector_TryRestore_Dict:[11,1,1,""],UIOSelectorsSecs_WaitAppear_List:[11,1,1,""],UIOSelectorsSecs_WaitDisappear_List:[11,1,1,""]},"pyOpenRPA.Tools":{StopSafe:[16,0,0,"-"]},"pyOpenRPA.Tools.StopSafe":{Init:[16,1,1,""],IsStopSafe:[16,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"0643":7,"0_stop":9,"100":6,"101":5,"1050":[5,6],"120":[6,9],"1200":6,"121":5,"123":5,"127":5,"1680":[5,6],"1680x1050":[5,6],"1992":7,"1_stopped_manu":9,"2008":[0,17],"2012":0,"2019":17,"2021":1,"222":[4,6],"2999226":0,"2_stop_saf":9,"300":[6,9],"3389":[5,6],"3600":6,"3720":[0,5,11,12],"3720python":12,"3_stop_safe_manu":9,"3rd":17,"412":5,"443":5,"4_start":9,"50000000":6,"5_started_manu":9,"600":6,"640x480":[5,6],"722":2,"77767775":5,"77777sdfsdf77777dsfdfsf77777777":5,"8081":6,"906":2,"\u0432":11,"\u0432\u0445\u043e\u0434\u043d\u043e\u0439":11,"\u0432\u044b\u043a\u0438\u043d\u0443\u0442\u044c":11,"\u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0442\u044c":11,"\u043a":11,"\u043a\u043e\u043d\u043d\u0435\u043a\u0442":11,"\u043b\u043e\u0433\u0433\u0435\u0440\u0430":6,"\u043b\u043e\u0433\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f":6,"\u043d\u0435":11,"\u043e\u0431\u043d\u0430\u0440\u0443\u0436\u0435\u043d\u0438\u0438":11,"\u043e\u0448\u0438\u0431\u043a\u0443":11,"\u043f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430":6,"\u043f\u043e\u043a\u0430\u0437\u0430\u0442\u0435\u043b\u044c":11,"\u043f\u0440\u043e\u0446\u0435\u0441\u0441\u0443":11,"\u043f\u0443\u0441\u0442\u043e\u0433\u043e":11,"\u0441\u043b\u0443\u0447\u0430\u0435":11,"\u0441\u043e\u0437\u0434\u0430\u0442\u044c":6,"\u0441\u043f\u0438\u0441\u043a\u0430":11,"\u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f":11,"\u0444\u0430\u0439\u043b":6,"\u0444\u043b\u0430\u0433":11,"\u0447\u0442\u043e":11,"\u044d\u043b\u0435\u043c\u0435\u043d\u0442":11,"byte":5,"case":[3,4,5,6,9,11,12],"catch":[3,5,6,9],"class":[9,12],"default":[3,5,6,9,12,15],"float":[3,4,6,9,11],"function":[2,3,5,6,9,10,11,12,16],"import":[4,5,6,7,9,10,11,12,16],"int":[4,5,9,11,12],"long":2,"new":[2,4,5,6,7,9],"return":[3,5,6,9,11,12,16],"switch":[9,13],"true":[3,5,6,7,8,9,10,11,12,16],"try":[5,11],"var":5,"while":[5,9],Abs:6,Are:0,But:9,DOS:[3,5],EXE:[3,5],For:[0,5,12,15],Has:6,NOT:5,RUS:[1,17],The:[0,4,5,6,9,10],Then:9,USEFUL:5,USe:[6,8],Use:[5,9],Will:[5,6,9],With:9,__agent__:17,__agentactivityreturndictitemcreate__:6,__agentdictitemcreate__:6,__create__:6,__init__:5,__main__:7,__name__:7,__orchestrator__:[9,17],__statisticsdict__:6,__uacclientadmincreate__:[6,7],_sessiolast:5,_sessionlast_gset:5,_sessionlast_rdplist:5,_sessionlast_storagedict:5,a2o:5,abil:12,abl:17,about:[2,4,5,6,9,16],abov:5,abs:[3,5],absolut:[3,5,6,9,17],abspath:[5,7],access:[5,6,7,17],accessus:6,action:[5,12,17],activ:[4,5,6,8,9,11,12,15],activitydict:[6,8],activityitem:[3,5],activityitemcr:5,activityitemdefaliascr:5,activityitemdefaliasmodulesload:5,activityitemdefaliasupd:5,activityitemdict:5,activityitemhelperdefautofil:5,activityitemhelperdeflist:5,activityitemnowdict:6,activitylist:6,activitylistappendprocessorqueuebool:[6,8],activitylistexecut:5,activitylistexecutebool:[6,8],activitynam:12,activitytimelist:6,actual:5,add:[5,6,7,9,12],addhandl:6,addit:[5,17],address:[5,6],addressstr:6,admin:[5,8],admindict:[6,8],administr:[5,7],after:[4,5,6,7,9,11,15,16],agent:[6,9],agentactivityitemadd:5,agentactivityitemexist:5,agentactivityitemreturnexist:5,agentactivityitemreturnget:5,agentactivitylifetimesecfloat:6,agentactivityreturndict:6,agentactivityreturnlifetimesecfloat:6,agentconnectionlifetimesecfloat:6,agentdict:[5,6],agentfilechunkbytessizeint:6,agentfilechunkcheckintervalsecfloat:6,agentkeydict:[6,8],agentkeystr:[6,8],agentlimitlogsizebytesint:6,agentloopsleepsecfloat:6,agentoscmd:5,agentosfilebinarydatabase64strappend:5,agentosfilebinarydatabase64strcr:5,agentosfilebinarydatabase64strrec:5,agentosfilebinarydatabytescr:5,agentosfilebinarydatarec:5,agentosfilesend:5,agentosfiletextdatastrcr:5,agentosfiletextdatastrrec:5,agentoslogoff:5,agentprocesswoexeupperuserlistget:5,algorithm:[4,17],algorythm:[4,6,17],alia:[4,5,6],aliasdefdict:[4,5,6],aliv:9,all:[4,5,6,7,8,9,11,12,17],allow:[5,6,7,8,9,10,12],alreadi:[5,12],also:5,amd64:[0,5,11,12],analyz:17,ani:[0,4,5,9,12,15,17],anoth:[5,11,15],anr:5,ant:9,apach:2,app:[3,5,11,17],appear:[5,11],append:[4,5,6,8,9,12],appli:[4,6,9],applic:[4,5,6,9,11,12],approach:12,architectur:17,archiv:[0,5,6],arg:[4,5,6],argdict:[4,5,6],arggset:[4,5,6],arglist:[4,5,6],arglogg:[4,5,6],argument:5,argvaluestr:5,articl:[1,17],artifici:12,asctim:6,ask:[5,6],assert:12,associ:5,asweigart:2,async:[4,5],asynchonu:4,attent:[3,4,5,6,8,12,15,17],attribut:[4,6,11,12],audit:5,authent:6,authentif:5,authtoken:6,authtokensdict:6,auto:[5,9],autoclean:[4,6],autoinit:[5,7],autom:[1,9,13,17],automat:[4,6,15],automationsearchmouseel:11,avail:[5,6,7,12],b4ff:7,b64decod:3,backend:[11,12],backward:[5,9],base64:[3,5],base:[4,5,17],base_wrapp:12,basehttprequesthandl:[5,9],basic:[4,6,7,17],beauti:[3,5],becaus:[4,5,9,12],been:[0,5,6,12,17],befor:[5,6],beginwith:[5,6],below:[4,5,15,17],best:[10,17],between:[4,5,6,7],big:[5,12,17],binari:[3,5],bit:[2,5,11,12],block:[5,6,9],bodi:[5,6],bool:[4,5,6,9,12],boppreh:2,both:[5,11,12],box:7,branch:0,browser:[6,15],bsd:2,bug:2,build:[2,17],built:0,busi:[4,5,12,17],button:[6,8],cabinetwclass:12,cach:6,calcfram:12,call:[4,5,6,7,9,11],callabl:5,can:[2,3,4,5,6,7,8,9,10,11,12,16,17],cancel:11,cant:4,captur:17,catchperiodsecfloat:6,central:4,certfilepempathstr:6,certif:5,chang:[6,9,17],check:[5,6,9,11,12,16,17],checkintervalsecfloat:6,child:[11,12],children:12,choos:11,chrome:12,chunk:6,class_nam:12,class_name_r:12,classif:12,claus:2,cleaner:5,clear:[5,6,9,12],click:[10,12],client:[5,6,9],clientrequesthandl:6,clipboard:5,close:[5,6,12,16],cmd:[3,5,6,8,9,15,17],cmdinputbool:[6,8],code:[4,5,6,9,12],collect:6,com:[0,2,12,13],come:[3,5,16,17],comma:4,command:[3,5,6,12],commerci:17,common:12,commun:5,compact:2,compani:[2,5,17],compat:[5,9,12],compex:4,compil:17,complet:[0,6],complex:4,compon:17,comput:[12,17],concept:17,condit:[11,12],config:[7,11],configur:[5,6,7,11,17],congratul:17,connect:[5,6],connectioncountint:6,connectionfirstqueueitemcountint:6,consist:4,consol:[6,12,15,17],consolid:[4,17],contact:17,contain:[5,6,9,11,12,15],content:[3,5,6],context:9,continu:5,control:[4,5,6,7,9,17],control_typ:12,control_type_r:12,controlpanel:[5,6,7,17],controlpanelcp_:5,controlpaneldict:6,controlpanelinst:9,controlpanelkeyallowedlist:6,controlpanelrefreshintervalsecfloat:6,convent:12,cooki:6,copi:12,copyright:17,core:[1,4,17],cost:[1,17],count:9,coverag:9,cp1251:[3,5],cp866:[3,5],cp_:[5,7],cp_versioncheck:5,cpkei:6,cpkeydict:[6,8],cpkeystr:[6,8],creat:[2,3,4,5,6,7,9,10,17],credenti:5,criteria:9,crosscheck:5,css:13,ctrl_index:12,current:[3,4,5,6,8,9,12],custom:[4,8,12],cv2:12,daemon:[3,5],dai:5,dashboard:5,data:[3,5,6,9],datadictgener:9,datasetlast:6,datetim:[6,7],deadlin:2,dear:17,debug:[5,6],decentr:4,decid:17,decod:3,def:[4,6,7,8,10,17],defaliastest:[4,6],defhelp:5,defnamestr:6,defsettingsupdatepathlist:6,depend:17,deploi:5,deprec:5,depth:12,depth_end:12,depth_start:12,depth_stop:12,depthbit:[5,6],descipt:12,descript:[11,12,17],desktop:[1,4,5,6,9,11,17],desktopus:5,destin:[5,11],detail:[4,5,17],detect:[5,6,9,11,12],determin:[5,9],dev:5,develop:[5,12,17],dict:[3,5,6,9,11,12,17],dictionari:[4,6],differ:4,directori:[5,9,12],disappear:11,disc:5,disconnect:[5,6],distribut:17,divis:17,dll:17,doc:[12,17],document:[11,17],docutil:[3,5,11,16],dodict:6,doe:[5,15],doen:5,doesn:11,domain:6,domainadstr:6,domainupperstr:5,domainus:5,don:[3,5,6,8,9],done:1,dont:[5,6,8,9],doubl:15,download:0,dp0:12,draw:11,drive:[5,6],driver:12,dsd:[4,6],dumo:5,dump:[6,7,9],dumploglist:6,dumploglistcountint:6,dumploglisthashstr:6,dumploglistrefreshintervalsecfloat:6,duplic:5,durat:6,dynam:12,each:[5,6,12,17],earli:[3,5],edit:17,editor:15,elem:12,element:[11,12],els:[3,5,6,7,9,11],empti:[5,6,8],enabl:[5,12],encapsul:[3,5,17],encod:[3,5],end:[4,5],eng:[1,17],enjoi:5,enterpris:17,enumer:9,enumeratedef:9,env:[6,9],enviro:12,environ:5,equal:[5,6],equalcas:[5,6],etc:5,even:5,event:9,everi:[5,6,9],everydai:5,exact:12,exampl:[3,4,5,6,8,9,10,11],except:[0,5,9],exe:[0,5,9,10,11,12,16],execut:[3,4,5,6,8,9,14,17],executebool:6,exist:[3,5,6,9,11,12],expens:17,expir:5,explor:[12,15],express:12,extens:[5,9,12],extra:5,extract:[5,12,17],facebook:2,fail:9,fals:[3,5,6,7,9,11],fast:[2,17],featur:[4,5,6,8,17],feel:2,field:[5,6],file:[3,5,6,9],filebodybyt:5,filehandl:6,filemanag:6,filemod:6,filenamestr:5,fileurl:6,fileurlfilepathdict:6,fileurlfilepathdict_help:6,fill:[5,6],filter:5,find:[2,4,10,11,12],find_element_by_nam:12,find_window:[11,12],firefox:12,first:[7,12,17],flag:[3,5,6,9],flagaccess:6,flagaccessdefrequestglobalauthent:6,flagcredentialsask:6,flagdonotexpir:6,flagsessionisact:[5,6],flaguseallmonitor:[5,6],flase:[3,5],flexibl:4,focu:11,folder:[5,7,12,17],follow:[0,8,9,15,17],forc:[5,9,17],forget:6,format:[3,5,9],formatt:6,found:12,founder:17,framework:[11,12,13,17],free:[2,17],fridai:5,friendly_class_nam:12,friendly_class_name_r:12,fro:5,from:[0,3,4,5,6,7,9,10,11,16,17],front:5,full:[5,6],fulli:12,fullscreen:[5,6],fullscreenbool:[6,8],fullscreenrdpsessionkeystr:6,functional:7,further:5,futher:9,garbag:5,gener:[5,6,17],get:[5,6,9,11,12,17],get_osbitnessint:11,getcontrol:11,getlogg:6,git:[0,5,6,8],github:2,gitlab:[0,1,2,12,17],give:[5,6,8],given:5,glob:5,global:[3,5,17],goe:[4,9],going:17,good:[4,17],graphic:[12,17],great:17,group:[8,17],gset:[4,7,9,17],gsettingsautoclean:5,gsettingsdict:5,gsettingsget:[5,7],gsettingskeylistvalueappend:5,gsettingskeylistvalueget:5,gsettingskeylistvalueoperatorplu:5,gsettingskeylistvalueset:5,gui:[3,4,5,11,12,13,17],guid:[1,5,6],guidstr:[5,6],gurbag:6,habr:[1,17],handl:6,handlebar:13,handler:[5,6,9],hard:[5,6,8],has:[0,2,4,5,6,8,9,12,16],hash:9,have:5,height:[5,6],help:[0,2,5,17],helpfulli:11,here:[5,7,10,11,12,17],hex:[5,6,12],hidden:5,hiddenisorchestratoriniti:6,hierarchi:[5,12,15],highlight:[11,12,15],hightlight:15,homepag:2,host:[2,5,6,17],hostnam:[5,9],hostnameupperstr:6,how:[9,11,16,17],html:[1,3,5,6,9,11,12,16,17],http:[0,2,3,4,5,6,9,11,12,13,16],human:5,identif:[5,12],identifi:[9,12],ignor:[5,6],ignorebool:[6,8],imag:17,imaslov:7,implement:12,inactionnam:11,inactivityitemdict:5,inactivitylist:5,inaddressstr:5,inadisdefaultbool:[5,7],inadloginstr:[5,7],inadstr:[5,7],inagentfilepathstr:5,inagenthostnamestr:9,inagentusernamestr:9,inaliasstr:5,inarg1str:5,inargdict:5,inarggset:5,inarggsettingsstr:5,inarglist:5,inargloggerstr:5,inargu:12,inargumentlist:11,inasyncinitbool:[5,7],inbackend:11,inbreaktriggerprocesswoexelist:5,incapturebool:[3,5],incertfilepempathstr:5,incheckintervalsecfloat:5,incloseforcebool:5,includ:11,incmdencodingstr:[3,5],incmdstr:[3,5],incontenttypestr:5,incontrolpanelnamestr:9,incontrolspecificationarrai:11,incpkeystr:5,indatadict:9,indef:5,indefargdict:5,indefarggsettingsnamestr:5,indefarglist:5,indefargloggernamestr:5,indefargnamegsettingsstr:[5,7],indefnamestr:5,indefquerystr:5,indefstr:[5,7],indepthbitint:5,index:[4,5,6,11,12],indict:6,indomainstr:5,indumprestorebool:[5,7],inel:[10,11,12],inelementspecif:11,inencodingstr:[3,5],inexecuteinnewthreadbool:5,infiledatabase64str:[3,5],infiledatabyt:5,infiledatastr:[3,5],infilepathstr:[3,5],infinit:5,inflagforceclosebool:5,inflaggetabspathbool:5,inflagraiseexcept:[10,11,12],inflagwaitallinmo:11,info:[5,6,7,12],infolderpathstr:5,inforcebool:5,inform:[4,5,9],infrastructur:17,inglobpatternstr:[5,7],ingset:[3,4,5,7],ingsettingsclientdict:6,inguidremovebool:5,inguidstr:5,inhashkeystr:6,inheightpxint:5,inherit:12,inhostfilepathstr:5,inhostnamestr:5,inhoststr:[5,6],inhtmlrenderdef:5,inintervalasyncbool:5,inintervalsecfloat:5,inintervalsecondsint:9,inismanualbool:9,init:[4,5,6,7,9,11,16],initdatetim:6,initi:[5,6,9],initjsjinja2strgener:9,initjsjinja2templatepathset:9,injinja2dataupdatedict:9,injinja2templatepathstr:9,injinja2templaterefreshbool:9,injsinitgeneratordef:5,injsongeneratordef:5,inkeyfilepathstr:5,inkeylist:5,inkeystr:6,inkwargumentobject:11,inlogg:[5,6,16],inloggerlevel:6,inloginstr:[5,6],inmatchtypestr:5,inmessagestr:5,inmethodstr:5,inmodestr:[4,5,6,7],inmodulepathstr:5,inmstdnint:9,inmstdtsecfloat:9,inmuteignorebool:9,inoperationcodestr:5,inorchestratorfilepathstr:5,inpasswordstr:[5,6],inpathstr:5,inportint:5,inportstr:[5,6],inprocessnamewexestr:5,inprocessnamewoexelist:[3,5],inprocessnamewoexestr:[5,9],inrdpfilepathstr:5,inrdpsessionkeystr:[5,6],inrdptemplatedict:5,inredirectclipboardbool:5,inrefreshhtmljinja2templatepathstr:9,inrequest:[5,9],inresponestr:5,inreturn:6,inrobotnamestr:[5,9],inrolehierarchyalloweddict:[5,7],inrolekeylist:5,inrowcountint:6,inrunasadministratorbool:5,inrunasyncbool:[3,5],insendoutputtoorchestratorlogsbool:[3,5],insert:[5,7],inserverkeystr:5,inshareddrivelist:5,inspecificationlist:[10,11,12],inspecificationlistlist:11,instal:17,instanc:[4,5,6,9,11,12],instartargdict:9,instartcmdstr:9,instartpathstr:9,instatuscheckintervalsecfloat:9,instopprocessnamewoexestr:5,instopsafetimeoutsecfloat:9,insupertokenstr:[5,7],intellig:12,interact:[4,5,11],interest:5,interfac:[4,5,7,12,17],intern:9,internet:15,interpret:4,interv:[5,6,9],intervalsecfloat:6,inthreadbool:5,intimehhmmstr:5,inuacbool:5,inuioselector:11,inurllist:[5,7],inurlstr:5,inusebothmonitorbool:5,inusernamestr:5,inuserstr:5,invalu:5,inwaitsec:11,inweekdaylist:5,inwidthpxint:5,is_en:12,is_vis:12,islistenbool:6,isresponsiblebool:5,issafestop:16,isstopsaf:16,issu:2,it4busi:2,it4busin:2,item:[4,5,6,11,12],iter:[5,6],ivan:17,ivanmaslov:2,java:9,javascript:5,jinja2:9,jinja2dataupdatedictset:9,jinja:9,join:[5,7],jsactivitylistexecut:5,json:[3,4,5,6,9],jsprocessoractivitylistadd:5,jsrender:13,jsview:13,just:[9,12],kb2999226:0,keep:4,kei:[5,6,9,12],keyboard:[2,13,17],keyfilepathstr:6,keyturpleget:9,kill:5,killer:17,know:[4,9],known:17,kwarg:4,lactivityitem:5,laliasstr:5,last:[6,9],later:5,latest:12,launch:5,lcp:9,lcpmanag:9,leaflet:[1,17],left:4,len:6,less:[1,17],let:17,level:[12,17],levelnam:6,lib:[5,12],librari:12,licens:17,life:6,lifetim:6,lifetimerequestsecfloat:6,lifetimesecfloat:6,light:4,like:[4,17],line:12,link:[4,5,6],linkedin:2,list:[3,4,5,6,9,11,12,17],listen:5,listendict:6,listread:6,litem:12,littl:8,llc:[2,17],llogger:5,lnotepadokbutton:10,load:[5,6,9],local:5,localhost:6,locat:5,lof:9,log:[3,5,6,7,8,9,16,17],logger:[5,6,16],loggerdumploghandleradd:6,loggerhandlerdumploglist:6,login:[5,6,7],logoff:[5,6],logout:17,logviewerbool:[6,8],lol:15,look:[4,5,6,8,15,17],lookmachinescreenshot:6,loop:[5,6,12],low:12,lowercas:6,lprocess:9,lprocessisstartedbool:5,lprocesslist:5,lpymodul:7,lpyopenrpa_settingsdict:11,lpyopenrpasourcefolderpathstr:7,lrdpitemdict:5,lrdptemplatedict:5,lrequest:5,lresult:6,lresultdict:[5,6],luacclientdict:7,lwebauditmessagestr:5,lxml:13,mabspathupperstr:6,mac:17,machin:[0,5,6,17],machina:6,magenthostnamestr:6,magentusernamestr:6,mail:2,main:[4,5,6,7,9,12],maintain:17,make:12,makedir:6,manag:[5,6,17],managersgitdict:6,managersprocessdict:6,mani:[2,4,5,11,17],manipul:[5,8,17],manual2auto:9,manual:9,manualstop:9,manualstoplistclear:9,manualstoptrigg:9,manualstoptriggernewstart:9,manualstoptriggerset:9,mark:9,markdown:[1,17],maslov:17,master:0,match:12,matchtyp:6,math:9,mathmodul:9,max:6,maxim:11,maximum:12,mayb:5,mechan:4,mega:[4,8],megafind:2,memori:5,menu:10,merg:5,messag:[5,6,16],method:[6,9,12],methodmatchurl:6,methodmatchurlbeforelist:6,methodolog:2,mhandlerdumploglist:6,microsoft:[0,12],minim:11,minut:6,miss:12,mit:2,mmstr:6,mode:15,model:[2,12],modif:3,modifi:9,modul:[4,5,6,7,16],modulenamestr:5,moduletocal:5,mondai:5,monitor:5,more:[4,6,7,9,12],mous:17,mprocessnamewoexestr:6,mrobotlogg:6,mrobotloggerfh:6,mrobotloggerformatt:6,mrobotnamestr:9,mst:9,mstatusstr:9,mstopsafetimeoutsecfloat:9,must:[5,6],mute:9,mutewait:9,name:[4,5,6,9,11,12],namewoexestr:5,namewoexeupperstr:5,need:[0,2,3,4,5,6,7,8,9,11,12,17],nest:5,net:[3,5,11,16],never:5,newkeydict:5,newkeylist:5,newvalu:5,next:[5,9,12],none:[3,4,5,6,9,10,11,12,16],notat:[11,12],notepad:[3,5,9,10,11,12],noth:5,nothingbool:[6,8],now:[5,6,9,11],nul:12,object:[4,5,6,9,11,12,17],occupi:5,ocr:12,octet:5,off:[6,8],old:[5,6,11],onc:[9,11],one:[6,8],oninitj:9,oninitjsdatadict:9,oninitjsstr:9,onli:[0,3,5,6,8,9,11,12,17],onrefreshhtml:9,onrefreshhtmldatadict:9,onrefreshhtmlhashstr:9,onrefreshhtmlstr:9,onrefreshjson:9,onrefreshjsondict:9,op_code_1:5,open:[1,6,15,17],opencv:[0,13,17],openrpa52zzz:7,openrpa:[0,6],openrpa_32:15,openrpa_64:15,openrpaorchestr:12,openrparesourceswpy32:12,openrparesourceswpy64:12,openrparobotguix32:11,opensourc:17,oper:[0,5,7,9,17],opera:12,operatormodul:9,optim:9,option:[5,6,8,12],orc:[5,6,8,9],orch:6,orchestr:[3,6,7,9],orchestratorinitwait:5,orchestratorisadmin:[5,7],orchestratorisinit:5,orchestratorloggerget:[5,7],orchestratormain:12,orchestratormodul:9,orchestratorpysearchinit:[5,7],orchestratorrerunasadmin:[5,7],orchestratorrestart:5,orchestratorscheduleget:[5,9],orchestratorsessionrestor:[5,7],orchestratorsessionsav:5,orchestratorstart:6,orchestratorthreadstart:5,order:[4,12,15],org:[2,12],oscmd:[3,5],oscredentialsverifi:5,osfilebinarydatabase64strappend:3,osfilebinarydatabase64strcr:3,osfilebinarydatabase64strrec:3,osfilemtimeget:3,osfiletextdatastrcr:3,osfiletextdatastrrec:3,oslogoff:5,osremotepcrestart:[5,6],other:[11,12,17],our:12,out:5,outargu:12,outlin:11,output:[3,5,6,9],outstr:5,over:9,overrid:9,overwrit:6,own:[4,7,9,12,17],packag:[0,5,7,9,10,17],page:[5,6,8,9,10],page_sourc:12,pai:[4,6],paid:[1,17],panel:[5,6,7,8,9,15],parallel:5,param:[5,9],paramet:[3,4,5,9,11,16],parent:[11,12,15],pars:5,parti:17,pass:[5,6,9],password:[5,6],path:[3,5,6,7,9,12],paus:12,pdb:6,pdf:[1,17],pem:5,perfom:[12,17],perform:17,perio:9,period:[5,6,9],perman:5,phone:4,pickl:[5,9],pid:5,pil:13,pixel:[5,6],plan:5,platform:17,pleas:5,plu:5,port:[5,6],portabl:[0,12],portint:6,possibl:17,post:[5,6],postfix:5,power:[5,17],powershel:[5,6],practic:[8,17],prefer:2,prepar:[5,9],previou:[5,9],print:[7,12],privat:5,procedur:5,process:[3,4,6,7,11,12,14,17],processbit:11,processdefintervalcal:5,processdetaillist:5,processexist:9,processget:9,processinitsaf:9,processisstart:5,processlistget:5,processmanual2auto:9,processmanualstoplistclear:9,processmanualstoptriggerset:9,processnam:5,processor:[3,6,8,17],processoractivityitemappend:5,processoractivityitemcr:5,processoraliasdefcr:5,processoraliasdefupd:5,processordict:6,processschedulestatuscheckeverysecond:9,processstart:[5,9],processstatuscheck:9,processstatusrestor:9,processstatussav:9,processstatusstrget:9,processstop:5,processstopforc:9,processstopsaf:9,processwoexelist:5,processwoexeupperlist:5,processwoexeupperuserlistget:3,product:12,program:[5,6,9,10],progress:1,project:[4,17],properti:[8,9,17],protocol:4,prototyp:6,provid:[12,17],psutil:[7,13],pull:[6,8],purpos:2,push:6,pwa:12,pwaspecif:12,pwaspecification_get_pwaappl:11,pwaspecification_get_uio:11,pyautogui:[2,12,13,17],pycon:12,pymupdf:13,pyopenrpa:[0,1,2,4,6,7,8,9,10,11,12,14,16],pyopenrpa_uidesktopx32:11,pyopenrpa_uidesktopx64:11,pyopenrpadict:[6,8],pypathstr:5,python32fullpath:11,python32processnam:11,python64fullpath:11,python64processnam:11,python:[0,4,10,11,13,15,17],pythonstart:5,pywin32:[2,13],pywinauto:[2,11,12,13],queri:5,queue:[1,4,5,6,8],queuelist:6,r01:6,r01_integrationorderout:6,r01_orchestratortorobot:6,rais:5,rdp:[4,5,6,8],rdpactiv:6,rdpkei:5,rdpkeydict:[6,8],rdpkeystr:[6,8],rdplist:[5,6],rdpsession:17,rdpsessioncmdrun:5,rdpsessionconnect:[5,6],rdpsessiondisconnect:[5,6],rdpsessiondublicatesresolv:5,rdpsessionfilestoredreciev:5,rdpsessionfilestoredsend:5,rdpsessionkei:6,rdpsessionkeystr:6,rdpsessionlogoff:5,rdpsessionmonitorstop:5,rdpsessionprocessstartifnotrun:5,rdpsessionprocessstop:5,rdpsessionreconnect:[5,6],rdpsessionresponsibilitycheck:5,rdptemplatecr:5,read:[3,5,6],readi:0,readthedoc:[5,6,12],receiv:5,reciev:[5,6],recognit:17,reconnect:[5,6],reconnectbool:[6,8],recoverydict:6,recurs:12,redirectclipboardbool:5,reestr_otgruzok:6,refer:17,refresh:[6,9],refreshhtmljinja2strgener:9,refreshhtmljinja2templatepathset:9,regener:5,regular:12,reinit:9,rel:[5,6,9],reliabl:[2,17],reload:9,rememb:[6,8],remot:[5,6,17],remov:[5,9],render:[9,15],replac:5,report:6,reqir:4,request:[5,6,9,13],requestinst:9,requesttimeoutsecfloat:6,requir:[5,9,17],rerun:5,resolut:[5,6],resourc:[0,5,11,12,17],respons:[5,6],responsecontenttyp:6,responsedefrequestglob:6,responsefilepath:6,responsefolderpath:6,responsibilitycheckintervalsec:6,restart:[5,6,8,9],restartforc:9,restartorchestr:6,restartorchestratorbool:[6,8],restartorchestratorgitpullbool:[6,8],restartpcbool:[6,8],restartsaf:9,restor:[5,7,9,11],restructuredtext:[3,5,11,16],result:[5,6,8,9,11,12],retart:5,returnbool:6,returnedbydatetim:6,rich_text:12,rich_text_r:12,right:[5,17],roadmap:17,robot:[4,5,6,7,8,9,10,11,16],robot_r01:6,robot_r01_help:6,robotrdpact:[5,6],rolehierarchyalloweddict:6,root:[5,6],row:6,rpa01:5,rpa:[1,5,6,10,17],rpa_99:5,rpatestdirtest:5,rst:[3,5,11,16],rule:9,ruledomainuserdict:6,rulemethodmatchurlbeforelist:6,run:[0,3,5,6,7,9,11,17],russia:[2,17],russian:17,safe:[3,5,9,11,17],safeti:5,same:11,save:[5,9],schedul:[4,6,9,17],scheduleractivitytimeaddweekli:5,schedulerdict:6,scopesrcul:[5,6],screen:[5,6,17],screenshot:[0,6,8,17],screenshotviewerbool:[6,8],script:[4,9,17],search:[5,17],sec:[5,6],second:[5,6,9,11,12],section:[5,11],secur:5,see:[0,5,6,7,9,10,11,17],select:11,selector:[11,12,15,17],selenium:[2,13,17],self:9,semant:[2,13],send:[3,5,6,8,9,17],send_kei:12,sensit:5,sent:[5,6],sequenc:[4,5],server:[0,3,4,5,6,8,9,15,17],serverdict:6,serverinst:6,serverset:[6,9],serverthread:6,sesion:[5,6],session:[3,5,6,9,17],sessionguidstr:6,sessionhex:[5,6],sessionisignoredbool:[5,6],sessioniswindowexistbool:[5,6],sessioniswindowresponsiblebool:[5,6],set:[3,5,6,7,8,9,11,17],set_trac:6,setformatt:6,setlevel:[6,7],settingsinit:11,settingstempl:[4,6,7],settingsupd:[5,7],setup:6,sever:[4,12,17],share:5,shareddrivelist:[5,6],shell:[5,17],should:[6,9],show:[6,8],side:[5,6,8,9,16],signal:[5,9,16],simplifi:12,sinc:[6,17],singl:4,singleton:[3,5],site:5,size:6,skype:2,sleep:[6,12],socket:4,softwar:2,solut:[0,12,17],some:[2,4,5,6,8,9],someprocess:16,someth:9,soon:[1,17],sorri:17,sort:5,sourc:[3,4,5,7,9,11,16,17],sourceforg:[3,5,11,16],space:4,special:[5,6],specialist:2,specif:12,specifi:[5,9],sphinx:[4,17],ssl:5,stabl:[5,6],standart:6,start:[0,3,5,6,7,9,12,15,17],startcheck:9,state:9,statu:[5,9],status:9,statuschangelog:9,statuscheck:9,statuscheckintervalrestor:9,statuscheckstart:9,statuscheckstopforc:9,statuscheckstopsaf:9,statuscheckstorforc:9,statusrestor:9,statussav:9,stdout:6,stop:[5,9,12,16,17],stop_saf:9,stopforc:9,stopforcecheck:9,stopsaf:[9,17],stopsafecheck:9,storag:[6,17],storagedict:6,storagerobotdict:9,storagerobotexist:5,storagerobotget:[5,9],store:6,str:[3,4,5,6,9,11,12],stream:5,streamhandl:6,strftime:6,string:[3,5,11],struct:6,structur:[4,5,6],studio:[4,14,15],subprocess:12,success:5,successfulli:[0,5,6,12,17],sundai:5,supertoken:[5,7],superus:[5,7],supetoken:5,supplement:12,support:[0,4,9,12,15,17],symbol:4,sync:[4,5],synchroni:5,sys:[5,6,7,12],system:17,tablet:4,task:2,taskkil:16,technic:[4,6],technicalsessionguidcach:6,telegram:2,templat:[9,17],term:9,termin:9,terminolog:12,tesseract:13,test2:6,test:[3,5,6,7,9],testcontrolpanel:9,testdef:5,testdefalia:5,testdir:5,testdirtest:5,testrdp:6,testttt:9,text:[3,5,12,15],than:[4,6,11],thank:[2,17],theori:17,thi:[3,5,6,8,9,12,17],thing:9,thought:5,thread:[4,5,6,8],threadidint:6,thursdai:5,thx:12,time:[3,5,6,9,12,17],timehh:6,timestamp:3,titl:[10,11,12],title_r:12,todo:[5,9],token:5,tokendatetim:6,too:[5,6,8],tool:[4,6,12,15,16],top:11,tor:17,track:5,transmiss:5,transmit:[3,4,5,6,9],tree:17,tri:9,trigger:[5,6,9],triggercountint:6,ttt:[4,6],turn:[6,8],turpl:[4,9],tutori:[1,17],txt:5,type:[5,6,9],uac:17,uacbool:6,uacclientcheck:9,uackeylistcheck:5,uacsupertokenupd:[5,7],uacupd:[5,7],uacuserdictget:[5,9],uia:[11,12],uidesktop:[10,11],uio:[11,15,17],uioactiv:[11,12],uioei:12,uioinfo:12,uioselector:11,uioselector_exist_bool:11,uioselector_focushighlight:[11,12],uioselector_get_bitnessint:11,uioselector_get_bitnessstr:11,uioselector_get_uio:[10,11,12],uioselector_get_uioactivitylist:11,uioselector_get_uioinfo:11,uioselector_get_uiolist:11,uioselector_getchildlist_uiolist:11,uioselector_highlight:11,uioselector_safeotherget_process:11,uioselector_searchchildbymouse_uio:11,uioselector_searchchildbymouse_uiotre:11,uioselector_tryrestore_dict:11,uioselectorsecs_waitappear_bool:11,uioselectorsecs_waitdisappear_bool:11,uioselectorssecs_waitappear_list:11,uioselectorssecs_waitdisappear_list:11,uioselectoruioactivity_run_dict:11,uiotre:12,under:17,understand:8,unicodelab:[0,2,12],univers:4,unix:17,unzip:0,updat:[5,6],upper:[3,5,6,9],url:[5,6],urllist:6,usag:[5,9,10,12],use:[0,3,4,5,6,8,9,11,16,17],used:5,useful:12,user:[3,4,5,6,7,9,11,12,17],user_99:5,user_pass_her:5,useradstr:6,userinfodict:9,usernam:5,usernameupperstr:5,userrpa:5,useruaccheckdef:9,useruacdict:9,userupperstr:6,using:[5,12,17],utf:[3,5],util:[6,11,17],valu:[5,6,9,11],variant:5,ver:[5,12],veri:[2,5],verifi:5,version:[5,9,12,15],versionstr:6,via:[2,5,9],video:12,viewer:[6,8,17],virtual:6,visibl:12,vision:[12,17],vista:0,visual:17,vms:5,wai:[5,7,12],wait:[3,5,9,11,12,15],want:[4,6,8,9,15],warn:6,warningexecutionmorethansecfloat:6,web:[1,4,6,9,17],webaudit:5,webauditmessagecr:5,webcpupd:5,webdriv:12,weblistencr:[5,7],webrequestget:5,webrequestparsebodybyt:5,webrequestparsebodyjson:5,webrequestparsebodystr:5,webrequestparsefil:5,webrequestparsepath:5,webrequestresponsesend:5,weburlconnectdef:5,weburlconnectfil:5,weburlconnectfold:5,webuserinfoget:[5,9],webuserissupertoken:5,webuseruachierarchyget:5,wednesdai:5,week:5,weekdai:[5,6],weekdaylist:6,well:17,were:[5,17],whatsapp:2,when:[4,5,6,9,11,15],where:[3,5,12,15],which:[2,4,5,6,9,10,11,12,17],who:6,why:4,width:[5,6],wiki:12,win32:[11,17],win32api:13,win:5,window:[0,3,5,6,11,13,17],winpython:2,without:[0,3,5,6,9,17],wm_close:16,wmi:13,work:[5,6,8,9,12,17],workingdirectorypathstr:6,world:17,wpy32:[0,11,12],wpy64:[0,5,11,12],wrapper:11,write:[2,3,4,12,17],www:[2,12,13],x32:[0,11,13,15,17],x64:[0,5,11,13,15,17],xlsx:6,you:[0,2,3,4,5,6,7,8,9,10,11,12,16,17],your:[0,2,6,9,11,12],zip:0},titles:["1. How to install","2. Roadmap","3. Copyrights & Contacts","2. Defs","1. Description","2. Defs","3. gSettings Template","4. How to use","5. UAC - User Access Control","6. Defs Managers","1. Description","2. Defs","3. How to use","4. Dependencies","1. Description","2. How to use","2. Defs StopSafe","Welcome to pyOpenRPA\u2019s wiki"],titleterms:{The:[12,15,17],Use:12,__agent__:3,__orchestrator__:5,about:[8,12,17],access:[8,12],action:15,agent:[3,5,17],app:12,architectur:4,autom:12,basic:5,button:15,captur:12,check:0,choos:15,click:15,cmd:12,compon:[2,4],concept:4,configur:4,contact:2,content:[15,17],control:8,controlpanel:9,copyright:2,creat:12,ctrl:15,def:[3,5,9,11,16],definit:12,depend:[2,13],descript:[4,10,14,15],desktop:12,detail:9,dict:[4,8],dll:12,exampl:12,execut:12,expand:15,extract:15,file:12,founder:2,from:12,gener:9,global:4,group:5,gset:[5,6],gui:15,guid:17,has:17,hold:15,hover:15,how:[0,4,7,12,15],imag:12,instal:0,interest:15,ivan:2,kei:15,keyboard:12,licens:2,list:15,main:17,manag:9,manipul:12,maslov:2,modul:12,mous:[12,15],object:15,openrpa:12,orchestr:[4,5,8,17],parti:2,practic:12,process:[5,9],processor:[4,5],properti:15,pyopenrpa:[3,5,17],python:[5,12],rdpsession:5,recognit:12,refer:[3,4,5,11,16],repo:17,requir:0,result:15,right:8,roadmap:1,robot:[12,17],rpa:12,run:15,schedul:5,screen:12,screenshot:15,script:12,search:15,second:15,select:15,selenium:12,set:4,shown:15,stopsaf:16,storag:5,structur:[12,17],studio:[12,17],system:0,templat:6,theori:12,tool:17,tree:15,turn:15,uac:[5,8],uidesktop:12,uio:12,uioselector:12,use:[7,12,15],user:8,viewer:15,web:[5,8,12],welcom:17,what:12,wiki:17,win32:12,x32:12,x64:12,you:15}}) \ No newline at end of file diff --git a/Wiki/ENG_Guide/markdown/01_HowToInstall.md b/Wiki/ENG_Guide/markdown/01_HowToInstall.md deleted file mode 100644 index f73493dd..00000000 --- a/Wiki/ENG_Guide/markdown/01_HowToInstall.md +++ /dev/null @@ -1,39 +0,0 @@ -# 1. How to install - -Are you ready to install the pyOpenRPA solution on your machine? - -Ok, we start. -**Do the following operations:** - - -* Download the pyOpenRPA package from master branch on GitLab [Download ZIP]([https://gitlab.com/UnicodeLabs/OpenRPA/-/archive/master/OpenRPA-master.zip](https://gitlab.com/UnicodeLabs/OpenRPA/-/archive/master/OpenRPA-master.zip)) - - -* Unzip the package - -**Installation has been completed :)** - -## How to check installation - - -* Run portable python (built in the pyOpenRPA) - - - * x32 python (GIT\\Resources\\WPy32-3720\\python-3.7.2\\python.exe) - - - * x64 python (GIT\\Resources\\WPy64-3720\\python-3.7.2.amd64\\python.exe) - -**The pyOpenRPA has been successfully installed if the portable python 3.7.2 was started without any exceptions (see screenshot).** - - - -![image](img/cb5dec8cecafa7d64f6cd14b2672acce.png) - -## System requirements - - -* OS Windows 7+. *Need Windows package KB2999226 if use windows Vista/7/8/8.1/Server 2008/Server 2012 (https://support.microsoft.com/ru-ru/help/2999226)* - - -* For OpenCV: OS Windows 7/8/8/10 only (no Windows Server) diff --git a/Wiki/ENG_Guide/markdown/02_RoadMap.md b/Wiki/ENG_Guide/markdown/02_RoadMap.md deleted file mode 100644 index d7c16caf..00000000 --- a/Wiki/ENG_Guide/markdown/02_RoadMap.md +++ /dev/null @@ -1,52 +0,0 @@ -# 2. Roadmap - - -* Guide - - - * ENG - done 2021.03.11 - - - * HTML [|OPEN GITLAB|](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/html/index.html) - - - * MarkDown [|OPEN GITLAB|](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/markdown/index.md) - - - * PDF [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) - - - * RUS - queue - - -* Tutorial - - - * ENG - queue - - - * RUS - in progress - - - * Article: Less cost - no paid RPA [|OPEN HABR|](https://habr.com/ru/post/506766/) - - - * Tutorial Desktop UI [|OPEN HABR|](https://habr.com/ru/post/509644/); [|OPEN GITLAB|](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/DesktopGUI_Habr/index.md) - - - * Tutorial Web UI [|OPEN HABR|](https://habr.com/ru/post/515310/); [|OPEN GITLAB|](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/WebGUI_Habr/readme.md) - - - * Article: RPA as a core of the IT automation - soon - - -* Leaflet - - - * ENG queue - - - * RUS done 2021.02.23 - - - * RUS Leaflet pyOpenRPA v4.pdf [|OPEN GITLAB|](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v4.pdf) diff --git a/Wiki/ENG_Guide/markdown/03_Copyrights_Contacts.md b/Wiki/ENG_Guide/markdown/03_Copyrights_Contacts.md deleted file mode 100644 index c7ac87d2..00000000 --- a/Wiki/ENG_Guide/markdown/03_Copyrights_Contacts.md +++ /dev/null @@ -1,55 +0,0 @@ -# 3. Copyrights & Contacts - -pyOpenRPA is created by Ivan Maslov (Russia). -Hosted by PYOPENRPA LLC (Russia) - -My purpose is to create #IT4Business models in the companies. -I can help you to create the new #IT4Business in your company. -#IT4Business homepage - [https://www.facebook.com/RU.IT4Business](https://www.facebook.com/RU.IT4Business) -#IT4Busines is the methodology which is created for build compact fast and reliable IT function in company. -If you has many IT specialists, very long deadlines for the IT tasks, many bugs in IT software - #IT4Business is for you :) - -If you need some IT help - feel free to contact me (prefer e-mail or skype). -If you will find some issue in pyOpenRPA - write about it to me via e-mail/skype/gitlab issue. - -Thank you! - -## Ivan Maslov (founder) - - -* E-mail: [Ivan.Maslov@UnicodeLabs.ru](mailto:Ivan.Maslov@UnicodeLabs.ru) - - -* Skype: MegaFinder - - -* Facebook: [https://www.facebook.com/RU.IT4Business](https://www.facebook.com/RU.IT4Business) - - -* LinkedIn: [https://www.linkedin.com/in/RU-IvanMaslov/](https://www.linkedin.com/in/RU-IvanMaslov/) - - -* WhatsApp | Telegram: +7 906 722 39 25 - -## 3-rd party components license dependencies - - -* WinPython 3.7.1 32-bit & 64-bit, license MIT ([https://github.com/winpython/winpython](https://github.com/winpython/winpython)) - - -* Selenium v…, license Apache 2.0 - - -* pywinauto 0.6.5, license BSD 3-Clause ([https://github.com/pywinauto/pywinauto](https://github.com/pywinauto/pywinauto)) - - -* Semantic UI …, license MIT ([https://github.com/Semantic-Org/Semantic-UI](https://github.com/Semantic-Org/Semantic-UI)) - - -* PyAutoGUI …, license BSD 3-Clause ([https://github.com/asweigart/pyautogui](https://github.com/asweigart/pyautogui)) - - -* keyboard …, license MIT ([https://github.com/boppreh/keyboard](https://github.com/boppreh/keyboard)) - - -* pywin32 diff --git a/Wiki/ENG_Guide/markdown/Agent/02_Defs.md b/Wiki/ENG_Guide/markdown/Agent/02_Defs.md deleted file mode 100644 index 0bc0f528..00000000 --- a/Wiki/ENG_Guide/markdown/Agent/02_Defs.md +++ /dev/null @@ -1,188 +0,0 @@ -# 2. Defs - -## pyOpenRPA.Agent.__Agent__ - -**Functions:** - -| `OSCMD`(inCMDStr[, inRunAsyncBool, …]) - - | Execute CMD on the Agent daemonic process - - | -| `OSFileBinaryDataBase64StrAppend`(…[, …]) - - | Create binary file by the base64 string (safe for JSON transmition) - - | -| `OSFileBinaryDataBase64StrCreate`(…[, …]) - - | Create binary file by the base64 string (safe for JSON transmition) - - | -| `OSFileBinaryDataBase64StrReceive`(inFilePathStr) - - | Read binary file and encode in base64 to transmit (safe for JSON transmition) - - | -| `OSFileMTimeGet`(inFilePathStr) - - | Read file modification time timestamp format (float) - - | -| `OSFileTextDataStrCreate`(inFilePathStr, …) - - | Create text file in the agent GUI session - - | -| `OSFileTextDataStrReceive`(inFilePathStr[, …]) - - | Read text file in the agent GUI session - - | -| `ProcessWOExeUpperUserListGet`() - - | Return the process list only for the current user (where Agent is running) without .EXE in upper case. - - | - -### pyOpenRPA.Agent.__Agent__.OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings=None, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr='cp1251', inCaptureBool=True) -Execute CMD on the Agent daemonic process - - -* **Parameters** - - - * **inCMDStr** – command to execute on the Agent session - - - * **inRunAsyncBool** – True - Agent processor don’t wait execution; False - Agent processor wait cmd execution - - - * **inGSettings** – Agent global settings dict - - - * **inSendOutputToOrchestratorLogsBool** – True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True - - - * **inCMDEncodingStr** – Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is “cp1251” early was “cp866” - need test - - - * **inCaptureBool** – !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent - - - -* **Returns** - - - - -### pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrAppend(inFilePathStr, inFileDataBase64Str, inGSettings=None) -Create binary file by the base64 string (safe for JSON transmition) - - -### pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str, inGSettings=None) -Create binary file by the base64 string (safe for JSON transmition) - - -### pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrReceive(inFilePathStr, inGSettings=None) -Read binary file and encode in base64 to transmit (safe for JSON transmition) - - -* **Parameters** - - - * **inFilePathStr** – File path to read - - - * **inGSettings** – global settings of the Agent (singleton) - - - -* **Returns** - - File content in string base64 format (use base64.b64decode to decode data). Return None if file is not exist - - - -### pyOpenRPA.Agent.__Agent__.OSFileMTimeGet(inFilePathStr: str) -Read file modification time timestamp format (float) - - -* **Parameters** - - **inFilePathStr** – File path to read - - - -* **Returns** - - timestamp (float) Return None if file is not exist - - - -### pyOpenRPA.Agent.__Agent__.OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr='utf-8', inGSettings=None) -Create text file in the agent GUI session - - -* **Parameters** - - - * **inFilePathStr** – File abs path - - - * **inFileDataStr** – File data text content - - - * **inEncodingStr** – Write file encoding - - - * **inGSettings** – global settings of the Agent (singleton) - - - -* **Returns** - - - - -### pyOpenRPA.Agent.__Agent__.OSFileTextDataStrReceive(inFilePathStr, inEncodingStr='utf-8', inGSettings=None) -Read text file in the agent GUI session - - -* **Parameters** - - - * **inFilePathStr** – File abs path - - - * **inEncodingStr** – Read file encoding. Default utf-8 - - - * **inGSettings** – global settings of the Agent (singleton) - - - -* **Returns** - - File text content in string format (use base64.b64decode to decode data). Return None if file is not exist - - - -### pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet() -Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent - - -* **Parameters** - - **inProcessNameWOExeList** – - - - -* **Returns** - - list of the agent user process in upper case without .EXE. Example [“NOTEPAD”,”…”], - - -## References - -[reStructuredText](http://docutils.sourceforge.net/rst.html) diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/01_Orchestrator.md b/Wiki/ENG_Guide/markdown/Orchestrator/01_Orchestrator.md deleted file mode 100644 index e6950bf2..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/01_Orchestrator.md +++ /dev/null @@ -1,82 +0,0 @@ -# 1. Description - -pyOpenRPA Orchestrator is the executable process. - -The features of the orchestrator is: -- Centralized/decentralized user control interface (applicable and for business users and for technical users). Web based, support desktop, tablet, phone. -- Automatized robots control (customized algorithms, robots scheduling) -- Source code mega flexibility: Light Orchestrator architecture is good for own customization - -## Global settings dict concept - -pyOpenRPA project is complex tool which consist of several executable modules such as Robot, Orchestrator, Studio, - -Because of module compexity, we use 1 init arg - inGSettings -inGSettings is a complex dictionary which has all reqired parameters for the module execution. - -The description of the GSettings you can find in executable module details. - -## Orchestrator how to configure - -To init pyOpenRPA Orchestrator instance use script: - -from pyOpenRPA import Orchestrator # Import orchestrator main -gSettings = SettingsTemplate.Create(inModeStr=”BASIC”) # Create GSettings with basic configuration -Orchestrator.Orchestrator(inGSettings=gSettings) # Call the orchestrator def - -gSettings structure - -## Orchestrator architecture - -Orchestrator has several source code components: -- User/robot activity consolidated queue single thread (Processor) -- User/robot activity asynchonus many threads (Processor) -- Scheduler single thread (main) -- RDP keep active many thread -- Autocleaner single thread -- GUI keep active single thread -- HTTP web server single thread (create user socket threads) -- - -Below you can find more information about all of the component. - -## Component Processor - -Sync - Append activity list to consolidated processor queue. Execution goes sequency by the activity list order - -Async - Create New thread to execute the activity list - - -* Activity list - -List of the activity item - - -* Activity item - -Activity item is universal mechanism to execute different algorythms from any sources. -The core feature of the Activity is to call python defs with args and kwargs. -If you need to init do some activity you can write some python def, then create Activity item with current def. -ATTENTION: In some cases (such as web transmition), when you can’t transmit python def as object you can use symbolic names for python defs. It is apply you to init all of you want from the web UI. - -?Why i cant transmit python def from the web -Because the WEB space is not the Python executable space. Interaction between it spaces create by JSON protocol. So, we know than JSON apply int, float, str, bool, None, list, dict - that is all. - -**NOTE**: Example -{ - -> “Def”:”DefAliasTest”, # def link or def alias (look gSettings[“Processor”][“AliasDefDict”]) -> “ArgList”:[1,2,3], # Args list -> “ArgDict”:{“ttt”:1,”222”:2,”dsd”:3}, # Args dictionary -> “ArgGSettings”: None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) -> “ArgLogger”: None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - -}# Pay attention! Do not left comma symbol after the end of the dict - it can be interpretated like a turple.. - -## References - - - -``` -`Python-sphinx`_ -``` diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md b/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md deleted file mode 100644 index 48ec1e82..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/02_Defs.md +++ /dev/null @@ -1,3107 +0,0 @@ -# 2. Defs - -## pyOpenRPA.Orchestrator.__Orchestrator__ - -``` -# EXAMPLE 1 -from pyOpenRPA import Orchestrator -Orchestrator.OSCMD(inCMDStr = "git status", inRunAsyncBool=True) - -# EXAMPLE 2 -from pyOpenRPA.Orchestrator import __Orchestrator__ -__Orchestrator__.OSCMD(inCMDStr = "git status", inRunAsyncBool=True) -``` - -### Group Agent… - -Interaction between Orchestrator and pyOpenRPA.Agent daemon process, which can be deployed in another user session. - -### Group GSettings… - -Basic defs to work with singleton gSettings. - -### Group Storage… - -Defs to work with special locations in Orchestrator: Robot, User (TODO), User + Robot (TODO) - -### Group OS… - -Interaction with shell on the Orchestrator user session. - -### Group Process… - -Interaction with some process on the Orchestrator user session. - -### Group Processor… - -Work with Processor queue (see …). - -### Group Python… - -Work with extra python modules. - -### Group RDPSession… - -Interaction with RDP session, where you can manage some robots. - -### Group Web… - -Manipulate the Orchestrator WEB side. - -### Group UAC… - -Manipulate the User Access Controls (actual for the Orchestrator WEB access for the business users) - -### Group Scheduler… - -Work with activity scheduling. - -**Functions:** - -| `ActivityItemCreate`(inDef[, inArgList, …]) - - | Create activity item. - - | -| `ActivityItemDefAliasCreate`(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) - - | -| `ActivityItemDefAliasModulesLoad`() - - | Load all def from sys.modules. - - | -| `ActivityItemDefAliasUpdate`(inDef, inAliasStr) - - | Update alias for def (can be used in ActivityItem in field Def). - - | -| `ActivityItemHelperDefAutofill`(inDef) - - | Detect def by the name and prepare the activity item dict with values. - - | -| `ActivityItemHelperDefList`([inDefQueryStr]) - - | Create list of the available Def names in activity item. You can use query def filter via arg inDefQueryStr - - | -| `AgentActivityItemAdd`(inHostNameStr, …[, …]) - - | Add activity in AgentDict. - - | -| `AgentActivityItemExists`(inHostNameStr, …) - - | Check by GUID if ActivityItem has exists in request list. - - | -| `AgentActivityItemReturnExists`(inGUIDStr[, …]) - - | Check by GUID if ActivityItem has been executed and result has come to the Orchestrator - - | -| `AgentActivityItemReturnGet`(inGUIDStr[, …]) - - | Work synchroniously! Wait while result will be recieved. - - | -| `AgentOSCMD`(inHostNameStr, inUserStr, inCMDStr) - - | Send CMD to OS thought the pyOpenRPA.Agent daemon. - - | -| `AgentOSFileBinaryDataBase64StrAppend`(…[, …]) - - | Append binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission) - - | -| `AgentOSFileBinaryDataBase64StrCreate`(…[, …]) - - | Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission) - - | -| `AgentOSFileBinaryDataBase64StrReceive`(…[, …]) - - | Read binary file and encode in base64 to transmit (safe for JSON transmition) - - | -| `AgentOSFileBinaryDataBytesCreate`(…[, …]) - - | Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition) - - | -| `AgentOSFileBinaryDataReceive`(inHostNameStr, …) - - | Read binary file from agent (synchronious) - - | -| `AgentOSFileSend`(inHostNameStr, inUserStr, …) - - | Send the file from the Orchestrator to Agent (synchroniously) pyOpenRPA.Agent daemon process (safe for JSON transmition). - - | -| `AgentOSFileTextDataStrCreate`(inHostNameStr, …) - - | Create text file by the string by the pyOpenRPA.Agent daemon process - - | -| `AgentOSFileTextDataStrReceive`(inHostNameStr, …) - - | Read text file in the agent GUI session - - | -| `AgentOSLogoff`(inHostNameStr, inUserStr) - - | Logoff the agent user session - - | -| `AgentProcessWOExeUpperUserListGet`(…[, …]) - - | Return the process list only for the current user (where Agent is running) without .EXE in upper case. - - | -| `GSettingsAutocleaner`([inGSettings]) - - | HIDDEN Interval gSettings auto cleaner def to clear some garbage. - - | -| `GSettingsGet`([inGSettings]) - - | Get the GSettings from the singleton module. - - | -| `GSettingsKeyListValueAppend`(inValue[, …]) - - | Append value in GSettings by the key list - - | -| `GSettingsKeyListValueGet`([inKeyList, …]) - - | Get the value from the GSettings by the key list - - | -| `GSettingsKeyListValueOperatorPlus`(inValue[, …]) - - | Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList) - - | -| `GSettingsKeyListValueSet`(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. - - | -| `OSLogoff`() - - | Logoff the current orchestrator session :return: - - | -| `OSRemotePCRestart`(inHostStr[, inForceBool, …]) - - | Send signal via power shell to restart remote PC ATTENTION: Orchestrator user need to have restart right on the Remote machine to restart PC. - - | -| `Orchestrator`([inGSettings, …]) - - | Main def to start orchestrator - - | -| `OrchestratorInitWait`() - - | Wait thread while orc will process initial action. - - | -| `OrchestratorIsAdmin`() - - | Check if Orchestrator process is running as administrator - - | -| `OrchestratorIsInited`() - - | Check if Orchestrator initial actions were processed - - | -| `OrchestratorLoggerGet`() - - | Get the logger from the Orchestrator - - | -| `OrchestratorPySearchInit`(inGlobPatternStr[, …]) - - | Search the py files by the glob and do the safe init (in try except). - - | -| `OrchestratorRerunAsAdmin`() - - | Check if not admin - then rerun orchestrator as administrator - - | -| `OrchestratorRestart`([inGSettings]) - - | Orchestrator restart - - | -| `OrchestratorScheduleGet`() - - | Get the schedule (schedule.readthedocs.io) from the Orchestrator - - | -| `OrchestratorSessionRestore`([inGSettings]) - - | Check _SessioLast… files in working directory. if exist - load into gsettings (from version 1.2.7) _SessionLast_GSettings.pickle (binary). - - | -| `OrchestratorSessionSave`([inGSettings]) - - | Orchestrator session save in file (from version 1.2.7) _SessionLast_GSettings.pickle (binary) - - | -| `OrchestratorThreadStart`(inDef, \*inArgList, …) - - | Execute def in new thread and pass some args with list and dict types - - | -| `ProcessDefIntervalCall`(inDef, inIntervalSecFloat) - - | Use this procedure if you need to run periodically some def. - - | -| `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`(inDef[, inAliasStr, …]) - - | 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) Deprecated. - - | -| `ProcessorAliasDefUpdate`(inDef, inAliasStr[, …]) - - | Update alias for def (can be used in ActivityItem in field Def). - - | -| `PythonStart`(inModulePathStr, inDefNameStr[, …]) - - | Import module and run def in the Orchestrator process. - - | -| `RDPSessionCMDRun`(inRDPSessionKeyStr, inCMDStr) - - | Send CMD command to the RDP session “RUN” window - - | -| `RDPSessionConnect`(inRDPSessionKeyStr[, …]) - - | Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists - - | -| `RDPSessionDisconnect`(inRDPSessionKeyStr[, …]) - - | Disconnect the RDP session and stop monitoring it. - - | -| `RDPSessionDublicatesResolve`(inGSettings) - - | DEVELOPING Search duplicates in GSettings RDPlist !def is developing! - - | -| `RDPSessionFileStoredRecieve`(…[, inGSettings]) - - | Recieve file from RDP session to the Orchestrator session using shared drive in RDP (see RDP Configuration Dict, Shared drive) - - | -| `RDPSessionFileStoredSend`(inRDPSessionKeyStr, …) - - | Send file from Orchestrator session to the RDP session using shared drive in RDP (see RDP Configuration Dict, Shared drive) - - | -| `RDPSessionLogoff`(inRDPSessionKeyStr[, …]) - - | Logoff the RDP session from the Orchestrator process (close all apps in session when logoff) - - | -| `RDPSessionMonitorStop`(inRDPSessionKeyStr[, …]) - - | Stop monitoring the RDP session by the Orchestrator process. - - | -| `RDPSessionProcessStartIfNotRunning`(…[, …]) - - | Start process in RDP if it is not running (check by the arg inProcessNameWEXEStr) - - | -| `RDPSessionProcessStop`(inRDPSessionKeyStr, …) - - | Send CMD command to the RDP session “RUN” window. - - | -| `RDPSessionReconnect`(inRDPSessionKeyStr[, …]) - - | Reconnect the RDP session - - | -| `RDPSessionResponsibilityCheck`(inRDPSessionKeyStr) - - | 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) - - | -| `SchedulerActivityTimeAddWeekly`([…]) - - | Add activity item list in scheduler. - - | -| `Start`([inDumpRestoreBool, …]) - - | Start the orchestrator threads execution - - | -| `StorageRobotExists`(inRobotNameStr) - - | Check if robot storage exists - - | -| `StorageRobotGet`(inRobotNameStr) - - | Get the robot storage by the robot name. - - | -| `UACKeyListCheck`(inRequest, inRoleKeyList) - - | Check is client is has access for the key list - - | -| `UACSuperTokenUpdate`(inSuperTokenStr[, …]) - - | Add supertoken for the all access (it is need for the robot communication without human) - - | -| `UACUpdate`(inADLoginStr[, inADStr, …]) - - | Update user access (UAC) - - | -| `UACUserDictGet`(inRequest) - - | Return user UAC hierarchy dict of the inRequest object. - - | -| `WebAuditMessageCreate`([inRequest, …]) - - | Create message string with request user details (IP, Login etc…). - - | -| `WebCPUpdate`(inCPKeyStr[, inHTMLRenderDef, …]) - - | Add control panel HTML, JSON generator or JS when page init - - | -| `WebListenCreate`([inServerKeyStr, …]) - - | Create listen interface for the web server - - | -| `WebRequestGet`() - - | Return the web request instance if current thread was created by web request from client. - - | -| `WebRequestParseBodyBytes`([inRequest]) - - | Extract the body in bytes from the request - - | -| `WebRequestParseBodyJSON`([inRequest]) - - | Extract the body in dict/list from the request - - | -| `WebRequestParseBodyStr`([inRequest]) - - | Extract the body in str from the request - - | -| `WebRequestParseFile`([inRequest]) - - | Parse the request - extract the file (name, body in bytes) - - | -| `WebRequestParsePath`([inRequest]) - - | Parse the request - extract the url. - - | -| `WebRequestResponseSend`(inResponeStr[, inRequest]) - - | Send response for the request - - | -| `WebURLConnectDef`(inMethodStr, inURLStr, …) - - | Connect URL to DEF - - | -| `WebURLConnectFile`(inMethodStr, inURLStr, …) - - | Connect URL to File - - | -| `WebURLConnectFolder`(inMethodStr, inURLStr, …) - - | Connect URL to Folder - - | -| `WebUserInfoGet`([inRequest]) - - | Return User info about request - - | -| `WebUserIsSuperToken`([inRequest, inGSettings]) - - | Return bool if request is authentificated with supetoken (token which is never expires) - - | -| `WebUserUACHierarchyGet`([inRequest]) - - | Return User UAC Hierarchy DICT Return {…} - - | - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr=None, inThreadBool=False) -Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -# EXAMPLE 1 -def TestDef(inArg1Str, inGSettings, inLogger): - pass -lActivityItem = Orchestrator.ActivityItemCreate( - inDef = TestDef, - inArgList=[], - inArgDict={"inArg1Str": "ArgValueStr"}, - inArgGSettingsStr = "inGSettings", - inArgLoggerStr = "inLogger") -# lActivityItem: -# { -# "Def":TestDef, -# "ArgList":inArgList, -# "ArgDict":inArgDict, -# "ArgGSettings": "inArgGSettings", -# "ArgLogger": "inLogger" -# } - -# EXAMPLE 2 -def TestDef(inArg1Str): - pass -Orchestrator.ActivityItemDefAliasUpdate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -lActivityItem = Orchestrator.ActivityItemCreate( - inDef = "TestDefAlias", - inArgList=[], - inArgDict={"inArg1Str": "ArgValueStr"}, - inArgGSettingsStr = None, - inArgLoggerStr = None) -# lActivityItem: -# { -# "Def":"TestDefAlias", -# "ArgList":inArgList, -# "ArgDict":inArgDict, -# "ArgGSettings": None, -# "ArgLogger": None -# } -``` - - -* **Parameters** - - - * **inDef** – def link or def alias (look gSettings[“Processor”][“AliasDefDict”]) - - - * **inArgList** – Args list for the Def - - - * **inArgDict** – Args dict for the def - - - * **inArgGSettingsStr** – Name of def argument of the GSettings dict - - - * **inArgLoggerStr** – Name of def argument of the logging object - - - * **inGUIDStr** – GUID which you can specify. If None the GUID will be generated - - - * **inThreadBool** – True - execute ActivityItem in new thread; False - in processor thread - - - -* **Returns** - - {} - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasCreate(inDef, inAliasStr=None, inGSettings=None) -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) - -``` -# USAGE -from pyOpenRPA import Orchestrator - -def TestDef(): - pass -lAliasStr = Orchestrator.ActivityItemDefAliasCreate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -# Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr) -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inDef** – Def - - - * **inAliasStr** – String alias for associated def - - - -* **Returns** - - str Alias string (Alias can be regenerated if previous alias was occupied) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasModulesLoad() -Load all def from sys.modules… in ActivityItem def alias dict - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemDefAliasUpdate(inDef, inAliasStr, inGSettings=None) -Update 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) - -``` -# USAGE -from pyOpenRPA import Orchestrator - -def TestDef(): - pass -Orchestrator.ActivityItemDefAliasUpdate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -# Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias") -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inDef** – Def - - - * **inAliasStr** – String alias for associated def - - - -* **Returns** - - str Alias string - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemHelperDefAutofill(inDef) -Detect def by the name and prepare the activity item dict with values. - - -* **Parameters** - - **inDef** – - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ActivityItemHelperDefList(inDefQueryStr=None) -> Create list of the available Def names in activity item. You can use query def filter via arg inDefQueryStr - - -* **Parameters** - - **inDefStr** – - - - -* **Returns** - - [“ActivityItemDefAliasUpdate”, “ActivityItemDefAliasCreate”, etc…] - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemAdd(inHostNameStr, inUserStr, inActivityItemDict, inGSettings=None) -Add activity in AgentDict. Check if item is created - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – Agent host name - - - * **inUserStr** – User login, where agent is based - - - * **inActivityItemDict** – ActivityItem - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemExists(inHostNameStr, inUserStr, inGUIDStr, inGSettings=None) -Check by GUID if ActivityItem has exists in request list. If exist - the result response has not been recieved from the agent - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inGUIDStr** – GUID String of the ActivityItem - - - -* **Returns** - - True - ActivityItem is exist in AgentDict ; False - else case - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemReturnExists(inGUIDStr, inGSettings=None) -Check by GUID if ActivityItem has been executed and result has come to the Orchestrator - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inGUIDStr** – GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -* **Returns** - - True - result has been received from the Agent to orc; False - else case - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemReturnGet(inGUIDStr, inCheckIntervalSecFloat=0.5, inGSettings=None) -Work synchroniously! Wait while result will be recieved. Get the result of the ActivityItem execution on the Agent side. Before this please check by the def AgentActivityItemReturnExists that result has come to the Orchestrator - -!ATTENTION! Use only after Orchestrator initialization! Before orchestrator init exception will be raised. - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inGUIDStr** – GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - * **inCheckIntervalSecFloat** – Interval in sec of the check Activity Item result - - - -* **Returns** - - Result of the ActivityItem executed on the Agent side anr transmitted to the Orchestrator. IMPORTANT! ONLY JSON ENABLED Types CAN BE TRANSMITTED TO ORCHESTRATOR! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSCMD(inHostNameStr, inUserStr, inCMDStr, inRunAsyncBool=True, inSendOutputToOrchestratorLogsBool=True, inCMDEncodingStr='cp1251', inGSettings=None, inCaptureBool=True) -Send CMD to OS thought the pyOpenRPA.Agent daemon. Result return to log + Orchestrator by the A2O connection - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – Agent host name in upper case (example “RPA01”, “RPA_99” and so on). Active agent session you can see on the orchestrator dashboard as Orchestrator admin - - - * **inUserStr** – Agent user name in upper case (example “UserRPA”). Active agent session you can see on the orchestrator dashboard as Orchestrator admin - - - * **inCMDStr** – command to execute on the Agent session - - - * **inRunAsyncBool** – True - Agent processor don’t wait execution; False - Agent processor wait cmd execution - - - * **inSendOutputToOrchestratorLogsBool** – True - catch cmd execution output and send it to the Orchestrator logs; Flase - else case; Default True - - - * **inCMDEncodingStr** – Set the encoding of the DOS window on the Agent server session. Windows is beautiful :) . Default is “cp1251” early was “cp866” - need test - - - * **inCaptureBool** – !ATTENTION! If you need to start absolutely encapsulated app - set this flag as False. If you set True - the app output will come to Agent - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrAppend(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings=None) -Append binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – - - - * **inFileDataBase64Str** – - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBase64Str, inGSettings=None) -Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmission) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – - - - * **inFileDataBase64Str** – - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrReceive(inHostNameStr, inUserStr, inFilePathStr, inGSettings=None) -Read binary file and encode in base64 to transmit (safe for JSON transmition) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – File path to read - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBytesCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataBytes, inGSettings=None) -Create binary file by the base64 string by the pyOpenRPA.Agent daemon process (safe for JSON transmition) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – - - - * **inFileDataBytes** – - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataReceive(inHostNameStr, inUserStr, inFilePathStr) -Read binary file from agent (synchronious) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – File path to read - - - -* **Returns** - - file data bytes - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileSend(inHostNameStr, inUserStr, inOrchestratorFilePathStr, inAgentFilePathStr, inGSettings=None) -Send the file from the Orchestrator to Agent (synchroniously) pyOpenRPA.Agent daemon process (safe for JSON transmition). -Work safety with big files -Thread safe - you can call def even if you dont init the orchestrator - def will be executed later - -> -> * **param inGSettings** - -> Global settings dict (singleton) - - - -> * **param inHostNameStr** - - - -> * **param inUserStr** - - - -> * **param inFilePathStr** - - - -> * **param inFileDataBytes** - - - -> * **return** - -> GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrCreate(inHostNameStr, inUserStr, inFilePathStr, inFileDataStr, inEncodingStr='utf-8', inGSettings=None) -Create text file by the string by the pyOpenRPA.Agent daemon process - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – - - - * **inFileDataStr** – - - - * **inEncodingStr** – - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrReceive(inHostNameStr, inUserStr, inFilePathStr, inEncodingStr='utf-8', inGSettings=None) -Read text file in the agent GUI session - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - * **inFilePathStr** – File path to read - - - * **inEncodingStr** – Text file encoding. Default ‘utf-8’ - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSLogoff(inHostNameStr, inUserStr) -Logoff the agent user session - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.AgentProcessWOExeUpperUserListGet(inHostNameStr, inUserStr, inGSettings=None) -Return the process list only for the current user (where Agent is running) without .EXE in upper case. Can use in ActivityItem from Orchestrator to Agent - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inHostNameStr** – - - - * **inUserStr** – - - - -* **Returns** - - GUID String of the ActivityItem - you can wait (sync or async) result by this guid! - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsAutocleaner(inGSettings=None) -HIDDEN Interval gSettings auto cleaner def to clear some garbage. - - -* **Parameters** - - **inGSettings** – Global settings dict (singleton) - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsGet(inGSettings=None) -Get the GSettings from the singleton module. - - -* **Parameters** - - **inGSettings** – You can pass some GSettings to check if it equal to base gsettings. If not equal - def will merge it - - - -* **Returns** - - GSettings - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueAppend(inValue, inKeyList=None, inGSettings=None) -Append value in GSettings by the key list - -``` -# USAGE -from pyOpenRPA import Orchestrator - -Orchestrator.GSettingsKeyListValueAppend( - inGSettings = gSettings, - inValue = "NewValue", - inKeyList=["NewKeyDict","NewKeyList"]): -# result inGSettings: { -# ... another keys in gSettings ..., -# "NewKeyDict":{ -# "NewKeyList":[ -# "NewValue" -# ] -# } -#} -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inValue** – Any value to be appended in gSettings Dict by the key list - - - * **inKeyList** – List of the nested keys (see example) - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueGet(inKeyList=None, inGSettings=None) -Get the value from the GSettings by the key list - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inKeyList** – - - - -* **Returns** - - value any type - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueOperatorPlus(inValue, inKeyList=None, inGSettings=None) -Execute plus operation between 2 lists (1:inValue and 2:gSettings by the inKeyList) - -``` -# USAGE -from pyOpenRPA import Orchestrator - -Orchestrator.GSettingsKeyListValueOperatorPlus( - inGSettings = gSettings, - inValue = [1,2,3], - inKeyList=["NewKeyDict","NewKeyList"]): -# result inGSettings: { -# ... another keys in gSettings ..., -# "NewKeyDict":{ -# "NewKeyList":[ -# "NewValue", -# 1, -# 2, -# 3 -# ] -# } -#} -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inValue** – List with values to be merged with list in gSettings - - - * **inKeyList** – List of the nested keys (see example) - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueSet(inValue, inKeyList=None, inGSettings=None) -Set value in GSettings by the key list - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inValue** – - - - * **inKeyList** – - - - -* **Returns** - - bool - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OSCMD(inCMDStr, inRunAsyncBool=True, inLogger=None) -OS send command in shell locally - - -* **Parameters** - - - * **inCMDStr** – - - - * **inRunAsyncBool** – - - - * **inLogger** – - - - -* **Returns** - - CMD result string - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OSCredentialsVerify(inUserStr, inPasswordStr, inDomainStr='') -Verify user credentials in windows. Return bool - - -* **Parameters** - - - * **inUserStr** – - - - * **inPasswordStr** – - - - * **inDomainStr** – - - - -* **Returns** - - True - Credentials are actual; False - Credentials are not actual - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OSLogoff() -Logoff the current orchestrator session -:return: - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OSRemotePCRestart(inHostStr, inForceBool=True, inLogger=None) -Send signal via power shell to restart remote PC -ATTENTION: Orchestrator user need to have restart right on the Remote machine to restart PC. - - -* **Parameters** - - - * **inLogger** – logger to log powershell result in logs - - - * **inHostStr** – PC hostname which you need to restart. - - - * **inForceBool** – True - send signal to force retart PC; False - else case - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.Orchestrator(inGSettings=None, inDumpRestoreBool=True, inRunAsAdministratorBool=True) -Main def to start orchestrator - - -* **Parameters** - - - * **inGSettings** – - - - * **inDumpRestoreBool** – - - - * **inRunAsAdministratorBool** – - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorInitWait() -Wait thread while orc will process initial action. -ATTENTION: DO NOT CALL THIS DEF IN THREAD WHERE ORCHESTRATOR MUST BE INITIALIZED - INFINITE LOOP - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorIsAdmin() -Check if Orchestrator process is running as administrator - - -* **Returns** - - True - run as administrator; False - not as administrator - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorIsInited() -Check if Orchestrator initial actions were processed - - -* **Returns** - - True - orc is already inited; False - else - - - -* **Return type** - - bool - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorLoggerGet() -Get the logger from the Orchestrator - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorPySearchInit(inGlobPatternStr, inDefStr=None, inDefArgNameGSettingsStr=None, inAsyncInitBool=False) -Search the py files by the glob and do the safe init (in try except). Also add inited module in sys.modules as imported (module name = file name without extension). -You can init CP in async way! -.. code-block:: python - -> # USAGE VAR 1 (without the def auto call) -> # Autoinit control panels starts with - -> ``` -> CP_ -> ``` - - -> Orchestrator.OrchestratorPySearchInit(inGlobPatternStr=”ControlPanelCP_\*.py”) - -> # USAGE VAR 2 (with the def auto call) - for the backward compatibility CP for the Orchestrator ver. < 1.2.7 -> # Autoinit control panels starts with - -> ``` -> CP_ -> ``` - - -> Orchestrator.OrchestratorPySearchInit(inGlobPatternStr=”ControlPanelCP_\*.py”, inDefStr=”SettingsUpdate”, inDefArgNameGSettingsStr=”inGSettings”) - -> # INFO: The code above will replace the code below -> ## !!! For Relative import !!! CP Version Check -> try: - -> > sys.path.insert(0,os.path.abspath(os.path.join(r””))) -> > from ControlPanel import CP_VersionCheck -> > CP_VersionCheck.SettingsUpdate(inGSettings=gSettings) - -> except Exception as e: - -> gSettings[“Logger”].exception(f”Exception when init CP. See below.”) - - -* **Parameters** - - - * **inGlobPatternStr** – example”..\*\*\*X64\*.cmd” - - - * **inDefStr** – OPTIONAL The string name of the def. For backward compatibility if you need to auto call some def from initialized module - - - * **inDefArgNameGSettingsStr** – OPTIONAL The name of the GSettings argument in def (if exists) - - - * **inAsyncInitBool** – OPTIONAL True - init py modules in many threads - parallel execution. False (default) - sequence execution - - - -* **Returns** - - { “ModuleNameStr”:{“PyPathStr”: “”, “Module”: …}, …} - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRerunAsAdmin() -Check if not admin - then rerun orchestrator as administrator - - -* **Returns** - - True - run as administrator; False - not as administrator - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRestart(inGSettings=None) -Orchestrator restart - - -* **Parameters** - - **inGSettings** – Global settings dict (singleton) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorScheduleGet() -Get the schedule (schedule.readthedocs.io) from the Orchestrator - -Fro example you can use: - - -* **Returns** - - schedule module. Example see here [https://schedule.readthedocs.io/en/stable/examples.html](https://schedule.readthedocs.io/en/stable/examples.html) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionRestore(inGSettings=None) -Check _SessioLast… files in working directory. if exist - load into gsettings -(from version 1.2.7) - -> _SessionLast_GSettings.pickle (binary) - -(above the version 1.2.7) - - _SessionLast_RDPList.json (encoding = “utf-8”) - _SessionLast_StorageDict.pickle (binary) - - -* **Parameters** - - **inGSettings** – Global settings dict (singleton) - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionSave(inGSettings=None) -Orchestrator session save in file -(from version 1.2.7) - -> _SessionLast_GSettings.pickle (binary) - -(above the version 1.2.7) - - _SessionLast_RDPList.json (encoding = “utf-8”) - _SessionLast_StorageDict.pickle (binary) - - -* **Parameters** - - **inGSettings** – Global settings dict (singleton) - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorThreadStart(inDef, \*inArgList, \*\*inArgDict) -Execute def in new thread and pass some args with list and dict types - - -* **Parameters** - - - * **inDef** – Python Def - - - * **inArgList** – args as list - - - * **inArgDict** – args as dict - - - -* **Returns** - - threading.Thread object - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessDefIntervalCall(inDef, inIntervalSecFloat, inIntervalAsyncBool=False, inDefArgList=None, inDefArgDict=None, inDefArgGSettingsNameStr=None, inDefArgLoggerNameStr=None, inExecuteInNewThreadBool=True, inLogger=None, inGSettings=None) -Use this procedure if you need to run periodically some def. Set def, args, interval and enjoy :) - - -* **Parameters** - - - * **inGSettings** – global settings - - - * **inDef** – def link, which will be called with interval inIntervalSecFloat - - - * **inIntervalSecFloat** – Interval in seconds between call - - - * **inIntervalAsyncBool** – False - wait interval before next call after the previous iteration result; True - wait interval after previous iteration call - - - * **inDefArgList** – List of the args in def. Default None (empty list) - - - * **inDefArgDict** – Dict of the args in def. Default None (empty dict) - - - * **inDefArgGSettingsNameStr** – Name of the GSettings arg name for def (optional) - - - * **inDefArgLoggerNameStr** – Name of the Logger arg name for def (optional). If Use - please check fill of the inLogger arg. - - - * **inExecuteInNewThreadBool** – True - create new thread for the periodic execution; False - execute in current thread. Default: True - - - * **inLogger** – logging def if some case is appear - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessIsStarted(inProcessNameWOExeStr) -Check if there is any running process that contains the given name processName. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -lProcessIsStartedBool = Orchestrator.ProcessIsStarted(inProcessNameWOExeStr = "notepad") -# lProcessIsStartedBool is True - notepad.exe is running on the Orchestrator machine -``` - - -* **Parameters** - - **inProcessNameWOExeStr** – Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”) - - - -* **Returns** - - True - process is running on the orchestrator machine; False - process is not running on the orchestrator machine - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessListGet(inProcessNameWOExeList=None) -Return process list on the orchestrator machine sorted by Memory Usage. You can determine the list of the processes you are interested - def will return the list about it. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -lProcessList = Orchestrator.ProcessListGet() -# Return the list of the process on the machine. -# !ATTENTION! RUn orchestrator as administrator to get all process list on the machine. -``` - - -* **Parameters** - - **inProcessNameWOExeList** – - - - -* **Returns** - - { - - - -“ProcessWOExeList”: [“notepad”,”…”], -“ProcessWOExeUpperList”: [“NOTEPAD”,”…”], -“ProcessDetailList”: [ - -> { - -> ‘pid’: 412, -> ‘username’: “DESKTOPUSER”, -> ‘name’: ‘notepad.exe’, -> ‘vms’: 13.77767775, -> ‘NameWOExeUpperStr’: ‘NOTEPAD’, -> ‘NameWOExeStr’: “‘notepad’”}, - -> {…}] - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStart(inPathStr, inArgList, inStopProcessNameWOExeStr=None) -Start process locally. Extra feature: Use inStopProcessNameWOExeStr to stop the execution if current process is running. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -Orchestrator.ProcessStart( - inPathStr = "notepad" - inArgList = [] - inStopProcessNameWOExeStr = "notepad") -# notepad.exe will be started if no notepad.exe is active on the machine -``` - - -* **Parameters** - - - * **inPathStr** – Command to send in CMD - - - * **inArgList** – List of the arguments for the CMD command. Example: [“test.txt”] - - - * **inStopProcessNameWOExeStr** – Trigger: stop execution if process is running. Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”) - - - -* **Returns** - - None - nothing is returned. If process will not start -exception will be raised - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStop(inProcessNameWOExeStr, inCloseForceBool, inUserNameStr='%username%') -Stop process on the orchestrator machine. You can set user session on the machine and set flag about to force close process. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -Orchestrator.ProcessStop( - inProcessNameWOExeStr = "notepad" - inCloseForceBool = True - inUserNameStr = "USER_99") -# Will close process "notepad.exe" on the user session "USER_99" (!ATTENTION! if process not exists no exceptions will be raised) -``` - - -* **Parameters** - - - * **inProcessNameWOExeStr** – Process name WithOut (WO) ‘.exe’ postfix. Example: “notepad” (not “notepad.exe”) - - - * **inCloseForceBool** – True - do force close. False - send signal to safe close (!ATTENTION! - Safe close works only in orchestrator session. Win OS doens’t allow to send safe close signal between GUI sessions) - - - * **inUserNameStr** – User name which is has current process to close. Default value is close process on the Orchestrator session - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemAppend(inGSettings=None, inDef=None, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inActivityItemDict=None) -Create and add activity item in processor queue. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -# EXAMPLE 1 -def TestDef(inArg1Str, inGSettings, inLogger): - pass -lActivityItem = Orchestrator.ProcessorActivityItemAppend( - inGSettings = gSettingsDict, - inDef = TestDef, - inArgList=[], - inArgDict={"inArg1Str": "ArgValueStr"}, - inArgGSettingsStr = "inGSettings", - inArgLoggerStr = "inLogger") -# Activity have been already append in the processor queue - -# EXAMPLE 2 -def TestDef(inArg1Str): - pass -Orchestrator.ProcessorAliasDefUpdate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -lActivityItem = Orchestrator.ProcessorActivityItemCreate( - inDef = "TestDefAlias", - inArgList=[], - inArgDict={"inArg1Str": "ArgValueStr"}, - inArgGSettingsStr = None, - inArgLoggerStr = None) -Orchestrator.ProcessorActivityItemAppend( - inGSettings = gSettingsDict, - inActivityItemDict = lActivityItem) -# Activity have been already append in the processor queue -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inDef** – def link or def alias (look gSettings[“Processor”][“AliasDefDict”]) - - - * **inArgList** – Args list for the Def - - - * **inArgDict** – Args dict for the Def - - - * **inArgGSettingsStr** – Name of def argument of the GSettings dict - - - * **inArgLoggerStr** – Name of def argument of the logging object - - - * **inActivityItemDict** – Fill if you already have ActivityItemDict (don’t fill inDef, inArgList, inArgDict, inArgGSettingsStr, inArgLoggerStr) - - -:return ActivityItem GUIDStr - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemCreate(inDef, inArgList=None, inArgDict=None, inArgGSettingsStr=None, inArgLoggerStr=None, inGUIDStr=None, inThreadBool=False) -Create activity item. Activity item can be used as list item in ProcessorActivityItemAppend or in Processor.ActivityListExecute. -Deprecated. See ActivityItemCreate -.. code-block:: python - -> # USAGE -> from pyOpenRPA import Orchestrator - -> # EXAMPLE 1 -> def TestDef(inArg1Str, inGSettings, inLogger): - -> > pass - -> lActivityItem = Orchestrator.ProcessorActivityItemCreate( - -> inDef = TestDef, -> inArgList=[], -> inArgDict={“inArg1Str”: “ArgValueStr”}, -> inArgGSettingsStr = “inGSettings”, -> inArgLoggerStr = “inLogger”) - -> # lActivityItem: -> # { -> # “Def”:TestDef, -> # “ArgList”:inArgList, -> # “ArgDict”:inArgDict, -> # “ArgGSettings”: “inArgGSettings”, -> # “ArgLogger”: “inLogger” -> # } - -> # EXAMPLE 2 -> def TestDef(inArg1Str): - -> > pass - -> Orchestrator.ProcessorAliasDefUpdate( - -> inGSettings = gSettings, -> inDef = TestDef, -> inAliasStr=”TestDefAlias”) - -> lActivityItem = Orchestrator.ProcessorActivityItemCreate( - -> inDef = “TestDefAlias”, -> inArgList=[], -> inArgDict={“inArg1Str”: “ArgValueStr”}, -> inArgGSettingsStr = None, -> inArgLoggerStr = None) - -> # lActivityItem: -> # { -> # “Def”:”TestDefAlias”, -> # “ArgList”:inArgList, -> # “ArgDict”:inArgDict, -> # “ArgGSettings”: None, -> # “ArgLogger”: None -> # } - - -* **Parameters** - - - * **inDef** – def link or def alias (look gSettings[“Processor”][“AliasDefDict”]) - - - * **inArgList** – Args list for the Def - - - * **inArgDict** – Args dict for the def - - - * **inArgGSettingsStr** – Name of def argument of the GSettings dict - - - * **inArgLoggerStr** – Name of def argument of the logging object - - - * **inGUIDStr** – GUID which you can specify. If None the GUID will be generated - - - * **inThreadBool** – True - execute ActivityItem in new thread; False - in processor thread - - - -* **Returns** - - {} - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefCreate(inDef, inAliasStr=None, inGSettings=None) -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) -Deprecated. See ActivityItemDefAliasCreate - -``` -# USAGE -from pyOpenRPA import Orchestrator - -def TestDef(): - pass -lAliasStr = Orchestrator.ProcessorAliasDefCreate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -# Now you can call TestDef by the alias from var lAliasStr with help of ActivityItem (key Def = lAliasStr) -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inDef** – Def - - - * **inAliasStr** – String alias for associated def - - - -* **Returns** - - str Alias string (Alias can be regenerated if previous alias was occupied) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefUpdate(inDef, inAliasStr, inGSettings=None) -Update 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) -Deprecated. See ActivityItemDefAliasUpdate - -``` -# USAGE -from pyOpenRPA import Orchestrator - -def TestDef(): - pass -Orchestrator.ProcessorAliasDefUpdate( - inGSettings = gSettings, - inDef = TestDef, - inAliasStr="TestDefAlias") -# Now you can call TestDef by the alias "TestDefAlias" with help of ActivityItem (key Def = "TestDefAlias") -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inDef** – Def - - - * **inAliasStr** – String alias for associated def - - - -* **Returns** - - str Alias string - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.PythonStart(inModulePathStr, inDefNameStr, inArgList=None, inArgDict=None, inLogger=None) -Import module and run def in the Orchestrator process. - -**NOTE**: Import module will be each time when PythonStart def will be called. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -Orchestrator.PythonStart( - inModulePathStr="ModuleToCall.py", # inModulePathStr: Working Directory\ModuleToCall.py - inDefNameStr="TestDef") -# Import module in Orchestrator process and call def "TestDef" from module "ModuleToCall.py" -``` - - -* **Parameters** - - - * **inModulePathStr** – Absolute or relative (working directory of the orchestrator process) path to the importing module .py - - - * **inDefNameStr** – Def name in module - - - * **inArgList** – List of the arguments for callable def - - - * **inArgDict** – Dict of the named arguments for callable def - - - * **inLogger** – Logger instance to log some information when PythonStart def is running - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionCMDRun(inRDPSessionKeyStr, inCMDStr, inModeStr='CROSSCHECK', inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inCMDStr** – Any CMD string - - - * **inModeStr** – Variants: - “LISTEN” - Get result of the cmd command in result; - “CROSSCHECK” - Check if the command was successfully sent - “RUN” - Run without crosscheck and get clipboard - - - -* **Returns** - - # OLD > True - CMD was executed successfully - - { - - “OutStr”: <> # Result string - “IsResponsibleBool”: True|False # Flag is RDP is responsible - works only when inModeStr = CROSSCHECK - - } - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionConnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inHostStr=None, inPortStr=None, inLoginStr=None, inPasswordStr=None, inGSettings=None, inRedirectClipboardBool=True) -Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if RDP key is already exists - - 2 way of the use - -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inRDPTemplateDict** – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate) - - - * **inHostStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict - - - * **inPortStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict - - - * **inLoginStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict - - - * **inPasswordStr** – Backward compatibility from Orchestrator v 1.1.20. Use inRDPTemplateDict - - - -* **Returns** - - True every time :) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDisconnect(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inBreakTriggerProcessWOExeList** – List of the processes, which will stop the execution. Example [“notepad”] - - Orchestrator look processes on the current machine - - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDublicatesResolve(inGSettings) -DEVELOPING Search duplicates in GSettings RDPlist -!def is developing! - - -* **Parameters** - - **inGSettings** – Global settings dict (singleton) - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredRecieve(inRDPSessionKeyStr, inRDPFilePathStr, inHostFilePathStr, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inRDPFilePathStr** – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py” - - - * **inHostFilePathStr** – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py” - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredSend(inRDPSessionKeyStr, inHostFilePathStr, inRDPFilePathStr, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inHostFilePathStr** – Relative or absolute path to the file location on the Orchestrator side. Example: “TESTDIRTest.py” - - - * **inRDPFilePathStr** – !Absolute! path to the destination file location on the RDP side. Example: “C:RPATESTDIRTest.py” - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionLogoff(inRDPSessionKeyStr, inBreakTriggerProcessWOExeList=None, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inBreakTriggerProcessWOExeList** – List of the processes, which will stop the execution. Example [“notepad”] - - - -* **Returns** - - True - logoff is successful - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionMonitorStop(inRDPSessionKeyStr, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - -* **Returns** - - True every time :> - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStartIfNotRunning(inRDPSessionKeyStr, inProcessNameWEXEStr, inFilePathStr, inFlagGetAbsPathBool=True, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inProcessNameWEXEStr** – Process name with extension (.exe). This arg allow to check the process is running. Example: “Notepad.exe” - - - * **inFilePathStr** – Path to run process if it is not running. - - - * **inFlagGetAbsPathBool** – True - get abs path from the relative path in inFilePathStr. False - else case - - - -* **Returns** - - True every time :) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStop(inRDPSessionKeyStr, inProcessNameWEXEStr, inFlagForceCloseBool, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inProcessNameWEXEStr** – Process name to kill. Example: ‘notepad.exe’ - - - * **inFlagForceCloseBool** – True - force close the process. False - safe close the process - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionReconnect(inRDPSessionKeyStr, inRDPTemplateDict=None, inGSettings=None) -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** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - * **inRDPTemplateDict** – RDP configuration dict with settings (see def Orchestrator.RDPTemplateCreate) - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionResponsibilityCheck(inRDPSessionKeyStr, inGSettings=None) -DEVELOPING, MAYBE NOT USEFUL Check RDP Session responsibility TODO NEED DEV + TEST - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inRDPSessionKeyStr** – RDP Session string key - need for the further identification - - - -* **Returns** - - True every time - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.RDPTemplateCreate(inLoginStr, inPasswordStr, inHostStr='127.0.0.1', inPortInt=3389, inWidthPXInt=1680, inHeightPXInt=1050, inUseBothMonitorBool=False, inDepthBitInt=32, inSharedDriveList=None, inRedirectClipboardBool=True) -Create RDP connect dict item/ Use it connect/reconnect (Orchestrator.RDPSessionConnect) - -``` -# 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) -# lRDPTemplateDict= { # Init the configuration item -# "Host": "127.0.0.1", "Port": "3389", "Login": "USER_99", "Password": "USER_PASS_HERE", -# "Screen": { "Width": 1680, "Height": 1050, "FlagUseAllMonitors": False, "DepthBit": "32" }, -# "SharedDriveList": ["c"], -# "RedirectClipboardBool": True, # True - share clipboard to RDP; False - else -# ###### Will updated in program ############ -# "SessionHex": "77777sdfsdf77777dsfdfsf77777777", # Hex is created when robot runs, example "" -# "SessionIsWindowExistBool": False, "SessionIsWindowResponsibleBool": False, "SessionIsIgnoredBool": False -# } -``` - - -* **Parameters** - - - * **inLoginStr** – User/Robot Login, example “USER_99” - - - * **inPasswordStr** – Password, example “USER_PASS_HERE” - - - * **inHostStr** – Host address, example “77.77.22.22” - - - * **inPortInt** – RDP Port, example “3389” (default) - - - * **inWidthPXInt** – Width of the remote desktop in pixels, example 1680 - - - * **inHeightPXInt** – Height of the remote desktop in pixels, example 1050 - - - * **inUseBothMonitorBool** – True - connect to the RDP with both monitors. False - else case - - - * **inDepthBitInt** – Remote desktop bitness. Available: 32 or 24 or 16 or 15, example 32 - - - * **inSharedDriveList** – Host local disc to connect to the RDP session. Example: [“c”, “d”] - - - * **inRedirectClipboardBool** – # True - share clipboard to RDP; False - else - - - -* **Returns** - - { - - “Host”: inHostStr, # Host address, example “77.77.22.22” - “Port”: str(inPortInt), # RDP Port, example “3389” - “Login”: inLoginStr, # Login, example “test” - “Password”: inPasswordStr, # Password, example “test” - “Screen”: { - - > ”Width”: inWidthPXInt, # Width of the remote desktop in pixels, example 1680 - > “Height”: inHeightPXInt, # Height of the remote desktop in pixels, example 1050 - > # “640x480” or “1680x1050” or “FullScreen”. If Resolution not exists set full screen, example - > “FlagUseAllMonitors”: inUseBothMonitorBool, # True or False, example False - > “DepthBit”: str(inDepthBitInt) # “32” or “24” or “16” or “15”, example “32” - - }, - “SharedDriveList”: inSharedDriveList, # List of the Root sesion hard drives, example [“c”] - “RedirectClipboardBool”: True, # True - share clipboard to RDP; False - else - ###### Will updated in program ############ - “SessionHex”: “77777sdfsdf77777dsfdfsf77777777”, # Hex is created when robot runs, example “” - “SessionIsWindowExistBool”: False, - # Flag if the RDP window is exist, old name “FlagSessionIsActive”. Check every n seconds , example False - “SessionIsWindowResponsibleBool”: False, - # Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too , example False - “SessionIsIgnoredBool”: False # Flag to ignore RDP window False - dont ignore, True - ignore, example False - - } - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.SchedulerActivityTimeAddWeekly(inTimeHHMMStr='23:55:', inWeekdayList=None, inActivityList=None, inGSettings=None) -Add activity item list in scheduler. You can set weekday list and set time when launch. Activity list will be executed at planned time/day. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -# EXAMPLE 1 -def TestDef(inArg1Str): - pass -lActivityItem = Orchestrator.ProcessorActivityItemCreate( - inDef = TestDef, - inArgList=[], - inArgDict={"inArg1Str": "ArgValueStr"}, - inArgGSettingsStr = None, - inArgLoggerStr = None) -Orchestrator.SchedulerActivityTimeAddWeekly( - inGSettings = gSettingsDict, - inTimeHHMMStr = "04:34", - inWeekdayList=[2,3,4], - inActivityList = [lActivityItem]) -# Activity will be executed at 04:34 Wednesday (2), thursday (3), friday (4) -``` - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inTimeHHMMStr** – Activation time from “00:00” to “23:59”. Example: “05:29” - - - * **inWeekdayList** – Week day list to initiate activity list. Use int from 0 (monday) to 6 (sunday) as list items. Example: [0,1,2,3,4]. Default value is everyday ([0,1,2,3,4,5,6]) - - - * **inActivityList** – Activity list structure - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.Start(inDumpRestoreBool=True, inRunAsAdministratorBool=True) -Start the orchestrator threads execution - - -* **Parameters** - - - * **inDumpRestoreBool** – True - restore data from the dumo - - - * **inRunAsAdministratorBool** – True - rerun as admin if not - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.StorageRobotExists(inRobotNameStr) -Check if robot storage exists - - -* **Parameters** - - **inRobotNameStr** – Robot name (case sensitive) - - - -* **Returns** - - True - robot storage exist; False - does not exist - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.StorageRobotGet(inRobotNameStr) -Get the robot storage by the robot name. If Robot storage is not exist - function will create it - - -* **Parameters** - - **inRobotNameStr** – Robot name (case sensitive) - - - -* **Returns** - - Dict - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.UACKeyListCheck(inRequest, inRoleKeyList) -Check is client is has access for the key list - - -* **Parameters** - - - * **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - * **inRoleKeyList** – - - - -* **Returns** - - bool - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.UACSuperTokenUpdate(inSuperTokenStr, inGSettings=None) -Add supertoken for the all access (it is need for the robot communication without human) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inSuperTokenStr** – - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.UACUpdate(inADLoginStr, inADStr='', inADIsDefaultBool=True, inURLList=None, inRoleHierarchyAllowedDict=None, inGSettings=None) -Update user access (UAC) - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inADLoginStr** – - - - * **inADStr** – - - - * **inADIsDefaultBool** – - - - * **inURLList** – - - - * **inRoleHierarchyAllowedDict** – - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.UACUserDictGet(inRequest) -Return user UAC hierarchy dict of the inRequest object. Empty dict - superuser access - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - user UAC hierarchy dict - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebAuditMessageCreate(inRequest=None, inOperationCodeStr='-', inMessageStr='-') -Create message string with request user details (IP, Login etc…). Very actual for IT security in big company. - -``` -# USAGE -from pyOpenRPA import Orchestrator - -lWebAuditMessageStr = Orchestrator.WebAuditMessageCreate( - inRequest = lRequest, - inOperationCodeStr = "OP_CODE_1", - inMessageStr="Success"): - -# Log the WebAudit message -lLogger.info(lWebAuditMessageStr) -``` - - -* **Parameters** - - - * **inRequest** – HTTP request handler. Optional if call def from request thread - - - * **inOperationCodeStr** – operation code in string format (actual for IT audit in control panels) - - - * **inMessageStr** – additional message after - - - -* **Returns** - - format “WebAudit :: [DOMAINUSER@101.121.123.12](mailto:DOMAINUSER@101.121.123.12) :: operation code :: message” - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebCPUpdate(inCPKeyStr, inHTMLRenderDef=None, inJSONGeneratorDef=None, inJSInitGeneratorDef=None, inGSettings=None) -Add control panel HTML, JSON generator or JS when page init - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inCPKeyStr** – - - - * **inHTMLRenderDef** – - - - * **inJSONGeneratorDef** – - - - * **inJSInitGeneratorDef** – - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebListenCreate(inServerKeyStr='Default', inAddressStr='', inPortInt=80, inCertFilePEMPathStr=None, inKeyFilePathStr=None, inGSettings=None) -Create listen interface for the web server - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inAddressStr** – IP interface to listen - - - * **inPortInt** – Port int to listen for HTTP default is 80; for HTTPS default is 443 - - - * **inCertFilePEMPathStr** – Path to .pem (base 64) certificate. Required for SSL connection. ATTENTION - do not use certificate with password - - - * **inKeyFilePathStr** – Path to the private key file - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestGet() -Return the web request instance if current thread was created by web request from client. else return None - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyBytes(inRequest=None) -Extract the body in bytes from the request - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - Bytes or None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyJSON(inRequest=None) -Extract the body in dict/list from the request - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - dict or list - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseBodyStr(inRequest=None) -Extract the body in str from the request - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - str or None - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParseFile(inRequest=None) -Parse the request - extract the file (name, body in bytes) - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - (FileNameStr, FileBodyBytes) or (None, None) - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestParsePath(inRequest=None) -Parse the request - extract the url. Example: /pyOpenRPA/Debugging/DefHelper/… - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - Str, Example: /pyOpenRPA/Debugging/DefHelper/… - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebRequestResponseSend(inResponeStr, inRequest=None) -Send response for the request - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectDef(inMethodStr, inURLStr, inMatchTypeStr, inDef, inContentTypeStr='application/octet-stream', inGSettings=None, inUACBool=None) -> Connect URL to DEF - -> “inMethodStr”:”GET|POST”, -> “inURLStr”: “/index”, #URL of the request -> “inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, -> “inContentTypeStr”: “”, #HTTP Content-type -> “inDef”: None #Function with str result - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inMethodStr** – “GET|POST”, - - - * **inURLStr** – example “/index”, #URL of the request - - - * **inMatchTypeStr** – #”BeginWith|Contains|Equal|EqualCase”, - - - * **inDef** – def arg allowed list: 2:[inRequest, inGSettings], 1: [inRequest], 0: [] - - - * **inContentTypeStr** – default: “application/octet-stream” - - - * **inUACBool** – default: None; True - check user access before do this URL item. None - get Server flag if ask user - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFile(inMethodStr, inURLStr, inMatchTypeStr, inFilePathStr, inContentTypeStr='application/octet-stream', inGSettings=None, inUACBool=None) -Connect URL to File - - “inMethodStr”:”GET|POST”, - “inURLStr”: “/index”, #URL of the request - “inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, - “inFolderPathStr”: “”, #Absolute or relative path - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inMethodStr** – - - - * **inURLStr** – - - - * **inMatchTypeStr** – - - - * **inFilePathStr** – - - - * **inContentTypeStr** – - - - * **inUACBool** – default: None; True - check user access before do this URL item. None - get Server flag if ask user - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFolder(inMethodStr, inURLStr, inMatchTypeStr, inFolderPathStr, inGSettings=None, inUACBool=None) -Connect URL to Folder - - “inMethodStr”:”GET|POST”, - “inURLStr”: “/Folder/”, #URL of the request - “inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”, - “inFolderPathStr”: “”, #Absolute or relative path - “inUACBool” - - -* **Parameters** - - - * **inGSettings** – Global settings dict (singleton) - - - * **inMethodStr** – - - - * **inURLStr** – - - - * **inMatchTypeStr** – - - - * **inFolderPathStr** – - - - * **inUACBool** – default: None; True - check user access before do this URL item. None - get Server flag if ask user - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebUserInfoGet(inRequest=None) -Return User info about request - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - {“DomainUpperStr”: “”, “UserNameUpperStr”: “”} - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebUserIsSuperToken(inRequest=None, inGSettings=None) -Return bool if request is authentificated with supetoken (token which is never expires) - - -* **Parameters** - - - * **inRequest** – inRequest from the server. Optional if call def from request thread - - - * **inGSettings** – Global settings dict (singleton) - - - -* **Returns** - - bool True - is supertoken; False - is not supertoken - - - -### pyOpenRPA.Orchestrator.__Orchestrator__.WebUserUACHierarchyGet(inRequest=None) -Return User UAC Hierarchy DICT Return {…} - - -* **Parameters** - - **inRequest** – inRequest from the server. Optional if call def from request thread - - - -* **Returns** - - UAC Dict {} - - -## pyOpenRPA.Orchestrator.Web.Basic - -**Functions:** - -| `JSActivityListExecute`(inActivityList[, …]) - - | Create JS for execute activity list/ activity permanent - - | -| `JSProcessorActivityListAdd`(inActivityList[, …]) - - | # Create JS for send activity list/ activity to the processor - - | - -### pyOpenRPA.Orchestrator.Web.Basic.JSActivityListExecute(inActivityList, inGUIDRemoveBool=True) -> Create JS for execute activity list/ activity permanent -> USAGE: Orchestrator.Web.Basic.JSActivityListExecute(inActivityList, inGUIDRemoveBool = True) - - -* **Parameters** - - - * **inActivityList** – List of the activities (See __Orchestrator__.ProcessorActivityItemCreate) - - - * **inGUIDRemoveBool** – True - remove GUID before generate JS (if GUID is not important) - - - -* **Returns** - - JavaScript string for the front end - - - -### pyOpenRPA.Orchestrator.Web.Basic.JSProcessorActivityListAdd(inActivityList, inGUIDRemoveBool=True) -> # Create JS for send activity list/ activity to the processor -> # USAGE: Orchestrator.Web.Basic.JSProcessorActivityListAdd(inActivityList) - - -* **Parameters** - - - * **inActivityList** – List of the activities (See __Orchestrator__.ProcessorActivityItemCreate) - - - * **inGUIDRemoveBool** – True - remove GUID before generate JS (if GUID is not important) - - - -* **Returns** - - JavaScript string for the front end - - -## References - -[reStructuredText](http://docutils.sourceforge.net/rst.html) diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/03_gSettingsTemplate.md b/Wiki/ENG_Guide/markdown/Orchestrator/03_gSettingsTemplate.md deleted file mode 100644 index 23b2fb59..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/03_gSettingsTemplate.md +++ /dev/null @@ -1,368 +0,0 @@ -# 3. gSettings Template - -gSettings structure - -``` -import os, logging, datetime, sys -import schedule # https://schedule.readthedocs.io/en/stable/examples.html - -# Technical def - return GSettings structure with examples -def __Create__(): - return { - "VersionStr": None, # Will be filled in orchestrator, - "Autocleaner": { - # Some gurbage is collecting in g settings. So you can configure autocleaner to periodically clear gSettings - "IntervalSecFloat": 3600.0, # Sec float to periodically clear gsettings - "AgentActivityReturnLifetimeSecFloat": 300.0 # Time in seconds to life for activity result recieved from the agent - }, - "Client": { # Settings about client web orchestrator - "Session": { - # Settings about web session. Session algorythms works only for special requests (URL in ServerSettings) - "LifetimeSecFloat": 600.0, - # Client Session lifetime in seconds. after this time server will forget about this client session - "LifetimeRequestSecFloat": 120.0, # 1 client request lifetime in server in seconds - "ControlPanelRefreshIntervalSecFloat": 2.0, # Interval to refresh control panels for session, - "TechnicalSessionGUIDCache": { # TEchnical cache. Fills when web browser is requesting - # "SessionGUIDStr":{ # Session with some GUID str. On client session guid stored in cookie "SessionGUIDStr" - # "InitDatetime": None, # Datetime when session GUID was created - # "DatasetLast": { - # "ControlPanel": { - # "Data": None, # Struct to check with new iterations. None if starts - # "ReturnBool": False # flag to return, close request and return data as json - # } - # }, - # "ClientRequestHandler": None, # Last client request handler - # "UserADStr": None, # User, who connect. None if user is not exists - # "DomainADStr": None, # Domain of the user who connect. None if user is not exists - # } - }, - }, - # # # # # # Client... # # # # # # # # - "DumpLogListRefreshIntervalSecFloat": 3.0, # Duration between updates for the Client - "DumpLogListCountInt": 100, # Set the max row for the dump - "DumpLogList": [], # Will be filled automatically - "DumpLogListHashStr": None, # Will be filled automatically - # # # # # # # # # # # # # # # # # # - }, - "ServerDict": { - "ControlPanelDict": { - # "CPKey": - }, - "AgentLimitLogSizeBytesInt": 300, # Don't show body if json body of transmition is more than - "ServerThread": None, # Server thread is there - "AgentActivityLifetimeSecFloat": 1200.0, # Time in seconds to life for activity for the agent - "AgentConnectionLifetimeSecFloat": 300.0, # Time in seconds to handle the open connection to the Agent - "AgentLoopSleepSecFloat": 2.0, # Time in seconds to sleep between loops when check to send some activity to the agent - "AgentFileChunkBytesSizeInt": 50000000, # size of the each chunk for the agent transmition - "AgentFileChunkCheckIntervalSecFloat": 0.2, # The interval for check last activity item was successfully sent - "WorkingDirectoryPathStr": None, # Will be filled automatically - "RequestTimeoutSecFloat": 300, # Time to handle request in seconds, - "ListenDict": { # Prototype - #"Default":{ - # "AddressStr":"", - # "PortInt":80, - # "CertFilePEMPathStr":None, - # "KeyFilePathStr":None, - # "ServerInstance": None - #} - }, - "AccessUsers": { # Default - all URL is blocked - "FlagCredentialsAsk": True, # Turn on Authentication - "RuleDomainUserDict": { - # ("DOMAIN", "USER"): { !!!!! only in upper case !!!! - # "MethodMatchURLBeforeList": [ - # { - # "Method":"GET|POST", - # "MatchType":"BeginWith|Contains|Equal|EqualCase", - # "URL":"", - # "FlagAccessDefRequestGlobalAuthenticate": None, #Return bool - # "FlagAccess": True - # } - # ], - # "ControlPanelKeyAllowedList":[], # If empty - all is allowed - # "RoleHierarchyAllowedDict": { - # "Orchestrator":{ - # "Controls": { - # "RestartOrchestrator": {}, # Feature to restart orchestrator on virtual machine - # "LookMachineScreenshots": {} # Feature to look machina screenshots - # }, - # "RDPActive": { # Robot RDP active module - # "ListRead": {} # Access to read RDP session list - # } - # } - # } - # } - }, - "RuleMethodMatchURLBeforeList": [ # General MethodMatchURL list (no domain/user) - # { - # "Method":"GET|POST", - # "MatchType":"BeginWith|Contains|Equal|EqualCase", - # "URL":"", - # "FlagAccessDefRequestGlobalAuthenticate": None, #Return bool - # "FlagAccess": True - # } - ], - "AuthTokensDict": { - # "":{"User":"", "Domain":"", "TokenDatetime":, "FlagDoNotExpire":True} - } - }, - "URLList": [ # List of available URLs with the orchestrator server - # { - # "Method":"GET|POST", - # "URL": "/index", #URL of the request - # "MatchType": "", #"BeginWith|Contains|Equal|EqualCase", - # "ResponseFilePath": "", #Absolute or relative path - # "ResponseFolderPath": "", #Absolute or relative path - # "ResponseContentType": "", #HTTP Content-type - # "ResponseDefRequestGlobal": None ,#Function with str result - # "UACBool": True # True - check user access before do this URL item. None - get Server flag if ask user - # } - #{ - # "Method": "GET", - # "URL": "/test/", # URL of the request - # "MatchType": "BeginWith", # "BeginWith|Contains|Equal|EqualCase", - # # "ResponseFilePath": "", #Absolute or relative path - # "ResponseFolderPath": "C:\Abs\Archive\scopeSrcUL\OpenRPA\Orchestrator\Settings", - # # Absolute or relative path - # # "ResponseContentType": "", #HTTP Content-type - # # "ResponseDefRequestGlobal": None #Function with str result - # # "UACBool": True # True - check user access before do this URL item - #} - ], - - }, - "OrchestratorStart": { - "DefSettingsUpdatePathList": [], - # List of the .py files which should be loaded before init the algorythms - "ActivityList": [] - }, - "SchedulerDict": { - "Schedule": schedule, # https://schedule.readthedocs.io/en/stable/examples.html - "CheckIntervalSecFloat": 5.0, # Check interval in seconds - "ActivityTimeList": [ - # { - # "TimeHH:MMStr": "22:23", # Time [HH:MM] to trigger activity - # "WeekdayList": [0, 1, 2, 3, 4, 5, 6], #List of the weekday index when activity is applicable, Default [0,1,2,3,4,5,6] - # "ActivityList": [ - # # { - # # "Def":"DefAliasTest", # def link or def alias (look gSettings["Processor"]["AliasDefDict"]) - # # "ArgList":[1,2,3], # Args list - # # "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary - # # "ArgGSettings": # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - # # "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - # # "GUIDStr": ..., # GUID of the activity - # # }, - # ], - # "GUID": None # Will be filled in Orchestrator automatically - is needed for detect activity completion - # }, - ], - }, - "ManagersProcessDict":{}, # The key of the Process is (mAgentHostNameStr.upper(), mAgentUserNameStr.upper(), mProcessNameWOExeStr.upper()) - "ManagersGitDict":{}, # The key of the Git instance is (mAgentHostNameStr.upper(), mAgentUserNameStr.upper(), mAbsPathUpperStr.upper()) - "ProcessorDict": { # Has been changed. New general processor (one threaded) v.1.2.0 - "ActivityList": [ # List of the activities - # { - # "Def":"DefAliasTest", # def link or def alias (look gSettings["Processor"]["AliasDefDict"]) - # "ArgList":[1,2,3], # Args list - # "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary - # "ArgGSettings": # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - # "ArgLogger": None # Name of GSettings attribute: str (ArgDict) or index (for ArgList) - # "GUIDStr": ..., # GUID of the activity - # }, - ], - "ActivityItemNowDict": None, # Activity Item which is executing now - "AliasDefDict": {}, # Storage for def with Str alias. To use it see pyOpenRPA.Orchestrator.ControlPanel - "CheckIntervalSecFloat": 1.0, # Interval for check gSettings in ProcessorDict > ActivityList - "ExecuteBool": True, # Flag to execute thread processor - "ThreadIdInt": None, # Technical field - will be setup when processor init - "WarningExecutionMoreThanSecFloat": 60.0 # Push warning if execution more than n seconds - }, - # # # # # # # # # # # # # # - "RobotRDPActive": { - "RecoveryDict": { - "CatchPeriodSecFloat": 1200, # Catch last 10 minutes - "TriggerCountInt": 10, # Activate trigger if for the period orch will catch the reconnect RDP n times - "DoDict": { - "OSRemotePCRestart": True # Do powershell remote restart - }, - "__StatisticsDict__": { - # RDPSessionKeyStr : [time.time(), time.time()], - } - }, - "RDPList": { - # "RDPSessionKey":{ - # "Host": "77.77.22.22", # Host address - # "Port": "3389", # RDP Port - # "Login": "test", # Login - # "Password": "test", # Password - # "Screen": { - # "Width": 1680, # Width of the remote desktop in pixels - # "Height": 1050, # Height of the remote desktop in pixels - # # "640x480" or "1680x1050" or "FullScreen". If Resolution not exists set full screen - # "FlagUseAllMonitors": False, # True or False - # "DepthBit": "32" # "32" or "24" or "16" or "15" - # }, - # "SharedDriveList": ["c"], # List of the Root sesion hard drives - # ###### Will updated in program ############ - # "SessionHex": "", # Hex is created when robot runs - # "SessionIsWindowExistBool": False, # Flag if the RDP window is exist, old name "FlagSessionIsActive". Check every n seconds - # "SessionIsWindowResponsibleBool": False, # Flag if RDP window is responsible (recieve commands). Check every nn seconds. If window is Responsible - window is Exist too - # "SessionIsIgnoredBool": False # Flag to ignore RDP window False - dont ignore, True - ignore - # } - }, - "ResponsibilityCheckIntervalSec": None, - # Seconds interval when Robot check the RDP responsibility. if None - dont check - "FullScreenRDPSessionKeyStr": None, - # RDPSessionKeyStr of the current session which is full screened, None is no session in fullscreen - "ActivityList": [ - # Technical Activity list for RobotRDPActive thread - equal to Main activity list, apply only RDP activity - # { - # "DefNameStr":"test", # Function name in RobotRDPActive.Processor - # "ArgList":[1,2,3], # Args list - # "ArgDict":{"ttt":1,"222":2,"dsd":3} # Args dictionary - # }, - # { - # "DefNameStr": "RDPSessionConnect", # Function name in RobotRDPActive.Processor - # "ArgList": [], # Args list - # "ArgDict": {"inRDPSessionKeyStr": "TestRDP", "inHostStr": "77.44.33.22", "inPortStr": "3389", - # "inLoginStr": "login", "inPasswordStr": "pass"} # Args dictionary - # }, - # { - # "DefNameStr": "RDPSessionDisconnect", # Disconnect the RDP session without logoff. Function name in RobotRDPActive.Processor - # "ArgList": [], # Args list - # "ArgDict": {"inRDPSessionKeyStr": "TestRDP"} - # }, - # { - # "DefNameStr": "RDPSessionReconnect", # Disconnect the RDP session without logoff. Function name in RobotRDPActive.Processor - # "ArgList": [], # Args list - # "ArgDict": {"inRDPSessionKeyStr": "TestRDP"} - # } - ] - }, - # # # # # # # # # # # # # # - "FileManager": { - "FileURLFilePathDict_help": "https://localhost:8081/filemanager/. All FileURL s must be set in lowercase", - "FileURLFilePathDict": { - #"r01/report.xlsx": "C:\\RPA\\R01_IntegrationOrderOut\\Data\\Reestr_otgruzok.xlsx" - } - }, - "Logger": logging.getLogger("Orchestrator"), - "StorageDict": { - "Robot_R01_help": "Robot data storage in orchestrator env", - "Robot_R01": {}, - "R01_OrchestratorToRobot": {"Test2": "Test2"} - }, - "AgentDict": { # Will be filled when program runs - #("HostNameUpperStr", "UserUpperStr"): { "IsListenBool": True, "QueueList": [] } - }, - "AgentActivityReturnDict": { # Will be filled when programs run - fill result of the Activity execution on the agent - # Key - Activity Item GUID str, Value {"Return": ..., "ReturnedByDatetime": datetime.datetime} - # If key exists - def has been completed - } - # "HiddenIsOrchestratorInitialized" - will be inited when orchestrator will be initialized - } - -# Create full configuration for -def __AgentDictItemCreate__(): - return {"IsListenBool":False, "ConnectionCountInt":0, "ConnectionFirstQueueItemCountInt":0, "ActivityList":[]} - -# Create full configuration for AgentActivityReturnDict -def __AgentActivityReturnDictItemCreate__(inReturn): - return {"Return": inReturn, "ReturnedByDatetime": datetime.datetime.now()} - -# Create full configuration for -def __UACClientAdminCreate__(): - lResultDict = { - "pyOpenRPADict":{ - "CPKeyDict":{ # Empty dict - all access - # "CPKeyStr"{ - # } - }, - "RDPKeyDict":{ # Empty dict - all access - #"RDPKeyStr"{ - # "FullscreenBool": True, - # "IgnoreBool":True, - # "ReconnectBool": True - # "NothingBool": True # USe option if you dont want to give some access to the RDP controls - # } - }, - "AgentKeyDict": { # Empty dict - all access - # "AgentKeyStr"{ - # } - }, - "AdminDict":{ # Empty dict - all access - "LogViewerBool":True, # Show log viewer on the web page - "CMDInputBool":True, # Execute CMD on the server side and result to the logs - "ScreenshotViewerBool":True, # Show button to look screenshots - "RestartOrchestratorBool": True, # Restart orchestrator activity - "RestartOrchestratorGITPullBool": True, # Turn off (RDP remember) orc + git pull + Turn on (rdp remember) - "RestartPCBool": True, # Send CMD to restart pc - "NothingBool":True, # USe option if you dont want to give some access to the RDP controls - "Debugging":True # Debugging tool - }, - "ActivityDict": { # Empty dict - all access - "ActivityListExecuteBool": True, # Execute activity at the current thread - "ActivityListAppendProcessorQueueBool": True # Append activity to the processor queue - } - } - - } - return lResultDict - - -# Init the log dump to WEB -# import pdb; pdb.set_trace() -############################################ -def LoggerDumpLogHandlerAdd(inLogger, inGSettingsClientDict): - lL = inLogger - if len(lL.handlers) == 0: - mRobotLoggerFormatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s') - else: - mRobotLoggerFormatter = lL.handlers[0].formatter - mHandlerDumpLogList = LoggerHandlerDumpLogList.LoggerHandlerDumpLogList(inDict=inGSettingsClientDict, - inKeyStr="DumpLogList", inHashKeyStr="DumpLogListHashStr", inRowCountInt=inGSettingsClientDict[ - "DumpLogListCountInt"]) - mHandlerDumpLogList.setFormatter(mRobotLoggerFormatter) - lL.addHandler(mHandlerDumpLogList) - -# inModeStr: -# "BASIC" - create standart configuration -from pyOpenRPA.Orchestrator.Utils import LoggerHandlerDumpLogList -def Create(inModeStr="BASIC", inLoggerLevel = None): - if inModeStr=="BASIC": - lResult = __Create__() # Create settings - # Создать файл логирования - # add filemode="w" to overwrite - if not os.path.exists("Reports"): - os.makedirs("Reports") - ########################## - # Подготовка логгера Robot - ######################### - if inLoggerLevel is None: inLoggerLevel=logging.INFO - lL = lResult["Logger"] - if len(lL.handlers) == 0: - lL.setLevel(logging.INFO) - # create the logging file handler - mRobotLoggerFH = logging.FileHandler( - "Reports\\" + datetime.datetime.now().strftime("%Y_%m_%d") + ".log") - mRobotLoggerFormatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s') - mRobotLoggerFH.setFormatter(mRobotLoggerFormatter) - # add handler to logger object - lL.addHandler(mRobotLoggerFH) - ####################Add console output - handler = logging.StreamHandler(sys.stdout) - handler.setFormatter(mRobotLoggerFormatter) - lL.addHandler(handler) - ############################################ - LoggerDumpLogHandlerAdd(inLogger=lL, inGSettingsClientDict=lResult["Client"]) - #mHandlerDumpLogList = LoggerHandlerDumpLogList.LoggerHandlerDumpLogList(inDict=lResult["Client"], - # inKeyStr="DumpLogList", - # inHashKeyStr="DumpLogListHashStr", - # inRowCountInt=lResult["Client"][ - # "DumpLogListCountInt"]) - #mHandlerDumpLogList.setFormatter(mRobotLoggerFormatter) - #mRobotLogger.addHandler(mHandlerDumpLogList) - else: - if lL: lL.warning("Pay attention! Your code has been call SettingsTemplate.Create - since pyOpenRPA v1.2.7 GSettings is creating automatically") - return lResult # return the result dict -``` diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToUse.md b/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToUse.md deleted file mode 100644 index 88d35dc4..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/04_HowToUse.md +++ /dev/null @@ -1,54 +0,0 @@ -# 4. How to use - -You need to run orchestrator process? - -``` -if __name__ == "__main__": # New init way - allow run as module -m PyOpenRPA.Orchestrator - from pyOpenRPA import Orchestrator # Import orchestrator main - gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration - no more config is available from the box - you can create own - # Call the orchestrator main def - Orchestrator.Orchestrator(inGSettings=gSettings) -``` - -If you need more configurations - so you can see here: - -``` -import psutil, datetime, logging, os, sys - - -# Config settings -lPyOpenRPASourceFolderPathStr = r"..\Sources" # Path for test pyOpenRPA package - -# Operations -if lPyOpenRPASourceFolderPathStr != "": sys.path.insert(0,os.path.abspath(os.path.join(lPyOpenRPASourceFolderPathStr))) # Path for test pyOpenRPA package -# Start import after config the pyOpenRPA folder -from pyOpenRPA.Orchestrator import SettingsTemplate # Import functionallity - -from pyOpenRPA import Orchestrator # Import orchestrator main -#Run as administrator -if not Orchestrator.OrchestratorIsAdmin(): - Orchestrator.OrchestratorRerunAsAdmin() - print(f"Orchestrator will be run as administrator!") -else: - gSettings = Orchestrator.GSettingsGet() - #gSettings = SettingsTemplate.Create(inModeStr="BASIC") # Create GSettings with basic configuration - no more config is available from the box - you can create own - Orchestrator.OrchestratorLoggerGet().setLevel(logging.INFO) - # TEST Add User ND - Add Login ND to superuser of the Orchestrator - lUACClientDict = SettingsTemplate.__UACClientAdminCreate__() - Orchestrator.UACUpdate(inGSettings=gSettings, inADLoginStr="ND", inADStr="", inADIsDefaultBool=True, inURLList=[], inRoleHierarchyAllowedDict=lUACClientDict) - # TEST Add User IMaslov - Add Login IMaslov to superuser of the Orchestrator - Orchestrator.UACUpdate(inGSettings=gSettings, inADLoginStr="IMaslov", inADStr="", inADIsDefaultBool=True, inURLList=[]) - # TEST Add Supertoken for the all access between robots - Orchestrator.UACSuperTokenUpdate(inGSettings=gSettings, inSuperTokenStr="1992-04-03-0643-ru-b4ff-openrpa52zzz") - # Add first interface! - Orchestrator.WebListenCreate(inGSettings=gSettings) - # Restore DUMP - Orchestrator.OrchestratorSessionRestore(inGSettings=gSettings) - # Autoinit control panels starts with CP_ - lPyModules = Orchestrator.OrchestratorPySearchInit(inGlobPatternStr="ControlPanel\\CP_*.py", inDefStr="SettingsUpdate", inDefArgNameGSettingsStr="inGSettings", inAsyncInitBool=True) - # Call the orchestrator def - Orchestrator.Orchestrator(inGSettings=gSettings, inDumpRestoreBool=False) - - - -``` diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/05_UAC.md b/Wiki/ENG_Guide/markdown/Orchestrator/05_UAC.md deleted file mode 100644 index d4f98eea..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/05_UAC.md +++ /dev/null @@ -1,53 +0,0 @@ -# 5. UAC - User Access Control - -## About - -Orchestrator has mega feature - user access control (UAC). This feature allow you to manipulate access of the web UI for the all users! - -If you need to give admin rights - you don’t customize UAC dict. - -If you need to give some little rights for user only for one robot in orchestrator web panel - you can set the following properties in UAC dict. - -To work with UAC you can use defs `Orchestrator.UAC` group. - -!!!ATTENTION!!! - -Need practice example to work with UAC! - too hard to understand - -## UAC Dict for Orchestrator WEB UI rights - -UAC Dict for pyOpenRPA Orchestrator WEB UI rights. - -``` -"pyOpenRPADict":{ - "CPKeyDict":{ # Empty dict - all access - # "CPKeyStr"{ - # } - }, - "RDPKeyDict":{ # Empty dict - all access - #"RDPKeyStr"{ - # "FullscreenBool": True, - # "IgnoreBool":True, - # "ReconnectBool": True - # "NothingBool": True # USe option if you dont want to give some access to the RDP controls - # } - }, - "AgentKeyDict": { # Empty dict - all access - # "AgentKeyStr"{ - # } - }, - "AdminDict":{ # Empty dict - all access - "LogViewerBool":True, # Show log viewer on the web page - "CMDInputBool":True, # Execute CMD on the server side and result to the logs - "ScreenshotViewerBool":True, # Show button to look screenshots - "RestartOrchestratorBool": True, # Restart orchestrator activity - "RestartOrchestratorGITPullBool": True, # Turn off (RDP remember) orc + git pull + Turn on (rdp remember) - "RestartPCBool": True, # Send CMD to restart pc - "NothingBool":True # USe option if you dont want to give some access to the RDP controls - }, - "ActivityDict": { # Empty dict - all access - "ActivityListExecuteBool": True, # Execute activity at the current thread - "ActivityListAppendProcessorQueueBool": True # Append activity to the processor queue - } -} -``` diff --git a/Wiki/ENG_Guide/markdown/Orchestrator/06_Defs Managers.md b/Wiki/ENG_Guide/markdown/Orchestrator/06_Defs Managers.md deleted file mode 100644 index 382a0d8f..00000000 --- a/Wiki/ENG_Guide/markdown/Orchestrator/06_Defs Managers.md +++ /dev/null @@ -1,2283 +0,0 @@ -# 6. Defs Managers - -## Process (General) - -``` -# EXAMPLE -from pyOpenRPA.Orchestrator import Orchestrator -lProcess = Orchestrator.Managers.Process(inAgentHostNameStr="PC-DESKTOP",inAgentUserNameStr="ND", inProcessNameWOExeStr="notepad",inStartCMDStr="notepad") -``` - -**Classes:** - -| `Process`(inAgentHostNameStr, …[, …]) - - | Manager process, which is need to be started / stopped / restarted - - | -**Functions:** - -| `ProcessExists`(inAgentHostNameStr, …) - - | Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) - - | -| `ProcessGet`(inAgentHostNameStr, …) - - | Return the process instance by the inProcessNameWOExeStr - - | -| `ProcessInitSafe`(inAgentHostNameStr, …[, …]) - - | Exception safe function. - - | -| `ProcessManual2Auto`(inAgentHostNameStr, …) - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ProcessManualStopListClear`(…) - - | Clear the last start tries list. - - | -| `ProcessManualStopTriggerSet`(…) - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ProcessScheduleStatusCheckEverySeconds`(…) - - | Run status check every interval in second you specify. - - | -| `ProcessStart`(inAgentHostNameStr, …[, …]) - - | Manual/Auto start. - - | -| `ProcessStatusCheck`(inAgentHostNameStr, …) - - | Check if process is alive. - - | -| `ProcessStatusRestore`(inAgentHostNameStr, …) - - | Execute the StatusCheck, after that restore status to the saved state (see StatusSave). - - | -| `ProcessStatusSave`(inAgentHostNameStr, …) - - | Save current status of the process. - - | -| `ProcessStatusStrGet`(inAgentHostNameStr, …) - - | Get the status of the Process instance. - - | -| `ProcessStopForce`(inAgentHostNameStr, …[, …]) - - | Manual/Auto stop force. - - | -| `ProcessStopSafe`(inAgentHostNameStr, …[, …]) - - | Manual/Auto stop safe. - - | - -### class pyOpenRPA.Orchestrator.Managers.Process.Process(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300, inStartArgDict=None, inStatusCheckIntervalSecFloat=30) -Manager process, which is need to be started / stopped / restarted - -With Process instance you can automate your process activity. Use schedule package to set interval when process should be active and when not. - -All defs in class are pickle safe! After orchestrator restart (if not the force stop of the orchestrator process) your instance with properties will be restored. But it not coverage the scheduler which is in __Orchestrator__ . -After orc restart you need to reinit all schedule rules: Orchestrator.OrchestratorScheduleGet - -Process instance has the following statuses: - - - * 0_STOPPED - - - * 1_STOPPED_MANUAL - - - * 2_STOP_SAFE - - - * 3_STOP_SAFE_MANUAL - - - * 4_STARTED - - - * 5_STARTED_MANUAL - -How to use StopSafe on the robot side - -**Methods:** - -| `KeyTurpleGet`() - - | Get the key turple of the current process - - | -| `Manual2Auto`() - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ManualStopListClear`() - - | Clear the last start tries list. - - | -| `ManualStopTriggerNewStart`() - - | Log new start event. - - | -| `ManualStopTriggerSet`(inMSTdTSecFloat, inMSTdNInt) - - | Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period - - | -| `MuteWait`() - - | Internal def. - - | -| `RestartForce`([inIsManualBool]) - - | Manual/Auto restart force. - - | -| `RestartSafe`([inIsManualBool]) - - | Manual/Auto restart safe. - - | -| `Start`([inIsManualBool, inStartArgDict]) - - | Manual/Auto start. - - | -| `StartCheck`() - - | Start program if auto stopped (0_STOPPED). - - | -| `StatusChangeLog`() - - | Lof information about status change - - | -| `StatusCheck`() - - | Check if process is alive. - - | -| `StatusCheckIntervalRestore`() - - | Call from orchestrator when init - - | -| `StatusCheckStart`() - - | Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED” - - | -| `StatusCheckStopForce`() - - | Check process status and auto stop force it if self.mStatusStr is 4_STARTED - - | -| `StatusCheckStopSafe`() - - | Check process status and auto stop safe it if self.mStatusStr is 4_STARTED - - | -| `StatusRestore`() - - | Execute the StatusCheck, after that restore status to the saved state (see StatusSave). - - | -| `StatusSave`() - - | Save current status of the process. - - | -| `StopForce`([inIsManualBool, inMuteIgnoreBool]) - - | Manual/Auto stop force. - - | -| `StopForceCheck`() - - | Stop force program if auto started (4_STARTED). - - | -| `StopSafe`([inIsManualBool, …]) - - | Manual/Auto stop safe. - - | -| `StopSafeCheck`([inStopSafeTimeoutSecFloat]) - - | Stop safe program if auto started (4_STARTED). - - | - -#### KeyTurpleGet() -Get the key turple of the current process - - -#### Manual2Auto() -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### ManualStopListClear() -Clear the last start tries list. - - -* **Returns** - - None - - - -#### ManualStopTriggerNewStart() -Log new start event. Check if it is applicable. Change status if ManualStop trigger criteria is applied - - -* **Returns** - - # 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### ManualStopTriggerSet(inMSTdTSecFloat: float, inMSTdNInt: int) -Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period - - -* **Parameters** - - - * **inMSTdTSecFloat** – Time perios in seconds - - - * **inMSTdNInt** – Counts of the start tries - - - -* **Returns** - - None - - - -#### MuteWait() -Internal def. Wait when class is apply to send new activities to the agent - - -* **Returns** - - - - -#### RestartForce(inIsManualBool=True) -Manual/Auto restart force. Force restart dont wait process termination - it just terminate process now ant then start it. -Manual restart will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### RestartSafe(inIsManualBool=True) -Manual/Auto restart safe. Restart safe is the operation which send signal to process to terminate own work (send term signal to process). Then it run process. Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### Start(inIsManualBool=True, inStartArgDict=None) -Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto. -Will not start if STOP SAFE is now and don’t start auto is stopped manual now - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StartCheck() -Start program if auto stopped (0_STOPPED). - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusChangeLog() -Lof information about status change - - -* **Returns** - - - - -#### StatusCheck() -Check if process is alive. The def will save the manual flag is exists. Don’t wait mute but set mute if it is not set. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckIntervalRestore() -Call from orchestrator when init - - -#### StatusCheckStart() -Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckStopForce() -Check process status and auto stop force it if self.mStatusStr is 4_STARTED - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckStopSafe() -Check process status and auto stop safe it if self.mStatusStr is 4_STARTED - - -* **Returns** - - - - -#### StatusRestore() -Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusSave() -Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopForce(inIsManualBool=True, inMuteIgnoreBool=False) -Manual/Auto stop force. Force stop don’t wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopForceCheck() -Stop force program if auto started (4_STARTED). - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopSafe(inIsManualBool=True, inStopSafeTimeoutSecFloat=None) -Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - * **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopSafeCheck(inStopSafeTimeoutSecFloat=None) -Stop safe program if auto started (4_STARTED). - - -* **Parameters** - - **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessExists(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - True - process exists in gsettings; False - else - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Return the process instance by the inProcessNameWOExeStr - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process instance (if exists) Else None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessInitSafe(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300) -Exception safe function. Check if process instance is not exists in GSettings (it can be after restart because Orchestrator restore objects from dump of the previous Orchestrator session) -Return existing instance (if exists) or create new instance and return it. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inStartPathStr** – Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute - - - * **inStartCMDStr** – CMD script to start program (if no start file is exists) - - - * **inStopSafeTimeoutSecFloat** – Time to wait for stop safe. After that do the stop force (if process is not stopped) - - - -* **Returns** - - Process instance - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManual2Auto(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopListClear(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Clear the last start tries list. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopTriggerSet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inMSTdTSecFloat: float, inMSTdNInt: int) -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inMSTdTSecFloat** – Time periods in seconds - - - * **inMSTdNInt** – Counts of the start tries - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessScheduleStatusCheckEverySeconds(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIntervalSecondsInt: int = 120) -Run status check every interval in second you specify. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIntervalSecondsInt** – Interval in seconds. Default is 120 - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStart(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusCheck(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Check if process is alive. The def will save the manual flag is exists. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusRestore(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusSave(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusStrGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Get the status of the Process instance. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStopForce(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -Manual/Auto stop force. Force stop dont wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStopSafe(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True, inStopSafeTimeoutSecFloat=None) -Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - * **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - -## Process (Details) - -**Classes:** - -| `Process`(inAgentHostNameStr, …[, …]) - - | Manager process, which is need to be started / stopped / restarted - - | -**Functions:** - -| `ProcessExists`(inAgentHostNameStr, …) - - | Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) - - | -| `ProcessGet`(inAgentHostNameStr, …) - - | Return the process instance by the inProcessNameWOExeStr - - | -| `ProcessInitSafe`(inAgentHostNameStr, …[, …]) - - | Exception safe function. - - | -| `ProcessManual2Auto`(inAgentHostNameStr, …) - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ProcessManualStopListClear`(…) - - | Clear the last start tries list. - - | -| `ProcessManualStopTriggerSet`(…) - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ProcessScheduleStatusCheckEverySeconds`(…) - - | Run status check every interval in second you specify. - - | -| `ProcessStart`(inAgentHostNameStr, …[, …]) - - | Manual/Auto start. - - | -| `ProcessStatusCheck`(inAgentHostNameStr, …) - - | Check if process is alive. - - | -| `ProcessStatusRestore`(inAgentHostNameStr, …) - - | Execute the StatusCheck, after that restore status to the saved state (see StatusSave). - - | -| `ProcessStatusSave`(inAgentHostNameStr, …) - - | Save current status of the process. - - | -| `ProcessStatusStrGet`(inAgentHostNameStr, …) - - | Get the status of the Process instance. - - | -| `ProcessStopForce`(inAgentHostNameStr, …[, …]) - - | Manual/Auto stop force. - - | -| `ProcessStopSafe`(inAgentHostNameStr, …[, …]) - - | Manual/Auto stop safe. - - | - -### class pyOpenRPA.Orchestrator.Managers.Process.Process(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300, inStartArgDict=None, inStatusCheckIntervalSecFloat=30) -Manager process, which is need to be started / stopped / restarted - -With Process instance you can automate your process activity. Use schedule package to set interval when process should be active and when not. - -All defs in class are pickle safe! After orchestrator restart (if not the force stop of the orchestrator process) your instance with properties will be restored. But it not coverage the scheduler which is in __Orchestrator__ . -After orc restart you need to reinit all schedule rules: Orchestrator.OrchestratorScheduleGet - -Process instance has the following statuses: - - - * 0_STOPPED - - - * 1_STOPPED_MANUAL - - - * 2_STOP_SAFE - - - * 3_STOP_SAFE_MANUAL - - - * 4_STARTED - - - * 5_STARTED_MANUAL - -How to use StopSafe on the robot side - -**Methods:** - -| `KeyTurpleGet`() - - | Get the key turple of the current process - - | -| `Manual2Auto`() - - | Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - | -| `ManualStopListClear`() - - | Clear the last start tries list. - - | -| `ManualStopTriggerNewStart`() - - | Log new start event. - - | -| `ManualStopTriggerSet`(inMSTdTSecFloat, inMSTdNInt) - - | Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period - - | -| `MuteWait`() - - | Internal def. - - | -| `RestartForce`([inIsManualBool]) - - | Manual/Auto restart force. - - | -| `RestartSafe`([inIsManualBool]) - - | Manual/Auto restart safe. - - | -| `Start`([inIsManualBool, inStartArgDict]) - - | Manual/Auto start. - - | -| `StartCheck`() - - | Start program if auto stopped (0_STOPPED). - - | -| `StatusChangeLog`() - - | Lof information about status change - - | -| `StatusCheck`() - - | Check if process is alive. - - | -| `StatusCheckIntervalRestore`() - - | Call from orchestrator when init - - | -| `StatusCheckStart`() - - | Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED” - - | -| `StatusCheckStopForce`() - - | Check process status and auto stop force it if self.mStatusStr is 4_STARTED - - | -| `StatusCheckStopSafe`() - - | Check process status and auto stop safe it if self.mStatusStr is 4_STARTED - - | -| `StatusRestore`() - - | Execute the StatusCheck, after that restore status to the saved state (see StatusSave). - - | -| `StatusSave`() - - | Save current status of the process. - - | -| `StopForce`([inIsManualBool, inMuteIgnoreBool]) - - | Manual/Auto stop force. - - | -| `StopForceCheck`() - - | Stop force program if auto started (4_STARTED). - - | -| `StopSafe`([inIsManualBool, …]) - - | Manual/Auto stop safe. - - | -| `StopSafeCheck`([inStopSafeTimeoutSecFloat]) - - | Stop safe program if auto started (4_STARTED). - - | - -#### KeyTurpleGet() -Get the key turple of the current process - - -#### Manual2Auto() -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### ManualStopListClear() -Clear the last start tries list. - - -* **Returns** - - None - - - -#### ManualStopTriggerNewStart() -Log new start event. Check if it is applicable. Change status if ManualStop trigger criteria is applied - - -* **Returns** - - # 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### ManualStopTriggerSet(inMSTdTSecFloat: float, inMSTdNInt: int) -Set ManualStopTrigger (MST) to switch to STOPPED MANUAL if specified count of start fails will be catched in specified time period - - -* **Parameters** - - - * **inMSTdTSecFloat** – Time perios in seconds - - - * **inMSTdNInt** – Counts of the start tries - - - -* **Returns** - - None - - - -#### MuteWait() -Internal def. Wait when class is apply to send new activities to the agent - - -* **Returns** - - - - -#### RestartForce(inIsManualBool=True) -Manual/Auto restart force. Force restart dont wait process termination - it just terminate process now ant then start it. -Manual restart will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### RestartSafe(inIsManualBool=True) -Manual/Auto restart safe. Restart safe is the operation which send signal to process to terminate own work (send term signal to process). Then it run process. Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### Start(inIsManualBool=True, inStartArgDict=None) -Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto. -Will not start if STOP SAFE is now and don’t start auto is stopped manual now - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StartCheck() -Start program if auto stopped (0_STOPPED). - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusChangeLog() -Lof information about status change - - -* **Returns** - - - - -#### StatusCheck() -Check if process is alive. The def will save the manual flag is exists. Don’t wait mute but set mute if it is not set. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckIntervalRestore() -Call from orchestrator when init - - -#### StatusCheckStart() -Check process status and run it if auto stopped self.mStatusStr is “0_STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckStopForce() -Check process status and auto stop force it if self.mStatusStr is 4_STARTED - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusCheckStopSafe() -Check process status and auto stop safe it if self.mStatusStr is 4_STARTED - - -* **Returns** - - - - -#### StatusRestore() -Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StatusSave() -Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopForce(inIsManualBool=True, inMuteIgnoreBool=False) -Manual/Auto stop force. Force stop don’t wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopForceCheck() -Stop force program if auto started (4_STARTED). - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopSafe(inIsManualBool=True, inStopSafeTimeoutSecFloat=None) -Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - * **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -#### StopSafeCheck(inStopSafeTimeoutSecFloat=None) -Stop safe program if auto started (4_STARTED). - - -* **Parameters** - - **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessExists(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Check if the Process instance is exists in GSettings by the (inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - True - process exists in gsettings; False - else - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Return the process instance by the inProcessNameWOExeStr - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process instance (if exists) Else None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessInitSafe(inAgentHostNameStr, inAgentUserNameStr, inProcessNameWOExeStr, inStartPathStr=None, inStartCMDStr=None, inStopSafeTimeoutSecFloat=300) -Exception safe function. Check if process instance is not exists in GSettings (it can be after restart because Orchestrator restore objects from dump of the previous Orchestrator session) -Return existing instance (if exists) or create new instance and return it. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inStartPathStr** – Path to start process (.cmd/ .exe or something else). Path can be relative (from orc working directory) or absolute - - - * **inStartCMDStr** – CMD script to start program (if no start file is exists) - - - * **inStopSafeTimeoutSecFloat** – Time to wait for stop safe. After that do the stop force (if process is not stopped) - - - -* **Returns** - - Process instance - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManual2Auto(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopListClear(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Clear the last start tries list. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessManualStopTriggerSet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inMSTdTSecFloat: float, inMSTdNInt: int) -Remove Manual flag from process (if exists) - it will allow the schedule operations via def StatusCheckStart(self): def StatusCheckStorForce(self): def StatusCheckStopSafe(self): - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inMSTdTSecFloat** – Time periods in seconds - - - * **inMSTdNInt** – Counts of the start tries - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessScheduleStatusCheckEverySeconds(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIntervalSecondsInt: int = 120) -Run status check every interval in second you specify. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIntervalSecondsInt** – Interval in seconds. Default is 120 - - - -* **Returns** - - None - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStart(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -Manual/Auto start. Manual start will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusCheck(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Check if process is alive. The def will save the manual flag is exists. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusRestore(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Execute the StatusCheck, after that restore status to the saved state (see StatusSave). Work when orchestrator is restarted. - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusSave(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Save current status of the process. After that you can restore process activity. Work when orchestrator is restarted. Don’t save “STOP_SAFE” status > “STOPPED” - - -* **Returns** - - Process status. See self.mStatusStr. 0_STOPPED 1_STOPPED_MANUAL 2_STOP_SAFE 3_STOP_SAFE_MANUAL 4_STARTED 5_STARTED_MANUAL - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStatusStrGet(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str) -Get the status of the Process instance. - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStopForce(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True) -Manual/Auto stop force. Force stop dont wait process termination - it just terminate process now. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - - -### pyOpenRPA.Orchestrator.Managers.Process.ProcessStopSafe(inAgentHostNameStr: str, inAgentUserNameStr: str, inProcessNameWOExeStr: str, inIsManualBool: bool = True, inStopSafeTimeoutSecFloat=None) -Manual/Auto stop safe. Stop safe is the operation which send signal to process to terminate own work (send term signal to process). Managers.Process wait for the mStopSafeTimeoutSecFloat seconds. After that, if process is not terminated - self will StopForce it. -Manual stop safe will block scheduling execution. To return schedule execution use def Manual2Auto - - -* **Parameters** - - - * **inAgentHostNameStr** – Agent hostname in any case. Required to identify Process - - - * **inAgentUserNameStr** – Agent user name in any case. Required to identify Process - - - * **inProcessNameWOExeStr** – The process name without extension .exe (the key of the Process instance). Any case - will be processed to the upper case - - - * **inIsManualBool** – Default is True - Mark this operation as manual - StatusCheckStart/Stop will be blocked - only StatusCheck will be working. False - Auto operation - - - * **inStopSafeTimeoutSecFloat** – Default value goes from the instance. You can specify time is second to wait while safe stop. After that program will stop force - - - -* **Returns** - - Process status. See self.mStatusStr. - Process instance has the following statuses: - - 0_STOPPED - - 1_STOPPED_MANUAL - - 2_STOP_SAFE - - 3_STOP_SAFE_MANUAL - - 4_STARTED - - 5_STARTED_MANUAL - - None (if Process instance not exists) - - -## ControlPanel (General) - -``` -# EXAMPLE -from pyOpenRPA.Orchestrator import Orchestrator - lCP = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestTTT",inRefreshHTMLJinja2TemplatePathStr="ControlPanel\\test.html", inJinja2TemplateRefreshBool = True) -``` - -**Classes:** - -| `ControlPanel`(inControlPanelNameStr[, …]) - - | Manage your control panel on the orchestrator - - | - -### class pyOpenRPA.Orchestrator.Managers.ControlPanel.ControlPanel(inControlPanelNameStr, inRefreshHTMLJinja2TemplatePathStr=None, inJinja2TemplateRefreshBool=False, inRobotNameStr=None) -Manage your control panel on the orchestrator - -Control panel has 3 events types: -- onRefreshHTML - run every n (see settings) second to detect changes in HTML control panel. -- onRefreshJSON - run every n (see settings) second to detect changes in JSON data container to client side. -- onInitJS - run when client reload the Orchestrator web page - -``` -# Usage example: -lCPManager = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestControlPanel", - inRefreshHTMLJinja2TemplatePathStr="ControlPanel\test.html", inJinja2TemplateRefreshBool = True) -``` - -If you use Jinja2 you can use next data context: -StorageRobotDict: Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr), -ControlPanelInstance: self, -OrchestratorModule:Orchestrator, -RequestInstance: inRequest, -UserInfoDict: Orchestrator.WebUserInfoGet(inRequest=inRequest), -UserUACDict: Orchestrator.UACUserDictGet(inRequest=inRequest), -UserUACCheckDef: inRequest.UACClientCheck, -EnumerateDef: enumerate, -OperatorModule: operator, -MathModule: math - -You can modify jinja context by use the function: -Jinja2DataUpdateDictSet - -**Methods:** - -| `DataDictGenerate`(inRequest) - - | -* **param inRequest** - - request handler (from http.server import BaseHTTPRequestHandler) - - - - | -| `InitJSJinja2StrGenerate`(inDataDict) - - | Generate the HTML str from the Jinja2. - - | -| `InitJSJinja2TemplatePathSet`(…) - - | Create Jinja2 env and load the template html - - | -| `Jinja2DataUpdateDictSet`(inJinja2DataUpdateDict) - - | Set the data dict from the Jinja2 context (you can add some new params) - - | -| `OnInitJSDataDict`(inRequest) - - | Event to prepare data context for the futher Jinja2 JS init generation. - - | -| `OnInitJSStr`(inRequest) - - | Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once. - - | -| `OnRefreshHTMLDataDict`(inRequest) - - | Event to prepare data context for the futher Jinja2 HTML generation. - - | -| `OnRefreshHTMLHashStr`(inRequest) - - | Generate the hash the result output HTML. - - | -| `OnRefreshHTMLStr`(inRequest) - - | Event to generate HTML code of the control panel when refresh time is over. - - | -| `OnRefreshJSONDict`(inRequest) - - | Event to transmit some data from server side to the client side in JSON format. - - | -| `RefreshHTMLJinja2StrGenerate`(inDataDict) - - | Generate the HTML str from the Jinja2. - - | -| `RefreshHTMLJinja2TemplatePathSet`(…) - - | Create Jinja2 env and load the template html - - | - -#### DataDictGenerate(inRequest) - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - - - -#### InitJSJinja2StrGenerate(inDataDict) -Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return: - - -#### InitJSJinja2TemplatePathSet(inJinja2TemplatePathStr) -Create Jinja2 env and load the template html - - -* **Parameters** - - **inJinja2TemplatePathStr** – - - - -* **Returns** - - - - -#### Jinja2DataUpdateDictSet(inJinja2DataUpdateDict) -Set the data dict from the Jinja2 context (you can add some new params) - - -* **Parameters** - - **inJinja2DataUpdateDict** – dict, which will be appended to main data context - - - -* **Returns** - - None - - - -#### OnInitJSDataDict(inRequest) -Event to prepare data context for the futher Jinja2 JS init generation. You can override this def if you want some thing more data - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - dict - - - -#### OnInitJSStr(inRequest) -Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once. - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - ”” - - - - -#### OnRefreshHTMLDataDict(inRequest) -Event to prepare data context for the futher Jinja2 HTML generation. You can override this def if you want some thing more data - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - dict - - - -#### OnRefreshHTMLHashStr(inRequest) -Generate the hash the result output HTML. You can override this function if you know how to optimize HTML rendering. -TODO NEED TO MODIFY ServerSettings to work with Hash because of all defs are need do use Hash - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - None - default, hash function is not determined. Str - hash function is working on! - - - -#### OnRefreshHTMLStr(inRequest) -Event to generate HTML code of the control panel when refresh time is over. -Support backward compatibility for previous versions. - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - - - -#### OnRefreshJSONDict(inRequest) -Event to transmit some data from server side to the client side in JSON format. Call when page refresh is initialized - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - Dict type - - - -#### RefreshHTMLJinja2StrGenerate(inDataDict) -Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return: - - -#### RefreshHTMLJinja2TemplatePathSet(inJinja2TemplatePathStr) -Create Jinja2 env and load the template html - - -* **Parameters** - - **inJinja2TemplatePathStr** – - - - -* **Returns** - - - -## ControlPanel (Details) - -**Classes:** - -| `ControlPanel`(inControlPanelNameStr[, …]) - - | Manage your control panel on the orchestrator - - | - -### class pyOpenRPA.Orchestrator.Managers.ControlPanel.ControlPanel(inControlPanelNameStr, inRefreshHTMLJinja2TemplatePathStr=None, inJinja2TemplateRefreshBool=False, inRobotNameStr=None) -Manage your control panel on the orchestrator - -Control panel has 3 events types: -- onRefreshHTML - run every n (see settings) second to detect changes in HTML control panel. -- onRefreshJSON - run every n (see settings) second to detect changes in JSON data container to client side. -- onInitJS - run when client reload the Orchestrator web page - -``` -# Usage example: -lCPManager = Orchestrator.Managers.ControlPanel(inControlPanelNameStr="TestControlPanel", - inRefreshHTMLJinja2TemplatePathStr="ControlPanel\test.html", inJinja2TemplateRefreshBool = True) -``` - -If you use Jinja2 you can use next data context: -StorageRobotDict: Orchestrator.StorageRobotGet(inRobotNameStr=self.mRobotNameStr), -ControlPanelInstance: self, -OrchestratorModule:Orchestrator, -RequestInstance: inRequest, -UserInfoDict: Orchestrator.WebUserInfoGet(inRequest=inRequest), -UserUACDict: Orchestrator.UACUserDictGet(inRequest=inRequest), -UserUACCheckDef: inRequest.UACClientCheck, -EnumerateDef: enumerate, -OperatorModule: operator, -MathModule: math - -You can modify jinja context by use the function: -Jinja2DataUpdateDictSet - -**Methods:** - -| `DataDictGenerate`(inRequest) - - | -* **param inRequest** - - request handler (from http.server import BaseHTTPRequestHandler) - - - - | -| `InitJSJinja2StrGenerate`(inDataDict) - - | Generate the HTML str from the Jinja2. - - | -| `InitJSJinja2TemplatePathSet`(…) - - | Create Jinja2 env and load the template html - - | -| `Jinja2DataUpdateDictSet`(inJinja2DataUpdateDict) - - | Set the data dict from the Jinja2 context (you can add some new params) - - | -| `OnInitJSDataDict`(inRequest) - - | Event to prepare data context for the futher Jinja2 JS init generation. - - | -| `OnInitJSStr`(inRequest) - - | Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once. - - | -| `OnRefreshHTMLDataDict`(inRequest) - - | Event to prepare data context for the futher Jinja2 HTML generation. - - | -| `OnRefreshHTMLHashStr`(inRequest) - - | Generate the hash the result output HTML. - - | -| `OnRefreshHTMLStr`(inRequest) - - | Event to generate HTML code of the control panel when refresh time is over. - - | -| `OnRefreshJSONDict`(inRequest) - - | Event to transmit some data from server side to the client side in JSON format. - - | -| `RefreshHTMLJinja2StrGenerate`(inDataDict) - - | Generate the HTML str from the Jinja2. - - | -| `RefreshHTMLJinja2TemplatePathSet`(…) - - | Create Jinja2 env and load the template html - - | - -#### DataDictGenerate(inRequest) - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - - - -#### InitJSJinja2StrGenerate(inDataDict) -Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return: - - -#### InitJSJinja2TemplatePathSet(inJinja2TemplatePathStr) -Create Jinja2 env and load the template html - - -* **Parameters** - - **inJinja2TemplatePathStr** – - - - -* **Returns** - - - - -#### Jinja2DataUpdateDictSet(inJinja2DataUpdateDict) -Set the data dict from the Jinja2 context (you can add some new params) - - -* **Parameters** - - **inJinja2DataUpdateDict** – dict, which will be appended to main data context - - - -* **Returns** - - None - - - -#### OnInitJSDataDict(inRequest) -Event to prepare data context for the futher Jinja2 JS init generation. You can override this def if you want some thing more data - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - dict - - - -#### OnInitJSStr(inRequest) -Event when orchestrator web page is init on the client side - you can transmit some java script code is str type to execute it once. - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - ”” - - - - -#### OnRefreshHTMLDataDict(inRequest) -Event to prepare data context for the futher Jinja2 HTML generation. You can override this def if you want some thing more data - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - dict - - - -#### OnRefreshHTMLHashStr(inRequest) -Generate the hash the result output HTML. You can override this function if you know how to optimize HTML rendering. -TODO NEED TO MODIFY ServerSettings to work with Hash because of all defs are need do use Hash - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - None - default, hash function is not determined. Str - hash function is working on! - - - -#### OnRefreshHTMLStr(inRequest) -Event to generate HTML code of the control panel when refresh time is over. -Support backward compatibility for previous versions. - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - - - -#### OnRefreshJSONDict(inRequest) -Event to transmit some data from server side to the client side in JSON format. Call when page refresh is initialized - - -* **Parameters** - - **inRequest** – request handler (from http.server import BaseHTTPRequestHandler) - - - -* **Returns** - - Dict type - - - -#### RefreshHTMLJinja2StrGenerate(inDataDict) -Generate the HTML str from the Jinja2. Pass the context inDataDict -:param inDataDict: -:return: - - -#### RefreshHTMLJinja2TemplatePathSet(inJinja2TemplatePathStr) -Create Jinja2 env and load the template html - - -* **Parameters** - - **inJinja2TemplatePathStr** – - - - -* **Returns** diff --git a/Wiki/ENG_Guide/markdown/Robot/01_Robot.md b/Wiki/ENG_Guide/markdown/Robot/01_Robot.md deleted file mode 100644 index 6d44d9ea..00000000 --- a/Wiki/ENG_Guide/markdown/Robot/01_Robot.md +++ /dev/null @@ -1,20 +0,0 @@ -# 1. Description - -pyOpenRPA Robot is the python package which allow you to create best RPA program. - -The description of the functions you can find page ‘Defs’ (see menu) - -Here is the example of the pyOpenRPA usage. - -``` -# EXAMPLE 1 -from pyOpenRPA.Robot import UIDesktop - -lNotepadOKButton = UIDesktop.UIOSelector_Get_UIO( - inSpecificationList=[ - {"title":"notepad.exe"},{"title":"OK"}], - inElement=None, - inFlagRaiseException=True) - -lNotepadOKButton.click() -``` diff --git a/Wiki/ENG_Guide/markdown/Robot/02_Defs.md b/Wiki/ENG_Guide/markdown/Robot/02_Defs.md deleted file mode 100644 index f5b63d22..00000000 --- a/Wiki/ENG_Guide/markdown/Robot/02_Defs.md +++ /dev/null @@ -1,545 +0,0 @@ -# 2. Defs - -Here you can find the functions description for interaction with desktop GUI applications - -How to use both x32 and x64 python processes (it can be helpfully, if another app GUI is on another bitness than your app) - -``` -from pyOpenRPA.Robot import UIDesktop -#Section for robot init -lPyOpenRPA_SettingsDict = { - "Python32FullPath": "..\\Resources\\WPy32-3720\\python-3.7.2\\python.exe", #Set from user: "..\\Resources\\WPy32-3720\\python-3.7.2\\OpenRPARobotGUIx32.exe" - "Python64FullPath": "..\\Resources\\WPy64-3720\\python-3.7.2.amd64\\python.exe", #Set from user - "Python32ProcessName": "pyOpenRPA_UIDesktopX32.exe", #Config set once - "Python64ProcessName": "pyOpenRPA_UIDesktopX64.exe" #Config set once -} -# Init the pyOpenRPA configuration -UIDesktop.Utils.ProcessBitness.SettingsInit(lPyOpenRPA_SettingsDict) -# Now you can use pyOpenRPA with both bitness. -``` - -**Functions:** - -| `Get_OSBitnessInt`() - - | Detect OS bitness. - - | -| `PWASpecification_Get_PWAApplication`(…) - - | #Backend selection - attribute “backend” (“win32” || “uia”) in 1-st list element - - | -| `PWASpecification_Get_UIO`(…) - - | #Backend def selection - attribute “backend” (“win32” || “uia”) in 1-st list element #old name - GetControl - - | -| `UIOSelectorSecs_WaitAppear_Bool`(…) - - | Wait for UI object will appear in GUI for inWaitSecs seconds. - - | -| `UIOSelectorSecs_WaitDisappear_Bool`(…) - - | Wait for UI object will disappear in GUI for inWaitSecs seconds. - - | -| `UIOSelectorUIOActivity_Run_Dict`(…[, …]) - - | Run the activity in UIO (UI Object) - - | -| `UIOSelector_Exist_Bool`(inUIOSelector) - - | Check if object is exist by the UIO selector. - - | -| `UIOSelector_FocusHighlight`(inUIOSelector) - - | Set focus and highlight (draw outline) the element (in app) by the UIO selector. - - | -| `UIOSelector_GetChildList_UIOList`([…]) - - | Get list of child UIO’s by the parent UIOSelector - - | -| `UIOSelector_Get_BitnessInt`(inSpecificationList) - - | Detect process bitness by the UI Object UIO Selector. - - | -| `UIOSelector_Get_BitnessStr`(inSpecificationList) - - | Detect process bitness by the UI Object UIO Selector. - - | -| `UIOSelector_Get_UIO`(inSpecificationList[, …]) - - | Get the pywinauto object by the UIO selector. - - | -| `UIOSelector_Get_UIOActivityList`(inUIOSelector) - - | Get the list of the UI object activities - - | -| `UIOSelector_Get_UIOInfo`(inUIOSelector) - - | Get the UIO dict of the attributes - - | -| `UIOSelector_Get_UIOList`(inSpecificationList) - - | Get the UIO list by the selector - - | -| `UIOSelector_Highlight`(inUIOSelector) - - | Highlight (draw outline) the element (in app) by the UIO selector. - - | -| `UIOSelector_SafeOtherGet_Process`(inUIOSelector) - - | Safe get other process or None if destination app is the other/same bitness - - | -| `UIOSelector_SearchChildByMouse_UIO`(…) - - | UIOSelector (see description on the top of the document) #old name - AutomationSearchMouseElement - - | -| `UIOSelector_SearchChildByMouse_UIOTree`(…) - - | !!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!! - - | -| `UIOSelector_TryRestore_Dict`(inSpecificationList) - - | Try to restore (maximize) window, if it’s minimized. - - | -| `UIOSelectorsSecs_WaitAppear_List`(…[, …]) - - | Wait for many UI object will appear in GUI for inWaitSecs seconds. - - | -| `UIOSelectorsSecs_WaitDisappear_List`(…[, …]) - - | Wait for many UI object will disappear in GUI for inWaitSecs seconds. - - | - -### pyOpenRPA.Robot.UIDesktop.Get_OSBitnessInt() -Detect OS bitness. - - -* **Returns** - - int 32 or int 64 - - - -### pyOpenRPA.Robot.UIDesktop.PWASpecification_Get_PWAApplication(inControlSpecificationArray) -#Backend selection - attribute “backend” (“win32” || “uia”) in 1-st list element - - -* **Parameters** - - **inControlSpecificationArray** – List of dict, dict in pywinauto.find_windows notation - - - -* **Returns** - - process application object - - - -### pyOpenRPA.Robot.UIDesktop.PWASpecification_Get_UIO(inControlSpecificationArray) -#Backend def selection - attribute “backend” (“win32” || “uia”) in 1-st list element -#old name - GetControl - - -* **Parameters** - - **inControlSpecificationArray** – List of dict, dict in pywinauto.find_windows notation - - - -* **Returns** - - list of UIO object - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelectorSecs_WaitAppear_Bool(inSpecificationList, inWaitSecs) -Wait for UI object will appear in GUI for inWaitSecs seconds. - - -* **Parameters** - - - * **inSpecificationList** – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}] - - - * **inWaitSecs** – Float value (seconds) for wait UI element appear in GUI - - - -* **Returns** - - True - UI object will appear. False - else case - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelectorSecs_WaitDisappear_Bool(inSpecificationList, inWaitSecs) -Wait for UI object will disappear in GUI for inWaitSecs seconds. - - -* **Parameters** - - - * **inSpecificationList** – UIOSelector. - Example: [{“title”:”notepad”},{“title”:”OK”}] - - - * **inWaitSecs** – Float value (seconds) for wait UI element disappear in GUI - - - -* **Returns** - - True - UI object will disappear. False - else case - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelectorUIOActivity_Run_Dict(inUIOSelector, inActionName, inArgumentList=None, inkwArgumentObject=None) -Run the activity in UIO (UI Object) - - -* **Parameters** - - - * **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - * **inActionName** – UIOActivity (name) activity name string from Pywinauto - - - * **inArgumentList** – - - - * **inkwArgumentObject** – - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Exist_Bool(inUIOSelector) -Check if object is exist by the UIO selector. - - -* **Parameters** - - **inUIOSelector** – - - - -* **Returns** - - True - Object is exist. False - else case - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_FocusHighlight(inUIOSelector) -Set focus and highlight (draw outline) the element (in app) by the UIO selector. - - -* **Parameters** - - **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_GetChildList_UIOList(inUIOSelector=None, inBackend='win32') -Get list of child UIO’s by the parent UIOSelector - - -* **Parameters** - - - * **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - * **inBackend** – “win32” or “uia” - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_BitnessInt(inSpecificationList) -Detect process bitness by the UI Object UIO Selector. - - -* **Parameters** - - **inSpecificationList** – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}] - - - -* **Returns** - - int 32 or int 64 - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_BitnessStr(inSpecificationList) -Detect process bitness by the UI Object UIO Selector. - - -* **Parameters** - - **inSpecificationList** – UIOSelector. Example: [{“title”:”notepad”},{“title”:”OK”}] - - - -* **Returns** - - str “32” or str “64” - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIO(inSpecificationList, inElement=None, inFlagRaiseException=True) -Get the pywinauto object by the UIO selector. - - -* **Parameters** - - - * **inSpecificationList** – - - - * **inElement** – - - - * **inFlagRaiseException** – - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOActivityList(inUIOSelector) -Get the list of the UI object activities - - -* **Parameters** - - **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOInfo(inUIOSelector) -Get the UIO dict of the attributes - - -* **Parameters** - - **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Get_UIOList(inSpecificationList, inElement=None, inFlagRaiseException=True) -Get the UIO list by the selector - - -* **Parameters** - - - * **inSpecificationList** – UIO Selector - - - * **inElement** – Входной элемент - показатель, что не требуется выполнять коннект к процессу - - - * **inFlagRaiseException** – Флаг True - выкинуть ошибку в случае обнаружении пустого списка - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_Highlight(inUIOSelector) -Highlight (draw outline) the element (in app) by the UIO selector. - - -* **Parameters** - - **inUIOSelector** – UIOSelector - List of items, which contains condition attributes - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_SafeOtherGet_Process(inUIOSelector) -Safe get other process or None if destination app is the other/same bitness - - -* **Parameters** - - **inUIOSelector** – UIO Selector of the UI object - - - -* **Returns** - - None or process (of the other bitness) - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_SearchChildByMouse_UIO(inElementSpecification) -UIOSelector (see description on the top of the document) -#old name - AutomationSearchMouseElement - - -* **Parameters** - - **inElementSpecification** – UIOSelector of the UI Object - - - -* **Returns** - - pywinauto element wrapper instance or None - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_SearchChildByMouse_UIOTree(inUIOSelector) -!!!!Safe call is included (you can set activity and UIDesktop will choose the bitness and return the result)!!!!! - - -* **Parameters** - - **inUIOSelector** – UIOSelector of the UI Object - - - -* **Returns** - - ? - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelector_TryRestore_Dict(inSpecificationList) -Try to restore (maximize) window, if it’s minimized. (!IMPORTANT! When use UIA framework minimized windows doesn’t appear by the UIOSelector. You need to try restore windows and after that try to get UIO) - - -* **Parameters** - - **inSpecificationList** – UIOSelector - List of items, which contains condition attributes - - - -* **Returns** - - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelectorsSecs_WaitAppear_List(inSpecificationListList, inWaitSecs, inFlagWaitAllInMoment=False) -Wait for many UI object will appear in GUI for inWaitSecs seconds. - - -* **Parameters** - - - * **inSpecificationListList** – UIOSelector list. - Example: [ - - > [{“title”:”notepad”},{“title”:”OK”}], - > [{“title”:”notepad”},{“title”:”Cancel”}] - - ] - - - - * **inWaitSecs** – Float value (seconds) for wait UI element appear in GUI - - - * **inFlagWaitAllInMoment** – True - Wait all UI objects from the UIOSelector list to be appeared - - - -* **Returns** - - List of index, which UI object UIO will be appeared. Example: [1] # Appear only UI object with UIO selector: [{“title”:”notepad”},{“title”:”Cancel”}] - - - -### pyOpenRPA.Robot.UIDesktop.UIOSelectorsSecs_WaitDisappear_List(inSpecificationListList, inWaitSecs, inFlagWaitAllInMoment=False) -Wait for many UI object will disappear in GUI for inWaitSecs seconds. - - -* **Parameters** - - - * **inSpecificationListList** – UIOSelector list. - Example: [ - - > [{“title”:”notepad”},{“title”:”OK”}], - > [{“title”:”notepad”},{“title”:”Cancel”}] - - ] - - - - * **inWaitSecs** – Float value (seconds) for wait UI element disappear in GUI - - - * **inFlagWaitAllInMoment** – True - Wait all UI objects from the UIOSelector list to be disappeared. - - - -* **Returns** - - List of index, which UI object UIO will be disappeared. Example: [1] # Disappear only UI object with UIO selector: [{“title”:”notepad”},{“title”:”Cancel”}] - - - -* **Returns** - - - -## References - -[reStructuredText](http://docutils.sourceforge.net/rst.html) diff --git a/Wiki/ENG_Guide/markdown/Robot/03_HowToUse.md b/Wiki/ENG_Guide/markdown/Robot/03_HowToUse.md deleted file mode 100644 index 9c017610..00000000 --- a/Wiki/ENG_Guide/markdown/Robot/03_HowToUse.md +++ /dev/null @@ -1,224 +0,0 @@ -# 3. How to use - -The Robot tool is the main module for production process automation. It has no graphic/console interface. All low-level actions to OS are perfoming by the Robot tool in pyOpenRPA. - -## How to execute RPA script - -You can use the robot by the several ways: - - -* In Python script - - -* In Studio script (n/a) - -### Create python script - -In order to use robot just add Robot tool folder in work directory and add line “import GUI” in your script. - -``` -import sys -sys.path.append('../../') -import selenium # [Web app access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.1.-Theory-&-practice:-Web-app-access-(Chrome,-Firefox,-Opera))
-import GUI # [Win32 & UI Automation access](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.2.-Theory-&-practice:-Desktop-app-UI-access-(win32-and-UI-automation-dlls))
-import pyautogui #[Screen capture/recognition](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition) [#Mouse manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
-import cv2 # [Computer vision](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.4.-Theory-&-practice:-Screen-capture-&-image-recognition)
-import keyboard #[Keyboard manipulation](https://gitlab.com/UnicodeLabs/OpenRPA/wikis/05.3.-Theory-&-practice:-Keyboard-&-mouse-manipulation)
-``` - -### Execute python script - -The pyOpenRPA is fully portable solution. It contains own python enviroment both 32 and 64 bit versions. So, you can execute your python script in several ways: -- Execute in python x32 (OpenRPAResourcesWPy32-3720python-3.7.2) -- Execute in python x64 (OpenRPAResourcesWPy64-3720python-3.7.2.amd64) -- Execute from .cmd file - -### Execute in the Python x32 - -To execute your python script in x32 bit version just write in command line from x32 python directory: - -``` -cd "\OpenRPA\Resources\WPy32-3720\python-3.7.2" -python.exe "path to your python script.py" -``` - -### Execute in the Python x64 - -To execute your python script in x32 bit version just write in command line from x32 python directory: - -``` -cd "\OpenRPA\Resources\WPy64-3720\python-3.7.2.amd64" -python.exe "path to your python script.py" -``` - -### Execute from .cmd file - -In order to simplify the execution process you can write several code lines in file with the .cmd extension: - -``` -cd %~dp0 -copy /Y ..\Resources\WPy32-3720\python-3.7.2\python.exe ..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe -.\..\Resources\WPy32-3720\python-3.7.2\OpenRPAOrchestrator.exe orchestratorMain.py -pause >nul -``` - -### Use in studio script (n/a) - -``` -import sys -sys.path.append('../../') -import GUI -import keyboard -import subprocess -import time - -#Highlight the UI Object in Folder explorer -GUI.UIOSelector_FocusHighlight([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]) - -#Wait 2 seconds -time.sleep(3) - -#Loop: get child element of UI List -for lItem in GUI.UIOSelector_Get_UIO([{"class_name":"CabinetWClass","backend":"uia"},{"ctrl_index":2},{"ctrl_index":0},{"ctrl_index":2},{"ctrl_index":0}]).children(): - print(str(lItem)) -``` - -Here you can find the docs and examples of the OpenRPA desktop (GUI) app access. - -## Desktop app UI access (win32 and UI automation dlls) - -### Definitions - - -* **UIO** - UI Object (class of pywinauto UI object) [pywinauto.base_wrapper] - - -* **UIOSelector** - List of dict (key attributes) - - -* **PWA** - PyWinAuto - - -* **PWASpecification** - List of dict (key attributes in pywinauto.find_window notation) - - -* **UIOTree** - Recursive Dict of Dict … (UI Parent -> Child hierarchy) - - -* **UIOInfo** - Dict of UIO attributes - - -* **UIOActivity** - Activity of the UIO (UI object) from the Pywinauto module - - -* **UIOEI** - UI Object info object - -### What is UIO? - -UIO is a User Interface Object (pyOpenRPA terminology). For maximum compatibility, this instance is inherited from the object model developed in the [pywinauto library (click to get a list of available class functions)]([https://pywinauto.readthedocs.io/en/latest/code/pywinauto.base_wrapper.html](https://pywinauto.readthedocs.io/en/latest/code/pywinauto.base_wrapper.html)). - -This approach allows us to implement useful functionality that has already been successfully developed in other libraries, and Supplement it with the missing functionality. In our case, the missing functionality is the ability to dynamically access UIO objects using UIO selectors. - -### UIOSelector structure & example - -UIOSelector is the list of condition items for the UIO in GUI. Each item has condition attributes for detect applicable UIO. Here is the description of the available condition attributes in item. - -**Desciption** - -``` -[ - { - "depth_start" :: [int, start from 1] :: the depth index, where to start check the condition list (default 1), - "depth_end" :: [int, start from 1] :: the depth index, where to stop check the condition list (default 1), - "ctrl_index" || "index" :: [int, starts from 0] :: the index of the UIO in parent UIO child list, - "title" :: [str] :: the condition for the UIO attribute *title*, - "title_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *title*, - "rich_text" :: [str] :: the condition for the UIO attribute *rich_text*, - "rich_text_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *rich_text*, - "class_name" :: [str] :: the condition for the UIO attribute *class_name*, - "class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *class_name*, - "friendly_class_name" :: [str] :: the condition for the UIO attribute *friendly_class_name*, - "friendly_class_name_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *friendly_class_name*, - "control_type" :: [str] :: the condition for the UIO attribute *control_type*, - "control_type_re" :: [str] :: regular expression (python ver) for the condition for the UIO attribute *control_type*, - "is_enabled" :: [bool] :: the condition for the UIO attribute *is_enabled*. If UI object is enabled on GUI, - "is_visible" :: [bool] :: the condition for the UIO attribute *is_visible*. If UI object is visible on GUI, - "backend" :: [str, "win32" || "uia"] :: the method of UIO extraction (default "win32"). ATTENTION! Current option can be only for the first item of the UIO selector. For the next items this option will be implemented from the first item. - }, - { ... specification next level UIO } -] -``` - -**The UIO selector example** - -``` -[ - {"class_name":"CalcFrame", "backend":"win32"}, # 1-st level UIO specification - {"title":"Hex", "depth_start":3, "depth_end": 3} # 3-rd level specification (because of attribute depth_start|depth_stop) -] -``` - -### The UIDesktop module (OpenRPA/Robot/UIDesktop.py) - -The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the **win32** and **ui automation** dll frameworks (big thx to the Microsoft :) ). - -``` -# EXAMPLE 1 -from pyOpenRPA.Robot import UIDesktop - -UIDesktop.UIOSelector_Get_UIO( - inSpecificationList=[ - {"title":"notepad.exe"},{"title":"OK"}], - inElement=None, - inFlagRaiseException=True) -``` - -### The UIDesktop module (OpenRPA/Robot/UIDesktop.py) - -The UIDesktop is extension of the pywinauto module which provide access to the desktop apps by the **win32** and **ui automation** dll frameworks (big thx to the Microsoft :) ). - - - -``` -* -``` - -Naming convention: __\*
- -## Theory & practice. WEB app UI access (selenium) - -### About - -The pyOpenRPA support web app manipulation (by the Selenium lib). -More docs about selenium you can find here ([https://selenium-python.readthedocs.io/](https://selenium-python.readthedocs.io/)) - -### How to use - -To start use selenium just import selenium modules in the robot tool. Here is the example of the usage. - -``` -from selenium import webdriver -from selenium.webdriver.common.keys import Keys - -driver = webdriver.Chrome() -driver.get("http://www.python.org") -assert "Python" in driver.title -elem = driver.find_element_by_name("q") -elem.clear() -elem.send_keys("pycon") -elem.send_keys(Keys.RETURN) -assert "No results found." not in driver.page_source -driver.close() -``` - -## Theory & practice. Keyboard & mouse manipulation - -## Theory & practice. Screen capture & image recognition - -### How to automate image recognition on PC - -Here you can find any ways you need to use in your business case: -- Find the exact match on the screen with the other image -- Use text recognition module (OCR) -- Use computer vision (CV) to identify the objects on screen/image/video -- Use artificial intelligence (AI) to make custom identification/classification/text recognition diff --git a/Wiki/ENG_Guide/markdown/Robot/04_Dependencies.md b/Wiki/ENG_Guide/markdown/Robot/04_Dependencies.md deleted file mode 100644 index fd69d706..00000000 --- a/Wiki/ENG_Guide/markdown/Robot/04_Dependencies.md +++ /dev/null @@ -1,8 +0,0 @@ -# 4. Dependencies - -Python 3 x32 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -Python 3 x64 [psutil, pywinauto, wmi, PIL, keyboard, pyautogui, win32api (pywin32), selenium, openCV, tesseract, requests, lxml, PyMuPDF] -pywinauto (Windows GUI automation) -Semantic UI CSS framework -JsRender by [https://www.jsviews.com](https://www.jsviews.com) (switch to Handlebars) -Handlebars diff --git a/Wiki/ENG_Guide/markdown/Studio/01_Studio.md b/Wiki/ENG_Guide/markdown/Studio/01_Studio.md deleted file mode 100644 index 95553b57..00000000 --- a/Wiki/ENG_Guide/markdown/Studio/01_Studio.md +++ /dev/null @@ -1,3 +0,0 @@ -# 1. Description - -pyOpenRPA Studio is the executable process. diff --git a/Wiki/ENG_Guide/markdown/Studio/02_HowToUse.md b/Wiki/ENG_Guide/markdown/Studio/02_HowToUse.md deleted file mode 100644 index 274f7253..00000000 --- a/Wiki/ENG_Guide/markdown/Studio/02_HowToUse.md +++ /dev/null @@ -1,149 +0,0 @@ -# 2. How to use - -## Content - - -* [How to run](#how-to-run) - - -* [UI Description](#ui-description) - - -* [How to extract UI tree](#how-to-extract-ui-tree) - - -* [How to search UI object by mouse -hover](#how-to-search-ui-object-by-mouse-hover) - - -* [How to extract UI object -properties](#how-to-extract-ui-object-properties) - -## How to run - - -* For OS x32 - - -* Run (double click): OpenRPA_32.cmd (for OS x32) - - -* For OS x64 - - -* Run (double click): OpenRPA_64.cmd (for OS x64) - - -* Wait text “running server” in console. Default browser will be open -automatically - - -* **Attention!** The studio tool does not support the Internet explorer -(any version) for GUI rendering (lol) - - - -![image](img/504b98f76747f63900a2943532a946bb.png) - -## UI Description - -**The studio tool GUI contains of:** - - -1. UI tree viewer - - -2. Selected UI object hierarchy list - - -3. Selected UI object property list - - -4. UIO selector editor - - -5. UIO action panel - - -6. Another Python activity panel - - -7. Action/activity list - -*Look it on the GUI screenshots are listed below* - -### GUI Screenshot 1 - - - -![image](img/d3d6ad14a7e50843bd89d2b14a092fee.png) - -### GUI Screenshot 2 - - - -![image](img/65b7d51c0a5b21e6b27dc23d4062d3ca.png) - -## How to extract UI tree - -In order to extract the UI tree do the following: in `UI tree viewer` -choose the object you are interested and click the button “Expand”. ## - -### Action: Click the button “Expand” - - - -![image](img/6effc376ff6ea928840674bd744caced.png) - -### Result - - - -![image](img/18b9ab36126c8c32168bf5bbb9330701.png) - -### How to search UI object by mouse hover - -In order to search UI object do the -following: in `UI tree viewer` choose the parent object, where you are -want to search UI object, and click the button “Mouse search”. The mouse -search mode will start. Turn mouse on the UI object you are interested -and wait when the studio will highlight the UI object. After the -hightlight hold the “Ctrl” key and wait 3 seconds. The interested UI -object will be shown in `UI tree viewer`. - -### Action: Click the button “Mouse search” - - - -![image](img/84d7e4de0c840631f87cf7b325b53ad8.png) - -### Action: Turn mouse on the UI object you are interested and hold the “Ctrl” key for 3 seconds - - - -![image](img/b7c38d622bf5b7afa5b26d1686d7302a.png) - -### Result: The interested UI object will be shown in `UI tree viewer` - - - -![image](img/629bbf4db2c01b9c640194230949fcd2.png) - -## How to extract UI object properties - -In order to extract UI object properties do the following: in -`Selected UI object hierarchy list` choose the UI object you are -interested and click it. The UI object property list will be shown in -`Selected UI object property list` - -### Action: Choose the UI object you are interested and click it - - - -![image](img/2c27be5bdde20b5d062cbb40e74eaec5.png) - -### Result: The UI object property list will be shown in `Selected UI object property list` - - - -![image](img/f235ae29099a713e0246cd574ac3a17c.png) diff --git a/Wiki/ENG_Guide/markdown/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png b/Wiki/ENG_Guide/markdown/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png deleted file mode 100644 index 55decb13..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/18b9ab36126c8c32168bf5bbb9330701.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png b/Wiki/ENG_Guide/markdown/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png deleted file mode 100644 index 3040bcd0..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/2c27be5bdde20b5d062cbb40e74eaec5.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/504b98f76747f63900a2943532a946bb.png b/Wiki/ENG_Guide/markdown/Studio/img/504b98f76747f63900a2943532a946bb.png deleted file mode 100644 index fa33c487..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/504b98f76747f63900a2943532a946bb.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/629bbf4db2c01b9c640194230949fcd2.png b/Wiki/ENG_Guide/markdown/Studio/img/629bbf4db2c01b9c640194230949fcd2.png deleted file mode 100644 index d4115094..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/629bbf4db2c01b9c640194230949fcd2.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png b/Wiki/ENG_Guide/markdown/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png deleted file mode 100644 index 973ed138..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/65b7d51c0a5b21e6b27dc23d4062d3ca.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/6effc376ff6ea928840674bd744caced.png b/Wiki/ENG_Guide/markdown/Studio/img/6effc376ff6ea928840674bd744caced.png deleted file mode 100644 index 2652cb1d..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/6effc376ff6ea928840674bd744caced.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png b/Wiki/ENG_Guide/markdown/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png deleted file mode 100644 index 8dd5df72..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/84d7e4de0c840631f87cf7b325b53ad8.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png b/Wiki/ENG_Guide/markdown/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png deleted file mode 100644 index e0ef0818..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/b7c38d622bf5b7afa5b26d1686d7302a.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png b/Wiki/ENG_Guide/markdown/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png deleted file mode 100644 index fa33c487..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/d3d6ad14a7e50843bd89d2b14a092fee.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Studio/img/f235ae29099a713e0246cd574ac3a17c.png b/Wiki/ENG_Guide/markdown/Studio/img/f235ae29099a713e0246cd574ac3a17c.png deleted file mode 100644 index ea6b153f..00000000 Binary files a/Wiki/ENG_Guide/markdown/Studio/img/f235ae29099a713e0246cd574ac3a17c.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/Tools/02_Defs.md b/Wiki/ENG_Guide/markdown/Tools/02_Defs.md deleted file mode 100644 index 69c0e273..00000000 --- a/Wiki/ENG_Guide/markdown/Tools/02_Defs.md +++ /dev/null @@ -1,48 +0,0 @@ -# 2. Defs StopSafe - -How to use StopSafe on the robot side - -# How to use -# from pyOpenRPA.Tools import StopSafe -# StopSafe.Init(inLogger=None) -# StopSafe.IsSafeStop() # True - WM_CLOSE SIGNAL has come. taskkill /im someprocess.exe - -**Functions:** - -| `Init`([inLogger]) - - | Init the StopSafe module. - - | -| `IsStopSafe`() - - | Check if stop signal has come. - - | - -### pyOpenRPA.Tools.StopSafe.Init(inLogger=None) -Init the StopSafe module. After that you can use def IsStopSafe() to check if close signal has come. - - -* **Parameters** - - **inLogger** – Logger to log messages about StopSafe - - - -* **Returns** - - - - -### pyOpenRPA.Tools.StopSafe.IsStopSafe() -Check if stop signal has come. - - -* **Returns** - - - -## References - -[reStructuredText](http://docutils.sourceforge.net/rst.html) diff --git a/Wiki/ENG_Guide/markdown/img/ModalGuide.png b/Wiki/ENG_Guide/markdown/img/ModalGuide.png deleted file mode 100644 index ce0890a5..00000000 Binary files a/Wiki/ENG_Guide/markdown/img/ModalGuide.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/img/cb5dec8cecafa7d64f6cd14b2672acce.png b/Wiki/ENG_Guide/markdown/img/cb5dec8cecafa7d64f6cd14b2672acce.png deleted file mode 100644 index 3d82a369..00000000 Binary files a/Wiki/ENG_Guide/markdown/img/cb5dec8cecafa7d64f6cd14b2672acce.png and /dev/null differ diff --git a/Wiki/ENG_Guide/markdown/index.md b/Wiki/ENG_Guide/markdown/index.md deleted file mode 100644 index 09779cd9..00000000 --- a/Wiki/ENG_Guide/markdown/index.md +++ /dev/null @@ -1,363 +0,0 @@ - -# Welcome to pyOpenRPA’s wiki - - - -![image](img/ModalGuide.png) - -*by Ivan Maslov (Russia)* - see 3. Copyrights & Contacts. - -! ATTENTION ! pyOpenRPA works only on MS Windows 7+/Server 2008+. Guys from Unix/Mac - sorry. We will come to you soon :) - -## About - -Dear RPA-tors. Let me congratulate you with great change in the RPA world. Since 2019 the first enterprise level open source RPA platform is here! - -pyOpenRPA is absolutely open source commercial project. Hosted by LLC PYOPENRPA (RUSSIA) - -The pyOpenRPA - free, fast and reliable -Powerful OpenSource RPA tool for business (based on python 3). Best performance and absolutely free! - -The pyOpenRPA is based on Python and using well known OpenSource solutions such as Selenium, OpenCV, Win32, UI automation and others. Thanks to it we were able to create consolidated platform with all possible features. -The pyOpenRPA is distributed under the PYOPENRPA license. -At the time of this writing the pyOpenRPA is successfully using in several big Russian companies. Companies in which it was decided to develop own RPA division with no dependencies on expensive licenses. - -## Repo structure - -The description of the each folder in GitLab repo is going below: - - -* **Agent**: template build for the pyOpenRPA.Agent component - - -* **Orchestrator**: template build for the pyOpenRPA.Orchestrator component - - -* **Resources**: 3rd party resources which is needed to provide pyOpenRPA encapsulation from the Operating System (OS) dependencies. - - -* **Robot**: template build for the robot - - -* **Sources**: pyOpenRPA python package sources + sphinx sources - - -* **Studio**: build for the pyOpenRPA.Studio which support Desktop UI (support x32 and x64 desktop UI apps) - - -* **Utils**: many additional good tools for the python developer - - -* **Wiki**: compiled wiki documentation - -## The pyOpenRPA structure - -### The pyOpenRPA has 4 main tools: - - -* Studio - - -* Robot - - -* Orchestrator - - -* Agent - -### Studio - -The pyOpenRPA.Studio tool has been developed to help RPA-tors to create the robot algorythms. - -**Features** - - -* Run actions - - -* Create visual algorythms of the robot - - -* Desktop app: Analyze desktop app ui tree - - -* Desktop app: Search desktop app ui by mouse - - -* Desktop app: Generate & edit the UIO Selector - -### Robot - -The pyOpenRPA.Robot package is the core of any action execution in the pyOpenRPA. All action from algorythms are perfoming by the Robot tool. It looks like a console process without graphic user interface. - -**Features** - - -* Based on Python (killer feature) - - -* Support Win32 GUI framework (desktop app) - - -* Support UI automation framework (desktop app) - - -* Support Selenium (web app) - - -* Support PyAutoGUI (screen capture & mouse) - - -* Support OpenCV (computer vision) - -### Orchestrator - -The pyOpenRPA.Orchestrator package has been developed to maintain robot infrastructure (2+ robots algorythm). - -**Features** - - -* Start/Stop robot algorithm - - -* Robot scheduler - - -* Remote machine screenshot viewer - - -* Remote machine cmd shell - - -* Remote machine logs storage - -### Agent - -The pyOpenRPA.Agent tool has been developed to maintain robot infrastructure (2+ robots algorythm). - -**Features** - - -* Send CMD to the RPA GUI session (start/safe stop/force stop/logout) - - -* Get screenshots from the RPA GUI session - - -* Get the list of the running processes - -## Wiki structure - -In wiki you can use the following docs: - - -* ENG Guide HTML [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/html/index.html) - - -* ENG Guide MarkDown [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/markdown/index.md) - - -* ENG Guide PDF [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/ENG_Guide/pdf/pyOpenRPA_Guide_ENG.pdf) - - -* RUS Article: Less cost - no paid RPA [[|OPEN HABR|]](https://habr.com/ru/post/506766/) - - -* RUS Tutorial Desktop UI [[|OPEN HABR|]](https://habr.com/ru/post/509644/); [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/DesktopGUI_Habr/index.md) - - -* RUS Tutorial Web UI [[|OPEN HABR|]](https://habr.com/ru/post/515310/); [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Tutorial/WebGUI_Habr/readme.md) - - -* RUS Leaflet pyOpenRPA v4.pdf [[|OPEN GITLAB|]](https://gitlab.com/UnicodeLabs/OpenRPA/-/tree/master/Wiki/RUS_Leaflet/RUS%20Leaflet%20pyOpenRPA%20v4.pdf) - -## Guide content - - -* 1. How to install - - - * How to check installation - - - * System requirements - - -* 2. Roadmap - - -* 3. Copyrights & Contacts - - - * Ivan Maslov (founder) - - - * 3-rd party components license dependencies - - - -* 1. Description - - -* 2. Defs - - - * References - - -* 3. How to use - - - * How to execute RPA script - - - * Desktop app UI access (win32 and UI automation dlls) - - - * Theory & practice. WEB app UI access (selenium) - - - * Theory & practice. Keyboard & mouse manipulation - - - * Theory & practice. Screen capture & image recognition - - -* 4. Dependencies - - - -* 1. Description - - -* 2. How to use - - - * Content - - - * How to run - - - * UI Description - - - * How to extract UI tree - - - * How to extract UI object properties - - - -* 1. Description - - - * Global settings dict concept - - - * Orchestrator how to configure - - - * Orchestrator architecture - - - * Component Processor - - - * References - - -* 2. Defs - - - * pyOpenRPA.Orchestrator.__Orchestrator__ - - - * Group Agent… - - - * Group GSettings… - - - * Group Storage… - - - * Group OS… - - - * Group Process… - - - * Group Processor… - - - * Group Python… - - - * Group RDPSession… - - - * Group Web… - - - * Group UAC… - - - * Group Scheduler… - - - * pyOpenRPA.Orchestrator.Web.Basic - - - * References - - -* 3. gSettings Template - - -* 4. How to use - - -* 5. UAC - User Access Control - - - * About - - - * UAC Dict for Orchestrator WEB UI rights - - -* 6. Defs Managers - - - * Process (General) - - - * Process (Details) - - - * ControlPanel (General) - - - * ControlPanel (Details) - - - -* 2. Defs - - - * pyOpenRPA.Agent.__Agent__ - - - * References - - - -* 2. Defs StopSafe - - - * References diff --git a/v1.2.7 b/v1.2.8 similarity index 100% rename from v1.2.7 rename to v1.2.8