Skip Headers

Oracle® Student Learning Installation and Deployment Guide Release 3.1.3 Part Number E20664-04 |
Home | Book List | Contents | Contact Us

Previous | Next
| PDF · Mobi · ePub

# 9 Deploying OSL Learning Tool Admin and OSL Learning Tool

This chapter describes the steps in preparing and deploying OSL Learning Tool Admin and OSL Learning Tool to the WebLogic Server.

## 9.1 Customizing OSL Settings

Customize the OSL Learning Tool before deploying it to the WebLogic Server. The customization capabilities include:

- Labels: Updating the label text in the user interfaces of the OSL Learning Tool and OSL Learning Tool Admin.

- Icon set: Replacing default icons in the user interfaces of the OSL Learning Tool and OSL Learning Tool Admin.

- Background images: Replacing or adding background images of the OSL Learning Tool

- Security roles mapping: Updating the mapping of LDAP groups to OSL application roles as mentioned in Scenario 1 of Section 5.1, "Creating Groups in OID". You can ignore this step if your LDAP groups follow the default naming convention described in Scenario 2 of Section 5.1, "Creating Groups in OID".

- Oracle UCM integration configuration: Updating properties for integration with Oracle UCM as discussed in Chapter 6, "Configuring Oracle Universal Content Management Default Integration".

### 9.1.1 Modifying Labels

Customizable label sets for OSL Learning Tool are located in the `[OSL home directory]/LearningTool/Configuration/LearningTool/Labels` folder. Customizable label sets for OSL Learning Tool Admin are located in the `[OSL home directory]/LearningTool/Configuration/Admin/Labels` folder. Each file in these two folders is a resource bundle file that consists of key-value pairs. You can modify the content of the value fields.

WARNING:

Modify only the content of the value fields. Do not update the key fields or remove any key-value pairs.

### 9.1.2 Modifying Icons

Customizable icon sets for the OSL Learning Tool are located in the `[OSL home directory]/LearningTool/Configuration/LearningTool/Images` folder. Customizable icon sets for the OSL Learning Tool Admin `[OSL home directory]/LearningTool/Configuration/Admin/Images` folder. You can replace image files in these two folders. Ensure that the file names and directory structures remain the same.

### 9.1.3 Modifying Background Images

You can add or change the background images that are available in User Preferences.

To add or change background images:

1. Place the image and its corresponding thumbnail image in the `[OSL home directory]/LearningTool/Common/background` folder.

2. For each image you add or change, use the LT Configurator to update the following files:

   - BackgroundImagesRes.properties—This file contains the location of the background image.

     Make sure the thumbnail image file name follows the format:

     thumbnail_file_name-thumbnail.extension

     For example, if you have apple.jpg, the thumbnail file name should be apple-thumbnail.jpg.

   - BackgroundTitle.properties—This file contains the name of the background image. The name will appear in User Preferences.

### 9.1.4 Updating Security Role Mappings

This step is required only if the group names used in the OID or LDAP server are different from the OSL default values described in Section 5.1, "Creating Groups in OID". If you create LDAP groups using Scenario 2, you can ignore this step.

#### 9.1.4.1 Updating ADF Security Role Mappings

The OSL Learning Tool and OSL Learning Tool Admin use ADF Security to authorize users to perform different actions based on the user roles. These roles must be mapped from the LDAP Groups created in Section 5.1, "Creating Groups in OID".

Table 9-1 shows the default mappings between LDAP groups and OSL roles.

Table 9-1 Default Mappings between LDAP Groups and OSL Roles

OSL Role | OID Group Name
--- | ---
`osl-student` | `StudentGroup`
`osl-teacher` | `TeacherGroup`
`osl-parent` | `ParentGroup`
`osl-department-admin` | `DeptCurrAdminGroup`
`osl-department-curr-admin` | `DeptCurrAdminGroup`
`osl-school-admin` | `SchAdminGroup`
`osl-school-curr-admin` | `SchCurrAdminGroup`
`osl-dataloading` | `DataLoadingGroup`
`osl-content` | `ContentIntegrationGroup`

