|
|
<!doctype html>
|
|
|
<html class="no-js">
|
|
|
<head><meta charset="utf-8"/>
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
|
|
|
|
|
|
<meta name="generator" content="sphinx-3.3.1, furo 2020.12.09.beta21"/>
|
|
|
<title>Home - pyOpenRPA v1.2.0 documentation</title>
|
|
|
<link rel="stylesheet" href="_static/styles/furo.css?digest=a3f371badb8538d75df213ccffb17a4f6e8f3ac5">
|
|
|
<link rel="stylesheet" href="_static/pygments.css">
|
|
|
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
|
:root {
|
|
|
--color-code-background: #f8f8f8;
|
|
|
--color-code-foreground: black;
|
|
|
|
|
|
}
|
|
|
@media (prefers-color-scheme: dark) {
|
|
|
:root {
|
|
|
--color-code-background: #202020;
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
|
}
|
|
|
}
|
|
|
|
|
|
/* For allowing end-user-specific overrides */
|
|
|
.override-light {
|
|
|
--color-code-background: #f8f8f8;
|
|
|
--color-code-foreground: black;
|
|
|
|
|
|
}
|
|
|
.override-dark {
|
|
|
--color-code-background: #202020;
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
|
}
|
|
|
</style><link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css" />
|
|
|
<link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=26485485040e7aaf717c13fd0188a5ad2c2deb60">
|
|
|
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
|
<script defer src="_static/jquery.js"></script>
|
|
|
<script defer src="_static/underscore.js"></script>
|
|
|
<script defer src="_static/doctools.js"></script>
|
|
|
<script defer src="_static/language_data.js"></script>
|
|
|
<script defer src="_static/scripts/main.js?digest=e931d09b2a40c1bb82b542effe772014573baf67"></script></head>
|
|
|
<body dir="">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
|
<title>Contents</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
|
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
|
|
<path stroke="none" d="M0 0h24v24H0z"/>
|
|
|
<line x1="4" y1="6" x2="20" y2="6" />
|
|
|
<line x1="10" y1="12" x2="20" y2="12" />
|
|
|
<line x1="6" y1="18" x2="20" y2="18" />
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
|
<title>Menu</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
|
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
|
|
class="feather feather-menu">
|
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
|
<title>Expand</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
|
|
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
|
|
class="feather feather-chevron-right">
|
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
</svg>
|
|
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
|
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
|
|
<label class="overlay toc-overlay" for="__toc"></label>
|
|
|
|
|
|
|
|
|
<div class="page">
|
|
|
<header class="mobile-header">
|
|
|
<div class="header-left">
|
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
|
</label>
|
|
|
</div>
|
|
|
<div class="header-center">
|
|
|
<a href="#"><div class="brand">pyOpenRPA v1.2.0 documentation</div></a>
|
|
|
</div>
|
|
|
<div class="header-right">
|
|
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
</label>
|
|
|
</div>
|
|
|
</header>
|
|
|
<aside class="sidebar-drawer">
|
|
|
<div class="sidebar-container">
|
|
|
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
|
|
|
|
|
|
|
|
|
<span class="sidebar-brand-text">pyOpenRPA v1.2.0 documentation</span>
|
|
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="search.html">
|
|
|
<input class="sidebar-search" placeholder="Search" name="q">
|
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
|
<input type="hidden" name="area" value="default">
|
|
|
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
</aside>
|
|
|
<main class="main">
|
|
|
<div class="content">
|
|
|
<article role="main">
|
|
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
</label>
|
|
|
<div class="section" id="welcome-to-pyopenrpa-s-documentation">
|
|
|
<h1>Welcome to pyOpenRPA’s documentation!<a class="headerlink" href="#welcome-to-pyopenrpa-s-documentation" title="Permalink to this headline">¶</a></h1>
|
|
|
</div>
|
|
|
<div class="section" id="indices-and-tables">
|
|
|
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
|
|
<ul class="simple">
|
|
|
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
|
|
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
|
|
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="section" id="module-pyOpenRPA.Orchestrator.__Orchestrator__">
|
|
|
<span id="pyopenrpa-orchestrator"></span><h1>pyOpenRPA Orchestrator<a class="headerlink" href="#module-pyOpenRPA.Orchestrator.__Orchestrator__" title="Permalink to this headline">¶</a></h1>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemAdd">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">AgentActivityItemAdd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inHostNameStr</span></em>, <em class="sig-param"><span class="n">inUserStr</span></em>, <em class="sig-param"><span class="n">inActivityItemDict</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#AgentActivityItemAdd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.AgentActivityItemAdd" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Add activity in AgentDict. Check if item is created</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inHostNameStr</strong> – Agent host name</p></li>
|
|
|
<li><p><strong>inUserStr</strong> – User login, where agent is based</p></li>
|
|
|
<li><p><strong>inActivityItemDict</strong> – ActivityItem</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>sad</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSCMD">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">AgentOSCMD</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inHostNameStr</span></em>, <em class="sig-param"><span class="n">inUserStr</span></em>, <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><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#AgentOSCMD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSCMD" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>pyOpenRPA.Agent: Send CMD to OS. Result return to log + Orchestrator by the A2O connection
|
|
|
def OSCMD(inCMDStr, inRunAsyncBool=True, inGSettings=None):
|
|
|
Send to agent activity item to OSCMD</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inHostNameStr</strong> – </p></li>
|
|
|
<li><p><strong>inUserStr</strong> – </p></li>
|
|
|
<li><p><strong>inCMDStr</strong> – </p></li>
|
|
|
<li><p><strong>inRunAsyncBool</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">AgentOSFileBinaryDataBase64StrCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inHostNameStr</span></em>, <em class="sig-param"><span class="n">inUserStr</span></em>, <em class="sig-param"><span class="n">inFilePathStr</span></em>, <em class="sig-param"><span class="n">inFileDataBase64Str</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#AgentOSFileBinaryDataBase64StrCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBase64StrCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmission)
|
|
|
def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
|
|
|
Send binary file to Agent (base64 string)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inHostNameStr</strong> – </p></li>
|
|
|
<li><p><strong>inUserStr</strong> – </p></li>
|
|
|
<li><p><strong>inFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inFileDataBase64Str</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBytesCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">AgentOSFileBinaryDataBytesCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inHostNameStr</span></em>, <em class="sig-param"><span class="n">inUserStr</span></em>, <em class="sig-param"><span class="n">inFilePathStr</span></em>, <em class="sig-param"><span class="n">inFileDataBytes</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#AgentOSFileBinaryDataBytesCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileBinaryDataBytesCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>pyOpenRPA.Agent: Create binary file by the base64 string (safe for JSON transmition)
|
|
|
def OSFileBinaryDataBase64StrCreate(inFilePathStr, inFileDataBase64Str,inGSettings = None):
|
|
|
Send binary file to Agent (Bytes)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inHostNameStr</strong> – </p></li>
|
|
|
<li><p><strong>inUserStr</strong> – </p></li>
|
|
|
<li><p><strong>inFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inFileDataBytes</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">AgentOSFileTextDataStrCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inHostNameStr</span></em>, <em class="sig-param"><span class="n">inUserStr</span></em>, <em class="sig-param"><span class="n">inFilePathStr</span></em>, <em class="sig-param"><span class="n">inFileDataStr</span></em>, <em class="sig-param"><span class="n">inEncodingStr</span><span class="o">=</span><span class="default_value">'utf-8'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#AgentOSFileTextDataStrCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.AgentOSFileTextDataStrCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>pyOpenRPA.Agent: Create text file by the string
|
|
|
def OSFileTextDataStrCreate(inFilePathStr, inFileDataStr, inEncodingStr = “utf-8”,inGSettings = None):
|
|
|
Create Activity Item for the agent</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inHostNameStr</strong> – </p></li>
|
|
|
<li><p><strong>inUserStr</strong> – </p></li>
|
|
|
<li><p><strong>inFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inFileDataStr</strong> – </p></li>
|
|
|
<li><p><strong>inEncodingStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsAutocleaner">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">GSettingsAutocleaner</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#GSettingsAutocleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsAutocleaner" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Interval gsettings auto cleaner</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inGSettings</strong> – Global settings dict (singleton)</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueAppend">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">GSettingsKeyListValueAppend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inValue</span></em>, <em class="sig-param"><span class="n">inKeyList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#GSettingsKeyListValueAppend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueAppend" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Append value in GSettings by the key list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inValue</strong> – </p></li>
|
|
|
<li><p><strong>inKeyList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueGet">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">GSettingsKeyListValueGet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inKeyList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#GSettingsKeyListValueGet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueGet" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Get the value from the GSettings by the key list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inKeyList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>value any type</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueOperatorPlus">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">GSettingsKeyListValueOperatorPlus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inValue</span></em>, <em class="sig-param"><span class="n">inKeyList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#GSettingsKeyListValueOperatorPlus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueOperatorPlus" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Operator plus value in GSettings by the key list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inValue</strong> – </p></li>
|
|
|
<li><p><strong>inKeyList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueSet">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">GSettingsKeyListValueSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inValue</span></em>, <em class="sig-param"><span class="n">inKeyList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#GSettingsKeyListValueSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.GSettingsKeyListValueSet" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Set value in GSettings by the key list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inValue</strong> – </p></li>
|
|
|
<li><p><strong>inKeyList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.OSCMD">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</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">inLogger</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#OSCMD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.OSCMD" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>OS send command in shell locally</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>inLogger</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>CMD result string</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.OSCredentialsVerify">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">OSCredentialsVerify</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inUserStr</span></em>, <em class="sig-param"><span class="n">inPasswordStr</span></em>, <em class="sig-param"><span class="n">inDomainStr</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#OSCredentialsVerify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.OSCredentialsVerify" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Verify user credentials in windows. Return bool</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inUserStr</strong> – </p></li>
|
|
|
<li><p><strong>inPasswordStr</strong> – </p></li>
|
|
|
<li><p><strong>inDomainStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True - Credentials are actual; False - Credentials are not actual</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRestart">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">OrchestratorRestart</code><span class="sig-paren">(</span><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/Orchestrator/__Orchestrator__.html#OrchestratorRestart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorRestart" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Orchestrator restart</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inGSettings</strong> – Global settings dict (singleton)</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionSave">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">OrchestratorSessionSave</code><span class="sig-paren">(</span><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/Orchestrator/__Orchestrator__.html#OrchestratorSessionSave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.OrchestratorSessionSave" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Orchestrator session save in file _SessionLast_RDPList.json (encoding = “utf-8”)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inGSettings</strong> – Global settings dict (singleton)</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessIsStarted">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessIsStarted</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inProcessNameWOExeStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessIsStarted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessIsStarted" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Check if there is any running process that contains the given name processName.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inProcessNameWOExeStr</strong> – </p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True - process is running; False - process is not running</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessListGet">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessListGet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inProcessNameWOExeList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessListGet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessListGet" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Check activity of the list of processes</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>TODO FILL THE RESULT DICT</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStart">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessStart</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inPathStr</span></em>, <em class="sig-param"><span class="n">inArgList</span></em>, <em class="sig-param"><span class="n">inStopProcessNameWOExeStr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessStart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStart" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Start process locally [optional: if task name is not started]</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inPathStr</strong> – </p></li>
|
|
|
<li><p><strong>inArgList</strong> – </p></li>
|
|
|
<li><p><strong>inStopProcessNameWOExeStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStop">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessStop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inProcessNameWOExeStr</span></em>, <em class="sig-param"><span class="n">inCloseForceBool</span></em>, <em class="sig-param"><span class="n">inUserNameStr</span><span class="o">=</span><span class="default_value">'%username%'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessStop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessStop" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Stop process</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inProcessNameWOExeStr</strong> – </p></li>
|
|
|
<li><p><strong>inCloseForceBool</strong> – </p></li>
|
|
|
<li><p><strong>inUserNameStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemAppend">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessorActivityItemAppend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inDef</span></em>, <em class="sig-param"><span class="n">inArgList</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgDict</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgGSettingsStr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgLoggerStr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessorActivityItemAppend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemAppend" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Add Activity item in Processor list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inDef</strong> – </p></li>
|
|
|
<li><p><strong>inArgList</strong> – </p></li>
|
|
|
<li><p><strong>inArgDict</strong> – </p></li>
|
|
|
<li><p><strong>inArgGSettingsStr</strong> – </p></li>
|
|
|
<li><p><strong>inArgLoggerStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessorActivityItemCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inDef</span></em>, <em class="sig-param"><span class="n">inArgList</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgDict</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgGSettingsStr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgLoggerStr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessorActivityItemCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorActivityItemCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Create ActivityItem</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inDef</strong> – </p></li>
|
|
|
<li><p><strong>inArgList</strong> – </p></li>
|
|
|
<li><p><strong>inArgDict</strong> – </p></li>
|
|
|
<li><p><strong>inArgGSettingsStr</strong> – </p></li>
|
|
|
<li><p><strong>inArgLoggerStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>{}</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessorAliasDefCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inDef</span></em>, <em class="sig-param"><span class="n">inAliasStr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessorAliasDefCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Create alias for def (can be used in ActivityItem in field Def)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inDef</strong> – </p></li>
|
|
|
<li><p><strong>inAliasStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>str Alias</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefUpdate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">ProcessorAliasDefUpdate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inDef</span></em>, <em class="sig-param"><span class="n">inAliasStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#ProcessorAliasDefUpdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.ProcessorAliasDefUpdate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Update alias for def (can be used in ActivityItem in field Def)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inDef</strong> – </p></li>
|
|
|
<li><p><strong>inAliasStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>str Alias</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.PythonStart">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">PythonStart</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inModulePathStr</span></em>, <em class="sig-param"><span class="n">inDefNameStr</span></em>, <em class="sig-param"><span class="n">inArgList</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inArgDict</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inLogger</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#PythonStart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.PythonStart" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Python import module and start def</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inModulePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inDefNameStr</strong> – </p></li>
|
|
|
<li><p><strong>inArgList</strong> – </p></li>
|
|
|
<li><p><strong>inArgDict</strong> – </p></li>
|
|
|
<li><p><strong>inLogger</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionCMDRun">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionCMDRun</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inCMDStr</span></em>, <em class="sig-param"><span class="n">inModeStr</span><span class="o">=</span><span class="default_value">'CROSSCHECK'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionCMDRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionCMDRun" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Send command in RDP session</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inCMDStr</strong> – </p></li>
|
|
|
<li><p><strong>inModeStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True - CMD was executed successfully</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionConnect">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionConnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inRDPTemplateDict</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inHostStr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inPortStr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inLoginStr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inPasswordStr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionConnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionConnect" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><dl class="simple">
|
|
|
<dt>Create new RDPSession in RobotRDPActive. Attention - activity will be ignored if key is exists</dt><dd><p>2 way of the use</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
<p>Var 1: inGSettings, inRDPSessionKeyStr, inRDPTemplateDict
|
|
|
Var 2 (Backward compatibility): inGSettings, inRDPSessionKeyStr, inHostStr, inPortStr, inLoginStr, inPasswordStr</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inRDPTemplateDict</strong> – </p></li>
|
|
|
<li><p><strong>inHostStr</strong> – </p></li>
|
|
|
<li><p><strong>inPortStr</strong> – </p></li>
|
|
|
<li><p><strong>inLoginStr</strong> – </p></li>
|
|
|
<li><p><strong>inPasswordStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDisconnect">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionDisconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inBreakTriggerProcessWOExeList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionDisconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDisconnect" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Disconnect the RDP session</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inBreakTriggerProcessWOExeList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDublicatesResolve">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionDublicatesResolve</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionDublicatesResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionDublicatesResolve" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Search dublicates in GSettings RDPlist
|
|
|
!def is developing!</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inGSettings</strong> – Global settings dict (singleton)</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredRecieve">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionFileStoredRecieve</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inRDPFilePathStr</span></em>, <em class="sig-param"><span class="n">inHostFilePathStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionFileStoredRecieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredRecieve" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Receive file from Session RDP to Host using shared drive in RDP</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inRDPFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inHostFilePathStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredSend">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionFileStoredSend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inHostFilePathStr</span></em>, <em class="sig-param"><span class="n">inRDPFilePathStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionFileStoredSend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionFileStoredSend" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Send file from Host to Session RDP using shared drive in RDP</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inHostFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inRDPFilePathStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionLogoff">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionLogoff</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inBreakTriggerProcessWOExeList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionLogoff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionLogoff" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Logoff the RDP session</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inBreakTriggerProcessWOExeList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True - logoff is successful</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionMonitorStop">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionMonitorStop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionMonitorStop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionMonitorStop" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Stop track the RDP session. Current def dont kill RDP session - only stop to track it (it can give )</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStartIfNotRunning">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionProcessStartIfNotRunning</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inProcessNameWEXEStr</span></em>, <em class="sig-param"><span class="n">inFilePathStr</span></em>, <em class="sig-param"><span class="n">inFlagGetAbsPathBool</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionProcessStartIfNotRunning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStartIfNotRunning" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Start process if it is not running</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inProcessNameWEXEStr</strong> – </p></li>
|
|
|
<li><p><strong>inFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inFlagGetAbsPathBool</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStop">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionProcessStop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inProcessNameWEXEStr</span></em>, <em class="sig-param"><span class="n">inFlagForceCloseBool</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionProcessStop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionProcessStop" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Create CMD str to stop process</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inProcessNameWEXEStr</strong> – </p></li>
|
|
|
<li><p><strong>inFlagForceCloseBool</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionReconnect">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionReconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em>, <em class="sig-param"><span class="n">inRDPTemplateDict</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionReconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionReconnect" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>RDP Session reconnect</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inRDPTemplateDict</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionResponsibilityCheck">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPSessionResponsibilityCheck</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inRDPSessionKeyStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPSessionResponsibilityCheck"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPSessionResponsibilityCheck" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Check RDP Session responsibility TODO NEED DEV + TEST</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inRDPSessionKeyStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>True every time</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.RDPTemplateCreate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">RDPTemplateCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inLoginStr</span></em>, <em class="sig-param"><span class="n">inPasswordStr</span></em>, <em class="sig-param"><span class="n">inHostStr</span><span class="o">=</span><span class="default_value">'127.0.0.1'</span></em>, <em class="sig-param"><span class="n">inPortInt</span><span class="o">=</span><span class="default_value">3389</span></em>, <em class="sig-param"><span class="n">inWidthPXInt</span><span class="o">=</span><span class="default_value">1680</span></em>, <em class="sig-param"><span class="n">inHeightPXInt</span><span class="o">=</span><span class="default_value">1050</span></em>, <em class="sig-param"><span class="n">inUseBothMonitorBool</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">inDepthBitInt</span><span class="o">=</span><span class="default_value">32</span></em>, <em class="sig-param"><span class="n">inSharedDriveList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#RDPTemplateCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.RDPTemplateCreate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Create some RDP template dict to use it when connect/reconnect</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inLoginStr</strong> – </p></li>
|
|
|
<li><p><strong>inPasswordStr</strong> – </p></li>
|
|
|
<li><p><strong>inHostStr</strong> – </p></li>
|
|
|
<li><p><strong>inPortInt</strong> – </p></li>
|
|
|
<li><p><strong>inWidthPXInt</strong> – </p></li>
|
|
|
<li><p><strong>inHeightPXInt</strong> – </p></li>
|
|
|
<li><p><strong>inUseBothMonitorBool</strong> – </p></li>
|
|
|
<li><p><strong>inDepthBitInt</strong> – </p></li>
|
|
|
<li><p><strong>inSharedDriveList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.SchedulerActivityTimeAddWeekly">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">SchedulerActivityTimeAddWeekly</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inTimeHHMMStr</span><span class="o">=</span><span class="default_value">'23:55:'</span></em>, <em class="sig-param"><span class="n">inWeekdayList</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inActivityList</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#SchedulerActivityTimeAddWeekly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.SchedulerActivityTimeAddWeekly" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Add activity in time weekly</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inTimeHHMMStr</strong> – </p></li>
|
|
|
<li><p><strong>inWeekdayList</strong> – </p></li>
|
|
|
<li><p><strong>inActivityList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.UACKeyListCheck">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">UACKeyListCheck</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inRequest</span></em>, <em class="sig-param"><span class="n">inRoleKeyList</span></em><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#UACKeyListCheck"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.UACKeyListCheck" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Check is client is has access for the key list</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inRequest</strong> – </p></li>
|
|
|
<li><p><strong>inRoleKeyList</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.UACSuperTokenUpdate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">UACSuperTokenUpdate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inSuperTokenStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#UACSuperTokenUpdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.UACSuperTokenUpdate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Add supertoken for the all access (it is need for the robot communication without human)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inSuperTokenStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.UACUpdate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">UACUpdate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inADLoginStr</span></em>, <em class="sig-param"><span class="n">inADStr</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">inADIsDefaultBool</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">inURLList</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inRoleHierarchyAllowedDict</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#UACUpdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.UACUpdate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Update user access (UAC)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inADLoginStr</strong> – </p></li>
|
|
|
<li><p><strong>inADStr</strong> – </p></li>
|
|
|
<li><p><strong>inADIsDefaultBool</strong> – </p></li>
|
|
|
<li><p><strong>inURLList</strong> – </p></li>
|
|
|
<li><p><strong>inRoleHierarchyAllowedDict</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebCPUpdate">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebCPUpdate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inCPKeyStr</span></em>, <em class="sig-param"><span class="n">inHTMLRenderDef</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inJSONGeneratorDef</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inJSInitGeneratorDef</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebCPUpdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebCPUpdate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Add control panel HTML, JSON generator or JS when page init</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inCPKeyStr</strong> – </p></li>
|
|
|
<li><p><strong>inHTMLRenderDef</strong> – </p></li>
|
|
|
<li><p><strong>inJSONGeneratorDef</strong> – </p></li>
|
|
|
<li><p><strong>inJSInitGeneratorDef</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectDef">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebURLConnectDef</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inMethodStr</span></em>, <em class="sig-param"><span class="n">inURLStr</span></em>, <em class="sig-param"><span class="n">inMatchTypeStr</span></em>, <em class="sig-param"><span class="n">inDef</span></em>, <em class="sig-param"><span class="n">inContentTypeStr</span><span class="o">=</span><span class="default_value">'application/octet-stream'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebURLConnectDef"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectDef" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><blockquote>
|
|
|
<div><dl class="simple">
|
|
|
<dt>Connect URL to DEF</dt><dd><p>“inMethodStr”:”GET|POST”,
|
|
|
“inURLStr”: “/index”, #URL of the request
|
|
|
“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”,
|
|
|
“inContentTypeStr”: “”, #HTTP Content-type
|
|
|
“inDef”: None #Function with str result</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div></blockquote>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inMethodStr</strong> – </p></li>
|
|
|
<li><p><strong>inURLStr</strong> – </p></li>
|
|
|
<li><p><strong>inMatchTypeStr</strong> – </p></li>
|
|
|
<li><p><strong>inDef</strong> – </p></li>
|
|
|
<li><p><strong>inContentTypeStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFile">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebURLConnectFile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inMethodStr</span></em>, <em class="sig-param"><span class="n">inURLStr</span></em>, <em class="sig-param"><span class="n">inMatchTypeStr</span></em>, <em class="sig-param"><span class="n">inFilePathStr</span></em>, <em class="sig-param"><span class="n">inContentTypeStr</span><span class="o">=</span><span class="default_value">'application/octet-stream'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebURLConnectFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFile" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><dl class="simple">
|
|
|
<dt>Connect URL to File</dt><dd><p>“inMethodStr”:”GET|POST”,
|
|
|
“inURLStr”: “/index”, #URL of the request
|
|
|
“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”,
|
|
|
“inFolderPathStr”: “”, #Absolute or relative path</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inMethodStr</strong> – </p></li>
|
|
|
<li><p><strong>inURLStr</strong> – </p></li>
|
|
|
<li><p><strong>inMatchTypeStr</strong> – </p></li>
|
|
|
<li><p><strong>inFilePathStr</strong> – </p></li>
|
|
|
<li><p><strong>inContentTypeStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFolder">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebURLConnectFolder</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inGSettings</span></em>, <em class="sig-param"><span class="n">inMethodStr</span></em>, <em class="sig-param"><span class="n">inURLStr</span></em>, <em class="sig-param"><span class="n">inMatchTypeStr</span></em>, <em class="sig-param"><span class="n">inFolderPathStr</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebURLConnectFolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebURLConnectFolder" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><dl class="simple">
|
|
|
<dt>Connect URL to Folder</dt><dd><p>“inMethodStr”:”GET|POST”,
|
|
|
“inURLStr”: “/Folder/”, #URL of the request
|
|
|
“inMatchTypeStr”: “”, #”BeginWith|Contains|Equal|EqualCase”,
|
|
|
“inFolderPathStr”: “”, #Absolute or relative path</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
<li><p><strong>inMethodStr</strong> – </p></li>
|
|
|
<li><p><strong>inURLStr</strong> – </p></li>
|
|
|
<li><p><strong>inMatchTypeStr</strong> – </p></li>
|
|
|
<li><p><strong>inFolderPathStr</strong> – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebUserInfoGet">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebUserInfoGet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inRequest</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebUserInfoGet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebUserInfoGet" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Return User info about request</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inRequest</strong> – </p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>{“DomainUpperStr”: “”, “UserNameUpperStr”: “”}</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebUserIsSuperToken">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebUserIsSuperToken</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inRequest</span></em>, <em class="sig-param"><span class="n">inGSettings</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebUserIsSuperToken"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebUserIsSuperToken" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Return bool if request is authentificated with supetoken (token which is never expires)</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>inRequest</strong> – </p></li>
|
|
|
<li><p><strong>inGSettings</strong> – Global settings dict (singleton)</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>bool True - is supertoken; False - is not supertoken</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
<dl class="py function">
|
|
|
<dt id="pyOpenRPA.Orchestrator.__Orchestrator__.WebUserUACHierarchyGet">
|
|
|
<code class="sig-prename descclassname">pyOpenRPA.Orchestrator.__Orchestrator__.</code><code class="sig-name descname">WebUserUACHierarchyGet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inRequest</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyOpenRPA/Orchestrator/__Orchestrator__.html#WebUserUACHierarchyGet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyOpenRPA.Orchestrator.__Orchestrator__.WebUserUACHierarchyGet" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Return User UAC Hierarchy DICT Return {…}</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters</dt>
|
|
|
<dd class="field-odd"><p><strong>inRequest</strong> – </p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns</dt>
|
|
|
<dd class="field-even"><p>UAC Dict {}</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
</div>
|
|
|
|
|
|
</article>
|
|
|
<footer>
|
|
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="related-information">
|
|
|
Copyright © 2020, Ivan Maslov
|
|
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
|
|
|
and
|
|
|
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
|
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
|
|
|
|
|
|
<a class="muted-link" href="_sources/index.rst.txt"
|
|
|
rel="nofollow">
|
|
|
Show Source
|
|
|
</a>
|
|
|
</div>
|
|
|
|
|
|
</footer>
|
|
|
</div>
|
|
|
<aside class="toc-drawer">
|
|
|
|
|
|
|
|
|
<div class="toc-sticky toc-scroll">
|
|
|
<div class="toc-title-container">
|
|
|
<span class="toc-title">
|
|
|
Contents
|
|
|
</span>
|
|
|
</div>
|
|
|
<div class="toc-tree-container">
|
|
|
<div class="toc-tree">
|
|
|
<ul>
|
|
|
<li><a class="reference internal" href="#">Welcome to pyOpenRPA’s documentation!</a></li>
|
|
|
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
|
|
<li><a class="reference internal" href="#module-pyOpenRPA.Orchestrator.__Orchestrator__">pyOpenRPA Orchestrator</a></li>
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
</aside>
|
|
|
</main>
|
|
|
</div>
|
|
|
</body>
|
|
|
</html> |
