Move Print Job Action

Move the specified print job to another printer.

This API action enables a single registered print job to be moved from one logical printer queue to another, empowering operational recovery without canceling and resubmitting the job. The action can be used only while the job remains in a Preparing or Held status.

Pausing the queue is not required to perform a move; however, users may pause a queue to increase the likelihood that a job remains eligible to move.

When a print job is successfully moved to a new printer, the job is removed from the source queue and appended to the end of the destination queue. The relative order and state of other jobs in the source queue remain unchanged. The target printerId is updated.

A successful move generates an audit record containing:

  • JobId

  • Source queue

  • Destination queue

  • Timestamp

  • User identity

A job is not movable once it has been:

  • Submitted to the BarTender print engine.

  • Rendered into printer-specific output.

  • Sent to the Print Gateway.

  • Submitted to the OS spooler.

  • Entered physical execution stages.

Jobs originating in Print Portal have an initial status of Generating and cannot be moved to another target printer.

A YAML reference document is available that provides complete details about the specific properties for each action and describes how to combine actions into groups and create arrays of actions to be sent as one script to the server. The YAML actions reference is provided as follows:

Action: MovePrintJobAction

Properties

JobId = string.Empty[get, set]

string

Specifies the job ID of the job to be moved. The user must provide a valid print job ID in the action script.

TargetPrinter = string.Empty[get, set]

string

Specifies the target printer to which the job will be moved.

For BarTender Cloud printing, the printer must be an internet printer shared by the BarTender Print Gateway service. The printer ID must follow these rules:

  • Use the "printer:" prefix.

  • Remove the UNC "\\" prefix.

  • Replace all spaces with underscores.

  • Replace all backslashes (\) in the path with slashes (/).

For example, to specify the following printer:

\\mypc.seagullscientific.com\Zebra 110Xi4(300 dpi)

Use the following printer ID:

printer:mypc.seagullscientific.com/Zebra_110Xi4(300_dpi)

Name[get, set]

string

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description[get, set]

string

Specifies the description. The default value is "".

RunType[get, set]

ActionRunType

Runs the action by using one of the following types:

  • Always (default)

  • Never

IgnoreErrors[get, set]

bool

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries[get, set]

int

Specifies the number of times the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval[get, set]

int

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

Example

Name: My Print Action

Description: Print a .btw file

FailureRetries: 3

RetryInterval: 10000