EBS and WCC Content 13-Jun-25
EBS and WCC Content 13-Jun-25
Attachments Solution
This chapter describes how to configure the Managed Attachments solution for Oracle E-
Business Suite, Oracle PeopleSoft, or another business application. It describes how to run
configuration scripts, configure Content Server components, customize the solution, integrate
Oracle AutoVue and Oracle Distributed Document Capture, and configure authentication and
security.
Note:
For background information on the Managed Attachments solution, see Section 1.4.
http://www.oracle.com/technetwork/middleware/webcenter/content/
documentation/documentation-155348.html
Note:
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
The Managed Attachments solution is supported on WebSphere Application Server
when Content Server is running on WebSphere Application Server and Application
Extension Framework (Imaging Server) is running on Oracle WebLogic Server.
The Managed Attachments solution supports the following Content Server search
engines.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Table 7-1 SQL Scripts for Configuring Managed Attachments
1. On the Fusion Middleware Home, locate the script in the folders specified
below for your business application.
For Oracle E-Business Suite Forms:
MW_HOME/ECM_HOME/axf/adapters/ebs/R11/
MW_HOME/ECM_HOME/axf/adapters/ebs/R12/
MW_HOME/ECM_HOME/axf/adapters/ebs/oaf/
MW_HOME/ECM_HOME/axf/adapters/psft/
MW_HOME/ECM_HOME/axf/adapters/framework/
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
2. Modify parameters in the AXF_ATTACHMENTS_CONFIG.sql script to match
your environment.
Note:
If you are using the AXF for BPM infrastructure, open the
AXF_ATTACHMENTS_CONFIG.sql file in any editor.
Replace .imaging. with .ecm. and save the file.
3. On the Oracle WebCenter Content middle tier, log in to the AXF Configuration
Database as the user who owns the Imaging schema and run the
AXF_ATTACHMENTS_CONFIG.sql script.
@AXF_ATTACHMENTS_CONFIG.sql
Note:
For information about creating schemas before or after Oracle WebCenter
Content installation, see "Creating Oracle WebCenter Content Schemas with
the Repository Creation Utility" in Oracle WebCenter Content Installation
Guide.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
If configuring the adapter for Oracle E-Business Suite Forms, follow these steps to
run AXF_EBS_ATTACHMENTS_CONFIG.sql, an Oracle E-Business Suite plug-in script
that configures the Zoom menu to enable the Managed Attachments solution within
the Oracle E-Business Suite system.
1. Locate the script corresponding to your release in the folder specified below.
MW_HOME/ECM_HOME/axf/adapters/ebs/R11/
MW_HOME/ECM_HOME/axf/adapters/ebs/R12/
@AXF_EBS_ATTACHMENTS_CONFIG.sql
See Section C.2.3. The script inserts multiple rows, allowing you to keep the
rows that apply to your particular configuration.
7.2.3.1 Populating the OAF AXF Database Tables With Sample Key Values
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
o View Attribute (businessObjectValue1 or labelValue1); for
example, RequisitionHeaderId
iProcurement Purchase Choose iProcurement, then the Requisitions tab, then click Order N
Orders
Purchase Orders Choose Purchasing, then Buyer Work Center, then Orders, then click
Suppliers Choose Purchasing, then Supply Base, then Suppliers. Search by clic
the Update icon
Request for Quote (RFQ) Choose Purchasing, then Buyer Work Center, then Negotiations, the
Header
Request for Quote (RFQ) Choose Purchasing, then Buyer Work Center, then Negotiations, the
Line the GO button.
Projects Choose Project Manager, then Projects: Delivery, then Project List. C
the Attachments tab
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
OAF Page Navigation
MW_HOME/ECM_HOME/axf/adapters/ebs/oaf/
2. Log in to the Oracle E-Business Suite database as the Oracle E-Business Suite
plug-in schema user (AXF).
3. In the script, replace the host name and port to match your Imaging server
host name and port.
4. Run the OAF_AXF_EBS_ATTACHMENTS_CONFIG.sql script.
@OAF_AXF_EBS_ATTACHMENTS_CONFIG.sql
This section provides steps for identifying the primary field(s) to link the OAF page
with Managed Attachments functionality, and identifying the page name and fields to
use as labels.
How you identify the needed information depends on the OAF page's contents, as
described in the following scenarios:
Ideally, the needed Oracle E-Business Suite attachment and primary key details are
present in the OAF page's XML file. In this case, follow these steps to locate required
mapping information.
1. Navigate to the OAF page and click the About this page link at the bottom.
For example, navigate to Employee Self Service, then the Appraisals OAF
page, and click the About this page link.
2. Note the full path of the page's XML file. For example:
3. /oracle/apps/per/selfservice/appraisals/webui/EmpMyAppraisalsPG
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
4. Search the XML file for an <oa:attachment> XML tag that contains view
object name and primary key details for the business entity associated with
the view.
<oa:entityMappings>
<oa:primaryKeys>
</oa:primaryKeys>
<oa:categoryMappings>
</oa:categoryMappings>
</oa:entityMap>
</oa:entityMappings>
</oa:attachmentImage>
5. Note the identifying values. You use them in Section 7.2.3 to map OAF page
details with Managed Attachments.
Entity = APPRAISEE_JOURNAL
Primary Key = APPRAISAL_ID and APPRAISEE_PERSON_ID
View Object = EmpMyAppraisalsInProgressVO
View Attribute = AppraisalId and AppraiseePersonId
In this case, the OAF page's XML file contains attachment object information (view
object and entity), but not the corresponding primary key. Follow these steps to
determine the view object and entity name from the XML file, then query the
FND_DOCUMENT_ENTITIES table to determine the primary key.
1. Navigate to the OAF page and click the About this page link at the bottom.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
For example, navigate to iProcurement, then Requisitions, then the
Requisition Details OAF page, and click the About this page link.
2. Note the full path of the page's XML file. For example:
3. /oracle/apps/icx/por/reqmgmt/webui/ReqDetailsPG
4. From the APPS schema, run the following query against the
FND_DOCUMENT_ENTITIES table, replacing EntityName with the entity
identified in the XML file.
For example, the following xml file's <oa:attachment> section provides these
key values, highlighted in bold characters:
<oa:entityMappings>
<oa:categoryMappings>
</oa:categoryMappings>
</oa:entityMap>
</oa:entityMappings>
</oa:attachmentLink>
Entity = REQ_HEADERS
View Object = ReqHeaderVO
5. Based on the primary key column, determine its corresponding view attribute.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
The query returns the primary key column name:
REQ_HEADER_ID.
b. Click the About this page link, select View Object and find the
corresponding attribute name, which matches the column name:
RequisitionHeaderId.
Primary Key = REQUISITION_HEADER_ID
View Attribute = RequisitionHeaderId
6. Note the identifying values. You use them in Section 7.2.3 to map OAF page
details with Managed Attachments.
Entity = REQ_HEADERS
Primary Key = REQUISITION_HEADER_ID
View Object = ReqHeadersVO
View Attribute = RequisitionHeaderId
In this case, the XML file associated with the page does not contain any attachment
information. Follow these steps to determine the needed information.
1. Navigate to the OAF page and click the About this page link at the bottom.
For example, navigate to Purchasing, then Buyer Work Center, then Orders,
then click the Order Number. Click the About this page link.
Note the full path of the page's XML file. For example:
/oracle/apps/po/document/order/webui/OrderPG
The page's XML file does not contain any Oracle E-Business Suite attachment
information.
In the View Object column, locate the view object listed the maximum
number of times. The view object used in the top-level region is the driving
view object for the page. In the example shown in Figure 7-1, the view object
is: PoHeaderMergeVO.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-1 Determining the View Object"
Click the view object link to display details for the view object. For example,
the entity (driving table) for the PoHeaderMergerVO view object
is PO_HEADERS_MERGE_V.
http://etrm.oracle.com/pls/etrm/etrm_search.search
b. Enter a search that includes the entity name to obtain the table
details. For example, for the PO_HEADERS_MERGE_V entity, enter:
http://etrm.oracle.com/pls/etrm/etrm_pnav.show_object?
c_name=PO_HEADERS_MERGE_V&c_owner=APPS&c_type=VIEW
c. From the search results, display the view or table details. The
example shown in Figure 7-2 provides view details.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-2 Displaying View Details"
d. Select the table that best describes the selected view (in this
example, PO_HEADERS_ALL).
e. Figure 7-3 shows the primary key details associated with the
table. Determine its primary key (in this
example, PO_HEADER_ID).
f. Figure 7-3 Displaying Table Details
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
6. Based on the primary key, obtain its corresponding view attribute.
Return to the OAF page, clicking the About this page link and clicking
the Expand All link. Select the view object that displays most often
(PoHeaderMergeVO, for example). From the Attributes list that displays,
determine the attribute name, which typically varies only slightly from the
primary key name (for example, PO_HEADER_ID versus PoHeaderId).
7. Note the identifying values. You use them in Section 7.2.3 to map OAF page
details with Managed Attachments.
Entity = PO_HEADERS_MERGE_V
Primary Key = PO_HEADER_ID
View Object = PoHeaderMergeVO
View Attribute = PoHeaderId
Configuring each Oracle PeopleSoft entity's primary key values in the Oracle
PeopleSoft AXF database tables, described in Section C.4. The
AXF_PSFT_ATTACHMENTS_CONFIG.sql script is provided as a starting point. It
contains sample values for PeopleSoft entities such as work order, sales
contract, and purchase requisition. You can modify the sample key values to
reflect your Oracle PeopleSoft pages, using the primary keys you noted
in Section 3.3.
Specifying an Oracle PeopleSoft role to grant users permission.
Follow the steps in this section to enable Managed Attachments for Oracle
PeopleSoft.
MW_HOME/ECM_HOME/axf/adapters/psft/
@AXF_PSFT_ATTACHMENTS_CONFIG.sql
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
7.3 Configuring the Content Server
Components
Follow the sections listed below to configure Content Server components for the
Managed Attachments solution for Oracle E-Business Suite or Oracle PeopleSoft, and
test the completed solution.
Note:
To configure the Managed Attachments solution for another business application, see
the instructions provided in Section 7.4.
Follow these steps to enable the Content Server components using Component
Manager.
4. Choose Integration.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AppAdapterEBS.zip for Oracle E-Business Suite
AppAdapterPSFT.zip for Oracle PeopleSoft
AppAdapterUniversal.zip for other business applications, as
described in Section 7.4.
7. Click Update.
8. Restart Content Server.
9. Check the Content Server and database logs to ensure that no application
adapter install errors occurred.
Installing the new adapter overwrites existing rules and profiles. If your
previous installation includes customizations to Content Server rules and
profiles, back up these rules and profiles using a CMU bundle before installing
Content Server components. After installation, create new rules and profiles,
and manually apply any customizations.
Some resource includes and templates have changed in this release. Manually
set these customizations after installation.
The following components must be at or above the version level included with
the installed Content Server 11g release:
YahooUserInterfaceLibrary
CheckoutAndOpenInNative
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
CoreWebdav
NativeOsUtils
ContentFolios
5. In the User Admin applet, ensure that the roles below have the correct access
level to the corresponding security groups.
In Content Server, choose the Administration option from the main menu,
choose Admin Applets, then User Admin. Select Security,
then Permissions by Role.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
From Component Manager, install the component, enable it, and restart the Content
Server. For more information, see Section 7.3.1 or "Creating Components Using the
Component Wizard" in Oracle Fusion Middleware Administering Oracle WebCenter
Content.
If you opt to rename files, follow these steps to unzip the component, rename certain
files for your business application, and zip the files into a newly named file. You will
need an uppercase business application name (for example, BIZAPP), a lowercase
name (for example, bizapp), and a long name (for example, ExampleBusinessApp).
ECM_HOME/ucm/Distribution/AppAdapter
Note that this string is used in the ResultTemplate name used in the Managed
Attachments URL (for example, ResultTemplate=BIZAPP_LIST). For details
about the result template, see Section 7.6.13.
To change the look-and-feel of the result template file, customize the result
template file (originally named Universal_LIST,
universal_adapter_list_results_template.htm). See Section 7.6.13.
To customize images, replace the images in the resources\publish\images
folder.
To customize the Content Server profile used, change the UniversalProfile file.
See Section 7.6.5.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
1. Configure the business application to provide an application entity context
link, button, or menu item to call AXF via the SOAP service and to pass the
Managed Attachments attributes listed in Table 7-4.
Example 7-1 provides a sample SOAP XML file for calling AXF
and Table 7-5 describes fields in the AXFRequest.
Example 7-2 provides a sample AXFResponse and Table 7-
6 describes fields in the AXFResponse.
2. http://Imaging Hostname:Imaging
Port/axf-ws/AxfSolutionMediatorService?wsdl
7. <soapenv:Header>
8. <Security
xmlns="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-secext-1.0.xsd">
9. <UsernameToken>
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
10. <Username>weblogic</Username>
11. <Password>welcome1</Password>
12. </UsernameToken>
13. </Security>
14. </soapenv:Header>
15. <soapenv:Body>
16. <ser:execute>
17. <request>
18.
<solutionNamespace>UCM_Managed_Attachments</solutionNamespace>
19.
<commandNamespace>UCM_Managed_Attachments</commandNamespace>
20. <conversationId></conversationId>
24. <username>jcooper</username>
25. <requestParameters>
26. <entry>
27. <key>application</key>
28. <value>BIZAPP_instanceA</value>
29. </entry>
30. <entry>
31. <key>businessObjectType</key>
32. <value>REQ_HEADERS</value>
33. </entry>
34. <entry>
35. <key>businessObjectKey1</key>
36. <value>BUSINESS_UNIT</value>
37. </entry>
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
38. <entry>
39. <key>businessObjectValue1</key>
40. <value>US001</value>
41. </entry>
42. <entry>
43. <key>businessObjectKey2</key>
44.
<value>REQUISITION_HEADER_ID</value>
45. </entry>
46. <entry>
47. <key>businessObjectValue2</key>
48. <value>1234</value>
49. </entry>
50. <entry>
51. <key>extraxReqNum</key>
52. <value>1234</value>
53. </entry>
54. </requestParameters>
55. </request>
56. </ser:execute>
57. </soapenv:Body>
58. </soapenv:Envelope>
AXFRequest
Description
Attributes
solutionNamespace SolutionNamespace in which to execute the command.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AXFRequest
Description
Attributes
role Reserved for future use.
60.
61. Example 7-2 AXFResponse
62. <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
63. <S:Body>
64. <ns2:executeResponse
xmlns:ns2="http://service.axf.imaging.oracle/">
65. <response>
66. <conversationId>b80ce79b-6b46-4302-ab59-
ddb91e30692b</conversationId>
67. <responseCommands>
68. <command>OPEN_BROWSER</command>
69.
<value>http://imaging.example.com:16200/cs/idcplg/-UniversalProfile?
IdcService=GET_SEARCH_RESULTS_FORCELOGIN&ResultTemplate=Universal_LIS
T&afGuid=00000132-b540-810e-63f4-00e94577f990</value>
70. </responseCommands>
71. </response>
72. </ns2:executeResponse>
73. </S:Body>
74. </S:Envelope>
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AXFResponse
Description
Attributes
conversationId Current conversation created by AXF to help maintain state/context
2. Enable SSL on Oracle WebLogic Server on the Oracle WebCenter Content side.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Keep this order of precedence in mind when configuring attachment settings. For
example, configuring a role that enables scanning results in scanning disabled for all
other roles.
Note:
This section describes how to edit Managed Attachments settings in the
administration interface. As an alternative, you can customize settings by directly
editing the preferences.hda file configuration file where the settings are stored, as
described in Section 7.5.2.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-4 Configure Managed Attachments Page"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
2. Edit Global Configuration variables if needed, and click Update.
Use these settings to configure Content Server environment variables for the
adapter, as described in Section 7.5.1 and Section 7.6.
Use this area to override global settings for a specified business entity or
application, as described in Section 7.6.3. For example, override a global
setting that displays the From Repository button and hide the button for a
specified business entity.
Default
Field Description
Value
AppAdapterCheckinPrivate true If set to true, the Share Document field on the Conten
private check-in, although users can select the field for
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Default
Field Description
Value
AppAdapterExtraCheckinMet null Specify a comma-separated list of parameters to option
adata comma before the next value). For more information, s
Default
Field Description
Value
AppAdapterExtraScanMet null Specify a comma-separated list of parameters to optional
adata comma before the next value). For more information, see
Format:
ODDCURLPath
http://ODDC_host/ODDC_webcapture_address
Example:
ODDCURLPath
http://xyz/webcapture.asp
1 = Scan
2 = Import
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Field Default Value Description
AppAdapterHelpIconVisible true Specifies if the Help icon displays on the
Format:
AutoVueURLPath
http://ucm_host name:port/web_
Example:
AutoVueURLPath
http://ucm1.example.com/cs/idc
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Field Default Value Description
ResultCount, previous and next pa
You can edit settings using the Managed Attachments Administration interface, as
described in Section 7.5. Alternatively, you can follow the steps in this section to
directly modify the preferences.hda file.
Notes:
You must restart the Content Server after modifying the preferences.hda file.
You can add or delete application and business entity configuration entries as
needed, but do NOT delete global configuration entries from the preferences.hda file.
UCM_Instance/data/appadapter
Section Description
AFEnvironmentConfiguration Use to configure Content Server environment v
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
2. Scroll to the AFEnvironmentConfiguration ResultSet section, and edit the
entries described in Section 7.5.1 as needed. For more information about
customizing the Managed Attachments solution using these variables,
see Section 7.6.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
2. Scroll to the Role Specific Configuration settings in the lower portion of the
page and click Add.
3. In the Add Role Specific Configuration page shown in Figure 7-5, enter fields
to customize a Managed Attachments variable based on user role and
click Update. This example specifies the following settings:
Configuration Name: AppAdapterGrantPrivilege
Value: R
Role: readRole
The example shown in Figure 7-6 configures the Scan button to display when
the businessObjectContext passed from the business application equals
ScanContext. This example specifies the following settings:
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Configuration Name: AppAdapterScanBtnVisible
Value: true
Role: ScanContext
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
display for the ExpenseClaims business entity only, regardless of
the global setting.
To override at the application level, leave the Object Name field
blank. Doing so in the example below would display the From
Repository button for all business entities of the EBS_Instance
application, regardless of the global setting.
Field Description
Application Name Identifies the business application
7. Note:
8. You must complete either the Application Name or Object Type field. Entering
an object type without an application name applies the setting to the business
entity of all applications with that object type.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
For more information about document types, see the Content Server
documentation.
Example 7-3 sets the document type ExpenseClaimsType as the default type
when users attach documents to the ExpenseClaims business entity (within
the PSFT_Instance application).
afDocType
ExpenseClaimsType
PSFT_Instance
ExpenseClaims
Note:
If you use custom profiles, generic error messages display by default instead of
application-specific error messages. To display custom error messages, override the
resource include - af_custom_error_msg_display. In the overridden resource include,
set the error message to afErrorMsg.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
1. From the Content Server Configuration Manager, copy the default profile
provided (EBSProfile, PSFTProfile, or UniversalProfile). To view these profiles,
navigate to the Profiles tab in Configuration Manager.
2. Add new rules as needed. For example, add new metadata fields.
3. In the UCM_CONNECTION_STR parameter (trigger value) of the
AXF_SOLUTION_PARAMETERS table, modify the URL to point to the new
profile.
Follow these steps to modify the profile for a specific business entity or application.
1. From the Content Server Configuration Manager, copy the default profile
provided (EBSProfile, PSFTProfile, or UniversalProfile). To view these profiles,
navigate to the Profiles tab in Configuration Manager.
2. Add new rules as needed. For example, add new metadata fields.
3. In the preferences.hda file, add a new row in the AFEnvironmentConfiguration
resultset. For general information, see Section 7.5.2.
4. Insert an entry that identifies the Content Server profile to use for a specified
business entity, where:
name: dpTriggerValue
value: Key of new Content Server profile
dAFApplication: Application to which to assign this profile
dAFBusinessObjectType: Business entity within application to
which to assign the profile
dpTriggerValue
OrderPayableProfile
EBS_Instance
OrderPayables
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Table 7-12 Variables For Displaying or Hiding Managed Attachments
Buttons
Follow these steps to hide or display a button globally, or for a specific business
entity or application.
You can enable or disable scanning at the global, application, or business entity
level. For example, you might disable scanning globally, then add an entity specific
configuration to enable scanning for an OrderPayables business entity only, using
the following Entity Specific Configuration settings:
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Object Type: OrderPayables
Configuration Name: AppAdapterScanBtnVisible
Configuration Value: true
The adapter provides these default business application scan profiles. Each points to
an application-specific field:
You can customize the scan profile used, by copying the profile appropriate for your
business application, modifying it to reference another application field, and
configuring it for one or more business entities, as described in the following steps.
1. Copy the scan profile that applies to your business application, saving it with a
new name.
2. Create all required schema elements, including the AppScanProfiles
application field, table, and view.
Example 7-5 shows a scan profile called MyPIMScanProfile enabled for the PIM
business entity only.
afScanProfile
MyPIMScanProfile
PSFT_Instance
PIM
The adapter provides the default business application document classifications for
scanning listed in Table 7-13. Each classification includes a set of Content Server
application fields, a table, and a view.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Business Application Content Server Fields
Oracle E-Business Suite EBSAppScanProfiles
Note:
Customizing images for Managed Attachments requires advanced knowledge of
Content Server configuration and customization. Be sure to back up the appropriate
files before making modifications.
Note:
Customizing style sheets for Managed Attachments requires advanced knowledge of
Content Server configuration and customization. Be sure to back up the appropriate
files before making modifications.
For example, suppose you have one document attached to two work order entities
(WO1 and WO2), and want to allow users to print the document from WO1, but not
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
from WO2. In this case, you would create a print attribute as an application field on
Content Server, and then specify a print relationship attribute for the WO1 business
entity in Managed Attachments Administration (or in the preferences.hda file). The
print attribute would be displayed on the Update page to end-users for the WO1
entity only, allowing them to print the attached document.
You can configure attachment relationship attribute for new document check-
in, but not for documents attached through scanning.
Adding a relationship attribute creates a new Application field in Content
Server for the relationship attribute if one does not exist. You can update the
Application field using Content Server Admin Applets - Configuration Manager.
Adding a relationship attribute also adds an entry in the
AFRelationshipAttributes section of the preferences.hda file described
in Section 7.5.2.
At run-time, attachment relationship attribute values are stored in the
AFRelationshipAttributes table; see Section C.5.3.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
7. Complete fields for the attribute and click Update. The example in Figure 7-
8 shows a relationship attribute (Print) configured for an WO1 business object
for an Oracle PeopleSoft application.
Element Description
Application Name Business application for which the relationship attribute is co
Object Type Business object for which to enable the relationship attribute
Attribute Type Attribute's type. Available types include: Text, Long Text, Da
8.
Follow these steps to configure a business entity to display the attached revision
instead of the most recent revision.
Description of "Figure 7-9 Configuring Revision Specific Mode in the Add Entity Specific Configuration
Page"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
3. Complete fields for revision specific mode, choosing
AFRevisionSpecificEntities for the Configuration Name field, and
click Update. The example in Figure 7-9 shows revision specific mode
configured for a CallRecords business object for an Oracle E-Business Suite
application.
Element Description
Application Name Business application for which the relationship attrib
Each row in the resultset represents one business entity for which to enable
revision specific attachments, where:.
@ResultSet AFRevisionSpecificEntities
dAFApplication
dAFBusinessObjectType
EBS_Instance
CallRecords
@end
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
The Managed Attachments page displays a specific number of attachment results
per page (referred to as ResultCount). If the number of results exceeds ResultCount,
previous and next page controls display on the page. You can change it to another
number (such as 20) by specifying a new ResultCount value in Managed
Attachments configuration. See Section 7.5.1.
Note:
Customizing the result template requires advanced knowledge of Content Server
administration and customization.
1. Create a copy of the appropriate default result template and register the
template with a new name, preferably in a new component.
The Oracle E-Business Suite template is located at:
UCM_HOME/custom/AppAdapterEBS/
adapter_list_results_template.htm
UCM_HOME/custom/AppAdapterPSFT/
ps_adapter_list_results_template.htm
UCM_HOME/custom/AppAdapterUniversal/
universal_adapter_list_results_template.htm
4. Template Reference
5. Application Name
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
6. Business Entity
ResultTemplate
EBS_WORK_ORDER_LIST
EBS_Instance
WorkOrder
The column defaults are title, type, author, date, and revision as follows:
dDocTitle,dDocType,dDocAuthor,dInDate,dRevision
To set alternate default columns for an application or business entity, follow these
steps.
In Example 7-8, the first entry sets document title, type, author, and date as
the default columns for the EBS_Instance application. The second entry
overrides this setting for the CallRecords business entity by adding the
revision column (dRevision) as a default column.
AppAdapterDefaultDisplayColumns
dDocTitle,dDocType,dDocAuthor,dInDate
EBS_Instance
AppAdapterDefaultDisplayColumns
dDocTitle,dDocType,dDocAuthor,dInDate,dRevision
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
EBS_Instance
CallRecords
Note:
This section applies to Oracle E-Business Suite Forms use only.
PROPNAME PROPVALUE
AXF_PAPERCLIP Set to TRUE to enable the paperclip option, or FALSE (default) to d
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
1. From Content Server, choose Managed Attachments from the
Administration menu.
2. Under Global Configuration, enter one or more field names to pass, using a
comma to separate multiple names.
Enter field names in
the AppAdapterExtraCheckinMetadata field to pass their
values directly to the Content Check In page.
Enter field names in the AppAdapterExtraScanMetadata field
to pass their values directly to the Scan Document page.
3. Access the command parameters table for your business application.
For an Oracle E-Business Suite Forms configuration, access
the AXF_COMMAND_PARAMETERS Table (Oracle E-Business Suite
Forms).
For an Oracle E-Business Suite OAF configuration, access
the OAF_AXF_CMD_PARAMS Table (Oracle E-Business Suite OAF).
For a PeopleSoft configuration, access the PS_AXF_CMD_PARAMS
Table.
For an Enterprise Application Adapter Framework configuration,
see Section 7.6.16.1.
4. Add entries in the table for the extra values to be passed to Content Server,
similar to adding labelValue rows. See the example command shown
in Example 7-9 and the example table shown in Table 7-15.
Add a row for each metadata value, prepending the Content Server field name
with extra. For
example, xReqNum becomes extraxReqNum and dDocTitle becomes extradDocT
itle.
Note:
Typically, Content Server extra information fields have an x character in front
of them and standard ones have a d character in front of them. For more
information, refer to the section on standard metadata fields in the Oracle
Fusion Middleware Managing Oracle WebCenter Content.
2 1 businessObjectType CONSTANT
3 1 businessObjectKey1 CONSTANT
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AXF_CMD_PARAMS_ID AXF_CMDS_ID AXF_PARAM_NAME AXF_DATAS
4 1 businessObjectValue1 DATA
5 1 labelValue1 DATA
6 1 labelValue2 DATA
7 1 extraxReqNum DATA
For the Enterprise Application Adapter Framework, pass the extra metadata values
as part of the request parameters section of the SOAP envelope body, prepending
the Content Server field name
with extra (xReqNum becomes extraxReqNum and dDocTitle becomes extradDocTitle
). For example:
<entry><key>extraxReqNum</key><value>123456</value></entry>
The default popup window size is 600 pixels high by 800 wide, set in
the PS_AXF_PROPERTIES Table. When a size is set in this table, users cannot
set and save popup window size themselves.
To change window size, enter new values in the table, as shown in Section
C.4.4.
To remove the popup window size and allow individual users to change and
save popup window size using standard browser controls, remove the
WINDOW_HEIGHT and WINDOW_WIDTH rows from the PS_AXF_PROPERTIES
Table.
On a per entity level, you can optionally override the security group for private
attachments, and assign documents to an alternate security group, by following
these steps.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
2. On the Configure Managed Attachments page, scroll to the Entity Specific
Configuration settings in the lower portion of the page, and click Add.
Description of "Figure 7-10 Configuring Entity Level Private Attachments Security Group"
3. In the Add Entity Specific Configuration page shown in Figure 7-10, complete
the fields, identifying the AppAdapterPrivateSecGroup variable and the
alternate security group to use for a specified business entity, where:
Application Name: Application for which to assign alternate
security group
Object Type: Business entity for which to assign alternate security
group
Configuration Name: AppAdapterPrivateSecGroup
Configuration Value: Alternate security group
The example values shown in Figure 7-10 set ClaimsSecurity as the security
group when users attach private documents to the ExpenseClaims business
entity (within the PSFT_Instance application).
4. Assign the following roles to the specified security group (must be the same
as those assigned to the AFDocuments security group): AFRead, AFWrite,
AFDelete, and AFAdmin.
5. In the config.cfg file, add the alternate security group to
the SpecialAuthGroups configuration variable.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
As described in Section 6.4.2, the BPEL Imaging solution allows you to configure the
authenticated Oracle WebLogic Server user to perform tasks, rather than the user
passed from Oracle E-Business Suite or Oracle PeopleSoft. This option is provided
through a USERNAME_PASS_THROUGH parameter in the AXF_SOLUTION_ATTRIBUTES
Table, where:
TRUE (default): Uses the passed-in user from Oracle E-Business Suite or
Oracle PeopleSoft to perform tasks.
FALSE: Uses the authenticated Oracle WebLogic Server user to perform tasks.
Note:
If no value is provided, the value defaults to FALSE.
The Managed Attachments solution requires that the passed-in user from Oracle E-
Business Suite or Oracle PeopleSoft perform tasks. The
AXF_ATTACHMENTS_CONFIG.SQL script that you ran in Section 7.2.1 for Managed
Attachments sets the USERNAME_PASS_THROUGH value to TRUE. If needed at any
point, restore the parameter's value to TRUE, as shown in Table 7-16 and Section
C.1.2.
SOLUTION_NAMESPACE PARAMETER_KEY
AXF USERNAME_PASS_THROUG
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Section 7.7.4, "Securing Communications Between AXF and Content Server"
Section 7.7.5, "Managing Business Application and Content Server Users"
You can create a credential through Enterprise Manger (EM) or through WebLogic
Scripting Tool (WLST).
The user name and password are passed by the business application to AXF,
and were previously configured for the Web Services call from Oracle E-
Business Suite (see Section 2.4.1), Oracle PeopleSoft (see Section 3.2.2.1),
and a custom plug-in calling the Enterprise Application Adapter Framework
(see Section 7.4.2).
1. Execute the following command, where username and password refer to a valid
Oracle WebLogic Server administrator passed by the business application to
AXF, and were previously configured for the Web Services call from Oracle E-
Business Suite (see Section 2.4.1), Oracle PeopleSoft (see Section 3.2.2.1),
and a custom plug-in calling the Enterprise Application Adapter Framework
(see Section 7.4.2).
createCred(map="oracle.wsm.security", key="MA_CSF_KEY",
user=[username], password=[password])
Example:
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
createCred(map="oracle.wsm.security", key="MA_CSF_KEY",
user="weblogic", password="Welcome1")
2. Execute the following command to verify that the credential was created
properly:
listCred(map="oracle.wsm.security",key="MA_CSF_KEY")
Note:
No user authentication is needed for AXF if security checks are properly
configured, as described in Section 7.7.
private (not shared): Users can access these documents only through their
associated business application entity screens through 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 Content Server user interface. This is the default security mode
when checking in a new document through the Managed Attachments user
interface.
Note:
The AppAdapterCheckinPrivate global configuration variable determines if
the Share Document field on the Content Check-In page is deselected by
default (set for private check-in). For more information, see Section 7.5.1.
Note:
Private (not shared) documents are automatically assigned to a special
security group called AFDocuments, and users who have access to the
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
business application entity are granted temporary access to the documents
when they invoke the Managed Attachments user interface.
The AppAdapterPrivateSecGroup variable enables you to override on a per
entity level the security group to use for private attachments, and assign
them to an alternate group. For more information, see Section 7.6.18.
shared: These documents are more easily accessed than private documents,
because their security is managed by Content Server. In addition to access
through their associated business application entity screens through the
Managed Attachments user interface, any Content Server user with a
document's assigned security group access can search for and access the
document using any standard Content Server user interface.
Note:
Users can view shared documents only in AutoVue (if configured). They
cannot view private documents. For details, see Section 7.8.
1. Open the System Properties utility for the Content Server instance.
2. Select the Server tab.
3. Identify the AXF host by either entering a name in the Hostname Filter field
or an address in the IP Address Filter field.
4. Click OK and restart Content Server.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Keep the following guidelines in mind when managing Oracle E-Business Suite,
Oracle PeopleSoft, or other business application users for Managed Attachments
access (for example, when managing users in a central repository using single sign-
on):
The adapter dynamically assigns roles to the user: Roles are granted to the
user based on dPrivilege's value when the AF_GRANT_ACCESS service is
invoked (see Section C.5.1); or, if not specified, based on the configuration
variable AppAdapterGrantPrivilege's value (see Section 7.5). Depending on
the privilege (R, W, D, or A), a predefined role is dynamically assigned to the
user.
Caution:
Do not delete the AFRead, AFWrite, AFDelete, AFAdmin roles from the system.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AutoVue icon and identifying the URL to the AutoVue servlet to launch when
the user clicks the View in AutoVue icon.
As with other preferences settings, you can enable the AutoVue integration at
the global, application, and business entity levels.
AutoVue trusts the user authentication against Content Server. Once
authenticated to Content Server, no further authentication to AutoVue is
required for users to view attached documents using AutoVue.
Viewing or annotating a document in AutoVue does not check it out or prevent
it from being edited by others. Annotations are contained in a separate layer
from their corresponding document.
http://www.oracle.com/technetwork/middleware/webcenter/content/
documentation/documentation-155348.html
Note:
The requirements listed in this section apply only if providing optional document
viewing with the adapter through Oracle AutoVue.
Note:
The AutoVue option for Managed Attachments is not supported on WebSphere
Application Server.
Requirements include:
Follow the procedures outlined in the Oracle VueLink 20 for Oracle UCM
System Administrator Manual.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
3. On the Configure Managed Attachments page, enable display globally of the
AutoVue icon by setting the AppAdapterAutoVueIconVisible variable to
True. For general information, see Section 7.5.
4. In the AutoVueURLPath field, specify the AutoVue servlet to run, using the
following format:
5. http://ucm_host name:port/web_root/idcplg?IdcService=VIEW_IN_AUTOVUE
For example:
http://ucm1.example.com/cs/idcplg?IdcService=VIEW_IN_AUTOVUE
Example 7-9 contains several AutoVue settings. It assumes that the View in
AutoVue icon is set to false globally. The first two entries enable and display
the icon for the PSFT_Instance_A application. The last two entries enable and
display the icon for the PSFT_Instance_B application, but only within its PIM
business entity.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
For installation requirements specific to Oracle Distributed Document Capture use
with this adapter, see Section 7.9.2.
A Scan button is added to the Managed Attachments page. The user clicks
the button, and selects options such as a document classification, which is
assigned to an Oracle Distributed Document Capture scan profile. For
example, the user might select a classification of Identity Documents to scan
a photocopy of a driver's license or passport. (An Oracle Distributed
Document Capture scan profile specifies scanning, importing, and indexing
settings.) The user also specifies whether the document should be shared,
and if so the user specifies a security group for the shared document from
those to which the user has access.
When the user clicks the Scan Document button, Oracle Distributed
Document Capture's remote client launches in a new window, automatically
authenticates and logs in the user (if configured), and passes in parameters
such as the scan profile to use and business application entity values for later
attachment.
Within the Oracle Distributed Document Capture client, the user reviews the
document, makes changes as needed, completes any index fields configured
in the scan profile, then sends the batch. Sending the batch commits the new
document to Content Server 11g using a commit profile specified for the scan
profile. (A Capture/Content Server commit profile specifies connection
information and field mappings between Capture and Content Server
metadata fields.)
Upon successful sending, the user returns to the Managed Attachments page
and refreshes the display to view the newly scanned document or imported
scanned image file.
http://www.oracle.com/technetwork/middleware/webcenter/content/
documentation/documentation-155348.html
Note:
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
The requirements listed in this section apply only if using Oracle Distributed
Document Capture for optional scanning functionality.
Requirements include:
Note:
The Mozilla Firefox browser is not supported for scan functionality via Oracle
Distributed Document Capture, which currently requires Internet Explorer.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-12 Distributed Document Capture Server Configuration, System Settings Tab"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-13 Capture Administration, Index Fields"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-14 Scan Profiles, Oracle Distributed Document Capture Profile
Administration"
Note:
Typically, you would not select the business application entity
fields (dAFBusinessObject, for example) for display to users. If you
choose to display them, lock them on the Field Properties pane to
prevent users from changing their values.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-15 Scan Profiles, Oracle Distributed Document Capture Profile
Administration"
This commit profile specifies how to connect to the Content Server and how
the business application and Capture values are passed to the Content Server.
For information about creating Content Server commit profiles, see the
section on commit profiles in the Administrator's Guide for Oracle Distributed
Document Capture.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-16 Commit Profile Settings"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-17 Capture Administration, Check-In for Content Server
Commit Settings"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-18 Capture Administration, Add/Edit Custom Fields"
Click OK. The custom fields you added now display on the Field
Mappings tab shown in Figure 7-19. Map these custom fields to
the corresponding index fields you created in step 2, as they are
required to attach the new Content Server document to the
business application entity. Also map other Capture fields whose
values you want written to Content Server fields. Click OK.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-19 Capture Administration, Field Mappings for Content Server Commit
Settings"
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
or UniversalDocClassView for Enterprise Application Adapter
Framework), and click Edit Values.
4. In the Edit Values dialog box, click Add and add document classifications and
their corresponding scan profile. Note that documentClassification entries
must be unique, but a scan profile can be used multiple times.
Click Close when done.
5. From the Options menu, choose Publish schema to publish the data.
1. Refresh the Managed Attachments results page. You should see a Scan button
beside the New button.
2. Click the Scan button. In the Scan Document page, select a document
classification and security group, and click Scan Document. The Oracle
Distributed Document Capture client launches.
Note:
You can attach one document only via scanning or importing at a time.
Notice that the URL reflects the settings you specified to run the client. It also
passes the scan profile, scan action (1 = Scan and 2 = Import), and index
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
data containing the Oracle E-Business Suite or Oracle PeopleSoft entity
values.
3. Within the Oracle Distributed Document Capture client, review, index, and
send the document.
Note:
If you decide to cancel a document scan or import, you must close the Oracle
Distributed Document Capture window and return to the Managed
Attachments page and perform a new scan or import. This ensures that index
values are properly set for attachments.
4. Return to the Managed Attachments page and click Refresh. The newly
scanned document or imported scanned image file should display in the list.
(It may take a few minutes to display.)
1. Display the command driver page using the following URL form:
Note that you must log in to this page as the user set up in the CSF Credential
for Managed Attachments (for example, weblogic), as described in Section
7.7.1.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
Description of "Figure 7-20 Example Parameters for the Managed Attachments Driver Page"
A new browser window opens and displays the Managed Attachments page.
AppAdapterCore
AppAdapterEBS
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN
AppAdapterPSFT
AppAdapterUniversal
3. Select the name of the Content Server instance from which to uninstall the
component.
8. Click Restart.
9. Click Component Manager.
Internal Use Only This information must be shared within Tawazun and may be shared externally to an authorized person
TAWAZUN