Differences

This shows you the differences between two versions of the page.

Link to this comparison view

enterprise service bus data handler - ups label [2016/09/14 14:19] (current)
Line 1: Line 1:
 +====== Enterprise Service Bus Data Handler - UPS Label ======
  
 +===== Purpose =====
 +
 +The UPS Label data handler allows the Software Developer to create an application that creates UPS Shipping Labels.
 +
 +//This feature will be available in Platform Version 14.06.961.//​
 +===== Supporting Elements =====
 +
 +For the UPS Label data handler to work properly there needs to be several elements added to the application. ​ A [[Table|table]] will need to be created by the Software Developer that the ESB will read from and or write to.  The UPS Label Data Handler will read up to 28 pieces of data that can be used to define the To And From Addresses and label options. ​ The UPS Label Data Handler will write up to 7 pieces of Data; Label, Tracking Number, Rate, Rate Currency, Warning / Error Severity, Warning / Error Code, and Warning / Error Message.
 +===== Options =====
 +
 +There is one configuration option in this data handler.
 +
 +  * File Name - When the label is returned it will need a file name.  If no file extension should be added to the file name because it will be appended automatically.
 +
 +===== Triggering =====
 +
 +This Data Handler is triggered via an [[Action Type - Enterprise Service Bus|Enterprise Service Bus Action]]. ​ To see which actions will trigger this Data Handler use the "​Outgoing"​ tab on the [[Enterprise Service Bus|Enterprise Service Bus]] page.
 +
 +
 +===== Field Mapping =====
 +
 +The field mapping interface will allow the Software Developer to choose a field on the table selected in the options above or to use a [[Expression Builder|expression]] to find a field on related records or enter a static value. ​ For rows that store data either a field on the current record can be selected or a [[Query Builder|query]] can be used to store data on related records.
 +
 +{{::​ups_esb_map.png?​nolink|}}
 +
 +===== Error Handling =====
 +When a label is generated it is possible that an error might occur because of missing or invalid data.  If UPS detects an error then it will not return a shipping label and will return an error code and message. ​ Sometimes an error is transient and simply retrying the label generate again later will work but if an error is "​HARD"​ severity then it will never generate a label. ​ It is generally a good practice to show the end user the error or warning so that they can either correct their data or be aware of the warning.
enterprise service bus data handler - ups label.txt ยท Last modified: 2016/09/14 14:19 (external edit)
Copyright WorkXpress, 2019