Working with PeopleSoft Directory Interface for PeopleSoft HCM

This chapter provides an overview of PeopleSoft Directory Interface for HCM customers. This chapter discusses how to:

• Load data for HCM.

• Use PeopleSoft Directory Interface with HCM.

Note. If you have also licensed PeopleSoft Campus Solutions, please refer to the PeopleSoft Campus Solutions Application Fundamentals PeopleBook, "Working with PeopleSoft Directory Interface for PeopleSoft Campus Solutions"

Understanding PeopleSoft Directory Interface

PeopleSoft Directory Interface enables you to share data that's maintained in your PeopleSoft HCM database with your Lightweight Directory Access Protocol (LDAP) directory, simplifying directory setup and maintenance.

See Also

PeopleSoft PeopleBook: Enterprise Components

Loading Directory Data Using the DSMAPINPUT FullSync Load Process

This section provides an overview of the directory load processes and discusses how to:

• Clean the temporary tables.

• Run the full data publish.

• Review transactions using the services operations monitor.

• Run the entry membership process.

Understanding the Directory Load Process

Once you have set up PeopleSoft Directory Interface you can load the data into the directory using the Directory Load process or the DSMAPINPUT FullSync Load process.

Use the DSMAPINPUT FullSync Load process to load only people and their job data. Use the Directory Load process when you are loading location and department entries in addition to person and job data.

Note. The Directory Load process sometimes experiences performance issues when loading a large volume of person data. To avoid these issues, use the DSMAPINPUT FullSync Load process.

Note. Both the DSMAPINPUT FullSync Load and the Directory Load processes overwrite any existing data in the directory.

Pages Used to Load the Directory Using the DSMAPINPUT FullSync Load Process

Cleaning the Temporary Tables

Run the Clean Temp Tables (DSMAPINPUT) process from the Directory Load page.

1. Specify the appropriate map name and click Run.

2. Select the DS_CLEANTEMP process from the list and click OK.

Note. Do not run the Directory Load (EO_DS_AUDIT) process at this time.

Running the Full Data Publish

The DSMAPINPUT service operation combines information from a person's job and personal data into one service operation. The DSMAPINPUT_FULLSYNC service operation is based on the DSMAPINPUT service operation structure and is defined within the DSMANCHNL service operation queue. The Full Data Publish utility uses the DSMAPINPUT_FULLSYNC service operation and loads multiple streams of emplID data into the directory.

The utility processes the first active map it finds in the Directory Map table. If several maps contain DSMAPINPUT as the message name, ensure that you activate the service operation for only the message that you want before running this process.

1. Access the Full Data Publish page.

2. Select a Process Frequency of Once.

3. In the Message Name field, enter DSMAPINPUT_FULLSYNC.

4. Specify a Request ID and description, save your changes and click Run.

5. Choose the Full Table Data Publish (EOP_PUBLISHT) process and click OK.

Review Transactions Using Service Operations Monitor

Monitor the message queue to determine the status of the DSMAPINPUT_FULLSYNC service operation within the DSMANCHNL service operation queue.

1. Access the Monitor Overview page of the Asynchronous Services component.

2. If the Started column has a number greater than zero, it means the message is still being processed. When the subscriptions are completed, the only column that will have a number greater than zero is the Done column.

See Also

PeopleTools PeopleBook: PeopleSoft Integration Broker

Run the Entry Membership Process

After verifying on the Monitor Overview page that all message subscriptions are complete, run the Entry Membership (DSMAPINPUT) process to load members into directory groups based on the Entry Membership Rules.

1. Access the Directory Load page.

2. Specify the appropriate map and click Run.

3. Choose the DS_ENTRY process and click OK.

Note. Do not run the Clean Temp Tables or the Directory Load (EO_DS_AUDIT) process at this time.

Auditing Directory Data Using the DSMAPINPUT FullSync Process

This section provides an overview of the directory auditing processes and discusses how to:

• Clean and load the temporary tables.

• Run full data publish for DSMAPINPUT_FULLSYNC_A.

• Review transactions using the Service Operations Monitor.

• Load directory group members and merge LDIF files.

Understanding the Directory Audit Process

Once you have loaded data into the directory and started processing transactions, you can regularly run the Directory Audit process or DSMAPINPUT FullSync Audit process to compare the data in the database to that in the directory.

Use the DSMAPINPUT FullSync Audit process to audit only people and their job data. Use the Directory Load process when you are auditing data that includes location and department entries in addition to person and job data.

Note. The Directory Audit process sometimes experiences performance issues when loading a auditing volume of person data. To avoid these issues, use the DSMAPINPUT FullSync Audit process.

Pages Used to Audit the Directory Using the DSMAPINPUT FullSync Audit Process

Cleaning and Loading the Temporary Tables

Run the Clean Temp and Load from Dir (EODS_CLEANLD) process from the Directory Audit page.

1. Specify the appropriate map name and click Run.

2. Select the EODS_CLEANLD process from the list and click OK.

Note. Do not run the Directory Load (EO_DS_AUDIT) process.

Running Full Data Publish for DSMAPINPUT_FULLSYNC_A

The DSMAPINPUT service operation combines information from a person's job and personal data into one service operation. The DSMAPINPUT_FULLSYNC_A is a FullSync service operation that is based on the DSMAPINPUT service operation structure and is defined within the DSMANCHNL service operation queue. The queue is partitioned on the emplID field to enable parallel processing. The Full Data Publish utility publishes the service operation. The subscription utility processes multiple streams of emplID data simultaneously. Each subscription produces a unique LDIF file containing LDAP commands for a range of people.

