NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added exit disclaimer icons.

...

Info
titleGet Support

For any general information about the application, application support, or to report a bug, contact Application Support (NCIAppSupport@nih.gov).

Print the Guide
If you want to print a single pageor export content from the guide, refer to Printing a Pageand Exporting to Different Formats.

Topics in this document include:

...

For more information about the 2.3 updates, refer to the caNanoLab 2.3 Release Notes.  (TBD?)

Return to top

Open Source Technologies

Download each of the following tools and follow the installation instructions provided with each respective product for your environment. Assistance from a MySQL database administrator is expected to properly configure the MySQL database. For MySQL database configuration and maintenance, it is also helpful to download the MySQL workbench (suite of GUI tools) at   the following page:

http://www.mysql.com/downloads/workbench/ 

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include
 

Product

Link

Java Software Development Kit (JDK) version 8.0 and set JAVA_HOME 

http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Wildfly version 8.2.0.Final

http://wildfly.org/downloads/

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Jakarta Ant version 1.9.x and set ANT_HOME environment variable

http://archive.apache.org/dist/ant/binaries/ 

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

MySQL version 5.1.x

http://dev.mysql.com/downloads/mysql/5.1.html

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Apache Maven 3.3.x or higher

https://archive.apache.org/dist/maven/maven-3

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Return to top

Obtaining the caNanoLab Source Code

Downloads for caNanoLab are available at the caNanoLab GitHub Repository:

https://github.com/CBIIT/cananolab/tree/cananolab-2.2-it-11

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

The caNanoLab Software License License applies.

Return to top

Ant Build Properties

...

Step 1.  Extract caNanoLab

Download the following file:

https://github.com/CBIIT/cananolab/archive/cananolab-2.3.1-it-07.zip

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Extract the above file to Extract the GitHub location to a location on your local system, for example, C:\caNanoLab_2.3. and navigate into the “software” directory to reach the source. (This location is referred as <CANANOLAB_SOURCE> throughout the document). Verify that the following five folders exist in the directory <CANANOLAB_SOURCE>:

...

Step 1.  DB changes to be deployed to migrate to caNanoLab 2.3 from caNanoLab 2.1

a   Execute the following

...

script:

https://github.com/CBIIT/cananolab/blob/cananolab-2.3-it-11/software/cananolab-webapp/db-scripts/2.3/caNanoLab22.sql

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Return to top

Step 2. caNanoLab installation instructions to upgrade to 2.3

...

#

Action

1

Set up an environment variable JBOSS_HOME to point to the Wildfly installation directory.

Info
titleWindows Platform
If working on the Windows platform, use either double back slashes // or a single forward slash / as the file separator, for example, JBOSS_HOME=C:/wildfly-8.2.0.Final (C:\wildfly-8.2.0.Final would fail).

2

Execute the Ant build script build.xml located at <CANANOLAB_SOURCE>/software/cananolab-webapp/build.xml with the target dist.

Example: Issue the following commands to execute the Ant script:

C:\>cd C:\caNanoLab_2.3\software\cananolab-webapp
C:\caNanoLab_2.3\software\cananolab-webapp>ant dist 

Successful execution of the Ant script generates the following artifacts that include two deployable web archive war files, configuration files and libraries for running the web application in the Wildfly environment, and also places these artifacts in the appropriate directories under <JBOSS_HOME>. Artifacts generated are also available in the following folder under <CANANOLAB_SOURCE>: 

target/dist/cananolab-webapp/caNanoLab.war 
target/dist/common/ApplicationSecurityConfig.xml  
target/dist/common/mysql-connector-java-5.1.26.jar 
target/dist/common/properties-service.xml
target/dist/common/bcprov-jdk15on-1.47.jar 
target/dist/common/caNanoLab_modules.cli 
target/dist/common/caNanoLab_setup.cli 
target/dist/common/caNanoLab_deploy.cli

