infor sce warehouse management module interface guide guide.pdf · 2014-11-22 · without...

Infor SCE Warehouse Management Module Interface Guide

Copyright © 2013 Infor

Important Notices The material contained in this publication (including any supplementary information) constitutes and contains confidential and proprietary information of Infor. By gaining access to the attached, you acknowledge and agree that the material (including any modification, translation or adaptation of the material) and all copyright, trade secrets and all other right, title and interest therein, are the sole property of Infor and that you shall not gain right, title or interest in the material (including any modification, translation or adaptation of the material) by virtue of your review thereof other than the non-exclusive right to use the material solely in connection with and the furtherance of your license and use of software made available to your company from Infor pursuant to a separate agreement, the terms of which separate agreement shall govern your use of this material and all supplemental related materials ("Purpose"). In addition, by accessing the enclosed material, you acknowledge and agree that you are required to maintain such material in strict confidence and that your use of such material is limited to the Purpose described above. Although Infor has taken due care to ensure that the material included in this publication is accurate and complete, Infor cannot warrant that the information contained in this publication is complete, does not contain typographical or other errors, or will meet your specific requirements. As such, Infor does not assume and hereby disclaims all liability, consequential or otherwise, for any loss or damage to any person or entity which is caused by or relates to errors or omissions in this publication (including any supplementary information), whether such errors or omissions result from negligence, accident or any other cause. Without limitation, U.S. export control laws and other applicable export and import laws govern your use of this material and you will neither export or re-export, directly or indirectly, this material nor any related materials or supplemental information in violation of such laws, or use such materials for any purpose prohibited by such laws. Trademark Acknowledgements The word and design marks set forth herein are trademarks and/or registered trademarks of Infor and/or related affiliates and subsidiaries. All rights reserved. All other company, product, trade or service names referenced may be registered trademarks or trademarks of their respective owners. Publication Information Release: Infor SCE Warehouse Management Module Release level 10.3 Publication date: September 27, 2013

Infor SCE Warehouse Management Module Interface Guide | 3

Contents

About this guide ................................................................................................................................... 7

Intended audience ........................................................................................................................... 7

Related documents .......................................................................................................................... 8

Contacting Infor................................................................................................................................ 8

Chapter 1 Architecture Overview ................................................................................................... 9

Introduction ...................................................................................................................................... 9

Classes and properties files........................................................................................................... 10 3BLoggerSettings.properties ....................................................................................................... 10 Router ...................................................................................................................................... 10 5BSocketListener ......................................................................................................................... 11 6BXSLTransform (XSLT) ............................................................................................................. 11 7BWM4000APIProcessor ............................................................................................................ 12 WM40TransactionServiceInterface ......................................................................................... 12 9BEXceedSocketInterface ........................................................................................................... 13 DelimitedToXML (Voice only) .................................................................................................. 14

Chapter 2 API Details ..................................................................................................................... 17

About API details ........................................................................................................................... 17

API structure overview ................................................................................................................... 18 <Head> .................................................................................................................................... 18 <Body> .................................................................................................................................... 18 <MessageType> and <Action> ............................................................................................... 18 Authentication .......................................................................................................................... 19

XML overview ................................................................................................................................ 19

Export interface .............................................................................................................................. 20

API descriptions ............................................................................................................................. 20 Adjustment ............................................................................................................................... 21 AdvancedShipNotice ............................................................................................................... 21

Contents

4 | Infor SCE Warehouse Management Module Interface Guide

Area ......................................................................................................................................... 21 Associate ................................................................................................................................. 22 BatchSelectionCriteria ............................................................................................................. 22 BODListAPI .............................................................................................................................. 22 Carrier ...................................................................................................................................... 23 CatchWeight ............................................................................................................................ 23 CodeList ................................................................................................................................... 23 Customer ................................................................................................................................. 24 CycleCount .............................................................................................................................. 24 DemandAllocation ................................................................................................................... 24 Equipment ................................................................................................................................ 25 ErpLot ...................................................................................................................................... 25 ExportInterface ........................................................................................................................ 25 Facility ...................................................................................................................................... 25 FacilityTransfer ........................................................................................................................ 26 FlowThruOrder......................................................................................................................... 26 Inventory .................................................................................................................................. 26 InventoryBalance ..................................................................................................................... 27 ItemID ...................................................................................................................................... 27 ItemMaster ............................................................................................................................... 28 ITRN......................................................................................................................................... 29 Load ......................................................................................................................................... 29 Location ................................................................................................................................... 30 Lot ............................................................................................................................................ 30 MasterBillOfLading .................................................................................................................. 31 MovableUnit ............................................................................................................................. 31 OutboundID ............................................................................................................................. 32 Owner ...................................................................................................................................... 32 Pack ......................................................................................................................................... 32 PurchaseOrder ........................................................................................................................ 33 PutawayZone ........................................................................................................................... 33 Receipt ..................................................................................................................................... 34 ReceivedInventory ................................................................................................................... 34 Report ...................................................................................................................................... 34 Section ..................................................................................................................................... 35 SelectionZone .......................................................................................................................... 35 SerialNumber ........................................................................................................................... 36 ShipmentOrder ........................................................................................................................ 36

Contents


SortationStation ....................................................................................................................... 37 Storer ....................................................................................................................................... 37 SubstituteSku........................................................................................................................... 38 Supplier .................................................................................................................................... 38 Task ......................................................................................................................................... 38 TaskManagerUser ................................................................................................................... 39 TaskReason ............................................................................................................................. 39 Transfer ................................................................................................................................... 40 TransShipASN ......................................................................................................................... 40 TransShipOrder ....................................................................................................................... 40 UserDataTranslation ................................................................................................................ 41 Voice ........................................................................................................................................ 41 VoiceTaskManager .................................................................................................................. 42 Wave ........................................................................................................................................ 42 Zone ......................................................................................................................................... 44

Chapter 3 Event Management ...................................................................................................... 45

Events architecture ........................................................................................................................ 45

Event cycle ..................................................................................................................................... 45

Event contents ............................................................................................................................... 46

Events flow ..................................................................................................................................... 47 XML converter ......................................................................................................................... 47 Input template .......................................................................................................................... 47

Event configuration ........................................................................................................................ 48 Eventcfg.ini .............................................................................................................................. 48 [Scanner] section ..................................................................................................................... 48 [Converter] section .................................................................................................................. 48

Default converter ............................................................................................................... 48 Event-specific converters .................................................................................................. 48

[Publisher] section ................................................................................................................... 49 Default publisher ............................................................................................................... 49 Event-specific publishers .................................................................................................. 49

[Switches], [Messages], [Alerts] sections ................................................................................ 49 Posted events .......................................................................................................................... 50 Usage ...................................................................................................................................... 50 Output format ........................................................................................................................... 50 Configuration ........................................................................................................................... 51

Contents


Chapter 4 Message Handling ........................................................................................................ 53

Message builder files ..................................................................................................................... 53

Appendix A Available Events........................................................................................................ 55

Events shipped with the WM ......................................................................................................... 55

Appendix B Glossary ..................................................................................................................... 61


About this guide

This guide provides information about integrating your system with the Infor10 SCE Warehouse Management Module (WM). It includes detailed information about:

• APIs

Sending data between the host computer and WM. Developers can use APIs to manipulate and retrieve data through a series of external calls.

• Event Management

Setting up the system to notify users about important events that occur and require some form of user action.

• Message Handling

Setting up message builder files that allow developers and administrators to select the type of information to send to an external system.

Other manuals, such as training or procedure manuals, guide you step-by-step through certain tasks.

Intended audience The intended audience for this manual includes:

• Administrators who are installing and setting up the APIs and their associated environment settings.

• Developers who are designing transactions for the APIs. • Any person responsible for initially integrating your system with WM.

Note: This manual assumes that the reader has a general knowledge of warehouse operations.

About this guide


Related documents You can find the documents in the product documentation section of the Infor Xtreme Support portal, as described in Contacting Infor on page 8.

Infor Supply Chain Execution Installation and Deployment Guide

Contacting Infor If you have questions about Infor products, go to the Infor Xtreme Support portal at www.infor.com/inforxtreme.

If we update this document after the product release, we will post the new version on this Web site. We recommend that you check this Web site periodically for updated documentation.

If you have comments about Infor documentation, contact [email protected].

http://www.infor.com/inforxtreme

mailto:[email protected]


Chapter 1 Architecture Overview 1

