Documentum Client for Siebel Implementer Guide · Siebel7.xToolsProcedures 5. ExpandtheAppletsobjectandnotethemodifications.Twotypesofappletsare beingmodified,attachmentappletsandformapplets.TheSIFfilesaddstheServer

Documentum Client for SiebelImplementer Guide

Version 5.3 SP4April 2007

Copyright © 1994-2007 EMC Corporation. All rights reserved.

Table of Contents

Preface .......................................................................................................................... 7

Chapter 1 Installing DCS ........................................................................................ 9

Chapter 2 Siebel 7.x Tools Procedures .................................................................. 11Importing the DCS_ModifiedBC SIF file....................................................... 11Importing the DCS_DocumentumProject SIF file .......................................... 15Importing the DCS_ModifiedApplets SIF file................................................ 17Importing the DCS_ModifiedViews SIF file .................................................. 18Importing the DCS_ModifiedScreens SIF file ................................................ 19Importing the DCS_ModifiedApplication SIF file.......................................... 20Compile all projects .................................................................................... 22Generate browser scripts............................................................................. 22Thick client vs Thin client............................................................................ 22Setting up views and responsibilities ........................................................... 22Setting up Documentum Logon Parameters ................................................. 23Integrating External Content ....................................................................... 23Setting up Java Business Service .............................................................. 24Prerequisites for Implementing a Java Business Service ............................ 24Implementing Java Business Service ........................................................ 25Setting up Symbolic URL ........................................................................ 26Setting up environment variables ............................................................ 34

Chapter 3 Business Services in DCS ..................................................................... 35

Documentum Client for Siebel Implementer Guide 3

Table of Contents

List of Figures

Figure 2–1. Import from Archive....................................................................................... 12Figure 2–2. Select the DCS_ModifiedBC.sif ........................................................................ 13Figure 2–3. DCS_ModifiedBC SIF File ............................................................................... 14Figure 2–4. DCS_DocumentumProject SIF File ................................................................... 15Figure 2–5. DCS_ModifiedApplets SIF File ........................................................................ 17Figure 2–6. DCS_ModifiedViews SIF File........................................................................... 19Figure 2–7. DCS_ModifiedScreens SIF File......................................................................... 20Figure 2–8. Example of Import Wizard - Preview ............................................................... 21

4 Documentum Client for Siebel Implementer Guide

Table of Contents

List of Tables

Table 2–1. DCSAttachPath .............................................................................................. 27Table 2–2. DCSContentPortal .......................................................................................... 27Table 2–3. DctmLogin..................................................................................................... 28Table 2–4. DctmPassword ............................................................................................... 28Table 2–5. DctmDocbase ................................................................................................. 29Table 2–6. DctmDomain ................................................................................................. 29Table 2–7. SessId ............................................................................................................ 29Table 2–8. DctmCab........................................................................................................ 29Table 2–9. DctmFold....................................................................................................... 30Table 2–10. DctmSubFold ................................................................................................. 30Table 2–11. dcsHTTPMeth ................................................................................................ 30Table 2–12. DctmSymiFrame............................................................................................. 30Table 2–13. DctmSymURL ................................................................................................ 31Table 2–14. DctmLogin..................................................................................................... 32Table 2–15. DctmPassword ............................................................................................... 32Table 2–16. DctmDocbase ................................................................................................. 33Table 2–17. DctmDomain ................................................................................................. 33Table 2–18. dcsHTTPMeth ................................................................................................ 33


Table of Contents


Preface

Documentum Client for Siebel (DCS) is the new name for Content Services for Siebel. However, forbackward compatibility, you may see “eConnector” or “Content Services for Siebel” in places likefolders and DocApps.

This document describes all the steps necessary to integrate the components of DCS 5.3 SP4 with aSiebel repository. The end-result of this integration is the Siebel SRF file, which is distributed to thickclient Siebel users and placed on the Siebel Application Server for thin client users.

Intended AudienceThe intended audience for this document is Siebel Developers and Administrators, whoare implementers of Documentum Client for Siebel. The implementer should have theexperience required to use Siebel tools, Documentum, and Documentum Client for Siebeland should have at least moderate knowledge of Java and Web applications.

The Implementer should be familiar with:

