With the release of Rich Portal 4.3 the Backbase Portal framework is available as a Maven archetype. This posting describes the procedure to create a Rich Portal Blank Maven project using the backbase-portal-archetype-blank archetype.

NOTE—to run any Rich Portal project requires a license. To request a trial license, please visit the Rich Portal Product Page.

Pre-requisites

To create a Rich Portal Maven project, the following preliminary tasks are necessary:

  • Maven needs to be installed. The procedure begins with downloading the Maven 2.2.1 binaries, as follows:
    1. Download the Maven 2.2.1 binaries from Apache Maven Downloads.
    2. Extract the archive (ZIP or TAR file depending on operating system) to the installation directory of your choice.
    3. Define an M2_HOME environment variable that points to the Maven install directory and add the path to its binaries to the PATH environment variable.
  • Maven needs to be configured to use the Backbase Artifactory. The procedure involves customizing the Maven settings.xml file, as follows:
    1. Locate the directory used by Maven to store downloaded dependencies. For example, on Microsoft Windows
      systems the default location is C:\Documents and Settings\YourWindowsUserName\.m2, while on Unix
      systems it is ~/.m2/.

      NOTE—the .m2 folder is created on the first occasion Maven is run. If Maven has not yet been run, the .m2 folder can be created manually.
    2. In the .m2 folder, create a settings.xml file with the following content:

      <settings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns="http://maven.apache.org/SETTINGS/1.0.0"
      xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0"
      "http://maven.apache.org/xsd/settings-1.0.0.xsd">
      <profiles>
      <profile>
      <id>backbase</id>
      <activation>
      <activeByDefault>true</activeByDefault>
      </activation>
      <repositories>
      <repository>
      <id>Backbase Artifact Repository</id>
      <url>https://artifactory.backbase.com/repo</url>
      </repository>
      </repositories>
      <pluginRepositories>
      <pluginRepository>
      <id>Backbase Artifact Repository</id>
      <url>https://artifactory.backbase.com/repo</url>
      </pluginRepository>
      </pluginRepositories>
      <properties>
      <downloadSources>true</downloadSources>
      <downloadJavadocs>true</downloadJavadocs>
      </properties>
      </profile>
      </profiles>
      </settings>

Creating the Rich Portal Blank Maven Project

The Rich Portal Blank Maven project is intended as the starting point for any new Rich Portal project. It is created as follows:

  1. At the command line, change to the location where the Rich Portal Blank Maven project should be created and run the following command:
    mvn archetype:generate -DarchetypeArtifactId=backbase-portal-archetype-blank -DarchetypeGroupId=com.backbase -DarchetypeVersion=4.3.0
  2. In response to a series of command line prompts, set the following arguments:
    • groupId—a fully-qualified package name identifying the organization, such as my.company.com.
    • artifactId—an identifier for the Rich Portal project, such as mycompany-portal. This setting defines the name of the folder in which the project is created.
    • version—defines the version of the Rich Portal project. The default value is 1.0-SNAPSHOT.
    • package—a fully qualified package name identifying the package, such as my.company.com. This setting defaults to the value of groupId.
  3. Finally, confirm the settings.

This procedure creates a Rich Portal Blank Maven project in the folder defined by artifactId. By following a similar procedure to the one described here but using the backbase-portal-archetype-example archetype, a Rich Portal Example Maven project can be created that demonstrates some of the features typical of a production application.