Configuration – DYNAMIC Anywhere Widget variables

Customizing the Anywhere Trip Tool

TripProximity Anywhere Trip Tool can be used by individuals, groups, non-profits or companies for travel to anywhere for any reason.

Examples of use cases could be:

  • Loyalty Program Members or Employees
  • Groups or clubs that share something in common
  • Different channels driving bookings (e.g. different enterprise platforms)
  • Different clients that are using your enterprise platform

If a company already uses a travel agency or an online booking tool for their corporate travel, the Anywhere  widget is not intended as a replacement, , but there are features that could make it attractive for small to mid-sized company use.  This includes the ability to specify the company name that you are seeing or the venue or address that you are visiting.

Static Version

Similar to our other widgets, the Anywhere version of the Smart Trip Tool is built using our TripProximity Portal.  Anyone can register for TripProximity using the Get Started tab on http://www.tripproximity.com and select the Anywhere version of the tool to begin.

Once built and customized, the tool can be hosted on our site or it can be embedded in your site.

If it is hosted on your site, you will be given the snippet of code for your site, which will look something like this:

<script type=”text/javascript” data-id=”tp-widget” data-token=”2v5X28Ox418Y5n4538M9aQ3m6ZFRKYg9dDEb18wYviSQ0g1KLug4NmvjN95teSxq” src=”https://widget.tripproximity.com/js/widget.min.js” async onload=”tripWidget()”></script><div class=”tp-widget” id=”tp-widget”></div>

Dynamic Version

For an organization that wants to track the use of the Anywhere tool by member, individual, group, company, source location, etc., you can use our dynamic widget by checking the “Need a dynamic implementation?” box.   This is displayed once you enter the location where you will be installing the tool on your site.  We need this in order to properly support you and assist with testing.

 

For the dynamic version of the trip tool, you pass the variable tracking parameters to in real time, customizing the tool for members, employees, vendors, clients, locations, etc.   The possibilities are endless.

You begin with the dynamic version of the widget, then add your own custom script.

<script type=”text/javascript” data-id=”tp-widget” data-token=”2v5X28Ox418Y5n4538M9aQ3m6ZFRKYg9dDEb18wYviSQ0g1KLug4NmvjN95teSxq” src=”https://widget.tripproximity.com/js/widget.min.js”></script><div class=”tp-widget” id=”tp-widget”></div>

You will provide the values for the variables at run time via a script that maps the values for this rendition of the widget to the variables listed below.

Here is a sample script from one of our clients:

<script type=”text/javascript”>
tripWidget({
headerText: ‘Plan the trip for John Smith to’,
appendPOI: ‘Y’,
poiName: ‘your destination’,
trackingCode: ‘45048 _John_Smith’,
})
</script>

In the above script, their data has already been passed using a variable name from their system that translates into the data that you see.  So John Smith would be a member or an employee from their database and 45048 would be their client number from their system.

The Parameters for Enterprise Use of the Anywhere Smart Trip Tool

There are several parameters that need to be passed to the anywhere trip tool to correctly track your use of the anywhere trip tool as a part of an enterprise system. These must be rendered in the web page as JSON data dictionary within an Html script tag.  The JavaScript variable name must be set to widgetVars.

If the trip tool is being used for a system that has multiple sources that you wish to track, you will substitute the VARIABLE NAMES in the dynamic anywhere widget that we set up for you with the correct data from your data source at transaction time.

In your script, the variable name will be followed by a colon : and the variable will be ensconced in straight, plain quotation marks. 

Base Variables

The base variables are set in the master widget, which is built and maintained in the TripProximity portal.  Any variables that are then used from the dynamic section below will override the base variables.

Function Variable Name Purpose and example Enterpr. Variable Mandatory Description
Destinaton Name poiName Name of the venue to appear as “I need a hotel near” and also on the booking results page (as the POI and the “0.1 miles away from POI NAME” field for each hotel listed. Y N This defaults to My Destination for the Anywhere tool and the user fills this in at transaction time.  They can enter a company name or venue name and the system will look up the address or they can enter an address.
Image imageUrl The URL for the image on the tool. Y N Optional.  If you do not have your own image, the default image is the button provided by TripProximity for each of our brands.  Your custom image can be up to 350 pixels tall and up to 670 pixels wide.
Default Tab active_tab Determines which tab will orient as the front window in a multi-tab format. N N The HOTEL tab is the default front tab.   For the Anywhere tool, since there is no stored address, the MAP tab can’t be used as there wouldn’t be anything to map.
Country country Two-digit country code N N This is set as a default in the base widget in the TripProximity Portal.   Two-digit code for the country.   Defaults to US.
Currency currency Currency code (ie. USD, CAD) N N This is set as a default in the base widget in the TripProximity Portal.  The default is USD.   The traveler can change the pricing currency when the results are displayed.
Widget Header Text headerText Widget title that appears in a transparent container above the widget.  headerText: “Smart trip planning for %name%“, Y N This can be modified for a particular individual or group, in which case you would pass your variable name as a part of the header text.  E.g. Smart trip planning for John Smith, where John Smith might be %name% in your system.
Image Link imageLink The URL for the link from the image.  imageLink: ‘https://www.solutionz.com’, Y N This is not mandatory.  This is the  link for where the user will go when they click on the image. The link can take you to any other website, blog, page represented by a URL
Branding refId This field determines the branding on the booking back end header and footer.  In this example, this is the code for theHotelsNearbyPlaces   refId: 6832, Y N The default is 6832 for the Hotels Nearby Places brand.  There are a number of optional niche brands available.  See the portal.
Branding refClickId2 This allows you to choose one of our niche brands, coupled with the use of refid 6832.  refClickId2: ‘hotelsbycompanies’, Y N You may set this to 6832 to take advantage of one of our other brands.  You would use the refClickID2 from the full brand list.  See the portal.
Address address If no geographic coordinates are provided these parameters will be used to calculate the proximity for the hotel search.  address: ‘118 Rue du 4 Septembre, Paris’, Y N Not required for Anywhere tool, as it is filled in at transaction time
Address city The address must be searchable on Google Maps API in order to result in a valid search.   city: ‘Atlanta’ Y N Not required for Anywhere tool, as it is filled in at transaction time
Address state The state or province for US or Canadian addresses. Y N Not required for Anywhere tool, as it is filled in at transaction time
Address postcode The zip or postal code for the address. Y N Not required for Anywhere tool, as it is filled in at transaction time

The Anywhere Trip Tool Variables

If you would like to use the dynamic version of the Anywhere smart trip tool, your developer will write a script that passes the variables from your system in real time into the widget code at the time the widget is rendered.

 

Dynamic Venue Variables for the Anywhere tool

Function Variable Name Purpose and example Enterpr. Variable Mandatory Description
Combine Header Text and Venue or Event Name appendPOI Append the POI to the widget title.
appendPOI: ‘Y’,
N N This is set as a default in the base widget in the TripProximity Portal.  If set to Yes, the header text and poi_name will be appended.
Tracking trackingCode Your internal tracking code for your customers or business segments. trackingCode: ‘TPT-HDQ’, Y Y Can be up to 15 characters, alpha-numeric
Airport airport Three-character airport code airport: ‘ORD’, Y N IATA 3-character code representing the closest airport.
Token dataToken The token number from the widget that you wish to use for tracking

dataToken: ‘JeRtSYkbmNqrQjue7c4LSM3Vy9YU’

Y N If you have multiple widgets that you have created so that you can track placement source, you can write one script and substitute the correct dataToken at display time.

Comments are closed.