This chapter gives an overview of the architecture used to implement APIs in WM. It also describes the various classes and their properties.

Introduction Each API is implemented through a Java application class specific to a business object, but is accessed through a single Java class. Only one class must be invoked to create a purchase order, as opposed to a shipment order.

The primary method to be invoked by a developer is the process method on com.ssaglobal.scm.wms.api.util.WM4000APIProcessor. This method includes the following parameters:

• Caller’s identity • Type of message being passed • Action to be performed on the message • XML formatted message

When a call is made, the class calls the process method of a router class with the parameters sent. The router looks up the appropriate class and method to send this new information to and makes that call. By default, the router passes the parameters to the process method of the WM40TransactionServiceInterface class, which sends the information to the WM to be processed.

For the current implementation, all calls point to the same WM40TransactionServiceInterface.

The transaction service interface:

• Determines which API to call. • Loads a remote interface to the TransactionServiceSO. • Sends the parameters received to the TransactionServiceSO.

The WM40TransactionServiceInterface returns an XML file with either the result of the data requested or a success message. If an error is encountered, that error is returned in XML format.

Architecture Overview


Classes and properties files Each class has its own properties file to handle logging configuration and local switches. By default, a single master logging properties file is created, but each class properties file can be changed to point to a different logger file if needed.

3BLoggerSettings.properties The LoggerSettings.properties file is the default master file that controls how logs are recorded in the APIs. The installer points the LoggerSettings variable in each of the class properties files to this file. These variables can be changed to point to different logger files if required.

The APIs use Apache log4 for logging. If you want to make changes to the LoggerSettings.properties file, review the log4j documentation at:

http://logging.apache.org/log4j/docs/documentation.html

The LoggerSetting.properties file contains the following entries:

Entry Description

log4j.rootCategory Controls the logging level and log destination.

log4j.appender.dest Sets the output processor for each destination.

log4j.appender.dest.File Since the default processor is a file, sets the file path and name to which you can write the logs.

log4j.appender.dest1.MaxFileSize The maximum size for a file before the rolling logger creates a new file.

log4j.appender.dest1.MaxBackupIndex The maximum number of files the rolling logger will create before deleting the oldest file.

log4j.appender.dest.layout Determines which layout manager is used.

log4j.appender.dest.layout. ConversionPattern

Uses codes recognized by the layout manager to build the log. Note: Java 1.4 on HPUX with a PatternLayout using %d can cause an error. Avoid this combination.

Router The Router class is used to determine which Java class and method is loaded and called, based on the caller and message type that was passed. The lines in the Router.properties file use this format:

CallerID_MesageType=PackageAndClassToLoad_MethodToCall





For example:

SomeSystem_ShipmentOrder=com.ssaglobal.scm.wms.api.util. WM40TransactionServiceInterface

In the example shown above, a system called SomeSystem is calling the router with a ShipmentOrder message. The WM40TransactionServiceInterface is loaded and its process() method is called.

The method called must always take four string parameters:

• CallerID • MessageType • Action • XMLMessage

On both sides of the lookup, the components are separated from each other by an underscore (_). A fully declared package name is required for the class you want to load.

The Router.properties files contain entries for all available API types.

5BSocketListener The SocketListener class listens for a TCP socket connection and passes it off to a class specified in the SocketListener.properties file. Each connection received generates a new thread. The listener resumes listening for a new connection on the designated port. The class specified to handle the connection must extend the thread and have a constructor that accepts a connection.

Note: Prior to 10.1 this listener was used to communicate with Voice Picking. That functionality is now under the application Socket Server.

The SocketListener.properties file contains the following entries:

Entry Description

MessageProcessor Package and class name that handles the connection.

ListenPort Port number identifying where the listener waits for a connection.

LoggerSettings Pointer that identifies the log4j logger settings properties file.

6BXSLTransform (XSLT) The XSL Transform class accepts an XML message and applies an XSLT to it. It can accept either a socket connection or a direct call. When you use the socket, either the source or the destination message must contain <MessageType> and <Action> tags, and can also have a <CallingObject>



tag. The CallingObject defaults to XSLTransform if it is not sent. The MessageType and Action fields are required as parameters, or as tags in the XML with a null value triggering the CallingObject default. The XSLT sheet you use is determined by a combination of the CallingObject, MessageType, and Action values. This class calls com.ssa.common.util.Router to pass the message, and checks for a response before returning the result.

The XSLTransform.properties file contains the following entries:

Entry Description

CallingObject_MessageType_ Action_XSLTFile

Entry that specifies the full path and filename of the XSLT sheet to use based on the CallingObject, MessageType, and Action sent. If an entry cannot be found, another attempt is made without the Action parameter. If the entry still cannot be found, no transformation is done and the message is passed on as it was received.

CallingObject_MessageType_ Action_Response_XSLTFile

Identical to the first entry, except it is applied to the response message received from the Router.

LoggerSettings POINTER that identifies the log4j logger settings properties file.

7BWM4000APIProcessor The WM4000APIProcessor class passes inbound messages to the Router and takes the same four parameters that the Router requires. If a message comes back but is not in XML format, which happens only in certain error scenarios, this class wraps that message in the appropriate XML structure.

The WM4000APIProcessor.properties file contains only one entry:

Entry Description


WM40TransactionServiceInterface The WM40TransactionServiceInterface class is used to make a remote request to the Infor WMS application over RMI. Any errors returned from application are in XML format. However, this class can return an exception that is not in XML format if it is unable to communicate with the correct class in the application. Use the WM4000APIProcessor class to ensure that all return values are properly enclosed in XML.

The WM40TransactionServiceInterface.properties file contains the following entries:



Entry Description

userName Name sent to the application with each message that identifies the user.

messageType_MessageType Entry identifying the type of API that needs to be called based on the message type sent.

For example:

ShipmentOrder_MessageType=ShipmentOrderAPI

The _MessageType is a hard-coded string that must be appended to the end of each message type. It serves no functional role, but it makes the file easier to read. The API name must be specified in the sproceeduremap table. The application attempts to locate this value after it receives the socket request.

9BEXceedSocketInterface The EXceedSocketInterface class is used to build the string sent to older versions of the WM Module over the socket and should not be used with more recent WM Module versions. Any errors returned from the application are in XML format. However, this class can return an exception that is not in XML format if it is unable to communicate with the correct class in the application. Use the WM4000APIProcessor class to ensure that all return values are properly enclosed in XML.

The EXceedSocketInterface.properties file contains the following entries:

Entry Description

userName Name sent to the WM Module with each message that identifies the user.

logName Name sent to the WM Module when the user logs in to the system.

password Password sent to the WM Module when the user logs in to the system.

dbString Default reference to the database and schema used when the user logs in to the system.

serverName Name of the server running the WM Module.

pbPort Location where the WM Module server is listening.

messageType_MessageType Entry identifying the type of API that needs to be called based on the message type sent.



Entry Description

serverName_dbString Same as the serverName entry with a dbString concatenated. If the recipient system id passed in the message matches the dbString, this entry is used for the server name. This allows one API install to communicate with multiple WM installs.

pbPort_dbString Same as the pbPort entry with a dbString concatenated. If the recipient system id passed in the message matches the dbString, this entry is used for the port. This allows one API install to communicate with multiple WM installs.

For example:

ShipmentOrder_MessageType=ShipmentOrderAPI

The _MessageType is a hard-coded string that must be appended to the end of each message type. It serves no functional role, but it makes the file easier to read. The API name must be specified in the sproceeduremap table. The application attempts to locate this value after it receives the socket request.

DelimitedToXML (Voice only) The DelimitedToXML class takes voice input in a delimited form (usually a comma) and converts it into the application XML API format. After it is processed by the application Voice APIs, the XML data is transformed back to the original delimited format.

Note: Prior to 10.1 this listener was used to communicate with Voice Picking. That functionality is now under the application Socket Server.

The DelimitedToXML.properties file contains the following entries:

Entry Description

Delimiter Set this to a comma for voice.

Function1_FieldList List the fields in the sequence they are to come in the delimited message. These values are the tag names used in building the XML message for the API.

Function1_MessageType Used by the router to find the correct API class to call. For voice, it is always Voice, except when it is set to None for transactions that do not need to go to the back-end APIs.

Function1_BusinessObject For voice, this is always set to MessageProcessor.

Function1_Action API method name to be called.



Entry Description

Function1_Recipient Recipient system ID, which should be a db connection string, such as PRD1_WH1.

