abhishek1235/archetypes

A collection of Backbase related Maven archetypes.

#Archetypes

Overview

A collection of Maven archetypes for Backbase CXP created by Expert Services that can help help with initial project setup and various project customizations.

Version 5.5.1.4

Archetypes are deployed to Backbase Expert Services' Maven repository at

1. PUBLIC RELEASES https://repo.backbase.com/extensions
2. INTERNAL RELEASES https://artifacts.backbase.com/backbase-ps-releases
3. INTERNAL SNAPSHOTS https://artifacts.backbase.com/backbase-ps-snapshots

##List of currently available archetypes:

1. backbase-all-in-one-archetype, from version 5.3.1.1 [DEPRECATED]
2. backbase-all-in-one-launchpad-archetype, from version 5.4.1.3 [DEPRECATED]
3. backbase-contentservices-archetype, from version 5.4.0.5 [DEPRECATED]
4. backbase-es-project-archetype, from version 5.5.0.0
5. backbase-launchpad-archetype, from version 5.5.0.0 [DEPRECATED]
6. backbase-mashupservices-archetype, from version 5.4.0.6 [DEPRECATED]
7. backbase-orchestrator-archetype, from version 5.4.2.2 [DEPRECATED]
8. backbase-portalserver-archetype, from version 5.4.1.3 [DEPRECATED]
9. backbase-services-archetype, from version 5.5.0.0 [DEPRECATED]
10. backbase-targeting-archetype, from version 5.4.2.2 [DEPRECATED]
11. backbase-forms-archetype, from version 5.5.1.0

##Important Notes

1. We have separated aggregator and parent POMs since 5.5.0.0 so make sure to understand this before making any changes to archetypes. Purpose of this was to separate lifecycle for each archetype if needed and to make sure Maven site plugin works correctly by aggregating reports from all modules.
2. From version 5.5.0.0 we're using JDK 7 as the default option due to the latest version of embedded Jetty which requires it and due to LP specific we also require Maven 3.1.1 as the minimal version. Also, make sure that your Maven is using correct version of the JDK. You can check all of these by typing

   mvn --version

   in your command prompt.
3. Some of the archetypes are memory intensive during build process so adjust your JVM memory settings for Maven through setting MAVEN_OPTS to appropriate version. MAVEN_OPTS = -Xmx1024m -XX:MaxPermSize=256m is a good starting point. If you see problems, increase JVM heap with -Xmx1536m.
4. From version 5.5.0.0 we're using NodeJS which needs to be at least 0.10.x, so make sure you have it and if not, please upgrade node and npm as well. For mobile development, 0.10.20 is the minimal version that Titanium requires, so bets to grab latest version available.

##Usage

###Pre-conditions We assume that you're already familiar with Development Guide and that you need more additional archetypes for specific needs. These additional archetypes are tailored by needs we have experienced when working with various clients around the world so they represent also a best practice on how to quickly bootstrap your Backbase CXP projector modules and solve some specific tasks related to Backbase CXP.

###Backbase extensions Maven repository configuration In order to deploy your snapshots or make releases to pre-confogured Backbase Maven repositories, you need to configure your Maven configuration to include the Backbase extensions releases repository (https://repo.backbase.com/extensions).

Edit the settings.xml file located in the .m2 folder.

    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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> <!-- Main product repository --> <repository> <id>repo.backbase.com</id> <url>https://repo.backbase.com/repo/</url> </repository> <!-- Internal development repository is due to mobile services until it gets properly released --> <repository> <id>artifacts.backbase.com</id> <url>https://repo.backbase.com/repo/</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>repo.backbase.com</id> <url>https://repo.backbase.com/repo/</url> </pluginRepository> </pluginRepositories> </profile> </profiles> <servers> <!-- Main product repository --> <server> <id>repo.backbase.com</id> <!--Please change your_user_name and your_password below--> <username>your_user_name</username> <password>your_password</password> </server> <!-- Internal development repository is due to mobile services until it gets properly released --> <server> <id>artifacts.backbase.com</id> <!--Please change your_user_name and your_password below--> <username>your_user_name</username> <password>your_password</password> </server> <!-- This identity is due to bug with LP 0.10 that requires this --> <server> <id>Backbase Artifact Repository</id> <!--Please change your_user_name and your_password below--> <username>your_user_name</username> <password>your_password</password> </server> </servers> </settings>

