Using the Adapter Factory

3.1 Introduction to Adapters

Adapters are Java classes that simplify the integration between access rights management application and other software solutions.

To be effective, it must be possible to integrate an access rights management application, such as Oracle Identity Manager, with other software solutions. This is necessary not only because there are many resources, but also because there is no single integration standard for connecting to these resources.

The traditional way to tackle this challenge is by using the common functionality that is supported by all the integrations. To do this, you need developers who can write this code. In addition, every time an existing software resource is modified, or a new one is added, you must write more code.

The Adapter Factory is a code-generation tool provided by Oracle Identity Manager. It helps you create Java classes, known as adapters, that simplify the integration challenge.

Note:

Oracle Identity Manager can connect to external systems such as databases and directory servers by using Java APIs for JDBC and LDAP. In addition, for all other APIs, such as C, C++, VB, and COM/DCOM, you can create a Java wrapper so that Oracle Identity Manager can communicate with the API directly.

A resource has an associated provisioning process, which in turn has various tasks associated with it. Each task in turn has an adapter associated to it, which in turn can connect to the target resource to carry out the required operations.

An adapter provides the following benefits:

It extends the internal logic and functionality of Oracle Identity Manager.
It interfaces with any software resource, by connecting to that resource by using the API of the resource.
It enables the integration between Oracle Identity Manager and an external system.
It can be generated without manually writing code. However, Oracle Identity Manager does not restrict you from writing your own code for creating adapters.
It is lightweight and specific to your needs.
It can be maintained easily because all of the definitions for the adapter are stored in a repository. This repository can be edited through a GUI.
One Oracle Identity Manager user can retain the domain knowledge about the integration, while another user can maintain the adapter.
It can be modified and upgraded efficiently.

Adapters can be developed for a range of tasks:

A process task adapter, which allows Oracle Identity Manager to automate the completion of a process task.
A task assignment adapter, which enables Oracle Identity Manager to automate the assignment of a process task to a user or group.
A rule generator, which incorporates business rules to the fields of either an Oracle Identity Manager form or a user-defined form (created by using the Form Designer form), so these fields can be populated automatically and saved to the Oracle Identity Manager database.
A pre-populate adapter, which is a specific type of rule generator adapter that can be attached to a user-created form field. The data generated by this type of adapter can appear either automatically or manually. In addition, it uses criteria that enable Oracle Identity Manager to determine which pre-populate adapter will be applied to the designated form field. It populates the designated form field without saving this information to the Oracle Identity Manager database.
An entity adapter, which is attached to an Oracle Identity Manager or user-created form field. Oracle Identity Manager triggers an entity adapter on preinsert, preupdate, predelete, postinsert, postupdate, or postdelete. After this occurs, the field to which the adapter is attached is populated automatically and saved to the Oracle Identity Manager database.

Note:

Oracle Identity Manager also allows you to create postprocessing handlers on entities, such as user, role, and organization.

3.2 Types of Adapters

The types of adapters include Rule Generator, Entity, Task Assignment, Prepolulate, and Process Task adapters.

This section provides details about the following adapter types:

3.2.1 Rule Generator Adapters

A rule generator adapter incorporates business rules to the fields of a form so that the fields can be populated automatically and saved to the database.

Certain business rules must be applied to perform field validations and enter default values into the forms which either come packaged with Oracle Identity Manager or are created by Oracle Identity Manager users. For example, for the Users form, you might want Oracle Identity Manager to generate the User ID automatically by concatenating the user's first name and last name.

To do this, you must create a specific type of adapter, which is designed to modify the field value in a form. This type of adapter, which can generate, modify, or verify the value of a form field automatically, is called a rule generator. Oracle Identity Manager triggers a rule generator on preinsert and preupdate.

After you create this adapter and attach it to a form, Oracle Identity Manager automatically updates the field value for all records of that form, and saves this information to the Oracle Identity Manager database.

If you create a rule generator that contains adapter variables, you must map these adapter variables to their proper locations. Otherwise, the adapter will not be functional.

You can also attach this type of adapter to a provisioning process. Once the process is provisioned to a target user or organization, Oracle Identity Manager will trigger the associated rule generator.

On occasion, a rule generator which has been assigned to a provisioning process might no longer be needed to complete the process. If this happens, you can remove the rule generator from the provisioning process. Similarly, after you attach one rule generator to a form field, you can connect a different rule generator to that form field. When this occurs, you must first remove the rule generator currently attached to the form field.

3.2.2 Entity Adapters

An entity adapter is attached to a form field. Oracle Identity Manager triggers an entity adapter on preinsert, preupdate, predelete, postinsert, postupdate, or postdelete. After this occurs, the field to which the adapter is attached is populated automatically and saved to the database.

Similar to rule generator adapters, entity adapters are also responsible for generating, modifying, or verifying the value of a form field automatically, and saving this information to the Oracle Identity Manager database.

Note:

In Oracle Identity Governance 12c (12.2.1.3.0), creating new entity adapters and modifying existing entity adapters are not supported..

Some differences between rule generators and entity adapters are:

Execution schedule. Entity adapters can be triggered by Oracle Identity Manager on preinsert, preupdate, predelete, postinsert, postupdate, and postdelete. A rule generator adapter can be executed only on preinsert and preupdate.
Manual field value modification. The adapter populates the form field to which an entity adapter is attached. An Oracle Identity Manager user should not edit this value because the entity adapter will overwrite this modification. As a result, the modification will not be saved to the database.

Similarly, the adapter also populates the form field to which a rule generator adapter is attached. However, an Oracle Identity Manager user can edit this value because this modification will take precedence over the value that the rule generator adapter generates. Because of this, the modification will be saved to the database.
Background color of form field. If a rule generator is attached to a form field, the field will appear in a particular background color such as pink. This is a visual indicator that the field has a rule generator attached to it. On the other hand, when an entity adapter is attached to a form field, the field will not have a distinct background color.

3.2.3 Task Assignment Adapters

A task assignment adapter enables the automation of the assignment of a process task to a user or group.

For a process task that must be completed manually, you can configure Oracle Identity Manager to automate the assignment of the task to either a specific user or a user who belongs to a particular role. This is achieved through the use of a task assignment adapter. Task assignment adapters are used only for assigning a task to a particular user or role.

When a task that is associated with specific provisioning process is created using the Tasks tab in the Process Definition form of the Design Console, you can choose the rule that decides if adapter will be picked up for execution. Note that this rule is defined in the Rule Definition form of the Design Console. An example of a rule is "Target User's Org name is XYZ. If this rule is satisfied, then the corresponding task assignment is picked up. However, you can have multiple rules defined and used while deciding task assignment. For multiple rules, Oracle Identity Manager associates priority with the task assignment functionality to decide the order in which the rule determination must occur. When the rule is determined, corresponding task assignment is run.

Note:

In other words, the task assignment rule allows Oracle Identity Manager to decide whether to assign a process task to a user or role. The task assignment adapter enables Oracle Identity Manager to determine which user or role will be the recipient of the process task.

For this example, Oracle Identity Manager will trigger the Associate Adapter with User rule first (because it has the highest priority). If the condition of this rule is TRUE, it is successful. As a result, Oracle Identity Manager will associate the related task assignment adapter (the Assign Task to User adapter) with the process task.

On the other hand, when the condition of a rule is FALSE, the rule has failed. Oracle Identity Manager triggers the rule with the next highest priority. If this rule is successful, then Oracle Identity Manager assigns the designated adapter to the target process task.

So, in this example, if the Associate Adapter with User rule fails, then Oracle Identity Manager triggers the Associate Adapter with Role rule. If this rule is successful, then Oracle Identity Manager associates the related task assignment adapter (the Assign Task to Role adapter) to the process task.

After assigning a rule to a task assignment adapter, if this type of adapter contains adapter variables, you must map these variables to their proper locations. Otherwise, the adapter will not be functional.

Finally, when a task assignment adapter becomes invalid, or is no longer necessary for Oracle Identity Manager to allocate the process task to a user or group, you must remove the adapter from the task.

3.2.4 Prepopulate Adapters

A pre-populate adapter is a specific type of rule generator adapter that can be attached to a user-created form field. The data generated by this type of adapter can appear either automatically or manually. In addition, it uses criteria that enable Oracle Identity Manager to determine which pre-populate adapter will be applied to the designated form field. It populates the designated form field without saving this information to the database.

Sometimes a user-created form contains both fields that can be populated by Oracle Identity Manager and fields into which an Oracle Identity Manager user must enter data. When the information that the user types into a field is contingent upon the data that appears in a system-generated field, Oracle Identity Manager must first populate this field. When the form is displayed, the user can view the system-generated data to enter information into the appropriate fields.

This is achieved by creating a type of rule generator known as a prepopulate adapter. By attaching it to a field designated to be system-generated, you enable Oracle Identity Manager to automatically populate this field with the appropriate information, without saving this information to the Oracle Identity Manager database.

The data generated by a prepopulate adapter can appear automatically or it can be manually entered. Oracle Identity Manager displays this information automatically when the Auto-prepopulate check box is selected for a provisioning process. When this check box is cleared, an Oracle Identity Manager user must manually generate the displaying of the data that is generated by the prepopulate adapter. To do this, click the prepopulate button on the form section of the Direct Provisioning wizard in the Web client, while provisioning the form to a user.

You can use the same prepopulate adapter for different form fields. In addition, you can designate multiple prepopulate adapters to be associated with a particular field. As a result, Oracle Identity Manager must know which prepopulate adapter it must select for the form field. This requires the use of prepopulate rules. These rules enable Oracle Identity Manager to select one prepopulate adapter, which is associated with a form field, when this prepopulate adapter is assigned to the field.

Each prepopulate adapter has a prepopulate rule associated with it. In addition every rule has a priority number which indicates the order in which Oracle Identity Manager triggers it.

For example, Oracle Identity Manager can trigger the Rule for Uppercase User ID rule first because it has the highest priority. If the condition of this rule is TRUE, it is successful. As a result, Oracle Identity Manager will attach the related prepopulate adapter (the Display Uppercase Letters for User ID adapter) to the User ID field.

On the other hand, when the condition of a rule is FALSE, the rule has failed. Oracle Identity Manager will trigger the rule with the next highest priority. If this rule is successful, Oracle Identity Manager will attach the associated adapter to the designated field.

