Admin Pro Tools Fedex® XML Tool - Installation / Quick Start Guide
Installation/Setup:

NOTE:
2 Versions of this tool are available
- CF5 Version: This package is compatible with CF Server 5/4.5 on Windows only (CF5 on Linux is not supported)
- CFMX Version: This package is compatible with CF Server CFMX 6 and above on both Windows and Linux

Pre-requisites (Server side)
CF5 Version
- Windows NT4 Server / Windows 2000 Server / Windows 2003 Server / Windows XP Pro
- Must have MSXML installed on the server (free download from Microsoft). Most servers from Windows 2000 Server forward have this installed by default
- Free soxml.cfm custom tag

CFMX
- No special requirements

1. unzip the package received.

2. Upload the file
- adminpro_fedexxml.cfm
- soxml.cfm (CF5 Server ONLY)

to your server's CustomTags directory (usually C:\Cfusion\CustomTags) or if you do not wish to place these tags in your Custom Tags directory or are unable to then you must have both files in the same directory from where you plan on calling them from in your web site and you can use either the custom tag syntax or use cfmodule to reference the custom tag.

3. You must register with Fedex to receive a valid Fedex meter number, this can be achieved by contacting Fedex technical support or by running the RegisterRequest to request your own meter number.

Quick Start Guide:

Using the adminpro_fedexxml.cfm Custom Tag is very simple the following is the basic flow of requests

  1. Call the custom tag (if in the same directory as the calling template or if installed in the CustomTags directory of the server) in the following way <cf_adminpro_adminpro_fedexxml function="Request Name" …>
    OR
    you can reference the custom tag directly using the cfmodule tag e.g.
    <cfmodule template="path-to-custom-tag/adminpro_adminpro_fedexxml.cfm function="Request Name"…>
  2. Pass the required information to the relevant attributes for each request (examples of every request and parameters required below)
  3. Process response, first variable to check for is FedexError , if this variable exists and its value is 0 (zero) then check display the variables available to each specific request (all available variables and query names if appropriate are defined in the relevant documentation for each request)

Additional Notes:

Debug Mode
The tag has a Debug mode that can be activated for all requests by simply passing the attribute Debug="True" which will place the tag in debug mode and will not process the response and populate the respective variables. Instead the XML request file will be written to the server in the Debug directory (it must be present with write permissions at the same level as where the tag is called from) and the XML response received from USPS will be dumped to screen (if for CF 4.5/5 you have objectdump.cfm Custom tag installed)

Testing/Development
The tag may also be directed to use the Fedex Test Server to submit requests to when testing and developing, simply pass the parameter
TestingEnvironment="true" .