| Oracle® Identity Manager Connector Guide for SAP Employee Reconciliation Release 9.0.4 Part Number E10171-01 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for SAP Employee Reconciliation Release 9.0.4 Part Number E10171-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
The following table lists the deployment requirements for the connector.
| Item | Requirement |
|---|---|
| Oracle Identity Manager | Oracle Identity Manager release 8.5.3 or later |
| Target system | The target system can be any one of the following:
|
| External Code | The following SAP custom code files:
For Microsoft Windows: sapjcorfc.dll librfc32.dll Version: 2.1.8 For Solaris and Linux: libsapjcorfc.so librfccm.so Version: 2.1.8 |
| Target system user account | Create a user account, and assign it to the SAP_ALL and SAP_NEW groups.
You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. If this target system user account is not assigned the specified rights, then the following error message may be displayed during connector operations:
|
The connector files to be copied and the directories to which you must copy them are given in the following table.
Note:
The directory paths given in the first column of this table correspond to the location of the connector files in the following directory on the installation media:Enterprise Applications/SAP Enterprise Applications/SAP Employee Reconciliation
Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.
| File in the Installation Media | Destination |
|---|---|
BAPI/xlhsapcar.sar |
This file can be copied to any location on the target system. For example:
C:/xlhsapcar/ Refer to the "Extracting the Request Files" section for more information. |
Files in the lib directory |
OIM_home/xellerate/JavaTasks
|
Files in the resources directory |
OIM_home/xellerate/connectorResources
|
Files in the test directory |
OIM_home/xellerate/XLIntegrations/saphrms/test
|
Files in the xml directory |
OIM_home/xellerate/XLIntegrations/saphrms/xml
|
To download and copy the external code files to the required locations:
Download the SAP Java connector file from the SAP Web site as follows:
Open the following page in a Web browser:
Open the SAP JAVA Connector page by selecting Application Platform, Connectivity, Connectors, SAP Java Connector, and Tools & Services.
On the SAP JAVA Connector page, links for files that you can download are displayed on the right pane. Click the link for the SAP JCO release that you want to download.
In the dialog box that is displayed, specify the path of the directory in which you want to save the file.
Extract the contents of the file that you download.
Copy the sapjco.jar file into the OIM_home/Xellerate/JavaTasks directory.
Copy the RFC files into the required directory, and then modify the appropriate environment variable so that it includes the path to this directory:
On Microsoft Windows:
Copy the librfccm.dll and libsapjcorfc.dll files into the winnt\system32 directory. Alternatively, you can copy these files into any directory and then add the path to the directory in the PATH environment variable.
On Solaris and Linux:
Copy the librfccm.so and libsapjcorfc.so files into the /usr/local/jco directory, and then add the path to this directory in the LD_LIBRARY_PATH environment variable.
Restart the server for the changes in the environment variable to take effect.
Note:
While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the
connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.Note:
In this guide, the term Oracle Identity Manager server refers to the computer on which Oracle Identity Manager is installed.Configuring the Oracle Identity Manager server involves performing the following procedures:
Note:
In a clustered environment, you must perform this step on each node of the cluster. Then, restart each node.Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.
You may require the assistance of the system administrator to change to the required input locale.
While performing the instructions described in the "Step 2: Copying the Connector Files and External Code Files" section, you copy files from the resources directory on the installation media into the OIM_home/xellerate/connectorResources directory. Whenever you add a new resource bundle in the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.
To clear content related to connector resource bundles from the server cache:
In a command window, change to the OIM_home/xellerate/bin directory.
Note:
You must perform Step 1 before you perform Step 2. If you run the command described in Step 2 as follows, then an exception is thrown:OIM_home/xellerate/bin/batch_file_name
Enter one of the following commands:
On Microsoft Windows:
PurgeCache.bat ConnectorResourceBundle
On UNIX:
PurgeCache.sh ConnectorResourceBundle
Note:
You can ignore the exception that is thrown when you perform Step 2.In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:
OIM_home/xellerate/config/xlConfig.xml
When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:
ALL
This level enables logging for all events.
DEBUG
This level enables logging of information about fine-grained events that are useful for debugging.
INFO
This level enables logging of informational messages that highlight the progress of the application at coarse-grained level.
WARN
This level enables logging of information about potentially harmful situations.
ERROR
This level enables logging of information about error events that may still allow the application to continue running.
FATAL
This level enables logging of information about very severe error events that could cause the application to stop functioning.
OFF
This level disables logging for all events.
The file in which you set the log level and the log file path depend on the application server that you use:
BEA WebLogic
To enable logging:
Add the following lines in the OIM_home/xellerate/config/log.properties file:
log4j.logger.XELLERATE=log_level log4j.logger.XL_INTG.SAPHRMS=log_level
In these lines, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO log4j.logger.XL_INTG.SAPHRMS=INFO
After you enable logging, the log information is written to the following file:
WebLogic_home/user_projects/domains/domain_name/server_name/server_name.log
IBM WebSphere
To enable logging:
Add the following lines in the OIM_home/xellerate/config/log.properties file:
log4j.logger.XELLERATE=log_level log4j.logger.XL_INTG.SAPHRMS=log_level
In these lines, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO log4j.logger.XL_INTG.SAPHRMS=INFO
After you enable logging, the log information is written to the following file:
WebSphere_home/AppServer/logs/server_name/startServer.log
JBoss Application Server
To enable logging:
In the JBoss_home/server/default/conf/log4j.xml file, locate or add the following lines:
<category name="XELLERATE">
<priority value="log_level"/>
</category>
<category name="XL_INTG.SAPHRMS">
<priority value="log_level"/>
</category>
In the second XML code line of each set, replace log_level with the log level that you want to set. For example:
<category name="XELLERATE"> <priority value="INFO"/> </category>
<category name="XL_INTG.SAPHRMS"> <priority value="INFO"/> </category>
After you enable logging, the log information is written to the following file:
JBoss_home/server/default/log/server.log
OC4J
To enable logging:
Add the following lines in the OIM_home/xellerate/config/log.properties file:
log4j.logger.XELLERATE=log_level log4j.logger.XL_INTG.SAPHRMS=log_level
In these lines, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO log4j.logger.XL_INTG.SAPHRMS=INFO
After you enable logging, the log information is written to the following file:
OC4J_home/opmn/logs/default_group~home~default_group~1.log
This section describes the procedures involved in configuring the target system. You may need the assistance of the SAP Basis administrator to perform some of these procedures.
Configuring the target system involves the following tasks:
The following information is required to configure the target system:
Note:
During SAP installation, a system number and client number are assigned to the server on which the installation is carried out. These items are mentioned in the following list.Login details of an admin user having the permissions required to import requests
Client number of the server on which the request is to be imported
System number
Server IP address
Server name
User ID of the account to be used for connecting to the SAP application server
Password of the account to be used for connecting to the SAP application server
The User Group field is one of the fields that hold user data in SAP. F4 values are values of a field that you can view and select from a list. You must create an entry in the BAPIF4T table to be able to view F4 values of the User Group field. To create this entry in the BAPIF4T table:
Run the SM30 transaction on the SAP system.
Enter BAPIF4T as the table name, and then click Maintain. Ignore any warnings or messages that may be displayed.
Click New Entries.
Enter XUCLASS as the data element and ZXL_PARTNER_BAPI_F4_AUTHORITY as the function name.
Note:
If an entry already exists for theXUCLASS data element, then do not change its value.Save the entry that you create, and then exit.
You must import the request to create the following custom objects in the SAP system.
| Object Type | Object Name |
|---|---|
| Package | ZXLH |
| Function Group | ZXLHRCON |
| Message Class | ZXLHBAPI |
| Business Object Types | ZXLHEMP |
| Table | ZBPEMPLOYEES
ZXLHBAPIMODE ZXLHEMPLOYEE ZXLHINFO ZXLHRECON ZXLHSTRING |
| Program | ZXLHEMP |
The xlhsapcar.sar file contains the definitions for these objects. When you import the request represented by the contents of the xlhsapcar.sar file, these objects are automatically created in SAP. This procedure does not result in any change in the existing configuration of SAP.
Importing the request into SAP involves the following steps:
The two files, Data file and Cofile, that constitute the request are compressed in the xlhsapcar.sar file. You can use the SAPCAR utility to extract these files.
To download the SAPCAR utility from the SAP Help Web site:
Log on to the SAP Web site at
Click OK to confirm that the certificate displayed is the certificate assigned for your SAP installation.
Enter your SAP user name and password to connect to the SAP service marketplace.
Click Downloads, SAP Support Packages, Entry by Application Group, and Additional Components.
Select SAPCAR, SAPCAR 6.20, and the operating system. The download object is displayed.
Select the Object check box, and then click Add to Download Basket.
Specify the directory in which you want to download the SAPCAR utility. For example: C:/xlhsapcar
To extract the Data file and Cofile components of the request:
Copy the xlhsapcar.sar file into the directory in which you downloaded the SAPCAR utility.
The xlhsapcar.sar file is in the BAPI directory inside the installation media directory.
In a command window, change to the directory in which you store the SAPCAR utility and the xlhsapcar.sar file.
Enter the following command to extract the Data file and Cofile components of the request:
sapcar -xvf xlhsapcar.sar
The format of the extracted files is similar to the following:
K900874.I47 (Cofile)
R900874.I47 (Data file)
To perform the request import operation:
Note:
You would need the SAP Basis administrator's assistance to perform the following steps.Copy the Data file and Cofile to the required locations on the SAP server.
Import the request into SAP.
Check the log file to determine whether or not the import was successful.
To display the log file:
Run the STMS transaction.
The list of transport requests is displayed.
Select the transport request number corresponding to the request that you import.
The transport request number is the same as the numeric part of the Cofile or Data file names. In Step 3 of the preceding procedure, for the sample Cofile (K900874.I47) and Data file (R900874.I47), the transport request number is 900874.
Click the log file icon.
If the return code displayed in the log file is 4, then it indicates that the import ended with warnings. This may happen if the object is overwritten or already exists in the SAP system. If the return code is 8 or a higher number, then there were errors during the import.
Confirm the import of the request by running the SE80 transaction and checking the ZXLH package in the ABAP objects.
As mentioned in the "Files and Directories That Comprise the Connector" section, the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.
To import the connector XML file into Oracle Identity Manager:
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 SAPHRResourceObject.xml file, which is in the OIM_home/xellerate/XLIntegrations/saphrms/xml directory. Details of this XML file are shown on the File Preview page.
Note:
The connector version is also displayed on this page.Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the SAP HRMS IT resource is displayed.
Specify values for the parameters of the SAP HRMS IT resource. Refer to the table in the "Defining IT Resources" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the SAP HRMS IT resource type is displayed.
Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.
See Also:
If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.Click View Selections.
The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.
Click Import. The connector XML file is imported into Oracle Identity Manager.
After you import the connector XML file, proceed to the "Configuring Reconciliation" section.
You must specify values for the SAP HRMS IT resource parameters listed in the following table.
| Parameter | Description | Sample Value |
|---|---|---|
SAPClient |
Port number to connect to the target system | 800 |
SAPHost |
Server address of the target system | 172.20.30.267 |
SAPLanguage |
Language of communication | The default is English (EN). |
SAPPassword |
Password to connect to the target system | NA |
SAPSystemNo |
SAP system number | 00 |
SAPType |
SAP system name | R3 |
SAPUser |
SAP user ID | xellerate |
SAPsnc_mode |
Specifies whether or not SNC is to be used to secure communication between Oracle Identity Manager and the target system
The value is 1 if SNC is enabled. Otherwise, it is 0. Other SNC values are required only if this parameter is set to 1. Note: It is recommended that you enable SNC to secure communication with the target system. |
0 |
snc_lib |
Location of the SNC library file | c://usr//sap//sapcrypto.dll |
snc_myname |
Name of the SNC system | p:CN=TST, OU=SAP, O=ORA, C=IN |
snc_partnername |
Name of the partner system, the system on which SAP is installed | p:CN=I47, OU=SAP, O=ORA, C=IN |
snc_qop |
This parameter controls the protection level (quality of protection, QOP) at which data is transferred. The default value is 3. Valid values are:
This is required only if SNC is enabled. |
3 |
TimeStamp |
For the first reconciliation run, the time-stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter. | The following are sample timestamp values:
English: French: Japanese: |
CustomizedReconQuery |
Query condition on which reconciliation must be based
If you specify a query condition for this parameter, then the target system records are searched based on the query condition. If you want to reconcile all the target system records, then do not specify a value for this parameter. The query can be composed with the AND (&) and OR (|) logical operators. For more information about this parameter, refer to the "Partial Reconciliation" section. |
firstname=John&lastname=Doe |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
Oracle Identity Manager uses a Java application server. To connect to the SAP system application server, this Java application server uses the Java connector (sapjco.jar) and RFC (librfccm and libsapjcorfc files). If required, you can use Secure Network Communication (SNC) to secure such connections.
Note:
The Java application server used by Oracle Identity Manager can be IBM WebSphere, BEA WebLogic, or JBoss Application Server.This section discusses the following topics:
The following are prerequisites for configuring the connector to use SNC:
SNC must be activated on the SAP application server.
You must be familiar with the SNC infrastructure. You must know which Personal Security Environment (PSE) the application server uses for SNC.
To install the security package on the Java application server used by Oracle Identity Manager:
Extract the contents of the SAP Cryptographic Library installation package.
The SAP Cryptographic Library installation package is available for authorized customers on the SAP Service Marketplace Web site at
http://service.sap.com/download
This package contains the following files:
SAP Cryptographic Library (sapcrypto.dll for Microsoft Windows or libsapcrypto.ext for UNIX)
A corresponding license ticket (ticket)
The configuration tool, sapgenpse.exe
Copy the library and the sapgenpse.exe file into a local directory. For example: C:/usr/sap
Check the file permissions. Ensure that the user under which the Java application server runs is able to run the library functions in the directory into which you copy the library and the sapgenpse.exe file.
Create the sec directory inside the directory into which you copy the library and the sapgenpse.exe file.
Note:
You can use any names for the directories that you create. However, creating theC:\usr\sap\sec (or /usr/sap/sec) directory is an SAP recommendation.Copy the ticket file into the sec directory. This is also the directory in which the Personal Security Environment (PSE) and credentials of the Java application server are generated.
See Also:
The "Configuring SNC" sectionSet the SECUDIR environment variable for the Java application server user to the sec directory.
Note:
From this point onward, the term SECUDIR directory is used to refer to the directory whose path is defined inSECUDIR environment variable.Set the SNC_LIB environment variable for the user of the Java application server to the cryptographic library directory, which is the parent directory of the sec directory.
To configure SNC:
Either create a PSE or copy the SNC PSE of the SAP application server to the SECUDIR directory. To create the SNC PSE for the Java application server, use the sapgenpse.exe command-line tool as follows:
To determine the location of the SECUDIR directory, run the sapgenpse command without specifying any command options. The program displays information such as the library version and the location of the SECUDIR directory.
Enter a command similar to the following to create the PSE:
sapgenpse get_pse -p PSE_Name -x PIN Distinguished_Name
The following is a sample distinguished name:
CN=SAPJ2EE, O=MyCompany, C=US
The sapgenpse command creates a PSE in the SECUDIR directory.
Create credentials for the Java application server.
The Java application server must have active credentials at run time to be able to access its PSE. To check whether or not this condition is met, enter the following command in the parent directory of the SECUDIR directory:
seclogin
Then, enter the following command to open the PSE of the server and create the credentials.sapgenpse file:
seclogin -p PSE_Name -x PIN -O [NT_Domain\]user_ID
The user_ID that you specify must have administrator rights. PSE_NAME is the name of the PSE file.
The credentials file, cred_v2, for the user specified with the -O option is created in the SECUDIR directory.
Exchange the public key certificates of the two servers as follows:
Note:
If you are using individual PSEs for each certificate of the SAP server, then you must perform this procedure once for each SAP server certificate. This means that the number of times you must perform this procedure is equal to the number of PSEs.Export the Oracle Identity Manager certificate by entering the following command:
sapgenpse export_own_cert -o filename.crt -p PSE_Name -x PIN
Import the Oracle Identity Manager certificate into the SAP application server. You may require the SAP administrator's assistance to perform this step.
Export the certificate of the SAP application server. You may require the SAP administrator's assistance to perform this step.
Import the SAP application server certificate into Oracle Identity Manager by entering the following command:
sapgenpse maintain_pk -a serverCertificatefile.crt -p PSE_Name -x PIN
Configure the following parameters in the SAP HRMS IT resource object:
SAPsnc_lib
SAPsnc_mode
SAPsnc_myname
SAPsnc_partnername
SAPsnc_qop
See Also:
The "Defining IT Resources" section