If you use existing LDAP groups instead of the groups listed above, replace the default group names in the `[OSL home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/jazn-data.xml` file.

For example, if the OID group for the `osl-school-admin` role is named `SchAdminPrinciples` instead of the default `SchAdminGroup`, then replace the `SchAdminGroup` entry inside `jazn-data.xml` with `SchAdminPrincipals`.

#### 9.1.4.2 Updating EJB Security Role Mappings

Table 9-2 lists the default mappings between J2EE security roles of OSL Learning Tool and LDAP groups. If your LDAP groups are different from the values in the LDAP Group Name column, then update the `<principal-name>` values in the `[OSL home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/weblogic-ejb-jar.xml` file accordingly.

Table 9-2 List of EJB Roles Mapped to the LDAP Groups

EJB Role | OID Group Name
--- | ---
`osl-student` | `StudentGroup`
`osl-teacher` | `TeacherGroup`
`osl-parent` | `ParentGroup`
`osl-dataloading` | `DataLoadingGroup`
`osl-content` | `ContentIntegrationGroup`
`osl-department-admin` | `DeptCurrAdminGroup`
`osl-department-curr-admin` | `DeptCurrAdminGroup`
`osl-school-admin` | `SchAdminGroup`
`osl-school-curr-admin` | `SchCurrAdminGroup`

### 9.1.5 Updating Content Integration Configuration

You can configure the settings for default integration with Oracle UCM in the `[OSL home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/osl_configuration.properties` file.

The following mandatory properties are available in the properties file. These properties have no default values.

Table 9-3 List of Mandatory Properties

Property Name | Description
--- | ---
osl.lt.web.contentAccess.homeURL | Oracle UCM server URL. In a default setup of Oracle UCM, this URL is: `http://<host>:<port>/idc`
osl.lt.web.contentAccess.attachedContentDelegateBaseURL | You can delegate the rendition of content attachment in OSL to the Content Access Web servlet. See osl.lt.web.contentAccess.delegateAttachedContentAccess. Define the URL to the Content Access Web servlet. In the default setup of OSL, this URL is: `http://<host>:<port>/ContentAccessWeb/contentdelegateservlet,` where `<host>:<port>` refers to the server to which Learning Tool is deployed.
osl.lt.content.ucmIntegration.ridcURI | RIDC URL of the Oracle UCM server. This value is `idc://<host>:<port> or idcs://<host>:<port>`. For related information, see Oracle® Universal Content Management Remote Intradoc Client (RIDC) Developer Guide at `http://download.oracle.com/docs/cd/E10316_01/ContentIntegration/ridc/ridc-developer-guide.pdf`.
osl.lt.web.contentAccess.attachedContentAccessBaseURL | The rendition of content attachment in OSL is done by the Content Access servlet. Define the URL to the Content Access servlet. In the default setup of OSL, this URL is: `http://<host>:<port>/LTWeb/contentaccessservlet` where `<host>:<port>` refers to the server to which the Learning Tool is deployed.
osl.lt.content.ucmIntegration.oslContentDoctype | UCM document type for OSL content.
osl.lt.content.ucmIntegration.update.URL | URL of the UCM update form. In a default setup of Oracle UCM, the URL is: `http://<host>:<port>/<idc_name>/idcplg?IdcService=GET_UPDATE_FORM`
osl.lt.content.ucmIntegration.search.URL | URL of the UCM search form. In a default setup of Oracle UCM, the URL is: `http://<host>:<port>/<idc_name>/idcplg?IdcService=GET_SEARCH_RESULTS`

The following mandatory properties define the Oracle UCM server settings. The default values are based on a standard Oracle UCM installation with no customization:

Table 9-4 List of Mandatory Properties for Oracle UCM Server