Function1_Sender Always set to Voice because all messages originate from Voice.

Function1_ResponseFields Fields that you want to retrieve from an API call. They should always be in capital letters because Oracle automatically capitalizes column names in selects. If the fields are not capitalized, it is likely that the API cannot find the value to return in the delimited form.

Function1_ObjectTag Always set to Voice.

Function1_HeaderTag Always set to VoiceHeader.


All fields that start with Function1 must be duplicated for each voice transaction type.

For example, the picked transaction would look like this:

prTaskLUTCoreSignOff_FieldList=DateAndTime,TerminalSerial

Number,Operator

prTaskLUTCoreSignOff_MessageType=Voice

prTaskLUTCoreSignOff_BusinessObject=MessageProcessor

prTaskLUTCoreSignOff_Action=signOff

prTaskLUTCoreSignOff_Recipient=PRD310_WH1

prTaskLUTCoreSignOff_Sender=Voice

prTaskLUTCoreSignOff_ResponseFields=ERRORCODE,

VOICEMSG

prTaskLUTCoreSignOff_ObjectTag=Voice

prTaskLUTCoreSignOff_HeaderTag=VoiceHeader


Chapter 2 API Details 2

This chapter describes the basic structure of all API’s used with WM and gives specific information about each API.

About API details All APIs share the same basic XML structure. This structure consists of the following sections:

• Header • Body • Object sections within the Body section.

For example:

<Message>

<Head>

<MessageID/>

<Date/>

<MessageType/>

<Action/>

<Sender>

<SystemID>External</SystemID>

<CompanyID/>

<ReplyToQ/>

<User/>

<Password/>

</Sender>

<Recipient>

<SystemID>WMPRD_wmwhse1</SystemID>

<CompanyID/>

<ReplyToQ/>

</Recipient>

API Details


</Head>

<Body>

<Object>

<ObjectHeader>

<ObjectDetail/>

</ObjectHeader>

</Object>

</Body>

</Message>

API structure overview

<Head> In the <Head> section, the only required field is the SystemID for the recipient. This must be either Enterprise (for Oracle case should match the enterprise entry in the pl_db table), for certain setup APIs that cross the entire enterprise, or the db_warehouse string of the warehouse to which you are connecting.

If API authentication has been turned on in the WM System Settings screen, the <Sender><User/><Password/></Sender> tags will need to be sent in addition to any other <Head> fields. The flag is off by default.

<Body> In the <Body> section, the <Object> and <ObjectHeader> sections are required for all messages. Although some can have various <Object> sections, many also require the <ObjectDetail>.

<MessageType> and <Action> The <MessageType> and <Action> tags might be required by certain external applications to route the message to the appropriate API. In this case, the <MessageType> must be the API name, such as PurchaseOrder, and the <Action> must be the method you are calling.

API Details


Authentication By default API callas are not authenticated. If you have a need to authenticate your API calls, turn on the system setting AUTHENTICATEAPIS. This setting will require that a valid user and password be sent in the XML message header sender section.

Example:

<Message>

<Head>

<Sender>

<SystemID>mySystem</SystemID>

<User>myUser</User>

<Password>myPassword</Password>

…

Authentication uses the OA authentication service, so any user that will pass that validation will be fine.

Note: If you turn on API authentication then ALL API calls will require authentication, including ESB calls using ION or direct TM messages. There is no way to turn authentication on for some calls but not others.

XML overview A key does not need to be passed when you create a new record using the APIs; however, if a key is passed it is used. Otherwise, a key is created internally by the WM Module.

For updates, deletes, and special actions, such as receive ship, and so on, keys are required. Except for updates, other fields are ignored. For example, if an update is made, the fields that are passed are updated, while other fields are left alone.

If the Sender.SystemId supplied in the XML is EXceed, the key must be the Infor WMS Internal Key. Otherwise, the external key for that transaction is used.

The Recipient.SystemId field tells the API which WM Module instance is intended for the message. A value of Enterprise tells the API to apply the message to all instances, which is done when you use the front-end and sign in to the Enterprise instance. Any other value tells the API to apply the message solely to the instance name specified in the field.

Lists require a header block, although all fields within it are optional. An empty header returns all available records. Any field supplied is used as a select constraint. Details associated with the requested header are returned.

API Details


Constraints cannot be specified for details. A call to store automatically determines whether the record exists, and performs an insert or update as appropriate.

When sending data to be stored in the WM Module, transactions are generally maintained at the <Object> tag level. This means if you send several <ShipmentOrderHeader> tags within a single <ShipmentOrder> tag, they will be inserted within the same transaction. If you create a separate <ShipmentOrder> tag for each <ShipmentOrderHeader>, you will have separate transactions. Avoid sending too many documents within a single message, and avoid grouping documents within a single transaction unless necessary. Creating large transactions or sending too many documents within a single message can have a negative impact on API performance.

Export interface The Business Object APIs have been enhanced with the ExportInterface API. The ExportInterface API allows events generated by the WM Module to be retrieved. This interface functions identically to the other APIs, sending a request message to the interface for which it receives a response. The request, by default, returns only new events and marks those events as processed. However, if a date range is specified, the interface returns all requested events from that range, regardless of their state, and does not mark them as Processed.

The XSDs for the request is included with this release. The event responses can be modified in structure and content by modifying the XML file associated with that event in the WM Module Events/Messages sub-folder, and are turned on or off in the eventcfg.ini file in the events folder.

API descriptions XSDs are available for each API on Infor’s Sharepoint site under the release documents folder. If you do not have access, ask your Project Manager for the documents. The naming convention for the XSDs is ObjectName-Method.xsd.

For example, the XSD for the Store method for an ASN is:

AdvancedShipNoticeAPI-store.xsd

Specific API descriptions follow.

API Details


Adjustment

Method Description

Store Creates an adjustment based on an inbound argument Infor XML format message. Includes validation of all adjustment fields, and defaults of required fields not supplied.

List Returns existing adjustments via an XML document based on search criteria passed in as arguments.

AdvancedShipNotice

Method Description

Store Creates or updates an ASN based on an inbound argument Infor XML format message. Updates can occur on existing ASNs that are not in a Closed status. Includes validation of all ASN fields, and defaults of required fields not supplied.

Delete Allows you to delete existing ASNs without received quantities, based on an inbound argument Infor XML format message.

List Returns existing ASNs via an XML document based on search criteria passed in as arguments.

Replace Updates certain values on the ASN to simulate a delete followed by a store.

Area

Method Description

Store Creates an area based on an inbound argument Infor XML format message. Includes validation of all area fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing area, based on an inbound argument Infor XML format message.

List Returns existing areas via an XML document based on search criteria passed in as arguments.

API Details


Associate

Method Description

Store Creates or updates a task manager user based on an inbound argument Infor XML format message. Includes validation of all task manager user fields, and defaults of required fields not supplied.

Delete Allows you to delete existing task manager users, based on an inbound argument Infor XML format message.

List Returns existing task manager users via an XML document based on search criteria passed in as arguments.

BatchSelectionCriteria

Method Description

Store Creates or updates the criteria for batch selection used during wave planning based on an inbound argument Infor XML format message. Includes validation of all batch selection fields, and defaults of required fields not supplied.

Delete Allows you to delete existing batch selection criteria, based on an inbound argument Infor XML format message.

List Returns existing batch selection criteria via an XML document based on search criteria passed in as arguments.

BODListAPI

Method Description

inspectDeliveryList Creates a list of inspect delivery records used to build an Infor BOD message

inventoryAdjustmentList Creates a list of inventory adjustment records used to build an Infor BOD message

inventoryHoldList Creates a list of inventory hold records used to build an Infor BOD message

receiveDeliveryList Creates a list of receive delivery records used to build an Infor BOD message

showAdvanceShipNoticeList Creates a list of ASN records used to build an Infor BOD message

API Details


Method Description

showPickList Creates a list of pick list records used to build an Infor BOD message

showShipmentOrderList Creates a list of shipment order records used to build an Infor BOD message

Carrier

Method Description

Store Creates or updates the storer record where the type is Carrier based on an inbound argument Infor XML format message. Includes validation of all carrier fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing carrier, based on an inbound argument Infor XML format message.

List Returns existing storer records of type carrier via an XML document based on search criteria passed in as arguments.

CatchWeight

Method Description

Store Creates or updates catch data information normally captured during the receiving and shipping process based on an inbound argument Infor XML format message. Includes validation of all catchweight fields, and defaults of required fields not supplied.

