Allegra Integrations

Allegra Integrations#

Overview#

You can integrate other web-based applications with Allegra so that you can can switch between them using the Allegra menu bar. The following applications are currently supported directly:

  • Jenkins Continuous Integration Server (https://www.jenkins.org/). Jenkins is very useful if you are developing software.

  • SonarQube, a quality improvement tool for software development. Integrated debugging and code coverage tools help you to avoid bugs early in the development lifecycle and generate code that is robust and easy to maintain (https://www.sonarqube.org/).

  • ViewVC, a browser for Subversion repositories. You can link Allegra objects to Subversion repositories and go directly from an item to the corresponding revision or file. Allegra even puts some access control on top of ViewVC, so that users can only see repositories for which they have an Allegra permission (https://www.viewvc.org/).

  • WebSVN, another browser for Subversion repositories. Here you can also link Allegra objects to Subversion repositories and go directly from an item to the corresponding revision or file. Allegra puts some access control on top of WebSVN so that users can only see repositories for which they have Allegra permissions (<>). (https://www.websvn.info/).

There is more software that Allegra can work with:

  • LaTeX for creating beautiful reports (https://www.miktex.org/).

  • Eclipse Mylyn to work with Allegra directly from Eclipse.

  • JasperSoft Studio to create report templates

Install Portal Plug-In#

To integrate other web-based applications with Allegra, download the Portals plug-in from our website. The file is called portals-x.y.z.tpx. Then proceed as follows:

  1. Copy portals-x.y.z.tpx to ALLEGRA_HOME/plugins und restart the server.

  2. In ALLEGRA_HOME/plugins/portals-x.y.z there is a file trackplus-plugin.xml.

It looks like this:

<trackplus-plugin id="trackplus.plugin" name="PortalPlugin">
     <plugin-info>
             <description>Portal plug-in</description>
             <version>5.0</version>
             <application-version min="5.0" max="10.0"/>
             <vendor name="Steinbeis - Trackplus" url="https://www.trackplus.com"/>
    </plugin-info>

    <!--  ${SERVER} will be replaced by the Allegra server base URL  -->
    <!--  including the protocol. You can also use a fixed URL like -->
    <!--  https://www.yourdomain.com                                -->

    <module id="jenkins"
            name="Jenkins"
            iconCls="jenkinsApp"
            useHeader="true"
            description="Jenkins integration"
            url="${SERVER}/jenkins"/>

    <module id="websvn"
            name="Subversion"
            iconCls="websvnApp"
            useHeader="true"
            description="Subversion repository browser"
            url="${SERVER}/websvn"/>

    <module id="sonar"
            name="Sonar"
            iconCls="sonarApp"
            useHeader="true"
            description="SonarCube Quality Assurance"
            url="${SERVER}/sonar"/>
</trackplus-plugin>

Edit this file according to your installation. Make sure that you you use the same protocol (https) on all servers. For some applications, refer to the notes in the specific sections sections below.

Jenkins#

For Jenkins, it is best to use the same usernames on Jenkins and on the Allegra server. The integration works best with a single sign on system.

WebSVN#

Allegra invokes WebSVN to display linked revisions and files directly from the cockpit or from tasks. To enable this behavior you need to patch WebSVN. In the directory ALLEGRA_HOME/plugins/portals-x.y.z there is a file config.php. On a Debian or Ubuntu Linux server copy this file to /etc/default/websvn.

SonarQube#

For SonarQube, it is best to use the same usernames on SonarQube and on the Allegra server. The integration works best with a single sign on system.

Contents