integrating oracle e-business suite (11i, r12, and r12.1) with content management repositories [id...

17
Integrating Oracle E-Business Suite (11i, R12, and R12.1) with Content Management Repositories [ID 1061947.1] Modified 04-OCT-2010 Type BULLETIN Status PUBLISHED Applies to: Oracle Advanced Product Catalog - Version: 11.5.10.0 to 12.1.2 - Release: 11.5 to 12.1 Information in this document applies to any platform. Purpose Business entities (like Items, Structures, Change Orders, Projects/Tasks etc.) in Oracle E-Business Suite can have attachments, which are unstructured data (files like MS word, xls, ppt, xml etc. and folders). This document describes the setup steps and prerequisites needed to enable attachment of such unstructured data stored in Content Management repositories (like Oracle Universal Content Management (UCM)/Oracle Files/Content Services/Content DB) to the business entities. Scope and Application The ability to attach unstructured data to business entities is available in EBS 11i.10, R12, and R12.1 releases. Integrating Oracle E-Business Suite (11i, R12, and R12.1) with Content Management Repositories Integrating E-Business Suite with UCM Integration Technology The integration between EBS and the Content Management repository (UCM) is achieved using the WEBDAV protocol. WebDAVstands for "Web-based Distributed Authoring and Versioning". It is a set of extensions to the HTTP protocol, which allows users to collaboratively edit and manage files on remote Web servers. For more information, refer to the WebDAV website, www.webdav.org . Features The following features/capabilities are supported when integrating E-Business Suite with UCM.

Upload: pradeep-k-achar

Post on 27-Jul-2015

1.309 views

Category:

Documents


0 download

TRANSCRIPT

Integrating Oracle E-Business Suite (11i, R12, and R12.1) with Content Management Repositories [ID 1061947.1] Modified 04-OCT-2010 Type BULLETIN Status PUBLISHED

Applies to:Oracle Advanced Product Catalog - Version: 11.5.10.0 to 12.1.2 - Release: 11.5 to 12.1 Information in this document applies to any platform.

PurposeBusiness entities (like Items, Structures, Change Orders, Projects/Tasks etc.) in Oracle E-Business Suite can have attachments, which are unstructured data (files like MS word, xls, ppt, xml etc. and folders). This document describes the setup steps and prerequisites needed to enable attachment of such unstructured data stored in Content Management repositories (like Oracle Universal Content Management (UCM)/Oracle Files/Content Services/Content DB) to the business entities.

Scope and ApplicationThe ability to attach unstructured data to business entities is available in EBS 11i.10, R12, and R12.1 releases.

Integrating Oracle E-Business Suite (11i, R12, and R12.1) with Content Management Repositories Integrating E-Business Suite with UCMIntegration Technology The integration between EBS and the Content Management repository (UCM) is achieved using the WEBDAV protocol. WebDAVstands for "Web-based Distributed Authoring and Versioning". It is a set of extensions to the HTTP protocol, which allows users to collaboratively edit and manage files on remote Web servers. For more information, refer to the WebDAV website, www.webdav.org. Features The following features/capabilities are supported when integrating E-Business Suite with UCM. WebDAV based Integration Yes

Feature Upload a new file (from your desktop) to a folder in the Content Repository and attach it to an EBS business object.

Attach an existing file/folder in the Content Repository to an EBS Yes business object. Render content of an attached Content Repository file from EBS. Yes Detach files/folders from an EBS business object. "Where Attached" feature - Enables you to find all EBS business objects to which a Content Repository file/folder is attached. Embedded browse of Content Repository folders within the EBS Yes Yes No

Feature UI. Single-SignOn integration between EBS and the Content Repository. Attach a specific version of a file in the Content Repository to an EBS business object. Submit specific versions of files in the Content Repository for review or approval from within the EBS UI.

WebDAV based Integration

No No No

Note: UCM Integration through WebServices Mode is currently not supported. Certification Matrix The following releases of EBS and Content Repository are certified. EBS EBS Products Release Certified 12 12.1 PIM PIM Content Repository Release Integration Technology Supported SingleSignOn Support No No

EBS Patch number 9071475:R12.DOM.A 9071475:R12.DOM.B

UCM 10G R3 WebDAV UCM 10G R3 WebDAV

Notes: To turn on the integration between EBS Attachments and external content management repositories like UCM, set the value of profile option "Self-Service Oracle Files Enabled" to "Yes" at the specific application level. Only Oracle Universal Content Management (UCM) is certified with this integration. Content Management products from other vendors are NOT certified. The LastModifiedDate attribute is available for Folders only after applying patch 10gR35UpdateBundle on the UCM Server (see bug ).

E-Business Suite Setup Steps 1. Defining Content Management Repositories in EBS 1.1 Defining and Updating Repositories EBS needs to know the Content Management instance used for the integration. Content Management instances are defined in EBS as "Repositories". The repository definition setup is common for the entire E-business suite. You cannot define a repository for only one product. Typically, at the customer site, a system/applications administrator defines the repositories. While defining the repository, choose the Integration Technology (WebDAV or WebService). To set up the repository, log on as the System Administrator, navigate to the Development Manager > Repository Setup page, then click Update.

Enter the details for the new UCM repository.

Integration Mode Service URL WebDAV Connection URL

WebDAV http://:/idcserver/idcplg/webdav http://:/idcserver/idcplg/webdav

Certificate Path In the case of a SSL enabled UCM instance, use the absolute path of the certificate uploaded to the middle tier. After setting up the connection, perform a Test Connection to verify the repository setup.

Integrating E-Business Suite with Oracle Content DB/Oracle Files OnlineThe following content is applicable for customers who have licensed Oracle's previous content management solutions, such as Oracle Content DB / Oracle Files Online. Integration Technology The integration between EBS and Content Management repository is achieved using 2 different technologies. - WebDAV: It stands for "Web-based Distributed Authoring and Versioning". It is a set of extensions to the HTTP protocol, which allows users to collaboratively edit and manage files on remote Web

servers. For more information, please refer to the WebDAV website, www.webdav.org. - WebServices: Two disparate systems can interact with each other by exposing services that can be invoked by each other using XML messages. Features Based on the integration technology is chosen, the following features/capabilities will be supported.Feature Upload a new file (from desktop) to a folder in Content Repository and attach to a EBS business object. Attach an existing file/folder in Content Repository to a EBS business object. Render content of an attached Content Repository file from EBS. Detach files/folders from EBS business object. "Where Attached" feature - Allowing you to find out all EBS business objects to which a Content Repository file/folder is attached to. Embedded browse of Content Repository folders within EBS UI. Single-SignOn integration b/w EBS and Content Repository Attaching a specific version of a file in Content Repository to EBS business object. Submit review/approval for specific versions of files in Content Repository within EBS UI Show Version history of files in Content Repository within EBS UI Create/Delete files/folders in Content Repository from EBS UI Move/Copy files/folders within Content Repository from EBS UI Check-in/Check-out files in Content Repository from EBS UI Search for content within files stored in Content Repository from EBS UI. Grant/Revoke access to EBS users on Content Repository folders from EBS UI WebDAV Based Integration Yes WebService Based Integration Yes

Yes

Yes

Yes Yes Yes

Yes Yes Yes

No No No

Yes Yes Yes

No

Yes

No No No No No No

Yes Yes Yes Yes Yes Yes

Certification MatrixThe following releases of EBS and Content Repository are certified.

EBS Release

EBS Products Certified Projects, Internal Controls Manager, PIM Projects, Internal Controls Manager, PIM Projects, Internal Controls Manager, PIM

Content Repository Integration Release Technology Supported Files 9.0.3/9.0.4, OCS WebDAV 10.1.2, ContentDB ContentDB WebDAV

Single-SignOn Support No

11i.10

12

No

12

ContentDB

WebService

Yes (with OID version 10.1.2 phase 2)

Note: Only Oracle Content Management products are certified with this integration. Content Management products from other vendors are NOT certified. E-Business Suite Patches The following patches need to be applied to the EBS instance.EBS Release 11i.10 EBS Patches - 3944888 (Base EBS-OCS integration patch) - Latest EBS-OCS integration rollup patch (Included into the latest rollup on top of PLM.E) - 3322788 (only if Content Repository is SSL enabled. Copy the jar to $IAS_TOP/lib) EBS R12 patch

12

1. EBS Patches - 3944888 - 5083860 - 4623798 (only if the OCS version is 10g. This is not needed for OCS version 9.0.4) Upgrade EBS data to fix the existing Files 9.0.4 data. If Oracle Files 9.0.4 was already used for the purpose of attachments in EBS 11i.10 and now the same Files instance has been upgraded to Oracle Content Services 10g, then the existing attachments present in EBS would break, hence to fix those attachments, the patch contains an upgrade script that needs to be run explicitly by the system administrator on the EBS instance middle-tier. Note: If there are no existing Files 9.0.4 data in EBS, then this upgrade script need not be run. To run this upgrade script: 1. Copy the input file from template $fnd/patch/115/etc/OCS10GUpgrade_Input.txt and edit it to provide the following mandatory information. --DomainName: Please provide the exact domain name (case sensitive) of the upgraded OCS instance. --ReposShortName: Please provide the short name of the repository which has been upgraded to Oracle Content Services 10g. This is stored in SHORT_NAME column of FND_DM_NODES table. --DbcFile : Please provide absolute path of the Dbc File for the EBS database. --LogFile : Please provide absolute path of the Output Log File.

2. Execute $fnd/patch/115/bin/OCS10GUpgrade.sh 3. Provide above location of the input file name with absolute path to the script OCS10gUpgrade.sh 4. Verify successful completion of the script from the generated log file.

2. Oracle Content Services (version 9.0.4 or 10g) For more information, please refer to: Oracle Collaboration Suite Installation Guide, Version 9.0.4 or 10g Oracle Collaboration Suite Administrator's Guide, Version 9.0.4 or 10g

3. Configuring with HTTPS / SSL (Optional) This step only required if you are running Oracle Content Services with HTTPS. Briefly described below is how HTTPS works in general: 1. Client (browser) connects to the server running with HTTPS. 2. Server responds with a certificate. 3. Client checks if the certificate is the trusted certificate and responds to the server. 4. Server looks at the client's response and determines the highest encryption that the client can support. 5. Once the handshake is complete the connection can be established with all the communication being encrypted using the highest encryption that is available. Note: WebDAV Client is the java implementation of the WebDAV Protocols that is used to connect to an instance of the WebDAV Enabled Repository. WebDAV protocol is an extension of HTTP protocols, which can be running in HTTPS or HTTP modes. When the remote server is running in the HTTPS mode, the WebDAV client needs to recognize the digital certificate used by the server before any communication can be established. WebDAV Client with HTTPS The WebDAV protocol will be used for upload of documents to Oracle Content Services as well as for selecting existing files from Oracle Content Services to attach to objects in Oracle E-Business Suite 11i. For the WebDAV client to register the server's certificate, it is necessary to put the certificate in the middle tier and provide its location when registering the repository. A copy of the certificate file can be placed anywhere in the middle tier where the JVM can pick it up. For example: $COMMON_TOP/admin/certs/apache Note: While specifying the file path of the certificate, the entire file path including the certificate file name should be specified. The JVM does not understand the use of variables. Obtaining a Copy of the Certificate If you do not have a copy of the certificate used by the Oracle Content Services server, you can get a copy of the certificate by one of the following options:

1. Copy from Oracle Content Services middle tier: If you have access to the Oracle Content Services middle tier, you can get a copy of the certificate from there. To determine the file path where the certificate is stored, please refer to the Oracle Content Services Administrators Guide.

2. Download from server: You can also download the certificate from the server, if you are connecting to the server for the first time. a) In your Internet Explorer browser, enter the URL for the login page for Oracle Content Services. You will be prompted with a Security Alert to accept the certificate. b) Click "View Certificate" button, to view the Certificate Details. c) Click on the Details tab. d) Click "Copy to File" button. This will initialize the "Certificate Export Wizard". e) Click Next to go to the Export File Format Page. f) Select "Base-64 encoded X.509 (.CER) option and click Next. g) Specify a File Name for the Certificate. The system will generate a .CER file. h) Click Next to export the Certificate. A confirmation window will give details of the file generated. i) Click Finish to complete the process. j) Retrieve the copy of the certificate from where it was exported. 3. Retrieve from the Internet Explorer list of Certificates: If you had already connected to the Oracle Content Services site before and accepted the certificate, you will not get the Security Alert in Option 2. In this case, to get a copy of the certificate you can do the following: a) In your Internet Explorer, select Internet Options under the Tools menu. b) Click on Contents tab. c) In the Certificates section, click on the Certificates button. d) Click on Intermediate Certification Authority sub-tab, to display a list of Certificates that you have accepted. e) Find the certificate for Oracle Content Services and select it. f) Click on the Export button. g) The "Certificate Export Wizard" will be initialized as in Step 2.d, above. h) Follow steps 2.e through 2.j as explained above. To summarize the steps for configuring a WebDAV client in Secure Socket Layer (SSL): 1. Configure the Oracle Content Services server side installation to run in HTTPS mode. Please refer to the Oracle Content Services Administration guide for more details. 2. Copy the certificate used in Oracle Content Services server to Oracle E-Business Suite Applications 11i middle tier, as explained above. 3. Register the repository in E-Business Suite by following the steps detailed below. 4. The WebDAV client picks up the certificate to use when connecting to the server. Definitions of Terms Attachment An attachment is any non-structured data item that is linked to more structured application data in order to illustrate or clarify the application data. For example, you can attach images to inventory items to show what each inventory item looks like. Other items that can be used as attachments include simple text files, word processing documents, spreadsheets, videos, and Web pages. Attachment Category Attachment categories allow attachments to be classified for organizational purposes. They can be used to improve search results and to enforce business processes. The definitions of attachment categories are based on the common characteristics that a class of attachments can have. For example, you can use the attachment category "mechanical specifications" for attachments that are related to mechanical specifications. Business Object A business object is an entity in Oracle E-Business Suite Applications 11i that has unique characteristics and processes. For example: Inventory Items, Projects, Change Requests and Purchase Orders. Repository A repository is a storage system that holds documents, files, and any other non-structured data.

