Newyse Templates

This page has been moved from General Documentation to here (Maxxton Knowledge Base)

For testing purposes, use the contents of AllTags.txt, put them in a Template and wrap them in a Report to verify what the value of each tag is.

Table of Contents

Purpose 

The template module is mentioned to create emailtemplates for all kind of purposes like reservationconfirmations. These templates are generic and contain different tags which will be replaced by specific data for that reservation.

PDF Files 

We're now using the templates too to generate email attachments with pdf or txt files. This requires a more strict template but we've built in some tools to help the user.

To make use of page breaks put the following code in the header of your HTML:

<style>
  @media print {
    .pagebreak { page-break-after: always; }
  }
</style>

Then, at places inside your text where you would want to start a new page use the following DIV-tag:

<div class="pagebreak"> </div>

Velocity Tools 

From Newyse 2011R1 we added Velocity Tools to the templates. This is a set of utilities which help you with certain things. Like parsing a date, mathmetical things etc.

You can read about the different tools here:Tools

• AlternatorTool - For creating Alternator to easily alternate over a set of values.
• ClassTool - For simplifying reflective lookup of information about Classes and their fields, methods and constructors.
• ContextTool - For convenient access to Context data and meta-data.
• ConversionTool - For converting String values to richer object types.
• DateTool & ComparisonDateTool - For manipulating, formatting, and comparing dates.
• DisplayTool - For controlling display of references (e.g. truncating values, "pretty printing" lists, and displaying alternates when a reference is null).
• EscapeTool - For common escaping needs in Velocity templates (e.g. escaping html, xml, javascript etc.)
• FieldTool - For (easy) access to static fields in a class, such as string constants.
• LoopTool - A convenience tool to use with #foreach loops. It wraps a list with a custom iterator to provide greater control, allowing loops to end early, skip ahead and more.
• LinkTool - For creating and manipulating URIs and URLs. The API for this tool is designed to closely resemble that of the VelocityView tool of the same name.
• ListTool - For working with arrays and lists, treats both transparently the same.
• MathTool - For performing math functions.
• NumberTool - For formatting and converting numbers.
• RenderTool - To evaluate and render arbitrary strings of VTL, including recursive rendering.
• ResourceTool - For simplified access to ResourceBundles for internationalization or other dynamic content needs.
• SortTool - Used to sort collections (or arrays, iterators, etc) on any arbitary set of properties exposed by the objects contained within the collection.
• XmlTool - For reading/navigating XML files. This uses dom4j under the covers and provides complete XPath support.
• NF525 audit related tags more details refer url /wiki/spaces/TP/pages/299991251
• Loyalty tags

Customer based templates 

A template can contain plain text and html formatted text, the html format makes it possible to add tables, images, hyperlinks etcetera in the template.

This is a list of tags and loops which are supported for now.

General:

  $current_date , the current date

Customer:

$customer.customerId

$customer.title

$customer.firstname

$customer.middlename

$customer.lastname

$customer.attentionOf

$customer.account

$customer.birthDate

$customer.sex

$customer.vatNumber

$customer.company (returns true or false)

$customer.companyName

$customer.department

$customer.ibanNumber

$customer.owner (returns true or false)

$customer.alternateName

$customer.login

$customer.title

$customer.language

$customer.address.address1

$customer.address.address2

$customer.address.housenumber

$customer.address.housenumberSuffix

$customer.address.zipcode

$customer.address.city

$customer.address.district

$customer.address.email

customer.address.countryCode

$customer.address.countryName

$customer.address.mobilePhone

$customer.address.privatePhone

$customer.address.workPhone

$customer.address.poBox

$customer.address.poBoxZipcode

$customer.address.poBoxCity

$customer.address.fax

Customer Care - customer-based templates

For Customer Care, it is possible to configure templates for ad-hoc messages through Customer Care. These templates use the same context as the regular customer templates, but don't support all the same tags. 

The most important tag for these kinds of templates is $custom_message, this will be replaced by the text that the users type. 

Reservation based templates 

A template can contain plain text and html formatted text, the html format makes it possible to add tables, images, hyperlinks etcetera in the template.

This is a list of tags and loops which are supported for now.

