fbpx
HomeConfiguration – Enterprise Client Guide

Configuration – Enterprise Client Guide

December 15, 2017 By Chicke Fitzgerald Comments are Off

Customizing your Smart Trip Widget for integration into your Enterprise System

Welcome to the TripProximity family.  Your Account Director will be providing you the code snippet(s) for integration into your enterprise system.  You will be provided with:

  • A venue widget snippet for your company headquarters location, which can be used to build a VISIT US page.
  • Snippets for any venues and events that you wish to create as hardcoded, static widgets.  These can be installed as is right away.
  • Snippets for any dynamic widgets (venue or event) that you wish to customize for implementation within your system, to be modified with your own variable data at display time.

The snippet will look like this:

<script type="text/javascript" data-id="widget" data-token="NgObJk17FFQyh1J0YZu461tA7h57iN1nCdtc572QUtUdS6yqi31yAYVCY09pOJb0" src="https://widget.tripproximity.com/js/widget.min.js" async onload="tripWidget()"></script><div id="widget"></div>

If you are going to install our dynamic tool, you will need to use this same snippet, but manually remove the following:

async onload="tripWidget()"

Then, you can append whatever variable names you wish to substitute at display time.  This will be done by entering the following (where providing the variable information from your system)

<script type=”text/javascript”>
tripWidget({
daysFromToday: ‘4’,
numberOfDays: ‘2’,
refId: 6856,
refClickId2: ‘hotelsbycompanies’,
imageUrl: ‘https://onpointexecutivecenter.com/wp-content/uploads/2014/03/offices.jpg’,
imageLink: ‘https://www.solutionz.com’,
headerText: “Solutionz Headquarters in Tampa”,
address: ‘118 Rue du 4 Septembre, Paris’,
poiName: ‘Solutionz HDQ’,
trackingCode: ‘TPT-HDQ’,
airport: ‘ORD’
})
</script>

 

 

 

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

Variable Name Purpose Enterprise Variable Req/ Opt Description
wdgt_image_URL The URL for the image on the graphical widget.

Y

N

 Optional.  If you do not have your own image, the default image is the Where Should I Stay button from TripProximity.
Recommended size: 150 x 150 pixels Image can be less than 150 pixels tall, but not wider than 150 pixels proportionately.
wdgt_link_URL The URL for the link from the image

Y

N

 This link only works if you have an image. The link can take you to any other website, blog, page represented by a URL.
 wdgt_st_type  event or venue

Y

  Tells the system how to handle the date display.
header_text Widget title, which defaults to “Plan your trip near”

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.
poi_name Name of the venue to appear on the booking results page

Y

Y

 This should be the short version of the name of the venue.
append_poi Append the POI to the widget title.

N

 If append_poi is set to Yes, the header text and poi_name fields will be appended.
tabs Ability to turn on/off widget tabs using a mask value. Please see the tabs possible values table at the bottom of this page.

N

 Default setting is 0x111, which is our complete widget with hotel, driving directions and car rental, plus air.
­­­­­tab order Determines which tab will orient as the front window in a multi-tab format.

Y

 The HOTEL tab is the default front tab, so the default setting is H.  The tabs remain in the same physical order.  This just changes the logical first tab.
latitude Geographic coordinate.

Y

N

 Optional, but will override the street address if included.
longitude Geographic coordinate.

Y

N

 Optional, but will override the street address if included.
refid This field determines the branding on the booking back end header and footer.

Y

 The default is 5135 for the TripProximity brand.  Your account director will provide the correct refid.
refclickid Customer ID from the customer’s client base.

Y

Y

 Mandatory that this field include the refclickid code provided by your account director, as this is used to track analytics for widget use and bookings.
Optionally you may append up to 35 characters to be used for tracking of the bookings from your account.  This can include your customer numbers, event numbers or the channel used (email, web, blog).
Your account director will work with you to determine how to structure.
 refclickid2 This is only used when you elect to use one of our Hotelsby brands.

Y

  The refid must be set to 6832, then you would use one of our brands.  For brand list see http://tripproximity.com/brands
cname Booking backend URL

N

 Optional (default to booking.thehotelnearby.com).
This must be a valid CNAME for the host site.
address If no geographic coordinates are provided these parameters will be used to calculate the proximity for the hotel search.

Y

N

 Optional if geographic coordinates were provided.
city The address must be searchable on Google Maps API in order to result in a valid search.

Y

Y

 Mandatory if lat/long is not used.
stateprovince

Y

Y

 Mandatory if lat/long is not used.
postalcode

Y

N

 Optional if geographic coordinates were provided.
country Two-digit country code

Y

Y

 Two-digit code for the country.  Defaults to US.
airport Three-character airport code

Y

N

 IATA 3-character code representing the closest airport.
currency Currency code (ie. USD, CAD)

Y

N

 The default is to take it from the browser’s language as determined by the IP Address.
check_in Numbers of days between today and the default check in date.

Y

Y

 This is used for venues (default 7).  Events use the event date parameters.
check_out Number of days between today and the default check out date

Y

Y

 This is for venues (default 9).  Events use the event date parameters.
guests Default selected number of guests.

Y

 Default to 2
rooms Default selected number of rooms.

Y

 Default to 1
hotel_stars Default hotel star ratings to be included in the hotel results.

N

 Optional (default 3,4,5)
pick_up Numbers of days between today and the default pick up date for car rental.

Y

N

 Defaults to 7 for venue widget if Driving Directions is used – uses event dates for event widget.
drop_off Numbers of days between today and the default drop_off date for car rental.

Y

N

 Defaults to 9 for venue widget if Driving Directions is used- uses event dates for event widget.
departure Numbers of days between today and the default departure date.

Y

 Y Defaults to 7 for venue widget if AIR is used – uses event dates for event widget
return Numbers of days between today and the default return date.

Y

Y

 Defaults to 9 for venue widget if AIR is used – uses event dates for event widget
social Include social sharing.

N

  Y (default)
 

TABS
This section shows you how to adjust the tabs value to include or exclude the I’m Driving and I’m Flying tabs from the widget.
0x100 HOTEL ONLY – I’m Staying Only (if this is the only widget it does NOT have a tab)
0x110 HOTEL and DRIVE – I’m Staying plus I’m Driving. This is NOT recommended for venues on an island.
0x101 HOTEL and FLYING – I’m Staying plus I’m Flying.  At this time, this is not recommended internationally.
0x111 ALL TABS – I’m Staying plus I’m Driving plus I’m Flying.  At this time, this is not recommended internationally.

Comments are closed.