2 Configuring E-Business Suite Components

2.1.1 PLL Modules

In AXF, user interface .PLL extension modules are used to access workflow tasks (Imaging Solution) and documents associated with business records (both solutions).

The Custom.PLL module is slightly modified during installation to call AXF functions. It notifies AXF each time an E-Business Suite event occurs, allowing AXF to determine if it relates to AXF functionality. See "Compiling E-Business Suite Forms".

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 E-Business Suite configuration database.

2.1.2 PL/SQL Procedures

The following PL/SQL procedures are provided. (In some cases, separate E-Business Suite release 11 and 12 versions are provided.) See "Configuring the E-Business Suite Database".

2.1.3 AXF-Related Tables in E-Business Suite

Configuring AXF for E-Business Suite requires configuring AXF-related tables in E-Business Suite. These tables are used to specify which screens are enabled to execute configured AXF commands. See "About the AXF Tables in E-Business Suite".

AXF-related E-Business Suite tables include the following:

• AXF_CONFIGS Table

• AXF_COMMANDS Table

• AXF_COMMAND_PARAMETERS Table

• AXF_PROPERTIES Table

• AXF_FND_MAP Table

2.2.1 Creating the AXF E-Business Suite Configuration Schema User (AXF)

The adapter uses an E-Business Suite database to store PL/SQL procedures and E-Business Suite configuration information. Follow these steps to create a database user for use by AXF within the E-Business Suite database.

1. Create a user named AXF.

   A system account username and password is required to create the user. For assistance creating the user, contact your DBA.

2. Assign the configuration schema user the following access privileges:

   • Create table

   • Create sequence

   • Create public synonym

   • Create session

   • Create procedure

   • Unlimited tablespace

2.2.2 Configuring the E-Business Suite Database

Follow these steps.

1. Locate the scripts in the following folders. Separate folders are provided for E-Business Suite releases 11 and 12.

   MW_HOME/ECM_HOME/axf/adapters/ebs/R12/

   MW_HOME/ECM_HOME/axf/adapters/ebs/R11/

2. Using SQL*PLUS, log in to the E-Business Suite database as the AXF E-Business Suite configuration schema user.

   This user was previously created, as described in "Creating the AXF E-Business Suite Configuration Schema User (AXF)".

3. As the AXF user, execute the AXF_CREATE_TABLES_SYNONYM script from the applicable E-Business Suite location. This script creates the tables and synonyms used by AXF.

   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.

4. As the AXF user, execute the AXF_EBS_PROPERTIES_DATA script from the applicable E-Business Suite location.

   To execute the script, enter:

   @AXF_EBS_PROPERTIES_DATA.sql

5. Log in as the APPS user.

6. As the APPS user, execute the AXF_APPS_INIT script from the applicable E-Business Suite location.

   Execute the script by entering:

   @AXF_APPS_INIT.sql

7. As the APPS user, execute the AXF_ADD_EBS_ATTACHMENT_PROC_12 or AXF_ADD_EBS_ATTACHMENT_PROC_11 script from the applicable E-Business Suite location. This script creates a stored procedure for inserting attachments to the transaction record.

   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 can be ignored.

8. As the APPS user, execute the AXF_MANAGED_ATTACH_AVAIL, AXF_MANAGED_ATTACH_VALUES, and AXF_MANAGED ATTACHMENT_DATA scripts from the applicable E-Business Suite location.

   Execute the scripts by entering:

   @AXF_MANAGED_ATTACH_AVAIL.sql

   @AXF_MANAGED_ATTACH_VALUES.sql

   @AXF_MANAGED_ATTACHMENT_DATA.sql

9. As the APPS user, execute the AXF_SOAP_CALL_PROC script from the applicable E-Business Suite location. This script creates a stored procedure to make SOAP calls from PL/SQL.

   Execute the script by entering:

   @AXF_SOAP_CALL_PROC.sql

2.2.3 Compiling E-Business Suite Forms

AXF installation requires certain files to be uploaded to the E-Business Suite system, which enables a seamless integration of custom actions with existing E-Business Suite Forms.

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.

1. For the applicable version listed below, copy the AXF_CUSTOM.pld file to the E-Business Server (to FORMS_PATH for E-Business Suite 12, or FORMS60_PATH for E-Business Suite 11).

   E-Business Suite 12: MW_HOME/ECM_HOME/axf/adapters/ebs/R12/AXF_CUSTOM.pld

   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 the dos2unix command before converting it below.

2. Open Oracle Forms Builder and connect to the 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 E-Business Suite database. If you fail to connect, verify the tnslistener.ora file.

3. In Forms Builder, open and convert AXF_CUSTOM.pld to AXF_CUSTOM.pll, by selecting File, then Administration, then Convert. Select PL/SQL libraries and Text to binary while converting the file.

   Note:

   If the following error is displayed 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 is displayed during conversion, click OK repeatedly until the file successfully converts.

   PDE-PLI018 - Could not find library AXF_CUSTOM

4. From the File menu, open AXF_CUSTOM.pll. Select Program, then Compile pl/sql, then All (E-Business Suite 12) or Program, then Compile, then All (E-Business Suite 11).