• Check-In and Checkout projects in Siebel• Import the Siebel Objects from archive files (SIF files).• Siebel Tools Objects such as applets and business components including their

corresponding properties and events.• Generation of a new SRF file.

Revision HistoryThe following changes have been made to this document.

Revision History

Revision Date Description

April 2007 Initial publication of Documentum Clientfor Siebel 5.3 SP4 Implementer Guide


Preface

Related DocumentationThe following documentation is available for using and customizing DocumentumClient for Siebel.• Documentum Client for Siebel User Guide• Documentum Client for Siebel Release Notes• Documentum Client for Siebel Installation Guide


Chapter 1Installing DCS

Documentum Client for Siebel (DCS) is the new name for Content Services for Siebel. However, forbackward compatibility, you may see “eConnector” or “Content Services for Siebel” in places likefolders and DocApps.

The steps involved in installing DCS are:

1. Installing DCS components

2. Performing Siebel 7.x Tools procedures

3. Creating SRF

4. Adding Views

5. Adding Responsibilities

6. Setting up logon information for employees

7. Integrating external components• Setting up Java Business Service• Prerequisites for implementing a Java Business Service• Implementing Java Business Service• Setting up Symbolic URL• Setting up environment variables


Installing DCS


Chapter 2Siebel 7.x Tools Procedures

The DCS install package comes with a set of SIF files. These SIF files are used to import new DCSobjects into the Siebel Tools Repository and to update existing objects in the Siebel Tools Repository.DCS supports the following Siebel vertical:

• Siebel Call Center/CRM (CRM)This Siebel vertical is described in detail in this section. Navigate to the SIF Files folder available in theDCS_Server_Components folder. This chapter goes on to describe the procedure you have to followand also includes the following sub procedures:• Importing the DCS_ModifiedBC SIF file, page 11• Importing the DCS_DocumentumProject SIF file, page 15• Importing the DCS_ModifiedApplets SIF file, page 17• Importing the DCS_ModifiedViews SIF file, page 18• Importing the DCS_ModifiedScreens SIF file, page 19• Importing the DCS_ModifiedApplication SIF file, page 20• Compile all projects, page 22• Generate browser scripts, page 22• Thick client vs Thin client, page 22• Setting up views and responsibilities, page 22• Setting up Documentum Logon Parameters, page 23• Integrating External Content, page 23

Importing the DCS_ModiedBC SIF leTo import the DCS_ModifiedBC SIF file, follow these steps:

1. Check out the Employee project.

2. Navigate to the Tools menu and select Import From Archive as shown below.


Siebel 7.x Tools Procedures

Figure 2-1. Import from Archive

3. Select the DCS_ModifiedBC.sif file located in the SIF files folder in the DCSinstallation media as shown below.



Figure 2-2. Select the DCS_ModiedBC.sif

4. The Import Wizard—Preview dialog box appears as shown below.



Figure 2-3. DCS_ModiedBC SIF File

Select theMerge the object definition from the archive with the definition in therepository option.

5. Click Next. The Import Wizard>Review Conflicts and Actions window opens.

6. Expand the Siebel Objects>Business ComponentObject>Employees>Field in the Conflicting Objects pane.Ensure that the action property of the fields listed below is set to File in the ObjectDifferences pane.• Documentum Docbase Name• Documentum Docbase Domain• Documentum Login• Documentum Password• Documentum Password MaskSimilarly the action property of all the other fields should be set to Repository.

7. Click Next when complete.

8. Click Yes to accept the modifications.

9. Click Finish to exit the wizard.



Importing the DCS_DocumentumProject SIFle

This particular SIF file import will create a new project in the repository. Therefore, youdon’t need to check out a particular Siebel project prior to importing the file.

To import the DCS_DocumentumProject SIF file, follow these steps:

1. Navigate to the Tools Menu and select Import From Archive.

2. Select the DCS_DocumentumProject.sif file located in the SIF File folder in the DCSinstallation media. The Import Wizard-Preview dialog box appears as shown below.

Figure 2-4. DCS_DocumentumProject SIF File

Select theMerge the object definition from the archive with the definition in therepository option and click Next.

