Automated File Import and Label Printing User Manual v3.0

Automated File Import and Label Printing User Manual v3.0

Commercial and in Confidence
The information contained in this document is confidential.  No part of this document may be reproduced, disclosed to any third party, or issued in any form or by any means without the express written permission of Intersoft Systems & Programming Ltd.


Contents
1. Document Controls
2. Table of Figures
3. Introduction
3.1. Process Diagram – Configuring Print Harvester and Silent Printing
4. Create CSV Import File
4.1. Create Bulk Mailing Template
4.1.1. Selecting fields for the Bulk Mailing Template
4.1.2. Adding a default value to a selected field
4.1.3. Bulk Mailing Templates
4.2. Test Import of Bulk Mailing Template
4.2.1. Upload New Data File
4.2.2. Data File does match the Upload Template
4.2.3. Bulk Mailing File Contains Errors
4.2.4. File Successfully Processed to Bulk Mailing
5. Label Options
5.1. Configuring Label Options
6. Silent Printing
6.1. Pre-requisites
6.2. Installing Silent Print Application
6.3. Configure Silent Print Application
6.3.1. Reset Settings
6.4. Selecting Silent Print Profile in Intelligent Shipper
6.5. Edit Silent Print Profile
7. Print Harvester
7.1. Installing Print Harvester
7.1. Configuring Print Harvester
7.1.1. Scan Settings
7.1.2. Response Settings
7.1.3. Printing Settings
7.1.4. API Information
7.2. Run Print Harvester
7.2.1. Application Log
8. End to End Test
9. Switching from Test to Live Environment
9.1. Uninstalling the Silent Print and Print Harvester Applications
10. Appendix 1 – Glossary
11. Appendix 2 – Quick Reference Guides
11.1. Quick Reference Guide - Add a Bulk Mailing Template
11.2. Quick Reference Guide - Upload New Data File
11.3. Quick Reference Guide – Silent Print Application
11.4. Quick Reference Guide – Print Harvester

Table of Figures


Figure 1 - Add Bulk Mailing Template
Figure 2 - Field Selection for the Bulk Mailing Template
Figure 3 - Default Values
Figure 4 - Default Value for the Shipment Service Field
Figure 5 - Bulk Mailing Templates
Figure 6 - Example CSV (opened with notepad)
Figure 7 – Bulk Mailing Button
Figure 8 - Upload New Data File Button
Figure 9 - Upload New Data File Screen
Figure 10 - Upload file does not match error
Figure 11 - Errors on Data File
Figure 12- Error Column on Data file
Figure 13 - Print Labels from Bulk Mailing Screen
Figure 14 - Label Options Screen
Figure 15 - Download Silent Print Application Button
Figure 16 - Silent Print Download Window
Figure 17 - Windows Defender Message
Figure 18 - Run Silent Print Installation
Figure 19 - Silent Print Icon
Figure 20 - Silent Print Registration and Profiles Screen
Figure 21 - Silent Print Profile Successfully Registered Message
Figure 22 - Silent Print Settings and Printing Screen
Figure 23 - Reset Silent Print Settings
Figure 24 - Silent Printing Screen Select Profile Button
Figure 25 - Silent Print Profile Selected
Figure 26 - Edit Print Profile Button
Figure 27 - Edit Silent Print Profile
Figure 28 - Edit Silent Print Profile Fields Description
Figure 29 - Open Print Harvester Settings
Figure 30 - Print Harvester Settings Screen
Figure 31 - Print Harvester Scan Settings
Figure 32 - Print Harvester Response Settings
Figure 33 - Print Harvester Printing Settings
Figure 34 - Silent Print Profile ID
Figure 35 - Enter Profile ID in Print Harvester
Figure 36 - Copy Import Profile ID
Figure 37 - Enter Import Profile ID in Print Harvester
Figure 38 - Run and Pause Print Harvester
Figure 39 - Print Harvester Application Log
Figure 40 - Download Example CSV File for Bulk Mailing Template
Figure 41 - Silent Print Start Polling Selected
Figure 42 - Import File in Scan Folder
Figure 43 - Import File Successfully Processed and Moved to Response Folder
Figure 44 - Error File Created in Response Folder
Figure 45 - Error Response File
Figure 15 - Silent Print application in Uninstall or Change a Program list

