Configuration and Administration

glog.ratingengine Properties

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Note: Support for on-premise SMC3 RateWare applications has been deprecated and is not supported.

To control the behavior of Oracle Transportation Management, you can change settings in the glog.properties file or the appropriate property set. Before you can use an external rating engine, you must point to it in the glog.properties file. See the topic The External Rating Engine. 

Property

New in version

Description

glog.RatingEngine.CarrierConnectXL.License

19C

Specifies the license key needed to access your CarrierConnectXL subscription. Default: null

glog.RatingEngine.CarrierConnectXL.Timeout

19C

Defines the amount of time in milliseconds to time out if there is no response from the CarrierConnectXL Web Services.

glog.RatingEngine.CarrierConnectXL.Wsdl.URL

19C

This property specifies the WSDL URL for SMC Web Service. The default value for this property is https://ccxl.smc3.com/CarrierConnectXL/services/soap/v3?wsdl.

glog.RatingEngine.fedex.accountNumberQual

23C

This property specifies the reference number qualifier used to obtain the FedEx account number. When this property is configured, the application fetches the reference number qualifier value from either of the following in priority order:
 

  1. Shipment
  2. Order Release
  3. Source stop location.

It looks for the reference number on the shipment with the specified reference number qualifier. If not found, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier. Otherwise, It looks for the reference number on the source stop location with the specified reference number qualifier. 

Default: FEDEX_ACCOUNT_NUMBER

glog.RatingEngine.fedex.documentShipmentRefnumQual 25A

This property specifies the reference number qualifier for document shipment of a FedEx package to check if the shipment contains document commodities. When this property is configured, the application fetches the reference number qualifier value from either of the following in priority order:

  1. Shipment
  2. Order Release
  3. Source stop location.

It looks for the reference number on the shipment with the specified reference number qualifier. If not found, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier. Otherwise, It looks for the reference number on the source stop location with the specified reference number qualifier. 

Note: The value will be sent to FedEx when the qualifier given in the property is set to true.

glog.RatingEngine.fedex.freightOnValueRefNumQual 25A

This property specifies reference number qualifier to fetch the freight value  from reference number. The application fetches the reference number qualifier value from either of the following in priority order:

  1. Shipment
  2. Order Release

It looks for the reference number on the shipment with the specified reference number qualifier. Otherwise, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier.

The values of the reference number can either be "CARRIER_RISK" or "OWN_RISK".

glog.RatingEngine.fedex.harmonizedCodeRefNumQual 25A

This property specifies the reference number qualifier to receive the harmonized code from reference number.

The refnum qualifier will be fetched based on the "Package Count Is determined by" field from the Rate Offering.

  1. If the field value is "L," (Ship Unit Line) the refnum is fetched from the Order release line corresponding to a shipment ship unit line.
  2. If the field value is "U," (Ship Unit) the refnum is fetched from the order release ship unit corresponding to the shipment ship unit.
glog.RatingEngine.fedex.hubIdRefNumQual 25A This property specifies the reference number qualifier to fetch the hub id value from the destination location reference number.
glog.RatingEngine.fedex.indiciaRefNumQual 25A This property specifies the reference number qualifier for indicia. The reference number will be fetched from either of the following in priority order:
  1. Shipment
  2. Order Release

It looks for the reference number on the shipment with the specified reference number qualifier. Otherwise, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier.

The value of the reference number can be either "MEDIA_MAIL" or "PARCEL_RETURN" or "PARCEL_SELECT" or "PRESORTED_BOUND_PRINTED_MATTER" or "PRESORTED_STANDARD".

glog.RatingEngine.fedex.LengthUOM 23C

This property specifies the unit of measurement (UOM) to be used for length in FedEx requests. The default value of the property is I.
If the property value is set to I, the UOM to be used for length is in IN else the unit is in CM.

glog.RatingEngine.fedex.packagingTypeQualifier 25A

This property specifies the packaging type qualifier used to obtain the packaging type. Default value is PACK_TYPE.

The refnum qualifier/remark qualifier will be fetched based on the "Package Count Is determined by" field from the Rate Offering.

  1. If the field value is "L," (Ship Unit Line) the refnum is fetched from the Order release line corresponding to a shipment ship unit line.
  2. If the field value is "U," (Ship Unit) the hierarchy will be in the following. 
    • ship unit specification refnum. 
    • ship unit refnum. 

If reference number qualifier "PACK_TYPE" is not present then it will look for the remark qualifier with ID "PACK_TYPE".

Note: The value for the reference number or remark should be same on all the shipment ship unit lines or corresponding order release lines.

glog.RatingEngine.fedex.pickUpTypeRefnumQual 25A

This property specifies the reference number qualifier used to obtain the type of pick up. Default value is PICKUP_TYPE.

