EXT: sm_employeelist¶

What does it do?¶

This extension creates lists of employees of a company based on TYPO3 frontend users. Frontend user groups are used as the departments of the company and you can define positions for the employees like “manager” or “clerk” etc. Additionally there is a details page for each employee with his/her picture, telephone etc.

The following page contents can be created by the extension's first plugin 'Employee List':

• Employee list: Displays a list of all employees. You can add/remove fields to display and sort the list by these fields.
• Department list: Displays a list of all departments or all employees of a certain department. According to the priority of the employees' positions, they will be displayed with different colors.
• Position list: Displays a list of all positions or all employees in a certain position.
• Telephone list: Displays a (printable) telephone list.
• Birthday list: Displays a (printable) list with all employees and their birthdays.
• Picture list: Displays a list with only the pictures and names of all employees or just a certain group of employees.
• Presence list: Displays a list of all employees with their current “status” (on-/offline, IP-address).
• List of collective numbers: Displays a list of the company's collective numbers or a list of employees assigned to a certain collective number.
• Details page: Displays a details page for each employee with all the information about him/her (picture, telephone number, email etc.).
• Statistics: Displays some statistics like number of employees, average age etc.
• Current Birthdays: A list of current (+/- 4 days) employees' birthdays.
• Current jubilees: A list of current (+/- 4 days) employees' jubilees.

The additional plugin 'Event List' offers a list of events the employees can sign up for (like the christmas party etc.). Definable administrators can sign up for other employees and automatically remind them via mail that they should make a decision etc.

Requirement¶

You need PHP5 to run this extension.

Screenshots¶

Introduction¶

First of all, let's take a look at my dummy installation of the extension. I created a few dummy records of all types the extension uses (employees, departments, positions, telephone numbers and events) in the users sysfolder (which has to be set as Startingpoint in the plugins' configuration).

Managing Employees¶

Employees are simply the front end users of your website. You can create them in the users sysfolder and set all their values. The extension adds some extra fields to the standard user administration page. They should be pretty self explaining, but I will explain the most interesting ones here:

Managing Departments¶

Departments are simply the frontend user groups of your website. According to the employees I will explain some fields added by the extension here:

Managing Positions¶

Positions are new database record types the extension offers. You should also create them in your users sysfolder. Positions have only two possible fields: name and priority. Name should be self explaining.

The priority is needed to sort department lists and assign configurable CSS-classes to the employees with the given priority on any list the extension can create. The higher the value for the position's priority, the higher the employees assigned to that position will appear in a list of the departments their in.

Take a look at the screenshot of the department list: the position Director has a priority of 99, Manager has 65 and 'normal' workers (like IT-Guys ;-) have 50 (the default value). The list gets sorted by the positions' priorities and the employees get a certain CSS-class, according to my configuration (e.g. the director gets the class 'highestPriority' which will result in a dark red background).

Managing Telephone Numbers¶

Telephone numbers are also new database records the extension offers. They represent a single telephone number that is not assigned to a single employee (e.g. the telephone central) but should appear on the telephone list. Furthermore a telephone number can also represent a collective number, that can be assigned to many different employees (collective numbers will not show up on the telephone list). I will explain the meaning of the fields here:

Managing Events¶

Events are also new database records the extension offers. They represent an event that takes place in the company, like the Christmas party etc. The employees can sign up for these events so the people in charge of planning them know who will be coming or not. The fields should be self-explaining, so I only explain some of them here:

FAQ¶

No FAQ yet.

Changing the look of the plug-in¶

The extension creates valid (X)HTML and is styled with CSS. You can reset my default style with the following code in your page's template:

plugin.tx_smemployeelist_pi1._CSS_DEFAULT_STYLE >
plugin.tx_smemployeelist_pi2._CSS_DEFAULT_STYLE >

You can take my CSS definitions from the files pi1/static/setup.txt and pi2/static/setup.txt in the extension's folder, add it to a custom stylesheet and change it the way you like.

FAQ¶

No FAQ yet.

Installing the extension¶

Installing the sm_employeelist extension is very simple.

Install the extension using TYPO3's extension manager.

Include the extension's static code in your page template (Note: If you want to use all plugins you have to select every single static file here).