List Returns existing catch data records via an XML document based on search criteria passed in as arguments.

CodeList

Method Description

Store Creates or updates the codelkup record based on an inbound argument Infor XML format message.

API Details


List Returns existing codelkup records via an XML document based on search criteria passed in as arguments.

Customer

Method Description

Store Creates or updates the storer record where the type is Consignee based on an inbound argument Infor XML format message. Includes validation of all customer fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing customer, based on an inbound argument Infor XML format message.

List Returns existing storer records via an XML document based on search criteria passed in as arguments.

CycleCount

Method Description

Store Creates a new cycle count based on an inbound argument Infor XML format message. Includes validation of all cycle count fields, and defaults of required fields not supplied.

Release Allows you to create cycle count tasks based on existing cycle count generation settings, and requests to count.

DemandAllocation

Method Description

Search Returns existing demand allocation records via an XML document based on a criteria range passed in as arguments. Search has a beginning and ending value for each argument. If the beginning is not supplied, it returns all rows equal to or less than the ending value. If the ending value is not supplied, it returns all rows equal to or greater than the beginning value. If both are supplied, it returns all rows equal to or greater than the beginning value, and equal to or less than the ending value.

API Details


Equipment

Method Description

Store Creates or updates an equipment profile based on an inbound argument Infor XML format message. Includes validation of all equipment profile fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing equipment profile based on an inbound argument Infor XML format message.

List Returns existing equipment profile records via an XML document based on search criteria passed in as arguments.

ErpLot

Method Description

getErpLot Determines how the ERP lot is stored for an item for outgoing messages.

getStorageType Determines how the ERP lot is stored for an item for incoming messages.

ExportInterface

Method Description

ExportEvent Exports transmitlog event records via an XML document based on criteria passed in as arguments.

UpdateStatus Allows you to flag a message as an error, or to implement a two-step commit (update to 5 on retrieval, 9 after processing).

Facility

Method Description

List Returns existing multi-facility setup records via an XML document based on search criteria passed in as arguments.

API Details


FacilityTransfer

Method Description

List Returns existing facility transfer records via an XML document based on search criteria passed in as arguments.

FlowThruOrder

Method Description

Store Creates or updates a flowthru shipment order based on an inbound argument infor XML format message. Updates are allowed for flowthru shipment orders not in a Shipped status. Includes validation of all fields, and defaulting of required fields not supplied.

Delete Allows you to delete existing flowthru shipment orders that are not in a Shipped status, based on an inbound argument Infor XML format message.

List Returns an XML document based on search criteria passed in as arguments.

Inventory

Method Description

List Returns existing lotxlocxid inventory records via an XML document based on search criteria passed in as arguments.

Search Returns existing lotxlocxid inventory records via an XML document based on a criteria range passed in as arguments. Search has a beginning and ending value for each argument. If the beginning is not supplied, it returns all rows equal to or less than the ending value. If the ending value is not supplied, it returns all rows equal to or greater than the beginning value. If both are supplied, it returns all rows equal to or greater than the beginning value, and equal to or less than the ending value.

Move Allows inventory to be moved from one location or ID to another, based on an inbound argument Infor XML format message.

Reclassify Creates and finalizes a new transfer based on an inbound argument Infor XML format message. Includes validation of all transfer fields, and defaults of required fields not supplied.

API Details


Method Description

Adjustment Creates an adjustment based on an inbound argument Infor XML format message. Includes validation of all adjustment fields, and defaults of required fields not supplied.

GetBalances Returns multi-facility inventory balances.

HoldList Returns a list of hold records.

InventoryBalance

Method Description

List Returns existing lotxlocxid inventory records via an XML document based on search criteria passed in as arguments.

ListBySku Returns the inventory balances by Sku.

ShowInventoryBalance Returns the inventory balances with only the fields needed to create an Infor BOD.

ShowInventoryCount Returns the inventory balances with only the fields needed to create an Infor BOD.

Note: This is a special-case XML. Make note of the fields, since they do not directly match the table field names. Refer to the InventoryBalance/List.dtd on your installation CD.

ItemID

Method Description

store Creates a cross reference between the WM Sku and the Infor enterprise ItemID

getStorerSku Gets the Storer/Sku combination for an ItemID

getItemId Gets the ItemID for a Storer/Sku combination

getNonStockStorerSku Gets non-stocked items.

insertNonStockStorerSku Creates a non-stocked item.

API Details


ItemMaster

Method Description

Store Creates or updates SKU, alternate SKU, substitute SKU, and bill of material for a SKU, based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

Delete Allows you to delete existing SKUs, alternate SKUs, substitute SKUs, or bill of materials for a SKU based on an inbound argument Infor XML format message. Only SKUs with zero-balance quantities can be deleted.

List Returns existing SKUs, alternate SKUs, substitute SKUs, and bill of materials for a SKU via an XML document, based on search criteria passed in as arguments.

Store Line Creates or updates an alternate SKU based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

Find Reserve BOH Returns the inventory BOH in reserve locations based on an inbound argument Infor XML format message. This includes all location types except Pick, Case, and Flow.

Find Selection BOH Returns the inventory BOH in selection locations based on an inbound argument Infor XML format message. This includes only Pick location types.

Find Case BOH Returns the inventory BOH in case locations based on an inbound argument Infor XML format message. This includes only Case location types.

Find Flowthru BOH Returns the inventory BOH in flow locations based on an inbound argument Infor XML format message. This includes only Flow location types.

Find Total BOH Returns the total inventory BOH based on an inbound argument Infor XML format message. This includes all locations in the warehouse.

Find Substitute SKU Returns existing substitute SKUs via an XML document based on search criteria passed in as arguments.

Request Count Creates a request to count records for the SKU based on an inbound argument Infor XML format message.

Remove Count Request Deletes a request to count records for the SKU based on an inbound argument Infor XML format message.

Get SKU Alias Returns existing alternate SKUs via an XML document based on search criteria passed in as arguments.

API Details


Method Description

Store SKU Alias Creates or updates an alternate SKU based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

Remove SKU Alias Allows you to delete existing alternate SKUs based on an inbound argument Infor XML format message.

Get SKU Location Returns all locations assigned to the SKU based on an inbound argument Infor XML format message.

Store SKU Location Creates a new, or updates an existing location assignment for the SKU based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

Remove SKU Location Allows you to delete an existing location assignment for the SKU, based on an inbound argument Infor XML format message.

ITRN

Method Description

List Returns all inventory transaction records based on an inbound argument Infor XML format message.

Load

Method Description

Store Creates or updates a load based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

List Returns all load records based on an inbound argument Infor XML format message.

Replace Emulates a delete followed by an insert, but only for fields used by Infor ION.

API Details


Location

Method Description

Store Creates or updates a location based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

List Returns all location records based on an inbound argument Infor XML format message.

Delete Allows you to delete existing locations based on an inbound argument Infor XML format message. Only locations with zero-balance quantities can be deleted.

Hold Creates an inventory hold record for the location with the hold flag On, or updates the hold flag to On for an existing inventory hold record, based on an inbound argument Infor XML format message.

Release Hold Updates the hold flag to Off for an existing inventory hold record for the location, based on an inbound argument Infor XML format message.

Request Count Creates a request to count record for the location based on an inbound argument Infor XML format message.

Remove Count Request Allows you to delete a request to count record for the location based on an inbound argument Infor XML format message.

Lot

Method Description

List Returns lot records based on an inbound argument Infor XML format message.

Hold Creates an inventory hold record for the lot with the hold flag On, or updates the hold flag to On for an existing inventory hold record, based on an inbound argument Infor XML format message.

Release Hold Updates the hold flag to Off for an existing inventory hold record for the lot, based on an inbound argument Infor XML format message.

Get Hold Reasons Returns an inventory hold record for each reason the lot is placed in a Hold status, based on an inbound argument Infor XML format message.

Synchronize This is only used for the Baan interface. Refer to the Baan Interface functional specification for more detail.

API Details


Method Description

Lot Request Adds or removes holds based on positive or negative quantities.

MasterBillOfLading

Method Description

Store Creates or updates a master bill of lading based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

List Returns master bill of lading records based on an inbound argument Infor XML format message.

Delete Allows you to delete existing master bill of lading records based on an inbound argument Infor XML format message.

MovableUnit

Method Description

List Returns ID records based on an inbound argument Infor XML format message.

