Batch Components

Contains another Batch Definition. This can be used to create a complex or multi-leveled Batch Definition. For example, a parent Batch Definition can start each day, starting with two child Batch Definitions, each with different schedules or conditions.

For each new Batch component, you must set the same parameters for a Batch Definition as described above. You can then add additional components to the Batch.

Provides conditional processing when running Batches. The component specified by the test is run. If it runs successfully, the component specified by success is executed. If it fails, the component specified by failed is executed.

The component specified in test returns success in the following conditions:

Contains a reference to a registered Batch Definition that gets loaded when scheduled from the Batch Registry.

Runs an implemented method in a deployed class. Properties in Batch commands are based on the Java Beans specification. In a Java class, you define methods which match a pattern to get and set property values. For example, if you have a property called MyName, you can define two methods:

Public class MyCommand implements Command { 
     public void setMyName(String value) { MyName = value; } 
public String getMyName() { Return MyName; } 
public int run() 
     { 
          ; //do stuff 
          return Command.SUCCESS; 
     } 
} 

On the Batch Registry page, adding this command to a Batch, you can then add a property with the name MyName and value Bob by entering these in the two text fields and clicking Add property.

Starts a Service. You can specify a Service type registered on the Manager and method name to run. You can also specify a Service reference ID (this enables you to reference the Service from another Service Command), Service action, and input and init data for the Service. Data is comma-delimited.

You can add ServiceDescription, ServiceOptions, and Discriminator components to a Service by using a Service Runner.

Loads the specified registered Service Runner. See below for information about registering a Service Runner.

Executes a command via the GridServer Admin API. For more information about using the Admin API, see the GridServer Developer’s Guide.

Sends an email message from a Batch Definition, for notification or alerts. You can enter a comma-delimited list of email addresses for recipients, and a message string, used as a subject and a body.

Note that for the batch processor to send email, you must define an SMTP server and Contact Address in your Manager Configuration. To do this, go to Admin > Manager Configuration > Admin, and enter values for SMTP Host and Contact Address under the Mail heading. Email sent by the batch processor is sent from the Contact Address.

Sends an email message from a Batch Definition that includes files as attachments, typically used to send the output of a previous command by saving that output to a file. You can enter a subject, a message body string, a comma-delimited list of email addresses, and a semicolon-delimited list of files, which are sent as attachments in the message.

The setup rules given above in the description of the EmailCommand component also apply to the EmailFileCommand component.

Executes a command from a Batch. This executes a command from the application server’s root directory. You can set an input, output, and error file, plus a log file for the command to be run.

Writes a string to the Manager log. This is useful for testing Batches or indicating when a Batch is starting or stopping.

Halts for a moment before proceeding. The amount of wait time is specified in seconds. Note that this component is only useful for generating a wait time when the Batch type is serial.

Sets the Engine distribution weighting relative to other Brokers. Only Brokers that are part of a Broker/Director Manager installation are listed.

Makes a Batch File wait for an implemented event to take place. You can use this to pause until a specific condition in a class you deployed has occurred.