3. Expand the Applet, Business Service, Class, DLL, Screen, and View objects. Ensurethat the action property of their sub-folders is set to File.

Note: Integrators should ensure that all of these items are imported successfullyinto the tools repository.



4. Click Next.





Importing the DCS_ModiedApplets SIF leThis sub procedure differs for each vertical and has been described separately.

To import the DCS_ModifiedApplets SIF File, follow these steps:

1. Check out the following projects:• Account (SSE)• Contact (SSE)• Oppty (SSE)• Service (SSV)

2. Navigate to the Tools menu and select Import from Archive.

3. Select the DCS_ModifiedApplets.sif file located in the SIF File folder in the DCSinstallation media.

4. The Import Wizard-Preview dialog box appears as shown below:

Figure 2-5. DCS_ModiedApplets SIF File




5. Expand the Applets object and note the modifications. Two types of applets arebeing modified, attachment applets and form applets. The SIF files adds the ServerScript, Browser Script, New Controls, and Web Template items to the attachmentapplets. The modified attachment applets are:• Account Attachment applet• Contact Attachment applet• Opportunity Attachment applet• Service Request Attachment appletThe SIF files adds the Browser Script to the Form applets. The modified Formapplets are:• Opportunity Form applet – Child• Contact Form applet• Account Entry applet• Service Request Detail applet

6. After reviewing these objects, click Next.



Importing the DCS_ModiedViews SIF leThis sub procedure differs for each vertical and has been described separately.

To import the DCS_ModifiedViews SIF file, follow these steps:

1. Verify whether the following projects are checked out and locked:• Account (SSE)• Contact (SSE)• Oppty (SSE)• Service (SSV)

2. Navigate to the Tools menu and select Import from Archive.

3. Select the DCS_ModifiedViews.sif file located in the SIF File folder in the DCSinstallation media. The Import Wizard-Preview dialog box appears as shown below:



Figure 2-6. DCS_ModiedViews SIF File

4. Select theMerge the object definition from the archive with the definition in therepository option.

5. Click Next.

6. Expand the View objects and verify that one View Web Template Item is addedto each of the modified views.

7. Click Next.



10. Lock the project called DCS Documentum.

Importing the DCS_ModiedScreens SIF leTo import the DCS_ModifiedScreens SIF file, follow these steps:

1. Check out the Admin project.



2. Navigate to the Tools menu and select Import from Archive

3. Select the DCS_ModifiedScreens.sif file located in the SIF file folder in the DCSinstallation media. The Import Wizard-Preview dialog box appears as shown below.

Figure 2-7. DCS_ModiedScreens SIF File


4. Expand the Screen object and verify that one screen is being added.

5. Click Next.



Importing the DCS_ModiedApplication SIF le1. To import the DCS_ModifiedApplication SIF File, follow these steps:

2. Check out the required project as given below:



• CRM—Siebel Universal Agent3. Navigate to the Tools menu and select Import from Archive.

4. Select the DCS_ModifiedApplication.sif file located in the SIF File folder in theDCS installation media. The Import Wizard-Preview dialog box appears as shownin the example below.

Figure 2-8. Example of Import Wizard - Preview

5. Select theMerge the object definition from the archive with the definition in therepository option and click Next.

6. Expand the application object and verify whether the file is able to add an applicationserver script, two page tabs and two screen menu items. All the other objects shownshould be part of the existing application definition, and the resolution of theseobjects is set to repository.

7. Click Next.





Compile all projectsAfter importing all the SIF files, compile all the projects to generate the new SRF (.srf) file.

Generate browser scriptsVarious objects from the SIF files (applets/business services) contain browser script code.In order to run the browser scripts in Siebel 7.x, a utility called genbscriptsmust be run togenerate the browser scripts on the client machine or Siebel Server. When generatingbrowser scripts for a thin client install, the browser script files must be placed in theSiebelServer\SWEApp\PUBLIC\<Language> directory. For more information relatingto this procedures, logon to the Siebel Support site and reference Alert 0365: BrowserScript Generation in Siebel 7.x.

Thick client vs Thin clientIn order to move files in and out of Documentum, the Siebel code makes a COMconnection to reference a .dll. This code is written in server script, and therefore if itis executed on the dedicated client, it executes the .dll on the client machine. If thecode is executed on the thin client, it executes the .dll on the server. Hence DCS andDocumentum should be installed on the server machine using thin client.

