Articles in this section
Category / Section

Project Editor

Published:
2 mins read

Project Editor is the development tool to write authentication flows. It has a low-code editor that can be used to drag and drop the code blocks, and the actual Agama code gets generated in the background. Major components of the Project Editor are noted below:

agama-Project-Editor.png

  1. Project explorer: The left-hand panel displays all the artifacts in the project in a structured view.
  2. Flow editor: The right-hand side panel is the low-code editor used to design the flow using different flow components like assignment, log, RRF, trigger, etc.
  3. Path of the artifact being edited.
  4. Test deployment button.
  5. Save the modifications to the project in the GitHub repository.
  6. Generate Agama code from the flow in the flow editor.
  7. Export: Exports a zip archive containing the .flow code file and .json configuration file for the flow.
  8. Import: Allows importing an existing flow.
  9. Clear: Removes all the flow components from the current flow. This operation is irreversible.
  10. Notes: Add sticky note-style annotations to the flow to highlight different areas and flow components for better understanding of the flow.

Working With The Flow Editor

When a flow (aka a .flow file) is opened using the left navigation, the project editor presents a visual rendering of the flow using the flow editor. You can add nodes, remove nodes, and edit configuration values of the nodes using the flow editor.

Creating A Node

A new node can be created from an existing node. Drag the colored dot at the edge of an existing node. Releasing the mouse button will present a pop-up menu. You can choose what type of next node you want to create.

Node Context Menu

Click on the node to open the node context menu as shown below. Use the node context menu to edit the node configuration, delete the node, or open the flow related to the node.

agama-Node-Context-Menu.png

Non-linear Flow

Nodes like the When node have multiple possible next nodes based on conditions evaluating to True or False. You can define these alternative execution paths by dragging colored dots on each vertex.

agama-non-linear-flow.png

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Access denied
Access denied