Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Not all the questions on this page are directly related to Canvas deployment, e.g. questions on Oracle database. Some of these questions were asked by participants during the Canvas training sessions. We have answered those here for the larger benefit of the Canvas Developer community.

...

Expand
titleWhat are the changes to be done when context root of the application is changed?

Let’s assume that the following are the details of the application: 

  • DATA_SOURCE_NAME : DliteCTDS
  • SCHEMA_NAME : CT_MIG
  • SCHEMA_NAME_PWD : CT_MIG
  • CONTEXT_ROOT : dliteweb
  • WAR_NAME : dliteweb
  • WORK_FOLDER : D:/Canvas19/dliteweb

As a sample reference, the following steps indicate the changes required for the JBoss app server and Oracle database environments. For other app server and database combinations, appropriate changes need to be done in the relevant files. 
Context Root changes

1. In the application WAR, in the JBoss folder, specify the context root in the \WEB-INF\jboss-web.xml file, as shown in the following code snippet:

Code Block
languagexml
<context-root> <CONTEXT_ROOT> </context-root>
<!-- For example -->
<context-root> dliteweb </context-root>

2. In the CTResources.jar, in the ....\Ctweb\Dependencies\Canvas\CTResources.jar\CanvasApplicationContext.json file, specify the context root, as shown in the following code snippet:

Code Block
languagebash
{
	"contextRoot": "<CONTEXT_ROOT>",
	"applicationId": "MODELHOUSE",
	"displayName": "CTWEB",
	"isService": "Y"
}
# For example
{
	"contextRoot": "dliteweb",
	"applicationId": "MODELHOUSE",
	"displayName": "CTWEB",
	"isService": "Y"
}

3. In the CtwebResource.jar, in the ....\Ctweb\CtwebResources\src\main\resource\Ctwebsecurityconfig.properties file, specify the default context root, as shown in the following code snippet: 

Code Block
languagexml
DEFAULT_CONTEXT_ROOT=/<CONTEXT_ROOT>
ALL_CONTEXT_ROOTS=<CONTEXT_ROOT>
<!-- For example -->
DEFAULT_CONTEXT_ROOT=dliteweb
ALL_CONTEXT_ROOTS=dliteweb

4. In the CtwebResource.jar, in the ....\CtwebResources\src\main\resource\Ctwebexportconfig.properties file, specify the context path, as shown in the following code snippet:

Code Block
languagexml
SESSION_TIMEOUT_URL=/<CONTEXT_ROOT>/index.jsp 
CONTEXT_PATH=/<CONTEXT_ROOT>
<!-- For example -->
SESSION_TIMEOUT_URL=dliteweb/index.jsp 
CONTEXT_PATH=dliteweb

JNDI Data source name change

1. In the CtwebResource.jar, in the ....\CtwebResources\src\main\resource\Ctwebdatabaseconfig.properties file, specify the JNDI data source name, as shown in the following code snippet:

Code Block
languagexml
CT_FW_DATASOURCE=java:/<DATA_SOURCE_NAME>
CT_FW_FILEIMPORT_DATASOURCE=java:/<DATA_SOURCE_NAME>
<!-- For example -->
CT_FW_DATASOURCE=java:/DliteCTDS 
CT_FW_FILEIMPORT_DATASOURCE=java:/DliteCTDS

2. In the application WAR, in the JBoss folder, specify the JNDI data source name in the ..../standalone/configuration/standalone.xml file, as shown in the following code snippet:

Code Block
languagexml
<datasource jndi-name="java:jboss/datasources/<DATA_SOURCE_NAME>" pool-name="<DATA_SOURCE_NAME>" enabled="true">
     <connection-url>jdbc:oracle:thin:@10.12.25.28:1521:SIR13714</connection-url>
     <driver-class>oracle.jdbc.driver.OracleDriver</driver-class>
     <driver>OracleJDBCDriver</driver>
     <security>
         <user-name><SCHEMA_NAME></user-name>
         <password><SCHEMA_NAME_PWD></password>
     </security>
</datasource>
<!-- For example -->
<datasource jndi-name="java:jboss/datasources/DliteCTDS" pool-name="DliteCTDS" enabled="true">
     <connection-url>jdbc:oracle:thin:@10.12.25.28:1521:SIR13714</connection-url>
     <driver-class>oracle.jdbc.driver.OracleDriver</driver-class>
     <driver>OracleJDBCDriver</driver>
     <security>
         <user-name>CT_MIG</user-name>
         <password>CT_MIG</password>
     </security>
</datasource>

3. In the application WAR, in the JBoss folder, specify the JNDI data source name in the \WEB-INF\jboss-web.xml file, as shown in the following code snippet:

Code Block
languagexml
<resource-ref>
   <res-ref-name>jdbc/CTwebCanvasDataSource</res-ref-name>
   <jndi-name>java:jboss/datasources/<DATA_SOURCE_NAME></jndi-name>
</resource-ref>
<!-- For example -->
<resource-ref>
   <res-ref-name>jdbc/CTwebCanvasDataSource</res-ref-name>
   <jndi-name>java:jboss/datasources/DliteCTDS</jndi-name>
</resource-ref>

Work Folder Changes

1. In the CtwebResource.jar, in the ....\CtwebResources\src\main\resource\CtwebImplementation.properties file, specify the work folder and centralized work folder paths, as shown in the following code snippet:

Code Block
languagexml
CT_WORK_FOLDER_PATH=<WORK_FOLDER>                
CT_WORK_CENTRALIZED_FOLDER_PATH=<WORK_FOLDER>   
<!-- For example -->
CT_WORK_FOLDER_PATH=D:/Canvas19/dliteweb                
CT_WORK_CENTRALIZED_FOLDER_PATH=D:/Canvas19/dliteweb

2. Specify the Web Application Resource (WAR) file name of the application in build.xml file, as shown in the following code snippet: 

Code Block
languagexml
<property name="WAR_FILE_NAME" value="${DIST_ROOT}/<WAR_NAME>.war" />
<!-- For example -->
<property name="dliteweb" value="${DIST_ROOT}/dliteweb.war" />


...

Expand
titleInstead of updating the CanvasApplicationContext.json file, update web.xml in the 19.1.7.11 19679 revision and above.
  • If the latest release revision is 19.1.7.11 19679 and above, refer to the following steps:

Perform the following steps to use the CT release as-is without the need to update the CanvasApplicationContext.json file in the CTResources.jar.

  1. Update web.xml in Canvas Studio WAR

File Location: ...\webapps\ctmodelhouse\WEB-INF\web.xml

The following snippet provides the sample values of the necessary elements and attributes that are to be configured within web.xml.

Code Block
<context-param>
<param-name>appId</param-name>
<param-value>MODELHOUSE</param-value>
</context-param>


Note

The param name should remain unchanged. Only "appId" should be used.

If the context-param attribute is already present in the web.xml for a different param-name, the new context-param attribute has to be added after that to configure the value of appId.

Refer to the following snippet for sample values of the necessary elements and attributes that are to be configured within web.xml.

Code Block
<context-param>
<param-name>ModelHouseInitializeBundle</param-name>
<param-value>MyImplementation</param-value>
</context-param>
<context-param>
<param-name>appId</param-name>
<param-value>MODELHOUSE</param-value>
</context-param>


...