So, in this example, if the Rule for Uppercase User ID rule fails, Oracle Identity Manager will trigger the Rule for Lowercase User ID rule. If this rule is successful, Oracle Identity Manager will attach the related prepopulate adapter (the Display Lowercase Letters for User ID adapter) to the User ID field.

After assigning a rule to a prepopulate adapter, if this type of adapter contains adapter variables, you must map these adapter variables to their proper locations. Otherwise, the adapter will not be functional.

Finally, when a prepopulate adapter associated with a field is no longer valid, you must remove the adapter from the field.

3.2.5 Process Task Adapters

A process task adapter enables Oracle Identity Manager to automatically execute process tasks in provisioning processes.

Each process and process task has a status, which indicates the stage of its completion. The statuses for a process or process task are listed in the following table in order of importance.

Task Status	Description
C	Completed: This process/process task has been completed successfully.
MC	Manually Completed: This process task has been completed successfully by an Oracle Identity Manager user (that is, manually).
P	Pending: This process/process task is in the process of being completed. All preceding tasks and processes, respectively, have been completed.
PX	Pending Cancellation: This process task will be canceled, but this task has to be completed first before it can be canceled.
R	Rejected: This process/process task has not been completed successfully or has not been approved. The status of rejected process tasks can only be changed to Canceled or Unsuccessfully Completed.
S	Suspended: This process/process task has been put on hold temporarily.
UC	Unsuccessfully Completed: This process task has been set to Completed. However, it had been rejected before.
W	Waiting: This process/process task cannot be completed until all preceding process tasks or processes are completed.
X	This process/process task has been stopped. Its status cannot change anymore

The status level of a process represents the most important status level of its process tasks, which must be completed for the process to be completed. Suppose a process has three process tasks, each process task has a different status level (Completed, Waiting, and Rejected), and all three process tasks must be completed for the process to complete. Because the highest task status level is Rejected, the status level of the process is also Rejected.

A process task can be managed in these ways:

It can be handled manually by using the Object Process Console tab of the Organizations or Users forms, or the Oracle Identity Manager Web Application.
An Oracle Identity Manager process can be configured so that one (or more) of its tasks is triggered automatically once it achieves a status of Pending.

3.3 Adapter Environment and Tools

Adapter environment and tools consist of configuring Oracle Identity Manager to find the appropriate Java APIs, creating adapters by using the Adapter Factory form in the Design Console, and compiling adapters.

This section contains these topics:

3.3.1 Configuring the Adapter Environment

To construct adapter tasks, ensure that Oracle Identity Manager has access to the target API JAR files and third-party applications to which you want to connect.

When your adapter uses Java tasks, you must configure Oracle Identity Manager to find the appropriate Java APIs. To do this, you must place the .jar files that contain these APIs into the Meta Data Store (MDS).

Then, you can access the Java classes associated with these Java APIs and use them in the Java task you are creating.

To configure Oracle Identity Manager to reference JAR and class files:

Open the JavaTasks subdirectory, which can be found within the OIM_HOME/ directory path. For example, C:\oracle\Xellerate\JavaTasks.
Place the JAR file or files into this subdirectory. You can use these files to create Java tasks within an adapter without restarting the server.

Note:

When the Java code is in two different JAR files in the Adapter Factory, and in the adapter tasks if an object from the first JAR file (which has the common or shared code) is passed into the constructor of the next adapter task that is located in the second JAR file, then a compilation error is thrown.

As a workaround for this issue, ensure that the entire Java code is in a single JAR file only.

3.3.2 The Adapter Factory

The Adapter Factory is a code-generation tool that enables you to create Java classes, known as adapters.

An adapter is a Java class created by an Oracle Identity Manager user through the Adapter Factory, which is accessed through the Design Console.

Adapters extend the internal logic and functionality of Oracle Identity Manager. In addition, they interact with any IT resource by connecting to that resource's API.

The Adapter Factory is a code-generation tool provided by Oracle Identity Manager that enables a user to create Java classes, known as adapters. Figure 3-1 shows the Adapter Factory Form in the Design Console.

Figure 3-1 Adapter Factory Form

Description of "Figure 3-1 Adapter Factory Form"

3.3.3 Compiling Adapters

There are various options for compiling adapters, including individual adapters at a time, a set of adapters at once, and all adapters that exist in the database with a single click.

This section describes how to compile adapters automatically and manually. It contains the following topics:

Note:

Verify and ensure that you have the required permissions in the temporary installation directory if adapter compilation fails with the following error:

DOBJ.EVT_NOT_FOUND: H: Event Handler not found.

3.3.3.1 Automatic Compilation of Adapters

Adapters are compiled automatically when you import connector files by using the Deployment Manager. The compiled adapter class files are stored in the Oracle Identity Manager database, as opposed to the file system, from where they are loaded at run time. The following two APIs are available to compile adapters programmatically:

public void compileAdapter (String adapterName): This API compiles a single adapter and stores the compiled classfile in the database. It takes the name of the adapter as a parameter. If the adapter is not found or if there are any errors, the API throws an appropriate exception.
public void compileAll: This API compiles all adapters in a system. If it encounters any errors during compilation, it throws an exception of the type tcBulkException. This exception comprises all the individual errors that the API encounters during compilation.

You can modify the adapters manually if you make any changes.

Note:

You must set the path of the JDK directory in the XL.CompilerPath system property. Otherwise, an error is encountered during the adapter compilation stage when you import an XML file using the Deployment Manager.

Refer to the Default System Properties in Oracle Identity Governance in Administering Oracle Identity Governance for information about setting values of system properties.

3.3.3.2 Compiling Adapters Manually

The Adapter Manager form is located in the Development Tools folder. You use it to compile multiple adapters simultaneously.

To manually compile multiple adapters, perform these steps:

Open the Adapter Manager form.

The Adapter Manager form is in the Development Tools folder. It is used to compile multiple adapters simultaneously, as shown in Figure 3-2.

Figure 3-2 Adapter Manager Form

Description of "Figure 3-2 Adapter Manager Form"
To compile every adapter that resides within the Oracle Identity Manager database, select the Compile All option.

To compile multiple adapters, select the adapters you want to compile. Then, select the Compile Selected option.

To compile all adapters that do not have an OK status, select the Compile Previously Failed option.
Click the Start button.

Oracle Identity Manager will compile the adapters that match the criteria you specified in Step 2.

Tip:

Oracle Identity Manager lets you review the record of any adapter that appears within the Adapter Manager form to see detailed information about the adapter.

To view an adapter's record, select the desired adapter and either double-click its row header, or right-click the adapter, and select the Launch Adapter command from the menu that appears.

3.4 Defining Adapters

Adapters are defined by using the Adapter Factory form in the Development Tools folder of the Design Console.

To define an adapter:

Log in to Oracle Identity Manager Design Console.
Open the Adapter Factory form. This form is in the Development Tools folder in the Design Console.
In the Adapter Name field, enter the name of the adapter, for example, Create Solaris User.

Note:

Although the adapter name can contain special characters, Oracle recommends that you do not use them because there might be run-time errors.
Double-click the Adapter Type lookup field.
The Lookup window is displayed, displaying the five types of Oracle Identity Manager adapters. These are:
- Process Task
- Rule Generator
- Pre-populate Rule Generator
- Entity
- Task Assignment
To enable the adapter to automate a process task, select Process Task (T).
To incorporate business rules into an Oracle Identity Manager or user-defined form field, select Rule Generator (R). For example, for the User ID field of a form, you can configure Oracle Identity Manager to concatenate the initial letter of the user's first name with the user's last name.

You can attach a type of rule generator adapter to a user-created form field, so that it can:
- Display the data, which is generated by the adapter, automatically or manually.
- Use criteria that enable Oracle Identity Manager to determine which adapter is applied to the designated form field.
To attach the adapter to an Oracle Identity Manager or user-defined form field, and have Oracle Identity Manager trigger the adapter on preinsert, preupdate, predelete, postinsert, postupdate, or postdelete, select Entity (E).

To allow the adapter to automate the allocation of a process task to a user or group, select Task Assignment (A).

Tip:

If you create an entity adapter, then an error might be generated while compiling the adapter on computers with less file limits. To avoid this problem, change the file limits in the /etc/security/limits.conf file to the following:

soft nofile 4096

hard nofile 4096

Then, restart Oracle Identity Manager.
Select the type of adapter you want, for example, Process Task (T). Then, click OK.
In the Description field, type a description for the adapter, for example, This adapter is used to create a new user for the Solaris environment.
From the toolbar, click Save.

The adapter is now stored in the Oracle Identity Manager database.

3.5 Tabs of the Adapter Factory Form

The Adapter Factory form consists of tabs that enable you to work with adapter tasks, resources, variable lists, lookups, and responses.

The Adapter Factory form contains the following tabs:

3.5.1 The Adapter Tasks Tab

The Adapter Tasks tab is used to create and manage the atomic function calls of an adapter. These function calls are known as adapter tasks.

The sequence of calls is vital because these calls in turn gets converted into Java statements. In other words, if you put an Else call before an If call, then the adapter is not compiled. In addition, you must understand the logical flow of java program while creating adapter. Analogically, this is like writing an algorithm instead of a program with Java syntax.

3.5.2 The Resources Tab

The Resources tab is used to view the Java APIs being used by the adapter and document a non-Java API file to the adapter.

From the Resources tab, you can:

Click the Java APIs subtab to see the Java APIs that are being used by the adapter.
Click the Other subtab to document a non-Java API file to the adapter, if necessary.

Note:

This Resources tab does not represent resource objects.

3.5.3 The Variable List Tab

The Variable List tab is used to manage adapter variables and map them to literals or adapter references.

For prepopulation adapters, the data is passed to adapter input variables and are processed by using adapter logic. The adapter returns output variable, which is then assigned to process form field.

From the Variable List tab, you can:

Create, modify, and delete adapter variables.
Set the data type and provide a description for each variable.
Map an adapter variable to a literal or an adapter reference. You can also postpone the mapping until it is attached to a process task or a form field.

You also can resolve the value of the adapter variable at run time, when it is attached to a process task and the process task is run. As a result, process-specific data is available to map to this variable.

3.5.4 The Usage Lookup Tab

For a process task or task assignment adapter, the Usage Lookup tab displays the process task to which the adapter is attached, as well as the process of which this process task is a member.

For a rule generator or entity adapter, this tab shows the Oracle Identity Manager form and associated data object to which the adapter is attached. In addition, it displays the execution schedule of the adapter, along with a sequence number that represents the order in which Oracle Identity Manager will trigger the adapter.

