Deploying Studio into the domain

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

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

Context path --> Studio is deployed to the domain's root context.
Liferay Home directory --> The Liferay Home directory is C:\Oracle\Middleware\user_projects\domains.
To deploy endeca-portal-weblogic-3.0.x.ear into the Studio WebLogic domain:
1. Set up the Liferay Home directory (C:\Oracle\Middleware\user_projects\domains):
(a) Extract the file portal-ext.properties from the top level of EID_3.0.x_Studio_portal_weblogic.zip.
(b) Place portal-ext.properties in the Liferay Home directory.
(c) In the Liferay 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(C:\Oracle\Middleware\user_projects\domains\endeca_studio_domain\startWebLogic.cmd).
Alternatively, from the Windows Start menu, select Oracle WebLogic>User_Projects>endeca_studio_domain>Start Admin Server for Weblogic Server Domain.

3. Extract endeca-portal-weblogic-3.0.x.ear from EID_3.0.x_Studio_portal_weblogic.zip.

4. Use the WebLogic Administration Console to deploy endeca-portal-weblogic-3.0.ear into the domain.
(a) Go to the Administration Console at https://localhost:8101/console.
(b) On the login page, log in using the domain administrator user name and password.
(c) Under Helpful Tools, click Configure applications.




(d) If necessary, click Lock & Edit at the top left of the page.
(e) Click the Install button.


(f) Use the file browser to find the endeca-portal-weblogic-3.0.x.ear file, then click the radio button to the left of it.


(g) Click Next.
(h) On the next page, under Choose targeting style, make sure the Install this deployment as an application radio button is selected, then click Next.




(i) On the next page, accept the default selections, then click Finish.


(j) If necessary, click Activate Changes.


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:
(a) In the Deployments list, check the checkbox for the Studio deployment.


(b) Click the Start button.
(c) From the drop-down list, select Servicing all requests.
(d) Under Start Deployments, click Yes.

Creating the WebLogic domain for Studio

Before you can install Studio, you must create the WebLogic domain in which to deploy it.

To create the WebLogic domain for Studio:
1. From a command prompt, change to the directory that contains the Configuration Wizard start-up program:
C:\Oracle\Middleware\wlserver_10.3\common\bin

2. To start the Configuration Wizard, run the following command:
config.cmd


The Configuration Wizard Welcome page is displayed.
3. On the Welcome page, click the Create a new WebLogic domain radio button, then click Next.


4. On the Select Domain Source page, the Basic WebLogic Server Domain checkbox is checked by default. Click Next.


5. On the Specify Domain Name and Location page:

(a) Set the domain name to endeca_studio_domain.
(b) Keep the default domain location.
(c) Click Next.



6. On the Configure Administrator User Name and Password page, to create the administrator credentials for starting the Studio domain:

(a) In the Name field, type the name for the new administrator user.
(b) In the User password field, type the user password.
The password must be at least eight alphanumeric characters long and contain at least one number or special character.

(c) In the Confirm user password field, retype the password.
(d) Optionally, in the Description field, type a description for the user account.
(e) Click Next.



7. On the Configure Server Start Mode and JDK page:

(a) Under WebLogic Domain Startup Mode, click the Production Mode radio button.
(b) Under JDK Selection, click the Available JDKs radio button.
(c) In the JDK list, click the Sun Java JDK that you installed earlier. If the JDK is not displayed, click the Other JDK button, and then browse to it (C:\Java\jdk1.6.0_43\).
(d) Click Next.



8. On the Select Optional Configuration page, check the Administration Server checkbox, then click Next.


9. On the Configure the Administration Server page:
(a) Use the default values for the Name and Listen address fields.
(b) In the Listen port field, type 8101.
(c) Click Next.



10. On the Configuration Summary page, to create the domain, click Create.


On the Creating Domain page, the message "Domain Created Successfully!" signifies the end of the domain creation process.


11. To exit the Configuration Wizard, click Done.

12. Update setDomainEnv.cmd.



The file is located in the bin subdirectory of the domain directory
(C:\Oracle\Middleware\user_projects\domains\endeca_studio_domain\bin) .
(a) Add the JAVA_OPTIONS argument close to the top of the file.

set JAVA_OPTIONS=-DUseSunHttpHandler=true -Djavax.xml.transform.TransformerFactory =com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl -Djavax.xml.parsers.DocumentBuilderFactory =com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl -Djavax.xml.parsers.SAXParserFactory =com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl

Note that if you're copying and pasting out of this guide, make sure to remove any line breaks after pasting the text into the file.

