Introduction to Modules

Use a module to collect information from your end users, implement logic, provide answers, or perform tasks in the background, such as calculations or automatic document creation. Modules can read from or write data to databases, and connect with data views.

When you create a module, you choose one of three types that determines how it is triggered and what it can do:

Input modules are opened by a person in the browser. They support the full range of nodes, input nodes, action nodes, and result nodes. They are the right choice for interactive workflows, forms, and document generation that requires end user answers. If you have built modules in BRYTER before, this is the type you already know.

Processing modules run without a user interface. They are triggered by another module, a data view, or an external system calling the module's API endpoint. Because no one interacts with them directly, processing modules do not support input nodes, handover actions, or redirect result nodes. They can return output values that the calling module or API consumer receives when the module finishes.

Scheduled modules also run without a user interface, but they start automatically on a recurring schedule you configure, hourly, daily, weekly, monthly execution. Use them for recurring reports, data syncs, or background jobs. Like processing modules, they do not support input nodes, handover actions, or redirect result nodes.

Each type has a distinct icon and color so you can recognize them at a glance in the application page: Input (blue form icon ), Processing (pink bolt icon ), Scheduled (orange clock icon ). To learn more, see: Module Types: Input, Processing, and Scheduled.

Create a module in BRYTER

1. To create a new module, open or create an application.

2. Click the + New button. You will see the three module types with short descriptions. Choose the type that matches how the module will be triggered.

   Not sure which type to pick? If a person will open the module and interact with it, choose Input. If it will be called by another module or an external system, choose Processing. If it should run on a recurring schedule, choose Scheduled. You can change the type later from within the editor.

3. Type in a name in the field New module.
4. Click Create. The editor will display where you, as an author, will be able to build modules:

After finishing the first version of the module, publish it (2) to make it accessible in a separate Test environment for internal testing before publishing it in a Live environment to reach your target audience. You can publish a module in multiple languages and change the module's look and feel for the end user by choosing a theme from the theme library.

Rename your module in the bar at the top of your screen (1). In the process of building, switch between the editor and the end user interface with the Preview (3) button.

Build a module with its components

To build a module in the editor, you can use:

• Nodes, to:
  • ask for end user input, e.g., answering a question, uploading a file, etc. (input modules only), or
  • perform a task in the background, e.g., creating a document, calculating, etc.
• Result nodes, either default Results or Redirect Results, to conclude your module and close and log the end user session. (Redirect results are available in Input modules only.)
• Transitions, to connect the different nodes and build paths through your module. Equip your transitions with conditions to make the end users’ path through the module dependent on their answers.

When building modules, you should be aware that:

• Every path through the module must end at a Result node. Otherwise, your end user may receive an error message after the last node.
• When using conditions, exactly one condition must be true at any node and for any combination of end user answers.

Navigate the graph

The graph on the left side of the editor is built automatically as you build your module. Nodes are sorted to optimize visualization. To simplify the graph, you can also group nodes. To zoom in or out, use the + and – icons (4). Return to 100% zoom by clicking the 🔲 icon in between. To view the graph full-screen, collapse the sidebar (5).

Undo, redo, and history

Your module is automatically saved in the background while you build it, so your progress will not be lost. To redo or undo a step, use the arrow icons in the bottom left corner (6). Up to 20 steps can be undone or redone.
You can view or restore earlier versions in the history (7), and manage and name earlier versions there as well.

Detect errors

While building your module, the Quick Check identifies common logical errors and provides warnings. To display these errors and correct them, click on the asterisk icon located on the bottom right (8). Ideally, your module should have no Quick Check errors prior to publishing.

To detect and debug potential errors on the content side of your module, use the Inspect mode to build debug sessions (9). The Inspect mode also enables you to view the module from a specific node in the end-user interface, which is particularly helpful for larger modules. To return to building, click the Build icon (10).

Get context and review content

To display all nodes in a list, click the List View icon located at the top left (11). To search for a term in the name or note of a node, use the search box (12). You can configure languages and end user navigation in the module configuration (13) and provide a module summary by clicking the info icon (14).