Oracle Internet Directory (OID) OID is Oracle's Lightweight Directory Access Protocol (LDAP). LDAP is a set of protocols for accessing information directories. LDAP is based on the standards contained within the X.500 standard, but is significantly simpler. And unlike X.500, LDAP supports TCP/IP, which is necessary for any type of Internet access. Because it's a simpler version of X.500, LDAP is sometimes called X.500lite. Single Sign-On (SSO) A "single sign-on" framework is a mechanism that allows a number of different applications common to an enterprise to share a user authentication service. With Oracle's enterprise-wide Single Sign-On, a user is required to log on, or authenticate himself, only once. That verification of his identity is valid for the duration of the user session, and for every application participating in the Single Sign-On framework. The user session ends, across every application, when he logs out. E-Business Suite Setup Steps 1. Defining Content Management Repositories in EBS 1.1 Defining and Updating Repositories EBS needs to know the Content Management instance that will be used for the integration. Such Content Management instances are defined in EBS as "Repositories". The repository definition setup is common for the entire E-business suite. You cannot define a repository just for your product. Typically at the customer site, a system/applications administrator would define the repositories. While defining the repository, you will also need to choose the Integration Technology (WebDAV or WebService). To setup the repository, logon as system administrator and navigate to Attachment -> Repository Setup.

