X

Technical info and insight on using Oracle Documaker for customer communication and document automation

  • ODEE
    June 14, 2016

ODEE 12.5 Green Field on Windows with Oracle Database

Andy Little
Technical Director
It's been a while since I last wrote about the green field topic, and since then we've had two versions of Oracle Documaker Enterprise Edition (ODEE) released. It's hard to believe that 12.3 was so long ago! Now we're up to 12.5, and the installation process has changed somewhat, along with the introduction of support for Microsoft SQL Server, so I figured it was time to start a new series of posts addressing some of these changes. For the first foray back into the world of green fields, I'm going to use a red field - that is, I'm going to walk through the installation of ODEE 12.5 on the so-called red stack, which is Oracle Database 11g, Oracle WebLogic 10.3.6, and Oracle SOA Suite 11.1.1.7.0, all on Windows. Technically that's not exactly a red stack, but it's close enough for our purposes. Let's dig in!

Getting Started


To begin, we'll need to revisit a few things - the first is that our prerequisites for this particular installation haven't changed since 12.3. That means you can use the existing posts where I detailed the installation procedures for Oracle Database 11g, Oracle WebLogic 10.3.6***, and Oracle SOA Suite 11.1.1.7.0. ***Note! My previous installation guide for Oracle WebLogic 10.3.6 mentions using JDK1.6 or higher, however JDK1.8 is not supported on WebLogic 10.3.6, so you should use the latest patch of JDK1.7
Note! If I didn't mention it before, I'll mention it here now: since this is a standalone sandbox, I recommend for simplicity using the same password for all accounts on this sandbox - for everything from database to Weblogic, to schemas, to JMS credentials. It will greatly ease the installation process. Yes, it's not secure, but this is a trial exercise!


Next, make sure you've had a look at the system requirements, and while you're at it, make a note of the Documaker 12.5 documentation site. Place it in your bookmarks! Finally, have the ODEE 12.5 installation guide handy - in fact, let's open it now, because on page 24 we need to review some Fusion Middleware concerns - specifically with patches required. Let's review each item.


JDK/JRE Selection


I'm just mentioning this again in case you missed it above. If you installed WebLogic 10.3.6 using JDK1.8 you need to start over using JDK1.7! JDK1.8 is not supported on WebLogic 10.3.6.

SOA Suite Patch


There are a few patches needed to address some problems with SOA Suite prior to deploying ODEE 12.5. These patches install using OPatch, which is installed as part of the SOA Suite. You will need to set a few environment variables prior to using OPatch. To do so, open a command window with Adminstrator privileges and do the following:
set MW_HOME = c:\oracle\middleware

This is the directory where you installed WebLogic 10.3.6.
set ORACLE_HOME = c:\oracle\middleware\oracle_soa1

This is the directory where you installed SOA Suite (oracle_soa1).
set JAVA_HOME = c:\progra~1\java\jdk1.8

This is the directory where you install the JDK - keep in mind spaces are not allowed, so use the 8.1 notation in Windows, or install it to a directory without spaces! Next you can navigate to ORACLE_HOME\OPatch, and run:
opatch lsinventory

You should see "OPatch succeeded" at the end of this run. This verifies everything is ready to go for patching.

Using IE11


If you intend to use Internet Explorer 11 with ODEE 12.5, you will need to download this patch for Fusion Middleware and install it. Extract the downloaded ZIP to ORACLE_HOME\patch. Then in your command prompt:
cd %ORACLE_HOME%\patch\18277370\oui\18277370

and then...
opatch apply

At then end, you should see "OPatch succeeded", or a message indicating no patch was necessary.


To fix a problem building BPEL using ANT, you need to install this patch that fixes a problem building BPEL with ANT. Download zip, unzip to ORACLE_HOME\patch and in your command prompt:
cd %ORACLE_HOME%\patch\16443288

and then...
opatch apply

You may be prompted to shutdown Oracle instances - you shouldn't have any running at this point, so press Y. At the end, you should see "Opatch succeeded".


