Schedulers in OIM

The second article on the plug-in points will be based on schedulers.
The relevant plugin point for the same is  : oracle.iam.scheduler.vo.TaskSupport

Oracle Identity Manager provides the capability of creating your own scheduled tasks. We can create scheduled tasks according to your requirements if none of the predefined scheduled tasks fit your needs.

OIM exposes scheduler APIs to perform long running tasks which may include huge data exchange, data processing which can be triggered periodically or on demand without any code changes.

one quick point here will be , we can start or stop the entire scheduler services from the below portal -
http://OIM_HOST:OIM_PORT/SchedulerService-web/status

There are three part of developing a custom scheduler  :

• Creating / Importing the Scheduled Task definition XML File
• Developing the Scheduled Task Class
• Configuring the Plug-in XML File

Creating / Importing the Scheduled Task definition XML File :

Configuring the scheduled task XML file involves updating the XML file that contains the definitions of custom scheduled tasks.

This file name must be the same as the scheduled task name, with the .xml extension. We must import the custom scheduled task file to the /db namespace of Oracle Identity Manager MDS schema.

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

We can import this metadata through "weblogicImportmetada.sh" script , make sure our "weblogic.properties" file under OIM_HOME/bin directory has the "metadata_from_loc" property updated with the current location for

The way I like to do it though, is from taking an export of any of the existing tasks (without the job jar file), and changing the parameters accordingly, and re-importing it through deployment manager -

<?xml version = '1.0' encoding = 'UTF-8'?> <xl-ddm-data version="11.1.2.3.0" user="XELSYSADM" database="jdbc:oracle:thin:@DATABASE_HOSTNAME_FQDN:PORT_NUMER/SERVICE_NAME" exported-date="1548663495530" description=""><scheduledtask repo-type="MDS" name="TASKNAME" mds-path="/db" mds-file="TASKNAME.xml"><completexml> <scheduledtasks xmlns="http://xmlns.oracle.com/oim/scheduler"> <task> <name>TASKNAME</name> <class>***** the fully qualified package + class name********</class> <description>Oracle Unified Directory Account provisioining scheduler</description> <retry>3</retry> <parameters> <string-param required="true" encrypted="false" helpText="User AD IDS, comma separated">User AD IDs</string-param> </parameters> </task> </scheduledTasks></completeXml></scheduledTask></xl-ddm-data>

Configuring the Plug-in XML File : 

just like any other plugins in OIM, we need a plug-in file to register the scheduler.

<?xml version="1.0" encoding="UTF-8"?> <oimplugins> <plugins pluginpoint="oracle.iam.scheduler.vo.TaskSupport"> <plugin pluginclass="***** the fully qualified class name********" version="1.0" name="TASKNAME"/> </plugins> </oimplugins>

Developing the Scheduled Task Class : 

We'll read the user's AD account UIds from the input parameter defined in the scheduler definition metadata, split them by ',' and provision OUD account to each of them. Point to be noted - we're only passing the Container DN for the OUD account here, rest of all the attributes will be filled by pre-populate adapters mapped in the process form.

The basic will be to extend the 'TaskSupport' class, and to override the method  'execute' -
package com.xyz.app.validator; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import oracle.iam.identity.usermgmt.api.UserManager; import oracle.iam.identity.usermgmt.vo.User; import oracle.iam.platform.Platform; import oracle.iam.platform.entitymgr.vo.SearchCriteria; import oracle.iam.provisioning.api.ApplicationInstanceService; import oracle.iam.provisioning.api.ProvisioningService; import oracle.iam.provisioning.vo.Account; import oracle.iam.provisioning.vo.ApplicationInstance; import oracle.iam.request.api.RequestService; import oracle.iam.scheduler.vo.TaskSupport; import oracle.iam.provisioning.vo.AccountData; import oracle.iam.provisioning.vo.FormInfo; public class CLASSNAME extends TaskSupport { @Override public void execute(HashMap hm) throws Exception { for ( String str : hm.get("User AD IDs").toString().split(",")) // reading the input { System.out.println( "AD s : " + str); UserManager usrMgr = Platform.getService(UserManager.class); ProvisioningService ps = (ProvisioningService) Platform.getService(ProvisioningService.class); RequestService rs = (RequestService)Platform.getService(RequestService.class); ApplicationInstanceService ais = (ApplicationInstanceService) Platform.getService(ApplicationInstanceService.class); ApplicationInstance OUDAppInstance = ais.findApplicationInstanceByName("OUDAccount"); System.out.println("APP name : " + OUDAppInstance.getApplicationInstanceName()); SearchCriteria criteria = new SearchCriteria("User Login",str, SearchCriteria.Operator.EQUAL); FormInfo formInfo = OUDAppInstance.getAccountForm(); Map parentData = new HashMap(); parentData.put("UD_OUD_USR_SERVER","6"); parentData.put("UD_OUD_USR_ORGANIZATION","6~ou=people,ou=intranet,dc=xyz,dc=com"); parentData.put("UD_OUD_USR_USERID",str); AccountData accountData = new AccountData(String.valueOf(formInfo.getFormKey()), null, parentData); // create an account data for the account, it's equivalent to filling the request onject form in OIM GUI Account account = new Account(OUDAppInstance, accountData); account.setAccountType(Account.ACCOUNT_TYPE.Primary); Set retSet = new HashSet(); retSet.add("usr_key"); retSet.add("User Login"); List<user> users = usrMgr.search(criteria, retSet, null); ps.provision(users.get(0).getId(), account); System.out.println(" OUD account has beenprovisioned : "); } } @Override public HashMap getAttributes() { // TODO Auto-generated method stub return null; } @Override public void setAttributes() { // TODO Auto-generated method stub } }

At the end  -
I'll like to encourage you to go through the below Oracle guides for a deeper understanding -

OIM admin guide  -  https://docs.oracle.com/cd/E37115_01/admin.1112/e27149/scheduler.htm#OMADM738 
OIM developer guide  - https://docs.oracle.com/cd/E37115_01/dev.1112/e27150/refsched.htm#OMDEV231