For a pre-populate adapter, this tab displays the user-defined form and form field to which the adapter is attached. Also, it shows the pre-populate rule that is associated with the adapter.

3.5.5 The Responses Tab

The Responses tab is used for defining meaningful responses to the process task. These responses depend on the execution result of the adapter.

The various error messages returned by the external system can be mapped to these responses in a way that they make sense in the context of the process task. On attaching the adapter to a process task, the status bucket, which consists of Pending, Completed, and Rejected, of the process task (and subsequently the Object status) can be set, based on the adapter response code.

Tip:

Oracle Identity Manager enables the Responses tab only for process task adapters. If an adapter is a task assignment, rule generator, pre-populate, or entity adapter, Oracle Identity Manager disables this tab.

3.6 Disabling and Re-enabling Adapters

Use the Disable Adapter option in the Adapter Factory form of the Design Console to disable or enable adapters.

To disable an adapter so that it cannot be used with a process task or form field, select the Disable Adapter option, and save the adapter.

To re-enable it, clear the Disable Adapter option, and save the adapter.

3.7 Working With Adapter Variables

Adapter variables are placeholders to map data to the parameters of the adapter tasks at tun time.

For a newly-created adapter to work, you can map data to the parameters of the adapter tasks. For this reason, you create placeholders, also known as adapter variables, to map the data at run time.

Note:

An adapter variable can be reused for all adapter tasks.

Once an adapter variable is not needed for the adapter to run, you can remove it from the adapter. After you have deleted the adapter variable, ensure to recompile the adapter.

This section contains the following topics:

3.7.1 Creating an Adapter Variable

An adapter variable is created from the Variable List tab.

To create an adapter variable:

Select the adapter to which you wish to add an adapter variable, for example, the Create Solaris User adapter.
Select the Variable List tab.
Click Add.

The Add a Variable window is displayed.
When you do not want Oracle Identity Manager to be able to change the adapter variable value after it is activated, select Final.
In the Variable Name field, enter the name of the adapter variable, for example, SolarisUserID.

Caution:

The adapter variable name cannot contain spaces.
From the Type menu, select the classification type of the adapter variable, such as String. The available items are:
- Object
- IT Resource
- String
- Boolean
- Character
- Byte
- Date
- Integer
- Float
- Long
- Short
- Double
Within the Description text area, you can enter explanatory information about the adapter variable.
From the Map To menu, you can map your adapter variable to one of the items listed in Items on the Map To Menu.
Note:

When you select the object type, a Qualifier menu is displayed within the Add a Variable window. From this menu, you can select either of the following:
- Database Reference. If you select this item, the adapter variable is mapped to the reference of the database that the Oracle Identity Manager is currently running against.
- Data Object Reference. If you select this item, the adapter variable is mapped to an Oracle Identity Manager data object.
Note:

If you select the IT Resource type, a Resource Type menu is displayed within the Add a Variable window. From this menu, you can select one of the IT resource types that have been created by using the IT Resource Type Definition form. By doing so, you can map the adapter variable to a parameter of this IT resource type.
On the toolbar in the Add a Variable window, click Save. The information for your adapter variable is stored in the Oracle Identity Manager database.

Close the Add a Variable window to activate the main screen. The name, classification type, mapping selection, and description of the adapter variable you created appear in the child table of the Variable List tab.

This adapter variable now belongs to the adapter in the Adapter Factory form. It is saved to the Oracle Identity Manager database, and the adapter variable is ready to use.

3.7.2 Items on the Map To Menu

You can map the items on the Map To menu to your adapter variable.

Table 3-1 lists the items on the Map To menu to which you can map your adapter variable.

Table 3-1 Items on the Map To Menu

Name	Description
Literal	This adapter variable is mapped to a constant (or literal).
Resolve at Run time	This adapter variable's mapping occurs later, at run time. Selecting this option increases the reusability of the adapter.
Adapter References	This adapter variable gives access to an Oracle Identity Manager database reference or an Oracle Identity Manager data object reference.
System Date	When this adapter variable is triggered by Oracle Identity Manager, it is mapped to the current date and time of the Server. Note: This option appears only when you select the Date type.

3.7.3 Modifying an Adapter Variable

You can modify an adapter variable from the Edit a Variable window that opens from the Variable List tab.

To modify an adapter variable:

Select the adapter that contains the adapter variable you want to edit, for example, the Create Solaris User adapter.
Click the Variable List tab and double-click the row header of the adapter variable you want to modify. The Edit a Variable window is displayed, showing information about the adapter variable.
Make the necessary edits, for example, changing the adapter variable's data type from String to Character.
On the Edit a Variable toolbar, click Save. The modified information about the adapter variable is stored in the Oracle Identity Manager database.
Close the Edit a Variable window to activate the main screen. The adapter variable you modified appears within the child table of the Adapter Factory form.

Note:

Ensure that you check your data mappings and recompile the adapter, especially if you change the adapter variable's data type.

3.7.4 Deleting an Adapter Variable

When an adapter variable is no longer necessary for the adapter to run, you can remove it from the adapter.

To delete an adapter variable:

Select the adapter that contains an adapter variable you want to remove, for example, the Create Solaris User adapter.
Select the Variable List tab.
From the list of this tab, select the adapter variable you want to delete.
Click Delete.
Recompile the adapter after deleting any variable.

The adapter variable disappears from the child table. The adapter variable has been deleted.

3.8 Creating Adapter Tasks

After you construct the adapter and create its variables, you can create the atomic function calls of an adapter. These function calls are known as adapter tasks.

This section explains adapter tasks and how to create tasks:

3.8.1 Types of Adapter Tasks

The types of adapter tasks are Java task, remote task, stored procedure task, utility task, API task, set variable task, error handler task, and logic task.

Oracle Identity Manager allows you to create the following adapter tasks:

A Java task, which allows an adapter to communicate with an external source by invoking Java API.
A utility task, which enables you to populate an adapter with methods and APIs that come packaged with Oracle Identity Manager. In addition, this type of task provides you with access to the Java Standard Library APIs.
An Oracle Identity Manager API task, which enables access to Oracle Identity Manager published APIs from adapter tasks. This allows for enhanced portability of adapter code.
A set variable task, which allows you to set a variable within an adapter.
An error handler task, which lets you display any errors associated with an adapter that occur at run time. In addition, you can see the reasons for the errors, along with possible solutions.
A logic task, which lets you build a conditional statement within an adapter.

You can create the following types of logic tasks:

FOR loops
WHILE loops
IF statements
ELSE statements
ELSE IF statements
BREAK statements
RETURN statements
CONTINUE statements
SET VARIABLE statements
Handle Error statements

For classification purposes, Oracle Identity Manager represents each type of adapter task by an icon. The icon, which precedes the task name, is a visual indicator of the type of task it is. For example, "J" represents a Java task, and "LT" represents a logic task.

To see a list of these icons, select the Adapter Tasks tab, and click Legend. The Legend window appears, displaying the following list of icons:

Functional Task
- Java
Utility Task
- Utility
- Oracle Identity Manager API
Logical Task

3.8.2 Creating a Java Task

Oracle Identity Manager can handshake with an external source through a Java API. To make this happen, you must add a task to an adapter which, when triggered by Oracle Identity Manager, initiates communications with the external source. This type of task is called a Java task.

To create a Java task:

Select the adapter to which you want to add a Java task, for example, the Update Solaris Password adapter.
Select the Adapter Tasks tab.
Click Add.

After the Adapter Task Selection window is displayed, select the Functional Task option.
From the display area to the right of this option, select the Java item, and click Continue.

The Object Instance Selection window is displayed. See Options in the Object Instance Selection Window for information about the options in the Object Instance Selection window.
Click an option—for example, New Object Instance—and click Continue. The Add an Adapter Factory Task window is displayed. See Regions of the Add an Adapter Factory Task Window for information about the various regions of the Add an Adapter Factory Task window.
In the Task Name field, enter the name of the task you are creating, for example, Update Password.
(Optional.) To make your Java object reusable, select Persistent Instance, type the name of the instance of this task in the text field located to the right of the check box.

Caution:

Ensure that name of the instance contains no spaces.

Note:

To reference a session with the target resource multiple times during the life of the adapter, and not just once, select Persistent Instance.

Tip:

By setting the Java object to be persistent, the next time you create a Java object, it appears in the Persistent Instance list of the Object Instance Selection window. In addition, you do not have to map the constructor to all adapter tasks of the same Java object.
Select the API Source. The JAR files appear, which Oracle Identity Manager references from the JavaTasks subdirectory of the OIM_HOME/ directory path—for example, C:\oracle\Xellerate\JavaTasks.

See Also:

Configuring the Adapter Environment for instructions on how to enable Oracle Identity Manager to use third-party JAR files with a Java task
Select the Application API. The class files, which belong to the JAR file you selected in the API Source, appear.
From the Constructors area, select the method to be used to initialize the Java class you selected.
From the Methods area, select the method that will be used with your Java task.
From the toolbar, click Save.

The information pertaining to the Java task is stored in the Oracle Identity Manager database. You can now access the parameters of your Java task's constructors and methods. These parameters appear in the Application Method Parameters region of the Add an Adapter Factory Task window.
To display the Java class constructors and methods for which you must set mappings, click the plus icons displayed to the left of the Constructor and Method icons.
Select the parameter of the constructor or method for which you must set a mapping.
In the Description text area, you can enter a description for this mapping.
Click the Map to combo box, and select an item that you can map to the parameter of the constructor or method, for example, Adapter Variables.
Set the appropriate mappings.

See Also:

Adapter Mapping Information for more information about which mappings to set
Click Set.

The parameter of the selected constructor or method now appears in blue. This signifies that it has been mapped.

Tip:

To remove a parameter mapping, right-click the appropriate parameter, and select Un-Map Parameter from the popup menu that appears.
Repeat steps 15 through 18 for all parameters of the constructors and methods that appear in the Application Method Parameters region.
On the Add an Adapter Factory Task window toolbar, click Save. The information pertaining to the Java task is stored in the Oracle Identity Manager database.
On the toolbar, click Close. The Add an Adapter Factory Task window disappears, and the main screen is active once again. The Java task that you created—for example, Update Password—appears within the Adapter Factory form.
(Optional.) To create additional Java tasks for the adapter, repeat steps 21.

Tip:

You can create different types of adapter tasks, and add them to the adapter.