Search Returns existing ID records via an XML document based on a criteria range passed in as arguments. Search has a beginning and ending value for each argument. If the beginning is not supplied, it returns all rows equal to or less than the ending value. If the ending value is not supplied, it returns all rows equal to or greater than the beginning value. If both are supplied, it returns all rows equal to or greater than the beginning value, and equal to or less than the ending value.

Hold Creates an inventory hold record for the ID with the hold flag On, or updates the hold flag to On for an existing inventory hold record, based on an inbound argument Infor XML format message.

Release Hold Updates the hold flag to Off for an existing inventory hold record for the ID, based on an inbound argument Infor XML format message.

Get Hold Reasons Returns an inventory hold record for each reason the ID is placed in a hold status, based on an inbound argument Infor XML format message.

API Details


OutboundID

Method Description

Store Allows for updates to existing Drop IDs not in a Shipped status, based on an inbound argument Infor XML format message.

List Returns Drop ID records based on an inbound argument Infor XML format message.

Delete Allows you to delete existing Drop IDs not in a Shipped status, based on an inbound argument Infor XML format message.

Ship Ships the Drop ID and all details based on an inbound argument Infor XML format message.

Remove Allows you to delete existing Drop IDs not in a Shipped status, based on an inbound argument Infor XML format message.

Remove Line Allows you to delete existing Drop ID details not in a Shipped status, based on an inbound argument Infor XML format message.

Owner

Method Description

Store Creates or updates the storer record, where the type is Storer based on an inbound argument Infor XML format message. Includes validation of all owner fields, and defaults of required fields not supplied.

Delete Allows you to delete existing storer records based on an inbound argument Infor XML format message.

List Returns existing storer records of type Storer via an XML document based on search criteria passed in as arguments.

Pack

Method Description

Store Creates or updates a pack record based on an inbound argument Infor XML format message. Includes validation of all pack fields, and defaults of required fields not supplied.

Delete Allows you to delete existing pack records based on an inbound argument Infor XML format message.

API Details


Method Description

List Returns existing pack records via an XML document based on search criteria passed in as arguments.

Remove Allows you to delete existing pack records based on an inbound argument Infor XML format message.

PurchaseOrder

Method Description

Store Creates or updates a purchase order record based on an inbound argument Infor XML format message. Includes validation of all purchase order fields, and defaults of required fields not supplied. Allows you to update existing purchase orders that have not been placed in a Closed status.

Delete Allows you to delete existing purchase orders without received quantities based on an inbound argument Infor XML format message.

List Returns a list of existing purchase orders via an XML document based on search criteria passed in as arguments.

Cancel Updates a purchase order status to Canceled.

Remove Allows you to delete existing purchase orders without received quantities based on an inbound argument Infor XML format message.

Remove Line Allows you to delete existing purchase order lines without received quantities based on an inbound argument Infor XML format message.

PutawayZone

Method Description

Store Creates or updates a putaway zone record based on an inbound argument Infor XML format message. Includes validation of all putaway zone fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing putaway zone based on an inbound argument Infor XML format message.

List Returns a list of existing putaway zones via an XML document based on search criteria passed in as arguments.

API Details


Receipt

Method Description

Store Creates or updates an Advanced Ship Notice (ASN) based on an inbound argument Infor XML format message. Updates can occur on existing ASNs not in a Closed status. Includes validation of all ASN fields, and defaults of required fields not supplied.

Remove Allows you to delete existing ASNs without received quantities based on an inbound argument Infor XML format message.

List Returns existing ASNs via an XML document based on search criteria passed in as arguments.

Receipt Reversal Changes all the Received quantities on a receipt to Not Received, based on an inbound argument Infor XML format message.

Receive All Receives all the lines on a receipt for the expected quantities, based on an inbound argument Infor XML format message.

ReceivedInventory

Method Description

Store Creates or updates receipt detail lines based on an inbound argument Infor XML format message. Updates can occur on existing receipt detail lines that have not been received. A receipt detail line that has been received can have the expected quantity increased, but no other changes are allowed. Includes validation of all receipt detail fields, and defaults of required fields not supplied.

Remove Allows you to delete existing receipt detail lines without received quantities, based on an inbound argument Infor XML format message.

List Returns existing receipt detail lines via an XML document based on search criteria passed in as arguments.

Report

Method Description

AssistedPickTicket Generates an assisted pick ticket report

DirectedPickTicket Generated a directed pick ticket report

PickList Generates a pick list report

API Details


Method Description

PackSlip Generates a packing slip report

CommercialInvoice Generates a commercial invoice

CatchweightDataList Generates a catchweight data report

CatchweightDataPackSlip Generates a catchweight packing slip report

Section

Method Description

Store Creates or updates a section based on an inbound argument Infor XML format message. Includes validation of all ASN fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing section based on an inbound argument Infor XML format message.

List Returns existing sections via an XML document based on search criteria passed in as arguments.

Remove Allows you to delete an existing section based on an inbound argument Infor XML format message.

SelectionZone

Method Description




API Details


SerialNumber

Method Description

GetSerialNumber Returns the SerialNumber lot for an outgoing message.

GetStorageType Determines how the SerialNumber is stored for an item for incoming messages.

ShipmentOrder

Method Description

Store Creates or update a shipment order based on an inbound argument Infor XML format message. Allows you to update existing shipment orders not in a Shipped status. Includes validation of all shipment order fields, and defaults of required fields not supplied.

Delete Allows you to delete existing shipment orders not in a Shipped status, based on an inbound argument Infor XML format message.

Allocate Allocates a single shipment order using the defined Order Detail SKU allocation strategies. Takes a single order key as an inbound argument Infor XML format message.

Unallocate Un-allocates a single shipment order. Takes a single order key as an inbound argument Infor XML format message.

Ship Ships a single shipment order. Takes a single order key as an inbound argument Infor XML format message.

List Returns existing shipment orders via an XML document based on search criteria passed in as arguments.

Cancel Sets the order status to cancel.

Hold Places the order in a hold state to prevent allocation and shipping.

Replace Updates the order to simulate a delete followed by a store.

PrintCaseLabels Prints case labels for the order.

Release Releases the order.

RFIDShip Ships a case, intended for use with RFID.

RFIDShipByCaseID Ships a case, intended for use with RFID.

RFIDShipByDropID Ships a drop ID, intended for use with RFID.

API Details


Method Description

StorePick Updates a pick.

StoreVAS Updates a VAS.

UpdateOrdersOnWave Updates orders on a wave with route and stop information.

SortationStation

Method Description

Store Creates or updates a sortation station based on an inbound argument Infor XML format message. Includes validation of all sortation station fields, and defaults of required fields not supplied.

Delete Allows you to delete an existing sortation station based on an inbound argument Infor XML format message.

List Returns existing sortation stations via an XML document based on search criteria passed in as arguments.

Get Available Tasks Gets tasks associated with sortation stations.

Storer

Method Description

Store Creates or updates the storer record based on an inbound argument Infor XML format message. Includes validation of all owner fields, and defaults of required fields not supplied.

Delete Allows you to delete existing storer records based on an inbound argument Infor XML format message.

List Returns existing storer records via an XML document based on search criteria passed in as arguments.

API Details


SubstituteSku

Method Description

Store Creates or updates a substitute SKU record based on an inbound argument Infor XML format message. Includes validation of all substitute SKU fields, and defaults of required fields not supplied.

Delete Allows you to delete existing substitute SKU records based on an inbound argument Infor XML format message.

List Returns existing substitute SKU records via an XML document based on search criteria passed in as arguments.

Supplier

Method Description

Store Creates or updates the storer record where the type is Supplier, based on an inbound argument Infor XML format message. Includes validation of all supplier fields, and defaults of required fields not supplied.

Delete Allows you to delete existing storer records of type Supplier, based on an inbound argument Infor XML format message.

List Returns existing storer records of type Supplier via an XML document based on search criteria passed in as arguments.

Task

Method Description

Store Creates or updates the task record based on an inbound argument Infor XML format message. Allows you to update existing tasks not in a Completed status. Includes validation of all task fields, and defaults of required fields not supplied.

Delete Allows you to delete existing task records not in a Completed status, based on an inbound argument Infor XML format message.

List Returns existing task records via an XML document based on search criteria passed in as arguments.

API Details


Method Description

Reassign Allows an uncompleted task to be assigned or reassigned to a different user, based on an inbound argument Infor XML format message.

PrintLabel Prints a label for the specified task.

ChangePriority Changes a task priority.