General:

  $current_date , the current date

Specific accommodation: (better use the new resourcelist and use thise only for infotexts)

  #foreach($acco in $accommodationList)  or (fakturen)--> ($acco in $parentAccommodationList) Loop on accommodation list.

$acco.accommodation_description

$acco.accommodation_name

$acco.accommodation_object

$acco.accommodation_start_date

$acco.accommodation_end_date

$acco.accommodation_object_forced

$acco.accommodation_object_infotext

$acco.accommodation_object_infotext_priority

$acco.accommodation_object_infotext_code

$acco.accommodation_object_infotext_addtovoucher

$acco.accommodation_object_infotext_addtotravel

$acco.accommodation_object_infotext_addtoprint

$acco.accommodation_object_infotext_type

$acco.accommodation_checkintime

$acco.real_accommodation_checkintime

$acco.accommodation_doorlock_pincode

$acco.accommodation_doorlock_pincode_early_checkin

$acco.accommodation_checkouttime

$acco.real_accommodation_checkouttime

$acco.accommodation_kind

$acco.accommodation_kind_code

$acco.accommodation_kind_dynamicfield

$acco.accommodation_representation_name

Accommodation representation name

$acco.accommodation_address1

Address of accommodation

$acco.accommodation_housenumber

Accommodationhouse number

$acco.accommodation_housenumber_suffix

Accommodation house number suffix

$acco.accommodation_zipcode

Zipcode of accommodation

$acco.accommodation_city

City of accommodation

$acco.accommodation_countryname

Country of accommodation

$acco.accommodation_countrycode

Accommodation country code

$acco.accommodation_phonenumber

Accommodation phone number

$acco.accommodation_statename

Accommodation state name

$acco.accommodation_statecode

Accommodation state code

$acco.accommodation_key_housenumber

Alternative Key pickup location house number

$acco.accommodation_key_housenumber_suffix

Alternative Key pickup location house number suffix 

$acco.accommodation_key_zipcode

Alternative Key pickup location zip code

$acco.accommodation_key_city

Alternative Key pickup location city

$acco.accommodation_key_countryname

Alternative Key pickup location country

$acco.accommodation_key_latitude

Alternative Key pickup location latitude

$acco.accommodation_key_longitude

Alternative Key pickup location longitude

$acco.accommodation_gas_start_date,

Gas start date

$acco.accommodation_gas_start_value,

Gas start value

$acco.accommodation_gas_end_date,

Gas end date

$acco.accommodation_gas_end_value,

Gas end value

$acco.accommodation_electricity_start_date,

Electricity start date

$acco.accommodation_electricity_start_value,

Electricity start value

$acco.accommodation_electricity_end_date,

Electricity end date

$acco.accommodation_electricity_end_value,

Electricity end value

$acco.accommodation_water_start_date,

Water start date

$acco.accommodation_water_start_value,

Water start value

$acco.accommodation_water_end_date,

Water end date

$acco.accommodation_water_end_value

Water end value

$acco.accommodation_cleansing_start_date,

Accommodation cleansing start date

$acco.accommodation_cleansing_start_value,

Accommodation cleansing start value

$acco.accommodation_cleansing_end_date,

Accommodation cleansing end date

$acco.accommodation_cleansing_end_value,

Accommodation cleansing end value

$acco.accommodation_images,    

Accommodation images

$acco.accommodatoin_dynamic_field

Accommodation dynamic field

$acco.accommodation_object_dynamic_field

Accommodation object dynamic field

$acco.accommodation_object_brand_name

Accommodation object brand name

$acco.accommodation_parent_name

Accommodation parent name

$acco.accommodation_parent_code

Accommodation parent code

$acco.accommodation_parent_id

Accommodation parent id

$acco.accommodation_memos

Accommodation memos

$acco.accommodation_type_memos

Accommodation type memos

$acco.object_description_forced

Object description

$acco.object_short_description_forced

Object short description

$acco.accommodation_is_imply

Accommodation is empty (returm true or false)

$acco.accommodation_object_id

Accommodation object id

$acco.reserved_resource_id

Reserved resource id of resource

$acco.accommodation_short_description

Accommodation short description

$acco.object_preference

Object preference