In EBS 11.5.10

Short Name Name

Description Product Type Any Text

Service URL WebDav Sequence Connection URL See below

Certificate Path

Any Text

Any Text

'Oracle Files Not needed V1/V2'

Any number See below

Product Type: Indicates what technology will be used to interact with the Content Repository. - 'Oracle Files V1/V2' means it is "WebDAV Protocol based integration". Service URL: This is not needed. WebDAV Connection URL: URL pointing to the DAV servlet of the Content Repository instance. For example:

http(s)://:/content/dav or http(s)://:/files Please refer to the Content Repository installation guide to get this URL. In EBS R12Short Name Name Description Integration Protocol Any text Any text WebDAV Service URL WebDav Sequence Connection URL Not needed See below See below Certificate Path

Any Text Any text

Any Text Any text

Any number See below Any number See below

WebService See below

Service URL: URL pointing to the WebService servlet of the Content Repository instance. For example: http(s)://:/content/ws Please refer to the Content Repository installation guide to get this URL.

WebDav Connection URL: URL pointing to the DAV servlet of the Content Repository instance. For example: http(s)://:/content/dav or http(s)://:/files

Please refer to the Content Repository installation guide to get this URL. Sequence: If you have more than one repository, this sequence will determine the order in which they will be displayed in the UI. Certificate Path: If Content Repository is SSL enabled, then this field should contain the location to the Content Repository digital certificate stored in the EBS mid-tier. The certificate should be accessible and readable. 1.2 Testing Repository Connection Use the following procedure to test the connection to the Content repository. 1) On the Repository list page, select a repository and click on "Test Connection" button. 2) Enter the User Name and Password for that repository and click Test. Ensure that the user name is lower case. 3) If the information for the repository has been entered correctly and repository is operational, then the test should succeed. Otherwise, an error may occur.

