Scheduling a Job by Editing the Configuration Files

You can schedule jobs, including import and export jobs, by hand-editing configuration files and restarting the application server.

Two configuration files control the scheduler. These two files are located in the $RBACX_HOME/WEB-INF folder:

• scheduling-context.xml - Edit this file to enable (or disable) scheduled tasks, such as users import, accounts import, and others.

• jobs.xml - Edit the cron expressions in this file to define a schedule for each job.

Note - The contents of these files vary by application server.

To schedule a job, you must edit both scheduling-context.xml and jobs.xml and restart the application server.

The following table lists the types of jobs that can be enabled and scheduled by editing the configuration files. For each job that you are enabling or disabling, both the job name and the trigger name appear in both scheduling-context.xml and jobs.xml. If you are enabling a job, verify that both job references and both trigger references contain correct information and are not commented out. See Scheduling a Job by Editing the Configuration Files for more information.

To Enable a Job by Editing the Configuration Files

The following procedure describes how to enable a job. This example demonstrates how to enable the users import job and the accounts import jobs. The same procedure, however, can be used to enable other kinds of jobs, as well.

1. Navigate to $RBACX_HOME/WEB-INF/.

2. Open scheduling-context.xml in a text editor.

3. Edit the required lines as follows to enable import:

   • To enable users import, uncomment usersImportJob in the jobDetails property section, and uncomment usersImportTrigger in the triggers property section.

     • The uncommented usersImportJob line should look like this:

       <ref bean="usersImportJob"/>

     • The uncommented usersImportTrigger line should look like this:

       <ref bean="usersImportTrigger"/>

   • To enable accounts import, uncomment accountsImportJob in the jobDetails property section, and uncomment accountsImportTrigger in the triggers property section.

     • The uncommented accountsImportJob line should look like this:

       <ref bean="accountsImportJob"/>

     • The uncommented accountsImportTrigger line should look like this:

       <ref bean="accountsImportTrigger"/>

4. Save your changes.

5. Schedule the job by editing jobs.xml in a text editor.

   See To Enable a Job by Editing the Configuration Files for more information.

The portion of scheduling-context.xml that contains the lines that you need to edit follows:

<property name="jobDetails">
<list>
<!-- Uncomment the line before to use this account import job.
Multiple jobs can be added,
1. Define a job in jobs.xml
2. Add a reference to job below -->
<!--ref bean="usersImportJob"/-->
<!--ref bean="accountsImportJob"/-->
<!--ref bean="rolesImportJob"/-->
<!--ref bean="glossaryImportJob"/-->
<!--ref bean="policiesImportJob"/-->
<!--ref bean="certificationReminderJob"/-->
<!--ref bean="reportReminderJob"/-->
<!--ref bean="stableFolderCleanUpJob"/-->
<!--ref bean="accountsMaintenanceJob"/-->
<!--ref bean="roleMembershipRuleJob"/-->
<ref bean="fullTextIndexMaintenancedJob"/>
<ref bean="workflowStepSLAJob"/>
<ref bean="roleMembershipJob"/>
</list>
</property>

<property name="triggers">
<list>
<!-- Uncomment the line before to use this account import job.
Multiple triggers can be added,
1. Define a trigger in jobs.xml
2. Add a reference below -->
<!--ref bean="usersImportTrigger"/-->
<!--ref bean="accountsImportTrigger"/-->
<!--ref bean="accountsImportTrigger_2"/--> <!-- Additional triggers for account imports 
                                                to be used in clusters -->
<!--ref bean="accountsImportTrigger_3"/--> <!-- Additional triggers for account imports 
                                                to be used in clusters -->
<!--ref bean="rolesImportTrigger"/-->
<!--ref bean="glossaryImportTrigger"/-->
<!--ref bean="policiesImportTrigger"/-->
<!--ref bean="certificationReminderTrigger"/-->
<!--ref bean="reportReminderTrigger"/-->
<!--ref bean="stableFolderCleanUpTrigger"/-->
<!--ref bean="accountsMaintenanceTrigger"/-->
<!--ref bean="roleMembershipRuleTrigger"/-->
<ref bean="fullTextIndexMaintenanceTrigger"/>
<ref bean="workflowStepSLATrigger"/>
<ref bean="roleMembershipJobTrigger"/>
</list>
</property>

To Schedule a Job by Editing the Configuration Files