Property Name | Description | Default Value
--- | --- | ---
osl.lt.content.ucmIntegration.search.operatorAND | AND operator of the UCM core search service. | <AND>
osl.lt.content.ucmIntegration.search.operatorOR | OR operator of the UCM core search service. | <OR>
osl.lt.content.ucmIntegration.search.queryParam | Query text parameter of the UCM core search service. | QueryText
osl.lt.content.ucmIntegration.search.ImageFilter | Search clause for images. | dFormat <SubString> 'image'
osl.lt.content.ucmIntegration.search.LearningItemFilter | Search clause for an exported learning items. | dExtension <matches> 'osl'
osl.lt.content.ucmIntegration.metadataSeparator | Separator for metadata values within a metadata field. | ,
osl.lt.content.ucmIntegration.oslContentAutoDocname | Defines whether DocName is auto-generated or must be specified by clients during check-in. Valid values: true (if auto-generated) and false (if not auto-generated). | false

The following mandatory properties are set during the configuration of content storage and access. Instructions in Chapter 6, "Configuring Oracle Universal Content Management Default Integration" are based on the default values of these properties. If you used different naming conventions during content management integration, then update the corresponding values here:

Table 9-5 List of Mandatory Properties for Configuration of Content Storage and Access

Property Name | Description | Default Value
--- | --- | ---
osl.lt.content.ucmIntegration.generalContentMetadataUser | User name of the special user that default content integration uses when associating metadata to general content. | oslmetadata
osl.lt.content.ucmIntegration.oslContentSecurityGroup | Security group holding OSL content and exported learning items. | OSLDocuments
osl.lt.content.ucmIntegration.oslContentUser | User name of the special user that the default content integration uses when accessing OSL content. | oslcontent
osl.lt.content.ucmIntegration.oslContentMainAccount | Account of the permanent space for OSL content. | OSL/oslcontent/main
osl.lt.content.ucmIntegration.publishedContentSecurityGroup | Security group for exported learning items. | Public
osl.lt.content.ucmIntegration.publishedContentAccount | Account for the exported learning items. | Public
osl.lt.content.ucmIntegration.publishedContentProfile | Profile for exported learning items | OSLPublic

The following properties are related to the Web service URI:

Table 9-6 List of Properties Related to Web Service URI

Property Name | Description | Default Value
--- | --- | ---
osl.lt.service.content.contentProxytype | Indicates how content integration communicates with the Learning Tool. The valid values are Internal and WS. If the value is WS, then set the following three properties. | Internal
osl.lt.service.content.wsProxyGeneralContentServiceURL | Service end point of the General Content Service Implementation. |
osl.lt.service.content.wsProxyOSLContentServiceURL | Service end point of the OSL Content Service Implementation. |
osl.lt.service.content.wsProxyPublishServiceURL | Service end point of the Publishing Content Service Implementation. |

### 9.1.6 Updating OBIEE Integration Configuration

Table 9-7, "Properties for configuring OBIEE integration" describes the properties for configuring OBIEE integration.

Table 9-7 Properties for configuring OBIEE integration

Property Name | Description | Default Value
--- | --- | ---
osl.lt.obiee.integration.protocol | Protocol that talkes to OBIEE. The available values are http and https. | http
osl.lt.obiee.integration.host | OBIEE server host name or IP address |
osl.lt.obiee.integration.port | OBIEE server port |

You can configure these properties in this file: `[OSL Home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/osl_configuration.properties`.

### 9.1.7 Updating Logout URL for Learning Tool and Learning Tool Admin

Table 9-8, "Properties for configuring the logout URL for Learning Tool and Learning Tool Admin" describes the properties for configuring the logout URL for Learning Tool and Learning Tool Admin.

Table 9-8 Properties for configuring the logout URL for Learning Tool and Learning Tool Admin

Property Name | Description
--- | ---
osl.lt.logout.url | LearingTool Logout URL
osl.admin.logout.url | LearingTool Admin Logout URL

Note:

These properties are useful to customize the logout URL to support features such as SSO logout. If you do not specify values for these properties, the default ADF logout is used.

You can configure these properties in this file: `[OSL Home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/osl_configuration.properties`.