$acco.object_short_description

Object short description

$acco.object_description

Object description

$acco.adjacent_preference

Is adjacent preference for accommodation (return 0 or 1)

$acco.misc_preference

Accommodation miscellaneous preference.

$acco.accommodation_dynamic_field

Accommodation dynamic fields: list of <key, value>-pairs where the key is the code which was given to the dynamic field

$acco.accommodation_type_address1

Accommodation type address first

$acco.accommodation_type_housenumber

Accommodation types house number

$acco.accommodation_type_housenumber_suffix

Accommodation types house number suffix

$acco.accommodation_type_address2

Accommodation types address second

$acco.accommodation_type_po_box

Accommodation types po box number

$acco.accommodation_type_po_box_zipcode

Accommodation types po box zipcode

$acco.accommodation_type_po_box_city

Accommodation types po box city

$acco.accommodation_type_city

Accommodation types city

$acco.accommodation_type_zipcode

Accommodation types zip code

$acco.accommodation_type_phonenumber

Accommodation types phone number

$acco.accommodation_type_latitude

Accommodation types latitude

$acco.accommodation_type_longitude

Accommodation types longitude

$acco.accommodation_type_countryname

Accommodation types country name

$acco.accommodation_type_countrycode

Accommodation types country code

$acco.accommodation_type_statename

Accommodation types state name

$acco.accommodation_type_statecode

Accommodation types state code

$acco.accommodation_type_propertymanager_id

Accommodation types property manager id

$acco.accommodation_propertymanager_id

Accommodation property manager id

$acco.accommodation_parent_images 

Accommodation parent images

$acco.accommodation_free_fieldList

Accommodation free fieldList from Unit level (use with the forEach loop to print all free field list)

$acco.accommodation_nr_of_bedrooms

Accommodation number of bedrooms

$acco.accommodation_nr_of_bathrooms

Accommodation number of bathrooms

$acco.accommodation_turnover

Accommodation turnover price

  #end

Resource: (better use the list below)

 #foreach($res in $resourceList)  or (fakturen)--> ($res in $parentResourceList) Loop on resource list

  #end

Reserved resource:

  #foreach($resource in $reservedResourceList) Loop on reservedresource list

  $resource.subjectCapacityList.A2 

A2 is reportgroup_subject code for senior, So here it will give senior capacity for accommodation

 #end

Terms:

  #foreach( $term in $termList ) Loop on term list

  #end

$term_confirmation_text

Customer :-

Paying Customer:

Employee:

Supplier:

Owner:

$owner_emails

#foreach($owner in $ownerList) loop for owner tags

$owner.owner_firstname

$owner.owner_middlename

$owner.owner_lastname

$owner.owner_language

$owner.owner_send_menthod

$owner.owner_country

$owner.owner_address1

$owner.owner_housenumber

$owner.owner_housenumber_sufix

$owner.owner_zipcode

$owner.owner_city

$owner.owner_email

$owner.owner_currency_id

$owner.owner_currency_symbol

$owner.owner_currency_code

Reservation:

Custom Fields (a.k.a. Free Fileds):

  #foreach( $field in $reservation_free_field_list ) Loop through all Custom Fields in the reservation

$field.name

$field.value

 #end

Billlines:
   #foreach( $bill in $billList ) Loop of bill list

$bill.bill_type

$bill.bill_resource

$bill.bill_cashflowrule

$bill.bill_startdate

$bill.bill_enddate

$bill.bill_value

$bill.bill_value_without_format

$bill.bill_quantity

$bill.bill_quantity_multiplier

$bill.bill_total

$bill.bill_total_without_format

$bill.bill_linetype

$bill.bill_multiplier

$bill.bill_resource_type 

Resource type like products or extra's

$bill.bill_resource_id 

Resource Id of the bill line.

$bill.bill_payer_type 

Payertype like c(ustomer), p(aying customer) or a(gent)

$bill.bill_total_excl_vat

 #end

BillLines excluding VAT:

#foreach( $bill_excl_vat in $billList_excl_vat ) Loop on bill list ( bill excluding vat).

$bill_excl_vat.bill_type

$bill_excl_vat.bill_resource

$bill_excl_vat.bill_cashflowrule

