Usage Notes

The PeopleSoft Component Interface adapter accomplishes user provisioning by invoking methods and setting properties on PeopleSoft component interfaces. Component interface definitions are assigned in the PeopleSoft Component Interface configuration object. This object can be modified through the debug pages or with the [Please define the IDMIDE text entity]. You can also edit a copy of the $WSHOME/sample/PeopleSoftComponentInterfaces.xml file and load that file into Identity Manager.

For more information about configuring and implementing component interfaces with this adapter, see the following sections:

• Component Interface Map Definitions

• Adding FIND Method Support to the USER_PROFILE Component Interface

• PeopleSoft Component Interface Resource Objects

Component Interface Map Definitions

The component interface map contains the list of component interfaces available to the adapter.

• interfaces object. Contains a list of component interfaces. If you have a custom component interface, you must define your own component interface definition in the map. Edit the PeopleSoft Component Interfaces Configuration object and add your definition as an additional Object into the <List> element under the <Attribute name=’interfaces’> element.

Each available component interface has its own definition. Key elements of a component interface definition include:

• name. The label of a component interface. It often matches the value of the componentInterface attribute, but this is not a requirement. The value will be displayed in the drop-down menu on the adapter’s Resource Parameters page.

• componentInterface attribute. The name of the component interface, as defined in PeopleSoft.

• getKey attribute. The name of the component interface property that is set when performing a PeopleSoft GET operation. If getKey is not defined, then the key attribute is used instead.

• findKey attribute. The name of the component interface property that is set when performing a PeopleSoft FIND operation. If findKey is not defined, then the key attribute is used instead.

• createKey attribute. The name of the component interface property that is set when performing a PeopleSoft CREATE operation. If createKey is not defined, then key attribute is used instead.

• key attribute. Deprecated. Use getKey, findKey, or createKey instead.

• properties attribute. A list of properties that can be read or set from the PeopleSoft component interface.

  Each Object in the properties list must have the following attribute:

  • name. The name of the property. This must match exactly with the name of a property exposed by the PeopleSoft component interface identified by the componentInterface property. The names of the properties are candidates to be listed as resource user attributes on the Account Attributes page.

    If this a collection property, then you must define additional attributes. A collection property defines its key property and its own nested set of simple and/or complex properties:

  • isCollection attribute. If the property is a collection, then set this to true.

  • key attribute. If the property is a collection, set this to the name of the property that uniquely identifies each item of the collection.

  • properties attribute. The list of properties that can be read/set for each item of the collection. To support arbitrary complexity, each member of this list is an Object with the same allowed attributes as the parent. That is, it can contain its own name, isCollection, key, and properties attributes.

  disableRule attribute. An Object that defines the logic to compute and set the user disable state. This attribute contains the following attributes

  • property attribute. The property to check. The value must be listed in the properties attribute for the componentInterface object.

  • trueValue attribute. A value that indicates the user is disabled.

  • falseValue attribute. A value that indicates the user is enabled.

  supportedObjectTypes attribute. A list of Identity Manager resource objects types that can be accessed through the adapter. Each object defines a set of features.

  • features attribute. A list supported features. Possible feature types include view, get, list, find, create, saveas, update, rename, and delete.

Default Component Interfaces Supported

The default Component Interface configuration object defines the following interfaces:

• USER_PROFILE. Performs create, read, and update actions.

• DELETE_USER_PROFILE. Deletes user accounts.

• ROLE_MAINT. Adds support for PeopleSoft roles.

USER_PROFILE Component Interface

The default USER_PROFLE component interface definition is used to perform create, read, and update actions. The key and findKey attributes are set to UserID, because the USER_PROFILE component interface assigns the UserID field for the GETKEYS and FINDKEYS keys.

The default definition for the USER_PROFILE component interface does not define all of the possible properties. It has been simplified to include those used in the sample user form. If you need to add more resource user attributes to the Account Attributes page, then the component interface definition must be updated first. A resource user attribute cannot be added to that page unless it is listed in the component interface definition.

Most properties are defined in USER_PROFILE are simple objects. However, the IDTypes and Roles objects are collections and can have multiple values. IDTypes contains a collection of its own, Attributes. These objects must include the isCollection attribute, the key name for the collection, and at least one property.

DELETE_USER_PROFILE Component Interface

The DELETE_USER_PROFILE component interface definition is used to delete user profile definitions. The OPRID key determines which user profile is to be deleted. Since the component interface does not have properties, none are listed in the definition.

