› Batch & Output Management Scripting Language Developer's Guide › Standard processes: scripts and functions › Processing component functions › Conversion component functions › ConvertStack function

ConvertStack function

The ConvertStack function performs these actions in the conversion component:

  1. Moves the input stack to the Busy status.
  2. DocBridge is used to perform the following actions:

    1. The input pages of all documents of all envelopes of the stack are read, one by one. If configured to do so by streaming, pages are inserted.

    2. For each page, the page modifications determined by streaming are carried out.

    3. An output file is written in the configured output format to the internal storage folder, by writing the modified pages to it.

  3. Moves the input stack back to the Waiting status and updates the stack type to "Distribute (70)."

Parameters

The ConvertStack function does not have any input parameters. It searches the run-time database for a stack in the Waiting status and stack type "Convert (30)." If multiple records are available, they are picked up one by one, but the order is not determined.

Result

If a stack is processed successfully, Run returns its stack identifier, represented as a string. If no stack is available, ConvertStack returns the empty string.

If an error is encountered, the ConvertStack function moves the input stack to the Error status and sets the error message.

If you call the ConvertStack function from different CCM_Conversion processes simultaneously, we recommend that you run them in a separate Windows Service.