MiniPick Integration Guide

7/31/2019 MiniPick Integration Guide

1/24


2/24

MiniPick Integration Guide MPS1

Version 1.02 Page 2MiniPick Integration Guide

1 Revision HistoryRevision Date Version Initials Details01 15/12/05 1.00.00 KCP Initial Release

02 27/01/06 1.00.02 RTM File layout updates

03 26/06/06 1.00.05 RTM File name update, order detail message lines

04 15/08/06 1.00.06 RTM Outer quantity and box number fields

05 23/08/06 1.01.01 RTM Goods Receiving Module

06 12/09/06 1.01.02 RTM Stock Take, Stock Location Transfer Modules

07 05/12/06 1.02.00 RTM MiniPick 1.2


3/24



2 Index

1 Revision History 22 Index 33 Overview 4

3.1 Purpose of this Document 43.2 MiniPick 43.3 Requirements 43.4 Host System 53.5 Data Transfer 5

4 Data Import 64.1 Full Tables 7

4.1.1 Product 74.1.2 Customer 84.1.3 Warehouse 84.1.4 Freetype Labels 94.1.5 Generic Labels 94.1.6 Generic Tables 104.1.7 Supplier 11

4.2 Partial Tables 124.2.1 Bin Stock 124.2.2 Sales Order Header 134.2.3 Sales Order Detail 144.2.4 Goods Receiving Header 154.2.5 Goods Receiving Detail 16

5 Data Export 175.1 Picked Orders 18

5.1.1 Completed Order Header 195.1.2 Completed Order Detail 19

5.2 Received Goods 205.2.1 Received Goods Header 215.2.2

Received Goods Detail 21

5.3 Stock Location Transfer 22

5.3.1 Stock Location Transfer Detail 225.4 Stock Take 23

5.4.1 Stock Take Batch Header 235.4.2 Stock Take Batch Detail 23

6 Contacting Aspin Management Systems 24


4/24



3 Overview

3.1 Purpose of this Document

This document is intended for technical personnel tasked with writing data exports for MiniPick and dataimports from MiniPick. It provides the MiniPick external data transfer specification.

This document is designed to be used by the IT department of MiniPick customers or by 3 rd party IT suppliersof MiniPick customers.

3.2 MiniPick

MiniPick is a software suite composing of a MiniPick server for Microsoft Windows PC and client software forMicrosoft Pocket PC.

MiniPick receives sales orders and supporting data ready for warehouse picking. It facilitates themanagement of those orders through allocation to pickers, the picking process, and return to the hostsystem.

3.3 Requirements

Both the MiniPick server and client software are written for the Microsoft .NET Framework.

The MiniPick server requires Windows XP or later.

MiniPick client software runs on Pocket PC 2003 or later.

The client and server communicate via TCP/IP networking. Therefore a network to which the server andclients can connect is required. The client Pocket PCs may connect to the network via Microsoft ActiveSync.


5/24



3.4 Host System

The term host system refers to the accounting software in use on which sales orders are maintained. Thehost system must be able to export text files to a directory which can be read by the MiniPick server. It mustalso be able to detect and read text files returned by the MiniPick server.

It is expected that when a sales order has been transferred to MiniPick for picking, it will remain unchangedon the host system pending the return of that order. If the order is modified on the host system whilepicking is in progress, this may lead to a data conflict when the picked order is returned from MiniPick.

3.5 Data Transfer

Data is transferred between MiniPick and the host system by way of text files. Two dedicated transferdirectories must be created which are visible to both the host system and to MiniPick.

These transfer directories may exist on the MiniPick server, the host system server or a third machine used asa file server. If the transfer directories are not on the MiniPick server, then a mapped network drive shouldbe used so that the MiniPick server can access the directories.

The following documentation describes files in a tilde ~ delimited format. MiniPick also includes standardadaptors to support the following file formats:

Csv (comma separated values)

Fixed width

Tab delimited

