Deploying Studio to the WebLogic domain

To install Studio, you use the WebLogic Server Administration Console to deploy endeca-portal-weblogic-3.1.x.ear into the WebLogic domain.

Note that when you deploy the .ear file to a WebLogic Administration Server, and you use the default WebLogic staging mode for an Administration Server, which is "nostage", then WebLogic does not copy the file from the download directory to the server.

If the file is deleted from its current location, then Studio cannot be loaded. So with this mode, once you deploy Studio, the .ear file must remain in the same location for as long as Studio is deployed.

If you use the "stage" mode, then WebLogic does copy the file.

For more information on the WebLogic staging modes, see the WebLogic documentation.

When you deploy using these instructions, the following default locations are used:

Location Default Value
Studio home directory By default, the Studio home directory is <MiddlewareHomeDirectory>/user_projects/domains/<StudioDomain>/eid/studio.
If this directory already exists, then before installing, make sure that it does not already contain the following subdirectories:
  • /data/endeca-data-sources
  • deploy
  • weblogic-deploy

If these directories exist, then it means there is an instance of Studio installed. For the installation to work correctly, these existing directories must be removed. Before moving these directories, also make sure that the other instance has been removed.

You can, if needed, change the location of the Studio home directory. To use a different directory for Studio home, then before you deploy Studio, you need to follow the instructions in Changing the Studio home directory on WebLogic Server.

Context path Studio is deployed to the /eid/ context in the domain.

When you created the domain, you should already have verified that there are no conflicts in that context.

After you deploy Studio, you can change the context root. See Changing the context path for Studio on WebLogic Server.

To deploy endeca-portal-weblogic-3.1.x.ear into a production environment:

  1. Set up the Studio home directory (the default is <MiddlewareHomeDirectory>/user_projects/domains/<StudioDomain>/eid/studio):
    1. In the Studio domain, create the Studio home directory.
    2. Extract the file portal-ext.properties from the top level of the Studio for WebLogic Server download .zip file.
    3. Place portal-ext.properties in the Studio home directory.
      This file is basically a stub configuration file you use to override default Studio configuration, for example when:
      • Changing the database used for Studio
      • Overriding Studio framework settings
      • Configuring a Studio cluster
      • Configuring a reverse proxy

      For the default Studio configuration, you do not need to make any changes to this file.

    4. In the Studio home directory, create the following subdirectories:
      • /data/endeca-data-sources
      • deploy
      • weblogic-deploy
  2. If WebLogic Server isn't already started, then to start it, run the WebLogic Server startup script.

    The startup script is in the domain directory.

    For Windows, the script name is startWebLogic.cmd.

    For Linux, the script name is startWebLogic.sh.

  3. Extract endeca-portal-weblogic-3.1.x.ear from the Studio for WebLogic Server download .zip file.

    To prevent the file from being inadvertently deleted after Studio is deployed, it is recommended that you place the file in a directory on the WebLogic Server. For example, you could create a directory such as user_projects/applications/studio.

  4. Use the WebLogic Server Administration Console to deploy endeca-portal-weblogic-3.1.x.ear into the domain.
    1. Go to the Administration Console at <hostname>:8101/console.
    2. Under Helpful Tools, click Configure applications.
      WebLogic console - Configuration Application link for the Studio domain
    3. If necessary, click Lock & Edit at the top left of the page.
    4. Click the Install button.
      Configuration Applications page with Install button for Studio deployment
    5. Use the file browser to find the endeca-portal-weblogic-3.1.x.ear file, then click the radio button to the left of it.
      WebLogic console - Studio .ear file selected
    6. Click Next.
    7. On the next page, under Choose targeting style, make sure the Install this deployment as an application radio button is selected, then click Next.
      WebLogic console - Select targeting style for the Studio deployment
    8. On the next page, accept the default selections, then click Finish.
      WebLogic Console - final page of the Studio deployment
    9. If necessary, click Activate Changes.
      Activate Changes button for the Studio deployment

    The deployment may take several minutes. Make sure you do not try to log in to Studio before the deployment is complete.

  5. When the deployment process is completed, the deployment status is Prepared. To start the deployment:
    1. In the Deployments list, check the checkbox for the Studio deployment.
      Deployments list with Studio deployment in Prepared state
    2. Click the Start button.
    3. From the drop-down list, select Servicing all requests.
    4. Under Start Deployments, click Yes.
      Start deployment confirmation for the Studio deployment
  6. To verify that Studio has deployed successfully, in a Web browser, go to http://<hostName>:<portNumber>/<context path>, where <hostName> is the name of the server, <portNumber> is the port number, and <context path> is the context path.

    For example, for a non-SSL implementation using the default context path: http://localhost:8101/eid

    You should see the Studio login page.