Introduction

The Print Harvester and Silent Printing functionality in Intelligent Shipper provides "on demand" file processing by automating file import and label printing. This functionality allows you tell the system where your order files are posted to so that they can be picked up by the system, processed automatically and the required labels printed automatically, without needing any manual input from the user.
This user guide explains how to configure the Intelligent Shipper system, Print Harvester and Silent Print applications to use this automated file import and printing process.

Process Diagram – Configuring Print Harvester and Silent Printing

The diagram below shows the process for configuring the Intelligent Shipper Print Harvester and Silent Printing functionality. The steps in this diagram are described in more detail throughout the document.


Continued on next page

Create CSV Import File

To configure the Intelligent Shipper system for automated file import and label printing, you will first need to create an import file in csv format. This can be done using the Bulk Mailing Template functionality in Intelligent Shipper.

  1. To create a new Bulk Mailing Template, login to Intelligent Shipper and navigate to Maintenance > Bulk Mailing Templates.

  2. Click "Add Template". This will then take you to the Add Bulk Mailing Template screen.

Create Bulk Mailing Template



Figure 1 - Add Bulk Mailing Template
To create a new template, complete the following steps in the Add Bulk Mailing Template screen:

  1. Enter a template name – this is a required field

  2. The sample file can be downloaded in the formats: CSV (Comma Separated), PIPE Separated and ASCII fixed length. Select CSV from the File Format drop-down list.

  3. Select the required template type from the 2 available options:

    1. Domestic

    2. International

Note: The International template has extra required fields.

  1. Select the Unit Weight from the 2 available options:

    1. KG(Kilos)

    2. G(Grams)

  2. Select the Unit Length from the 2 available options:

    1. CM(Centimetres)

    2. MM(Millimetres)

  3. Tick the "Share this template" box, as the template will need to be shared for it to work with the Printer Harvester application. This will make the template available to other users under your customer account.

  4. Select the "Information" button to display instructions on adding fields to the template. The section Selecting fields for the Bulk Mailing Template also contains more details on selecting fields for the template.

  5. All required fields must be selected by clicking on the field in the Available Fields list – this will move the field over to the Selected Fields list. A progress bar indicates if all required fields have been selected. This bar must be at 100% before a template can be saved.

  6. If a Conditional field is selected, then it will require other fields. I.e. Item Description requires item value and weight.

  7. Optional fields are truly optional, if they are not selected there is no impact to template functionality.

  8. A newly created Bulk Mailing Template may be saved once all required fields have been selected. Once you have added all the necessary fields to your Bulk Mailing Template, click "Save" to create the new template.

  9. Click on the back button to go back the Bulk Mailing Templates screen.

Note: If the "Back" button is selected without the template being saved, then the data will be lost.

Selecting fields for the Bulk Mailing Template


Figure 2 - Field Selection for the Bulk Mailing Template

  1. From the Available Fields table, as fields are selected these will move across into the Selected fields table.

  2. All required fields progress bar in the example above is now Green and 100% indicating the template can now be saved.

 

Adding a default value to a selected field


Figure 3 - Default Values

  1. A default value can be added by clicking on the icon in the image above. On clicking the icon, the Default Value option appears as below in the Shipment Service example.



Figure 4 - Default Value for the Shipment Service Field

  1. You can enter the default value in the field provided. This will then be output as example data when example csv files are downloaded for the template.

 

Bulk Mailing Templates


Figure 5 - Bulk Mailing Templates

  1. The recently created template will be displayed on the Bulk Mailing Templates screen. To download a sample file:

  2. Find your template

  3. Click on Example (CSV)



Figure 6 - Example CSV (opened with notepad)

  1. An example csv will be provided that can be updated with your shipments. The csv will contain an example row underneath the header row, and this example row will contain the default values you entered when the template was created.

 

