Start a conversation

Multiline Merge fields

This facility only exists in Influence Professional versions later than 1.00.14.064 and some TYPES only exist in later versions of the software. (e.g. The CANDDOCS type is only available from ver 1.00.15.234 or later)


Contents  (Click an Item to Jump to that section)

Overview

Syntax for Multiline

Syntax for Multiline inside a table

Example of a Multiline Merge Field

List of Types

Booking Multiline

Examples

Candidate Documents Multiline

Compliance Multiline

Examples

Interviews Multiline

Invoice Multiline

Journal Multiline

Examples

Example of Compliance Document Attachment


Overview

The Influence software has a new MULTILINE merge facility which can be used on template documents and template emails to display multiple records. This is often useful for producing particular emails such as a summary of a candidate bookings, or a confirmation to a client with multiple interview dates/times on a single email.

 

Syntax for MULTILINE.

Usage:

[[MULTILINE=TYPE;Parameter1=xxxxx;Parameter2=xxxxx;….]] FFFFFFFFF [[/MULTILINE]]

Where TYPE is replaced with one of the TYPEs listed below, and the Parameters are replaced with one (or more) of then Parameters associated with the chosen TYPE.
Parameters should be separated with a semi-colon. (;)
FFFFFFFF should be replaced with fields chosen from the Catalogue


Back to top




Syntax for MULTILINE inside a TABLE

It is also possible to 'wrap' a Multiline field inside a TABLE field to create an output that displays the data within a Table. 

Essentially the format is:

[[*TABLE=4 | Title 1 | Title2 | Title 3 | Title 4 | [[MULTILINE=?????]]  Field 1   |  Field 2  | field 3 |  field 4 | [[/MULTILINE]]  *]]


As you can see, the [[MULTILINE=????]] needs to be included in the first table field after the Titles and the [[/MULTILINE]] needs to be included after the last field, but before the table field is closed with *]]

Which will produce a table something like the one below:

Day
Date
StartTime
Role
Thur
13/05/2021
08:45
Secretary
Fri
14/05/2021
09:00
Secretary


Note: When emails are passed to Outlook, tables will only work if you have specified an email signature against your UserID within Influence. IF you try to pass a table to Outlook without an email signature, it will not work and will appear as plain text rather than as a table.


 

EXAMPLE of a Multiline merge field

Example:
[[MULTILINE=BOOKING]][[ENIK_DATE]] - [[ENIK_START_TIME]] to [[ENIK_END_TIME]] on [[ENIK_DATE_6]]
[[/MULTILINE]]

Gives the output as below

10/03/2014 - 09:00 to 17:30 on 10th March 2014
11/03/2014 - 09:00 to 17:30 on 11th March 2014
12/03/2014 - 09:00 to 17:30 on 12th March 2014
13/03/2014 - 09:00 to 17:30 on 13th March 2014
14/03/2014 - 09:00 to 17:30 on 14th March 2014


Example2:
[[MULTILINE=BOOKING;ONELINE;REVERSE]]
Your last booking is on [[ENIK_DATE]] at [[ENIK_END_TIME]] [[/MULTILINE]]

Gives the output

Your last booking is on 14/03/2014 at 17:30

(i.e. the output has been REVERSED, and then only ONE LINE has been shown)

Note: When using multi-line fields if a particular parameter does not work it is likely that it was only introduced in a later version of the software than you are currently using, and you will require an update before the parameter will work.


Back to top




List of TYPES


MULTILINE=BOOKING or BOOKINGS
Reads through bookings depending on journal type for the date range specified. Date range may be overridden by using THISWEEK or NEXTWEEK parameters

Parameters:

REVERSE                  
This runs thought the bookings in reverse order – If used in conjunction with ONELINE (below) it allows you to list details of the ‘Last’ booking.
ONELINE           
Uses the data from the ‘First’ relevant booking line.
LASTWEEK 
(ver. 1.00.22.200 onward)      
Based upon Todays’ date, it will only select bookings for “Last Week”
(NB: This is only necessary if you are using the field on a document/template called from anywhere other than the ‘Confirm Bookings’ screen)
THISWEEK            
Based upon Todays’ date, it will only select bookings for “This Week”
(NB: This is only necessary if you are using the field on a document/template called from anywhere other than the ‘Confirm Bookings’ screen)
NEXTWEEK       
Based upon Todays’ date, it will only select bookings for “Next Week”
(NB: This is only necessary if you are using the field on a document/template called from anywhere other than the ‘Confirm Bookings’ screen)
UNFILLED     
This will show details for ‘un-filled’ bookings – by default they will be excluded from the output unless this parameter is specified.
CANDLIST
This will only show ONE line per candidate, even if they have multiple bookings during the given period.
SITELIST
 This will only show ONE line per site, even if they have multiple bookings during the given period. It is useful when producing a 'schedule' showing a list of the site addresses where a candidate will be working this week. (Only available from ver 1.00.18.271 or later)
