Skip to content

Latest commit

 

History

History
220 lines (142 loc) · 9.12 KB

README.md

File metadata and controls

220 lines (142 loc) · 9.12 KB

LiberRPA Flowchart

(If you can't see the images in the document, have a look on GitHub.)

This extension is a part of LiberRPA to manage the overall flow of an RPA project, including project arguments and settings.

1740302097535

The project.flow file (in JSON format) contains:

  • Flowchart information(nodes and lines)
  • Project setting
  • Build-in project arguments
  • Custom project arguments

Since LiberRPA Flowchart is actually a VS Code custom editor, so you can open the project.flow with another editor and take advantage of VS Code Timeline:

1740311326677

Usage

Set File Icon(optional)

  1. Press Ctrl+Shift+P to open the Command Palette.
  2. Execute the command Preferences: File Icon Theme
  3. Select VSCode Great Icons with LiberRPA Flowchart File

This ensure that .flow files can display the correct icon.

Note: This is purely a UI enhancement, the project will work correctly even if you skip this step.

Manage Nodes and Lines

When you click or hover a node, four anchors appear.

Drag an anchor to another node to create a new line.

Ensure that the line follow the Link Rules.

17403106301131740310650278174031066839117403106932591740310706782

Start Node

  • Purpose: The unique Start node initiates the entire project. It can't be deleted.
  • Execution: Click the ⊳ icon within the Start node to execute the whole project in a Python MainProcess .

SubStart Node

  • Create: Drag a SubStart node from Node Panel into the middle area. This creates a new subprocess when the project executes.
  • Error Handling: If a subprocess encounters an uncaught exception, it will exit without affecting the MainProcess.
  • Configuration: Click the SubStart node to open Node Info panel where you can modify its description. 1740303373902

Block Node

  • Create: Drag a Block node from Node Panel into the middle area, then update its description and set the corresponding Python file path. 1740304044081

  • Python File Path Rules:

    • Must be a relative path to a .py file.

    • The filename may only contain only:

      • English letters (a-z, A-Z)
      • Numbers (0-9) (but cannot start with a number)
      • Underscores(_)

    • Use "/" as the folder separator.

    • The "./" prefix is optional.

    • Avoid using LiberRPA built-in module names: ["Mouse", "Keyboard", "Window", "UiInterface", "Browser", "Excel", "Outlook", "Application", "Database", "Data", "Str", "List", "Dict", "Regex", "Math", "Time", "File", "OCR", "Web", "Mail", "FTP", "Clipboard", "System", "Credential", "ScreenPrint", "Dialog"]

The Python file must have a main function because when you clicking ⊳ in the Start node to execute the whole project, LiberRPA will run the main function in each Block node's Python file.

  • File Creation: Click 1740304294046 in a Block node to open the corresponding Python file, If the file does not exist, LiberRPA will create it and add a default script.

  • Execution: Click ⊳ in a Block node to Execute the corresponding Python file.

  • Connection Nodes: Drag from a Block node to create either a Common-line(default) or an Exception-line (if a Common-line exists).

    • When the whole project executing, if the Block node's Python script runs successfully, LiberRPA follows the Common-line.
    • If an uncaught exception occurs, it follows the Exception-line. The exception will be stored in a global object PrjArgs.errorObj, see more detail.
    • If neither lines is connected, an End node is executed automatically. 1740304582323

Choose Node

  • Create: Drag to create a Choose node and Modify it description and condition. The condition will be evaluated using eval().

    • When referring values in Custom Project Argument, use CustomArgs["valueName"]. 1740306458764

  • Connection Nodes: Drag from a Choose node to create either a True-line(default) or a False-line (if a True-line exists).

    • When the whole project executing, if the condition is evaluated to True, the True-line is followed.
    • Otherwise, the False-line is used.
    • If neither lines is connected, an End node is executed automatically. 1740306549704

End Node

  • Purpose: Connecting any node to an End node will terminate the process when executing the whole project.

  • Behavior:

    • For a MainProcess , the entire program exits.
    • If a node has no connected next node, LiberRPA will automatically execute an End node.

Link Rules

LiberRPA will check the rules when you attempt to create a new line.

If a rule is broken, an alert will appear.

  • Nodes cannot link to a Start or SubStart node.
  • A node cannot link to itself.
  • Cannot create a connection from the same source anchor to the same target anchor.
  • The next node of Start or SubStart node can only be a Block or Choose node.
  • Start and SubStart node can only have one outgoing line.
  • An End node cannot have outgoing lines.
  • A Block node can have up to 2 outgoing lines(Common-line and Exception-line).
  • A Choose node can have up to 2 outgoing lines(True-line and False-line).

Shortcuts for Node

Shortcut Action
Ctrl+C Copy the selected node
Ctrl+V Paste the copied node
Ctrl+Z Undo
Ctrl+Y Redo
Backspace Delete the selected node
Delete Delete the selected node

Setting

Execute Mode

Execute the whole project or a Block node in Debug or Run mode.

1740306998909

1740307008099

Log Level

LiberRPA sets the log level (using Log.set_level()) according to the configuration when a project or Block node starts.

1740307077172

Record Video

You can enable it to save an execution video(video_record.mkv) in the corresponding log folder.

The functionality relies on LiberRPA Local Server.

1740307313698

LiberRPA Local Server will also create a subtitle(video_record.srt) file for the video, generated automatically from human_read_MainProcess.log.

1740307426364

For log folder path configuration, see Configuration.

Stop Shortcut

If enable, when the whole project is running (not applicable for a single Block node), you can press Ctrl+F12 to stop it forcibly.

1740308423164

Highlight UI

If enable, LiberRPA will briefly highlight the target elements before manipulating them.

It applies to most functions within the modules Mouse, Keyboard, Window, and UiInterface.

1740308644288

Custom Project Arguments

You can define project arguments in Custom Project Arguments area.

1740309307537

When editing a Python script, typing CustomArgs, CustomArgs[ or CustomArgs[" will prompty an IntelliSense list showing the available arguments.

1740309273810

1740309284626

1740309294818

Note:

There is an issue now, the values in Custom Project Arguments will not appear when you first type CustomArgs.

Anyway, use CustomArgs[ and CustomArgs[" will be better.

Resize

Adjust the width of the right panels by dragging the divider.

This allows for wider input boxes so that you can view more content.

If you need to edit extensive content, it may be more convenient to edit it elsewhere and then paste it here.

resize

Known Issues

  • Drag a node from Node Panel may occasionally fail, please try again.
  • Text in a node and inputbox can't display optimally if it is not very short, due to the nodes and inputboxes all have a limited width.
  • The values in Custom Project Arguments will not appear when you first type CustomArgs in a Python script.
  • Shortcuts for node often unresponsive.