BPilot

Exports the value assigned to the Batch Pilot property designated as the parameter.

Syntax

bool BPilot (StrParam)

Parameters

The name of the Batch Pilot Property whose value is to be included in the Export file.
  • BatchDir: The name and location of the application’s Batches directory.
  • BatchID: The Batch Number of the current batch (20020072.003, for example.)
  • JobName: The name of the current User Application job (Main, for example.)
  • Operator: The User ID of the operator currently processing the batch.
  • PagesInBatch: A count of all pages in the batch.
  • DocsInBatch: A count of all documents in the batch. Remember: in most configurations, a Recognition task reorganizes a batch into a series of documents and their pages.
  • Priority: The processing priority assigned to the current batch (“10” = Low, “1 = High, “5” = Default). A task selects batches from its queue first according to Priority.
  • Station: The Station ID of the workstation currently processing the batch.
  • TaskName: The name of the task with the batch in its queue.
  • XtraBatchFieldValue: The value in a custom field you’ve added to the Job Monitor’s Batch Information Table.

Returns

False if the parameter is not a Batch Pilot property. Otherwise, True.

Level

Any level.

Details

Exports the value assigned to the Batch Pilot property that designated as the parameter.
Example
NewLine()
Text("BatchID:")
BPilot ("BatchID"

This sequence adds "BatchID:" followed by the current Batch ID into the Export file. For example: BatchID: 20050019.001