Establishing a Connection
The Lyftron Provider for UPS uses five pieces of information in order to authenticate its actions with the UPS service.
- Server: This controls the URL where the requests should be sent. Common testing options for this are: "https://wwwcie.ups.com/ups.app/xml", and "https://wwwcie.ups.com/webservices"
- AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
- UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
- Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
- AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
- PrintLabelLocation: This property is required to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.
The Cache Database
Many of the useful task available from UPS require a lot of data. To ensure this data is easy to input and recall later, the Lyftron Provider for UPS utilizes a cache database to make these requests. You must set the cache connection properties in order to use the Lyftron Provider for UPS
- CacheLocation: The path to the cache location, for which a connection will be configured with the default cache provider. For example, C:\users\username\documents\upscache
Connecting Through a Firewall or Proxy
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
As an alternative to CacheLocation, set the combination of CacheConnection and CacheProvider to configure a cache connection using a provider separate from the default.