Now we're ready to start the ODEE 12.5 installation. To obtain the software, follow these steps:
  1. Browse to the Oracle Software Delivery Cloud (OSDC) and sign in with your Oracle account.
  2. In the OSDC Search bar, type "documaker" and in the auto-sense list, select Oracle Documaker Enterprise Edition. Then click the Platform dropdown, and check Windows x64, and click Select. Now you should see something populated in the download queue, so click Continue.
  3. In the release Download Queue screen, click the triangle to expand the release downloads for ODEE 12.5. We don't need all of this, so uncheck the box next to Release, which unchecks all releases. We need only select the Oracle Documaker Enterprise Edition - which should be 914.6MB. With that option checked, click Continue.
  4. Now you'll need to accept the license agreements - read and review, then check the "I have reviewed..." box, and click Continue.
  5. Click the V137972-01.zip link to download the installation package.
  6. Once you have downloaded the software, unzip it. You should have a readme and an additional zip file. Review the readme, then unzip the ODEE12.5.00.29909W64.zip file.

Before we get started, I should mention something about nomenclature within this post. You'll see references to some items which I will define in this table. You might want to create environment variables to use on your own system for each of these, which greatly eases navigation. You can set these environment variables in a command window for one-time use:
set ORACLE_HOME=c:\oracle

Or you can Right-click Computer, select Properties, click Advanced System Settings, click Environment Variables, and click New under System Variables. Then you can add the name and value of the variable as shown below.
ItemValue
ORACLE_HOMEThe location where the Oracle software is installed, typically c:\oracle.
MW_HOMEThe location of the middleware software, usually c:\oracle\middleware.
ODEE_HOMEThe location of the ODEE installation, usually c:\oracle\odee_1.
ODEE_MWThe location of the ODEE middleware domain, usually MW_HOME\user_projects\domains\idocumaker_domain.
SOA_HOMEThe location where SOA Suite domain is installed, usually MW_HOME\Oracle_SOA1

Installation


Now it's time to perform the installation! Open the Disk1 folder extracted from the zip, and click setup.exe. Let's follow each of the steps:
  1. Welcome screen: Click Next.
  2. Specify Installation Location: I prefer to use c:\oracle\odee_1; from here on out I'll call this ODEE_HOME. Note! there is a 44 character limit to this path size. I have no idea why, just make it simple, then click Next.
  3. Specify Administrator Group and User: It's fine to accept the defaults here; you'll need to enter and confirm a password. Write it down and click Next. Note! because we're installing in WebLogic, the installer will create the security realm with the group and user we define here. If this was a WebSphere install, then you would need to input a valid group and user that already exists in the LDAP repository for WebSphere.
  4. Database Server Details: Oracle 11g should already be selected for you. Input the host, port, and database name. The name should be either the SID or the Service Name you used back when you created the database (I used IDMAKER and idmaker.us.oracle.com respectively). You can use either SID or Service name, and select the correct type from the drop down. For the purposes of the sandbox we are not using Advanced Compression, so uncheck this box and click Next.
  5. Administration Schema Details: This is where we define the schema that will hold the administrative/system tables for ODEE. Accept the defaults, however you will want to provide a new password and confirm it. Leave the System ID and name as-is.
  6. Assembly Line Schema Details: This is where we define the schema that will hold the assembly line tables for ODEE. Accept the defaults, however you will want to provide a new password and confirm it. Leave the Assembly Line ID as-is, if you want to use a fancy name, go ahead! Click Next.
  7. Application Server Details: Select WebLogic Server 10.3.6 from the dropdown. Set your username to weblogic, and set the password. This is the username that you'll use to login to the WebLogic domain and administer it. Click Next.
  8. JMS Details: Part of the deployment will include a managed server that runs JMS servers. Here you will specify the connection details that will be used. Accept the defaults and enter a password. Click Next.
  9. Hot Folder Path: Accept the default here and click Next.
  10. SMTP Email Server Details: If you have an SMTP server that you want to use to send emails from Documaker, you can enter the connection criteria here, then click Next.Note! It's quite likely that your IT enterprise won't allow just any service to send email, so for the purposes of the sandbox you might want to use a developer's SMTP server. I use SMTP4Dev - it's lightweight (under 1MB!) and free. If you decide to run it on your sandbox, it listens on port 25 by default and does not require a user or password.
  11. Optional UCM Details: UCM is out of scope for the sandbox, so click Next.
  12. Optional UMS Details: UMS is out of scope for the sandbox, so click Next.
  13. Documaker Interactive Workflow: Accept the defaults here, and click Next.
  14. Installation Summary: Review your details here. You might want to save the response file in case you have to re-run the installation, and you can do that here. Click Install to get things going!

