Deploying Asset Picker

Prerequisites

  • Ensure that JRE 1.8 or higher works for Asset Picker.
    Note: Asset Picker does not support clustered environment.
  • UnicaPlatformDS JNDI resource for Platform database is required for Asset Picker. See this guide to learn how to set up UnicaPlatformDS data source.

Setting Asset Picker home JVM argument

  1. Add the following JVM argument to the application server, where Asset Picker is required to be deployed.

    -DASSET_PICKER_HOME= path_where_asset_picker_is_installed

    For example: ASSET_PICKER_HOME =/opt/Platform/AssetPicker

    Point ASSET_PICKER_HOME to the directory, where Asset Picker is installed. It is installed within AssetPicker directory under UNICA_PLATFORM_HOME.

  2. Provide write permissions to the logs directory already created inside ASSET_PICKER_HOME.

Deployment procedure

You must follow a set of guidelines, when you deploy Asset Picker on your web application server. There is a different set of guidelines for deploying Asset Picker on WebLogic and on WebSphere. When you ran the suite installer, you completed the following action:
  • You created the WAR file of Asset Picker (asset-viewer.war) inside UNICA_PLATFORM_HOME/AssetPicker directory. UNICA_PLATFORM_HOME refers to the Unica Platform installation location.
Note: It is assumed that you possess information on how to work with your web application server. Consult your web application server documentation for details

Guidelines for deploying Asset Picker on WebLogic

You must follow a set of guidelines when you deploy Asset Picker on the WebLogic application. Use the following guidelines when you deploy the Asset Picker on any supported version of WebLogic:

  • Unica products customize the Java virtual machine (JVM) that is used by WebLogic. If you encounter errors related to JVM, you can create a WebLogic instance that is dedicated to Unica products.
  • Open the startWebLogic.cmd file and verify that the SDK that is selected for the WebLogic domain that you are using is the Sun SDK for the JAVA_VENDOR variable.
  • The JAVA_VENDOR variable must be set to Sun (JAVA_VENDOR=Sun). If theJAVA_VENDOR variable is set to JAVA_VENDOR, it means that JRockit is selected. You must change the selected SDK, as JRockit is not supported. See the BEA WebLogic documentation to change the selected SDK.
  • Deploy Asset Picker as a web application.
  • If you are configuring WebLogic to use the IIS plug-in, review the BEA WebLogic documentation.
  • Complete the following tasks for your installation to support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters.
    1. Edit the setDomainEnv script in the bin directory under your WebLogic domain directory to add -Dfile.encoding=UTF-8 to JAVA_VENDOR.
    2. In the WebLogic console, click the Domain link on the home page.
    3. In the Web Applications tab, select the Archived Real Path Enabled check box.
    4. Restart WebLogic.
    5. Deploy and start the asset-viewer.war file.
  • If deploying in a production environment, set the JVM memory heap size parameters to 1024 by adding the following line to the setDomainEnv script: Set MEM_ARGS=-Xms1024m -Xmx1024m -XX:MaxPermSize=256m

Guidelines for deploying Asset Picker on WebSphere®