Test Import of Bulk Mailing Template

Once you have created the Bulk Mailing Template and downloaded an example csv, it is recommended that you import the csv file into Intelligent Shipper manually to test that the file can be imported successfully.

  1. To run a test import of the csv file, first add a row of test data to the file and save in csv format.

  2. In Intelligent Shipper navigate to Shipment Processing and Select "Bulk Mailing".



Figure 7 – Bulk Mailing Button

  1. The Bulk Mailing Screen will open.

 

Upload New Data File


Figure 8 - Upload New Data File Button
To import your csv file, click on "Upload New Data File" in the Bulk Mailing screen. The Upload New Data File screen will then open:

Figure 9 - Upload New Data File Screen
In the Upload New Data File screen:

  1. Enter a Project Name. This field is not required, but if provided the project name will be displayed on the Dashboard->Shipment Processing->Bulk Mailing where you can download the labels generated.

  2. Browse the file to be uploaded.

  3. If an email address is provided, then an email notification will be sent confirming the file was successfully processed.

  4. If the file has headers, select the 'Headers' tick box.

  5. Select the Bulk Mailing template created earlier.

  6. The Upload Type can be either Unprocessed or Bulk Mailing, explained below. For the purpose of testing the file import, select Bulk Mailing.

  7. Unprocessed - If you choose this option then labels will not be generated. These shipments can be scanned later to produce labels.

  8. Bulk Mailing - If this option is selected then shipments will be processed, and labels will be produced on upload.

  9. Click on "Upload file".

 

Data File does match the Upload Template


Figure 10 - Upload file does not match error

  1. On clicking upload file, if the file chosen does not match the Upload template, an error is returned, "The uploaded file does not match the bulk mailing template selected." In this scenario, you can:

  2. Select the correct template for your file

  3. Update your file to match the template

  4. Add a new Bulk Mailing Template

 

Bulk Mailing File Contains Errors



Figure 11 - Errors on Data File

  1. If the import file contains some errors, the message "Your file has some errors. You can download errors and abort uploading or continue processing successful records" will be displayed. Click on "Download errors" to download the file detailing the list of errors encountered.

  2. Click on "Continue processing successful records" to process records that were successfully uploaded.



Figure 12- Error Column on Data file

  1. The errors file that is downloaded contains the data entered in the import file and includes a column at the end describing the errors that prevented the data from being processed.

  2. Update the import file to correct the errors stated in the errors file, then upload the import file again.

 

File Successfully Processed to Bulk Mailing

  1. If the Bulk Mailing import file does not contain any errors, then the file will be imported successfully and added to the list of uploads in the Bulk Mailing screen:



Figure 13 - Print Labels from Bulk Mailing Screen

  1. From here it is possible to print/download the labels generated by clicking the printer/agent icon. For the purpose of testing the import file, you do not need to download and print the label.

 

Label Options

The Intelligent Shipper system contains various label designs for you to choose from, ranging from standard thermal labels to labels integrated as part of an A4 document.

  1. To select your label options, log into Intelligent Shipper then select Maintenance > Label Options.

  2. The Label Options screen will then be displayed for you to select your preferred label settings.

 

Configuring Label Options



Figure 14 - Label Options Screen

  1. Select the "Label on a roll" option from the Label Format list. This label format is required for use with the Print Harvester application.

  2. The "Update" button saves your label format selection.


Silent Printing

The Silent Printing functionality allows for the fully automated production of shipping labels and associated documents by printing to the necessary printers automatically when a shipment is created.

Pre-requisites

To run the Silent Print application successfully the below requirements will need to be met:

  • PC running Windows 7 or above

  • An x64-capable processor

  • 20 megabytes (MB) of available hard disk space

  • 2 GB or more of RAM.

  • A monitor with a resolution of 1024 × 768 or higher

  • Internet access (HTTPS port 443)

  • Access to either a physical or network printer


To install the Intersoft Silent Print application you will need Administrator privileges on your PC.

