Last Revision Date: August 27, 2008
Kewill Imaging Automatic Import Entry Extract
Imaging-2
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Introduction Kewill Imaging Automatic Import Entry Extract is a Windows application that automatically extracts 7501’s and supporting documentation for Import Entries from Kewill Imaging. It runs continuously, detecting Import Entries in Kewill
Customs or Alliance Import for which it is has not already extracted documentation. It maintains a list of Import Entries for which documentation is pending in Kewill Imaging, and extracts the documentation when it becomes available in Kewill Imaging.
Import Entry selection is based on Customer and Release Date .
The Customer’s role in the Import Entry can be one or more of the following: Importer of Record, Ultimate Consignee, or Bill To Party.
The Release Date must be greater than or equal to the previous
Import Entry selection query date/time minus a configurable delta-time.
The types of documents extracted are specific to the Customer.
The extracted documents are placed in a folder specific to the
Customer.
Supporting documentation is extracted into a TIFF file named eeeeeeeeeee.TIF
, where eeeeeeeeeee is the 11-character Entry Number of the Import Entry, e.g., ABC00000001 . At the time that the supporting documentation is extracted, if the 7501 is available for the Import Entry, then it is also extracted and included in TIFF file eeeeeeeeeee.TIF
. However, if the
7501 becomes available after the supporting documentation has been extracted, then it is extracted into a TIFF file named eeeeeeeeeeeES.TIF
.
Documentation is extracted only for Import Entries having a valid Entry
Number.
Kewill Imaging Automatic Import Entry Extract is installed on the Kewill
Imaging server or on a workstation. It runs as a foreground application on the console of the host system.
Prerequisites Before you install Kewill Imaging Automatic Import Entry Extract, you must install the following on the host system:
Full Oracle 10g client
1. Copy the file Oracle_10201_client_win32.zip
from the Kewill Imaging distribution media to the host system.
Imaging-3
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
2. Unzip the file, preserving its folder structure, to a temporary folder on the host system.
3. Run setup.exe
in the client subfolder of the temporary folder to start installation of the full Oracle 10g client.
4. Select a Custom install.
5. When presented with a list of options to install, select all options.
6. After installation of the full Oracle 10g client is completed, you may need to change the following setting
SQLNET.AUTHENTICATION_SERVICES=(NTS) to
SQLNET.AUTHENTICATION_SERVICES=(NONE) in file SQLNET.ORA
, depending on how Kewill Imaging Automatic
Import Entry Extract is connecting to the Kewill Imaging database.
This file is typically found in the NETWORK\ADMIN subfolder of the
Oracle 10g client installation folder.
In the same file, you may also need to comment out the following setting
NAMES.DIRECTORY_PATH= (TNSNAMES) by changing it to
#NAMES.DIRECTORY_PATH= (TNSNAMES)
Steps for Installing To install Kewill Imaging Automatic Import Entry Extract on the host system, do the following:
1. Copy the file KIAIEE_n.n.n_install.zip
from the Kewill Imaging distribution media to the host system.
2. Unzip the file to a temporary folder on the host system.
3. Run Setup.exe
in the temporary folder to install Kewill Imaging
Automatic Import Entry Extract.
4. Accept all defaults during installation.
5. If you are upgrading Kewill Imaging Automatic Import Entry Extract, then you will be prompted for a choice of Modify, Repair, or Remove ; choose Repair .
Imaging-4
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Overview
Step
1
The steps below describe how to start Kewill Imaging Automatic Import Entry
Extract.
Action
To start Kewill Imaging Automatic Import Entry Extract, select the Kewill Imaging
Automatic Import Entry Extract shortcut in the Kewill Imaging Automatic Import
Entry Extract program group.
As Kewill Imaging Automatic Import Entry Extract starts, you may briefly see the following splash screen ( below ).
Kewill Imaging Automatic Import Entry Extract splash screen:
Step
2
Action
If you are starting Kewill Imaging Automatic Import Entry Extract for the first time, you will then see the following error message ( below ).
Imaging-5
Copyright © 2008 Kewill plc
KI Automatic Import Entry Extract error screen:
Kewill Imaging Automatic Import Entry Extract
Error screen This error message is normal and indicates that you must configure Kewill
Imaging Automatic Import Entry Extract before you can use it.
Step
3
Action
Click the OK button in the error message screen. The Options screen is displayed
( below ).
Imaging-6
Copyright © 2008 Kewill plc
Options screen:
Kewill Imaging Automatic Import Entry Extract
Options screen See section Configuring Kewill Imaging Automatic Import Entry Extract for information on configuring Kewill Imaging Automatic Import Entry Extract.
Step
4
Action
Once Kewill Imaging Automatic Import Entry Extract is configured, you will see the following screen when you start it.
Imaging-7
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Start screen:
Fields/Buttons
Time
Last Entry Query
Customer
File Number
Entry Number
Action
Start button
Stop button
Description
The Time field shows the current date and time of the host system.
The L ast Entry Query field displays the date and time that Kewill Customs or
Alliance Import was last queried for Import Entries having a recent Release
Date.
This field shows the Customer code currently being processed.
This field displays the File Number currently being processed.
This field shows Entry Number currently being processed.
This field displays the current action.
The Start button starts automatic extraction of documents from Kewill Imaging.
The Stop button stops automatic extraction of documents from Kewill Imaging.
Imaging-8
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Configuring Kewill Imaging Automatic Import Entry Extract is configured via its Options screen and Kewill Imaging System Manager.
You can access the Options screen by selecting the Options menu item.
Options screen:
Sections of Options screen
Oracle Connection section defines the Kewill Imaging database that
Kewill Imaging Automatic Import Entry Extract will communicate with.
Entry Query section controls the selection of Import Entries.
Error Reporting section controls the logging of errors.
Imaging-9
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Fields/Buttons
Database Name
Description
The Oracle Connection section defines the Kewill Imaging database that Kewill
Imaging Automatic Import Entry Extract will communicate with. Typically, the
Database Name has the format ServerName:Port/SID .
Contact your Kewill Imaging system administrator for this information.
Processing Interval The Processing Interval is the time interval in minutes ( >0 ) on which Kewill
Imaging Automatic Import Entry Extract runs to extracts documents from Kewill
Imaging.
Entry Query Interval The Entry Query section controls the selection of Import Entries. Interval is the time interval in minutes ( >0 ) on which Kewill Imaging Automatic Import Entry
Extract queries Kewill Customs or Alliance Import for Import Entries having a recent Release Date.
Release Date Delta-
Time
Release Date Delta-Time in hours ( >=0 ) determines the Release Date range for Import Entry selection: the Release Date must be greater than or equal to the last Import Entry query date/time minus the Release Date Delta-Time .
Error Reporting The Error Reporting section controls the logging of errors. Errors can be logged to any combination of the following by checking the box in front of the method:
the Windows Application Event Log,
a specified Log File, and
a semicolon-delimited SMTP E-mail ( user@domain ) address list. Email is sent using SMTP. SMTP settings are defined in the SMTP
Email screen (menu item General/SMTP Email ) in Kewill Imaging
System Manager. [ See the Kewill Imaging System Manager User
Guide for details .]
Confirm Processing of
Each Entry
The Confirm Processing Of Each Entry checkbox pauses processing after documents are extracted for each Import Entry to allow the user to review the indicators for the processed Import Entry.
OK button When you are finished configuring Kewill Imaging Automatic Import Entry
Extract, click the OK button to save the configuration.
Kewill Imaging System
Manager configuration
In Kewill Imaging System Manager, two screens configure Kewill Imaging
Automatic Import Entry Extract:
1. Import FTP Customers (menu item Import/Import FTP Customers )
2. Import FTP Document Types (menu item Import/Import FTP
Document Types ). [ See the Kewill Imaging System Manager User
Guide for details .]
Imaging-10
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Flagging an Import
Entry for Re-Extraction
To flag an Import Entry for re-extraction, you must edit the record for the
Import Entry in the table ImFTPEntries in the Kewill Imaging database.
Clear the values in fields Sent7501 and SentDocs .
Activity Reports On a daily basis, at a specified time, an activity report can be automatically generated for a Customer code and sent to a specified SMTP E-mail distribution list. The activity report lists the Import Entries for which documentation was extracted in the previous 24 hours.
Activity reporting is configured for each Customer code via the Import FTP
Customers screen (menu item Import/Import FTP Customers ) in Kewill
Imaging System Manager. [ See the Kewill Imaging System Manager User
Guide for details.
]
Finding Version To find out what version of Kewill Imaging Automatic Import Entry Extract you are using, select the About menu item to show the About box.
About screen:
Imaging-11
Copyright © 2008 Kewill plc
Kewill Imaging Automatic Import Entry Extract
Closing Extract To close Kewill Imaging Automatic Import Entry Extract, click the Exit button.
Copyright © 2008 by Kewill plc [last revision date: 08/27/08]
Imaging-12
Copyright © 2008 Kewill plc