Krengel Ship for UPS Configuration
From Wiki
|
| User Guide |
Krengel Ship for UPS configuration is handled in three physical files: UPSCFG, UPSUSER, and UPSACCT.
Contents |
Physical Files
These three physical files handle all configuration of Krengel Ship for UPS.
UPSCFG
UPSCFG controls configuration values that are used globally through all requests.
| Name | Data Type | Description | Notes |
|---|---|---|---|
| ID | 6 characters | ID | Key. This must be UPSCFG. Other records in this table will not be used. |
| LOGXML | 1 character | XML Logging | This field controls whether request and response XML is logged to UPSXML. If this is set to a true value, XML will be logged in UPSXML, and the files will be stored in the file path specified in physical file UPSCFG, field LOGXMLPATH. The XML files are used during the process of getting production access to the UPS APIs. Afterwards, however, it is advised to disable this option to prevent unnecessary disk space usage. |
| DEBUG | 1 character | Debugging | This field controls whether messages with a severity level of UPS_INFO will be written to UPSLOG. If this field contains a true value, all messages will be logged to UPSLOG. Otherwise, only messages with a severity level higher than UPS_INFO will be logged. All of the Krengel Ship for UPS APIs write UPS_INFO messages frequently for debugging purposes, so it is advised to disable this option once stable and running in production. |
| OUTPUTPATH | 128 characters | IFS Output Path | This field specifies a valid IFS path where shipping labels and the high-value report, as well as the UPS HTML Sizing Page. |
| CERTPATH | 128 characters | SSL Certificate Store Path | This field should contain a valid IFS path where the kshipups.kdb certificate store is located. If this field is left empty, the APIs will attempt to locate necessary certificates in the *SYSTEM certificate store. It is advised to not use the *SYSTEM store. |
| CERTPW | 12 characters | SSL Certificate Store Password | This field contains the password for the kshipups.kdb certificate store. If this field is left empty, the APIs will attempt to locate necessary certificates in the *SYSTEM certificate store. This password should only be changed when indicated by our support staff. |
| LOGXMLPATH | 128 characters | XML Logging Path | This field should contain a valid IFS path where the request, response, and HTTP header files will be stored. If field LOGXML in file UPSCFG is a true value, the XML files will be located within the path specified by this field. |
| PLUGINPATH | 128 characters | Plugin Path | This field is currently unused, but should still specify a valid IFS path. This field exists to support future development. |
| TPLPATH | 128 characters | Template Path | This field must contain a valid IFS path where the UPS Template File is located. If this field is not populated with a valid path, or the the template file does not exist at the location specified, Krengel Ship will be unable to function. |
UPSUSER
UPSUSER controls configuration values which apply to a specific UPS OnLine Tools Account.
| Name | Data Type | Description | Notes |
|---|---|---|---|
| USERID | 30 characters | UPS OnLine Tools ID | Key. This field will contain the user ID that was registered at UPS. Registering for a user ID and access key is explained here. |
| PWD | 30 characters | UPS OnLine Tools Password | This field will contain the password for the specified user ID. This password was specified during registration. |
| ACCKEY | 30 characters | UPS OnLine Access Key | This access key is issued during registration. |
| SMARTDFT | 1 characters | Smart Defaults | This field controls whether the values stored in fields CURCD, WGTCD, SVCCD, DIMCD, and PKGCD will be used for smart defaulting. If this is set to a true value, smart defaulting is enabled. |
| CURCD | 3 characters | Default Currency Code | This field specifies a smart default for currency code fields used in API calls. |
| WGTCD | 3 characters | Default Weight Code | This field specifies a smart default for weight code fields used in API calls. |
| SVCCD | 4 characters | Default UPS Service Code | This field specifies a smart default for UPS service code fields used in API calls. |
| DIMCD | 2 characters | Default Dimension Code | This field specifies a smart default for dimension code fields used in API calls. |
| PKGCD | 2 characters | Default Packaging Type Code | This field specifies a smart default for packaging type code fields used in API calls. |
| AVURL | 4 characters | Address Validation URL Type | This field controls whether calls to UPS_adrVld are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| XVURL | 4 characters | Street-Level Address Validation URL Type | This field controls whether calls to UPS_sAdrVld are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| TTURL | 4 characters | Time in Transit URL Type | This field controls whether calls to UPS_timeInTransit are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| RTURL | 4 characters | Rating Request URL Type | This field controls whether calls to UPS_ratingReq are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| TKURL | 4 characters | Tracking URL Type | This field controls whether calls to UPS_tracking are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| SCURL | 4 characters | Shipment Confirm URL Type | This field controls whether calls to UPS_shipConfirm are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| SAURL | 4 characters | Shipment Accept URL Type | This field controls whether calls to UPS_shipAccept are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| SVURL | 4 characters | Shipment Void URL Type | This field controls whether calls to UPS_shipVoid are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| PCURL | 4 characters | Pickup Create URL Type | This field controls whether calls to UPS_pkupCreate are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| PRURL | 4 characters | Pickup Rating URL Type | This field controls whether calls to UPS_pkupRating are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| PXURL | 4 characters | Pickup Cancel URL Type | This field controls whether calls to UPS_pkupCancel are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
| PSURL | 4 characters | Pickup Status URL Type | This field controls whether calls to UPS_pkupStatus are sent to the development or production URLs. This field must have a value of DEV or PROD. If this field is left blank, the API will act as though DEV was specified, and a message of severity UPS_WARNING will be sent to UPSLOG. |
UPSACCT
UPSACCT controls configuration values which apply to a specific UPS Shipper Number.
| Name | Data Type | Description | Notes |
|---|---|---|---|
| USERID | 30 characters | UPS OnLine Tools ID | Key. This field will contain the user ID that was registered at UPS. Registering for a user ID and access key is explained here. This user ID must exist in UPSUSER. |
| ACCTNBR | 10 characters | UPS Shipper Account Number | Key. This field must contain the UPS Shipper Number for a UPS account. |
| CONAME | 35 characters | Shipper's Company Name | |
| ATNAME | 35 characters | Shipper's Attention Name | Shipper's attention name - this may show up on shipping labels. |
| PHONE | 15 characters | Phone Number | |
| ADDR1 | 35 characters | Shipper's Address Line 1 | |
| ADDR2 | 35 characters | Shipper's Address Line 2 | |
| ADDR3 | 35 characters | Shipper's Address Line 3 | |
| TOWN | 35 characters | Shipper's Town | This is only used for international shipping. |
| CITY | 35 characters | Shipper's City | |
| STATE | 5 characters | Shipper's State | For US addresses, use the 2 character abbreviations used by the US Postal Service. For international addresses, follow the abbreviation standards of the shipper's country. |
| POSTCD | 16 characters | Shipper's Postal Code | For US addresses, use the Zip Code with the +4 code if available. For international addresses, use the postal code system of the shipper's country. |
| CNTRY | 2 characters | Shipper's Country Code | For all addresses, use the Alpha-2 abbreviation specified in ISO 3166-1. |
| 50 characters | Shipper's Email Address | ||
| FAX | 15 characters | Shipper's Fax Number | |
| TAXID | 15 characters | Shipper's Tax ID |