Setting up views and responsibilitiesThe procedure to set up views and responsibilities is as follows:

1. Log on to the Call Center vertical

2. Navigate to View>Site Map>Application Administration>Views.

3. Add the following views:• DCS Login/Password for Documentum• DCS Content Manager Portal View

4. Navigate to View>Site Map>Application Administration>Responsibilities.

5. Create a new responsibility called Documentum.

6. Create a new responsibility called Documentum Administrator.


https://ebusiness.siebel.com/supportweb/


7. Add the DCS Content manager Portal view to these responsibilities. Also, add userswho should have access to Documentum views to these responsibilities.

8. Add the DCS Login/Password for Documentum view to the DocumentumAdministrator Responsibility. Give this responsibility only to the user who isdesignated to administer the Documentum Passwords. This recommendation isfor security purposes, as users with access to this view will have administrativeprivileges to the user community’s Documentum passwords.

9. Exit.

Setting up Documentum Logon ParametersTo set up Documentum Logon Parameters, follow these steps:

1. Using the compiled .srf, logon to Siebel and navigate to View>Site Map>UserAdministration>Employees.

2. In the Employee List Applet, select an employee whose Documentum logon andpassword is added or updated.

3. In the bottom half of the screen, select the DCS Login/Password for Documentumtab.

4. Enter the user’s Documentum Login, Docbase Name, and Docbase Domain.

Note: Ensure that dmcl.ini points to the required repository (Docbase Name) in theApplication Server where Webtop is installed. Also, ensure that the system does nothave multiple copies of the file at various locations. For example, in a Win 2000system, the files can be found in the C:\WINNT folder.

5. Return to the record and clickModify Documentum Password.

6. Enter the employee’s password.

7. When the Confirmation Input box appears, enter the password again.

8. Exit.

Integrating External ContentThis section deals with the configuration and administration tasks that are necessary todisplay external content in the Siebel user interface. The following sections describe theprocedures to integrate Siebel with Documentum:



Setting up Java Business Service

The EAI Java Business Service (JBS) is a service framework that allows custom businessservices to be implemented in Java and run from a Siebel application. This serviceframework consists of the following:

1. A template Business Service, EAI Java Business Service, defined in the repository.

2. An abstract Java class, com.siebel.eai.SiebelBusinessService, that defines the interfaceof the Java class that implements the business service.

The EAI Java Business Service works by creating a Java Virtual Machine (JVM) in-processwith the Siebel application and invoking Java implementations using JNI. Each Siebelprocess (component) has at most one JVM. JVMs are not shared across components.

Prerequisites for Implementing a Java Business Service

To implement a Java Business Service, you require the following software that must beinstalled and properly configured on each Siebel Server or Siebel Mobile and DedicatedWeb Clients:

• A Java Runtime Environment.• All necessary Java code.• A configured named subsystem of type JVMSubSys.The named subsystem supplies the parameters to the JBS. The three parameters are:• DLL—The complete path of the Java Runtime Environment library.

For each of the Operating Systems: jvm.dll (Windows), libjvm.a (AIX), libjvm.sl(HP-UX), and libjvm.so (Solaris).

• CLASSPATH—The classpath used by the Java Virtual Machine.

The classpath must include the following Siebel JAR files as well as all Java codeimplementing the desired business service. The required Siebel JAR files are:

— Siebel.jar

— SiebelJI_lang.jar (lang corresponds to the default language for your installation).• VMOPTIONS— Java Virtual Machine Options. On all platforms, except AIX, it is

recommended that the option -Xusealtsigs be used to make sure that the signalhandlers used by the Siebel Server do not conflict with those of the JVM.



Implementing Java Business Service

The procedure to implement a Java Business Service are as follows:

• Importing the DCSImpExp.jar file

Once you extract the DCS_SIF.zip file, you get the DCSImpExp.jar file in theDCS_Server_Components\JAR folder. Copy that file to the CLASSES folder of theSiebel Server. For example: F:\Sea78\Siebsrvr\CLASSES.

Note: Make sure that the required Siebel.jar and Siebel_lang.jar files exist in theCLASSES folder.

