4 Administering the Platform

This chapter describes administration of the DIVA Enterprise Connect platform and includes the following information:

Administration Overview

After you complete the basic configuration, you can use a combination of the WebLogic Administration Console and command-line utilities to administer the DIVA Enterprise Connect. The services must be operational to use the basic administrative functions described in the following sections.

Generating API Users and API Keys

DIVArchive Web Services clients must supply a user name and API key to access the services. Oracle recommends adding the user to the WebLogic platform using the API Key Generator command-line utility. You execute the API Key Generator script which generates a random clientID and a random API key, and adds them to the WebLogic user directory.

Linux

  1. Change to the $DIVAS_HOME/bin directory.

  2. Enter the WebLogic user name and password you previously created as arguments to the key generator as follows:

    ./runAPIKeyGenerator.sh --wluser {WL_admin_user_name} --wlpass {WL_admin_password}

  3. Write down the clientId and API key appearing in the script output. API clients must supply these values when making web service requests.

Windows

  1. From the command prompt, change to the %DIVAS_HOME%/%DOMAIN_NAME%_ec directory.

  2. Enter the WebLogic user name and password you previously created:

    runAPIKeyGenerator.cmd --wluser {WL_admin_user_name} --wlpass {WL_admin_password}

  3. Write down the clientId and API key that appear in the script output. API clients must supply these values when making web service requests.

Deleting or Modifying Users using the WebLogic Admin Console

You can delete, or modify, users through the WebLogic Admin Console. Use the following procedure to delete a user:

  1. Log in to the WebLogic Admin Console.

    A typical log in URL is http://127.0.0.1:7001/console.

  2. Navigate to Domain Structure, Security Realms, myrealm, Users and Groups, and then Users.

  3. Select the check box next to the name of the user that you want to delete, and click Delete.

Use the following procedure to modify a user:

  1. Log in to the WebLogic Admin Console.

    A typical log in URL is http://127.0.0.1:7001/console.

  2. Navigate to Domain Structure, Security Realms, myrealm, Users and Groups, and then Users.

  3. Click the name of the user that you want to modify.

  4. Complete the required modifications (for example, adding a new description), and click Save.

Starting and Stopping WebLogic Services with the DIVAS Script

The DIVArchive Web Services platform includes the DIVAS script located in the %DIVAS_HOME%/%DOMAIN_NAME%_ec directory on Windows or the $DIVAS_HOME/bin directory on Linux. You use the start, stop, and status options to control WebLogic, and the DIVArchive Web Services. You use the divaWebLogic, divaSvcs, and all options to dictate the scope of the command. You must provide one option from each category to run the script as follows:

DIVAS {start|stop|status|help} {divaWebLogic|divaSvcs|all}

The following list describes the command line options:

start

You use this option to start WebLogic (divaWebLogic), the DIVArchive Web Services (divaSvc), or both (all).

stop

You use this option to stop WebLogic (divaWebLogic), the DIVArchive Web Services (divaSvc), or both (all).

status

You use this option to view status information for WebLogic (divaWebLogic), the DIVArchive Web Services (divaSvc), or both (all).

help

You use this option to view help for the command.

divaWebLogic

You use this option to start, stop, or view status information for only the WebLogic server.

divaSvcs

You use this option to start, stop, or view status information for only the DIVArchive Web Services.

all

You use this option to start, stop, or view status information for DIVArchive Web Services and the WebLogic server platform.

Deploying a New .ear File

You can use the included script to redeploy the DIVArchive Web Services .ear file, or deploy a new one.

  1. Open a terminal console, and temporarily place the new .ear file in the directory %DIVAS_HOME% on Windows or $DIVAS_HOME on Linux.

  2. Change to %DIVAS_HOME%/%DOMAIN_NAME%_ec on Windows or $DIVAS_HOME/bin on Linux and execute the following command:

    Linux:
    ./deploy_ear.sh -svr DivaServices -app DIVAS.1.0.0 -ear
    ../diva-ws-ear-1.0.0-{buildNumber}.ear -wluser {wlUser} -wlpass {wlPassword}

    Windows:
    deploy_ear.cmd {earFilename} {wluser} {wlpassword}

    Where:

    • {buildNumber}— the specific DIVArchive Web Services build number

    • {wlUser} — the WebLogic user name

    • {wlPassword} — the WebLogic password associated with the user

This command deploys the .ear file in the dwsConfig directory to WebLogic - undeploying the service with the name DIVAS.1.0.0. In the current release, you must use DIVAS.1.0.0 as the application name for this operation.

You can also deploy an .ear file using the WebLogic Admin Console.

For more information refer to https://docs.oracle.com/middleware/12212/wls/WLACH/taskhelp/applications/ApplicationOverview.html.

Viewing Logs

The application logs are located in %DIVAS_HOME%/%DOMAIN_NAME%_ec/logs on Windows, and $DIVAS_HOME/logs on Linux. The installation log files are in %DIVAS_HOME%/%DOMAIN_NAME%_ec/logs on Windows or $DIVAS_HOME/logs/install on Linux.

To change the log level, open the WebLogic Admin Console and navigate to Environment, Servers, DivaServices, Logging, General, and then Advanced.

Set the Minimum severity to log, and the Message Destination Severity level to the appropriate logging level. You can optionally set additional severities for Standard out and the Domain log, and then click Save.

The HTTP access logs are also in the same directory as the application logs. The access logs track each HTTP request issued to the DIVA Enterprise Connect API. The HTTP access logs are stored in files with the file name format access*.log.

Uninstalling DIVA Enterprise Connect and Weblogic

Linux

Run the uninstall.sh script in $DIVA_HOME/bin as the root user. This script removes the service definition for DIVA Enterprise Connect. You can then delete the application files.

Windows

First stop the service by running the uninstall.cmd script located in %DIVA_HOME%/%DOMAIN_NAME%_ec. Then, run the Weblogic deinstall.cmd utility located in the %DIVAS_HOME%/oui/bin directory. The Windows Weblogic installer also creates a shortcut to a UI version of this utility. After running the utility, you can delete the application files.