This chapter describes how to configure the Oracle E-Business Suite plug-in for use by one or more Oracle ECM adapter solutions. It covers the following topics:
Section 2.1, "Configuring Oracle E-Business Suite Solution Components"
Section 2.2, "Securing Adapter Communications for Oracle E-Business Suite"
Section 2.3, "Configuring AXF-Related Oracle E-Business Suite Tables"
Section 2.5, "Uninstalling AXF From Oracle E-Business Suite"
Note:
If installing adapter solutions for Oracle PeopleSoft but not Oracle E-Business Suite, skip this chapter and complete the steps described in Chapter 3, "Configuring the Oracle PeopleSoft Suite Plug-In."Configuring the Oracle E-Business Suite portion of AXF requires an active connection to the Oracle E-Business Suite database, general database experience, and knowledge of Oracle E-Business Suite Forms Builder. Consult your local DBA for assistance with these tasks. The instructions in this section assume the use of SQL*PLUS, but you can use any tool capable of querying the Oracle Database.
This section describes how to configure Oracle E-Business Suite components for the solutions. It covers the following topics:
Section 2.1.1, "Creating the AXF Oracle E-Business Suite Configuration Schema User (AXF)"
Section 2.1.2, "Configuring the Oracle E-Business Suite Database"
The adapter uses an Oracle E-Business Suite database to store PL/SQL procedures and Oracle E-Business Suite configuration information. Follow these steps to create a database user for use by AXF within the Oracle E-Business Suite database.
Note:
If using Oracle E-Business Suite 11i and Oracle Database 9i, you must install the Oracle XML Database XDB Package into the Oracle E-Business Suite database. (This requirement applies only when using Oracle E-Business Suite 11i and Oracle Database 9i.) For information about installing the Oracle XML Database XDB Package, see the Oracle Database 9i documentation.Create a user named AXF.
A system account user name and password is required to create the user. For assistance creating the user, contact your DBA.
Assign the configuration schema user the following access privileges:
Create table
Create sequence
Create public synonym
Create session
Create procedure
Unlimited tablespace
The following PL/SQL procedures are provided. (In some cases, separate Oracle E-Business Suite release 11 and 12 versions are provided.) See Section 2.1.3, "Compiling Oracle E-Business Suite Forms."
| PL/SQL Procedure | Purpose |
|---|---|
| AXF_CREATE_TABLES_SYNONYM | Creates the tables and synonyms used by AXF. |
| AXF_EBS_PROPERTIES_DATA | Populates the AXF_PROPERTIES table with security information for various Oracle E-Business Suite calls to AXF. |
| AXF_APPS_INIT | Required for Oracle E-Business Suite attachment. |
| AXF_ADD_EBS_ATTACHMENT_PROC_R11
AXF_ADD_EBS_ATTACHMENT_PROC_R12 |
Creates a stored procedure that adds an attachment to a transaction in Oracle E-Business Suite. |
| AXF_MANAGED_ATTACHMENT_DATA
AXF_MANAGED_ATTACH_AVAIL AXF_MANAGED_ATTACH_VALUES |
Required for document attachment. |
| AXF_SOAP_CALL_PROC | Creates a stored procedure to make SOAP calls from PL/SQL. |
Follow these steps to configure the Oracle E-Business Suite database.
Locate the scripts in the following folders. Separate folders are provided for Oracle E-Business Suite releases 11 and 12.
MW_HOME/ECM_HOME/axf/adapters/ebs/R12/
MW_HOME/ECM_HOME/axf/adapters/ebs/R11/
Using SQL*PLUS, log in to the Oracle E-Business Suite database as the AXF Oracle E-Business Suite configuration schema user (AXF).
This user was previously created, as described in Section 2.1.1.
As the AXF user, execute the AXF_CREATE_TABLES_SYNONYM script from the applicable Oracle E-Business Suite location.
To execute the script, enter:
@AXF_CREATE_TABLES_SYNONYM.sql
Verify that the following tables were created: AXF_COMMAND_PARAMETERS, AXF_COMMANDS, AXF_CONFIGS, AXF_PROPERTIES, and AXF_FND_MAP.
As the AXF user, execute the AXF_EBS_PROPERTIES_DATA script from the applicable Oracle E-Business Suite location.
To execute the script, enter:
@AXF_EBS_PROPERTIES_DATA.sql
As the APPS user, execute the AXF_APPS_INIT script from the applicable Oracle E-Business Suite location.
Execute the script by entering:
@AXF_APPS_INIT.sql
As the APPS user, execute the AXF_ADD_EBS_ATTACHMENT_PROC_R12 or AXF_ADD_EBS_ATTACHMENT_PROC_R11 script from the applicable Oracle E-Business Suite location.
Execute the script by entering the command appropriate for your version:
@AXF_ADD_EBS_ATTACHMENT_PROC_R12.sql
@AXF_ADD_EBS_ATTACHMENT_PROC_R11.sql
Note:
This compilation may result in warnings, which you can ignore.As the APPS user, execute the AXF_MANAGED_ATTACH_AVAIL, AXF_MANAGED_ATTACH_VALUES, and AXF_MANAGED ATTACHMENT_DATA scripts from the applicable Oracle E-Business Suite location.
Execute the scripts by entering:
@AXF_MANAGED_ATTACH_AVAIL.sql
@AXF_MANAGED_ATTACH_VALUES.sql
@AXF_MANAGED_ATTACHMENT_DATA.sql
As the APPS user, execute the AXF_SOAP_CALL_PROC script from the applicable Oracle E-Business Suite location.
Execute the script by entering:
@AXF_SOAP_CALL_PROC.sql
To enable a seamless integration of custom actions with existing Oracle E-Business Suite Forms, certain files are uploaded to the Oracle E-Business Suite system for the adapters. The adapters use user interface .PLL extension modules to access workflow tasks (Imaging Solution) and documents associated with business records (both solutions).
The Custom.PLL module is slightly modified during configuration to call AXF functions. It notifies AXF each time an Oracle E-Business Suite event occurs, allowing AXF to determine if it relates to AXF functionality.
The AXF_Custom.PLL component performs the following functions:
Calls out to a web service to execute an AXF Command
Responds to the following AXF response commands:
Open Browser
Terminate Conversation
Renders menus to expose AXF functionality based on the Oracle E-Business Suite configuration database.
Follow these steps to copy the AXF_CUSTOM.pld file, convert it to an AXF_CUSTOM.pll file, make modifications, and then compile it to an AXF_CUSTOM.plx file.
Note:
For information on using Oracle Forms Builder, see the following Oracle E-Business Suite documentation:http://www.oracle.com/technology/documentation/applications.html
For the applicable version listed below, copy the AXF_CUSTOM.pld file to the E-Business Server (to FORMS_PATH for Oracle E-Business Suite 12, or FORMS60_PATH for Oracle E-Business Suite 11).
Oracle E-Business Suite 12: MW_HOME/ECM_HOME/axf/adapters/ebs/R12/AXF_CUSTOM.pld
Oracle E-Business Suite 11: MW_HOME/ECM_HOME/axf/adapters/ebs/R11/AXF_CUSTOM.pld
Note:
If you are using a Linux/UNIX system and copied the .PLD from a Windows system, issue thedos2unix command before converting it below.Open Oracle Forms Builder and connect to the Oracle E-Business Suite database as the APPS user. Forms Builder is typically located in the /bin/ subdirectory of your database's Oracle home.
Note:
Be sure to connect to the Oracle E-Business Suite database. If you fail to connect, verify the tnsnames.ora file.In Forms Builder, convert AXF_CUSTOM.pld to AXF_CUSTOM.pll.
In Oracle E-Business Suite 12, select File, then Convert.
In Oracle E-Business Suite 11, select File, then Administration, then Convert.
Select PL/SQL libraries and Text to binary while converting the file.
Note:
If the following error displays during conversion of AXF_CUSTOM.pld to AXF_CUSTOM.pll, repeat this step until the file successfully converts.PDE-PLI038 - Can not open file as a PL/SQL Library
Note:
If the following error displays during conversion, click OK repeatedly until the file successfully converts.PDE-PLI018 - Could not find library AXF_CUSTOM
From the File menu, open AXF_CUSTOM.pll.
In Oracle E-Business Suite 12, select Program, then Compile pl/sql, then All.
In Oracle E-Business Suite 11, select Program, then Compile, then All.
Compile AXF_CUSTOM into a module (.plx).
In Oracle E-Business Suite 12, select Program, then Compile Module.
In Oracle E-Business Suite 11, select File, then Administration, then Compile File.
Notes:
You must compile AXF_CUSTOM using the APPS schema user ID.
If you encounter the following identifier or other errors referencing objects in APPCORE.pll while compiling, this indicates that the APPCORE.pll file must be attached to your form:
'APP_SPECIAL.ENABLE' must be declared (a).
Select File then Connect and ensure that you are connected to the database as the APPS user.
WARNING:
Modifications to CUSTOM.pll are modifications to the Oracle E-Business Suite infrastructure. Ensure that you have appropriately backed up this file before making changes.
Open CUSTOM.pll by selecting File, then Open and selecting PL/SQL Libraries (*.pll) in the Files of Type field. After opening the file and expanding Program Units, right-click the custom package body of CUSTOM.pll and select pl/sql editor.
In the body text of CUSTOM.pll, modify the following text formatted in bold italics for the solutions you are configuring. If the file contains other customizations, place the following modification after the existing code inside each function/procedure.
For Managed Attachments Only or Both Solutions:
function zoom_available return boolean is
begin
-- Required for ALL integrations
return true;
end zoom_available;
For Imaging Solution Only:
function zoom_available return boolean is
begin
-- Required for ALL integrations
return AXF_CUSTOM.zoom_available();
end zoom_available;
Important:
Be sure to modify the body text of the pll, NOT its header. Scroll down until you reach the following comment header:- -Real code starts here
In the body text of CUSTOM.pll, modify the following text formatted in bold italics. If the file contains other customizations, place the following modification after the existing code inside each function/procedure.
procedure event(event_name varchar2) is
begin
-- Required for AXF integrations
AXF_CUSTOM.event(event_name);
null;
end event;
Note:
Do not remove thenull; line.Save CUSTOM.pll by selecting File, then Save.
With CUSTOM.pll open, determine if AXF_CUSTOM is listed as an attached library.
If it is listed, highlight AXF_CUSTOM and click the minus (-) symbol to detach it. Then reattach AXF_CUSTOM by highlighting Attached Libraries under CUSTOM and clicking the plus (+) symbol; browse to AXF_CUSTOM.pll and select it.
If it is not listed, attach AXF_CUSTOM by highlighting Attached Libraries under CUSTOM and clicking the plus (+) symbol; browse to AXF_CUSTOM.pll and select it.
When prompted to remove the path, click Yes.
With CUSTOM.pll open, verify that APPCORE and APPCORE2 are listed as attached libraries to AXF_CUSTOM.pll. If not listed, attach them. If listed, detach and attach them.
With CUSTOM.pll open, select Program, then Compile pl/sql, then All (Oracle E-Business Suite 12) or Program, then Compile, then All (Oracle E-Business Suite 11).
Compile CUSTOM into a module (.plx) by selecting Program, then Compile Module (Oracle E-Business Suite 12) or File, then Administration, then Compile File (Oracle E-Business Suite 11).
Save all before exiting Forms Builder. Verify that the Zoom menu command displays in the appropriate Oracle E-Business Suite forms.
This section covers the following topics:
Follow these steps to configure SOAP security, in which the application sends the SOAP user and password in the header for authentication.
Enable SOAP security by specifying TRUE for the AXF_SOAP_SECURITY property in the AXF_PROPERTIES Table (Oracle E-Business Suite).
Set the AXF_SOAP_POLICY property to USER_NAME_TOKEN.
Set the AXF_SOAP_USER value (for example, to weblogic).
Store the SOAP password in the database vault by executing the following command as APPS schema:
execute fnd_vault.put('AXF','AXF_SOAP_USER','SOAP_PASSWORD');
Where AXF_SOAP_USER is the SOAP user id used in the SOAP header for authentication, and SOAP_PASSWORD is the SOAP password.
Verify the previous command with this statement:
select fnd_vault.get ('AXF','AXF_SOAP_USER') from dual;
Perform the following procedures to specify Oracle E-Business Suite system settings for SSL configuration for AXF.
Run Oracle Wallet Manager. In Linux, the owm executable is located at:
//ORACLE_HOME/bin/owm
Create a wallet. Using the wizard, enter the required information to create a certificate. Export to a file.
Submit the certificate request to CA (Certificate Authority, such as Verisign) to purchase a new certificate.
Save the SSL certificates with a .cer extension. Most likely, the CA provided an SSL certificate, an Intermediate certificate, and a Trusted Root certificate through e-mail.
Import the Root and Intermediate certificates into the Oracle Wallet by right-clicking Trusted Certificates and importing.
Import the SSL certificate into the wallet manager.
If the process is successfully completed, a Ready status displays.
Tip:
To import the SSL certificate, right- click the Certificate Requested tree item if needed.Save the wallet in one of the folders defined in the FORMS_PATH. (It is saved with the name ewallet.p12).
For more information, see "Configuring SSL" in Oracle Fusion Middleware Securing Oracle WebLogic Server.
On the Oracle E-Business Suite database, run the SQL statements listed below.
update AXF_PROPERTIES set propvalue='file:walletpath' where propname = 'AXFWalletPath';
update AXF_PROPERTIES set propvalue='ON/OFF' where propname = 'SecureMode';
commit;
In the Oracle E-Business Suite AXF_CONFIGS table, update the SOLUTIONENDPOINT value to reflect the SecureMode setting and secure port. When SecureMode is on, the integration attempts to connect to the AXF application using SSL (https).
Begin the value with https:// if SecureMode is on. Begin with http:// if SecureMode is off.
Change Port to match the secure port on the ECM side.
For the Imaging solution, see Section A.4.2. For the Managed Attachments solution, see Section B.2.1.
Store the Wallet password in the database vault by executing the following command as APPS schema:
execute fnd_vault.put('AXF','AXFWalletKey','WalletPassword');
Where WalletPassword is the wallet password.
Verify the previous command with this statement:
select fnd_vault.get ('AXF','AXFWalletKey') from dual;
Import the AXF certificate into the wallet.
Enable SSL on Oracle WebLogic Server on the ECM side.
For information, see "Configuring SSL for Oracle ECM Applications" in Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.
Exchange server certificates between the web servers.
This step involves exporting the certificate from Oracle Wallet and importing it into the Oracle WebLogic Server keystore on the ECM side of the integration. This keystore must be enabled for both the Administration and Oracle I/PM servers. In addition, you must export the server certificate from the Oracle Weblogic Server and import it into the Oracle Wallet.
Configure the AXF-related Oracle E-Business Suite tables to enable the AXF solution on Oracle E-Business Suite Forms using a Zoom menu and command.
For the Imaging solution, see Section A.4.
For the Managed Attachments solution, see Section B.2.
You enable logging for specific forms in the AXF_CONFIGS table. For the Imaging solution, see Section A.4.2; for the Managed Attachments solution, see Section B.2.1.
To enable logging for a particular Form function, set the LOGENABLED field to either 1, YES or TRUE to create the file in the UTL_FILE_DIR folder. Consult with your DBA to verify that the UTL_FILE_DIR folder is available and accessible. Log files are named Username_MASTER_LOG.txt, and continue to grow as items are appended.
Follow these steps to uninstall AXF from Oracle E-Business Suite.
Assign the AXF configuration schema user the following privileges:
Drop table
Drop sequence
Drop public synonym
As the AXF user, execute the AXF_DROP_TABLES_SYNONYM script for your Oracle E-Business Suite version, from the applicable location listed below. This script drops all tables, synonyms, and sequences created by the AXF_CREATE_TABLES_SYNONYM script run during installation.
Oracle E-Business Suite 12: MW_HOME/ECM_HOME/axf/adapters/ebs/R12/AXF_DROP_TABLES_SYNONYM.sql
Oracle E-Business Suite 11: MW_HOME/ECM_HOME/axf/adapters/ebs/R11/AXF_DROP_TABLES_SYNONYM.sql
Execute the script by entering:
@AXF_DROP_TABLES_SYNONYM.sql
Remove the AXF database schema user.
Remove AXF_CUSTOM.* (AXF_CUSTOM.pll, AXF_CUSTOM.pld, and AXF_CUSTOM.plx) from FORMS_PATH (or FORMS60_PATH on Oracle E-Business Suite 11 systems).
Restore the CUSTOM.pll file you backed up in step 7 in Section 2.1.3.
Open Oracle Forms Builder and connect to the Oracle E-Business Suite database as the APPS user. Forms Builder is typically located in the /bin/ subdirectory of your database's Oracle home.
Open the restored CUSTOM.pll by selecting File, then Open and selecting PL/SQL Libraries (*.pll) in the Files of Type field.
With CUSTOM.pll open, select Program, then Compile pl/sql, then All (Oracle E-Business Suite 12) or Program, then Compile, then All (Oracle E-Business Suite 11).
Compile CUSTOM into a module (.plx) by selecting Program, then Compile Module (Oracle E-Business Suite 12) or File, then Administration, then Compile File (Oracle E-Business Suite 11).
Save all before exiting Forms Builder.