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.

...

For more information about the 2.1 updates, see the caNanoLab 2.1 Release NoteNotes.

Targeted Developer

caNanoLab application development is best suited for an experienced Java developer who has some familiarity with the following J2EE and related technologies.

...

Step

Action

1

Execute the Ant build script build.xml located at <CANANOLAB_SOURCE>/build with the target update:cananolab-db.

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

C:\>cd C:\caNanoLab_2.1\build C:\caNanoLab_2.1\build>ant update:cananolab-db

Successful execution of the Ant script updates the database schema and seed data required the caNanoLab 2.1 release.

2

If you are NOT using LDAP for user authentication, you can skip this step. If you are using LDAP for authentication, execute the Ant build script build.xml located at <CANANOLAB_SOURCE>/build with the target update:cananolab-db:ldap:upt:superadmin

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

C:\>cd C:\caNanoLab_2.1\build C:\caNanoLab_2.1\build>ant update:cananolab- db:ldap:upt:superadmin

Successful execution of the Ant script updates the default UPT super admin with the user name entered in the build properties file.

3

If you are NOT using LDAP for user authentication, you can skip this step. If you are using LDAP for authentication, and you already have user accounts in the system and you have data created by these users whose login names are not their LDAP login IDs, you need to perform the following update:

  1. Update the login_name column of the csm_user table with the LDAP login name for each user in the table: 
    Example:
    Issue the following query at the MySQL prompt for each user, logging in as root:
    mysql> update csm_user set login_name='' where login_name='';

    ...Where the token is replaced by the real LDAP login name that corresponds to the old login name. Replace the token with the old login name.

  2. Update the created_by column of tables containing the column with the LDAP login name:
    Example:
    Issue the following query at the MySQL prompt for each table containing the created_by column, logging in as root:
    mysql> update sample set created_by='' where created_by ='';
    ...Where the token is replaced by the real LDAP login name that corresponds to the old login name. Replace the token with old login name.

    Info
    titleNote

    If the created_by field contains the word "COPY" in it, update it with a prefix : (colon), where the token is replaced by the real LDAP login name that corresponds to the old login name who created the data. If you do not know the original login who created the data, use the LDAP login of a curator. If you need assistance on completing the data updates for this step, please contact the caNanoLab technical team.

After data migration, refer to the Verification section to verify that the migration is successful.

...

Step

Action

1

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

Info
titleNote

Use either double back slashes // or a single forward slash / as the file separator if working on Windows platform, 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>/build with the target deploy:cananolab-webpp.

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

C:\>cd C:\caNanoLab_2.1\build C:\caNanoLab_2.1\build>ant deploy:cananolab-webapp

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>:

Code Block
titleArtifacts
 <CANANOLAB_SOURCE>/target/dist/exploded/cananolab- webapp/caNanoLab.war 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/ApplicationSecurityConfig.xml 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/csmupt.csm.new.hibernate.cfg.xml 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/csmupt423.csm.new.hibernate.cfg.xml 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/login-config.xml 
 <CANANOLAB_SOURCE>/target/dist/exploaded/common/mysql-connector-java-5.1.26.jar 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/upt-ds.xml 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/properties-service.xml 
 <CANANOLAB_SOURCE>/target/dist/exploded/common/upt-ds.xml  
 <CANANOLAB_SOURCE>/target/dist/exploded/common/uptEAR.ear
 <CANANOLAB_SOURCE>/target/dist/exploded/common/bcprov-jdk15on-1.47.jar
 <CANANOLAB_SOURCE>/target/dist/exploded/common/caNanoLab_modules.cli
 <CANANOLAB_SOURCE>/target/dist/exploded/common/caNanoLab_setup.cli
 <CANANOLAB_SOURCE>/target/dist/exploded/common/caNanoLab_deploy.cli
 <CANANOLAB_SOURCE>/target/dist/exploded/common/csmapi-5.2.jar

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:

Code Block
titleJAVA_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.