• Creating a Java subsystem using Siebel Web Client

To create a Java subsystem using Siebel Web Client:

1. Start any Siebel eBusiness application and navigate to Site Map>Administration -Server Configuration>Enterprises.

2. In the top list applet, select the Enterprise Server that you want to configure.

3. In the middle applet, click the Profile Configuration tab.



4. Click New to create a new component profile and set the following parameters:— Profile = JAVA— Alias = JAVA— Subsystem Type = JVMSubsys

5. In the Profile Parameters list applet (the bottom applet), set the following values:— Set the Value of the JVM Classpath parameter to one of the following: TheSiebel.jar and SiebelJI_enu.jar files. These files can be installed by using eitherSiebel Tools or the Siebel Server. An example of these files for Microsoft Windowsis as follows:F:\sea78\siebsrvr\CLASSES\Siebel.jar; F:\sea78\siebsrvr\CLASSES\SiebelJI_enu.jar;F:\sea78\siebsrvr\CLASSES\DCSImpExp.jar;— Set the Value of the JVM DLL Name parameter to the path where you have thejvm.dll file installed. For example,DLL= D:\Program Files\Java\j2re1.4.2_12\bin\client\jvm.dll— Set the Value of the JVM Options record to any JVM-specific options that youwould like to enable.VMOPTIONS = -Xrs -Djava.compiler=NONE

Alternatively, the parameters to the Java Business Service may be specified in theapplication configuration file instead of a named subsystem. This should only be usedin conjunction with the Siebel Mobile and Dedicated Web clients, and not the SiebelServer. The parameters are:[JAVA]

DLL = D:\Program Files\Java\j2re1.4.2_12\bin\client\jvm.dll

CLASSPATH = F:\sea78\siebsrvr\CLASSES\Siebel.jar;F:\sea78\siebsrvr\CLASSES\SiebelJI_enu.jar;F:\sea78\siebsrvr\CLASSES\DCSImpExp.jar;.

VMOPTIONS = -Xrs -Djava.compiler=NONE

Note: Make sure that all the Siebel Java classes and DCSImpExp.jar exists in theClasspath mentioned above.

For more information on Java Business Service, refer to the Siebel eBusiness ApplicationIntegration Volume III guide.

Setting up Symbolic URL

Log into the Siebel Application using the compiled SRF file:

1. Navigate to Site Map>Administration - Integration>WI Symbolic URL List.



2. From the dropdown choose Symbolic URL Administration.

3. Click New to create a new record with the following values:

Table 2-1. DCSAttachPath

Symbolic URL Administration Value

Name DCSAttachPath

URL http://localhost:port/webtop/component/dcsobjectlist

For example:

http://10.104.13.131:8080/webtop/component/dcsobjectlist

SSO Disposition IFrame

4. Click New again to create a new record with the following values:

Table 2-2. DCSContentPortal

Symbolic URL Administration Value

Name DCSContentPortal

URL http://localhost:port/webtop/component/dcsmain

For example:

http://10.104.13.131:8080/webtop/component/dcsmain

SSO Disposition IFrame

5. After creating Symbolic URL, you need to pass the Symbolic URL Arguments. Topass the arguments, select the DCSAttachPath. Click New to create new recordswith the following values:



Table 2-3. DctmLogin

Symbolic URL Arguments Value

Name DctmLogin

Required Argument None

Argument Type Profile Attribute

Argument Value DctmLogin

Table 2-4. DctmPassword


Name DctmPassword





Argument Value DctmPassword

Table 2-5. DctmDocbase


Name DctmDocbase



Argument Value DctmDocbase

Table 2-6. DctmDomain


Name DctmDomain



Argument Value DctmDomain

Table 2-7. SessId


Name SessId



Argument Value SessId

Table 2-8. DctmCab


Name DctmCab





Argument Value DctmCab

Table 2-9. DctmFold


Name DctmFold



Argument Value DctmFold

Table 2-10. DctmSubFold


Name DctmSubFold



Argument Value DctmSubFold

Table 2-11. dcsHTTPMeth


Name dcsHTTPMeth


Argument Type Command

Argument Value PostRequest

Table 2-12. DctmSymiFrame


