Open topic with navigation
The Print Document action enables you to specify a BarTender document that you want to be printed each time the integration runs.
You can configure the following properties for the Print Document action:
Action
-
Name: Specifies the name of the action. If desired, you can replace the default name by typing a new name in the field.
-
Description: Allows you to save a description for the action.
-
Run Action: Allows you to specify how often you want to run the action.
-
Always: Specifies that the Integration Service will run the action each time it runs the integration.
-
Never: Specifies that the Integration Service will not run the action when it runs the integration.
-
Conditionally, based on variable: Specifies that the Integration Service will run the action only when a selected variable meets a specified condition. Use this option in situations where there is only one condition that determines whether or not the action will run. Once you have enabled this option, you can create the conditional statement in the input box provided.
Input box controls
-
Variable: Enter the variable that you want to use for the conditional statement. Alternatively, you can add a variable for the conditional statement value.
-
[Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to open a list of additional operators, and select the one you want to use. For more information, refer to Relational Operators. The operators available in the list depend on whether you have selected Text or Decimal for the Type option.
-
Value: Specifies the value(s) to use for the conditional statement. Some operators, such as Is null and Is not null, do not require a value to be specified. In these situations, the Value field is not available.
-
Type: Specifies whether the conditional statement is evaluating a text or decimal value.
-
Conditionally, based on expression: Specifies the conditions under which the Integration Service will run the action. Use this option for situations that require more than one conditional statement. Once you have enabled this option, you can create the conditional expression in the input box provided by creating the desired conditional statements. You create and edit your conditional expression on the Tree View tab. Click the Text View tab to see a read-only text view of the conditional expression.
Input box controls (Tree View tab)
-
[Conditional Joiner]: Specifies the conditional joiner for the conditional statements within the group. The default conditional joiner is And.
Click the existing conditional joiner to access a menu that allows you to configure your conditional expression in one of the following ways:
-
Select a different conditional joiner: The menu options include a list of conditional joiners. Select the conditional joiner you want to use for the conditional statements. For more information about the supported conditional joiners, see Conditional Joiners.
-
Add Condition: Click to add another conditional statement to the current group.
-
Add Group: Click to add a sub-group of conditional statements to the current group.
-
Remove Group: Available in the menu when the menu has been opened from a sub-group. Click to delete the sub-group.
-
Clear All: Available in the menu when the menu has been opened from the top-most group. Click to delete all conditional statements (including sub-groups).
-
: Visible just to the right of each conditional joiner in your expression. Click to add a conditional statement to the group associated with that joiner.
-
: Visible when you position the cursor over an existing conditional statement. Click to delete the conditional statement.
-
Variable: Enter the variable that you want to use for the conditional statement. Alternatively, you can add a variable for the conditional statement.
-
[Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to open a list of additional operators, and select the one you want to use. For more information, refer to Relational Operators. The operators available in the list depend on whether you have selected Text or Decimal for the Type option.
-
Value: Specifies the value(s) to use for the conditional statement. Some operators, such as Is null and Is not null do not require a value to be specified. In these situations, the Value field will be hidden.
-
Type: Specifies whether the conditional statement is evaluating a text or decimal value.
Document
-
Document: Specifies the folder location and document. You can type the folder location and document name or click Browse to locate and select the document that you want. Alternatively, you can add a variable that specifies the document. You can also add a special character to the value that you enter.
-
Import Document Settings: Imports the document settings from the selected BarTender document. These imported settings are subsequently displayed in the Print Option Overrides settings.
-
Close at end of print job: Specifies that the BarTender document is closed when the print job is completed.
-
Save document at end of print job: Specifies that the BarTender document is saved when the print job is completed.
Print Option Overrides
The print option overrides enable you to configure specific printer options for the print job. Unless they are configured otherwise, the print options that are used are those that are stored in the document. For each of the following override options, you can enter the value that you want. Alternatively, you can add a variable.
|
|
You can populate the Print Option Overrides properties with the settings that are stored in the document by clicking the Import Document Settings button in the Document area.
|
-
Printer: When enabled, specifies a printer other than the one that is specified by the document.
-
Paper tray: When enabled, specifies a printer tray other than the one that is specified by the document.
-
Copies: When enabled, specifies a number of copies to print other than the number that is specified by the document.
-
Serial Numbers: When enabled, specifies a number of serialized items to print other than the ones that are specified by the document.
-
Record Range: When enabled, specifies a range of records to print other than the one that is specified by the document.
-
Job Name: When enabled, specifies a job name other than the one that is specified by the document.
-
Prompt for data input: When enabled, the document's data entry forms and requests are opened for user input, prior to sending the print job to the printer.
Media Handling
-
Action: Determines the printer's media handling action. Available options depend on the selected printer.
-
Use Driver's Settings: Specifies that the action is determined by the driver's settings.
-
Page Break: Specifies that the printer will issue a page break.
-
Pause: Specifies that the printer will pause.
-
Wait for Label Taken Sensor: Specifies that the printer will wait until it senses that the label has been taken.
-
Cut: Specifies that the printer will cut the label.
-
Cut and Pause: Specifies that the printer will cut the label and pause.
-
Occurrence: When you select an Action setting other than User Driver's Settings, you can specify the frequency of the action by using the Occurrence property.
-
At End of Print Job: Specifies that the action occurs at the end of the print job.
-
After Every Page: Specifies that the action occurs after every printed page.
-
After Every Record: Specifies that the action occurs after each record.
-
After Copies: Specifies that the action occurs after the specified number of copies have completed.
-
After Data Changed: Specifies that the action occurs after the specified data has changed.
-
Data Item Type: Enables you to specify the type of data item as Database Field, Named Data Source, or Object Value.
-
Data Item Name: Specifies the data item name.
-
After Specified Number of Printed Items: Specifies that the action occurs after a specified number of labels are printed.
Database Overrides
-
Use data source: Enables you to select a data source to use when printing the document. If this option is not selected, the data source that is specified in the document is used.
-
Data Source: Specifies the data source that you want to use when printing the document.
-
Integration Input Data: Specifies that the integration's input data will be used for the data source.
-
Current Record: Specifies that the current record that is being processed by a For Each Database Record action will be used for the data source. Available when the Print Document action is a child action of a For Each Database Record action.
-
Variable: Enables you to specify a variable that will be used for the data source. Available when the Print Document action is a child action of a For Each Database Record action or when the Print Document action is immediately preceded by a For Each Database Record or Transform Text to Record Set action.
-
Text File: Specifies that a text file will be used for the data source. You can type the folder location and file name or click Browse to locate and select the desired file. Alternatively, you can add a variable to specify the desired file or add a special character to the value you have entered.
-
SAP IDoc File: Specifies that a SAP IDoc file will be used for the data source. You can type the folder location and file name or click Browse to locate and select the desired file. Alternatively, you can add a variable to specify the desired file or add a special character to the value you have entered.
-
Variable: Specifies the variable that you want to use for the data source. Depending on your integration design, variable options that you can select might include CurrentRecord and/or EventData. Available when Variable is selected as the data source.
-
Location: Specifies the file system where the data source file exists. Available when either Text File or SAP IDoc File are selected as the data source.
|
|
File systems or locations can include local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, see Administration Console's Cloud Storage Page.
|
-
File Name: You can type the folder location and file name or click Browse to locate and select the desired file. Alternatively, you can add a variable to specify the desired file or add a special character to the value you have entered. Available when either Text File or SAP IDoc File are selected as the data source.
Named Data Sources
-
Specify Values for Named Data Sources: Enables you to enter the names and values for the named data sources that you want to use for the printed items. Click in either field to type the desired name or value. Alternatively, you can add a variable that specifies the name or value, and in the Value field, you can add a special character to the value you have entered.
Query Prompts
-
Specify Values for Query Prompts: Enables you to enter the names and corresponding values for data entry controls that require user input on your document's data entry form. Click in either field to type the desired name or value. Alternatively, you can add a variable that specifies the name or value, and in the Value field, you can add a special character to the value you have entered.
Verification Options
-
Queue print job and continue immediately: Submits the job to the print scheduler and immediately completes the action. When this option is selected, no "response" options are available.
-
Verify the print job has been processed before continuing: Submits the job to the print scheduler and waits for verification that the print job has been processed before completing the action.
-
Verify the print job has been printed before continuing: Submits the job to the print scheduler and waits for verification that the print job has been printed before completing the action.
-
Place Response in Variable: Specifies the variable that will return the action response. Enter the desired variable name. Alternatively, you can add a variable.
-
Include print data: When enabled, the print data will be included in the print response.
-
Include print summary: When enabled, the print summary will be included in the print response. Available when Include print data in response is enabled.
-
Include label data: When enabled, the label data will be included in the print response. Available when Include print data in response is enabled.
-
Include checksum: When enabled, the checksum will be included in the print response.
Test Print Document
User Account
-
Inherit from parent action: When enabled, the action inherits the user account credentials specified on the Actions property page. Alternatively, if the action is part of a Group action, it will inherit the user account credentials specified on the immediate parent Group action’s property page.
-
Specify user credentials: When enabled, the action runs using the credentials specified.
Error Handling and Diagnostics
-
Resend failed print jobs: When enabled, any print jobs that failed will be resent to the print spooler.
-
Maximum retries: Specifies the maximum number of times the failed print jobs will be resent. Available when Resend failed print jobs is enabled.
-
Retry if failed: When enabled, specifies that if the action fails, the Integration Service will try to run it again.
-
Maximum retries: Specifies the maximum number of times the Integration Service will try to run the action again. Available when Retry if failed is enabled.
-
Retry interval: Specifies the amount of time the Integration Service will wait after the action has failed before trying to run the action again. Available when Retry if failed is enabled.
Related Integration Builder Examples