Configuration – DYNAMIC Venue Widget variables

Customizing the DYNAMIC Venue Trip Tool

Companies and venue managers may customize the TripProximity Trip Tool for use with any corporate website or venue page, any blog or any enterprise system that lists/aggregates company lists or venues.

It can be hard coded with a single venue’s information, or an organization that has multiple venues or that lists/aggregates venues can use our dynamic widget.  For the dynamic version of the trip tool, you would pass the variable parameters to us at time of display of the trip tool, customizing literally hundreds or thousands of pages.

There are several parameters that need to be passed to the venue trip tool to operate correctly. These must be rendered in the web page as JSON data dictionary within an Html script tag like the sample at the bottom of this page.

The trip tool can be hardcoded with all of this information for your company or venue (such as on the CONTACT US or VISIT US page on your corporate website).  If the trip tool is being used for a system that has multiple venues, you will substitute the %VARIABLE NAMES% with the correct data from your landing page for the venue at transaction time.

The Widget Variables

Base Variables

Function
Variable Name
Purpose
Enterprise Variable
Required
Description
Default Tab active_tab Determines which tab will orient as the front window in a multi-tab format. N Y This is set as a default in the base widget in the TripProximity Portal.   The HOTEL tab is the default front tab. The tabs remain in the same physical order.  This just changes the logical first tab.  The alternative is the MAP tab.  Air and Car tabs cannot be “Active” tabs
Country country Two-digit country code N Y 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.

 

The Venue Trip Tool Date Variables

The venue trip tool variables drive the hotel check-in and checkout dates and also the car rental and air dates.  They also drive defaults for the car rental and air dates.  If the hotel dates are changed, the car rental and air dates will reflect the change.

Parameter Name

Description

Mandatory

Format/Defaults

Checkin daysFromToday The number of days from the day the widget is displayed drives  the default checkin. N This is set as a default in the base widget in the TripProximity Portal. daysFromToday: ‘4’,
Checkout numberOfDays The number of days of the stay N This is set as a default in the base widget in the TripProximity Portal. numberOfDays: ‘2’,

The Widget Variables

Dynamic Variables

Function

Variable Name

Purpose and example

Enterprise Variable

Req

Description

Widget Header Text headerText Widget title that appears in a transparent container above the widget.  headerText: “Plan your trip to “, Y Y This can also be a more complete description of an event or venue, in which case you would ensure that the append poi flag is set to N.  This flag is controlled in the Portal as a default in the setup of your widgets, but can also be included as a variable.
Short Name (venue or event) 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.    poiName: ‘Billy Joel Concert’, Y Y This should be the short version of the name of the venue.
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.
Image imageUrl The URL for the image on the graphical widget.    imageUrl: ‘https://onpointexecutivecenter.com/wp-content/uploads/2014/03/offices.jpg’, Y N Optional.  If you do not have your own image, the default image is the Where Should I Stay button from TripProximity.  Your image can be up to 350 pixels tall and up to 670 pixels wide.
Image Link imageLink The URL for the link from the image.  imageLink: ‘https://www.solutionz.com’, Y N 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 theHotelsNearby Events.  refId: 6856, Y Y The default is 5135 for the TripProximity brand.  There are a number of optional niche brands available.  See Attachment A.
Branding refClickid2 This allows you to choose one of our niche brands, coupled with the use of refid 6832.  refClickId2: ‘hotelsbycompanies’, Y Y If the refid is set to 6832 to take advantage of one of our brands, you would use the refClickID2 from the full brand list (see Attachment A.)
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
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 Optional if geographic coordinates were provided.  For enterprise clients, this field can contain the entire address (see example), or can be just the street address if you are using city, state/province, postcode.
Address city The address must be searchable on Google Maps API in order to result in a valid search.   city: ‘Atlanta’ Y Y Only mandatory if you do NOT use the entire address as the override in the %address% variable field.
Address state The state or province for US or Canadian addresses. Y N Optional (initial lookup is in the address and city, so in most cases, state/province is not needed)
Address postcode The zip or postal code for the address. Y N Optional (initial lookup is in the address and city, so in most cases, postcode is not needed)
Airport airport Three-character airport code airport: ‘ORD’ Y N IATA 3-character code representing the closest airport.

Comments are closed.