|Oracle® Fusion Middleware Administrator's Guide for Oracle E-Business Suite Adapter for Oracle Enterprise Content Management
11g Release 1 (11.1.1)
Part Number E15865-02
This guide describes the Oracle E-Business Suite Adapter for Oracle Enterprise Content Management. This adapter includes the following solutions:
Imaging Solution, which provides imaging, capture, and workflow capabilities using Oracle Imaging and Process Management (Oracle I/PM). See "About the Imaging Solution".
Attachments Solution, which allows business users to attach, scan, and retrieve document attachments stored in an Oracle Universal Content Management (Oracle UCM) repository. See "About the Managed Attachments Solution".
Oracle Enterprise Content Management solutions use the Application Extension Framework (AXF) infrastructure to integrate a business application with a content management application. See "About Application Extension Framework (AXF)". An AXF solution is a micro-application whose components are created using the AXF infrastructure.
Solutions are installed on top of a base configuration of core AXF and E-Business Suite files standard to solutions that use AXF functionality. (AXF is included in Oracle I/PM installation.) AXF-related tables are configured in E-Business Suite to specify which screens are enabled to execute configured AXF commands and PLL modules are modified. See "About E-Business Suite Components".
System requirements are listed in "Adapter System Requirements". Additional requirements for the Managed Attachments solution are listed in "System Requirements For the Managed Attachments Solution".
This guide contains the following chapters:
Chapter 1, "Solutions Overview", introduces AXF components, the imaging and attachments solutions, security and authentication, and adapter system requirements.
Chapter 2, "Configuring E-Business Suite Components" describes how to configure E-Business Suite components for the adapter.
Chapter 3, "Configuring Imaging Solution Components," describes how to configure the BPEL Connection for solutions.
Chapter 4, "Configuring Managed Attachments Solution Components" lists installation and configuration steps specific to the Managed Attachments Solution.
Chapter 5, "Imaging Solution Tables" describes the AXF and E-Business Suite configuration tables used for the Imaging Solution, including commands and web user interface tools, and provides example implementations.
Chapter 6, "Managed Attachments Solution Tables" defines the AXF, E-Business Suite, and Content Server tables configured for the Managed Attachments Solution.
Oracle's Application Extension Framework (AXF) is a command-driven, web services integration between a business application such as E-Business Suite and a content management application such as Oracle I/PM or Oracle UCM (also referred to as Content Server). The open Java-based architecture of AXF allows integrators to configure and modify multiple business process solutions separate from the systems themselves, and to upgrade systems without affecting implemented AXF solutions.
The Application Extension Framework includes the following components:
AXF Solution Templates
Note:To obtain a solution template, contact your systems integrator, Oracle Consulting, or Oracle Support.
AXF provides reusable commands for implementing functionality.
The Imaging Solution uses multiple AXF commands, as described in "About AXF Commands".
The Managed Attachments Solution uses a single AXF command that implements Oracle UCM services that temporarily display and provide access to documents associated with an E-Business Suite entity.
AXF Web Tools
AXF provides web interface components for display to users, such as a task list and task viewer. Configured through the AXF tables, these web tools are used in some imaging solutions, and described in "About AXF Web User Tools".
You configure AXF solutions, commands, and web tools by configuring the AXF database tables. The solutions use the AXF tables in different ways. For information about each table and example implementations for the solution, see "Imaging Solution Tables" or "AXF Tables for Managed Attachments Solution".
A workflow imaging solution is an integration between a business application such as E-Business Suite and BPEL (Oracle BPEL Process Manager), using Oracle I/PM as the imaging source, as illustrated in Figure 1-1. Through an AXF configuration, business users can process associated images and perform document-centric workflow tasks from their business application user interface.
This section covers the following topics:
From a business user's perspective, the integration is virtually seamless. End-users use the Imaging Solution to:
Launch Oracle I/PM from E-Business Suite, and select and perform workflow tasks. For example, users performing Invoice Processing tasks select a custom menu command integrated into their business application called Invoice Processing, initiating the following processes:
A SOAP request is generated and sent to AXF, passing the selected command along with additional parameters such as an AXF solution (Invoice Processing), an AXF command (Open_Tasklist), and a user name.
AXF returns an Open_URL command with the URL to launch, such as an AXF Task List.
The business application opens the Task List URL in a new browser window, enabling the user to start processing invoice images.
View attached images and metadata values. Use Oracle I/PM's tools for viewing, annotating, and redacting images, as permissions allow.
Key entries in E-Business Suite while viewing images and related values in the Oracle I/PM viewer.
Perform actions related to the workflow task, such as routing, canceling, updating, and completing tasks.
Scan or upload supporting documents for a selected E-Business Suite record.
View supporting images for an E-Business Suite record without leaving the E-Business Suite application.
An Imaging Solution configured for invoice processing might work as follows:
A workflow process automatically generates user tasks.
An invoice is uploaded, metadata values are assigned, and a task for processing the invoice is generated. Typically, tasks are pooled into profiles from which groups of users select. A user may have access to tasks in multiple profiles.
From E-Business Suite, the user launches the Imaging Solution, by selecting a command called Process Invoices from the Zoom menu (or other special menu or key).
The user selects a task from those listed for a selected profile. Once a task is selected (acquired), it is no longer available to other users.
In the Task Viewer, users view the task's invoice image, key entries in E-Business Suite based on the image, and perform related commands.
Additional action commands are typically provided in a side panel. Users might route the task to another user or user group for approval, add comments for others to view, skip the task, or re-scan or delete the task's document.
Users complete the task and begin another, if desired.
Most often, changes users make in E-Business Suite are synchronized with Oracle I/PM, and vice versa.
Note:For details about Imaging Solution user tasks, see the Oracle Fusion Middleware User's Guide for Oracle Enterprise Content Management Solutions for Oracle E-Business Suite.
An Imaging Solution configured for capturing supporting documents might work as follows:
From E-Business Suite, a user retrieves a record such as an employee record.
The user launches the document imaging solution, by selecting a command called Scan Employee Document from the Zoom menu (or other special menu or key).
Oracle Distributed Document Capture launches and automatically initiates a scan (if a scanner is attached to the desktop) or allows the user to upload electronic images from desktop.
The user enters index values (metadata) in Oracle Distributed Document Capture to store with the images.
The user clicks Send, which transmits the captured document images and their metadata from Oracle Distributed Document Capture to Oracle I/PM.
An Imaging Solution configured for viewing supporting documents might work as follows:
From E-Business Suite, a user retrieves a record such as an employee record.
A user launches the document imaging solution, by selecting a command called View Employee Documents from the Zoom menu (or other special menu or key).
From the list of documents associated with the employee record and their metadata values, the user selects a document.
The document is displayed in the Oracle I/PM viewer, where the user can view its images, and with appropriate permissions, apply annotations or redactions.
Figure 1-2 illustrates an imaging solution configuration for the E-Business Suite adapter.
The reusable AXF commands allow you to implement the functionality described below. For information about these commands, including their parameters and example implementations, see "AXF Commands".
|Open Task||Initializes and displays the AXF Task Viewer web page and claims a human workflow task. See "Open Task Command".|
|Autotask||Initializes autotask mode, in which a new human workflow task is automatically claimed in the AXF Task Viewer without displaying the Task List. See "Autotask Command".|
|Release Task||Initializes the AXF Task List web tool for display (regardless of Autotask mode) and releases a human workflow task. See "Release Task Command".|
|Complete Task||Completes a human workflow task and updates BPEL payload attribute values. If using the Autotask Command, claims the next task and displays it in the Task Viewer. See "Complete Task Command".|
|Redirect||Redirects the current AXF web page to any URL specified in the configuration. See "Redirect Command".|
|Terminate Conversation||Used by an external client to terminate a conversation with AXF. (This command does not include parameters.)|
|Update Task||Updates BPEL payload field values on a specified human task or values in the XML payload using XPATH. See "Update Task Command".|
|Update Task From Procedure||Calls a stored procedure using a specified data source and updates values in the BPEL payload using XPATH. See "Update Task From Procedure Command".|
|Validate Task||Used to validate BPEL system attribute data or BPEL payload data using the Regular Expression language, and based on validation results, execute a subsequent command. See "Validate Task Command".|
Note:You can also deploy custom commands to execute through AXF. See "Custom Commands".
The Imaging Solution provides the following user interface components. These are web interface components displayed to users and configured through the AXF tables.
The Task List web page displays a list of available tasks to users. It interacts with the AXF infrastructure and BPEL to display the list using views configured in the BPEL Worklist application.
Note:Use the BPM Worklist application to create views and share them with other users or groups.
For configuration information, see "Task List Web Tool".
The Task List web tool can also display a list of AXF actions just like the Task Viewer, using AXF action commands. These action commands are menu components configured in the AXF_ACTIONS Table for display on a web page.
The Task Viewer web page displays images and metadata values through interaction with the AXF infrastructure, BPEL, Oracle I/PM, and the business application. It also typically displays a side menu containing AXF action commands configured in the AXF_ACTIONS Table. It may also include a Comments side pane; see "About Comments".
For configuration information, see "Task Viewer Web Tool".
The Enumeration Picker web page allows users to select from a list of enumerated values configured in the AXF database tables.
For configuration information, see "Enumeration Picker Web Tool".
The Identity Picker web page allows users to select one or more users or groups from an identity store configured for BPEL. After choosing an identity, a related action is typically taken. Most likely, a task is assigned or delegated to the selected user or group of users. For example, a business user who encounters a problem with a transaction might select an exception handler to send the transaction to, after entering a comment that describes the problem.
For configuration information, see "Identity Picker Web Tool".
The Comments web page allows users to enter comments related to the human task during the transaction's processing. Comments can be displayed in a side pane on the Task Viewer. Comments persist for the entire process, allowing users to view and add comments. Comments are saved using the native comments capabilities of BPEL's workflow task.
For configuration information, see "Comments".
The Managed Attachments Solution allows business users to attach, scan, and retrieve attachments stored in an Oracle UCM Content Server repository. An Oracle UCM repository enables users throughout an enterprise to view, collaborate on, and retire content, ensuring that content is secure, accurate, and up-to-date.
This section covers the following topics:
E-Business Suite users can perform these tasks in the Managed Attachments Solution:
Check in new documents to Content Server and attach them to the selected E-Business Suite entity
Scan and import documents using Oracle Distributed Document Capture, attaching them to the selected E-Business Suite entity
Open documents in their native application or Web-viewable format
Detach documents from the selected E-Business Suite entity
Search Content Server and attach documents to the selected E-Business Suite entity from the Oracle UCM repository
Check out documents, locking them to changes by other users
Modify a document's metadata values
Refresh the list of attachments
Select and order fields for display in the attachments list
View an attached document's information
Note:For details about Managed Attachments Solution user tasks, see the Oracle Fusion Middleware User's Guide for Oracle Enterprise Content Management Solutions for Oracle E-Business Suite.
Figure 1-8 illustrates an attachments solution configuration for E-Business Suite.
With this solution, Oracle UCM documents are listed as managed attachments to E-Business Suite forms in a customizable screen launched from the E-Business Suite Zoom menu. For example, an E-Business Suite user displays an Employee record, invokes the Managed Attachment functionality, and attaches a passport image and supporting identity documents.
When the E-Business Suite user selects the Managed Attachments command from the Zoom menu from an E-Business Suite entity, the adapter makes an AXF request. This solution supports a single AXF command called AfGrantAccessCommand.
The AfGrantAccessCommand command calls the AF_GRANT_ACCESS Oracle UCM service. This service temporarily grants a user who has logged into E-Business Suite access to all Oracle UCM documents associated with the selected E-Business Suite entity and to which the user has security group access. This service also returns an AXF response containing a Managed Attachments URL to invoke the Oracle UCM attachments framework search. This framework search lists all documents associated with the E-Business Suite entity.
With the returned URL, the solution opens the Managed Attachments browser window for the E-Business Suite user, also displaying a line of key values (AFLabel) for the E-Business Suite entity with which the attachment list is associated.
How Oracle UCM Access is Granted to the E-Business Suite User
The solution uses a temporary authorization mechanism for managed attachments access. Communicating through a trusted RIDC mechanism, AXF invokes the AF_GRANT_ACCESS service with the application entity and user information needing authorization. The AF_GRANT_ACCESS service grants access to the user for the specified period, then ends the user session.
E-Business Suite users must have a Content Server account to display the Managed Attachments screen within the supported E-Business Suite entity. In addition, the authentication model configured for Content Server and E-Business Suite determines how users are authenticated the first time they activate managed attachments from an E-Business Suite record:
Content Server configured for Oracle Single Sign-on: If E-Business Suite is not configured for single sign-on, the Oracle UCM single sign-on login prompt is displayed. (If E-Business Suite is configured for single sign-on, the user has been authenticated so no login prompt is displayed.)
Content Server not configured for Oracle Single Sign-On: The Content Server login form is displayed, regardless of the selected E-Business Suite authentication model.
Note:No user authentication is needed for AXF provided security checks. See "Managing Authentication and Security".
When checking documents into Content Server using the Managed Attachments user interface, users decide how they want them accessed, by choosing one of two modes:
private (not shared): These documents can be accessed only through their associated E-Business Suite entity screens using the Managed Attachments user interface. Users (including the user who checks in a document) cannot search for or access a private document using any other standard Oracle UCM user interface. This is the default security mode when checking in a new document using the Managed Attachments user interface.
shared: These documents are more easily accessed than private documents, because their security is managed by Oracle UCM. In addition to access through their associated E-Business Suite entity screens using the Managed Attachments user interface, any Oracle UCM user with a document's assigned security group access can search for and access the document using any standard Oracle UCM user interface. It is recommended to configure the Oracle UCM profile to specify default Oracle UCM security values for shared document check-in.
Note:Private (not shared) documents are automatically assigned to a special security group called AFDocuments, and users who have access to the E-Business Suite entity are granted temporary access to the documents when they invoke the Managed Attachments user interface from the E-Business Suite Zoom Menu. In certain exceptional cases, special users may be granted direct access to the AFDocuments security group by permanent assignment of the AFRead, AFWrite, AFDelete or AFAdmin roles for the AFDocuments security group, in which case the user could access a private document using any standard Oracle UCM user interface.
The E-Business Suite adapter provides the following authentication points:
Browser level authentication, where end-users invoke an AXF web tool or the Oracle I/PM viewer from an E-Business Suite form configured for access. Authentication at this level is handled by Oracle WebLogic Server.
Service call authentication, where web service calls are made to the Application Extension Framework. The E-Business Suite adapter supports user authentication against the AXF solution mediator web services using a username token security installed on the application server on which AXF resides. This is handled through SOAP security, in which the application sends the SOAP user and password in the header for authentication, as described in "Securing Communications". Secure Sockets Layer (SSL) mode can be configured.
The E-Business Suite Adapter is composed of optional solutions installed over a base configuration of AXF, Oracle I/PM, and Oracle UCM files standard to adapters that use AXF functionality. Requirements for the E-Business Suite Adapter for Enterprise Content Management are listed below.
Note:Supported configuration and certification information is available at:
Note:The Managed Attachments Solution has additional requirements, listed in "System Requirements For the Managed Attachments Solution".
A fully functioning Oracle E-Business Suite system.
E-Business Suite Forms Builder is required for .PLL compilation.
For Oracle E-Business Suite 11i, Forms 6.0 Version 18.104.22.168.2+
For Oracle E-Business Suite 12, Forms Builder Version 10.1.2.0.2+
To avoid duplicate logins, Oracle Single Sign-On or Oracle Access Manager is required.
Note:The E-Business Suite Adapter for ECM supports E-Business Suite Forms only. OAF web pages are not currently supported. In addition, Zoom Menu names are limited to a single language.
For the Imaging Solution, SOA 11gR1 (with patchset 1) is required, along with a BPEL server instance. BPEL is part of SOA 11gR1. Oracle SOA Suite is not needed if configuring the Managed Attachments Solution only.