ROLE_MAINT Component Interface

The ROLE_MAINT component interface definition is part of a sample implementation that illustrates how Identity Manager can be configured to list role resource objects. Other resource objects can be listed by following the general guidelines listed below and modifying the ROLE_MAINT example to match your requirements.

The PeopleSoft Component Interface adapter supports listing resource objects only. It does not support other object features, such as update, create, or delete.

The ROLE_MAINT component interface definition has the following characteristics of note:

• The findKey and getKey attributes are assigned to ROLENAME because ROLENAME is the primary key for FINDKEYS and GETKEYS.

• DESCR and ROLESTATUS are also keys in FINDKEYS, but since they are not primary keys, they are not listed as values for findKey. Instead, they are listed in the properties section.

• The supportedObjectTypes attribute defines the Role object. The Role object supports the find and get features.

Adding FIND Method Support to the USER_PROFILE Component Interface

The default USER_PROFILE component interface does not support the FIND method. However, the PeopleSoft Component Interface adapter requires the FIND method in order to support account iteration and list.

Use the following steps to add FIND method support to an existing USER_PROFILE component interface.

Adding FIND Method Support

1. Load the USER_PROFILE component interface in the PeopleSoft Application Designer.

2. On the left window (which shows the USERMAINT Component), select the OPRID field under the PSOPRDEFN_SRCH object.

   Drag this field over to the right window (which shows the USER_PROFILE CI).

   When you drop the field, a new key called FINDKEYS will be created in the USER_PROFILE CI. Under that key, there will be a sub-key called OPRID.

3. Right-click on the OPRID name under FINDKEYS, and select Edit Name. Change the name to UserID.

4. Right click on USER_PROFILE CI and select Component Interface Properties. Select the Standard Methods tab, then select the Find checkbox. Click OK to close the Component Interface Properties dialog.

5. Save your changes to the USER_PROFILE component interface.

   The Find method is now visible under the METHODS field for the component interface. To verify the functionality of the new FIND method, right-click on the component interface and select Test Component Interface.

   ---

   Note –

   A PeopleSoft administrator should grant Full Access to the Find method for the component interface (in addition to the Create, Get, Save, and SetPassword methods).

   ---

PeopleSoft Component Interface Resource Objects

The XML of a PeopleSoft Component Interface resource can be edited so that resource objects can be managed. Use the debug pages or [Please define the IDMIDE text entity] to add an ObjectType element.

For example, to add support for the Role resource object, add an ObjectType element similar to the following.

<ObjectTypes>
<ObjectType name=’Role’ icon=’role’>
   <ObjectFeatures>
      <ObjectFeature name=’find’/>
   </ObjectFeatures>
   <ObjectAttributes idAttr=’ROLENAME’ displayNameAttr=’ROLENAME’ descriptionAttr=’DESCR’>
      <ObjectAttribute name=’ROLENAME’ type=’string’/>
      <ObjectAttribute name=’DESCR’ type=’string’/>
      <ObjectAttribute name=’ROLESTATUS’ type=’string’/>
   </ObjectAttributes>
</ObjectType>
</ObjectTypes>

The ObjectType name (for example, Role) must match the name of one of the objects in the supportedObjectTypes list of exactly one component interface definition. Each ObjectFeature (for example, find) must have a corresponding feature in the features list in that same supportedObjectTypes. The matched component interface will be the one used to perform the resource feature. (If there are multiple matches, the first one found will be used.)

The following example is part of the component interface definition for the ROLE_MAINT component interface in the component interface map. Note that the Object name Role is found and that an item in the features list is named find.

<Attribute name=’supportedObjectTypes’ >
   <List>
      <Object name=’Role’>
         <Attribute name=’features’ >
            <List>
               <Object name=’find’ />
               <Object name=’get’ />
            </List>
         </Attribute>
      </Object>
   </List>
</Attribute>

User Form

The following user form fragment can be used to retrieve a list of PeopleSoft roles. Note that ROLENAME and DESCR attributes are being fetched.

<invoke name=’getResourceObjects’ class=’com.waveset.ui.FormUtil’>
   <ref>:display.session</ref>
   <s>Role</s>
   <s>PeopleSoft Component Interface</s>
   <map>
      <s>searchAttrsToGet</s>
      <list>
         <s>ROLENAME</s>
         <s>DESCR</s>
      </list>
    </map>
</invoke>