The installer will layout the filesystem for ODEE, and stage everything for deployment based on the configuration options selected in the Installer. Once this is done, we'll proceed to deploy the Data and Presentation tiers (the Processing tier deploys automatically during installation, but won't be operational until the other two tiers are deployed).

Data Tier


Now we'll need to deploy the administrative and assembly line schemas to our database. At some point perhaps Documaker will start using the RCU to deploy it's schemas, which will relieve you of some hassle, but for the moment we'll need to do it "by hand" - so roll up your sleeves and open a command prompt!
  1. Navigate to the the ODEE_HOME/documaker/database folder in Windows Explorer. Shift-Right-Click on the oracle11g folder and select open command window here.
  2. In the command window that opens, type in SET NLS_LANG=AL32UTF8 and press enter. Note! This step is optional; execute it if you're going to add languages to ODEE installation. If you're using English (default) you don't need this step, but it won't hurt!
  3. In command window, type in sqlplus / as sysdba and press enter. If you're prompted for the password you established for the database back in the prerequisites (you remember it, right?) key it in and press enter. You should see:
    C:\Oracle\odee_1\documaker\database\oracle11g>sqlplus / as sysdba
    SQL*Plus: Release 11.2.0.1.0 Production on Fri Jun 10 16:57:18 2016
    Copyright (c) 1982, 2010, Oracle. All rights reserved.
    Connected to:
    Oracle Database 11g Enterprise Edition Release 11.2.0.1.0 - Production
    With the Partitioning, OLAP, Data Mining and Real Application Testing options
    SQL>
  4. Next, enter @dmkr_admin.sql and press enter. When the script is finished you should see:
    No errors.alter 
    Commit complete.
    SQL>
  5. In the command window, type in @dmkr_asline.sql and press enter. At the end of processing, you should see:
    Commit complete.
    SQL>
  6. NOTE! In the previous two steps, it is possible that you might see two error messages at the beginning of each script:
    SQL> @dmkr_admin.sql
    '{system.folder.empty}ALTER' is not recognized as an internal or external command, operable program or batch file.

    and
    SQL> @dmkr_asline.sql
    '{assemblyLine.folder.empty}ALTER' is not recognized as an internal or external command, operable program or batch file.

    You can safely ignore these errors - they have no effect on the installation and deployment.
  7. In the command window, type in @dmkr_admin_user_examples.sql and press enter - this is to install the demonstration users and groups. If you are using these instructions to assist in your actual system deployment you can skip this step. At the end of processing, you should see:
    Commit complete.
    SQL>
  8. Note! If you wish to install additional languages, you may do so now using SQLPLUS. Follow the same steps as above:
    1. Execute @dmkr_admin_XX.sql, where XX is the language code for the language you wish to install.
    2. Execute @dmkr_asline_XX.sql, where XX is the language code for the language you wish to install.
    3. Note! The language code for Simplified Chinese is incorrectly listed in the documentation as zh. It is actually zh_CN, e.g. dmkr_admin_zh_CN.sql.
  9. Enter exit into the SQLPLUS window and press enter to end the session.

Library Deployment


