1. In Eclipse, from the main menu select File > Import... > Maven > Existing Maven Projects.
2. Click Next >
3. Click Browse...>
4. Navigate to the directory where your Maven project is located. For example alfresco-extensions/all-in-one.

   You should see a dialog looking something like this when importing an All-in-One (AIO) project:

   

5. Click Finish

   The project, and any sub-projects, will now be imported.

6. Enable Alfresco Enterprise edition (Optional)

   If your project is using the Enterprise edition of Alfresco you also want Eclipse to load the enterprise versions of the Alfresco WARs and related libraries. You can do this by enable the enterprise profile. In the Package Explorer view to the left, right click on the all-in-one project, then select Maven from the popup menu. Now in the next popup menu choose Select Maven Profiles.... In the dialog that appears select the enterprise profile, you should see a dialog looking something like this now:

   

Start an instance of Alfresco Tomcat that will be used for hot-reloading.

1. Use the run script to start the Application server with the Alfresco extension project deployed, for example:

   
   alfresco-extensions/all-in-one$ ./run.sh                        
                           
                       

   Attention: This is usually done outside the IDE.
2. Test the custom Repository Web Script

   The All-in-One project (and the Repository AMP project) have a sample Web Script included. You can invoke it by pointing your web browser at http://localhost:8080/alfresco/service/sample/helloworld. If you need to login then use admin with password admin. Running this Web Script produces the output "Message: Hello World from JS! HelloFromJava".

3. Test the custom Share Aikau Page

   The All-in-One project (and the Share AMP project) have a sample Aikau page included. You can display it by pointing your web browser at http://localhost:8080/share/page/hdp/ws/simple-page. If you need to login then use admin with password admin. The page should display as follows:

   

Enabling Rapid Application Development (RAD) in Eclipse.

4. This is enabled by default and there is no specific configuration needed. If you want to have more control over when web applications are refreshed, then see the last tutorial about Run Configurations.

Testing RAD when doing Repository customizations (alfresco.war).

5. In the Package Explorer, navigate to and expand the all-in-one/repo-amp/src/main/amp/config/alfresco/extension/templates/webscripts folder
6. Locate the helloworld.get.js file and load it into the editor by double-clicking it.

   This is the controller for the Web Script that we tried after starting the server. Update the controller code by adding an 'UPDATED' string as follows:

   model["fromJS"] = "Hello World from JS! UPDATED";
                           

7. Now build(Make) the project by saving, i.e. click Ctrl+S

   The application server log should display messages about the web scripts being refreshed:

   2015-05-12 11:13:40,652  INFO  [extensions.webscripts.DeclarativeRegistry] [http-bio-8080-exec-9] Registered 407 Web Scripts (+0 failed), 549 URLs
    2015-05-12 11:13:40,653  INFO  [extensions.webscripts.DeclarativeRegistry] [http-bio-8080-exec-9] Registered 1 Package Description Documents (+0 failed) 
    2015-05-12 11:13:40,653  INFO  [extensions.webscripts.DeclarativeRegistry] [http-bio-8080-exec-9] Registered 0 Schema Description Documents (+0 failed) 
    2015-05-12 11:13:40,656  INFO  [extensions.webscripts.AbstractRuntimeContainer] [http-bio-8080-exec-9] Initialised Repository Web Script Container (in 2215.1865ms)
    2015-05-12 11:13:42,414  INFO  [extensions.webscripts.DeclarativeRegistry] [asynchronouslyRefreshedCacheThreadPool1] Registered 407 Web Scripts (+0 failed), 549 URLs
    2015-05-12 11:13:42,414  INFO  [extensions.webscripts.DeclarativeRegistry] [asynchronouslyRefreshedCacheThreadPool1] Registered 1 Package Description Documents (+0 failed) 
    2015-05-12 11:13:42,414  INFO  [extensions.webscripts.DeclarativeRegistry] [asynchronouslyRefreshedCacheThreadPool1] Registered 0 Schema Description Documents (+0 failed) 
                           

   Note that there is no output in the Eclipse console, or other window. Also, it is only the Repository Application (i.e. alfresco.war) that is being refreshed, the Share application is not touched.
8. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

   The output from the Web Script should change to "Message: Hello World from JS! UPDATED HelloFromJava". Note that there is no need to restart the application server, just a Make of the project, and a refresh of the Web Script page from the browser (you are basically invoking the Web Script again and the update should be immediately visible).

9. Now locate the helloworld.get.html.ftl file and load it into the editor by double-clicking it.

   This is the FreeMarker template for the Web Script. Update the template by adding an 'ExtraTemplateText' string as follows:

   Message: ${fromJS} ${fromJava} ExtraTemplateText                       
                           

10. Now build(Make) the project by clicking Ctrl+S

    The application server log should display messages about the web scripts being refreshed.

11. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output from the Web Script should change to "Message: Hello World from JS! UPDATED HelloFromJava ExtraTemplateText ". Again, note that there is no need to restart the application server, only a Make of the project and a refresh of the Web Script page are necessary.

12. In the next demo we will add a properties file for the Web Script, create a helloworld.get.properties file next to the other files we have been working with.

    The properties file should have one property as follows:

    hello.word.extras=Extra Stuff From Props 
                            

13. Add this property to the template, open up helloworld.get.html.ftl.

    The FreeMarker template should now look like this:

    Message: ${fromJS} ${fromJava}  ExtraTemplateText
    ${msg("hello.word.extras")}                      
                            

14. Now build(Make) the project by clicking Ctrl+S

    The application server log should display messages about the web scripts being refreshed.

15. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output of the Web Script should change to "Message: Hello World from JS! UPDATED HelloFromJava ExtraTemplateText Extra Stuff From Props". No restart of application server should be needed, just a Make of the project and a refresh of the Web Script page from the browser.

16. In the last Web Script demo we will change the Java controller
17. Open up all-in-one/repo-amp/src/main/java/{your package path}/demoamp/HelloWorldWebScript.java.

    Change the property text as follows:

    public class HelloWorldWebScript extends DeclarativeWebScript {
        protected Map<String, Object> executeImpl(
                WebScriptRequest req, Status status, Cache cache) {
            Map<String, Object> model = new HashMap<String, Object>();
            model.put("fromJava", "HelloFromJavaUPDATED");
            return model;
        }
    }                      
                            

18. Now build(Make) the project by clicking Ctrl+S

    The application server log should display messages about the web scripts being refreshed.

19. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output of the Web Script should change to "Message: Hello World from JS! UPDATED HelloFromJavaUPDATED ExtraTemplateText Extra Stuff From Props". No restart of application server should be needed, just a Make of the project and a refresh of the Web Script page from the browser.

Test Driven Development (TDD) and RAD when doing Repository customizations (alfresco.war).