TIMESHEETS=Y/N 
 Y gives only timesheeted records, N gives only un-timesheeted records, and if omitted then all records will be included) [only available after version 1.00.15.324]
CONTACT
 If selected this will only show bookings for the chosen contact from the 'Confirm Bookings' screen. If omitted the multi line field will show ALL bookings at the site, irrespective of the selected contact. (Available after release 1.00.16.292 )

TYPE=
If selected this will only show bookings of the specified TYPE (e.g. CAN - cancelled). If omitted the multi line field will show bookings which are 'working time'. (Available after release 1.00.17.019)
PAYPER=H/D
Use H to select only Hourly-rate bookings or D to select only Daily Rate bookings. (Available after release 1.00.19.004)
OFFICE
(Only applicable to multi-office systems). If this is added to the parameters of the multi line field then the output will be restricted to display only bookings which match the current office of the user.
 e.g. If the user was logged in as the "Driving" office only bookings added by the "Driving" office would be printed - bookings added to the same client by the "Construction" office would not be included.

ALLSITES
If a client has multiples sites (branches) then normally the system would only show bookings from the selected site. This Parameter forces the system to display bookings from ALL sites regardless of which site is currently open.
(Only available after release 1.00.20.070 )


Examples:

Booking Details:
[[MULTILINE=BOOKING;ALLSITES]] [[ENIK_DATE]] - [[ENIK_START_TIME]] - [[ENIK_END_TIME]]   : [[ENIK_JOB_CODE$]]  [[ENID_FORENAME$]] [[ENID_SURNAME$]] :   (Site: [[CMS_SITE_LOCAL$]])
[[/MULTILINE]]

This might produce output, looking like: 

Booking Details:
 06/04/2020 - 09:00 - 17:00   : Receptionist  Andy Anderson :   (Site: Leatherhead (Head Office))
 06/04/2020 - 09:00 - 17:00   : Secretary  Candy Button :   (Site: Reigate)
 06/04/2020 - 09:00 - 17:00   : Receptionist  Holly Stevens :   (Site: Croydon)
 06/04/2020 - 09:00 - 17:00   : Receptionist  Holly Stevens :   (Site: Croydon)
 06/04/2020 - 09:00 - 17:00   : Receptionist  Holly Stevens :   (Site: Croydon)
 06/04/2020 - 09:00 - 17:00   : Secretary  Tanya Typist :   (Site: Sutton)
 07/04/2020 - 09:00 - 17:00   : Receptionist  Andy Anderson :   (Site: Leatherhead (Head Office))
 07/04/2020 - 09:00 - 17:00   : Secretary  Candy Button :   (Site: Reigate)


Back to top





MULTILINE= CANDDOCS   (only available from ver 1.00.15.234 or later)
Scans through the attachment buffer and reads the candidate record for each candidate document found.

Parameters:

None

 Back to top







MULTILINE= COMPLIANCE   (Available from Ver 1.00.15.234 or later)
Reads through the compliance items for a candidate or client. If not specified the default is candidate.

Parameters:

TYPE=CLIENT/CAND
(Default is CAND if missed off)
DEPEND=XXXX
 (Only dependencies of selected code)
COMPLIANT=Y/N
(All if not used)
EXPIRES=Y/N/E/X/B
 Y = Items with an expiry date, N = Items without and expiry date, E=Near Expiry, X=Expired, B=Blank
It is only possible to specify ONE answer for this parameter
EXPIREDAYS = ??
(enter a number of days, or a range of days within which time the item will expire. e.g EXPIREDAYS=30-60 will list items due to expire between 30 and 60 days time.)  (EXPIREDAYS parameter only available from 1.00.16.240 or later) - Range available after version 1.00.20.066
REFS=Y/N
 (Only include compliance items with/without a reference number)
ISSUE=Y/N
(Only include compliance items with/without Issue Date)
DOC=Y/N
(Only include compliance items with/without documents)
GROUP=XXXX
(All items with a specific group or groups, Multiple groups separates by commas  e.g. GROUP=DRIV,REFS)
MAND=Y/W/N
(Mandatory flag – Can use combinations e.g YW for mandatory and warn, WN for warn and not mandatory)
VALIDCODES=XXX,XXX,XXX
(allows users to choose specific compliance codes that will be listed in the multiline output, e.g. DBS,DRIV,PASS) (only available from 1.00.16.240 or later)

INVALIDCODES=XXX,XXX,XXX
(allows users to choose specific compliance codes that will be excluded/omitted in the multiline output, e.g. CPC,DBS,CINC)
COMPTYPES

