NIH | National Cancer Institute | NCI Wiki  

Unable to render {include} The included page could not be found.

Question: How do I create a caArray user with UPT?

Topic: caArray and UPT Installation

Release: Up to caArray 2.4.0

Date entered: 01/06/2009
Date last updated: 06/02/2011


Since UPT is a shared user authorization system for all caGrid tools, users created for each tool are grouped in the UPT CSM schema by "Application".

To create the user for caArray, you would need to first create an "Application" in UPT, point this application to the caArray installed, and then create users within the application you just created.

It is necessary to have both UPT and caArray installed before you start creating caArray users.

Launch UPT

To launch the UPT application, first open a browser and access UPT via the URL: http://<jboss.server.hostname>:<jboss.server.port>/upt

The parameters are defined in UPT's configuration file:

You would need different UPT logins to create the application and users:

  • The application will be created in UPT's CSM schema (Application = "csmupt" in the login as a super admin in the illusration)
  • The caArray user will be created within caArray's CSM schema (Application = "caArray" in the login as an application admin in the illustration).

UPT Login Screens for Creating the Application and Users
Screenshots of UPT Login Screens for Creating the Application and Users

For more information about how to use the UPT application, please refer to the UPT User Guide.

Create caArray Application with UPT

The following diagram shows the steps in creating a new application with UPT, as explained in the steps that follow.

Flow Diagram Showing Steps in Creating a New Application with UPT
Flow Diagram Showing Steps in Creating a New Application with UPT

Step 1. Login to UPT's CSM schema as "superadmin"

(This is the default username created during UPT installation). This step will sign you in to the UPT schema.

Username: superadmin
Password: changeme
Application: csmupt

Step 2. Create a User

This is going to be your application's admin. It is recommended not to use 'caarrayadmin', since 'caarrayadmin' is the default super user created in caArray CSM_user table for application data administration during caArray Installation.

Step 3. Create an Application (see sample below).

Step 4. Associate the User created in Step 2 with Application created in Step 3.

Step 5. Re-login to UPT with the username created in step 2, and with the application created in step 3 (This step signs you in the caArray Schema)

Step 6. Update Association.

Application Configuration

When you create the application, you will need to point this application to the actual application installed. It is important to enter consistent values as those specified in the application configuration file. Following is a sample set of parameters used to create the caArray application:

Application Name: caArray

Application Description: caArray description

Application Declarative Flag: Yes

Application Active Flag: Yes

Application Database URL: jdbc:mysql://localhost:3306/caarraydb

Application Database Username: caarray_database_owner

Application Database Password: changeme

Application Database Dialect: org.hibernate.dialect.MySQLDialect

Application Database Driver: com.mysql.jdbc.Driver

Application CSM Version: 4.2

Key Points

  1. The Application Database Username should correspond to the value for the "database.user" property which you specified in
  2. Environment variable substitution string (${}) is not supported. See examples below:

    Application Database Driver: *$\{com.mysql.jdbc.Driver\}*  - Invalid Syntax
    Application Database Driver: *com.mysql.jdbc.Driver*       - Correct Syntax
  3. The Application Name is case sensitive. For example, caaaray != caArray
  4. The administration user created in step 2 can be associated with more than one application.
    • For example, you may create a user called "LSD-SuperAdmin" and associate this user with all your applications installed, such as: caArray, caGWAS, Rembrandt etc.
    • In this way, you would be able to log in, with one set of username and password, to all LSD applications deployed in your institution, as long as the application name is changed accordingly during the login process.
  5. UPT 4.2 is backward compatible with previous versions of CSM. When you provision the application in UPT 4.2, you will be asked to specify the CSM version caArray 2.4.x is using. You should enter 4.2, since that is the version that caArray uses.

Create caArray Users with UPT

An application user can only be created after the application is created in UPT, when you log in as an application admin as shown in the illustration of login screens.

  • Login to UPT with the information below:
    • Username: application admin (such as: "caArray_User_Admin" created in step 2 above)
    • Password: YourPassWord
    • Application: caArray (created in step 3 above)
  • Create a user

What happens at the database level?

During the installation process for UPT or other applications, a CSM schema is created for UPT and each application tool (except those applications that do not need a database). Each CSM schema has its sampler/default users and a role/permission structure. For the UPT CSM schema, "superadmin" is created by default, which has the privilege to create other users or applications. For the caArray CSM schema, "caArrayAdmin" is created by default, which is a "super User" with the privilege to view or modify all caArray's data. However, "caArrayAdmin" cannot create another caArray user.

Diagram of UPT and Database Schema Contents
Diagram of UPT and Database Schema Contents

The UPT Schema has database connection and administrator information for each application database. The CSM applications are included (caArray, Rembrandt, and caGWAS in the example), and the CSM_User admins. For each application, the schema lists the CSM admin and users.

Have a comment?

Please leave your comment in the caArray End User Forum.