20. In the Package Explorer expand all-in-one/repo-amp/src/test/java/{your package path}/demoamp/test and then locate the DemoComponentTest.java source file.
21. Load it into the editor by double-clicking it.
22. Now set up a Run Configuration to run repo-amp tests. From the main menu select Run > Run Configurations....
23. In the Run Configurations dialog, select Maven Build in the left list. Then right click on it and select New.
24. Set the Name field of the configuration to "Test Repo AMP".
25. Set the Base Directory field of the configuration to "${workspace_loc:/repo-amp}".
26. Set the Goals field "test".
27. In the JRE tab set JDK 8.
28. Click Apply.
29. Now run the test by selecting Run.

    The test will run, and three tests will pass, the Console will have logs as follows:

                            
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:set-version (default-set-version) @ repo-amp ---
    [INFO] Removed -SNAPSHOT suffix from version - 1.0
    [INFO] Added timestamp to version - 1.0.1505121136
    [INFO] 
    [INFO] --- build-helper-maven-plugin:1.9.1:add-test-resource (add-env-test-properties) @ repo-amp ---
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:resources (default-resources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] skip non existing resourceDirectory /home/martin/src/alfresco-extensions/all-in-one/repo-amp/src/main/resources
    [INFO] Copying 16 resources to ../repo-amp
    [INFO] 
    [INFO] --- yuicompressor-maven-plugin:1.5.1:compress (compress-js) @ repo-amp ---
    [INFO] nothing to do, /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/classes/../repo-amp/web/scripts/demoamp-min.js is younger than original, use 'force' option or clean your target
    [INFO] nb warnings: 0, nb errors: 0
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh (refresh-webscripts-repo-and-share) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:compile (default-compile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:testResources (default-testResources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 2 resources
    [INFO] Copying 1 resource
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:copy-resources (add-module-properties-to-test-classpath) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 1 resource to alfresco/module/repo-amp
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:copy-resources (add-module-config-to-test-classpath) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 11 resources
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:testCompile (default-testCompile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- maven-surefire-plugin:2.18:test (default-test) @ repo-amp ---
    [INFO] Surefire report directory: /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/surefire-reports
    
    -------------------------------------------------------
     T E S T S
    -------------------------------------------------------
    Running org.alfresco.allinone.demoamp.test.DemoComponentTest
    Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.088 sec - in org.alfresco.allinone.demoamp.test.DemoComponentTest
    
    Results :
    
    Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
    
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 7.232 s
    [INFO] Finished at: 2015-05-12T11:36:13+01:00
    [INFO] Final Memory: 27M/338M
    [INFO] ------------------------------------------------------------------------
    
                        

30. Now, in DemoComponentTest.java, modify one of the tests so that it will fail. For example, you could change the line assertEquals(7, childNodeCount); to assertEquals(8, childNodeCount);
31. Now run the test again by selecting Run from main menu and then from Run History select Run 'Test Repo AMP'.

    Note the test will run again and this time fail. But you did not need to restart Alfresco. This demonstrates hot reloading of Java code.

32. Change the code back and re-run the test.

    Now you will see that all tests pass. The code has re-run without any reloading of Alfresco! This allows for Test Driven Development with very low overhead.

Testing RAD when doing Share customizations (share.war).

33. In the Package Explorer, navigate to and expand the all-in-one/share-amp/src/main/amp/config/alfresco/web-extension/site-webscripts/com/example/pages folder
34. Locate the simple-page.get.js file and load it into the editor by double-clicking it.

    This is the controller for the Aikau Page Web Script that we tried after starting the server. Update the controller code by adding an 'UPDATED' string as follows to the page title, also change the layout from HorizontalWidgets to VerticalWidgets:

    model.jsonModel = {
        widgets: [{
            id: "SET_PAGE_TITLE",
            name: "alfresco/header/SetTitle",
            config: {
                title: "This is a simple page UPDATED"
            }
        },
            {
                id: "MY_HORIZONTAL_WIDGET_LAYOUT",
                name: "alfresco/layout/VerticalWidgets",
                config: {
                    widgetWidth: 50,
                    widgets: [
                        {
                            id: "DEMO_SIMPLE_LOGO",
                            name: "alfresco/logo/Logo",
                            config: {
                                logoClasses: "alfresco-logo-only"
                            }
                        },
                        {
                            id: "DEMO_SIMPLE_MSG",
                            name: "example/widgets/TemplateWidget"
                        }
                    ]
                }
            }]
    };                        

35. Now build(Make) the project by clicking Ctrl+S

    The Share web application will now have the web script container refreshed and the resouce cache cleared.

36. Refresh the http://localhost:8080/share/page/hdp/ws/simple-page Aikau Page from the Browser

    The page should now display as follows:

    

37. Now, let's update some HTML, CSS, and Properties for the sample widget that is used by the Aikau page, navigate to and expand the all-in-one/share-amp/src/main/amp/web/js/example/widgets folder
38. Locate the css/TemplateWidget.css file and load it into the editor by double-clicking it.

    This is the Stylesheet for the Aikau Widget. Update the widget style as follows:

    .my-template-widget {
        border: 2px #000000 solid;
        padding: 1em;
        width: 100px;
        color: white;
        background-color: blue;
    }                     

39. Then locate the i18n/TemplateWidget.properties file and load it into the editor by double-clicking it.

    This is the resource file for the the Aikau Widget. Update the properties as follows:

    hello-label=Hello from i18n UPDATED!
    hello-test=Going to use this label too now!
    

40. Then locate the templates/TemplateWidget.html file and load it into the editor by double-clicking it.

    This is the HTML template file for the the Aikau Widget. Update so it looks as follows:

    <div class="my-template-widget">${greeting} and ${greeting2}</div>
    

41. And finally, locate the TemplateWidget.js file and load it into the editor by double-clicking it.

    This is the main JavaScript implementation for the Aikau Widget. Update so it also sets the new property used in template:

    define(["dojo/_base/declare",
            "dijit/_WidgetBase",
            "alfresco/core/Core",
            "dijit/_TemplatedMixin",
            "dojo/text!./templates/TemplateWidget.html"
        ],
        function(declare, _Widget, Core, _Templated, template) {
            return declare([_Widget, Core, _Templated], {
                templateString: template,
                i18nRequirements: [ {i18nFile: "./i18n/TemplateWidget.properties"} ],
                cssRequirements: [{cssFile:"./css/TemplateWidget.css"}],
                
                buildRendering: function example_widgets_TemplateWidget__buildRendering() {
                    this.greeting = this.message('hello-label');
                    this.greeting2 = this.message('hello-test');
    
                    this.inherited(arguments);
    
                }
            });
    });
    

42. Now build(Make) the project by clicking Ctrl+S.
43. Refresh the http://localhost:8080/share/page/hdp/ws/simple-page Aikau Page from the Browser.

    The page should now display as follows:

    

Enabling RAD in Eclipse with Run Configurations.

44. Introduction

    In this article we have seen how we can achieve Rapid Application Development within Eclipse by having the alfresco maven plugin refresh goals executed automatically (magically) after a Make, which is triggered by saving the file. This auto-refresh feature is enabled by default when you use Eclipse. If you don't want that, and instead want to have more control over when web application refreshs happens etc, then you can use a Run Configuration instead and disable auto-refresh. In the following tutorial you will see how run configurations can be used for better control of when the refresh call is being made.

45. Start by disabling auto-refresh, set the following property in the top project POM (i.e. in alfresco-extensions/all-in-one/pom.xml):

                        
            ...
            <share.client.url>http://localhost:8080/share</share.client.url>
            
            <!--  Turn off auto-refresh of web applications -->
            <maven.alfresco.refresh.mode>none</maven.alfresco.refresh.mode>
        </properties>
     
                    

    Besides none, the other values for this property are:
    • auto - (default) Checks packaging and app.amp.client.war.artifactId to determine if it should refresh Respository (alfresco.war) or Share (share.war)
    • both - Will refresh both Respository and Share
    • share - Refresh only Share
    • repo - Refresh only Respository
    • none - Disables refreshing all together
46. Then set up a Run Configuration to run repo-amp builds and Repository webapp refresh (alfresco.war). From the main menu select Run > Run Configurations....
47. In the Run Configurations dialog, select Maven Build in the left list. Then right click on it and select New.
48. Set the Name field of the configuration to "Make Repo AMP".
49. Set the Base Directory field of the configuration to "${workspace_loc:/repo-amp}".
50. Set the Goals field "compile alfresco:refresh-repo".
51. In the JRE tab set JDK 8.
52. Click Apply.
53. Now run the repo-amp build by selecting Run.

    The build will run with the following result, the Eclipse Console will output:

                            
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:set-version (default-set-version) @ repo-amp ---
    [INFO] Removed -SNAPSHOT suffix from version - 1.0
    [INFO] Added timestamp to version - 1.0.1505121201
    [INFO] 
    [INFO] --- build-helper-maven-plugin:1.9.1:add-test-resource (add-env-test-properties) @ repo-amp ---
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:resources (default-resources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] skip non existing resourceDirectory /home/martin/src/alfresco-extensions/all-in-one/repo-amp/src/main/resources
    [INFO] Copying 16 resources to ../repo-amp
    [INFO] 
    [INFO] --- yuicompressor-maven-plugin:1.5.1:compress (compress-js) @ repo-amp ---
    [INFO] nothing to do, /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/classes/../repo-amp/web/scripts/demoamp-min.js is younger than original, use 'force' option or clean your target
    [INFO] nb warnings: 0, nb errors: 0
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh (refresh-webscripts-repo-and-share) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:compile (default-compile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-repo (default-cli) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 8.440 s
    [INFO] Finished at: 2015-05-12T12:01:13+01:00
    [INFO] Final Memory: 29M/342M
    [INFO] ------------------------------------------------------------------------
    
                        

    Note: Note that only the repo-amp is built and only the Repository webapp is refreshed (alfresco.war), the Share application is not touched. This demonstrates how you can have better control of the build and refresh when you have a many different AMPs. You can create a similar run configuration for the share-amp project, and for any other AMP project.

1. First, make sure IDEA is using the correct Maven installation (3.2.5 or newer). In the main menu, select File > Settings....

   In the IDEA Settings dialog you should see something like this:

   

2. Then check that you are using JDK 8, In the main menu, select File > Project Structure....

   In the IDEA Project Structure dialog you should see something like this:

   

3. Now, in the main menu, select File > Open...
4. Navigate to where the project's parent pom is located, in this case the AIO parent pom.

   You should see a dialog looking something like this when you have located an All-in-One (AIO) project:

   

5. Select the pom.xml file for the All-in-One parent project.
6. Click OK. The project is now imported and should appear in the Project tool view to the left.
7. Enable Alfresco Enterprise edition (Optional)

   If your project is using the Enterprise edition of Alfresco you also want IDEA to load the enterprise versions of the Alfresco WARs and related libraries. You can do this by enable the enterprise profile. In the Maven Projects tool view to the right expand the Profiles folder, then check the enterprise profile. You should see a dialog looking something like this:

   

8. Now use Maven to build the All-in-One (AIO) project. Do this by executing the install command on the parent AIO project. In the Maven Projects tool view to the right expand the parent pom, then expand the Lifecycle folder.

   You should see a dialog looking something like this:

   

9. Double-click the install plugin goal.

   The project will build, and information will be displayed in the Console. You will see a message similar to the following, indicating that the project was successfully built.

                           
   /usr/lib/jvm/java-8-oracle/bin/java -Xms256m -Xmx1G -XX:PermSize=500m -javaagent:/home/martin/libs/springloaded-1.2.3.RELEASE.jar -noverify -Dmaven.home=/usr/local/apache-maven-3.2.5 ......  install
                           
   [INFO] Reactor Summary:
   [INFO] 
   [INFO] Alfresco Repository and Share Quickstart with database and an embedded Tomcat runner. SUCCESS [  0.387 s]
   [INFO] Alfresco Repository AMP Module ..................... SUCCESS [ 38.368 s]
   [INFO] Alfresco Share AMP Module .......................... SUCCESS [  0.734 s]
   [INFO] Alfresco Repository WAR Aggregator ................. SUCCESS [ 11.000 s]
   [INFO] Alfresco Solr 4 Configuration ...................... SUCCESS [  0.028 s]
   [INFO] Alfresco Share WAR Aggregator ...................... SUCCESS [  9.903 s]
   [INFO] Alfresco, Share and Solr4 Tomcat Runner ............ SUCCESS [  0.007 s]
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 01:01 min
   [INFO] Finished at: 2015-05-06T11:28:02+01:00
   [INFO] Final Memory: 61M/503M
   [INFO] ------------------------------------------------------------------------
   
   Process finished with exit code 0
   
                       

   Attention: You should see that the MAVEN_OPTS setting has been picked up by IDEA, look at the first line of the log.

Start an instance of Alfresco Tomcat that will be used for hot-reloading.

1. Use the run script to start the Application server with the Alfresco extension project deployed, for example:

   alfresco-extensions/all-in-one$ ./run.sh                        
                                              

   Important: This is usually done outside the IDE.
2. Test the custom repository web script

   The All-in-One project (and the repository AMP project) have a sample web script included. You can invoke it by pointing your web browser at http://localhost:8080/alfresco/service/sample/helloworld. If you need to login then use admin with password admin. Running this web script produces the output "Message: Hello World from JS! HelloFromJava".

3. Test the custom Share Aikau Page

   The All-in-One project (and the Share AMP project) have a sample Aikau page included. You can display it by pointing your web browser at http://localhost:8080/share/page/hdp/ws/simple-page. If you need to login then use admin with password admin. The page should display as follows:

   

Enabling Rapid Application Development (RAD) in IDEA.

4. Configure repository AMP projects to Refresh Webapp (alfresco.war)

   The All-in-One project has one Repository AMP project by default (all-in-one/repo-amp), we need to set up IDEA so that when we build via IDEA (that is, not via Maven) a script runs that will refresh the Repo Web Script container. In the Maven Projects tool view to the right expand the Alfresco Repository AMP Module folder, then expand the Plugins folder. Now expand the alfresco plugin folder. Right click on the alfresco:refresh-repo goal of the plugin. In the drop down menu select Execute After Make. You should now see a dialog looking something like this:

   

   If you are working with multiple Repo AMPs [69], then you need to do this configuration for each one of them.
   Important: You only need to do this if you are doing customizations for the Alfresco repository webapp (that is, customizing alfresco.war). If you are just customizing the Share UI, see the next configuration.
5. Configure Share AMP projects to Refresh Webapp (share.war)

   The All-in-One project has one Share AMP project by default (all-in-one/share-amp), we need to set up IDEA so that when we build via IDEA (that is, not via Maven) a script runs that will refresh the Surf Web Script container and clear dependency caches. In the Maven Projects tool view to the right expand the Alfresco Share AMP Module folder, then expand the Plugins folder. Now expand the alfresco plugin folder. Right click on the alfresco:refresh-share goal of the plugin. In the drop down menu select Execute After Make. You should now see a dialog looking something like this:

   

   If you are working with multiple Share AMPs [69], then you need to do this configuration for each one of them.
   Important: You only need to do this if you are doing customizations for the Alfresco Share webapp (that is, customizing share.war). If you are just customizing the repository, see the previous configuration.

Testing RAD when doing repository customizations (alfresco.war).

6. In the Project Explorer, navigate to and expand the all-in-one/repo-amp/src/main/amp/config/alfresco/extension/templates/webscripts folder
7. Locate the helloworld.get.js file and load it into the editor by double-clicking it.

   This is the controller for the web script that we tried after starting the server. Update the controller code by adding an 'UPDATED' string as follows:

   model["fromJS"] = "Hello World from JS! UPDATED";
                           

8. Now build(Make) the project by clicking Ctrl+F9

   The message console in IDEA should display BUILD SUCCESS for both the repo-amp and share-amp modules as follows:

   [INFO] Scanning for projects...
   [INFO]                                                                         
   [INFO] ------------------------------------------------------------------------
   [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
   [INFO] ------------------------------------------------------------------------
   [INFO] 
   [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-repo (default-cli) @ repo-amp ---
   [INFO] Successfull Refresh Web Scripts for Alfresco Repository
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 3.854 s
   [INFO] Finished at: 2015-05-11T10:20:17+01:00
   [INFO] Final Memory: 15M/315M
   [INFO] ------------------------------------------------------------------------
   [INFO] Scanning for projects...
   [INFO]                                                                         
   [INFO] ------------------------------------------------------------------------
   [INFO] Building Alfresco Share AMP Module 1.0-SNAPSHOT
   [INFO] ------------------------------------------------------------------------
   [INFO] 
   [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-share (default-cli) @ share-amp ---
   [INFO] Successfull Refresh Web Scripts for Alfresco Share
   [INFO] Successfull Clear Dependency Caches for Alfresco Share
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 4.173 s
   [INFO] Finished at: 2015-05-11T10:20:24+01:00
   [INFO] Final Memory: 18M/309M
   [INFO] ------------------------------------------------------------------------
   [INFO] Maven execution finished                       
                           

   Note the refresh calls to the web applications. If you would prefer to only refresh the repository webapp (that is, alfresco.war) have a look later on in this article for a different approach to refreshing the webapp via run configurations.
9. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

   The output from the web script should change to "Message: Hello World from JS! UPDATED HelloFromJava". Note that there is no need to restart the application server, just a Make of the project, and a refresh of the web script page from the browser (you are basically invoking the web script again and the update should be immediately visible).

10. Now locate the helloworld.get.html.ftl file and double-click it to load it into the editor.

    This is the FreeMarker template for the web script. Update the template by adding an 'ExtraTemplateText' string as follows:

    Message: ${fromJS} ${fromJava} ExtraTemplateText                       
                            

11. Now build(Make) the project by clicking Ctrl+F9

    The message console in IDEA should display BUILD SUCCESS

12. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output from the web script should change to "Message: Hello World from JS! UPDATED HelloFromJava ExtraTemplateText ". Again, note that there is no need to restart the application server, only a Make of the project and a refresh of the web script page are necessary.

13. In the next demo we will add a properties file for the web script, create a helloworld.get.properties file next to the other files we have been working with.

    The properties file should have one property as follows:

    hello.word.extras=Extra Stuff From Props 
                            

14. Add this property to the template, open up helloworld.get.html.ftl.

    The FreeMarker template should now look like this:

    Message: ${fromJS} ${fromJava}  ExtraTemplateText
    ${msg("hello.word.extras")}                      
                            

15. Now build(Make) the project by clicking Ctrl+F9

    The message console in IDEA should display BUILD SUCCESS.

16. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output of the web script should change to "Message: Hello World from JS! UPDATED HelloFromJava ExtraTemplateText Extra Stuff From Props". No restart of application server should be needed, just a Make of the project and a refresh of the web script page from the browser.

17. In the last web script demo we will change the Java controller
18. Open up all-in-one/repo-amp/src/main/java/{your package path}/demoamp/HelloWorldWebScript.java.

    Change the property text as follows:

    public class HelloWorldWebScript extends DeclarativeWebScript {
        protected Map<String, Object> executeImpl(
                WebScriptRequest req, Status status, Cache cache) {
            Map<String, Object> model = new HashMap<String, Object>();
            model.put("fromJava", "HelloFromJavaUPDATED");
            return model;
        }
    }                      
                            

19. Now build(Make) the project by clicking Ctrl+F9

    The message console in IDEA should display BUILD SUCCESS.

20. Refresh the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script page from the Browser

    The output of the web script should change to "Message: Hello World from JS! UPDATED HelloFromJavaUPDATED ExtraTemplateText Extra Stuff From Props". No restart of application server should be needed, just a Make of the project and a refresh of the web script page from the browser.

Test Driven Development (TDD) and RAD when doing Repository customizations (alfresco.war).

21. In the IntelliJ Project Explorer expand all-in-one/repo-amp/src/test/java/{your package path}/demoamp/test and then locate the DemoComponentTest.java source file.
22. Load it into the editor by double-clicking it.
23. Now set up a Run Configuration to run repo-amp tests. From the main menu select Run > Edit Configurations.
24. In the Run/Debug Configurations dialog, click '+' to create a new configuration. Select Maven from the list of available configuration types.
25. Set the Name field of the configuration to "Test Repo AMP".
26. Set the Working Directory field of the configuration to "alfresco-extensions/all-in-one/repo-amp".
27. Set the Command line field "test".
28. Click OK.
29. Now run the test by selecting Run > Run 'Test Repo AMP' from the main menu.

    The test will run, and three tests will pass:

                            
    /usr/lib/jvm/java-8-oracle/bin/java -Xms256m -Xmx1G -javaagent:/home/martin/libs/springloaded-1.2.3.RELEASE.jar -noverify -Dmaven.home=/usr/local/apache-maven-3.2.5 ....
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:set-version (default-set-version) @ repo-amp ---
    [INFO] Removed -SNAPSHOT suffix from version - 1.0
    [INFO] Added timestamp to version - 1.0.1505120757
    [INFO] 
    [INFO] --- build-helper-maven-plugin:1.9.1:add-test-resource (add-env-test-properties) @ repo-amp ---
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:resources (default-resources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] skip non existing resourceDirectory /home/martin/src/alfresco-extensions/all-in-one/repo-amp/src/main/resources
    [INFO] Copying 14 resources to ../repo-amp
    [INFO] 
    [INFO] --- yuicompressor-maven-plugin:1.5.1:compress (compress-js) @ repo-amp ---
    [INFO] nothing to do, /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/classes/../repo-amp/web/scripts/demoamp-min.js is younger than original, use 'force' option or clean your target
    [INFO] nb warnings: 0, nb errors: 0
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh (refresh-webscripts-repo-and-share) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:compile (default-compile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:testResources (default-testResources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 2 resources
    [INFO] Copying 1 resource
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:copy-resources (add-module-properties-to-test-classpath) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 1 resource to alfresco/module/repo-amp
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:copy-resources (add-module-config-to-test-classpath) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] Copying 9 resources
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:testCompile (default-testCompile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- maven-surefire-plugin:2.18:test (default-test) @ repo-amp ---
    [INFO] Surefire report directory: /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/surefire-reports
    
    -------------------------------------------------------
     T E S T S
    -------------------------------------------------------
    Running org.alfresco.allinone.demoamp.test.DemoComponentTest
    Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.085 sec - in org.alfresco.allinone.demoamp.test.DemoComponentTest
    
    Results :
    
    Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
    
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 6.946 s
    [INFO] Finished at: 2015-05-12T07:57:24+01:00
    [INFO] Final Memory: 25M/443M
    [INFO] ------------------------------------------------------------------------                   
                            
                        

30. Now, in DemoComponentTest.java, modify one of the tests so that it will fail. For example, you could change the line assertEquals(7, childNodeCount); to assertEquals(8, childNodeCount);
31. Now run the test again by right-clicking the file in Project Explorer and selecting Run 'Test Repo AMP'.

    Note the test will run again and this time fail. But you did not need to restart Alfresco. This demonstrates hot reloading of Java code.

32. Change the code back and re-run the test.

    Now you will see that all tests pass. The code has re-run without any reloading of Alfresco! This allows for Test Driven Development with very low overhead.

Testing RAD when doing Share customizations (share.war).

33. In the Project Explorer, navigate to and expand the all-in-one/share-amp/src/main/amp/config/alfresco/web-extension/site-webscripts/com/example/pages folder
34. Locate the simple-page.get.js file and load it into the editor by double-clicking it.

    This is the controller for the Aikau Page web script that we tried after starting the server. Update the controller code by adding an 'UPDATED' string as follows to the page title, also change the layout from HorizontalWidgets to VerticalWidgets:

    model.jsonModel = {
        widgets: [{
            id: "SET_PAGE_TITLE",
            name: "alfresco/header/SetTitle",
            config: {
                title: "This is a simple page UPDATED"
            }
        },
            {
                id: "MY_HORIZONTAL_WIDGET_LAYOUT",
                name: "alfresco/layout/VerticalWidgets",
                config: {
                    widgetWidth: 50,
                    widgets: [
                        {
                            id: "DEMO_SIMPLE_LOGO",
                            name: "alfresco/logo/Logo",
                            config: {
                                logoClasses: "alfresco-logo-only"
                            }
                        },
                        {
                            id: "DEMO_SIMPLE_MSG",
                            name: "example/widgets/TemplateWidget"
                        }
                    ]
                }
            }]
    };                        

35. Now build(Make) the project by clicking Ctrl+F9

    The message console in IDEA should display BUILD SUCCESS for both the repo-amp and share-amp modules as follows:

    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-repo (default-cli) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 3.854 s
    [INFO] Finished at: 2015-05-11T10:20:17+01:00
    [INFO] Final Memory: 15M/315M
    [INFO] ------------------------------------------------------------------------
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Share AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-share (default-cli) @ share-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Share
    [INFO] Successfull Clear Dependency Caches for Alfresco Share
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 4.173 s
    [INFO] Finished at: 2015-05-11T10:20:24+01:00
    [INFO] Final Memory: 18M/309M
    [INFO] ------------------------------------------------------------------------
    [INFO] Maven execution finished                       
                            

    Also, note the refresh calls to the Web Applications to refresh. If you would prefer to only refresh the Share webapp (that is, share.war) have a look later on in this article for a different approach to refreshing the webapp via run configurations.
36. Refresh the http://localhost:8080/share/page/hdp/ws/simple-page Aikau Page from the Browser

    The page should now display as follows:

    

37. Now, let's update some HTML, CSS, and Properties for the sample widget that is used by the Aikau page, navigate to and expand the all-in-one/share-amp/src/main/amp/web/js/example/widgets folder
38. Locate the css/TemplateWidget.css file and load it into the editor by double-clicking it.

    This is the Stylesheet for the Aikau Widget. Update the widget style as follows:

    .my-template-widget {
        border: 2px #000000 solid;
        padding: 1em;
        width: 100px;
        color: white;
        background-color: blue;
    }                     

39. Then locate the i18n/TemplateWidget.properties file and load it into the editor by double-clicking it.

    This is the resource file for the the Aikau Widget. Update the properties as follows:

    hello-label=Hello from i18n UPDATED!
    hello-test=Going to use this label too now!
    

40. Then locate the templates/TemplateWidget.html file and load it into the editor by double-clicking it.

    This is the HTML template file for the the Aikau Widget. Update so it looks as follows:

    <div class="my-template-widget">${greeting} and ${greeting2}</div>
    

41. And finally, locate the TemplateWidget.js file and load it into the editor by double-clicking it.

    This is the main JavaScript implementation for the Aikau Widget. Update so it also sets the new property used in template:

    define(["dojo/_base/declare",
            "dijit/_WidgetBase",
            "alfresco/core/Core",
            "dijit/_TemplatedMixin",
            "dojo/text!./templates/TemplateWidget.html"
        ],
        function(declare, _Widget, Core, _Templated, template) {
            return declare([_Widget, Core, _Templated], {
                templateString: template,
                i18nRequirements: [ {i18nFile: "./i18n/TemplateWidget.properties"} ],
                cssRequirements: [{cssFile:"./css/TemplateWidget.css"}],
                
                buildRendering: function example_widgets_TemplateWidget__buildRendering() {
                    this.greeting = this.message('hello-label');
                    this.greeting2 = this.message('hello-test');
    
                    this.inherited(arguments);
    
                }
            });
    });
    

42. Now build(Make) the project by clicking Ctrl+F9.
43. Refresh the http://localhost:8080/share/page/hdp/ws/simple-page Aikau Page from the Browser.

    The page should now display as follows:

    

Enabling RAD in IDEA with run configurations.

44. Introduction

    In this article we have seen how we can achieve Rapid Application Development within IDEA by executing alfresco maven plugin refresh goals after a Make. This is an easy way to configure RAD in IDEA when you are only working with 1 or 2 AMPs. However, when you start to get a number of AMPs that you are working on simultaneously, then there will be a lot of refresh calls going on as every AMP's alfresco plugin goal config will be executed. This could be seen in the tutorials above where the refresh-share and refresh-repo goals were always executed even if we were just working with one of the associated AMPs. In the following tutorial you will see how run configurations can be used for better control of when the refresh call is being made.

45. Set up a Run Configuration to run repo-amp builds and Repository webapp refresh (alfresco.war). From the main menu select Run > Edit Configurations.
46. In the Run/Debug Configurations dialog, click '+' to create a new configuration. Select Maven from the list of available configuration types.
47. Set the Name field of the configuration to "Make Repo AMP".
48. Set the Working Directory field of the configuration to "alfresco-extensions/all-in-one/repo-amp".
49. Set the Command line field "compile alfresco:refresh-repo".
50. Click OK.
51. Now do a Make(build) by selecting Run > Run 'Make Repo AMP' from the main menu.

    The build will run with the following result:

                            
    /usr/lib/jvm/java-8-oracle/bin/java -Xms256m -Xmx1G -javaagent:/home/martin/libs/springloaded-1.2.3.RELEASE.jar -noverify -Dmaven.home=/usr/local/apache-maven-3.2.5 ....
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Alfresco Repository AMP Module 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:set-version (default-set-version) @ repo-amp ---
    [INFO] Removed -SNAPSHOT suffix from version - 1.0
    [INFO] Added timestamp to version - 1.0.1505120823
    [INFO] 
    [INFO] --- build-helper-maven-plugin:1.9.1:add-test-resource (add-env-test-properties) @ repo-amp ---
    [INFO] 
    [INFO] --- maven-resources-plugin:2.7:resources (default-resources) @ repo-amp ---
    [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [INFO] skip non existing resourceDirectory /home/martin/src/alfresco-extensions/all-in-one/repo-amp/src/main/resources
    [INFO] Copying 14 resources to ../repo-amp
    [INFO] 
    [INFO] --- yuicompressor-maven-plugin:1.5.1:compress (compress-js) @ repo-amp ---
    [INFO] nothing to do, /home/martin/src/alfresco-extensions/all-in-one/repo-amp/target/classes/../repo-amp/web/scripts/demoamp-min.js is younger than original, use 'force' option or clean your target
    [INFO] nb warnings: 0, nb errors: 0
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh (refresh-webscripts-repo-and-share) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] 
    [INFO] --- maven-compiler-plugin:3.2:compile (default-compile) @ repo-amp ---
    [INFO] Nothing to compile - all classes are up to date
    [INFO] 
    [INFO] --- alfresco-maven-plugin:2.1.0-SNAPSHOT:refresh-repo (default-cli) @ repo-amp ---
    [INFO] Successfull Refresh Web Scripts for Alfresco Repository
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 6.389 s
    [INFO] Finished at: 2015-05-12T08:23:57+01:00
    [INFO] Final Memory: 30M/490M
    [INFO] ------------------------------------------------------------------------                        
                        

    Note: Note that only the repo-amp is built and only the repository webapp is refreshed (alfresco.war), the Share application is not touched. This demonstrates how you can have better control of the build and refresh when you have a many different AMPs. You can create a similar run configuration for the share-amp project, and for any other AMP project.

1. In this tutorial we assume that we are working with an All-in-One (AIO) project, change into the top directory (alfresco-extensions/all-in-one).

Start the AIO project in debug mode.

2. Run mvnDebug rather than the mvn command:

   $ mvnDebug clean install -Prun
   Preparing to Execute Maven in Debug Mode
   Listening for transport dt_socket at address: 8000
   ...
                           
                       

   The Maven project will start and listen for a remote debugger on port 8000.
   Important: This is usually done outside the IDE.

Connect to the running application process from Eclipse

3. In Eclipse, select Run > Debug Configurations from the main menu.
4. Select Remote Java Application and click the New icon on the top left of the dialog.
5. Give the Debug Configuration a suitable name, such as "Debug Alfresco Extension".
6. Click Browse and select the repo-amp project, the rest of the fields for host and port have suitable default values.
7. Click Apply.
8. Click Debug to run the Debug Configuration and connect to the remote Alfresco server.
9. In Eclipse, enable the Debug perspective by selecting Window > Open Perspective > Debug from the main menu.
10. Set a breakpoint in the all-in-one/repo-amp/src/main/java/org/alfresco/allinone/demoamp/HelloWorldWebScript.java) file.
11. Invoke the http://localhost:8080/alfresco/service/sample/helloworld Repository Web Script from the Browser

    You should now see the process stopping in the debugger as follows:

    

1. Stop the embedded Tomcat instance, if it is running.
2. Copy the Repository keystore to the AIO project.

   Execute the following command to copy the keystore into the runner project:

   {ALFRESCO_INSTALL_DIR}/alf_data$ cp -R keystore/ {AIO_PARENT_DIR}/runner/

   We can now configure the embedded Tomcat instace to use this keystore.
3. Copy Tomcat users definition to the AIO project.

   Execute the following command to copy the tomcat users file into the runner project:

   {AIO_PARENT_DIR}/runner/tomcat$ mkdir conf
   {ALFRESCO_INSTALL_DIR}/tomcat/conf$ cp tomcat-users.xml {AIO_PARENT_DIR}/runner/tomcat/conf/

   What we do here is first create a directory to hold the tomcat users file. And then we copy the tomcat users file from the Alfresco installation to this new directory in the runner project. This file contains identities for the Repository and Solr applications when setting up SSL connections.
4. Turn on SSL for Repository.

   Open up the alfresco-global.properties file located in the {AIO_PARENT_DIR}/repo/src/main/properties/local directory. Then update the section about Solr configuration:

   index.subsystem.name=solr4
   dir.keystore={AIO_PARENT_DIR}/runner/keystore
   solr.host=localhost
   solr.port=8080
   solr.port.ssl=8443
   #solr.secureComms=none

   Note. You have to change {AIO_PARENT_DIR} to whatever the parent directory is for your AIO project.
5. Update the tomcat7-maven-plugin with keystore, port, and Tomcat users

   Open up the pom.xml file located in the {AIO_PARENT_DIR}/runner directory. Then update the plugin configuration as follows:

   <plugin>
      <groupId>org.apache.tomcat.maven</groupId>
      <artifactId>tomcat7-maven-plugin</artifactId>
      <executions>
          <execution>
              <id>run-wars</id>
              <goals>
                  <goal>run</goal>
              </goals>
              <phase>pre-integration-test</phase>
          </execution>
      </executions>
      <configuration>
          <httpsPort>8443</httpsPort>
          <keystoreFile>${project.basedir}/keystore/ssl.keystore</keystoreFile>
          <keystorePass>kT9X6oe68t</keystorePass>
          <keystoreType>JCEKS</keystoreType>
          <truststoreFile>${project.basedir}/keystore/ssl.truststore</truststoreFile>
          <truststorePass>kT9X6oe68t</truststorePass>
          <truststoreType>JCEKS</truststoreType>
          <tomcatUsers>${project.basedir}/tomcat/conf/tomcat-users.xml</tomcatUsers>

6. Change Solr4 configuration package to the one that has SSL enabled.

   Open up the pom.xml file located in the {AIO_PARENT_DIR}/solr-config directory. Then update the dependency and plugin configuration as follows:

   <dependencies>
      <dependency>
          <groupId>org.alfresco</groupId>
          <artifactId>alfresco-solr4</artifactId>
          <version>${alfresco.version}</version>
          <classifier>config-ssl</classifier>
          <type>zip</type>
      </dependency>
   </dependencies>
   
   <build>
      <plugins>
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-dependency-plugin</artifactId>
              <executions>
                  <execution>
                      <id>unpack-alfresco-config</id>
                      <goals>
                          <goal>unpack</goal>
                      </goals>
                      <phase>generate-resources</phase>
                      <configuration>
                          <outputDirectory>${alfresco.solr.home.dir}</outputDirectory>
                          <artifactItems>
                              <artifactItem>
                                  <groupId>org.alfresco</groupId>
                                  <artifactId>alfresco-solr4</artifactId>
                                  <version>${alfresco.version}</version>
                                  <classifier>config-ssl</classifier>
                                  <type>zip</type>
                              </artifactItem>
                          </artifactItems>

   This Solr4 configuration comes preconfigured with SSL enabled, keystore and truststore, including the keystores themselves.
7. Delete previous "no-ssl" configuration directory.

   {AIO_PARENT_DIR}/alf_data_dev/solr4$ rm -rf config/

   This is so the new SSL enabled configuration is downloaded and installed correctly under alf_data_dev.
8. Make sure that the Alfresco Repository (alfresco.war) web application is using SSL.

   Open up the pom.xml file located in the {AIO_PARENT_DIR}/repo directory. Then update the maven-war-plugin configuration as follows:

   <plugin>
      <artifactId>maven-war-plugin</artifactId>
      <executions>
          <execution>
              <id>prepare-exploded-war</id>
              <goals>
                  <goal>exploded</goal>
              </goals>
              <phase>prepare-package</phase>
          </execution>
          <execution>
              <id>default-war</id>
             <!-- <configuration>
                   <webXml>${project.build.directory}/${project.build.finalName}-nossl/WEB-INF/web.xml</webXml>
              </configuration>-->
          </execution>
      </executions>

   What we do here is just commenting out the web.xml file that we normally use when we don't want to use SSL.
9. Start it up and make sure it works.

   You should see something like this in the logs:

   {AIO_PARENT_DIR}$ mvn clean install -Prun
   ...
   Jun 05, 2015 10:56:33 AM org.apache.coyote.AbstractProtocol start
   INFO: Starting ProtocolHandler ["http-bio-8080"]
   Jun 05, 2015 10:56:33 AM org.apache.coyote.AbstractProtocol start
   INFO: Starting ProtocolHandler ["http-bio-8443"]

   Try accessing Share securely: https://localhost:8443/share. Make sure search works by adding a text file with a unique word, then search for it. Then access Solr4 securely: https://localhost:8443/solr4.

Adding an external JAR to a Repository AMP project.

1. Stop the embedded Tomcat instance, if it is running (i.e. via -Pamp-to-war).
2. Find a library that can be used to send emails from Java and add a dependency for it to the Repo AMP project.

   We know that the Java Mail library can be used for this, so we look up the maven dependency for it and add it to the componentX-repo/pom.xml:

   ...                            
   <dependencies>
       <dependency>
          <groupId>${alfresco.groupId}</groupId>
          <artifactId>alfresco-repository</artifactId>
      </dependency>
      <!-- Added a new dependency for Java Mail -->
      <dependency>
          <groupId>com.sun.mail</groupId>
          <artifactId>javax.mail</artifactId>
          <version>1.5.3</version>
      </dependency>
   </dependencies>
   ...

   We can now start implementing some code that uses the Java Mail library.
3. Update the Hello World Web Script to send an email.

   The implementation can be done as follows in the Java controller (componentX-repo/src/main/java/com/acme/componentX/demoamp/HelloWorldWebScript.java):

   import javax.mail.*;
   import javax.mail.internet.InternetAddress;
   import javax.mail.internet.MimeBodyPart;
   import javax.mail.internet.MimeMessage;
   import javax.mail.internet.MimeMultipart;
   import java.util.HashMap;
   import java.util.Map;
   import java.util.Properties;
   
   /**
   * A demonstration Java controller for the Hello World Web Script.
   *
   * @author martin.bergljung@alfresco.com
   * @since 2.1.0
   */
   public class HelloWorldWebScript extends DeclarativeWebScript {
      protected Map<String, Object> executeImpl(
              WebScriptRequest req, Status status, Cache cache) {
          Map<String, Object> model = new HashMap<String, Object>();
          model.put("fromJava", "HelloFromJava");
          sendEmail();
          return model;
      }
   
      private void sendEmail() {
          String to = "somebody@example.com";
          String subject = "Test email from Web Script";
          String body = "Hello World!";
   
          try {
              // Create mail session
              Properties props = new Properties();
              props.put("mail.smtp.host", "<yourhost>");  // localhost will not work
              props.put("mail.smtp.port", "2525");        // non-privileged port
              Session session = Session.getDefaultInstance(props, null);
              session.setDebug(false);
   
              // Define message
              Message message = new MimeMessage(session);
              String fromAddress = "no-reply@alfresco.com";
              message.setFrom(new InternetAddress(fromAddress));
              message.addRecipient(Message.RecipientType.TO, new InternetAddress(to));
              message.setSubject(subject);
   
              // Create the message part with body text
              BodyPart messageBodyPart = new MimeBodyPart();
              messageBodyPart.setText(body);
              Multipart multipart = new MimeMultipart();
              multipart.addBodyPart(messageBodyPart);
   
              // Put parts in message
              message.setContent(multipart);
   
              // Send the message
              Transport.send(message);
   
          } catch (MessagingException me) {
              me.printStackTrace();
          }
      }
   }

   For the code to work you will need to update <yourhost> to whatever hostname your machine has. The code uses standard Java Mail classes to send a simple email without attachments.
4. Build the Repository AMP.

   Standing in the Repo AMP project directory, type the following Maven command:

   componentX-repo$ mvn clean install -DskipTests=true
   

   What we end up with now is a Repository AMP with the following JARs:

   

   This might seem okay at first, but it is actually not a good idea. When we apply this AMP to an Alfresco5.WAR file, the JAR files will be added to the tomcat/webapps/alfresco/WEB-INF/lib directory, and we end up with duplicate Java Mail libraries as it already contains one version of the libarary:

   

   So the correct approach is to always check what JARs that are available in the Alfresco 5 WAR, and then for any JAR that is available use <scope>provided</scope> when specifying the dependency for it.
5. Update the Java Mail dependency to have scope provided.

   Open up the componentX-repo/pom.xml and update the Java Mail dependency as follows:

   ...                        
   <dependencies>
      <dependency>
          <groupId>${alfresco.groupId}</groupId>
          <artifactId>alfresco-repository</artifactId>
      </dependency>
   
      <dependency>
          <groupId>com.sun.mail</groupId>
          <artifactId>javax.mail</artifactId>
          <version>1.5.3</version>
          <scope>provided</scope>
      </dependency>
   ...   
   </dependencies>

   This will mean that the Java Mail JAR is not included in the AMP but we can still compile and build against it, which is what we want.

   So to summarize, if the JAR is not in tomcat/webapps/alfresco/WEB-INF/lib, then do not use provided scope as you want it included with the AMP. On the other hand, if the JAR is available, then use provided scope to exclude it from the AMP deliverable.

Adding an internal JAR to a Repository AMP project.

6. Create a Repository AMP parent project directory.

   To achieve what we want, we will have to turn the Repository AMP project into a multi-module project, and for this we need a parent project. Create a new directory called componentX-parent and then copy the Repository AMP directory into it:

   componentX-repo$ cd ..
   ~/src/$ mkdir componentX-parent
   ~/src/$ mv componentX-repo/ componentX-parent/

7. Create a Repository AMP parent project POM file.

   Add the following pom.xml to the componentX-parent directory:

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.acme</groupId>
      <artifactId>componentX-parent</artifactId>
      <version>1.0-SNAPSHOT</version>
      <name>componentX-repo Repository AMP parent</name>
      <description>This is the parent project for the multi-module componentX-repo Repository AMP project</description>
      <packaging>pom</packaging>
   
      <parent>
          <groupId>org.alfresco.maven</groupId>
          <artifactId>alfresco-sdk-parent</artifactId>
          <version>2.1.0</version>
      </parent>
   
      <modules>
          <module>componentX-repo</module>
      </modules>
   </project>

   Note how this parent project now has the SDK Project as a parent. And it includes the Repository AMP project as a sub-module. The parent project packaging is pom, which means it is not producing an artefact like a JAR, AMP, or WAR, it just acts as a parent for other sub-modules.
8. Update parent definition in the Repository AMP project POM file.

   Open up the componentX-parent/componentX-repo/pom.xml file. Then update the parent definition as follows:

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <artifactId>componentX-repo</artifactId>
      <name>componentX-repo Repository AMP project</name>
      <packaging>amp</packaging>
      <description>Manages the lifecycle of the componentX-repo Repository AMP (Alfresco Module Package)</description>
   
      <parent>
          <groupId>com.acme</groupId>
          <artifactId>componentX-parent</artifactId>
          <version>1.0-SNAPSHOT</version>
      </parent>
      ...

   Note the parent section and how it now points to our new parent. Also, we have removed the version and groupId properties from the AMP project as they are inherited from the parent project.
9. Build the Repository AMP parent project.

   You should see something like this in the logs:

   componentX-parent$ mvn clean install -DskipTests=true
   . . .
   [INFO] Reactor Summary:
   [INFO]
   [INFO] componentX-repo Repository AMP parent .............. SUCCESS [  0.607 s]
   [INFO] componentX-repo Repository AMP project ............. SUCCESS [  6.850 s]
   [INFO] ------------------------------------------------------------------------
   [INFO] BUILD SUCCESS

   So we now got a parent project that can contain more sub-projects then just the Repository AMP project.
10. Add a JAR project and move the Hello World Web Script code.

    We are going to create a new JAR sub-project and then move the Hello World Web Script code over to it from the AMP. Let’s start by adding a new JAR project. Stand in the parent directory and issue the following command, which will generate a starting point for a JAR module:

    componentX-parent$ mvn archetype:generate -DgroupId=com.acme -DartifactId=componentX-web-script -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

    We are using the Maven Quickstart archetype to generate the JAR module. Our parent directory now looks like this:

    componentX-parent$ ls -l
    total 16
    drwxrwxr-x 6 martin martin 4096 Jun  5 15:27 componentX-repo
    drwxrwxr-x 3 martin martin 4096 Jun  5 15:35 componentX-web-script
    -rw-rw-r-- 1 martin martin  881 Jun  5 15:35 pom.xml

    When we generate a new module from the parent directory it is automatically added to the modules section of the parent POM as follows:

    ...                        
    <modules>
           <module>componentX-repo</module>
           <module>componentX-web-script</module>
     </modules>
    </project>

    And the parent section is setup correctly also in the new JAR module, open up componentX-parent/componentX-web-script/pom.xml and have a look:

    <?xml version="1.0"?>
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
            xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <modelVersion>4.0.0</modelVersion>
    
       <parent>
           <groupId>com.acme</groupId>
           <artifactId>componentX-parent</artifactId>
           <version>1.0-SNAPSHOT</version>
       </parent>
    
       <artifactId>componentX-web-script</artifactId>
      <name>componentX-web-script JAR project</name>
       <url>http://maven.apache.org</url>
       ...

    You might notice that I have removed the version and groupId properties from the JAR project as they are inherited from our parent project. I also updated the name so it is easy to see what type of artefact that is produced.
11. Build the Repository AMP parent project.

    You should see something like this in the logs:

    componentX-parent$ mvn clean install -DskipTests=true
    . . .
    [INFO] Reactor Summary:
    [INFO]
    [INFO] componentX-repo Repository AMP parent .............. SUCCESS [  0.685 s]
    [INFO] componentX-repo Repository AMP project ............. SUCCESS [  7.131 s]
    [INFO] componentX-web-script JAR project .................. SUCCESS [  0.539 s]
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS

12. Move the Hello World Web Script files over to the new JAR project.

    Here we are doing this via command line:

    componentX-parent$ cd componentX-web-script/
    componentX-parent/componentX-web-script$ cd src/main/java/com/acme/
    componentX-parent/componentX-web-script/src/main/java/com/acme$ mkdir componentX
    componentX-parent/componentX-web-script/src/main/java/com/acme$ cd componentX/
    componentX-parent/componentX-web-script/src/main/java/com/acme/componentX$ mkdir demoamp
    componentX-parent/componentX-web-script/src/main/java/com/acme/componentX$ cd demoamp/
    componentX-parent/componentX-web-script/src/main/java/com/acme/componentX/demoamp$ mv ~/src/componentX-parent/componentX-repo/src/main/java/com/acme/componentX/demoamp/HelloWorldWebScript.java .
    componentX-parent/componentX-web-script/src/main/java/com/acme/componentX/demoamp$ cd ../../../../../
    componentX-parent/componentX-web-script/src/main$ mkdir resources
    componentX-parent/componentX-web-script/src/main$ cd resources/
    componentX-parent/componentX-web-script/src/main/resources$ mkdir alfresco
    componentX-parent/componentX-web-script/src/main/resources$ cd alfresco/
    componentX-parent/componentX-web-script/src/main/resources/alfresco$ mkdir extension
    componentX-parent/componentX-web-script/src/main/resources/alfresco$ cd extension/
    componentX-parent/componentX-web-script/src/main/resources/alfresco/extension$ mkdir templates
    componentX-parent/componentX-web-script/src/main/resources/alfresco/extension$ cd templates/
    componentX-parent/componentX-web-script/src/main/resources/alfresco/extension/templates$ mkdir webscripts
    componentX-parent/componentX-web-script/src/main/resources/alfresco/extension/templates$ cd webscripts/
    componentX-parent/componentX-web-script/src/main/resources/alfresco/extension/templates/webscripts$ mv ~/src/componentX-parent/componentX-repo/src/main/amp/config/alfresco/extension/templates/webscripts/* .

    If you have followed along, then you should see something like this in your IDE now:

    

    We are not moving the spring context file with the Java controller bean definition over to the JAR project as we want there only to be one module bringing in the spring context (i.e. the Repository AMP Module). We are just keeping the Web Script files in a separate JAR to be able to work with them in an easier way. It will also give us the opportunity to completely lift out this JAR as a stand-alone project in the future, and release it separately to Nexus, if we should want to do that.
13. Move the Java Mail dependency from the AMP project to the JAR project.

    Open up the componentX-parent/componentX-web-script/pom.xml file and update it so it looks like this:

    <?xml version="1.0"?>
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
            xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <modelVersion>4.0.0</modelVersion>
    
       <parent>
           <groupId>com.acme</groupId>
           <artifactId>componentX-parent</artifactId>
           <version>1.0-SNAPSHOT</version>
       </parent>
    
       <artifactId>componentX-web-script</artifactId>
       <name>componentX-web-script JAR project</name>
    
       <url>http://maven.apache.org</url>
    
       <dependencies>
           <dependency>
               <groupId>junit</groupId>
               <artifactId>junit</artifactId>
               <version>3.8.1</version>
               <scope>test</scope>
           </dependency>
    
           <dependency>
               <groupId>${alfresco.groupId}</groupId>
               <artifactId>alfresco-repository</artifactId>
           </dependency>
    
           <dependency>
               <groupId>com.sun.mail</groupId>
               <artifactId>javax.mail</artifactId>
               <version>1.5.3</version>
               <scope>provided</scope>
           </dependency>
       </dependencies>
    </project>

    We also needed to add the alfresco-repository dependency as the Java Web Script controller uses Declarative Web Script classes. It does not have version specified as part of dependency definition, so we need to make sure it works anyway.
14. Move the Dependency Management section from the AMP project to the Parent project.

    Open up the componentX-parent/pom.xml file and update it so it looks like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <groupId>com.acme</groupId>
       <artifactId>componentX-parent</artifactId>
       <version>1.0-SNAPSHOT</version>
       <name>componentX-repo Repository AMP parent</name>
       <description>This is the parent project for the multi-module componentX-repo Repository AMP project</description>
       <packaging>pom</packaging>
    
       <parent>
           <groupId>org.alfresco.maven</groupId>
           <artifactId>alfresco-sdk-parent</artifactId>
           <version>2.1.0</version>
       </parent>
    
       <modules>
           <module>componentX-repo</module>
           <module>componentX-web-script</module>
       </modules>
    
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>${alfresco.groupId}</groupId>
                   <artifactId>alfresco-platform-distribution</artifactId>
                   <version>${alfresco.version}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
    </project>

    It’s a good idea to move the Dependency Management section to the parent POM as you might have more JAR extensions added that needs Alfresco libraries, and then you want to be consitent with what version of these libraries you are using. The Repository AMP POM now looks like this (i.e. componentX-parent/componentX-repo/pom.xml) after removing the Java Mail dependency, moving Dependency Management, and putting in the Web Script JAR dependency:

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <groupId>com.acme</groupId>
       <artifactId>componentX-parent</artifactId>
       <version>1.0-SNAPSHOT</version>
       <name>componentX-repo Repository AMP parent</name>
       <description>This is the parent project for the multi-module componentX-repo Repository AMP project</description>
       <packaging>pom</packaging>
    
       <parent>
           <groupId>org.alfresco.maven</groupId>
           <artifactId>alfresco-sdk-parent</artifactId>
           <version>2.1.0</version>
       </parent>
    
       <modules>
           <module>componentX-repo</module>
           <module>componentX-web-script</module>
       </modules>
    
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>${alfresco.groupId}</groupId>
                   <artifactId>alfresco-platform-distribution</artifactId>
                   <version>${alfresco.version}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
    </project>

    We are now ready to build the project again.
15. Build the Repository AMP parent project.

    You should see something like this in the logs:

    componentX-parent$ mvn clean install -DskipTests=true
    
    [INFO] Reactor Summary:
    [INFO]
    [INFO] componentX-repo Repository AMP parent .............. SUCCESS [  0.556 s]
    [INFO] componentX-web-script JAR project .................. SUCCESS [  2.662 s]
    [INFO] componentX-repo Repository AMP project ............. SUCCESS [  4.688 s]                

    The Repository AMP now contains the following libraries:

    

    Now it looks a bit better, we have split up the AMP code into two JARs and the Java Mail dependency is set to provided so no extra libraries are contained in the produced AMP.
16. Run and try out the Hello World Web Script.

    To make sure this really works we need to try out the Web Script. Step into the AMP directory and do run.sh:

    componentX-parent$ cd componentX-repo/
    componentX-parent/componentX-repo$ chmod +x run.sh
    componentX-parent/componentX-repo$ ./run.sh

    You can test the Web Script as follows from a web browser:

    

    Remember, if you got the send email code in there, then it will try to send an email. And if you don't have an email server (SMTP) running locally, then the Web Script call will eventually time-out as in the following example:

    2015-06-05 16:43:00,105  INFO  [alfresco.util.OpenOfficeConnectionTester] [DefaultScheduler_Worker-1] The OpenOffice connection was re-established.
     com.sun.mail.util.MailConnectException: Couldn't connect to host, port: brutor, 2525; timeout -1;
      nested exception is:
        java.net.ConnectException: Connection timed out 

Linking the RM repository AMP to the alfresco.war.

1. Add the RM repository AMP dependency.

   In the IDE, open up the alfresco-extensions/acme-cms-poc/repo/pom.xml. Scroll down so you see the dependencies section:

   

   What you need to do here is uncomment the alfresco-rm dependency, which brings in the RM Repository AMP. Note that dependency type is set to amp, this is because by default Maven dependencies are assumed to be JARs.
2. Overlaying the RM repository AMP on the alfresco.war.

   The RM repository AMP will not be automatically added to the alfresco.war by just adding the dependency. We need to add some configuration to the war plugin. Scroll further down in the alfresco-extensions/acme-cms-poc/repo/pom.xml file until you see the maven-war-plugin section:

   

   What you need to do here is uncomment the alfresco-rm overlay, which will overlay the RM repository AMP as the last operation to build the customized alfresco.war.

Linking the RM Share AMP to the share.war.

3. Add the RM Share AMP dependency.

   In the IDE, open up the alfresco-extensions/acme-cms-poc/share/pom.xml. Scroll down so you see the dependencies section:

   

   What you need to do here is uncomment the alfresco-rm-share dependency, which brings in the RM Share AMP.
4. Overlaying the RM Share AMP on the share.war.

   The RM Share AMP will not be automatically added to the share.war by just adding the dependency. We need to add some configuration to the war plugin. Scroll further down in the alfresco-extensions/acme-cms-poc/share/pom.xml file until you see the maven-war-plugin section:

   

   What you need to do here is uncomment the alfresco-rm-share overlay, which will overlay the RM Share AMP as the last operation to build the customized share.war.

Verify that the AIO project has been configured with the RM module.

5. Build and Run the AIO project.

   Use the acme-cms-poc/run.sh script to run Alfresco Tomcat with the customized WARs.

6. Check the logs for installation of RM module.

   2015-05-07 10:30:17,004  INFO  [repo.module.ModuleServiceImpl] [localhost-startStop-1] Found 2 module(s).
   2015-05-07 10:30:17,082  INFO  [repo.module.ModuleServiceImpl] [localhost-startStop-1] Installing module 'org_alfresco_module_rm' version 2.3.
   2015-05-07 10:30:18,560  INFO  [repo.module.ModuleServiceImpl] [localhost-startStop-1] Upgrading module 'repo-amp' version 1.0.1505071028 (was 1.0.1505070918).
   ....
   INFO: Starting ProtocolHandler ["http-bio-8080"]
   

   Note: We can see here that version 2.3 of the RM module has been installed.
7. Check that the Site Type Records Management is available.

   Login to Share via http://localhost:8080/share and then create a new site. When you create the site select Records Management Site from the Type drop down. If this type is not available then something is not configured correctly, go back and verify that you have followed all the steps correctly.

Upgrading Alfresco version for a Repository AMP project.

1. Set new version.

   In the IDE, open up the Repository AMP project that you are working on. Then open the project file for it, for example alfresco-extensions/component-a-repo/pom.xml. Scroll down so you see the properties section:

   <properties>
       <!-- The following are default values for data location and Alfresco Community version.
            Uncomment if you need to change (Note. current default version for Enterprise edition is 5.0.1) -->
         <alfresco.version>5.0.e</alfresco.version>
         <!--<alfresco.data.location>alf_data_dev</alfresco.data.location> -->
   

   What you need to do here is uncomment the alfresco.version property, and then update the version to desired latest version. In this case we are upgrading to a newer Community Edition (default is 5.0.d). It would be the same procedure to upgrade to a newer Enterprise version.
2. Clean metadata and content.

   After setting a newer Alfresco version you will need to clean out current database (with metadata), content files, and indexes. It currently does not work to do an incremental upgrade with the SDK and the H2 database. You can clean the DB and conten files by running the following command: alfresco-extensions/component-a-repo/mvn clean -Ppurge

Upgrading Alfresco version for a Share AMP project.

3. Set new version.

   In the IDE, open up the Share AMP project that you are working on. Then open the project file for it, for example alfresco-extensions/component-a-share/pom.xml. Scroll down so you see the properties section:

    <properties>
           <!-- The following are default values for data location and Alfresco version.
                Uncomment if you need to change-->
         <alfresco.version>5.0.e</alfresco.version>
   ...
   

   What you need to do here is uncomment the alfresco.version property, and then update the version to desired latest version. In this case we are upgrading to a newer Community Edition (default is 5.0.d). It would be the same procedure to upgrade to a newer Enterprise version.
4. Clean metadata and content

   When upgrading the Alfresco Share AMP it is not necessary to clean out a database or clean content because these are related to the Alfresco Repository application (alfresco.war) and not the Share Application (share.war).

Upgrading Alfresco version for an All-in-One (AIO) project.

5. Set new version.

   In the IDE, open up the All-in-One project that you are working on. Then open the project file for it, for example alfresco-extensions/all-in-one/pom.xml. Scroll down so you see the properties section:

   <properties>
       <!-- The following are default values for data location, Alfresco Community version, and Records Management Module version.
            Uncomment if you need to change (Note. current default version for Enterprise edition is 5.0.1) -->
         <alfresco.version>5.0.e</alfresco.version>
         <alfresco.rm.version>2.3.b</alfresco.rm.version>
             
                       

   What you need to do here is uncomment the alfresco.version property, and then update the version to desired latest version. In this case we are upgrading to a newer Community edition (default is 5.0.d). It would be the same procedure to upgrade to a newer Enterprise edition. Note also that in this case I'm using the Records Management module and I am updating the version for it at the same time by uncommenting the alfresco.rm.version property and setting new version.
6. Clean metadata and content

   After setting a newer Alfresco version you will need to clean out current database (with metadata), content files, and indexes. It currently does not work to do an incremental upgrade with the SDK and the H2 database. You can clean the DB and conten files by running the following command: alfresco-extensions/component-a-repo/mvn clean -Ppurge

1. Create a file db_setup.sql with the following contents:

                           
       create database alfresco default character set utf8;
       grant all on alfresco.* to 'alfresco'@'localhost' identified by 'alfresco' with grant option;
       grant all on alfresco.* to 'alfresco'@'localhost.localdomain' identified by 'alfresco' with grant option;                        
                           
                       

2. Log into your MySQL server as root using the MySQL client:

                           
       mysql -u root -p                        
                           
                       

3. Run your script to set up the database for Alfresco:

                           
       source db_setup.sql                        
                           
                       

   This will create the Alfresco database (alfresco) and user/pwd (alfresco/alfresco).

4. You now need to configure your project POM file. Change into your project directory and load pom.xml into your editor of choice.
5. Add a dependency for the MySQL JDBC driver at the <project> level of your pom.xml file:

       
       <dependencies>
           ...
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <version>5.1.32</version>
           </dependency>
       </dependencies>
   
                       

6. Now add the configuration required for connecting to your MySQL server in the properties section of the POM:

                           
           <!-- MySQL configuration -->
           <alfresco.db.name>alfresco</alfresco.db.name>
           <alfresco.db.username>alfresco</alfresco.db.username>
           <alfresco.db.password>alfresco</alfresco.db.password>
           <alfresco.db.host>localhost</alfresco.db.host>
           <alfresco.db.port>3306</alfresco.db.port>
           <alfresco.db.params></alfresco.db.params>
           <alfresco.db.url>jdbc:mysql://${alfresco.db.host}:${alfresco.db.port}/${alfresco.db.name}</alfresco.db.url>
           <alfresco.db.datasource.class>org.gjt.mm.mysql.Driver</alfresco.db.datasource.class>                        
                           
                       

7. Save your changes to the pom.xml file.
8. Comment out the H2 Dialect configuration from alfresco-global.properties

   Open the src/test/properties/local/alfresco-global.properties configuration file. Then comment out the following line:

                           
   #hibernate.dialect=org.hibernate.dialect.H2Dialect                      
   

9. Now in the project directory you can type:

                           
       mvn clean install                        
                           
                       

10. Clean up any previous runs with H2:

                            
        rm -rf alf_data_dev/                        
                            
                        

    This step is also very important as it will remove any content and indexes created when you started with the H2 database. When you switch over to run with MySQL the system thinks that it is the first time that you are running Alfresco, so it will create a new database, new content, and index again, which will clash with any previous starts with H2.
11. Once you have a successful build you can run up Alfresco using:

                            
        mvn install -Pamp-to-war                        
                            
                        

    Alfresco will start up and use the MySQL database server that you configured. Track console messages to confirm such as:

                            
    ...
    2014-09-15 15:47:52,552  INFO  [alfresco.repo.admin] [localhost-startStop-1] Using database URL 'jdbc:mysql://localhost:3306/alfresco' with user 'alfresco'.
    2014-09-15 15:47:52,987  INFO  [alfresco.repo.admin] [localhost-startStop-1] Connected to database MySQL version 5.6.11                
    ...
    
                        

12. Check for the message INFO: Starting ProtocolHandler ["http-bio-8080"].
13. Point your web browser at http://localhost:8080/alfresco, and log in as admin with password admin.

1. Create a fresh All-in-One (AIO) project to work with. You can use the instructions contained in this tutorial [57] as your guide.
2. Create a file db_setup_aio.sql with the following contents:

                           
       create database alfrescoaio default character set utf8;
       grant all on alfrescoaio.* to 'alfresco'@'localhost' identified by 'alfresco' with grant option;
       grant all on alfrescoaio.* to 'alfresco'@'localhost.localdomain' identified by 'alfresco' with grant option;                        
                           
                       

   CAUTION:
   Note a different database has been specified here to avoid conflict with the previous tutorial.
3. Log into your MySQL server as root using the MySQL client:

                           
       mysql -u root -p                        
                           
                       

4. Run your script to set up the database for Alfresco:

                           
       source db_setup_aio.sql                        
                           
                       

   This will create the Alfresco database and user.

5. Add a dependency for the MySQL JDBC driver

   Open the {AIO_PROJECT_ROOT}/runner/pom.xml project file. Then add the following dependency at the end of the tomcat7-maven-plugin definition:

                           
   <plugin>
       <groupId>org.apache.tomcat.maven</groupId>
       <artifactId>tomcat7-maven-plugin</artifactId>
   ...
       </configuration>
       <dependencies>
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <version>5.1.32</version>
           </dependency>
       </dependencies>
   </plugin>
                       

6. Now add the configuration required for connecting to your MySQL server

   Open the {AIO_PROJECT_ROOT}/pom.xml project file. Then add the MySQL database connection properties as follows:

            
   <properties>
    ...
       <!-- MySQL configuration -->
       <alfresco.db.name>alfrescoaio</alfresco.db.name>
       <alfresco.db.username>alfresco</alfresco.db.username>
       <alfresco.db.password>alfresco</alfresco.db.password>
       <alfresco.db.host>localhost</alfresco.db.host>
       <alfresco.db.port>3306</alfresco.db.port>
       <alfresco.db.params></alfresco.db.params>
       <alfresco.db.url>jdbc:mysql://${alfresco.db.host}:${alfresco.db.port}/${alfresco.db.name}</alfresco.db.url>
       <alfresco.db.datasource.class>org.gjt.mm.mysql.Driver</alfresco.db.datasource.class>                        
   </properties>

7. Comment out the H2 Dialect configuration from alfresco-global.properties

   Open the {AIO_PROJECT_ROOT}/repo/src/main/properties/local/alfresco-global.properties configuration file. Then comment out the following line:

                           
   #hibernate.dialect=org.hibernate.dialect.H2Dialect                      
   

   Open the {AIO_PROJECT_ROOT}/repo-amp/src/test/properties/local/alfresco-global.properties configuration file. Then comment out the following line:

                           
   #hibernate.dialect=org.hibernate.dialect.H2Dialect                      
   

8. Now in the project directory you can type:

                           
       mvn clean install                        
                           
                       

   This step is very important as it cleans up any previous configuration files from target/...
9. Clean up any previous runs with H2:

                           
       rm -rf alf_data_dev/                        
                           
                       

   This step is also very important as it will remove any content and indexes created when you started with the H2 database. When you switch over to run with MySQL the system thinks that it is the first time that you are running Alfresco, so it will create a new database, new content, and index again, which will clash with any previous starts with H2.
10. Once you have a successful build the project you can start up Alfresco using:

                            
        mvn install -Prun                        
                            
                        

    Alfresco will start up and use the MySQL database server that you configured. As before, scan the console for messages that confirm that Alfresco has connected to MySQL:

                            
    2014-09-15 16:14:59,912  INFO  [domain.schema.SchemaBootstrap] [localhost-startStop-1] Connecting to database: jdbc:mysql://localhost:3306/alfrescoaio, UserName=alfresco@localhost, MySQL Connector Java
    2014-09-15 16:14:59,913  INFO  [domain.schema.SchemaBootstrap] [localhost-startStop-1] Schema managed by database dialect org.hibernate.dialect.MySQLInnoDBDialect.                        
                            
                        

11. Point your web browser at http://localhost:8080/share, and log in as admin with password admin.