This chapter covers the following topics:
Following are the general requirements for the adapter. Supported configuration and certification information is available at:
The Siebel Adapter for WebCenter Content requires the following:
Siebel SIA or SEA. The Siebel Web Client is also required.
Oracle WebCenter Content 11g Release 1 (11.1.1 or higher).
Oracle WebCenter Content 12c Release.
If implementing scanning functionality, you can use either Oracle WebCenter Enterprise Capture 11g/12c or Oracle Distributed Document Capture 10.1.3.5.1 or later. If using Oracle Distributed Document Capture, you must install the Oracle UCM 11g Commit Driver.
The Siebel Adapter supports the following Content Server search engines. For more information, see Configure the IFrame URL in the Siebel Web Client.
Metadata Only Search
Database – Full Text Search
Oracle Text – Full Text Search
The Content Server configuration procedures are detailed below:
Follow these steps to verify that required Content Server components are enabled:
Follow these steps to upload and import the Siebel adapter bundle:
The following Content Server components are provided with the adapter:
Table 2-1 Content Server Components Provided in Siebel Adapter
Content Server Component | Required | Description |
---|---|---|
SiebelEcmIntegration |
Yes |
This component provides IFrame functionality. |
SiebelFilter |
Optional |
This component is an optional part of the Siebel Adapter for Oracle WebCenter Content. It enables filtering of the attachments list based on metadata such as Document Type, Author and Security Group. |
SiebelIntegrationSearchDisplay |
Yes |
This component provides searching and IFrame functionality. |
SiebelSearchExtension |
Optional |
This component determines whether documents not yet released are displayed in the attachments list.
Note: This feature is available only when Metadata Only Search is used on the Content Server. |
SiebelSearchExtraParams |
Optional |
This component enables passing Siebel metadata values to Content Server through the New or Scan buttons. For instructions, see Passing Extra Metadata Parameters From Siebel to Content Server. Specify parameters to pass as configuration variables, as described in Set the Configuration Variables. |
Follow these steps to enable the components using Component Manager:
Follow the steps to configure the Siebel side of the adapter.
The Siebel configuration procedures include the following:
Important Points
Keep the following points in mind during Siebel configuration:
Siebel adapter Siebel SIF files can be found at the following location after an install:
middleware
/Oracle_ECM1/ucm/Distribution/SiebelEcmIntegration
Ensure that you are compiling to and testing on the same Siebel Repository file (.SRF).
A typical method is to import the SIF file into the local Siebel database and test it locally. When ready, you can check in the objects to the Siebel server, compile objects, and generate browser scripts.
New browser scripts that are generated must reside in the appropriate production location (for example, local client/PUBLIC/ENU and/or server Web client (SWE)/PUBLIC/ENU folders).
Performing the Siebel configuration steps automatically disables display of the corresponding Siebel File System Applets. This occurs when importing the SIF file, which deactivates specific File System attachment applets. If needed, reactivate these applets to display Siebel File System attachments, such as during a migration process. For information on activating and deactivating applets, see Siebel Object Locking.
When the Siebel Adapter for WebCenter Content is configured, Siebel attachments that customers have migrated from Siebel File Systems to Content Server and previously accessed with Siebel EAI or EIM Web services are no longer available. However, these migrated documents could now be accessed using Content Server Web services.
The SIF archive file contains changes to multiple Siebel objects, including Projects, Applets, Views, Business Components, and browser scripts. Before importing the SIF file, follow these steps to lock objects to be modified by the import:
Follow these steps to import Siebel Adapter for WebCenter Managed Attachments objects into Siebel from a Siebel Archive File from a Siebel archive file using the Import Wizard:
Caution:
On certain custom Siebel configurations, importing the SIF file using the merge option (as described in this procedure) could result in fields, user properties, and joins from custom Siebel configurations being overwritten.
Before testing the modified projects, follow these steps to compile them:
Follow the steps to configure a symbolic URL in the Siebel Web client to the Managed Attachments IFrame. (A symbolic URL is a type of link that references the Content Server search results page.)
The size of the IFrame is based on the ResultCount and IFrameSRC height settings defined in the Symbolic URL.
ResultCount determines the number of results that display on a results page before pagination controls are added at the bottom of the screen.
IFrameSRC height determines the height (in pixels) of the IFrame.
If the ResultCount setting causes the IFrame display to exceed the height, a vertical scroll bar is displayed. If users scroll to the bottom, the header information may become hidden.
For this reason, it is recommended that you adjust the ResultCount and IFrameSRC height settings in combination so that no scroll bar is displayed. Ensure that the IFrame height accommodates the result count. A recommended setting combination is an IFrame height setting of 280 and ResultCount setting of 6.
Note:
If you encounter technical issues in configuring this adapter, on either the Content Server side or the Siebel side, log a service request using My Oracle Support.
Setting AllowContentServerInAnyDomains
If the Content Server login page displays in the Siebel page instead of the IFrame, setting AllowContentServerInAnyDomains=1 in the Content Server config.cfg fixes the issue.
Note:
Be aware that setting the AllowContentServerInAnyDomains variable to 1 allows Content Server pages to be opened in IFrames, which could pose a potential security issue.
Following topics cover how to configure Oracle WebCenter Enterprise Capture:
About Document Scanning Using Oracle WebCenter Enterprise Capture
Configure Oracle WebCenter Enterprise Capture for the Siebel Adapter
Configure Content Server for WebCenter Enterprise Capture Using the Adapter
Test the WebCenter Enterprise Capture Using Siebel Adapter Configuration
Note:
This section describes scanning using Managed Attachments using Oracle WebCenter Enterprise Capture 11g. For information about scanning using Oracle Distributed Document Capture 10g, see Configuring Oracle Distributed Document Capture.
The Oracle WebCenter Enterprise Capture application allows an application such as the Siebel Adapter to direct it to scan a document and pass in document metadata values. This allows users to scan a document or import a file (image or non-image file such as PDF or Microsoft Word file) from the Managed Attachments IFrame and attach it to the selected Siebel record.
When configured for the Siebel Adapter, document scanning works like this:
Follow these steps to configure attachment scanning on the Oracle WebCenter Enterprise Capture side:
If needed, configure Single Sign-on (SSO) for Oracle WebCenter Enterprise Capture.
As long as the Siebel adapter solution and WebCenter Enterprise Capture are configured in Oracle Access Manager (OAM), Capture users can be authenticated using SSO.
In the Capture Workspace Console, add metadata fields to a selected workspace for capturing values for new documents, as shown in Figure 2-2. For details, see Adding or Editing a Metadata Field in Managing Oracle WebCenter Enterprise Capture.
Create metadata fields for values you want to save with attached documents on the Content Server. For example, you might configure Doc Type and Security Group choice list metadata fields for users to select from standard settings.
Create a metadata field to contain the Siebel entity value. Name the field based on the Siebel entity you are using, listed in the following table.
Identifier
Following are the Siebel entity identifiers:
dDocAuthor
dDocAccount
xAccountId
xsiebelAcct
xsiebelActivity
xsiebelArrest
xsiebelAsset
xsiebelCallRpt
xsiebelCase
xsiebelClaim
xsiebelContact
xsiebelEvidence
xsiebelGroup
xsiebelIncident
xsiebelLead
xsiebelOffense
xsiebelOpprnty
xsiebelOrder
xsiebelProject
xsiebelQuote
xsiebelSuspect
xsiebelSvcReq
Note:
Capture allows you to map DocAuthor as a custom metadata field. This ensures that the documents can have an author other than the default author.
Figure 2-3 WebCenter Enterprise Capture, Metadata Fields
Note:
The Siebel identifier metadata fields (named xsiebel<entity>, as in xsiebelContact and xsiebelAcct) store Siebel entity values used for linking attachments to Siebel entities. Because they are not stored as regular metadata fields, they are not searchable and administrators configuring profiles should not treat them as regular metadata fields. (By default, these identifier fields are not visible to users in WebCenter Content. While users can enter search values into the fields if displayed, matching documents will not be found by the Content Server search engine.)
Users can attach documents to entities by entering entity row IDs into the Siebel identifier fields as a comma-separated list. In this case, Managed Attachments stores the values in a separate database table.
On the Workspace's Classification tab, create a document profile for the Siebel metadata fields, as shown in Figure 2-2. For details, see Adding or Editing a Document Profile in Managing Oracle WebCenter Enterprise Capture.
Figure 2-4 WebCenter Enterprise Capture, Document Profile
Note:
Typically, you would not select the Siebel identifier field (xsiebelContact, for example) for display to users. If you choose to display it, lock it under the metadata settings to prevent users from changing the value.
On the Capture tab, create a client profile, as shown in Figure 2-5. Later, you associate this client profile with one or more document classifications, so that when a user selects a classification, the associated client profile's settings are used. For details, see Introduction to Client Profiles in Managing Oracle WebCenter Enterprise Capture.
On the General Settings train stop, select 2 - Capture and Index in the Profile Type field. This capture type includes indexing, and scans or imports pages into a single document in a batch. Specify a profile name and batch prefix for the client profile.
On the Document Indexing Settings train stop, select the Siebel document profile you created in step 3. You can optionally select the database lookups and choice lists that you created in the Metadata tab.
Click Submit to save the client profile.
Figure 2-5 WebCenter Enterprise Capture, Client Profile
On the Commit tab, create an Oracle WebCenter Content commit profile to commit the scanned or imported documents to the Content Server when users release a completed batch. See Figure 2-6.
This commit profile specifies how to connect to the Content Server, and how the Siebel and Capture values are passed to the Content Server. For information about creating Oracle WebCenter Content commit profiles, see About the WebCenter Content Commit Driver in Managing Oracle WebCenter Enterprise Capture.
Select WebCenter Content from the Commit driver drop-down list.
On the Login tab, specify settings for logging in to the Content Server instance. (The other tabs become active after you log in.)
On the Check-In tab, specify where to make documents visible, how to name documents and assign Type, Security Group, and Account metadata values.
On the Field Mappings tab, specify how to write Capture metadata values to the Content Server fields.
Note:
You must map the Siebel entity field you created in step 2.b, as it is required to attach the new Content Server document to the Siebel record.
On the Options tab, specify additional settings.
Figure 2-6 WebCenter Enterprise Capture, Field Mappings for a Content Commit Profile
Follow these steps to configure attachment scanning on the Content Server side:
On Content Server, edit the following configuration variables for Oracle WebCenter Enterprise Capture, if you have not done so. See Set the Configuration Variables.
ODCURLPath=http://
capture_host:port
/dc-client
ODDCScanAction=ODDC Scan Action
AdapterAppScanBtnVisible=true
Restart Content Server.
On the Content Server, configure document classification and scan types.
From the Administration tray in the Content Server, click the Admin Applets link.
Select the Configuration Manager applet. The Configuration Manager is displayed.
Click the Views tab, select DocClassView from the alphabetical list, and click Edit Values.
In the Edit Values dialog box, click Add and specify the document classification and the corresponding client profile. Note that documentClassification entries must be unique, but a client profile can be used multiple times. Click Close when done.
From the Options menu, select Publish schema to publish the data.
Follow these steps to test the configuration as an end-user. For details about scanning using Oracle WebCenter Enterprise Capture as an end-user, see How does scanning work? in Using Oracle WebCenter Enterprise Capture:
Following topics cover how to configure Oracle Distributed Document Capture:
About Document Scanning Using Oracle Distributed Document Capture
Configure Oracle Distributed Document Capture For the Siebel Adapter
Configure Content Server for Distributed Document Capture Using the Adapter
Test the Distributed Document Capture Using Siebel Adapter Configuration
Note:
This section describes scanning using Managed Attachments using Oracle Distributed Document Capture 10g. For information about scanning using Oracle WebCenter Enterprise Capture 11g, see Configuring Oracle WebCenter Enterprise Capture.
The Oracle Distributed Document Capture application allows an application such as the Siebel Adapter to direct it to scan a document and pass in document index values. This allows users to scan documents or import scanned image files from the Managed Attachments IFrame and attach them to the selected Siebel record.
When configured for the Siebel Adapter, document scanning works like this:
Follow these steps to configure attachment scanning on the Oracle Distributed Document Capture side:
Ensure that Oracle Distributed Document Capture is set for automatic login (optional).
On the System Settings tab of the Distributed Document Capture Server Configuration application shown in Figure 2-7, select Web Server Authenticated Access from the Authentication Methods options. This allows the client to launch automatically without users needing to log in. For details, see the section on authentication in the Installation Guide for Oracle Distributed Document Capture.
Figure 2-7 Distributed Document Capture Server Configuration, System Settings Tab
In Capture Administration, add index fields to a selected file cabinet for capturing values for new documents, as shown in Figure 2-8. For details, see the section on Capture Administration in the Administrator's Guide for Oracle Distributed Document Capture:
Create index fields for values you want saved with attached documents on the Content Server. For example, you might configure Doc Type and Security Group pick-list index fields for users to select from standard settings.
Create an index field to contain the Siebel entity value. Name the field based on the Siebel entity you are using, listed in the following table:
Identifier
Following are the Siebel entity identifiers:
xsiebelAcct
xsiebelActivity
xsiebelArrest
xsiebelAsset
xsiebelCallRpt
xsiebelCase
xsiebelClaim
xsiebelContact
xsiebelEvidence
xsiebelGroup
xsiebelIncident
xsiebelLead
xsiebelOffense
xsiebelOpprnty
xsiebelOrder
xsiebelProject
xsiebelQuote
xsiebelSuspect
xsiebelSvcReq
Figure 2-8 Capture Administration, Index Fields
In Oracle Distributed Document Capture's Profile Administration, create a scan profile, as shown in Figure 2-9. Later, you associate this scan profile with one or more document classifications, so that when a user selects a classification, the associated scan profile's settings are used. For details, see the section on scan profiles in the Administrator's Guide for Oracle Distributed Document Capture.
On the General pane, select 2 - Scan and Index Documents in the Scanning Type field. This scanning type includes indexing, and scans or imports pages into a single document in a batch. Specify a file cabinet and batch prefix.
On the Document Indexing pane, move all fields you want displayed to users to the Selected Fields box.
Note:
Typically, you would not select the Siebel identifier field (xsiebelContact, for example) for display to users. If you choose to display it, lock it on the Field Properties pane to prevent users from changing the value.
On the Field Properties, Auto Populate, and Database Lookup panes, configure any pick-lists, database lookups, or autopopulating needed for indexing. Save the scan profile.
Figure 2-9 Scan Profiles, Oracle Distributed Document Capture Profile Administration
In Capture Administration, create an Oracle UCM 11g commit profile to commit the scanned or imported documents to Content Server when users send a completed batch. See Figure 2-10.
This commit profile specifies how to connect to the Content Server, and how the Siebel and Capture values are passed to the Content Server. For information about creating Oracle UCM 11g commit profiles, see the section on committing profiles in the Administrator's Guide for Oracle Distributed Document Capture:
Select Oracle UCM 11g Commit Driver in the Commit Driver field. Click Configure adjacent to the Commit Driver field.
On the Login tab, specify settings for logging in to the Content Server instance. (The other tabs become active after you log in.)
On the Check-In tab, specify how to name documents and assign Type, Security Group, and Account values.
On the Field Mappings tab, map Capture fields to Content Server fields.
Note:
You must map the Siebel entity field you created in step 2.b, as it is required to attach the new Content Server document to the Siebel record.
Activate the Siebel-UCM commit profile.
Figure 2-10 Capture Administration, Oracle UCM 11g Commit Settings
Follow these steps to configure attachment scanning on the Content Server side:
On Content Server, edit the following configuration variables for Oracle Distributed Document Capture, if you have not done so. See Set the Configuration Variables.
ODDCURLPath=http://
ODDC_host/ODDC_webcapture_address
ODDCScanAction=ODDC Scan Action
AdapterAppScanBtnVisible=true
Restart Content Server.
On Content Server, configure document classification and scan types.
From the Administration tray in Content Server, click the Admin Applets link.
Select the Configuration Manager applet. The Configuration Manager is displayed.
Click the Views tab, select DocClassView from the alphabetical list, and click Edit Values.
In the Edit Values screen, click Add and add document classification and their corresponding scan profile. Note that the documentClassification entries must be unique, but a scan profile can be used multiple times. Click Close when done.
From the Options menu, select Publish schema to publish the data.
As part of an adapter configuration, you can pass one or more metadata values from Siebel to Content Server for populating New and Scan button URLs within the Siebel IFrame. For example, whenever a user checks in a new document using the New or Scan button, you might pass a Siebel account name for use in check-in.
Here's how it works:
To pass values, you need a Siebel field and a Content Server metadata field.
Two configuration variables are provided: one for new documents and the other for scanning documents. You set these variables to the metadata field(s) to populate on the Content Server side.
You add arguments to the symbolic URL (with the prefix extra added to the variable name) that link the Siebel and Content Server fields, so that they are appended to the New or Scan button URL. When the IFrame is displayed, the application searches the URL for extra parameter variables and uses their assigned values to populate New or Scan button actions.
Depending on configuration, extra values being passed may be visible or hidden from users checking in or scanning documents. For example, you might hide an account number, but for another value, you might populate a drop-down field and allow users to change the value.
Configuring extra metadata parameters involves the following main steps:
Follow these steps to configure extra parameters on the Content Server side:
You can customize the Siebel Adapter in the ways described below:
Follow these steps to add a custom button to the IFrame to implement an additional function:
js_custom_siebel_functions
The super.js_custom_siebel_functions must be included for the main button bar to display. This include adds a javascript listener attached to the custom button. The YAHOO.oracle.ucm.adapter.extension is the YUI namespace which helps in detecting and preventing name conflicts.
<@dynamichtml js_custom_siebel_functions@> <$include super.js_custom_siebel_functions$> <script type="text/javascript"> //namespace definition YAHOO.namespace("YAHOO.oracle.ucm.adapter.extension"); /** * Function for custom functionality added to the existing adapter. * */ YAHOO.oracle.ucm.adapter.extension.customFunctionListener=function(){ //custom code goes in here alert("You have your custom functionality running"); }; </script> <@end@>
custom_configurable_btn_bar
The super include must be present. This code makes the button appear in the user interface.
<@dynamichtml custom_configurable_btn_bar@> <$include super.custom_configurable_btn_bar$> <a id="customBtn" href="http://hostname/pages/editpage.action#" >Custom Button</a> <@end@>
js_custom_configurable_btn_bar
This code associates the listener function with the button code.
<@dynamichtml js_custom_configurable_btn_bar@> <$include super.js_custom_configurable_btn_bar$> YAHOO.util.Event.addListener("customBtn","click",YAHOO.oracle.ucm.adapter.extension.customFunctionListener); <@end@>
As an option, you can configure a special display mode that dynamically overrides the default display configuration settings, hiding one or more buttons and disabling one or more icons. For example, when users are viewing a specific Siebel record type, such as Orders, you might hide the New and Scan buttons to prevent them from adding new attachments to orders, and disable the Edit icon so they can view but not edit order related attachments.
Here's how it works:
By default, no dynamic display mode is configured. Under normal default settings, buttons in the IFrame are displayed according to their configuration variable settings (see Set the Configuration Variables). Columns are displayed according to the user's field configuration settings, and if columns are displayed, their icons are always functional.
A parameter called SiebelDisplayMode sets the alternate display mode's combination of disabled buttons and icons. When set, this parameter overrides the other configuration variables (for example, AdapterAppCheckinBtn=true). The SiebelDisplayMode parameter is an integer that you calculate. During display, the integer is translated to dynamically determine the button and icon status.
You activate the alternate dynamic display mode by configuring a secondary symbolic URL for the IFrame and specifying the SiebelDisplayMode parameter within it. Then, for business objects that require the alternate display mode, you change the symbolic URL to point to the secondary symbolic URL.
Each button and icon is assigned an integer value, as shown in Figure 2-14 and listed in Table 2-3. Calculate the display mode integer by adding the integer value of each button and icon to be disabled.
For example, to disable the Edit and Properties icons and hide the New, Scan, Detach, and Configure buttons, calculate the SiebelDisplayMode value as follows:
2^1 + 2^2 + 2^3 + 2^4 + 2^5 + 2^8 = 318
Note:
Setting the SiebelDisplayMode value to 0 displays all buttons and enables all icons, overriding any specified values in the config.cfg file.
Figure 2-14 Integer Values for Calculating a Display Mode Integer
Table 2-3 Integer Values for Calculating a Display Mode Integer
Button or Icon | Integer Value |
---|---|
Info Icon |
20 |
Edit Icon |
21 |
Properties Icon |
22 |
New Button |
23 |
Scan Button |
24 |
Detach Button |
25 |
Refresh Button |
26 |
Advanced Search Button |
27 |
Configure Button |
28 |
Note:
To hide custom buttons, see Calculate Values for Custom Buttons.
After calculating a display mode integer, as described in Calculate the SiebelDisplayMode Integer follow these steps to configure the alternate display mode:
In the Siebel Web Client, configure a secondary symbolic URL for the IFrame.
Enter a new name for the URL (for example, UcmServUrl2) and select the same settings as the original URL. For more information, see Configure the IFrame URL in the Siebel Web Client.
Include an additional argument that specifies the SiebelDisplayMode parameter as shown in the table and the illustration that follows:
Name | Required Argument | Argument Type | Argument Value | Append as Argument | Substitute in Text | Sequence # |
---|---|---|---|---|---|---|
SiebelDisplayMode |
N |
Constant |
Integer corresponding to display mode |
Y |
N |
12 |
For business objects that require the alternate display mode, change the symbolic URL to point to the secondary symbolic URL.
If you have added custom buttons to the IFrame (as described in Add Custom Buttons) and want to hide them in an alternate display mode, include their values in the integer calculation.
The following resource adds the buttons (custombtn1 and custombtn2) to the EnumObj javascript object and the framework calculates their values at runtime:
js_custom_button_visibility_handler
<@dynamichtml js_custom_button_visibility_handler@> <$include super.js_custom_button_visibility_handler$> NAME_ENUM.CUSTOMBTN1="CUSTOMBTN1", NAME_ENUM.CUSTOMBTN2="CUSTOMBTN2", EnumObj.add(NAME_ENUM.CUSTOMBTN1,"customBtn1",IMG_ENUM.BUTTON); EnumObj.add(NAME_ENUM.CUSTOMBTN2,"customBtn2",IMG_ENUM.BUTTON); <@end@>
The following illustration displays the custom buttons and their calculated values:
To change the background, highlighted row, or hover row in IFrame, create a component and override the following resources:
css_adapter_background_styling
css_adapter_row_styling
css_adapter_background_styling
In the following lines, specify another background color for the adapterBackgroundColor idoc variable (hexidecimal code recommended). The super include line must be present.
<@dynamichtml css_adapter_background_styling@> <$adapterBackgroundColor="#346a2a"$> <$include super.css_adapter_background_styling$> <@end@>
css_adapter_row_styling
In the following lines, change the row colors by specifying different colors for the selectedRowColor and highlightedRowColor idoc variables. The super include line must be present.
<@dynamichtml css_adapter_row_styling@> <$selectedRowColor="#eac5a6"$> <$highlightedRowColor="#bdc1a3"$> <$include super.css_adapter_row_styling$> <@end@>
Follow the steps listed below to uninstall the adapter:
Follow these steps to disable the following adapter components on the Content Server:
Uninstalling Siebel adapter components includes activating the default Siebel File Attachment Applets that were disabled during adapter configuration, and deactivating the applets the SIF file added for the adapter configuration. See Activating or Deactivating Siebel Objects.