Skip to content

Control Application

David Maxwell edited this page Mar 25, 2021 · 5 revisions

How to Use the LogUI Server Control Application

How do you use the LogUI server control application? What can you do with it? If you have a question like this, this is the page for you!

About the Control Application

The LogUI server control application lets you control various aspects of the LogUI server. Examples include being able to control what applications can be tracked from your server instance, or downloading the interaction log data for post-hoc analysis.

You can accesss the LogUI server control application at the location where your LogUI server Docker containers have been instantiated. The containers provide both a HTTP server (for serving the control server application), and a WebSocket server (for handling any clients where interactions are to be logged).

The Basic Interface

The basic LogUI server control application interface is shown below. There are six notable areas that form the interface.

Overview of the Control Application interface

  • The largest is the main pane, which presents the page you have selected. In this example, the Applications component is displaying a list of applications created on this instance of LogUI server.
  • Above the main pane are the breadcrumbs. The breadcrumbs provide you with a series of handy links that allow you to easily navigate through the control application's interface.
  • Components of the interface are listed down the left of the interface. While there are only two at present (Applications and Settings), more will be implemented over time.
  • For each component that is clicked, a component menu will appear to the right. This provides a series of handy links for the component that has been selected. For this example, the Applications component has been selected.
  • At the bottom of the page, the About LogUI link is presented — this presents information on LogUI, along with a reference for citing LogUI in your work!
  • The User Management component is shown at the bottom left. The icon is dark when the user is not logged in; it turns green when a user has been authenticated with the LogUI server.

Components

The LogUI server interface provides a series of components that lets you change how the server works, control user accounts, or determine what applications and flights are to be tracked. Click on a link below to learn more about each component — and what you can do with them.

  • Application Management is the most important component in LogUI server. It allows you to view and create applications, flights, and sessions. In addition, you can obtain the authentication token for your individual flights.
  • Settings will provide the option to tweak settings pertaining to the LogUI server as a whole. This component is currently unavailable and is in development.
  • User Management provides options on the management of user accounts — such as logging in and out, the creation of accounts, and more.

Additional components will be added over time. For example, we are planning on developing a data analysis component that will allow you to obtain summary statistics from an easy-to-use GUI.

Clone this wiki locally