ChangeStatus Updates a task status.

TaskManagerUser

Method Description

Store Creates or updates the task manager user record based on an inbound argument Infor XML format message.

Delete Allows you to delete existing task manager user records, based on an inbound argument Infor XML format message.

List Returns existing task manager user records via an XML document based on search criteria passed in as arguments.

TaskReason

Method Description

Store Creates or updates the task manager reason record based on an inbound argument Infor XML format message. Includes validation of all task manager reason fields, and defaults of required fields not supplied.

Delete Allows you to delete existing task manager reason records, based on an inbound argument Infor XML format message.

List Returns existing task manager reason records via an XML document based on search criteria passed in as arguments.

API Details


Transfer

Method Description

Store Creates or updates transfer based on an inbound argument Infor XML format message. A transfer line cannot be updated once it has been finalized. Includes validation of all transfer fields, and defaults of required fields not supplied.

List Returns existing internal transfer records via an XML document based on search criteria passed in as arguments.

Finalize Finalizes a single internal transfer. Takes a single transfer key as an inbound argument Infor XML format message.

TransShipASN

Method Description

Store Creates a new transship ASN based on an inbound argument Infor XML format message. Allows you to update existing transship ASNs not in a Received status. Includes validation of all fields, and defaults of required fields not supplied.

Delete Allows you to delete existing transship ASNs without received quantities, based on an inbound argument Infor XML format message.

List Returns existing transship ASNs via an XML document based on search criteria passed in as arguments.

TransShipOrder

Method Description

Store Creates a new transship shipment order based on an inbound argument Infor XML format message. Allows for updates to existing transship shipment orders not in a Shipped status. Includes validation of all fields, and defaults of required fields not supplied.

Delete Allows for deletion of existing transship shipment orders not in a Shipped status based on an inbound argument Infor XML format message.

List Returns existing transship shipment orders via an XML document based on search criteria passed in as arguments.

API Details


UserDataTranslation

Method Description

Store Creates or updates translation data.

Delete Removes translation data.

Remove Removes translation data.

List Retrieves translation data.

Voice

Method Description

SignOn Signs a voice user in.

SignOff Signs a voice user out.

ValidVehicleTypes Lists the valid vehicle types for the user (not implemented, all types returned).

ValidFunctions Lists the valid functions for the user (not implemented, all functions returned).

PermForWorkType Determines if the user has permission for a work type.

PickingRegion Gets the picking region for the area passed.

RequestWork Requests work units for the user.

GetAssignment Gets assignment records based on passed criteria.

GetPicks Returns task details for an assignment.

UpdateStatus Updates task details to the status provided.

Picked Marks a task detail as picked or short.

VariableWeights Stores weight data in the LotxIDDetail table.

OptionalData Return the data from LOTxIDHEADER and LOTxIDDETAIL tables

StopAssignment This completes the assignment and update the assignment status

Configuration Returns the Configuration information.

ContainerTracking Validates the Container Information

DropId Validates the DropID received.

checkAndReturnToLocInfo Task Management Picking - Check if TO ID already exists.

API Details


VoiceTaskManager

Method Description

Configuration Gets configuration information.

ConfirmCatchWeightsForPickTask Verifies permission for task.

ConfirmDynamicPickByOrder Verifies permission for task.

ConfirmPickTask Verifies permission for task.

ConfirmPutawayTask Verifies permission for task.

ConfirmReplenishmentTask Verifies permission for task.

ConfirmSerialsForPickTask Verifies permission for task.

GetAllTasks Gets a task.

GetDynamicPickByContainerId Gets a task.

GetDynamicPickByOrder Gets a task.

GetPutawayTasksByLPN Gets a task.

RequestTMRegions Gets user permissions for areas.

SkipCurrentTMTask Skips a task.

UpdateTaskStatus Updates task status.

ValidateAndConfirmTMDynamicPickTask Verifies permission for task.

Wave

Method Description

Store Creates or update a wave based on an inbound argument Infor XML format message. Includes validation of all fields, and defaults of required fields not supplied.

Delete Allows you to delete existing waves that have not been shipped, based on an inbound argument Infor XML format message. If a wave is partially shipped, you can delete the lines that have not been shipped.

List Returns existing waves via an XML document based on search criteria passed in as arguments.

Get Batch Details Returns the batch information for each order on the wave that has been batched. Takes a single wave key as an inbound argument Infor XML format message.

API Details


Method Description

Release Releases a single wave, which allows tasks to be created. Takes a single wave key as an inbound argument Infor XML format message.

Ship Wave Ships all orders on a single wave. Takes a single wave key as an inbound argument Infor XML format message. Shipping is not allowed if the wave has tasks that have not been completed, or unsorted picks that have not been completed from batch picking.

Ship Orders Ships all orders on a single wave. Takes a single wave key as an inbound argument Infor XML format message. Does not check for outstanding tasks or unsorted picks.

Consolidate Allows waves that are not consolidated or batched, to be consolidated. Takes a single wave key as an inbound argument Infor XML format message.

Unconsolidate Wave Allows waves that have been consolidated to be unconsolidated. Takes a single wave key as an inbound argument Infor XML format message. A wave that has been allocated, released, or completed, cannot be unconsolidated.

Allocate Allocates all orders on a single wave. Takes a single wave key as an inbound argument Infor XML format message.

Batch Orders Allows waves to be batched. Takes a single wave key as an inbound argument Infor XML format message.

Unbatch Orders Allows waves that have been batched to be unbatched. Takes a single wave key as an inbound argument Infor XML format message. A wave that has been released or completed cannot be un-batched.

Search Orders For Build Wave Returns a list of orders based on an inbound argument Infor XML format message matching the wave order selection criteria.

Build Wave Adds an order, or a list of orders to the wave. Ideally, you should call the Search Orders for the Build Wave API, and then call the Build Wave API with the orders returned from the Search Orders for the Build Wave.

GetSelectionTasks Gets the selection tasks for a wave.

GetOderSummary Gets a list of orders for a wave.

PrintCaseLabels Prints case labels for a wave.

Preallocate Pre-allocates orders on a wave.

Unallocate Un-allocates orders on a wave.

API Details


Method Description

MassUpdateAll Updates all orders on the wave with route, stop, door, and stage.

ListSpeedLine Lists the available speed lanes.

GetNotStartedWave StatusDetails

Lists the orders that are not started on a wave.

GetPreAllocatedWave StatusDetails

Lists the orders that are pre-allocated on the wave.

GetAllocatedWave StatusDetails Lists the orders that are allocated on the wave.

GetPickedWave StatusDetails Lists the orders that are picked on the wave.

GetShippedWave StatusDetails Lists the orders that are shipped on the wave.

GetAllTotalsWave StatusDetails Lists totals for all orders on the wave.

GetProductionLocations ForConsolidation

Lists the SkuxLoc records for the wave.

ConfirmWave Completely rebuilds the wave to look like the XML passed in.

UpdateOrderInfo Updates an order on with route, stop, door, and stage.

GetSuspendedOrders CountForWave

Returns the number of suspended on the Wave.

Zone

Method Description





Chapter 3 Event Management 3

This chapter describes event handling within WM. The APIs described previously provide a means for external applications to make inbound requests of WM. Events provide a standardized outbound interface that allows WM to communicate with external applications.

Events architecture An WM event is a computer-generated response to a business event. A business event can be anything with a corresponding point in the WM code base, such as inventory events and document events.

• Inventory events

Inventory events are transactions that affect inventory levels within the application. Inventory events encompass deposits, withdrawals, moves, and adjustments.

• Document events

Document events represent changes to warehouse documents within the application. Document events can be described as creating a new purchase order, modifying an ASN, deleting a shipment order, and so on.

Inventory and Document events can be triggered by way of any technical media that the application is supporting, such as RF-handheld or fork-mount units, data entry from a client workstation, and transactions from an MHE system.

Event cycle The cycle of an event consists of these steps:

1 Posting

Posting means inserting a row into the TransmitLog table. The inserted row is an event text string that corresponds to the business event that triggered the call to the AddEvent function.

2 Scanning

Event Management


Scanning is the process of polling the TransmitLog table and looking for new rows that must be converted and published. For each new event the scanner finds, the appropriate converter is called. Users can configure the system to relate different event types to various converters and publishers.

3 Converting

Converting is the process of building a new data object based on the event type and category. The converter generates a well-formed XML message in response to each publishable business event.

4 Publishing

