EnsLib.RecordMap.Batcher

Interval to use for checking schedule-based Rollover status. See the comments for RolloverSchedule for more detailed information.

Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

The classname of the Batch class to be used for the Default Batch.

Mode to open the temporary file with when creating a new file for a batch. See the documentation for %IO.FileStream and file devices for more information on the available options.

Mode to open the temporary file with when reopening an existing file for a batch. See the documentation for %IO.FileStream and file devices for more information on the available options.

Provide a limit to the number of messages which will be included in the current Default Batch. UseDefaultBatch must be enabled for this setting to take effect. If this number is 0, the application will be reponsible for enforcing batch rollovers by either sending BatchRolloverRequest messages from other components or by making use of the RolloverSchedule property. Note that this limit is evaluated after checking RolloverSchedule.

A schedule string to control when the Default Batch ought to be rolled over. UseDefaultBatch must be enabled for this setting to take effect. The schedule string takes the same format as the standard schedule string for a component, with one exception: only START strings are permitted. At any time when a START is scheduled to occur, the current default Batch will be written out and replaced with a new default Batch. Note that the RolloverSchedule will be evaluated before checking RolloverLimit.

UnSwizzle each record from memory after it has been written to the output stream. This option is used when processing an entire batch at once.

Flag to indicate whether incoming messages which are not assigned to a batch already should be added to a Default Batch. This Default Batch will be processed either when this configuration item receives a BatchRolloverRequest or the batch object itself. If RolloverSchedule is used to specify times when a Batch should be rolled over, then the current Default Batch will be processed based on the specified schedule.

Control whether Batch objects which contain no records should be written out. Note that this applies to all batches, including the default Batch.

Check whether the current default Batch needs to be rolled over. This check is not run if UseDefaultBatch is false or if RolloverSchedule is not specified. Note that the check based on RolloverLimit is performed after the record has been processed in PutRecord()().

Callback to create a new default Batch. This method can be overridden in subclasses to further initialize the Batch object.

Get the current default Batch as an object

Clean up temp file and AppData that might be left.

Verify the previous default Batch object if UseDefaultBatch is true, or create a new one if it didn't exist previously. Also validate that the contents of RolloverSchedule are valid.

Callback invoked to check whether a Rollover is required when RolloverSchedule is specified.

Handle processing of a Batch object, depending on context. See the documentation for the OnMessage() method for more information on the processing order.

Write out a Record object, depending on the context for the Batch to which the Record belongs.

Handle incoming requests depending on their type. If a Batch message is received without being preceded by its contents, the entire batch will be processed immediately. If a message associated with a Batch is received before that Batch, the configuration item will note which messages are received for the Batch and will process the complete Batch when the Batch itself is received by the configuration item. If a BatchRolloverRequest is received and UseDefaultBatch is true, the current Default Batch will be rolled over and will be treated as if the default Batch was sent in a message.

Callback which subclasses should override. The completed temporary file will be passed to this method when the Batch has been processed.

Create a new batch object if UseDefaultBatch is true. This method has no effect when UseDefaultBatch is false.

Calculate the next rollover time based on the contents of RolloverSchedule.