Print Document

Document

• Location: Specifies the file system or location of the document that you want to print. File systems or locations can include a path that is relative to the folder that contains the process file, local file systems or network shares, or Librarian.

• File Name: Specifies the file name of the document that you want to print. You can enter the folder location and file name or click Browse to locate and then select the file that you want (the Browse option is not available when Location is set to Relative to Process File). Alternatively, you can add a variable to specify the file that you want or add a special character to the value that you enter.

• Last Published Revision: Specifies that the action uses the last published revision of the specified Librarian file. This option takes effect only when the Librarian file is assigned to a workflow. Available when Location is set to Librarian.

• Import Document Settings: Imports the document settings from the specified BarTender document. These imported settings are subsequently displayed in the Print Option Overrides and Media Handling areas on the Print Options tab, the Named Data Sources area on the Named Data Sources tab, and the Query Prompts area on the Query Prompts tab. For the Named Data Sources tab, only Embedded Data named data sources are imported.

• Open in Designer: Opens the specified document in BarTender Designer.

• 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.

  • Skip thumbnail regeneration: Specifies that the thumbnail image for the BarTender document is not regenerated at the end of the print job.

Print Option Overrides

Use the print option overrides 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.

 

• Printer: Specifies a printer other than the one that is specified by the document.

• Advanced Printer Options: Opens the Advanced Printer Options dialog, which you can use to specify advanced printer options. Not available for all printers.

• Paper tray: Specifies a printer tray other than the one that is specified by the document.

• Copies: Specifies a number of copies to print other than the number that is specified by the document.

• Serial Numbers: Specifies a number of serialized items to print other than the ones that are specified by the document.

• Record Range: Specifies a range of records to print other than the one that is specified by the document.

• Job Name: Specifies a job name other than the one that is specified by the document.

• Prompt for data input: Specifies that the document's data entry forms and requests are opened for user input before the print job is sent 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 issues a page break.

  • Pause: Specifies that the printer pauses.

  • Wait for Label Taken Sensor: Specifies that the printer waits until it senses that the label has been taken.

  • Cut: Specifies that the printer cuts the label.

  • Cut and Pause: Specifies that the printer cuts the label and pauses.

• 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: Specifies the type of data item as Database Field, Named Data Source, or Object Value.

    • Data Item Name: Specifies the data item name.

      • Ignore case: Specifies that the comparison between values of the specified data item ignores differences in case.

  • After Specified Number of Printed Items: Specifies that the action occurs after a specified number of labels are printed.

    • Number of Printed Items: Specifies how many items to print before the action occurs.

Database Overrides

• Add database override: Click to specify the data source you want to use when printing the document, and to specify the database you want to override with the data source values. The following options are available after you click Add database override.

• Databases: Specifies the database that you want to override with the data source values.

  When you have imported the document settings, the Databases list displays the name of the first database connection found in the document. When your document has multiple database connections, you can click to select a different connection in the Database to override list.

  The (The default database) option is selected by default when you have not imported the document settings. It specifies that the first document-level database connection in the document will be overridden. It does not refer to table object or data entry control database connections. If you instead want to override a table object or data entry control database connection, or you know the name of the connection, you can select an existing name in the Database to override list or click Add and type the name in the Database to override text field to add a new connection.

• Database to override: Specifies the database that you want to override with the data source values.

• Data Source: Specifies the data source that you want to use when printing the document.

  • Current Record: Specifies that the current record that is being processed by a For Each Database Record action is used for the data source. Available when the Print Document action is a child action of a For Each Database Record action.

  • Variable: Specifies that a variable is used for the data source. Available when the Print Document action is immediately preceded by a Transform Text to Record Set action or an Execute SQL action.

  • File: Specifies that a file is used for the data source. Supported file types include text, SAP IDoc, XML, Microsoft Access, Microsoft Excel, and Data Builder.

• Variable: Specifies the variable that you want to use for the data source. Depending on your process file design, variable options that you can select might include EventData or the new variable that you specified for the Save record set to variable option in the preceding Transform Text to Record Set or Execute SQL action. Available when Variable is selected as the data source and you have specified a new variable for the Save record set to variable option in preceding action.

• Location: Specifies the file system where the data source file exists. Available when File is selected as the data source.

File systems or locations can include a path that is relative to the folder that contains the process file, a temporary storage folder, local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

 

• File Name: You can enter the folder location and file name or click Browse to locate and then select the file that you want (the Browse option is not available when Location is set to Relative to Process File or Temporary Storage). Alternatively, you can add a variable to specify the file that you want or add a special character to the value that you enter. Available when File is selected as the data source.

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 was 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 was printed before completing the action.

  • Maximum wait time: Specifies the time to wait for the printer to complete the print job.

• Place Response in Variable: Specifies the variable that returns the action response. Enter the variable name that you want. Alternatively, you can add a variable.

• Include print data: Specifies that the print data is included in the print response.

• Include print summary: Specifies that the print summary is included in the print response. Available when the Include print data option is selected.

