| Oracle® Identity Manager Connector Guide for PeopleSoft User Management Release 9.0.4 Part Number E10167-02 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for PeopleSoft User Management Release 9.0.4 Part Number E10167-02 |
|
|
View PDF |
After you deploy the connector, you must configure it to meet your requirements. This chapter discusses the following connector configuration procedures:
Note:
These sections provide both conceptual and procedural information about configuring the connector. It is recommended that you read the conceptual information before you perform the procedures.As mentioned earlier in this guide, reconciliation involves duplicating in Oracle Identity Manager additions of and modifications to user accounts on the target system. This section discusses the following topics related to configuring reconciliation:
By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. You can customize this process by specifying the subset of added or modified target system records that must be reconciled. You do this by creating filters for the reconciliation module.
Creating a filter involves specifying values for the following scheduled task attributes, which will be used in the query SELECT criteria to retrieve the records to be reconciled:
UserId
UserType (This attribute is used only in trusted source reconciliation)
If you want to use multiple target system attributes to filter records, then you must also specify the logical operator (AND or OR) that you want to apply to the combination of target system attributes that you select.
For example, suppose you specify the following values for these attributes:
UserId=jdoe
This will return results of all users who have the string jdoe in their user IDs. For example, records of users with user ID njdoehn, cajdoe, jdoettir, and so on are fetched.
UserType=Employee
Because you are using the OR operator, during reconciliation, only user records for which any one of these criteria is met are reconciled. If you were to use the AND operator, then only user records for which all of these criteria are met are reconciled.
While deploying the connector, follow the instructions in the "Specifying Values for the Scheduled Task Attributes" section to specify values for these attributes and the logical operator that you want to apply.
During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.
You can specify the number of records to be reconciled. To do this, you use the NoOfRecordsToBeReconciled scheduled task attribute.
You specify a value for the NoOfRecordsToBeReconciled attribute by following the instructions described in the "Specifying Values for the Scheduled Task Attributes" section.
This section describes how to configure the listener for the connector. In the following procedure, OIM_home refers to the local Oracle Identity Manager installation directory.
To configure the PeopleSoft Listener Web service:
Enter the following command to extract the contents of the peopleSoftUserMgmt.war file. This file is in the OIM_home/xlclient/lib directory.
jar –xvf peopleSoftUserMgmt.war
Note:
All the files mentioned in the remaining steps of this procedure are extracted from the
peopleSoftUserMgmt.war file.Edit the deployment.properties file. This file contains the message property that corresponds to the name of the XML message from the PeopleSoft feed. The default value of this attribute is USR_MGMT_MSG. Obtain the correct value for this attribute from the PeopleSoft administrator.
If you are using PeopleTools 8.22, then you must modify the PSFTBase.Roles property in the attributemap.properties file as follows:
Search for the following line:
PSFTBase.Roles=//Transaction/PSROLEUSER_VW/ROLES
Replace it with the following line:
PSFTBase.Roles=//Transaction/PSROLEUSER_VW/ROLENAME
Edit the xlsession.properties file. This file contains the following Oracle Identity Manager connection parameters:
ObjectName: This is the name of the resource object in Oracle Identity Manager against which the reconciliation event is created. The default value is PSFTBase. For nontrusted source reconciliation, you can change it to any other resource object.
Username: This is the user name for logging in to Oracle Identity Manager. The default value is xelsysadm.
Password: This is the password for logging in to Oracle Identity Manager. You must enter the encrypted value for the default password:
Kk3821YZhIoG36lvDH2YTw==
Note:
If the password for Oracle Identity Manager is different from the default password, then refer to the "Encrypting a New Oracle Identity Manager Password" section for information about encrypting a plaintext password.Edit the xlclient.properties file. This file contains the following system properties that enable an API client to communicate with Oracle Identity Manager:
xl.homedir: This property specifies the Oracle Identity Manager client directory. Typically, the Oracle Identity Manager client directory is OIM_home/xlclient.
java.security.policy: This property specifies the path of the security policy file. Typically, this file is located in the OIM_home/xlclient/config directory.
java.security.auth.login.config: This property specifies the path of the authentication configuration file. Typically, this file is located in the OIM_home/xlclient/config directory.
Each application server uses a different authentication configuration file:
IBM WebSphere: authws.conf
BEA WebLogic: authwl.conf
JBoss Application Server: auth.conf
java.naming.provider.url: This property specifies the JNP URL of the application server. This URL is given in the <Discovery><CoreServer><java.naming.provider.url> tag of the OIM_home/xlclient/config/xlconfig.xml file.
Edit the following properties in the configureReconciliation.properties file:
reconciliationMode: This property can accept one of two possible values:
If you want to perform reconciliation in trusted mode, then set this property to trusted.
If you want to perform reconciliation in nontrusted mode, then set this property to nontrusted.
Serverdateformat: This property specifies the date format that is used by the PeopleSoft User Management server. You can select one of the following date formats:
dd-mmm-yy
ddmmyy
yyddmm
yymmdd
xellerateOrganization: This property specifies the name of the Oracle Identity Manager organization. The default value of this parameter is Xellerate Users. The value that you assign to this property must exist in Oracle Identity Manager.
nullDate: This property specifies the default value for a date field. The value is 2200/01/01 00:00:00 PST. This value is used if the date field is left empty.
PeoplesoftstartingYEAR: This property specifies the year in two digits. If the number represented by these two digits (xx):
Is greater than or equal to 50, then it is assumed that the year is 19xx.
Is less than 50, then it is assumed that the year is 20xx.
This specifies a range of 1950 to 2049 for the property.
XelServerDate: This property contains the date format that is used for the Oracle Identity Manager server.
Sample value: yyyy/MM/dd hh:mm:ss z
Copy the following files from the OIM_home/xellerate/lib directory to the WEB-INF/lib directory:
wlXLSecurityProviders.jar
xlAPI.jar
xlAuthentication.jar
xlBackOfficeBeans.jar
xlBackofficeClient.jar
xlCache.jar
xlCrypto.jar
xlDataObjectBeans.jar
xlDataObjects.jar
xlLogger.jar
xlUtils.jar
xlVO.jar
Copy the following files from the OIM_home/xellerate/ext directory to the WEB-INF/lib directory:
oscache.jar
javagroups-all.jar
Delete the peopleSoftUserMgmt.war file from the temporary directory into which you extract it, and then use the following command to re-create the file:
jar –cvf peopleSoftUserMgmt.war
Ensure that the old version of the peopleSoftUserMgmt.war file is removed from the application server (JBoss Application Server, IBM WebSphere, BEA WebLogic, or OC4J) deployment directory and the OIM_home/xellerate/webapp directory.
Copy the newly created peopleSoftUserMgmt.war file into the application server deployment directory and the OIM_home/xellerate/webapp directory.
Restart the Oracle Identity Manager server and client.
Note:
You can add custom attributes to be reconciled during change-based reconciliation. However, you must complete the deployment procedure before you can add custom attributes.Refer to the "Adding Custom Attributes for Reconciliation" section for information about the procedure to add custom attributes for reconciliation.
Configuring the target system involves performing the following procedures:
The procedure to create and publish the message depends on the release of PeopleTools that you are using:
Creating and publishing the message on PeopleTools 8.22 involves the following steps:
To create the message channel:
Click Start, Programs, and Application Designer. The Application Designer window is displayed.
Select New from the File menu. The New Definition dialog box is displayed.
Select Message Channel, and then click OK.
Save the new message channel as USR_MGMT_MSGCH.
Select Object Properties from the File menu. The Message Channel Properties dialog box is displayed.
Select the Run option, and then select Archive Messages.
Click OK, and then save the message.
To create the message:
In the Application Designer, select New from the File menu. The New Definition dialog box is displayed.
Select Message from the list, and then click OK.
Select Object Properties from the File menu. The Message Properties dialog box is displayed.
Click the Use tab.
On the Use tab, select the USR_MGMT_MSGCH message channel and the version of the message that you create.
Select Active to make the message an active message, and then click OK.
Right-click VERSION_1, and select the Insert Child Record option. The Insert Record window is displayed.
Enter PSOPRDEFN in the Name field, click Insert, and then click Close.
Note:
PSOPRDEFN is a record defined in the OIM_home/xellerate/test/cbrecon/USR_MGMT_MSG.xml file. Refer to this file for information about the fields that comprise the PSOPRDEFN record.Click PSOPRDEFN under VERSION_1. All the fields comprising the PSOPRDEFN record are displayed.
By default, all the fields appear as selected. Deselect the fields that are not required for the message XML file to be generated.
Repeat Steps g through i for the PSROLEUSER_VW record.
Note:
PSROLEUSER_VW is the second record defined in the OIM_home/xellerate/test/cbrecon/USR_MGMT_MSG.xml file.Save the message as USR_MGMT_MSG.
To publish the message:
Select Open from the File menu. The Open Definition dialog box is displayed.
Select Component from the Definition list, enter USERMAINT in the Name Selection Criteria field, and then click Enter. All component names starting with the text USERMAINT are displayed.
Select USERMAINT from the list, and then click Open. The details of the USERMAINT component are displayed.
Click the Structure tab, right-click USERMAINT, and then select View PeopleCode. The PeopleCode for the USERMAINT component is displayed.
Select the SavePostChange event from the list in the upper-left corner of the window. The PeopleCode for this event is displayed.
Copy the code given in the following file immediately after the import definitions in the PeopleCode for the SavePostChange event:
OIM_home/xellerate/Scripts/UserMgmtCBRecon.txt
Select Save from the File menu to save the changes to the USERMAINT component.
After you complete this procedure, proceed to the "Configuring PeopleSoft Enterprise Portal" section.
Creating and publishing the message on PeopleTools 8.45 through 8.47 involves the following steps:
To create the message channel:
Click Start, Programs, and Application Designer. The Application Designer window is displayed in the 2-tier mode.
Select New from the File menu. The New Definition dialog box is displayed.
Select Message Channel, and then click OK.
Save the new message channel as USR_MGMT_MSGCH.
Select Definition Properties from the File menu. The Message Channel Properties dialog box is displayed.
Select the Run option, and then select Archive Messages.
Click OK and save the message channel.
In PeopleSoft Application Designer, select New from the File menu. The New Definition dialog box is displayed.
Select Message from the list, and then click OK.
Select Definition Properties from the File menu. The Message Properties dialog box is displayed.
Click the Use tab.
On the Use tab, select the USR_MGMT_MSGCH message channel and the version of the message that you create.
Select Active to make the message an active message.
Save the message as USR_MGMT_MSG.
Select Open from the File menu. The Open Definition dialog box is displayed.
Select Component from the Definition list, enter USERMAINT in the Name Selection Criteria field, and then press Enter. All component names starting with the text USERMAINT are displayed.
Select USERMAINT from the list, and then click Open. The details of the USERMAINT component are displayed.
Click the Structure tab, right-click USERMAINT, and then select View PeopleCode. The PeopleCode for the USERMAINT component is displayed.
Select the SavePostChange event from the list in the upper-left corner of the window. The PeopleCode for this event is displayed.
Copy the code given in the following file immediately after the import definitions in the PeopleCode for the SavePostChange event:
OIM_home/xellerate/Scripts/UserMgmtCBRecon.txt
Add the following function call at the end of the PeopleCode for the SavePostChange event:
Note:
Perform this step only after you copy the code from theUserMgmtCBRecon.txt file./**********************************************************************/
/* Calling the GENERATEUSER function to generate the
USR_MGMT_MSG message*/
/**********************************************************************/
If Len(%CompIntfcName) = 0 Then
Local string &OPID;
&OPID = PSOPRDEFN.OPRID;
GENERATEUSR(&OPID);
End-If;
Select Save from the File menu to save the changes to the USERMAINT component.
Note:
If your PeopleSoft installation does not include PeopleSoft Enterprise Portal, then you cannot perform this procedure. Change-based reconciliation cannot be enabled if you do not use PeopleSoft Enterprise Portal. However, you can perform provisioning and bulk reconciliation.Refer to the "User Reconciliation" section for information about change-based and bulk reconciliation.
PeopleSoft Enterprise Portal provides a single gateway to critical information in PeopleSoft User Management Reconciliation and other PeopleSoft applications.
The procedure to configure PeopleSoft Enterprise Portal depends on the release of PeopleTools that you are using:
Configuring PeopleSoft Enterprise Portal on PeopleTools 8.22
Configuring PeopleSoft Enterprise Portal on PeopleTools 8.45 Through 8.47
Configuring PeopleSoft Enterprise Portal on PeopleTools 8.22 involves the following steps:
To create the USR_MGMT_NODE remote node:
In the Application Designer, select New from the File menu. The New Definition dialog box is displayed.
Select Message Node from the list, and then click OK.
Right-click anywhere in the white space, and then select Insert Location. The Location dialog box is displayed.
Enter the URL for the PeopleSoft Application Gateway in the following format:
http://hostname:port/servlets/gateway
In this URL, hostname is the application server that hosts PeopleSoft and port is the port number at which the application server is listening.
Select Object Properties from the File menu. The Message Node Properties dialog box is displayed.
Select the Use tab. Ensure that Local Node is not selected.
Save the remote node as USR_MGMT_NODE.
To configure the USR_MGMT_MSGCH message channel:
From the File menu, select Open and then click Message Channel.
To open the USR_MGMT_MSGCH message channel, select USR_MGMT_MSGCH.
Click the Routing Rules tab.
Right-click anywhere in the empty area of the right pane, and then select Insert Message Node. The Insert Message Node dialog box is displayed.
Select the USR_MGMT_NODE message node, and then click Insert.
Click Cancel to close the dialog box.
Right-click the message node displayed on the Routing Rules tab.
Point to Routing Direction, and then select Publish To.
Save the message channel.
To configure the PeopleSoft Enterprise Portal gateway so that messages can be sent through the gateway to third-party systems:
Note:
The Simple File Handler mentioned in the following procedure is a utility in PeopleTools 8.22 that can receive messages published by a PeopleSoft node and write these messages to a file that can be used by third-party systems.In a Web browser, use a URL with the following format to launch the PeopleSoft configuration servlet interface (handler directory):
http://hostname:port/servlets/gateway.administration
In this URL, hostname is the application server that hosts PeopleSoft and port is the port number at which the application server is listening.
Click Add Handler. The Add Handler window is displayed.
Enter the full name of the Simple File Handler class, psft.pt8.filehandler.SimpleFileHandler.
Click Save. The Handler Directory window is displayed.
To load the handler, click Load. After the handler loads, the "Loaded successfully" message is displayed in the Status column.
Click Configure.
Click Add a file handler node. The Add File Handler Node window is displayed.
In the Node Name field, enter the name of the message node that you create, USR_MGMT_NODE.
Specify the output directory in which the published messages are to be stored.
Select Include Header.
Click Save.
Restart the Web server.
XML messages are generated by the Simple File Handler. To publish these messages to the PeopleSoft Connector Listener servlet, you must create a scheduled task as follows:
Note:
The scheduled task calls a Java program that communicates with the servlet deployed on the Oracle Identity Manager server. The servlet parses the message and sends reconciliation events to Oracle Identity Manager.The servlet sends a return code based on the status of the reconciliation event. If the reconciliation event is successfully sent, then the message is deleted or archived. Otherwise, the message file is left unchanged. The next time the scheduled task is run, another attempt is made to send the message.
Copy the publish.bat and xliMsgPublisher.jar files from the OIM_home/xellerate/MsgPublisher directory to any directory on the PeopleSoft User Management server.
Use a text editor to open the publish.bat file, and then make the following changes in the file:
i. Change the value of the JAVA_HOME variable so that it points to the JDK installation directory on the PeopleSoft Web server.
ii. Specify the following values in the Java command given at the end of the file:
PeopleSoft_listener_servlet_URL: This is the URL of the servlet that listens for reconciliation events generated using PeopleSoft Application Messaging.
Output_directory_for_XML_messages: This is the PeopleSoft Web server directory in which you want published messages to be stored. You have already specified the output directory while performing Step 3.i of this procedure.
XML_message_name
console_log_file_path
The command is in the following format:
java Com.thortech.xl.Integration.msgpublisher.PeopleSoftPublisher "PeopleSoft_listener_servlet_URL" "Output_directory_for_XML_messages" XML_message_name >> console_log_file_path
For example:
java Com.thortech.xl.Integration.msgpublisher.PeopleSoftPublisher "http://host:port/peopleSoftUserMgmt/do/peopleSoftAction" "C:/test/file" USR_MGMT_MSG >> c:/test/consolelog.log
In the PeopleSoft listener servlet URL specified in this example, host is the IP address or host name of the application server on which Oracle Identity Manager is running and port is the HTTP port at which the application server listens for incoming messages.
Save and close the batch file.
On the PeopleSoft Web server, click Start, Settings, and Control Open.
Double-click Scheduled Tasks.
Click Add Schedule Task, and then click Next.
Click Browse, and then select the publish.bat file from the directory in which you save it.
Select Daily, click Next, and then click Next again.
Enter the user ID and password for the scheduled task to run.
Select Open Advance properties.
Click Finish.
On the Schedule tab, click Advanced.
Select Repeat Task.
Select the frequency at which you want the task to run.
Click OK, and then click OK again to close the window.
Configuring PeopleSoft Enterprise Portal on PeopleTools 8.45 through 8.47 involves the following steps:
To configure the PeopleSoft Enterprise Portal gateway so that messages can be sent through the gateway to the connector:
Open a Web browser and enter the URL for PeopleSoft Enterprise Portal.
This URL is in the following format:
http://servername/psp/Databasename/?cmd=login
Here, psp is the name of the Web application. For example:
http://psftserver.acme.com/psp/TestDB/?cmd=login
Expand PeopleTools, Integration Broker, and then Gateways in the list on the portal page. The Gateway component details are displayed.
Enter LOCAL in the Integration Gateway ID field, and then click Search. The LOCAL gateway is a default gateway that is created when you install PeopleSoft Enterprise Portal.
Ensure that the IP address specified in the URL of the PeopleSoft listening connector is the IP address of the Web server on which PeopleSoft User Management is installed. The PeopleSoft listening connector is a module provided by PeopleSoft. The URL of the PeopleSoft listening connector is in the following format:
http://computer_name/PSIGW/PeopleSoftListeningConnector
For example:
http://172.19.151.53/PSIGW/PeopleSoftListeningConnector
Click Load Gateway Connectors to load all target connectors that are registered with the LOCAL gateway.
Click Save.
To create the USR_MGMT_NODE remote node:
In the PeopleSoft Enterprise Portal window, expand PeopleTools, Integration Broker, and Node Definitions.
Click the Add a New Value tab.
On the Add a New Value tab, enter USR_MGMT_NODE as the node name and then click Add. The Node Definition page is displayed.
Enter a description for the node in the Description field.
Make this node a remote node by deselecting the Local Node check box and selecting the Active Node check box.
On the Connectors tab, enter the following information and then perform a lookup:
Gateway ID: LOCAL
Connector ID: PSFT81TARGET
On the Properties tab, enter the following information:
Property ID: PSFT81TARGET
Property Name: URL
Required value: Enter the URL of the PeopleSoft servlet that is to receive the XML message. This URL is in the following format:
http://computer_name:port/peopleSoftUserMgmt/do/peopleSoftAction
For example:
http://172.21.109.75:8080/peopleSoftUserMgmt/do/peopleSoftAction
Click Save.
Click the Transactions tab, and then click Add Transaction. The Add Transaction page is displayed.
Enter the following details to define the new transaction:
Transaction Type: Outbound Asynchronous
Request Message: USR_MGMT_MSG
Request Message Version: VERSION_1
Click Add.
To keep the status as active, select Active.
Click Save to save the changes.
To secure the USR_MGMT_MSGCH message channel:
Navigate to PeopleTools, Security, Permission & Roles, and Permission Lists.
Select AEAE1000. The AEAE1000 permission list is displayed.
Select the Message Monitor tab, and then click the button with the plus sign (+).
Enter USR_MGMT_MSGCH as the channel name.
Select Full Access from the list, and then click Save.
Click PeopleTools, Integration Broker, Monitor, Monitor Message, and Channel Status to check the status of the message channel.
If the status of the USR_MGMT_MSGCH message channel is Pause, then click the Run button to activate it.
To create the Application Engine program:
Click Start, Programs, PeopleSoft8.x, and then Application Designer. The Application Designer window is displayed.
Select New from the File menu. The New Definition dialog box is displayed.
Select Application Engine from the Definition list. The App Engine Program window is displayed, and the Step01 step is created by default.
In the App Engine Program window, select Step01 and then select Action from the Insert menu.
Rename Step01 to currency.
From the list on the action, select PeopleCode.
Select Save from the File menu, and save the Application Engine program with the name BLKPRCS_USER.
Double-click the PeopleCode action.
Copy the code from the CurrencyCode.txt file, which is in the OIM_home/xellerate/Scripts directory.
The code that you copy has the following default path for the output file in which the currency code data changes are to be stored:
C:/PT822/data/log/currency.txt
In the code, retain the file name (currency.txt) but change the path to any directory location on the PeopleSoft server. For example:
C:/MyDirectory/currency.txt
Save the PeopleCode action and close the window.
In the App Engine Program window, select the MAIN section and then select Step/Action from the Insert menu.
Repeat Steps 5 through 12 to create the remaining steps, which are listed in the following table.
| Step Name | File Containing the Required PeopleCode |
|---|---|
language |
LanguageCode.txt |
emplid |
EmployeeId.txt |
userrole |
UserRoles.txt |
permiss |
PermissionList.txt |
EmailType (PeopleTools 8.45 through 8.47 only) |
EmailType.txt |
addemp |
AddEmp.txt |
Save the Application Engine program.
The procedure to run the Application Engine program depends on the release of PeopleTools that you are using:
To run the Application Engine program on PeopleTools 8.22:
Log in to the PeopleSoft Enterprise Portal.
Click People Tools, Process Scheduler Manager, Use, and Process Definitions. The Process Definitions page is displayed.
Click Add a New value.
Select Application Engine from the Process Type list.
Enter the name of the Application Engine program as the process name, for example, BLKPRCS_USER.
Click Add.
Select the Application Engine Program from the search results that are displayed.
On the Process Definition Options tab, specify the following values:
Run Location: Server
Server Name: PSNT
Component: PRCSMULTI
Process Groups: ALLPANLS
Click Save.
Return to the home page.
Click People Tools, Process Scheduler Manager, Process, and Sample Processes. The Sample Processes page is displayed.
Click Add a New value.
Specify a run control ID, and then click Add.
Note:
A run control ID is used as a key for records that contain the parameters required by a process at run time. If the parameters are stored in a table that the process can query using the run control ID and user ID, then the process can run without user intervention.Click Run. The Process Scheduler Request page is displayed
Specify the server name.
Select the Application Engine program name, and then click OK.
Click Process Monitor to verify the status of the process.
After the process status changes to Success, the comma-separated file is created at the location specified in the code that you copy from the AddEmp.txt file.
To run the Application Engine program on PeopleTools 8.45 through 8.47:
Note:
For the Application Engine program to run in 2-tier mode, the database client must be installed on the server used for accessing the application designer. To switch to the 2-tier mode, you selectConnection Type as the database on the PeopleSoft sign-on screen.Open the application designer in 2-tier mode.
Specify the connection type, user ID, and password.
To open the Application Engine program that you create:
From the File menu, select Open and then select Application Engine Program from the Object Type list.
Select BLKPRCS_USER, and then click Open.
Click the RUN PROGRAM control on the toolbar below the menu bar. The code for the PeopleCode action is run. The comma-separated file containing user records is created at the location specified in the code.
While configuring the connector, the target system can be designated as a trusted source or a target resource. If you designate the target system as a trusted source, then both newly created and modified user accounts are reconciled in Oracle Identity Manager. If you designate the target system as a target resource, then only modified user accounts are reconciled in Oracle Identity Manager.
Note:
You can skip this section if you do not want to designate the target system as a trusted source for reconciliation.Import the XML file for trusted source reconciliation, PSFTBaseXellerateUser.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.
Note:
Only one target system can be designated as a trusted source. If you import thePSFTBaseXellerateUser.xml file while you have another trusted source configured, then both connector reconciliations would stop working.Specify values for the attributes of the PSFT Base Trusted User Reconciliation scheduled task. This procedure is described later in this guide.
To configure trusted source reconciliation:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the PSFTBaseXellerateUser.xml file, which is in the OIM_home/xlclient directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
When you perform the procedure described in the "Step 4: Importing the Connector XML Files" section, the scheduled tasks for lookup fields, trusted source user, and nontrusted user reconciliations are automatically created in Oracle Identity Manager. To configure these scheduled tasks:
Open the Oracle Identity Manager Design Console.
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.
Enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.
To set the task to run only once, select the Once option in the Interval region.
Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.
Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.
Repeat Steps 5 through 10 to create the second scheduled task.
After you create both scheduled tasks, proceed to the "Adding Custom Attributes for Reconciliation" section.
This section provides information about the values to be specified for the following scheduled tasks:
You must specify values for the following attributes of the PSFT Base LookUp Reconciliation scheduled task.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
| Attribute | Description |
|---|---|
ServerName |
Name of the IT resource
Default value: |
LookupType |
The type of data that is being looked up in the target system.
The value can be any one of the following:
|
FilePath |
Directory path on the Oracle Identity Manager server where the reconciliation lookup .txt file is stored
Sample value: |
LookupName |
Name of the lookup definition configured in Oracle Identity Manager
The value can be any one of the following:
|
TargetSystem |
Name of the resource object
Default value: |
After you specify values for these task attributes, go to Step 10 of the procedure to create scheduled tasks.
Depending on whether you want to implement trusted or nontrusted soured reconciliation, you must specify values for the attributes of one of the following user reconciliation scheduled tasks:
PSFT Base Trusted User Reconciliation (Scheduled task for trusted source reconciliation)
PSFT Base Non Trusted User (Scheduled task for nontrusted source reconciliation)
The following table describes the attributes of both scheduled tasks.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
| Attribute | Description |
|---|---|
MultiValueSeperator |
## is the multivalue separator in the flat file that is used for bulk reconciliation |
ServerName |
Name of the IT resource instance
Default value: |
IsTrusted |
Specifies whether or not reconciliation is to be carried out in trusted mode
Specify Specify |
XellerateOrganization |
Default name of the Oracle Identity Manager organization
This value is used to create the Xellerate User in trusted mode. Note: This attribute is specific to the scheduled task for trusted source reconciliation. |
FolderPath |
Directory path on the Oracle Identity Manager server where the reconciliation lookup .txt file is stored |
TargetSystem |
Name of the resource object
Default value: |
After you specify values for these task attributes, go to Step 10 of the procedure to create scheduled tasks.
Note:
In this section, the term "attribute" refers to the identity data fields that store user data.Standard change-based reconciliation involves the reconciliation of predefined attributes. If required, you can add custom attributes to the list of fields that are reconciled.
The procedure to add a custom attribute for reconciliation depends on the release of PeopleTools that you are using:
Adding a Custom Attribute for Reconciliation on PeopleTools 8.22
Adding a Custom Attribute for Reconciliation on PeopleTools 8.45 Through 8.47
To add a custom attribute for reconciliation on PeopleTools 8.22:
In PeopleSoft Application Designer:
Select Open from the File menu. The Open Definition dialog box is displayed.
Select Message from the Definition list, enter USR_MGMT_MSG in the Name Selection Criteria field, and then click Enter. The details of the USR_MGMT_MSG message are displayed.
Click the record to which you want to add custom attributes.
For example, suppose you want to add the job location attribute, LOCATION, then click JOB under VERSION_1.
Select the check box for the required attribute, and then save the message.
For example, select the LOCATION check box.
Make the required changes in the PeopleCode given in the UserMgmtCBRecon.txt file. This file is in the OIM_home/xellerate/Scripts directory. The required changes are as follows:
At the end of the SQL statements section, edit the SQL statement to retrieve the column values for the new attribute and store the values in local variables.
For example, suppose you want to add the job location attribute, LOCATION, to the list of attributes that are reconciled. Then, performing this step involves editing the SQL statement as follows, so that it retrieves the values of the LOCATION column from the JOB table:
SQLExec("select DEPTID, JOBCODE, LOCATION from ps_job a where emplid =:1 and effdt=(select max(effdt) from ps_job b where a.emplid=b.emplid and effseq =(select max(effseq) from ps_job c where b.emplid = c.emplid and b.effdt=c.effdt))", &empid, &deptid, &jobcd, &location);
Add the required lines at the end of the block of code for adding data to the XML message. For example, to add the LOCATION column to the JOB tag, add the lines highlighted in bold in the following code sample:
/* FOR JOB RECORD */
&MSG_ROWSET.GetRow(1).JOB.JOBCODE.Value = &jobcd;
&MSG_ROWSET.GetRow(1).JOB.DEPTID.Value = &deptid;
&MSG_ROWSET.GetRow(1).JOB.LOCATION.Value = &location;
To extract the contents of the peopleSoftUserMgmt.war file into a temporary directory, enter the following command:
jar –xvf peopleSoftUserMgmt.war
Copies of this file are in the application server deployment directory and the OIM_home/xellerate/webapp directory.
In the attributemap.properties file, add the XPath (key-value entry) of the custom attribute. For example, you can add the following XPath for the LOCATION attribute:
Users.LOCATION=//Transaction/DEPT_TBL/LOCATION
Delete the existing peopleSoftUserMgmt.war file from the temporary directory into which you extract it, and then enter the following command to re-create the file:
jar –cvf peopleSoftUserMgmt.war .
Delete the old version of the peopleSoftUserMgmt.war file from the application server deployment directory and the OIM_home/xellerate/webapp directory.
Copy the newly created peopleSoftUserMgmt.war file into the application server deployment directory and the OIM_home/xellerate/webapp directory.
In the Oracle Identity Manager Design Console, make the required changes as follows:
See:
Oracle Identity Manager Design Console for detailed instructions on performing the following stepsAdd a column corresponding to the new attribute in the User Defined process form, UD_PSFT_BAS. For the example described earlier, you can add the UD_PSFT_BAS_LOCATION column.
Add a reconciliation field corresponding to the new attribute in the resource object, PSFTBase. For the example described earlier, you can add the Users.LOCATION reconciliation field.
Modify the PSFTBase process definition to include the mapping between the newly added attribute and the corresponding reconciliation field. For the example described earlier, the mapping is as follows:
Users.LOCATION = UD_PSFT_BAS_LOCATION
Modify the attributemapping_recon.properties file, which is in the OIM_home/xellerate/XLIntegrations/PSFTBASE/config directory.
You can also add new attributes in this file. The format that you must use is as follows:
TargetAttribute=Users.OimAttributeName
For example:
LOCATION=Users.LOCATION
In this example, LOCATION is the reconciliation field and also the equivalent target system attribute. As a standard, the prefix "Users." is added at the start of all reconciliation field names.
Restart the Oracle Identity Manager server and client.
To add a custom attribute for reconciliation on PeopleTools 8.45 through 8.47:
Make the required changes in the PeopleCode given in the UserMgmtCBRecon.txt file. This file is in the OIM_home/xellerate/Scripts directory. The required changes are as follows:
At the end of the SQL statements section, add a SQL statement to retrieve the column values for the new attribute and store the values in local variables.
For example, suppose you want to add the department location attribute, LOCATION, to the list of attributes that are reconciled. Then, performing this step involves adding the following SQL statement to retrieve the values of the LOCATION column from the PS_DEPT_TBL table:
SQLExec("SELECT DESCR, LOCATION FROM PS_DEPT_TBL WHERE DEPTID=:1", &deptid, &deptname, &location);
Add the required lines at the end of the block of code for adding data to the XML message. For example, to add the LOCATION column to the DEPT_TBL tag, add the lines highlighted in bold in the following code sample:
&recnode = &fieldtypenode.AddElement("DEPT_TBL");
&recnode.AddAttribute("class", "R");
&fields = &recnode.AddElement("DEPTNAME");
&fields.AddAttribute("type", "CHAR");
&fields = &recnode.AddElement("LOCATION");
&fields.AddAttribute("type", "CHAR");
Add the required lines at the end of the block of code for adding data to the XML message. For example, to add the LOCATION column to the DEPT_TBL tag, add the lines highlighted in bold in the following code sample:
&datarecnode = &transnode.AddElement("DEPT_TBL");
&datarecnode.AddAttribute("class", "R");
&datafldnode = &datarecnode.AddElement("DEPTNAME");
&textnode = &datafldnode.AddText(&deptname);
&datafldnode = &datarecnode.AddElement("LOCATION");
&textnode = &datafldnode.AddText(&location);
In PeopleSoft Application Designer, copy the contents of the UserMgmtCBRecon.txt file into the savePostChange event for the PERSONAL_DATA component.
To extract the contents of the peopleSoftUserMgmt.war file into a temporary directory, enter the following command:
jar –xvf peopleSoftUserMgmt.war
Copies of this file are in the application server deployment directory and the OIM_home/xellerate/webapp directory.
In the attributemap.properties file, add the XPath (key-value entry) of the custom attribute. For example, you can add the following XPath for the LOCATION attribute:
Users.LOCATION=//Transaction/DEPT_TBL/LOCATION
Delete the existing peopleSoftUserMgmt.war file from the temporary directory into which you extract it, and then enter the following command to re-create the file:
jar –cvf peopleSoftUserMgmt.war .
Delete the old version of the peopleSoftUserMgmt.war file from the application server deployment directory and the OIM_home/xellerate/webapp directory.
Copy the newly created peopleSoftUserMgmt.war file into the application server deployment directory and the OIM_home/xellerate/webapp directory.
In the Oracle Identity Manager Design Console, make the required changes as follows:
See:
Oracle Identity Manager Design Console for detailed instructions on performing the following stepsAdd a column corresponding to the new attribute in the User Defined process form, UD_PSFT_BAS. For the example described earlier, you can add the UD_PSFT_BAS_LOCATION column.
Add a reconciliation field corresponding to the new attribute in the resource object, PSFTBase. For the example described earlier, you can add the Users.LOCATION reconciliation field.
Modify the PSFTBase process definition to include the mapping between the newly added attribute and the corresponding reconciliation field. For the example described earlier, the mapping is as follows:
Users.LOCATION = UD_PSFT_HR_LOCATION
Modify the attributemapping_recon.properties file, which is in the OIM_home/xellerate/XLIntegrations/PSFTBASE/config directory.
You can also add new attributes in this file. The format that you must use is as follows:
TargetAttribute=Users.OimAttributeName
For example:
LOCATION=Users.LOCATION
In this example, LOCATION is the reconciliation field and also the equivalent target system attribute. As a standard, the prefix "Users." is added at the start of all reconciliation field names.
Restart the Oracle Identity Manager server and client.
If the password of the Oracle Identity Manager administrator is different from the default password, then you must encrypt the Oracle Identity Manager password as follows:
Note:
The default administrator user ID isxelsysadm.On the Oracle Identity Manager server, open a command window.
In the command window, change to the OIM_home/xellerate/ScheduleTask directory.
Enter the following command:
java -classpath PSFTBaseReconciliation .jar \
Com.thortech.xl.Integration.peoplesoft.util.tcUtilEncryption -e \
OIM_plaintext_password
In this command, OIM_plaintext_password is the new Oracle Identity Manager administrator password that you want to encrypt.
The encrypted password is displayed in the command window.
Copy the encrypted password into the xlsession.properties file. This file is compressed in the OIM_home/xlclient/lib/peopleSoftUserMgmt.war file.
Delete the peopleSoftUserMgmt.war file from the temporary directory where you extracted its contents, and then use the following command to re-create the file:
jar –cvf peopleSoftUserMgmt.war
Ensure that the old version of the peopleSoftUserMgmt.war file is removed from the application server (JBoss Application Server, IBM WebSphere, BEA WebLogic, or OC4J) deployment directory and the OIM_home/xellerate/webapp directory.
Copy the newly created peopleSoftUserMgmt.war file into the application server (JBoss Application Server, IBM WebSphere, BEA WebLogic or OC4J) deployment directory and the OIM_home/xellerate/webapp directory.
Restart the Oracle Identity Manager server and client.
As mentioned earlier in this guide, provisioning involves creating or modifying a user's account information on the target system through Oracle Identity Manager. Refer to the "Supported Functionality" section for a listing of the provisioning functions that are available with this connector.
This section discusses the following topics related to configuring provisioning:
Note:
You must perform this procedure if you want to use the provisioning features of the connector.Adapters are used to implement provisioning functions. The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
See Also:
The "Supported Functionality" section for a listing of the provisioning functions that are available with this connectoradpPSFTCREATEUSER
adpPSFTUPDATEUSER
adpPSFTRESETPASSWORD
adpPSFTUNLOCKUSER
adpPSFTLOCKUSER
adpPSFTUPDATEUSEREMPID
adpPSFTADDORDELETEROLE
adpPSFTADDORDELETEEMAIL (PeopleTools 8.45 through 8.47 only)
You must compile these adapters before they can be used in provisioning operations.
To compile adapters by using the Adapter Manager form:
Open the Adapter Manager form.
To compile all the adapters that you import into the current database, select Compile All.
To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.
Note:
Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have anOK compilation status.Click Start. Oracle Identity Manager compiles the selected adapters.
If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_home/xellerate/Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes.
If you want to compile one adapter at a time, then use the Adapter Factory form.
See Also:
Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager formsTo view detailed information about an adapter:
Highlight the adapter in the Adapter Manager form.
Double-click the row header of the adapter, or right-click the adapter.
Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.
Note:
In this section, the term "attribute" refers to the identity data fields that store user data.To add a custom attribute for provisioning:
See Also:
Oracle Identity Manager Design Console GuideModify the attributemapping_prov.properties file, which is in the OIM_home/xellerate/XLIntegrations/PSFTBase/config directory. At the end of this file, some of the attribute definitions are preceded by comment characters. You can uncomment the definitions of attributes that you want to use any one of them to make it a part of the provisioning attributes.
You can also add new attributes in this file. The format that you must use is as follows:
OimAttributeName=TargetAttributeName
For example:
If you want to add the AlternateUserID field, then add the following line in the attributemapping_prov.properties file:
AlternateUserID=AlternateUserID
Add a new column in the process form.
Open the process form. This form is in the Development Tools folder of the Oracle Identity Manager Design Console
Click Create New Version.
In the Create a New Version dialog box, specify the version name in the Label field, save the changes, and then close the dialog box.
From the Current Version list, select the newly created version.
On the Additional Columns tab, click Add.
Specify the new field name and other values.
Add a new variable in the variable list.
Open the Adapter Factory form. This form is in the Development Tools folder of the Oracle Identity Manager Design Console.
Click the Query for Records icon.
On the Adapter Factory Table tab, double-click the adpPSFTCREATEUSER adapter from the list.
On the Variable List tab, click Add.
In the Add a Variable dialog box, specify the required values and then save and close the dialog box.
Define an additional adapter task for the newly added variable in the adpPSFTCREATEUSER adapter.
On the Adapter Tasks tab of the Adapter Factory form, click Add.
In the Adapter Task Selection dialog box, select Functional Task, select Java from the list of functional task types, and then click Continue.
In the Object Instance Selection dialog box, select the Persistent instance and then click Continue.
In the Add an Adapter Factory Task dialog box, specify the task name, select the setProperty method from the Method list, and then click Save.
Map the application method parameters, and then save and close the dialog box. To map the application method parameters:
For the "Output: String Return variable (Adapter Variable)" parameter:
i. From the Map to list, select Literal.
ii. From the Name list, select Return variable.
For the "Input: String input (Adapter Variable)" parameter:
i. From the Map to list, select Adapter Variables.
ii. From the Name list, select Input.
For the "Input: String Status (Literal)" parameter:
i. From the Map to list, select Literal.
ii. From the Name list, select String.
iii. In the Value field, enter Status.
For the "Input: String Status (Adapter Variable)" parameter:
i. From the Map to list, select Adapter Variables.
ii. From the Name list, select Status.
Repeat Steps b through g' to create more adapter tasks.
Create an additional adapter task to set the input variable.
Open the Adapter Factory form. This form is in the Development Tools folder in the Oracle Identity Manager Design Console.
On the Adapter Tasks tab, click Add.
In the Adapter Task Selection dialog box, select Logic Task, select SET VARIABLE from the list, and then click Continue.
In the Edit Set Variable Task Parameters dialog box, select input from the Variable Name list, select Adapter Task from the Operand Type list, and the Operand Qualifier as the Adapter Task that you have created in the previous step. Then, click Save.
Map the process form columns and adapter variables for the Create User process task as follows:
Open the Process Definition form. This form is in the Process Management folder of the Design Console.
Click the Query for Records icon.
On the Process Definition Table tab, double-click the PSFTBase process.
On the Tasks tab, double-click the Create User task.
In the Closing Form dialog box, click Yes.
On the Integration tab of the Editing Task Columns Create User dialog box, map the unmapped variables, and then save and close the dialog box. To map an unmapped variable:
i. Double-click the row in which N is displayed in the Status column. The value N signifies that the variable is not mapped.
ii. From the Map to list in the Edit Data Mapping for Variables dialog box, select Process Data.
iii. From the Qualifier list, select the name of the variable.
Repeat Steps i through iii for all unmapped variables.
Repeat Steps 1 through 6 if you want to add more attributes.
This section describes the following procedures to be performed on the target system:
To create the APIs for the component interface:
Open the Application Designer by clicking Start and then selecting Programs, Peoplesoft8.x, and Application Designer. The Application Designer window is displayed.
In the Application Designer window, select Open from the File menu. The Open Definition dialog box is displayed.
In the Open Definition dialog box, select Component Interface from the Definition list.
Enter USER_PROFILE in the Name field, and then press Enter.
All the component interfaces with names that start with USER_PROFILE are displayed in the Open Definition dialog box.
Select the USER_PROFILE entry, and then click Open.
Click Yes in the message that is displayed. The properties of the USER_PROFILE component interface are displayed.
In the window for the USER_PROFILE component interface, select PeopleSoft APIs from the Build menu. The Build PeopleSoft API Bindings dialog box is displayed.
In the Java Classes region, select the Build check box.
From the Select APIs to Build list, select CompIntfc.CompIntfcPropertyInfo, CompIntfc.CompIntfcPropertyInfoCollection, and the APIs with names that start with CompIntfc.USER_PROFILE.
In the Target Directory field, specify the path of the directory in which you want the Java API classes to be created, and then click OK.
Ensure that the psjoa.jar file is set in the CLASSPATH environment variable. This file is in the OIM_home/xellerate/ThirdParty directory.
Compile the APIs from the target directory specified in the preceding step.
Bundle the compiled class files in a JAR named peoplesoft.jar as follows:
jar -cvf peoplesoft.jar PeopleSoft/Generated/CompIntfc/*.class
To create the Java template for the component interface:
On the right pane of the window for the USER_PROFILE component interface, right-click USER_PROFILE.
Select Generate Java Template from the shortcut menu. A message showing the name and path of the Java template is displayed.
Click OK to close the message.
Note:
Perform this procedure only if you want to configure the connector for multiple installations of PeopleSoft User Management.You may want to configure the connector for multiple installations of PeopleSoft User Management. The following example illustrates this requirement:
The Tokyo, London, and New York offices of Acme Multinational Inc. have their own installations of PeopleSoft User Management. The company has recently installed Oracle Identity Manager, and they want to configure Oracle Identity Manager to link all the installations of PeopleSoft User Management.
To meet the requirement posed by such a scenario, you must configure the connector for multiple installations of PeopleSoft User Management.
To configure the connector for multiple installations of the target system:
See Also:
Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedureCreate and configure one IT resource for each target system installation.
The IT Resources form is in the Resource Management folder. An IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same IT resource type.
Configure reconciliation for each target system installation. Refer to the "Partial Reconciliation" section for instructions. Note that you only need to modify the attributes that are used to specify the IT resource and to specify whether or not the target system installation is to be set up as a trusted source.
If required, modify the fields to be reconciled for the Xellerate User resource object.
Additional Steps for Configuring Change-Based Reconciliation
For change-based reconciliation, you must perform the procedure described in the following sections:
The following are actions that you must perform differently from the procedure described in these sections:
In Step 4.b of the "Configuring PeopleSoft Enterprise Portal on PeopleTools 8.22" section:
Note:
Perform this step only if you use PeopleTools 8.22.Change the Java command in the publish.bat file as shown in the following example:
java Com.thortech.xl.Integration.msgpublisher.PeopleSoftPublisher "http://host:port/peopleSoftUserMgmt1/do/peopleSoftAction" "C:/test/file" USR_MGMT_MSG >> c:/test/consolelog.log
Similarly, change the name of the Web application for each WAR file that you create.
In Step 7 of the procedure to create the XL_NODE node, given in the "Configuring PeopleSoft Enterprise Portal on PeopleTools 8.45 Through 8.47" section:
Note:
Perform this step only if you use PeopleTools 8.45 through 8.47.Change the name of the application in the URL as shown in the following example:
http://computer_name:port/peopleSoftUserMgmt1/do/peopleSoftAction
Similarly, change the name of the Web application in the URL for each WAR file that you create.
In the "Configuring the PeopleSoft Listener Web Service for Change-Based Reconciliation" section:
In Step 3, the value that you specify for the ObjectName parameter in the xlsession.properties file must be the name of the resource object that you create.
In Step 7, specify a different file name in the command that you use to re-create the WAR file. For example:
jar –cvf peopleSoftUserMgmt1.war
Similarly, change the name of the WAR file for each target system installation