The following procedure describes how to schedule a job by editing jobs.xml in a text editor. This example demonstrates how to schedule the users import jobs and the accounts import jobs. The same procedure, however, can be used to schedule other kinds of jobs, as well.

- Before a job can run, you need to enable it. See Scheduling a Job by Editing the Configuration Files for instructions.

1. Navigate to $RBACX_HOME/WEB-INF/.

2. Open jobs.xml in a text editor.

3. To schedule a users import job, follow these steps:

   1. Uncomment usersImportTrigger and usersImportJob (if necessary).

   2. In usersImportTrigger, edit the cron expression to schedule the job.

      See Sample Cron Expressions for more information.

4. To schedule an accounts import job, follow these steps:

   1. Uncomment accountsImportTrigger and accountsImportJob (if necessary).

   2. In accountsImportTrigger, edit the cron expression to schedule the job.

      See Sample Cron Expressions for more information.

5. Save your changes.

6. Restart the application server to have your changes take effect.

Note - If running Oracle Identity Analytics in a clustered environment, you need to define additional triggers for each server in the cluster that you want to run the job at the same time. Refer to the example in the jobs.xml file for more information.

The portion of jobs.xml that contains the usersImportJob and usersImportTrigger sections that you need to edit follows:

  <bean id="usersImportTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
        <property name="jobDetail">
            <ref bean="usersImportJob"/>
        </property>
        <property name="cronExpression">
            <value>0 0/5 * * * ?</value>
        </property>
    </bean>

    <bean id="usersImportJob" class="org.springframework.scheduling.quartz.JobDetailBean">
        <property name="name">
            <value>Users Import</value>
        </property>
        <property name="description">
            <value>Users import Job</value>
        </property>
        <property name="jobClass">
            <value>com.vaau.rbacx.scheduling.manager.providers.quartz.jobs.IAMJob /
</value>
        </property>
        <property name="group">
            <value>SYSTEM</value>
        </property>
        <property name="durability">
            <value>true</value>
        </property>
        <property name="jobDataAsMap">
            <map>
                <!-- only single user name can be specified for  jobOwnerName (optional)-->
                <entry key="jobOwnerName">
                    <value>REPLACE_ME</value>
                </entry>
                <!-- multiple user names can be specified as 
                     comma delimited e.g user1,user2 (optional)-->
                <entry key="usersToNotify">
                    <value>REPLACE_ME</value>
                </entry>
                <entry key="IAMActionName">
                    <value>ACTION_IMPORT_USERS</value>
                </entry>
                <entry key="IAMServerName">
                    <value>FILE_SERVER</value>
                </entry>
                <!-- Job chaining, i.e. specify the next job to run (optional) -->
                <entry key="NEXT_JOB">
                    <value>rolesImportJob</value>
                </entry>
            </map>
        </property>
    </bean>

Sample Cron Expressions

The schedule for each job is specified using a cron expression. A cron expression is a string comprised of six or seven fields separated by white space that specify the time and day (or time and date) for every job. Each job has a cron expression, which is defined within the <property name="cronExpression"> element in jobs.xml.

The following operators can be used in cron expressions:

• The comma operator (',') specifies a list of values, for example: 1,2,3,5,7.

• The dash operator ('-') specifies a range of values, for example: 1-5, which is equivalent to 1,2,3,4,5.

• The asterisk operator ('*') specifies all possible values for a field. For example, an asterisk in the day-of-month field is equivalent to every day (unless other fields further modify the expression).

• The slash operator ('/') can be used to skip a given number of values. For example 0/5 in the minute field is equivalent to every five minutes.

• The question mark operator ('?') is allowed for the day-of-month and day-of-week fields. It is used to specify 'no specific value'. This is useful when you need to specify something in one of the two fields, but not the other.

The fields that make up a cron expression are listed here:

 .------------------- second (0 - 59) 
 |  .---------------- minute (0 - 59) 
 |  |  .------------- hour (0 - 23)
 |  |  |  .---------- day of month (1 - 31)
 |  |  |  |  .------- month (1 - 12) OR jan,feb,mar,apr ... 
 |  |  |  |  |  .---- day of week (1 - 7) (Sunday=1)  OR sun,mon,tue,wed,thu,fri,sat 
 |  |  |  |  |  |
 *  *  *  *  *  *   

Following are a few sample cron expressions.