Documentation  >  Admin  > 

Mapping Plug-Ins

Mapping plug-ins are managed via the Selection Options screen in the Admin screen in TicketRx.

The "Label" field defines the text that will be displayed on the mapping button in the Ticket Detail screen. The "Value" field defines what plug-in to use. The syntax of the Value field depends on the type of plug-in:

• for Java-based plug-ins, the Value must contain a full class name (including package) of the plug-in class
• for Web-based plug-ins using HTTP POST requests, the Value must contain the URL of the web plug-in starting with "http://".
• for Web-based plug-ins using HTTP GET requests, the Value must contain the URL of the web plug-in preceded with "url:" (for example: "url:http://plugin.url.com/map.php").

Web-based plug-ins using HTTP GET requests can pass custom parameters using HTTP GET query syntax (with URL encoding). For example, if a parameter "param1" with value "val1" must be passed to a web-based plug-in, and ticket number must be passed as a parameter named "ticket", then the following Value can be used:

url:http://plugin.url.com/plugin.php?param1=val1&ticket=$ticket$

Web-based plug-ins using HTTP POST requests are also allowed to pass custom parameters using HTTP GET query string syntax. These parameters are included in the HTTP POST parameters that are sent to the plug-in.

VUPS Mapping

TicketRx can connect to the Virginia Utility Protection Service (VUPS) mapping. It uses HTTP GET requests with the ticket number as a query parameter. The VUPS service URL in TicketRx has the following value:

url:http://www1.vups.org/ocars/apps/web_map_gis_tkt.asp?Operation=MAPINHOUSE&ticket=$ticket-trimmed$

Below is a sample map from the VUPS mapping service:

More Information

More information about creating mapping plug-ins can be found here.