<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > 2. Defs — pyOpenRPA v1.2.0 documentation< / title >
< link rel = "stylesheet" href = "../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
<!-- [if lt IE 9]>
< script src = "../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "prev" title = "5. UAC - User Access Control" href = "../Orchestrator/05_UAC.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../index.html" class = "icon icon-home" > pyOpenRPA
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > GENERAL< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../01_HowToInstall.html" > 1. How to install< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../02_RoadMap.html" > 2. Roadmap< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../03_Copyrights_Contacts.html" > 3. Copyrights & Contacts< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > ROBOT< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Robot/01_Robot.html" > 1. Description< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Robot/02_Defs.html" > 2. Defs< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Robot/03_HowToUse.html" > 3. How to use< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Robot/04_Dependencies.html" > 4. Dependencies< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > STUDIO< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Studio/01_Studio.html" > 1. Description< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Studio/02_HowToUse.html" > 2. How to use< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > ORCHESTRATOR< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Orchestrator/01_Orchestrator.html" > 1. Description< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Orchestrator/02_Defs.html" > 2. Defs< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Orchestrator/03_gSettingsTemplate.html" > 3. gSettings Template< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Orchestrator/04_HowToUse.html" > 4. How to use< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../Orchestrator/05_UAC.html" > 5. UAC - User Access Control< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > AGENT< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 2. Defs< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#module-pyOpenRPA.Agent.__Agent__" > pyOpenRPA.Agent.__Agent__< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#references" > References< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../index.html" > pyOpenRPA< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../index.html" class = "icon icon-home" > < / a > » < / li >
< li > 2. Defs< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/Agent/02_Defs.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "defs" >
< h1 > 2. Defs< a class = "headerlink" href = "#defs" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "module-pyOpenRPA.Agent.__Agent__" >
< span id = "pyopenrpa-agent-agent" > < / span > < h2 > pyOpenRPA.Agent.__Agent__< a class = "headerlink" href = "#module-pyOpenRPA.Agent.__Agent__" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < strong > Functions:< / strong > < / p >
< table class = "longtable docutils align-default" >
< colgroup >
< col style = "width: 10%" / >
< col style = "width: 90%" / >
< / colgroup >
< tbody >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "#pyOpenRPA.Agent.__Agent__.OSCMD" title = "pyOpenRPA.Agent.__Agent__.OSCMD" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > OSCMD< / span > < / code > < / a > (inCMDStr[, < / p > < / td >
< td > < p > Execute CMD on the Agent daemonic process< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < a class = "reference internal" href = "#pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate" title = "pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > OSFileBinaryDataBase64StrCreate< / span > < / code > < / a > (…[, …])< / p > < / td >
< td > < p > Create binary file by the base64 string (safe for JSON transmition)< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "#pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet" title = "pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > ProcessWOExeUpperUserListGet< / span > < / code > < / a > ()< / p > < / td >
< td > < p > Return the process list only for the current user (where Agent is running) without .EXE in upper case.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "py function" >
< dt id = "pyOpenRPA.Agent.__Agent__.OSCMD" >
< code class = "sig-prename descclassname" > pyOpenRPA.Agent.__Agent__.< / code > < code class = "sig-name descname" > OSCMD< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > inCMDStr< / span > < / em > , < em class = "sig-param" > < span class = "n" > inRunAsyncBool< / span > < span class = "o" > =< / span > < span class = "default_value" > True< / span > < / em > , < em class = "sig-param" > < span class = "n" > inGSettings< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > inSendOutputToOrchestratorLogsBool< / span > < span class = "o" > =< / span > < span class = "default_value" > True< / span > < / em > , < em class = "sig-param" > < span class = "n" > inCMDEncodingStr< / span > < span class = "o" > =< / span > < span class = "default_value" > 'cp1251'< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/pyOpenRPA/Agent/__Agent__.html#OSCMD" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#pyOpenRPA.Agent.__Agent__.OSCMD" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Execute CMD on the Agent daemonic process< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > inCMDStr< / strong > – < / p > < / li >
< li > < p > < strong > inRunAsyncBool< / strong > – ’ < / p > < / li >
< li > < p > < strong > inGSettings< / strong > – < / p > < / li >
< li > < p > < strong > inSendOutputToOrchestratorLogsBool< / strong > – < / p > < / li >
< / ul >
< / dd >
< / dl >
< p > !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
: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
:return:< / p >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate" >
< code class = "sig-prename descclassname" > pyOpenRPA.Agent.__Agent__.< / code > < code class = "sig-name descname" > OSFileBinaryDataBase64StrCreate< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > inFilePathStr< / span > < / em > , < em class = "sig-param" > < span class = "n" > inFileDataBase64Str< / span > < / em > , < em class = "sig-param" > < span class = "n" > inGSettings< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/pyOpenRPA/Agent/__Agent__.html#OSFileBinaryDataBase64StrCreate" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#pyOpenRPA.Agent.__Agent__.OSFileBinaryDataBase64StrCreate" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create binary file by the base64 string (safe for JSON transmition)< / p >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet" >
< code class = "sig-prename descclassname" > pyOpenRPA.Agent.__Agent__.< / code > < code class = "sig-name descname" > ProcessWOExeUpperUserListGet< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/pyOpenRPA/Agent/__Agent__.html#ProcessWOExeUpperUserListGet" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#pyOpenRPA.Agent.__Agent__.ProcessWOExeUpperUserListGet" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > 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< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > inProcessNameWOExeList< / strong > – < / p >
< / dd >
< dt class = "field-even" > Returns< / dt >
< dd class = "field-even" > < p > list of the agent user process in upper case without .EXE. Example [“NOTEPAD”,”…”],< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / div >
< div class = "section" id = "references" >
< h2 > References< a class = "headerlink" href = "#references" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < a class = "reference external" href = "http://docutils.sourceforge.net/rst.html" > reStructuredText< / a > < a class = "footnote-reference brackets" href = "#id1" id = "id2" > 1< / a > < / p >
< dl class = "footnote brackets" >
< dt class = "label" id = "id1" > < span class = "brackets" > < a class = "fn-backref" href = "#id2" > 1< / a > < / span > < / dt >
< dd > < p > < a class = "reference external" href = "http://docutils.sourceforge.net/rst.html" > http://docutils.sourceforge.net/rst.html< / a > < / p >
< / dd >
< / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "../Orchestrator/05_UAC.html" class = "btn btn-neutral float-left" title = "5. UAC - User Access Control" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2021, Ivan Maslov.
< / p >
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
