Skip to content

Creating Component Interfaces Manually

This section describes the procedure of creating basic structure of a Component Interface (CI).

Important

  • The screenshots used in this section, are of PeopleSoft Direct managed target system (PeopleTool 8.56, 8.55, 8.54, 8.53) and are subject to change without prior notice. Please refer to PeopleSoft Direct's documentation.
  • Ensure to create Component Interface (CI) on the Java 11 version supported by SailPoint.

Basic Structure of Component Interface (CI) from USERMAINT Component for Users

Creating a Component Interface

You must create the basic structure of component interface (CI) from the USERMAINT component.

To create a component interface from the USERMAINT component, complete the following:

  1. Log in to the Application Designer and go to File > New.

    The New Definition dialog box is displayed.

  2. Select Component Interface > OK.

    The Select Source Component for Component Interface dialog box is displayed.

  3. In the Selection Criteria tab, enter the name as USERMAINT and then select the Select button.

    The following message is displayed: Do you want to default the properties based on the underlying component definition?

  4. Select Yes.

    The following screen is displayed:

    Screenshot

    Component Interface Interface

  5. Select File > Save As.

    A dialog box is displayed with a request for the name of the CI.

  6. Enter the name of the CI as {New_Name}. For example, SAILPOINT_USERS.

  7. Drag the Scroll-Level 1 Primary Record: PSUSERMAIL from the source component (USERMAINT) to the PROPERTIES of the new created CI {New_Name}.

    After dragging and dropping the Scroll-Level 1 Primary Record: PSUSERMAIL attribute, a new property is listed in the properties of the new created CI.

    Screenshot

    Component Interface Properties

  8. Drag the Scroll-Level 2 Primary Record: RTE_CNTL_USERVW from the source component (USERMAINT) to the PROPERTIES of the newly created CI.

    After dragging and dropping the Scroll-Level 2 Primary Record: RTE CNTL_USERVW attribute, a new property is listed in the properties of the newly created CI. Rename this property to RolesAndRouteControls.

    Screenshot

    Component Interface Roles Routes

Changing GETKEYS, FINDKEYS, and CREATEKEYS for the Newly Created CI

To change GETKEYS, FINDKEYS, and CREATEKEYS, complete the following:

  1. In the Attribute window, expand FINDKEYS.

    Screenshot

    Component Interface Findkeys

  2. Right-click OPRID and select Edit Name.

  3. Update the name to UserID.
  4. Right-click OPRDEFNDESC and select Edit Name.
  5. Update the name to UserDescription.
  6. Expand GETKEYS.
  7. Right-click OPRID and select Edit Name.
  8. Update name to UserID.
  9. Expand CREATEKEYS.
  10. Right-click OPRID and select Edit Name.
  11. Update name to UserID.

Changing PROPERTIES for the Newly Created CI

To change the PROPERTIES, complete the following:

  1. Expand PROPERTIES.
  2. Delete the SERVERNAME collection.

  3. Right-click each attribute and select Edit Name. Update each attribute with the following:

    Original Attribute Name New Attribute Name
    OPRID UserID
    OPRDEFNDESK UserDescription
    OPRCLASS PrimaryPermissionList
    ROWSECCLASS RowSecurityPermissionList
    OPERPSWD Password
    SYMBOLICID SymbolicID
    LANGUAGE_CD LanguageCode
    CURRENCY_CD CurrencyCode
    ACCTLOCK AccountLocked
    PRCSPRFLCLS ProcessProfilePermissionList
    DEFAULTNAVHP NavigatorHomePermissionList
    EXPENT ExpertEntry
    USERIDALIAS UserIDAlias
    LASTUPDDTTM LastUpdateDateTime
    PTALLOWSWITCHUSER AllowSwitchUser
    OPERPSWDCONF ConfirmPassword
    TOTAL_ROW_COUNT WorkListEntriesCount
    ROLEUSER_REASSIGN ReassignUserID
    ROLEUSER_ASSIGN_SW ReassignWork
    NO_SYMBID_WARN NoSymbolicIDWarning
    PSWDEXPIRED PasswordExpired
    MPDEFAULTMP DefaultMobilePage
    WORKLIST_USER_SW WorkListUser
    EMAIL_USER_SW EmailUser
    LASTUPDOPRID LastUpdateUserID
    ROLEUSER_ALT AlternateUserID
    ROLEUSER_SUPR SupervisingUserID
    EFFDT_FROM EffectiveDateFrom
    EFFDT_TO EffectiveDateto
    CHANGE_PWD_BTN ChangePassword

    Note

    • Use the PTPSWDCLEARTXTINPT field when using PeopleTools version 8.60.05 for OPERPSWD.
    • Use the PTPSWDCLEARTXTCONF field when using PeopleTools version 8.60.05 for OPERPSWDCONF.
    • The CHANGE_PWD_BTN attribute is only applicable to PeopleTools version 8.55 and later.

Changing Collection Attributes

Some attributes when expanded, have other attributes under them. These attributes are called collection attributes.

Screenshot

Collection Attribute Example

