Release 3.0.1
Part Number A90151-01
 Home |
 Book List |
 Contents |
 Index |  Master Index |  Feedback |
| Oracle Internet Directory Administrator's Guide Release 3.0.1 Part Number A90151-01 |
|
If you store employee data in Oracle Internet Directory, and if you use Oracle Human Resources to create, modify, and delete that data, then you must ensure that the data is synchronized between the two. The Oracle Human Resources agent enables you to do this.
This chapter introduces the Oracle Human Resources agent and explains how to deploy it. It contains these topics:
The Oracle Human Resources agent enables you to import a subset of employee data from Oracle Human Resources into Oracle Internet Directory. It is installed, with a default configuration, along with Oracle Internet Directory. It is ready to run out of the box.
The Oracle Human Resources agent is deployed in the Oracle Directory Integration platform as a partner agent. You can schedule it to run at any time, configuring it to extract incremental changes from the Oracle Human Resources system as often as every second. You can also set and modify attribute mapping between Oracle Human Resources and Oracle Internet Directory.
The Oracle Human Resources agent executable name is odihragent and is located in the $ORACLE_HOME/ldap/dip/bin directory. You can manage the Oracle Human Resources agent by using Oracle Directory Manager.
Table 27-1 lists the tables in the Oracle Human Resources schema, most of whose attributes you can import into Oracle Internet Directory:
| Table Name | Alias Used in the Agent Config Info Field |
|---|---|
|
PER_PEOPLE_F |
PER |
|
PER_ADDRESSES |
PA |
|
PER_PERIOD_OF_ SERVICE |
PPS |
|
PER_PERSON_TYPE |
PPT |
All of these tables are visible if the login to the Oracle Human Resources database is done with the apps account.
Because attributes can be added or deleted at runtime from the configuration file, the Oracle Human Resources agent dynamically creates a SQL statement that selects and retrieves only the required attributes.
Table 27-2 shows some of the fields in the Oracle Human Resources user interface. These fields appear when you add or modify employee data.
This section contains these topics:
To deploy the Oracle Human Resources agent, you must create a directory integration profile for it in Oracle Internet Directory. You can do this by using the procedures outlined in Chapter 24, "Managing the Oracle Directory Integration Server". However, if you have a server installation--that is, a typical installation--then you can use the default integration profile that the Oracle Universal Installer created in the directory for you. A client-only installation does not include this integration profile.
The integration profile contains several attributes and attribute values. Table 27-3 lists these attributes by both their friendly names as used by Oracle Directory Manager--for example, Agent Name--and their actual names--for example, orclodipAgentName. It provides a description of each attribute, and, where appropriate, the default values in the Oracle Human Resources agent integration profile. Some cells in Table 27-3 contain italicized text providing information and instructions specific to the Oracle Human Resources agent.
| Attribute | Description |
|---|---|
|
General Information |
|
|
Agent Name ( |
Unique name by which the agent is identified in the system. This name is used as an RDN component of the DN that identifies the integration profile. The name can contain only alpha-numeric characters. This attribute is mandatory. You can modify this attribute. The default name is OracleHRAgent. However, if there is already an Oracle Human Resources agent in the system with this name, then you must change the Oracle Human Resources agent name to something else. |
|
Agent Control ( |
Indicates whether the agent is enabled or disabled. Valid values are This attribute is mandatory. You can modify this attribute. You must set this value to ENABLE. |
|
Agent Password ( |
This is the password that the directory integration server uses to bind to Oracle Internet Directory on behalf of the agent. This attribute is mandatory. You can modify this attribute. Set this value to whatever password you want the Oracle Human Resources agent to use. |
|
Host Name ( |
Host on which the agent runs. This attribute is mandatory. You can modify this attribute. |
|
Synchronization Mode ( |
The direction of synchronization between Oracle Internet Directory and a connected directory
This attribute is mandatory. You can modify this attribute. Note: Oracle Internet Directory release 3.0.1 support import operations only. |
|
Scheduling Interval ( |
Time interval in seconds after which a connected directory is synchronized with Oracle Internet Directory. This attribute is mandatory. You can modify this attribute. |
|
Number of Retries ( |
Maximum number of times the directory integration server would try to perform synchronization before disabling it completely. This attribute is mandatory. You can modify this attribute. |
|
Execution Information |
|
|
Agent Execution Command ( |
Agent executable name and argument list used by the directory integration server to execute the agent. This attribute is mandatory. You can modify this attribute. The default is:
You must set the value in the argument connect=hrdb to the connect string of the Oracle Human Resources system database. |
|
Connected Directory Account ( |
Valid user account in the Oracle Human Resources system that you want to access changes in the Oracle Human Resources system. This information is passed by the directory integration server to the agent in the command line at time of agent's invocation. This attribute is optional. You can modify this attribute. |
|
Connected Directory Account Password ( |
Password for the user account accessing the Oracle Human Resources system. It is passed by the directory integration server to the agent at time of agent invocation. This attribute is optional. You can modify this attribute. |
|
Agent Config Info ( |
Any configuration information that you want an agent to store in Oracle Internet Directory. It is passed by the directory integration server to the agent at time of agent invocation. The information is stored as a binary attribute and the directory integration server does not have any knowledge of its content. This is a binary value. The value stored in this attribute represents data to be synchronized from Oracle Human Resources. It is discussed in "Customizing the List of Attributes to Be Synchronized with Oracle Internet Directory". This attribute is optional. You can modify this attribute. |
|
Datafile Format ( |
The type of the import or export file. Types are either LDIF or Tagged. This attribute is optional. You can modify this attribute. |
|
Mapping Information |
|
|
Subscribed Domain ( |
DN of the subtree in Oracle Internet Directory to which an agent subscribes for all the changes exported by the agent. |
|
DN Construct Rule ( |
Rule for generating DN for an entry in Oracle Internet Directory from its RDN during an import operation. For example, for
The default is This attribute is optional. You can modify this attribute. You must change this value to an appropriate DN of the entry under which you want to create the employee entries |
|
Synchronization Key ( |
Attribute that uniquely identifies records in a connected directory. This is used as a key to perform synchronization between Oracle Internet Directory and the connected directory.
The default is This attribute is optional. You can modify this attribute. |
|
Mapping Filter ( |
Attribute used to filter the changes in Oracle Internet Directory that are not required for a connected directory. |
|
Attribute Mapping Rules ( |
The mapping rules for mapping data between a connected directory and Oracle Internet Directory, stored as a binary attribute. This is a binary value. The value stored in this attribute is discussed under "Mapping Rules". This attribute is optional. You can modify this attribute. |
|
Status Information |
|
|
Next Synchronization Time ( |
Time when the agent is to be executed next. Its format is
The default is This attribute is mandatory. You can modify this attribute. |
|
Synchronization Status ( |
Execution status of the agent. This attribute is mandatory. It is read-only. |
|
Synchronization Errors ( |
Error message for the last error encountered. This attribute is multivalued. This attribute is mandatory. It is read-only. |
|
Con Dir Last Applied Change Time ( |
Time when the last change from the connected directory was applied to Oracle Internet Directory.Its format is
The default is This attribute is mandatory. You can modify this attribute. |
|
Con Dir Last Applied Change Num ( |
For agents performing import operations, indicates the last change from the connected directory that has been applied to Oracle Internet Directory. |
|
OID Last Applied Change Number ( |
Time when the last change from Oracle Internet Directory was applied to the local directory. |
You can customize the list of Oracle Human Resources attributes you want to synchronize with Oracle Internet Directory. To help you do this, Oracle Internet Directory includes a default list of Oracle Human Resources attributes to be synchronized. You can modify this list by including additional attributes in it, or excluding some from it.
The default attribute list is stored in the orclodipAgentConfigInfo attribute as part of the integration profile. The integration profile is loaded into Oracle Internet Directory as part of a typical installation. The list is also contained in the file named oraclehragent.cfg.master and is located under the $ORACLE_HOME/ldap/odi/conf directory.
The columns in the default list of Oracle Human Resources attributes are:
The oraclehragent.cfg.master file contains the following:
ATTRNAME:COLUMN_NAME:TABLE_NAME:FORMAT:MAP
PersonId:person_id:PER:NUMBER:Y
PersonType:person_type_id:PER:NUMBER:Y
PersonTypeName:system_person_type:PPT:ASCII:Y
LastName:last_name:PER:ASCII:Y
StartDate:start_date:PER:DATE:Y
BirthDate:date_of_birth:PER:DATE:Y
EMail:email_address:PER:ASCII:Y
EmployeeNumber:employee_number:PER:NUMBER:Y
FirstName:first_name:PER:ASCII:Y
FullName:full_name:PER:ASCII:Y
knownas:known_as:PER:ASCII:Y
MaritalStatus:marital_status:PER:ASCII:Y
middleName:middle_names:PER:ASCII:Y
country:country:PA:ASCII:Y
socialsecurity:national_identifier:PER:ASCII:Y
Sex:sex:PER:ASCII:Y
Title:title:PER:ASCII:Y
suffix:suffix:PER:ASCII:Y
street1:address_line1:PA:ASCII:Y
zip:postal_code:PA:ASCII:Y
Address1:address_line1:PA:ASCII:Y
Address2:address_line2:PA:ASCII:Y
Address3:address_line3:PA:ASCII:Y
TelephoneNumber1:telephone_number_1:PA:ASCII:Y
TelephoneNumber2:telephone_number_2:PA:ASCII:Y
TelephoneNumber3:telephone_number_3:PA:ASCII:Y
town_or_city:town_or_city:PA:ASCII:Y
state:region_2:PA:ASCII:Y
Start_date:effective_start_date:PER:DATE:Y
End_date:effective_end_date:PER:DATE:Y
per_updateTime:last_update_date:PER:DATE:Y
pa_updateTime:last_update_date:PA:DATE:Y
To include additional Oracle Human Resources attributes for synchronization, follow these steps:
oraclehragent.cfg.master file and name it anything other than Agent_Name.cfg. This is because the directory integration server generates a configuration file with that name, using it to pass the configuration information to the Oracle Human Resources agent at run time.
You also need to assign an attribute name to the column name. This acts as the output tag by which this attribute is identified in the output file. This tag is also used in the mapping rules to establish a rule between the Oracle Human Resources attribute and the Oracle Internet Directory attribute.
You must also ensure that the map column--that is, the last column in the record--is set to the value Y.
|
Note:
If you add a new attribute in the attribute list, then you must define a corresponding rule in the |
orclodipAgentConfigInfo attribute by using the ldapmodify tool. The changes take effect the next time the agent runs.
To exclude an Oracle Human Resources attribute that is currently being synchronized with Oracle Internet Directory:
oraclehragent.cfg.master file and name it anything other than Agent_Name.cfg. This is because the directory integration server generates a configuration file with that name, using it to pass the configuration information to the Oracle Human Resources agent at run time.
orclodipAgentConfigInfo attribute by using the ldapmodify tool. The changes take effect the next time the agent runs.
Attribute mapping rules govern how the directory integration server converts attributes between Oracle Human Resources and Oracle Internet Directory. You can customize the mapping rules you want the directory integration server to use.
To help you do this, Oracle Internet Directory includes a default list of Oracle Human Resources mapping rules for the Oracle Human Resources system. You configure, modify, and delete mapping rules by editing this list.
The default list of mapping rules is stored in the orclodipAttributeMappingRules attribute in the integration profile. In addition, the rules are also in the file named oraclehragent.map.master located under the $ORACLE_HOME/ldap/odi/conf directory.
The oraclehragent.map.master file contains the following:
OIDCLASSNAME:OIDATTRIBNAME:OIDATTRIBTYPE:CONNDIRCLASS:CONNDIRATTRIBNAME:CONNDIRATTRIBTYPE:MAPPINGRULE
person:cn: : :1: :copy_string,lastname;append_string,firstname,,
person:sn: : :LastName: :COPY_STRING
#:start_date: ::StartDate::Copy_String_lower
person:rdn: : : : :trim_string,email,@
#organizationalperson:birthday : : :BirthDate: :copy_string
inetOrgperson:mail: : :EMail: :copy_String
inetOrgperson:employeenumber: : :EmployeeNumber: :copy_string
person:cn: : :FirstName: :copy_string
person:cn: : :2 ::copy_string,firstname;append_string,lastname,,
country:c: : :country: :copy_string
#person:ssn: : :socialsecurity: :copy_string
#person:sex: : :Sex: :copy_string
#organizationalperson:title: : :Title: :copy_string
#person:postaladdress: : :Address1: :copy_string
#person:postaladdress: : :Address2: :copy_string
#person:postaladdress: : :Address3: :copy_string
person:telephonenumber: : :TelephoneNumber1: :copy_string
person:telephonenumber: : :TelephoneNumber2: :copy_string
person:telephonenumber: : :TelephoneNumber3: :copy_string
locality:l: : :town_or_city: :copy_string
:changetype: : :changetype: :copy_string
person:userpassword: : : : :literal,welcome
#orclperson:uid: : :EMail: :trim_String,email,@
inetOrgperson:cn: : :EMail: :trim_String,email,@
inetOrgperson:cn: : :lastname: :copy_string
#inetOrgperson:dnqualifier: : :EMail: :copy_string
locality:st: : :state: :copy_string
locality:street: : :street1: :copy_string
locality:postalCode: : :zip: :copy_string
The default mapping rules in the orclodipAttributeMappingRules attribute correspond to the default Oracle Human Resources attributes list in the orclodipAgentConfigInfo attribute. To establish mappings between Oracle Human Resources attributes and Oracle Internet Directory attributes, the mapping rules use the ATTRNAME column in each record of the Oracle Human Resources attributes list.
To create Oracle Human Resources attribute mapping rules, you modify the orclodipAttributeMappingRules attribute. To do this:
oraclehragent.map.master file and name it anything other than Agent_Name.map, which is reserved for use by the directory integration server.
orclodipAttributeMappingRules attribute by using the ldapmodify tool. The changes take effect the next time the agent runs.
To modify existing Oracle Human Resources attribute mapping rules, you modify the orclodipAttributeMappingRules attribute. To do this:
oraclehragent.map.master file and name it anything other than Agent_Name.map, which is reserved for use by the directory integration server.
orclodipAttributeMappingRules attribute by using the ldapmodify tool. The changes take effect the next time the agent runs.
To delete existing Oracle Human Resources attribute mapping rules, you modify the orclodipAttributeMappingRules attribute. To do this:
oraclehragent.map.master file and name it anything other than Agent_Name.map, which is reserved for use by the directory integration server.
orclodipAttributeMappingRules attribute by using the ldapmodify tool. The changes take effect the next time the agent runs.
This section explains how to set up synchronization from Oracle Human Resources to Oracle Internet Directory.
During synchronization, the Oracle Directory Integration platform uses an import file. This file can contain a few or many changes that the Oracle Human Resources agent extracts from the Oracle Human Resources system.
This file is in the tagged format and acts as input to the Oracle directory server. It is named Oracle_HR_Agent_Name.data and is located in $ORACLE_HOME/ldap/odi/import.
You do not need to modify this file, but the last version of it is stored in the directory $ORACLE_HOME/ldap/odi/import/archive to help you with troubleshooting.
This is an example of an Oracle Human Resources change record in the import file:
FirstName: John LastName: Liu EmployeeNumber: 12345 Title: Mr. Sex: M MaritalStatus: Married TelephoneNumber: 123-456-7891 Mail: Jliu@my_company.com Address: 100 Jones Parkway City: MyTown
To prepare for synchronization between Oracle Human Resources and Oracle Internet Directory, follow these steps:
orclodipAgentControl attribute to ENABLE. This indicates that the Oracle Human Resources agent is ready to run.
"Managing the Oracle Directory Integration Server" for instructions about starting and stopping the directory integration server
See Also:
Once the Oracle Human Resources system, Oracle Internet Directory, and the directory integration server are running and the Oracle Human Resources agent is enabled, the directory integration server automatically starts synchronizing changes from the Oracle Human Resources system into Oracle Internet Directory. It follows this process:
orclodipNextSynchronizationTime attribute, the directory integration server executes the Oracle Human Resources agent.
orclodipConDirLastAppliedChgTime attribute in the integration profile. It writes the changes into the Oracle Human Resources import file, namely, $ORACLE_HOME/ldap/odi/import/HR_Agent_Name.data. It extracts only the attributes specified in the orclodipAgentConfigInfo attribute of the integration profile.
orclodipConDirLastAppliedChgTime attribute to the current time.
$ORACLE_HOME/ldap/odi/import/archive.
There are two ways to bootstrap Oracle Internet Directory from Oracle HR:
orclodipConDirLastAppliedChgTime to a time before Oracle Human Resources was installed.
Chapter 26, "Bootstrapping a Directory in the Oracle Directory Integration Platform" for further instructions about initial bootstrapping
See Also:
|
 Copyright © 1996-2001, Oracle Corporation. All Rights Reserved. |
|