Custom Label Generator toolkit - Introduction
In Transtream, custom labels are configured via the Reference Data page of the Administration App's Data tab. For detail, see Administration - Data.
The Custom Label Generator toolkit provides platform for the customization of complex labelling requirements. Its purpose is to facilitate the generation of labels, which require either additional data or formatting exceeding the functionality provided by the current custom label options.
The toolkit supports EPL, ZPL and DPL label code generation. Depending on the label type, the generator can be triggered by either a Pierbridge Label Request or a Pierbridge Ship Request.
The purpose of this content is to provide insight into developing a Custom Label Generator following the Windows-based samples included with this document. These working samples consist of C#, VB.NET, ASP and PHP examples, which can be modified to meet the needs of the project. In addition, this content also aims to present a walkthrough explaining the different configuration options and necessary steps for creating custom labels or thermal label extensions with the Custom Label Generator.
Custom Label Generators are currently supported for all thermal label extensions and standalone label types. The available custom and conditional custom labels are listed in the table below:
| Output Name | Output Type ID | When Produced? | Notes |
|---|---|---|---|
| CustomLabel1 | 46 | Always (if configured). | - |
| CustomLabel2 | 47 | Always (if configured). | - |
| CustomLabel3 | 48 | Always (if configured). | - |
| ConditionalCustomLabel1 | 50 | Only if mapped and called manually using a Pierbridge Label request. | As Billing Label is not supported for returns, use this label instead. |
| ConditionalCustomLabel2 | 51 | Only if mapped and called manually using a Pierbridge Label request. | As Billing Label is not supported for returns, use this label instead. |
| ConditionalCustomLabel3 | 52 | Only if mapped and called manually using a Pierbridge Label request. | As Billing Label is not supported for returns, use this label instead. |
To create custom labels, you need to:
- Install a toolkit example.
- Create a Custom Label Generator that has been developed following one of the examples provided in the toolkit.
- Use the LabelRequestHttpPoster.exe test utility to test the thermal code produced by the generator.
- Configure Transtream through the Administration App to know the rules of contacting the Custom Label Generator.