If the adapter is logically complete, and all variables on the adapter tasks are mapped, you can compile it to use with a process task or form field.
To compile the adapter, click Build.

The text in the Compile Status field changes from Recompile to OK. This indicates that Oracle Identity Manager compiled the adapter and found no errors. You can now attach the adapter to a process task or form field.
(Optional.) To see the code that Oracle Identity Manager generates, from the toolbar, click Notes.
The Notes window is displayed, containing the code that Oracle Identity Manager generated.
Note:

If, after clicking Build, CODE GEN ERROR appears in the Compile Status field, it means that Oracle Identity Manager encountered one of two types of errors while validating and compiling the adapter:
- Validation Error
  
  While Oracle Identity Manager is checking the adapter to verify that it is valid, an error is found. This error can result from a parameter of an adapter task not being mapped, a parameter being mapped improperly, or an adapter task being placed out of order.
  
  Because Oracle Identity Manager generates code for an adapter only after it is validated, if Oracle Identity Manager encounters a validation error, it does not create any code.
- Java Compilation Error
  
  Oracle Identity Manager has verified that the adapter is valid. However, while Oracle Identity Manager is compiling the adapter, an error is found. This error can result from assigning an incorrect data type to an adapter task parameter.
  
  Because Oracle Identity Manager has validated the adapter, it generates code. However, Oracle Identity Manager stops building code at the point of the compilation where it encounters the error.
Tip:

Once you create a Java task, and add it to an adapter, you can see the following information by accessing the Resources tab of the Adapter Factory form:
- The JAR and class files used to create the Java task.
- The name, which represents the directory path that contains these JAR and class files.

3.8.3 Options in the Object Instance Selection Window

The Object Instance Selection window provides options to select new object instance, persistent instance, or task return value instance.

Table 3-2 explains the options in the Object Instance Selection window.

Table 3-2 Options in the Object Instance Selection Window

Option	Description
New Object Instance	When you click this option, you are creating a new Java object instance.
Persistent Instance	You can call the method on a persistent object by clicking this option, clicking the adjacent combo box, and selecting an object instance from the drop-down menu.
Task Return Value Instance	You can call this method on an object returned by an adapter task defined earlier by clicking this option, clicking the combo box, and selecting an adapter task from the drop down list.

Note:

When the Persistent Instance option is grayed out, it indicates that you have not defined any persistent objects for your adapter. Similarly, if the Task Return Value Instance option is grayed out, none of the tasks have Java Object return values associated with them.

3.8.4 Regions of the Add an Adapter Factory Task Window

The Add an Adapter Factory Task window provides access to the parameters of your Java task's constructors and methods.

Table 3-3 lists and describes the various regions of the Add an Adapter Factory Task window:

Table 3-3 Regions of the Add an Adapter Factory Task Window

Name	Description
Task Name	This field displays the name of the Java task.
Persistent Instance	If this Java object is to be used again, the check box is selected, and the name of the task instance is entered in the adjacent field.
API Source	This combo box contains a list of all JAR and class files to which you have access.
Application API	This combo box contains a list of all class files to which you have access, and which belong to the JAR file that has been selected from the API Source list.
Constructors	This text area displays all the constructors, which are available for the Java object.
Methods	This text area shows a list of all the methods, which are available for the Java object.
Application Method Parameters	This area contains the parameters of the selected constructor and method. These parameters are mapped to the adapter variables and Oracle Identity Manager components.

3.8.5 Reassigning the Value of an Adapter Variable

You can reassign the value of an adapter variable, a different type of adapter task, or a constant (or literal).

This section describes how to reassign the value of an adapter variable and then compile the adapter. It contains the following topics:

3.8.5.1 About Reassigning Adapter Variable

Sometimes, for an adapter to accomplish its required objective, you must reassign the value of one adapter variable to another adapter variable, a different type of adapter task, or a constant (or literal). The task that enables you to reallocate an adapter variable value is known as a set variable task.

3.8.5.2 Creating a Set Variable Task

To create a set variable task:

Select the adapter to which you wish to add a set variable task (for example, the Check the Solaris User ID adapter).
Click the Adapter Tasks tab.
Click Add. The Adapter Task Selection window is displayed.
Select the Logic Task option.
From the display area, select SET VARIABLE, and click Continue. The Add Set Variable Task Parameters window is displayed.
From the Variable Name list, select the adapter variable that has a value you want to reassign—for example, Adapter return value.
From the Operand Type list, select the type of operand that will provide the value for the variable.

Tip:

You can reassign an adapter variable's value to another adapter variable, a different type of adapter task, or a literal.

For information about the various types of operands, see Types of Operands.

3.8.5.3 Types of Operands

Use Table 3-4 to understand the various types of operands that will provide the value of the variable.

Table 3-4 Types of Operands

Operand Name	Description
Variable	If you select this operand type, adapter variables appear in the Operand Qualifier list. From this list, select the specific adapter variable that will provide the reassigned value. Note: The only adapter variables that will appear in the Operand Qualifier combo box will be those variables that have the same data type as the adapter variable that is displayed within the Variable Name combo box.
Adapter Task	By selecting this operand type, adapter tasks are displayed in the Operand Qualifier combo box. From this combo box, select the particular adapter task that will provide the reallocated value. Note: The only adapter tasks that will appear in the Operand Qualifier combo box will be those tasks that have the same data type as the adapter variable that is displayed within the Variable Name combo box.
Literal	When you select this operand type, types of literals appear in the Operand Qualifier combo box. From this combo box, select the type of literal that will provide the reallocated value. Then, type the specific literal into the field that appears underneath the combo box.

Operand Name

Description

Variable

If you select this operand type, adapter variables appear in the Operand Qualifier list. From this list, select the specific adapter variable that will provide the reassigned value.

Note: The only adapter variables that will appear in the Operand Qualifier combo box will be those variables that have the same data type as the adapter variable that is displayed within the Variable Name combo box.

Adapter Task

By selecting this operand type, adapter tasks are displayed in the Operand Qualifier combo box. From this combo box, select the particular adapter task that will provide the reallocated value.

Note: The only adapter tasks that will appear in the Operand Qualifier combo box will be those tasks that have the same data type as the adapter variable that is displayed within the Variable Name combo box.

Literal

When you select this operand type, types of literals appear in the Operand Qualifier combo box. From this combo box, select the type of literal that will provide the reallocated value. Then, type the specific literal into the field that appears underneath the combo box.

3.8.5.4 Creating Additional Set Variable Tasks

The following task sets the adapter variable's return value to be equal to the UserName adapter variable.

On the toolbar in the Add Set Variable Task Parameters window, click Save. The set variable task you created is stored in the Oracle Identity Manager database.
On the Add Set Variable Task Parameters window toolbar, click Close. The Add Set Variable Task Parameters window disappears, and the main screen is active once again. The set variable task that you created, for example, Set Adapter return value = UserName, appears in the Adapter Factory form.
(Optional.) Repeat Steps 3-9 to create additional set variable tasks for the adapter.

You are now ready to compile the adapter, so it can be used with a process task or form field.
To compile the adapter, click Build. The text in the Compile Status field changes from Recompile to OK. Oracle Identity Manager compiled the adapter and found no errors. You can attach the adapter to a process task or form field.

3.9 Modifying Adapter Tasks

Use the Adapter Tasks tab of the Adapter Factory form to modify an adapter task.

The following procedure will show you how to edit an adapter task, in case you must make changes to it. To modify an adapter task

Select the adapter that contains the adapter task you wish to edit (for example, the Update Solaris User Group adapter).
Click the Adapter Tasks tab.
Double-click the adapter task that you want to modify.

The Edit Adapter Factory Task Parameters window is displayed, displaying information that relates to the adapter task you selected. Within this window, make the necessary modifications.
On the Edit Adapter Factory Task Parameters window toolbar, click Save.

The information you modified is stored in the Oracle Identity Manager database.
On the toolbar, click Close.

The Edit Adapter Factory Task Parameters window disappears. The main screen is active again. The modified task appears within the child table of the Adapter Factory form. You must re-compile the adapter, so it can be used with a process task or form field.
To recompile the adapter, click Build.

The text in the Compile Status field changes from Recompile to OK. This indicates that Oracle Identity Manager compiled the adapter and did not find any errors. You can now attach the adapter to a process task or form field.

Caution:

You cannot modify the API call inside a Java, Xellerate API, or Utility task. The adapter task has to be deleted and re-created. In addition, if CODE GEN ERROR appears in the Compile Status field, Oracle Identity Manager encountered errors while compiling the adapter. Rectify the errors, if necessary re-do the adapter task modifications, and compile the adapter again.

3.10 Changing the Order and Nesting of Tasks

If you add multiple tasks to an adapter, you can either change the order in which the tasks are executed, or place one task inside of another task for the adapter to work.

The following procedure will show you how to change the order and nesting of tasks.

Caution:

You should not change the order and nesting of adapter tasks unless you understand the mapping dependencies of the adapter tasks.

To change the order and nesting of tasks:

Select the adapter that contains tasks of which you want to change the order and/or nest (for example, the Check the Solaris User ID adapter).
Click the Adapter Tasks tab.
The tasks appear, which belong to the current adapter.

In this example, the following changes must occur:
- The error handler task must be nested inside of the IF (Check ID Length > 10) logic task.
- The set variable task has to be nested inside of the ELSE logic task.
- The IF logic task precedes the ELSE logic task.
Therefore, you must first reorganize the logic tasks. Then, you must nest the error handler task and set variable task inside of the IF and ELSE logic tasks, respectively. To reorganize tasks:
Select the task that must run before another task, and click the Up arrow button. The selected task will switch places with the task that precedes it.

or

Select the task that must be executed after another task, and click the Down arrow button. The highlighted task is displayed below the task that previously followed it.

To nest tasks/remove task nestings:
Select the task that must be placed inside of another task, and click the Right arrow button. The selected task will be nested inside of the task that appears above it.

or

Select the task that no longer be nested inside of another task, and click the Left arrow button. The highlighted task will not be nested inside of the task that is displayed above it.
On the toolbar, click Save.

The order and nesting of the adapter's tasks is stored in the Oracle Identity Manager database. If the adapter is logically complete and all variables on the adapter tasks are mapped, you can compile it to use with a process task or form field.
To compile the adapter, click Build.

The text in the Compile Status field changes from Recompile to OK. This indicates that Oracle Identity Manager compiled the adapter and did not find any errors. You can now attach the adapter to a process task or form field.

