Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
hat_12 [2014/03/19 11:22] – barbara | hat_12 [2019/07/23 15:59] (current) – [Boilerplate menu list size] Shelley Hunter | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Boiler Plate Text (Standard Text / AutoText) ====== | + | ====== Boiler Plate Text (Standard Text/ |
- | Boiler Plate Text allows setting up of blocks of standard text which may be easily dropped into the current cursor position of the various free text notes fields. | + | ===== Set Up Boiler Plate Text ===== |
- | This is helpful | + | Boiler Plate Text, (BPT), allows the setting up of blocks of standard text which may be easily dropped into the current cursor position of the various free text notes fields. |
+ | |||
+ | Useful | ||
Set up in Maintenance> | Set up in Maintenance> | ||
Select whether you want the text to be accessible from: | Select whether you want the text to be accessible from: | ||
- | \\ Company | ||
- | \\ Vacancy | ||
- | \\ Contact Event | ||
- | \\ Company | ||
- | \\ Applicant | ||
- | \\ Text Message | ||
- | Double click on the boiler plate text field to open the box to enter the text. | + | * Company |
- | \\ {{: | + | * Vacancy |
- | \\ {{: | + | * Contact Event |
+ | * Company | ||
+ | * Applicant | ||
+ | * Text Message | ||
- | When inserting boiler plate fields, please make sure the fields are surrounded by {}s | + | The Type given to the Boiler Plate Text will determine where in IQX it can be used. For example, Progress type is available from the Insert Text on a progress record but if you want to use that block of text in a contact event from a progress record then it needs to be set up as a Contact Event Type. |
- | eg {APP_NAME}, {COM_NAME} | + | Text Message Type is used for sending SMS/Email from Shift Booking or Shift Confirmation. |
- | This allows | + | Mail Merge Text buttons use the Contact Event Type. |
- | The below fields are available | + | |
- | SHIFTDETAILS | + | Insert a relevant Description, |
- | Applicant Fields | + | Double click on the boiler plate text field to open the box to enter the text.\\ |
- | Boiler Plate Field | + | {{ :bpt_double_click_to_add_text.jpg?500 |}} |
- | APP_NAME | + | |
- | APP_SURNAME | + | |
- | APP_USURNAME | + | |
- | APP_FORENAMES | + | |
- | APP_UFORENAMES | + | |
- | APP_SALUTATION | + | |
- | APP_ADDR1 | + | |
- | APP_ADDR2 | + | |
- | APP_ADDR3 | + | |
- | APP_TOWN | + | |
- | APP_COUNTY | + | |
- | APP_COUNTRY | + | |
- | APP_POSTCODE | + | |
- | APP_DOB | + | |
- | APP_SEX | + | |
- | APP_NI | + | |
- | APP_APPNUMBER | + | |
- | APP_PAYROLLNUMBER | + | |
- | APP_REGISTRATIONDATE Person | + | |
- | APP_ADDRESS | + | |
- | APP_PHN_HOME_TELEPHONE | + | |
- | APP_PHN_DAY_TELEPHONE | + | |
- | APP_PHN_FAX | + | |
- | APP_PHN_E-MAIL | + | |
- | APP_HEADERNAME | + | |
- | APP_LISTOFCVS | + | |
+ | {{ : | ||
+ | When inserting boiler plate fields, please make sure the fields are surrounded by {}s. | ||
- | Company | + | eg {APP_NAME}, {COM_NAME}... |
- | Boiler Plate Table Field Example | + | |
+ | The fields that are available for the Boiler Plate Text will depend on where the text is being inserted from. For example if you are making a contact event from the candidate record the Applicant | ||
+ | |||
+ | ==== Applicant Fields ==== | ||
+ | |||
+ | Accessible from Applicant, Vacancy, Placement or a Contact Event (if it has a link to a Company, Vacancy, Placement record or via Shift Confirmation). | ||
+ | |||
+ | Boiler Plate Field Table Field Example | ||
+ | APP_NAME Person Name Mr Fred Smith | ||
+ | APP_SURNAME | ||
+ | APP_USURNAME | ||
+ | APP_FORENAMES | ||
+ | APP_UFORENAMES | ||
+ | APP_SALUTATION | ||
+ | APP_ADDR1 | ||
+ | APP_ADDR2 | ||
+ | APP_ADDR3 | ||
+ | APP_TOWN | ||
+ | APP_COUNTY | ||
+ | APP_COUNTRY | ||
+ | APP_POSTCODE | ||
+ | APP_DOB | ||
+ | APP_SEX | ||
+ | APP_NI | ||
+ | APP_APPNUMBER | ||
+ | APP_PAYROLLNUMBER | ||
+ | APP_REGISTRATIONDATE Person | ||
+ | APP_ADDRESSLONG Wester Newhouse, Lilliesleaf, | ||
+ | APP_ADDRESS | ||
+ | Lilliesleaf | ||
+ | Melrose | ||
+ | TD6 9JT | ||
+ | APP_PHN_HOME_TELEPHONE | ||
+ | APP_PHN_DAY_TELEPHONE | ||
+ | APP_PHN_MOBILE | ||
+ | APP_PHN_FAX | ||
+ | APP_PHN_E-MAIL | ||
+ | APP_HEADERNAME | ||
+ | APP_LISTOFCVS | ||
+ | |||
+ | ==== Company Fields ==== | ||
+ | |||
+ | Accessible from Company, Vacancy, Progress or a Contact Event (if it has a link to a Company, Vacancy, Progress record or via Shift Confirmation). | ||
+ | |||
+ | |||
+ | Boiler Plate Field Table Field Example | ||
COM_NAME Person | COM_NAME Person | ||
- | COM_SALUTATION Person | + | COM_SALUTATION Person |
COM_COMPANYNAME Company Name IQX Limited | COM_COMPANYNAME Company Name IQX Limited | ||
COM_ADDR1 Company Addr1 | COM_ADDR1 Company Addr1 | ||
- | COM_ADDR2 Company | + | COM_ADDR2 |
- | COM_ADDR3 Company | + | COM_ADDR3 |
- | COM_TOWN Company Town Melrose | + | COM_TOWN |
- | COM_COUNTY Company County | + | COM_COUNTY |
- | COM_COUNTRY | + | COM_COUNTRY |
COM_POSTCODE | COM_POSTCODE | ||
COM_POSITION | COM_POSITION | ||
COM_DEPARTMENT | COM_DEPARTMENT | ||
- | COM_ADDRESS | + | COM_ADDRESSLONG |
- | COM_HOME_TELEPHONE | + | COM_ADDRESS |
- | COM_DAY_TELEPHONE | + | Lilliesleaf |
- | COM_PHN_FAX | + | Melrose |
- | COM_PHN_E-MAIL | + | TD6 9JT |
- | COM_HEADERNAME | + | COM_PHN_DIRECT_TELEPHONE |
+ | COM_PHN_MOBILE | ||
+ | COM_PHN_DIRECT_FAX | ||
+ | COM_PHN_E-MAIL | ||
+ | COM_HEADERNAME | ||
+ | ==== Vacancy Fields ==== | ||
+ | |||
+ | Accessible from Company, Vacancy, Progress, Placement, or a Contact Event (if it has a link to a Company, Vacancy, Progress record, Placement record or via Shift Confirmation). | ||
- | Vacancy Fields : Accessible from Company, Vacancy, Progress and Placement | ||
Boiler Plate Field Table Field Example | Boiler Plate Field Table Field Example | ||
VAC_POSITION | VAC_POSITION | ||
Line 89: | Line 114: | ||
VAC_NOOFPOSTS | VAC_NOOFPOSTS | ||
VAC_EXPIRY | VAC_EXPIRY | ||
+ | VAC_SITEADDR1 Vacancy Addr1 | ||
+ | VAC_SITEADDR2 | ||
+ | VAC_SITEADDR3 | ||
+ | VAC_SITETOWN | ||
+ | VAC_SITECOUNTY | ||
+ | VAC_SITECOUNTRY | ||
+ | VAC_SITEPOSTCODE | ||
+ | VAC_ADDRESSLONG | ||
+ | VAC_ADDRESS | ||
+ | Lilliesleaf | ||
+ | Melrose | ||
+ | TD6 9JT | ||
+ | VAC_SITENAME | ||
+ | VAC_SITECONTACT | ||
+ | VAC_SITEFAX | ||
+ | VAC_SITEEMAIL | ||
+ | VAC_SITEPHONES | ||
+ | VAC_SITEROLE | ||
+ | |||
+ | |||
+ | ==== Shift Fields ==== | ||
+ | |||
+ | Accessible from Shift Confirmation buttons and can also be passed through to contact events via the shift confirmation and tempdesk – shifts screen. | ||
+ | |||
+ | Can use **either** Shift Details **or** {SHF} fields but **not both**, if SHIFTDETAILS is used then none of the {SHF} fields will be available. | ||
+ | |||
+ | Boiler Plate Field Example | ||
+ | SHIFTDETAILS | ||
+ | |||
+ | **OR** | ||
+ | |||
+ | Boiler Plate Field Example | ||
+ | SHF_DATE 1/ | ||
+ | SHF_FROM 8: | ||
+ | SHF_TO 10: | ||
+ | SHF_NOTE Notes | ||
+ | SHF_BREAKMINUTES 30 | ||
+ | SHF_WHENCANCELLED 1/1/2015 | ||
+ | SHF_THEIRREF A/ | ||
+ | SHF_CANCELREASON Holiday | ||
+ | SHF_WHENCANCELLED 1/ | ||
+ | SHF_PERSON Mr Fred Smith | ||
+ | SHF_CLIENTCONFIRMED 1 | ||
+ | SHF_TEMPCONFIRMED 1 | ||
+ | SHF_STATE P | ||
+ | SHF_STATEDESC Provisional | ||
+ | SHF_SERIALNUMBER 12345 | ||
+ | |||
+ | It is possible to list all shifts applicable (up to 365 days in advance) to an applicant. The shifts do not have to be referenced in the Shift Confirmation Screen. | ||
+ | |||
+ | {SHR_BEGIN}{SHR_DATE dd/mm/yyyy} {SHR_FROM} – {SHR_TO}{SHR_END} | ||
+ | |||
+ | Would output something like: | ||
+ | |||
+ | 01/07/2016 08:00 – 17-00 | ||
+ | 02/07/2016 08:00 – 17-00 | ||
+ | 03/07/2016 08:00 – 17-00 | ||
+ | 04/07/2016 08:00 – 17-00 | ||
+ | |||
+ | SHR_BEGIN, can be replaced with {SHR_BEGIN_n}, | ||
+ | |||
+ | **Note** It is the current date that the Shift Range starts from and not the date of the shift you a confirming. This means that if you a confirming a shift in the future the SHR command might not list all of the shifts from the date you are confirming on. | ||
+ | |||
+ | **These fields cannot be used with {SHIFTDETAILS}.** | ||
+ | |||
+ | ==== Shift Matching Fields ==== | ||
+ | |||
+ | Boiler Plate Field Example | ||
+ | SHIFTDETAILS 01/ | ||
+ | SHF_DATE 1/ | ||
+ | SHF_FROM 8: | ||
+ | SHF_TO 10: | ||
+ | SHF_THEIRREF A/ | ||
+ | |||
+ | If you wish to contact a candidate about their availability for more than one shift you can use {SHF_BEGIN} and {SHF_END} to list the shifts. | ||
+ | |||
+ | {SHF_BEGIN}{SHF_DATE dd/mm/yyyy} {SHF_FROM} {SHF_TO}{SHF_END} {COM_COMPANYNAME} | ||
+ | |||
+ | Would output something like: | ||
+ | |||
+ | 01/07/2016 08:00 – 17-00 | ||
+ | 02/07/2016 08:00 – 17-00 | ||
+ | 03/07/2016 08:00 – 17-00 | ||
+ | IQX Limited | ||
+ | |||
+ | **These fields cannot be used with {SHIFTDETAILS}.** | ||
+ | |||
+ | ==== Colleague Fields ==== | ||
+ | |||
+ | **ONLY** accessible from Shift Confirmation button. | ||
+ | Enables you to include the details of other candidates booked in to the same shift when confirming shifts. | ||
+ | |||
+ | Boiler Plate Field Example | ||
+ | {COL_DATE} 01/ | ||
+ | {COL_FROM} 09: | ||
+ | {COL_TO} 17: | ||
+ | {COL_NOTE} Notes | ||
+ | {COL_BREAKMINUTES} 30 | ||
+ | {COL_THEIRREF} A/ | ||
+ | {COL_CANCELREASON} Holiday | ||
+ | {COL_WHENCANCELLED} 01/ | ||
+ | {COL_CLIENTCONFIRMED} 1 | ||
+ | {COL_TEMPCONFIRMED} 1 | ||
+ | {COL_STATE} P | ||
+ | {COL_STATEDESC} Provisional | ||
+ | {COL_SERIALNUMBER} 9876 | ||
+ | {COL_ORDEREDBY} Jack Jones | ||
+ | {COL_CLIENTNOTE} Client Notes | ||
+ | {COL_APP_NAME} Fred Smith | ||
+ | {COL_APP_SURNAME} Smith | ||
+ | {COL_APP_ADDR1} Wester Newhouse | ||
+ | {COL_APP_ADDR2} Lilliesleaf | ||
+ | {COL_APP_ADDR3} | ||
+ | {COL_APP_TOWN} Melrose | ||
+ | {COL_APP_COUNTY} Scottish Borders | ||
+ | {COL_APP_COUNTRY} Scotland | ||
+ | {COL_APP_MOBILE} 07777 XXXXXX | ||
+ | {COL_APP_EMAIL} support@iqx.co.uk | ||
+ | |||
+ | ==== Progress Fields ==== | ||
+ | |||
+ | Accessible from Progress, or a ContactEvent (if it has a link to a Progress Record) | ||
- | |||
- | Progress fields : Only accessible from Progress | ||
Boiler Plate Field Table Field Example | Boiler Plate Field Table Field Example | ||
PRG_STATUS | PRG_STATUS | ||
PRG_ACTIONDATE | PRG_ACTIONDATE | ||
- | PRG_INTERVIEWDATE | + | PRG_INTERVIEWDATE |
PRG_INTERVIEWTIME | PRG_INTERVIEWTIME | ||
- | |||
- | Placement | + | ==== Placement |
+ | |||
+ | Accessible | ||
Boiler Plate Field Table Field Example | Boiler Plate Field Table Field Example | ||
- | PLC_SALARY | + | PLC_SALARY |
- | PLC_POSITION | + | PLC_POSITION |
PLC_STARTDATE | PLC_STARTDATE | ||
PLC_LEAVEDATE | PLC_LEAVEDATE | ||
Line 109: | Line 256: | ||
- | Any additional phone types can be accessed (if present in the database) in the format of COM_< | + | ==== Additional Phone Type Fields ==== |
- | Eg | + | |
- | COM_PHN_SKYPE | + | |
- | COM_PHN_FACEBOOK | + | |
- | COM_PHN_LINKEDIN | + | |
- | APP_PHN_SKYPE | + | |
- | APP_PHN_FACEBOOK | + | |
- | APP_PHN_LINKEDIN | + | |
- | Only if the corresponding field is available. | + | |
+ | These can be accessed (if present in the database, Agency Set Up – Phone Types) in the | ||
+ | format of COM_PHN_< | ||
+ | |||
+ | E.g. | ||
+ | |||
+ | COM_PHN_SKYPE xxxxxx | ||
+ | COM_PHN_FACEBOOK xxxxxx | ||
+ | COM_PHN_LINKEDIN xxxxxx | ||
+ | APP_PHN_SKYPE xxxxxx | ||
+ | APP_PHN_FACEBOOK xxxxxx | ||
+ | APP_PHN_LINKEDIN xxxxxx | ||
+ | |||
+ | Only if the corresponding APP_PHN_E-MAIL or COM_PHN_E-MAIL field is available. | ||
+ | |||
+ | ==== Custom Word Merge Fields ==== | ||
+ | |||
+ | Access via Maintenance-> | ||
+ | |||
+ | All merge fields can be accessed from within boiler plate text, if they follow same rules as above | ||
+ | |||
+ | i.e. | ||
+ | |||
+ | Applicant Fields : Accessible from Applicant, Vacancy, Placement or a ContactEvent (if it has a link to a Company, Vacancy, Placement record).\\ | ||
+ | Company Fields : Accessible from Company, Vacancy, Progress or a ContactEvent (if it has a link to a Company, Vacancy or Progress record).\\ | ||
+ | Vacancy Fields : Accessible from Company, Vacancy, Progress, Placement, or a ContactEvent (if it has a link to a Company, Vacancy, Progress or Placement record).\\ | ||
+ | Progress Fields : Accessible from Progress, or a ContactEvent (if it has a link to a Progress Record).\\ | ||
+ | Placement Fields : Accessible from Placement, or a ContactEvent (if it has a link to a Placement Record).\\ | ||
+ | |||
+ | How to name a Custom Word Merge Field :- | ||
+ | |||
+ | The same conventions apply, use the FieldCategory to determine the prefix | ||
+ | |||
+ | Applicant Fields Starts with APP_\\ | ||
+ | Company Fields Starts with COM_\\ | ||
+ | Vacancy Fields Starts with VAC_\\ | ||
+ | Progress Fields Starts with PRG_\\ | ||
+ | Placement Fields Starts with PLC_\\ | ||
+ | Contact Event Fields Starts with CON_\\ | ||
+ | Branch Fields Starts with BRN_\\ | ||
+ | |||
+ | After the prefix, add on the FieldName | ||
+ | |||
+ | e.g. | ||
+ | APP_UPPERTOWN | ||
+ | PLC_MINPAY | ||
+ | |||
+ | The resulting name must be unique, i.e. if it is already a predefined boiler plate name, it will not be accessible. E.g. APP_NAME.\\ | ||
+ | |||
+ | |||
+ | ==== Questions ==== | ||
+ | |||
+ | Allows access to both the question answer and the description | ||
+ | |||
+ | QTN_< | ||
+ | |||
+ | eg | ||
+ | QTN_A_P_CUR | ||
+ | QTN_D_P_CUR | ||
+ | |||
+ | Sub menu selection not currently supported. | ||
+ | Multiple / Graded and Scored Selection are output in a comma separated list. | ||
+ | |||
+ | A question answer will only be evaluated if the question is applicable to the rest of the substitutions. | ||
+ | |||
+ | |||
+ | ==== Letter / Consultant Fields ==== | ||
+ | |||
+ | All fields staff with ‘LET_’ | ||
+ | |||
+ | Boiler Plate Field Example | ||
+ | LET_TODAY 1st January 2015 | ||
+ | LET_TODAY_dd/ | ||
+ | LET_ADDRESSLONG Wester Newhouse, Lilliesleaf, | ||
+ | LET_ADDRESS Wester Newhouse | ||
+ | Lilliesleaf | ||
+ | Melrose | ||
+ | TD6 9JT | ||
+ | LET_CONSULTANT Fred Smith | ||
+ | LET_CONSULTANTTITLE Administrator | ||
+ | LET_CONSULTANTEMAIL fred@iqx.co.uk | ||
+ | |||
+ | |||
+ | ==== Boilerplate menu list size==== | ||
+ | |||
+ | If you have large numbers of Boilerplate Text these will appear in one large list and some may disappear off the screen. | ||
+ | |||
+ | Switch off: {{: | ||
+ | |||
+ | This requires system administrator set up in General Settings group of Settings number 1850, the value entered will be the number of templates in each column. | ||
+ | |||
+ | \\ \\ \\ | ||
Go back to [[hints_and_tips|Hints, | Go back to [[hints_and_tips|Hints, | ||
+ | |||
+ | Go back to [[ug1-22|References]] |