Chapter 41 Siebel CRM

The Siebel CRM resource adapter is defined in the com.waveset.adapter.SiebelCRMResourceAdapter class.

Adapter Details

Identity Manager Installation Notes

The Siebel CRM resource adapter is a custom adapter. You must perform the following steps to complete the installation process:

Installing the Siebel CRM Resource Adapter

1. To add the Siebel CRM resource to the resources list, you must add the following value in the Custom Resources section of the Configure Managed Resources page.

   com.waveset.adapter.SiebelCRMResourceAdapter

2. Copy the appropriate JAR files to the InstallDir\idm\WEB-INF\lib directory, as listed in the following table.

   The JAR file versions must match the version of the Siebel CRM resource:

   Siebel 7.0	Siebel 7.7, 7.8, 8.0
   SiebelJI_Common.jar SiebelJI_enu.jar SiebelJI.jar	Siebel.jar SiebelJI_enu.jar

   ---

   Note –

   Do not copy the JAR files for multiple versions of Siebel into the InstallDir\idm\WEB-INF\lib directory. You might encounter conflicts between versions.

   ---

Resource Configuration Notes

None

Usage Notes

Choosing Business Objects and Components

By default, the Siebel CRM adapter uses the Employee Siebel business component of the Employee Siebel business object for account provisioning. However, you can configure the adapter to use any Siebel business component of any Siebel business object for account provisioning.

• To use a different business object, set the Account Business Object resource parameter appropriately.

• To use a different business component, set the Account Business Component resource parameter to the name of the preferred business component.

---

Note –

You must specify the business component within the specified business object.

---

You can use the Siebel Tools Client to inspect your business component and to verify which attributes are available for provisioning. The default schema map has some common attributes that are useful for the default Employee business component.

You may have to add, remove, or change attributes to manage your Siebel environment– especially if you have configured the adapter to use a business object or business component other than the default.

The following steps are a basic guide to discovering which attributes Identity Manager can provision to your Siebel environment using the Siebel Tools client:

Identifying Attributes for Provisioning to a Siebel Environment

1. Open the Siebel Tools’ Object Explorer.

2. Click the Business Component icon.

3. Scroll down or create a query to select the desired business component.

4. Select Fields within the Object Explorer.

   A list of fields available to the bus-iness component should display.

   The field Name column values shown in the Object Explorer are typically used for the right-hand side (or the Resource User Attribute), within the schema map of your configured Siebel CRM resource.

   In general, you can manage any of these fields to some degree. However, if you want to manage a multi-valued field or a pick-list field, you must specify a different format for the right-hand side of the schema map, as follows:

   • For a multi-valued field: The right-hand side must use the field@@keyAttr format, where:

     • field represents the name of the multi-valued field

     • keyAttr represents the name of a field within the associated multi-valued business component used to uniquely identify each member of the multi-valued list.

       For example: Position@@Name

     For a pick list field: The right-hand side must use the field!!keyAttr format, where:

     • field represents the name of the pick list field

     • keyAttr represents the name of a field within the associated pick-list business component used to uniquely identify a member of the pick list.

       For example: Employee Organization!!Name

Managing Primary Values in Multi-Value Groups

The adapter performs the following actions when a multi-value group (MVG) already contains a single member that is designated as primary:

• If the incoming MVG contains a single value that is different than the value currently defined in Identity Manager, then the new value will be inserted and marked as the primary. The previous value is then removed from Identity Manager.

• If other non-primary values have been added, by default, the primary value will remain unchanged.

If there are currently multiple values in an MVG with one of the values marked as the primary:

• If any non-primary values are deleted from the set, the current primary will remain as the primary.

• If the MVG value set is replaced with a new single value, then the new single value will be inserted and marked as the primary. All previous values are then removed.

• If other non-primary values have been added, by default, the primary value will remain unchanged.

To move a primary marker from an existing value to a new value when multiple values exist, you must add an account attribute to the schema map. The name of this attribute must be in the form “Primary MVG_Name”, where MVG_Name is a value such as Employee Organization Id or Position. Therefore, the attribute will have a name such as Primary Employee Organization Id or Primary Position. Then, in the user form, set the Primary attribute to the desired value.

Advanced Navigation

The advanced navigation feature of the Siebel CRM adapter allows you to create and update child business components. This is an advanced feature that is not typically implemented in Identity Manager.

The advanced navigation feature allows you to optionally specify the following information needed to create and update child business components:

• business object name

• parent business component name

• parent search attribute

• target business component

• target search attribute

• in scope attributes (which attributes of the business component should be set/updated)

• optional co-action

An advanced navigation rule can be used during create and update actions. It cannot be used for other types of actions.

To implement the advanced navigation feature of the Siebel CRM adapter, you must perform the following tasks:

• Add an attribute to the schema map in which the Resource User Attribute (right hand side) is named PARENT_COMP_ID.

• Use the debug page to manually add the following ResourceAttribute to your resource’s XML

  <ResourceAttribute name=’AdvancedNavRule’
      displayName=’Advanced Nav Rule’
      value=’MY_SIEBEL_NAV_RULE’>
  </ResourceAttribute>

  Replace MY_SIEBEL_NAV_RULE with a valid rule name.

• Write the advanced navigation rule. The rule should expect two variables to be present:

  resource.action. The value must be either create or update.

  resource.objectType. For normal account maintenance, this value will be account.

  The rule must return a map with one or more of the following name/value pairs:

Attribute	Definition
busObj	The name of the business object.
parentBusComp	The name of the parent business component for busObj. The context of the business object is updated by moving to the first qualified (see parentSearchAttr) record of this business component
parentSearchAttr	The attribute to use as the search field in the parentBusComp. The value to search for is expected to be present as the value for the attribute whose Resource User Attribute name is PARENT_COMP_ID.
busComp	The name of final business component to create or update. If creating, then a new record of this business component will be created in the business object. If updating, then the business component record to update is selected by moving to the first qualified (see searchAttr) record of this business component.
searchAttr	The attribute to use as the search field in the busComp. The value to search for is the user’s account ID.
attributes	A list of strings that specifies the set of fields in the busComp that will be set or updated. This list overrides the attributes defined in the resource’s schema map for the action being performed.
coAction	If the requested action (resource.action) is create, then specify a coAction value of update to instruct the adapter to also perform an update immediately following the create. This may be necessary if the create cannot set all the necessary fields, and therefore an update must also occur to logically complete the create. This attribute will be ignored unless resource.action is create and coAction is set to update.

An example navigation rule is provided in $WSHOME/sample/rules/SiebelNavigationRule.xml.

Provisioning Notes

The following table summarizes the provisioning capabilities of this adapter.

Feature	Supported?
Enable/disable account	No
Rename account	Yes
Create account	Yes
Update account	Yes
Delete account	Yes
Pass-through authentication	Yes
Before/after actions	No
Data loading methods	Import directly from resource Reconciliation

Account Attributes

The default schema map assumes that the Employee business object and Employee business component are configured. You might have to add, remove, or change attributes to manage your Siebel environment– especially if you have configured the adapter to use a business object or business component other than the default.

Identity System User Attribute	Resource User Attribute	Description
accountId	Login Name	User’s login name
firstname	First Name	User’s first name
lastname	Last Name	User’s last name
Responsibility	Responsibility@@Name	Multi-value attribute that contains a list of responsibilities you want to assign to the employee. You must manage this attribute in the user form with a multi-select box.  The Responsibility field is set as a multi-select box in the sample Siebel CRM User Form.
Position	Position@@Name	Multi-value attribute that contains a list of positions you want to assign to the employee.  All assigned positions must exist in Siebel.  To assign a Primary Position, add the Primary Position attribute to your schema map and set the attribute to the name of the position you want to make primary.

Security Notes

This section provides information about supported connections and privilege requirements.

Supported Connections

Identity Manager can use HTTP or RSA to communicate with the Siebel CRM adapter. (See the Siebel user documentation for more information.)

Required Administrative Privileges

Ensure the administrator user name/password configured for the adapter is assigned sufficient privileges within Siebel to create new records and to update existing records for the specified business component.

Resource Object Management

By default, the Siebel CRM adapter supports the following Siebel objects:

Resource Object	Features Supported	Attributes Managed
Employee:Position	Create Update Delete Rename	Name Division Primary Employee Description

If necessary, you can manually configure the adapter to support additional resource object types by editing the resource prototype XML as follows:

Editing Resource Prototype XML

1. Add a new <ObjectType> element to the XML, following the default Employee:Position object type example.

2. Replace Employee with the name of the preferred Siebel business object.

3. Replace Position with the name of the preferred Siebel business component.

4. Verify that the embedded <ObjectAttributes> element has an idAttr attribute that names which <ObjectAttribute> will be used to uniquely identity each item in the business component.

Identify Template

The default identity template is $accountId$.

Sample Forms

The following sample forms are provided with this resource adapter:

Form	File
SiebelCRM User Form	sample/SiebelCRMUserForm.xml
SiebelCRM Create Employee:Position Form	sample/SiebelCRMpositioncreate.xml
SiebelCRM Update Employee:Position Form	sample/SiebelCRMpositionupdate.xml

Troubleshooting

Use the Identity Manager debug pages to set trace options on the following class:

com.waveset.adapter.SiebelCRMResourceAdapter

Additionally, you can set the following Identity Manager Active Sync logging parameters for the resource instance:

• Maximum Log Archives

• Maximum Active Log Age

• Maximum Log File Size

• Log File Path

• Log Level