Caution:

If you see CODE GEN ERROR in the Compile Status field, Oracle Identity Manager found errors while compiling the adapter. Rectify the errors, if necessary re-do the adapter task modifications, and compile the adapter again.

3.11 Deleting Adapter Tasks

When an adapter task is no longer necessary for the adapter to run, you must remove it from the adapter.

To delete an adapter task:

Select the adapter that contains the task you wish to remove (for example, the Update Solaris User Group adapter).
Click the Adapter Tasks tab.
Select the task that you want to remove (for example, the CONTINUE logic task).
Click Delete.

The selected task is deleted and disappears from the child table.
On the toolbar, click Save.
Recompile the adapter.

Caution:

While deleting adapter tasks, ensure that the logic of the adapter is consistent and maintained.

3.12 Working with Responses

The Responses tab of the Adapter Factory form lets you can create, modify, and delete responses, which are outcomes of the adapters based on which adapters can trigger other process tasks.

This section describes responses and how to create, modify, and delete responses. It contains the following topics:

3.12.1 About Responses

Adapters can have various outcomes, called responses, based on which adapters can trigger other process tasks.

For example, if the adapter returns a True response, the process task's status can be set automatically to Completed. However, if the adapter returns a False response, the process task's status can be set automatically to Rejected, and another process task can be triggered.

These responses can be added, modified, or removed on the Responses tab of the Adapter Factory form.

Note:

Responses are used only with process task adapters, because these adapters are attached to process tasks. Rule generators, pre-populate adapters, and entity adapters are not connected to processes. In addition, task assignment adapters are not associated with responses. Therefore, if the active adapter is a task assignment adapter, rule generator, pre-populate adapter, or entity adapter, Oracle Identity Manager disables the Responses tab.

3.12.2 Creating a Response

You can create a response for an adapter from the Responses tab.

To create a response:

Select the adapter to which you want to add responses (for example, the Create Solaris User adapter).
Click the Responses tab.
Click Add.

An empty row is inserted into the Responses tab.
Click the field that appears within the Code Name column.
Enter a code, which represents a response type that can be generated (for example, True).
Click the field that appears within the Description column.
Enter a description for this response (for example, The user was created successfully.).
Double-click the field that appears within the Status column.
Click the desired status level (for example, Completed (C)). Then, click OK.

The Lookup window disappears, and the Responses tab is active once again.
Create another response, by clicking the Add button, and entering False and The user was not created successfully. into the Code Name and Description fields, respectively. Then, access the Lookup window, and assign the Rejected (R) status level to this response.
On the toolbar, click Save.

The responses that you created for this adapter have been stored in the Oracle Identity Manager database. After you attach this adapter to a process task, these responses will appear in the Responses tab of the Editing Task window of the Process Definition form.

3.12.3 Modifying a Response

You can modify the response of an adapter from the Responses tab.

To edit a response:

Select the adapter that contains the response you want to edit (for example, the Create Solaris User adapter).
Click the Responses tab.
Double-click the field of the response, which contains information that you want to modify.
1. If the field is a text field, Oracle Identity Manager enables it. You can now edit the contents within this field.
2. When the field is a lookup field, the Lookup popup window is displayed, containing the different status levels that you can associate with the response. Click the desired status level, click OK.
For example, double-click the Status column of the False response, select the Suspended (S) status level, and click OK.
On the toolbar, click Save.

The information that you modified for the response is stored in the Oracle Identity Manager database.

3.12.4 Deleting a Response

When a response is no longer necessary, you can delete it from the adapter by using the Responses tab.

To delete a response:

Select the adapter, which contains a response that you want to remove.
Click the Responses tab.
Select the response that you want to delete.
Click Delete.

The response disappears. This indicates that Oracle Identity Manager has deleted the response.

3.13 Working with Prepopulate Adapters

Working with prepopulate adapters include attaching prepopulate adapters to form fields and removing them.

This section describes how to attach prepopulate adapters to form fields and remove prepopulate adapters from form fields. It contains the following topics:

3.13.1 Attaching Prepopulate Adapters to Form Fields

Use the Prepopulate tab of the Form Designer form to attach prepopulate adatapers to form fields.

To attach a prepopulate adapter to a form field, perform the following steps:

Select the field to which a prepopulate adapter will be attached.
Select the rule that will determine if the adapter will be used to populate the designated field with information.
Select the adapter that will be associated with the designated field.
Set the priority number of the selected rule.
Map the adapter variables of the prepopulate adapter to their proper locations.
Note:

To attach a prepopulate adapter to a form field, you must ensure the following:
- The form is not in an active state. Otherwise, create a new form version.
- After attaching the adapter, you must activate the form to be able to use it.
Open the Form Designer form.
Query for the form to which you want to attach a prepopulate adapter (for example, Solaris).
Click the prepopulate tab.

The prepopulate adapters, which have already been attached to the form you queried, appear within this tab.

Note:

If no adapters have been attached to a form field, the prepopulate tab will be empty.

If a process form has two IT resource fields, then the second IT resource must be populated using programmatic mechanism and prepopulate adapters. Two IT resources cannot be populated because the UI Form Designer does not support an IT resource type widget.
Click Add.

The prepopulate Adapters dialog box is displayed. For information about the fields of the Prepopulate Adapters dialog box, see Fields of the Prepopulate Adapters Dialog Box.
From the Field Name combo box, select the form field, such as User ID, to which the prepopulate adapter will be attached.
Double-click the Rule lookup field. From the Lookup dialog box that is displayed, select the rule that will determine if the associated adapter will be used to populate the designated form field with information (for example, Rule for Lowercase User ID).
Double-click the Adapter lookup field. From the Lookup dialog box that is displayed, choose the adapter that will be associated with the field you selected in Step 10, for example, Display Lowercase Letters for User ID.
In the Order field, enter the priority number of the rule you selected in Step 11, for example, 2.
On the prepopulate Adapters window toolbar, click Save.
Mapping Incomplete appears within the Adapter Status field. This signifies that the adapter you selected contains variables that have not been mapped correctly. These variables can be mapped to their proper locations. Otherwise, the adapter will not work.
Set the mappings for each variable that appears in the Adapter Variables region of the prepopulate Adapters window. To do so, double-click the row header of the variable you want to map, for example, UserID.

The Map Adapter Variables window is displayed. For information about the fields of the Map Adapter Variable window, see Fields of the Map Adapter Variables Window.
Complete the Map To, Qualifier, IT Asset Type, IT Asset Property, and Literal Value fields.

See Also:

Adapter Mapping Information for more information about the mappings to select
On the Map Adapter Variable window toolbar, click Save. Then, click Close.

The Map Adapter Variables window disappears. The prepopulate Adapters window is active again.

The text in the Adapter Status field changes from Mapping Incomplete to Ready. In addition, the mapping statuses for the adapter's variables change from No (N) to Yes (Y).
On the prepopulate Adapters window toolbar, click Close.
The prepopulate Adapters window disappears, and the Form Designer form is active again. The prepopulate adapter, which you attached to the User ID form field (Display Lowercase Letters for User ID), appears in the prepopulate tab of the Results of 1Q Sales 2003 form.

After a process, which references this form, is provisioned to a target user or organization, the form will appear. Oracle Identity Manager will check to see if the prepopulate rule, which has the highest priority, is valid. If so, Oracle Identity Manager will assign the associated prepopulate adapter to the designated field (User ID), and execute it. At this point, one of the following actions occur:
- If the Auto-prepopulate check box is selected for the provisioning process, Oracle Identity Manager will display the data that is generated by the prepopulate adapter automatically.
- If the Auto-prepopulate check box is cleared, an Oracle Identity Manager user must manually trigger the displaying of the data that is generated by the prepopulate adapter. To do this, the administrator must click the prepopulate button on the form section of the direct provisioning wizard in the Web client, while provisioning the form to a user.
Tip:

Once you allocate a prepopulate adapter to a form field, and assign a prepopulate rule to the adapter, a quick way to see the association among the adapter, the form field, and the rule is by accessing the Usage Lookup tab of the Adapter Factory form.

3.13.2 Fields of the Prepopulate Adapters Dialog Box

The Prepopulate Adapters dialog box provides options for attaching prepopulate adapters to form fields.

Table 3-5 lists and describes the fields of the prepopulate Adapters dialog box.

Table 3-5 Fields of the Prepopulate Adapters Dialog Box

Name	Description
Field Name	This combo box contains a list of all of the form fields to which a prepopulate adapter can be attached.
Rule	From this lookup field, select the rule that will determine if the associated adapter will be used to populate the designated form field with information.
Adapter	From this lookup field, select the adapter that will be associated with the designated field.
Order	From this field, set the priority number of the selected rule.
Adapter Status	This field displays the mapping status of the adapter variables. See Attaching Process Task Adapters to Process Tasks for information about the various mapping statuses for an adapter.
Adapter Variables	This area displays the following: Mapped: The mapping statuses of the adapter's variables. "Y" indicates that an adapter variable has been mapped properly; "N" indicates that this variable has not been mapped correctly. Name: The names of the adapter variables. Mapped to: The form fields to which the variables are mapped If an adapter variable is not yet mapped, the corresponding cell in this column will be empty.

3.13.3 Fields of the Map Adapter Variables Window

The Map Adapter Variables window provides options for attaching prepopulate adapters to form fields.

Table 3-6 describes the fields of the Map Adapter Variables window.

Table 3-6 Fields of the Map Adapter Variables WIndow

Field Name	Description
Variable Name	This field displays the name of the adapter variable for which you are setting a mapping (for example, UserID).
Data Type	This field shows the data type of the adapter variable (for example, String is the data type for the UserID adapter variable).
Map To	This field contains the types of mappings that you can set for the adapter variable (for example, Process Data). When you map the adapter variable to a location or a contact, Oracle Identity Manager enables the adjacent combo box. From this combo box, select the specific type of location or contact to which you are mapping the adapter variable. If you are not mapping the adapter variable to a location or contact, this combo box is grayed out.
Qualifier	This field contains the qualifiers for the mapping you selected in the Map to combo box (for example, User ID).
IT Asset Type	This field enables you to select a specific IT Resource (for example, Solaris) when you map an adapter variable to an IT Resource, and this variable's data type is String. If you are not mapping the adapter variable to an IT Resource, or the variable's data type is not String, this field does not appear.
IT Asset Property	This field enables you to select a specific field that will receive the results of the mapping (for example, User Name), when you map an adapter variable to an IT Resource, and this variable's data type is String. If you are not mapping the adapter variable to an IT Resource, or the variable's data type is not String, this field does not appear. Important: The IT Asset Type and IT Asset Property fields are included within this window for backward compatibility. The preferred way is to create an adapter variable with a data type of IT Resource, in which case these fields will not appear.
Literal Value	When you map the adapter variable to a literal, use this field to specify the specific literal value. If you are not mapping the adapter variable to a literal, this field does not appear.

