Establishing a Connection
You can create and manage connections with the Data Explorer and the FireDAC Connection Editor wizards. See Connection Definitions for more information on creating connections from code and creating persistent, private, or temporary connections.
The CData FireDAC Components 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 CData FireDAC Components for UPS utilizes a cache database to make these requests. You must set the cache connection properties in order to use the CData FireDAC Components 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
As an alternative to CacheLocation, set the combination of CacheConnection and CacheProvider to configure a cache connection using a provider separate from the default.
Using the FireDAC Connection Editor
Complete the following steps to use the FireDAC Connection Editor to assign a UPS connection to a TFDConnection object:
- Open a project and drop a TFDPhysCDataUPSDriverLink from the Tool Palette onto the Form Designer.
- Drop a TFDConnection object onto the Form Designer.
- Double-click the TFDConnection and select CDataUPS in the Driver Id menu.
- Define the necessary connection properties.
- To execute ad-hoc SQL statements based on this connection, enter SQL commands on the SQL Script tab.
- In the Form Designer, select the TFDConnection object and set the Connected property to true.
Using the Data Explorer
Complete the following steps to use the Data Explorer to define persistent connections that can be shared across applications and projects:
- Click View > Tool Windows > Data Explorer in RAD Studio and expand the FireDAC node.
- Right-click the CData UPS Data Source node and click Add New Connection.
- Enter a name for the connection. The FireDAC Connection Editor opens.
Working with Persistent Connections
The connections you define in the Data Explorer can be assigned to a TFDConnection object by specifying the connection name in the TFDConnection object's ConnectionDefName property.
Browsing Data and Metadata
The Data Explorer also provides options for browsing UPS objects at design time:
- Expand the CData UPS Data Source node in the Data Explorer to view the defined connections.
- Expand a connection node to find the database objects available for a connection.
- Drill down to a database object to find metadata such as primary keys.
- To display data, double-click a table or view or right-click and click View.