Alfresco Records Management Community code
Branch: master
Clone or download
rodicasutu Merge remote-tracking branch 'remotes/origin/release/V3.0' into merge…
…/MNT_20191_RM_export_tool

Mirrored from commit eb868fd847da1e9e8b8567becacbb89918745494
Latest commit 322a4e6 Jan 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ide-config
license
rm-benchmark
rm-community
scripts RM-6428 Fix repo for newly created tag. Jul 25, 2018
.editorConfig Let git handle line endings for us. Sep 23, 2016
.gitattributes
.gitignore
.jshintrc Let git handle line endings for us. Sep 23, 2016
.travis.yml Increase travis_wait to thirty minutes. Apr 21, 2017
CODE_OF_CONDUCT.md Update reporting email address on CODE_OF_CONDUCT document. Nov 23, 2017
CONTRIBUTING.md RM-5792 Minor fixes to CONTRIBUTING.md. Oct 26, 2017
README.md Revert "RM-6269 Changed the module folder names on enterprise" Aug 20, 2018
l10n.properties
pom.xml Merge remote-tracking branch 'remotes/origin/release/V3.0' Oct 1, 2018

README.md

Records Management: README

Contributing

Please refer to our How to contribute guide and our Contributor Covenant Code of Conduct.

Configuring and starting Alfresco/Share

  • Clone the project (e.g. git clone git@gitlab.alfresco.com:records-management/records-management.git)

  • Import the project as a maven project

  • Start the Alfresco/Share instances with the following commands:

    mvn clean install -Pstart-repo
    mvn clean install -Pstart-share
    

    (these commands work best if run from the specific directories, e.g. start Share from rm-community/rm-community-share/ or rm-enterprise/rm-enterprise-share/ )

Configuring a different DB other than H2 (e.g. MySQL or PostgreSQL)

  • Create a file called local.properties under src/main/resources in alfresco-rm-enterprise-repo

  • Add the following properties in this new file

    my.db.name -> The name of the database schema
    my.db.port -> The port number for your database (default port number for postgres is 5432 and for mysql it is 3306)
    
  • Run the following commands to start your Alfresco instance:

    to start Alfresco (using Postgres):

    mvn clean install -Pstart-repo,use-postgres
    

    to start Alfresco (using MySQL):

    mvn clean install -Pstart-repo,use-mysql
    

Technical documentation

Technical documentation is available at rm-community/documentation/README.md and rm-enterprise/documentation/README.md. This should be particularly useful for anyone wanting to integrate with or extend RM.

Running integration test

In order to execute the integration tests run the following command (unit tests will be executed every time before you start Alfresco/Share):

mvn clean install -Dskip.integrationtests=false

Running UI Automation tests

To run the automated UI tests, change to the rm-automation directory and run:

mvn clean install -Dskip.automationtests=false

Note: due to Selenium Firefox driver changes, the highest supported Firefox version for UI tests is 43.0.4 (with Selenium 2.52.0).

It is possible to have multiple versions of Firefox installed onto your workstation (e.g. one for running the UI tests and the other, kept up to date, for everyday browsing) but beware Firefox auto-updates. In this scenario the best approach is to create a non-default profile (default profiles will be shared between your Firefox installations!) for which auto-updates are disabled and forcing the use of this profile in your tests (-Dwebdriver.firefox.profile="ProfileName"). If your Firefox 43 install isn't in your path, you can use the -Dwebdriver.firefox.profile option set to the full path of its "firefox-bin" executable.

MacOS X Sierra users: if you experience by order of magnitude slower performance when connected to a WiFi network (e.g. office WiFi) add your workstation to your local /etc/hosts file as described on https://github.com/SeleniumHQ/selenium/issues/2824.

To use Chrome instead of Firefox:

  1. copy webdriver.properties from https://github.com/AlfrescoTestAutomation/selenium-grid/tree/master/src/main/resources
  2. put it under src/test/resource in rm-automation-ui project
  3. download the chrome driver from http://chromedriver.storage.googleapis.com and extract it
  4. change the following properties in webdriver.properties: webdriver.browser (Chrome) and webdriver.chrome.server.path (path/to/chrome/driver)
  5. run the tests as usual

Updating License Headers

In order to refesh out of date license source headers run the following command:

