Documents

Overview

Document Details

Minimum Fields Required

Browser

Header

Line Item

Write-Back

On the Documents tab, you will define the documents that the StarShip user will ship against. A document is a set of related data in the financial system such as a customer, vendor, order, invoice, return, or shipment (packed order).

You then create SQL queries for the different documents that identify the fields necessary to process a shipment against each document.

Documents are maintained in the All Documents List, where you can add, duplicate, or delete documents.

For each of the data retrieval sections on the Documents tab (Browser, Header, Line Items, Package, Batches), there will be one or more SQLs created. For each section, one (and only one) SQL needs to be identified as the Key Provider SQL. The Key Provider SQL will be executed first, and should include fields that additional SQLs may need for their execution.

Note : The only tabs that require you to define SQL statements are the Browser and Header tabs. Other tabs are optional.

Document Details

This section is related to the currently selected document in the All Documents List. It contains the document's properties, such as if the document will support freight and notes write-back or batches. Each document is made up of fields organized into a structure : header, line items, packages, package content, etc.

Freight Update, Notes Update, Batches Supported

Check the appropriate check box for what this document will support. If you check any of these options, the corresponding sub-tab must be set up.

• Freight Update : Check this box if freight charges can be updated for this document type. When checked, the StarShip user will have options for freight write-back in Customize Interface.. Users can also define freight rules which determine whether freight is written back and the amount.
  
• Notes Update : Check this box if the document has a notes or memo field where StarShip can append a text string containing shipping information.  If checked, the user will have settings in Customize Interface under Write-Back > Notes where they can enable/disable notes write back, and define the shipment fields that will be included.    
  
• Batches Supported : Check this box if the document supports "batch" processing.  If enabled, the interface must define a SQL statement that returns a list of possible batches. The StarShip user selects a batch from the Ship screen and the interface will perform the necessary updates within the Write-Back > Document SQL statements.
  
  See StarShip Write-Back options
  

Document Name

The name of the document as you want it to appear on the StarShip Ship screen. For example, Sales Orders.

Document Type

Shipment is the only document type that allows for importing packaging. When this field is set to Shipment,  you will see an additional Package sub-tab.

Shipment also supports header and line item information.

Order supports header and line items.

The Customer document type will not have a Write-Back sub-tab; write-back for Customers is not supported. It contains only shipment fields, such as Address, but no line item information.

Minimum Fields Required

The following minimum fields are required for StarShip to retrieve enough information to process a shipment.

Customers

Company, Address 1, City, State, Postal Code, Country

Orders   

All fields above, plus Order number, Carrier + Service (Ship Via)

Items

All fields under Customers, plus Item Number, Item Description, Ordered Units

Shipment

All fields under Customers, plus Packaging

Write-Back

The following minimum fields are required for StarShip to retrieve enough information to perform write-back.