- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
enterprise service bus data handler - fedex label [2016/09/14 18:19] |
enterprise service bus data handler - fedex label [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Enterprise Service Bus Data Handler - FedEx Label ====== | ||
| + | ===== Purpose ===== | ||
| + | |||
| + | The FedEx Label data handler allows the Software Developer to create an application that creates FedEx Shipping Labels. | ||
| + | |||
| + | //This feature will be available in Platform Version 14.06.961.// | ||
| + | ===== Supporting Elements ===== | ||
| + | |||
| + | For the Fedex 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 FedEx Label Data Handler will read up to 30 pieces of data that can be used to define the To And From Addresses and label options. The FedEx 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 three configuration options in this data handler. | ||
| + | |||
| + | * Label Return Type - This is a selection that allows the software developer to choose between either a PNG or PDF return for the label | ||
| + | * Paper - This determines the size of the label and how it is oriented. | ||
| + | * File Name - When the label is returned it will need a file name. If no file extension needs to be added to the file name because it will be appended automatically based on the label return type. If the extension is included and it is of the wrong type for the label return type the correct extension will be appended and may cause issues with some operating systems. | ||
| + | |||
| + | ===== 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. | ||
| + | |||
| + | {{::fedex_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 FedEx detects an error then it will not return a shipping label and will return an error code and message. Sometimes an error is minor enough that FedEx will still return a label and issue a warning code and message. 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 in case the change made automatically by FedEx will cause unintended consequences. | ||
