Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Intelligent Shipper
Agent Setup Manual
Version 1.0

Document Owner

INTERSOFT Systems and Programming Limited

Version

1.0

Date

30/07/2020

Description

Instructs System Admins on how to setup and maintain Agents

Author

Deepa Sankaran

...

Version

Amendments

Date

Author

0.1

Initial Draft

16/07/2020

Deepa Sankaran

0.2

Updated with review comments

21/07/2020

Deepa Sankaran

1.0

Final version

30/07/2020

Deepa Sankaran

...

Name

Title

Date Reviewed

Version Reviewed

Laura Price

Head of Business Analysis

17/07/2020

0.1

Beata Brewer

Customer Experience Manager

29/07/2020

0.2

...

Document Name

...

Version

...

Location (e.g. Link to Shared Drive, SharePoint etc.)

...

N/A

...

N/A

...

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 Setting Up an Agent
4.1 Add Agent
4.2 Update Logo
4.3 Pallet Label
4.4 Agent Contact Details
5 Appendix 1 – Glossary
6 Appendix 2 – Pallet Label Example

Anchor
_Toc47039456
_Toc47039456
Table of Figures


Figure 1: Access Agent menu from the maintenance screen
Figure 2: Add Agent via the Agent option in maintenance menu
Figure 3: Agent details screen
Figure 4: Enter Agent Details
Figure 5: Confirmation screen to update tracking URL
Figure 6: Automatic updating of tracking URL
Figure 7: Confirmation required screen to not to update automatic URL
Figure 8: Tracking URL not updated automatically
Figure 9: Add Agent
Figure 10: Newly added Agent displayed in the screen
Figure 11: Logo tab and choose a logo for the Agent
Figure 12: Agent logo updated
Figure 13: Setup address for pallet label
Figure 14: Cancel button in pallet label screen
Figure 15: Select an Agent to add contact details
Figure 16: Add contact for an Agent
Figure 17: Display contact details of the Agent

...

Anchor
_Toc47039457
_Toc47039457
Introduction


Agents is a functionality in Intelligent Shipper that allows System Administrators to setup the carriers that will be available in the system. This manual instructs system admin users on how to create an Agent, add a logo, set up a pallet label and add contacts for the Agent.

Anchor
_Setting_Up_an
_Setting_Up_an
Anchor
_Toc47039458
_Toc47039458
Setting Up an Agent

Anchor
_Toc47039459
_Toc47039459
Add Agent


Agents are those that physically ship the goods. To add an Agent, you must first navigate to the Agent screen via the Maintenance functionality.
To do this:

  1. Navigate to the "Maintenance" on the left pane menu.
  2. Click "Maintenance"
  3. Click "Add" button of from the Agent menu



Anchor
_Toc47039594
_Toc47039594
Figure 1: Access Agent menu from the maintenance screen

  1. You can also access the "Add Agent" via the "Agents" option in the maintenance menu.


Anchor
_Toc47039595
_Toc47039595
Figure 2: Add Agent via the Agent option in maintenance menu

  1. Once the "Add Agent" is clicked this will display an Agent screen as shown below.


Anchor
_Toc47039596
_Toc47039596
Figure 3: Agent details screen

  1. Populate the fields with the Agent's details. An Agent is required to be setup for each carrier that customers will be shipping with. Multiple Agents can be setup per carrier if needed

e.g. one Agent for high volume shipments and one for standard shipments.


Anchor
_Toc47039597
_Toc47039597
Figure 4: Enter Agent Details

The fields are described in the table below:

Field Name

Description

Optionality (M/C/O)

Validation Rules

Agent Code

Define a unique identifying code for the Agent. This will be displayed in the system alongside Agent name everywhere when Agent details are displayed. Agent code cannot be changed once the Agent is added and saved.

Mandatory

Maximum 4 alphanumeric characters.

Agent Name

Name of the Agent

Mandatory

Maximum 100 alphanumeric characters.

Country

Select the country the Agent is based in from the drop-down list.

Mandatory

Selection from drop-down list.

Address

Enter the Agent's main address.

Mandatory

Must be in a valid email format e.g. name@customer.co.uk

Town

Enter the town of the Agent's main address.

Mandatory

Maximum 30 alphanumeric characters.

County

Enter the county or state of the Agent's main address. The field name will display as "County" or "State" or "State/Territory" depending on the country selected. E.g. if country is "Australia", it will display as "State/Territory".

Optional

Maximum 50 alphanumeric characters.

Postcode

Enter the postcode of the Agent's main address. The field name will display as "Zip code" for certain countries e.g. USA.

Mandatory

Maximum 10 characters.

Lowest Cost Routing

Tick this option if the Agent should be included in lowest cost routing calculations. This should only be used if pricing functionality is being used in the system.

Optional

Tick or un-tick this box.

Rate Card Group

If a rate card needs to be used for the Agent, then choose a rate card from the list. This is applicable only if pricing is being used in the system.