This can be a list of valid compliance types separated with a comma. In addition, an asterisk (*) may be used which will include any compliance item not associated with any compliance types. (See example 4 below - only available from release 1.00.22.200 or later)
ROLEONLY=Y/N When set to ROLEONLY=Y this will only show compliance codes that are associated with the 'Main Role' for the candidate (as seen at the top right of their Record)
(ROLEONLY=N will show items that are 'generic' and not associated with any role.)
ROLE=XXXX This will filter the items and only display those which are specific to a ROLE. e.g. ROLE=RGN would only display codes specific to the RGN Role  
(only one code can be specified)
SORT 
(or ORDERBY)=EXPIRY/DOCUMENT/QUAL/CHECKED – use these to specify which of the dates the output will be sorted by. (If  you experience problems with SORT, update to a version after 1.00.21.085)
REVERSE
specify the word Reverse to reverse the order of the sort. (If omitted it will not be reversed)


Example1: Items which require a Document, Expiring in 45 Days or less

[[MULTILINE=COMPLIANCE;TYPE=CAND;COMPLIANT=N;EXPIRES=Y;DOC=Y;SORT=EXPIRY;EXPIREDAYS=45]] [[RQDF_DESC$]] [[RQIN_EXPIRY_DATE]] [[RQIN_CHECKED$]] [[/MULTILINE]]

This will produce a list of Compliance items for a candidate which require a document to be stored and have expiry dates which will expire within 45 Days.


Example2: Items that are specifically needed for RGN which have an Expiry Date 

[[MULTILINE=COMPLIANCE;ROLE=RGN;EXPIRES=Y;SORT=EXPIRY]] [[RQDF_DESC$]] [[RQIN_EXPIRY_DATE]] [[RQIN_CHECKED$]] [[/MULTILINE]]

This will produce a list of Compliance items for a candidate which have an expiry date, but only those relevant to the role RGN. (Items which are 'generic' and not linked to any role, such as Right-To-Work will be excluded).  They will be sorted by expiry date order.


Example3:  Non-compliant Mandatory or Warnable Items plus any such items specific to the Role RGN

You might want to produce a list of expired/missing items for a candidate, including generic items plus any specific items related to their ROLE. To do this would require two multi-line fields

Generic Items

[[MULTILINE=COMPLIANCE;ROLEONLY=N;MAND=YW;COMPLIANT=N]] [[RQDF_DESC$]] [[RQIN_EXPIRY_DATE]] [[RQIN_CHECKED$]] [[/MULTILINE]]

ROLE Specific Items

[[MULTILINE=COMPLIANCE;ROLEONLY=Y;MAND=YW;COMPLIANT=N]] [[RQDF_DESC$]] [[RQIN_EXPIRY_DATE]] [[RQIN_CHECKED$]] [[/MULTILINE]]

.The above pair of merge fields will produce two lists of items; 

List 1 (Generic Items) will be items which are Mandatory/Warnable but NOT linked to any specific Role. This will typically include items such as Right-To-Work, Proof of ID, etc. that are needed by all workers.
List 2 (Role Specific Items) will be items specific to the main ROLE for the candidate. i.e. If they are an RGN, then it would list items that are specific to RGNs such as Vaccinations, Blood tests, etc.


Example4: List if Compliance Items that are linked to the Type MED OR those that are not associated with any Type

If you are using Compliance Types, then you may want a field to show only the items from the relevant Type(s), such as
[[MULTILINE=COMPLIANCE;COMPTYPES=MED,*]][[RQIN_REQ_CODE$]] [[RQDF_DESC$]]

[[/MULTILINE]]

The merge field above will list compliance items that are linked to compliance type "Medical" along with any compliance types that have no type association at all. (Specified with the * )



Back to top




MULTILINE= INTERVIEWS or INTERVIEW
Reads through the interview/match records for Clients, Candidates or Vacancies or a specific list of interview records.

In addition to the interview record for each line, the relevant candidate and trade detail record will be read for client and vacancy journals, client and site records for candidate and vacancy journals and vacancy and contact record for client and candidate journals.

Parameters:

SELECTED
 (A list of specified interview records has been supplied. This should not be used without instructions from Influence)


Use the field

[[MULTILINE=INTERVIEWS]] multiline details [[/MULTILINE]]


Multiline details - replace this text with the details that you want to send by choosing fields from the Catalogue.
Whichever fields are chosen will form the body of the email and be repeated for each candidate who is sent.
Typical examples are Candidate forename/Surname, Interview Date & Interview time.


Example

[MULTILINE=INTERVIEW]] [[ENID_FORENAME$]] [[ENID_SURNAME$]] on [[ENII_INT_DATE]] at [[ENII_INT_TIME]] with [[ENII_INT_CONT$]][[/MULTILINE]]

