BatchNumber Property

The batch number to close or retrieve details about.

Syntax

 tsyshcbatchmgr.getBatchNumber([callback])
 tsyshcbatchmgr.setBatchNumber( batchNumber, [callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getBatchNumber([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setBatchNumber([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used to specify the batch number that you want to retrieve details about (via GetDetails or GetSummary) or to manually close (via CloseBatch).

This property is required to be set in CloseBatch calls. However for GetDetails and GetSummary calls, if BatchNumber is not set the current open batch will be used.

Data Type

Integer