$bill_excl_vat.bill_startdate

$bill_excl_vat.bill_enddate

$bill_excl_vat.bill_value

$bill_excl_vat.bill_value_without_format

$bill_excl_vat.bill_quantity

$bill_excl_vat.bill_total

$bill_excl_vat.bill_total_without_format

$bill_excl_vat.bill_linetype

$bill_excl_vat.bill_multiplier

$bill_excl_vat.bill_quantity_multiplier

$bill_excl_vat.bill_resource_type

Resource type like products or extra's

$bill_excl_vat.bill_resource_id

Resource Id of the bill line.

$bill_excl_vat.bill_payer_type

Payertype like c(ustomer), p(aying customer) or a(gent)

$bill_excl_vat.bill_total_excl_vat

$bill_excl_vat.bill_total_excl_vat_without_format

#end

Grouped billlines: This is the same list as above but with slightly less fields. When the resource is the same one, we group the lines to one line and sum the values. Can be useful in group reservations.

#foreach( $bill in $groupedBillList ) Loop of group bill list for grouped bill lines.

#end

Grouped billlines excluding VAT:

#foreach( $bill_excl_vat in $groupedBillList_excl_vat ) Loop of groupedBillList (bill excluding vat)

  #end


FYI : wawb stand for Withholings And Warrants Bill 

#foreach( $bill_excl_vat in $withholings_and_warrants_bill) Loop of Withholings And Warrants Bill use in cognos to template convert 

#end

Reminders:

  #foreach( $rem in $reminderList ) Loop of reminder list

  #end

Memo's:

  #foreach( $memo in $memoList ) Loop for memo list

  #end

Memo's:

    #foreach( $memo in $reservation_memolist ) Loop for  reservation_memo List

Subjects:

  #foreach( $subject in $subjectList ) Loop for subject list

  #end

Travel subjects:

  #foreach( $subject in $travelList ) Loop for travel list

 #end

 #foreach( $vehicle in $travelVehiclesList) Loop for travel list

#end

Received Payments:

  #foreach( $receivedPayment in $receivedPaymentList) Loop for received payment list

   #end

Questionnaires:

  #foreach( $questionnaire in $questionnaireList) Loop for questionnaire List

  #end

Business snapshot:

#foreach($snapshotDetail in $snapshotDetailList)

 #foreach($vatRate in $snapshotdistinctvatratelist)

  $vatRate.snapshot_vat_rate

  $vatRate.snapshot_vat_sum

  #end

Issue Invoices:

  #foreach($issueIncident in $issueIncidentList) Loop for issue incident
 

 #end

WorkOrder:

TipsTrips:

  #foreach($trip in $tips_trips) Loop for triptrips

  #end

Currency:

Login Employee

 #foreach($energy in $energyList) 

Debit card transaction tags

#foreach( $debitCardTransaction in $debitCardTransactionList )

Debit card availability tags

foreach ($debitCardItem in $debitCardAvailabilityTagList)

Reservation event list tags

#foreach( $reservationEvent in $reservationEventList )

Loyalty Transaction: 

#foreach($loyalty in $loyaltyTransactionList)

Tag for formatting dates in template

$dateFormatter.format("name of tag" , "required date format")    e.g.  $dateFormatter.format("reservation_arrivaldate" , "dd-MM-yyyy")

$dateFormatter.increment(date, days, month, year)    e.g. increase date by 1 day using $dateFormatter.increment($reservation_reservationdate , 1,0,0)

Below is a list of date variables to use with dateFormatter:

EEE - Short day name (Fri)  

EEEE - Full day name (Friday)  

HH:mm - 24 hour clock (13:00)  

hh:mm - 24 hour clock (1:00)  

a - Shows am/pm (am)  

mm - Minutes with leading zero (60)

dd - Day in month with leading zero (09)  

DD - Day in year (64)  

M- Month (7)  

MM- Month with leading zero (07)  

MMM - Short month name (Jul)  

MMMM - Full month name (July)  

yyyy - Full year (1985)  

yy - Shortend year (85)  

Basic components:

G - era designator (AD)  

y - year (1996)  

M - month in year (July & 07)  

w - week in year (27)  