mvn clean install -Dlicense.update.dryrun=false

Running tests against latest Aikau snapshot

The latest Aikau snapshot can be pulled by running the following command in rm-community:

mvn clean install -DskipTests -Dalfresco.aikau.version=LATEST -U

Thereafter start the Share instance and run automation tests as described above.

Configuring Outlook Integration

To download and run RM with the Outlook Integration AMPs installed on the repo and Share use the following commands:

mvn clean install -Pstart-repo,outlook-integration
mvn clean install -Pstart-share,outlook-integration

Follow these instructions to install licence and Outlook plugin:

SNAPSHOT dependencies

If you're building Enterprise RM, the base project (Community) is pulled in via a snapshot dependency configured in maven. This dependency will either be loaded from your local .m2 cache, or from Nexus if the version in your .m2 doesn't exist or is old ('old' in maven terms is anything over 24 hours old). If maven fetches community dependencies from Nexus, then it's unlikely to contain your changes. You want to always use the version in your local cache - this means either doing a daily build at the root project level that pushes a new copy of the correct version into your cache, or alternatively you could run mvn with the --no-snapshot-dependency (or -nsu) option, which won't try to download a newer version.

Code Formatting

This project follows the usual Alfresco Coding Standards. If you use Eclipse or IntelliJ, there are settings inside the ide-config directory for you to import.

Surf build errors

If you get:

[ERROR] Failed to execute goal on project alfresco-rm-community-share: Could not resolve dependencies for project org.alfresco:alfresco-rm-community-share:amp:2.6-SNAPSHOT: Failed to collect dependencies at org.alfresco.surf:spring-surf-api:jar:6.3 -> org.alfresco.surf:spring-surf:jar:${dependency.surf.version}: Failed to read artifact descriptor for org.alfresco.surf:spring-surf:jar:${dependency.surf.version}: Could not transfer artifact org.alfresco.surf:spring-surf:pom:${dependency.surf.version} from/to alfresco-internal (https://artifacts.alfresco.com/nexus/content/groups/private): Not authorized , ReasonPhrase:Unauthorized. -> [Help 1]

then please re-run with -Ddependency.surf.version=6.3

Install lombok plugin for IDEs

To allow automation and benchmark projects to be built within an IDE the lombok 'plugin' needs to be installed. Execute lombok.jar (doubleclick it, or run java -jar lombok.jar). Follow the instructions.

Use Solr 6 with Alfresco 5.2.x

In alfresco-global.properties (depending on the RM edition /records-management/rm-community/rm-community-repo/src/test/properties/local or /records-management/rm-enterprise/rm-enterprise-repo/src/test/properties/local) change the value for "index.subsystem.name" from "solr4" to "solr6". Add also the following property "solr.port=8983".

Download the latest Alfresco Search Services from https://nexus.alfresco.com/nexus/#nexus-search;gav~~alfresco-search-services~~~ Currently it's 1.0.0 (alfresco-search-services-1.0.0.zip)

Unzip it and change to the "solr" folder within it. Start the Solr server using the following command:

solr start -a "-Dcreate.alfresco.defaults=alfresco,archive"

Start your repository

Build Docker images for RM Repo and Share

A first step is checking that you have installed a working version of Docker that can be downloaded from here: [https://docs.docker.com/install/]

The second step, in case you already have Docker installed, the current running images must be checked in order to be sure that they are not occupying any of the ports that ACS and Share use.

To kill and clean all the images and containers the following command can be used:

docker system prune --volumes

Note that this will also remove all the stopped containers, containers, networks, volumes and build cache.

Depending on which version of AGS you want to start, Community or Enterprise, you must first build the docker images. From the root folder of the project you can create both the Repo and the Share images for Community and Enterprise. To build all the images use the following command:

mvn install -PbuildDockerImage

If only the Community or Enterprise images need to be built than the same command as above must be run either in the rm-community or rm-enterprise modules.

Start the Docker images

The Docker images of the Repo can be started independently from Share running the following command in the rm-repo-enterprise or rm-repo-community folder which contains the Docker-compose.yml file:

docker-compose up

Be aware of the fact that the Share images can not be started independently from Repo

e.g. In order to start an instance of rm-enterprise-repo and rm-enterprise-share, the above command must be run in rm-enterprise-share after the images have been built.