Would produce 

Billy Bean on 02/03/2023 at 11:00 with Gary Goldfish 

Andy Admin on 02/03/2023 at 14:00 with Gary Goldfish 

James Burton on 03/03/2023 at 16:30 with Andy Abbott


NOTE:  When building the list of interviews this field will only consider interview dates that are current/future. Any Interview dates in the past will not be added to the merge field.

 e.g. If the confirmation was sent on 15th Feb 2023 then only interveiws on or after that date would be listed  {For interviews before that date, it's too late !! - Doh. }



MULTILINE= INVOICE
Reads through the lines on the current invoice record.

Parameters:

None


Back to top




 



MULTILINE= JOURNAL or JOURNALS
Reads through the journals for the relevant journal type (i.e. Client, Candidate, Contact, Vacancy, Interview) and date range specified in the parameters.

Parameters:

DIRECTION=I/O 
 (If omitted then all journal will be displayed irrespective of direction)
METHOD=A/C/E/F/G/I/L/M/N/P/S/T/W/X
This can be used to specify which method(s) will be included in the list. If omitted then ALL methods are assumed. The chosen methods can be specified as a list, e.g. METHOD=EPSG
CALL_TYPE=XXXX
This can be used to specify call types to look for. You can specify multiple call types, but each must be 4-characters long. e.g. CALL_TYPE=SCV TOBSBUSD
DELETED=ONLY/FALSE/NO
Will display deleted journals if set to ONLY. If omitted then false is assumed and only non-deleted journals are displayed.
START_DATE=DD/MM/YYYY or YYYY-MM-DD or TODAY


END_DATE=DD/MM/YYYY or YYYY-MM-DD or TODAY


Back to top

 

EXAMPLE:

When adding the merge field the entry should start with

[[MULTILINE=???????]]  where ????? is replaced by the relevant type of multiline, e.g. BOOKING, JOURNALS, etc.
The entry should be ended with [[/MULTILINE]]

There are also various additional parameters which can be used, e.g.
[[MULTILINE=JOURNALS;DIRECTION=O;METHOD=E;START_DATE=TODAY-30]]

Example:

Dear [[ENID_FORENAME$]]

Below is a list of the  journals you have been sent (email)

[[MULTILINE=JOURNALS;DIRECTION=O;METHOD=E;START_DATE=TODAY-30]][[JNLE_DATE]] [[JNLE_TIME]] [CMS_SITE_NAME$]] [[JNLE_SUBJECT$]][[TXT_JOURNAL_BODY_TEXT$]] [[/MULTILINE]]

If you have any problems, please contact us immediately so that we can make alternative arrangements

A template such as this, might produce output looking like :-

Dear Martin

Below is a list of the  journals you have been sent (email)

26/03/2018 14:52 ABC Products Application Information
We have sent your application and are awaiting feedback.
As soon as we hear we will let you know.

29/03/2018 09:46 ABC Products Application Update
We have heard back from our client and on this occasion you have been unsuccessful.
We will contact you if another suitable position arises, but in the meantime best of luck.


If you have any problems, please contact us immediately so that we can make alternative arrangements

Note: When using multi-line fields if a particular parameter does not work it is likely that it was only introduced in a later version of the software than you are currently using, and you will require an update before the parameter will work.

Back to top



 

Example of Compliance Document Attachment 
(Only available after release 1.00.18.299)

The template below is an example of  a booking confirmation that could be sent to  client and would attach a document relating to the "PASS" (Passport) compliance item from a candidate.

Hi [[CMC_FORENAME$]]  

Here is a confirmation of the bookings for [[MULTILINE=BOOKING;ONELINE]] [[ENID_FORENAME$]] [[ENID_SURNAME$]][[/MULTILINE]]

Booking Details:
[[MULTILINE=BOOKING]] [[ENIK_DATE_19]]  [[ENIK_DATE]] - [[ENID_FORENAME$]] [[ENID_SURNAME$]] : [[ENIK_START_TIME]] - [[ENIK_END_TIME]] [[ENIK_JOB_CODE$]]
[[/MULTILINE]]

Compliance Items to Attach
[[MULTILINE=BOOKING;CANDLIST]] [[ENID_FORENAME$]] [[ENID_SURNAME$]]: Passport No: [[RQIN_QUAL_REF$(PASS)]] 
[[RQIN_DOC_NAME$(PASS)]]
[[/MULTILINE]]


The field shown in RED is the one which will attach the relevant compliance document from the candidate.


Back to top




[Keywords: Multiline, multi line, multi-line, multiple line, multilines, multi-lines, multi lines ]



Choose files or drag and drop files
Helpful?
Yes
No
  1. Graeme Orchard

  2. Posted
  3. Updated

Comments