Merge Fields

From sbv.wiki
Revision as of 17:49, 14 May 2016 by Stage (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 complete list of merge fields:

Merge Field Replaced With Notes
<EmployeeID> The employee's ID Employee / Main tab
<FullName> The employee's full name Employee / Main tab
<FullNameWithoutTag> The employee's full name excluding their Tag Employee / Main tab
<FirstName> The employee's first name Employee / Main tab
<MiddleName> The employee's middle name Employee / Main tab
<LastName> The employee's last name 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
<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
<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
<LaborLevelXID> The labor level ID of the level X labor level. The level is determined by looking at Configuration / Setup / System / Labor Levels tab. This is a zero based index and the order in which labor levels are displayed is not necessarily the index of the labor level. The second labor level is number 1 so <LaborLevel1ID> would be replaced with the employee's second labor level ID. For example, this might be the ID of the employee's company.
<LaborLevelXDescription> The labor level description of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXSchedulerID> The scheduler ID of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXPayrollID> The payroll ID of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag> The complete Tag of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag1> The first Tag of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag2> The second Tag of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag3> The third Tag of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag4> The fourth Tag of the level X labor level. See <LaborLevelXID> above for details.
<LaborLevelXTag5> The fifth Tag of the level X labor level. See <LaborLevelXID> above for details.
<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