1.3 Removing Repositories Use the following procedure to remove a repository from the list of available repositories. 1) On the Repository list page, select the repository to be removed. 2) Click the "Remove" button to remove the selected repository. This will just delete the definition of that repository in EBS. The Repository instance installed will be intact. If you need to remove a Content repository , you need to first detach all the attachments associated to this repository. 2. Setting up Attachment Categories As an administrator, you need to create attachment categories and define their usage for each Oracle Application product. For more details please refer to the "Attachments" chapter in the Oracle Applications Developer's Guide.

Frequently Asked Questions (FAQ)1. Is OID (Oracle Internet Directory) mandatory to integrate EBS with OCS ? - OCS uses OID as its identity management system, hence OID is mandatory. 2. If Active Directory is used as the password repository, will EBS-OCS integration still work ? - Yes. The integation will still work as long as the Active Directory to OID integration has been setup correctly. Please refer to the OID administration guide to understand how third party Identity Management systems (like Active Directory) can be integrated with it.

Note: It seems like Active Directory sometimes allows strange password behavior where users can log in with old passwords for a period of time. We have seen this occur using ldapbinds directly to Active Directory, so essentially this is an issue with Active Directory configuration (and not with OID or OCS). If this happens, please contact your Active Directory administrator. Also in OCS, try setting the parameter IFS.SERVICE.CREDENTIALMANAGER.Oid.SupportsSetPassword to FALSE. Please refer to the following related bugs: - 4958310 : If there is no Digest password, the error generated says INCORRECT ERROR MESSAGE: "FTPPASSWORDNOTSET" - 4453749 : CHANGING PSWD IN AD DOESN'T RESET DAV PSWD WHEN USER LOGS IN THROUGH WEBUI

3. OCS instance is secure (SSL enabled). Is there anything specific that needs to be done to enable EBS-OCS integration ? - Get the certificate for the OCS instance and save it to any accessible directory in the EBS middle tier. In the repository setup page in EBS, ensure that the full path to the above certificate is provided in the "certificate path" field. - Ensure that the HttpClient jar present in patch#3322788 is downloaded and saved to the EBS middle tier under $IAS_TOP/lib directory. Bounce the EBS middle-tier. 4. Can EBS be integrated with non-Oracle based Content Management repositories (like Documentum) ? - EBS has been certified with ONLY Oracle Content Management products (like Oracle Files, Oracle Content Services, Oracle ContentDB). Ideally, EBS should work with any WebDAV enabled repository, but it is upto the customer to test this integration.