From c989a55b1cdccee9112f7397e1c3014613192dd9 Mon Sep 17 00:00:00 2001 From: Ivan Maslov Date: Sun, 9 Jan 2022 10:55:08 +0300 Subject: [PATCH] Add info about managers in sphinx --- .../Orchestrator/06_Defs Managers.rst | 52 + .../Orchestrator/Managers/Process.py | 26 +- Wiki/ENG_Guide/html/01_HowToInstall.html | 1 + Wiki/ENG_Guide/html/02_RoadMap.html | 1 + .../html/03_Copyrights_Contacts.html | 1 + Wiki/ENG_Guide/html/Agent/02_Defs.html | 5 +- .../html/Orchestrator/01_Orchestrator.html | 1 + Wiki/ENG_Guide/html/Orchestrator/02_Defs.html | 674 +++++-- .../Orchestrator/03_gSettingsTemplate.html | 60 +- .../html/Orchestrator/04_HowToUse.html | 43 +- Wiki/ENG_Guide/html/Orchestrator/05_UAC.html | 5 +- .../html/Orchestrator/06_Defs Managers.html | 1628 +++++++++++++++++ Wiki/ENG_Guide/html/Robot/01_Robot.html | 1 + Wiki/ENG_Guide/html/Robot/02_Defs.html | 1 + Wiki/ENG_Guide/html/Robot/03_HowToUse.html | 1 + .../ENG_Guide/html/Robot/04_Dependencies.html | 1 + Wiki/ENG_Guide/html/Studio/01_Studio.html | 1 + Wiki/ENG_Guide/html/Studio/02_HowToUse.html | 1 + Wiki/ENG_Guide/html/_modules/index.html | 3 + .../_modules/pyOpenRPA/Agent/__Agent__.html | 1 + .../Orchestrator/Managers/ControlPanel.html | 571 ++++++ .../Orchestrator/Managers/Process.html | 567 ++++++ .../pyOpenRPA/Orchestrator/Web/Basic.html | 1 + .../Orchestrator/__Orchestrator__.html | 542 +++++- .../_modules/pyOpenRPA/Robot/UIDesktop.html | 1 + .../_sources/Orchestrator/02_Defs.rst.txt | 4 + .../Orchestrator/06_Defs Managers.rst.txt | 52 + Wiki/ENG_Guide/html/genindex.html | 164 +- Wiki/ENG_Guide/html/index.html | 9 + Wiki/ENG_Guide/html/objects.inv | Bin 1507 -> 2012 bytes Wiki/ENG_Guide/html/py-modindex.html | 11 + Wiki/ENG_Guide/html/search.html | 1 + Wiki/ENG_Guide/html/searchindex.js | 2 +- .../markdown/Orchestrator/02_Defs.md | 922 +++++++--- .../Orchestrator/03_gSettingsTemplate.md | 59 +- .../markdown/Orchestrator/04_HowToUse.md | 42 +- .../markdown/Orchestrator/06_Defs Managers.md | 1555 ++++++++++++++++ Wiki/ENG_Guide/markdown/Robot/02_Defs.md | 42 +- Wiki/ENG_Guide/markdown/index.md | 18 + 39 files changed, 6429 insertions(+), 641 deletions(-) create mode 100644 Sources/GuideSphinx/Orchestrator/06_Defs Managers.rst create mode 100644 Wiki/ENG_Guide/html/Orchestrator/06_Defs Managers.html create mode 100644 Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/ControlPanel.html create mode 100644 Wiki/ENG_Guide/html/_modules/pyOpenRPA/Orchestrator/Managers/Process.html create mode 100644 Wiki/ENG_Guide/html/_sources/Orchestrator/06_Defs Managers.rst.txt create mode 100644 Wiki/ENG_Guide/markdown/Orchestrator/06_Defs Managers.md diff --git a/Sources/GuideSphinx/Orchestrator/06_Defs Managers.rst b/Sources/GuideSphinx/Orchestrator/06_Defs Managers.rst new file mode 100644 index 00000000..060b8528 --- /dev/null +++ b/Sources/GuideSphinx/Orchestrator/06_Defs Managers.rst @@ -0,0 +1,52 @@ +#################################### +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/Sources/pyOpenRPA/Orchestrator/Managers/Process.py b/Sources/pyOpenRPA/Orchestrator/Managers/Process.py index 2e06c386..e1845b2a 100644 --- a/Sources/pyOpenRPA/Orchestrator/Managers/Process.py +++ b/Sources/pyOpenRPA/Orchestrator/Managers/Process.py @@ -35,6 +35,7 @@ class Process(): __Orchestrator__.GSettingsGet()["ManagersProcessDict"][(inAgentHostNameStr.upper(), inAgentUserNameStr.upper(), inProcessNameWOExeStr.upper())]=self lActivityDict = __Orchestrator__.ProcessorActivityItemCreate(inDef=self.StatusCheck,inArgList=[]) __Orchestrator__.ProcessorActivityItemAppend(inActivityItemDict=lActivityDict) + 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): @@ -46,9 +47,7 @@ class Process(): 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: - lL = __Orchestrator__.OrchestratorLoggerGet() - lL.info(f"Managers.Process: {self.mProcessNameWOExeStr} change status to {self.mStatusStr})") + if lLogBool == True: self.StatusChangeLog() return self.mStatusStr def Start(self, inIsManualBool = True) -> str: @@ -75,8 +74,7 @@ class Process(): else: self.mStatusStr = "4_STARTED" # Log info about process - lL = __Orchestrator__.OrchestratorLoggerGet() - lL.info(f"Managers.Process: {self.mProcessNameWOExeStr} change status to {self.mStatusStr})") + self.StatusChangeLog() return self.mStatusStr def StopSafe(self, inIsManualBool = True) -> str: @@ -110,8 +108,7 @@ class Process(): else: self.mStatusStr = "0_STOPPED" # Log info about process - lL = __Orchestrator__.OrchestratorLoggerGet() - lL.info(f"Managers.Process: {self.mProcessNameWOExeStr} change status to {self.mStatusStr})") + self.StatusChangeLog() return self.mStatusStr def RestartSafe(self, inIsManualBool = True): @@ -134,6 +131,17 @@ class Process(): """ pass + 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})") + + def StatusCheck(self): """ Check if process is alive. The def will save the manual flag is exists. @@ -154,9 +162,7 @@ class Process(): 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: - lL = __Orchestrator__.OrchestratorLoggerGet() - lL.info(f"Managers.Process: {self.mProcessNameWOExeStr} change status to {self.mStatusStr})") + if lLogBool == True: self.StatusChangeLog() return self.mStatusStr def StatusCheckStart(self): """ diff --git a/Wiki/ENG_Guide/html/01_HowToInstall.html b/Wiki/ENG_Guide/html/01_HowToInstall.html index d8024268..ba6e0828 100644 --- a/Wiki/ENG_Guide/html/01_HowToInstall.html +++ b/Wiki/ENG_Guide/html/01_HowToInstall.html @@ -115,6 +115,7 @@
  • 3. gSettings Template
  • 4. How to use
  • 5. UAC - User Access Control
    • +
  • 6. Defs Managers

    • AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT

    AGENT