BarTenderProcessAction Class Reference

Defines a common class for BarTenderProcessAction and PrintBTXMLScriptAction.
More...

Inherits PrintActionBase.

Properties
DataTarget	Script [get, set]
	Specifies the BarTender XML batch script to run. More...
string	PrintResponseVariable [get, set]
	Specifies that the response is placed into a variable. More...
bool	PromptForDataInput [get, set]
	Specifies whether the print job is interactive. More...
int	MaximumRetriesOnFailure [get, set]
	Specifies the maximum number of times to try to resend a failed print job. Valid only when the value of ResendFailedJobs is true. The default value is 1. More...
bool	ResendFailedJobs [get, set]
	Specifies whether to resend the print job if it fails. The default value is true. More...
bool	ReturnPrintData [get, set]
	Specifies whether print data is included in the response. The default value is false. More...
bool	ReturnPrintSummary [get, set]
	Specifies whether the print summary is included in the response. The default value is false. More...
bool	ReturnLabelData [get, set]
	Specifies whether label data is included in the response. The default value is false. More...
bool	ReturnChecksum [get, set]
	Specifies whether the checksum is included in the response. The default value is false. More...
bool	QueueAndContinue [get, set]
	Specifies whether to queue the print request and continue immediately. The default value is false. More...
CommonActionProperties
Describes the common action properties for Actions and ActionGroups.
string	Name [get, set]
	Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
string	Description [get, set]
	Specifies the description. The default value is "". More...
ActionRunType	RunType [get, set]
	Runs the action by using one of the following types: More...
bool	IgnoreErrors [get, set]
	Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
int	FailureRetries [get, set]
	Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
int	RetryInterval [get, set]
	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. More...

Detailed Description

Defines a common class for BarTenderProcessAction and PrintBTXMLScriptAction.

• BarTenderProcessAction: Runs a process file that was created in BarTender Process Builder.
• PrintBTXMLScriptAction: Prints one or more BarTender documents by using BTXML script.

For common action properties, see IntegrationAction.
Example of script from an integration variable:

Actions:
- BarTenderProcessAction:
    Script: '%EventData%'
    PrintResponseVariable: MyPrintResponse
    PromptForDataInput: true
    # And more common action properties
    ...

Example of script from a file:

Actions:
- PrintBTXMLScriptAction:
     Script: 
       File: C:\Scan\%FileName%
     PrintResponseVariable: MyPrintResponse
     PromptForDataInput: true
     # And more common action properties
     ...

Property Documentation

Script

DataTarget Script

getset

Specifies the BarTender XML batch script to run.

Example:

Script: |
  <XMLScript Version = "2.0" >
    <Command Name="Print Document">
      <Print SaveAfterPrintCondition = "IfModified" ReturnPrintData="false" ReturnSummary="false" ReturnLabelData="false" ReturnChecksum="false">
        <Format CloseAtEndOfJob = "false" SaveAtEndOfJob="false" RegenerateThumbnail="false">.\TextDB.btw</Format>
        <RecordSet>
          <FileName>.\test2.txt</FileName>
        </RecordSet>
      </Print>
    </Command>
  </XMLScript>

Example of script from an integration variable:

Script: '%EventData%'

Example of script from the temporary storage:

Script: 
  File: MyPrintScript.btxml      

Example of script from a local file:

Script: 
  File: C:\Scan\%FileName%      

Example of script from a cloud file:

Script: 
  File: amazon://MyAmazonS3/MyPrintScript.btxml

PrintResponseVariable

string PrintResponseVariable

getset

Specifies that the response is placed into a variable.

PromptForDataInput

bool PromptForDataInput

getset

Specifies whether the print job is interactive.

MaximumRetriesOnFailure

int MaximumRetriesOnFailure

getset

Specifies the maximum number of times to try to resend a failed print job. Valid only when the value of ResendFailedJobs is true. The default value is 1.

ResendFailedJobs

bool ResendFailedJobs

getset

Specifies whether to resend the print job if it fails. The default value is true.

ReturnPrintData

bool ReturnPrintData

getsetinherited

Specifies whether print data is included in the response. The default value is false.

ReturnPrintSummary

bool ReturnPrintSummary

getsetinherited

Specifies whether the print summary is included in the response. The default value is false.

ReturnLabelData

bool ReturnLabelData

getsetinherited

Specifies whether label data is included in the response. The default value is false.

ReturnChecksum

bool ReturnChecksum

getsetinherited

Specifies whether the checksum is included in the response. The default value is false.

QueueAndContinue

bool QueueAndContinue

getsetinherited

Specifies whether to queue the print request and continue immediately. The default value is false.

Name

string Name

getsetinherited

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

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

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

FailureRetries

int FailureRetries

getsetinherited

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

RetryInterval

int RetryInterval

getsetinherited

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.

---

The documentation for this class was generated from the following file:

• BarTenderProcessAction.Properties.cs