Name DctmSymiFrame





Argument Value IFrame Height=400 Width=1100Align=center

Table 2-13. DctmSymURL


Name DctmSymURL



Argument Value NoFormFixup

Note: Check the Append as Argument field for all the arguments to append it as anargument to a Symbolic URL.

Enter the sequence number in the Sequence # field in ascending order starting fromthe first argument to append these arguments in a sequence.

6. After passing the Symbolic URL arguments for DCSAttachPath, select theDCSContentPortal. Click New to create new records with the following values:



Table 2-14. DctmLogin


Name DctmLogin



Argument Value DctmLogin

Table 2-15. DctmPassword


Name DctmPassword





Argument Value DctmPassword

Table 2-16. DctmDocbase


Name DctmDocbase



Argument Value DctmDocbase

Table 2-17. DctmDomain


Name DctmDomain



Argument Value DctmDomain

Table 2-18. dcsHTTPMeth


Name dcsHTTPMeth



Argument Value PostRequest

Note: Check the Append as Argument field for all the arguments to append it as anargument to a Symbolic URL.

Enter the sequence number in the Sequence # field in ascending order starting fromthe first argument to append these arguments in a sequence.

For more information on Symbolic URLs and Arguments, refer to the Siebel PortalFrame work Guide.



Setting up environment variables

The following environment variables need to be set:

DcsAppServer — URL of the Application Server.

DCS_SIEBEL_PATH— Temporary file path for Import and export of a file.

To set these environment variables:

1. Right-click theMy Computer icon at Desktop and click Properties.

2. The System Properties dialog box is displayed. Click the Advanced tab.

3. Click the Environment Variables button in the second frame.

4. The Environment Variables dialog box is displayed. Click New in the user variablesframe.

5. For setting DcsAppServer:In the Variable Name field, enter DcsAppServer.In the Variable Value field, enter http://localhost:port/webtop/component/dcsobjectlist.For example: http://10.104.13.131:8080/webtop/component/dcsobjectlist

Note: The value entered in the Variable Value field should be similar to the URLentered in the DCSAttachPath of Symbolic URL. For more information, refer Settingup Symbolic URL, page 26.

6. For setting DCS_SIEBEL_PATH:In the Variable Name field, enter DCS_SIEBEL_PATH.In the Variable Value field, enter the temporary file path of your local system usedfor importing or exporting a file.For example: C:\DCS\...

7. Click OK.


Chapter 3Business Services in DCS

The Business Services help in handling the application logic in DCS. The Business Services getenabled when the user tries to access any required functionality. The Business Services also help inproviding the required objects to perform the following actions:

• Creating Documentum users• Creating user logon IDs for Documentum and Siebel• Adding files to Siebel• Adding files to Documentum• Displaying cabinets in the Documentum applet• Connecting or Disconnecting in SiebelBusiness Services available in DCS are:

• DCS Change Employee Password: To change the Documentum password which gets mapped tothe Siebel user or Siebel employee

• DCS ExpJB Service: To export the files from Siebel to Documentum• DCS Export Siebel : To invoke the DCS ExpJB Service• DCS Gen UniqueID: To maintain the session for the Documentum users.• DCS Get Current Folder: To provides access to the current folders while saving a document• DCS Get Sieb File: To access Siebel files and copies the same to the Documentum Server• DCS ImpJB Service: To import the files from Documentum to Siebel• DCS Import Siebel: To invoke the DCS ImpJB Service• DCS Initialize WebApp: To invoke the manual initialization method

Note: From Siebel 7.5.2.200 onwards, a new feature has been added for executing business servicesfrom the browser script. As a result, all the business service names listed above have to be declared inthe CFG file. For more details visit the Siebel Support site.

Some users may find that Internet Explorer for Windows crashes when they try to access theInbox screen in DCS. If that happens, include the following in the CFG file to avoid crashing:OverrideWindowsControls0 = Documentum Inbox Applet. For more details visit the SiebelSupport site.




Documents

Documentum Client for Siebel Implementer Guide · Siebel7.xToolsProcedures 5. ExpandtheAppletsobjectandnotethemodifications.Twotypesofappletsare beingmodified,attachmentappletsandformapplets.TheSIFfilesaddstheServer