Configuring Sterling Configurator Visual Modeler

Sterling Configurator Visual Modeler is provided as part of the Sterling Configurator integration with WebSphere® Commerce.

About this task

Sterling Configurator Visual Modeler is a modeling application that administrators use to configure models for dynamic kits. The WebSphere Commerce integration with Sterling Configurator provides administrators with the capability to import dynamic kits from a modeler, such as Sterling Configurator Visual Modeler, or to directly access Sterling Configurator Visual Modeler from the WebSphere Commerce Management Center. The integration requires that you configure Sterling Configurator Visual Modeler for WebSphere Commerce.

To configure Sterling Configurator Visual Modeler for integration with WebSphere Commerce, follow these steps:

Procedure

Copy the VM_wardir/WEB-INF/properties/pagetypes.properties file to a temporary location, and then update the copied file. VM_wardir refers to the WAR directory under the EAR directory in the deployed Sterling Configurator Visual Modeler application.
For example, copy opt/WebSphere/AppServer/profiles/vmprofile/installedApps/m2svt37Node03Cell/Sterling_201301 11_dev_war.ear/Sterling_20130111_dev.war/WEB-INF/properties/pagetypes.properties

to /opt/WebSphere/tpltemp/.

In the example, opt/WebSphere/AppServer/profiles/vmprofile/installedApps/m2svt37Node03Cell/Sterling_201301 11_dev_war.ear/Sterling_20130111_dev.war equals VM_wardir, which refers to the EAR and WAR directories in the deployed Sterling Configurator Visual Modeler application.
In the copied file, make the following modifications:
1. Add ,COMMERCE to pagetypes.
2. Add COMMERCE.name=Commerce Configurator and COMMERCE.jsppage=commerceConfigurator.jsp to the end of the file.
  For example:
```
pagetypes=NORMAL,TABBED,STEPWISE,COMMERCE
NORMAL.name=Normal Configurator
NORMAL.jsppage=configurator.jsp
TABBED.name=Tabbed Configurator
TABBED.jsppage=configuratorTabbed.jsp
STEPWISE.name=Stepwise Configurator
STEPWISE.jsppage=Configurator_Stepped.jsp
COMMERCE.name=Commerce Configurator
COMMERCE.jsppage=commerceConfigurator.jsp
```
Copy VM_wardir/WEB-INF/classes/com/comergent/reference/apps/visualModeler/beans/DisplayTabResourceBundle.properties to a temporary location, and then update the copied file by adding the following lines:
```
# WebSphere Commerce custom configurator
COMMERCE.name=Commerce Configurator
```
Start the Sterling Configurator Visual Modeler server. To start the server, go to the <VM_profiledir>/bin/ directory and run the ./startServer server1 command.
Deploy the files updated in step 1 and step 2 to the application using a partial application update. For more information on partial application updates, see Ways to update enterprise application files in the WebSphere Application Server documentation. Use these sample steps as a guide to deploying the WebSphere Application Server Administrative Console:
1. Open the Sterling Configurator Visual Modeler WebSphere Application Server Console by pointing your browser at: https://<hostname>:<port>/ibm/console. You can obtain the port from the Administrative console secure port line in <VM_profiledir>/logs/AboutThisProfile.txt.
2. Open Applications > Application Types > WebSphere enterprise applications.
3. Check the box beside the Sterling Configurator Visual Modeler Application, and click Update.
4. Choose Replace or add a single file.
5. In the Specify the path beginning with the installed application archive file to the file to be replaced or added field, enter Sterling_20141008_dev.war/WEB-INF/properties/pagetypes.properties.
6. Choose Remote file system and enter the path to pagetypes.properties in the temporary directory that you created. For example, /opt/WebSphere/tpltemp/pagetypes.properties.
7. Click Next, and then click OK. Wait for the update to complete and then click Save.
8. Repeat steps a-g with an installed path of Sterling_20141008_dev.war/WEB-INF/classes/com/comergent/reference/apps/visualModeler/beans/DisplayTabResourceBundle.properties and your temporary path to DisplayTabResourceBundle.properties. For example,/opt/WebSphere/tpltemp/DisplayTabResourceBundle.properties.

WebSphere Commerce V7 FEP7 WebSphere Commerce V7 FEP8 Sterling Order Management V9.3 Sterling Order Management V9.4 Sterling Order Management V9.5 Perform steps 5-9 for only these releases.

Copy VM_wardir/WEB-INF/web.xml to a temporary location, and then update the copied file by adding the following at the end of the filter definitions:

<filter><filter-name>WCContextCookieFilter</filter-name>
<filter-class>com.ibm.commerce.filters.WCContextCookieFilter</filter-class><init-param>
<param-name>Parameters</param-name>
<param-value>WC_USERACTIVITY,storeId,contractId,currency,identityId,identitySignature
</param-value></init-param></filter>

Add the following in filter mappings towards the end of DispatchServlet filter mappings after CookieCredentialFilter:

<filter-mapping><filter-name>WCContextCookieFilter</filter-name>
<servlet-name>DispatchServlet</servlet-name></filter-mapping>

Add the following in filter mappings towards the end of NoCacheDispatchServlet filter mappings after CookieCredentialFilter:

<filter-mapping><filter-name>WCContextCookieFilter</filter-name>
<servlet-name>NoCacheDispatchServlet</servlet-name></filter-mapping>

