A Scheduled Task Configuration File

This appendix describes the structure and details of the XML file containing scheduler task definitions.

Structure of the Scheduler XML File
The scheduledTasks Element
The task Element
The name Element
The class Element
The description Element
The retry Element
The parameters Element
The string-param Element
The number-param Element
The boolean-param Element

A.1 Structure of the Scheduler XML File

The following is a list of elements in the configuration XML file:

<scheduledTasks xmlns="http://xmlns.oracle.com/oim/scheduler">
    <task>
        <name>
        <class>
        <description>
        <retry>
        <parameters>
            <string-param>
            .....
            </string-param>
            
            <number-param>
            .......
            </number-param>
            
            <boolean-param>
            .......
            </boolean-param>
        </parameters>
    </task>
</scheduledTasks>

A.2 The scheduledTasks Element

The scheduledTasks element is the root element in XML used to define scheduled tasks.

Table A-1 summarizes the properties of the scheduledTasks element.

Table A-1 Properties of the scheduledTasks Element

Property	Value
Parent Element	NA
Attributes	The XML namespace is specified as an attribute of the scheduledTasks element as follows: <scheduledTasks xmlns="http://xmlns.oracle.com/oim/scheduler"> Note: The xmlns parameter is mandatory.
Child Elements	task
Number of Occurrences	One for each scheduled task XML file to be created.
Element Value	NA
Mandatory or Optional?	Mandatory

A.3 The task Element

The task element is the child element of the scheduledTasks element.

You use the task element to define a scheduled task. The task element contains information about the scheduled task, for example, the name, class, description, and retry count of the scheduled task.

Table A-2 summarizes the properties of the task element.

Table A-2 Properties of the task Element

Property	Value
Parent Element	scheduledTasks
Attributes	None
Child Elements	name, class, description, retry, and parameters
Number of Occurrences	One for each task to be created. NOTE: If you want to define more than one task in a single scheduled task XML file, you must use one task element for every scheduled task being defined.
Element Value	NA
Mandatory or Optional?	Mandatory

A.4 The name Element

The name element is the child element of the task element. The name element is used to specify the name of the scheduled task being created.

Table A-3 summarizes the properties of the name element.

Table A-3 Properties of the name Element

Property	Value
Parent Element	task
Attributes	None
Child Elements	None
Number of Occurrences	One
Element Value	Name of the scheduled task being created. Note: The name of the scheduled task must be unique.
Mandatory or Optional?	Mandatory

A.5 The class Element

The class element is a mandatory element and is the child element of the task element. You use the class element to specify the name of the Java class that runs the scheduled task.

Table A-4 summarizes the properties of the class element.

Table A-4 Properties of the class Element

Property	Value
Parent Element	task
Attributes	None
Child Elements	None
Number of Occurrences	One
Element Value	Name of the Java class that runs the scheduled task. See Section 6.4, "Develop the Scheduled Task Class" for information on developing a class for the scheduled task.
Mandatory or Optional?	Mandatory

A.6 The description Element

The description element is a mandatory element and is the child element of the task element. You can use the description element to provide a description of the task being created.

Table A-5 summarizes the properties of the description element.

Table A-5 Properties of the description Element

Property	Value
Parent Element	task
Attributes	None
Child Elements	None
Number of Occurrences	One
Element Value	Description of the task being created
Mandatory or Optional?	Mandatory

A.7 The retry Element

Table A-6 summarizes the properties of the retry element.

Table A-6 Properties of the retry Element

Property	Value
Parent Element	task
Attributes	None
Child Elements	None
Number of Occurrences	One
Element Value	Number of seconds the scheduler must wait before it tries to schedule the task again
Mandatory or Optional?	Mandatory

A.8 The parameters Element

If you want to specify parameters at run time that the scheduled task requires for a successful job run, you must use the parameters element. For example, you might create a scheduled task that requires the user to specify the number of records to be retrieved at run time.

The parameters specified within this element are displayed under the Parameters section on the Create Job page.

Table A-7 summarizes the properties of the parameters element.

Table A-7 Properties of the parameters Element

Property	Value
Parent Element	task
Attributes	None
Child Elements	string-param, number-param, boolean-param
Number of Occurrences	One
Element Value	NA
Mandatory or Optional?	Optional

A.9 The string-param Element

You can use the string-param element to specify the name of the field that can take a value of the string data type. In other words, the string-param element specifies a label for the field that can hold a value of the string data type.

Table A-8 summarizes the properties of the string-param element.

Table A-8 Properties of the string-param Element

Property	Value
Parent Element	parameters
Attributes	required, helpText, encrypted
Child Elements	None
Number of Occurrences	One for every parameter of the string data type
Element Value	Name of the string parameter
Mandatory or Optional?	Optional

As listed in Table A-8, the string-param element contains the following attributes:

required

This is a mandatory attribute and it can take a value of either true or false.

If the value of the required attribute is true, it is mandatory to enter a value for the parameter at run time.

If the value of the required attribute is false, it is not mandatory to enter a value for the parameter at run time.
helpText

Use this attribute to specify the text that must appear at run time to help users know what to enter in the field. The text that is specified is usually the description of the field that is being created by the parameter.
encrypted

By default, it has a value of false and this can take a value of either true or false.

If the value of the encrypted attribute is true, then the entered value for the parameter at run time is stored in encrypted form.

If the value of the required attribute is false, then the entered value for the parameter at run time is stored in plain text.

A.10 The number-param Element

You can use the number-param element to specify the name of the field that can take a value of the long data type.

Table A-9 summarizes the properties of the number-param element.

Table A-9 Properties of the number-param Element

Property	Value
Parent Element	parameters
Attributes	required, helpText
Child Elements	None
Number of Occurrences	One for every parameter of the long data type
Element Value	Name of field that can hold a long data type
Mandatory or Optional?	Optional

The behavior and description of the require and helpText attributes for the number-param and string-param elements is the same. See "The string-param Element" for information about the require and helpText attributes.

A.11 The boolean-param Element

You can use the boolean-param element to specify the name of the field that can take a value of the boolean data type.

Table A-10 summarizes the properties of the boolean-param element.

Table A-10 Properties of the boolean-param Element

Property	Value
Parent Element	parameters
Attributes	required, helpText
Child Elements	None
Number of Occurrences	One for every parameter of the boolean data type
Element Value	Name of field that can hold a boolean data type
Mandatory or Optional?	Optional

The behavior and description of the require and helpText attributes for the boolean-param element and the string-param element is the same. See Section A.9, "The string-param Element" for information about the require and helpText attributes.