### 9.1.8 Updating Curriculum Framework Caching Configuration

The following table describes the property for configuring the curriculum framework caching.

Table 9-9 Property for Configuration of Curriculum Framework Caching

Property Name | Description | Default Value
--- | --- | ---
osl.lt.web.enableFrameworkDataCaching | Property to configure to cache the curriculum framework data in the Web layer. | true

### 9.1.9 Updating JPA Cache Isolation Configuration

The table list the properties to configure JPA cache isolation.

Table 9-10 List of Properties

Property Name | Description | Default Value
--- | --- | ---
osl.lt.model.cache.isolation.enable | Property to configure the JPA cache isolation. | false

### 9.1.10 Controlling the display of Learning Item Types in Teacher UI

You can control the types of learning items that display or do not display under the New button menu on the lesson plan and class plan pages of the Teacher UI. Set the appropriate values in the osl_learning_item_types.xml file during OSL installation. This XML file is located in the <OSL home directory>/LearningTool/Configuration/LearningTool/DeploymentDescriptors directory.

Below are the default settings for the osl_learning_item_types.xml file:

    <LearningItemTypes>
    <LearningItemType name="Folder" available="Y"/>
    <LearningItemType name="Document" available="Y"/>
    <Separator/>
    <LearningItemType name="Discussion" available="Y"/>
    <LearningItemType name="Journal" available="Y"/>
    <LearningItemType name="Submission" available="Y"/>
    <LearningItemType name="Task" available="Y"/>
    <LearningItemType name="Reference" available="Y"/>
    </LearningItemTypes>

The following changes are supported in osl_learning_item_types.xml:

- You can make any LearningItemType unavailable by setting the property named `available` to `N`. The default value is `Y`.

  Note:

  The items marked as `N` are hidden from the New button menu. However, the existing learning items of these types (in OSL upgrade scenarios) continue to work in the application. The import and export of such learning items also continues to work.

- You can move the `Separator` tag up or down the list of learning item types. There can be more than one `Separator` tags in the osl_learning_item_types.xml file at different places. The `Separator` tags cause a line separator between two learning item types in the New button menu on the lesson plan and class plan pages of the Teacher UI.

### 9.1.11 Customizing the CKEditor toolbar

You can customize your CKEditor toolbar by adding buttons to the toolbar. The customizable CKEditor is in the `[OSL Home directory]/LearningTool/Configuration/LearningTool/ckeditor` directory.

To customize the CKEditor toolbar:

1. Place the new CKEditor plug-in in the <OSL installation directory>`/LearningTool/Configuration/LearningTool/ckeditor/plugins` directory.

2. Load the plug-in by modifying the config_default.js in the <OSL installation directory>`/LearningTool/Configuration/LearningTool/ckeditor` directory:

   1. Append the plug-in name in config.extraPlugins.

   2. Add the plug-in icon name in a proper location in config.toolbar.

## 9.2 Deployment Configuration

The following sections describes the deployment configuration.

### 9.2.1 Recommended Configuration for OSL Deployment in a WebLogic Cluster

Prior to deploying OSL application in a WebLogic cluster, do the following configuration changes.

1. In `[OSL Home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/osl_configuration.properties`, configure the following properties.

   Table 9-11 Configure the following properties

   Property | Value
   --- | ---
   osl.lt.model.cache.isolation.enable | true
   osl.lt.web.enableFrameworkDataCaching | true

2. In `[OSL Home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/persistence.xml`, add the following eclipselink property.

   `<property name="eclipselink.cache.shared.default" value="false"/>`

The above configuration disables the shared JPA cache. However, the Framework data is cached at the application level for better performance.

Note:

Since the Framework data is cached at the application level in the LT Web, any update to the Framework data through the Administration screens or through Data Loading Services will not be automatically reflected in the LT Web. Hence, with this configuration, OSL LT application must be restarted whenever any change occurs to the Framework data.

### 9.2.2 Recommended Configuration for OSL Deployment in a Single WebLogic Instance