Publishing is the process of dispatching (transmitting) the converted event to its final destination. Transmission can mean transferring data to external processes such as a messaging queue, email program, paging system, or external database.

Event contents When a defined business event occurs, an event is created and posted to the TransmitLog table. The posted event is a data string that contains thses primary components:

• Event Type

The event type is a text string that describes the event. Each business event relates to a unique event type, which is named to reveal the specific activity that generated the event. For example, when a new purchase order is created, an event type is created called pocreated.

• Event Category

The event category is a text character that describes the type of output message that should be generated. There are three event categories:

• Category A (Alert) • Category E (Event) • Category M (Message)

Category Description Event Priority Event Outgoing XML Content

A Alert High The Alert category contains the notification and brief description of the business event. Although Alerts tend to be brief, they are intended to receive a high priority during processing.

E Event Medium An Event category usually contains a notification of the business event without any additional information.

Event Management


Category Description Event Priority Event Outgoing XML Content

M Message Low A Message category contains a notification of the business event, as well as an unrestricted amount of additional information. Although Messages tend to contain in-depth information, they are processed at a low priority.

Technically, there is no difference between an Alert, Event, or a Message. The WM code base handles the three categories identically. The individual converter and publisher impose any differences between these categories.

• Event Key

The event key is primarily associated to a business event in the application database. Each event is associated with a specific table and key. For example, the primary key associated to a newly created purchase order would be its PO number.

Events flow

XML converter The XML converter generates a well-formed XML message in response to each publishable business event requested from the ExportInterface API. The XML converter receives the event type, event category, and key as input. From these inputs, the converter builds a well-formed XML message that describes the business event as a Java object, and returns it to the caller.

Input template The input template defines the format of the XML output message. The input template specifies which information is included in the output message. The event type, event category, and the warehouse determine the input template that is used.

The default template can be used, or the users can set up warehouse-specific event configurations; however, different warehouses could have unique configurations for the same event. Any warehouse without a specific configuration for an event uses the default configuration, which all warehouses with a single Java environment share.

Event Management


Event configuration Through the Event Configuration files, WM enables you to configure events, messages, and alerts with a great deal of flexibility. The first of these, eventcfg.ini, allows you to configure the basic settings of the event scanner.

In addition, the individual message builder files, expressed in XML, allow the administrator flexibility in the data produced by WM events, messages, and alerts.

Eventcfg.ini Various aspects of the events lifecycle can be configured. Each WM server can be configured independently. The configuration information is located in the following directory in a file called EventCfg.ini.:

infor/sce/<SCHEMA>/wm/app/conf/Events/<warehouse>

[Scanner] section The scanner is obsolete and its configuration entries can be ignored. This section is retained in the configuration file for compatibility with older WM installations.

[Converter] section Default=WMSEvent, APIEventHandler

Default converter A default converter class must be designated. An object of this class is used to convert all event types not specifically associated with any other converter class (refer to Event-specific converters below).

Event-specific converters Some converter types can be associated with specific event types. Note, however, that converters cannot be configured based on category type. Therefore, the converter used to convert specific event types must be used to convert all categories of that type.

Event Management


[Publisher] section Default=WMSEvent,GenericEventHandler POCreated=CustomEvent, CustomFilePublisher

Default publisher A default publisher class must be specified. An object of this class is used to publish all event types not specifically associated with any other publisher class (refer to Event-specific publishers below).

Event-specific publishers Specific publisher classes can be associated with specific event types. Note, however, that publishers cannot be configured based on category type. Therefore, the publisher used to publish specific event types must be used to publish all categories of that type.

[Switches], [Messages], [Alerts] sections ----Low-level inventory events Deposit=FALSE Move=FALSE Adjustment=FALSE Withdrawal=FALSE ----Task events TaskCreated=FALSE TaskCompleted=FALSE …

Event Management


Posted events Users can specify which types and categories of events are posted. Each server writes to the TransmitLog based on its own configuration file. However, once an event is entered into the TransmitLog, any scanner can attempt to convert and publish the event, even if that server’s configuration has a specific type and category disabled.

Usage All integration partners should register the events they want to receive by making sure that the event is turned in the eventcfg.ini file, and the transmitflag used by that integration partner is set in the config.xml file (see Configuration).

Each integration partner must use a discreet transmitflag so that it can request the same events as other integrations without conflicting. The chosen flag must be passed in the <TransmitFlagToUse> tag. While the most common integrations always use the same flag, it should be set as a configuration entry by all integration partners in case a conflict does occur with another system.

When an event is created by the system, it checks the configuration files and sets the transmit flags listed for that event in the config.xml file to 0. Flags not specified remain null.

Once an event has been successfully extracted, the flag used by that integration is set to 9 to indicate that it no longer needs that record. At this point, an archiving process is started in a new thread (see Archiving). The system returns the message without waiting for the archiving process to finish.

Output format The structure and fields returned by any event is determined by the contents of the XML file with the same name as the event in the infor/sce/<SCHEMA>/wm/app/conf/Events/<warehouse> /messages folder where warehouse is replaced by the warehouse name, or default if the message is not in that folder. For example, the ordershipped event is controlled by the ordershipped.xml file.

In addition, the capitalization of the tags within a message is controlled by the infor/sce/<SCHEMA>/wm/app/conf/ApiTagNames.txt file. This file affects all integrations and should not be changed. Any change has the potential to break existing integrations. If a particular integration requires a custom structure or capitalization, that integration should take advantage of the APIs XSLT capabilities. This functionality allows an integration to apply XSL Transforms to both the inbound and outbound messages based on both the message type and action.

Event Management


Configuration The config.xml file has entries for each used event type with a pipe ( | ) delimited list of the transmitflag to be used. Flags specified in these entries are set to 0 when an event is created, while the other flags are null. This allows an easy visual determination of how many systems have requested the event, and how many still need the data.

The eventcfg.ini file has a list of each event for the type [Switches], [Messages], and [Alerts]. The switches correspond to events, the messages and alerts are as named. The events should be set to TRUE in the [Messages] sections for any event that needs to be exported.

[Messages] Global=FALSE ----Low-level inventory message Deposit=FALSE Move=FALSE Adjustment=TRUE Withdrawal=FALSE …

In addition to the TRUE/FALSE flag, a particular event can be set to to generate its message content at the time the event occurs. Normally, only the event trigger is written to the database when an event occurs, and the content is generated when requested. In the case of inventory count events, the data can change between the time the event is generated and the data is requested so the content must be generated at the time the event occurs.

All of the events that require their content to generate immediately are configured to do so by default. If you change the configuration to not generate the content immediately, this can result in sending incorrect data through the export processes. Setting additional event types to generate message content immediately can have a negative effect on performance and must be thoroughly tested under load before you put them into production.

To set an event to generate content immediately, add the eventType_GenMessageAtEvent=TRUE entry immediately after the eventType=TRUE entry. Example:

cyclecountposted=TRUE cyclecountposted_GenMessageAtEvent=TRUE

Event Management



Chapter 4 Message Handling 4

This chapter describes the structure of message builder files that allow the application developer or administrator to select the type of information the publisher sends to an external system.

Message builder files Different message builders are used depending on whether the output is a message, event, or alert. For example, the following shows a very simple event definition file:

<MessageBuilder Name="adjustment">

<Parameter>ItrnKey</Parameter>

<Column Column="ItrnKey" Output="on">AdjKey</Column>

</MessageBuilder>

Where the message builder file takes the data it is given, and repeats it as a message to the external system. However, the following message definition file gives details on the transaction and the product.

Note that the column called SkuKey serves as an input to the detail query, which obtains the product description from the SKU table.

<MessageBuilder Name="Adjustment">

<Parameter>ItrnKey</Parameter>

<Column Output="on">AdjustmentKey</Column>

<Column Type="number" Output="on">ItrnSysId</Column>

<Column Output="on">TranType</Column>

<Column Output="on">StorerKey</Column>

<Column Output="on">SkuKey</Column>

<Column Output="on">Lot</Column>

<Column Output="on">FromLoc</Column>

<Column Output="on">FromID</Column>

<Column Output="on">ToLoc</Column>

<Column Output="on">ToID</Column>

Message Handling


<SQL>

SELECT ItrnKey AS AdjustmentKey, ItrnSysID, TranType, StorerKey,

Sku AS SkuKey, Lot, FromLoc, FromID, ToLoc, ToID

FROM Itrn

WHERE Itrn.ItrnKey = :ItrnKey

</SQL>