(b) Update all of the Java perm size arguments in the file to replace all occurrences of XX:MaxPermSize=128m and -XX:MaxPermSize=256m with -XX:MaxPermSize=512m.

(c) Update all of the memory arguments in the file to replace all occurrences of -Xmx512m with Xmx1024m.

13. To verify that there are no conflicting applications on the domain's root context:

(a) Start the domain.
In C:\Oracle\Middleware\user_projects\domains\endeca_studio_domain, run startWebLogic.cmd.
Alternatively, from the Windows Start menu, select Oracle WebLogic>User_Projects>endeca_studio_domain>Start Admin Server for Weblogic Domain.
b) When prompted, enter the domain user name and password.

c) After the domain is started, in a browser, go to the root context path https://:

For example: https://localhost:8101

you get a "page not found" (404) error, then there are no applications on the domain's root context,and you can continue the Studio installation process.

you see the login page for a previously deployed Studio application, then you should un-deploy this application.

you see another application, then you should log in to the WebLogic Console, and then either remove the application or untarget it from the WebLogic Server instance.
For example, one common conflicting application is Oracle Enterprise Manager, which deploys an application to /em, but also installs the FMW Welcome Page Application to the root context.

Installing Integrator

Integrator is installed as a machine-wide installation on Windows.
This type of installation requires administrator permissions and is used because it is intended for a production environment. To complete this installation, you need the Integrator package you downloaded from the Oracle Software Delivery Cloud.

To install Integrator on a Windows client:

1. From the Integrator package, extract EID_3.0_Integrator_designer.exe.This is the Integrator installer file.



2. To start the wizard, double-click the installer file.

The wizard verifies the contents of the installation package. 3. To begin the installation process, click Next.



4. On the Copyright and Legal page, click Next.



5. On the Destination Folder page, accept the default installation directory, then click Next. You must install Integrator into an empty directory.



6. On the Completing the Setup Wizard page, click Next.



The wizard begins to install the Integrator files.


7. When the wizard confirms that you have successfully completed the installation, click Finish.



8. After installation, to start the program, double-click the Integrator shortcut icon.

Verifying the Endeca Server deployment

After installing the Endeca Server, you should verify that the Endeca Server application was correctly deployed.
To verify the Endeca Server application deployment:

1. To start the Admin Server for the Endeca Server domain, run
C:\Oracle\Middleware\user_projects\domains\endeca_server_domain\startWebLogic.cmd.

Alternatively, from the Windows Start menu, select Oracle WebLogic>User_Projects>endeca_server_domain>Start Admin Server for Weblogic Server Domain.

2. When prompted, enter the administrator user name and password for the Endeca Server domain.









3. From a Web browser, go to the Administration Server console at

https://localhost:7001/console.
4. On the Administration Console login page, log in using the domain administrator user name and password.


5. Under Domain Structure, in the endeca_server_domain tree, click Deployments.



6. In the Deployments table, check the oracle.endecaserver Web application (on the second page of the list).
Its State should be "Active" and its Health should be "OK".

Creating the WebLogic domain for Endeca Server

The Endeca Server installation includes a WebLogic domain template that you use to create the Endeca Server WebLogic domain.

To create the WebLogic domain for Endeca Server:

1. From a command prompt, change to the directory that contains the Configuration Wizard start-up program:
C:\Oracle\Middleware\wlserver_10.3\common\bin

2. To start the Configuration Wizard, run the following command:
config.cmd
The Configuration Wizard Welcome page is displayed.


3. On the Welcome page, click the Create a new WebLogic domain radio button, then click Next.


4. On the Select Domain Source page, check the Oracle Endeca Server checkbox. The Oracle JRF checkbox is then checked automatically. Click Next.


5. On the Specify Domain Name and Location page:

(a) Set the domain name to endeca_server_domain.
(b) Keep the default domain location.
(c) Click Next.


6. On the Configure Administrator User Name and Password page, to create the administrator credentials for starting WebLogic Server:

(a) In the Name field, type the name for the new administrator user.
(b) In the User password field, type the user password.
The password must be at least eight alphanumeric characters long, and contain at least one number or special character.
(c) In the Confirm user password field, retype the password.
(d) Optionally, in the Description field, type a description for the user account.
(e) Click Next.



7. On the Configure Server Start Mode and JDK page:

(a) Under WebLogic Domain Startup Mode, click the Production Mode radio button.
(b) Under JDK Selection, click the Available JDKs radio button.
(c) In the JDK list, click the Sun Java SDK that you installed. If the Sun Java JDK is not displayed,
click the Other JDK button, and then browse for the Sun Java JDK home:
C:\Java\jdk1.6.0_45\
(d) Click Next.



