External Interface Maintenance

Menu Path: System Administration Images\bluerarw.gif Module Setup Images\bluerarw.gif External Interface Maintenance

Purpose

Define locations for Business Intelligence extracts and third-party label printing.

Overview

Use External Interface Maintenance to set up shipping or other labels using third-party label software. You can also set the output path and file names associated with Business Intelligence data extracts, set up the ODBC for reports, and set up integration with other third-party software.

For Business Intelligence setup information, see Business Intelligence (legacy) Overview. For label setup information, see Setting up Shipping Labels.

Ribbon Home Tab Buttons

Button

Description

Exit

Click this button to close the External Interface Maintenance window.

New

Click this button to create a new external interface record.

Update

Click this button to update the selected external interface record.

Delete

Click this button to delete the selected external interface record.

OK

Click this button to accept an action. This button is only available if you click the New, Update, or Delete button in the ribbon.

Cancel

Click this button to cancel an action. This button is only available if you click the New, Update, or Delete button in the ribbon.

First

Click this button to display the first external interface record.

Prev

Click this button to display the previous external interface record.

Next

Click this button to display the next external interface record.

Last

Click this button to display the last external interface record.

Fields and Buttons

Field or Button

Description

Interface Name

Enter an appropriate external interface name, or click the Lookup button to select an existing name. This can be the third-party label software file name (.rpt or .btw). This can also be the Business Intelligence extract name when used to define Business Intelligence exports (for more information, see Business Intelligence Export (legacy).

Main Tab Fields and Buttons

Field or Button

Description

Interface Type

Click the Lookup button to select one of the following external interface types:

  • BI - A Business Intelligence extract

  • Crystal - A Crystal Reports report

  • Label - A label file

  • Other - Any other third-party integration

Associated Program/Export Program/Export File Path

If Crystal is selected for the Interface Type field, enter the Apprise program file name associated with the report.

If BI is selected for the Interface Type field, enter the extract program associated with the Business Intelligence extract. For Business Intelligence setup information, see Business Intelligence (legacy) Overview.

If Label is selected for the Interface Type field, enter the folder path to which you want to output label data in sequentially numbered files.

If Other is selected for the Interface Type field, enter the appropriate data.

Crystal Report Path/Export File Path/Label Path/Path

Enter the location of the file. The label of this field changes based on the type selected for the Interface Type field. For a Business Intelligence extract, you must enter the path and file name.

Note If you are entering a folder path in this field, it must end in a backslash (\).

ODBC Data Source Type

Click the Lookup button to select one of the following ODBC data source types for a Crystal Reports report:

  • Custom - The report uses the custom ODBC data source set up on the Network tab in System ID Maintenance.

  • Manual -  The report uses the ODBC data source entered in the ODBC Data Source field.

  • Standard - The report uses the standard Apprise ODBC data source set up on the Network tab in System ID Maintenance.

The Lookup button is only enabled if Crystal is selected for the Interface Type field.

ODBC Data Source/Label File Data Source

Enter the logical datasource name if you are setting up labels. Otherwise, this field is used for customization only. The ODBC Data Source field is only enabled if Manual is selected for the ODBC Data Source Type field.

Misc 1

This field is slated for future functionality.

Misc 2

This field is slated for future functionality.

Misc 3

This field is slated for future functionality.

Description

Enter a description of the external interface.

From Address

If you are using SMTP for emailing reports, enter the email address from which to send the report. This overrides the email address entered in the Default From Address field in System ID Maintenance.

Example You want all invoices to be sent from invoicing@apprise.com. You can enter that address in this field for the invoice report.

Template

This field is slated for future functionality.

Content Label

Enter a content label report, or click the Lookup button to select a report. You can use this field when you want to use two-page labels.

Example You set up one report for UCC 128 labels and a second report for content labels. You can enter the content label report name in this field for the UCC 128 labels report.

If you enter a content label in this field, you may want to select the Print Content Labels Only for Packages with Multiple Items check box to prevent content labels from printing for packages that contain a single product.

Interface Orientation

Select whether to print the report in portrait (vertical) or landscape (horizontal) orientation when outputting to a printer.

Note The format of the report is not changed based on the orientation. If you are printing a Crystal Reports report and you change the orientation, you must modify the report to match the selected orientation.

Display Label Printer Selection

Select this check box to allow users to select a printer when printing BarTender labels. If this check box is selected, the BarTender Print dialog box appears when printing labels. This check box is only enabled if you select Label for the Interface Type field, and include a .btw extension in the Interface Name field.

Print Content Labels Only for Packages with Multiple Items

Select this check box to only print content labels for packages that contain more than one product. If you leave this check box cleared for a label report, content labels are printed for all packages, including those that contain only a single product. This check box is only enabled if you select Label for the Interface Type field.

Note If you want to use this functionality, only select this check box for a label report that is associated with a content label report (i.e., a content label report is entered in the Content Label field). Do not select this check box for the content label report itself.

Overflow Option

Select one of the following options for package or pallet labels:

  • Ignore - If a package contains more products than the value entered in the Max. # of Products per Label field, do not include those products on the label. For example, if a package contains 30 products and 10 is entered in the Max. # of Products per Label field.

  • 2nd Label - If a package contains more products than the value entered in the Max. # of Products per Label field, generate one or more additional labels to display the additional products.

  • Content Label - If a package contains more products than the value entered in the Max. # of Products per Label field, list all those products on a content label. You can only select this option if you enter a content label in the Content Label field.

Example A package contains 30 different products and 10 is entered in the Max. # of Products per Label field. If you select Ignore for the package label, it only displays the first 10 products. If you select 2nd Label, three labels are printed, each with 10 products. If you select Content Label, the package label displays the first 10 products, and the remaining 20 products display on the content label.

These radio buttons are only enabled if you select Label for the Interface Type field.

Max. # of Products per Label

Enter the maximum number of products displayed on labels. This field is only enabled if you enter a .btw file in the Interface Name field and select Label for the Interface Type field.

Consolidate Lot Tracked Products

Select this check box to only show lot information for the lot with the earliest expiration date on labels. This check box is selected by default.