W - week in month (2)  

d - day in month (10)  

D - day in year (189)  

F - day of week in month 2 (2nd Wed in July)  

E - day in week (Tuesday)  

h - hour in am/pm (1~12) (12)  

H - hour in day (0~23) (0)  

k - hour in day (1~24) (24)  

K - hour in am/pm (0~11) (0)  

m - minute in hour (30)  

s - second in minute (55)  

S - millisecond (978)  

z - time zone (Pacific Standard Time)  

' - escape for text  

'' - single quote (')

For more info on formatting these strings see the Java docs

messageTool tag ("messageTool" is a general tag for getting message data in template)

$messageTool.getAccommodationProperties($accommodation)

$messageTool.getAccommodationTypeProperties($accommodation)

#foreach($acco in $accommodationList)
     #foreach($property in $messageTool.getAccommodationProperties($acco))

     #end
#end

Info text tag list

#foreach( $infotext in $infotextList )

Energy section tag list

#foreach( $energySection in $energySectionList )

Loyalty tag list

Transaction Loyalty tags 

Independent tags for both Loyalty context and reservation context:

#foreach($loyalty in $loyaltyTransactionList) 

#end

Inner List

#foreach($loayalty in $loyaltyTransactionList)
#foreach($trans in $loayalty.loyaltyTransactionReferenceList)

#end

#end

For emails, based on notifications created by the notification-service, the following tags are available: 

numberFormatter tag ($numberFormatter.format())

This tag is for formatting the bill amount according to current customer language.

Note: Please use this tag with other *_without_format tag only.

e.g. $numberFormatter.format($bill.bill_total_without_format)

loginUrlGenerator tag ($loginUrlGenerator.generate($email, $landingPage))

This tag is for creating a hash to get access on login/password change page in MyEnvironment

$loginUrlGenerator.generate($email)

or with a landingpage (redirected to after success login)

$loginUrlGenerator.generate($email, $landingPage)

GroupBill function for grouping Billlines $messageTool.groupBill($billList,"resourceId","startDate","endDate")

function groupBill is used for grouping the bill lines on the basis of parameters which is passed to that function.
parameters which we can pass are "resourceId", "startDate", "endDate".
Example: $messageTool.groupBill($billList,"resourceId","startDate","endDate");
in this we have added resourceId , startDate and endDate as a grouping parameters the function will group the contents of bill lines according to this fields.
Note: (quantity, multiplier will not be used in the case of group bill).

Tips

• When using pdfs, add "@page { margin: 0; }" to the CSS. This will generate a pdf with smaller margins.
• The templates will be parsed using the Velocity template engine which is part of the Jakarta project from Apache. There are several keywords to use in the template which gives a lot of freedom to the template author. They are all explained in the user guide. The website can be found here:Velocity

Reservation distribution channel

Payment Link function $messageTool.generatePaymentLink(successUrl,cancelUrl,failUrl,paymentTerm,paymentMethods[])

parameters

successUrl/cancelUrl/failUrl - Client provided urls per payment status (success, cancelled, failed).

paymentTerm - this should be from first/all/due/Deposit one of this.

• First : Link will generate for the amount from first payment term from particular reservation. it will not check whether it's close or open
• All : Link will generate for the amount from all payment terms from particular reservation. it will not check whether it's close or open.
• Due : Link will generate for total due amount from all payment terms from particular reservation.
• Deposit : Link will generate for the amount of deposit payment term (it's checking the name of the payment term for this case ).

paymentMethods - payment method which need to be displayed on ingenico page.

Generate Barcode feature please Click here...

Olde Method Name : $messageUtil.generateBarcodeLink("BarcodeNumer") This is still working but only return barcode type CODE_39
New Method Name : $messageUtil.generateBarcodeLink("BarcodeNumber", "BarcodeType")
Where :
@Text : BarcodeNumber 
@BarcodeType : Below is BarcodeType value we support in our tool 

Note: We not support PDF_417 Type seems it create some error I already created issue in Zxing to resolved it so once it resolved we can provide PDF_417 Type as well
https://github.com/zxing/zxing/issues/1190

Note: Barcode type is case insensitive and if you pass any value apart from above list it select default CODE_39 type