3.13.4 Removing Prepopulate Adapters from Form Fields

If a prepopulate adapter, which has been associated with a form field, is no longer valid, you must remove the adapter from the field.

To remove a prepopulate adapter from a form field:

Note:

Before removing the prepopulate adapter from a form field, you must create a new version of the form.

Select the prepopulate adapter that you want to remove.
Click Delete. The prepopulate adapter is removed from the form field. It cannot be triggered when the form is launched.
After removing the adapter, you must activate the form.

3.14 Working with Process Task Adapters

Working with process task adapters includes attaching them to process tasks and removing them.

This section describes how to attach process task adapters to process tasks. It contains the following topics:

3.14.1 Guidelines for Working with a Process Task Adapter

After you attach the process task adapter to a dependent process task, understand how process task adapters are triggered depending on the status of the process task.

After you create a process task adapter, you attach it to the appropriate process task by using the Integration tab of the Process Definition form. From this tab, you can also map any variables of the adapter to their proper locations, which were designated as either Resolve at Run time or as an adapter return variable.For example, the adapter named adpSOLARISPASSWORDUPDATED is connected to the Password Updated task of the Solaris process.After you attach an adapter to a process task, for the adapter to be functional, it might need data from fields of other forms. For this example, the adpSOLARISPASSWORDUPDATED adapter cannot work unless it obtains the following information:

The user's Oracle Identity Manager ID and password.
The user's Solaris ID and password.
The IP address where Solaris is located.

Therefore, it must get this information from the UserID, Passwd, SolarisUserID, SolarisUserPasswd, and ServerAddress adapter variables respectively. These five variables are created by using the Adapter Factory form. The "Y" that precedes each adapter variable signifies that it has been mapped correctly.The form that enables you to create process-specific fields, which will be used by a process to obtain the information it needs, is called the Form Designer. When you create these fields, Oracle Identity Manager stores them into a table. Then, by associating this table with a process (through the Table Name lookup field of the Process Definition form), the adapter, which you attach to a task of this process, will use the table to retrieve the appropriate data.If you want to modify this table, you can do so through the Form Designer form.The UD_SOLARIS table contains two fields: UD_SOLARIS_USERID and UD_SOLARIS_PASSWD. By accessing this record of the Form Designer form, you can edit the fields of the table.

Once you attach the process task adapter to a dependent process task, and the status of this process task is Pending (the status of the previous process task is Completed), Oracle Identity Manager will trigger the adapter automatically. When the process task is an independent task, Oracle Identity Manager will execute the adapter as soon as the process is requested.The result of the adapter being executed represents the state of the process task. When the adapter is finished successfully, the process task to which this adapter is attached will have a status of Completed.On the other hand, if the adapter cannot perform its designated function, the process task to which this adapter is attached will have a status of Rejected. By discovering the cause of the error, you can modify the process task and/or adapter so it can run successfully.

Note:

To determine why a process task might have failed:

Find the process task. When the process task has not yet been provisioned to the target user or organization, it is located in the To Do List or Pending Approvals. To find the task:

Log in as the user.
Select the To Do List link or the Pending Approvals links in the left side of the window.

3.14.2 Attaching Process Task Adapters to Process Tasks

After you create a process task adapter, you attach it to the appropriate process task by using the Integration tab of the Process Definition form.

You must attach the process task adapter to a process task to execute that process task automatically. To connect an adapter to a process task, access the Integration tab (from the Process Definition form). From this tab, you can also map any adapter variables to their proper locations.The following procedure shows you how to attach a process task adapter to a process task:

Open the Process Definition form, which is located in the Process Management folder.

In the Oracle Identity Manager Workspace, the Process Definition form appears.
Select the process, which contains a task to which you want to attach an adapter. The selected process, along with its tasks, appears in the Process Definition form. For this example, the Solaris process has been selected.
Double-click the row header of the task to which you want to attach an adapter. The Editing Task window appears, containing information about the task (for example, the Password Updated process task).
Click the Integration tab.
Click Add.

The Handler Selection window appears.
To access Oracle Identity Manager adapters, click the Adapter option.

The adapters appear, which you can attach to the process task.
From this region, select the adapter that you want to attach to the process task, for example, the adpSOLARISPASSWORDUPDATED adapter.

Tip:

For classification purposes, the first three letters of each adapter's name are adp. For classification purposes, the first three letters of each adapter's name are adp.
From the Handler Selection window's toolbar, click Save.

A dialog box appears, stating that the adapter was successfully added to the process task.
Click OK.
The dialog box disappears, and the Integration tab is now active. This tab now displays the following:
- The name of the adapter that is attached to the process task;
- The status of the adapter; and
- The names, descriptions, and mapping statuses of the adapter's variables.
Note:

An adapter can have one of three mapping statuses:

Ready. This adapter has been successfully compiled, and all of its variables have been mapped correctly.

Mapping Incomplete. This adapter has been successfully compiled, but at least one of its variables have not been mapped correctly.

Adapter Unavailable. After this adapter had been compiled successfully, it was modified, and recompiled.

Note:

If an adapter does not have any mappable variables, the Adapter Variables region is empty. In addition, the Status field will display either Ready or Adapter Unavailable, depending on whether the adapter has to be recompiled.

Note:

A mappable adapter variable either has been designated as Resolve at Run time or it is an adapter return variable.

Note:

Once you attach the adapter to the process task, any responses that you defined for the adapter appear in the Responses tab of the Editing Task window.
Set the mappings for each variable that appears in the Adapter Variables region of the Integration tab. To do so, double-click the row header of the variable you want to map (for example, SolarisUserID).

The Data Mapping for Variable window is displayed. See Fields of the Data Mapping for Variable Window for information about the fields of the Data Mapping for Variable window.
Complete the Map To, Qualifier, IT Asset Type, IT Asset Property, Literal Value, and Old Value fields.

See Also:

Adapter Mapping Information for more information about the mappings to select
On the toolbar, click Save. Then, click Close.

The Data Mapping for Variable window disappears. The Integration tab is active again.
On the Editing Task window toolbar, click Save.

The contents in the Status field change from Mapping Incomplete to Ready. In addition, the mapping statuses for the adapter's variables change from No (N) to Yes (Y).
On the toolbar, click Close.

The Editing Task window disappears, and the main screen is active once again. The adapter you added to the Password Updated task (adpSOLARISPASSWORDUPDATED) appears in the Process Definition form.This signifies that the adpSOLARISPASSWORDUPDATED process task adapter was attached to the Password Updated process task.

Tip:

Once you attach a process task adapter to a process task, a quick way to see the process and task to which it is connected is by accessing the Usage Lookup tab of the Adapter Factory form.

3.14.3 Fields of the Data Mapping for Variable Window

The Data Mapping for Variable window provides options for attaching process task adapters to process tasks.

Table 3-7 describes the fields of the Data Mapping for Variable window.

Table 3-7 Fields of the Data Mapping for Variable WIndow

Field Name	Description
Variable Name	This field displays the name of the adapter variable for which you are setting a mapping (for example, SolarisUserID).
Data Type	This field shows the data type of the adapter variable (for example, String is the data type for the SolarisUserID variable).
Map To	This field contains the types of mappings that you can set for the adapter variable (for example, IT Resources).When you map the adapter variable to a location or a contact, Oracle Identity Manager enables the adjacent combo box. From this combo box, select the specific type of location or contact to which you are mapping the adapter variable. In addition, if you map the adapter variable to a custom process form, and this form contains child table(s), Oracle Identity Manager enables the adjacent combo box. From this combo box, select the child table to which you are mapping the adapter variable. If you are not mapping the adapter variable to a location, contact, or child table of a custom process form, this combo box is grayed out.
Qualifier	This field contains the qualifiers for the mapping you selected in the Map to combo box (for example, IT Asset).
IT Asset Type	This field enables you to select a specific IT Resource (for example, Solaris) when you map an adapter variable to an IT Resource, and this variable's data type is String. If you are not mapping the adapter variable to an IT Resource, or the variable's data type is not String, this field does not appear.
IT Asset Property	This field enables you to select a specific field that will receive the results of the mapping (for example, User Name), when you map an adapter variable to an IT Resource, and this variable's data type is String. If you are not mapping the adapter variable to an IT Resource, or the variable's data type is not String, this field does not appear. Important: The IT Asset Type and IT Asset Property fields are included within this window for backward compatibility. The preferred way is to create an adapter variable with a data type of IT Resource, in which case these fields will not appear.
Literal Value	When you map the adapter variable to a literal, use this field to specify the specific literal value. If you are not mapping the adapter variable to a literal, this field does not appear.
Old Value	By selecting this check box, you map the adapter variable to the value that was originally in the selected Qualifier field before modification. Process task adapters associated with process tasks are conditionally triggered when some field on the process form gets changed. If you click the Old Value option, and the process task is marked Conditional, the value that is passed to the adapter is the previous value of the field, before it got modified. This is useful in cases of fields that accept passwords. For example, if you want to disallow setting the password to the same value, you can use the old value for comparison. If you are not mapping the adapter variable to a field that belongs to a child table of a custom process form, this check box is grayed out.

3.14.4 Removing Process Task Adapters from Process Tasks

If a process task adapter is no longer necessary for Oracle Identity Manager to complete the process task automatically, or when you wish to attach a different adapter to a process task, you must first remove the adapter that is attached to the process task.

To remove a process task adapter from a process task:

Open the Process Definition form.

In the Design Console workspace, the Process Definition form appears.
Select the process, which contains a task from which you want to remove an adapter (for example, the Solaris process).

The selected process, along with its tasks, appears in the Process Definition form.
Double-click the row header of the process task from which you want to remove the adapter (for example, the Password Updated task).

The Editing Task window appears, containing information about the process task. Click the Integration tab.
Click the Integration tab.

The Integration tab displays information about the adapter that is attached to the process task.
Click Remove.