<Query Name="Commodity" Output="on">

<Column Output="on">StorerKey</Column>

<Column Output="on">Sku</Column>

<Column Output="on">Descr</Column>

<SQL>

SELECT StorerKey, Sku, Descr

FROM sku

WHERE sku.sku = :SkuKey

</SQL>

</Query>

</MessageBuilder>

Message builder files can become quite complex. Developers should investigate as many of the examples in the server's events/messages directory as possible before attempting to develop new examples.


Appendix A Available Events A

A

Events shipped with the WM • ADJUSTMENT • ALLOCATED • ASNCANCELLED • ASNCANCELLED • ASNCLOSED • ASNCOMPLETED • ASNCREATED • ASNDELETED • ASNLINECREATED • ASNLINEDELETED • ASNLINEUPDATED • ASNTRANSPORTATIONREQUEST • ASNTRANSPORTATIONREQUEST • ASNUPDATED • ASNUPDATEDBEFORERECEIPT • ASNUPDATEDBEFORERECEIPT • ASNVERIFIED • CCINVENTORYDISCREPANCY • CODELKUPCREATED • CODELKUPDELETED • CODELKUPUPDATED • COMMODITYCREATED • COMMODITYDELETED • COMMODITYUPDATED • COMPONENTWITHDRAWAL • CUSTOMERORDERCANCELLED • CUSTOMERORDERCONVERTED • CUSTOMERORDERCREATED • CUSTOMERORDERDELETED

Available Events


• CUSTOMERORDERINPACKING • CUSTOMERORDERINPICKING • CUSTOMERORDERLINECANCELLED • CUSTOMERORDERLINECONVERTED • CUSTOMERORDERLINECREATED • CUSTOMERORDERLINEDELETED • CUSTOMERORDERLINEINPACKING • CUSTOMERORDERLINEINPICKING • CUSTOMERORDERLINELOADED • CUSTOMERORDERLINEPACKED • CUSTOMERORDERLINESTAGED • CUSTOMERORDERLINEUPDATED • CUSTOMERORDERLOADED • CUSTOMERORDERLOADED • CUSTOMERORDERPACKED • CUSTOMERORDERSTAGED • CUSTOMERORDERUPDATED • CUSTORDCONVERTEDTONRFID • CUSTORDCONVERTEDTORFID • CUSTORDERLINEQTYUPDATED • CYCLECOUNTINVENTORYADD • CYCLECOUNTPOSTED • DEPOSIT • EQUIPMENTPROFILECREATED • EQUIPMENTPROFILEDELETED • EQUIPMENTPROFILEUPDATED • EQUIPMENTUNITCREATED • EQUIPMENTUNITDELETED • EQUIPMENTUNITUPDATED • EXTERNALLOADCLOSED • FLOWTHRUORDERCANCELLED • FLOWTHRUORDERCONVERTED • FLOWTHRUORDERCREATED • FLOWTHRUORDERDELETED • FLOWTHRUORDERINPACKING • FLOWTHRUORDERINPICKING • FLOWTHRUORDERLINECANCELLED • FLOWTHRUORDERLINECONVERTED

Available Events


• FLOWTHRUORDERLINECREATED • FLOWTHRUORDERLINEDELETED • FLOWTHRUORDERLINEINPACKING • FLOWTHRUORDERLINEINPICKING • FLOWTHRUORDERLINELOADED • FLOWTHRUORDERLINEPACKED • FLOWTHRUORDERLINESHIPPED • FLOWTHRUORDERLINESTAGED • FLOWTHRUORDERLINEUPDATED • FLOWTHRUORDERLOADED • FLOWTHRUORDERPACKED • FLOWTHRUORDERPARTIALSHIPM • FLOWTHRUORDERSHIPPED • FLOWTHRUORDERSTAGED • FLOWTHRUORDERUPDATED • HOLDALLOCATEDPICK • HOLDBYID • HOLDBYLOC • HOLDBYLOT • HOLDBYSKU • HOLDMOVEDTOHELDLOC • HOLDRECEIVEDTOHELDLOC • HOLDREMOVEDALLOCATEDPICK • HOLDREMOVEDBYID • HOLDREMOVEDBYLOC • HOLDREMOVEDBYLOT • HOLDREMOVEDMOVEDFROMHELDLOC • HOLDREMOVEDPUTAWAYFROMHELDLOC • HOLDREMOVEDSHIPFROMHELDLOC • HOLDUNKONWN • IDPACKINGCOMPLETE • INBOUNDINSPECTIONCOMPLETED • INBOUNDINSPECTIONREQUPDATED • INTERNALLOADCLOSED • INVENTORYDELETED • INVENTORYHOLD • INVENTORYHOLD • INVENTORYUPDATED

Available Events


• LABORBILLINGAPPROVAL • LINEITEMSHIPPED • LOADCLOSED • LOADSHIPPED • LOADUPDATED • LOCATIONCREATED • LOCATIONDELETED • LOCATIONUPDATED • LOTREQUEST • MATERIALCHANGETOSHIPMENT • MOVE • ORDERALLOCATIONRUN • ORDERLINEINPROCESS • ORDERPACKINGCOMPLETE • ORDERPICKED • ORDERSHIPPED • PALLETBUILDINGDETAIL • PARTIALRECEIPT • PARTIALSHIPMENT • PHYINVENTORYDISCREPANCY • PHYSICALCOUNTPOSTED • PICKCOMPLETED • PICKCREATED • PICKSHIPPED • POCLOSED • POCOMPLETED • POCREATED • PODELETED • POLINECREATED • POLINEDELETED • POLINEUPDATED • POUPDATED • PRODUCTIONPICKSHIPPED • RECEIPTLINECOMPLETED • RECEIPTREVERSAL • RECEIVINGNOTICEATDOOR • RECEIVINGNOTICECHECKIN • RECEIVINGNOTICECHECKOUT

Available Events


• RECEIVINGNOTICECREATED • RECEIVINGNOTICEDELETED • RECEIVINGNOTICEENDUNLOAD • RECEIVINGNOTICESTARTUNLOA • RECEIVINGNOTICEUPDATED • RFIDCUSTOMERORDERCREATED • RFIDCUSTOMERORDERDELETED • RFIDCUSTORDERLINECREATED • RFIDCUSTORDERLINEDELETED • RFIDCUSTORDLINEQTYUPDATED • RFIDPALLETBUILDINGDETAIL • RFLOADCLOSEDCUSTOMERORDER • RMADOESNOTEXIST • SALESPICKSHIPPED • SHIPMENTSPLIT • SHIPPINGNOTICEATDOOR • SHIPPINGNOTICECHECKIN • SHIPPINGNOTICECHECKOUT • SHIPPINGNOTICECREATED • SHIPPINGNOTICEDELETED • SHIPPINGNOTICEENDLOAD • SHIPPINGNOTICESTARTLOAD • SHIPPINGNOTICEUPDATED • STORERCREATED • STORERDELETED • STORERUPDATED • TASKCOMPLETED • TASKCREATED • TASKMANAGERUSERCREATED • TASKMANAGERUSERDELETED • TASKMANAGERUSERDETAILCREATED • TASKMANAGERUSERDETAILDELETED • TASKMANAGERUSERDETAILUPDATED • TASKMANAGERUSERUPDATED • TASKUPDATED • TOIDCOMPLETE • TRANSFERFINALIZED • TRANSFERITRNFINALIZED

Available Events


• TRANSFERPICKSHIPPED • TRANSSHIPCREATED • TRANSSHIPSHIPPED • TRIPTODOCKCOMPLETE • UNALLOCATED • UNHOLDBYSKU • WEIGHTADJUSTMENT • WITHDRAWAL • WORKORDERCLOSED • WORKORDERCOMPLETED • WORKORDERCOMPONENTCREATED • WORKORDERCOMPONENTDELETED • WORKORDERCREATED • WORKORDERDELETED • WORKORDERINPROCESS • WORKORDEROPUPDATED • WORKORDERSCRAP • WORKORDERSUSPENDED • WORKORDERUPDATED


Appendix B Glossary B

B • XSD - XML Schema definition. These are a collection of XML declarations that define the format

and contents of an XML document. • External key - The key value supplied to WM for the calling system. An example is the PO

number created by a system other than WM. • Internal key - The key value is created within WM. It is not supplied by the calling system. An

example is the PO number created within WM.

infor sce warehouse management module interface guide guide.pdf · 2014-11-22 · without...

Documents