Module Generator: Recommendations for creating a Module

Modified on Thu, 2 Apr at 4:21 PM

Getting started with module creation in the Module Generator is straightforward: automated checks and test mode support you throughout the process. For more complex modules, we recommend modeling the associated process beforehand.

Configuration happens in several steps, and you can switch between configuration masks at any time to make adjustments.

Step 1: Configure Data and Views

Start with the Data and Views tab. Here you create the basic content blocks – the building blocks of your form. Then populate the corresponding fields. You can skip access restrictions at the block level for now and add them later.

Step 2: Define the Workflow

After drafting your form design, go to the Workflow tab. Create the necessary statuses and connect them with transitions. For now, you can skip restricting editing rights – you'll configure those later.

Step 3: Set Up Overview and Display

In the Overview tab, create the tabs for your module and configure them. Then populate the table and filters.

Step 4: Configure Access Restrictions and Details

Most of your module is now configured. It's time to set up editing and viewing permissions for statuses, transitions, and content blocks.

Important: Generally, you should keep Q.wiki open and accessible to all users. Only activate access restrictions at the block level or globally under Overview > Basis when dealing with sensitive data that requires special protection.

Under Overview > Basis, customize the texts and configure any other necessary settings.

Step 5: Test and Finalize

Check for configuration errors and potential issues. Then we recommend running a test run and walking through your intended usage scenario.

Multiple Iterations Are Normal

It's completely normal to switch between configuration masks multiple times and run through test mode several times before your module is ready. During this exploration phase, you can try different configurations and undo changes without affecting the final module.

If you encounter difficulties or the module becomes too complex, the consultants at Modell Aachen GmbH are happy to support you.