A dialog box appears, asking if you want to remove the adapter from the process task.
Click OK.

A dialog box appears, signifying that the adapter has been removed from the process task.
Click OK.

The contents of the adapter no longer appear in the Integration tab.
On the toolbar, click Close.

The Editing Task window disappears, and the main screen is active once again. The adapter that was once linked to the Password Updated task (adpSOLARISPASSWORDUPDATED) no longer appears in the child table of the Process Definition form.

This signifies that you have removed the adapter from the process task.

3.15 Adapter Mapping Information

Adapter mapping includes the mappings you can set for the parameters of an adapter task and adapter variable mapping to map the data at run time.

This section describes adapter task mapping and adapter variable mapping information. It contains the following topics:

3.15.1 About Adapters

An adapter is a Java class, generated by the Adapter Factory, which enables Oracle Identity Manager to interact with an external JAR file, a target IT resource (for example, a resource asset), or a user-defined form.

The Adapter Factory is a code-generation tool provided by Oracle Identity Manager, which enables a User Administrator to create Java classes.

An adapter extends the internal logic and functionality of Oracle Identity Manager. It automates process tasks, and defines the rules for the auto-generation and validation of data in fields within Oracle Identity Manager. There are five types of adapters: task assignment adapters, task adapters, rule generator adapters, pre-populate adapters, and entity adapters.

3.15.2 Adapter Task Mapping Information

An adapter task is one of the several possible components within an adapter. And this is a logical step within an adapter, equivalent to calling a programming language method.

The following types of adapter tasks are available: Functional Tasks (Java Task), Utility Tasks (Utility Task and Oracle Identity Manager API Task), and Logic Tasks (Set Variable Task and Error Handler Task).

This section lists the mappings that you can set for the parameters of an adapter task, in the following topics:

3.15.2.1 Adapter Variables

The following table lists and describes the items of the Map To list box of the Data Mapping for Variable window and the Name list box to which you can map the parameters of an adapter variable for an adapter task.

Map To Combo Box	Name Combo Box	Description
Adapter Variables	A list of adapter variables are displayed	You can map the parameter to the adapter variables that you created for this adapter. Note: When the adapter variable's classification type is Object, it cannot be used with process task adapters. Note: If the adapter variable's classification type is IT Resource, then an Attribute combo box is displayed. From this combo box, select the attribute of the IT resource to which you wish to map the parameter.

Map To Combo Box

Name Combo Box

Description

Adapter Variables

A list of adapter variables are displayed

You can map the parameter to the adapter variables that you created for this adapter.

Note: When the adapter variable's classification type is Object, it cannot be used with process task adapters.

Note: If the adapter variable's classification type is IT Resource, then an Attribute combo box is displayed. From this combo box, select the attribute of the IT resource to which you wish to map the parameter.

3.15.2.2 Adapter Task

The following table lists and describes the items of the Map To, Name, and Output combo boxes of the Adapter Factory form to which you can map the parameters of an adapter task.

Map To Combo Box	Name Combo Box	Output combo Box	Description
Adapter Task	A list of adapter tasks are displayed.	A list of output variables pertaining to the selected adapter task is displayed.	You can map the parameter to the adapter tasks that you created for this adapter.

3.15.2.3 Literal for an Adapter Task

The following table lists and describes the items of the Map To and Type combo boxes, as well as the Value field of the Adapter Factory form, to which you can map the parameters of a constant (or literal) for an adapter task.

Map To Combo Box	Type Combo Box	Value Field	Description
Literal	String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Enter the value of the literal into this field.	You can map the parameter to a String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, or Double data type, respectively.

3.15.2.4 Adapter References

The following table lists and describes the items of the Map To and Type combo boxes of the Adapter Factory form to which you can map the parameters of an adapter reference for an adapter task.

Map To Combo Box	Type Combo Box	Description
Adapter References	Event Handler Name or Database Reference	You can map the parameter to the active adapter.

3.15.2.5 Process Definition

The following table lists and describes the items of the Map To and Field combo boxes of the Adapter Factory form to which you can map the parameters of a process definition for an adapter task.

Map To Combo Box	Field Combo Box	Description
Process Definition	Name	You can map the parameter to the Name field of the Process Definition form.
Process Definition	Type	You can map the parameter to the Type field of the Process Definition form.

3.15.2.6 User Definition

The following table lists and describes the items of the Map To and Field combo boxes of the Adapter Factory form to which you can map the parameters of a user definition for an adapter task.

Map To Combo Box	Field Combo Box	Description
User Definition	User Key	You can map the parameter to a key, representing a unique record of the Users form.
User Definition	First Name	You can map the parameter to the First Name field of the Users form.
User Definition	Middle Initial	You can map the parameter to the Middle Name field of the Users form.
User Definition	Last Name	You can map the parameter to the Last Name field of the Users form.
User Definition	User Login	You can map the parameter to the User ID field of the Users form.
User Definition	Password	You can map the parameter to user password of the Users form.
User Definition	Type	You can map the parameter to the Xellerate Type field of the Users form.
User Definition	User Status	You can map the parameter to the Status field of the Users form.
User Definition	Role	You can map the parameter to the Role field of the Users form.
User Definition	Identity	You can map the parameter to the Identity field of the Users form.
User Definition	Disabled	You can map the parameter to the Disable User check box of the Users form.
User Definition	Organization	You can map the parameter to the Organization field of the Users form.
User Definition	Manager	You can map the parameter to the Manager field of the Users form.
User Definition	Start Date	You can map the parameter to the Start Date field of the Users form.
User Definition	End Date	You can map the parameter to the End Date field of the Users form.
User Definition	Email	You can map the parameter to the Email field of the Users form.
User Definition	Provisioning Date	You can map the parameter to the Provisioning Date field of the Users form.
User Definition	Provisioned Date	You can map the parameter to the Provisioned Date field of the Users form.
User Definition	Deprovisioning Date	You can map the parameter to the Deprovisioning Date field of the Users form.
User Definition	Deprovisioned Date	You can map the parameter to the Deprovisioned Date field of the Users form.
User Definition	Any fields that are displayed in the User Defined Fields tab of the Users form.	You can map the parameter to the selected user-defined field.

3.15.3 Adapter Variable Mapping Information

For a newly created adapter to work, you can map data to the parameters of the adapter's tasks. For this reason, you create placeholders, also known as adapter variables, to map the data at run time.

Once an adapter variable is not needed for the adapter to run, you can remove it from the adapter. After you have deleted the adapter variable, recompile the adapter.

This section contains the following topics:

3.15.3.1 Adapter Type and Location

When an adapter variable is not the adapter return variable, or it is not designated as Resolve at Run time, it should be mapped within the Variable List tab of the Adapter Factory form. On the other hand, if the adapter variable is classified as an adapter return variable, or the adapter variable is set to Resolve at Run time, it can be mapped at another location within Oracle Identity Manager. This location is contingent upon the adapter's type. For example, the variables of a process task adapter will be mapped at a different place than the variables of a pre-populate adapter. The following table lists the variables of a particular type of adapter that can be mapped.

Adapter Type	Location
Process Task	The Integration tab of the Editing Task window
Task Assignment	The Assignment tab of the Editing Task window
Rule Generator	The Map Adapters tab of the Data Object Manager form
Pre-Populate	The Pre-Populate tab of the Form Designer form
Entity	The Map Adapters tab of the Data Object Manager form

3.15.3.2 From the Variable List Tab

The following table lists the mappings that you can set from the Variable List tab.

Variable Type	Map To	Qualifier/Resource Type
Object	Adapter References	Database References
Object	Adapter References	Data Object References
Object	Set at run time (for Task Assignment adapters only)	Database References
Object	Set at run time (for Task Assignment adapters only)	Data Object References
IT Resource	Resolve at Run time	The IT Resource types that are displayed in the Table view of the IT Resources Type Definition form
String, Character, Byte, Integer, Float, Long, Short, Double	Literal	If you are mapping the adapter variable to a literal, a Literal Value field is displayed below the Resource Type combo box. Within this field, enter the value of this literal.
String, Character, Byte, Integer, Float, Long, Short, Double	Resolve at Run time	NA
String, Character, Byte, Integer, Float, Long, Short, Double	Adapter References	Event Handler Name Note: If the data type of the adapter variable is not String, Adapter References cannot be selected from the Map To combo box.
Boolean	Literal	Boolean. If you select this resource type, two Literal Value options are displayed below the Resource Type combo box: True and False. Select the option that corresponds to the value of the adapter variable.
Boolean	Resolve at Run time	NA
Date	Literal	If you are mapping the adapter variable to a literal, a Literal Value lookup field is displayed below the Resource Type combo box. Double-click this lookup field. From the Date & Time window that is displayed, select the date and time that will be the value of this literal.
Date	Resolve at Run time	NA
Date	System Date	NA Note: This variable's value will reflect Oracle Identity Manager's date and time. Hence, you do not map it.

3.15.3.3 Process Task Adapter Variable Mappings

The following table lists the process task adapter variable mappings.

Variable Type	Map To	Qualifier/Description
Object (Adapter Return Variable)	Process Data	You can map the parameter to a field of either the associated custom process form, or a child table that belongs to this form.
Object (Adapter Return Variable)	Response Code	NA
Object (Adapter Return Variable)	Task Information	Note. You can map the parameter to the Note tab of the Task List form. Reason. You can map the parameter to the Error Details window. To access this window, double-click a task that is displayed within the Task List form.
Object (Adapter Return Variable)	Process Definition	Name. You can map the parameter to the Name field of the Process Definition form. Type. You can map the parameter to the Type lookup field of the Process Definition form.
Object (Adapter Return Variable)	Organization Definition	The fields of the Organizations form to which you can map the adapter variable. Note: Because the data type of the adapter variable is Object, you cannot select Organization ID from the Qualifier combo box.
Object (Adapter Return Variable)	User Definition	The fields of the Users form to which you can map the adapter variable.
IT Resource	IT Resource	You can map the parameter to an IT resource. This IT resource is a member of the IT resource type that is displayed in parenthesis from within the Data Type field.
IT Resource	Process Data	You can map the parameter to a field of the associated process-specific form. Note: The only field names that are displayed in this combo box are ones with a data type of IT Resource Lookup Field.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Process Data	You can map the parameter to a field of either the associated custom process form, or a child table that belongs to this form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Task Information	Note. You can map the parameter to the Note tab of the Task List form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Task Information	Reason. You can map the parameter to the Error Details window. To access this window, double-click a task that is displayed within the Task List form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Process Definition	Name. You can map the parameter to the Name field of the Process Definition form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Process Definition	Type. You can map the parameter to the Type lookup field of the Process Definition form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Organization Definition	The fields of the Organizations form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	User Definition	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Literal	If you are mapping the adapter variable to a literal, and the variable's data type is String, Character, Byte, Integer, Float, Long, Short, or Double, a Literal Value field is displayed below the Qualifier combo box. Within the field, enter the value of this literal. When you are mapping the adapter variable to a literal, and the variable's data type is Boolean, two Literal Value options are displayed below the Qualifier combo box: True and False. Select the option that corresponds to the value of the adapter variable. If you are mapping the adapter variable to a literal, and the variable's data type is Date, a Literal Value lookup field is displayed below the Qualifier combo box. Double-click this lookup field. From the Date & Time window that is displayed, select the date and time that will be the value of this literal.
String	IT Resources	If you are mapping the adapter variable to an IT Resource, three combo boxes are displayed below the Map To combo box: Qualifier, IT Asset Type, and IT Asset Property. From these combo boxes, select the qualifier for the mapping, the specific name of the IT resource, and the field of the IT resource that will receive the results of the mapping. Note: If the data type of the adapter variable is not String, IT Resources cannot be selected from the Map To combo box.

