Professional Documents
Culture Documents
Installation Guide - Oracle12.2 WANDS 20.2.3
Installation Guide - Oracle12.2 WANDS 20.2.3
The Excel4apps Wands for Oracle comprises a suite of products. The installation process set out
below will install all the products although only those that are licensed will be active.
The installation process is executed entirely on the Oracle server. The application is accessed via the
normal Oracle logon URL, but from a new Responsibility that is created during the installation
process. No Excel4apps software is required to be installed on the client machine.
If you need assistance during the installation process, please contact our support team at
e4asupport@insightsoftware.com.
2 Prerequisites
By installing the software into your system you acknowledge that you accept the terms of the
Software License and Maintenance Agreement -
http://collateral.excel4apps.com/documents/license_maintenance_agreement.pdf.
In order to run this version of the Excel4apps Wands, the following prerequisites must be met: NB
Check the Customer Support Community (https://help.insightsoftware.com/s/) for any updates since
publishing.
* Requires R12.AD.C.Delta.4 and R12.TXK.C.Delta.4 to address an Oracle bug which affects the
servlet installation. Refer to Document 1617461.1 - Applying R12.AD.C.Delta.4 and R12.TXK.C.Delta.4
Release Update Packs.
** We do not currently support Java Access Bridge and require this feature to be disabled. See
Oracle Documentation.
Workbooks created in version 4 will need to be upgraded when they are first opened in this version.
There is a menu option under the Excel4apps tab to execute this process.
For this upgrade option you need to follow all the instructions in section 4 “Installation on the
Server” except for section 4.2 “Setup the Excel4apps custom applications”. The custom applications
would have been created with the initial install and do not need to be recreated. All the other steps
of the installation will be required, including a cutover, in order to follow Oracle’s official patching
process.
An upgrade using hot mode allows you to deploy a new version of the application without needing
to perform all the required steps for a full adop patch cycle.
1. Confirm that both the Excel4apps and Excel4apps Reports Wand applications have been
registered on you system.
a. Log on to the Oracle system and select a responsibility like System Administrator
that has permission to register an application.
b. Navigate to the following menu: Application > Register.
c. Query the values that start with Excel4apps% and confirm that the two required
applications exist.
Windows:
C:\>install.cmd --hotpatch UPGRADE
10. For Oracle EBS 12.2.7 or 12.2.6 + Patch 24737426:R12.FND.C ensure that the “Allowed
Resources” feature has been configured to grant access to the Excel4apps servlets. Refer to
the Known Issues section in the Excel4apps Wands product release notes for further details.
11. Restart the OACore JVM server.
12. Load the Excel4apps Wands test page to make the new version active. This is a simple web
page that you access by entering the test page URL into a browser.
a. Open a browser.
b. Enter the URL for this Application server node followed by /OA_HTML/excel4apps
e.g. http://appsserver1.domain.com:8000/OA_HTML/excel4apps
c. The test page should display similar to the image below.
13. If the APPL_TOP is not shared, repeat the process for the remaining nodes.
14. For shared APPL_TOP installations just load test page for each Application server node URL
to make the new version active for that node.
1. Locate the Excel4apps install file. This is the complete zip file that was downloaded from our
web site (which contained this installation guide). FTP it to the server as the applications
user.
2. Unzip the Excel4apps install file.
3. Initiate an adop prepare phase on the target installation environment.
4. Connect to the Patch Edition file system on the target installation environment. Take careful
note of the file system you are attached to as the steps below must be executed on the
Patch Edition file system.
ADSplice is an Oracle utility that installs a product definition for new applications. It requires some
configuration files which must first be prepared.
1. As the Applications node technology stack owner (applmgr), navigate to the folder on the
server where you unzipped the install file.
2. Navigate to the Excel4apps install folder that will have been created by the unzip process
earlier.
3. For UNIX systems, change permissions on the file “install.sh” to allow it to be executed.
4. Run the Excel4apps Wands installer to deploy the ADSplice configuration files by running the
install.sh script with the DEPLOY_ADSPLICE_FILES option as follows:
UNIX:
./install.sh DEPLOY_ADSPLICE_FILES
Windows:
C:\>install.cmd DEPLOY_ADSPLICE_FILES
[applmgr@oracle122 excel4apps_wands_oracle5.7.0.5405]$
6. Review the output from the Excel4apps Wands Installer and proceed to run ADSplice below
unless instructed otherwise.
7. Change directory to the admin directory under $APPL_TOP and run the ADSplice utility as
follows:
[applmgr@oracle122 admin]$ cd $APPL_TOP/admin
[applmgr@oracle122 admin]$ adsplice
8. Respond to the application prompts and specifically accept the default values for the
following items:
Enter the directory where your AD Splicer control file is located.
The default directory is [/oracle/VIS/apps/apps_st/appl/admin] :
9. The ADSplice process will now run. When prompted to regenerate your environment file i.e.
Run AutoConfig, please select Yes.
a. Review the ADSplice log file to ensure the procedure completed successfully.
b. Review the AutoConfig log file to ensure it completed successfully.
1. As the APPS user, connect to the patch edition database and run the following SQL to
confirm that the applications were created successfully.
SELECT DECODE (foo.c, 1, 'Application XXE4A created', 'Error, application XXE4A was not
created') answer
FROM (SELECT COUNT (*) c
FROM fnd_application fa, fnd_product_installations fpi, dba_users dau
WHERE fa.application_short_name = 'XXE4A'
AND fa.application_id = fpi.application_id
AND dau.username = fa.application_short_name) foo
UNION ALL
SELECT DECODE (foo.c, 1, 'Application XXE4ARW created', 'Error, application XXE4ARW was
not created') answer
FROM (SELECT COUNT (*) c
FROM fnd_application fa, fnd_product_installations fpi, dba_users dau
WHERE fa.application_short_name = 'XXE4ARW'
AND fa.application_id = fpi.application_id
Note: You can use SQL*PLUS while accessing the patch edition file system to connect to the patch
edition database.
2. To ensure the new environment file is picked up, log out and then log back in again as the
Applications node technology stack owner (applmgr). Source the Patch Edition file system
and run the following command to confirm the $XXE4A_TOP is correctly set.
[applmgr@oracle122 ~]$ ls -l $XXE4A_TOP
total 24
drwxr-xr-x. 4 applmgr dba 4096 Oct 25 13:18 admin
drwxr-xr-x. 2 applmgr dba 4096 Oct 25 13:18 log
drwxr-xr-x. 2 applmgr dba 4096 Oct 25 13:18 mds
drwxr-xr-x. 2 applmgr dba 4096 Oct 25 13:18 mesg
drwxr-xr-x. 2 applmgr dba 4096 Oct 25 13:18 out
drwxr-xr-x. 2 applmgr dba 4096 Oct 25 13:18 sql
[applmgr@oracle122 ~]$
1. If the APPL_TOP is not shared, repeat the section “Setup the Excel4apps custom
applications” for the remaining nodes.
2. For shared APPL_TOP installations simply run AutoConfig for the remaining nodes. There is
no need to rerun ADSplice.
1. For Oracle EBS 12.2.7 or 12.2.6 + Patch 24737426:R12.FND.C ensure that the “Allowed
Resources” feature has been configured to grant access to the Excel4apps servlets. Refer to
the Known Issues section in the Excel4apps Wands product release notes for further details.
4.3 Install
This step involves running the Excel4apps Wands Installer which will deploy the Excel4apps files on
the server, configure the Excel4apps applet, load the Excel4apps OAF home page and load the
required application components e.g. the menu and responsibility.
Note: An option to install custom database tables has been included in the installer. Please see the
Custom Database Objects section of this guide to understand the implications.
1. As the Applications node technology stack owner (applmgr), navigate to the folder on the
server where you unzipped the install file.
2. Navigate to the Excel4apps install folder that will have been created by the unzip process
earlier.
3. For UNIX systems, change permissions on the file “install.sh” to allow it to be executed.
4. Ensure that you are still in the Patch Edition file system.
5. Run the Excel4apps Wands Installer
UNIX:
./install.sh
Windows:
C:\>install.cmd
[applmgr@oracle122 excel4apps_wands_oracle6.2.0]$
1. As the Applications node technology stack owner (applmgr)user run the adcgnjar Utility:
[applmgr@oracle122 classes]$ adcgnjar
Windows:
C:\>install.cmd APPS_TIER
[applmgr@oracle122 excel4apps_wands_oracle6.2.0]$
4. For shared APPL_TOP installations, simply run AutoConfig for the remaining nodes.
4.6 Cutover
1. Connect to the Run Edition file system and run the adop cutover phase.
The System Administrator Configuration Options section of the online user guide (accessible via the
product or logging on to the customer community) includes settings that affect the Shared
Templates Drive functionality. If you wish to use the EBS Database option as your preferred Drive
type, you will be required to execute a SQL script, please see the Shared Templates Drive Type
section of the online user guide for complete configuration instructions.
4.8.2 GL Wand
There is not much that needs to be done specifically for the GL Wand product. You should just
review the default options to ensure that they are appropriate for your users. These options can be
set on the System Administrator options dialog. Please see the user guide (accessible via the product
or logging on to the customer community) and navigate to the System Administrator Options section
under the Excel4apps menu and specifically review the System Administrator User Options which
include a number of items that affect GL Wand functionality.
The System Administrator User Options section of the online user guide (accessible via the product
or logging on to the customer community) includes settings for configuring your email which will
allow you to send RDM published workbooks via email.
The System Administrator User Options section of the online user guide (accessible via the product
or logging on to the customer community) includes settings that affect the Budget Wand
functionality. In addition, should you wish to use the automatic posting feature for budget journals,
you must complete the necessary setup of the AutoPost criteria set in Oracle. The details can be
found in the user guide under the Budget Wand section.
The Reports Wand product will work without any further configuration steps and you can create
your own queries and reports. However, if you have the Reports Wand insights feature installed, you
will need to enable it. The insights section of the of the online user guide include all instructions
required for installing Reports Wand insights and generating all relevant content. Additional Reports
Wand configuration options are detailed in the System Administrator User Options section of the
online user guide.
The System Administrator User Options section of the online user guide (accessible via the product
or logging on to the customer community) includes settings that affect the Journal Wand
functionality. In addition, should you wish to use the automatic posting feature for journals, you
After logging into Oracle E-Business Suite, users can navigate to the Excel4apps launch page causing
the Excel4apps Launcher plugin to kick off some commands, ensuring that the user has the latest
copy of the Excel4apps client code. If the user does not have the latest, then they will be notified
that the files are being updated. This downloads a new Java Runtime Image from the EBS server. This
file is about 25mb and can impact the product launch on slower network speeds.
The installer will prompt the user to install the custom database objects:
Enter Y to create custom tables in the APPS schema [N]: Y
It is important that you understand your current Oracle license agreement and whether custom
database objects are permitted. The custom database objects can be installed after the installation
1. Open a browser.
2. Enter the URL for your Oracle system followed by /OA_HTML/excel4apps e.g.
http://server.domain.com:8000/OA_HTML/excel4apps.
3. The test page should display similar to the image below.
6.1 Chrome
On initial launch of this version, the user will be instructed to install an Excel4apps Wands launcher
plugin from the Chrome App Store.
6.2 Firefox
On initial launch of this version, if using Firefox, users will be requested to download our Firefox
specific add-on which is installed in the browser.
6.4 Edge
Instruction will be published soon.
Run the Excel4apps Wands Installer in VALIDATION mode, using the –-hotpatch option when
executing in the RUN edition filesystem:
UNIX:
./install.sh --hotpatch VALIDATE
Windows:
C:\>install.cmd --hotpatch VALIDATE
Below is an example of the output that the validation routine will generate:
[applmgr@oracle122 excel4apps_wands_oracle5.9.0.898]$ ./install.sh --hotpatch VALIDATE
Installer Mode: VALIDATE
Excel4apps Wands Installer Started
Enter the APPS username [APPS]:
Enter the APPS password:
Database Connection Details from Environment Context File:
/home/ebs122/oracle/VIS/fs2/inst/apps/VIS_oracle122/appl/admin/VIS_oracle122.xml
==========================================================
Server: oracle122
Port: 1525
Sid: VIS
Enter Y to use the following connection settings [Y]:
Servlet Configuration: PASSED
Application File Deployment: PASSED
OAF Artifacts: PASSED
AOL Objects: PASSED
Call Servlet Test Page: PASSED
Installer Completed Successfully
Program Exit Status=0
[applmgr@oracle122 excel4apps_wands_oracle5.9.0.898]$
If the installer validation routine fails, please contact Excel4apps support by emailing the validation
log file to e4asupport@insightsoftware.com.
8 Uninstall Steps
The following instructions can be used to uninstall the Excel4apps Wands software on Oracle EBS
12.2.x environments:
4. On both the Run and Patch Edition filesystems, remove the following lines from the bottom
of the custom OACORE web.xml template file,
$FND_TOP/admin/template/custom/oacore_web_xml_FMW.tmp :
<!-- Excel4apps Wands x Alias -->
<servlet>
<servlet-name>excel4apps</servlet-name>
Note: The Oracle E-Business Suite system does not allow for the complete removal of all custom
configuration e.g. Custom Applications and is thus not covered by this procedure.
See the “Installation Guide - Performance Optimization” for our performance tuning tips.