Installing Silent Print Application

  1. To install the Silent Print application, log into Intelligent Shipper and select Maintenance > Silent Printing > then click the "Download Silent Print Application" button.

Note: This button will only be displayed for Customer Administrator users.


Figure 15 - Download Silent Print Application Button

  1. The Silent Print download window will be displayed. You will need to tick the "I agree to Intersoft Terms & Conditions" box to download the Silent Print application.



Figure 16 - Silent Print Download Window

  1. Windows may display a message regarding Windows Defender which has prevented the download. If this message is displayed, then you will need to select the "More Info" link to proceed.



Figure 17 - Windows Defender Message

  1. Click "Run Anyway" to proceed with installing the Silent Print application. This will download the application and install it on your PC.



Figure 18 - Run Silent Print Installation

  1. Once the application has been downloaded a small icon will appear in the icon task bar and the Silent Print Registration and Profiles screen will open automatically.



Figure 19 - Silent Print Icon

Figure 20 - Silent Print Registration and Profiles Screen

Configure Silent Print Application

Once the Silent Print application has been installed, you will then need to configure the application in the Registration and Profiles screen. This will create a Silent Print Profile that is then available for selection in the Intelligent Shipper application.

  1. In the Email Address field enter the email address that you use to login to Intelligent Shipper.

  2. In the Password field enter the password that you use to login to Intelligent Shipper.

  3. Workstation/Profile Name will be displayed in the Intelligent Shipper Silent Printing maintenance screen to identify the silent print profile. This will be populated with the name of your PC by default but can be changed to a name of your choice.

  4. Share This Profile makes the silent print profile available in Intelligent Shipper to all users under your customer account. If you want the silent print profile to be available to other users, then tick this box.

  5. Description allows you to enter a description for the profile. The description will be displayed in the Intelligent Shipper Silent Printing maintenance screen.

  6. Proxy Configuration allows you to set up proxy details. The Default option will be selected by default, you can change this and enter other proxy details if needed.

  7. Once all details have been completed then select "Register / Create Print Profile".

  8. A message will be displayed informing you the Silent Print profile has been successfully registered. Click "OK" on this message to proceed.



Figure 21 - Silent Print Profile Successfully Registered Message

  1. The Settings and Printing window will then open. To start the application looking for print jobs select "Start Polling". The application will then start looking for print jobs and automatically print any labels that are generated and associated documentation (where applicable).



Figure 22 - Silent Print Settings and Printing Screen

Reset Settings

  1. Silent print settings can be reset at any time by right-clicking on the silent print icon on the task bar and then selecting "Reset Settings".



Figure 23 - Reset Silent Print Settings

  1. A confirmation message will be displayed prompting you to confirm you want to reset settings.

  2. If you select Yes on this message, the Registration and Profiles screen will be cleared ready and you will be able create a new silent print profile.

 

Selecting Silent Print Profile in Intelligent Shipper

Once a Silent Print profile has been created, you can select it as your chosen print profile in Intelligent Shipper.

  1. To select the new Silent Print profile, log into Intelligent Shipper and navigate to Maintenance > Silent Printing.

  2. The profile you created in the previous section will be listed, and the Creation date will display the current date.

  3. If your Silent Print profile is not displayed in the print profiles list, then go back into the Silent Print application and stop and restart polling. This will refresh the printer profile list in the Silent Printing maintenance screen.

  4. To select the Silent Print profile as your chosen printing profile, click the "Select Profile" button.



Figure 24 - Silent Printing Screen Select Profile Button

  1. The "Select Profile" button will then be replaced with a green tick to show that the profile has been selected as your chosen printing profile.



Figure 25 - Silent Print Profile Selected

Edit Silent Print Profile

You can update the printer selection or printer profile description for your Silent Print profile by editing the profile.

  1. To edit your Silent Print profile, in Intelligent Shipper navigate to Maintenance > Silent Printing then select "Edit Profile".



Figure 26 - Edit Print Profile Button

  1. The Edit Profile screen will open, containing the fields listed below.



Figure 27 - Edit Silent Print Profile

Field name

Description

Field name

Description