Chapter 2. User interface

Table of Contents

Dashboard
Configurations
Build queues
Find builds
Manage groups
Manage users
Manage subscriptions

This chapter explains some typical user interface pages in QuickBuild application.

Dashboard

Dashboard is the first page of QuickBuild user interface. It gives an overview of all configurations and its build status. From this page, you can do most of your daily jobs, such as start/stop builds, monitor build status, access build logs, etc. Here is the screenshot of the dashboard page followed by the explanation of the function areas (indexed by number):

  1. Main navigation area

    From this area, user can navigate to different function areas of QuickBuild:

    DASHBOARD

    Navigate to this page.

    CONFIGURATIONS

    Navigate to configuration details.

    BUILD QUEUES

    Navigate to build queue details.

    FIND BUILDS

    Navigate to builds search page.

    ADMINISTRATION

    Navigate to administrative pages.

  2. Configuration name

    Displays configuration name. Detail information of the configuration will be displayed when you click on the configuration link.

  3. Open/Close button

    Click on the button to open or close a particular configuration node.

  4. Queued builds

    Number of queued builds for the configuration. When you click on this link, detail information about the queue bound to the current configuration will be displayed.

  5. History builds

    Number of history builds for the configuration. When you click on this link, the detail information about the history builds will be displayed.

  6. Build status indicator

    Build status indicator for the latest build of the current configuration. GREEN icon means a successful build, RED icon means a failed build, while a RUNNING GEAR icon means a running build. Build log of this build will be displayed, when you click on the status indicator icon.

  7. Latest build

    Latest build of the current configuration. Build detail will be displayed when you click on the build version link.

  8. Configuration status indicator

    Configuration status indicator GREEN means that most recent execution of the current configuration has been successful, RED means that most recent execution of the current configuration has failed, while a RUNNING GEAR means that the configuration is currently running. Configuration log of this build will be displayed when you click on this status indicator icon.

    [Note]Note

    The configuration status is different from the build status. The configuration status means execution status of a configuration, while build status means status of the build process. When a configuration has been triggered and it is being executed, it may fail to generate new build (for instance, error occurs when the next build version is calculated). This will result in a failed configuration execution. On the other hand, a new build can be generated and executed, but the build process fails for some reason (for instance, a compilation error). This will result in a failed build, but execution of the configuration is still successful, because this configuration has been successfully triggered and executed regardless of the actual build status. Information about the build process will be logged into the build log, and information about triggering and execution of the configuration (such as checking the build necessary condition, calculating the next build version, etc.) will be logged into the configuration log.

  9. Start/Stop icon

    You can manually trigger the execution of the configuration by clicking on this button. When a configuration is running, the Stop icon will be displayed that can be used to forcibly stop the execution of the current configuration.

    [Note]Note

    When you click on the Start/Stop button, and do not see any changes on the page, just try to refresh the page after a while.

    [Note]Note

    For particular configuration, if there is more than one triggering instance waiting in the build queue, stopping the configuration will only stop and remove the current triggering instance, which will cause the next waiting triggering instance to be executed. If you want to stop and remove all triggering instances, just go to the detail page of the build queue, and remove all waiting and running triggering instances.

    [Warning]Warning

    The stop action interrupts all threads involved in the currently running configuration. Normally it also kills all external OS processes created by your builder (for example, Ant builder will spawn a Java process to run build script). However on Windows platform, if your builder is executed by using a Windows batch file, processes created in that batch file will not be killed. In this case, you should kill these processes manually, otherwise when you stop a configuration and run it again, you may encounter errors stating that checkouts directory can not be deleted, which normally means the spawned OS process is still running and it is accessing that directory. This is also true for QuickBuild's Ant and Maven builder (executed by ant.bat and maven.bat) on Windows platform.

  10. Auto refresh switch

    You can turn on auto-refresh by clicking on ON/OFF link. By setting the auto refresh switch on, the page will be periodically refreshed, which helps with monitoring of the build status.

  11. Quick search

    You can search builds by entering partial name of a build version and pressing the RETURN key.

  12. From the admin area, you can change your profile, password, access system log, or access system help.

    [Note]Note

    System log is only available to administrator.

  13. Schedule setting

    View or edit schedule setting for the current configuration.