4

  1. Create a new directory structure C:/local/content/caNanoLab/artifacts and move the following artifacts.
    • csmapi-5.2.jar
    • caNanoLab.war
    • uptEAR.ear
    • bcprov-jdk15on-1.47.jar
    • mysql-connector-java-5.1.26.jar
    • caNanoLab_modules.cli
    • caNanoLab_setup.cli
    • caNanoLab_deploy.cli
  2. Create a new directory structure C:/local/content/caNanoLab/config and move the following artifacts.
    • ApplicationSecurityConfig.xml
    • csmupt.csm.new.hibernate.cfg.xml
    • wikihelp.properties
5.

 Start JBoss application server in Standalone mode.

 This script assumes the CLI port is running at 19990. If it is different, you need to update port number at the second line in the script.

  1. Type the following:
    • For Windows environment:  jboss-cli.bat --file=C:/local/content/caNanoLab/artifacts/caNanoLab_modules.cli and press <ENTER>.
    • For Linux environment:  jboss-cli.sh --file=C:/local/content/caNanoLab/artifacts/caNanoLab_modules.cli and press <ENTER>.
  2. Run the remaining caNanoLab_setup.cli and caNanoLab_deploy.cli that deploys the caNanoLab and csmUPT.
    After successful completion, you should see following output in the window.

    Code Block
    titleOutput
     {"outcome"=> "success"}
     {"outcome"=> "success"}
     {"outcome"=> "success"}
     {"outcome"=> "success"}
     {
     "outcome"=> "success",
     "result"=> undefined
     }
  3. Press any key to continue.

...

Step

Action

1

  1. Launch the UPT tool at http://<APP_SERVER_URL>/upt52/Home.action and login as the super admin. If you are NOT using LDAP for user authentication, the default user account/password for super admin is superadmin/superadmin.
  2. Enter csmupt as the application name when prompted at the UPT log in. If you are using LDAP for user authentication, use the LDAP login name and password of the user assigned as the super admin as specified in the Ant build properties file.

    Info
    titleNote

    The user superadmin with the password superadmin was created as a part of the database setup. Only a superadmin user can assign users to be caNanoLab administrators.

2

If you are using LDAP for user authentication, skip this step. If you are not using LDAP for authentication, follow this step to reset the password for superadmin:

  1. Select User > Select an Existing User.
  2. Click on Search and select superadmin, and click on ViewDetails.
  3. Update the UserPassword field and ConfirmPassword field.
  4. Click on Update to commit the change.

3

Log in as the super admin, and follow these steps to create a new user and assign the user to be a caNanoLab administrator:

  1. Select User > Create a New User.
  2. Create a new user account named admin with an initial password.
  3. Select Application>SelectanExistingApplication, and click Search. Select caNanoLab from the application list.
  4. Click ViewDetails, then AssociatedAdmins.
  5. Assign this user to be an administrator for the caNanoLab application.
  6. Click UpdateAssociation to commit the change.

    Info
    titleNote

    If you are using LDAP for user authentication, any user login names created in the UPT tool must be a valid LDAP log in name.

4

Before the newly-created user can log into the UPT application, logged in as the super admin, follow these steps to update the required database connection information for the csmupt and caNanoLab applications under the Application tab:

  1. Select Application > Select an Existing Application, and click Search. Select csmupt from the application list.
  2. Click ViewDetails, then update the following fields:
    • ApplicationDatabaseURL, for example, jdbc://mysql://localhost:3306/canano
    • ApplicationDatabaseUserName, for example, cananolab_app
    • ApplicationDatabasePassword, for example, go!234
    • ApplicationDatabaseConfirmPassword, for example, go!234
    • ApplicationDatabaseDialect, for example, org.hibernate.dialect.MySQLDialect
    • ApplicationDatabaseDriver, for example, com.mysql.jdbc.Driver

      Info
      titleNote

      Please refer to Edit Ant Properties for the appropriate values for these fields. Values for Application Database Dialect and Application Database Driver must be exactly entered as shown above.

       

  3. Repeat the steps to update the database connection information for the caNanoLab application.

5

Log out of the UPT tool and log back in as admin. Use caNanoLab as the application name when prompted at the UPT log in.

6

  1. Select User > Select an Existing User, and click Search. Select admin from the User list.
  2. Click ViewDetails, then AssociatedGroups.
  3. Select Curator from the pre-defined group list and assign it to the user. Click UpdateAssociations to commit the change.

...