3.15.3.4 Task Assignment Adapter Variable Mappings

The following table lists the task assignment adapter variable mappings.

Variable Type	Map To	Qualifier/Description
IT Resource	Object Data	You can map the parameter to an IT resource's instance key. This IT resource is a member of the IT resource type that is displayed in parenthesis from within the Data Type field.
IT Resource	IT Resource	You can map the parameter to an IT resource.
Object (Adapter Return Value)	Object Data	You can map the parameter to a field of either the associated custom resource object form, or a child table that belongs to this form.
Object (Adapter Return Value)	Response Code	NA
Object (Adapter Return Value)	Task Information	The fields of the Task List form to which you can map the adapter variable.
Object (Adapter Return Value)	Process Definition	The fields of the Process Definition form to which you can map the adapter variable.
Object (Adapter Return Value)	Organization Definition	The fields of the Organizations form to which you can map the adapter variable.
Object (Adapter Return Value)	User Definition	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Object Data	You can map the parameter to a resource object's instance key.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Task Information	The fields of the Task List form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Process Definition	The fields of the Process Definition form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Organization Definition	The fields of the Organizations form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	User Definition	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Request Info	Request ID. You can map the parameter to the Request ID field of the Requests form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Request Info	Request Action. You can map the parameter to the Request Action field of the Requests form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Request Info	Request Priority. You can map the parameter to the Request Priority field of the Requests form.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Request Target User	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Request Target Organization	The fields of the Organizations form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Requester Info	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Literal	If you are mapping the adapter variable to a literal, a Literal Value field is displayed below the Qualifier combo box. Within the field, enter the value of this literal. Note: If the data type of the adapter variable is Boolean, two options are displayed in place of the field: True and False. Select the option that reflects the value of the adapter variable. Note: If the data type of the adapter variable is Object, Literal cannot be selected from the Map To combo box.
String	IT Resources	Resource Instance. You can map the parameter to an IT resource's instance key. This IT resource is a member of the IT resource type that is displayed in parenthesis from within the Data Type field.
String	IT Resources	IT Asset Type. You can map the parameter to an IT resource type.
String	IT Resources	IT Asset Property. You can map this parameter to one of the properties that comprise the selected IT resource type.

3.15.3.5 Rule Generator and Entity Adapter Variable Mappings

The following table lists the rule generator and entity adapter variable mappings.

Variable Type	Map To	Qualifier/Description
Object (Adapter Return Variable), IT Resource, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short	Literal	If you are mapping the adapter variable to a literal, a Literal Value field is displayed below the Qualifier combo box. Within the field, enter the value of this literal. Note: If the data type of the adapter variable is Object, Literal cannot be selected from the Map To combo box.
Object (Adapter Return Variable), IT Resource, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short	Entity Field	You can map the adapter variable to a field of the associated process form. The name of this form is displayed in the Form Description field of the Data Object Manager form.
Object (Adapter Return Variable), IT Resource, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short	Organization Definition	The fields of the Organizations form to which you can map the adapter variable. Note: If the data type of the adapter variable is not Object, you cannot select Organization ID and Organization Parent ID from the Qualifier combo box.
Object (Adapter Return Variable), IT Resource, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short	User Definition	The fields of the Users form to which you can map the adapter variable.

3.15.3.6 Prepopulate Adapter Variable Mappings

The following table lists the prepopulate adapter variable mappings.

Variable Type	Map To	Qualifier/Description
IT Resource	IT Resource	You can map the parameter to an IT resource. This IT resource is a member of the IT resource type that is displayed in parenthesis from within the Data Type field.
IT Resource	Process Data	You can map the parameter to a field of the associated process-specific form. Note: The only field names that are displayed in this combo box are ones with a data type of IT Resource Lookup Field.
Object, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Process Data	You can map the parameter to a field of the associated process-specific form.
Object, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Organization Definition	The fields of the Organizations form to which you can map the adapter variable.
Object, String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	User Definition	The fields of the Users form to which you can map the adapter variable.
String, Boolean, Character, Byte, Date, Integer, Float, Long, Short, Double	Literal	If you are mapping the adapter variable to a literal, and the variable's data type is String, Character, Byte, Integer, Float, Long, Short, or Double, a Literal Value field is displayed below the Qualifier combo box. Within the field, enter the value of this literal. When you are mapping the adapter variable to a literal, and the variable's data type is Boolean, two Literal Value options are displayed below the Qualifier combo box: True and False. Select the option that corresponds to the value of the adapter variable. If you are mapping the adapter variable to a literal, and the variable's data type is Date, a Literal Value lookup field is displayed below the Qualifier combo box. Double-click this lookup field. From the Date & Time window that is displayed, select the date and time that will be the value of this literal.
String	IT Resources	If you are mapping the adapter variable to an IT Resource, three combo boxes are displayed below the Map To combo box: Qualifier, IT Asset Type, and IT Asset Property. From these combo boxes, select the qualifier for the mapping, the specific name of the IT resource, and the field of the IT resource that will receive the results of the mapping. Note: If the data type of the adapter variable is not String, then IT Resources cannot be selected from the Map To combo box.

3.16 Defining Error Messages

The Error Message Definition form is used to define error messages that are displayed in the UI and that application developers can access when creating error handler tasks.

This section contains the following topics:

3.16.1 The Error Message Definition Form

The Error Message Definition form is in the Development Tools folder of the Design Console.

The Error Message Definition form is used to:

Create the error messages that are displayed in dialog boxes when certain problems occur.
Define the error messages that users can access when they create error handler tasks by using the Adapter Factory form.

The error messages you create are displayed on the Identity Self Service or Identity System Administration if they are added to an adapter definition while creating a new adapter by using an error handler logic task based on a failure condition.

Note:

If an entity adapter is attached to a process form or an object form for validation of field values, these adapters will run if you edit data in these forms after completing direct or request provisioning.

This release of Oracle Identity Manager does not support creating new entity adapters.

Figure 3-3shows the Error Message Definition form.

Figure 3-3 Error Message Definition Form

Description of "Figure 3-3 Error Message Definition Form"

When you create an error message, Oracle Identity Manager populates the Key field with a unique identification number. When a condition occurs that causes the error message to be displayed, the text in the Description field is displayed in a dialog box.

Note:

After you create an error message definition, to reset the count of how many times the error message is displayed, click the Reset Count button. This resets the count to zero.

3.16.2 Fields of the Error Message Definition Form

The Error Message Definition form provides fields to create error messages to be displayed when certain problems occur and to define error messages that users can access when they create error handler tasks.

Table 3-8 describes the data fields of the Error Message Definition form.

Table 3-8 Fields of the Error Message Definition Form

Field Name	Description
Key	The error message definition's unique, system-generated identification number.
Code	The code that represents the error message definition.
Reset Count	When you click this button, Oracle Identity Manager resets the counter to zero. This counter is the number of times the error message is displayed.
Description	A description of the error message.
Remedy	A description of how to correct the condition that caused the error message to be displayed.
Help URL	The link to the URL that contains an online Help topic for this error message.
Action	A one-letter code, representing the seriousness of the condition that causes the error message to be displayed. An error message has three levels of seriousness: Error (E), Rejection (R), and Fatal Rejection (F).
Severity	For classification purposes, you can categorize the seriousness of the condition that results in the error message being displayed, even further. An error message has five sub-levels of severity: None (N), Low (L), Medium (M), High (H), and Crash (C).
Note	Explanatory information about the error message.

3.16.3 Creating an Error Message

You can create error messages and add new error codes and advice messages in the customResources.properties resource bundle to display the localized error codes and advice messages in the UI.

To create an error message:

Open the Error Messaging Definition form.
In the Code field, enter the code that represents the error message definition.
In the Description field, enter a description for the error message.
In the Remedy field, you can enter a description for how to correct the condition that causes the error message to be displayed.
In the Help URL field, you can enter the link to the URL that contains an online Help topic for this error message.
(Optional) Double-click the Action Lookup field.
From the Lookup dialog box that is displayed, you can select a code that represents the seriousness of the condition that causes the error message to be displayed. These codes, listed by degree of seriousness (from lowest to highest), are:
- Error (E). Oracle Identity Manager stores the error message, and stops any related operations from being triggered. Instead, the operation rolls back to the previous operation.
- Reject (R). Oracle Identity Manager stores the rejection message, but it does not prevent subsequent operations from being executed.
- Fatal Reject (F). Oracle Identity Manager stores the rejection message, and it stops any subsequent operations from being triggered. However, it stores all operations that were executed up to the fatal rejection.
(Optional) Double-click the Severity Lookup field. From the Lookup dialog box that is displayed, you can select a code (None (N), Low (L), Medium (M), High (H), or Crash (C)). This code presents a detailed classification of the code that is displayed in the Action lookup field.
In the Note field, enter explanatory information about the error message.
Click Save.

The error message is created.

After creating error messages by using the Error Message Definition form, you must add new error codes and advice messages in the Oracle Identity Manager customResources.properties resource bundle. These localized error codes and advice messages will be displayed in Identity Self Service or Identity System Administration.