Developing and Deploying OIM 11G Custom Scheduler Task

Hi

The following steps used to build the Custom Scheduler Task in OIM 11g

Environment Setup

The following jar files are required to compile the Custom Scheduler Task Java file. They are
1) wlfullclient.jar
2) wlclient.jar

Generating wlfullclient.jar
Go to the WL_Home/server/lib directory and Run the following command

java -jar wljarbuilder.jar

It will generate the wlfullclient.jar file and set the class path for the wlfullclient.jar and wlclient.jar file.


Develop the Java Class

package test.scheduler;

import java.util.HashMap;

import oracle.iam.scheduler.vo.TaskSupport;

public class TrustedSourceReconciliation extends TaskSupport {

public TrustedSourceReconciliation() {


System.out.println("TrustedSourceReconciliation() Called");
}

/**
* This method called by quartz scheduler and HashMap contains the config parameters.
*/
public void execute(HashMap arg0) throws Exception {

System.out.println("SfsuTrustedSourceReconciliation Arguments "+arg0);
}

public HashMap getAttributes()
{
return null;
}
public void setAttributes()
{

}

}

Make Jar File

Jar cvf TrustedSourceReconciliation.jar *


Develop the Custom Scheduler Config File


<scheduledtasks xmlns="http://xmlns.oracle.com/oim/scheduler">
<task>
<name>TrustedSourceReconciliation</name>
<class>test.scheduler.TrustedSourceReconciliation</class>
<description>Trusted Reconciliation</description>
<retry>5</retry>
<parameters>
<string-param required="true" encrypted="false" helpText="User Name">DB User Name</string-param>
<string-param required="true" encrypted="false" helpText="DB Password">DB Password</string-param>
<string-param required="true" encrypted="false" helpText="DB URL">DB URL</string-param>
<string-param required="true" encrypted="false" helpText="Select Statement">Select Statement</string-param>
</parameters>
</task>
</scheduledTasks>

Save this file as TrustedSourceReconciliation.xml because Custom Scheduler task name and file name as same as per the oracle custom scheduler scpecification.

XML Name space is very important when you deploying custom scheduler task in MDS Schema. If you give wrong name space in scheduledTasks tag and it will deploy in the OIM MDS Schema But OIM won't recognised as a ScheuledTask.


Develop the plugin.xml file

<?xml version="1.0" encoding="UTF-8"?>
<oimplugins>
<plugins pluginpoint="oracle.iam.scheduler.vo.TaskSupport">
<plugin pluginclass="test.scheduler.TrustedSourceReconciliation" version="1.0" name="TrustedSourceReconciliation"/>
</plugins>
</oimplugins>


Making the Scheduler.zip File

plugin.xml file
lib/TrustedSourceReconciliation.jar

Regsiter the Plugin File into the OIM Server

ant -f pluginregistration.xml register

It will ask the following details after running the above command


1) OIM Admin User Name : xelsysadm
2) OIM Admin Password : xelsysadm password
3) OIM URL : t3://localhost:14000
4) Plugin Zip File absolute path.

It will deploy the OIM Plugin without any issue. Some Times It will throw error if the class file is not found in the jar file.

Importing the Custom Scheduler Task into MDS Schema

Go to the OIM_HOME/bin directory and modify the following properties in the weblogic.properties file

wls_servername=oim_server1
application_name=oim
metadata_from_loc=/home/oracle/schedulers

Schedeler Config file location as /home/oracle/schedulers/db/TrustedSourceReconciliation.xml

Run the weblogicImportmetada.sh file and will ask the following details


1) Weblogic Admin User Name : weblogic
2) Weblogic Admin Password : weblogic admin password
3) weblogic Admin URL : t3://localhost:7001

After running the above command the custom scheduler task will be imported into the MDS Schema.

Clear the OIM Cache

Run the PurgeCache.sh All file and it will ask the following details.


1) OIM Admin User Name : xelsysadm
2) OIM Admin Password : xelsysadm password
3) OIM URL : t3://localhost:14000


After running the above command and it will clear the OIM cache

Restart the OIM Server

Go to the WL_DOMAIN_HOME/bin direcory and run stopManagedServer.sh oim_server1 command and it will stop the oim managed server.

Run the startManagedServer.sh oim_server1 and it will start the OIM Managed Server.

Testing The Scheduler Task

Login to the OIM Admin Console >> Advanced >> System Management >> Scheduler >>Create >> Search the TrustedSourceReconciliation and select the Scheduler and enter the parameters and click Save and run the Scheduler.


Trouble Shooting

Problem : Scheduler Task is not showing in the Scheduler List
Cause : Scheduler Name space is missing
Solution : Check the Scheduler name space in the scheduer task. The name space always xmlns="http://xmlns.oracle.com/oim/scheduler"

Problem : The Scheduler implemented class file not found while deploying the plugin.zip file.
Cause : The class file is missing in the zip file.

Solution : Please add the jar file into the lib directory and make the zip file again and regsiter the plugin.


Reference Document : Oracle Identity Manager Developer Guide