8. On the Select Optional Configuration page, do not select any optional configurations. Click Next.


9. On the Configuration Summary page, to create the domain, click Create.


On the Creating Domain page, the message "Domain Created Successfully!" signifies the end of the domain creation process
10. To exit the Configuration Wizard, click Done.

Running the Oracle Endeca Server installer

To install Oracle Endeca Server:
1. Unpack the Endeca Server zip file to a temporary directory.


The resulting endecaserver directory contains a Disk1 subdirectory.

2. From a command prompt, change to the Disk1 directory, then run the installer:

setup.exe -jreLoc
is the full path to the location of the Sun Java 6 JRE (Java Runtime Environment) that
you installed earlier.

For example:
setup.exe -jreLoc C:\Java\jdk1.6.0_43\jre
The installation wizard Welcome page is displayed.


3. On the Welcome page, read the information, then click Next.



4. On the Prerequisite Checks page, if everything passes the checks, click Next.



5. On the Specify Installation Location page:
(a) For the Oracle Middleware Home field, verify the name of the Oracle Middleware home directory.
(b) For the Oracle Home Directory field, accept the default Endeca Server home directory.
This is the root directory of the Endeca Server installation.
(c) Click Next.





6. On the Select Deploy Mode page, uncheck the YES checkbox, then click Next.


7. On the Installation Summary page, verify the installation details, then click Install.


8. On the Installation Progress page, when the installation progress has completed, click Next.


9. On the Installation Complete page, to exit the installation wizard, click Finish.


When the installation finishes, the Endeca Server files and directories are written to the Oracle Home Location.

Installing Oracle ADF Runtime

After you install WebLogic Server, you next install ADF Runtime 11.1.1.6, which contains the JRF needed byOracle Endeca Server.

To install Oracle ADF Runtime:

1. Unpack the ADF zip package (m_appdev_generic_11.1.1.6.0_disk1_of1.zip).
The package contains:
• readme.htm file
• Disk1 directory
• Disk2 directory


2. From a command prompt, change to the Disk1 directory.

3. Run the installer:

setup.exe -jreLoc
is the full path to the location of the Sun Java 6 JRE (Java Runtime Environment) that
you installed. The JRE is located in the JDK installation directory.

For example:
setup.exe -jreLoc c:\Java\jdk1.6.0_43\jre

The Welcome page of the ADF installation wizard is displayed.

4. On the Welcome page, read the information, then click Next.

5. On the Install Software Updates page, click the Skip Software Updates radio button, then click Next.

6. On the Prerequisite Checks page, wait until the installation process passes all the necessary checks.If everything passes the checks, click Next.

7. On the Specify Installation Location page, verify that the Oracle Middleware Home directory is the location where you installed WebLogic, then click Next.

8. On the Application Server page, click the WebLogic Server radio button, then click Next.

9. On the Installation Summary page, verify the installation details, then click Install.

10. On the Installation Progress page, when the installation process has completed, click Next.

11. On the Installation Complete page, to exit the installer, click Finish.

Installing the Sun Java JDK

When you install the Sun Java SDK, you must install it to a path that does not have any spaces.

To install the Sun Java SDK:

1. Double-click the JDK installer file that you downloaded (jdk-6u43-windows-x64.exe). The welcome page of the JDK installation wizard is displayed.

2. On the welcome page, click Next.

