Module Generator: Create your own module with the module Generator

This article guides you through creating and configuring a module using "Complaint Process" as an example. You can find further inspiration and best practices on our website: Q.wiki Modules (external).

Creating your own module

Create an empty configuration

An empty configuration initially contains no configuration parameters. Follow these steps:

1. Open Module Management from the tool menu
2. Click New Configuration
3. Select Empty Configuration and click Create Module
4. On the page that opens, click Begin Configuration

Create data fields

With data fields, you configure the content that your module will display.

• In the Data and Views tab, create a First Content Block
• The dialog that appears offers you the following components:
  • Data Fields 1 / 2 / 3-column: Fields for core information in a one-, two-, or three-column layout. You configure:
    • The Section Name – the heading under which additional fields are added
    • Additional Fields with Name and Type
  • Large Text Field: For longer descriptions; can be created once per module
  • Task Management: For creating tasks related to the process
  • Attachments: For uploading file attachments
  • Links to Processes and Modules: For linking processes and modules from Q.wiki

Configure workflow

In the workflow, you define the process flow: which statuses exist and what transitions are possible between statuses.

• In the Workflow tab, create statuses with + Add Status
• In each status, add transitions with + Add Transition:
  • A transition connects two statuses and describes the action between them
  • A status can have multiple transitions leading to different statuses
• In the transition dialog, you configure:
  • The Target Status
  • A meaningful name for the action in the Name field
  • Authorized user groups and notification groups (these can be added after you've defined roles – see Define Roles)
  • Click Add Transition to apply your settings
  • The diagram on the right side updates automatically

Configure overview

In the Overview tab, you customize the module's initial view.

• In the Basis section, make basic settings:
  • Overview Page Name – displayed as the page name in the main window
  • Module Name – the name shown in the left navigation bar
  • Button Text – the text on the button for creating new processes
  • Title Composition of Module Content – defines the display name of a created process
• In the Tabs section, add tabs to the initial view. You can name them and restrict their visibility
• In the Table section, define how tables are displayed in the tabs:
  • The structure remains the same across all tabs
  • Create columns with + New Column, which are based on fields from Data and Views
• In the Filter section, create filters for content – recommended for modules with many processes

Define roles

By adding roles, you define which user can perform which transitions and edit which statuses.

• In the Roles section, add roles and assign users or groups to them:
  • Only these users have access to their assigned actions (see Workflow)
  • After defining roles, you can assign them in the workflow

Test configuration and create module

After completing the required configuration, you can test your module by creating processes, running through workflows, and checking the views.

• Save the module using the arrow next to Test Configuration
• To edit the module later, use Module Management
• With Test Configuration > Check Configuration, the workflow and other module parameters are validated. You'll receive notifications if a configuration is questionable or incorrect
• With Test Configuration > Continue, a new browser tab opens where the module runs:
  • Here you perform full functional tests of the module
  • All data entered will be lost after closing the tab
• Using the arrow next to Test Configuration > Create Module creates the module permanently