Bookshelf Home | Contents | Index | PDF     

Siebel Collaboration Guide > Configuring Siebel Collaboration >

Extending Siebel Collaboration for Additional Siebel Objects

In the preconfigured Siebel application, Siebel Collaboration is enabled for the Opportunity and the Service Request objects. You can configure other Siebel objects to be enabled for Siebel Collaboration.

The final result is:

  • A new Collaboration business object which contains two business components.

    The primary business component represents the Siebel object that you want to configure (for example, Account). The second component is the team space business component. This represents the Siebel users who automatically become members of a new team space.

    NOTE:  You can omit this business component. Without this business component, the team space owner is the only Siebel user automatically made a member of the team space. The owner then invites the other members.

  • A new view and applet setup to display the team space within the Siebel application.
  • On the SharePoint side, an updated config.xml file and a new XSL file configured to include the new object.

Object Requirements

Only business objects that meet these requirements can be enabled for Siebel Collaboration:

  • The primary business component must use the class CSSBCBase or a class derived from CSSBCBase
  • The applet used must:
    • Be a list applet
    • Use the class CSSFrameList or a class derived from the CSSFrameList class

Two Part Task

This task is a step inProcess of Configuring Siebel Collaboration. It involves two procedures:

Extending Siebel Collaboration in Siebel Tools

This procedure outlines the steps you carry out in Siebel Tools. Throughout this procedure, the example is enabling accounts for Siebel Collaboration.

TIP:   Review the Opportunity or Service Request configuration, and use it as a guide as you extend Siebel Collaboration for other objects.