3. On the Custom Setup page, because the default installation location (under space, you must change it here. To change the JDK installation location:

4. The Destination Folder page sets the location of the public JRE. Because this JRE is not used by Endeca Information Discovery, you can leave the default directory. Click Next.

The installation process begins.

When the installation is completed, click Close.

Creating the WebLogic domain for and installing the Provisioning Service

You use the Provisioning Service domain template to create the WebLogic domain for and install the Provisioning Service.
To create the WebLogic domain and install the Provisioning Service:

1. Unzip the Provisioning Service .zip file into a temporary directory.


2. From a command prompt, change to the directory that contains the Configuration Wizard start-up program:
C:\Oracle\Middleware\wlserver_10.3\common\bin
3. To start the Configuration Wizard, run the following command:
config.cmd


The Configuration Wizard Welcome page is displayed.

4. On the Welcome page, select Create a new WebLogic domain, then click Next.


5. On the Select Domain Source page:
(a) Click the Base this domain on an existing template radio button.
(b) Click the Browse button, and then browse to the directory where you unzipped the Provisioning Service installation package.
(c) Select the file eidProvisioningTemplate.jar.
(d) After selecting the file, click Next.


6. On the Specify Domain Name and Location page:
(a) The default domain name is oracle.eid-ps.
(b) Do not change the Domain location or Application location.
(c) Click Next.


7. On the Configure Administrator User Name and Password page, to create the administrator credentials for starting the Provisioning Service domain:

(a) In the Name field, type the name for the new administrator user.
(b) In the User password field, type the user password.
The password must be at least eight alphanumeric characters long and contain at least one number or special character.
(c) In the Confirm user password field, retype the password.
(d) Optionally, in the Description field, type a description for the user account.
(e) Click Next.



8. On the Configure Server Start Mode and JDK page:
(a) Under WebLogic Domain Startup Mode, click the Production Mode radio button.
(b) Under JDK Selection, click the Available JDKs radio button.
(c) In the JDK list, click the Sun Java JDK that you installed earlier. If the JDK is not displayed, click the Other JDK button, and then browse to it (C:\Java\jdk1.6.0_45\).
(d) Click Next.



9. On the Select Optional Configuration dialog, check Administration Server, then click Next


10. On the Configure the Administration Server dialog:
(a) Use the default values for the Name and Listen address fields.
(b) In the Listen port field, type 8201.
(c) In the SSL listen port field, type 8202.
(d) Click Next.


11. On the Configuration Summary page, to create the domain, click Create.


12. On the Creating Domain page, the message "Domain Created Successfully!" signifies the end of the create process.



13. To exit the Configuration Wizard, click Done.

Configuring the Provisioning Service

Before running the Provisioning Service, you must configure it.
To configure the Provisioning Service, open the file
C:\Oracle\Middleware\user_projects\domains\oracle.eidps\eidProvisioningConfig\plan.xml.


Change the following settings:

Setting and Value pairs endeca-server-ws-port : 7001
endeca-server-security-enabled : false
upload-file-directory: Optional. If you do not change this setting, the Provisioning Service uses the operating system temporary directory. Because this directory is not very secure, and scripts often modify its contents, it is recommended that you specify a directory. The directory you specify must exist, and the user that runs the Provisioning Service must have write permissions on the directory.
transport-guarantee : NONE
protected-url-pattern : /DISABLED

Verifying the Provisioning Service deployment

After you finish installing the Provisioning Service, you can confirm that it runs.
To confirm the Provisioning Service deployment:

1. To start the Admin Server for the Provisioning Service domain, run
C:\Oracle\Middleware\user_projects\domains\ps_domain\startWebLogic.cmd.




2. When prompted, enter the administrator user name and password for the Provisioning Service domain.


3. From a Web browser, go to the Administration Server console at

https://localhost:8201/console.

4. In the Domain Structure section of the page, click Deployments.

Configuring the Studio connection to the Provisioning Service

In order to be able to create Studio applications via file upload, you must configure the connection from Studio to the Provisioning Service.

To configure the Provisioning Service connection from Studio:
1. Log in to Studio.


2. From the Studio menu, select Control Panel.


3. In the Control Panel menu, under Information Discovery, click Provisioning Service.


4. On the Provisioning Service page, edit the connection string to:
• Change the server name to localhost.
• Change the port number to 8201.
• Remove the sslConfig section.
When you finish, the connection string should look like:
{
"port": "8201",
"server": "localhost"
}


5. Click Save.
Studio saves and validates the connection information.

Oracle Endeca Installation Guidelines

1. Downloading the required for Oracle Endeca
2. Installing the Sun Java JDK for Oracle Endeca
3. Installing WebLogic Server and ADF Runtime for Oracle Endeca
   1. Installing WebLogic Server for Oracle Endeca
   2. Installing Oracle ADF Runtime for Oracle Endeca
4. Installing Oracle Endeca Server
   For Endeca Server, you first install the application, then create a WebLogic domain for it.
   1. Running the Oracle Endeca Server installer for Oracle Endeca
   2. Creating the WebLogic domain for Endeca Server for Oracle Endeca
   3. Verifying the Endeca Server deployment for Oracle Endeca
5. Installing Integrator
6. Installing Studio
   To install Studio, you first create the WebLogic domain for it, then deploy Studio into that domain.
   
   1. Creating the WebLogic domain for Studio for Oracle Endeca
   2. Deploying Studio into the domain for Oracle Endeca
7. Installing the Provisioning Service
   For the Provisioning Service, you use its domain template to create the WebLogic domain, then update the configuration.
   
   1. Creating the WebLogic domain for and installing the Provisioning Service for Oracle Endeca
   2. Configuring the Provisioning Service for Oracle Endeca
   3. Verifying the Provisioning Service deployment for Oracle Endeca
   4. Configuring the Studio connection to the Provisioning Service for Oracle Endeca