Additionally there is an adaptor to support a custom defined field delimiter which can be used if a multiplecharacter delimiter is required. This is useful if the data itself may include tilde ~ characters. For example,fields may be separated by the string #=#=#.


6/24



4 Data Import

Data to be imported into the MiniPick server is supplied in text files which should be written to a directoryspecified in the MiniPick implementation.

Any file name may be used with a .txt extension. When a file has been fully copied or written into the importdirectory, then an empty file of the same name with a .ok extension should be written to the same directory.This is to ensure that data files are not imported by the MiniPick server before they are complete.

e.g.

Order123456.txt

Order123456.ok

Sections of data within the files should begin with a line to specify the data type. This is in the form

mode=. There may be one or more of these sections in each file.

It is acceptable to have a different data file for each data type. It is also acceptable to have more than onedata type in a data file. An empty file with a .ok extension must be supplied with every data file to beimported.

The data fields should be separated by a tilde character (~). No data field may contain a tilde character.

The first field cannot be blank. This means that data lines must have one or more characters before the firsttilde. Lines beginning with a tilde will not be imported.

Also, lines beginning with a hash character (#) will not be imported. Therefore the first data field may not

begin with a hash character. A hash as the first character in a line may be used to indicate a remark line.

e.g.

# Here are todays orders

mode=soheader

#id~customer~whouse~po ref~name~~~~~~ord date~despatch date~

11221~CUST002~1~my order~Harry Shop~~~~~~20051010~20051111~X~~~~~~

11222~CUST001~1~second order~A Customer~~~~~~20050918~20051203~V~~~~

11223~CUST001~1~third order~A Customer~~~~~~20050918~20051203~V~~

mode=sodetail

#id~customer~line~product~qty

11221~CUST002~1~PROD005~10~0~~~~~~~~~~~~~~~~

11221~CUST002~2~PROD004~10~0~~~~~~~~~~~~~~~~11221~CUST002~3~PROD003~10~0~~~~~~~~~~~~~~~~

11222~CUST001~1~PROD002~220~0~~~~~~~~~~~~~~~~

11222~CUST001~2~PROD003~230~0~~~~~~~~~~~~~~~~

11223~CUST001~1~PROD003~200~0~~~~~~~~~~~~~~~~

Each table has a primary key specified. This primary key must be unique. For example, there cannot be twoproducts with the same product code.

After importing data, the files will be moved to an archive directory where they will be stored for a specifiedperiod of time.


7/24



4.1 Full Tables

The following files must be supplied in full. When the MiniPick server receives any of these new files, all olddata from the given table is deleted and repopulated with the newly supplied data.

4.1.1 Product

mode=product

Field Type Required Notes

ProductCode 35 alpha Y

Description 128 alpha Y

Barcode 35 alpha Y

PickQuantity decimal Y The unit quantity included in 1

picked warehouse packageSubstitutionGroup 35 alpha N The group within which product

substitutions may be made inthe picking process

Generic1 15 alpha N

Generic2 15 alpha N

Generic3 15 alpha N

Generic4 15 alpha N

Generic5 15 alpha N

Generic6 15 alpha N

Generic7 15 alpha N

Generic8 15 alpha N

Generic9 15 alpha NGeneric10 15 alpha N

Freetype1 128 alpha N










OuterBarcode 35 alpha N The barcode on the outercarton (must be different fromproduct barcode)

OuterQuantity decimal N The unit quantity included inone outer carton

Primary key = ProductCode


8/24



4.1.2 Customer

mode=customer

Field Type Required NotesAccountCode 35 alpha Y

Name 128 alpha Y

Address1 128 alpha Y





Generic11 15 alpha N



















Contact 128 alpha N

Telephone 128 alpha N

Email 128 alpha N

WebAddress 128 alpha N

Primary key = AccountCode

4.1.3 Warehouse

mode=warehouse


Warehouse 15 alpha Y If only one picking warehouseis in use, it is recommendedthat 1 is used in this field

Description 128 alpha Y

Primary key = Warehouse


9/24



4.1.4 Freetype Labels

Several of the tables include 128 character alpha-numeric freetype fields. These are optional and may be

used to display any information associated with the record. Each freetype field has a unique number. Inorder for MiniPick to display the data supplied in this field, a label must be supplied for that numberedfreetype field.

If no freetype label is supplied for a numbered freetype field, then the data in that freetype field will not bedisplayed.

mode=freetypelabel


Category Integer Y Corresponds to one of thefreetype fields on another table

Label 128 alpha Y The label to be displayed for

this freetype field

Primary key = Category

4.1.5 Generic Labels

Several of the tables include 15 character alpha-numeric generic fields. These are optional. They may bepopulated with codes which can be looked up against values in the generic table.

Each generic field has a unique number. In order for MiniPick to display the data supplied in this field, a labelmust be supplied for that numbered generic field. If no generic label is supplied for a numbered generic field,

then it will not be displayed.

mode=genericlabel


Category Integer Y Corresponds to one of thegeneric fields on another table

Label 128 alpha Y The label to be displayed forthis generic field

Primary key = Category


10/24



4.1.6 Generic Tables

The generic table holds descriptions for the generic codes supplied in various tables. Where a generic label

has been supplied, the description of a generic value will be displayed. If a generic code in any table has nocorresponding record in this generic lookup table, then the code will be displayed.

mode=generic


Category Integer Y Corresponds to one of thegeneric fields on another table

Code 15 alpha Y A unique code within thecategory. Entries in genericfields on other tablescorrespond to an entry in thiscode field for the appropriate

categoryDescription 128 alpha Y

Primary key = Category, Code


11/24



4.1.7 Supplier

mode=supplier


SupplierCode 35 alpha Y

Name 128 alpha Y






Contact 128 alpha N


Email 128 alpha N

WebAddress 128 alpha N











Freetype41 128 alpha NFreetype42 128 alpha N









Primary key = SupplierCode


12/24



4.2 Partial Tables

The following files are to be supplied as data becomes available. When the MiniPick server receives any ofthese new files, the new data is added to the existing data on the appropriate table. Existing data is notdeleted unless the primary key supplied matches an existing record.

For example, this means that new orders to be picked can be supplied as they are ready for picking. Also,the stock level data may be supplied for the products whose stock level or location has changed. It is notnecessary to supply the full stock list with stock levels.

4.2.1 Bin Stock

mode=binstock


Warehouse 15 alpha Y If only one picking warehouse is inuse, it is recommended that 1 isused in this field


BinLocation 15 alpha Y Bin location within warehouse

FreeQuantity Decimal Y Number of units available

AllocatedQuantity Decimal N Number of units allocated

BondedStatus 0/1 N 0 = cleared stock (default)1 = bonded

Primary key = Warehouse, ProductCode, Bin


13/24



4.2.2 Sales Order Header

mode=soheader

Field Type Required NotesOrderId 15 alpha Y

AccountCode 35 alpha Y


PORef 128 alpha Y

Name 128 alpha Y





Address5 128 alpha YOrderDate 8 alpha Y YYYYMMDD

DespatchDate 8 alpha Y YYYYMMDD





















Priority Integer N 0 to 9. Lower numbers areautomatically assigned topickers first.

Highlight Integer N 0 to 9. Coloured display maybe configured on the MiniPickserver.

Boxes Integer N The total number of boxes tobe used in order despatch.

DeliveryNoteCode 15 alpha N

Primary key = OrderId


14/24



4.2.3 Sales Order Detail

mode=sodetail

Field Type Required NotesOrderId 15 alpha Y

AccountCode 35 alpha Y

LineNumber Integer Y


Quantity Decimal Y

PickedQuantity Decimal Y






Freetype31 128 alpha NFreetype32 128 alpha N




Message 128 alpha N This may be used for order lineswhere no product description isavailable on the product file

BoxNumber Integer N Only relevant for an order line thatis already picked

BinLocation 15 alpha N

Primary key = OrderId, LineNumber


15/24



4.2.4 Goods Receiving Header

mode=manifestheaderField Type Required Notes

ManifestId 15 alpha Y May be purchase order id



Reference 128 alpha Y

Consignment 15 alpha Y

Courier 128 alpha Y

Name 128 alpha Y

OrderDate 8 alpha Y YYYYMMDD

DespatchDate 8 alpha Y YYYYMMDDAddress1 128 alpha Y





Contact 128 alpha N





















Primary key = ManifestId, Consignment


16/24



4.2.5 Goods Receiving Detail

mode=manifestdetail

Field Type Required NotesManifestId 15 alpha Y May be purchase order id

Consignment 15 alpha Y

OrderId 15 alpha Y


LineNumber Integer Y


BondedStatus 0/1 Y 0 = clear, 1 = bonded

ExpectedQuantity Decimal Y

ReceivedQuantity Decimal Y










Primary key = ManifestId, Consignment, LineNumber


17/24



5 Data Export

Data is exported from the MiniPick server as text files written to an export directory specified in the MiniPickimplementation. The export directory must be different from the data import directory.

The MiniPick server will not write to a directory that already has files in it. Therefore the process that readsthe data files must archive to a different location or delete the exported files after processing so that moredata can be exported on the next occasion.

Sections of exported data will begin with a line specifying the data type in the format:mode=

The final line of the data export file will be:mode=end

When the MiniPick server has completed writing to a data file, it will write another empty file of the samename, but with a .ok file extension. This is to indicate that the data file is complete and ready for processing.

Data fields will be separated by a tilde character (~).

Note:It is possible that with future software upgrades more fields will be added to the data export filespecifications. It is therefore highly recommended that any automatic processing of these exported files bewritten in such a way that fields added to the end of data records will not cause problems. (New fields willnot be added at the beginning or in the middle of these specified layouts. Therefore these layoutspecifications will continue to show an accurate sequence of the fields that they specify.)


18/24



5.1 Picked Orders

Orders will be exported from the MiniPick server in a text file named:picked.txt

MiniPick will not export orders if there is already a file in the export directory with a conflicting file name.Therefore an alternative setting will cause text files to be named with the order id in the file name. With thissetting, files will be named (for example):

picked11221.txt

picked11222.txt

picked11223.txt

The orders being exported from the MiniPick server will have been picked, partially picked, or not picked.

This will be reflected in the Return Status of an order.

The following order Return Status values may be used:0 = Not Picked

1 = Partially Picked

2 = Fully Picked

If an order is Not Picked, then the order lines will not be returned as they have no additional information.

If substitutions are allowed, picked orders may include product substitutions. This will be shown by the valuein the field SubstitutedLines. A zero in this field will indicate that no lines have been substituted.

The following example of exported data shows a partially picked order, a completely picked order with a

substitution, and a returned unpicked order:

mode=orderheader

11221~CUST002~1~1~0~JACK~

mode=orderdetail

11221~CUST002~1~PROD005~10~10~

11221~CUST002~2~PROD004~10~0~

11221~CUST002~3~PROD003~10~10~

mode=orderheader

11222~CUST001~1~2~1~JACK~

mode=orderdetail

11222~CUST001~1~PROD002~220~230~

11222~CUST001~2~PROD005~230~230~PROD003

mode=orderheader11223~CUST001~1~0~0~~

mode=end


19/24



5.1.1 Completed Order Header

Order header sections begin with the line:mode=orderheader

These data sections have the following layout:

Field Type Notes

OrderId 15 alpha

AccountCode 35 alpha

Warehouse 15 alpha

ReturnStatus Integer 0, 1, 2

SubstitutedLines Integer 0 or more

PickerId 15 alpha

PickingNotes 128 alpha

5.1.2 Completed Order Detail

Order detail sections begin with the line:mode=orderdetail


Field Type Notes

OrderId 15 alpha

AccountCode 35 alpha

LineNumber IntegerProductCode 35 alpha

Quantity Decimal Quantity required

PickedQuantity Decimal Quantity picked

OriginalProduct 35 alpha Blank if no productsubstitution is made

BinLocation 15 alpha

Box Integer If the user is entering thebox number by order line

AdditionalBoxes Integer Count of additional boxes willbe 0 unless more boxes areused than the Box number

above


20/24



5.2 Received Goods

Received Goods data will be exported from the MiniPick server in a text file named:received.txt

MiniPick will not export data if there is already a file in the export directory with a conflicting file name.Therefore an alternative setting will cause text files to be named with the manifest id in the file name. Withthis setting, files will be named (for example):

recieved821.txt

received822.txt

recieved823.txt

The records being exported from the MiniPick server will represent a received goods manifest which may beun-received, partly, fully or over-received.

The following Received Status values may be used:0 = Not Received

1 = Partially Received

2 = Fully Received

3 = Over Received

If any goods are received which were not on the expected manifest, then the

record will be over-received. If received goods are recorded on a blank manifest

without any explicit expected manifest, then the record will have a status of

over-received.

An un-received manifest will have no following detail records.


21/24



5.2.1 Received Goods Header

Order header sections begin with the line:mode=receivedheader


Field Type Notes

ReceivingId 15 alpha

Consignment 15 alpha

SupplierCode 35 alpha

Courier 128 alpha

Reference 128 alpha

Warehouse 15 alpha

ReceivedStatus Integer 0, 1, 2, 3

ReceivedDate 8 alpha YYYYMMDDReceiverId 15 alpha

Notes 128 alpha

5.2.2 Received Goods Detail

Order detail sections begin with the line:mode=receiveddetail


Field Type NotesReceivingId 15 alpha

Consignment 15 alpha

OrderId 15 alpha

SupplierCode 35 alpha

LineNumber Integer

ProductCode 35 alpha

ExpectedQuantity Decimal Quantity required

ReceivedQuantity Decimal Quantity picked

BondedStatus 0/1 0 = clear1 = bonded

BinLocation 15 alpha


22/24



5.3 Stock Location Transfer

Stock location transfers recorded on in MiniPick will be exported in files named Transfer followed by the

transfer id (generated within MiniPick). For example:

Transfer00001.txtTransfer00002.txtTransfer00003.txt

5.3.1 Stock Location Transfer Detail

Stock transfer sections begin with the line:mode=stocktransfer

These data sections have the following layout:Field Type Notes

TransferId 15 alpha

TransferDate 8 alpha YYYYMMDD

TransferTime 4 alpha HHmm

PickerId 15 alpha

ProductCode 35 alpha

FromWarehouse 15 alpha

FromLocation 15 alpha

FromBondedStatus 0/1 0 = clear, 1 = bonded

ToWarehouse 15 alpha

ToLocation 15 alpha

ToBondedStatus 0/1 0 = clear, 1 = bondedQuantity Decimal

Message 128 alpha


23/24



5.4 Stock Take

Recorded stock take data will be exported in files named StockTake followed by the batchid. For example:

StockTake12345.txtStockTake12346.txtStockTake12347.txt

5.4.1 Stock Take Batch Header

Stock take batch header sections begin with the line:

mode=stocktakeheader


Field Type Notes

BatchId 15 alpha

CountDate 8 alpha YYYYMMDD

CountTime 4 alpha HHmm

PickerId 15 alpha

Reference 128 alpha

Warehouse 15 alpha

5.4.2 Stock Take Batch Detail

Stock take batch detail sections begin with the line:mode=stocktakedetail


Field Type Notes

BatchId 15 alpha

LineNumber Integer

Warehouse 15 alpha

Location 15 alpha

BondedStatus 0/1 0 = clear, 1 = bondedProductCode 35 alpha

ExpectedQuantity Decimal

CountedQuantity Decimal


24/24


6 Contacting Aspin Management Systems

United Kingdom sales information [email protected] and New Zealand sales information [email protected] Information and support [email protected]

By phone (UK) +44 (0)1794 500200By phone (Australia) +61 (0)395501808By fax +44 (0)1794 500210Support Line +44 (0)1794 500205

Documents

MiniPick Integration Guide