The out of the box OSL archive has JPA cache and application level cache for Framework data enabled for performance reasons. However, if implementations foresee frequent changes to the Framework through the Administration screens or the Data Loading Services, the following property configuration is recommended.

1. In `[OSL Home directory]/LearningTool/Configuration/LearningTool/DeploymentDescriptors/osl_configuration.properties`, configure the following property.

   Table 9-12 Configure the following properties

   Property | Value
   --- | ---
   osl.lt.web.enableFrameworkDataCaching | false

This configuration disables the application level Framework cache. Any changes to the Framework data through the Administration screens or through the Data Loading Services will be automatically reflected in the JPA cache and the application does not require a restart.

### 9.2.3 File Upload Limit

The web.xml file in the `[OSL home directory] /LearningTool/Configuration/LearningTool/DeploymentDescriptors` directory contains the following parameters:

- org.apache.myfaces.trinidad.UPLOAD_MAX_DISK_SPACE: Used to configure the file upload limit. This parameter sets the default limit at 2,000 KB. You can change the value of this parameter to increase the file upload limit.

- org.apache.myfaces.trinidad.UPLOAD_TEMP_DIR: Specifies the default directory named /tmp/TrinidadUploads/ to store temporary files created during file upload. Ensure that this directory exists in the Learning Tool server and has the necessary permissions to create files. If this directory does not exist, create the directory as root user and assign full permission (777).

### 9.2.4 Configuring authentication mechanism for non-SSO environment

The OSL .ear file is configured to support deployment in an SSO environment (OSSO or OAM) by default. If you want to configure OSL in an SSO environment, you can ignore this step.

To configure OSL in a non-SSO environment for OSL to use form-based authentication, update the <login-config> option in the web.xml file:

1. Update OSL Learning Tool web.xml file located in the [OSL Home directory]/LearningTool/Configuration/LearningTool/ DeploymentDescriptors directory as follows:

       <!--<login-config>    <auth-method>CLIENT-CERT</auth-method>    <realm-name>myRealm</realm-name></login-config>  --><login-config>    <auth-method>FORM</auth-method>    <form-login-config>      <form-login-page>/faces/loginView.jspx</form-login-page>      <form-error-page>/faces/loginErrorView.jspx</form-error-page>    </form-login-config></login-config>

2. Update the OSL Learning Tool Admin web.xml file located in the [OSL Home directory]/LearningTool/Configuration/Admin/ DeploymentDescriptors directory as follows:

       <!--<login-config>    <auth-method>CLIENT-CERT</auth-method>    <realm-name>myRealm</realm-name></login-config>
       --><login-config>    <auth-method>FORM</auth-method>    <form-login-config>      <form-login-page>/faces/Login.jspx</form-login-page>      <form-error-page>/faces/LoginError.jspx</form-error-page>    </form-login-config></login-config>

## 9.3 Running the OSL Learning Tool Configurator

You must run the OSL Learning Tool Configurator if you have customized any of the OSL settings. These settings are described in Section 9.1.1, "Modifying Labels" to Section 9.1, "Customizing OSL Settings". The OSL Learning Tool Configurator is delivered as an ANT script to repackage the OSLLearningToolApp.ear with a customized file set.

1. Update the `[OSL home directory]/LearningTool/Scripts/build.properties` file as described in Table 9-13.

   Table 9-13 OSL LT Configurator Properties

   Property | Default Value | Description
   --- | --- | ---
   lt.ear.path | .. | Location of `OSLLearningToolApp.ear`
   lt.label.path | ../Configuration/LearningTool/Labels | Location of the folder that contains the customized labels and texts for the OSL Learning Tool
   lt.image.path | ../Configuration/LearningTool/Images | Location of the folder that contains the customized icons and images for the OSL Learning Tool
   lt.dd.path | ../Configuration/LearningTool/DeploymentDescriptors | Location of the folder that contains the customized deployment descriptors for the OSL Learning Tool
   ltadmin.label.path | ../Configuration/Admin/Labels | Location of the folder that contains the customized labels for the OSL Learning Tool Admin
   ltadmin.image.path | ../Configuration/Admin/Images | Location of the folder that contains the customized icons andimages for the OSL Learning Tool Admin
   ltadmin.dd.path | ../Configuration/Admin/DeploymentDescriptors | Location of the folder that contains the customized deployment descriptors for the OSL Learning Tool Admin
   lt.resource.path | ../Configuration/Common/resources | Location of the folder that contains the BackgroundImagesRes.properties and BackgroundTitle.properties files
   lt.resource.background.path | ../Configuration/Common/background | Location of the folder that contains the background images