Conditional

Selection from drop-down list.

Label Type

Choose a label to apply for the Agent. This field will contain a list of integrations available in the system and sets the carrier integration that will be used for shipments for that Agent. Most of the label type will correspond to a specific carrier label. There are few label types that are used for specific reason.

  • Default label – Temporary label can be used for customer account setup who is set with transfer type to operations. A shipment cannot be shipped using this label and will require a final mile label.
  • Admin label – This label type can be used if the shipments require further investigation e.g. data missing, etc... A shipment cannot be shipped using this label and will require a final mile label.
  • Generic label – A label format that can be used for Agents that do not require their own label format. This is Intersoft' s standard label format.

Mandatory

Selection from drop-down list.

Account Number

Agent's assigned account number. If the label type is chosen as "generic label", then a carrier account number will be required.

Mandatory

Maximum 10 characters.

Website

Enter the Agent's website link.

Optional

Maximum 80 characters.

Tracking URL

The carrier's tracking link will be updated automatically based on the label type chosen. The link can be manually edited too. This will be used on the Tracking page, to provide a link through the carrier's tracking page for more detailed tracking information.

Optional

Maximum 300characters.

  1. When you select a label type from the drop-down, a prompt will be displayed to confirm if you want the tracking URL to be updated for the Agent.
  2. Select "Yes". On selecting "Yes", the tracking link will be updated automatically based on the label type chosen. The link can be manually edited, and this will be used on the tracking page.



Anchor
_Toc47039598
_Toc47039598
Figure 5: Confirmation screen to update tracking URL

  1. The tracking URL for the label type chosen will updated as below.


Anchor
_Toc47039599
_Toc47039599
Figure 6: Automatic updating of tracking URL

  1. On clicking "No", the tracking URL will not get updated.


Anchor
_Toc47039600
_Toc47039600
Figure 7: Confirmation required screen to not to update automatic URL

  1. An empty tracking URL will be displayed. You can update this URL manually.


Anchor
_Toc47039601
_Toc47039601
Figure 8: Tracking URL not updated automatically

  1. Once the screen has been populated with the Agent's details, click "Add Agent" button to add the Agent to the system.


Anchor
_Toc47039602
_Toc47039602
Figure 9: Add Agent

  1. You can now see the added Agent, as shown below.


Anchor
_Toc47039603
_Toc47039603
Figure 10: Newly added Agent displayed in the screen


Once the Agent is added, you can add a logo to the Agent via the "Logo" tab.

  1. To do this, access the logo and select the required logo from the right-hand side, as highlighted below. The logos used here are the logos of the carrier integrations available in the system.


Anchor
_Toc47039604
_Toc47039604
Figure 11: Logo tab and choose a logo for the Agent

  1. The logo for the Agent is updated as shown below.


Anchor
_Toc47039605
_Toc47039605
Figure 12: Agent logo updated

Anchor
_Toc47039461
_Toc47039461
Pallet Label


A pallet label address can be setup for an Agent. If the depot scanning functionality of the system is used, and if an Agent has an address setup for a pallet label, then on closing the pallet, a pallet label will be produced with the address setup here. An example of pallet label is provided in Appendix 2

  1. You can add this address by navigating to the pallet label menu.
  2. Once the address is entered, click "Update" and the address will be updated.


Anchor
_Toc47039606
_Toc47039606
Figure 13: Setup address for pallet label

  1. On clicking on the "cancel" button, you will be directed to the previous screen.


Anchor
_Toc47039607
_Toc47039607
Figure 14: Cancel button in pallet label screen

Anchor
_Toc47039462
_Toc47039462
Agent Contact Details


An Agent contact can be added for an Agent once the Agent is created. The contact added here is only used for reference and can be used by the customer for support purposes.

  1. To add a contact, navigate to the required Agent.


Anchor
_Toc47039608
_Toc47039608
Figure 15: Select an Agent to add contact details

  1. Click on the contact tab of the Agent.
  2. Enter the Agent details like name, phone, etc...
  3. Click "Add Contact"


Anchor
_Toc47039609
_Toc47039609
Figure 16: Add contact for an Agent

  1. Once added, the contact details are displayed as per the example below.


Anchor
_Toc47039610
_Toc47039610
Figure 17: Display contact details of the Agent

Anchor
_Toc47039463
_Toc47039463
Appendix 1 – Glossary


Term

Definition

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 the system.

Rate card

Rate card is a functionality in the system which is available for system admin users to setup pricing for Agents or customers. The price that is set in the rate card will be used in the calculation of shipment pricing.

Lowest cost routing

Lowest cost routing uses the pricing setup in Agent Rate Cards to find the lowest cost agent to deliver a shipment. If an agent has been set to use lowest cost routing, then it will be included in lowest cost routing calculations.


Anchor
_Appendix_2_–
_Appendix_2_–
Anchor
_Toc47039464
_Toc47039464
Appendix 2 – Pallet Label Example