When this property is configured, the application fetches the reference number qualifier from either of the following in priority order:

  1. Shipment
  2. Order Release
  3. Source stop location.

It looks for the reference number on the shipment with the specified reference number qualifier. If not found, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier. Otherwise, It looks for the reference number on the source stop location with the specified reference number qualifier. 

Pick up types can be one of CONTACT_FEDEX_TO_SCHEDULE, DROPOFF_AT_FEDEX_LOCATION, USE_SCHEDULED_PICKUP, ON_CALL, PACKAGE_RETURN_PROGRAM, and REGULAR_STOP.

glog.RatingEngine.fedex.pkgSpclSrvc* 25A

The required information for different special services will have to be defined as accessorial codes and accessorial remarks.
When the field "Package Count Is determined by" from Rate Offering 

  1. If the field value is "L (Ship Unit Line)" the hierarchy would be as follows:
    • Shipment Ship unit line accessorial. 
    • Order release Line accessorial.
    • Packaged Item accessorial.

       It looks for the accessorial code on the shipment ship unit line. If not found, It looks for the accessorial code on order release line. Otherwise, It looks on the packaged item. 

  2. If the field value is "U (Ship Unit)" then the accessorial code will be fetched from ship unit specification. 

The attribute required to be added to the payload for special service, can be identified using the properties

Naming convention for adding the property for the accessorial code should be "glog.RatingEngine.fedex.pkgSplSrvc.accCode.<<spclService>> = <<spclServiceAccessorialCode>>", and

Naming convention for adding the property for the accessorial remark qualifier should be "glog.RatingEngine.fedex.pkgSplSrvc.accRemQual.<<spclService>>.<<spclServiceRelatedRemarkKey>> =<<spclServiceRelatedRemarkQualifier>>". 

See How to Set Up FedEx Rating Engine for more properties related to package special services.

glog.RatingEngine.fedex.shipmentPurposeRefNumQual 25A

This property specifies reference number qualifier to obtain the qualifier value for reason of the shipment. 

The reference number qualifier will be defined from either of the following in priority order:

  1. Shipment 
  2. Order Release

It looks for the reference number on the shipment with the specified reference number qualifier. Otherwise, It looks for the reference number on one of the corresponding order releases with the specified reference number qualifier.

The value of the reference number can be either "GIFT" or "NOT_SOLD" or "PERSONAL_EFFECTS" or "REPAIR_AND_RETURN" or "SAMPLE" or "SOLD" or "COMMERCIAL" or "RETURN_AND_REPAIR" or "PERSONAL_USE".

glog.RatingEngine.fedex.subPkgTypeRefNumQualifier 25A

This property defines the reference number qualifier for the sub-packaging type of a FedEx package. The refnum qualifier will be fetched based on the "Package Count Is determined by" field from the Rate Offering.

  1. If the field value is "L (Ship Unit Line)" the refnum is fetched from the Order Release Line corresponding to a shipment ship unit line.
  2. If the field value is "U (Ship Unit)" the refnum is fetched from the Ship Unit corresponding to a shipment ship unit.
glog.RatingEngine.fedex.WeightUOM 23C

This property specifies the unit of measurement to be used for weight in FedEx requests. The default value of the property is P.
If the property value is set to P, the UOM to be used for weight is in LB else the unit is in KG.

glog.RatingEngine.Kewill.Costs.IncludeDiscounts

6.3

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies whether to include discounts as one of the costs in the shipment when reading from the BluJay Solutions Parcel response. The other costs received from BluJay Solutions Parcel will be adjusted upwards to reflect the discount, then the discount will be displayed on a separate line with the total cost equaling the calculated cost as received from BluJay Solutions Parcel.

glog.RatingEngine.Kewill.ExportReasonRefnumQual

6.2.7

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

This allows for BluJay Solutions Parcel rating from Canada - USA using DHCA carrier: Set it to KEWILL_EXPORT_REASON.

Use Order Release by setting the property glog.RatingEngine.Kewill.ExportReasonRefnumQual to KEWILL_EXPORT_REASON and by configuring the refnum (KEWILL_EXPORT_REASON) at Order Release level to one of the value (P,T,R) ->(Permanent, Temporary, Re-Export), no support from Rate Inquiry.

glog.RatingEngine.Kewill.LengthUOM

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Determines length unit of measurement that will be sent to the BluJay Solutions Parcel rating engine.

glog.RatingEngine.Kewill.Port

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies the port number used to communicate with the BluJay Solutions Parcel engine.

glog.RatingEngine.Kewill.RefnumQual

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies the user-defined location reference number qualifier GID used to identify the location reference number that stores the Kewill CUSTNUM corresponding to the location.

glog.RatingEngine.Kewill.URL

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies the IP address or network address of the machine running the BluJay Solutions Parcel rate server.

