How to read and work with the Reframe OS documentation

The Mainlevel CONNECT documentation is written in a way that people that are not familiar with the system and similar applications in general, are able to use CONNECT. The easiest way to work and understand CONNECT is to have this documentation open in one browser window and the (customized version of the) CONNECT open in another browser window.

Throughout the documentation, the following recurring elements are used:

Paths

ABC→DEF→GHI

Paths and links with → indicate directions to certain parts of CONNECT, usually departing from the entry page.

Steps

1. XXX

2. ZZZ

3. YYY

The CONNECT documentation pages are arranged according to the chronological steps with ascending numbering. By following these steps, you can set up the relevant configuration within CONNECT.

Info-Panels

Screenshots

Screenshots show a preview of the actual Reframe OS (in configuration mode or in end user mode) and/or indicate where to find particular elements and buttons on the page for configuration. Typically, the relevant elements are marked with red boxes on the screenshot.

Tables

Within tables, all customizing options of certain Reframe OS pages are explained. In particular, the customizing of all fields within dialogue forms of Reframe OS is explained in detail. Rows starting with “→“ represent dropdown menus and list all options available within the menu (respective field given in line above).

Key terms and definitions

All terms and definitions relevant for the Reframe OS are listed in the Glossary.

Functionalites of Mainlevel Reframe OS

This section gives a brief overview on the functionalities of Reframe OS and how customized versions of Reframe OS are applied in reality. Given the high flexibility and customizability of Reframe OS, all possible use cases of Reframe OS cannot be listed here. Typical functionalities are:

• Monitoring: Project activities at various detail levels can be monitored and the achievement of indicators can be measured and stored. Reframe OS represents a repository for project activities and/or serves as a tool for M&E processes.

• Surveys: Reframe OS allows the collection of data from a high number of respondents, which makes it an easy-to-use tool for online surveys.

• Information sharing: The role and permission scheme of Reframe OS is highly adaptable and allows for a granular endowment of rights according to user groups, roles or permissions. Thereby, information storage and sharing is a key funtionality of a Reframe OS application.

• Data analyses: The user-friendly interface and the capacity of storing, calculating and illustrating data in various ways enable the users to conduct data analyses within Reframe OS applications.

Typically, many of these abstract functionalities listed above are combined and customized for the specific needs of the client.

Typical user roles

The following user roles typically appear in Reframe OS applications.

• Viewer (‘Users with the viewer role can see everything’)

• Reporter (‘Users with the reporter role can submit new submissions for data collections’)

• Approver (‘An approver is allowed to approve and archive submitted submissions’)

• Manager (‘Users with the manager role can see, edit and approve all data submissions. They can also create indicator updates’)

• Admin (‘Users with the admin role are able to create, edit and delete everything’)

The Admin role is usually the one that allows for setting up a Reframe OS application. This is why many of the steps described in the documentation are only possible with the respective permissions. However, certain functions and configurations decribed can be executed also with the Viewer, Reporter, Approver and Manager role.

Typical process for setting up a customized Reframe OS

1. A typical process for setting up and customizing a Reframe OS application starts with a specific use case that requires IT-enabled methods of data collection.

2. Based on the used case, requirements for the system are derived and specifications are set up.

3. Customizing CONNECT is an iterative process with many feedback loops between the client and the configurators or administrators of the system.

4. At a certain point, the system allows for the collection of data - Reframe OScan be used.

5. While collecting data, new and unforeseen conditions may occur, which necessitate the (re-)configuration of certain aspects. This is why, again, feedback loops are often necessary between the client and the configurators or administrators.