To change the collection attribute, complete the following:

  1. Update the following collection attributes by right-click the attribute and selecting Edit Name:

    Original Collection Attribute Name New Collection Attribute Name Original Child Attribute Name New Child Attribute Name
    PSUSEREMAIL EmailAddresses EMAILID EmailAddress
    PSUSEREMAIL EmailAddresses EMAILTYPE EmailType
    PSUSEREMAIL EmailAddresses PRIMARY_EMAIL PrimaryEmail
    PSUSEREMAIL EmailAddresses OPRID OPRID
    PSOPRALIAS IDTypes OPRALIASTYPE IDType
    PSOPRALIAS IDTypes PSOPRALIASFIELD Attributes
    PSOPRALIAS IDTypes ATTRNAME AttributeName
    PSOPRALIAS IDTypes ATTRVALUE AttributeValue
    PSOPRALIAS IDTypes DESCR DESCR
    PSROLEUSER_VW Roles DYNAMIC_SW Dynamic
    PSROLEUSER_VW Roles ROLENAME_1 RoleName_1

  2. Delete the following attributes:

    • PSOPTIONS
    • RUN_CNTLLDAP
    • PSUSEROTHER_VW

Basic Structure of Component Interface (CI) from ROLEMAINT Component for Roles

Creating a Component Interface

You must create the basic structure of component interface (CI) from the ROLEMAINT component.

To create a component interface from the ROLEMAINT component, complete the following:

  1. Log into the Application Designer and go to File > New.

    The New Definition dialog box is displayed.

  2. Select Component Interface > OK.

    The Select Source Component for Component Interface dialog box is displayed.

  3. In the Selection Criteria tab, enter the name as ROLEMAINT and then select the Select button.

    The following message is displayed: Do you want to default the properties based on the underlying component definition?

  4. Select Yes.

    The following screen is displayed:

    Screenshot

    Component Interface ROLEMAINT

  5. Select File > Save As.

    A dialog box is displayed with a request for the name of the CI.

  6. Enter the name of the CI as {New_Name}. For example, SAILPOINT_ROLES.

  7. Delete the following collective attributes:

    • PSOPTIONS
    • RUN_CNTLLDAP

  8. Verify the standard methods are selected for the newly created component interface. For more information, see Verification of the Standard Methods for Newly Created CI.

  9. To copy the description for the Role in SailPoint, you must drag the following components into the new CI.

    Screenshot

    Component Interface Role Transfer

Basic Structure of Component Interface (CI) from RTE_CNTL_PROFILE Component for Users

Creating a Component Interface

You must create the basic structure of component interface (CI) from the RTE_CNTL_PROFILE component.

To create a component interface from the RTE_CNTL_PROFILE component, complete the following:

  1. Log into the Application Designer and go to File > New.

    The New Definition dialog box is displayed.

  2. Select Component Interface > OK.

    The Select Source Component for Component Interface dialog box is displayed.

  3. In the Selection Criteria tab, enter the name as RTE_CNTL_PROFILE and then select the Select button.

    The following message is displayed: Do you want to default the properties based on the underlying component definition?

  4. Select Yes.

    The following screen is displayed:

    Screenshot

    Component Interface RTE

  5. Select File > Save As.

    A dialog box is displayed with a request for the name of the CI.

  6. Enter the name of the CI as {New_Name}. For example, SAILPOINT_ROUTECONTROL.

    Screenshot

    Component Interface RTE Rename

  7. Drag the Scroll-Level 0: DESCRLONG (Record Field) from the source component (SAILPOINT_RTE_CNTL_PRF_CI) to the PROPERTIES of the new created CI {New_Name}.

    After dragging and dropping the Scroll-Level 1 Primary Record: PSUSERMAIL attribute, a new property is listed in the properties of the new created CI.

    Screenshot

    Component Interface RTE DescrLong

Changing GETKEYS, FINDKEYS, and CREATEKEYS for the Newly Created CI

To change GETKEYS, FINDKEYS, and CREATEKEYS, complete the following:

  1. In the Attribute window, expand FINDKEYS.

    Screenshot

    Component Interface RTE Get Keys

  2. Right-click RTE_CNTL_PROFILE and select Edit Name.

  3. Update the name to RouteControl.
  4. Right-click DESCRLONG and select Edit Name.
  5. Update the name to RouteControlDescription.
  6. Expand GETKEYS.
  7. Right-click RTE_CNTL_PROFILE and select Edit Name.
  8. Update the name to RouteControl.
  9. Expand CREATEKEYS.
  10. Right-click RTE_CNTL_PROFILE and select Edit Name.
  11. Update the name to RouteControl.

Changing PROPERTIES for the Newly Created CI

To change the PROPERTIES, complete the following:

  1. Expand PROPERTIES.
  2. Delete the RTE_CNTL_HDR collection.

  3. Right-click each attribute and select Edit Name. Update each attribute with the following:

    Key Original Attribute Name New Attribute Name
    GETKEYS RTE_CNTL_PROFILE RouteControl
    FINDKEYS RTE_CNTL_PROFILE RouteControl
    CREATEKEYS RTE_CNTL_PROFILE RouteControl
    PROPERTIES RTE_CNTL_PROFILE RouteControl

Verification of the Standard Methods for Newly Created CI

You can use the verification methods for CIs that have been created from the USERMAINT and ROLEMAINT components.

To verify the new CI, complete the following:

  1. Right-click and on the name of the CI, and go to Component Interface Properties > Standard Methods.

    Screenshot

    Component Interface Properties Menu

  2. On the Standard Methods tab, verify all of the properties (Cancel, Create, Find, Get, and Save) are selected.

    Screenshot

    Component Interface Standard Method

  3. The new CI is ready for use.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.