###Maven archetype project generation:

	$ mvn archetype:generate -DarchetypeArtifactId= -DarchetypeGroupId=com.backbase.expert.tools -DarchetypeVersion= 

##Contributions Please feel encouraged to create your own versions of these archetypes by forking the code and further changing it to meet your specific needs if you have them. If you feel change you have on mind is something that other Backbase CXP customers or Backbase Expert Services could use, please feel free to share ideas on Github Issues section or make a pull request.

After you have build these archetypes locally and optionally deploy within your organization, you are ready to start using them. Each archetype is specific so details on usage are within each of them.

In order to use these archetypes, you need to clone or fork code from this Git repository and build it locally:

	$ mvn clean install

This way you can use these archetypes from your local Maven repository directly.

###Deploy within your organization Optionally, you can also install these archetypes into a Maven repository within your organization. This would enable other people from your organization with access to that Maven repository to use these archetypes. You should do this with Maven deploy plugin. We already use it to deploy to our internal Maven repository so you just need to change Backbase settings into yours. More info on these plugins you can find here. Key configuration you need to change is related to distributionManagement section inside aggregator and parent POM files.

This way, your entire organization can use these archetypes from your organization's Maven repository.

History of Changes

5.5.1.0

1. Alignement of all existing archetypes with Backbase CXP 5.5.1.0 and Launchpad 0.10.1
2. Aligning release process with other Mosiac projects based on two distribution repository profiles
3. Fixing reported bugs
4. Removed custom RSS feed XSL where applicable since default one is working fine
5. Removed FakeAuthentication filter where applicable since no need for it any more

5.5.0.0

1. Initial version of Launchpad Archetype and Backbase CXP ES Project Archetype with Launchpad 0.10.0 and Services Archetype.
2. Alignement of Portal Server, Content Services, Mashup Services, Orchestrator, Targeting, All-In-One and All-In-One with Launchpad archetypes with Backbase Portal suite 5.5.0.0
3. Alignement of All-In-One with Launchpad archetypes with Launchpad 0.10.0
4. Separation of aggregating and parent POM
5. Move to Jetty 9.1.2.v20140210
6. Move to JDK 7
7. Introduction to NodeJS
8. Fixing reported bugs
9. Moved RSS target feed for test into application
10. Adding ES best practices for web development
11. Migrated TODO section from this file into GitHub Issues section
12. Upgrade to latest Mosaic Tools (1.0)
13. Adding best practices for widget lifecycle through use of Mosaic Tools / YAPI / Grunt / NodeJS Proxy
14. Out-of-box ehcache configuration files in src/main/resources of all relevant components

5.4.2.2

1. Alignement of Portal Server, Content Services, Mashup Services, All-In-One and All-In-One with Launchpad archetypes with Backbase Portal suite 5.4.2.2
2. Alignement of All-In-One with Launchpad archetypes with Launchpad 0.8
3. Initial version of Orchestrator Archetype
4. Initial version of Targeting Archetype
5. Rename archetypes to fit uniform naming convention
6. Making 7777 as a default port for Backbase Portal
7. Change repositories so that Backbase Expert Services Jenkins can perform builds
8. Fixing reported bugs

5.4.1.3

1. Initial version of Portal Server Archetype
2. Initial version of Launchpad All-In-One Archetype with Launchpad 0.7
3. Alignement of All-In-One, Content Services and Mashup Services Archetypes with Backbase Portal suite 5.4.1.3
4. Fixing reported bugs
5. Consolidated logging configurations across archetypes
6. Documentation optimization

5.4.0.6

1. Initial version of Mashup Services Archetype
2. Alignement of All-In-One and Content Services Archetypes with Backbase Portal suite 5.4.0.6
3. Adding importer.jar to All-In-One Archetype
4. Documentation optimization

5.4.0.5

1. Initial version of Content Services Archetype
2. Alignement of All-In-One Archetype with Backbase Portal suite 5.4.0.5
3. Documentation re-structuring

5.3.1.1

1. Initial version of All-In-One Archetype