Running the installation scripts for the Persona-based UI

Run the installation scripts to automate the installation of the Persona-based UI.

Before you begin

Ensure that you complete the following tasks before you run the scripts for installing the Persona-based UI:
  • Install the InfoSphere® Master Data Management Collaboration Server - Collaborative Editionproduct. For more information, see Installing the product.
  • Download the installer of the Persona-based UI, and extract the installation files. For more information, see Downloading and extracting the Persona-based UI installer.
  • If you are upgrading to the InfoSphere Master Data Management Collaboration Server - Collaborative Edition version 11.6 Fix Pack 7 or later, run the following database migration script:
    $TOP/bin/migration/migrateToInstalledFP.sh --from=<FixPackVersion>
    Example
    $TOP/bin/migration/migrateToInstalledFP.sh --from=FP6
  • The WebSphere® Application Server is running with security is disabled.
    The Persona-based
    UI     does not support installation with WebSphere®
    Application Server     security enabled. To disable the  WebSphere®
    Application Server     security,
     Command-line interface 
    1. Go to the profile_root/bin folder.
    2. Run the wsadmin -conntype NONE command.
    3. At the wsadmin prompt, type securityoff and then type exit to return to a command prompt.
    4. Restart the server.
     Graphical user interface 
    1. Log in to the Administrative console.
    2. Click Security > Global security.
    3. Clear the Enable administrative security checkbox.
    4. Restart the server.

  • Free Text Search - If enabled, you must install and configure the Hazelcast IMDG and Elasticsearch. For more information, see Configuring the Hazelcast IMDG and Installing the Elasticsearch.

  • Digital Asset Management - If enabled, you must install MongoDB. For more information, see Installing MongoDB by using package management system (yum).
  • Machine Learning (ML) services - If enabled, you must install and configure Hazelcast IMDG and MongoDB. For more information, see Configuring the Hazelcast IMDG and Installing MongoDB by using package management system (yum). To install Python 3.6.9 and dependencies on the AIX, Ubuntu, RHEL, or CentOS, run the operating system-specific script file:
    $TOP_MDMCEUI/machinelearning/requirements/requirements_<OS>.sh
Following are the various properties of the newui_env_settings.ini file at the mdmceui/conf folder:
Task Updates
App server configuration
[was-server]
port - Specifies the app server port number. If the port 9090 is not available, change the port number.
REST Application configuration
[rest-app-war]
hostname - Specify the IP address of the REST server. Example: hostname=10.51.238.185
DAM
[mongo]
  •  ML services  mongo_database - Specifies the MongoDB database name.
  • mongo_hostname - Specifies the hostname of MongoDB server.
  •  ML services  mongo_username - Specifies the MongoDB username.
  •  ML services  mongo_password - Specifies the MongoDB user password.
  • mongo_port - Specifies the MongoDB port number. The default value is 27017.
Free Text Search
[freetext-search]
  • enable - Enables the Free Text Search, set the value to yes.
  • pimcollector_port - Specifies the port number for the pim-collector application. Change port number, if the port 9095 is not available.
  • indexer_port - Specifies the port number for the Indexer application. Change port number, if the port 9096 is not available.
  • elastic_cluster_name - Specifies the name of the Elasticsearch cluster. The default value is es-cluster.
  • elastic_server_hostname - Specifies the host name of the Elasticsearch Server, for example, "hostname=10.51.238.185".
  • elastic_server_http_port - Specifies the HTTP port number of the Elasticsearch Server, for example, "elastic_server_http_port =9200".
  • elastic_server_transport_port - Specifies the transport port number of the Elasticsearch Server, for example, "elastic_server_transport_port=9300".
Hazelcast configuration
[hazelcast]
  • hazelcast_server_IpAddress - Specifies the IP address of the Hazelcast Server, for example, "hazelcast_server_IpAddress=10.200.10.232".
  • hazelcast_server_port - Specifies the port number of the Hazelcast Server, for example, "hazelcast_server_port=5702".
Federated application server profile
[cluster]
Set the value of the enable property to yes. This deploys the Persona-based UI and REST applications on the Admin UI application server.
Note:
  • Also, applicable to the Dmgr and Appserver stand-alone profiles. The Persona-based UI gets deployed on the 7507 (default port number for the Admin UI).
  • This flag should be enabled either when cluster deployment is required or when deployment is on the federated WebSphere®.
Vendor role enabled
[vendor-portal]
Set the value of the enable property to yes.
Dashboards feature
[dashboards]
Set the value of the enable property to yes. The Dashboard module installs and configures the Derby 10.14.2 to run on the port 1535.
Important: Install WebSphere Application Server(WAS) with Java™ Development Kit (JDK) 8 version. For more information, see Installing and setting up the WebSphere® Application Server.
ML services enabled
[mlservice]
  • enable - Specifies whether the ML services are enabled. Possible value is "yes" or "no". The default value is "no".
  • ml_service_protocol - Specifies the protocol for the ML service.
  • ml_service_host - Specifies the hostname where the ML services are deployed.
  • ml_controller_port - Specifies the port number to start the controller service.
  • ml_predictor_port_range - Specifies the port number range for the ML prediction services.

Procedure

To run the installation scripts, complete the following steps:

  1. Go to the bin folder.
    For example, /opt/mdmceui/bin/
  2. Use the following commands to start the installation:
    Fresh installation
    ./installAll.sh
    Update installation
    ./installAll.sh --update
  3. To skip the prompts, run the following commands:
    Fresh installation
    ./installAll.sh -ov
    Update installation
    ./installAll.sh --update -ov
  4. Enter the following URL in the address bar of your browser to access the Persona-based UI:
    http://host_name:port_number/mdm_ce_ui
    The default value is http://host_name:9090/mdm_ce_ui.
  5. If Free Text Search service is enabled, then running the installAll.sh file also starts the pim collector and indexer services.
  6. If the Machine Learning services are enabled, then running the installAll.sh file also starts the Machine Learning services.
    To manually start services, proceed as follows:
     ML services 
    1. Go to the scripts folder, for example $TOP_MDMCEUI/machinelearning/scripts.
    2. Use the following commands as required:
      To start the service: python3.6 start.py
      To stop the service: python3.6 stop.py
      To check the status of the service: python3.6 status.py
     Persona-based UI server 
    $TOP_MDMCEUI/bin/startServer.sh
    $TOP_MDMCEUI/bin/stopServer.sh
     Free Text Search services 
    $TOP_MDMCEUI/bin/startFtsServices.sh
    $TOP_MDMCEUI/bin/stopFtsServices.sh
    Enable Free Text Search, for more details, see Free Text Search settings.

    To implement custom modifications, proceed as follows:

     Modifying the Persona base UI application properties 
    1. Browse to the config.json file located in the $TOP_MDMCEUI/dynamic/mdmceui folder.
    2. Update the required properties and run the updateRtProperties.sh script present in the $TOP_MDMCEUI/bin folder.
    3. Restart the server by using the start or stop server scripts present in the $TOP_MDMCEUI/bin folder.
     Supporting Java API extensions 
    1. In the WebSphere Application Server Administrative Console, browse to Application servers > servername > Process Definition > Java Virtual Machine > Classpath .
    2. Add the location of Java API extension JARs as specified in the $TOP/bin/conf/env_settings.ini file to the class path of the mdmceui server.
    3. Restart the mdmceui server.

What to do next

Complete the steps that are listed in the Postinstallation instructions for the Persona-based UI.