Module Generator: Parts of an module

Modules can be customized to fit specific processes and use cases. All modules follow overarching design principles that are consistent across implementations. This article explains the functions and elements that make up a module from a user perspective, and how you can work with them. Understanding these features will help you choose the right configuration.

Overview page

The overview page is divided into three areas:

• Function bar
• Tabs
• Table view of elements within the tabs

Function bar

In the function bar, you can create a new element and fill in a new form instance. Depending on the configuration, you can also create a new template. Learn how to work with templates in Working with templates.

If a task block is configured in the form, an overview of all tasks is provided through the function bar. Via the three-dot menu, you can configure the module directly – if you have the necessary rights. You'll also find access to Module metrics there.

Tabs

The tabs provide you with a filtered view of the elements. This way, you see only the elements that are relevant to you – not all elements from all users across all statuses. Typical tabs are called My requests, Requests pending my approval, or All requests. The tabs only show you elements you're allowed to see – protected elements are not displayed.

If you're a module owner, you'll get an additional tab to view deleted elements. See Restore deleted pages and files for details.

Element table

Each tab displays a table with the created content. The columns in the table vary depending on the module. Depending on the configuration, you'll find a full-text search above the table and one or more filters next to it. These let you quickly search through large amounts of content. At least one column contains a link to the detail view of an element.

Detail view

The detail view of an element (e.g., a request) is divided into three sections:

• Page header with navigation
• Content – the configured form
• Approval workflow

Page header

The page header shows you the page title, current status, creator, author, and date of last modification. In the top right area, you'll find buttons to return to the overview or edit the page – if you have the necessary rights. Via the three-dot menu, you can print the page as a PDF.

Form with content blocks

The form itself is divided into content blocks. These are freely configurable and can be used as many times as needed. Content blocks can be input fields that capture user input or offer options, or they can manage attachments and tasks.

Content blocks are subject to rights management. Depending on the configuration, not all blocks are visible to all users, and editing of individual blocks can be restricted.

To edit the content, click Edit to switch to edit mode.

Approval workflow

With the approval workflow, you move the page through the workflow. A graphical timeline shows you the recent changes and status transitions. The display and function are identical to the approval workflow in the Processes area of Q.wiki.