• Place Output File Name in Variable: Specifies the variable in which you want to place the output file name.

• Include label data: Specifies that the label data is included in the print response. Available when the Include print data option is selected.

• Include checksum: Specifies that the checksum is included in the print response.

Named Data Sources

• Specify values for named data sources: Specifies the names and values for the named data sources that you want to use for the printed items. Click either field to enter the name or value that you want. 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 that you enter.

• Copy data source values to variables at end of print job: Specifies that the named data source values that are used in the print job are saved to process variables when the print job is complete. You can then use these values in other actions within the process file, such as printing another document or sending output to an email message, a log, or a file. Available when Verify the print job has been processed before continuing or Verify the print job has been printed before continuing is selected on the Print Options tab.

• Prefix: Specifies the prefix for the variables to which the named data source values are saved. By default, these variables have the same name as the named data source together with the prefix “BTDS_”. You can modify or delete the prefix.

Query Prompts

• Specify values for query prompts: Specifies the names and corresponding values for data entry controls that require user input on your document's data entry form. Click either field to enter the name or value that you want. 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 that you enter.

Action

• Name: Specifies the name of the action. You can replace the default name by entering a new name in the field.

• Description: Specifies a description for the action.

• Run Action: Specifies how often you want to run the action.

  • Always: Specifies that the action runs each time the process file is run.

  • Never: Specifies that the action does not run when the process file is run.

  • Conditionally, based on variable: Specifies that the action runs only when a selected variable meets a specified condition. Use this option in situations in which there is only one condition that determines whether the action runs. After you select this option, you can create the conditional statement in the input box.

    Input box controls

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables, or click Variable or More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, 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 action runs. Use this option for situations that require more than one conditional statement. When you select this option, you can create the conditional expression in the input box by creating the conditional statements that you want. 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 display a menu that enables you to configure your conditional expression in one of the following ways:

      • And, Or, NotAnd, NotOr: Click the conditional joiner in the list that you want to use for the conditional statements. For more information about the supported conditional joiners, refer to Conditional Joiners.

      • Add Condition: Click to add another conditional statement to the current group.

      • Add Group: Click to add a subgroup of conditional statements to the current group.

      • Remove Group: Click to delete the subgroup. Available when you open the menu from a subgroup.

      • Clear All: Click to delete all conditional statements (including subgroups). Available when you open the menu from the top-most group.

    • : Click to add a conditional statement to the group that is associated with that joiner. Visible to the right of each conditional joiner in your expression.

    • :  Click to delete the conditional statement. Visible to the right of an existing conditional statement when you point to the statement.

    • Variable: Specifies the variable that you want to use for the conditional statement. Enter the variable in the input box. Click to see a list of recently used variables, or click Variable or More Variables to open the Insert Variable dialog.

    • [Relational Operator]: Specifies the relational operator to use for the conditional statement. Click the existing operator to display a list of additional operators, and then click the one that you want to use. For more information, refer to Relational Operators. The operators that are available in the list depend on whether you selected Text or Decimal for the Type option.

    • Value: Specifies the values to use for the conditional statement. To add a value, click , click <enter a value>, enter the value that you want, and then press Enter. To delete a value, use the secondary mouse button to click it, and then click Delete. Some operators, such as Is blank and Is not blank, 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.

User Account

• Inherit from parent action: Specifies that the action inherits the user account credentials that are specified on the Actions property tab. Alternatively, if the action is part of a Group action, it inherits the user account credentials that are specified on the immediate parent Group action’s property tab.

• Specify user credentials: Specifies that the action runs by using the credentials that are specified.

Error Handling and Diagnostics

• Ignore errors and continue running actions: Specifies that if the action fails, the remaining actions continue to run. When this option is not selected and the action fails, the resulting behavior depends on several factors, as follows:

  The action is within a Group action

  • If you specified Sequentially for the Execute Actions property on the Group action's Execution tab, no further actions within that Group action are run. No actions outside of this Group action are affected.

  • If you specified In Parallel for the Execute Actions property on the Group action's Execution tab, the errors are ignored, and the other actions within that Group action are run. No actions outside of this Group action are affected.

  The action is not within a Group action

  • If you specified Sequentially for the Execute Actions property on the Actions Execution tab, no further actions within the process are run.

  • If you specified In Parallel for the Execute Actions property on the Actions Execution tab, the errors are ignored, and the other actions within the process are run.

• Resend failed print jobs: Specifies that any print jobs that failed are re-sent to the print spooler.

  • Maximum retries: Specifies the maximum number of times that the failed print jobs are re-sent. Available when the Resend failed print jobs option is selected.

• Retry if failed: Specifies that if the action fails, the Integration Service tries to run it again.

  • Maximum retries: Specifies the maximum number of times the Integration Service tries to run the action again. Available when the Retry if failed option is selected.

  • Retry interval: Specifies the length of time the Integration Service waits after the action has failed before it tries to run the action again. Available when the Retry if failed option is selected.