Merge Fields

From sbv.wiki
Revision as of 15:40, 19 May 2020 by Joel (Talk | contribs)

Jump to: navigation, search

Merge fields are used in multiple places throughout the software. A merge field is identified by starting with a < and ending with a >. When used in the software, the merge field is replaced with information specific to the employee. Examples of where merge fields are used are:

  • Employee Info Text
  • Dynamic paths such as used for payroll file location
  • Name formats for staffing sheets

Here is a list of merge fields:

Merge Field Replaced With Notes
<FirstNameLastName> The employee's first and last name separated with a space Employee / Main tab
<EmployeeID> The employee's ID Employee / Main tab
<FullName> The employee's full name including any middle name and tag Employee / Main tab
<FULLNAME> The employee's full name including any middle name and tag in upper case Employee / Main tab
<FullNameWithoutTag> The employee's full name including the middle name but excluding the tag Employee / Main tab
<FULLNAMEWITHOUTTAG> The employee's full name including the middle name but excluding the tag in upper case Employee / Main tab
<FirstName> The employee's first name Employee / Main tab
<FIRSTNAME> The employee's first name in upper case Employee / Main tab
<SchedulerTagElseFirstName> The scheduler tag if it exists else the employee's first name Employee / Scheduling / Other tab
<MiddleName> The employee's middle name Employee / Main tab
<MIDDLENAME> The employee's middle name in upper case Employee / Main tab
<LastName> The employee's last name Employee / Main tab
<LASTNAME> The employee's last name in upper case Employee / Main tab
<*IfNotInHouse> * if the employee is not in a company that is marked as being In House Configuration / Setup / Labor Levels / Company
<FirstNameInitial> The first letter of the employee's first name followed by a period Employee / Main tab
<SchedulerTagElseFirstNameInitial> The scheduler tag if it exists else the first letter of the employee's first name followed by a period Employee / Scheduling / Other tab
<MiddleNameInitial> The first letter of the employee's middle name preceded by a space and followed by a period Employee / Main tab
<LastNameInitial> The first letter of the employee's last name followed by a period Employee / Main tab
<CPR> CPR indicator of ♥ Employee / Employment / Licensing tab
<LastDayWorked> The date of the latest punch made by the employee Time Cards tab
<Union> Displays the word Union if the employee is in the union Determined in multiple ways based on department, union date and or Not In Union setting
<PayRule> The employee's current pay rule ID Employee / Main tab
<HolidayGroup> The employee's current holiday group ID Employee / Main tab
<SocialSecurityNumber> The employee's Social Security Number Employee / Employment / General tab
<HireDate> The employee's hire date Employee / Status tab
<ShiftCount> The employee's current shift Employee / Work Pattern tab
<DailyHours> The employee's current daily hours Employee / Work Pattern tab
<ShiftID> The ID of the employee's current shift Employee / Work Pattern tab
<Address> The employee's full address Employee / Contact Info tab
<Address1> The employee's address 1 field Employee / Contact Info tab
<Address2> The employee's address 2 field Employee / Contact Info tab
<City> The employee's city from their address Employee / Contact Info tab
<State> The employee's state from their address Employee / Contact Info tab
<StartTimehh:mm> The start time of the employee schedule The text after StartTime is the display format used. For example, for the time 3:30pm. hh:mm = 03:30, h:mm = 3:30, h:mm tt = 3:30 PM
<EndTimehh:mm> The end time of the employee schedule The text after EndTime is the display format used

Dynamic Fields

Examples of dynamically named fields are labor levels and the employee custom types. Labor levels can be referenced by using their index or by their name. The index is determined by looking at Configuration / Setup / System / Labor Levels tab. This is a zero based index so the first labor level is 0, the second labor level is 1. The order in which labor levels display throughout the software does not necessarily indicate the index of the labor level. Labor levels can also be referenced by using their name, so for example, if the first labor level is Company then it can be referenced by using LaborLevel0 or Company. As such, the company ID can be used as a merge field by using <LaborLevel0ID> or <CompanyID>.

Merge Field Replaced With Notes
<LaborLevelX> or <"Labor Level Name"> The default when referencing just the labor level is the value of the description. As such <Company> and <CompanyDescription> will be replaced with the same value, i.e. the employee's company description.
<LaborLevelXID> or <"Labor Level Name"ID> The labor level ID of the level X labor level of the employee If using the labor level name then an example is <CompanyID>
<LaborLevelXDescription> or <"Labor Level Name"Description> The labor level description of the level X labor level of the employee If using the labor level name then an example is <DepartmentDescription>
<LaborLevelXSchedulerID> or <"Labor Level Name"SchedulerID> The scheduler ID of the level X labor level of the employee of the employee If using the labor level name then an example is <FloorSchedulerID>
<LaborLevelXPayrollID> or <"Labor Level Name"PayrollID> The payroll ID of the level X labor level of the employee If using the labor level name then an example is <DepartmentPayrollID>
<LaborLevelXTag> or <"Labor Level Name"Tag> The complete Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag>
<LaborLevelXTag1> or <"Labor Level Name"Tag1> The first Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag1>
<LaborLevelXTag2> or <"Labor Level Name"Tag2> The second Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag2>
<LaborLevelXTag3> or <"Labor Level Name"Tag3> The third Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag3>
<LaborLevelXTag4> or <"Labor Level Name"Tag4> The fourth Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag4>
<LaborLevelXTag5> or <"Labor Level Name"Tag5> The fifth Tag of the level X labor level of the employee If using the labor level name then an example is <CompanyTag5>

All labor level based merge fields above can also use the labor level from the schedule or schedule pattern by prefixing with "Worked". For example, <WorkedFloorID> would display the scheduled floor ID as part of the name.

Employee Custom Types are referenced by using their ID. For example, if you added a custom field named Health Benefits then you reference this as a merge field by using <Health Benefits>.