You must follow a set of guidelines when you deploy Asset Picker on Websphere. Ensure that the version of WebSphere meets the requirements that are described in the Recommended Software Environments and Minimum System Requirements document, including any required fix packs. Use the following guidelines when you deploy Asset Picker on WebSphere:
  1. Specify the following custom property in the server:
    • Name: com.ibm.ws.webcontainer.invokefilterscompatibility
    • Value: true
  2. Deploy the asset-viewer.war file as an enterprise application. When you deploy the asset-viewer.war file, ensure that the JDK source level is set to 18 for SDK 1.8:
    1. In the form, select the WAR file, select Show me all installation options and parameters so the Select Installation Options wizard runs.
    2. In step 3 of the Select Installation Options wizard, ensure that the JDK Source Level is set to 18 for SDK 1.8.
    3. In step 8 of the Select Installation Options wizard, select UnicaPlatformDS as the matching Target Resource. UnicaPlatformDS JNDI resource must be present for Asset Picker. See the guide to know how to set up UnicaPlatformDS data source.
    4. In step 10 of the Select Installation Options wizard, the context root must be set to /asset-viewer( all lower case).
  3. For your installation to support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters, add the following arguments to Generic JVM Arguments at the server level.
    • -Dfile.encoding=UTF-8
    • -Dclient.encoding.override=UTF-8
    Note: Navigation tip: Select Servers > Application Servers > Java and Process Management > Process Definition > Java Virtual Machine > Generic JVM Arguments. See the WebSphere documentation for additional details.
  4. In the Applications > Enterprise Applications section of the server, select the WAR file that you deployed, then select Class loading and update detection and specify the following properties.
    • For Class loader order, select Classes loaded with local class loader first (parent last).
    • For WAR class loader policy, select Single class loader for application.
  5. Start your deployment. If your instance of WebSphere is configured to use a JVM version 1.7 or higher, complete the following steps to work around an issue with the time zone database.
    1. Stop WebSphere.
    2. Download the Time Zone Update Utility for Java (JTZU).
    3. Follow the steps provided by the IBM (JTZU) to update the time zone data in your JVM.
    4. Restart WebSphere.
  6. In Websphere Enterprise Applications, select your Application > Manage Modules > Your Application > Class Loader Order > Classes loaded with local class loader first (parent last).
  7. The recommended minimum heap size for the basic functioning of the application is 512 and the recommended maximum heap size is 1024. Complete the following tasks to specify the heap size.
    1. In WebSphere Enterprise Applications, select Servers > WebSphere application servers > server1 > Server Infrastructure > Java and Process Management > Process definition > Java Virtual Machine.
    2. Set the initial heap size to 512.
    3. Set the maximum heap size to 1024 .
      Note: See the WebSphere documentation for more information about sizing.

For DB2, set progressiveStreaming = 2 in WebSphere console at following path: JDBC >Data sources > UnicaPlatformDS > Custom properties.

Guidelines for deploying Asset Picker on JBOSS

You must follow a set of guidelines when you deploy Asset Picker on JBoss. Ensure that the version of JBoss meets the requirements that are described in the Recommended Software Environments and Minimum System Requirements document. Use the following guidelines when you deploy Asset Picker on JBoss:

Use the following guidelines when you deploy the Asset Picker product on any supported version of JBoss:
  1. Deploy the asset-viewer.war file as an enterprise application. See https://docs.jboss.org/jbossweb/3.0.x/deployer-howto.html for instructions on Deploying Web Server Application in JBoss.
  2. Complete the following task if your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters.
    • Edit the following standalone.conf script in the bin directory under your JBOSS /bin directory to add to JAVA_VENDOR.
      • -Dfile.encoding=UTF-8
      • -Dclient.encoding.override=UTF-8
      • -Djboss.as.management.blocking.timeout=3600
  3. Restart JBOSS server.

Guidelines for deploying Asset Picker on Apache Tomcat®

You must follow a set of guidelines when you deploy Asset Picker on Apache Tomcat. Ensure that the version of Apache Tomcat meets the requirements that are described in the Recommended Software Environments and Minimum System Requirements document. Use the following guidelines when you deploy Asset Picker on Apache Tomcat.
  1. Deploy the HCL asset-viewer.war file as an enterprise application on Tomcat Apache server. Complete the following tasks if your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters.
    1. Edit the setenv.sh file for the respective product instances script in the bin directory under your tomcat instances directory to add -Dfile.encoding=UTF-8 Dclient.encoding.override=UTF-8 to JAVA_VENDOR.
    2. Restart Tomcat.
  2. If deploying in a production environment, you can add JVM heap setting for that Tomcat instance in app-one/bin/setenv.sh file respectively for all the instances.

Asset Picker | User Role Creation

The procedure included in this section is not required for the following scenarios:
  • It is a fresh installation. The installation process creates this role under default partition (partition1).
  • It is an upgrade and only one partition exists in the current system.

In case, it is an upgrade and system contains more than one partition, you must execute the following command manually for each partition, except partition1. The command exists under <PLATFORM_HOME>\tools\bin directory inside your Platform installation directory. This creates Asset Picker User role under each partition.

On Windows

populateDb.bat -n AssetPicker -p <partition_name>

On Unix

populateDb.sh -n AssetPicker -p <partition_name>