Insert a new page content to one of your pages. Select the Employee List plugin.

First of all, set the Startingpoint . That's the page/sysfolder where the extension looks for employees, departments, positions and telephone numbers. I recommend using a sysfolder in which all the data is stored.

Continue to configure the plugin. You can use the flexform to configure the output of a single page content. If you want to use more than one page (e.g. one for each different list) you should set the pages' Ids in your template, so you don't have to define them on each single page content.

Flexform configuration¶

GroupID,IconFile,Description

%d.%m.%Y

id, fullname, fulladdress, title, surname, firstname, address, city, zip, company, country, birthday, image, sex, hobbies, signature, signatureimage, departments, positions, collectivenumbers, firstentry, telephone, fax, email, website, description, username, ipaddress, lastwinlogon, age, workyears, workinghours, workingtime

Priority,CSS-class name

%d. %B %Y

Configuration in the page's template¶

All settings from the flexform could also be set in the page's template. For a list of possible settings see section Reference .

Common settings for the page's template¶

I recommend to set some configuration in your page's template, so you don't have to define them every time you create a new list. Simply set the following values (you will have to precede them with plugin.tx_smemployeelist_pi1.):

Changing the mail template for the event list¶

The template file for the automatic mails from the event list is located in the extension's directory under pi2/mail.txt . It is a simple HTML-file, that you can change according to your needs. The following variables can be placed anywhere in the template and will be replaced with the corresponding values.

FAQ¶

No FAQ yet.

Reference¶

0

1

Id, fullname, zip, city, country, birthday, sex, signature, company, firstentry, telephone, fax, email, website, description, username, ipaddress, lastwinlogon

0

0

0

0

0

specialGroups (
        37,ico_football.gif,Plays football
        38,ico_firstAid.gif,Is able to give First Aid
)

%d.%m.%Y

fullname

1

1

1

100

100

1

excludeGroups = 22,23

1

priorityClasses (
        49,lowPriority
        55,highPriority
        60,higherPriority
        70,highestPriority
)

49,lowPriority
55,highPriority
60,higherPriority
70,highestPriority

%d. %B %Y

fulladdress, birthday, hobbies

150

150

1

customFields = city,zip

5

2

100

2

plugin.tx_smemployeelist_pi1 {
  pidList = 21
  recursive = 1
  flexform {
    general {
      listPage = 11
      detailsPage = 12
      deptListPage = 13
      posListPage = 14
      numberListPage = 15
      specialGroups (
        37,ico_football.gif,Plays football
        38,ico_firstAid.gif,Is able to give First Aid
      )
    )
    list {
      dateFormat = %d.%m.%Y
      listfields = fullname,signature,telephone
      sortable = 1
      linkNames = 1
      showAnchors = 1
      imageMaxWidth = 100
      imageMaxHeight = 100
      clickEnlarge = 1
      excludeGroups = 23,24
      excludeGroupsInfo = 1
      priorityClasses (
        49,lowPriority
        55,highPriority
        60,higherPriority
        70,highestPriority
      )
    }
    details {
      dateFormat = %d. %B %Y
      fields = fulladdress,birthday,hobbies,firstentry,collectivenumbers
      imageMaxWidth = 150
      imageMaxHeight = 150
      clickEnlarge = 1
    }
    specialLists {
      ILcolumns = 5
      BLcolumns = 2
      BLrows = 100
      TLcolumns = 2
    }
  }
}

Version 1.0.0¶

Initial version.

Version 1.0.2¶

• Removed Subversion-files and _res -folder :-)
• Added a more detailed description of the extension.
• Added working hours to employees' fields. If working hours are defined for an employee he/she will be considered to be a part-time worker. Working times can be displayed on the details page. You can now add the column 'workingtime' that displays if the employee is a part-time or full-time worker to any list and 'workinghours' as a detail to the details page.
• Empty fields will no longer be shown on the details page. Before they were shown, but the value was set to '-'.

Version 1.0.3¶

• Updated manual.
• Statistics now include number of part-time workers.

Version 1.1.0¶

• Added the event list.
• Updated the manual to look nicer in TER.
• Some smaller changes in the source code.

EXT: sm_employeelist - 13