Pacejet

Sending and Using User Fields in Pacejet

Overview

User fields can be used manually to store data. The Rate & Ship screen is a common area for the User fields. The table selected when Adding User Fields (steps below) will determine where the data is stored. With some ERP systems, you have the capability to use the Pacejet API to import the ERP custom data into Pacejet User fields. Data transmitted in User fields can be displayed and used in various places in the Pacejet platform via a user field administration feature. User fields can also be included at the shipment, package, and item levels but are restricted to 100 characters.

Exposing these fields is not a requirement for other features to use the data. The field only needs to be exposed if the user wants to view / manually change the data.


IMPORTANT! Do not use a User field until you have submitted a help ticket to determine if the User field you plan to use is not being used in the portal.

We recommend creating Custom fields rather than User fields. For more information, refer to Sending and Using Custom Fields Fields.


Configuring User Fields

You can use the User fields on the Rate & Ship screen by selecting the appropriate User field. It is highly recommended to use Shipment Rules when importing User fields.


Adding User Fields

Follow the steps below to configure the User fields that will be displayed on the Rate & Ship screen.

  1. From the Admin drop-down menu, click Location Setup, and then click User Fields.
    set_up_user_fieldsv3.png

  2. Click the add.png icon.

  3. In the Table Name drop-down list, click to select the appropriate table where you would plan to have the data stored.
    Selecting SaaS_RateQuote or SaaS_RateQuoteDetail will display the fields on the Rate & Ship screen.
    Add_new_user_field.png

  4. In the Column Name drop-down list, click to select UserField from the list.
    This list shows all UserFields, empty and used.

  5. In the Label text box, enter a meaningful label for the User field.

  6. In the Display checkbox, click to select to display the User field based on the table selected in step 3.

  7. Click Save.


Editing User Fields

The following items can be edited:

  • The label associated with a User field.

  • Whether or not the User field is displayed on the designated screen.

Follow the steps below to edit a User field.

  1. From the User Fields screen, click the row of the User field to select the field you plan to edit. user_fields.png

  2. Change the Label field and/or Display checkbox (to determine whether the User field is displayed on the table selected in step 3 of the Adding User Fields section.

  3. Click Save.


- You have a maximum of 15 User fields at each level.
- User fields are limited to a maximum of 100 characters.
If more than 100 characters are imported, the import will not go through (will "error out") for the API. The API does not provide any error
checking.

Importing ERP Custom Fields Using Pacejet API


Use the Pacejet Shipment Rule entitled Map Custom Fields to ensure the data imported from the ERP goes into the User fields.
map_custom_field.png


Examples for Defining User Fields with the API Request

Viewing of data is typically a verification step that is performed during implementation. Once that process is verified, the data is generally ignored by the user.


User Fields at the Shipment Level

User fields at the shipment level are specified in the ShipmentDetail section of data and are identified by fields numbered from 1 to 15 and a value. By standard convention, Pacejet uses UserField1 through 3 and UserField13 through 15. Do not use these UserFields.


shipment_levelv2.png


User Fields at the Package Level

User fields at the package level are specified in the PackageDetailsList section of data and are identified by fields numbered from 1 to 15 and a value. No package level user fields are used by standard Pacejet convention, so all are available for custom data purposes.


user_fields_package_level.png


User Fields at the Product Level

User fields at the product level are specified in the ProductDetailList section of data and are identified by fields numbered from 1 to 15 and a value. By standard convention, Pacejet uses UserField 1 through 4. Do not use these User Fields.


product_level_v4.png