Copy VM_wardir/WEB-INF/properties/init.xml to a temporary location, and then update the copied file by adding the following towards the end of the file just before the ending element tag:
```
<module name="WebSphereCommerce"> <config name="MessageType">
WEB-INF/properties/WebSphereCommerceMessageTypes.xml </config></module>
```
Copy VM_wardir/WEB-INF/properties/ObjectMap.xml to a temporary location, and then update the copied file by adding the following lines towards the end:
```
<Object ID="com.comergent.api.msgService.MsgContext"><ClassName>
com.ibm.commerce.msgservice.WCMsgContext</ClassName></Object>
```
Move the following files from the WebSphere Commerce server to a temporary directory, such as /opt/WebSphere/tpltemp, on the Sterling Configurator Visual Modeler server:
- WC_installdir/components/foundation/samples/integration/SterlingConfigurator/visualModeler/WebSphereCommerceMessageTypes.xml
  
  WC_installdir/samples/integration/SterlingConfigurator/visualModeler/WebSphereCommerceMessageTypes.xml
- WC_installdir/components/foundation/samples/integration/SterlingConfigurator/visualModeler/commerceBlankWhite.jsp
  
  WC_installdir/samples/integration/SterlingConfigurator/visualModeler/commerceBlankWhite.jsp
- WC_installdir/components/foundation/samples/integration/SterlingConfigurator/SterlingCommerceVisualModeler.jar
  
  WC_installdir/samples/integration/SterlingConfigurator/SterlingCommerceVisualModeler.jar
- WC_eardir/Foundation-Core.jar

Deploy the following files to the application using a partial application update. For instructions, see step 4.

Table 1. Deploying files to the application
Installed path (for example, Sterling_20141008_dev.war Sterling Configurator Visual Modeler WAR directory under EAR directory	File to update/add (For example, using /opt/WebSphere/tpltemp/ as a temporary directory)
Sterling_20141008_dev.war/WEB-INF/web.xml	/opt/WebSphere/tpltemp/web.xml
Sterling_20141008_dev.war/WEB-INF/properties/init.xml	/opt/WebSphere/tpltemp/init.xml
Sterling_20141008_dev.war/WEB-INF/properties/ObjectMap.xml	/opt/WebSphere/tpltemp/ObjectMap.xml
Sterling_20141008_dev.war/WEB-INF/properties/WebSphereCommerceMessageTypes.xml	/opt/WebSphere/tpltemp/WebSphereCommerceMessageTypes.xml
Sterling_20141008_dev.war/WEB-INF/web/en/US/visualModeler/commerceBlankWhite.jsp	/opt/WebSphere/tpltemp/commerceBlankWhite.jsp
Sterling_20141008_dev.war/WEB-INF/lib/SterlingCommerceVisualModeler.jar	/opt/WebSphere/tpltemp/SterlingCommerceVisualModeler.jar
Sterling_20141008_dev.war/WEB-INF/lib/Foundation-Core.jar	/opt/WebSphere/tpltemp/Foundation-Core.jar

Perform steps 10-12 for all releases.

Verify initialization parameters for Sterling Configurator Visual Modeler in the WebSphere Application Server Administrative Console.
1. Open the Sterling Configurator Visual Modeler WebSphere Application Server Console by pointing your browser at: https://<hostname>:<port>/ibm/console. You can obtain the port from the Administrative console secure port line in <VM_profiledir>/logs/AboutThisProfile.txt.
2. Open Applications > Application Types > WebSphere enterprise applications.
3. Click the Sterling Configurator Visual Modeler Application.
4. In the Web Module Properties section, click Initialize parameters for servlets.
5. Locate the comergent.preferences.store web module. If the value is empty, set the value to the following path:
  <VM_installdir>/projects/matrix/prefs.xml
  
  <VMSDK_installdir>/projects/matrix/prefs.xml
  
  For example, /opt/Sterling/VMSDK/projects/matrix/prefs.xml.
Restart the server for Sterling Configurator Visual Modeler.
In Sterling Configurator Visual Modeler, create a storefront for the organization that you created in Sterling Configurator.
1. Log on to Sterling Configurator Visual Modeler at http://host_name:port/Sterling/en/US/enterpriseMgr/matrix as an administrator. You can obtain the port from the HTTP transport port line in <VM_profiledir>/logs/AboutThisProfile.txt.
2. Click the following:
  Go in the Search for Organization by Name section of the home page.
  
  Search under System Administration > View your Organization Profile.
3. Click Create storefront.
4. Complete the following fields:
  Profile Name
  
  Any string with the recommendation that you use the name of the WebSphere Commerce store; for example, Aurora. This value must be 20 characters or less.
  
  Organization ID
  
  The name of the Sterling organization code; for example, AuroraESite.
  
  Skin URL
  
  The style that the store uses.
  The skin URL is mapped to the Sterling organization code. For example, if the Sterling organization code is AuroraESite, the skin URL needs to be the same.
  
  The skin URL is independent of the organization code. For example, if the organization code is AuroraESite, the skin URL can be Aurora.
  
  Note: The URL must contain only upper and lowercase ASCII letters, digits, and the underscore character.
5. Click Save. Some additional tabs are shown.
6. Click the Detail tab. In the External Partner ID field, type the Sterling organization code, then click Save.
  Note: The External Partner ID is mapped to the Sterling organization code. For example, if the organization code is AuroraESite, the External Partner ID must be AuroraESite.
7. Click View users.
8. Click Create user, then complete the fields. The password must be at least 8 characters. For the user functions, select all options, including Manager, and then click Save. You can now open the Sterling Configurator Visual Modeler at the following location using the organization that you created:
  http://<hostname>:<port>/Sterling/en/US/enterpriseMgr/skin
  
  where,
  
  <port> is the same port that you used in step a. You obtain the port from the HTTP transport port line in <VM_profiledir>/logs/AboutThisProfile.txt.
  
  skin is the same skin URL that you used in step d.
9. (Optional) Repeat steps c-h to create each storefront for each enterprise organization that you created in Sterling Configurator.