Configure Batch
Configure Batch Properties
Four files are provided to configure Batch:
File |
Description |
---|---|
selfservice-batch.properties |
Defines various Batch related properties used within Batch |
quartz.properties |
Defines the quartz scheduler properties |
criteria.xml |
Defines the selection criteria used within Batch to define a batch |
batch.xml |
Configuration file to configure various options in drop-down fields when creating/editing a batch |
selfservice-batch.properties
No properties in selfservice-batch.properties must be configured to get Batch up and running and generating Batch audits. However, there may be certain properties you may be interested in knowing are available options to configure.
quartz.properties
Four major properties found in quartz.properties define the JDBC connection the quartz scheduler will use to connect to your database:
|
See Quartz Scheduler information.
criteria.xml
Batch criteria are defined within the criteria bean element of the criteria.xml file. Several properties are specified to provide users with operands and values within drop-down boxes that will ultimately generate a SQL statement to retrieve a list of students. It uses the following format:
|
New in 4.4.2 Two new Batch queries added for use when copying over your existing file
NOTE: |
Criteria bean properties:
Property |
Description |
---|---|
studentQuery |
Retrieves all information |
studentQueryKeyword |
If the query already includes a clause and the system needs to append more conditions, it appends using an "and" specified within this property |
operands |
List of operands that will be available to the user when creating the batch criteria. The operand is defined within the next property |
operand |
The Operand is defined within an entry element since it is based on a Java Map object |
stunos_query New in 4.4.2 |
The query used to look up the stuno by name on the Criteria page |
stuname_query New in 4.4.2 |
The query used to look up a student by name on the Criteria page |
Batch ships with a query to retrieve the students from a u.achieve database that looks like the following:
|
This query may be modified to access student table directly from the institution SIS. The student number and name are required to be defined within the new query and must be in the same order specified, but the unique id is no longer required. Both the dprog and catlyt are required, even if you choose not to run What-if Batch audit requests, in which case they would be set to a space (' ').
Within the Operand, the key property must be defined, should be unique, and should also match the operand bean id. Within the operand bean element, the following properties need to be defined:
Property |
Required |
Description |
---|---|---|
name |
Yes |
Short text how it will show within the drop-down box |
type |
Yes |
The type of value that will be used |
query |
Yes |
Sub-query used that will be appended to the main student query |
lov |
No |
Query used to present a list of values within the drop-down box in the value text box of the condition form |
What-if Batch Audit Requests
In addition to adding columns in the batch.xml for dprog and catlyt, as of 4.3.0.3 the studentQuery in the criteria.xml must also be configured for each student using a view that includes the stuno, stuname, dprog, and catlyt:
Understanding the Criteria Data Points (criteria.xml)
Defining data points is done by configuring the criteria.xml file. This file basically defines the student population the user will select students from and the conditions they can select from.
The criteria.xml file consists of two major areas:
- Student Query
- Operands
Student Query
The Student Query property contains the main query used that defines the largest student population collection. The query looks like the following:
|
The query must always return a unique list of students. Once again, both the dprog and catalog year fields are required and must be returned within the fields in the select statement, even if you choose not to run What-if Batch audit requests [in which case they would be set to a space (' ')]. The int_seq_no is no longer required.
Field |
Description |
---|---|
int_seq_no |
Student identifier as used within the STU_MASTER table. If the STU_MASTER table is not used, it can return 0. |
stuno |
Student number. This could be different for the SIS system used. For example, if using DARWin, you would use STU_MASTER.STUNO. In a Banner system, you would use SPRIDEN.SPRIDEN_ID. |
stuname |
Student name |
dprog | Degree program name to submit with Batch audit request, if wanting to perform Batch what-if audit requests. |
catlyt | Catalog year and term to submit with Batch audit request, if wanting to perform Batch what-if audit requests. |
Operands
The operands are the datapoints or labels that define how the student population will be narrowed down.
Operands look like the following:
|
For functional details on Batch operands, see Create or Edit a Batch. |
See also Batch Data Points.
How it Creates the Query
Batch generates a new query for every condition defined within the criteria tab; for every condition on the criteria tab, a condition is added the the main query. For example, we will use the student query as defined above and assume the user has a condition using operand "GraduationTerm = 200010". Within Batch, it will look something like this:
The query generated by Batch behind the scenes will look like the following:
|
The condition is added to the main query, and the {operator} and {value} tags are replaced with the "=" sign and the "200010" value as specified by the selection of the user.
batch.xml
Configuring the batch.xml file follows the same format as other XML file configurations within Self-Service. Batch can be configured with various drop-down options to choose from when creating a batch. Several options have been given defaults. However, for some fields such as servername value to use, they are specific to the uAchieve Server configuration and will likely need to be changed.
Below is an example:
<options name="serverNames">
<option name="40TEST" label="40TEST" />
<option name="40DEV" label="40DEV" />
</options>
See Batch Forms for more information.