glog.RatingEngine.Kewill.WeightUOM

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Determines weight unit of measurement that will be sent to the BluJay Solutions Parcel rating engine.

glog.RatingEngine.Kewill.merchDescRefnumQual

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies the order release reference number qualifier used to store the value passed into the MERCHANDISE_DESCRIPTION field for queries. If rating a RETURN or 3RDPARTY, this value will be passed to BluJay Solutions Parcel.

glog.RatingEngine.Kewill.returnRefnumQual

 

Note: BluJay Solutions Parcel (formerly Kewill Flagship Parcel Rates) is not supported.

Specifies the order release reference number qualifier used to determine return versus third party behavior. The corresponding value of this reference number can be set to either RETURN or 3RDPARTY on the order release. All other values will be ignored. When set to RETURN, the source and destination will be swapped in the outgoing Kewill query. When set to 3RDPARTY, the source and destination will be swapped, and the value of the TERMS API key is set to 3 instead of the standard S. When using either RETURN or 3RDPARTY, the SFCUSTNUM must also be specified on the order release. If not found, standard Kewill rating behavior will apply.

glog.RatingEngine.Ratable.SetSelected.TraversedPathLogic

6.3.1

Set this to true to have the rating engine check for inconsistent instances within shipments that cause problems with rating. For example, if you want to rate a shipment with two pieces of equipment, where one is associated with a ship unit and the other is not, rating will fail because the rates/charges are defined per equipment. This is not very common, but may happen.

In order to rate this specific scenario, you will have to set this property to true. By setting this new property to true, the rating engine will check for such inconsistent instances within the shipment and rate the shipment accordingly.

glog.RatingEngine.Rateware.NewAPI

6.3.3

If using CarrierConnect, in addition to setting up SMC3 rates, this property must be set to True.

Default: false

Alternatively, you can select the rating engine SMC3 WITH CARRIERCONNECT.

glog.RatingEngine.Rateware.Port

 

This is related to the SMC3 external rating engine. Replace <ratingengine_port> with the port number on which the rating engine listens (This is often 23700.).

glog.RatingEngine.Rateware.URL

 

This is related to the SMC3 external rating engine. Enter the name of the server on which the rating engine runs. Use the following format:<ratingengine_name>

glog.RatingEngine.RatewareXL.checkForValidTariffEffectiveDate

19C

This property compares the Tariff Effective Date entered in the Rate Offering with the effective date returned in response from RatewareXL. Set this property to true, if you want an exception to be thrown if the dates are not matched.

Default: false

glog.RatingEngine.RatewareXL.License

 

Specifies the license key needed to access your RatewareXL subscription. Default: null

The password is stored in the OTM Wallet under the glog.RatingEngine.RatewareXL.License wallet key. To set this use the property set or directly modify the OTM Wallet.

glog.RatingEngine.RatewareXL.Password

 

Specifies the password needed to access your RatewareXL subscription. Default: null

The password is stored in the OTM Wallet under the glog.RatingEngine.RatewareXL.Password wallet key. To set this use the property set or directly modify the OTM Wallet.

glog.RatingEngine.RatewareXL.RetryCount

 

Specifies the invocation retry count of RatewareXL Web service

glog.RatingEngine.RatewareXL.Timeout

6.4.3

Defines the amount of time in milliseconds to time out if there is no response from the RatewareXL Web Services.

Default: 10,000ms

glog.RatingEngine.RatewareXL.Username

 

Specifies the username needed to access your RatewareXL subscription. Default: null

The password is stored in the OTM Wallet under the glog.RatingEngine.RatewareXL.Username wallet key. To set this use the property set or directly modify the OTM Wallet.

glog.RatingEngine.RatewareXL.Wsdl.URL

6.4.2

This property specifies the WSDL URL for SMC Web Service. The default value for this property is "https://applications.smc3.com/AdminManager/services/RateWareXL?wsdl".

glog.RatingEngine.RatewareXL.captureDetailCosts

6.4.2

This property indicates if OTM should capture only the total base cost of the shipment or should capture the ship unit level detail cost received from RatewareXL or RatewareXL with Carrier connect.

If false (the default), OTM captures only the total base cost of the shipment.

If true, OTM captures the ship unit level detail cost received from RatewareXL or RatewareXL with Carrier connect.

When OTM captures only the total base cost, the description is set to SMC Base Charge.

glog.RatingEngine.RatewareXLCarrierConnect.weightRounding

6.3.6

When using Rateware XL with Carrier Connect, weight given in decimal is rounded off to a whole number. The number can be floored (F), ceiling (C), rounded (I) to whole number. The default is 'F' (floor).

glog.RatingEngine.roundingPrecision

 

Specifies the rounding precision for Rating Engine while performing the rounding operation.

Related Topics