The utility processes the first active map it finds in the Directory Map table. If several maps contain DSMAPINPUT as the message name, ensure that you activate the service operation for only the message that you want before running this process.

1. Access the Full Data Publish page.

2. Select a Process Frequency of Once.

3. In the Message Name field, enter DSMAPINPUT_FULLSYNC_A.

4. Specify a Request ID and description, save your changes and click Run.

5. Choose the Full Table Data Publish (EOP_PUBLISHT) process and click OK.

Note. You can choose to use your own service operation instead of DSMAPINPUT_FULLSYNC_A but you must add FULLSYNC_A to the name of the service operation from the directory map. For example, if PERSMSG is a configured service operation specified on the map for person entries, name the service operation PERSMSG_FULLSYNC_A.

Review Transactions Using Service Operations Monitor

Monitor the service operation queue to determine the status of the DSMAPINPUT_FULLSYNC_A message within the DSMANCHNL service operation queue.

1. Access the Monitor Overview page.

2. If the Started column has a number greater than zero, it means the message is still being processed. When the subscriptions are completed, the only column that will have a number greater than zero is the Done column.

See Also

PeopleTools PeopleBook: PeopleSoft Integration Broker

Loading Directory Group Members and Merge LDIF Files

After verifying on the Monitor Overview page that all service operation subscriptions are complete, run the Entry Membership and LDIF Merge (EODS_LDIFMRG) process to load members into directory groups based on the Entry Membership Rules and to merge the contents of all the LDIF files that were generated during the full table publish. You can review the merged file later, modify the contents, and import them into the directory later.

To run the Entry Membership and LDIF Merge process:

1. Access the Directory Audit page.

2. Specify the appropriate map and click Run.

3. Choose the EODS_LDIFMRG process and click OK.

Note. Do not run the Clean Temp Tables or the Directory Load (EO_DS_AUDIT) process at this time.

Using PeopleSoft Directory Interface with HCM

This section discusses how to:

• Access sample mappings and delivered service operations.

• Use sample mappings.

• Review delivered service operations.

Accessing Sample Mappings and Delivered Service Operations

If you have licensed PeopleSoft Directory Interface for HCM, PeopleSoft provides you with sample mappings and service operations for HCM.

Using Sample Mappings

To use sample mappings that PeopleSoft delivers, establish directory IDs in the Directory Configurations component (PSDSSETUP) and add a directory ID to the mappings. The sample mappings use schema objects from a standard Novell eDirectory.

We developed the sample mappings assuming that you are using the tree structure illustrated below, which is HR_PERSONs reporting to HR_DEPARTMENT, the departments are associated to the HR_LOCATION, which report to the corporate level, or HR_COMPANY:

Sample Directory Interface tree

Note. PeopleSoft delivers HR_LOCATION, HR_DEPARTMENT, and HR_PERSON as sample mappings

Reviewing Delivered Service Operations

The following sections describe the delivered sample service operations and PeopleCode functions that are related to your directory mappings.

Directory Interface Service Operations

PeopleSoft Directory Interface delivers the following sample messages for mapping PeopleSoft data to the directory.

Note. The Directory Interface engine, using the message level HCDI_SERVICES:HCDIUtilities.runPOIandIdentifictn, populates the DSIDENTIFICTN table with HCM values that you can use for creating directory interface maps. For example, it generates a Universal Unique Identifier string and stores it in DSIDENTIFICTN.DSUUID and a default Unique Identifier, stored in DSIDENTIFICTN.DSUID. The default unique identifier defaults to the current person's email address, or, if blank, to the First Name + Last Name.

The UID field is limited to fifty characters. The system truncates the person's name if it exceeds fifty characters.

See PeopleTools PeopleBook: PeopleSoft Integration Broker

DSMAPINPUT Message

The DSMAPINPUT service operation, which corresponds to Directory Input, is a sample service operation that combines a person's job and personal data into one service operation. The DSWORKFORCE_SYNC mservice operation publishes person's job information. The DSPERSON_BASIC_SYNC service operation publishes a person's personal information.

In the subscription of DSWROKFORCE_SYNC and DSPERSON_BASIC_SYNC, the service operation is passed as input into the BuildMappingMessage, which populates the DSMAPINPUT service operation with the employee's job and personal data. This enables you to map job and personal data for one service operation to one directory entry.

BuildMappingMessage Syntax

The BuildMappingMessage function populates a service operation with data that is stored in another service operation and with data from the local database. After populating the service operation from the two data sources, it calls the mapping function. When all the data required for directory mapping isn't in the original published service operation, BuildMappingMessage uses this function instead of directly calling the mapping function:

BuildMappingMessage (input message, output message, on-line flag, [, map name])

The function performs the following tasks:

• Copies data in the same record from the input service operation into the output service operation.

• Searches for empty records in the output service operation.

• Examines data in the service operation for key values for empty records.

• If it finds key values for empty records, populates empty records in the output service operation by retrieving its current rows in the database.

• If a map name is provided, calls the mapping function for the specified name. Otherwise, calls the mapping function for each map referencing the output service operation.

The BuildMappingMessage is found in the application package and class that is associated with handler of the _EFF service operation. For example, you can find the BuildMappingMessage for the DSLOCATION_SYNC_EFF service operation in theDSMappingSub application class, which is part of DSLOCATION_SYNC_EFF application package. The BuildMappingMessage code is in the FUNCLIB_EO_DS derived record, DSMAPMESSAGE field, FieldFormula event.

Parameters

An example:

Local Message &MsgIn;
                
BuildMappingMessage(&MsgIn, "DSMAPINPUT", True, "PERSON_NDS");