target/dist/common/wikihelp.properties

3

We recommend increasing the JBoss JVM heap size to 2G bytes and permanent generation (permgen) memory space to 256M bytes by updating the file <JBOSS_HOME>/bin/standalone.conf with the following JAVA_OPTS:

JAVA_OPTS="-Xms512m -Xmx2048m -XX:PermSize=128m 
-XX:MaxPermSize=256m -Dsun.rmi.dgc.client.gcInterval=3600000
-Dsun.rmi.dgc.server.gcInterval=3600000"

This configuration file is read when Wildfly server starts.

For a standalone server, pass in the JVM settings either as command line arguments when executing the $JBOSS_HOME/bin/standalone.sh script, or by declaring them in $JBOSS_HOME/bin/standalone.conf.
(For Windows users, the script to execute is %JBOSS_HOME%/bin/standalone.bat while the JVM settings can be declared in
%JBOSS_HOME%/bin/standalone.conf.bat.)

4

Create a new directory structure C:/local/content/caNanoLab/artifacts and move the following artifacts.

  • caNanoLab.war
  • bcprov-jdk15on-1.47.jar
  • mysql-connector-java-5.1.26.jar
  • caNanoLab_modules.cli
  • caNanoLab_setup.cli
  • caNanoLab_deploy.cli 

Create a new directory structure C:/local/content/caNanoLab/config and move the following artifacts.

  • ApplicationSecurityConfig.xml
  • wikihelp.properties
5

Start JBoss application server in Standalone mode.

From <install-dir>/bin:

./standalone.sh --server-config=standalone-full.xml

The cli scripts assumes the CLI port is running at 19990. If it is different, update the port number at the second line in the script. 

For Windows environment:

jboss-cli.bat --file=C:/local/content/caNanoLab/artifacts/caNanoLab_modules.clicli and press <ENTER>. 

For Linux environment:

jboss-cli.sh --file= /local/content/caNanoLab/artifacts/caNanoLab_modules.cli and press <ENTER>.

Run the remaining caNanoLab_setup.cli and caNanoLab_deploy.cli that deploys the caNanoLab.

After successful completion, the following output appears in the window.

{"outcome"=> "success"}
{"outcome"=> "success"}
{"outcome"=> "success"}
{"outcome"=> "success"}
{
"outcome"=> "success",
"result"=> undefined
}

...

The migration of access control data has been implemented as a series of ReST REST services. These services must be invoked in the following order for all access data to be migrated from CSM to Spring Security.

#

Action

1

Migrates all user accounts and grants them all the default Public role and Curator role to curators in CSM.

http://localhost:8080/caNanoLab/rest/datamigration/migrateuseraccounts

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Migrates all access for samples - RWD access for owner and curator, R access for researcher, RWD and R access for specific users.

http://localhost:8080/caNanoLab/rest/datamigration/migratesampleaccess

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Migrates all access for protocols - RWD access for owner and curator, R access for researcher, RWD and R access for specific users.

http://localhost:8080/caNanoLab/rest/datamigration/migrateprotocolaccess

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Migrates all access for publications - RWD access for owner and curator, R access for researcher, RWD and R access for specific users.

http://localhost:8080/caNanoLab/rest/datamigration/migratepublicationaccess

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Adds all charaterizations to the ACL tables and sets them up with the corresponding sample as parent objects. This sets up the characterizations to inherit the access of their sample.

http://localhost:8080/caNanoLab/rest/datamigration/migratecharaccess

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

Migrates all organizations to ACL tables and grant public access. Also, sets up inheritance of access for POCs of organizations.

http://localhost:8080/caNanoLab/rest/datamigration/migratesamplesourceaccess

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

c  Restart the application server after the above step to migrate data is completed.

...

Open the URL, http://<APP_SERVER_URL>/caNanoLab/, for example:

http://localhost:8080/caNanoLab

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

. The Welcome/Login page appears.

...