5. Compile AXF_CUSTOM into a module (.plx) by selecting Program, then Compile Module (E-Business Suite 12) or File, then Administration, then Compile File (E-Business Suite 11).

   Notes:

   • AXF_CUSTOM must be compiled 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).

6. Select File then Connect and ensure that you are connected to the database as the APPS user.

7. Back up the CUSTOM.pll file.

   WARNING:

   Modifications to CUSTOM.pll are modifications to the E-Business Suite infrastructure. Ensure that this file is appropriately backed up before making changes.

8. 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.

9. In CUSTOM.pll, modify the following text formatted in bold italics for the solutions you are configuring. If the file contains other customizations, place these modifications 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;
     

10. In CUSTOM.pll, modify the following text formatted in bold italics. If the file contains other customizations, place these modifications 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;
    

11. 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.

12. With CUSTOM.pll open, select Program, then Compile pl/sql, then All (E-Business Suite 12) or Program, then Compile, then All (E-Business Suite 11).

13. Compile CUSTOM into a module (.plx) by selecting Program, then Compile Module (E-Business Suite 12) or File, then Administration, then Compile File (E-Business Suite 11).

14. Save all before exiting Forms Builder. Verify that the Zoom menu command is displayed in the appropriate E-Business Suite forms.

2.2.4 Setting User Locales

To prevent issues with different locales when invoking AXF, E-Business Suite users should set the same values for their user locale preference and their browser locale. If using the Managed Attachments Solution, the same value should also be set for the Oracle UCM locale.

2.3.1 Securing E-Business Suite to AXF Communications

Follow these steps to configure SOAP security, in which the application sends the SOAP user and password in the header for authentication.

1. Enable SOAP security by specifying TRUE for the AXF_SOAP_SECURITY property in the AXF_PROPERTIES table (see "AXF_PROPERTIES Table").

2. Set the AXF_SOAP_POLICY property to USER_NAME_TOKEN.

3. 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.

4. Verify the previous command with this statement:

   select fnd_vault.get ('AXF','AXF_SOAP_USER') from dual;

2.3.2 Securing Web Services

Follow the steps in this section to apply the wss_username_token_service_policy to all web services via the WebLogic Server Administration Console.

1. Log in to the WebLogic Server Administration Console.

2. From the Domain Structure options, select Deployments. The Summary of Deployments page is displayed.

3. From the Deployments table, select imaging.

4. Click the Update button. The Update Application Assistant page is displayed.

5. Select the lower Redeploy this application using... option to redeploy the ear file with a deployment plan.

6. Click the Change Path button for the Deployment plan path option, browse to the following location, and select the Plan.xml file:

   MW_HOME/user_projects/applications/domain_name/server/ipm

7. Continue the wizard and complete the deployment.

2.4.1 AXF Logging

Use the AXF logs to isolate issues in solution configuration. By default, some AXF logging automatically occurs as part of Application Server logging. Follow these steps to configure more detailed and separate AXF logging.

1. Add a log handler to the Application Server configuration. Add the handler inside the <log_handlers> tag in the logging.xml file, at the following location:

   DOMAIN/config/fmwconfig/servers/SERVER/logging.xml

   An example location follows:

   base_domain/config/fmwconfig/servers/IPM_Server1/logging.xml

   <log_handler name='axf-handler'class='oracle.core.ojdl.logging.ODLHandlerFactory' level='ALL'>
      <property name='path' value='${domain.home}/servers/${weblogic.Name}/logs/axf.log'/>
      <property name='maxFileSize' value='5485760'/>
      <property name='maxLogSize' value='54857600'/> 
      <property name='encoding' value='UTF-8'/>
   </log_handler>
   

2. Add a logger to the logging.xml file and set the level from the Log Levels (ODL Message Types) listed in Table 2-1. You can set the logging level in the XML file or using Enterprise Manager.

   <logger name='oracle.imaging.axf' level='TRACE:32' useParentHandlers='false'>
        <handler name='axf-handler'/>
        <handler name='console-handler'/>
   </logger>
   

   Note:

   Remove the console-handler tag to omit logging on the console.

3. Table 2-1 Available Logging Levels

   Log Type	Description	Log Level (ODL Message Type)
   NULL	The logger inherits the log level set for its parent.	n/a
   SEVERE	Log system errors requiring attention from the system administrator.	ERROR:1
   WARNING	Log actions or conditions discovered that should be reviewed and may require action before an error occurs.	WARNING:1
   INFO	Log normal actions or events. This could be a user operation, such as login completed, or an automatic operation, such as a log file rotation.	NOTIFICATION:1
   CONFIG	Log configuration-related messages or problems.	NOTIFICATION:16
   FINE	Log trace or debug messages used for debugging or performance monitoring. Typically contains detailed event data.	TRACE:1
   FINER	Log fairly detailed trace or debug messages.	TRACE:16
   FINEST	Log highly detailed trace or debug messages.	TRACE:32

   
   

4. Restart Administration Server if it is running. The logger is displayed in Enterprise Manager. You can change the logging level at run time.

2.4.2 E-Business Suite Logging

You enable logging for specific forms in the AXF_CONFIGS Table. For details, see "Enabling E-Business Suite Logging".

2.4.3 Oracle UCM Logging

For information about Content Server logging, see the Oracle Fusion Middleware System Administrator's Guide for Universal Content Management.