2. Run the OSL Learning Tool Configurator using ANT:

       [~]#cd $DOMAIN_HOME/bin
       [bin]#source./setDomainEnv.sh
       [bin]#cd [OSL Home directory]/LearningTool/Scripts
       [Scripts]#ant repackageLT

   The `OSLLearningToolApp.ear` located in the `[OSL home directory]/LearningTool` folder is updated with the new configuration described in Section 9.1, "Customizing OSL Settings" and Section 9.2, "Deployment Configuration".

## 9.4 Running the Deployment Script

You can deploy the OSL Learning Tool and OSL Learning Tool Admin using the ANT script.

To deploy the OSL Learning Tool and OSL Learning Tool Admin to the WebLogic Server:

1. Open the `[OSL home directory]/LearningTool/Scripts/build.properties` file.

2. Modify the configuration options to suit your environment.

   Table 9-14 describes the list of properties to set.

   Table 9-14 Deployment Properties

   Property | Description | Remark
   --- | --- | ---
   lt.weblogic.host | Host name or IP address of the WebLogic Server to which to deploy the OSL Learning Tool. |
   lt.weblogic.server | Name of the WebLogic Server to which to deploy the OSL Learning Tool. |
   lt.weblogic.admin.port | Port of the WebLogic Admin Server of the domain in which lt.weblogic.server is configured. | The default value in the WebLogic installation is 7001.
   lt.ear.path | Location of the OSLLearningToolApp.ear file. By default, the OSLLearningToolApp.ear file is located in the parent folder of the folder that contains this file. | You do not have to change the default value when installing from the installation directory.

3. Run the deployment using ANT:

       [~]#cd $DOMAIN_HOME/bin
       [bin]#source ./setDomainEnv.sh
       [bin]#cd [OSL Home directory]/LearningTool/Scripts
       [Scripts]#ant deployLT

   Note:

   When deploying the Learning Tool using the ANT script for the first time, if the security policies do not migrate into the $DOMAIN_HOME/config/fmwconfig/system-jazn-data.xml file, do the following:

   1. After your OSL-specific WebLogic managed server is created:

      1. Go to FMW Control using this URL - http://<WLS Server>:7001/em.

      2. Select your managed server in the left menu (under the WebLogic domain).

      3. Click the Apply JRF button that appears on the middle area in this screen.

         Figure 9-1 Apply JRF button

         If you cannot see this button, then probably it has been applied and no action is needed.

   2. Ensure that the OSL-specific WebLogic managed server is disabled, and the WebLogic Administration Server is running.

## 9.5 Disabling WSDL Files Access in WebLogic Server

This configuration is applicable to the OSL deployment in WebLogic Server 10.3.3.

To disable access of WSDL files in WebLogic:

1. Open the Oracle WebLogic Administration Console:

   Start the Oracle WebLogic Server. For more information, see "Start and Stop servers" in the Oracle WebLogic Administration Console Online Help.

2. Open a supported Web browser and navigate to the following URL:

   ```http://<WLS host name>:<port>/console`

3. Expand the Web services list.

4. Select any Web service.

5. Click the Configuration tab.

6. Clear the View Dynamic WSDL Enabled check box.

7. Click Save.

   The deployment plan is created.

8. Complete steps 1-7 for all Web services.

9. Access the WSDL URL.

   The WSDL does not display.