To extend Siebel Collaboration to other Siebel objects: Siebel Tools part

  1. Identify the business component and the applet that you want to configure, making sure that the preceding requirements are met.

    For example, the Account business component is based on the CSSBCBase class and the Account List Applet is based on the CSSFrameList class.

  2. Add these three fields to the primary business component.
    Name
    Calculated
    Calculated Value
    Comments

    TeamspaceExistenceState

    TRUE

    TeamspaceNone

    This calculated field has possible values of TeamspaceActive, TeamspaceInactive, TeamspaceNone, and TeamspaceActiveNew.

    TeamspaceSymbolicURL

    TRUE

    "Collaboration Teamspace"

    This calculated field indicates the symbolic URL for the team space.

    TeamspaceObjectType

    TRUE

    "Abbreviation of Object Type"

    For example, "Acc"

    This text is added to the team space's URL to indicate what kind of object the team space is based on. This text should be the same as the SitePrefix you enter in Step 2.
  3. Add these three user properties to the primary business component:
    User Property Name
    Value
    Comments

    CollaborationField:Description

    A description field

    For example, Description

    This field indicates the business component field that provides the description for the site.

    CollaborationField:Owner

    A user login field

    For example, Primary Employee Login

    This field indicates the business component field representing owner for the team space.

    CollaborationField:Title

    Object name

    For example, Name

    This field indicates the business component field that provides the title for the team space.
  4. Configure the list applet (for example, the Account List Applet) by adding the column that displays the team space icon and the buttons for Collaborate and Create Team Space:
    1. Add the following column to the list applet.
      Attribute
      Value

      Name

      TeamspaceExistenceState

      Field

      TeamspaceExistenceState

      Available

      TRUE

      Display Name

      Team Space

      Display Name - String Reference

      SBL_COLLABORATION_TEAM_SPACE_HOR

      HTML Display Mode

      EncodeData

      HTML Icon Map

      TeamspaceState

      HTML List Edit

      TRUE

      HTML Row Sensitive

      TRUE

      HTML Type

      ImageButton

      Read Only

      TRUE

      Text Alignment

      Left

      Show in List

      TRUE

      Width

      20

      Text Alignment-Label

      Right
    2. Add this column to the list applet's Edit List template.
    3. Add the following two controls to the list applet:
      Attribute
      Value for Control 1
      Value for Control 2

      Name

      CreateTeamSpace

      Collaborate

      Caption

      Create Team Space

      Collaborate

      Caption - String Reference

      SBL_COLLABORATION_CREATE_TEAM_SPACE_HOR

      SBL_COLLABORATE-1004224858-039

      Height

      10

      10

      HTML Display Mode

      DontEncodeData

      DontEncodeData

      HTML Only

      TRUE

      TRUE

      HTML Type

      MiniButton

      MiniButton

      Method Invoked

      CreateTeamSpace

      Collaboration

      Text Alignment

      Left

      Left

      Visible

      TRUE

      TRUE
    4. Add the two controls to the toolbar on the list applet's Edit List template.
    5. Add following applet user properties to the list applet.
      User Property Name
      Value
      Comments

      CollaborationView

      Object Teamspace View

      For example, Account Teamspace View

      This is the view used for collaboration. See Step 8.

      CollaborationApplet

      Object Teamspace Applet

      For example, Account Teamspace Applet

      This is the applet used to support the symbolic URL for the team space. See Step 6.

  5. (Optional) If you want to have some users (in addition to the team space's owner) automatically become members of newly created team space, then create the Teamspace Members business component as follows:
    1. Identify which users you want to have added as members when a team space is created.
    2. Create a business component that represents these users and name it Object Teamspace Members.

      Make sure that your business component contains these fields:

      Field
      Comments

      Login

      The LOGIN column from the S_USER table, representing the users who are to be added as team space members.

      Object Id

      The row ID of the primary business component (the object for which the team space is being created).

      For example, create a business component called Account Teamspace Members that represents the account team.

    3. Create a link between the new Object Teamspace Members business component and your primary business component.

      For example, create a link between the Account Teamspace Members business component and the Account business component as follows:

      Attribute Name
      Value

      Name

      Account/Account Teamspace Members

      Parent Business Component

      Account

      Child Business Component

      Account Teamspace Members

      Source Field

      Leave blank

      Destination Field

      Object Id

      Cascade Delete

      None
  6. Create the applet to display the team space:
    1. Copy the Service Request Teamspace Applet and rename it Object Teamspace Applet (for example, Account Teamspace Applet).
    2. Change the Business Component property from Service Request to Object (for example, Account).
  7. Create and configure the Collaboration business object:
    1. Create a new business object and name it Collaboration Object, for example, Collaboration Account.
    2. Add the primary business component, for example Account. Make sure to indicate that this is the primary business component for the object.
    3. (Optional) Add the Teamspace Members business component, for example Account Teamspace Members.
  8. Create and configure the collaboration view; this is the view that will contain the Teamspace Applet that you created in Step 6:
    1. Copy the Service Request Teamspace View and rename it Object Teamspace View, for example Account Teamspace View.
    2. Change its Business Object property from Service Request to Object, for example, Account.
    3. Change the properties for the view web template item as follows:
      Attribute
      Value

      Name

      Object Teamspace Applet

      For example, Account Teamspace Applet

      Applet

      Object Teamspace Applet
    4. change the Visibility Applet attribute for the view to Object Teamspace Applet, for example Account Teamspace Applet.
    5. Add the Object Teamspace View in the required screen as an Aggregate View type with an appropriate sequence number; set Display In Page and Display In Site Map to FALSE.

      (Do not specify any labels or parent category.)

    6. Add this view to the appropriate responsibilities.
Related Topic

Configuring Membership Lists for Team Spaces

SharePoint Procedure

Complete the steps in the following procedure to edit the config.xml file, XSL file in the SharePoint Portal Server, and registry to accommodate a new object. Throughout this procedure, the example enables accounts for Siebel Collaboration.

TIP:   Review the Opportunity or Service Request configuration, and use it as a guide as you extend Siebel Collaboration for other objects.

To extend Siebel Collaboration to other Siebel objects: SharePoint part

  1. Open the file config.xml in the Siebel-SharePoint Integration\config directory.

    For example, C:\Siebel\SharePointIntegration\config\config.xml

  2. Add a new ObjectType element the ObjectTypes element to describe your new object. Make sure that you:
    • Create a field element for each of the data fields that you want to display in the Siebel Web Part.
    • Set the SitePrefix to the same text that you entered for TeamspaceObjectType in Step 2.

      TIP:   Copy and edit one of the existing ObjectType elements in the file.

      For example, an ObjectType for accounts:

    <ObjectType
    Type="Account"
    SitePrefix="Acc"
    SiteTemplate="SIEBEL#0"
    ActiveNewDays="0"
    ActiveDays="30"
    UserRole="Contributor">

    <Name>
    <LocaleText lcid="1033" text="Account"/>
    </Name>

    <SiteGroup Role="Contributor">
    <LocaleText lcid="1033" text="Siebel Users"/>
    </SiteGroup>

    <Fields>
    <Field name="Id">
    <LocaleText lcid="1033" text="Account #'"/>
    </Field>
    <Field name="Name">
    <LocaleText lcid="1033" text="Name"/>
    </Field>
    <Field name="Type">
    <LocaleText lcid="1033" text="Type"/>
    </Field>
    <Field name="Account Status">
    <LocaleText lcid="1033" text="Account Status"/>
    </Field>
    <Field name="Description">
    <LocaleText lcid="1033" text="Description"/>
    </Field>
    </Fields>
    </ObjectType>

  3. Create a new XSL file for the object:
    1. Copy the SiebelSR.xsl file and rename it SiebelObject.xsl, for example, SiebelAccount.xsl.

      Locate the SiebelSR.xsl file in the Siebel-SharePoint Integration\config directory. (For example, C:\Siebel\SharePointIntegration\config\SiebelSR.xsl)

    2. Modify the <xsl:template match="/SiebelCollaboration/FieldList" > section of the new XSL file to reference the data fields that you added in Step 2.

      For example, a template for accounts looks like this:

    <xsl:template match="/SiebelCollaboration/FieldList" >
    <xsl:apply-templates select="Field[@Name='Id']" />
    <xsl:apply-templates select="Field[@Name='Name']" />
    <xsl:apply-templates select="Field[@Name='Type']" />
    <xsl:apply-templates select="Field[@Name='Account Status']" />
    <xsl:apply-templates select="Field[@Name='Description']" />
    </xsl:template>

    NOTE:  The @Name value is the name of the field used by the business component.

  4. Create and run a registry entry to specify the location of the new SiebelObject.xsl file:
    1. Create a new string type registry entry file.

      TIP:   Copy and edit the WebParts.reg (in the Siebel-SharePoint Integration directory\config directory).

      The registry entry must be named ObjectType XSL File, where ObjectType is the Type attribute in the ObjectType element of the config.xml file.

      For example, for accounts, the registry entry looks like this:

    [HKEY_LOCAL_MACHINE\SOFTWARE\Siebel Systems, Inc.\Collaboration\Sharepoint]
    "Account XSL File"="C:\\Siebel\SharePointIntegration\\config\\SiebelAccount.xsl"

    1. Execute the registry file.
Related Topics

Configuring the Siebel Web Part for Team Spaces

Configuring the Collaboration Service

  
Siebel Collaboration Guide Copyright © 2006, Oracle. All rights reserved.