Commercial and in Confidence
The information contained in this document is confidential. No part of this document may be reproduced, disclosed to any third party, or issued in any form or by any means without the express written permission of Intersoft Systems & Programming Ltd.
Contents
1 Document Controls
2 Table of Figures
3 Introduction
4 Configure Service Enhancements and Service Enhancement Groups
4.1 Configure Service Enhancement Groups
4.1.1 Add Service Enhancement Group
4.1.2 Edit Service Enhancement Group
4.1.3 Delete Service Enhancement Group
4.2 Configure Service Enhancements
4.2.1 Add Service Enhancement
4.2.2 Edit Service Enhancement
4.2.3 Delete Service Enhancement
5 Add Service Enhancements to Services
5.1 Add Enhancements to Service
5.2 Remove Enhancements from Service
6 Service Enhancement Translations
6.1 Add Service Enhancement Translation
6.2 Remove Service Enhancement Translations
7 Appendix 1 – Glossary
Figure 1: Service Enhancements screen
Figure 2: Service Enhancement Groups screen
Figure 3: Add Service Enhancement Group
Figure 4: Service Enhancement Group added
Figure 5: Edit Service Enhancement Group screen
Figure 6: Edit Service Enhancement group
Figure 7: Service Enhancement Group edited
Figure 8: Delete Service Enhancement
Figure 9: Delete Service Enhancement Group confirmation message
Figure 10: Screen Name Screenshot
Figure 11: Delete Service Enhancement Group with services assigned
Figure 12: Add Service Enhancement button
Figure 13: Add Service Enhancement screen table of fields
Figure 14: Add Service Enhancement screen
Figure 15: Service Enhancement added
Figure 16: Edit Service Enhancement screen
Figure 17: Edit Service Enhancement
Figure 18: Service Enhancement edited
Figure 19: Delete Service Enhancement
Figure 20: Delete Service Enhancement confirmation message
Figure 21: Service Enhancement deleted
Figure 22: Edit Service screen Enhancements tab
Figure 23: Add Service Enhancements to Service
Figure 24: Service Enhancement added to Service
Figure 25: Remove Service Enhancements from Service
Figure 26: Service Enhancements removed from Service
Figure 27: Integrations list for selected carrier
Figure 28: Service Enhancement Translations screen
Figure 29: Add Service Enhancement Translation
Figure 30: Service Enhancement Translation added
Figure 31: Remove Service Enhancement Translation
Figure 32: Remove Service Enhancement Translation confirmation message
Figure 33: Service Enhancement Translation removed
Some of the carriers integrated with Intelligent Shipper offer optional service enhancements, which can be used to provide additional delivery services above and beyond the carrier's standard services. For example, SMS or email delivery notifications, increased compensation for high value shipments and age verification on delivery. Intelligent Shipper allows System Administrator users to setup service enhancements, so that customer users have the option of using these enhancements when creating shipments.
This manual instructs System Administrator users how to configure service enhancements in Intelligent Shipper. Instructions for customer users on how to create shipments using service enhancements are detailed in the documents "Create Shipments Using Service Enhancements Manual" and "Intelligent Shipper API - Multi-Piece Shipment Bookings".
To configure service enhancements in Intelligent Shipper, the first step is to configure service enhancements and Service Enhancement Groups in the Maintenance functionality. To do this:
Figure 1: Service Enhancements screen
First you will need to setup Service Enhancement Groups. To do this, select the 'Enhancement Groups' button and the Service Enhancement Groups screen will open.
Enhancement Groups are optional and allow you to categorise similar service enhancements so that they are grouped together. E.g. enhancements relating to email and/or SMS notifications, delivery options enhancements (such as delivery to neighbour, delivery to Post Office).
When customers are creating shipments, they will only be able to use one enhancement from each Service Enhancement Group per shipment, so keep this in mind when setting up your Service Enhancement Groups. E.g. If a Service Enhancement Group SMS Notifications contains enhancements, the customer will only be able to use one SMS enhancement from the group per shipment.
If service enhancement groups are not used, then customers will not be restricted on the number of similar service enhancements they can use when creating shipments.
To setup a new Service Enhancement Group:
Figure 2: Service Enhancement Groups screen
NOTE: Service Enhancement Group name must be unique. If you attempt to enter a Service Enhancement Group name that already exists in the system then an error message will be displayed.
Figure 3: Add Service Enhancement Group
Figure 4: Service Enhancement Group added
To edit a Service Enhancement Group:
Figure 5: Edit Service Enhancement Group screen
NOTE: If you click 'Cancel', the Edit Service Enhancement Group screen will close and the Service Enhancement Group name will not be updated.
Figure 6: Edit Service Enhancement group
Figure 7: Service Enhancement Group edited
To delete a Service Enhancement Group:
Figure 8: Delete Service Enhancement
Figure 9: Delete Service Enhancement Group confirmation message
Figure 10: Screen Name Screenshot
Figure 11: Delete Service Enhancement Group with services assigned
Once you have setup Service Enhancement Groups (if required), you can then setup service enhancements.
To setup service enhancements:
Figure 12: Add Service Enhancement button
To add a new service enhancement:
Field Name | Description | Optionality (M/C/O) | Validation Rules |
---|---|---|---|
Code | A code used for identifying the enhancement. This code will be used by customers when creating shipments to request the enhancements. | Mandatory | Max length 10 characters. |
Description | Enhancement name or description. Used to tell customers what the enhancement is. | Mandatory | Max length 50 characters. |
Drop enhancement request if not available for service | Sets what should happen if the enhancement is requested for a shipment but is not available for the shipment service. In this scenario, if the box is ticked then the enhancement will be "dropped" and the shipment will be created without the enhancement. If the box is unticked, then an error message will be displayed and the shipment will not be created. | Mandatory | Tick box, unticked by default. |
Service Enhancement Group | Sets the Service Enhancement Group the service enhancement belongs to. When creating shipments customers will only be able to use one enhancement from a group per shipment, so adding the enhancement to a group ensures it cannot be used with any similar/conflicting enhancements. | Optional | Selection from list of groups setup in Service Enhancement Groups screen. |
Figure 13: Add Service Enhancement screen table of fields
Figure 14: Add Service Enhancement screen
Figure 15: Service Enhancement added
To edit a service enhancement:
Figure 16: Edit Service Enhancement screen
Figure 17: Edit Service Enhancement
Figure 18: Service Enhancement edited
To delete a service enhancement:
Figure 19: Delete Service Enhancement
Figure 20: Delete Service Enhancement confirmation message
Figure 21: Service Enhancement deleted
Once you have setup service enhancements in the system, these enhancements then need to be assigned to services so that customers can use these service enhancements when creating shipments.
To add a service enhancement to a service:
NOTE: For newly added services only the Available Enhancements list will show, as there will not be any enhancements currently assigned to the service.
Figure 22: Edit Service screen Enhancements tab
To add service enhancements to the service:
Figure 23: Add Service Enhancements to Service
Figure 24: Service Enhancement added to Service
To remove service enhancements from the service:
Figure 25: Remove Service Enhancements from Service
Figure 26: Service Enhancements removed from Service
Once service enhancements have been setup and added to services, the final configuration step required is to map the service enhancements to carrier service enhancements in Service Enhancement Translations. This is so that when a customer creates a shipment using a service enhancement, the carrier receives the data they need in order to apply the service enhancement to the shipment. For example, if a shipment is created with a notification enhancement and the carrier offers multiple notifications, they will need to know which notification that has been requested to ensure the correct one is sent.
In the example shown in figures 28 to 31, service enhancement 'No signature needed on delivery' setup in Service Enhancements maintenance is being mapped to the Parcelforce service enhancement 'No Signature Required'.
See the document "Intelligent Shipper Carrier Integrations and Features" for more information on the service enhancements that are available for each carrier.
To setup Service Enhancement Translations:
Figure 27: Integrations list for selected carrier
Figure 28: Service Enhancement Translations screen
To add a new service enhancement translation:
NOTE: This determines the data that will be sent to the carrier when shipments are created using the service enhancement. E.g.: In the example in figure 30, if a shipment is created using the Parcelforce integration and the service enhancement code DSONS, then the shipment will be created with the Parcelforce service enhancement "No Signature Required".
Figure 29: Add Service Enhancement Translation
Figure 30: Service Enhancement Translation added
NOTE: A service enhancement setup in Service Enhancements maintenance can be mapped to multiple carrier integrations. For example, the system enhancement 'No signature needed on delivery' mapped to a Parcelforce enhancement in figure 30 can also be mapped to other carriers. When a shipment is created using the 'No signature needed on delivery' system enhancement, the agent and label integration used for the shipment will then determine the correct service enhancement translation to use.
To remove a service enhancement translation from an integration:
Figure 31: Remove Service Enhancement Translation
Figure 32: Remove Service Enhancement Translation confirmation message
Figure 33: Service Enhancement Translation removed
Term | Definition |
Customer User | The core users of the system who will be creating, processing and closing out shipments. This user role will be assigned to a customer account. |
Service Enhancement | Optional functionality offered by carriers that provide additional services above and beyond standard delivery services. For example, delivery notifications, alternative delivery options (such a deliver to a neighbour or leave in a safe place) and enhanced compensation levels are all types of service enhancement. |
System Administrator User | Administrator who will be setting up and maintaining the system. This user role will not be assigned to a customer account and so will be able to view data for all customer accounts in your system. |