Now that the schemas have been created, you can deploy the reference implementation Master Resource Library (MRL). This will complete one of the installation steps as well as verify the database connection outside of SQLPLUS.

In Windows Explorer, navigate to ODEE_HOME\documaker\mstrres\dmres. Double click on deploysamplemrl.bat. You should see a lot of information flowing across the screen, like this:
...
--- LBYSync Copyright (C) 1998, 2016, Oracle and/or its affiliates. All rights r
eserved.
--- Synchronize Documaker libraries
Will attempt to Sync all Revisions of all Versions.
Inserting default LBYSync criteria ;*;*;*;*;*;*;*;*;*;
Promoted Resource, Name <CORRESPONDENCE>, Type<BDF>, Ver<00001>, Rev<00001>
...
Synchronization performed. The following number of objects were
added to the target library.
SOURCE LIBRARY: deflib/master.lby
TARGET LIBRARY: DMRES
BDFs : 1
GRPs : 25
FORs : 95
FAPs : 408
DDTs : 0
LOGOs: 46
DALs : 24
XDDs : 2
PARs : 26
PSLs : 7
STYs : 3
TLKs : 1
TPLs : 4
Total: 642

You should see a total of 642 resources promoted (in case you're wondering, one resource will not promote and that is expected, so ignore the "Did not promote older resource, Name<TIMESTAMP>" message). Once this completes, you have finished deploying the Data Tier.

Presentation Tier

  1. In Windows Explorer navigate to ODEE_HOME\documaker\j2ee\weblogic\oracle11g\scripts.
  2. Open set_middleware_env.cmd in Notepad, and locate the following:
    SET MW_DRIVE=E:
    SET MW_HOME=%MW_DRIVE%\Oracle\Middleware

    Update the value of MW_DRIVE and MW_HOME to match your environment - this is where you installed WebLogic. The default is C:\Oracle\Middleware, so update accordingly. Save the file and exit Notepad.
  3. Open weblogic_installation.properties in Notepad, and locate the following:
    # The dirWeblogicHome directory is the middleware home where WebLogic
    # is installed on the WebLogic server machine.
    # Unix Example: dirWeblogicHome=/home/oracle/middleware
    dirWeblogicHome=E:\\oracle\\middleware

    Update the value for dirWeblogicHome to match the MW_HOME value above, noting that this file uses Java syntax for backslashes (\\ instead of \). Save the file but don't exit yet!
  4. While still in weblogic_installation.properties in Notepad, and locate the following:
    ###############################################################################
    # Update and verify these credentials for JDBC, DMKR_ADMIN DB user,
    # DMKR_ASLINE DB user, JMS user (blank if not secured) , Documaker Demo user
    # and WebLogic domain admin account user
    ###############################################################################
    # Administration DB users credential
    jdbcAdminPassword='<SECURE VALUE>'
    # AssembleLine DB users credential
    jdbcAslinePassword='<SECURE VALUE>'
    # Secured JMS users credential (set to blank of not secured)
    jmsCredential='<SECURE VALUE>'
    # Documaker Enterprise Admin user users credential (set to blank of not secured)
    adminPasswd='<SECURE VALUE>'
    # WebLogic domain admin account credential
    weblogicPassword='<SECURE VALUE>'

    You'll need to replace each of these occurences of '<SECURE VALUE>' (yes, including the ') with the password you specified during the installation phase. This is done for security reasons. You did write all these down, didn't you? Hint: remember when I said,"use the same password for everything" back in Getting Started? Now you know why! Save the file and exit.
  5. Double-click the wls_create_domain.cmd file and watch it do its thing. Note: if you see an error like this:
    Failed to get environment, environ will be empty: (0, 'Failed to execute command
    ([\'sh\', \'-c\', \'env\']): java.io.IOException: Cannot run program "sh": Crea
    teProcess error=2, The system cannot find the file specified')

    you can safely ignore it.
  6. Double-click the wls_add_correspondence.cmd file and watch it do its thing.
  7. Now we can start up the AdminServer component - navigate to MW_HOME/user_projects/domains/idocumaker_domain/bin and execute startWebLogic.cmd. This will open a new command window, and once it gets to the point where you see this:
    Server started in RUNNING mode
    you are ready to proceed.
  8. To create the demonstration user accounts in WebLogic, return to the ODEE_HOME\documaker\j2ee\weblogic\oracle11g\scripts directory and execute the create_users_groups.cmd file.
  9. To install the demonstration users execute create_users_groups_correspondence_example.cmd in the same directory (FYI - if you're using these instructions for building your deployment system and not just for demonstration, you can skip running this script). Note! If you want to change the passwords for each/some/all of these demo users, you can edit the documaker.py script in this directory. By default, the demo user and password are the same (e.g. Alan Abrams -> Alan Abrams). Locate the following area in the documaker.py file:

    atnr.createUser('Alan Abrams',adminPasswd,'Alan Abrams');
    Replace the adminPasswd with a password of your choosing, remembering to enclose it in single quotes.
  10. Next we need to link these users and groups created via the scripts to the entities that are configured in the database. Note that this is a one-time, installation-only process. When new users are added to the security realm, they will automatically be linked/created in the entities database, so this is a strictly one-time step. Execute this step by opening a browser and navigating to http://localhost:7001/jpsquery - of course if you aren't running the browser on the server, you need to replace localhost with your servername or IP address. You should see some output that indicates users/groups added. If you access the URL again, it will show the users/groups found and/or added.

Starting Services


At this point we have deployed all the basic services and applications that are needed to start up ODEE. You should still have the AdminServer running, but just in case you don't, we'll revisit those steps.

Documaker Factory

  1. If not already started, start the WebLogic AdminServer by running MW_HOME\user_projects\domains\idocumaker_domain\startWebLogic.cmd. Once you see
    Server started in RUNNING mode
    you may proceed. (If the server is already running you will of course see error messages which you can ignore).

  2. Start the JMS Server by running MW_HOME\user_projects\domains\idocumaker_domain\bin\startManagedWebLogic.cmd jms_server. You will be prompted for credentials to start the managed server, which you entered in Installation Step 7 above. Once you see
    Server started in RUNNING mode
    you may proceed.

  3. Start Document Factory services by opening Windows Services manager. You can do this using Start->Run->services.msc, or under Administrative Tools->Services. In the Services manager, find the service that starts with "ODDF". Start this service. It may take a few moments for all of the services to initially start up. You can view the Windows Task Manager using the Details tab. Sort by Name, and you should see docfactory_* services listed. You can also review the startup log in ODEE_HOME\documaker\docfactory\logs\startup.log. This log file will show each worker being deployed and will note any problems. If all is successful you should see
    2016-06-13 12:32:04,315- INFO-[Supervisor-oracle.documaker.processmonitor.deployment.HotDeployer]:  0 Error(s).
    at the end of the log file. If there are any errors, you can review further up the log file, and then follow up in ODEE_HOME\documaker\docfactory\temp for the specific worker.

    Note! It is possible that the installer could fail to create the Windows service for one reason or another. You can manually deploy the Windows service by navigating to ODEE_HOME\documaker\docfactory\bin. Here you can run docfactory_supervisor_install.cmd. Switch to the Services manager and hit F5 to refresh. If you still don't see the services, open up docfactory_supervisor.properties file and modify the service.debugging=0 setting to service.debugging=1. Run the docfactory_supervisor_install.cmd again and check in the same directory for a log file called docfactory_supervisor-service. Inspect for any problems you can remediate by modifying settings in the aforementioned properties file.

Documaker Administrator and Dashboard

  1. To start the Documaker Administrator and Dashboard web applications, open a command window and navigate to MW_HOME\user_projects\domains\idocumaker_domain\bin. Execute startManagedWebLogic.cmd dmkr_server. You will be prompted for credentials to start the managed server, which you entered in Installation Step 7 above. Once you see
    Server started in RUNNING mode
    you may proceed.

    Note! You can edit the startManagedWebLogic.cmd file to include the user credentials to avoid being prompted whenever starting - but note that it's insecure to do so. Open the startManagedWebLogic.cmd file in Notepad and locate
    set WLS_USER=
    set WLS_PW=
    and add the credentials, then save the file.

Documaker Interactive - Correspondence

  1. To start the Documaker Interactive web applications, open a command window and navigate to MW_HOME\user_projects\domains\idocumaker_domain\bin. Execute startManagedWebLogic.cmd idm_server. You will be prompted for credentials to start the managed server, which you entered in Installation Step 7 above. Once you see
    Server started in RUNNING mode
    you may proceed.

    Note! You can edit the startManagedWebLogic.cmd file to include the user credentials to avoid being prompted whenever starting - but note that it's insecure to do so. Open the startManagedWebLogic.cmd file in Notepad and locate
    set WLS_USER=
    set WLS_PW=
    and add the credentials, then save the file.
  2. There is an additional step you'll need to perform on any client computers that will be accessing Documaker Interactive - you'll need to install the WIPedit client. The installer is located in ODEE_HOME\documaker\j2ee\ODWE.exe. Copy this installer to any client computer and run the installer, accepting the defaults. Note! Documaker Interactive supports the capability to provide a direct link in case a user does not have the WIPedit plugin installed. It requires a little bit of additional effort which I will cover in another post.

Optional Step: SOA deployment


If you plan on testing BPEL rules for approving transactions processed in Documaker Interactive, read on. This is an optional step and is not required for Documaker Interactive, or Document Factory to work. The first part of this procedure is to extend SOA Suite components into the WebLogic domain for ODEE.

Extend Domain

  1. Stop any running Document Factory services.
  2. Stop any running managed servers, then stop the AdminServer.
  3. Open a command window to and run MW_HOME\wlsserver_10.3\common\bin\config.cmd; the configuration wized will open
  4. .
  5. Select Extend an existing WebLogic domain and click Next.
  6. In the selection tree, click the idocumaker_domain, which is in MW_HOME\user_projects\domains. Click Next.
  7. Check the box for Oracle SOA Suite 11.1.1.0; this may select additional items too. Click Next.
  8. Click Next on the Configure JDBC Data Sources screen.
  9. Click Select All and then click Test Connections. For each connection you should see the following (in addition to other information) in the Connection Result Log box:
    CFGFWK-20850: Test Successful!
    Click Next.
  10. On the Configure JDBC Component Schema screen, check the boxes next to each component schema. Update the following items, then click Next:
    PropertyValue
    DBMS/Serviceidmaker.us.oracle.com (or the service name you used for your Oracle database)
    Schema Owner(Do not change)
    Schema PasswordHopefully you set all of the schema passwords to the same value during your SOA Suite installation. Input that value here. If you gave each schema a different password, put nothing here.
    Host Namelocalhost (or if using a remote database, the hostname of the data)
    Port1521 (the default; otherwise use the port for your database)
    Note! If you used separate schema passwords for each schema, you will need to check each component individually, set the password, then uncheck until all passwords are set.
  11. For each connection you should see the following (in addition to other information) in the Connection Result Log box:
    CFGFWK-20850: Test Successful!
    If everything was succesful, click Next - otherwise click Previous to correct errors and retry.
  12. On the Select Optional Configuration screen just click Next.
  13. On the Configuration Summary screen, verify your choices and click Extend. Once the operation is complete, click Done.
  14. Note! If you followed the optional configuration to add the weblogic credentials to the startup script, you'll need to redo this as the domain extension recreates the startup scripts.

Build Rules Composite


Next, we'll compile and deploy the rules composite into the SOA framework.
  1. Open a command window and execute ODEE_HOME\documaker\j2ee\weblogic\oracle11g\bpel\antbuild.cmd. Note! It's possible that you may receive an error during the build - see these steps to resolve.
  2. Start the AdminServer.
  3. Open the Weblogic Console and login (http://localhost:7001/console).
  4. Navigate in the left-hand domain structure to Services->Data Sources.
  5. For both dmkr_admin and dmkr_asline perform the following:
    1. Click the data source name.
    2. Click the Targets tab.
    3. Check the soa_server1 box.
    4. Click Save.
    5. In domain structure on the left, click Services->Data Sources.
  6. Open a command window and navigate to and execute ODEE_MW\bin\startManagedWebLogic.cmd soa_server1
  7. Once the server is running, navigate to and execute ODEE_HOME\j2ee\weblogic\oracle11g\scripts\depoy_soa.cmd. You should see the following at the end of the process:
    ---->Deploying composite success.
    Press any key to continue . . .
  8. Now you can start up the other managed servers (jms_server, dmkr_server, and idm_server).

Resolving Antbuild Failures


During the antbuild phase of deploying the BPEL composite, you could see this error:
BUILD FAILED
C:\oracle\MIDDLE~1\Oracle_SOA1\soa\modules\oracle.soa.ext_11.1.1\build.xml:41:
Problem: failed to create task or type if
Cause: The name is undefined.
Action: Check the spelling.
Action: Check that any custom tasks/types have been declared.
Action: Check that any presetdef/macrodef declarations have taken place.

If you run into this problem, you can workaround it:
  1. Navigate to SOA_HOME\soa\modules\oracle.soa.ext_11.1.1 in Windows Explorer.
  2. Locate the build.xml copy it to build.xml.backup.
  3. Open build.xml in Notepad, and locate this line:
        <if>
    <equals arg1="${Extension-Name}" arg2="oracle.soa.workflow.wc" />

    and replace it with:
        <!--
    <if>
    <equals arg1="${Extension-Name}" arg2="oracle.soa.workflow.wc" />
  4. Locate this line:
          <else>
    <jar destfile="${library.path}"
    update="yes" >

    and modify it to
          <else>
    -->
    <jar destfile="${library.path}"
    update="yes" >
  5. Locate this line:
            </else>
    </if>

    and modify it to:
            <!--
    </else>
    </if>
    -->
  6. Save the file, and rerun the antbuild step.

Validation


To verify our system is fully operational, we'll exercise each of the components.
  1. First we'll submit a job to the Document Factory. To do this, navigate in Windows Explorer to ODEE_HOME\documaker\mstrres\dmres\input. Here, locate the input file extrfile.xml. Copy this file and place it in ODEE_HOME\documaker\hotdirectory.
  2. Next, we'll inspect the Documaker Dashboard to inquire about the transaction status. Open a browser and navigate to http://localhost:10001/DocumakerDashboard. Login with one of the demonstration users (e.g. Alan Abrams) and have a look around. You should be able to locate the transaction you just submitted. Note! If you are using a browser that is not located on the same server, replace localhost with the servername.
  3. Test your ability to login to Documaker Administrator by opening a browser and navigating to http://localhost:10001/DocumakerAdministrator. You can login with the adminstration account you created in Installation Step 3 above. Note! If you are using a browser that is not located on the same server, replace localhost with the servername.
  4. Test your ability to login to Documaker Interactive by opening a browser and navigating to http://localhost:9001/DocumakerInteractive. Note! If you are using a browser that is not located on the same server, replace localhost with the servername.
  5. Test DWS (Documaker Web Services) by opening a browser and navigating to http://localhost:10001/DWSV0AL1/CompositionService?WSDL. You can also import this WSDL into a SOAP testing tool such as Soap UI or similar. Note! If you are using a browser that is not located on the same server, replace localhost with the servername.

Uh Oh


Did something not work correctly? Here are a list of common issues and solutions on initial deployments.
  • I tried to go to the Dashboard/Administrator/Interactive, but my browser gave me a security warning and I couldn't continue. Some typical reasons:
    1. If you're using a newer browser, you'll need to enable a new version of security for SSL in WebLogic. Open the WebLogic Console (http://localhost:7001/console and login with the administrative credentials. Click on Environment->Servers in the left-hand navigation. For each server where SSL is used (AdminServer, dmkr_server, and idm_server) perform these steps:
      1. Click on the Server name.
      2. Click on the SSL tab.
      3. Scroll to the bottom and expand Advanced settings.
      4. Check the JSSE Enabled box.
      You will likely have to restart each of the servers here after applying these settings.
    2. The out-of-the-box deployment includes "demo" self-signed SSL certificates that will work for most cases on installation, but these are never meant for production use. You should replace these demonstration certificates with actual certificates signed by a valid Certification Authority (CA). When the demo certificates are in use you might see errors like these:
      1. Newer browsers may issue an error message like this:
            The server certificate included a public key that was too weak. 
        Error code: SSL_ERROR_WEAK_SERVER_CERT_KEY

        Some browsers have a default setting that requires a certificate to be encrpyted with a key length that is less than 1024 bits. To remedy this, you can either encrypt the certificate again with a longer key, or replace the certificate with a valid certifcate (ensure that you use a 1024-bit key or better). To regenerate the key, do the following:
        1. Open a command window and navigate to MW_HOME\wlserver_10.3\server\lib.
        2. Run java -version as a quick test to make sure that Java is in your path. You should see output like this:
              C:\oracle\Middleware\wlserver_10.3\server\lib>java -version
          java version "1.7.0_79"
          Java(TM) SE Runtime Environment (build 1.7.0_79-b15)
          Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode)

        3. If you don't see this and instead see a message like 'java' is not recognized as an internal or external command... then add it to the PATH temporarily:
              set path = c:\java\jdk1.7.0_79\bin
          Make sure you replace the value above with the path to the bin directory inside your JDK installation.
        4. Next, take a backup of the existing keystore:
              copy DemoIdentity.jks DemoIdentityBackup.jks
          1 file(s) copied.
        5. Use the keytool to delete the existing DemoIdentity certificate.
              keytool -delete -keystore DemoIdentity.jks -storepass DemoIdentityKeyStorePassPhrase -alias DemoIdentity
        6. Use the keytool to generate a new DemoIdentity certificate, which will use an encryption key of 2048-bits - nice and secure!
              keytool -genkey -keystore DemoIdentity.jks -storepass DemoIdentityKeyStorePassPhrase -alias DemoIdentity -keypass DemoIdentityPassPhrase -keyalg RSA -keysize 2048 -validity 3650

          You'll be prompted for some common name ("CN") information, which you can fill out to your liking.
          What is your first and last name?
          [Unknown]: Documaker
          What is the name of your organizational unit?
          [Unknown]: Oracle Insurance
          What is the name of your organization?
          [Unknown]: Oracle
          What is the name of your City or Locality?
          [Unknown]: Atlanta
          What is the name of your State or Province?
          [Unknown]: GA
          What is the two-letter country code for this unit?
          [Unknown]: US
          Is CN=Documaker, OU=Oracle Insurance, O=Oracle, L=Atlanta, ST=GA, C=US correct?
          [no]: yes
        7. Restart the AdminServer and any managed servers that are running.
      2. You may see various types of certificate errors when using the "demo" certificate. The browser will typically show a risk due to unknown or invalid certificate. You may be able to proceed by acknowledging the risk, or adding an exception for this certificate. This can be also be remediated by replacing your SSL demo certificates with actual certificates issued by a CA.

What's Next?


I'll follow up this post with some additional information on how you can configure NodeManager, how to setup WIPedit installer for automatic download, and how to consolidate the various managed servers to reduce the footprint on your sandbox machine. In the meantime, enjoy your new sandbox and post any comments below!

Join the discussion

Comments ( 1 )
  • guest Monday, June 20, 2016

    The "green field" blog entries are invaluable to pull together all the pieces required for a successful Documaker installation. They are my primary reference during installation, and give me the necessary background to look up more detailed information for the various components.


Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.