Employee Labels Report

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

Jump to: navigation, search

The employee labels report allows you to create labels using a configuration file. The configuration file contains information about the label design, and the information to print on the label. Specify the configuration file in the Options tab. The software will look for the file in the labels subdirectory. If the file is not placed in the labels subdirectory, then you must provide the full path and filename.

Sample Template File

Here is the content of a sample file. The file uses XML tags to provide the label information. You can create or edit these files in Notepad.

<Settings>
 <RowCount>10</RowCount>
 <ColumnCount>3</ColumnCount>
 <LeftMargin>13</LeftMargin>
 <TopMargin>36</TopMargin>
 <LabelHeight>72</LabelHeight>
 <LabelWidth>189</LabelWidth>
 <ColumnSpacing>9</ColumnSpacing>
 <RowSpacing>0</RowSpacing>
 <LabelLeftMargin>0</LabelLeftMargin>
 <LabelTopMargin>0</LabelTopMargin>
 <FontSize>12</FontSize>
 <DownThenAcross>False</DownThenAcross>
 <BorderWidth>0</BorderWidth>
 <LabelContent><![CDATA[<p align='center'><b><FullName></b><br><LaborLevel3Description><br><EmployeeID></p>]]></LabelContent>
</Settings>

Base Requirements

The file requires one top-level tag <Settings></Settings>.

Measurements are specified in points. This is the same measurement used for the font size in programs like Microsoft Word or Excel. There are 72 points to one inch.

Allowable Tags

Within the Settings tag, the following tags are allowed. If a tag is not specified, then the default value is used. The default values are based on the Avery 5160 labels, a standard 30 to a page label. Therefore, if you are using 5160 labels, then you can start with just the LabelContent tag. Other tags need to be added to nudge the labels down or across the page to align perfectly when printing.

RowCount – specifies how many rows of labels per page. The default is 10.

ColumnCount – specifies how many columns of labels per page. The default is 3.

LeftMargin – specifies the distance from the left edge of the paper to the left edge of the labels in the first column. The default is 14 (0.19").

TopMargin – specifies the distance from the top edge of the paper to the top edge of the labels in the first row. The default is 36 (1/2").

LabelHeight – specifies the height of an individual label. The default is 72 (1").

LabelWidth – specifies the width of an individual label. The default is 189 (2 5/8").

ColumnSpacing – specifies the horizontal distance between labels. This is the distance between the right edge of a label and the left edge of a label in the next column. The default is 9 (0.12").

RowSpacing – specifies the vertical distance between labels. This is the distance between the bottom edge of a label and the top edge of a label in the next row. The default is 0.

LabelLeftMargin – specifies the distance between the left edge of the label and the label content. The default is 0. Typically, the label content is centered so no margin needs to be specified.

LabelTopMargin – specifies the distance between the top edge of the label and the label content. The default is 18 (1/4"), so that the text is not too close to the top of the label.

FontSize – specifies the default size of the font used in the label content. The default is 12. The default font used is Helvetica. Fonts are specified in the label content tag (see below).

DownThenAcross – specifies that direction in which labels should be printed. The default is false.

BorderWidth – by setting the border width (1 is sufficient) you can see the actual layout of the labels. This assists you in making adjustments until what prints out aligns with the labels. The default is 0.

Label Content

The label content tag uses HTML. The standard HTML tags are allowed. In addition to the HTML, placeholders are used to represent what employee information is required.

The LabelContent value must start with <![CDATA[ and end with ]]>. This is necessary because both the placeholders and HTML use the characters < and > which have a special meaning in an XML file.

Placeholders

Below is a partial list of the placeholders supported. For a complete list see [Merge_Fields]

<EmployeeID> – replaced with the employee's ID.

<FullName> – replaced with the employee's full name.

<FirstName> – replaced with the employee's first name.

<LastName> – replaced with the employee's last name.

<Initial> – is replaced with the employee's initial.

<LaborLevelXID> – replaced with the employee's labor level ID where X is the level (0 based). For example, if you are using 3 labor levels of Company, Department and Floor, then LaborLevel1ID would be replaced with the employee's department ID.

<LaborLevelXDescription> – replaced with the employee's labor level description where X is the level (0 based). For example, if using 3 labor levels of Company, Department and Floor, then LaborLevel1Description would be replaced with the employee's department description.

<PayRule> – replaced with the employee's pay rule ID.

<BaseScheduleGroup> – replaced with the employee's base schedule group ID.

<HolidayGroup> – replaced with the employee's holiday group ID.

<SocialSecurityNumber> – replaced with the employee's SSN (if the user is authorized to see SSNs).

<ShiftCount> – replaced with the employee's current shift count.

<DailyHours> – replaced with the employee's current daily hours.

Formatting

The formatting allows the use of simple HTML. The HTML tags are not case sensitive. The following HTML tags can be used:

<b>bold</>

<i>italic</i>

<u>underline</u>

<p>paragraph</p>

<br>line break

E.g., this is bold, this is in italics, this is underlined, this all all three

The paragraph tag allows for a number of attributes. The most common attributes used is align with values of right, center and left.

The font attribute allows for color (e.g. color='FF0000'), face (e.g. face='Times'), size and pointsize.

The allowable fonts are Times, Helvetica, Courier, Symbol and Zapf Dingbats. Helvetica is the default font for the labels.

Size specifies the HTML font size for the text. This is mapped to a point size internally (0 = 6 points, 1 = 8 points, 2 = 10 points, 3 = 12 points, 4 = 14 points, 5 = 18 points, 6 = 24 points, 7 = 36 points).

PointSize specifies the size of the text in points. The default point size is 12.

Example

For the following

<LabelContent><![CDATA[<p align='center'><b><FullName></b><br><LaborLevel3Description><br><br><font size='6'><EmployeeID></font></p>]]></LabelContent>

The actual label content information is:

Jim Smith
Certified Nurse Aide

12345

See also